From 210653745edacd522cfc365ba427cc17f1a61ed9 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 6 Feb 2024 15:38:35 -0800 Subject: [PATCH 001/343] TypeSpec changes to support Python SDK updates for beta.2 --- specification/ai/ImageAnalysis/client.tsp | 24 ----------------------- specification/ai/ImageAnalysis/routes.tsp | 1 + 2 files changed, 1 insertion(+), 24 deletions(-) diff --git a/specification/ai/ImageAnalysis/client.tsp b/specification/ai/ImageAnalysis/client.tsp index 15dc6f531856..e8256baf9e95 100644 --- a/specification/ai/ImageAnalysis/client.tsp +++ b/specification/ai/ImageAnalysis/client.tsp @@ -51,27 +51,3 @@ using Azure.ClientGenerator.Core; @@access(ImageAnalysis.SmartCropsResult, Access.public, "java"); @@access(ImageAnalysis.TagsResult, Access.public, "java"); @@access(ImageAnalysis.VisualFeatures, Access.public, "java"); - -@@access(ImageAnalysis.analyzeFromImageData, Access.internal, "python"); -@@access(ImageAnalysis.analyzeFromUrl, Access.internal, "python"); - -@@access(ImageAnalysis.CaptionResult, Access.public, "python"); -@@access(ImageAnalysis.CropRegion, Access.public, "python"); -@@access(ImageAnalysis.DenseCaption, Access.public, "python"); -@@access(ImageAnalysis.DenseCaptionsResult, Access.public, "python"); -@@access(ImageAnalysis.DetectedObject, Access.public, "python"); -@@access(ImageAnalysis.DetectedPerson, Access.public, "python"); -@@access(ImageAnalysis.DetectedTag, Access.public, "python"); -@@access(ImageAnalysis.DetectedTextBlock, Access.public, "python"); -@@access(ImageAnalysis.DetectedTextLine, Access.public, "python"); -@@access(ImageAnalysis.DetectedTextWord, Access.public, "python"); -@@access(ImageAnalysis.ImageAnalysisResult, Access.public, "python"); -@@access(ImageAnalysis.ImageBoundingBox, Access.public, "python"); -@@access(ImageAnalysis.ImageMetadata, Access.public, "python"); -@@access(ImageAnalysis.ImagePoint, Access.public, "python"); -@@access(ImageAnalysis.ObjectsResult, Access.public, "python"); -@@access(ImageAnalysis.PeopleResult, Access.public, "python"); -@@access(ImageAnalysis.ReadResult, Access.public, "python"); -@@access(ImageAnalysis.SmartCropsResult, Access.public, "python"); -@@access(ImageAnalysis.TagsResult, Access.public, "python"); -@@access(ImageAnalysis.VisualFeatures, Access.public, "python"); diff --git a/specification/ai/ImageAnalysis/routes.tsp b/specification/ai/ImageAnalysis/routes.tsp index 0bdebd4b889a..4f102822706e 100644 --- a/specification/ai/ImageAnalysis/routes.tsp +++ b/specification/ai/ImageAnalysis/routes.tsp @@ -73,6 +73,7 @@ alias SharedAnalyzeQuery = { #suppress "@azure-tools/typespec-azure-core/byos" "It's an RPC call to analyze an image, it doesn't store anything. There's a BYOS version of this call, but it's not this one." @doc("Performs a single Image Analysis operation") @route("imageanalysis:analyze") +@projectedName("python", "analyze") @post @sharedRoute op analyzeFromImageData is Azure.Core.RpcOperation< From 79e9a425053f8d4a1f9120ba0d0037e99779018d Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 6 Feb 2024 17:44:46 -0800 Subject: [PATCH 002/343] use imageUrl and imageData instead of imageContent. Make analyzeFromUrl internal, since its using the ImageUrl class --- specification/ai/ImageAnalysis/client.tsp | 2 ++ specification/ai/ImageAnalysis/routes.tsp | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/specification/ai/ImageAnalysis/client.tsp b/specification/ai/ImageAnalysis/client.tsp index e8256baf9e95..d2439a237425 100644 --- a/specification/ai/ImageAnalysis/client.tsp +++ b/specification/ai/ImageAnalysis/client.tsp @@ -28,6 +28,8 @@ using Azure.ClientGenerator.Core; @@projectedName(ImageAnalysis.VisualFeatures, "csharp", "VisualFeaturesImpl"); +@@access(ImageAnalysis.analyzeFromUrl, Access.internal, "python"); + @@access(ImageAnalysis.analyzeFromImageData, Access.internal, "java"); @@access(ImageAnalysis.analyzeFromUrl, Access.internal, "java"); diff --git a/specification/ai/ImageAnalysis/routes.tsp b/specification/ai/ImageAnalysis/routes.tsp index 4f102822706e..a6322c9ed39f 100644 --- a/specification/ai/ImageAnalysis/routes.tsp +++ b/specification/ai/ImageAnalysis/routes.tsp @@ -84,7 +84,7 @@ op analyzeFromImageData is Azure.Core.RpcOperation< @doc("The image to be analyzed") @body - imageContent: bytes; + imageData: bytes; ...SharedAnalyzeQuery; }, @@ -103,7 +103,7 @@ op analyzeFromUrl is Azure.Core.RpcOperation< @doc("The image to be analyzed") @body - imageContent: ImageUrl; + imageUrl: ImageUrl; ...SharedAnalyzeQuery; }, From 0934f729d99ddf5eaa7f2279d5dcf727438586a3 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 6 Feb 2024 18:05:32 -0800 Subject: [PATCH 003/343] Revert back Python specific changes --- specification/ai/ImageAnalysis/client.tsp | 27 +++++++++++++++++++++-- specification/ai/ImageAnalysis/routes.tsp | 1 - 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/specification/ai/ImageAnalysis/client.tsp b/specification/ai/ImageAnalysis/client.tsp index d2439a237425..2244a0d8fe98 100644 --- a/specification/ai/ImageAnalysis/client.tsp +++ b/specification/ai/ImageAnalysis/client.tsp @@ -28,8 +28,6 @@ using Azure.ClientGenerator.Core; @@projectedName(ImageAnalysis.VisualFeatures, "csharp", "VisualFeaturesImpl"); -@@access(ImageAnalysis.analyzeFromUrl, Access.internal, "python"); - @@access(ImageAnalysis.analyzeFromImageData, Access.internal, "java"); @@access(ImageAnalysis.analyzeFromUrl, Access.internal, "java"); @@ -53,3 +51,28 @@ using Azure.ClientGenerator.Core; @@access(ImageAnalysis.SmartCropsResult, Access.public, "java"); @@access(ImageAnalysis.TagsResult, Access.public, "java"); @@access(ImageAnalysis.VisualFeatures, Access.public, "java"); + +@@access(ImageAnalysis.analyzeFromImageData, Access.internal, "python"); +@@access(ImageAnalysis.analyzeFromUrl, Access.internal, "python"); + +@@access(ImageAnalysis.CaptionResult, Access.public, "python"); +@@access(ImageAnalysis.CropRegion, Access.public, "python"); +@@access(ImageAnalysis.DenseCaption, Access.public, "python"); +@@access(ImageAnalysis.DenseCaptionsResult, Access.public, "python"); +@@access(ImageAnalysis.DetectedObject, Access.public, "python"); +@@access(ImageAnalysis.DetectedPerson, Access.public, "python"); +@@access(ImageAnalysis.DetectedTag, Access.public, "python"); +@@access(ImageAnalysis.DetectedTextBlock, Access.public, "python"); +@@access(ImageAnalysis.DetectedTextLine, Access.public, "python"); +@@access(ImageAnalysis.DetectedTextWord, Access.public, "python"); +@@access(ImageAnalysis.ImageAnalysisResult, Access.public, "python"); +@@access(ImageAnalysis.ImageBoundingBox, Access.public, "python"); +@@access(ImageAnalysis.ImageMetadata, Access.public, "python"); +@@access(ImageAnalysis.ImagePoint, Access.public, "python"); +@@access(ImageAnalysis.ObjectsResult, Access.public, "python"); +@@access(ImageAnalysis.PeopleResult, Access.public, "python"); +@@access(ImageAnalysis.ReadResult, Access.public, "python"); +@@access(ImageAnalysis.SmartCropsResult, Access.public, "python"); +@@access(ImageAnalysis.TagsResult, Access.public, "python"); +@@access(ImageAnalysis.VisualFeatures, Access.public, "python"); + diff --git a/specification/ai/ImageAnalysis/routes.tsp b/specification/ai/ImageAnalysis/routes.tsp index a6322c9ed39f..1db075b7c439 100644 --- a/specification/ai/ImageAnalysis/routes.tsp +++ b/specification/ai/ImageAnalysis/routes.tsp @@ -73,7 +73,6 @@ alias SharedAnalyzeQuery = { #suppress "@azure-tools/typespec-azure-core/byos" "It's an RPC call to analyze an image, it doesn't store anything. There's a BYOS version of this call, but it's not this one." @doc("Performs a single Image Analysis operation") @route("imageanalysis:analyze") -@projectedName("python", "analyze") @post @sharedRoute op analyzeFromImageData is Azure.Core.RpcOperation< From 000a3269f9e748d9de720d914379083051357e45 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 6 Feb 2024 18:06:40 -0800 Subject: [PATCH 004/343] Revert new line, so it shows no change in client.tsp file --- specification/ai/ImageAnalysis/client.tsp | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/ai/ImageAnalysis/client.tsp b/specification/ai/ImageAnalysis/client.tsp index 2244a0d8fe98..ecd2a3f00b2f 100644 --- a/specification/ai/ImageAnalysis/client.tsp +++ b/specification/ai/ImageAnalysis/client.tsp @@ -74,5 +74,4 @@ using Azure.ClientGenerator.Core; @@access(ImageAnalysis.ReadResult, Access.public, "python"); @@access(ImageAnalysis.SmartCropsResult, Access.public, "python"); @@access(ImageAnalysis.TagsResult, Access.public, "python"); -@@access(ImageAnalysis.VisualFeatures, Access.public, "python"); - +@@access(ImageAnalysis.VisualFeatures, Access.public, "python"); \ No newline at end of file From c8c1d7bd8e4a04faadbc8eea0300e583fb29ee0a Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 6 Feb 2024 18:08:09 -0800 Subject: [PATCH 005/343] Try again --- specification/ai/ImageAnalysis/client.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ImageAnalysis/client.tsp b/specification/ai/ImageAnalysis/client.tsp index ecd2a3f00b2f..15dc6f531856 100644 --- a/specification/ai/ImageAnalysis/client.tsp +++ b/specification/ai/ImageAnalysis/client.tsp @@ -74,4 +74,4 @@ using Azure.ClientGenerator.Core; @@access(ImageAnalysis.ReadResult, Access.public, "python"); @@access(ImageAnalysis.SmartCropsResult, Access.public, "python"); @@access(ImageAnalysis.TagsResult, Access.public, "python"); -@@access(ImageAnalysis.VisualFeatures, Access.public, "python"); \ No newline at end of file +@@access(ImageAnalysis.VisualFeatures, Access.public, "python"); From 171c917cf68a352c5423615c880484cd49d57ff4 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 6 Feb 2024 19:28:28 -0800 Subject: [PATCH 006/343] Fix generated & example JSONs --- .../examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json | 2 +- .../examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json index 336d20f470b1..65381fe30d09 100644 --- a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json +++ b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json @@ -19,7 +19,7 @@ 1.33 ], "model-version": "latest", - "imageContent": "" + "imageData": "" }, "responses": { "200": { diff --git a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json index 266456feef92..a5f460c02704 100644 --- a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json +++ b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json @@ -19,7 +19,7 @@ 1.33 ], "model-version": "latest", - "imageContent": { + "imageUrl": { "url": "https://aka.ms/azai/vision/image-analysis-sample.jpg" } }, From acd93ec91086980bb165215249da453c8a8ec656 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 7 Feb 2024 07:16:34 -0800 Subject: [PATCH 007/343] Use unique variable names for image URL and image data --- .../2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json | 2 +- .../stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json | 2 +- .../data-plane/ImageAnalysis/stable/2023-10-01/generated.json | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json index 336d20f470b1..65381fe30d09 100644 --- a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json +++ b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json @@ -19,7 +19,7 @@ 1.33 ], "model-version": "latest", - "imageContent": "" + "imageData": "" }, "responses": { "200": { diff --git a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json index 266456feef92..a5f460c02704 100644 --- a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json +++ b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json @@ -19,7 +19,7 @@ 1.33 ], "model-version": "latest", - "imageContent": { + "imageUrl": { "url": "https://aka.ms/azai/vision/image-analysis-sample.jpg" } }, diff --git a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json index a223b95be137..fced0b7c2f01 100644 --- a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json +++ b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json @@ -165,7 +165,7 @@ "x-ms-client-name": "modelVersion" }, { - "name": "imageContent", + "name": "imageData", "in": "body", "description": "The image to be analyzed", "required": true, @@ -319,7 +319,7 @@ "x-ms-client-name": "modelVersion" }, { - "name": "imageContent", + "name": "imageUrl", "in": "body", "description": "The image to be analyzed", "required": true, From 2690ded87c92aec9f70d87b87eaa16db57bc6ea5 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 22 Mar 2024 11:36:43 -0700 Subject: [PATCH 008/343] data plane template --- specification/ai/ModelInference/client.tsp | 5 ++ .../Widgets_CreateOrUpdateWidgetSample.json | 37 +++++++++ .../Widgets_DeleteWidgetSample.json | 29 +++++++ ...idgets_GetWidgetOperationStatusSample.json | 45 +++++++++++ .../Widgets_GetWidgetSample.json | 25 ++++++ .../Widgets_ListWidgetsSample.json | 27 +++++++ specification/ai/ModelInference/main.tsp | 78 +++++++++++++++++++ .../ai/ModelInference/tspconfig.yaml | 36 +++++++++ 8 files changed, 282 insertions(+) create mode 100644 specification/ai/ModelInference/client.tsp create mode 100644 specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json create mode 100644 specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_DeleteWidgetSample.json create mode 100644 specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json create mode 100644 specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetSample.json create mode 100644 specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json create mode 100644 specification/ai/ModelInference/main.tsp create mode 100644 specification/ai/ModelInference/tspconfig.yaml diff --git a/specification/ai/ModelInference/client.tsp b/specification/ai/ModelInference/client.tsp new file mode 100644 index 000000000000..164fc28c837f --- /dev/null +++ b/specification/ai/ModelInference/client.tsp @@ -0,0 +1,5 @@ +/** + * PLACEHOLDER + * Add readme and sample + */ +import "./main.tsp"; diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json new file mode 100644 index 000000000000..9adc3398bcad --- /dev/null +++ b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json @@ -0,0 +1,37 @@ +{ + "title": "Widgets_CreateOrUpdateWidget", + "operationId": "Widgets_CreateOrUpdateWidget", + "parameters": { + "widgetName": "name1", + "api-version": "2022-11-01-preview", + "body": { + "manufacturerId": "manufacturer id1", + "sharedModel": { + "tag": "tag1", + "createdDate": "2023-01-09T02:12:25.689Z" + } + } + }, + "responses": { + "200": { + "body": { + "name": "name1", + "manufacturerId": "manufacturer id1", + "sharedModel": { + "tag": "tag1", + "createdDate": "2023-01-09T02:12:25.689Z" + } + } + }, + "201": { + "body": { + "name": "name1", + "manufacturerId": "manufacturer id1", + "sharedModel": { + "tag": "tag1", + "createdDate": "2023-01-09T02:12:25.689Z" + } + } + } + } +} diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_DeleteWidgetSample.json b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_DeleteWidgetSample.json new file mode 100644 index 000000000000..8a6b117b5cde --- /dev/null +++ b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_DeleteWidgetSample.json @@ -0,0 +1,29 @@ +{ + "operationId": "Widgets_DeleteWidget", + "title": "Delete widget by widget name using long-running operation.", + "parameters": { + "api-version": "2022-11-01-preview", + "widgetName": "searchbox" + }, + "responses": { + "202": { + "headers": { + "location": "https://contosowidgetmanager.azure.com/operations/00000000-0000-0000-0000-000000000123/result?api-version=2022-11-01-preview", + "operation-location": "https://contosowidgetmanager.azure.com/operations/00000000-0000-0000-0000-000000000123?api-version=2022-11-01-preview" + }, + "body": { + "id": "id1", + "status": "deleted" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "details": [] + } + } + } + } +} diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json new file mode 100644 index 000000000000..c88b6155b003 --- /dev/null +++ b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json @@ -0,0 +1,45 @@ +{ + "title": "Widgets_GetWidgetOperationStatus", + "operationId": "Widgets_GetWidgetOperationStatus", + "parameters": { + "widgetName": "name1", + "operationId": "opreation id1", + "api-version": "2022-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "opreation id1", + "status": "InProgress", + "error": { + "code": "Error code", + "message": "Error message", + "target": "op1", + "details": [ + { + "code": "code1", + "message": "message1", + "target": "op1", + "details": [], + "innererror": { + "code": "code1" + } + } + ], + "innererror": { + "code": "code1" + } + }, + "result": { + "name": "bingsearch", + "manufacturerId": "manufacturer Id1", + "sharedModel": { + "tag": "tag1", + "createdDate": "2023-01-09T02:12:25.689Z" + } + }, + "widgetName": "rfazvwnfwwomiwrh" + } + } + } +} diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetSample.json b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetSample.json new file mode 100644 index 000000000000..9c07ed974352 --- /dev/null +++ b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetSample.json @@ -0,0 +1,25 @@ +{ + "operationId": "Widgets_GetWidget", + "title": "Get widget by widget name.", + "parameters": { + "api-version": "2022-11-01-preview", + "widgetName": "searchbox" + }, + "responses": { + "200": { + "body": { + "name": "bingsearch", + "manufacturerId": "a-22-01" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "details": [] + } + } + } + } +} diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json new file mode 100644 index 000000000000..60cfc8902fb8 --- /dev/null +++ b/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json @@ -0,0 +1,27 @@ +{ + "title": "Widgets_ListWidgets", + "operationId": "Widgets_ListWidgets", + "parameters": { + "top": 8, + "skip": 15, + "maxpagesize": 27, + "api-version": "2022-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bingsearch", + "manufacturerId": "manufacturer Id1", + "sharedModel": { + "tag": "tag1", + "createdDate": "2023-01-09T02:12:25.689Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/ai/ModelInference/main.tsp b/specification/ai/ModelInference/main.tsp new file mode 100644 index 000000000000..7fa5fd9a80ac --- /dev/null +++ b/specification/ai/ModelInference/main.tsp @@ -0,0 +1,78 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; + +@useAuth( + ApiKeyAuth | OAuth2Auth<[ + { + type: OAuth2FlowType.implicit, + authorizationUrl: "https://login.contoso.com/common/oauth2/v2.0/authorize", + scopes: ["https://widget.contoso.com/.default"], + } + ]> +) +@service({ + title: "Azure.AI.Inference service", +}) +@versioned(Azure.AI.Inference.Versions) +namespace Azure.AI.Inference; + +@doc("The Azure.AI.Inference service versions.") +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @doc("The 2022-11-01-preview version of the Azure.AI.Inference service.") + `2022-11-01-preview`, +} + +@doc("A widget.") +@resource("widgets") +model Widget { + @key("widgetName") + @doc("The widget name.") + @visibility("read") + name: string; + + @doc("The ID of the manufacturer.") + manufacturerId: string; + + @doc("The faked shared model.") + sharedModel?: FakedSharedModel; +} + +@doc("Faked shared model") +model FakedSharedModel { + @doc("The tag.") + tag: string; + + @doc("The created date.") + createdDate: utcDateTime; +} + +interface Widgets { + @doc("Fetch a Widget by name.") + getWidget is ResourceRead; + + @doc("Gets status of a Widget operation.") + getWidgetOperationStatus is GetResourceOperationStatus; + + @doc("Creates or updates a Widget asynchronously.") + @pollingOperation(Widgets.getWidgetOperationStatus) + createOrUpdateWidget is LongRunningResourceCreateOrUpdate; + + @doc("Delete a Widget asynchronously.") + @pollingOperation(Widgets.getWidgetOperationStatus) + deleteWidget is LongRunningResourceDelete; + + @doc("List Widget resources") + listWidgets is ResourceList< + Widget, + { + parameters: StandardListQueryParameters; + } + >; +} diff --git a/specification/ai/ModelInference/tspconfig.yaml b/specification/ai/ModelInference/tspconfig.yaml new file mode 100644 index 000000000000..6fe8afea2da3 --- /dev/null +++ b/specification/ai/ModelInference/tspconfig.yaml @@ -0,0 +1,36 @@ +parameters: + "service-dir": + default: "sdk/modelinference" + "dependencies": + "additionalDirectories": [] + default: "" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" + emitter-output-dir: "{project-root}/.." + examples-directory: "{project-root}/examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" + "@azure-tools/typespec-python": + package-dir: "azure-ai-inference" + package-name: "{package-dir}" + package-mode: dataplane + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.Inference" + namespace: "{package-dir}" + clear-output-folder: true + model-namespace: false + "@azure-tools/typespec-ts": + package-dir: "azure-ai-inference-rest" + generateMetadata: true + generateTest: true + packageDetails: + name: "@azure-rest/azure-ai-inference-rest" + description: "Azure.AI.Inference Service" + "@azure-tools/typespec-java": + package-dir: "azure-ai-inference" + namespace: com.azure.ai.inference +linter: + extends: + - "@azure-tools/typespec-azure-core/all" From 831ac8b594b743ff15d9ec0c6f7d3a789cc721e3 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 22 Mar 2024 17:28:02 -0700 Subject: [PATCH 009/343] Bring over a trimmed down version of Azure OpenAI TypeSpec --- specification/ai/ModelInference/client.tsp | 21 +- specification/ai/ModelInference/main.tsp | 54 +--- .../models/completions/chat_completions.tsp | 301 ++++++++++++++++++ .../models/completions/chat_messages.tsp | 85 +++++ .../ai/ModelInference/routes/completions.tsp | 28 ++ .../Widgets_CreateOrUpdateWidgetSample.json | 0 .../examples}/Widgets_DeleteWidgetSample.json | 0 ...idgets_GetWidgetOperationStatusSample.json | 0 .../examples}/Widgets_GetWidgetSample.json | 0 .../examples}/Widgets_ListWidgetsSample.json | 0 .../preview/2024-04-01-preview/openapi.json | 69 ++++ 11 files changed, 505 insertions(+), 53 deletions(-) create mode 100644 specification/ai/ModelInference/models/completions/chat_completions.tsp create mode 100644 specification/ai/ModelInference/models/completions/chat_messages.tsp create mode 100644 specification/ai/ModelInference/routes/completions.tsp rename specification/ai/{ModelInference/examples/2022-11-01-preview => data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples}/Widgets_CreateOrUpdateWidgetSample.json (100%) rename specification/ai/{ModelInference/examples/2022-11-01-preview => data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples}/Widgets_DeleteWidgetSample.json (100%) rename specification/ai/{ModelInference/examples/2022-11-01-preview => data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples}/Widgets_GetWidgetOperationStatusSample.json (100%) rename specification/ai/{ModelInference/examples/2022-11-01-preview => data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples}/Widgets_GetWidgetSample.json (100%) rename specification/ai/{ModelInference/examples/2022-11-01-preview => data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples}/Widgets_ListWidgetsSample.json (100%) create mode 100644 specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json diff --git a/specification/ai/ModelInference/client.tsp b/specification/ai/ModelInference/client.tsp index 164fc28c837f..e6570eef1a49 100644 --- a/specification/ai/ModelInference/client.tsp +++ b/specification/ai/ModelInference/client.tsp @@ -1,5 +1,18 @@ -/** - * PLACEHOLDER - * Add readme and sample - */ +import "@azure-tools/typespec-client-generator-core"; + import "./main.tsp"; + +using Azure.ClientGenerator.Core; + +@TypeSpec.Versioning.useDependency( + Azure.AI.Inference.Versions.v2024_04_01_Preview +) +namespace Client; + +@client({ + name: "ModelClient", + service: Azure.AI.Inference, +}) +interface ModelClient { + getChatCompletions is Azure.AI.Inference.getChatCompletions; +} diff --git a/specification/ai/ModelInference/main.tsp b/specification/ai/ModelInference/main.tsp index 7fa5fd9a80ac..c710c67dab3c 100644 --- a/specification/ai/ModelInference/main.tsp +++ b/specification/ai/ModelInference/main.tsp @@ -2,6 +2,8 @@ import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; +import "./routes/completions.tsp"; + using TypeSpec.Http; using TypeSpec.Rest; using TypeSpec.Versioning; @@ -20,59 +22,13 @@ using Azure.Core; title: "Azure.AI.Inference service", }) @versioned(Azure.AI.Inference.Versions) +#suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Namespace types must use PascalCase" namespace Azure.AI.Inference; @doc("The Azure.AI.Inference service versions.") enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_2) - @doc("The 2022-11-01-preview version of the Azure.AI.Inference service.") - `2022-11-01-preview`, -} - -@doc("A widget.") -@resource("widgets") -model Widget { - @key("widgetName") - @doc("The widget name.") - @visibility("read") - name: string; - - @doc("The ID of the manufacturer.") - manufacturerId: string; - - @doc("The faked shared model.") - sharedModel?: FakedSharedModel; -} - -@doc("Faked shared model") -model FakedSharedModel { - @doc("The tag.") - tag: string; - - @doc("The created date.") - createdDate: utcDateTime; + @doc("The 2024-04-01-preview version of the Azure.AI.Inference service.") + v2024_04_01_Preview: "2024-04-01-preview", } -interface Widgets { - @doc("Fetch a Widget by name.") - getWidget is ResourceRead; - - @doc("Gets status of a Widget operation.") - getWidgetOperationStatus is GetResourceOperationStatus; - - @doc("Creates or updates a Widget asynchronously.") - @pollingOperation(Widgets.getWidgetOperationStatus) - createOrUpdateWidget is LongRunningResourceCreateOrUpdate; - - @doc("Delete a Widget asynchronously.") - @pollingOperation(Widgets.getWidgetOperationStatus) - deleteWidget is LongRunningResourceDelete; - - @doc("List Widget resources") - listWidgets is ResourceList< - Widget, - { - parameters: StandardListQueryParameters; - } - >; -} diff --git a/specification/ai/ModelInference/models/completions/chat_completions.tsp b/specification/ai/ModelInference/models/completions/chat_completions.tsp new file mode 100644 index 000000000000..1868bb96bac5 --- /dev/null +++ b/specification/ai/ModelInference/models/completions/chat_completions.tsp @@ -0,0 +1,301 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +import "./chat_messages.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.Inference; + +@doc(""" +Representation of the token counts processed for a completions request. +Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and +other consumers. +""") +model CompletionsUsage { + @doc("The number of tokens generated across all completions emissions.") + @projectedName("json", "completion_tokens") + completionTokens: int32; + + @doc("The number of tokens in the provided prompts for the completions request.") + @projectedName("json", "prompt_tokens") + promptTokens: int32; + + @doc("The total number of tokens processed for the completions request and response.") + @projectedName("json", "total_tokens") + totalTokens: int32; +} + +@doc(""" +Representation of the manner in which a completions response concluded. +""") +enum CompletionsFinishReason { + @doc("Completions ended normally and reached its end of token generation.") + stopped: "stop", + + @doc("Completions exhausted available token limits before generation could complete.") + tokenLimitReached: "length", + + @doc(""" + Completions generated a response that was identified as potentially sensitive per content + moderation policies. + """) + contentFiltered: "content_filter", +} + +@doc("A description of the intended purpose of a message within a chat completions interaction.") +enum ChatRole { + @doc("The role that instructs or sets the behavior of the assistant.") + system: "system", + + @doc("The role that provides responses to system-instructed, user-prompted input.") + assistant: "assistant", + + @doc("The role that provides input for chat completions.") + user: "user", +} + +@doc(""" +An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON +mode. +""") +@discriminator("type") +model ChatCompletionsResponseFormat { + @doc("The discriminated type for the response format.") + type: string; +} + +@doc(""" +The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response +content that adheres to a specific schema. +""") +model ChatCompletionsTextResponseFormat extends ChatCompletionsResponseFormat { + @doc("The discriminated object type, which is always 'text' for this format.") + type: "text"; +} + +@doc(""" +A response format for Chat Completions that restricts responses to emitting valid JSON objects. +""") +model ChatCompletionsJsonResponseFormat extends ChatCompletionsResponseFormat { + @doc("The discriminated object type, which is always 'json_object' for this format.") + type: "json_object"; +} + +@doc(""" +The configuration information for a chat completions request. +Completions support a wide variety of tasks and generate text that continues from or "completes" +provided prompt data. +""") +model ChatCompletionsOptions { + @doc(""" + The collection of context messages associated with this chat completions request. + Typical usage begins with a chat message for the System role that provides instructions for + the behavior of the assistant, followed by alternating messages between the User and + Assistant roles. + """) + @projectedName("json", "messages") + messages: ChatRequestMessage[]; + + @doc("The maximum number of tokens to generate.") + @projectedName("json", "max_tokens") + maxTokens?: int32; + + @doc(""" + The sampling temperature to use that controls the apparent creativity of generated completions. + Higher values will make output more random while lower values will make results more focused + and deterministic. + It is not recommended to modify temperature and top_p for the same completions request as the + interaction of these two settings is difficult to predict. + """) + @projectedName("json", "temperature") + temperature?: float32; + + @doc(""" + An alternative to sampling with temperature called nucleus sampling. This value causes the + model to consider the results of tokens with the provided probability mass. As an example, a + value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be + considered. + It is not recommended to modify temperature and top_p for the same completions request as the + interaction of these two settings is difficult to predict. + """) + @projectedName("json", "top_p") + topP?: float32; + + @doc(""" + A map between GPT token IDs and bias scores that influences the probability of specific tokens + appearing in a completions response. Token IDs are computed via external tokenizer tools, while + bias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to + a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias + score varies by model. + """) + @projectedName("json", "logit_bias") + logitBias?: Record; + + @doc(""" + An identifier for the caller or end user of the operation. This may be used for tracking + or rate-limiting purposes. + """) + @projectedName("json", "user") + user?: string; + + @doc(""" + The number of chat completions choices that should be generated for a chat completions + response. + Because this setting can generate many completions, it may quickly consume your token quota. + Use carefully and ensure reasonable settings for max_tokens and stop. + """) + @projectedName("json", "n") + n?: int32; + + @doc(""" + A collection of textual sequences that will end completions generation. + """) + @projectedName("json", "stop") + stop?: string[]; + + @doc(""" + A value that influences the probability of generated tokens appearing based on their existing + presence in generated text. + Positive values will make tokens less likely to appear when they already exist and increase the + model's likelihood to output new topics. + """) + @projectedName("json", "presence_penalty") + presencePenalty?: float32; + + @doc(""" + A value that influences the probability of generated tokens appearing based on their cumulative + frequency in generated text. + Positive values will make tokens less likely to appear as their frequency increases and + decrease the likelihood of the model repeating the same statements verbatim. + """) + @projectedName("json", "frequency_penalty") + frequencyPenalty?: float32; + + @doc(""" + A value indicating whether chat completions should be streamed for this request. + """) + @projectedName("json", "stream") + stream?: boolean; + + @doc(""" + The model name to provide as part of this completions request. + Not applicable to Azure OpenAI, where deployment information should be included in the Azure + resource URI that's connected to. + """) + @projectedName("json", "model") + `model`?: string; + + @doc(""" + If specified, the system will make a best effort to sample deterministically such that repeated requests with the + same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the + system_fingerprint response parameter to monitor changes in the backend." + """) + seed?: int64; + + @projectedName("json", "response_format") + @doc("An object specifying the format that the model must output. Used to enable JSON mode.") + responseFormat?: ChatCompletionsResponseFormat; +} + +@doc(""" +The representation of a single prompt completion as part of an overall chat completions request. +Generally, `n` choices are generated per provided prompt with a default value of 1. +Token limits and other settings may limit the number of choices generated. +""") +model ChatChoice { + @doc("The chat message for a given chat completions prompt.") + @projectedName("json", "message") + message?: ChatResponseMessage; + + @doc("The ordered index associated with this chat completions choice.") + @projectedName("json", "index") + index: int32; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" + #suppress "@azure-tools/typespec-autorest/union-unsupported" "OpenAPI v2 support deferred" + @doc("The reason that this chat completions choice completed its generated.") + @projectedName("json", "finish_reason") + finishReason: CompletionsFinishReason | null; + + // Note: this property is currently speculative via observation and not yet documented anywhere. + @doc(""" + The reason the model stopped generating tokens, together with any applicable details. + This structured representation replaces 'finish_reason' for some models. + """) + @projectedName("json", "finish_details") + finishDetails?: ChatFinishDetails; + + @doc("The delta message content for a streaming response.") + @projectedName("json", "delta") + delta?: ChatResponseMessage; +} + +@doc(""" +Representation of the response data from a chat completions request. +Completions support a wide variety of tasks and generate text that continues from or "completes" +provided prompt data. +""") +model ChatCompletions { + @doc("A unique identifier associated with this chat completions response.") + @projectedName("json", "id") + id: string; + + @doc(""" + The first timestamp associated with generation activity for this completions response, + represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. + """) + @projectedName("json", "created") + @projectedName("java", "createdAt") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + created: utcDateTime; + + @doc(""" + The collection of completions choices associated with this completions response. + Generally, `n` choices are generated per provided prompt with a default value of 1. + Token limits and other settings may limit the number of choices generated. + """) + @projectedName("json", "choices") + choices: ChatChoice[]; + + @projectedName("json", "system_fingerprint") + @doc(""" + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that + might impact determinism. + """) + systemFingerprint?: string; + + @doc(""" + Usage information for tokens processed and generated as part of this completions operation. + """) + @projectedName("json", "usage") + usage: CompletionsUsage; +} + +@discriminator("type") +@doc("An abstract representation of structured information about why a chat completions response terminated.") +model ChatFinishDetails { + @doc("The object type.") + type: string; +} + +@doc("A structured representation of a stop reason that signifies natural termination by the model.") +model StopFinishDetails extends ChatFinishDetails { + @doc("The object type, which is always 'stop' for this object.") + type: "stop"; + + @doc("The token sequence that the model terminated with.") + stop: string; +} + +@doc(""" +A structured representation of a stop reason that signifies a token limit was reached before the model could naturally +complete. +""") +model MaxTokensFinishDetails extends ChatFinishDetails { + @doc("The object type, which is always 'max_tokens' for this object.") + type: "max_tokens"; +} diff --git a/specification/ai/ModelInference/models/completions/chat_messages.tsp b/specification/ai/ModelInference/models/completions/chat_messages.tsp new file mode 100644 index 000000000000..a51b55af4e69 --- /dev/null +++ b/specification/ai/ModelInference/models/completions/chat_messages.tsp @@ -0,0 +1,85 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.Inference; + +#suppress "@azure-tools/typespec-autorest/union-unsupported" "External API shape is defined in OpenAPI 3.0 as oneOf." +alias ChatMessageContent = string | ChatMessageContentItem[]; + +@doc("An abstract representation of a structured content item within a chat message.") +@discriminator("type") +model ChatMessageContentItem { + @doc("The discriminated object type.") + type: string; +} + +@doc("A structured chat content item containing plain text.") +model ChatMessageTextContentItem extends ChatMessageContentItem { + @doc("The discriminated object type: always 'text' for this type.") + type: "text"; + + @doc("The content of the message.") + text: string; +} + +@discriminator("role") +@doc("An abstract representation of a chat message as provided in a request.") +model ChatRequestMessage { + @doc("The chat role associated with this message.") + role: ChatRole; +} + +@doc(""" +A request chat message containing system instructions that influence how the model will generate a chat completions +response. +""") +model ChatRequestSystemMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'system' for system messages.") + role: ChatRole.system; + + @doc("The contents of the system message.") + content: string; + + @doc("An optional name for the participant.") + name?: string; +} + +@doc("A request chat message representing user input to the assistant.") +model ChatRequestUserMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'user' for user messages.") + role: ChatRole.user; + + @doc("The contents of the user message, with available input types varying by selected model.") + content: ChatMessageContent; + + @doc("An optional name for the participant.") + name?: string; +} + +@doc("A request chat message representing response or action from the assistant.") +model ChatRequestAssistantMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'assistant' for assistant messages.") + role: ChatRole.assistant; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" + @doc("The content of the message.") + content: string | null; + + @doc("An optional name for the participant.") + name?: string; +} + +@doc("A representation of a chat message as received in a response.") +model ChatResponseMessage { + @doc("The chat role associated with the message.") + role: ChatRole; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" + @doc("The content of the message.") + content: string | null; +} diff --git a/specification/ai/ModelInference/routes/completions.tsp b/specification/ai/ModelInference/routes/completions.tsp new file mode 100644 index 000000000000..bba5efff960c --- /dev/null +++ b/specification/ai/ModelInference/routes/completions.tsp @@ -0,0 +1,28 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +import "../models/completions/chat_completions.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +using Azure.Core; + +namespace Azure.AI.Inference; + +@doc(""" +Gets chat completions for the provided chat messages. +Completions support a wide variety of tasks and generate text that continues from or "completes" +provided prompt data. +""") +@actionSeparator("/") +@action("chat/completions") //@convenientAPI(true) +op getChatCompletions is ResourceAction< + Deployment, + ChatCompletionsOptions, + ChatCompletions +>; + diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json similarity index 100% rename from specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json rename to specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_DeleteWidgetSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_DeleteWidgetSample.json similarity index 100% rename from specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_DeleteWidgetSample.json rename to specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_DeleteWidgetSample.json diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json similarity index 100% rename from specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json rename to specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetSample.json similarity index 100% rename from specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_GetWidgetSample.json rename to specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetSample.json diff --git a/specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_ListWidgetsSample.json similarity index 100% rename from specification/ai/ModelInference/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json rename to specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_ListWidgetsSample.json diff --git a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json new file mode 100644 index 000000000000..967cf5e1e098 --- /dev/null +++ b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json @@ -0,0 +1,69 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure.AI.Inference service", + "version": "2024-04-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://widget.contoso.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.contoso.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://widget.contoso.com/.default": "" + } + } + }, + "tags": [], + "paths": {}, + "definitions": { + "Versions": { + "type": "string", + "description": "The Azure.AI.Inference service versions.", + "enum": [ + "2024-04-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2024_04_01_Preview", + "value": "2024-04-01-preview", + "description": "The 2024-04-01-preview version of the Azure.AI.Inference service." + } + ] + } + } + }, + "parameters": {} +} From f4f4a397f713835946d3d9098ed118cf965d5ca9 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 22 Mar 2024 17:58:22 -0700 Subject: [PATCH 010/343] Make it build via `npx tsp compile .` --- specification/ai/ModelInference/client.tsp | 1 + .../ai/ModelInference/routes/completions.tsp | 17 +- .../ai/ModelInference/tspconfig.yaml | 17 +- .../preview/2024-04-01-preview/openapi.json | 579 +++++++++++++++++- 4 files changed, 591 insertions(+), 23 deletions(-) diff --git a/specification/ai/ModelInference/client.tsp b/specification/ai/ModelInference/client.tsp index e6570eef1a49..44154cc52590 100644 --- a/specification/ai/ModelInference/client.tsp +++ b/specification/ai/ModelInference/client.tsp @@ -13,6 +13,7 @@ namespace Client; name: "ModelClient", service: Azure.AI.Inference, }) + interface ModelClient { getChatCompletions is Azure.AI.Inference.getChatCompletions; } diff --git a/specification/ai/ModelInference/routes/completions.tsp b/specification/ai/ModelInference/routes/completions.tsp index bba5efff960c..97f77b6c3b09 100644 --- a/specification/ai/ModelInference/routes/completions.tsp +++ b/specification/ai/ModelInference/routes/completions.tsp @@ -19,10 +19,17 @@ Completions support a wide variety of tasks and generate text that continues fro provided prompt data. """) @actionSeparator("/") -@action("chat/completions") //@convenientAPI(true) -op getChatCompletions is ResourceAction< - Deployment, - ChatCompletionsOptions, +@actionSeparator("/") +@route("chat/completions") +op getChatCompletions is Azure.Core.RpcOperation< + { + @doc("The format of the HTTP payload.") + @header + contentType: "application/json"; + + @doc("The JSON payload containing chat completion options.") + @body + chatCompletionOptions: ChatCompletionsOptions; + }, ChatCompletions >; - diff --git a/specification/ai/ModelInference/tspconfig.yaml b/specification/ai/ModelInference/tspconfig.yaml index 6fe8afea2da3..f5da300bbc18 100644 --- a/specification/ai/ModelInference/tspconfig.yaml +++ b/specification/ai/ModelInference/tspconfig.yaml @@ -1,6 +1,6 @@ parameters: "service-dir": - default: "sdk/modelinference" + default: "sdk/machinelearning" "dependencies": "additionalDirectories": [] default: "" @@ -16,21 +16,6 @@ options: package-dir: "azure-ai-inference" package-name: "{package-dir}" package-mode: dataplane - "@azure-tools/typespec-csharp": - package-dir: "Azure.AI.Inference" - namespace: "{package-dir}" - clear-output-folder: true - model-namespace: false - "@azure-tools/typespec-ts": - package-dir: "azure-ai-inference-rest" - generateMetadata: true - generateTest: true - packageDetails: - name: "@azure-rest/azure-ai-inference-rest" - description: "Azure.AI.Inference Service" - "@azure-tools/typespec-java": - package-dir: "azure-ai-inference" - namespace: com.azure.ai.inference linter: extends: - "@azure-tools/typespec-azure-core/all" diff --git a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json index 967cf5e1e098..137066430361 100644 --- a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json @@ -44,8 +44,572 @@ } }, "tags": [], - "paths": {}, + "paths": { + "/chat/completions": { + "post": { + "operationId": "GetChatCompletions", + "description": "Gets chat completions for the provided chat messages.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "chatCompletionOptions", + "in": "body", + "description": "The JSON payload containing chat completion options.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ChatCompletions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + } + } + } + }, "definitions": { + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "ChatChoice": { + "type": "object", + "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "properties": { + "message": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "The chat message for a given chat completions prompt." + }, + "index": { + "type": "integer", + "format": "int32", + "description": "The ordered index associated with this chat completions choice." + }, + "finish_reason": { + "$ref": "#/definitions/CompletionsFinishReason", + "description": "The reason that this chat completions choice completed its generated.", + "x-nullable": true, + "x-ms-client-name": "finishReason" + }, + "finish_details": { + "$ref": "#/definitions/ChatFinishDetails", + "description": "The reason the model stopped generating tokens, together with any applicable details.\nThis structured representation replaces 'finish_reason' for some models.", + "x-ms-client-name": "finishDetails" + }, + "delta": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "The delta message content for a streaming response." + } + }, + "required": [ + "index", + "finish_reason" + ] + }, + "ChatCompletions": { + "type": "object", + "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier associated with this chat completions response." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "choices": { + "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "items": { + "$ref": "#/definitions/ChatChoice" + }, + "x-ms-identifiers": [] + }, + "system_fingerprint": { + "type": "string", + "description": "Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that\nmight impact determinism.", + "x-ms-client-name": "systemFingerprint" + }, + "usage": { + "$ref": "#/definitions/CompletionsUsage", + "description": "Usage information for tokens processed and generated as part of this completions operation." + } + }, + "required": [ + "id", + "created", + "choices", + "usage" + ] + }, + "ChatCompletionsJsonResponseFormat": { + "type": "object", + "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects.", + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsResponseFormat" + } + ], + "x-ms-discriminator-value": "json_object" + }, + "ChatCompletionsOptions": { + "type": "object", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "messages": { + "type": "array", + "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", + "items": { + "$ref": "#/definitions/ChatRequestMessage" + }, + "x-ms-identifiers": [] + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tokens to generate.", + "x-ms-client-name": "maxTokens" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict." + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "x-ms-client-name": "topP" + }, + "logit_bias": { + "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-ms-client-name": "logitBias" + }, + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of chat completions choices that should be generated for a chat completions\nresponse.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop." + }, + "stop": { + "type": "array", + "description": "A collection of textual sequences that will end completions generation.", + "items": { + "type": "string" + } + }, + "presence_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", + "x-ms-client-name": "presencePenalty" + }, + "frequency_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", + "x-ms-client-name": "frequencyPenalty" + }, + "stream": { + "type": "boolean", + "description": "A value indicating whether chat completions should be streamed for this request." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + }, + "seed": { + "type": "integer", + "format": "int64", + "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the\nsystem_fingerprint response parameter to monitor changes in the backend.\"" + }, + "response_format": { + "$ref": "#/definitions/ChatCompletionsResponseFormat", + "description": "An object specifying the format that the model must output. Used to enable JSON mode.", + "x-ms-client-name": "responseFormat" + } + }, + "required": [ + "messages" + ] + }, + "ChatCompletionsResponseFormat": { + "type": "object", + "description": "An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON\nmode.", + "properties": { + "type": { + "type": "string", + "description": "The discriminated type for the response format." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatCompletionsTextResponseFormat": { + "type": "object", + "description": "The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response\ncontent that adheres to a specific schema.", + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsResponseFormat" + } + ], + "x-ms-discriminator-value": "text" + }, + "ChatFinishDetails": { + "type": "object", + "description": "An abstract representation of structured information about why a chat completions response terminated.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatMessageContentItem": { + "type": "object", + "description": "An abstract representation of a structured content item within a chat message.", + "properties": { + "type": { + "type": "string", + "description": "The discriminated object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatMessageTextContentItem": { + "type": "object", + "description": "A structured chat content item containing plain text.", + "properties": { + "text": { + "type": "string", + "description": "The content of the message." + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatMessageContentItem" + } + ], + "x-ms-discriminator-value": "text" + }, + "ChatRequestAssistantMessage": { + "type": "object", + "description": "A request chat message representing response or action from the assistant.", + "properties": { + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "assistant" + }, + "ChatRequestMessage": { + "type": "object", + "description": "An abstract representation of a chat message as provided in a request.", + "properties": { + "role": { + "$ref": "#/definitions/ChatRole", + "description": "The chat role associated with this message." + } + }, + "discriminator": "role", + "required": [ + "role" + ] + }, + "ChatRequestSystemMessage": { + "type": "object", + "description": "A request chat message containing system instructions that influence how the model will generate a chat completions\nresponse.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the system message." + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "system" + }, + "ChatRequestUserMessage": { + "type": "object", + "description": "A request chat message representing user input to the assistant.", + "properties": { + "content": { + "description": "The contents of the user message, with available input types varying by selected model." + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "user" + }, + "ChatResponseMessage": { + "type": "object", + "description": "A representation of a chat message as received in a response.", + "properties": { + "role": { + "$ref": "#/definitions/ChatRole", + "description": "The chat role associated with the message." + }, + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + } + }, + "required": [ + "role", + "content" + ] + }, + "ChatRole": { + "type": "string", + "description": "A description of the intended purpose of a message within a chat completions interaction.", + "enum": [ + "system", + "assistant", + "user" + ], + "x-ms-enum": { + "name": "ChatRole", + "modelAsString": true, + "values": [ + { + "name": "system", + "value": "system", + "description": "The role that instructs or sets the behavior of the assistant." + }, + { + "name": "assistant", + "value": "assistant", + "description": "The role that provides responses to system-instructed, user-prompted input." + }, + { + "name": "user", + "value": "user", + "description": "The role that provides input for chat completions." + } + ] + } + }, + "CompletionsFinishReason": { + "type": "string", + "description": "Representation of the manner in which a completions response concluded.", + "enum": [ + "stop", + "length", + "content_filter" + ], + "x-ms-enum": { + "name": "CompletionsFinishReason", + "modelAsString": true, + "values": [ + { + "name": "stopped", + "value": "stop", + "description": "Completions ended normally and reached its end of token generation." + }, + { + "name": "tokenLimitReached", + "value": "length", + "description": "Completions exhausted available token limits before generation could complete." + }, + { + "name": "contentFiltered", + "value": "content_filter", + "description": "Completions generated a response that was identified as potentially sensitive per content\nmoderation policies." + } + ] + } + }, + "CompletionsUsage": { + "type": "object", + "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", + "properties": { + "completion_tokens": { + "type": "integer", + "format": "int32", + "description": "The number of tokens generated across all completions emissions.", + "x-ms-client-name": "completionTokens" + }, + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "The number of tokens in the provided prompts for the completions request.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "The total number of tokens processed for the completions request and response.", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "completion_tokens", + "prompt_tokens", + "total_tokens" + ] + }, + "MaxTokensFinishDetails": { + "type": "object", + "description": "A structured representation of a stop reason that signifies a token limit was reached before the model could naturally\ncomplete.", + "allOf": [ + { + "$ref": "#/definitions/ChatFinishDetails" + } + ], + "x-ms-discriminator-value": "max_tokens" + }, + "StopFinishDetails": { + "type": "object", + "description": "A structured representation of a stop reason that signifies natural termination by the model.", + "properties": { + "stop": { + "type": "string", + "description": "The token sequence that the model terminated with." + } + }, + "required": [ + "stop" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatFinishDetails" + } + ], + "x-ms-discriminator-value": "stop" + }, "Versions": { "type": "string", "description": "The Azure.AI.Inference service versions.", @@ -65,5 +629,16 @@ } } }, - "parameters": {} + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } } From 135f3f4fdc34b2126c83f54e1a9d74378139b620 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 25 Mar 2024 12:06:22 -0700 Subject: [PATCH 011/343] Additional refinement --- .../models/completions/chat_completions.tsp | 81 ++--------------- .../preview/2024-04-01-preview/openapi.json | 87 +++---------------- 2 files changed, 18 insertions(+), 150 deletions(-) diff --git a/specification/ai/ModelInference/models/completions/chat_completions.tsp b/specification/ai/ModelInference/models/completions/chat_completions.tsp index 1868bb96bac5..f7606c269914 100644 --- a/specification/ai/ModelInference/models/completions/chat_completions.tsp +++ b/specification/ai/ModelInference/models/completions/chat_completions.tsp @@ -125,32 +125,6 @@ model ChatCompletionsOptions { @projectedName("json", "top_p") topP?: float32; - @doc(""" - A map between GPT token IDs and bias scores that influences the probability of specific tokens - appearing in a completions response. Token IDs are computed via external tokenizer tools, while - bias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to - a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias - score varies by model. - """) - @projectedName("json", "logit_bias") - logitBias?: Record; - - @doc(""" - An identifier for the caller or end user of the operation. This may be used for tracking - or rate-limiting purposes. - """) - @projectedName("json", "user") - user?: string; - - @doc(""" - The number of chat completions choices that should be generated for a chat completions - response. - Because this setting can generate many completions, it may quickly consume your token quota. - Use carefully and ensure reasonable settings for max_tokens and stop. - """) - @projectedName("json", "n") - n?: int32; - @doc(""" A collection of textual sequences that will end completions generation. """) @@ -181,14 +155,6 @@ model ChatCompletionsOptions { @projectedName("json", "stream") stream?: boolean; - @doc(""" - The model name to provide as part of this completions request. - Not applicable to Azure OpenAI, where deployment information should be included in the Azure - resource URI that's connected to. - """) - @projectedName("json", "model") - `model`?: string; - @doc(""" If specified, the system will make a best effort to sample deterministically such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the @@ -221,14 +187,6 @@ model ChatChoice { @projectedName("json", "finish_reason") finishReason: CompletionsFinishReason | null; - // Note: this property is currently speculative via observation and not yet documented anywhere. - @doc(""" - The reason the model stopped generating tokens, together with any applicable details. - This structured representation replaces 'finish_reason' for some models. - """) - @projectedName("json", "finish_details") - finishDetails?: ChatFinishDetails; - @doc("The delta message content for a streaming response.") @projectedName("json", "delta") delta?: ChatResponseMessage; @@ -249,7 +207,6 @@ model ChatCompletions { represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. """) @projectedName("json", "created") - @projectedName("java", "createdAt") @encode(DateTimeKnownEncoding.unixTimestamp, int32) created: utcDateTime; @@ -261,41 +218,17 @@ model ChatCompletions { @projectedName("json", "choices") choices: ChatChoice[]; - @projectedName("json", "system_fingerprint") @doc(""" - Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that - might impact determinism. + Usage information for tokens processed and generated as part of this completions operation. """) - systemFingerprint?: string; - - @doc(""" - Usage information for tokens processed and generated as part of this completions operation. - """) @projectedName("json", "usage") usage: CompletionsUsage; -} - -@discriminator("type") -@doc("An abstract representation of structured information about why a chat completions response terminated.") -model ChatFinishDetails { - @doc("The object type.") - type: string; -} -@doc("A structured representation of a stop reason that signifies natural termination by the model.") -model StopFinishDetails extends ChatFinishDetails { - @doc("The object type, which is always 'stop' for this object.") - type: "stop"; - - @doc("The token sequence that the model terminated with.") - stop: string; -} + @doc("The response object type, which is always `chat.completion`.") + @projectedName("json", "object") + object: string; -@doc(""" -A structured representation of a stop reason that signifies a token limit was reached before the model could naturally -complete. -""") -model MaxTokensFinishDetails extends ChatFinishDetails { - @doc("The object type, which is always 'max_tokens' for this object.") - type: "max_tokens"; + @doc("The model used for the chat completion.") + @projectedName("json", "model") + `model`: string; } diff --git a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json index 137066430361..a8862dd524ed 100644 --- a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json @@ -167,11 +167,6 @@ "x-nullable": true, "x-ms-client-name": "finishReason" }, - "finish_details": { - "$ref": "#/definitions/ChatFinishDetails", - "description": "The reason the model stopped generating tokens, together with any applicable details.\nThis structured representation replaces 'finish_reason' for some models.", - "x-ms-client-name": "finishDetails" - }, "delta": { "$ref": "#/definitions/ChatResponseMessage", "description": "The delta message content for a streaming response." @@ -203,21 +198,26 @@ }, "x-ms-identifiers": [] }, - "system_fingerprint": { - "type": "string", - "description": "Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that\nmight impact determinism.", - "x-ms-client-name": "systemFingerprint" - }, "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." + }, + "object": { + "type": "string", + "description": "The response object type, which is always `chat.completion`." + }, + "model": { + "type": "string", + "description": "The model used for the chat completion." } }, "required": [ "id", "created", "choices", - "usage" + "usage", + "object", + "model" ] }, "ChatCompletionsJsonResponseFormat": { @@ -259,24 +259,6 @@ "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", "x-ms-client-name": "topP" }, - "logit_bias": { - "type": "object", - "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "x-ms-client-name": "logitBias" - }, - "user": { - "type": "string", - "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." - }, - "n": { - "type": "integer", - "format": "int32", - "description": "The number of chat completions choices that should be generated for a chat completions\nresponse.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop." - }, "stop": { "type": "array", "description": "A collection of textual sequences that will end completions generation.", @@ -300,10 +282,6 @@ "type": "boolean", "description": "A value indicating whether chat completions should be streamed for this request." }, - "model": { - "type": "string", - "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." - }, "seed": { "type": "integer", "format": "int64", @@ -343,20 +321,6 @@ ], "x-ms-discriminator-value": "text" }, - "ChatFinishDetails": { - "type": "object", - "description": "An abstract representation of structured information about why a chat completions response terminated.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, "ChatMessageContentItem": { "type": "object", "description": "An abstract representation of a structured content item within a chat message.", @@ -581,35 +545,6 @@ "total_tokens" ] }, - "MaxTokensFinishDetails": { - "type": "object", - "description": "A structured representation of a stop reason that signifies a token limit was reached before the model could naturally\ncomplete.", - "allOf": [ - { - "$ref": "#/definitions/ChatFinishDetails" - } - ], - "x-ms-discriminator-value": "max_tokens" - }, - "StopFinishDetails": { - "type": "object", - "description": "A structured representation of a stop reason that signifies natural termination by the model.", - "properties": { - "stop": { - "type": "string", - "description": "The token sequence that the model terminated with." - } - }, - "required": [ - "stop" - ], - "allOf": [ - { - "$ref": "#/definitions/ChatFinishDetails" - } - ], - "x-ms-discriminator-value": "stop" - }, "Versions": { "type": "string", "description": "The Azure.AI.Inference service versions.", From 1da51c9ef13df08245636e9a282c63c2c12db39a Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 25 Mar 2024 14:35:52 -0700 Subject: [PATCH 012/343] Fix URL path --- specification/ai/ModelInference/routes/completions.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelInference/routes/completions.tsp b/specification/ai/ModelInference/routes/completions.tsp index 97f77b6c3b09..668a41626003 100644 --- a/specification/ai/ModelInference/routes/completions.tsp +++ b/specification/ai/ModelInference/routes/completions.tsp @@ -20,7 +20,7 @@ provided prompt data. """) @actionSeparator("/") @actionSeparator("/") -@route("chat/completions") +@route("v1/chat/completions") op getChatCompletions is Azure.Core.RpcOperation< { @doc("The format of the HTTP payload.") From 640ac1cc0345c68748643911419e61c67a9aec06 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 25 Mar 2024 14:44:28 -0700 Subject: [PATCH 013/343] Revert unrelated changes --- .../examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json | 2 +- .../examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json | 2 +- specification/ai/ImageAnalysis/routes.tsp | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json index 65381fe30d09..336d20f470b1 100644 --- a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json +++ b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json @@ -19,7 +19,7 @@ 1.33 ], "model-version": "latest", - "imageData": "" + "imageContent": "" }, "responses": { "200": { diff --git a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json index a5f460c02704..266456feef92 100644 --- a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json +++ b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromUrl_MaximumSet.json @@ -19,7 +19,7 @@ 1.33 ], "model-version": "latest", - "imageUrl": { + "imageContent": { "url": "https://aka.ms/azai/vision/image-analysis-sample.jpg" } }, diff --git a/specification/ai/ImageAnalysis/routes.tsp b/specification/ai/ImageAnalysis/routes.tsp index 1db075b7c439..0bdebd4b889a 100644 --- a/specification/ai/ImageAnalysis/routes.tsp +++ b/specification/ai/ImageAnalysis/routes.tsp @@ -83,7 +83,7 @@ op analyzeFromImageData is Azure.Core.RpcOperation< @doc("The image to be analyzed") @body - imageData: bytes; + imageContent: bytes; ...SharedAnalyzeQuery; }, @@ -102,7 +102,7 @@ op analyzeFromUrl is Azure.Core.RpcOperation< @doc("The image to be analyzed") @body - imageUrl: ImageUrl; + imageContent: ImageUrl; ...SharedAnalyzeQuery; }, From fc6fa2bb54f4f23b2388decbea48541683a3d45c Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 25 Mar 2024 14:49:24 -0700 Subject: [PATCH 014/343] Continue to revert unrelated changes --- .../2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json | 2 +- .../stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json | 2 +- .../data-plane/ImageAnalysis/stable/2023-10-01/generated.json | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json index 65381fe30d09..336d20f470b1 100644 --- a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json +++ b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json @@ -19,7 +19,7 @@ 1.33 ], "model-version": "latest", - "imageData": "" + "imageContent": "" }, "responses": { "200": { diff --git a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json index a5f460c02704..266456feef92 100644 --- a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json +++ b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromUrl_MaximumSet.json @@ -19,7 +19,7 @@ 1.33 ], "model-version": "latest", - "imageUrl": { + "imageContent": { "url": "https://aka.ms/azai/vision/image-analysis-sample.jpg" } }, diff --git a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json index fced0b7c2f01..a223b95be137 100644 --- a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json +++ b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json @@ -165,7 +165,7 @@ "x-ms-client-name": "modelVersion" }, { - "name": "imageData", + "name": "imageContent", "in": "body", "description": "The image to be analyzed", "required": true, @@ -319,7 +319,7 @@ "x-ms-client-name": "modelVersion" }, { - "name": "imageUrl", + "name": "imageContent", "in": "body", "description": "The image to be analyzed", "required": true, From 63733152d7611578ae21410e953b466894427303 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 25 Mar 2024 14:53:03 -0700 Subject: [PATCH 015/343] Delete old examples --- .../Widgets_CreateOrUpdateWidgetSample.json | 37 --------------- .../examples/Widgets_DeleteWidgetSample.json | 29 ------------ ...idgets_GetWidgetOperationStatusSample.json | 45 ------------------- .../examples/Widgets_GetWidgetSample.json | 25 ----------- .../examples/Widgets_ListWidgetsSample.json | 27 ----------- 5 files changed, 163 deletions(-) delete mode 100644 specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json delete mode 100644 specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_DeleteWidgetSample.json delete mode 100644 specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json delete mode 100644 specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetSample.json delete mode 100644 specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_ListWidgetsSample.json diff --git a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json deleted file mode 100644 index 9adc3398bcad..000000000000 --- a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "title": "Widgets_CreateOrUpdateWidget", - "operationId": "Widgets_CreateOrUpdateWidget", - "parameters": { - "widgetName": "name1", - "api-version": "2022-11-01-preview", - "body": { - "manufacturerId": "manufacturer id1", - "sharedModel": { - "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" - } - } - }, - "responses": { - "200": { - "body": { - "name": "name1", - "manufacturerId": "manufacturer id1", - "sharedModel": { - "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" - } - } - }, - "201": { - "body": { - "name": "name1", - "manufacturerId": "manufacturer id1", - "sharedModel": { - "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" - } - } - } - } -} diff --git a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_DeleteWidgetSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_DeleteWidgetSample.json deleted file mode 100644 index 8a6b117b5cde..000000000000 --- a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_DeleteWidgetSample.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "operationId": "Widgets_DeleteWidget", - "title": "Delete widget by widget name using long-running operation.", - "parameters": { - "api-version": "2022-11-01-preview", - "widgetName": "searchbox" - }, - "responses": { - "202": { - "headers": { - "location": "https://contosowidgetmanager.azure.com/operations/00000000-0000-0000-0000-000000000123/result?api-version=2022-11-01-preview", - "operation-location": "https://contosowidgetmanager.azure.com/operations/00000000-0000-0000-0000-000000000123?api-version=2022-11-01-preview" - }, - "body": { - "id": "id1", - "status": "deleted" - } - }, - "default": { - "body": { - "error": { - "code": "Error code", - "message": "Error message", - "details": [] - } - } - } - } -} diff --git a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json deleted file mode 100644 index c88b6155b003..000000000000 --- a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "title": "Widgets_GetWidgetOperationStatus", - "operationId": "Widgets_GetWidgetOperationStatus", - "parameters": { - "widgetName": "name1", - "operationId": "opreation id1", - "api-version": "2022-11-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "opreation id1", - "status": "InProgress", - "error": { - "code": "Error code", - "message": "Error message", - "target": "op1", - "details": [ - { - "code": "code1", - "message": "message1", - "target": "op1", - "details": [], - "innererror": { - "code": "code1" - } - } - ], - "innererror": { - "code": "code1" - } - }, - "result": { - "name": "bingsearch", - "manufacturerId": "manufacturer Id1", - "sharedModel": { - "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" - } - }, - "widgetName": "rfazvwnfwwomiwrh" - } - } - } -} diff --git a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetSample.json deleted file mode 100644 index 9c07ed974352..000000000000 --- a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_GetWidgetSample.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "operationId": "Widgets_GetWidget", - "title": "Get widget by widget name.", - "parameters": { - "api-version": "2022-11-01-preview", - "widgetName": "searchbox" - }, - "responses": { - "200": { - "body": { - "name": "bingsearch", - "manufacturerId": "a-22-01" - } - }, - "default": { - "body": { - "error": { - "code": "Error code", - "message": "Error message", - "details": [] - } - } - } - } -} diff --git a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_ListWidgetsSample.json b/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_ListWidgetsSample.json deleted file mode 100644 index 60cfc8902fb8..000000000000 --- a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/examples/Widgets_ListWidgetsSample.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "title": "Widgets_ListWidgets", - "operationId": "Widgets_ListWidgets", - "parameters": { - "top": 8, - "skip": 15, - "maxpagesize": 27, - "api-version": "2022-11-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "bingsearch", - "manufacturerId": "manufacturer Id1", - "sharedModel": { - "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" - } - } - ], - "nextLink": "https://microsoft.com/a" - } - } - } -} From d31bec22373acb0d6f280419e738b57c93b6bee2 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:28:19 -0700 Subject: [PATCH 016/343] Update service name. Redo data-plane folder --- specification/ai/ModelInference/client.tsp | 6 +- specification/ai/ModelInference/main.tsp | 10 +-- .../models/completions/chat_completions.tsp | 2 +- .../models/completions/chat_messages.tsp | 2 +- .../ai/ModelInference/routes/completions.tsp | 2 +- .../GetChatCompletions_MaximumSet_Gen.json | 56 +++++++++++++ .../GetChatCompletions_MinimumSet_Gen.json | 35 ++++++++ .../preview/2024-04-01-preview/openapi.json | 18 ++-- .../ai/data-plane/ModelInference/readme.md | 82 +++++++++++++++++++ 9 files changed, 197 insertions(+), 16 deletions(-) create mode 100644 specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json rename specification/ai/data-plane/{Azure.AI.Inference => ModelInference}/preview/2024-04-01-preview/openapi.json (97%) create mode 100644 specification/ai/data-plane/ModelInference/readme.md diff --git a/specification/ai/ModelInference/client.tsp b/specification/ai/ModelInference/client.tsp index 44154cc52590..a7225a793119 100644 --- a/specification/ai/ModelInference/client.tsp +++ b/specification/ai/ModelInference/client.tsp @@ -5,15 +5,15 @@ import "./main.tsp"; using Azure.ClientGenerator.Core; @TypeSpec.Versioning.useDependency( - Azure.AI.Inference.Versions.v2024_04_01_Preview + ModelInference.Versions.v2024_04_01_Preview ) namespace Client; @client({ name: "ModelClient", - service: Azure.AI.Inference, + service: ModelInference, }) interface ModelClient { - getChatCompletions is Azure.AI.Inference.getChatCompletions; + getChatCompletions is ModelInference.getChatCompletions; } diff --git a/specification/ai/ModelInference/main.tsp b/specification/ai/ModelInference/main.tsp index c710c67dab3c..35cf491839c1 100644 --- a/specification/ai/ModelInference/main.tsp +++ b/specification/ai/ModelInference/main.tsp @@ -19,16 +19,16 @@ using Azure.Core; ]> ) @service({ - title: "Azure.AI.Inference service", + title: "AI Model Inference", }) -@versioned(Azure.AI.Inference.Versions) +@versioned(ModelInference.Versions) #suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Namespace types must use PascalCase" -namespace Azure.AI.Inference; +namespace ModelInference; -@doc("The Azure.AI.Inference service versions.") +@doc("The ModelInference service versions.") enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_2) - @doc("The 2024-04-01-preview version of the Azure.AI.Inference service.") + @doc("The 2024-04-01-preview version of the ModelInference service.") v2024_04_01_Preview: "2024-04-01-preview", } diff --git a/specification/ai/ModelInference/models/completions/chat_completions.tsp b/specification/ai/ModelInference/models/completions/chat_completions.tsp index f7606c269914..8c22bee083f2 100644 --- a/specification/ai/ModelInference/models/completions/chat_completions.tsp +++ b/specification/ai/ModelInference/models/completions/chat_completions.tsp @@ -8,7 +8,7 @@ using TypeSpec.Rest; using TypeSpec.Http; using TypeSpec.Versioning; -namespace Azure.AI.Inference; +namespace ModelInference; @doc(""" Representation of the token counts processed for a completions request. diff --git a/specification/ai/ModelInference/models/completions/chat_messages.tsp b/specification/ai/ModelInference/models/completions/chat_messages.tsp index a51b55af4e69..64f6472b97ac 100644 --- a/specification/ai/ModelInference/models/completions/chat_messages.tsp +++ b/specification/ai/ModelInference/models/completions/chat_messages.tsp @@ -6,7 +6,7 @@ using TypeSpec.Rest; using TypeSpec.Http; using TypeSpec.Versioning; -namespace Azure.AI.Inference; +namespace ModelInference; #suppress "@azure-tools/typespec-autorest/union-unsupported" "External API shape is defined in OpenAPI 3.0 as oneOf." alias ChatMessageContent = string | ChatMessageContentItem[]; diff --git a/specification/ai/ModelInference/routes/completions.tsp b/specification/ai/ModelInference/routes/completions.tsp index 668a41626003..6d706fa7c2a4 100644 --- a/specification/ai/ModelInference/routes/completions.tsp +++ b/specification/ai/ModelInference/routes/completions.tsp @@ -11,7 +11,7 @@ using TypeSpec.Versioning; using Azure.Core; -namespace Azure.AI.Inference; +namespace ModelInference; @doc(""" Gets chat completions for the provided chat messages. diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json new file mode 100644 index 000000000000..1b0119e81b72 --- /dev/null +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "GetChatCompletions", + "operationId": "GetChatCompletions", + "parameters": { + "api-version": "2024-04-01-preview", + "chatCompletionOptions": { + "messages": [ + { + "role": "ChatRequestMessage" + } + ], + "max_tokens": 3, + "temperature": 17, + "top_p": 11, + "stop": [ + "tdznlwkqqkwpfwhfzgrnadcprfnwh" + ], + "presence_penalty": 27, + "frequency_penalty": 20, + "stream": true, + "seed": 29, + "response_format": { + "type": "ChatCompletionsResponseFormat" + } + } + }, + "responses": { + "200": { + "body": { + "id": "guxpnhvgeseixtlwsz", + "created": 16, + "choices": [ + { + "message": { + "role": "system", + "content": "ldwtcers" + }, + "index": 12, + "finish_reason": "stop", + "delta": { + "role": "system", + "content": "ldwtcers" + } + } + ], + "usage": { + "completion_tokens": 24, + "prompt_tokens": 13, + "total_tokens": 30 + }, + "object": "foqibnwknavndujrtsqlb", + "model": "ssioolygavmebvstrmucaulzdpocqa" + } + } + } +} \ No newline at end of file diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json new file mode 100644 index 000000000000..bad9fe38e530 --- /dev/null +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "GetChatCompletions", + "operationId": "GetChatCompletions", + "parameters": { + "api-version": "2024-04-01-preview", + "chatCompletionOptions": { + "messages": [ + { + "role": "ChatRequestMessage" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "guxpnhvgeseixtlwsz", + "created": 16, + "choices": [ + { + "index": 12, + "finish_reason": "stop" + } + ], + "usage": { + "completion_tokens": 24, + "prompt_tokens": 13, + "total_tokens": 30 + }, + "object": "foqibnwknavndujrtsqlb", + "model": "ssioolygavmebvstrmucaulzdpocqa" + } + } + } +} \ No newline at end of file diff --git a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json similarity index 97% rename from specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json rename to specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json index a8862dd524ed..993147fce268 100644 --- a/specification/ai/data-plane/Azure.AI.Inference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Azure.AI.Inference service", + "title": "AI Model Inference", "version": "2024-04-01-preview", "x-typespec-generated": [ { @@ -45,7 +45,7 @@ }, "tags": [], "paths": { - "/chat/completions": { + "/v1/chat/completions": { "post": { "operationId": "GetChatCompletions", "description": "Gets chat completions for the provided chat messages.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", @@ -82,6 +82,14 @@ } } } + }, + "x-ms-examples": { + "GetChatCompletions_MaximumSet_Gen": { + "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" + }, + "GetChatCompletions_MinimumSet_Gen": { + "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" + } } } } @@ -547,7 +555,7 @@ }, "Versions": { "type": "string", - "description": "The Azure.AI.Inference service versions.", + "description": "The ModelInference service versions.", "enum": [ "2024-04-01-preview" ], @@ -558,7 +566,7 @@ { "name": "v2024_04_01_Preview", "value": "2024-04-01-preview", - "description": "The 2024-04-01-preview version of the Azure.AI.Inference service." + "description": "The 2024-04-01-preview version of the ModelInference service." } ] } @@ -576,4 +584,4 @@ "x-ms-client-name": "apiVersion" } } -} +} \ No newline at end of file diff --git a/specification/ai/data-plane/ModelInference/readme.md b/specification/ai/data-plane/ModelInference/readme.md new file mode 100644 index 000000000000..fe937b5a2672 --- /dev/null +++ b/specification/ai/data-plane/ModelInference/readme.md @@ -0,0 +1,82 @@ +# [[ServiceName]] + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for [[ServiceName]]. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the [[ServiceName]]. + +```yaml +openapi-type: [[OpenApiType]] +tag: package-[[Version]] +``` + +### Tag: package-[[Version]] + +These settings apply only when `--tag=package-[[Version]]` is specified on the command line. + +```yaml $(tag) == 'package-[[Version]]' +input-file: + - [[ResourceProviderName]]/[[ReleaseState]]/[[Version]]/[[ServiceName]].json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions + - repo: azure-powershell +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) From d5c7b0b1ef78e59dfab800460a286d851a687231 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:37:20 -0700 Subject: [PATCH 017/343] Copy examples --- .../GetChatCompletions_MaximumSet_Gen.json | 56 +++++++++++++++++++ .../GetChatCompletions_MinimumSet_Gen.json | 35 ++++++++++++ 2 files changed, 91 insertions(+) create mode 100644 specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json create mode 100644 specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json new file mode 100644 index 000000000000..1b0119e81b72 --- /dev/null +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "GetChatCompletions", + "operationId": "GetChatCompletions", + "parameters": { + "api-version": "2024-04-01-preview", + "chatCompletionOptions": { + "messages": [ + { + "role": "ChatRequestMessage" + } + ], + "max_tokens": 3, + "temperature": 17, + "top_p": 11, + "stop": [ + "tdznlwkqqkwpfwhfzgrnadcprfnwh" + ], + "presence_penalty": 27, + "frequency_penalty": 20, + "stream": true, + "seed": 29, + "response_format": { + "type": "ChatCompletionsResponseFormat" + } + } + }, + "responses": { + "200": { + "body": { + "id": "guxpnhvgeseixtlwsz", + "created": 16, + "choices": [ + { + "message": { + "role": "system", + "content": "ldwtcers" + }, + "index": 12, + "finish_reason": "stop", + "delta": { + "role": "system", + "content": "ldwtcers" + } + } + ], + "usage": { + "completion_tokens": 24, + "prompt_tokens": 13, + "total_tokens": 30 + }, + "object": "foqibnwknavndujrtsqlb", + "model": "ssioolygavmebvstrmucaulzdpocqa" + } + } + } +} \ No newline at end of file diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json new file mode 100644 index 000000000000..bad9fe38e530 --- /dev/null +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "GetChatCompletions", + "operationId": "GetChatCompletions", + "parameters": { + "api-version": "2024-04-01-preview", + "chatCompletionOptions": { + "messages": [ + { + "role": "ChatRequestMessage" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "guxpnhvgeseixtlwsz", + "created": 16, + "choices": [ + { + "index": 12, + "finish_reason": "stop" + } + ], + "usage": { + "completion_tokens": 24, + "prompt_tokens": 13, + "total_tokens": 30 + }, + "object": "foqibnwknavndujrtsqlb", + "model": "ssioolygavmebvstrmucaulzdpocqa" + } + } + } +} \ No newline at end of file From 2829c284739222b384e342cf81bc29526080584e Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:13:34 -0700 Subject: [PATCH 018/343] Fix build issues --- .../GetChatCompletions_MaximumSet_Gen.json | 2 +- .../GetChatCompletions_MinimumSet_Gen.json | 2 +- .../GetChatCompletions_MaximumSet_Gen.json | 2 +- .../GetChatCompletions_MinimumSet_Gen.json | 2 +- .../ai/data-plane/ModelInference/readme.md | 18 +++++++++--------- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 1b0119e81b72..f6bda4a88d2a 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -53,4 +53,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index bad9fe38e530..9011c336e0f2 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -32,4 +32,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 1b0119e81b72..f6bda4a88d2a 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -53,4 +53,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index bad9fe38e530..9011c336e0f2 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -32,4 +32,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/ai/data-plane/ModelInference/readme.md b/specification/ai/data-plane/ModelInference/readme.md index fe937b5a2672..ef1d4084fd65 100644 --- a/specification/ai/data-plane/ModelInference/readme.md +++ b/specification/ai/data-plane/ModelInference/readme.md @@ -1,8 +1,8 @@ -# [[ServiceName]] +# Azure AI Model Inference > see https://aka.ms/autorest -This is the AutoRest configuration file for [[ServiceName]]. +This is the AutoRest configuration file for Azure AI Model Inference. ## Getting Started @@ -22,20 +22,20 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor ### Basic Information -These are the global settings for the [[ServiceName]]. +These are the global settings for the Azure AI Model Inference. ```yaml -openapi-type: [[OpenApiType]] -tag: package-[[Version]] +openapi-type: data-plane +tag: package-2024-04-01-preview ``` -### Tag: package-[[Version]] +### Tag: package-2024-04-01-preview -These settings apply only when `--tag=package-[[Version]]` is specified on the command line. +These settings apply only when `--tag=package-2024-04-01-preview` is specified on the command line. -```yaml $(tag) == 'package-[[Version]]' +```yaml $(tag) == 'package-2024-04-01-preview' input-file: - - [[ResourceProviderName]]/[[ReleaseState]]/[[Version]]/[[ServiceName]].json + - preview/2024-04-01-preview/openapi.json ``` --- From 9dfb94f250418710787705822cabae7bd909c896 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 25 Mar 2024 17:52:17 -0700 Subject: [PATCH 019/343] Simplify and fix errors --- .../GetChatCompletions_MaximumSet_Gen.json | 34 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++----- .../models/completions/chat_messages.tsp | 21 +----------- .../GetChatCompletions_MaximumSet_Gen.json | 34 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++----- .../preview/2024-04-01-preview/openapi.json | 34 +------------------ .../ai/data-plane/ModelInference/readme.md | 3 +- 7 files changed, 54 insertions(+), 104 deletions(-) diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index f6bda4a88d2a..43fb939990d1 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -9,16 +9,16 @@ "role": "ChatRequestMessage" } ], - "max_tokens": 3, - "temperature": 17, - "top_p": 11, + "max_tokens": 14, + "temperature": 16, + "top_p": 24, "stop": [ - "tdznlwkqqkwpfwhfzgrnadcprfnwh" + "fb" ], - "presence_penalty": 27, - "frequency_penalty": 20, + "presence_penalty": 4, + "frequency_penalty": 12, "stream": true, - "seed": 29, + "seed": 18, "response_format": { "type": "ChatCompletionsResponseFormat" } @@ -27,29 +27,29 @@ "responses": { "200": { "body": { - "id": "guxpnhvgeseixtlwsz", - "created": 16, + "id": "qsezeimknwumonidzrtinssbx", + "created": 6, "choices": [ { "message": { "role": "system", - "content": "ldwtcers" + "content": "hwrlzeoiungbiepci" }, - "index": 12, + "index": 4, "finish_reason": "stop", "delta": { "role": "system", - "content": "ldwtcers" + "content": "hwrlzeoiungbiepci" } } ], "usage": { - "completion_tokens": 24, - "prompt_tokens": 13, - "total_tokens": 30 + "completion_tokens": 22, + "prompt_tokens": 26, + "total_tokens": 22 }, - "object": "foqibnwknavndujrtsqlb", - "model": "ssioolygavmebvstrmucaulzdpocqa" + "object": "o", + "model": "lmqsmmsj" } } } diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 9011c336e0f2..3a271b990518 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "guxpnhvgeseixtlwsz", - "created": 16, + "id": "qsezeimknwumonidzrtinssbx", + "created": 6, "choices": [ { - "index": 12, + "index": 4, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 24, - "prompt_tokens": 13, - "total_tokens": 30 + "completion_tokens": 22, + "prompt_tokens": 26, + "total_tokens": 22 }, - "object": "foqibnwknavndujrtsqlb", - "model": "ssioolygavmebvstrmucaulzdpocqa" + "object": "o", + "model": "lmqsmmsj" } } } diff --git a/specification/ai/ModelInference/models/completions/chat_messages.tsp b/specification/ai/ModelInference/models/completions/chat_messages.tsp index 64f6472b97ac..c7216c73e234 100644 --- a/specification/ai/ModelInference/models/completions/chat_messages.tsp +++ b/specification/ai/ModelInference/models/completions/chat_messages.tsp @@ -8,25 +8,6 @@ using TypeSpec.Versioning; namespace ModelInference; -#suppress "@azure-tools/typespec-autorest/union-unsupported" "External API shape is defined in OpenAPI 3.0 as oneOf." -alias ChatMessageContent = string | ChatMessageContentItem[]; - -@doc("An abstract representation of a structured content item within a chat message.") -@discriminator("type") -model ChatMessageContentItem { - @doc("The discriminated object type.") - type: string; -} - -@doc("A structured chat content item containing plain text.") -model ChatMessageTextContentItem extends ChatMessageContentItem { - @doc("The discriminated object type: always 'text' for this type.") - type: "text"; - - @doc("The content of the message.") - text: string; -} - @discriminator("role") @doc("An abstract representation of a chat message as provided in a request.") model ChatRequestMessage { @@ -55,7 +36,7 @@ model ChatRequestUserMessage extends ChatRequestMessage { role: ChatRole.user; @doc("The contents of the user message, with available input types varying by selected model.") - content: ChatMessageContent; + content: string; @doc("An optional name for the participant.") name?: string; diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index f6bda4a88d2a..43fb939990d1 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -9,16 +9,16 @@ "role": "ChatRequestMessage" } ], - "max_tokens": 3, - "temperature": 17, - "top_p": 11, + "max_tokens": 14, + "temperature": 16, + "top_p": 24, "stop": [ - "tdznlwkqqkwpfwhfzgrnadcprfnwh" + "fb" ], - "presence_penalty": 27, - "frequency_penalty": 20, + "presence_penalty": 4, + "frequency_penalty": 12, "stream": true, - "seed": 29, + "seed": 18, "response_format": { "type": "ChatCompletionsResponseFormat" } @@ -27,29 +27,29 @@ "responses": { "200": { "body": { - "id": "guxpnhvgeseixtlwsz", - "created": 16, + "id": "qsezeimknwumonidzrtinssbx", + "created": 6, "choices": [ { "message": { "role": "system", - "content": "ldwtcers" + "content": "hwrlzeoiungbiepci" }, - "index": 12, + "index": 4, "finish_reason": "stop", "delta": { "role": "system", - "content": "ldwtcers" + "content": "hwrlzeoiungbiepci" } } ], "usage": { - "completion_tokens": 24, - "prompt_tokens": 13, - "total_tokens": 30 + "completion_tokens": 22, + "prompt_tokens": 26, + "total_tokens": 22 }, - "object": "foqibnwknavndujrtsqlb", - "model": "ssioolygavmebvstrmucaulzdpocqa" + "object": "o", + "model": "lmqsmmsj" } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 9011c336e0f2..3a271b990518 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "guxpnhvgeseixtlwsz", - "created": 16, + "id": "qsezeimknwumonidzrtinssbx", + "created": 6, "choices": [ { - "index": 12, + "index": 4, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 24, - "prompt_tokens": 13, - "total_tokens": 30 + "completion_tokens": 22, + "prompt_tokens": 26, + "total_tokens": 22 }, - "object": "foqibnwknavndujrtsqlb", - "model": "ssioolygavmebvstrmucaulzdpocqa" + "object": "o", + "model": "lmqsmmsj" } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json index 993147fce268..9ea17f9709cb 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json @@ -329,39 +329,6 @@ ], "x-ms-discriminator-value": "text" }, - "ChatMessageContentItem": { - "type": "object", - "description": "An abstract representation of a structured content item within a chat message.", - "properties": { - "type": { - "type": "string", - "description": "The discriminated object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "ChatMessageTextContentItem": { - "type": "object", - "description": "A structured chat content item containing plain text.", - "properties": { - "text": { - "type": "string", - "description": "The content of the message." - } - }, - "required": [ - "text" - ], - "allOf": [ - { - "$ref": "#/definitions/ChatMessageContentItem" - } - ], - "x-ms-discriminator-value": "text" - }, "ChatRequestAssistantMessage": { "type": "object", "description": "A request chat message representing response or action from the assistant.", @@ -428,6 +395,7 @@ "description": "A request chat message representing user input to the assistant.", "properties": { "content": { + "type": "string", "description": "The contents of the user message, with available input types varying by selected model." }, "name": { diff --git a/specification/ai/data-plane/ModelInference/readme.md b/specification/ai/data-plane/ModelInference/readme.md index ef1d4084fd65..5d8e93f6b1ea 100644 --- a/specification/ai/data-plane/ModelInference/readme.md +++ b/specification/ai/data-plane/ModelInference/readme.md @@ -37,7 +37,7 @@ These settings apply only when `--tag=package-2024-04-01-preview` is specified o input-file: - preview/2024-04-01-preview/openapi.json ``` - + \ No newline at end of file From a14be5a0d4285049f2b7f23dba101a7e88afff29 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 26 Mar 2024 06:43:45 -0700 Subject: [PATCH 020/343] Fix more errors --- specification/ai/ModelInference/client.tsp | 4 +--- specification/ai/ModelInference/main.tsp | 1 - .../ModelInference/preview/2024-04-01-preview/openapi.json | 2 +- 3 files changed, 2 insertions(+), 5 deletions(-) diff --git a/specification/ai/ModelInference/client.tsp b/specification/ai/ModelInference/client.tsp index a7225a793119..248fbc5933f6 100644 --- a/specification/ai/ModelInference/client.tsp +++ b/specification/ai/ModelInference/client.tsp @@ -4,9 +4,7 @@ import "./main.tsp"; using Azure.ClientGenerator.Core; -@TypeSpec.Versioning.useDependency( - ModelInference.Versions.v2024_04_01_Preview -) +@TypeSpec.Versioning.useDependency(ModelInference.Versions.v2024_04_01_Preview) namespace Client; @client({ diff --git a/specification/ai/ModelInference/main.tsp b/specification/ai/ModelInference/main.tsp index 35cf491839c1..945530628f01 100644 --- a/specification/ai/ModelInference/main.tsp +++ b/specification/ai/ModelInference/main.tsp @@ -22,7 +22,6 @@ using Azure.Core; title: "AI Model Inference", }) @versioned(ModelInference.Versions) -#suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Namespace types must use PascalCase" namespace ModelInference; @doc("The ModelInference service versions.") diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json index 9ea17f9709cb..211b6d442252 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json @@ -552,4 +552,4 @@ "x-ms-client-name": "apiVersion" } } -} \ No newline at end of file +} From 97d7375684cd00d7fb9a4f2c8a92b4de890b6d9a Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 26 Mar 2024 07:01:10 -0700 Subject: [PATCH 021/343] More fixes --- specification/ai/ModelInference/client.tsp | 1 - specification/ai/ModelInference/main.tsp | 1 - specification/ai/ModelInference/tspconfig.yaml | 4 ++-- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/specification/ai/ModelInference/client.tsp b/specification/ai/ModelInference/client.tsp index 248fbc5933f6..74044c108993 100644 --- a/specification/ai/ModelInference/client.tsp +++ b/specification/ai/ModelInference/client.tsp @@ -11,7 +11,6 @@ namespace Client; name: "ModelClient", service: ModelInference, }) - interface ModelClient { getChatCompletions is ModelInference.getChatCompletions; } diff --git a/specification/ai/ModelInference/main.tsp b/specification/ai/ModelInference/main.tsp index 945530628f01..72c5121a80f1 100644 --- a/specification/ai/ModelInference/main.tsp +++ b/specification/ai/ModelInference/main.tsp @@ -30,4 +30,3 @@ enum Versions { @doc("The 2024-04-01-preview version of the ModelInference service.") v2024_04_01_Preview: "2024-04-01-preview", } - diff --git a/specification/ai/ModelInference/tspconfig.yaml b/specification/ai/ModelInference/tspconfig.yaml index f5da300bbc18..3e950d498d47 100644 --- a/specification/ai/ModelInference/tspconfig.yaml +++ b/specification/ai/ModelInference/tspconfig.yaml @@ -1,6 +1,6 @@ parameters: "service-dir": - default: "sdk/machinelearning" + default: "sdk/ai" "dependencies": "additionalDirectories": [] default: "" @@ -13,9 +13,9 @@ options: examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" "@azure-tools/typespec-python": + package-mode: dataplane package-dir: "azure-ai-inference" package-name: "{package-dir}" - package-mode: dataplane linter: extends: - "@azure-tools/typespec-azure-core/all" From 553ccaadec0b913e4b438b42fdaac823d910d656 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 26 Mar 2024 08:25:20 -0700 Subject: [PATCH 022/343] Another fix --- specification/ai/ModelInference/tspconfig.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/ai/ModelInference/tspconfig.yaml b/specification/ai/ModelInference/tspconfig.yaml index 3e950d498d47..94303e024610 100644 --- a/specification/ai/ModelInference/tspconfig.yaml +++ b/specification/ai/ModelInference/tspconfig.yaml @@ -16,6 +16,7 @@ options: package-mode: dataplane package-dir: "azure-ai-inference" package-name: "{package-dir}" + flavor: azure linter: extends: - "@azure-tools/typespec-azure-core/all" From 3b8c933cdb9ff186419286e6a4b6a0dbacabad41 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 26 Mar 2024 17:05:24 -0700 Subject: [PATCH 023/343] Fix typo in variable name --- .../GetChatCompletions_MaximumSet_Gen.json | 34 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++----- .../ai/ModelInference/routes/completions.tsp | 2 +- .../GetChatCompletions_MaximumSet_Gen.json | 34 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++----- .../preview/2024-04-01-preview/openapi.json | 2 +- 6 files changed, 54 insertions(+), 54 deletions(-) diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 43fb939990d1..9b8d91ad5f25 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,20 +3,20 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "chatCompletionOptions": { + "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" } ], - "max_tokens": 14, - "temperature": 16, - "top_p": 24, + "max_tokens": 30, + "temperature": 21, + "top_p": 21, "stop": [ - "fb" + "bsqsyjrzujojthmxmxcrgqniuwr" ], - "presence_penalty": 4, - "frequency_penalty": 12, + "presence_penalty": 11, + "frequency_penalty": 7, "stream": true, "seed": 18, "response_format": { @@ -27,29 +27,29 @@ "responses": { "200": { "body": { - "id": "qsezeimknwumonidzrtinssbx", - "created": 6, + "id": "brfimykzbfjbrrnwwzavielcgrkxs", + "created": 9, "choices": [ { "message": { "role": "system", - "content": "hwrlzeoiungbiepci" + "content": "tvuhpskzpfjwpt" }, - "index": 4, + "index": 15, "finish_reason": "stop", "delta": { "role": "system", - "content": "hwrlzeoiungbiepci" + "content": "tvuhpskzpfjwpt" } } ], "usage": { - "completion_tokens": 22, - "prompt_tokens": 26, - "total_tokens": 22 + "completion_tokens": 7, + "prompt_tokens": 8, + "total_tokens": 3 }, - "object": "o", - "model": "lmqsmmsj" + "object": "qtdixlriouipivyf", + "model": "caqtfy" } } } diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 3a271b990518..12c5a8b52444 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "chatCompletionOptions": { + "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "qsezeimknwumonidzrtinssbx", - "created": 6, + "id": "brfimykzbfjbrrnwwzavielcgrkxs", + "created": 9, "choices": [ { - "index": 4, + "index": 15, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 22, - "prompt_tokens": 26, - "total_tokens": 22 + "completion_tokens": 7, + "prompt_tokens": 8, + "total_tokens": 3 }, - "object": "o", - "model": "lmqsmmsj" + "object": "qtdixlriouipivyf", + "model": "caqtfy" } } } diff --git a/specification/ai/ModelInference/routes/completions.tsp b/specification/ai/ModelInference/routes/completions.tsp index 6d706fa7c2a4..89c255896848 100644 --- a/specification/ai/ModelInference/routes/completions.tsp +++ b/specification/ai/ModelInference/routes/completions.tsp @@ -29,7 +29,7 @@ op getChatCompletions is Azure.Core.RpcOperation< @doc("The JSON payload containing chat completion options.") @body - chatCompletionOptions: ChatCompletionsOptions; + chatCompletionsOptions: ChatCompletionsOptions; }, ChatCompletions >; diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 43fb939990d1..9b8d91ad5f25 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,20 +3,20 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "chatCompletionOptions": { + "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" } ], - "max_tokens": 14, - "temperature": 16, - "top_p": 24, + "max_tokens": 30, + "temperature": 21, + "top_p": 21, "stop": [ - "fb" + "bsqsyjrzujojthmxmxcrgqniuwr" ], - "presence_penalty": 4, - "frequency_penalty": 12, + "presence_penalty": 11, + "frequency_penalty": 7, "stream": true, "seed": 18, "response_format": { @@ -27,29 +27,29 @@ "responses": { "200": { "body": { - "id": "qsezeimknwumonidzrtinssbx", - "created": 6, + "id": "brfimykzbfjbrrnwwzavielcgrkxs", + "created": 9, "choices": [ { "message": { "role": "system", - "content": "hwrlzeoiungbiepci" + "content": "tvuhpskzpfjwpt" }, - "index": 4, + "index": 15, "finish_reason": "stop", "delta": { "role": "system", - "content": "hwrlzeoiungbiepci" + "content": "tvuhpskzpfjwpt" } } ], "usage": { - "completion_tokens": 22, - "prompt_tokens": 26, - "total_tokens": 22 + "completion_tokens": 7, + "prompt_tokens": 8, + "total_tokens": 3 }, - "object": "o", - "model": "lmqsmmsj" + "object": "qtdixlriouipivyf", + "model": "caqtfy" } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 3a271b990518..12c5a8b52444 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "chatCompletionOptions": { + "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "qsezeimknwumonidzrtinssbx", - "created": 6, + "id": "brfimykzbfjbrrnwwzavielcgrkxs", + "created": 9, "choices": [ { - "index": 4, + "index": 15, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 22, - "prompt_tokens": 26, - "total_tokens": 22 + "completion_tokens": 7, + "prompt_tokens": 8, + "total_tokens": 3 }, - "object": "o", - "model": "lmqsmmsj" + "object": "qtdixlriouipivyf", + "model": "caqtfy" } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json index 211b6d442252..669cbc65bb42 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json @@ -54,7 +54,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "chatCompletionOptions", + "name": "chatCompletionsOptions", "in": "body", "description": "The JSON payload containing chat completion options.", "required": true, From 837a784a040a09765da135783ef02b889ea3d487 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 27 Mar 2024 15:44:41 -0700 Subject: [PATCH 024/343] Remove delta streaming for now --- .../GetChatCompletions_MaximumSet_Gen.json | 38 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++---- .../models/completions/chat_completions.tsp | 4 -- .../ai/ModelInference/routes/completions.tsp | 5 --- .../GetChatCompletions_MaximumSet_Gen.json | 38 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++---- .../preview/2024-04-01-preview/openapi.json | 4 -- 7 files changed, 50 insertions(+), 71 deletions(-) diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 9b8d91ad5f25..f719c04111a4 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -9,16 +9,16 @@ "role": "ChatRequestMessage" } ], - "max_tokens": 30, - "temperature": 21, - "top_p": 21, + "max_tokens": 4, + "temperature": 13, + "top_p": 17, "stop": [ - "bsqsyjrzujojthmxmxcrgqniuwr" + "mdgofrvxhywiftfd" ], - "presence_penalty": 11, - "frequency_penalty": 7, + "presence_penalty": 17, + "frequency_penalty": 13, "stream": true, - "seed": 18, + "seed": 6, "response_format": { "type": "ChatCompletionsResponseFormat" } @@ -27,29 +27,25 @@ "responses": { "200": { "body": { - "id": "brfimykzbfjbrrnwwzavielcgrkxs", - "created": 9, + "id": "rqkpsweaxnvzmrofqlwnhuavklcvo", + "created": 21, "choices": [ { "message": { "role": "system", - "content": "tvuhpskzpfjwpt" + "content": "uicrnfw" }, - "index": 15, - "finish_reason": "stop", - "delta": { - "role": "system", - "content": "tvuhpskzpfjwpt" - } + "index": 25, + "finish_reason": "stop" } ], "usage": { - "completion_tokens": 7, - "prompt_tokens": 8, - "total_tokens": 3 + "completion_tokens": 1, + "prompt_tokens": 28, + "total_tokens": 1 }, - "object": "qtdixlriouipivyf", - "model": "caqtfy" + "object": "zlmymzdiugfivjqbfbzmzu", + "model": "oyawtxkpvnnj" } } } diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 12c5a8b52444..14f23bc0cb63 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "brfimykzbfjbrrnwwzavielcgrkxs", - "created": 9, + "id": "rqkpsweaxnvzmrofqlwnhuavklcvo", + "created": 21, "choices": [ { - "index": 15, + "index": 25, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 7, - "prompt_tokens": 8, - "total_tokens": 3 + "completion_tokens": 1, + "prompt_tokens": 28, + "total_tokens": 1 }, - "object": "qtdixlriouipivyf", - "model": "caqtfy" + "object": "zlmymzdiugfivjqbfbzmzu", + "model": "oyawtxkpvnnj" } } } diff --git a/specification/ai/ModelInference/models/completions/chat_completions.tsp b/specification/ai/ModelInference/models/completions/chat_completions.tsp index 8c22bee083f2..4c59e66a1dc9 100644 --- a/specification/ai/ModelInference/models/completions/chat_completions.tsp +++ b/specification/ai/ModelInference/models/completions/chat_completions.tsp @@ -186,10 +186,6 @@ model ChatChoice { @doc("The reason that this chat completions choice completed its generated.") @projectedName("json", "finish_reason") finishReason: CompletionsFinishReason | null; - - @doc("The delta message content for a streaming response.") - @projectedName("json", "delta") - delta?: ChatResponseMessage; } @doc(""" diff --git a/specification/ai/ModelInference/routes/completions.tsp b/specification/ai/ModelInference/routes/completions.tsp index 89c255896848..4262f25e025e 100644 --- a/specification/ai/ModelInference/routes/completions.tsp +++ b/specification/ai/ModelInference/routes/completions.tsp @@ -19,14 +19,9 @@ Completions support a wide variety of tasks and generate text that continues fro provided prompt data. """) @actionSeparator("/") -@actionSeparator("/") @route("v1/chat/completions") op getChatCompletions is Azure.Core.RpcOperation< { - @doc("The format of the HTTP payload.") - @header - contentType: "application/json"; - @doc("The JSON payload containing chat completion options.") @body chatCompletionsOptions: ChatCompletionsOptions; diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 9b8d91ad5f25..f719c04111a4 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -9,16 +9,16 @@ "role": "ChatRequestMessage" } ], - "max_tokens": 30, - "temperature": 21, - "top_p": 21, + "max_tokens": 4, + "temperature": 13, + "top_p": 17, "stop": [ - "bsqsyjrzujojthmxmxcrgqniuwr" + "mdgofrvxhywiftfd" ], - "presence_penalty": 11, - "frequency_penalty": 7, + "presence_penalty": 17, + "frequency_penalty": 13, "stream": true, - "seed": 18, + "seed": 6, "response_format": { "type": "ChatCompletionsResponseFormat" } @@ -27,29 +27,25 @@ "responses": { "200": { "body": { - "id": "brfimykzbfjbrrnwwzavielcgrkxs", - "created": 9, + "id": "rqkpsweaxnvzmrofqlwnhuavklcvo", + "created": 21, "choices": [ { "message": { "role": "system", - "content": "tvuhpskzpfjwpt" + "content": "uicrnfw" }, - "index": 15, - "finish_reason": "stop", - "delta": { - "role": "system", - "content": "tvuhpskzpfjwpt" - } + "index": 25, + "finish_reason": "stop" } ], "usage": { - "completion_tokens": 7, - "prompt_tokens": 8, - "total_tokens": 3 + "completion_tokens": 1, + "prompt_tokens": 28, + "total_tokens": 1 }, - "object": "qtdixlriouipivyf", - "model": "caqtfy" + "object": "zlmymzdiugfivjqbfbzmzu", + "model": "oyawtxkpvnnj" } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 12c5a8b52444..14f23bc0cb63 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "brfimykzbfjbrrnwwzavielcgrkxs", - "created": 9, + "id": "rqkpsweaxnvzmrofqlwnhuavklcvo", + "created": 21, "choices": [ { - "index": 15, + "index": 25, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 7, - "prompt_tokens": 8, - "total_tokens": 3 + "completion_tokens": 1, + "prompt_tokens": 28, + "total_tokens": 1 }, - "object": "qtdixlriouipivyf", - "model": "caqtfy" + "object": "zlmymzdiugfivjqbfbzmzu", + "model": "oyawtxkpvnnj" } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json index 669cbc65bb42..0dfa0e724857 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json @@ -174,10 +174,6 @@ "description": "The reason that this chat completions choice completed its generated.", "x-nullable": true, "x-ms-client-name": "finishReason" - }, - "delta": { - "$ref": "#/definitions/ChatResponseMessage", - "description": "The delta message content for a streaming response." } }, "required": [ From 1b950ebcf6b58804a387e17641b1c933aeb13f4b Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 27 Mar 2024 19:14:02 -0700 Subject: [PATCH 025/343] Use bearer auth --- .../GetChatCompletions_MaximumSet_Gen.json | 32 ++++----- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++--- specification/ai/ModelInference/main.tsp | 11 +--- .../{completions => }/chat_completions.tsp | 66 +++++++++++++++++-- .../models/completions/chat_messages.tsp | 66 ------------------- .../ai/ModelInference/routes/completions.tsp | 2 +- .../GetChatCompletions_MaximumSet_Gen.json | 32 ++++----- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++--- .../preview/2024-04-01-preview/openapi.json | 39 +++-------- 9 files changed, 123 insertions(+), 157 deletions(-) rename specification/ai/ModelInference/models/{completions => }/chat_completions.tsp (80%) delete mode 100644 specification/ai/ModelInference/models/completions/chat_messages.tsp diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index f719c04111a4..ac1c0e30be71 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -9,16 +9,16 @@ "role": "ChatRequestMessage" } ], - "max_tokens": 4, - "temperature": 13, - "top_p": 17, + "max_tokens": 25, + "temperature": 19, + "top_p": 5, "stop": [ - "mdgofrvxhywiftfd" + "rtavfjfyhnzl" ], - "presence_penalty": 17, - "frequency_penalty": 13, + "presence_penalty": 15, + "frequency_penalty": 19, "stream": true, - "seed": 6, + "seed": 19, "response_format": { "type": "ChatCompletionsResponseFormat" } @@ -27,25 +27,25 @@ "responses": { "200": { "body": { - "id": "rqkpsweaxnvzmrofqlwnhuavklcvo", - "created": 21, + "id": "sxmyscekvlsxqpsegdwnzyal", + "created": 30, "choices": [ { "message": { "role": "system", - "content": "uicrnfw" + "content": "mdhccqpdhwbiohjsm" }, - "index": 25, + "index": 6, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 1, - "prompt_tokens": 28, - "total_tokens": 1 + "completion_tokens": 14, + "prompt_tokens": 3, + "total_tokens": 11 }, - "object": "zlmymzdiugfivjqbfbzmzu", - "model": "oyawtxkpvnnj" + "object": "uuxdaqxswkk", + "model": "zaacxtgyugjfid" } } } diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 14f23bc0cb63..74f26554c793 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "rqkpsweaxnvzmrofqlwnhuavklcvo", - "created": 21, + "id": "sxmyscekvlsxqpsegdwnzyal", + "created": 30, "choices": [ { - "index": 25, + "index": 6, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 1, - "prompt_tokens": 28, - "total_tokens": 1 + "completion_tokens": 14, + "prompt_tokens": 3, + "total_tokens": 11 }, - "object": "zlmymzdiugfivjqbfbzmzu", - "model": "oyawtxkpvnnj" + "object": "uuxdaqxswkk", + "model": "zaacxtgyugjfid" } } } diff --git a/specification/ai/ModelInference/main.tsp b/specification/ai/ModelInference/main.tsp index 72c5121a80f1..fa0307e2a8e1 100644 --- a/specification/ai/ModelInference/main.tsp +++ b/specification/ai/ModelInference/main.tsp @@ -9,15 +9,8 @@ using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.Core; -@useAuth( - ApiKeyAuth | OAuth2Auth<[ - { - type: OAuth2FlowType.implicit, - authorizationUrl: "https://login.contoso.com/common/oauth2/v2.0/authorize", - scopes: ["https://widget.contoso.com/.default"], - } - ]> -) +#suppress "@azure-tools/typespec-autorest/unsupported-http-auth-scheme" +@useAuth(BearerAuth) @service({ title: "AI Model Inference", }) diff --git a/specification/ai/ModelInference/models/completions/chat_completions.tsp b/specification/ai/ModelInference/models/chat_completions.tsp similarity index 80% rename from specification/ai/ModelInference/models/completions/chat_completions.tsp rename to specification/ai/ModelInference/models/chat_completions.tsp index 4c59e66a1dc9..d58f8a658cee 100644 --- a/specification/ai/ModelInference/models/completions/chat_completions.tsp +++ b/specification/ai/ModelInference/models/chat_completions.tsp @@ -2,8 +2,6 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/versioning"; -import "./chat_messages.tsp"; - using TypeSpec.Rest; using TypeSpec.Http; using TypeSpec.Versioning; @@ -51,11 +49,14 @@ enum ChatRole { @doc("The role that instructs or sets the behavior of the assistant.") system: "system", + @doc("The role that provides input for chat completions.") + user: "user", + @doc("The role that provides responses to system-instructed, user-prompted input.") assistant: "assistant", - @doc("The role that provides input for chat completions.") - user: "user", + @doc("The role that represents extension tool activity within a chat completions operation.") + tool: "tool", } @doc(""" @@ -228,3 +229,60 @@ model ChatCompletions { @projectedName("json", "model") `model`: string; } + +@discriminator("role") +@doc("An abstract representation of a chat message as provided in a request.") +model ChatRequestMessage { + @doc("The chat role associated with this message.") + role: ChatRole; +} + +@doc(""" +A request chat message containing system instructions that influence how the model will generate a chat completions +response. +""") +model ChatRequestSystemMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'system' for system messages.") + role: ChatRole.system; + + @doc("The contents of the system message.") + content: string; + + @doc("An optional name for the participant.") + name?: string; +} + +@doc("A request chat message representing user input to the assistant.") +model ChatRequestUserMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'user' for user messages.") + role: ChatRole.user; + + @doc("The contents of the user message, with available input types varying by selected model.") + content: string; + + @doc("An optional name for the participant.") + name?: string; +} + +@doc("A request chat message representing response or action from the assistant.") +model ChatRequestAssistantMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'assistant' for assistant messages.") + role: ChatRole.assistant; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" + @doc("The content of the message.") + content: string | null; + + @doc("An optional name for the participant.") + name?: string; +} + +@doc("A representation of a chat message as received in a response.") +model ChatResponseMessage { + @doc("The chat role associated with the message.") + role: ChatRole; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" + @doc("The content of the message.") + content: string | null; +} diff --git a/specification/ai/ModelInference/models/completions/chat_messages.tsp b/specification/ai/ModelInference/models/completions/chat_messages.tsp deleted file mode 100644 index c7216c73e234..000000000000 --- a/specification/ai/ModelInference/models/completions/chat_messages.tsp +++ /dev/null @@ -1,66 +0,0 @@ -import "@typespec/rest"; -import "@typespec/http"; -import "@typespec/versioning"; - -using TypeSpec.Rest; -using TypeSpec.Http; -using TypeSpec.Versioning; - -namespace ModelInference; - -@discriminator("role") -@doc("An abstract representation of a chat message as provided in a request.") -model ChatRequestMessage { - @doc("The chat role associated with this message.") - role: ChatRole; -} - -@doc(""" -A request chat message containing system instructions that influence how the model will generate a chat completions -response. -""") -model ChatRequestSystemMessage extends ChatRequestMessage { - @doc("The chat role associated with this message, which is always 'system' for system messages.") - role: ChatRole.system; - - @doc("The contents of the system message.") - content: string; - - @doc("An optional name for the participant.") - name?: string; -} - -@doc("A request chat message representing user input to the assistant.") -model ChatRequestUserMessage extends ChatRequestMessage { - @doc("The chat role associated with this message, which is always 'user' for user messages.") - role: ChatRole.user; - - @doc("The contents of the user message, with available input types varying by selected model.") - content: string; - - @doc("An optional name for the participant.") - name?: string; -} - -@doc("A request chat message representing response or action from the assistant.") -model ChatRequestAssistantMessage extends ChatRequestMessage { - @doc("The chat role associated with this message, which is always 'assistant' for assistant messages.") - role: ChatRole.assistant; - - #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" - @doc("The content of the message.") - content: string | null; - - @doc("An optional name for the participant.") - name?: string; -} - -@doc("A representation of a chat message as received in a response.") -model ChatResponseMessage { - @doc("The chat role associated with the message.") - role: ChatRole; - - #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" - @doc("The content of the message.") - content: string | null; -} diff --git a/specification/ai/ModelInference/routes/completions.tsp b/specification/ai/ModelInference/routes/completions.tsp index 4262f25e025e..576d72dcb976 100644 --- a/specification/ai/ModelInference/routes/completions.tsp +++ b/specification/ai/ModelInference/routes/completions.tsp @@ -3,7 +3,7 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/versioning"; -import "../models/completions/chat_completions.tsp"; +import "../models/chat_completions.tsp"; using TypeSpec.Rest; using TypeSpec.Http; diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index f719c04111a4..ac1c0e30be71 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -9,16 +9,16 @@ "role": "ChatRequestMessage" } ], - "max_tokens": 4, - "temperature": 13, - "top_p": 17, + "max_tokens": 25, + "temperature": 19, + "top_p": 5, "stop": [ - "mdgofrvxhywiftfd" + "rtavfjfyhnzl" ], - "presence_penalty": 17, - "frequency_penalty": 13, + "presence_penalty": 15, + "frequency_penalty": 19, "stream": true, - "seed": 6, + "seed": 19, "response_format": { "type": "ChatCompletionsResponseFormat" } @@ -27,25 +27,25 @@ "responses": { "200": { "body": { - "id": "rqkpsweaxnvzmrofqlwnhuavklcvo", - "created": 21, + "id": "sxmyscekvlsxqpsegdwnzyal", + "created": 30, "choices": [ { "message": { "role": "system", - "content": "uicrnfw" + "content": "mdhccqpdhwbiohjsm" }, - "index": 25, + "index": 6, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 1, - "prompt_tokens": 28, - "total_tokens": 1 + "completion_tokens": 14, + "prompt_tokens": 3, + "total_tokens": 11 }, - "object": "zlmymzdiugfivjqbfbzmzu", - "model": "oyawtxkpvnnj" + "object": "uuxdaqxswkk", + "model": "zaacxtgyugjfid" } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 14f23bc0cb63..74f26554c793 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "rqkpsweaxnvzmrofqlwnhuavklcvo", - "created": 21, + "id": "sxmyscekvlsxqpsegdwnzyal", + "created": 30, "choices": [ { - "index": 25, + "index": 6, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 1, - "prompt_tokens": 28, - "total_tokens": 1 + "completion_tokens": 14, + "prompt_tokens": 3, + "total_tokens": 11 }, - "object": "zlmymzdiugfivjqbfbzmzu", - "model": "oyawtxkpvnnj" + "object": "uuxdaqxswkk", + "model": "zaacxtgyugjfid" } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json index 0dfa0e724857..2f883241fc11 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json @@ -18,31 +18,6 @@ "consumes": [ "application/json" ], - "security": [ - { - "ApiKeyAuth": [] - }, - { - "OAuth2Auth": [ - "https://widget.contoso.com/.default" - ] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "api-key", - "in": "header" - }, - "OAuth2Auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.contoso.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://widget.contoso.com/.default": "" - } - } - }, "tags": [], "paths": { "/v1/chat/completions": { @@ -433,8 +408,9 @@ "description": "A description of the intended purpose of a message within a chat completions interaction.", "enum": [ "system", + "user", "assistant", - "user" + "tool" ], "x-ms-enum": { "name": "ChatRole", @@ -445,15 +421,20 @@ "value": "system", "description": "The role that instructs or sets the behavior of the assistant." }, + { + "name": "user", + "value": "user", + "description": "The role that provides input for chat completions." + }, { "name": "assistant", "value": "assistant", "description": "The role that provides responses to system-instructed, user-prompted input." }, { - "name": "user", - "value": "user", - "description": "The role that provides input for chat completions." + "name": "tool", + "value": "tool", + "description": "The role that represents extension tool activity within a chat completions operation." } ] } From 11cd623b7f704a2c40c34aacb9a6456f6e32445a Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 28 Mar 2024 12:08:31 -0700 Subject: [PATCH 026/343] Add support for tools. Reorder elements based on order I see in service swagger --- .../GetChatCompletions_MaximumSet_Gen.json | 49 ++- .../GetChatCompletions_MinimumSet_Gen.json | 20 +- .../models/chat_completions.tsp | 403 ++++++++++++------ .../GetChatCompletions_MaximumSet_Gen.json | 49 ++- .../GetChatCompletions_MinimumSet_Gen.json | 20 +- .../preview/2024-04-01-preview/openapi.json | 290 +++++++++++-- 6 files changed, 611 insertions(+), 220 deletions(-) diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index ac1c0e30be71..6318da943bfd 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -9,43 +9,54 @@ "role": "ChatRequestMessage" } ], - "max_tokens": 25, - "temperature": 19, - "top_p": 5, + "frequency_penalty": -2, + "presence_penalty": -1, + "temperature": 0, + "top_p": 0, + "max_tokens": 0, + "response_format": { + "type": "ChatCompletionsResponseFormat" + }, "stop": [ - "rtavfjfyhnzl" + "zlkrxijvazqium" ], - "presence_penalty": 15, - "frequency_penalty": 19, "stream": true, - "seed": 19, - "response_format": { - "type": "ChatCompletionsResponseFormat" - } + "tools": [ + { + "type": "ChatCompletionsToolDefinition" + } + ], + "seed": 30 } }, "responses": { "200": { "body": { - "id": "sxmyscekvlsxqpsegdwnzyal", + "id": "vxckegxkfctjdqjitcawjna", + "object": "wepdkxpkuzhs", "created": 30, + "model": "ekoksbbgcjzskssaxefhmkrmnpfopm", "choices": [ { + "index": 30, "message": { "role": "system", - "content": "mdhccqpdhwbiohjsm" + "content": "bfeykwwialisszlizvbiu", + "tool_calls": [ + { + "type": "ChatCompletionsToolCall", + "id": "pxokpajzlccgcbaz" + } + ] }, - "index": 6, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 14, - "prompt_tokens": 3, - "total_tokens": 11 - }, - "object": "uuxdaqxswkk", - "model": "zaacxtgyugjfid" + "completion_tokens": 19, + "prompt_tokens": 29, + "total_tokens": 29 + } } } } diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 74f26554c793..d126d5d3c435 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,25 @@ "responses": { "200": { "body": { - "id": "sxmyscekvlsxqpsegdwnzyal", + "id": "vxckegxkfctjdqjitcawjna", + "object": "wepdkxpkuzhs", "created": 30, + "model": "ekoksbbgcjzskssaxefhmkrmnpfopm", "choices": [ { - "index": 6, + "index": 30, + "message": { + "role": "system", + "content": "bfeykwwialisszlizvbiu" + }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 14, - "prompt_tokens": 3, - "total_tokens": 11 - }, - "object": "uuxdaqxswkk", - "model": "zaacxtgyugjfid" + "completion_tokens": 19, + "prompt_tokens": 29, + "total_tokens": 29 + } } } } diff --git a/specification/ai/ModelInference/models/chat_completions.tsp b/specification/ai/ModelInference/models/chat_completions.tsp index d58f8a658cee..00a9c6c1843f 100644 --- a/specification/ai/ModelInference/models/chat_completions.tsp +++ b/specification/ai/ModelInference/models/chat_completions.tsp @@ -8,6 +8,151 @@ using TypeSpec.Versioning; namespace ModelInference; +@doc(""" +The configuration information for a chat completions request. +Completions support a wide variety of tasks and generate text that continues from or "completes" +provided prompt data. +""") +model ChatCompletionsOptions { + @doc(""" + The collection of context messages associated with this chat completions request. + Typical usage begins with a chat message for the System role that provides instructions for + the behavior of the assistant, followed by alternating messages between the User and + Assistant roles. + """) + @projectedName("json", "messages") + @minItems(1) + messages: ChatRequestMessage[]; + + @doc(""" + A value that influences the probability of generated tokens appearing based on their cumulative + frequency in generated text. + Positive values will make tokens less likely to appear as their frequency increases and + decrease the likelihood of the model repeating the same statements verbatim. + """) + @maxValue(2.0) + @minValue(-2.0) + @projectedName("json", "frequency_penalty") + frequencyPenalty?: float32 = 0.0; + + @doc(""" + A value that influences the probability of generated tokens appearing based on their existing + presence in generated text. + Positive values will make tokens less likely to appear when they already exist and increase the + model's likelihood to output new topics. + """) + @maxValue(2.0) + @minValue(-2.0) + @projectedName("json", "presence_penalty") + presencePenalty?: float32 = 0.0; + + @doc(""" + The sampling temperature to use that controls the apparent creativity of generated completions. + Higher values will make output more random while lower values will make results more focused + and deterministic. + It is not recommended to modify temperature and top_p for the same completions request as the + interaction of these two settings is difficult to predict. + """) + @maxValue(1.0) + @minValue(0.0) + @projectedName("json", "temperature") + temperature?: float32 = 0.7; + + @doc(""" + An alternative to sampling with temperature called nucleus sampling. This value causes the + model to consider the results of tokens with the provided probability mass. As an example, a + value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be + considered. + It is not recommended to modify temperature and top_p for the same completions request as the + interaction of these two settings is difficult to predict. + """) + @maxValue(1.0) + @minValue(0.0) + @projectedName("json", "top_p") + topP?: float32 = 1.0; + + @doc("The maximum number of tokens to generate.") + @projectedName("json", "max_tokens") + @minValue(0.0) + maxTokens?: int32; + + @projectedName("json", "response_format") + @doc("An object specifying the format that the model must output. Used to enable JSON mode.") + responseFormat?: ChatCompletionsResponseFormat; + + @doc(""" + A collection of textual sequences that will end completions generation. + """) + @projectedName("json", "stop") + @minItems(1) + stop?: string[]; + + @doc(""" + A value indicating whether chat completions should be streamed for this request. + """) + @projectedName("json", "stream") + stream?: boolean = false; + + @doc("The available tool definitions that the chat completions request can use, including caller-defined functions.") + @minItems(1) + tools?: ChatCompletionsToolDefinition[]; + + @encodedName("application/json", "tool_choice") + @doc(""" + If specified, the model will configure which of the provided tools it can use for the chat completions response. + """) + toolChoice?: ChatCompletionsToolSelection; + + @doc(""" + If specified, the system will make a best effort to sample deterministically such that repeated requests with the + same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the + system_fingerprint response parameter to monitor changes in the backend." + """) + seed?: int64; +} + +@doc(""" +Representation of the response data from a chat completions request. +Completions support a wide variety of tasks and generate text that continues from or "completes" +provided prompt data. +""") +model ChatCompletions { + @doc("A unique identifier associated with this chat completions response.") + @projectedName("json", "id") + id: string; + + @doc("The response object type, which is always `chat.completion`.") + @projectedName("json", "object") + object: string; + + @doc(""" + The first timestamp associated with generation activity for this completions response, + represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. + """) + @projectedName("json", "created") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + created: utcDateTime; + + @doc("The model used for the chat completion.") + @projectedName("json", "model") + `model`: string; + + @doc(""" + The collection of completions choices associated with this completions response. + Generally, `n` choices are generated per provided prompt with a default value of 1. + Token limits and other settings may limit the number of choices generated. + """) + @projectedName("json", "choices") + @minItems(1) + choices: ChatChoice[]; + + @doc(""" + Usage information for tokens processed and generated as part of this completions operation. + """) + @projectedName("json", "usage") + usage: CompletionsUsage; +} + @doc(""" Representation of the token counts processed for a completions request. Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and @@ -86,102 +231,20 @@ model ChatCompletionsJsonResponseFormat extends ChatCompletionsResponseFormat { type: "json_object"; } -@doc(""" -The configuration information for a chat completions request. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") -model ChatCompletionsOptions { - @doc(""" - The collection of context messages associated with this chat completions request. - Typical usage begins with a chat message for the System role that provides instructions for - the behavior of the assistant, followed by alternating messages between the User and - Assistant roles. - """) - @projectedName("json", "messages") - messages: ChatRequestMessage[]; - - @doc("The maximum number of tokens to generate.") - @projectedName("json", "max_tokens") - maxTokens?: int32; - - @doc(""" - The sampling temperature to use that controls the apparent creativity of generated completions. - Higher values will make output more random while lower values will make results more focused - and deterministic. - It is not recommended to modify temperature and top_p for the same completions request as the - interaction of these two settings is difficult to predict. - """) - @projectedName("json", "temperature") - temperature?: float32; - - @doc(""" - An alternative to sampling with temperature called nucleus sampling. This value causes the - model to consider the results of tokens with the provided probability mass. As an example, a - value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be - considered. - It is not recommended to modify temperature and top_p for the same completions request as the - interaction of these two settings is difficult to predict. - """) - @projectedName("json", "top_p") - topP?: float32; - - @doc(""" - A collection of textual sequences that will end completions generation. - """) - @projectedName("json", "stop") - stop?: string[]; - - @doc(""" - A value that influences the probability of generated tokens appearing based on their existing - presence in generated text. - Positive values will make tokens less likely to appear when they already exist and increase the - model's likelihood to output new topics. - """) - @projectedName("json", "presence_penalty") - presencePenalty?: float32; - - @doc(""" - A value that influences the probability of generated tokens appearing based on their cumulative - frequency in generated text. - Positive values will make tokens less likely to appear as their frequency increases and - decrease the likelihood of the model repeating the same statements verbatim. - """) - @projectedName("json", "frequency_penalty") - frequencyPenalty?: float32; - - @doc(""" - A value indicating whether chat completions should be streamed for this request. - """) - @projectedName("json", "stream") - stream?: boolean; - - @doc(""" - If specified, the system will make a best effort to sample deterministically such that repeated requests with the - same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the - system_fingerprint response parameter to monitor changes in the backend." - """) - seed?: int64; - - @projectedName("json", "response_format") - @doc("An object specifying the format that the model must output. Used to enable JSON mode.") - responseFormat?: ChatCompletionsResponseFormat; -} - @doc(""" The representation of a single prompt completion as part of an overall chat completions request. Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated. """) model ChatChoice { - @doc("The chat message for a given chat completions prompt.") - @projectedName("json", "message") - message?: ChatResponseMessage; - @doc("The ordered index associated with this chat completions choice.") @projectedName("json", "index") index: int32; + @doc("The chat message for a given chat completions prompt.") + @projectedName("json", "message") + message: ChatResponseMessage; + #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" #suppress "@azure-tools/typespec-autorest/union-unsupported" "OpenAPI v2 support deferred" @doc("The reason that this chat completions choice completed its generated.") @@ -189,47 +252,6 @@ model ChatChoice { finishReason: CompletionsFinishReason | null; } -@doc(""" -Representation of the response data from a chat completions request. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") -model ChatCompletions { - @doc("A unique identifier associated with this chat completions response.") - @projectedName("json", "id") - id: string; - - @doc(""" - The first timestamp associated with generation activity for this completions response, - represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. - """) - @projectedName("json", "created") - @encode(DateTimeKnownEncoding.unixTimestamp, int32) - created: utcDateTime; - - @doc(""" - The collection of completions choices associated with this completions response. - Generally, `n` choices are generated per provided prompt with a default value of 1. - Token limits and other settings may limit the number of choices generated. - """) - @projectedName("json", "choices") - choices: ChatChoice[]; - - @doc(""" - Usage information for tokens processed and generated as part of this completions operation. - """) - @projectedName("json", "usage") - usage: CompletionsUsage; - - @doc("The response object type, which is always `chat.completion`.") - @projectedName("json", "object") - object: string; - - @doc("The model used for the chat completion.") - @projectedName("json", "model") - `model`: string; -} - @discriminator("role") @doc("An abstract representation of a chat message as provided in a request.") model ChatRequestMessage { @@ -277,6 +299,21 @@ model ChatRequestAssistantMessage extends ChatRequestMessage { name?: string; } +@doc("A request chat message representing requested output from a configured tool.") +model ChatRequestToolMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'tool' for tool messages.") + role: ChatRole.tool; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" + @doc("The content of the message.") + content: string | null; + + @encodedName("application/json", "tool_call_id") + @doc("The ID of the tool call resolved by the provided content.") + toolCallId: string; +} + + @doc("A representation of a chat message as received in a response.") model ChatResponseMessage { @doc("The chat role associated with the message.") @@ -285,4 +322,116 @@ model ChatResponseMessage { #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" @doc("The content of the message.") content: string | null; + + @encodedName("application/json", "tool_calls") + @doc(""" + The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat + completions request to resolve as configured. + """) + toolCalls?: ChatCompletionsToolCall[]; +} + +// tool_choice: "auto" | "none" | { "type": "function", "name": string } + +#suppress "@azure-tools/typespec-autorest/union-unsupported" "External API shape is defined in OpenAPI 3.0 as oneOf." +alias ChatCompletionsToolSelection = ChatCompletionsToolSelectionPreset | ChatCompletionsNamedToolSelection; + +@doc("Represents a generic policy for how a chat completions tool may be selected.") +union ChatCompletionsToolSelectionPreset { + string, + + @doc(""" + Specifies that the model may either use any of the tools provided in this chat completions request or + instead return a standard chat completions response as if no tools were provided. + """) + auto: "auto", + + @doc(""" + Specifies that the model should not respond with a tool call and should instead provide a standard chat + completions response. Response content may still be influenced by the provided tool definitions. + """) + none: "none", +} + +@discriminator("type") +@doc("An abstract representation of an explicit, named tool selection to use for a chat completions request.") +model ChatCompletionsNamedToolSelection { + @doc("The object type.") + type: string; +} + +@discriminator("type") +@doc("An abstract representation of a tool that can be used by the model to improve a chat completions response.") +model ChatCompletionsToolDefinition { + @doc("The object type.") + type: string; +} + +@doc(""" +The definition information for a chat completions function tool that can call a function in response to a tool call. +""") +model ChatCompletionsFunctionToolDefinition + extends ChatCompletionsToolDefinition { + @doc("The object name, which is always 'function'.") + type: "function"; + + @doc("The function definition details for the function tool.") + function: FunctionDefinition; +} + +@doc(""" +The definition of a caller-specified function that chat completions may invoke in response to matching user input. +""") +model FunctionDefinition { + @doc("The name of the function to be called.") + name: string; + + @doc(""" + A description of what the function does. The model will use this description when selecting the function and + interpreting its parameters. + """) + description?: string; + + #suppress "@azure-tools/typespec-azure-core/no-unknown" "External API shape takes an arbitrary json" + @doc("The parameters the function accepts, described as a JSON Schema object.") + parameters?: unknown; +} + +@discriminator("type") +@doc(""" +An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested +chat completion. +""") +model ChatCompletionsToolCall { + @doc("The object type.") + type: string; + + @doc("The ID of the tool call.") + id: string; +} + +@doc(""" +A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents +a function invocation needed for a subsequent chat completions request to resolve. +""") +model ChatCompletionsFunctionToolCall extends ChatCompletionsToolCall { + @doc("The type of tool call, in this case always 'function'.") + type: "function"; + + @doc("The details of the function invocation requested by the tool call.") + function: FunctionCall; +} + +@doc("The name and arguments of a function that should be called, as generated by the model.") +model FunctionCall { + @doc("The name of the function to call.") + name: string; + + @doc(""" + The arguments to call the function with, as generated by the model in JSON format. + Note that the model does not always generate valid JSON, and may hallucinate parameters + not defined by your function schema. Validate the arguments in your code before calling + your function. + """) + arguments: string; } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index ac1c0e30be71..6318da943bfd 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -9,43 +9,54 @@ "role": "ChatRequestMessage" } ], - "max_tokens": 25, - "temperature": 19, - "top_p": 5, + "frequency_penalty": -2, + "presence_penalty": -1, + "temperature": 0, + "top_p": 0, + "max_tokens": 0, + "response_format": { + "type": "ChatCompletionsResponseFormat" + }, "stop": [ - "rtavfjfyhnzl" + "zlkrxijvazqium" ], - "presence_penalty": 15, - "frequency_penalty": 19, "stream": true, - "seed": 19, - "response_format": { - "type": "ChatCompletionsResponseFormat" - } + "tools": [ + { + "type": "ChatCompletionsToolDefinition" + } + ], + "seed": 30 } }, "responses": { "200": { "body": { - "id": "sxmyscekvlsxqpsegdwnzyal", + "id": "vxckegxkfctjdqjitcawjna", + "object": "wepdkxpkuzhs", "created": 30, + "model": "ekoksbbgcjzskssaxefhmkrmnpfopm", "choices": [ { + "index": 30, "message": { "role": "system", - "content": "mdhccqpdhwbiohjsm" + "content": "bfeykwwialisszlizvbiu", + "tool_calls": [ + { + "type": "ChatCompletionsToolCall", + "id": "pxokpajzlccgcbaz" + } + ] }, - "index": 6, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 14, - "prompt_tokens": 3, - "total_tokens": 11 - }, - "object": "uuxdaqxswkk", - "model": "zaacxtgyugjfid" + "completion_tokens": 19, + "prompt_tokens": 29, + "total_tokens": 29 + } } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 74f26554c793..d126d5d3c435 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,25 @@ "responses": { "200": { "body": { - "id": "sxmyscekvlsxqpsegdwnzyal", + "id": "vxckegxkfctjdqjitcawjna", + "object": "wepdkxpkuzhs", "created": 30, + "model": "ekoksbbgcjzskssaxefhmkrmnpfopm", "choices": [ { - "index": 6, + "index": 30, + "message": { + "role": "system", + "content": "bfeykwwialisszlizvbiu" + }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 14, - "prompt_tokens": 3, - "total_tokens": 11 - }, - "object": "uuxdaqxswkk", - "model": "zaacxtgyugjfid" + "completion_tokens": 19, + "prompt_tokens": 29, + "total_tokens": 29 + } } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json index 2f883241fc11..786e0fd4ce70 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json @@ -135,15 +135,15 @@ "type": "object", "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { - "message": { - "$ref": "#/definitions/ChatResponseMessage", - "description": "The chat message for a given chat completions prompt." - }, "index": { "type": "integer", "format": "int32", "description": "The ordered index associated with this chat completions choice." }, + "message": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "The chat message for a given chat completions prompt." + }, "finish_reason": { "$ref": "#/definitions/CompletionsFinishReason", "description": "The reason that this chat completions choice completed its generated.", @@ -153,6 +153,7 @@ }, "required": [ "index", + "message", "finish_reason" ] }, @@ -164,14 +165,23 @@ "type": "string", "description": "A unique identifier associated with this chat completions response." }, + "object": { + "type": "string", + "description": "The response object type, which is always `chat.completion`." + }, "created": { "type": "integer", "format": "unixtime", "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." }, + "model": { + "type": "string", + "description": "The model used for the chat completion." + }, "choices": { "type": "array", "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "minItems": 1, "items": { "$ref": "#/definitions/ChatChoice" }, @@ -180,25 +190,55 @@ "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." - }, - "object": { - "type": "string", - "description": "The response object type, which is always `chat.completion`." - }, - "model": { - "type": "string", - "description": "The model used for the chat completion." } }, "required": [ "id", + "object", "created", + "model", "choices", - "usage", - "object", - "model" + "usage" ] }, + "ChatCompletionsFunctionToolCall": { + "type": "object", + "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\na function invocation needed for a subsequent chat completions request to resolve.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionCall", + "description": "The details of the function invocation requested by the tool call." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsToolCall" + } + ], + "x-ms-discriminator-value": "function" + }, + "ChatCompletionsFunctionToolDefinition": { + "type": "object", + "description": "The definition information for a chat completions function tool that can call a function in response to a tool call.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionDefinition", + "description": "The function definition details for the function tool." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsToolDefinition" + } + ], + "x-ms-discriminator-value": "function" + }, "ChatCompletionsJsonResponseFormat": { "type": "object", "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects.", @@ -209,6 +249,20 @@ ], "x-ms-discriminator-value": "json_object" }, + "ChatCompletionsNamedToolSelection": { + "type": "object", + "description": "An abstract representation of an explicit, named tool selection to use for a chat completions request.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, "ChatCompletionsOptions": { "type": "object", "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", @@ -216,60 +270,89 @@ "messages": { "type": "array", "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", + "minItems": 1, "items": { "$ref": "#/definitions/ChatRequestMessage" }, "x-ms-identifiers": [] }, - "max_tokens": { - "type": "integer", - "format": "int32", - "description": "The maximum number of tokens to generate.", - "x-ms-client-name": "maxTokens" + "frequency_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", + "default": 0, + "minimum": -2, + "maximum": 2, + "x-ms-client-name": "frequencyPenalty" + }, + "presence_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", + "default": 0, + "minimum": -2, + "maximum": 2, + "x-ms-client-name": "presencePenalty" }, "temperature": { "type": "number", "format": "float", - "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict." + "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "default": 0.7, + "minimum": 0, + "maximum": 1 }, "top_p": { "type": "number", "format": "float", "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "default": 1, + "minimum": 0, + "maximum": 1, "x-ms-client-name": "topP" }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tokens to generate.", + "minimum": 0, + "x-ms-client-name": "maxTokens" + }, + "response_format": { + "$ref": "#/definitions/ChatCompletionsResponseFormat", + "description": "An object specifying the format that the model must output. Used to enable JSON mode.", + "x-ms-client-name": "responseFormat" + }, "stop": { "type": "array", "description": "A collection of textual sequences that will end completions generation.", + "minItems": 1, "items": { "type": "string" } }, - "presence_penalty": { - "type": "number", - "format": "float", - "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", - "x-ms-client-name": "presencePenalty" - }, - "frequency_penalty": { - "type": "number", - "format": "float", - "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", - "x-ms-client-name": "frequencyPenalty" - }, "stream": { "type": "boolean", - "description": "A value indicating whether chat completions should be streamed for this request." + "description": "A value indicating whether chat completions should be streamed for this request.", + "default": false + }, + "tools": { + "type": "array", + "description": "The available tool definitions that the chat completions request can use, including caller-defined functions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ChatCompletionsToolDefinition" + }, + "x-ms-identifiers": [] + }, + "tool_choice": { + "description": "If specified, the model will configure which of the provided tools it can use for the chat completions response.", + "x-ms-client-name": "toolChoice" }, "seed": { "type": "integer", "format": "int64", "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the\nsystem_fingerprint response parameter to monitor changes in the backend.\"" - }, - "response_format": { - "$ref": "#/definitions/ChatCompletionsResponseFormat", - "description": "An object specifying the format that the model must output. Used to enable JSON mode.", - "x-ms-client-name": "responseFormat" } }, "required": [ @@ -300,6 +383,63 @@ ], "x-ms-discriminator-value": "text" }, + "ChatCompletionsToolCall": { + "type": "object", + "description": "An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested\nchat completion.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + } + }, + "discriminator": "type", + "required": [ + "type", + "id" + ] + }, + "ChatCompletionsToolDefinition": { + "type": "object", + "description": "An abstract representation of a tool that can be used by the model to improve a chat completions response.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatCompletionsToolSelectionPreset": { + "type": "string", + "description": "Represents a generic policy for how a chat completions tool may be selected.", + "enum": [ + "auto", + "none" + ], + "x-ms-enum": { + "name": "ChatCompletionsToolSelectionPreset", + "modelAsString": true, + "values": [ + { + "name": "auto", + "value": "auto", + "description": "Specifies that the model may either use any of the tools provided in this chat completions request or\ninstead return a standard chat completions response as if no tools were provided." + }, + { + "name": "none", + "value": "none", + "description": "Specifies that the model should not respond with a tool call and should instead provide a standard chat\ncompletions response. Response content may still be influenced by the provided tool definitions." + } + ] + } + }, "ChatRequestAssistantMessage": { "type": "object", "description": "A request chat message representing response or action from the assistant.", @@ -361,6 +501,32 @@ ], "x-ms-discriminator-value": "system" }, + "ChatRequestToolMessage": { + "type": "object", + "description": "A request chat message representing requested output from a configured tool.", + "properties": { + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call resolved by the provided content.", + "x-ms-client-name": "toolCallId" + } + }, + "required": [ + "content", + "tool_call_id" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "tool" + }, "ChatRequestUserMessage": { "type": "object", "description": "A request chat message representing user input to the assistant.", @@ -396,6 +562,14 @@ "type": "string", "description": "The content of the message.", "x-nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "items": { + "$ref": "#/definitions/ChatCompletionsToolCall" + }, + "x-ms-client-name": "toolCalls" } }, "required": [ @@ -498,6 +672,44 @@ "total_tokens" ] }, + "FunctionCall": { + "type": "object", + "description": "The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format.\nNote that the model does not always generate valid JSON, and may hallucinate parameters\nnot defined by your function schema. Validate the arguments in your code before calling\nyour function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "FunctionDefinition": { + "type": "object", + "description": "The definition of a caller-specified function that chat completions may invoke in response to matching user input.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called." + }, + "description": { + "type": "string", + "description": "A description of what the function does. The model will use this description when selecting the function and\ninterpreting its parameters." + }, + "parameters": { + "description": "The parameters the function accepts, described as a JSON Schema object." + } + }, + "required": [ + "name" + ] + }, "Versions": { "type": "string", "description": "The ModelInference service versions.", From a5b5fe9e6c1451c8f33cbcc52291204ed62e6a26 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 28 Mar 2024 16:32:25 -0700 Subject: [PATCH 027/343] More changes --- .../2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json | 2 +- .../2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json | 2 +- specification/ai/ModelInference/models/chat_completions.tsp | 1 - specification/ai/ModelInference/tspconfig.yaml | 2 +- .../examples/GetChatCompletions_MaximumSet_Gen.json | 2 +- .../examples/GetChatCompletions_MinimumSet_Gen.json | 2 +- .../ModelInference/preview/2024-04-01-preview/openapi.json | 4 ++-- 7 files changed, 7 insertions(+), 8 deletions(-) diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 6318da943bfd..efab36e44fea 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions", + "title": "[Maximum Set] Creates a completion for the provided prompt, parameters and chosen model.", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index d126d5d3c435..7b4bfe8433a3 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions", + "title": "[Minimum Set] Creates a completion for the provided prompt, parameters and chosen model.", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", diff --git a/specification/ai/ModelInference/models/chat_completions.tsp b/specification/ai/ModelInference/models/chat_completions.tsp index 00a9c6c1843f..1f289d29a25e 100644 --- a/specification/ai/ModelInference/models/chat_completions.tsp +++ b/specification/ai/ModelInference/models/chat_completions.tsp @@ -313,7 +313,6 @@ model ChatRequestToolMessage extends ChatRequestMessage { toolCallId: string; } - @doc("A representation of a chat message as received in a response.") model ChatResponseMessage { @doc("The chat role associated with the message.") diff --git a/specification/ai/ModelInference/tspconfig.yaml b/specification/ai/ModelInference/tspconfig.yaml index 94303e024610..8456fbe5d171 100644 --- a/specification/ai/ModelInference/tspconfig.yaml +++ b/specification/ai/ModelInference/tspconfig.yaml @@ -1,4 +1,4 @@ -parameters: +parameters: "service-dir": default: "sdk/ai" "dependencies": diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 6318da943bfd..efab36e44fea 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions", + "title": "[Maximum Set] Creates a completion for the provided prompt, parameters and chosen model.", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index d126d5d3c435..7b4bfe8433a3 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions", + "title": "[Minimum Set] Creates a completion for the provided prompt, parameters and chosen model.", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json index 786e0fd4ce70..dc439a384896 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json @@ -59,10 +59,10 @@ } }, "x-ms-examples": { - "GetChatCompletions_MaximumSet_Gen": { + "[Maximum Set] Creates a completion for the provided prompt, parameters and chosen model.": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "GetChatCompletions_MinimumSet_Gen": { + "[Minimum Set] Creates a completion for the provided prompt, parameters and chosen model.": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } From 684e6429d40f2c8e934ae3616cf7bf1d4460d3b3 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 29 Mar 2024 15:22:42 -0700 Subject: [PATCH 028/343] Add embeddings. Use ModelClient folders --- specification/ai/ModelClient/client.tsp | 5 + .../GetChatCompletions_MaximumSet_Gen.json | 28 +- .../GetChatCompletions_MinimumSet_Gen.json | 20 +- .../GetEmbeddings_MaximumSet_Gen.json | 32 +++ .../GetEmbeddings_MinimumSet_Gen.json | 30 ++ .../{ModelInference => ModelClient}/main.tsp | 11 +- .../models/chat_completions.tsp | 11 +- .../ai/ModelClient/models/embeddings.tsp | 90 ++++++ .../routes.tsp} | 17 +- .../tspconfig.yaml | 0 specification/ai/ModelInference/client.tsp | 16 -- .../GetChatCompletions_MaximumSet_Gen.json | 28 +- .../GetChatCompletions_MinimumSet_Gen.json | 20 +- .../GetEmbeddings_MaximumSet_Gen.json | 32 +++ .../GetEmbeddings_MinimumSet_Gen.json | 30 ++ .../preview/2024-04-01-preview/openapi.json | 263 ++++++++++++++++-- .../{ModelInference => ModelClient}/readme.md | 4 +- 17 files changed, 537 insertions(+), 100 deletions(-) create mode 100644 specification/ai/ModelClient/client.tsp rename specification/ai/{ModelInference => ModelClient}/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json (63%) rename specification/ai/{data-plane/ModelInference/preview/2024-04-01-preview/examples => ModelClient/examples/2024-04-01-preview}/GetChatCompletions_MinimumSet_Gen.json (53%) create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json rename specification/ai/{ModelInference => ModelClient}/main.tsp (67%) rename specification/ai/{ModelInference => ModelClient}/models/chat_completions.tsp (98%) create mode 100644 specification/ai/ModelClient/models/embeddings.tsp rename specification/ai/{ModelInference/routes/completions.tsp => ModelClient/routes.tsp} (63%) rename specification/ai/{ModelInference => ModelClient}/tspconfig.yaml (100%) delete mode 100644 specification/ai/ModelInference/client.tsp rename specification/ai/data-plane/{ModelInference => ModelClient}/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json (63%) rename specification/ai/{ModelInference/examples/2024-04-01-preview => data-plane/ModelClient/preview/2024-04-01-preview/examples}/GetChatCompletions_MinimumSet_Gen.json (53%) create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json rename specification/ai/data-plane/{ModelInference => ModelClient}/preview/2024-04-01-preview/openapi.json (76%) rename specification/ai/data-plane/{ModelInference => ModelClient}/readme.md (94%) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp new file mode 100644 index 000000000000..9cfaeccaaa88 --- /dev/null +++ b/specification/ai/ModelClient/client.tsp @@ -0,0 +1,5 @@ +import "@azure-tools/typespec-client-generator-core"; + +import "./main.tsp"; + +using Azure.ClientGenerator.Core; diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json similarity index 63% rename from specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json rename to specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index efab36e44fea..a1c6e588c875 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "[Maximum Set] Creates a completion for the provided prompt, parameters and chosen model.", + "title": "maximum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", @@ -10,7 +10,7 @@ } ], "frequency_penalty": -2, - "presence_penalty": -1, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -18,7 +18,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "zlkrxijvazqium" + "auwxmqcyvviefoitlskgzdnl" ], "stream": true, "tools": [ @@ -26,26 +26,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 30 + "seed": 10 } }, "responses": { "200": { "body": { - "id": "vxckegxkfctjdqjitcawjna", - "object": "wepdkxpkuzhs", - "created": 30, - "model": "ekoksbbgcjzskssaxefhmkrmnpfopm", + "id": "wrelxhuatyzejdocdoduxhxifgbkp", + "object": "revmvdu", + "created": 4, + "model": "ajd", "choices": [ { - "index": 30, + "index": 29, "message": { "role": "system", - "content": "bfeykwwialisszlizvbiu", + "content": "wskquccyzztkt", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "pxokpajzlccgcbaz" + "id": "xvzwwn" } ] }, @@ -53,9 +53,9 @@ } ], "usage": { - "completion_tokens": 19, - "prompt_tokens": 29, - "total_tokens": 29 + "completion_tokens": 20, + "prompt_tokens": 17, + "total_tokens": 5 } } } diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json similarity index 53% rename from specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json rename to specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 7b4bfe8433a3..3ca487517bb4 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "[Minimum Set] Creates a completion for the provided prompt, parameters and chosen model.", + "title": "minimum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "vxckegxkfctjdqjitcawjna", - "object": "wepdkxpkuzhs", - "created": 30, - "model": "ekoksbbgcjzskssaxefhmkrmnpfopm", + "id": "wrelxhuatyzejdocdoduxhxifgbkp", + "object": "revmvdu", + "created": 4, + "model": "ajd", "choices": [ { - "index": 30, + "index": 29, "message": { "role": "system", - "content": "bfeykwwialisszlizvbiu" + "content": "wskquccyzztkt" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 19, - "prompt_tokens": 29, - "total_tokens": 29 + "completion_tokens": 20, + "prompt_tokens": 17, + "total_tokens": 5 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json new file mode 100644 index 000000000000..e95fb5221525 --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "maximum set embeddings", + "operationId": "GetEmbeddings", + "parameters": { + "api-version": "2024-04-01-preview", + "embeddingOptions": { + "input": [ + "wdazexgkffqeyzkhnpsjssbuwdf" + ], + "encoding_format": "float", + "input_type": "text" + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "embedding": [ + 21 + ], + "index": 1 + } + ], + "usage": { + "prompt_tokens": 22, + "total_tokens": 6 + } + } + } + } +} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json new file mode 100644 index 000000000000..42c04ebdc6e5 --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "title": "minimum set embeddings", + "operationId": "GetEmbeddings", + "parameters": { + "api-version": "2024-04-01-preview", + "embeddingOptions": { + "input": [ + "wdazexgkffqeyzkhnpsjssbuwdf" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "embedding": [ + 21 + ], + "index": 1 + } + ], + "usage": { + "prompt_tokens": 22, + "total_tokens": 6 + } + } + } + } +} diff --git a/specification/ai/ModelInference/main.tsp b/specification/ai/ModelClient/main.tsp similarity index 67% rename from specification/ai/ModelInference/main.tsp rename to specification/ai/ModelClient/main.tsp index fa0307e2a8e1..cec7bc48489f 100644 --- a/specification/ai/ModelInference/main.tsp +++ b/specification/ai/ModelClient/main.tsp @@ -1,8 +1,7 @@ import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; - -import "./routes/completions.tsp"; +import "./routes.tsp"; using TypeSpec.Http; using TypeSpec.Rest; @@ -14,12 +13,12 @@ using Azure.Core; @service({ title: "AI Model Inference", }) -@versioned(ModelInference.Versions) -namespace ModelInference; +@versioned(ModelClient.Versions) +namespace ModelClient; -@doc("The ModelInference service versions.") +@doc("The ModelClient service versions.") enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_2) - @doc("The 2024-04-01-preview version of the ModelInference service.") + @doc("The 2024-04-01-preview version of the ModelClient service.") v2024_04_01_Preview: "2024-04-01-preview", } diff --git a/specification/ai/ModelInference/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp similarity index 98% rename from specification/ai/ModelInference/models/chat_completions.tsp rename to specification/ai/ModelClient/models/chat_completions.tsp index 1f289d29a25e..fd773f5ca6a1 100644 --- a/specification/ai/ModelInference/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -6,7 +6,7 @@ using TypeSpec.Rest; using TypeSpec.Http; using TypeSpec.Versioning; -namespace ModelInference; +namespace ModelClient; @doc(""" The configuration information for a chat completions request. @@ -269,9 +269,6 @@ model ChatRequestSystemMessage extends ChatRequestMessage { @doc("The contents of the system message.") content: string; - - @doc("An optional name for the participant.") - name?: string; } @doc("A request chat message representing user input to the assistant.") @@ -281,9 +278,6 @@ model ChatRequestUserMessage extends ChatRequestMessage { @doc("The contents of the user message, with available input types varying by selected model.") content: string; - - @doc("An optional name for the participant.") - name?: string; } @doc("A request chat message representing response or action from the assistant.") @@ -294,9 +288,6 @@ model ChatRequestAssistantMessage extends ChatRequestMessage { #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" @doc("The content of the message.") content: string | null; - - @doc("An optional name for the participant.") - name?: string; } @doc("A request chat message representing requested output from a configured tool.") diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp new file mode 100644 index 000000000000..3392435ca286 --- /dev/null +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -0,0 +1,90 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace ModelClient; + +@doc(""" +The configuration information for an embeddings request. +Embeddings measure the relatedness of text strings and are commonly used for search, clustering, +recommendations, and other similar scenarios. +""") +model EmbeddingsOptions { + @doc(""" + Input texts to get embeddings for, encoded as a an array of strings. + Each input must not exceed 2048 tokens in length. + + Unless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space, + as we have observed inferior results when newlines are present. + """) + input: string[]; + + @encodedName("application/json", "encoding_format") + @doc("The response encoding format to use for embedding data.") + encodingFormat?: EmbeddingEncodingFormat = EmbeddingEncodingFormat.float; + + @doc("Specifies the input type to use for embedding search.") + @encodedName("application/json", "input_type") + inputType?: EmbeddingInputType = EmbeddingInputType.text; +} + +@doc(""" +Representation of the response data from an embeddings request. +Embeddings measure the relatedness of text strings and are commonly used for search, clustering, +recommendations, and other similar scenarios. +""") +model Embeddings { + @doc("Embedding values for the prompts submitted in the request.") + data: EmbeddingItem[]; + + @doc("Usage counts for tokens input using the embeddings API.") + usage: EmbeddingsUsage; +} + +@doc("Represents the available formats for embeddings data on responses.") +enum EmbeddingEncodingFormat { + @doc("Specifies that responses should provide arrays of floats for each embedding.") + float: "float", + + @doc("Specifies that responses should provide a base64-encoded string for each embedding.") + base64: "base64", +} + +@doc("Represents the input types used for embedding search.") +enum EmbeddingInputType { + @doc("fill me.") + text: "text", + + @doc("fill me.") + query: "query", + + @doc("fill me.") + document: "document", +} + +@doc("Representation of a single embeddings relatedness comparison.") +model EmbeddingItem { + @doc(""" + List of embeddings value for the input prompt. These represent a measurement of the + vector-based relatedness of the provided input. + """) + embedding: float32[]; + + @doc("Index of the prompt to which the EmbeddingItem corresponds.") + index: int32; +} + +@doc("Measurement of the amount of tokens used in this request and response.") +model EmbeddingsUsage { + @doc("Number of tokens sent in the original request.") + @encodedName("application/json", "prompt_tokens") + promptTokens: int32; + + @doc("Total number of tokens transacted in this request/response.") + @encodedName("application/json", "total_tokens") + totalTokens: int32; +} diff --git a/specification/ai/ModelInference/routes/completions.tsp b/specification/ai/ModelClient/routes.tsp similarity index 63% rename from specification/ai/ModelInference/routes/completions.tsp rename to specification/ai/ModelClient/routes.tsp index 576d72dcb976..af43bfdf70a9 100644 --- a/specification/ai/ModelInference/routes/completions.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -3,7 +3,8 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/versioning"; -import "../models/chat_completions.tsp"; +import "./models/chat_completions.tsp"; +import "./models/embeddings.tsp"; using TypeSpec.Rest; using TypeSpec.Http; @@ -11,7 +12,7 @@ using TypeSpec.Versioning; using Azure.Core; -namespace ModelInference; +namespace ModelClient; @doc(""" Gets chat completions for the provided chat messages. @@ -28,3 +29,15 @@ op getChatCompletions is Azure.Core.RpcOperation< }, ChatCompletions >; + +@doc("Return the embeddings for a given prompt.") +@actionSeparator("/") +@route("v1/embeddings") +op getEmbeddings is Azure.Core.RpcOperation< + { + @doc("The JSON payload containing embedding options.") + @body + embeddingOptions: EmbeddingsOptions; + }, + Embeddings +>; diff --git a/specification/ai/ModelInference/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml similarity index 100% rename from specification/ai/ModelInference/tspconfig.yaml rename to specification/ai/ModelClient/tspconfig.yaml diff --git a/specification/ai/ModelInference/client.tsp b/specification/ai/ModelInference/client.tsp deleted file mode 100644 index 74044c108993..000000000000 --- a/specification/ai/ModelInference/client.tsp +++ /dev/null @@ -1,16 +0,0 @@ -import "@azure-tools/typespec-client-generator-core"; - -import "./main.tsp"; - -using Azure.ClientGenerator.Core; - -@TypeSpec.Versioning.useDependency(ModelInference.Versions.v2024_04_01_Preview) -namespace Client; - -@client({ - name: "ModelClient", - service: ModelInference, -}) -interface ModelClient { - getChatCompletions is ModelInference.getChatCompletions; -} diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json similarity index 63% rename from specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json rename to specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index efab36e44fea..a1c6e588c875 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "[Maximum Set] Creates a completion for the provided prompt, parameters and chosen model.", + "title": "maximum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", @@ -10,7 +10,7 @@ } ], "frequency_penalty": -2, - "presence_penalty": -1, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -18,7 +18,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "zlkrxijvazqium" + "auwxmqcyvviefoitlskgzdnl" ], "stream": true, "tools": [ @@ -26,26 +26,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 30 + "seed": 10 } }, "responses": { "200": { "body": { - "id": "vxckegxkfctjdqjitcawjna", - "object": "wepdkxpkuzhs", - "created": 30, - "model": "ekoksbbgcjzskssaxefhmkrmnpfopm", + "id": "wrelxhuatyzejdocdoduxhxifgbkp", + "object": "revmvdu", + "created": 4, + "model": "ajd", "choices": [ { - "index": 30, + "index": 29, "message": { "role": "system", - "content": "bfeykwwialisszlizvbiu", + "content": "wskquccyzztkt", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "pxokpajzlccgcbaz" + "id": "xvzwwn" } ] }, @@ -53,9 +53,9 @@ } ], "usage": { - "completion_tokens": 19, - "prompt_tokens": 29, - "total_tokens": 29 + "completion_tokens": 20, + "prompt_tokens": 17, + "total_tokens": 5 } } } diff --git a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json similarity index 53% rename from specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json rename to specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 7b4bfe8433a3..3ca487517bb4 100644 --- a/specification/ai/ModelInference/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "[Minimum Set] Creates a completion for the provided prompt, parameters and chosen model.", + "title": "minimum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "vxckegxkfctjdqjitcawjna", - "object": "wepdkxpkuzhs", - "created": 30, - "model": "ekoksbbgcjzskssaxefhmkrmnpfopm", + "id": "wrelxhuatyzejdocdoduxhxifgbkp", + "object": "revmvdu", + "created": 4, + "model": "ajd", "choices": [ { - "index": 30, + "index": 29, "message": { "role": "system", - "content": "bfeykwwialisszlizvbiu" + "content": "wskquccyzztkt" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 19, - "prompt_tokens": 29, - "total_tokens": 29 + "completion_tokens": 20, + "prompt_tokens": 17, + "total_tokens": 5 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json new file mode 100644 index 000000000000..e95fb5221525 --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "maximum set embeddings", + "operationId": "GetEmbeddings", + "parameters": { + "api-version": "2024-04-01-preview", + "embeddingOptions": { + "input": [ + "wdazexgkffqeyzkhnpsjssbuwdf" + ], + "encoding_format": "float", + "input_type": "text" + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "embedding": [ + 21 + ], + "index": 1 + } + ], + "usage": { + "prompt_tokens": 22, + "total_tokens": 6 + } + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json new file mode 100644 index 000000000000..42c04ebdc6e5 --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "title": "minimum set embeddings", + "operationId": "GetEmbeddings", + "parameters": { + "api-version": "2024-04-01-preview", + "embeddingOptions": { + "input": [ + "wdazexgkffqeyzkhnpsjssbuwdf" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "embedding": [ + 21 + ], + "index": 1 + } + ], + "usage": { + "prompt_tokens": 22, + "total_tokens": 6 + } + } + } + } +} diff --git a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json similarity index 76% rename from specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json rename to specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index dc439a384896..fb15ce205344 100644 --- a/specification/ai/data-plane/ModelInference/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -59,14 +59,62 @@ } }, "x-ms-examples": { - "[Maximum Set] Creates a completion for the provided prompt, parameters and chosen model.": { + "maximum set chat completion": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "[Minimum Set] Creates a completion for the provided prompt, parameters and chosen model.": { + "minimum set chat completion": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } } + }, + "/v1/embeddings": { + "post": { + "operationId": "GetEmbeddings", + "description": "Return the embeddings for a given prompt.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "embeddingOptions", + "in": "body", + "description": "The JSON payload containing embedding options.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Embeddings" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "maximum set embeddings": { + "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" + }, + "minimum set embeddings": { + "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" + } + } + } } }, "definitions": { @@ -448,10 +496,6 @@ "type": "string", "description": "The content of the message.", "x-nullable": true - }, - "name": { - "type": "string", - "description": "An optional name for the participant." } }, "required": [ @@ -485,10 +529,6 @@ "content": { "type": "string", "description": "The contents of the system message." - }, - "name": { - "type": "string", - "description": "An optional name for the participant." } }, "required": [ @@ -534,10 +574,6 @@ "content": { "type": "string", "description": "The contents of the user message, with available input types varying by selected model." - }, - "name": { - "type": "string", - "description": "An optional name for the participant." } }, "required": [ @@ -672,6 +708,201 @@ "total_tokens" ] }, + "EmbeddingEncodingFormat": { + "type": "string", + "description": "Represents the available formats for embeddings data on responses.", + "enum": [ + "float", + "base64" + ], + "x-ms-enum": { + "name": "EmbeddingEncodingFormat", + "modelAsString": true, + "values": [ + { + "name": "float", + "value": "float", + "description": "Specifies that responses should provide arrays of floats for each embedding." + }, + { + "name": "base64", + "value": "base64", + "description": "Specifies that responses should provide a base64-encoded string for each embedding." + } + ] + } + }, + "EmbeddingInputType": { + "type": "string", + "description": "Represents the input types used for embedding search.", + "enum": [ + "text", + "query", + "document" + ], + "x-ms-enum": { + "name": "EmbeddingInputType", + "modelAsString": true, + "values": [ + { + "name": "text", + "value": "text", + "description": "fill me." + }, + { + "name": "query", + "value": "query", + "description": "fill me." + }, + { + "name": "document", + "value": "document", + "description": "fill me." + } + ] + } + }, + "EmbeddingItem": { + "type": "object", + "description": "Representation of a single embeddings relatedness comparison.", + "properties": { + "embedding": { + "type": "array", + "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", + "items": { + "type": "number", + "format": "float" + } + }, + "index": { + "type": "integer", + "format": "int32", + "description": "Index of the prompt to which the EmbeddingItem corresponds." + } + }, + "required": [ + "embedding", + "index" + ] + }, + "Embeddings": { + "type": "object", + "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "properties": { + "data": { + "type": "array", + "description": "Embedding values for the prompts submitted in the request.", + "items": { + "$ref": "#/definitions/EmbeddingItem" + }, + "x-ms-identifiers": [] + }, + "usage": { + "$ref": "#/definitions/EmbeddingsUsage", + "description": "Usage counts for tokens input using the embeddings API." + } + }, + "required": [ + "data", + "usage" + ] + }, + "EmbeddingsOptions": { + "type": "object", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "properties": { + "input": { + "type": "array", + "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", + "items": { + "type": "string" + } + }, + "encoding_format": { + "type": "string", + "description": "The response encoding format to use for embedding data.", + "default": "float", + "enum": [ + "float", + "base64" + ], + "x-ms-enum": { + "name": "EmbeddingEncodingFormat", + "modelAsString": true, + "values": [ + { + "name": "float", + "value": "float", + "description": "Specifies that responses should provide arrays of floats for each embedding." + }, + { + "name": "base64", + "value": "base64", + "description": "Specifies that responses should provide a base64-encoded string for each embedding." + } + ] + }, + "x-ms-client-name": "encodingFormat" + }, + "input_type": { + "type": "string", + "description": "Specifies the input type to use for embedding search.", + "default": "text", + "enum": [ + "text", + "query", + "document" + ], + "x-ms-enum": { + "name": "EmbeddingInputType", + "modelAsString": true, + "values": [ + { + "name": "text", + "value": "text", + "description": "fill me." + }, + { + "name": "query", + "value": "query", + "description": "fill me." + }, + { + "name": "document", + "value": "document", + "description": "fill me." + } + ] + }, + "x-ms-client-name": "inputType" + } + }, + "required": [ + "input" + ] + }, + "EmbeddingsUsage": { + "type": "object", + "description": "Measurement of the amount of tokens used in this request and response.", + "properties": { + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "Number of tokens sent in the original request.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "Total number of tokens transacted in this request/response.", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + }, "FunctionCall": { "type": "object", "description": "The name and arguments of a function that should be called, as generated by the model.", @@ -712,7 +943,7 @@ }, "Versions": { "type": "string", - "description": "The ModelInference service versions.", + "description": "The ModelClient service versions.", "enum": [ "2024-04-01-preview" ], @@ -723,7 +954,7 @@ { "name": "v2024_04_01_Preview", "value": "2024-04-01-preview", - "description": "The 2024-04-01-preview version of the ModelInference service." + "description": "The 2024-04-01-preview version of the ModelClient service." } ] } diff --git a/specification/ai/data-plane/ModelInference/readme.md b/specification/ai/data-plane/ModelClient/readme.md similarity index 94% rename from specification/ai/data-plane/ModelInference/readme.md rename to specification/ai/data-plane/ModelClient/readme.md index 5d8e93f6b1ea..8b0733d3bf71 100644 --- a/specification/ai/data-plane/ModelInference/readme.md +++ b/specification/ai/data-plane/ModelClient/readme.md @@ -1,8 +1,8 @@ -# Azure AI Model Inference +# Azure AI Model Client > see https://aka.ms/autorest -This is the AutoRest configuration file for Azure AI Model Inference. +This is the AutoRest configuration file for Azure AI Model Client. ## Getting Started From 7f2f7cc612c8b5950b600e14a37e99db491ce15d Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 29 Mar 2024 17:54:58 -0700 Subject: [PATCH 029/343] Update embeddings --- .../GetChatCompletions_MaximumSet_Gen.json | 26 ++-- .../GetChatCompletions_MinimumSet_Gen.json | 18 +-- .../GetEmbeddings_MaximumSet_Gen.json | 19 ++- .../GetEmbeddings_MinimumSet_Gen.json | 18 ++- .../ai/ModelClient/models/embeddings.tsp | 37 ++--- specification/ai/ModelClient/routes.tsp | 4 +- .../GetChatCompletions_MaximumSet_Gen.json | 26 ++-- .../GetChatCompletions_MinimumSet_Gen.json | 18 +-- .../GetEmbeddings_MaximumSet_Gen.json | 19 ++- .../GetEmbeddings_MinimumSet_Gen.json | 18 ++- .../preview/2024-04-01-preview/openapi.json | 142 +++++++----------- 11 files changed, 161 insertions(+), 184 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index a1c6e588c875..275147dc8c02 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ } ], "frequency_penalty": -2, - "presence_penalty": -2, + "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -18,7 +18,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "auwxmqcyvviefoitlskgzdnl" + "ejcoecwrdd" ], "stream": true, "tools": [ @@ -26,26 +26,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 10 + "seed": 27 } }, "responses": { "200": { "body": { - "id": "wrelxhuatyzejdocdoduxhxifgbkp", - "object": "revmvdu", - "created": 4, - "model": "ajd", + "id": "fcfgwlzaojobobqpwtasrxyawcu", + "object": "ifryfrkdwwlmysdbog", + "created": 2, + "model": "xutlvnjqgpqhhdxxroqvyqdfilxcqu", "choices": [ { - "index": 29, + "index": 11, "message": { "role": "system", - "content": "wskquccyzztkt", + "content": "zpyae", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "xvzwwn" + "id": "hmfzwkufaksourcpbbnxah" } ] }, @@ -53,9 +53,9 @@ } ], "usage": { - "completion_tokens": 20, - "prompt_tokens": 17, - "total_tokens": 5 + "completion_tokens": 26, + "prompt_tokens": 7, + "total_tokens": 11 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 3ca487517bb4..ba01645f4c01 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "wrelxhuatyzejdocdoduxhxifgbkp", - "object": "revmvdu", - "created": 4, - "model": "ajd", + "id": "fcfgwlzaojobobqpwtasrxyawcu", + "object": "ifryfrkdwwlmysdbog", + "created": 2, + "model": "xutlvnjqgpqhhdxxroqvyqdfilxcqu", "choices": [ { - "index": 29, + "index": 11, "message": { "role": "system", - "content": "wskquccyzztkt" + "content": "zpyae" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 20, - "prompt_tokens": 17, - "total_tokens": 5 + "completion_tokens": 26, + "prompt_tokens": 7, + "total_tokens": 11 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index e95fb5221525..62ed61a3ee4c 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,29 +3,32 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "embeddingOptions": { + "embeddingsOptions": { "input": [ - "wdazexgkffqeyzkhnpsjssbuwdf" + "prhoocdgrtnqsqdipt" ], - "encoding_format": "float", "input_type": "text" } }, "responses": { "200": { "body": { + "id": "bghgrsnxwdfyeaerb", "data": [ { "embedding": [ - 21 + 10 ], - "index": 1 + "index": 18, + "object": "nxpemodezjrugmzpxtbflkfyjkstl" } ], "usage": { - "prompt_tokens": 22, - "total_tokens": 6 - } + "prompt_tokens": 25, + "total_tokens": 5 + }, + "object": "pvjtpdgpbzbwlberghnwrnaakcwop", + "model": "xkxapmuebtvkutuxklghh" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 42c04ebdc6e5..52ce31aac84c 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -3,27 +3,31 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "embeddingOptions": { + "embeddingsOptions": { "input": [ - "wdazexgkffqeyzkhnpsjssbuwdf" + "prhoocdgrtnqsqdipt" ] } }, "responses": { "200": { "body": { + "id": "bghgrsnxwdfyeaerb", "data": [ { "embedding": [ - 21 + 10 ], - "index": 1 + "index": 18, + "object": "nxpemodezjrugmzpxtbflkfyjkstl" } ], "usage": { - "prompt_tokens": 22, - "total_tokens": 6 - } + "prompt_tokens": 25, + "total_tokens": 5 + }, + "object": "pvjtpdgpbzbwlberghnwrnaakcwop", + "model": "xkxapmuebtvkutuxklghh" } } } diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index 3392435ca286..fcc4ad08aeb5 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -14,19 +14,9 @@ Embeddings measure the relatedness of text strings and are commonly used for sea recommendations, and other similar scenarios. """) model EmbeddingsOptions { - @doc(""" - Input texts to get embeddings for, encoded as a an array of strings. - Each input must not exceed 2048 tokens in length. - - Unless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space, - as we have observed inferior results when newlines are present. - """) + @doc("Input texts to get embeddings for, encoded as a an array of strings.") input: string[]; - @encodedName("application/json", "encoding_format") - @doc("The response encoding format to use for embedding data.") - encodingFormat?: EmbeddingEncodingFormat = EmbeddingEncodingFormat.float; - @doc("Specifies the input type to use for embedding search.") @encodedName("application/json", "input_type") inputType?: EmbeddingInputType = EmbeddingInputType.text; @@ -37,32 +27,32 @@ Representation of the response data from an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios. """) -model Embeddings { +model EmbeddingsResult { + @doc("Unique identifier for the embeddings result.") + id: string; + @doc("Embedding values for the prompts submitted in the request.") data: EmbeddingItem[]; @doc("Usage counts for tokens input using the embeddings API.") usage: EmbeddingsUsage; -} -@doc("Represents the available formats for embeddings data on responses.") -enum EmbeddingEncodingFormat { - @doc("Specifies that responses should provide arrays of floats for each embedding.") - float: "float", + @doc("The object type of the embeddings result. Will always be `list`.") + object: string; - @doc("Specifies that responses should provide a base64-encoded string for each embedding.") - base64: "base64", + @doc("The model ID used to generate this result.") + `model`: string; } @doc("Represents the input types used for embedding search.") enum EmbeddingInputType { - @doc("fill me.") + @doc("to do") text: "text", - @doc("fill me.") + @doc("to do") query: "query", - @doc("fill me.") + @doc("to do") document: "document", } @@ -76,6 +66,9 @@ model EmbeddingItem { @doc("Index of the prompt to which the EmbeddingItem corresponds.") index: int32; + + @doc("The object type of this embeddings item. Will always be `embedding`.") + object: string } @doc("Measurement of the amount of tokens used in this request and response.") diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index af43bfdf70a9..5d4ddf8bfc79 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -37,7 +37,7 @@ op getEmbeddings is Azure.Core.RpcOperation< { @doc("The JSON payload containing embedding options.") @body - embeddingOptions: EmbeddingsOptions; + embeddingsOptions: EmbeddingsOptions; }, - Embeddings + EmbeddingsResult >; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index a1c6e588c875..275147dc8c02 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ } ], "frequency_penalty": -2, - "presence_penalty": -2, + "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -18,7 +18,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "auwxmqcyvviefoitlskgzdnl" + "ejcoecwrdd" ], "stream": true, "tools": [ @@ -26,26 +26,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 10 + "seed": 27 } }, "responses": { "200": { "body": { - "id": "wrelxhuatyzejdocdoduxhxifgbkp", - "object": "revmvdu", - "created": 4, - "model": "ajd", + "id": "fcfgwlzaojobobqpwtasrxyawcu", + "object": "ifryfrkdwwlmysdbog", + "created": 2, + "model": "xutlvnjqgpqhhdxxroqvyqdfilxcqu", "choices": [ { - "index": 29, + "index": 11, "message": { "role": "system", - "content": "wskquccyzztkt", + "content": "zpyae", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "xvzwwn" + "id": "hmfzwkufaksourcpbbnxah" } ] }, @@ -53,9 +53,9 @@ } ], "usage": { - "completion_tokens": 20, - "prompt_tokens": 17, - "total_tokens": 5 + "completion_tokens": 26, + "prompt_tokens": 7, + "total_tokens": 11 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 3ca487517bb4..ba01645f4c01 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "wrelxhuatyzejdocdoduxhxifgbkp", - "object": "revmvdu", - "created": 4, - "model": "ajd", + "id": "fcfgwlzaojobobqpwtasrxyawcu", + "object": "ifryfrkdwwlmysdbog", + "created": 2, + "model": "xutlvnjqgpqhhdxxroqvyqdfilxcqu", "choices": [ { - "index": 29, + "index": 11, "message": { "role": "system", - "content": "wskquccyzztkt" + "content": "zpyae" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 20, - "prompt_tokens": 17, - "total_tokens": 5 + "completion_tokens": 26, + "prompt_tokens": 7, + "total_tokens": 11 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index e95fb5221525..62ed61a3ee4c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,29 +3,32 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "embeddingOptions": { + "embeddingsOptions": { "input": [ - "wdazexgkffqeyzkhnpsjssbuwdf" + "prhoocdgrtnqsqdipt" ], - "encoding_format": "float", "input_type": "text" } }, "responses": { "200": { "body": { + "id": "bghgrsnxwdfyeaerb", "data": [ { "embedding": [ - 21 + 10 ], - "index": 1 + "index": 18, + "object": "nxpemodezjrugmzpxtbflkfyjkstl" } ], "usage": { - "prompt_tokens": 22, - "total_tokens": 6 - } + "prompt_tokens": 25, + "total_tokens": 5 + }, + "object": "pvjtpdgpbzbwlberghnwrnaakcwop", + "model": "xkxapmuebtvkutuxklghh" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 42c04ebdc6e5..52ce31aac84c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -3,27 +3,31 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "embeddingOptions": { + "embeddingsOptions": { "input": [ - "wdazexgkffqeyzkhnpsjssbuwdf" + "prhoocdgrtnqsqdipt" ] } }, "responses": { "200": { "body": { + "id": "bghgrsnxwdfyeaerb", "data": [ { "embedding": [ - 21 + 10 ], - "index": 1 + "index": 18, + "object": "nxpemodezjrugmzpxtbflkfyjkstl" } ], "usage": { - "prompt_tokens": 22, - "total_tokens": 6 - } + "prompt_tokens": 25, + "total_tokens": 5 + }, + "object": "pvjtpdgpbzbwlberghnwrnaakcwop", + "model": "xkxapmuebtvkutuxklghh" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index fb15ce205344..7f0292002fde 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -59,10 +59,10 @@ } }, "x-ms-examples": { - "maximum set chat completion": { + "GetChatCompletions_MaximumSet_Gen": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "minimum set chat completion": { + "GetChatCompletions_MinimumSet_Gen": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -77,7 +77,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "embeddingOptions", + "name": "embeddingsOptions", "in": "body", "description": "The JSON payload containing embedding options.", "required": true, @@ -90,7 +90,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/Embeddings" + "$ref": "#/definitions/EmbeddingsResult" } }, "default": { @@ -107,10 +107,10 @@ } }, "x-ms-examples": { - "maximum set embeddings": { + "GetEmbeddings_MaximumSet_Gen": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "minimum set embeddings": { + "GetEmbeddings_MinimumSet_Gen": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } @@ -708,30 +708,6 @@ "total_tokens" ] }, - "EmbeddingEncodingFormat": { - "type": "string", - "description": "Represents the available formats for embeddings data on responses.", - "enum": [ - "float", - "base64" - ], - "x-ms-enum": { - "name": "EmbeddingEncodingFormat", - "modelAsString": true, - "values": [ - { - "name": "float", - "value": "float", - "description": "Specifies that responses should provide arrays of floats for each embedding." - }, - { - "name": "base64", - "value": "base64", - "description": "Specifies that responses should provide a base64-encoded string for each embedding." - } - ] - } - }, "EmbeddingInputType": { "type": "string", "description": "Represents the input types used for embedding search.", @@ -747,17 +723,17 @@ { "name": "text", "value": "text", - "description": "fill me." + "description": "to do" }, { "name": "query", "value": "query", - "description": "fill me." + "description": "to do" }, { "name": "document", "value": "document", - "description": "fill me." + "description": "to do" } ] } @@ -778,33 +754,16 @@ "type": "integer", "format": "int32", "description": "Index of the prompt to which the EmbeddingItem corresponds." - } - }, - "required": [ - "embedding", - "index" - ] - }, - "Embeddings": { - "type": "object", - "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", - "properties": { - "data": { - "type": "array", - "description": "Embedding values for the prompts submitted in the request.", - "items": { - "$ref": "#/definitions/EmbeddingItem" - }, - "x-ms-identifiers": [] }, - "usage": { - "$ref": "#/definitions/EmbeddingsUsage", - "description": "Usage counts for tokens input using the embeddings API." + "object": { + "type": "string", + "description": "The object type of this embeddings item. Will always be `embedding`." } }, "required": [ - "data", - "usage" + "embedding", + "index", + "object" ] }, "EmbeddingsOptions": { @@ -813,37 +772,11 @@ "properties": { "input": { "type": "array", - "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", + "description": "Input texts to get embeddings for, encoded as a an array of strings.", "items": { "type": "string" } }, - "encoding_format": { - "type": "string", - "description": "The response encoding format to use for embedding data.", - "default": "float", - "enum": [ - "float", - "base64" - ], - "x-ms-enum": { - "name": "EmbeddingEncodingFormat", - "modelAsString": true, - "values": [ - { - "name": "float", - "value": "float", - "description": "Specifies that responses should provide arrays of floats for each embedding." - }, - { - "name": "base64", - "value": "base64", - "description": "Specifies that responses should provide a base64-encoded string for each embedding." - } - ] - }, - "x-ms-client-name": "encodingFormat" - }, "input_type": { "type": "string", "description": "Specifies the input type to use for embedding search.", @@ -860,17 +793,17 @@ { "name": "text", "value": "text", - "description": "fill me." + "description": "to do" }, { "name": "query", "value": "query", - "description": "fill me." + "description": "to do" }, { "name": "document", "value": "document", - "description": "fill me." + "description": "to do" } ] }, @@ -881,6 +814,43 @@ "input" ] }, + "EmbeddingsResult": { + "type": "object", + "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the embeddings result." + }, + "data": { + "type": "array", + "description": "Embedding values for the prompts submitted in the request.", + "items": { + "$ref": "#/definitions/EmbeddingItem" + }, + "x-ms-identifiers": [] + }, + "usage": { + "$ref": "#/definitions/EmbeddingsUsage", + "description": "Usage counts for tokens input using the embeddings API." + }, + "object": { + "type": "string", + "description": "The object type of the embeddings result. Will always be `list`." + }, + "model": { + "type": "string", + "description": "The model ID used to generate this result." + } + }, + "required": [ + "id", + "data", + "usage", + "object", + "model" + ] + }, "EmbeddingsUsage": { "type": "object", "description": "Measurement of the amount of tokens used in this request and response.", From 9523f51c767212f72961227ec5ba8b725cc80960 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 29 Mar 2024 18:35:14 -0700 Subject: [PATCH 030/343] After running `npx tsv specification/ai/ModelClient` --- specification/ai/ModelClient/models/embeddings.tsp | 2 +- .../ModelClient/preview/2024-04-01-preview/openapi.json | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index fcc4ad08aeb5..0ca77c043998 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -68,7 +68,7 @@ model EmbeddingItem { index: int32; @doc("The object type of this embeddings item. Will always be `embedding`.") - object: string + object: string; } @doc("Measurement of the amount of tokens used in this request and response.") diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 7f0292002fde..c8220dc55198 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -59,10 +59,10 @@ } }, "x-ms-examples": { - "GetChatCompletions_MaximumSet_Gen": { + "maximum set chat completion": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "GetChatCompletions_MinimumSet_Gen": { + "minimum set chat completion": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -107,10 +107,10 @@ } }, "x-ms-examples": { - "GetEmbeddings_MaximumSet_Gen": { + "maximum set embeddings": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "GetEmbeddings_MinimumSet_Gen": { + "minimum set embeddings": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } From b545c63e18af148bcde2861fa9254976f9f4ae7d Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:47:51 -0700 Subject: [PATCH 031/343] Add two optional HTTP request headers --- .../GetChatCompletions_MaximumSet_Gen.json | 28 +++--- .../GetChatCompletions_MinimumSet_Gen.json | 18 ++-- .../GetEmbeddings_MaximumSet_Gen.json | 20 +++-- .../GetEmbeddings_MinimumSet_Gen.json | 18 ++-- specification/ai/ModelClient/routes.tsp | 30 +++++++ .../GetChatCompletions_MaximumSet_Gen.json | 28 +++--- .../GetChatCompletions_MinimumSet_Gen.json | 18 ++-- .../GetEmbeddings_MaximumSet_Gen.json | 20 +++-- .../GetEmbeddings_MinimumSet_Gen.json | 18 ++-- .../preview/2024-04-01-preview/openapi.json | 86 +++++++++++++++++++ 10 files changed, 204 insertions(+), 80 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 275147dc8c02..9b254033359d 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,13 +3,15 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", + "unknown-parameters": "error", + "azureml-model-deployment": "kqxbbykmsfhdfwmiyysabwh", "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": 1, "presence_penalty": 1, "temperature": 0, "top_p": 0, @@ -18,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "ejcoecwrdd" + "uofedckdwcklhmpkj" ], "stream": true, "tools": [ @@ -26,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 27 + "seed": 26 } }, "responses": { "200": { "body": { - "id": "fcfgwlzaojobobqpwtasrxyawcu", - "object": "ifryfrkdwwlmysdbog", - "created": 2, - "model": "xutlvnjqgpqhhdxxroqvyqdfilxcqu", + "id": "nkfoulafxyrkkswcrnrsioe", + "object": "oovu", + "created": 16, + "model": "gkgodvkehjrhpmkkgsonchskrvp", "choices": [ { - "index": 11, + "index": 2, "message": { "role": "system", - "content": "zpyae", + "content": "qwdizqtjfm", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "hmfzwkufaksourcpbbnxah" + "id": "amrnscyekdadtmeqeqvimk" } ] }, @@ -53,9 +55,9 @@ } ], "usage": { - "completion_tokens": 26, - "prompt_tokens": 7, - "total_tokens": 11 + "completion_tokens": 10, + "prompt_tokens": 13, + "total_tokens": 14 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index ba01645f4c01..a8839318ae48 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "fcfgwlzaojobobqpwtasrxyawcu", - "object": "ifryfrkdwwlmysdbog", - "created": 2, - "model": "xutlvnjqgpqhhdxxroqvyqdfilxcqu", + "id": "nkfoulafxyrkkswcrnrsioe", + "object": "oovu", + "created": 16, + "model": "gkgodvkehjrhpmkkgsonchskrvp", "choices": [ { - "index": 11, + "index": 2, "message": { "role": "system", - "content": "zpyae" + "content": "qwdizqtjfm" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 26, - "prompt_tokens": 7, - "total_tokens": 11 + "completion_tokens": 10, + "prompt_tokens": 13, + "total_tokens": 14 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 62ed61a3ee4c..a9c43de399c7 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,9 +3,11 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", + "unknown-parameters": "error", + "azureml-model-deployment": "kqxbbykmsfhdfwmiyysabwh", "embeddingsOptions": { "input": [ - "prhoocdgrtnqsqdipt" + "nnormoruykwyiasmaojrzfksqbyta" ], "input_type": "text" } @@ -13,22 +15,22 @@ "responses": { "200": { "body": { - "id": "bghgrsnxwdfyeaerb", + "id": "btzachsaltzthaaqukolsofo", "data": [ { "embedding": [ - 10 + 9 ], - "index": 18, - "object": "nxpemodezjrugmzpxtbflkfyjkstl" + "index": 7, + "object": "rndnrvhialamaokaeacdta" } ], "usage": { - "prompt_tokens": 25, - "total_tokens": 5 + "prompt_tokens": 5, + "total_tokens": 30 }, - "object": "pvjtpdgpbzbwlberghnwrnaakcwop", - "model": "xkxapmuebtvkutuxklghh" + "object": "qhqziuorbh", + "model": "blrjwls" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 52ce31aac84c..974fb8a18dc1 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,29 @@ "api-version": "2024-04-01-preview", "embeddingsOptions": { "input": [ - "prhoocdgrtnqsqdipt" + "nnormoruykwyiasmaojrzfksqbyta" ] } }, "responses": { "200": { "body": { - "id": "bghgrsnxwdfyeaerb", + "id": "btzachsaltzthaaqukolsofo", "data": [ { "embedding": [ - 10 + 9 ], - "index": 18, - "object": "nxpemodezjrugmzpxtbflkfyjkstl" + "index": 7, + "object": "rndnrvhialamaokaeacdta" } ], "usage": { - "prompt_tokens": 25, - "total_tokens": 5 + "prompt_tokens": 5, + "total_tokens": 30 }, - "object": "pvjtpdgpbzbwlberghnwrnaakcwop", - "model": "xkxapmuebtvkutuxklghh" + "object": "qhqziuorbh", + "model": "blrjwls" } } } diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 5d4ddf8bfc79..d4a825c9ad9b 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -14,6 +14,32 @@ using Azure.Core; namespace ModelClient; +@doc("Defines the service behaviour when unknown parameters are passed as extra properties in the request payload.") +enum UnknownParameters { + @doc("The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service.") + error: "error", + + @doc("The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model.") + ignore: "ignore", + + @doc("The service should pass unknown parameters to the back-end AI model.") + allow: "allow", +} + +@doc("Additional request headers") +model AdditionalRequestHeaders { + @doc("Controls what happens if unknown parameters are passed as extra properties in the request payload.") + @header("unknown-parameters") + unknownParameters?: UnknownParameters; + + @doc(""" + Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments. + Typically used when you want to target a test enviroment instead of production enviroment. + """) + @header("azureml-model-deployment") + modelDeployment?: string; +} + @doc(""" Gets chat completions for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" @@ -26,6 +52,8 @@ op getChatCompletions is Azure.Core.RpcOperation< @doc("The JSON payload containing chat completion options.") @body chatCompletionsOptions: ChatCompletionsOptions; + + ...AdditionalRequestHeaders; }, ChatCompletions >; @@ -38,6 +66,8 @@ op getEmbeddings is Azure.Core.RpcOperation< @doc("The JSON payload containing embedding options.") @body embeddingsOptions: EmbeddingsOptions; + + ...AdditionalRequestHeaders; }, EmbeddingsResult >; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 275147dc8c02..9b254033359d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,13 +3,15 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", + "unknown-parameters": "error", + "azureml-model-deployment": "kqxbbykmsfhdfwmiyysabwh", "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": 1, "presence_penalty": 1, "temperature": 0, "top_p": 0, @@ -18,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "ejcoecwrdd" + "uofedckdwcklhmpkj" ], "stream": true, "tools": [ @@ -26,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 27 + "seed": 26 } }, "responses": { "200": { "body": { - "id": "fcfgwlzaojobobqpwtasrxyawcu", - "object": "ifryfrkdwwlmysdbog", - "created": 2, - "model": "xutlvnjqgpqhhdxxroqvyqdfilxcqu", + "id": "nkfoulafxyrkkswcrnrsioe", + "object": "oovu", + "created": 16, + "model": "gkgodvkehjrhpmkkgsonchskrvp", "choices": [ { - "index": 11, + "index": 2, "message": { "role": "system", - "content": "zpyae", + "content": "qwdizqtjfm", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "hmfzwkufaksourcpbbnxah" + "id": "amrnscyekdadtmeqeqvimk" } ] }, @@ -53,9 +55,9 @@ } ], "usage": { - "completion_tokens": 26, - "prompt_tokens": 7, - "total_tokens": 11 + "completion_tokens": 10, + "prompt_tokens": 13, + "total_tokens": 14 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index ba01645f4c01..a8839318ae48 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "fcfgwlzaojobobqpwtasrxyawcu", - "object": "ifryfrkdwwlmysdbog", - "created": 2, - "model": "xutlvnjqgpqhhdxxroqvyqdfilxcqu", + "id": "nkfoulafxyrkkswcrnrsioe", + "object": "oovu", + "created": 16, + "model": "gkgodvkehjrhpmkkgsonchskrvp", "choices": [ { - "index": 11, + "index": 2, "message": { "role": "system", - "content": "zpyae" + "content": "qwdizqtjfm" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 26, - "prompt_tokens": 7, - "total_tokens": 11 + "completion_tokens": 10, + "prompt_tokens": 13, + "total_tokens": 14 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 62ed61a3ee4c..a9c43de399c7 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,9 +3,11 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", + "unknown-parameters": "error", + "azureml-model-deployment": "kqxbbykmsfhdfwmiyysabwh", "embeddingsOptions": { "input": [ - "prhoocdgrtnqsqdipt" + "nnormoruykwyiasmaojrzfksqbyta" ], "input_type": "text" } @@ -13,22 +15,22 @@ "responses": { "200": { "body": { - "id": "bghgrsnxwdfyeaerb", + "id": "btzachsaltzthaaqukolsofo", "data": [ { "embedding": [ - 10 + 9 ], - "index": 18, - "object": "nxpemodezjrugmzpxtbflkfyjkstl" + "index": 7, + "object": "rndnrvhialamaokaeacdta" } ], "usage": { - "prompt_tokens": 25, - "total_tokens": 5 + "prompt_tokens": 5, + "total_tokens": 30 }, - "object": "pvjtpdgpbzbwlberghnwrnaakcwop", - "model": "xkxapmuebtvkutuxklghh" + "object": "qhqziuorbh", + "model": "blrjwls" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 52ce31aac84c..974fb8a18dc1 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,29 @@ "api-version": "2024-04-01-preview", "embeddingsOptions": { "input": [ - "prhoocdgrtnqsqdipt" + "nnormoruykwyiasmaojrzfksqbyta" ] } }, "responses": { "200": { "body": { - "id": "bghgrsnxwdfyeaerb", + "id": "btzachsaltzthaaqukolsofo", "data": [ { "embedding": [ - 10 + 9 ], - "index": 18, - "object": "nxpemodezjrugmzpxtbflkfyjkstl" + "index": 7, + "object": "rndnrvhialamaokaeacdta" } ], "usage": { - "prompt_tokens": 25, - "total_tokens": 5 + "prompt_tokens": 5, + "total_tokens": 30 }, - "object": "pvjtpdgpbzbwlberghnwrnaakcwop", - "model": "xkxapmuebtvkutuxklghh" + "object": "qhqziuorbh", + "model": "blrjwls" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index c8220dc55198..3c9e6a048ba7 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -28,6 +28,12 @@ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, + { + "$ref": "#/parameters/AdditionalRequestHeaders.unknownParameters" + }, + { + "$ref": "#/parameters/AdditionalRequestHeaders.modelDeployment" + }, { "name": "chatCompletionsOptions", "in": "body", @@ -76,6 +82,12 @@ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, + { + "$ref": "#/parameters/AdditionalRequestHeaders.unknownParameters" + }, + { + "$ref": "#/parameters/AdditionalRequestHeaders.modelDeployment" + }, { "name": "embeddingsOptions", "in": "body", @@ -911,6 +923,36 @@ "name" ] }, + "UnknownParameters": { + "type": "string", + "description": "Defines the service behaviour when unknown parameters are passed as extra properties in the request payload.", + "enum": [ + "error", + "ignore", + "allow" + ], + "x-ms-enum": { + "name": "UnknownParameters", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "error", + "description": "The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service." + }, + { + "name": "ignore", + "value": "ignore", + "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." + }, + { + "name": "allow", + "value": "allow", + "description": "The service should pass unknown parameters to the back-end AI model." + } + ] + } + }, "Versions": { "type": "string", "description": "The ModelClient service versions.", @@ -931,6 +973,50 @@ } }, "parameters": { + "AdditionalRequestHeaders.modelDeployment": { + "name": "azureml-model-deployment", + "in": "header", + "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test enviroment instead of production enviroment.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "modelDeployment" + }, + "AdditionalRequestHeaders.unknownParameters": { + "name": "unknown-parameters", + "in": "header", + "description": "Controls what happens if unknown parameters are passed as extra properties in the request payload.", + "required": false, + "type": "string", + "enum": [ + "error", + "ignore", + "allow" + ], + "x-ms-enum": { + "name": "UnknownParameters", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "error", + "description": "The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service." + }, + { + "name": "ignore", + "value": "ignore", + "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." + }, + { + "name": "allow", + "value": "allow", + "description": "The service should pass unknown parameters to the back-end AI model." + } + ] + }, + "x-ms-parameter-location": "method", + "x-ms-client-name": "unknownParameters" + }, "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", From 7f14ca7a54b05b2e9f25b5c83b6e54270b7ba6b4 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 1 Apr 2024 15:19:57 -0700 Subject: [PATCH 032/343] use alias for the grouping of HTTP request header --- .../GetChatCompletions_MaximumSet_Gen.json | 30 ++-- .../GetChatCompletions_MinimumSet_Gen.json | 18 +-- .../GetEmbeddings_MaximumSet_Gen.json | 20 +-- .../GetEmbeddings_MinimumSet_Gen.json | 18 +-- specification/ai/ModelClient/routes.tsp | 5 +- .../GetChatCompletions_MaximumSet_Gen.json | 30 ++-- .../GetChatCompletions_MinimumSet_Gen.json | 18 +-- .../GetEmbeddings_MaximumSet_Gen.json | 20 +-- .../GetEmbeddings_MinimumSet_Gen.json | 18 +-- .../preview/2024-04-01-preview/openapi.json | 132 +++++++++++------- 10 files changed, 168 insertions(+), 141 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 9b254033359d..739e1b8a51d7 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -4,15 +4,15 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "kqxbbykmsfhdfwmiyysabwh", + "azureml-model-deployment": "qclspnaxydz", "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, - "presence_penalty": 1, + "frequency_penalty": -1, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "uofedckdwcklhmpkj" + "b" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 26 + "seed": 5 } }, "responses": { "200": { "body": { - "id": "nkfoulafxyrkkswcrnrsioe", - "object": "oovu", - "created": 16, - "model": "gkgodvkehjrhpmkkgsonchskrvp", + "id": "ddm", + "object": "kcbeleehxegkfozcap", + "created": 7, + "model": "at", "choices": [ { - "index": 2, + "index": 4, "message": { "role": "system", - "content": "qwdizqtjfm", + "content": "exlergdmrxoatd", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "amrnscyekdadtmeqeqvimk" + "id": "yazhziuohbiefirbr" } ] }, @@ -55,9 +55,9 @@ } ], "usage": { - "completion_tokens": 10, - "prompt_tokens": 13, - "total_tokens": 14 + "completion_tokens": 30, + "prompt_tokens": 7, + "total_tokens": 25 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index a8839318ae48..4ac201b1095a 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "nkfoulafxyrkkswcrnrsioe", - "object": "oovu", - "created": 16, - "model": "gkgodvkehjrhpmkkgsonchskrvp", + "id": "ddm", + "object": "kcbeleehxegkfozcap", + "created": 7, + "model": "at", "choices": [ { - "index": 2, + "index": 4, "message": { "role": "system", - "content": "qwdizqtjfm" + "content": "exlergdmrxoatd" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 10, - "prompt_tokens": 13, - "total_tokens": 14 + "completion_tokens": 30, + "prompt_tokens": 7, + "total_tokens": 25 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index a9c43de399c7..6aa2cbb14cc4 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "kqxbbykmsfhdfwmiyysabwh", + "azureml-model-deployment": "oqgvadjznwkiaajvnwljbxwpdn", "embeddingsOptions": { "input": [ - "nnormoruykwyiasmaojrzfksqbyta" + "kxxknnegiwwyqn" ], "input_type": "text" } @@ -15,22 +15,22 @@ "responses": { "200": { "body": { - "id": "btzachsaltzthaaqukolsofo", + "id": "o", "data": [ { "embedding": [ - 9 + 12 ], - "index": 7, - "object": "rndnrvhialamaokaeacdta" + "index": 2, + "object": "uqqacl" } ], "usage": { - "prompt_tokens": 5, - "total_tokens": 30 + "prompt_tokens": 22, + "total_tokens": 5 }, - "object": "qhqziuorbh", - "model": "blrjwls" + "object": "uxjdgciolcwcghb", + "model": "coxcshqbgtsdhuibmshfpaccw" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 974fb8a18dc1..9505ce49734b 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,29 @@ "api-version": "2024-04-01-preview", "embeddingsOptions": { "input": [ - "nnormoruykwyiasmaojrzfksqbyta" + "kxxknnegiwwyqn" ] } }, "responses": { "200": { "body": { - "id": "btzachsaltzthaaqukolsofo", + "id": "o", "data": [ { "embedding": [ - 9 + 12 ], - "index": 7, - "object": "rndnrvhialamaokaeacdta" + "index": 2, + "object": "uqqacl" } ], "usage": { - "prompt_tokens": 5, - "total_tokens": 30 + "prompt_tokens": 22, + "total_tokens": 5 }, - "object": "qhqziuorbh", - "model": "blrjwls" + "object": "uxjdgciolcwcghb", + "model": "coxcshqbgtsdhuibmshfpaccw" } } } diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index d4a825c9ad9b..e9d3d49d2261 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -26,8 +26,7 @@ enum UnknownParameters { allow: "allow", } -@doc("Additional request headers") -model AdditionalRequestHeaders { +alias AdditionalRequestHeaders = { @doc("Controls what happens if unknown parameters are passed as extra properties in the request payload.") @header("unknown-parameters") unknownParameters?: UnknownParameters; @@ -38,7 +37,7 @@ model AdditionalRequestHeaders { """) @header("azureml-model-deployment") modelDeployment?: string; -} +}; @doc(""" Gets chat completions for the provided chat messages. diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 9b254033359d..739e1b8a51d7 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -4,15 +4,15 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "kqxbbykmsfhdfwmiyysabwh", + "azureml-model-deployment": "qclspnaxydz", "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, - "presence_penalty": 1, + "frequency_penalty": -1, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "uofedckdwcklhmpkj" + "b" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 26 + "seed": 5 } }, "responses": { "200": { "body": { - "id": "nkfoulafxyrkkswcrnrsioe", - "object": "oovu", - "created": 16, - "model": "gkgodvkehjrhpmkkgsonchskrvp", + "id": "ddm", + "object": "kcbeleehxegkfozcap", + "created": 7, + "model": "at", "choices": [ { - "index": 2, + "index": 4, "message": { "role": "system", - "content": "qwdizqtjfm", + "content": "exlergdmrxoatd", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "amrnscyekdadtmeqeqvimk" + "id": "yazhziuohbiefirbr" } ] }, @@ -55,9 +55,9 @@ } ], "usage": { - "completion_tokens": 10, - "prompt_tokens": 13, - "total_tokens": 14 + "completion_tokens": 30, + "prompt_tokens": 7, + "total_tokens": 25 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index a8839318ae48..4ac201b1095a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "nkfoulafxyrkkswcrnrsioe", - "object": "oovu", - "created": 16, - "model": "gkgodvkehjrhpmkkgsonchskrvp", + "id": "ddm", + "object": "kcbeleehxegkfozcap", + "created": 7, + "model": "at", "choices": [ { - "index": 2, + "index": 4, "message": { "role": "system", - "content": "qwdizqtjfm" + "content": "exlergdmrxoatd" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 10, - "prompt_tokens": 13, - "total_tokens": 14 + "completion_tokens": 30, + "prompt_tokens": 7, + "total_tokens": 25 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index a9c43de399c7..6aa2cbb14cc4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "kqxbbykmsfhdfwmiyysabwh", + "azureml-model-deployment": "oqgvadjznwkiaajvnwljbxwpdn", "embeddingsOptions": { "input": [ - "nnormoruykwyiasmaojrzfksqbyta" + "kxxknnegiwwyqn" ], "input_type": "text" } @@ -15,22 +15,22 @@ "responses": { "200": { "body": { - "id": "btzachsaltzthaaqukolsofo", + "id": "o", "data": [ { "embedding": [ - 9 + 12 ], - "index": 7, - "object": "rndnrvhialamaokaeacdta" + "index": 2, + "object": "uqqacl" } ], "usage": { - "prompt_tokens": 5, - "total_tokens": 30 + "prompt_tokens": 22, + "total_tokens": 5 }, - "object": "qhqziuorbh", - "model": "blrjwls" + "object": "uxjdgciolcwcghb", + "model": "coxcshqbgtsdhuibmshfpaccw" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 974fb8a18dc1..9505ce49734b 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,29 @@ "api-version": "2024-04-01-preview", "embeddingsOptions": { "input": [ - "nnormoruykwyiasmaojrzfksqbyta" + "kxxknnegiwwyqn" ] } }, "responses": { "200": { "body": { - "id": "btzachsaltzthaaqukolsofo", + "id": "o", "data": [ { "embedding": [ - 9 + 12 ], - "index": 7, - "object": "rndnrvhialamaokaeacdta" + "index": 2, + "object": "uqqacl" } ], "usage": { - "prompt_tokens": 5, - "total_tokens": 30 + "prompt_tokens": 22, + "total_tokens": 5 }, - "object": "qhqziuorbh", - "model": "blrjwls" + "object": "uxjdgciolcwcghb", + "model": "coxcshqbgtsdhuibmshfpaccw" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 3c9e6a048ba7..bfee837ae1fb 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -29,10 +29,46 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/AdditionalRequestHeaders.unknownParameters" + "name": "unknown-parameters", + "in": "header", + "description": "Controls what happens if unknown parameters are passed as extra properties in the request payload.", + "required": false, + "type": "string", + "enum": [ + "error", + "ignore", + "allow" + ], + "x-ms-enum": { + "name": "UnknownParameters", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "error", + "description": "The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service." + }, + { + "name": "ignore", + "value": "ignore", + "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." + }, + { + "name": "allow", + "value": "allow", + "description": "The service should pass unknown parameters to the back-end AI model." + } + ] + }, + "x-ms-client-name": "unknownParameters" }, { - "$ref": "#/parameters/AdditionalRequestHeaders.modelDeployment" + "name": "azureml-model-deployment", + "in": "header", + "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test enviroment instead of production enviroment.", + "required": false, + "type": "string", + "x-ms-client-name": "modelDeployment" }, { "name": "chatCompletionsOptions", @@ -65,10 +101,10 @@ } }, "x-ms-examples": { - "maximum set chat completion": { + "GetChatCompletions_MaximumSet_Gen": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "minimum set chat completion": { + "GetChatCompletions_MinimumSet_Gen": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -83,10 +119,46 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/AdditionalRequestHeaders.unknownParameters" + "name": "unknown-parameters", + "in": "header", + "description": "Controls what happens if unknown parameters are passed as extra properties in the request payload.", + "required": false, + "type": "string", + "enum": [ + "error", + "ignore", + "allow" + ], + "x-ms-enum": { + "name": "UnknownParameters", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "error", + "description": "The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service." + }, + { + "name": "ignore", + "value": "ignore", + "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." + }, + { + "name": "allow", + "value": "allow", + "description": "The service should pass unknown parameters to the back-end AI model." + } + ] + }, + "x-ms-client-name": "unknownParameters" }, { - "$ref": "#/parameters/AdditionalRequestHeaders.modelDeployment" + "name": "azureml-model-deployment", + "in": "header", + "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test enviroment instead of production enviroment.", + "required": false, + "type": "string", + "x-ms-client-name": "modelDeployment" }, { "name": "embeddingsOptions", @@ -119,10 +191,10 @@ } }, "x-ms-examples": { - "maximum set embeddings": { + "GetEmbeddings_MaximumSet_Gen": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "minimum set embeddings": { + "GetEmbeddings_MinimumSet_Gen": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } @@ -973,50 +1045,6 @@ } }, "parameters": { - "AdditionalRequestHeaders.modelDeployment": { - "name": "azureml-model-deployment", - "in": "header", - "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test enviroment instead of production enviroment.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-client-name": "modelDeployment" - }, - "AdditionalRequestHeaders.unknownParameters": { - "name": "unknown-parameters", - "in": "header", - "description": "Controls what happens if unknown parameters are passed as extra properties in the request payload.", - "required": false, - "type": "string", - "enum": [ - "error", - "ignore", - "allow" - ], - "x-ms-enum": { - "name": "UnknownParameters", - "modelAsString": true, - "values": [ - { - "name": "error", - "value": "error", - "description": "The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service." - }, - { - "name": "ignore", - "value": "ignore", - "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." - }, - { - "name": "allow", - "value": "allow", - "description": "The service should pass unknown parameters to the back-end AI model." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "unknownParameters" - }, "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", From faa1b2cdc94bf994f70a21ed004fd471b42369ba Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 1 Apr 2024 15:21:35 -0700 Subject: [PATCH 033/343] Fix example titles --- .../ModelClient/preview/2024-04-01-preview/openapi.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index bfee837ae1fb..7fc92c57a7e7 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -101,10 +101,10 @@ } }, "x-ms-examples": { - "GetChatCompletions_MaximumSet_Gen": { + "maximum set chat completion": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "GetChatCompletions_MinimumSet_Gen": { + "minimum set chat completion": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -191,10 +191,10 @@ } }, "x-ms-examples": { - "GetEmbeddings_MaximumSet_Gen": { + "maximum set embeddings": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "GetEmbeddings_MinimumSet_Gen": { + "minimum set embeddings": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } From 708818b576507b519b373ad16877553550e5f9fd Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 1 Apr 2024 16:21:27 -0700 Subject: [PATCH 034/343] Remove @projectedName(json,...) and disable the linter warning --- .../GetChatCompletions_MaximumSet_Gen.json | 28 ++++++------- .../GetChatCompletions_MinimumSet_Gen.json | 18 ++++----- .../GetEmbeddings_MaximumSet_Gen.json | 20 +++++----- .../GetEmbeddings_MinimumSet_Gen.json | 18 ++++----- .../ModelClient/models/chat_completions.tsp | 39 +++++-------------- specification/ai/ModelClient/tspconfig.yaml | 8 ++-- .../GetChatCompletions_MaximumSet_Gen.json | 28 ++++++------- .../GetChatCompletions_MinimumSet_Gen.json | 18 ++++----- .../GetEmbeddings_MaximumSet_Gen.json | 20 +++++----- .../GetEmbeddings_MinimumSet_Gen.json | 18 ++++----- .../preview/2024-04-01-preview/openapi.json | 27 +++++-------- 11 files changed, 107 insertions(+), 135 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 739e1b8a51d7..9fa3934a4a8a 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -4,14 +4,14 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "qclspnaxydz", + "azureml-model-deployment": "avoclyhqnmuivlomzxvficq", "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": 0, "presence_penalty": -2, "temperature": 0, "top_p": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "b" + "ordrqcoghor" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 5 + "seed": 30 } }, "responses": { "200": { "body": { - "id": "ddm", - "object": "kcbeleehxegkfozcap", - "created": 7, - "model": "at", + "id": "hsmpiuxgi", + "object": "t", + "created": 16, + "model": "okmnhcumjvfneohbpldhttbfzjg", "choices": [ { - "index": 4, + "index": 11, "message": { "role": "system", - "content": "exlergdmrxoatd", + "content": "uqysdzkjdqaiiyyvyutoqcayb", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "yazhziuohbiefirbr" + "id": "obnwznlmlydakxk" } ] }, @@ -55,9 +55,9 @@ } ], "usage": { - "completion_tokens": 30, - "prompt_tokens": 7, - "total_tokens": 25 + "completion_tokens": 27, + "prompt_tokens": 23, + "total_tokens": 30 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 4ac201b1095a..62961eac3b50 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "ddm", - "object": "kcbeleehxegkfozcap", - "created": 7, - "model": "at", + "id": "hsmpiuxgi", + "object": "t", + "created": 16, + "model": "okmnhcumjvfneohbpldhttbfzjg", "choices": [ { - "index": 4, + "index": 11, "message": { "role": "system", - "content": "exlergdmrxoatd" + "content": "uqysdzkjdqaiiyyvyutoqcayb" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 30, - "prompt_tokens": 7, - "total_tokens": 25 + "completion_tokens": 27, + "prompt_tokens": 23, + "total_tokens": 30 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 6aa2cbb14cc4..32a9dce2a523 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "oqgvadjznwkiaajvnwljbxwpdn", + "azureml-model-deployment": "ilu", "embeddingsOptions": { "input": [ - "kxxknnegiwwyqn" + "fggycssnpxdiz" ], "input_type": "text" } @@ -15,22 +15,22 @@ "responses": { "200": { "body": { - "id": "o", + "id": "wglg", "data": [ { "embedding": [ - 12 + 9 ], - "index": 2, - "object": "uqqacl" + "index": 20, + "object": "oodpoxzonnvgdlrtliueknroxu" } ], "usage": { - "prompt_tokens": 22, - "total_tokens": 5 + "prompt_tokens": 6, + "total_tokens": 11 }, - "object": "uxjdgciolcwcghb", - "model": "coxcshqbgtsdhuibmshfpaccw" + "object": "xtkqgnviusvnficpmqxqphg", + "model": "tzkpqrstfzlaepnxxdcgm" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 9505ce49734b..a95207e91f26 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,29 @@ "api-version": "2024-04-01-preview", "embeddingsOptions": { "input": [ - "kxxknnegiwwyqn" + "fggycssnpxdiz" ] } }, "responses": { "200": { "body": { - "id": "o", + "id": "wglg", "data": [ { "embedding": [ - 12 + 9 ], - "index": 2, - "object": "uqqacl" + "index": 20, + "object": "oodpoxzonnvgdlrtliueknroxu" } ], "usage": { - "prompt_tokens": 22, - "total_tokens": 5 + "prompt_tokens": 6, + "total_tokens": 11 }, - "object": "uxjdgciolcwcghb", - "model": "coxcshqbgtsdhuibmshfpaccw" + "object": "xtkqgnviusvnficpmqxqphg", + "model": "tzkpqrstfzlaepnxxdcgm" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index fd773f5ca6a1..f4ddf1b8a9e7 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -20,7 +20,6 @@ model ChatCompletionsOptions { the behavior of the assistant, followed by alternating messages between the User and Assistant roles. """) - @projectedName("json", "messages") @minItems(1) messages: ChatRequestMessage[]; @@ -32,8 +31,7 @@ model ChatCompletionsOptions { """) @maxValue(2.0) @minValue(-2.0) - @projectedName("json", "frequency_penalty") - frequencyPenalty?: float32 = 0.0; + frequency_penalty?: float32 = 0.0; @doc(""" A value that influences the probability of generated tokens appearing based on their existing @@ -43,8 +41,7 @@ model ChatCompletionsOptions { """) @maxValue(2.0) @minValue(-2.0) - @projectedName("json", "presence_penalty") - presencePenalty?: float32 = 0.0; + presence_penalty?: float32 = 0.0; @doc(""" The sampling temperature to use that controls the apparent creativity of generated completions. @@ -55,7 +52,6 @@ model ChatCompletionsOptions { """) @maxValue(1.0) @minValue(0.0) - @projectedName("json", "temperature") temperature?: float32 = 0.7; @doc(""" @@ -68,29 +64,24 @@ model ChatCompletionsOptions { """) @maxValue(1.0) @minValue(0.0) - @projectedName("json", "top_p") - topP?: float32 = 1.0; + top_p?: float32 = 1.0; @doc("The maximum number of tokens to generate.") - @projectedName("json", "max_tokens") @minValue(0.0) - maxTokens?: int32; + max_tokens?: int32; - @projectedName("json", "response_format") @doc("An object specifying the format that the model must output. Used to enable JSON mode.") - responseFormat?: ChatCompletionsResponseFormat; + response_format?: ChatCompletionsResponseFormat; @doc(""" A collection of textual sequences that will end completions generation. """) - @projectedName("json", "stop") @minItems(1) stop?: string[]; @doc(""" A value indicating whether chat completions should be streamed for this request. """) - @projectedName("json", "stream") stream?: boolean = false; @doc("The available tool definitions that the chat completions request can use, including caller-defined functions.") @@ -118,23 +109,19 @@ provided prompt data. """) model ChatCompletions { @doc("A unique identifier associated with this chat completions response.") - @projectedName("json", "id") id: string; @doc("The response object type, which is always `chat.completion`.") - @projectedName("json", "object") object: string; @doc(""" The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. """) - @projectedName("json", "created") @encode(DateTimeKnownEncoding.unixTimestamp, int32) created: utcDateTime; @doc("The model used for the chat completion.") - @projectedName("json", "model") `model`: string; @doc(""" @@ -142,14 +129,12 @@ model ChatCompletions { Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated. """) - @projectedName("json", "choices") @minItems(1) choices: ChatChoice[]; @doc(""" Usage information for tokens processed and generated as part of this completions operation. """) - @projectedName("json", "usage") usage: CompletionsUsage; } @@ -160,16 +145,13 @@ other consumers. """) model CompletionsUsage { @doc("The number of tokens generated across all completions emissions.") - @projectedName("json", "completion_tokens") - completionTokens: int32; + completion_tokens: int32; @doc("The number of tokens in the provided prompts for the completions request.") - @projectedName("json", "prompt_tokens") - promptTokens: int32; + prompt_tokens: int32; @doc("The total number of tokens processed for the completions request and response.") - @projectedName("json", "total_tokens") - totalTokens: int32; + total_tokens: int32; } @doc(""" @@ -238,18 +220,15 @@ Token limits and other settings may limit the number of choices generated. """) model ChatChoice { @doc("The ordered index associated with this chat completions choice.") - @projectedName("json", "index") index: int32; @doc("The chat message for a given chat completions prompt.") - @projectedName("json", "message") message: ChatResponseMessage; #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" #suppress "@azure-tools/typespec-autorest/union-unsupported" "OpenAPI v2 support deferred" @doc("The reason that this chat completions choice completed its generated.") - @projectedName("json", "finish_reason") - finishReason: CompletionsFinishReason | null; + finish_reason: CompletionsFinishReason | null; } @discriminator("role") diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index 8456fbe5d171..8c7c4d75c64e 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -6,6 +6,11 @@ parameters: default: "" emit: - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-core/all" + disable: + "@azure-tools/typespec-azure-core/casing-style": "Disabled since JSON payload in REST API does not conform to Azure guidelines with regards to casing" options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" @@ -17,6 +22,3 @@ options: package-dir: "azure-ai-inference" package-name: "{package-dir}" flavor: azure -linter: - extends: - - "@azure-tools/typespec-azure-core/all" diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 739e1b8a51d7..9fa3934a4a8a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -4,14 +4,14 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "qclspnaxydz", + "azureml-model-deployment": "avoclyhqnmuivlomzxvficq", "chatCompletionsOptions": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": 0, "presence_penalty": -2, "temperature": 0, "top_p": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "b" + "ordrqcoghor" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 5 + "seed": 30 } }, "responses": { "200": { "body": { - "id": "ddm", - "object": "kcbeleehxegkfozcap", - "created": 7, - "model": "at", + "id": "hsmpiuxgi", + "object": "t", + "created": 16, + "model": "okmnhcumjvfneohbpldhttbfzjg", "choices": [ { - "index": 4, + "index": 11, "message": { "role": "system", - "content": "exlergdmrxoatd", + "content": "uqysdzkjdqaiiyyvyutoqcayb", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "yazhziuohbiefirbr" + "id": "obnwznlmlydakxk" } ] }, @@ -55,9 +55,9 @@ } ], "usage": { - "completion_tokens": 30, - "prompt_tokens": 7, - "total_tokens": 25 + "completion_tokens": 27, + "prompt_tokens": 23, + "total_tokens": 30 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 4ac201b1095a..62961eac3b50 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "ddm", - "object": "kcbeleehxegkfozcap", - "created": 7, - "model": "at", + "id": "hsmpiuxgi", + "object": "t", + "created": 16, + "model": "okmnhcumjvfneohbpldhttbfzjg", "choices": [ { - "index": 4, + "index": 11, "message": { "role": "system", - "content": "exlergdmrxoatd" + "content": "uqysdzkjdqaiiyyvyutoqcayb" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 30, - "prompt_tokens": 7, - "total_tokens": 25 + "completion_tokens": 27, + "prompt_tokens": 23, + "total_tokens": 30 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 6aa2cbb14cc4..32a9dce2a523 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "oqgvadjznwkiaajvnwljbxwpdn", + "azureml-model-deployment": "ilu", "embeddingsOptions": { "input": [ - "kxxknnegiwwyqn" + "fggycssnpxdiz" ], "input_type": "text" } @@ -15,22 +15,22 @@ "responses": { "200": { "body": { - "id": "o", + "id": "wglg", "data": [ { "embedding": [ - 12 + 9 ], - "index": 2, - "object": "uqqacl" + "index": 20, + "object": "oodpoxzonnvgdlrtliueknroxu" } ], "usage": { - "prompt_tokens": 22, - "total_tokens": 5 + "prompt_tokens": 6, + "total_tokens": 11 }, - "object": "uxjdgciolcwcghb", - "model": "coxcshqbgtsdhuibmshfpaccw" + "object": "xtkqgnviusvnficpmqxqphg", + "model": "tzkpqrstfzlaepnxxdcgm" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 9505ce49734b..a95207e91f26 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,29 @@ "api-version": "2024-04-01-preview", "embeddingsOptions": { "input": [ - "kxxknnegiwwyqn" + "fggycssnpxdiz" ] } }, "responses": { "200": { "body": { - "id": "o", + "id": "wglg", "data": [ { "embedding": [ - 12 + 9 ], - "index": 2, - "object": "uqqacl" + "index": 20, + "object": "oodpoxzonnvgdlrtliueknroxu" } ], "usage": { - "prompt_tokens": 22, - "total_tokens": 5 + "prompt_tokens": 6, + "total_tokens": 11 }, - "object": "uxjdgciolcwcghb", - "model": "coxcshqbgtsdhuibmshfpaccw" + "object": "xtkqgnviusvnficpmqxqphg", + "model": "tzkpqrstfzlaepnxxdcgm" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 7fc92c57a7e7..a69fad17cc76 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -279,8 +279,7 @@ "finish_reason": { "$ref": "#/definitions/CompletionsFinishReason", "description": "The reason that this chat completions choice completed its generated.", - "x-nullable": true, - "x-ms-client-name": "finishReason" + "x-nullable": true } }, "required": [ @@ -414,8 +413,7 @@ "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", "default": 0, "minimum": -2, - "maximum": 2, - "x-ms-client-name": "frequencyPenalty" + "maximum": 2 }, "presence_penalty": { "type": "number", @@ -423,8 +421,7 @@ "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", "default": 0, "minimum": -2, - "maximum": 2, - "x-ms-client-name": "presencePenalty" + "maximum": 2 }, "temperature": { "type": "number", @@ -440,20 +437,17 @@ "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", "default": 1, "minimum": 0, - "maximum": 1, - "x-ms-client-name": "topP" + "maximum": 1 }, "max_tokens": { "type": "integer", "format": "int32", "description": "The maximum number of tokens to generate.", - "minimum": 0, - "x-ms-client-name": "maxTokens" + "minimum": 0 }, "response_format": { "$ref": "#/definitions/ChatCompletionsResponseFormat", - "description": "An object specifying the format that the model must output. Used to enable JSON mode.", - "x-ms-client-name": "responseFormat" + "description": "An object specifying the format that the model must output. Used to enable JSON mode." }, "stop": { "type": "array", @@ -770,20 +764,17 @@ "completion_tokens": { "type": "integer", "format": "int32", - "description": "The number of tokens generated across all completions emissions.", - "x-ms-client-name": "completionTokens" + "description": "The number of tokens generated across all completions emissions." }, "prompt_tokens": { "type": "integer", "format": "int32", - "description": "The number of tokens in the provided prompts for the completions request.", - "x-ms-client-name": "promptTokens" + "description": "The number of tokens in the provided prompts for the completions request." }, "total_tokens": { "type": "integer", "format": "int32", - "description": "The total number of tokens processed for the completions request and response.", - "x-ms-client-name": "totalTokens" + "description": "The total number of tokens processed for the completions request and response." } }, "required": [ From c26f993ec2271f0fabdd24905a99d2da062686dd Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 1 Apr 2024 17:15:37 -0700 Subject: [PATCH 035/343] Fix typos. Use alias instead of model for request settings. Use common.tsp --- .../GetChatCompletions_MaximumSet_Gen.json | 30 +- .../GetChatCompletions_MinimumSet_Gen.json | 20 +- .../GetEmbeddings_MaximumSet_Gen.json | 22 +- .../GetEmbeddings_MinimumSet_Gen.json | 20 +- .../ModelClient/models/chat_completions.tsp | 19 +- .../ai/ModelClient/models/common.tsp | 34 ++ .../ai/ModelClient/models/embeddings.tsp | 9 +- specification/ai/ModelClient/routes.tsp | 36 +-- .../GetChatCompletions_MaximumSet_Gen.json | 30 +- .../GetChatCompletions_MinimumSet_Gen.json | 20 +- .../GetEmbeddings_MaximumSet_Gen.json | 22 +- .../GetEmbeddings_MinimumSet_Gen.json | 20 +- .../preview/2024-04-01-preview/openapi.json | 292 +++++++++--------- 13 files changed, 279 insertions(+), 295 deletions(-) create mode 100644 specification/ai/ModelClient/models/common.tsp diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 9fa3934a4a8a..7b9b0fc36f6a 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -4,14 +4,14 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "avoclyhqnmuivlomzxvficq", - "chatCompletionsOptions": { + "azureml-model-deployment": "plpjuedmhjyrqlyxwz", + "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, + "frequency_penalty": 1, "presence_penalty": -2, "temperature": 0, "top_p": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "ordrqcoghor" + "uamtjzfmqyaitpylvvugdy" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 30 + "seed": 12 } }, "responses": { "200": { "body": { - "id": "hsmpiuxgi", - "object": "t", - "created": 16, - "model": "okmnhcumjvfneohbpldhttbfzjg", + "id": "baauxksfzyiaksvy", + "object": "uzorevsijgizsvkzn", + "created": 10, + "model": "ogtsmawgfrtch", "choices": [ { - "index": 11, + "index": 23, "message": { "role": "system", - "content": "uqysdzkjdqaiiyyvyutoqcayb", + "content": "jkplvpbckbxcubunfqjdtcomx", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "obnwznlmlydakxk" + "id": "wtiayzuayhvkqtsygfcwwbayfforo" } ] }, @@ -55,9 +55,9 @@ } ], "usage": { - "completion_tokens": 27, - "prompt_tokens": 23, - "total_tokens": 30 + "completion_tokens": 28, + "prompt_tokens": 25, + "total_tokens": 20 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 62961eac3b50..2450df698b22 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "chatCompletionsOptions": { + "body": { "messages": [ { "role": "ChatRequestMessage" @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "hsmpiuxgi", - "object": "t", - "created": 16, - "model": "okmnhcumjvfneohbpldhttbfzjg", + "id": "baauxksfzyiaksvy", + "object": "uzorevsijgizsvkzn", + "created": 10, + "model": "ogtsmawgfrtch", "choices": [ { - "index": 11, + "index": 23, "message": { "role": "system", - "content": "uqysdzkjdqaiiyyvyutoqcayb" + "content": "jkplvpbckbxcubunfqjdtcomx" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 27, - "prompt_tokens": 23, - "total_tokens": 30 + "completion_tokens": 28, + "prompt_tokens": 25, + "total_tokens": 20 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 32a9dce2a523..70ae70809e3e 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "ilu", - "embeddingsOptions": { + "azureml-model-deployment": "pj", + "body": { "input": [ - "fggycssnpxdiz" + "copkorrtsczhffddrkoc" ], "input_type": "text" } @@ -15,22 +15,22 @@ "responses": { "200": { "body": { - "id": "wglg", + "id": "lmoof", "data": [ { "embedding": [ - 9 + 23 ], - "index": 20, - "object": "oodpoxzonnvgdlrtliueknroxu" + "index": 5, + "object": "rhzfbdiitlbehkgkzgbdk" } ], "usage": { - "prompt_tokens": 6, - "total_tokens": 11 + "prompt_tokens": 23, + "total_tokens": 23 }, - "object": "xtkqgnviusvnficpmqxqphg", - "model": "tzkpqrstfzlaepnxxdcgm" + "object": "bxgcrzrbzpcehgvlfvssnfa", + "model": "bd" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index a95207e91f26..309e67a16e1d 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -3,31 +3,31 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "embeddingsOptions": { + "body": { "input": [ - "fggycssnpxdiz" + "cbhmyvfodvxizghzzkxfab" ] } }, "responses": { "200": { "body": { - "id": "wglg", + "id": "lmoof", "data": [ { "embedding": [ - 9 + 23 ], - "index": 20, - "object": "oodpoxzonnvgdlrtliueknroxu" + "index": 5, + "object": "rhzfbdiitlbehkgkzgbdk" } ], "usage": { - "prompt_tokens": 6, - "total_tokens": 11 + "prompt_tokens": 23, + "total_tokens": 23 }, - "object": "xtkqgnviusvnficpmqxqphg", - "model": "tzkpqrstfzlaepnxxdcgm" + "object": "bxgcrzrbzpcehgvlfvssnfa", + "model": "bd" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index f4ddf1b8a9e7..2b2bd0c687da 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -8,18 +8,13 @@ using TypeSpec.Versioning; namespace ModelClient; -@doc(""" -The configuration information for a chat completions request. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") -model ChatCompletionsOptions { +alias ChatCompletionsOptions = { @doc(""" - The collection of context messages associated with this chat completions request. - Typical usage begins with a chat message for the System role that provides instructions for - the behavior of the assistant, followed by alternating messages between the User and - Assistant roles. - """) + The collection of context messages associated with this chat completions request. + Typical usage begins with a chat message for the System role that provides instructions for + the behavior of the assistant, followed by alternating messages between the User and + Assistant roles. + """) @minItems(1) messages: ChatRequestMessage[]; @@ -100,7 +95,7 @@ model ChatCompletionsOptions { system_fingerprint response parameter to monitor changes in the backend." """) seed?: int64; -} +}; @doc(""" Representation of the response data from a chat completions request. diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp new file mode 100644 index 000000000000..01c4e7572e18 --- /dev/null +++ b/specification/ai/ModelClient/models/common.tsp @@ -0,0 +1,34 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace ModelClient; + +@doc("Defines the service behavior when unknown parameters are passed as extra properties in the request payload.") +enum UnknownParameters { + @doc("The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service.") + error: "error", + + @doc("The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model.") + ignore: "ignore", + + @doc("The service should pass unknown parameters to the back-end AI model.") + allow: "allow", +} + +alias AdditionalRequestHeaders = { + @doc("Controls what happens if unknown parameters are passed as extra properties in the request payload.") + @header("unknown-parameters") + unknownParameters?: UnknownParameters; + + @doc(""" + Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments. + Typically used when you want to target a test environment instead of production environment. + """) + @header("azureml-model-deployment") + modelDeployment?: string; +}; diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index 0ca77c043998..bddd2018e293 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -8,19 +8,14 @@ using TypeSpec.Versioning; namespace ModelClient; -@doc(""" -The configuration information for an embeddings request. -Embeddings measure the relatedness of text strings and are commonly used for search, clustering, -recommendations, and other similar scenarios. -""") -model EmbeddingsOptions { +alias EmbeddingsOptions = { @doc("Input texts to get embeddings for, encoded as a an array of strings.") input: string[]; @doc("Specifies the input type to use for embedding search.") @encodedName("application/json", "input_type") inputType?: EmbeddingInputType = EmbeddingInputType.text; -} +}; @doc(""" Representation of the response data from an embeddings request. diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index e9d3d49d2261..c95bccdce8b5 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -3,6 +3,7 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/versioning"; +import "./models/common.tsp"; import "./models/chat_completions.tsp"; import "./models/embeddings.tsp"; @@ -14,31 +15,6 @@ using Azure.Core; namespace ModelClient; -@doc("Defines the service behaviour when unknown parameters are passed as extra properties in the request payload.") -enum UnknownParameters { - @doc("The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service.") - error: "error", - - @doc("The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model.") - ignore: "ignore", - - @doc("The service should pass unknown parameters to the back-end AI model.") - allow: "allow", -} - -alias AdditionalRequestHeaders = { - @doc("Controls what happens if unknown parameters are passed as extra properties in the request payload.") - @header("unknown-parameters") - unknownParameters?: UnknownParameters; - - @doc(""" - Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments. - Typically used when you want to target a test enviroment instead of production enviroment. - """) - @header("azureml-model-deployment") - modelDeployment?: string; -}; - @doc(""" Gets chat completions for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" @@ -48,10 +24,7 @@ provided prompt data. @route("v1/chat/completions") op getChatCompletions is Azure.Core.RpcOperation< { - @doc("The JSON payload containing chat completion options.") - @body - chatCompletionsOptions: ChatCompletionsOptions; - + ...ChatCompletionsOptions; ...AdditionalRequestHeaders; }, ChatCompletions @@ -62,10 +35,7 @@ op getChatCompletions is Azure.Core.RpcOperation< @route("v1/embeddings") op getEmbeddings is Azure.Core.RpcOperation< { - @doc("The JSON payload containing embedding options.") - @body - embeddingsOptions: EmbeddingsOptions; - + ...EmbeddingsOptions; ...AdditionalRequestHeaders; }, EmbeddingsResult diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 9fa3934a4a8a..7b9b0fc36f6a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -4,14 +4,14 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "avoclyhqnmuivlomzxvficq", - "chatCompletionsOptions": { + "azureml-model-deployment": "plpjuedmhjyrqlyxwz", + "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, + "frequency_penalty": 1, "presence_penalty": -2, "temperature": 0, "top_p": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "ordrqcoghor" + "uamtjzfmqyaitpylvvugdy" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 30 + "seed": 12 } }, "responses": { "200": { "body": { - "id": "hsmpiuxgi", - "object": "t", - "created": 16, - "model": "okmnhcumjvfneohbpldhttbfzjg", + "id": "baauxksfzyiaksvy", + "object": "uzorevsijgizsvkzn", + "created": 10, + "model": "ogtsmawgfrtch", "choices": [ { - "index": 11, + "index": 23, "message": { "role": "system", - "content": "uqysdzkjdqaiiyyvyutoqcayb", + "content": "jkplvpbckbxcubunfqjdtcomx", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "obnwznlmlydakxk" + "id": "wtiayzuayhvkqtsygfcwwbayfforo" } ] }, @@ -55,9 +55,9 @@ } ], "usage": { - "completion_tokens": 27, - "prompt_tokens": 23, - "total_tokens": 30 + "completion_tokens": 28, + "prompt_tokens": 25, + "total_tokens": 20 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 62961eac3b50..2450df698b22 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "chatCompletionsOptions": { + "body": { "messages": [ { "role": "ChatRequestMessage" @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "hsmpiuxgi", - "object": "t", - "created": 16, - "model": "okmnhcumjvfneohbpldhttbfzjg", + "id": "baauxksfzyiaksvy", + "object": "uzorevsijgizsvkzn", + "created": 10, + "model": "ogtsmawgfrtch", "choices": [ { - "index": 11, + "index": 23, "message": { "role": "system", - "content": "uqysdzkjdqaiiyyvyutoqcayb" + "content": "jkplvpbckbxcubunfqjdtcomx" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 27, - "prompt_tokens": 23, - "total_tokens": 30 + "completion_tokens": 28, + "prompt_tokens": 25, + "total_tokens": 20 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 32a9dce2a523..70ae70809e3e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "ilu", - "embeddingsOptions": { + "azureml-model-deployment": "pj", + "body": { "input": [ - "fggycssnpxdiz" + "copkorrtsczhffddrkoc" ], "input_type": "text" } @@ -15,22 +15,22 @@ "responses": { "200": { "body": { - "id": "wglg", + "id": "lmoof", "data": [ { "embedding": [ - 9 + 23 ], - "index": 20, - "object": "oodpoxzonnvgdlrtliueknroxu" + "index": 5, + "object": "rhzfbdiitlbehkgkzgbdk" } ], "usage": { - "prompt_tokens": 6, - "total_tokens": 11 + "prompt_tokens": 23, + "total_tokens": 23 }, - "object": "xtkqgnviusvnficpmqxqphg", - "model": "tzkpqrstfzlaepnxxdcgm" + "object": "bxgcrzrbzpcehgvlfvssnfa", + "model": "bd" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index a95207e91f26..309e67a16e1d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -3,31 +3,31 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "embeddingsOptions": { + "body": { "input": [ - "fggycssnpxdiz" + "cbhmyvfodvxizghzzkxfab" ] } }, "responses": { "200": { "body": { - "id": "wglg", + "id": "lmoof", "data": [ { "embedding": [ - 9 + 23 ], - "index": 20, - "object": "oodpoxzonnvgdlrtliueknroxu" + "index": 5, + "object": "rhzfbdiitlbehkgkzgbdk" } ], "usage": { - "prompt_tokens": 6, - "total_tokens": 11 + "prompt_tokens": 23, + "total_tokens": 23 }, - "object": "xtkqgnviusvnficpmqxqphg", - "model": "tzkpqrstfzlaepnxxdcgm" + "object": "bxgcrzrbzpcehgvlfvssnfa", + "model": "bd" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index a69fad17cc76..33cda3d06b53 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -46,7 +46,7 @@ { "name": "error", "value": "error", - "description": "The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service." + "description": "The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service." }, { "name": "ignore", @@ -65,18 +65,104 @@ { "name": "azureml-model-deployment", "in": "header", - "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test enviroment instead of production enviroment.", + "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", "required": false, "type": "string", "x-ms-client-name": "modelDeployment" }, { - "name": "chatCompletionsOptions", + "name": "body", "in": "body", - "description": "The JSON payload containing chat completion options.", "required": true, "schema": { - "$ref": "#/definitions/ChatCompletionsOptions" + "type": "object", + "properties": { + "messages": { + "type": "array", + "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ChatRequestMessage" + }, + "x-ms-identifiers": [] + }, + "frequency_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "presence_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "default": 0.7, + "minimum": 0, + "maximum": 1 + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "default": 1, + "minimum": 0, + "maximum": 1 + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tokens to generate.", + "minimum": 0 + }, + "response_format": { + "$ref": "#/definitions/ChatCompletionsResponseFormat", + "description": "An object specifying the format that the model must output. Used to enable JSON mode." + }, + "stop": { + "type": "array", + "description": "A collection of textual sequences that will end completions generation.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "stream": { + "type": "boolean", + "description": "A value indicating whether chat completions should be streamed for this request.", + "default": false + }, + "tools": { + "type": "array", + "description": "The available tool definitions that the chat completions request can use, including caller-defined functions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ChatCompletionsToolDefinition" + }, + "x-ms-identifiers": [] + }, + "tool_choice": { + "description": "If specified, the model will configure which of the provided tools it can use for the chat completions response.", + "x-ms-client-name": "toolChoice" + }, + "seed": { + "type": "integer", + "format": "int64", + "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the\nsystem_fingerprint response parameter to monitor changes in the backend.\"" + } + }, + "required": [ + "messages" + ] } } ], @@ -136,7 +222,7 @@ { "name": "error", "value": "error", - "description": "The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service." + "description": "The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service." }, { "name": "ignore", @@ -155,18 +241,61 @@ { "name": "azureml-model-deployment", "in": "header", - "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test enviroment instead of production enviroment.", + "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", "required": false, "type": "string", "x-ms-client-name": "modelDeployment" }, { - "name": "embeddingsOptions", + "name": "body", "in": "body", - "description": "The JSON payload containing embedding options.", "required": true, "schema": { - "$ref": "#/definitions/EmbeddingsOptions" + "type": "object", + "properties": { + "input": { + "type": "array", + "description": "Input texts to get embeddings for, encoded as a an array of strings.", + "items": { + "type": "string" + } + }, + "input_type": { + "type": "string", + "description": "Specifies the input type to use for embedding search.", + "default": "text", + "enum": [ + "text", + "query", + "document" + ], + "x-ms-enum": { + "name": "EmbeddingInputType", + "modelAsString": true, + "values": [ + { + "name": "text", + "value": "text", + "description": "to do" + }, + { + "name": "query", + "value": "query", + "description": "to do" + }, + { + "name": "document", + "value": "document", + "description": "to do" + } + ] + }, + "x-ms-client-name": "inputType" + } + }, + "required": [ + "input" + ] } } ], @@ -394,97 +523,6 @@ "type" ] }, - "ChatCompletionsOptions": { - "type": "object", - "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", - "properties": { - "messages": { - "type": "array", - "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", - "minItems": 1, - "items": { - "$ref": "#/definitions/ChatRequestMessage" - }, - "x-ms-identifiers": [] - }, - "frequency_penalty": { - "type": "number", - "format": "float", - "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", - "default": 0, - "minimum": -2, - "maximum": 2 - }, - "presence_penalty": { - "type": "number", - "format": "float", - "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", - "default": 0, - "minimum": -2, - "maximum": 2 - }, - "temperature": { - "type": "number", - "format": "float", - "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", - "default": 0.7, - "minimum": 0, - "maximum": 1 - }, - "top_p": { - "type": "number", - "format": "float", - "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", - "default": 1, - "minimum": 0, - "maximum": 1 - }, - "max_tokens": { - "type": "integer", - "format": "int32", - "description": "The maximum number of tokens to generate.", - "minimum": 0 - }, - "response_format": { - "$ref": "#/definitions/ChatCompletionsResponseFormat", - "description": "An object specifying the format that the model must output. Used to enable JSON mode." - }, - "stop": { - "type": "array", - "description": "A collection of textual sequences that will end completions generation.", - "minItems": 1, - "items": { - "type": "string" - } - }, - "stream": { - "type": "boolean", - "description": "A value indicating whether chat completions should be streamed for this request.", - "default": false - }, - "tools": { - "type": "array", - "description": "The available tool definitions that the chat completions request can use, including caller-defined functions.", - "minItems": 1, - "items": { - "$ref": "#/definitions/ChatCompletionsToolDefinition" - }, - "x-ms-identifiers": [] - }, - "tool_choice": { - "description": "If specified, the model will configure which of the provided tools it can use for the chat completions response.", - "x-ms-client-name": "toolChoice" - }, - "seed": { - "type": "integer", - "format": "int64", - "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the\nsystem_fingerprint response parameter to monitor changes in the backend.\"" - } - }, - "required": [ - "messages" - ] - }, "ChatCompletionsResponseFormat": { "type": "object", "description": "An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON\nmode.", @@ -841,54 +879,6 @@ "object" ] }, - "EmbeddingsOptions": { - "type": "object", - "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", - "properties": { - "input": { - "type": "array", - "description": "Input texts to get embeddings for, encoded as a an array of strings.", - "items": { - "type": "string" - } - }, - "input_type": { - "type": "string", - "description": "Specifies the input type to use for embedding search.", - "default": "text", - "enum": [ - "text", - "query", - "document" - ], - "x-ms-enum": { - "name": "EmbeddingInputType", - "modelAsString": true, - "values": [ - { - "name": "text", - "value": "text", - "description": "to do" - }, - { - "name": "query", - "value": "query", - "description": "to do" - }, - { - "name": "document", - "value": "document", - "description": "to do" - } - ] - }, - "x-ms-client-name": "inputType" - } - }, - "required": [ - "input" - ] - }, "EmbeddingsResult": { "type": "object", "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", @@ -988,7 +978,7 @@ }, "UnknownParameters": { "type": "string", - "description": "Defines the service behaviour when unknown parameters are passed as extra properties in the request payload.", + "description": "Defines the service behavior when unknown parameters are passed as extra properties in the request payload.", "enum": [ "error", "ignore", @@ -1001,7 +991,7 @@ { "name": "error", "value": "error", - "description": "The service should error when it sees unknown parameters in the request payload. This is the default behaviour if the service." + "description": "The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service." }, { "name": "ignore", From efeef7a343c495b1c2d525dd3aacf2dbc894ceb8 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 2 Apr 2024 17:56:35 -0700 Subject: [PATCH 036/343] Add image generation --- .../GetChatCompletions_MaximumSet_Gen.json | 28 +-- .../GetChatCompletions_MinimumSet_Gen.json | 18 +- .../GetEmbeddings_MaximumSet_Gen.json | 20 +- .../GetEmbeddings_MinimumSet_Gen.json | 18 +- .../GetImageGenerations_MaximumSet_Gen.json | 31 +++ .../GetImageGenerations_MinimumSet_Gen.json | 23 ++ .../ModelClient/models/chat_completions.tsp | 3 +- .../ModelClient/models/image_generation.tsp | 89 +++++++ specification/ai/ModelClient/routes.tsp | 12 + .../GetChatCompletions_MaximumSet_Gen.json | 28 +-- .../GetChatCompletions_MinimumSet_Gen.json | 18 +- .../GetEmbeddings_MaximumSet_Gen.json | 20 +- .../GetEmbeddings_MinimumSet_Gen.json | 18 +- .../GetImageGenerations_MaximumSet_Gen.json | 31 +++ .../GetImageGenerations_MinimumSet_Gen.json | 23 ++ .../preview/2024-04-01-preview/openapi.json | 235 +++++++++++++++++- 16 files changed, 528 insertions(+), 87 deletions(-) create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json create mode 100644 specification/ai/ModelClient/models/image_generation.tsp create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 7b9b0fc36f6a..be65975ee2d4 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -4,14 +4,14 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "plpjuedmhjyrqlyxwz", + "azureml-model-deployment": "pglefvljhlzoukl", "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, + "frequency_penalty": 0, "presence_penalty": -2, "temperature": 0, "top_p": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "uamtjzfmqyaitpylvvugdy" + "jqdujnbcklauuaxnj" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 12 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "baauxksfzyiaksvy", - "object": "uzorevsijgizsvkzn", - "created": 10, - "model": "ogtsmawgfrtch", + "id": "gbtiscxtqmztyjrmikhf", + "object": "tydbybazyllfxdp", + "created": 20, + "model": "qigsmvvmaqfkuuirqqpfynpxkfvinz", "choices": [ { - "index": 23, + "index": 28, "message": { "role": "system", - "content": "jkplvpbckbxcubunfqjdtcomx", + "content": "iwzinrm", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "wtiayzuayhvkqtsygfcwwbayfforo" + "id": "mekxvfnststwlebncvajqpwnxn" } ] }, @@ -55,9 +55,9 @@ } ], "usage": { - "completion_tokens": 28, - "prompt_tokens": 25, - "total_tokens": 20 + "completion_tokens": 3, + "prompt_tokens": 1, + "total_tokens": 19 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 2450df698b22..281787c5ce9f 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "baauxksfzyiaksvy", - "object": "uzorevsijgizsvkzn", - "created": 10, - "model": "ogtsmawgfrtch", + "id": "gbtiscxtqmztyjrmikhf", + "object": "tydbybazyllfxdp", + "created": 20, + "model": "qigsmvvmaqfkuuirqqpfynpxkfvinz", "choices": [ { - "index": 23, + "index": 28, "message": { "role": "system", - "content": "jkplvpbckbxcubunfqjdtcomx" + "content": "iwzinrm" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 28, - "prompt_tokens": 25, - "total_tokens": 20 + "completion_tokens": 3, + "prompt_tokens": 1, + "total_tokens": 19 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 70ae70809e3e..b5c948b0879a 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "pj", + "azureml-model-deployment": "ewpcbieff", "body": { "input": [ - "copkorrtsczhffddrkoc" + "htpg" ], "input_type": "text" } @@ -15,22 +15,22 @@ "responses": { "200": { "body": { - "id": "lmoof", + "id": "xhwyggbsdaimiakvmsxcirfu", "data": [ { "embedding": [ - 23 + 18 ], - "index": 5, - "object": "rhzfbdiitlbehkgkzgbdk" + "index": 16, + "object": "lyicymftklj" } ], "usage": { - "prompt_tokens": 23, - "total_tokens": 23 + "prompt_tokens": 27, + "total_tokens": 2 }, - "object": "bxgcrzrbzpcehgvlfvssnfa", - "model": "bd" + "object": "szvtzcwsefzswpnfcboxfxiiyo", + "model": "jbgvgbjqmomyeslsyljyktwiipv" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 309e67a16e1d..4abf1bdcfb25 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,29 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "cbhmyvfodvxizghzzkxfab" + "vskamvbcowdzrfqznbuvkrclpu" ] } }, "responses": { "200": { "body": { - "id": "lmoof", + "id": "xhwyggbsdaimiakvmsxcirfu", "data": [ { "embedding": [ - 23 + 18 ], - "index": 5, - "object": "rhzfbdiitlbehkgkzgbdk" + "index": 16, + "object": "lyicymftklj" } ], "usage": { - "prompt_tokens": 23, - "total_tokens": 23 + "prompt_tokens": 27, + "total_tokens": 2 }, - "object": "bxgcrzrbzpcehgvlfvssnfa", - "model": "bd" + "object": "szvtzcwsefzswpnfcboxfxiiyo", + "model": "jbgvgbjqmomyeslsyljyktwiipv" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json new file mode 100644 index 000000000000..21846c9eb0ed --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "maximum set image generation", + "operationId": "GetImageGenerations", + "parameters": { + "api-version": "2024-04-01-preview", + "unknown-parameters": "error", + "azureml-model-deployment": "yx", + "body": { + "prompt": "xooawhhxrfiknuehilafefwnvtly", + "size": "iwitljodl", + "quality": "standard", + "response_format": "url", + "seed": 13 + } + }, + "responses": { + "200": { + "body": { + "id": "m", + "created": 6, + "model": "xciqbsjgbyjvqhjep", + "data": [ + { + "url": "https://microsoft.com/a", + "b64_json": "aatitlaotrwfubwvqciv" + } + ] + } + } + } +} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json new file mode 100644 index 000000000000..082b41bd4060 --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "title": "minimum set image generation", + "operationId": "GetImageGenerations", + "parameters": { + "api-version": "2024-04-01-preview", + "body": { + "prompt": "uvyrmwtflhulaegrbfeb", + "size": "vkvsmfyrmvjpsqitqiiik" + } + }, + "responses": { + "200": { + "body": { + "id": "m", + "created": 6, + "model": "xciqbsjgbyjvqhjep", + "data": [ + {} + ] + } + } + } +} diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 2b2bd0c687da..5916292b45fc 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -91,8 +91,7 @@ alias ChatCompletionsOptions = { @doc(""" If specified, the system will make a best effort to sample deterministically such that repeated requests with the - same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the - system_fingerprint response parameter to monitor changes in the backend." + same seed and parameters should return the same result. Determinism is not guaranteed." """) seed?: int64; }; diff --git a/specification/ai/ModelClient/models/image_generation.tsp b/specification/ai/ModelClient/models/image_generation.tsp new file mode 100644 index 000000000000..d84b608ca49d --- /dev/null +++ b/specification/ai/ModelClient/models/image_generation.tsp @@ -0,0 +1,89 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace ModelClient; + +alias ImageGenerationOptions = { + @doc("A description of the desired images.") + prompt: string; + + @doc(""" + The desired dimension in pixels of the generated images, in the format "WidthxHeight". + For example: "1024x1024", "1792x1024". + """) + size: string; + + @doc(""" + The desired image generation quality level to use. + """) + quality?: ImageGenerationQuality = ImageGenerationQuality.standard; + + @doc("The format in which image generation response items should be presented.") + response_format?: ImageGenerationResponseFormat; + + @doc(""" + If specified, the system will make a best effort to sample deterministically such that repeated requests with the + same seed and parameters should return the same result. Determinism is not guaranteed." + """) + seed?: int64; +}; + +@doc("The result of a successful image generation operation.") +model ImageGenerations { + @doc("A unique identifier associated with this image generation response.") + id: string; + + @doc(""" + A timestamp representing when this operation was started. + Represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. + """) + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + created: utcDateTime; + + @doc("The model used for the image generation.") + `model`: string; + + @doc("The images generated by the operation.") + data: ImageGenerationData[]; +} + +@doc(""" +An image generation configuration that specifies how the model should prioritize quality, cost, and speed. +""") +enum ImageGenerationQuality { + @doc(""" + Requests image generation with standard, balanced characteristics of quality, cost, and speed. + """) + standard: "standard", + + @doc(""" + Requests image generation with higher quality, higher cost and lower speed relative to standard. + """) + hd: "hd", +} + +@doc("The format in which the generated images are returned.") +enum ImageGenerationResponseFormat { + @doc("Image generation response items should provide a URL from which the image may be retrieved.") + url: "url", + + @doc("Image generation response items should provide image data as a base64-encoded string.") + base64: "b64_json", +} + +@doc(""" +A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image +may be retrieved. +""") +model ImageGenerationData { + @doc("The URL that provides temporary access to download the generated image.") + url?: url; + + @doc("The complete data for an image, represented as a base64-encoded string.") + b64_json?: string; +} diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index c95bccdce8b5..a160a921522b 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -6,6 +6,7 @@ import "@typespec/versioning"; import "./models/common.tsp"; import "./models/chat_completions.tsp"; import "./models/embeddings.tsp"; +import "./models/image_generation.tsp"; using TypeSpec.Rest; using TypeSpec.Http; @@ -40,3 +41,14 @@ op getEmbeddings is Azure.Core.RpcOperation< }, EmbeddingsResult >; + +@doc("Creates images given a prompt.") +@actionSeparator("/") +@route("v1/images/generations") +op getImageGenerations is Azure.Core.RpcOperation< + { + ...ImageGenerationOptions; + ...AdditionalRequestHeaders; + }, + ImageGenerations +>; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 7b9b0fc36f6a..be65975ee2d4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -4,14 +4,14 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "plpjuedmhjyrqlyxwz", + "azureml-model-deployment": "pglefvljhlzoukl", "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, + "frequency_penalty": 0, "presence_penalty": -2, "temperature": 0, "top_p": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "uamtjzfmqyaitpylvvugdy" + "jqdujnbcklauuaxnj" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 12 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "baauxksfzyiaksvy", - "object": "uzorevsijgizsvkzn", - "created": 10, - "model": "ogtsmawgfrtch", + "id": "gbtiscxtqmztyjrmikhf", + "object": "tydbybazyllfxdp", + "created": 20, + "model": "qigsmvvmaqfkuuirqqpfynpxkfvinz", "choices": [ { - "index": 23, + "index": 28, "message": { "role": "system", - "content": "jkplvpbckbxcubunfqjdtcomx", + "content": "iwzinrm", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "wtiayzuayhvkqtsygfcwwbayfforo" + "id": "mekxvfnststwlebncvajqpwnxn" } ] }, @@ -55,9 +55,9 @@ } ], "usage": { - "completion_tokens": 28, - "prompt_tokens": 25, - "total_tokens": 20 + "completion_tokens": 3, + "prompt_tokens": 1, + "total_tokens": 19 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 2450df698b22..281787c5ce9f 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,24 @@ "responses": { "200": { "body": { - "id": "baauxksfzyiaksvy", - "object": "uzorevsijgizsvkzn", - "created": 10, - "model": "ogtsmawgfrtch", + "id": "gbtiscxtqmztyjrmikhf", + "object": "tydbybazyllfxdp", + "created": 20, + "model": "qigsmvvmaqfkuuirqqpfynpxkfvinz", "choices": [ { - "index": 23, + "index": 28, "message": { "role": "system", - "content": "jkplvpbckbxcubunfqjdtcomx" + "content": "iwzinrm" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 28, - "prompt_tokens": 25, - "total_tokens": 20 + "completion_tokens": 3, + "prompt_tokens": 1, + "total_tokens": 19 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 70ae70809e3e..b5c948b0879a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "pj", + "azureml-model-deployment": "ewpcbieff", "body": { "input": [ - "copkorrtsczhffddrkoc" + "htpg" ], "input_type": "text" } @@ -15,22 +15,22 @@ "responses": { "200": { "body": { - "id": "lmoof", + "id": "xhwyggbsdaimiakvmsxcirfu", "data": [ { "embedding": [ - 23 + 18 ], - "index": 5, - "object": "rhzfbdiitlbehkgkzgbdk" + "index": 16, + "object": "lyicymftklj" } ], "usage": { - "prompt_tokens": 23, - "total_tokens": 23 + "prompt_tokens": 27, + "total_tokens": 2 }, - "object": "bxgcrzrbzpcehgvlfvssnfa", - "model": "bd" + "object": "szvtzcwsefzswpnfcboxfxiiyo", + "model": "jbgvgbjqmomyeslsyljyktwiipv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 309e67a16e1d..4abf1bdcfb25 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,29 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "cbhmyvfodvxizghzzkxfab" + "vskamvbcowdzrfqznbuvkrclpu" ] } }, "responses": { "200": { "body": { - "id": "lmoof", + "id": "xhwyggbsdaimiakvmsxcirfu", "data": [ { "embedding": [ - 23 + 18 ], - "index": 5, - "object": "rhzfbdiitlbehkgkzgbdk" + "index": 16, + "object": "lyicymftklj" } ], "usage": { - "prompt_tokens": 23, - "total_tokens": 23 + "prompt_tokens": 27, + "total_tokens": 2 }, - "object": "bxgcrzrbzpcehgvlfvssnfa", - "model": "bd" + "object": "szvtzcwsefzswpnfcboxfxiiyo", + "model": "jbgvgbjqmomyeslsyljyktwiipv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json new file mode 100644 index 000000000000..21846c9eb0ed --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "maximum set image generation", + "operationId": "GetImageGenerations", + "parameters": { + "api-version": "2024-04-01-preview", + "unknown-parameters": "error", + "azureml-model-deployment": "yx", + "body": { + "prompt": "xooawhhxrfiknuehilafefwnvtly", + "size": "iwitljodl", + "quality": "standard", + "response_format": "url", + "seed": 13 + } + }, + "responses": { + "200": { + "body": { + "id": "m", + "created": 6, + "model": "xciqbsjgbyjvqhjep", + "data": [ + { + "url": "https://microsoft.com/a", + "b64_json": "aatitlaotrwfubwvqciv" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json new file mode 100644 index 000000000000..082b41bd4060 --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "title": "minimum set image generation", + "operationId": "GetImageGenerations", + "parameters": { + "api-version": "2024-04-01-preview", + "body": { + "prompt": "uvyrmwtflhulaegrbfeb", + "size": "vkvsmfyrmvjpsqitqiiik" + } + }, + "responses": { + "200": { + "body": { + "id": "m", + "created": 6, + "model": "xciqbsjgbyjvqhjep", + "data": [ + {} + ] + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 33cda3d06b53..9f0f2157d54d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -157,7 +157,7 @@ "seed": { "type": "integer", "format": "int64", - "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the\nsystem_fingerprint response parameter to monitor changes in the backend.\"" + "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed.\"" } }, "required": [ @@ -328,6 +328,143 @@ } } } + }, + "/v1/images/generations": { + "post": { + "operationId": "GetImageGenerations", + "description": "Creates images given a prompt.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "unknown-parameters", + "in": "header", + "description": "Controls what happens if unknown parameters are passed as extra properties in the request payload.", + "required": false, + "type": "string", + "enum": [ + "error", + "ignore", + "allow" + ], + "x-ms-enum": { + "name": "UnknownParameters", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "error", + "description": "The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service." + }, + { + "name": "ignore", + "value": "ignore", + "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." + }, + { + "name": "allow", + "value": "allow", + "description": "The service should pass unknown parameters to the back-end AI model." + } + ] + }, + "x-ms-client-name": "unknownParameters" + }, + { + "name": "azureml-model-deployment", + "in": "header", + "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", + "required": false, + "type": "string", + "x-ms-client-name": "modelDeployment" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "prompt": { + "type": "string", + "description": "A description of the desired images." + }, + "size": { + "type": "string", + "description": "The desired dimension in pixels of the generated images, in the format \"WidthxHeight\".\nFor example: \"1024x1024\", \"1792x1024\"." + }, + "quality": { + "type": "string", + "description": "The desired image generation quality level to use.", + "default": "standard", + "enum": [ + "standard", + "hd" + ], + "x-ms-enum": { + "name": "ImageGenerationQuality", + "modelAsString": true, + "values": [ + { + "name": "standard", + "value": "standard", + "description": "Requests image generation with standard, balanced characteristics of quality, cost, and speed." + }, + { + "name": "hd", + "value": "hd", + "description": "Requests image generation with higher quality, higher cost and lower speed relative to standard." + } + ] + } + }, + "response_format": { + "$ref": "#/definitions/ImageGenerationResponseFormat", + "description": "The format in which image generation response items should be presented." + }, + "seed": { + "type": "integer", + "format": "int64", + "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed.\"" + } + }, + "required": [ + "prompt", + "size" + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageGenerations" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "maximum set image generation": { + "$ref": "./examples/GetImageGenerations_MaximumSet_Gen.json" + }, + "minimum set image generation": { + "$ref": "./examples/GetImageGenerations_MinimumSet_Gen.json" + } + } + } } }, "definitions": { @@ -976,6 +1113,102 @@ "name" ] }, + "ImageGenerationData": { + "type": "object", + "description": "A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image\nmay be retrieved.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The URL that provides temporary access to download the generated image." + }, + "b64_json": { + "type": "string", + "description": "The complete data for an image, represented as a base64-encoded string." + } + } + }, + "ImageGenerationQuality": { + "type": "string", + "description": "An image generation configuration that specifies how the model should prioritize quality, cost, and speed.", + "enum": [ + "standard", + "hd" + ], + "x-ms-enum": { + "name": "ImageGenerationQuality", + "modelAsString": true, + "values": [ + { + "name": "standard", + "value": "standard", + "description": "Requests image generation with standard, balanced characteristics of quality, cost, and speed." + }, + { + "name": "hd", + "value": "hd", + "description": "Requests image generation with higher quality, higher cost and lower speed relative to standard." + } + ] + } + }, + "ImageGenerationResponseFormat": { + "type": "string", + "description": "The format in which the generated images are returned.", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + } + }, + "ImageGenerations": { + "type": "object", + "description": "The result of a successful image generation operation.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier associated with this image generation response." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "A timestamp representing when this operation was started.\nRepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "model": { + "type": "string", + "description": "The model used for the image generation." + }, + "data": { + "type": "array", + "description": "The images generated by the operation.", + "items": { + "$ref": "#/definitions/ImageGenerationData" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "id", + "created", + "model", + "data" + ] + }, "UnknownParameters": { "type": "string", "description": "Defines the service behavior when unknown parameters are passed as extra properties in the request payload.", From 9af8c9eba492a737bb53529bd6afed77b65eed04 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 3 Apr 2024 22:14:22 -0700 Subject: [PATCH 037/343] Update 'Usage' models --- .../GetChatCompletions_MaximumSet_Gen.json | 29 +++---- .../GetChatCompletions_MinimumSet_Gen.json | 19 ++--- .../GetEmbeddings_MaximumSet_Gen.json | 22 ++--- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++--- .../GetImageGenerations_MaximumSet_Gen.json | 16 ++-- .../GetImageGenerations_MinimumSet_Gen.json | 10 +-- .../ModelClient/models/chat_completions.tsp | 2 + .../ai/ModelClient/models/common.tsp | 15 ++++ .../ai/ModelClient/models/embeddings.tsp | 20 +++-- .../ModelClient/models/image_generation.tsp | 2 +- .../GetChatCompletions_MaximumSet_Gen.json | 29 +++---- .../GetChatCompletions_MinimumSet_Gen.json | 19 ++--- .../GetEmbeddings_MaximumSet_Gen.json | 22 ++--- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++--- .../GetImageGenerations_MaximumSet_Gen.json | 16 ++-- .../GetImageGenerations_MinimumSet_Gen.json | 10 +-- .../preview/2024-04-01-preview/openapi.json | 80 +++++++++++-------- 17 files changed, 198 insertions(+), 153 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index be65975ee2d4..baf6b6503c2d 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -4,14 +4,14 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "pglefvljhlzoukl", + "azureml-model-deployment": "wdodqzfxtbqauxfgbn", "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, + "frequency_penalty": -1, "presence_penalty": -2, "temperature": 0, "top_p": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "jqdujnbcklauuaxnj" + "kpfcmsvturnjvs" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 21 + "seed": 20 } }, "responses": { "200": { "body": { - "id": "gbtiscxtqmztyjrmikhf", - "object": "tydbybazyllfxdp", - "created": 20, - "model": "qigsmvvmaqfkuuirqqpfynpxkfvinz", + "id": "zzbqzxgihnxvmyampgwdchdp", + "object": "nhtver", + "created": 8, + "model": "lgywxagwtjilh", "choices": [ { - "index": 28, + "index": 20, "message": { "role": "system", - "content": "iwzinrm", + "content": "iyjepwhcjyagt", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "mekxvfnststwlebncvajqpwnxn" + "id": "isgyupqydkgqgizqknaywafmky" } ] }, @@ -55,9 +55,10 @@ } ], "usage": { - "completion_tokens": 3, - "prompt_tokens": 1, - "total_tokens": 19 + "capacity_type": "usage", + "completion_tokens": 2, + "prompt_tokens": 11, + "total_tokens": 12 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 281787c5ce9f..773b31e73302 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,25 @@ "responses": { "200": { "body": { - "id": "gbtiscxtqmztyjrmikhf", - "object": "tydbybazyllfxdp", - "created": 20, - "model": "qigsmvvmaqfkuuirqqpfynpxkfvinz", + "id": "zzbqzxgihnxvmyampgwdchdp", + "object": "nhtver", + "created": 8, + "model": "lgywxagwtjilh", "choices": [ { - "index": 28, + "index": 20, "message": { "role": "system", - "content": "iwzinrm" + "content": "iyjepwhcjyagt" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 3, - "prompt_tokens": 1, - "total_tokens": 19 + "capacity_type": "usage", + "completion_tokens": 2, + "prompt_tokens": 11, + "total_tokens": 12 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index b5c948b0879a..d9fec11e8f88 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "ewpcbieff", + "azureml-model-deployment": "cnquvjshwxwasejrlribvxspgdcyno", "body": { "input": [ - "htpg" + "rvdcugmgaxsweyxmwacexiqzzdnv" ], "input_type": "text" } @@ -15,22 +15,24 @@ "responses": { "200": { "body": { - "id": "xhwyggbsdaimiakvmsxcirfu", + "id": "xoxxbviodejcnefbc", "data": [ { "embedding": [ - 18 + 9 ], - "index": 16, - "object": "lyicymftklj" + "index": 17, + "object": "qpnhqtqlctkj" } ], "usage": { - "prompt_tokens": 27, - "total_tokens": 2 + "capacity_type": "usage", + "input_tokens": 7, + "prompt_tokens": 21, + "total_tokens": 14 }, - "object": "szvtzcwsefzswpnfcboxfxiiyo", - "model": "jbgvgbjqmomyeslsyljyktwiipv" + "object": "hwtzuzdatzukwdmznv", + "model": "dntviiybgquylte" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 4abf1bdcfb25..42296f286558 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "vskamvbcowdzrfqznbuvkrclpu" + "uksdjffdaorxqxuv" ] } }, "responses": { "200": { "body": { - "id": "xhwyggbsdaimiakvmsxcirfu", + "id": "xoxxbviodejcnefbc", "data": [ { "embedding": [ - 18 + 9 ], - "index": 16, - "object": "lyicymftklj" + "index": 17, + "object": "qpnhqtqlctkj" } ], "usage": { - "prompt_tokens": 27, - "total_tokens": 2 + "capacity_type": "usage", + "input_tokens": 7, + "prompt_tokens": 21, + "total_tokens": 14 }, - "object": "szvtzcwsefzswpnfcboxfxiiyo", - "model": "jbgvgbjqmomyeslsyljyktwiipv" + "object": "hwtzuzdatzukwdmznv", + "model": "dntviiybgquylte" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json index 21846c9eb0ed..0208a82a6442 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -4,25 +4,25 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "yx", + "azureml-model-deployment": "zpckrf", "body": { - "prompt": "xooawhhxrfiknuehilafefwnvtly", - "size": "iwitljodl", + "prompt": "wuifyhjsmqrfkpq", + "size": "qsmjjuclpkbzey", "quality": "standard", "response_format": "url", - "seed": 13 + "seed": 25 } }, "responses": { "200": { "body": { - "id": "m", - "created": 6, - "model": "xciqbsjgbyjvqhjep", + "id": "eoamupfuehbrw", + "created": 27, + "model": "afanuwmlmewyeorjjurb", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "aatitlaotrwfubwvqciv" + "b64_json": "uydlomkfojh" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json index 082b41bd4060..4f83c6e65ce8 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "uvyrmwtflhulaegrbfeb", - "size": "vkvsmfyrmvjpsqitqiiik" + "prompt": "jpyuhpnidpubidvtzptzlnw", + "size": "odumumkfabzoorusutucauolkaexjy" } }, "responses": { "200": { "body": { - "id": "m", - "created": 6, - "model": "xciqbsjgbyjvqhjep", + "id": "eoamupfuehbrw", + "created": 27, + "model": "afanuwmlmewyeorjjurb", "data": [ {} ] diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 5916292b45fc..29fb67bfff25 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -138,6 +138,8 @@ Counts consider all tokens across prompts, choices, choice alternates, best_of g other consumers. """) model CompletionsUsage { + ...CapacityAlias; + @doc("The number of tokens generated across all completions emissions.") completion_tokens: int32; diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 01c4e7572e18..41834284102a 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -32,3 +32,18 @@ alias AdditionalRequestHeaders = { @header("azureml-model-deployment") modelDeployment?: string; }; + + +alias CapacityAlias = { + @doc("Indicates whether your capacity has been affected by the usage amount (token count) reported here.") + capacity_type: CapacityType; +}; + +@doc("Whether your capacity has been afected by the usage amount (token count) reported here.") +enum CapacityType { + @doc("Your capacity has been affected by the usage amount (token count) reported here.") + error: "usage", + + @doc("Your capacity has not been affected by the usage amount (token count) reported here.") + ignore: "fixed", +} diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index bddd2018e293..3fd85b52dd7e 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -13,8 +13,7 @@ alias EmbeddingsOptions = { input: string[]; @doc("Specifies the input type to use for embedding search.") - @encodedName("application/json", "input_type") - inputType?: EmbeddingInputType = EmbeddingInputType.text; + input_type?: EmbeddingInputType; }; @doc(""" @@ -68,11 +67,18 @@ model EmbeddingItem { @doc("Measurement of the amount of tokens used in this request and response.") model EmbeddingsUsage { - @doc("Number of tokens sent in the original request.") - @encodedName("application/json", "prompt_tokens") - promptTokens: int32; + ...CapacityAlias; + + @doc("Number of tokens in the request prompt.") + input_tokens: int32; + + @doc(""" + Number of tokens used for the prompt sent to the AI model. Typically identical to`input_tokens`. + However, certain AI models may add extra tokens to the input hence the number can be higher. + (for example when input_type="query"). + """) + prompt_tokens: int32; @doc("Total number of tokens transacted in this request/response.") - @encodedName("application/json", "total_tokens") - totalTokens: int32; + total_tokens: int32; } diff --git a/specification/ai/ModelClient/models/image_generation.tsp b/specification/ai/ModelClient/models/image_generation.tsp index d84b608ca49d..5c699224de46 100644 --- a/specification/ai/ModelClient/models/image_generation.tsp +++ b/specification/ai/ModelClient/models/image_generation.tsp @@ -13,7 +13,7 @@ alias ImageGenerationOptions = { prompt: string; @doc(""" - The desired dimension in pixels of the generated images, in the format "WidthxHeight". + The desired dimension in pixels of the generated images, in the format "x". For example: "1024x1024", "1792x1024". """) size: string; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index be65975ee2d4..baf6b6503c2d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -4,14 +4,14 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "pglefvljhlzoukl", + "azureml-model-deployment": "wdodqzfxtbqauxfgbn", "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, + "frequency_penalty": -1, "presence_penalty": -2, "temperature": 0, "top_p": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "jqdujnbcklauuaxnj" + "kpfcmsvturnjvs" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 21 + "seed": 20 } }, "responses": { "200": { "body": { - "id": "gbtiscxtqmztyjrmikhf", - "object": "tydbybazyllfxdp", - "created": 20, - "model": "qigsmvvmaqfkuuirqqpfynpxkfvinz", + "id": "zzbqzxgihnxvmyampgwdchdp", + "object": "nhtver", + "created": 8, + "model": "lgywxagwtjilh", "choices": [ { - "index": 28, + "index": 20, "message": { "role": "system", - "content": "iwzinrm", + "content": "iyjepwhcjyagt", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "mekxvfnststwlebncvajqpwnxn" + "id": "isgyupqydkgqgizqknaywafmky" } ] }, @@ -55,9 +55,10 @@ } ], "usage": { - "completion_tokens": 3, - "prompt_tokens": 1, - "total_tokens": 19 + "capacity_type": "usage", + "completion_tokens": 2, + "prompt_tokens": 11, + "total_tokens": 12 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 281787c5ce9f..773b31e73302 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,24 +14,25 @@ "responses": { "200": { "body": { - "id": "gbtiscxtqmztyjrmikhf", - "object": "tydbybazyllfxdp", - "created": 20, - "model": "qigsmvvmaqfkuuirqqpfynpxkfvinz", + "id": "zzbqzxgihnxvmyampgwdchdp", + "object": "nhtver", + "created": 8, + "model": "lgywxagwtjilh", "choices": [ { - "index": 28, + "index": 20, "message": { "role": "system", - "content": "iwzinrm" + "content": "iyjepwhcjyagt" }, "finish_reason": "stop" } ], "usage": { - "completion_tokens": 3, - "prompt_tokens": 1, - "total_tokens": 19 + "capacity_type": "usage", + "completion_tokens": 2, + "prompt_tokens": 11, + "total_tokens": 12 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index b5c948b0879a..d9fec11e8f88 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "ewpcbieff", + "azureml-model-deployment": "cnquvjshwxwasejrlribvxspgdcyno", "body": { "input": [ - "htpg" + "rvdcugmgaxsweyxmwacexiqzzdnv" ], "input_type": "text" } @@ -15,22 +15,24 @@ "responses": { "200": { "body": { - "id": "xhwyggbsdaimiakvmsxcirfu", + "id": "xoxxbviodejcnefbc", "data": [ { "embedding": [ - 18 + 9 ], - "index": 16, - "object": "lyicymftklj" + "index": 17, + "object": "qpnhqtqlctkj" } ], "usage": { - "prompt_tokens": 27, - "total_tokens": 2 + "capacity_type": "usage", + "input_tokens": 7, + "prompt_tokens": 21, + "total_tokens": 14 }, - "object": "szvtzcwsefzswpnfcboxfxiiyo", - "model": "jbgvgbjqmomyeslsyljyktwiipv" + "object": "hwtzuzdatzukwdmznv", + "model": "dntviiybgquylte" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 4abf1bdcfb25..42296f286558 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,29 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "vskamvbcowdzrfqznbuvkrclpu" + "uksdjffdaorxqxuv" ] } }, "responses": { "200": { "body": { - "id": "xhwyggbsdaimiakvmsxcirfu", + "id": "xoxxbviodejcnefbc", "data": [ { "embedding": [ - 18 + 9 ], - "index": 16, - "object": "lyicymftklj" + "index": 17, + "object": "qpnhqtqlctkj" } ], "usage": { - "prompt_tokens": 27, - "total_tokens": 2 + "capacity_type": "usage", + "input_tokens": 7, + "prompt_tokens": 21, + "total_tokens": 14 }, - "object": "szvtzcwsefzswpnfcboxfxiiyo", - "model": "jbgvgbjqmomyeslsyljyktwiipv" + "object": "hwtzuzdatzukwdmznv", + "model": "dntviiybgquylte" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json index 21846c9eb0ed..0208a82a6442 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -4,25 +4,25 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "yx", + "azureml-model-deployment": "zpckrf", "body": { - "prompt": "xooawhhxrfiknuehilafefwnvtly", - "size": "iwitljodl", + "prompt": "wuifyhjsmqrfkpq", + "size": "qsmjjuclpkbzey", "quality": "standard", "response_format": "url", - "seed": 13 + "seed": 25 } }, "responses": { "200": { "body": { - "id": "m", - "created": 6, - "model": "xciqbsjgbyjvqhjep", + "id": "eoamupfuehbrw", + "created": 27, + "model": "afanuwmlmewyeorjjurb", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "aatitlaotrwfubwvqciv" + "b64_json": "uydlomkfojh" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json index 082b41bd4060..4f83c6e65ce8 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "uvyrmwtflhulaegrbfeb", - "size": "vkvsmfyrmvjpsqitqiiik" + "prompt": "jpyuhpnidpubidvtzptzlnw", + "size": "odumumkfabzoorusutucauolkaexjy" } }, "responses": { "200": { "body": { - "id": "m", - "created": 6, - "model": "xciqbsjgbyjvqhjep", + "id": "eoamupfuehbrw", + "created": 27, + "model": "afanuwmlmewyeorjjurb", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 9f0f2157d54d..63c2fdce545e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -261,36 +261,8 @@ } }, "input_type": { - "type": "string", - "description": "Specifies the input type to use for embedding search.", - "default": "text", - "enum": [ - "text", - "query", - "document" - ], - "x-ms-enum": { - "name": "EmbeddingInputType", - "modelAsString": true, - "values": [ - { - "name": "text", - "value": "text", - "description": "to do" - }, - { - "name": "query", - "value": "query", - "description": "to do" - }, - { - "name": "document", - "value": "document", - "description": "to do" - } - ] - }, - "x-ms-client-name": "inputType" + "$ref": "#/definitions/EmbeddingInputType", + "description": "Specifies the input type to use for embedding search." } }, "required": [ @@ -392,7 +364,7 @@ }, "size": { "type": "string", - "description": "The desired dimension in pixels of the generated images, in the format \"WidthxHeight\".\nFor example: \"1024x1024\", \"1792x1024\"." + "description": "The desired dimension in pixels of the generated images, in the format \"x\".\nFor example: \"1024x1024\", \"1792x1024\"." }, "quality": { "type": "string", @@ -529,6 +501,30 @@ } } }, + "CapacityType": { + "type": "string", + "description": "Whether your capacity has been afected by the usage amount (token count) reported here.", + "enum": [ + "usage", + "fixed" + ], + "x-ms-enum": { + "name": "CapacityType", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "usage", + "description": "Your capacity has been affected by the usage amount (token count) reported here." + }, + { + "name": "ignore", + "value": "fixed", + "description": "Your capacity has not been affected by the usage amount (token count) reported here." + } + ] + } + }, "ChatChoice": { "type": "object", "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", @@ -936,6 +932,10 @@ "type": "object", "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", "properties": { + "capacity_type": { + "$ref": "#/definitions/CapacityType", + "description": "Indicates whether your capacity has been affected by the usage amount (token count) reported here." + }, "completion_tokens": { "type": "integer", "format": "int32", @@ -953,6 +953,7 @@ } }, "required": [ + "capacity_type", "completion_tokens", "prompt_tokens", "total_tokens" @@ -1057,20 +1058,29 @@ "type": "object", "description": "Measurement of the amount of tokens used in this request and response.", "properties": { + "capacity_type": { + "$ref": "#/definitions/CapacityType", + "description": "Indicates whether your capacity has been affected by the usage amount (token count) reported here." + }, + "input_tokens": { + "type": "integer", + "format": "int32", + "description": "Number of tokens in the request prompt." + }, "prompt_tokens": { "type": "integer", "format": "int32", - "description": "Number of tokens sent in the original request.", - "x-ms-client-name": "promptTokens" + "description": "Number of tokens used for the prompt sent to the AI model. Typically identical to`input_tokens`.\nHowever, certain AI models may add extra tokens to the input hence the number can be higher.\n(for example when input_type=\"query\")." }, "total_tokens": { "type": "integer", "format": "int32", - "description": "Total number of tokens transacted in this request/response.", - "x-ms-client-name": "totalTokens" + "description": "Total number of tokens transacted in this request/response." } }, "required": [ + "capacity_type", + "input_tokens", "prompt_tokens", "total_tokens" ] From 7b772e1e83fb5fb9bee7913d512c9c71023d0013 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 3 Apr 2024 22:18:36 -0700 Subject: [PATCH 038/343] Fix following `tsp format` --- specification/ai/ModelClient/models/common.tsp | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 41834284102a..12b2cf2e4fb8 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -33,7 +33,6 @@ alias AdditionalRequestHeaders = { modelDeployment?: string; }; - alias CapacityAlias = { @doc("Indicates whether your capacity has been affected by the usage amount (token count) reported here.") capacity_type: CapacityType; From 7a68070c6c1d788776547fe4f9b9bca5e2622d7e Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 3 Apr 2024 22:31:47 -0700 Subject: [PATCH 039/343] Fix enums --- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 22 +++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++++------- .../GetImageGenerations_MaximumSet_Gen.json | 16 +++++----- .../GetImageGenerations_MinimumSet_Gen.json | 10 +++---- .../ModelClient/models/chat_completions.tsp | 8 +++-- .../ai/ModelClient/models/common.tsp | 8 +++-- .../ai/ModelClient/models/embeddings.tsp | 4 ++- .../ModelClient/models/image_generation.tsp | 8 +++-- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 22 +++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++++------- .../GetImageGenerations_MaximumSet_Gen.json | 16 +++++----- .../GetImageGenerations_MinimumSet_Gen.json | 10 +++---- 16 files changed, 137 insertions(+), 123 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index baf6b6503c2d..2b94c7907a56 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -4,15 +4,15 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "wdodqzfxtbqauxfgbn", + "azureml-model-deployment": "sbxqdhisnvedthoknxfqfrxqjvvz", "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, - "presence_penalty": -2, + "frequency_penalty": 1, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "kpfcmsvturnjvs" + "xivaykskanywbehspdis" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 20 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "zzbqzxgihnxvmyampgwdchdp", - "object": "nhtver", - "created": 8, - "model": "lgywxagwtjilh", + "id": "eqqsyjmx", + "object": "gxhzvtmxqrvlwagbcdjfwvcm", + "created": 18, + "model": "sinjkqekxep", "choices": [ { - "index": 20, + "index": 23, "message": { "role": "system", - "content": "iyjepwhcjyagt", + "content": "qgopmdlgy", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "isgyupqydkgqgizqknaywafmky" + "id": "yqnpxcjcomo" } ] }, @@ -56,9 +56,9 @@ ], "usage": { "capacity_type": "usage", - "completion_tokens": 2, - "prompt_tokens": 11, - "total_tokens": 12 + "completion_tokens": 21, + "prompt_tokens": 12, + "total_tokens": 21 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 773b31e73302..95f8cb92cfb5 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,25 +14,25 @@ "responses": { "200": { "body": { - "id": "zzbqzxgihnxvmyampgwdchdp", - "object": "nhtver", - "created": 8, - "model": "lgywxagwtjilh", + "id": "eqqsyjmx", + "object": "gxhzvtmxqrvlwagbcdjfwvcm", + "created": 18, + "model": "sinjkqekxep", "choices": [ { - "index": 20, + "index": 23, "message": { "role": "system", - "content": "iyjepwhcjyagt" + "content": "qgopmdlgy" }, "finish_reason": "stop" } ], "usage": { "capacity_type": "usage", - "completion_tokens": 2, - "prompt_tokens": 11, - "total_tokens": 12 + "completion_tokens": 21, + "prompt_tokens": 12, + "total_tokens": 21 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index d9fec11e8f88..19870807286e 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "cnquvjshwxwasejrlribvxspgdcyno", + "azureml-model-deployment": "xxfmherexnpixqktotsihebaeqlkwn", "body": { "input": [ - "rvdcugmgaxsweyxmwacexiqzzdnv" + "fdax" ], "input_type": "text" } @@ -15,24 +15,24 @@ "responses": { "200": { "body": { - "id": "xoxxbviodejcnefbc", + "id": "eurnfwkuzeopsndedouddk", "data": [ { "embedding": [ - 9 + 11 ], - "index": 17, - "object": "qpnhqtqlctkj" + "index": 12, + "object": "agmolyfyccmklewk" } ], "usage": { "capacity_type": "usage", - "input_tokens": 7, - "prompt_tokens": 21, - "total_tokens": 14 + "input_tokens": 26, + "prompt_tokens": 9, + "total_tokens": 18 }, - "object": "hwtzuzdatzukwdmznv", - "model": "dntviiybgquylte" + "object": "oae", + "model": "aymxkfdvct" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 42296f286558..a7135f405636 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "uksdjffdaorxqxuv" + "pd" ] } }, "responses": { "200": { "body": { - "id": "xoxxbviodejcnefbc", + "id": "eurnfwkuzeopsndedouddk", "data": [ { "embedding": [ - 9 + 11 ], - "index": 17, - "object": "qpnhqtqlctkj" + "index": 12, + "object": "agmolyfyccmklewk" } ], "usage": { "capacity_type": "usage", - "input_tokens": 7, - "prompt_tokens": 21, - "total_tokens": 14 + "input_tokens": 26, + "prompt_tokens": 9, + "total_tokens": 18 }, - "object": "hwtzuzdatzukwdmznv", - "model": "dntviiybgquylte" + "object": "oae", + "model": "aymxkfdvct" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json index 0208a82a6442..22563c239f1b 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -4,25 +4,25 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "zpckrf", + "azureml-model-deployment": "pikpkzrohfiapovzveivznic", "body": { - "prompt": "wuifyhjsmqrfkpq", - "size": "qsmjjuclpkbzey", + "prompt": "htlcthhqyxlsungfxezgg", + "size": "sdixgjbtxdwlocueozokorrujpr", "quality": "standard", "response_format": "url", - "seed": 25 + "seed": 5 } }, "responses": { "200": { "body": { - "id": "eoamupfuehbrw", - "created": 27, - "model": "afanuwmlmewyeorjjurb", + "id": "fqcokvchkagmwkzwvh", + "created": 23, + "model": "qbjn", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "uydlomkfojh" + "b64_json": "svlnhvyp" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json index 4f83c6e65ce8..7dfc63270918 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "jpyuhpnidpubidvtzptzlnw", - "size": "odumumkfabzoorusutucauolkaexjy" + "prompt": "khsbegoalsw", + "size": "wtclaoaqckufhjqfqmd" } }, "responses": { "200": { "body": { - "id": "eoamupfuehbrw", - "created": 27, - "model": "afanuwmlmewyeorjjurb", + "id": "fqcokvchkagmwkzwvh", + "created": 23, + "model": "qbjn", "data": [ {} ] diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 29fb67bfff25..00cd51b0a5ef 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -153,7 +153,9 @@ model CompletionsUsage { @doc(""" Representation of the manner in which a completions response concluded. """) -enum CompletionsFinishReason { +union CompletionsFinishReason { + string, + @doc("Completions ended normally and reached its end of token generation.") stopped: "stop", @@ -168,7 +170,9 @@ enum CompletionsFinishReason { } @doc("A description of the intended purpose of a message within a chat completions interaction.") -enum ChatRole { +union ChatRole { + string, + @doc("The role that instructs or sets the behavior of the assistant.") system: "system", diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 12b2cf2e4fb8..cbb4980cf25a 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -9,7 +9,9 @@ using TypeSpec.Versioning; namespace ModelClient; @doc("Defines the service behavior when unknown parameters are passed as extra properties in the request payload.") -enum UnknownParameters { +union UnknownParameters { + string, + @doc("The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service.") error: "error", @@ -39,7 +41,9 @@ alias CapacityAlias = { }; @doc("Whether your capacity has been afected by the usage amount (token count) reported here.") -enum CapacityType { +union CapacityType { + string, + @doc("Your capacity has been affected by the usage amount (token count) reported here.") error: "usage", diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index 3fd85b52dd7e..7c8b96a7df72 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -39,7 +39,9 @@ model EmbeddingsResult { } @doc("Represents the input types used for embedding search.") -enum EmbeddingInputType { +union EmbeddingInputType { + string, + @doc("to do") text: "text", diff --git a/specification/ai/ModelClient/models/image_generation.tsp b/specification/ai/ModelClient/models/image_generation.tsp index 5c699224de46..7429f9625145 100644 --- a/specification/ai/ModelClient/models/image_generation.tsp +++ b/specification/ai/ModelClient/models/image_generation.tsp @@ -55,7 +55,9 @@ model ImageGenerations { @doc(""" An image generation configuration that specifies how the model should prioritize quality, cost, and speed. """) -enum ImageGenerationQuality { +union ImageGenerationQuality { + string, + @doc(""" Requests image generation with standard, balanced characteristics of quality, cost, and speed. """) @@ -68,7 +70,9 @@ enum ImageGenerationQuality { } @doc("The format in which the generated images are returned.") -enum ImageGenerationResponseFormat { +union ImageGenerationResponseFormat { + string, + @doc("Image generation response items should provide a URL from which the image may be retrieved.") url: "url", diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index baf6b6503c2d..2b94c7907a56 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -4,15 +4,15 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "wdodqzfxtbqauxfgbn", + "azureml-model-deployment": "sbxqdhisnvedthoknxfqfrxqjvvz", "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, - "presence_penalty": -2, + "frequency_penalty": 1, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -20,7 +20,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "kpfcmsvturnjvs" + "xivaykskanywbehspdis" ], "stream": true, "tools": [ @@ -28,26 +28,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 20 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "zzbqzxgihnxvmyampgwdchdp", - "object": "nhtver", - "created": 8, - "model": "lgywxagwtjilh", + "id": "eqqsyjmx", + "object": "gxhzvtmxqrvlwagbcdjfwvcm", + "created": 18, + "model": "sinjkqekxep", "choices": [ { - "index": 20, + "index": 23, "message": { "role": "system", - "content": "iyjepwhcjyagt", + "content": "qgopmdlgy", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "isgyupqydkgqgizqknaywafmky" + "id": "yqnpxcjcomo" } ] }, @@ -56,9 +56,9 @@ ], "usage": { "capacity_type": "usage", - "completion_tokens": 2, - "prompt_tokens": 11, - "total_tokens": 12 + "completion_tokens": 21, + "prompt_tokens": 12, + "total_tokens": 21 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 773b31e73302..95f8cb92cfb5 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,25 +14,25 @@ "responses": { "200": { "body": { - "id": "zzbqzxgihnxvmyampgwdchdp", - "object": "nhtver", - "created": 8, - "model": "lgywxagwtjilh", + "id": "eqqsyjmx", + "object": "gxhzvtmxqrvlwagbcdjfwvcm", + "created": 18, + "model": "sinjkqekxep", "choices": [ { - "index": 20, + "index": 23, "message": { "role": "system", - "content": "iyjepwhcjyagt" + "content": "qgopmdlgy" }, "finish_reason": "stop" } ], "usage": { "capacity_type": "usage", - "completion_tokens": 2, - "prompt_tokens": 11, - "total_tokens": 12 + "completion_tokens": 21, + "prompt_tokens": 12, + "total_tokens": 21 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index d9fec11e8f88..19870807286e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "cnquvjshwxwasejrlribvxspgdcyno", + "azureml-model-deployment": "xxfmherexnpixqktotsihebaeqlkwn", "body": { "input": [ - "rvdcugmgaxsweyxmwacexiqzzdnv" + "fdax" ], "input_type": "text" } @@ -15,24 +15,24 @@ "responses": { "200": { "body": { - "id": "xoxxbviodejcnefbc", + "id": "eurnfwkuzeopsndedouddk", "data": [ { "embedding": [ - 9 + 11 ], - "index": 17, - "object": "qpnhqtqlctkj" + "index": 12, + "object": "agmolyfyccmklewk" } ], "usage": { "capacity_type": "usage", - "input_tokens": 7, - "prompt_tokens": 21, - "total_tokens": 14 + "input_tokens": 26, + "prompt_tokens": 9, + "total_tokens": 18 }, - "object": "hwtzuzdatzukwdmznv", - "model": "dntviiybgquylte" + "object": "oae", + "model": "aymxkfdvct" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 42296f286558..a7135f405636 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "uksdjffdaorxqxuv" + "pd" ] } }, "responses": { "200": { "body": { - "id": "xoxxbviodejcnefbc", + "id": "eurnfwkuzeopsndedouddk", "data": [ { "embedding": [ - 9 + 11 ], - "index": 17, - "object": "qpnhqtqlctkj" + "index": 12, + "object": "agmolyfyccmklewk" } ], "usage": { "capacity_type": "usage", - "input_tokens": 7, - "prompt_tokens": 21, - "total_tokens": 14 + "input_tokens": 26, + "prompt_tokens": 9, + "total_tokens": 18 }, - "object": "hwtzuzdatzukwdmznv", - "model": "dntviiybgquylte" + "object": "oae", + "model": "aymxkfdvct" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json index 0208a82a6442..22563c239f1b 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -4,25 +4,25 @@ "parameters": { "api-version": "2024-04-01-preview", "unknown-parameters": "error", - "azureml-model-deployment": "zpckrf", + "azureml-model-deployment": "pikpkzrohfiapovzveivznic", "body": { - "prompt": "wuifyhjsmqrfkpq", - "size": "qsmjjuclpkbzey", + "prompt": "htlcthhqyxlsungfxezgg", + "size": "sdixgjbtxdwlocueozokorrujpr", "quality": "standard", "response_format": "url", - "seed": 25 + "seed": 5 } }, "responses": { "200": { "body": { - "id": "eoamupfuehbrw", - "created": 27, - "model": "afanuwmlmewyeorjjurb", + "id": "fqcokvchkagmwkzwvh", + "created": 23, + "model": "qbjn", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "uydlomkfojh" + "b64_json": "svlnhvyp" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json index 4f83c6e65ce8..7dfc63270918 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "jpyuhpnidpubidvtzptzlnw", - "size": "odumumkfabzoorusutucauolkaexjy" + "prompt": "khsbegoalsw", + "size": "wtclaoaqckufhjqfqmd" } }, "responses": { "200": { "body": { - "id": "eoamupfuehbrw", - "created": 27, - "model": "afanuwmlmewyeorjjurb", + "id": "fqcokvchkagmwkzwvh", + "created": 23, + "model": "qbjn", "data": [ {} ] From 58c70bef538e71dd512407c438d4c957fdc75cfd Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 3 Apr 2024 22:47:50 -0700 Subject: [PATCH 040/343] Fix typo --- specification/ai/ModelClient/models/common.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index cbb4980cf25a..dafb22843bfe 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -40,7 +40,7 @@ alias CapacityAlias = { capacity_type: CapacityType; }; -@doc("Whether your capacity has been afected by the usage amount (token count) reported here.") +@doc("Whether your capacity has been affected by the usage amount (token count) reported here.") union CapacityType { string, From 319f92bd61ce8acce6e0c5e14025d7d6f34430e3 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 4 Apr 2024 07:45:06 -0700 Subject: [PATCH 041/343] Fix the same typo in swagger --- .../ModelClient/preview/2024-04-01-preview/openapi.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 63c2fdce545e..1f4ba0738ea4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -503,7 +503,7 @@ }, "CapacityType": { "type": "string", - "description": "Whether your capacity has been afected by the usage amount (token count) reported here.", + "description": "Whether your capacity has been affected by the usage amount (token count) reported here.", "enum": [ "usage", "fixed" From 227172eb4c80e86d103825ccbb37e4583167c4e5 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 4 Apr 2024 14:31:47 -0700 Subject: [PATCH 042/343] Add Record for extra parameters --- .../GetChatCompletions_MaximumSet_Gen.json | 33 +- .../GetChatCompletions_MinimumSet_Gen.json | 18 +- .../GetEmbeddings_MaximumSet_Gen.json | 25 +- .../GetEmbeddings_MinimumSet_Gen.json | 18 +- .../GetImageGenerations_MaximumSet_Gen.json | 21 +- .../GetImageGenerations_MinimumSet_Gen.json | 10 +- .../ModelClient/models/chat_completions.tsp | 4 +- .../ai/ModelClient/models/common.tsp | 30 +- .../ai/ModelClient/models/embeddings.tsp | 4 +- .../ModelClient/models/image_generation.tsp | 4 +- specification/ai/ModelClient/routes.tsp | 3 +- .../GetChatCompletions_MaximumSet_Gen.json | 33 +- .../GetChatCompletions_MinimumSet_Gen.json | 18 +- .../GetEmbeddings_MaximumSet_Gen.json | 25 +- .../GetEmbeddings_MinimumSet_Gen.json | 18 +- .../GetImageGenerations_MaximumSet_Gen.json | 21 +- .../GetImageGenerations_MinimumSet_Gen.json | 10 +- .../preview/2024-04-01-preview/openapi.json | 387 +++++++++--------- 18 files changed, 364 insertions(+), 318 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 2b94c7907a56..dfb46e612fb8 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,16 +3,19 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "unknown-parameters": "error", - "azureml-model-deployment": "sbxqdhisnvedthoknxfqfrxqjvvz", + "extra-parameters": "error", + "azureml-model-deployment": "tonilp", "body": { + "extras": { + "key6891": "kbemeffwrchpubwol" + }, "messages": [ { "role": "ChatRequestMessage" } ], "frequency_penalty": 1, - "presence_penalty": 0, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -20,7 +23,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "xivaykskanywbehspdis" + "ybcbdvregoivwxvdfcczuvpeqmeupo" ], "stream": true, "tools": [ @@ -28,26 +31,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 21 + "seed": 1 } }, "responses": { "200": { "body": { - "id": "eqqsyjmx", - "object": "gxhzvtmxqrvlwagbcdjfwvcm", - "created": 18, - "model": "sinjkqekxep", + "id": "ejh", + "object": "jdlektbtkmlafuey", + "created": 13, + "model": "s", "choices": [ { - "index": 23, + "index": 20, "message": { "role": "system", - "content": "qgopmdlgy", + "content": "buywjxoocqnus", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "yqnpxcjcomo" + "id": "jxt" } ] }, @@ -56,9 +59,9 @@ ], "usage": { "capacity_type": "usage", - "completion_tokens": 21, - "prompt_tokens": 12, - "total_tokens": 21 + "completion_tokens": 15, + "prompt_tokens": 26, + "total_tokens": 18 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 95f8cb92cfb5..c2bbf5cc38bd 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,25 +14,25 @@ "responses": { "200": { "body": { - "id": "eqqsyjmx", - "object": "gxhzvtmxqrvlwagbcdjfwvcm", - "created": 18, - "model": "sinjkqekxep", + "id": "ejh", + "object": "jdlektbtkmlafuey", + "created": 13, + "model": "s", "choices": [ { - "index": 23, + "index": 20, "message": { "role": "system", - "content": "qgopmdlgy" + "content": "buywjxoocqnus" }, "finish_reason": "stop" } ], "usage": { "capacity_type": "usage", - "completion_tokens": 21, - "prompt_tokens": 12, - "total_tokens": 21 + "completion_tokens": 15, + "prompt_tokens": 26, + "total_tokens": 18 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 19870807286e..f681b9608410 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,11 +3,14 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "unknown-parameters": "error", - "azureml-model-deployment": "xxfmherexnpixqktotsihebaeqlkwn", + "extra-parameters": "error", + "azureml-model-deployment": "keqnpizxpgkjtrphualhgo", "body": { + "extras": { + "key4791": "wlkccycrgulewayprqmixvcqoeh" + }, "input": [ - "fdax" + "omeboabffdok" ], "input_type": "text" } @@ -15,24 +18,24 @@ "responses": { "200": { "body": { - "id": "eurnfwkuzeopsndedouddk", + "id": "uhcfa", "data": [ { "embedding": [ - 11 + 12 ], - "index": 12, - "object": "agmolyfyccmklewk" + "index": 14, + "object": "acrufadzyvaxlfihmkngxqcaxj" } ], "usage": { "capacity_type": "usage", "input_tokens": 26, - "prompt_tokens": 9, - "total_tokens": 18 + "prompt_tokens": 13, + "total_tokens": 20 }, - "object": "oae", - "model": "aymxkfdvct" + "object": "jeihlrgdjmkyjdk", + "model": "pgjmftxyblmvutylczqjj" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index a7135f405636..c5d44ff68509 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "pd" + "kctpevtlklpvjk" ] } }, "responses": { "200": { "body": { - "id": "eurnfwkuzeopsndedouddk", + "id": "uhcfa", "data": [ { "embedding": [ - 11 + 12 ], - "index": 12, - "object": "agmolyfyccmklewk" + "index": 14, + "object": "acrufadzyvaxlfihmkngxqcaxj" } ], "usage": { "capacity_type": "usage", "input_tokens": 26, - "prompt_tokens": 9, - "total_tokens": 18 + "prompt_tokens": 13, + "total_tokens": 20 }, - "object": "oae", - "model": "aymxkfdvct" + "object": "jeihlrgdjmkyjdk", + "model": "pgjmftxyblmvutylczqjj" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json index 22563c239f1b..19ffefa62fcf 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -3,26 +3,29 @@ "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", - "unknown-parameters": "error", - "azureml-model-deployment": "pikpkzrohfiapovzveivznic", + "extra-parameters": "error", + "azureml-model-deployment": "mqyhplyskslifaoxuvho", "body": { - "prompt": "htlcthhqyxlsungfxezgg", - "size": "sdixgjbtxdwlocueozokorrujpr", + "extras": { + "key9873": "mjwetwlps" + }, + "prompt": "pwodoqb", + "size": "kzf", "quality": "standard", "response_format": "url", - "seed": 5 + "seed": 2 } }, "responses": { "200": { "body": { - "id": "fqcokvchkagmwkzwvh", - "created": 23, - "model": "qbjn", + "id": "ijyymqifsiaekwavwtcmrbn", + "created": 17, + "model": "m", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "svlnhvyp" + "b64_json": "ehfcbuotnxovacoh" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json index 7dfc63270918..5a8fd21e7369 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "khsbegoalsw", - "size": "wtclaoaqckufhjqfqmd" + "prompt": "jiftc", + "size": "qrvtgulvssvxuba" } }, "responses": { "200": { "body": { - "id": "fqcokvchkagmwkzwvh", - "created": 23, - "model": "qbjn", + "id": "ijyymqifsiaekwavwtcmrbn", + "created": 17, + "model": "m", "data": [ {} ] diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 00cd51b0a5ef..32e0540d556f 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -1,14 +1,14 @@ import "@typespec/rest"; import "@typespec/http"; -import "@typespec/versioning"; using TypeSpec.Rest; using TypeSpec.Http; -using TypeSpec.Versioning; namespace ModelClient; alias ChatCompletionsOptions = { + ...ExtraRequestParameters; + @doc(""" The collection of context messages associated with this chat completions request. Typical usage begins with a chat message for the System role that provides instructions for diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index dafb22843bfe..3ddd56d901ac 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -1,38 +1,36 @@ import "@typespec/rest"; import "@typespec/http"; -import "@typespec/versioning"; using TypeSpec.Rest; using TypeSpec.Http; -using TypeSpec.Versioning; namespace ModelClient; -@doc("Defines the service behavior when unknown parameters are passed as extra properties in the request payload.") -union UnknownParameters { +@doc("Defines the service behavior when extra parameters are passed in the request payload.") +union ExtraParameters { string, - @doc("The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service.") + @doc("The service should error when it sees extra parameters in the request payload. This is the default behavior if the service.") error: "error", - @doc("The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model.") + @doc("The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model.") ignore: "ignore", - @doc("The service should pass unknown parameters to the back-end AI model.") + @doc("The service should pass extra parameters to the back-end AI model.") allow: "allow", } alias AdditionalRequestHeaders = { - @doc("Controls what happens if unknown parameters are passed as extra properties in the request payload.") - @header("unknown-parameters") - unknownParameters?: UnknownParameters; + @doc("Controls what happens if extra parameters are passed in the request payload.") + @header("extra-parameters") + extra_parameters?: ExtraParameters; @doc(""" Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments. Typically used when you want to target a test environment instead of production environment. """) @header("azureml-model-deployment") - modelDeployment?: string; + model_deployemnt?: string; }; alias CapacityAlias = { @@ -50,3 +48,13 @@ union CapacityType { @doc("Your capacity has not been affected by the usage amount (token count) reported here.") ignore: "fixed", } + +alias ExtraRequestParameters = { + @doc(""" + Extra parameters (in the form of string key-value pairs) that are not in the standard request payload. + They will be passed to the service as-is in the root of the JSON request payload. + How the service handles these extra parameters depends on the value of the `extra-parameters` + HTTP request header. + """) + extras?: Record; +}; diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index 7c8b96a7df72..46481717b941 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -1,14 +1,14 @@ import "@typespec/rest"; import "@typespec/http"; -import "@typespec/versioning"; using TypeSpec.Rest; using TypeSpec.Http; -using TypeSpec.Versioning; namespace ModelClient; alias EmbeddingsOptions = { + ...ExtraRequestParameters; + @doc("Input texts to get embeddings for, encoded as a an array of strings.") input: string[]; diff --git a/specification/ai/ModelClient/models/image_generation.tsp b/specification/ai/ModelClient/models/image_generation.tsp index 7429f9625145..19c85aab5273 100644 --- a/specification/ai/ModelClient/models/image_generation.tsp +++ b/specification/ai/ModelClient/models/image_generation.tsp @@ -1,14 +1,14 @@ import "@typespec/rest"; import "@typespec/http"; -import "@typespec/versioning"; using TypeSpec.Rest; using TypeSpec.Http; -using TypeSpec.Versioning; namespace ModelClient; alias ImageGenerationOptions = { + ...ExtraRequestParameters; + @doc("A description of the desired images.") prompt: string; diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index a160a921522b..4dadb61f79a7 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -11,7 +11,6 @@ import "./models/image_generation.tsp"; using TypeSpec.Rest; using TypeSpec.Http; using TypeSpec.Versioning; - using Azure.Core; namespace ModelClient; @@ -44,7 +43,7 @@ op getEmbeddings is Azure.Core.RpcOperation< @doc("Creates images given a prompt.") @actionSeparator("/") -@route("v1/images/generations") +@route("/images/generations") op getImageGenerations is Azure.Core.RpcOperation< { ...ImageGenerationOptions; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 2b94c7907a56..dfb46e612fb8 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,16 +3,19 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "unknown-parameters": "error", - "azureml-model-deployment": "sbxqdhisnvedthoknxfqfrxqjvvz", + "extra-parameters": "error", + "azureml-model-deployment": "tonilp", "body": { + "extras": { + "key6891": "kbemeffwrchpubwol" + }, "messages": [ { "role": "ChatRequestMessage" } ], "frequency_penalty": 1, - "presence_penalty": 0, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -20,7 +23,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "xivaykskanywbehspdis" + "ybcbdvregoivwxvdfcczuvpeqmeupo" ], "stream": true, "tools": [ @@ -28,26 +31,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 21 + "seed": 1 } }, "responses": { "200": { "body": { - "id": "eqqsyjmx", - "object": "gxhzvtmxqrvlwagbcdjfwvcm", - "created": 18, - "model": "sinjkqekxep", + "id": "ejh", + "object": "jdlektbtkmlafuey", + "created": 13, + "model": "s", "choices": [ { - "index": 23, + "index": 20, "message": { "role": "system", - "content": "qgopmdlgy", + "content": "buywjxoocqnus", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "yqnpxcjcomo" + "id": "jxt" } ] }, @@ -56,9 +59,9 @@ ], "usage": { "capacity_type": "usage", - "completion_tokens": 21, - "prompt_tokens": 12, - "total_tokens": 21 + "completion_tokens": 15, + "prompt_tokens": 26, + "total_tokens": 18 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 95f8cb92cfb5..c2bbf5cc38bd 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,25 +14,25 @@ "responses": { "200": { "body": { - "id": "eqqsyjmx", - "object": "gxhzvtmxqrvlwagbcdjfwvcm", - "created": 18, - "model": "sinjkqekxep", + "id": "ejh", + "object": "jdlektbtkmlafuey", + "created": 13, + "model": "s", "choices": [ { - "index": 23, + "index": 20, "message": { "role": "system", - "content": "qgopmdlgy" + "content": "buywjxoocqnus" }, "finish_reason": "stop" } ], "usage": { "capacity_type": "usage", - "completion_tokens": 21, - "prompt_tokens": 12, - "total_tokens": 21 + "completion_tokens": 15, + "prompt_tokens": 26, + "total_tokens": 18 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 19870807286e..f681b9608410 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,11 +3,14 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "unknown-parameters": "error", - "azureml-model-deployment": "xxfmherexnpixqktotsihebaeqlkwn", + "extra-parameters": "error", + "azureml-model-deployment": "keqnpizxpgkjtrphualhgo", "body": { + "extras": { + "key4791": "wlkccycrgulewayprqmixvcqoeh" + }, "input": [ - "fdax" + "omeboabffdok" ], "input_type": "text" } @@ -15,24 +18,24 @@ "responses": { "200": { "body": { - "id": "eurnfwkuzeopsndedouddk", + "id": "uhcfa", "data": [ { "embedding": [ - 11 + 12 ], - "index": 12, - "object": "agmolyfyccmklewk" + "index": 14, + "object": "acrufadzyvaxlfihmkngxqcaxj" } ], "usage": { "capacity_type": "usage", "input_tokens": 26, - "prompt_tokens": 9, - "total_tokens": 18 + "prompt_tokens": 13, + "total_tokens": 20 }, - "object": "oae", - "model": "aymxkfdvct" + "object": "jeihlrgdjmkyjdk", + "model": "pgjmftxyblmvutylczqjj" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index a7135f405636..c5d44ff68509 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "pd" + "kctpevtlklpvjk" ] } }, "responses": { "200": { "body": { - "id": "eurnfwkuzeopsndedouddk", + "id": "uhcfa", "data": [ { "embedding": [ - 11 + 12 ], - "index": 12, - "object": "agmolyfyccmklewk" + "index": 14, + "object": "acrufadzyvaxlfihmkngxqcaxj" } ], "usage": { "capacity_type": "usage", "input_tokens": 26, - "prompt_tokens": 9, - "total_tokens": 18 + "prompt_tokens": 13, + "total_tokens": 20 }, - "object": "oae", - "model": "aymxkfdvct" + "object": "jeihlrgdjmkyjdk", + "model": "pgjmftxyblmvutylczqjj" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json index 22563c239f1b..19ffefa62fcf 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -3,26 +3,29 @@ "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", - "unknown-parameters": "error", - "azureml-model-deployment": "pikpkzrohfiapovzveivznic", + "extra-parameters": "error", + "azureml-model-deployment": "mqyhplyskslifaoxuvho", "body": { - "prompt": "htlcthhqyxlsungfxezgg", - "size": "sdixgjbtxdwlocueozokorrujpr", + "extras": { + "key9873": "mjwetwlps" + }, + "prompt": "pwodoqb", + "size": "kzf", "quality": "standard", "response_format": "url", - "seed": 5 + "seed": 2 } }, "responses": { "200": { "body": { - "id": "fqcokvchkagmwkzwvh", - "created": 23, - "model": "qbjn", + "id": "ijyymqifsiaekwavwtcmrbn", + "created": 17, + "model": "m", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "svlnhvyp" + "b64_json": "ehfcbuotnxovacoh" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json index 7dfc63270918..5a8fd21e7369 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "khsbegoalsw", - "size": "wtclaoaqckufhjqfqmd" + "prompt": "jiftc", + "size": "qrvtgulvssvxuba" } }, "responses": { "200": { "body": { - "id": "fqcokvchkagmwkzwvh", - "created": 23, - "model": "qbjn", + "id": "ijyymqifsiaekwavwtcmrbn", + "created": 17, + "model": "m", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 1f4ba0738ea4..1a4ab6f3b18d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -20,6 +20,150 @@ ], "tags": [], "paths": { + "/images/generations": { + "post": { + "operationId": "GetImageGenerations", + "description": "Creates images given a prompt.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "extra-parameters", + "in": "header", + "description": "Controls what happens if extra parameters are passed in the request payload.", + "required": false, + "type": "string", + "enum": [ + "error", + "ignore", + "allow" + ], + "x-ms-enum": { + "name": "ExtraParameters", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "error", + "description": "The service should error when it sees extra parameters in the request payload. This is the default behavior if the service." + }, + { + "name": "ignore", + "value": "ignore", + "description": "The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model." + }, + { + "name": "allow", + "value": "allow", + "description": "The service should pass extra parameters to the back-end AI model." + } + ] + }, + "x-ms-client-name": "extra_parameters" + }, + { + "name": "azureml-model-deployment", + "in": "header", + "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", + "required": false, + "type": "string", + "x-ms-client-name": "model_deployemnt" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "extras": { + "type": "object", + "description": "Extra parameters (in the form of string key-value pairs) that are not in the standard request payload.\nThey will be passed to the service as-is in the root of the JSON request payload.\nHow the service handles these extra parameters depends on the value of the `extra-parameters`\nHTTP request header.", + "additionalProperties": { + "type": "string" + } + }, + "prompt": { + "type": "string", + "description": "A description of the desired images." + }, + "size": { + "type": "string", + "description": "The desired dimension in pixels of the generated images, in the format \"x\".\nFor example: \"1024x1024\", \"1792x1024\"." + }, + "quality": { + "type": "string", + "description": "The desired image generation quality level to use.", + "default": "standard", + "enum": [ + "standard", + "hd" + ], + "x-ms-enum": { + "name": "ImageGenerationQuality", + "modelAsString": true, + "values": [ + { + "name": "standard", + "value": "standard", + "description": "Requests image generation with standard, balanced characteristics of quality, cost, and speed." + }, + { + "name": "hd", + "value": "hd", + "description": "Requests image generation with higher quality, higher cost and lower speed relative to standard." + } + ] + } + }, + "response_format": { + "$ref": "#/definitions/ImageGenerationResponseFormat", + "description": "The format in which image generation response items should be presented." + }, + "seed": { + "type": "integer", + "format": "int64", + "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed.\"" + } + }, + "required": [ + "prompt", + "size" + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageGenerations" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "maximum set image generation": { + "$ref": "./examples/GetImageGenerations_MaximumSet_Gen.json" + }, + "minimum set image generation": { + "$ref": "./examples/GetImageGenerations_MinimumSet_Gen.json" + } + } + } + }, "/v1/chat/completions": { "post": { "operationId": "GetChatCompletions", @@ -29,9 +173,9 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "unknown-parameters", + "name": "extra-parameters", "in": "header", - "description": "Controls what happens if unknown parameters are passed as extra properties in the request payload.", + "description": "Controls what happens if extra parameters are passed in the request payload.", "required": false, "type": "string", "enum": [ @@ -40,27 +184,27 @@ "allow" ], "x-ms-enum": { - "name": "UnknownParameters", + "name": "ExtraParameters", "modelAsString": true, "values": [ { "name": "error", "value": "error", - "description": "The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service." + "description": "The service should error when it sees extra parameters in the request payload. This is the default behavior if the service." }, { "name": "ignore", "value": "ignore", - "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." + "description": "The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model." }, { "name": "allow", "value": "allow", - "description": "The service should pass unknown parameters to the back-end AI model." + "description": "The service should pass extra parameters to the back-end AI model." } ] }, - "x-ms-client-name": "unknownParameters" + "x-ms-client-name": "extra_parameters" }, { "name": "azureml-model-deployment", @@ -68,7 +212,7 @@ "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", "required": false, "type": "string", - "x-ms-client-name": "modelDeployment" + "x-ms-client-name": "model_deployemnt" }, { "name": "body", @@ -77,6 +221,13 @@ "schema": { "type": "object", "properties": { + "extras": { + "type": "object", + "description": "Extra parameters (in the form of string key-value pairs) that are not in the standard request payload.\nThey will be passed to the service as-is in the root of the JSON request payload.\nHow the service handles these extra parameters depends on the value of the `extra-parameters`\nHTTP request header.", + "additionalProperties": { + "type": "string" + } + }, "messages": { "type": "array", "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", @@ -205,9 +356,9 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "unknown-parameters", + "name": "extra-parameters", "in": "header", - "description": "Controls what happens if unknown parameters are passed as extra properties in the request payload.", + "description": "Controls what happens if extra parameters are passed in the request payload.", "required": false, "type": "string", "enum": [ @@ -216,27 +367,27 @@ "allow" ], "x-ms-enum": { - "name": "UnknownParameters", + "name": "ExtraParameters", "modelAsString": true, "values": [ { "name": "error", "value": "error", - "description": "The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service." + "description": "The service should error when it sees extra parameters in the request payload. This is the default behavior if the service." }, { "name": "ignore", "value": "ignore", - "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." + "description": "The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model." }, { "name": "allow", "value": "allow", - "description": "The service should pass unknown parameters to the back-end AI model." + "description": "The service should pass extra parameters to the back-end AI model." } ] }, - "x-ms-client-name": "unknownParameters" + "x-ms-client-name": "extra_parameters" }, { "name": "azureml-model-deployment", @@ -244,7 +395,7 @@ "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", "required": false, "type": "string", - "x-ms-client-name": "modelDeployment" + "x-ms-client-name": "model_deployemnt" }, { "name": "body", @@ -253,6 +404,13 @@ "schema": { "type": "object", "properties": { + "extras": { + "type": "object", + "description": "Extra parameters (in the form of string key-value pairs) that are not in the standard request payload.\nThey will be passed to the service as-is in the root of the JSON request payload.\nHow the service handles these extra parameters depends on the value of the `extra-parameters`\nHTTP request header.", + "additionalProperties": { + "type": "string" + } + }, "input": { "type": "array", "description": "Input texts to get embeddings for, encoded as a an array of strings.", @@ -300,143 +458,6 @@ } } } - }, - "/v1/images/generations": { - "post": { - "operationId": "GetImageGenerations", - "description": "Creates images given a prompt.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "unknown-parameters", - "in": "header", - "description": "Controls what happens if unknown parameters are passed as extra properties in the request payload.", - "required": false, - "type": "string", - "enum": [ - "error", - "ignore", - "allow" - ], - "x-ms-enum": { - "name": "UnknownParameters", - "modelAsString": true, - "values": [ - { - "name": "error", - "value": "error", - "description": "The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service." - }, - { - "name": "ignore", - "value": "ignore", - "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." - }, - { - "name": "allow", - "value": "allow", - "description": "The service should pass unknown parameters to the back-end AI model." - } - ] - }, - "x-ms-client-name": "unknownParameters" - }, - { - "name": "azureml-model-deployment", - "in": "header", - "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", - "required": false, - "type": "string", - "x-ms-client-name": "modelDeployment" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "prompt": { - "type": "string", - "description": "A description of the desired images." - }, - "size": { - "type": "string", - "description": "The desired dimension in pixels of the generated images, in the format \"x\".\nFor example: \"1024x1024\", \"1792x1024\"." - }, - "quality": { - "type": "string", - "description": "The desired image generation quality level to use.", - "default": "standard", - "enum": [ - "standard", - "hd" - ], - "x-ms-enum": { - "name": "ImageGenerationQuality", - "modelAsString": true, - "values": [ - { - "name": "standard", - "value": "standard", - "description": "Requests image generation with standard, balanced characteristics of quality, cost, and speed." - }, - { - "name": "hd", - "value": "hd", - "description": "Requests image generation with higher quality, higher cost and lower speed relative to standard." - } - ] - } - }, - "response_format": { - "$ref": "#/definitions/ImageGenerationResponseFormat", - "description": "The format in which image generation response items should be presented." - }, - "seed": { - "type": "integer", - "format": "int64", - "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed.\"" - } - }, - "required": [ - "prompt", - "size" - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/ImageGenerations" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "maximum set image generation": { - "$ref": "./examples/GetImageGenerations_MaximumSet_Gen.json" - }, - "minimum set image generation": { - "$ref": "./examples/GetImageGenerations_MinimumSet_Gen.json" - } - } - } } }, "definitions": { @@ -1085,6 +1106,36 @@ "total_tokens" ] }, + "ExtraParameters": { + "type": "string", + "description": "Defines the service behavior when extra parameters are passed in the request payload.", + "enum": [ + "error", + "ignore", + "allow" + ], + "x-ms-enum": { + "name": "ExtraParameters", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "error", + "description": "The service should error when it sees extra parameters in the request payload. This is the default behavior if the service." + }, + { + "name": "ignore", + "value": "ignore", + "description": "The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model." + }, + { + "name": "allow", + "value": "allow", + "description": "The service should pass extra parameters to the back-end AI model." + } + ] + } + }, "FunctionCall": { "type": "object", "description": "The name and arguments of a function that should be called, as generated by the model.", @@ -1219,36 +1270,6 @@ "data" ] }, - "UnknownParameters": { - "type": "string", - "description": "Defines the service behavior when unknown parameters are passed as extra properties in the request payload.", - "enum": [ - "error", - "ignore", - "allow" - ], - "x-ms-enum": { - "name": "UnknownParameters", - "modelAsString": true, - "values": [ - { - "name": "error", - "value": "error", - "description": "The service should error when it sees unknown parameters in the request payload. This is the default behavior if the service." - }, - { - "name": "ignore", - "value": "ignore", - "description": "The service should ignore unknown parameters in the request payload. They will not be passed to the back-end AI model." - }, - { - "name": "allow", - "value": "allow", - "description": "The service should pass unknown parameters to the back-end AI model." - } - ] - } - }, "Versions": { "type": "string", "description": "The ModelClient service versions.", From be2a34fe268b688531e685be809f57aba2af0862 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 4 Apr 2024 14:57:37 -0700 Subject: [PATCH 043/343] Minor fixes --- specification/ai/ModelClient/models/common.tsp | 2 +- specification/ai/ModelClient/routes.tsp | 2 +- .../ModelClient/preview/2024-04-01-preview/openapi.json | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 3ddd56d901ac..adb2e88988df 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -30,7 +30,7 @@ alias AdditionalRequestHeaders = { Typically used when you want to target a test environment instead of production environment. """) @header("azureml-model-deployment") - model_deployemnt?: string; + model_deployment?: string; }; alias CapacityAlias = { diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 4dadb61f79a7..1d7015f77943 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -43,7 +43,7 @@ op getEmbeddings is Azure.Core.RpcOperation< @doc("Creates images given a prompt.") @actionSeparator("/") -@route("/images/generations") +@route("images/generations") op getImageGenerations is Azure.Core.RpcOperation< { ...ImageGenerationOptions; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 1a4ab6f3b18d..58b8e741b993 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -68,7 +68,7 @@ "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", "required": false, "type": "string", - "x-ms-client-name": "model_deployemnt" + "x-ms-client-name": "model_deployment" }, { "name": "body", @@ -212,7 +212,7 @@ "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", "required": false, "type": "string", - "x-ms-client-name": "model_deployemnt" + "x-ms-client-name": "model_deployment" }, { "name": "body", @@ -395,7 +395,7 @@ "description": "Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments.\nTypically used when you want to target a test environment instead of production environment.", "required": false, "type": "string", - "x-ms-client-name": "model_deployemnt" + "x-ms-client-name": "model_deployment" }, { "name": "body", From 4269199cc639dcec3c0f8158078ff3a381a4022f Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 4 Apr 2024 15:22:22 -0700 Subject: [PATCH 044/343] Recompile --- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 24 +++++++-------- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++++------- .../GetImageGenerations_MaximumSet_Gen.json | 18 +++++------ .../GetImageGenerations_MinimumSet_Gen.json | 10 +++---- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 24 +++++++-------- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++++------- .../GetImageGenerations_MaximumSet_Gen.json | 18 +++++------ .../GetImageGenerations_MinimumSet_Gen.json | 10 +++---- 12 files changed, 120 insertions(+), 120 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index dfb46e612fb8..51a27be1e76e 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "tonilp", + "azureml-model-deployment": "ucrufeucw", "body": { "extras": { - "key6891": "kbemeffwrchpubwol" + "key4009": "guzqcyes" }, "messages": [ { @@ -15,7 +15,7 @@ } ], "frequency_penalty": 1, - "presence_penalty": -2, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -23,7 +23,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "ybcbdvregoivwxvdfcczuvpeqmeupo" + "eztyfqipgwftuccuiyjmylrfqlf" ], "stream": true, "tools": [ @@ -31,26 +31,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 1 + "seed": 6 } }, "responses": { "200": { "body": { - "id": "ejh", - "object": "jdlektbtkmlafuey", - "created": 13, - "model": "s", + "id": "dcg", + "object": "wivjwjboly", + "created": 19, + "model": "qldstnckyzhqgwmtprnuabvo", "choices": [ { - "index": 20, + "index": 4, "message": { "role": "system", - "content": "buywjxoocqnus", + "content": "vuvdcwlbndzfi", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "jxt" + "id": "mflczsywc" } ] }, @@ -59,9 +59,9 @@ ], "usage": { "capacity_type": "usage", - "completion_tokens": 15, - "prompt_tokens": 26, - "total_tokens": 18 + "completion_tokens": 5, + "prompt_tokens": 5, + "total_tokens": 16 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index c2bbf5cc38bd..a9e12f64a7e2 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,25 +14,25 @@ "responses": { "200": { "body": { - "id": "ejh", - "object": "jdlektbtkmlafuey", - "created": 13, - "model": "s", + "id": "dcg", + "object": "wivjwjboly", + "created": 19, + "model": "qldstnckyzhqgwmtprnuabvo", "choices": [ { - "index": 20, + "index": 4, "message": { "role": "system", - "content": "buywjxoocqnus" + "content": "vuvdcwlbndzfi" }, "finish_reason": "stop" } ], "usage": { "capacity_type": "usage", - "completion_tokens": 15, - "prompt_tokens": 26, - "total_tokens": 18 + "completion_tokens": 5, + "prompt_tokens": 5, + "total_tokens": 16 } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index f681b9608410..e37a07bf26dd 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -4,13 +4,13 @@ "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "keqnpizxpgkjtrphualhgo", + "azureml-model-deployment": "fiuodvwqlkchmjbjoqagki", "body": { "extras": { - "key4791": "wlkccycrgulewayprqmixvcqoeh" + "key8343": "qddzhpbcstky" }, "input": [ - "omeboabffdok" + "dfkpylslenbtzjwqmgkksutgr" ], "input_type": "text" } @@ -18,24 +18,24 @@ "responses": { "200": { "body": { - "id": "uhcfa", + "id": "nrqfmq", "data": [ { "embedding": [ - 12 + 25 ], - "index": 14, - "object": "acrufadzyvaxlfihmkngxqcaxj" + "index": 11, + "object": "fg" } ], "usage": { "capacity_type": "usage", - "input_tokens": 26, - "prompt_tokens": 13, - "total_tokens": 20 + "input_tokens": 23, + "prompt_tokens": 4, + "total_tokens": 29 }, - "object": "jeihlrgdjmkyjdk", - "model": "pgjmftxyblmvutylczqjj" + "object": "namwykxalaom", + "model": "ncpr" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index c5d44ff68509..5e8b3236caa5 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "kctpevtlklpvjk" + "cumohaewuxedzvq" ] } }, "responses": { "200": { "body": { - "id": "uhcfa", + "id": "nrqfmq", "data": [ { "embedding": [ - 12 + 25 ], - "index": 14, - "object": "acrufadzyvaxlfihmkngxqcaxj" + "index": 11, + "object": "fg" } ], "usage": { "capacity_type": "usage", - "input_tokens": 26, - "prompt_tokens": 13, - "total_tokens": 20 + "input_tokens": 23, + "prompt_tokens": 4, + "total_tokens": 29 }, - "object": "jeihlrgdjmkyjdk", - "model": "pgjmftxyblmvutylczqjj" + "object": "namwykxalaom", + "model": "ncpr" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json index 19ffefa62fcf..b18b69198126 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -4,28 +4,28 @@ "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "mqyhplyskslifaoxuvho", + "azureml-model-deployment": "o", "body": { "extras": { - "key9873": "mjwetwlps" + "key9241": "zxstvlctwofjyhmzfmkipesjyh" }, - "prompt": "pwodoqb", - "size": "kzf", + "prompt": "drhwtcjlhngujxxjelhft", + "size": "olcavqmhbqfzlqbyvlplgayrn", "quality": "standard", "response_format": "url", - "seed": 2 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "ijyymqifsiaekwavwtcmrbn", - "created": 17, - "model": "m", + "id": "nfdnjvqylmcnkrtuylex", + "created": 9, + "model": "roqaaqlfiqkehzlnur", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "ehfcbuotnxovacoh" + "b64_json": "yuulxvoxaifcvhgagjemmll" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json index 5a8fd21e7369..a01b76bdfcc3 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "jiftc", - "size": "qrvtgulvssvxuba" + "prompt": "femuuaemgwpg", + "size": "kiot" } }, "responses": { "200": { "body": { - "id": "ijyymqifsiaekwavwtcmrbn", - "created": 17, - "model": "m", + "id": "nfdnjvqylmcnkrtuylex", + "created": 9, + "model": "roqaaqlfiqkehzlnur", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index dfb46e612fb8..51a27be1e76e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -4,10 +4,10 @@ "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "tonilp", + "azureml-model-deployment": "ucrufeucw", "body": { "extras": { - "key6891": "kbemeffwrchpubwol" + "key4009": "guzqcyes" }, "messages": [ { @@ -15,7 +15,7 @@ } ], "frequency_penalty": 1, - "presence_penalty": -2, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -23,7 +23,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "ybcbdvregoivwxvdfcczuvpeqmeupo" + "eztyfqipgwftuccuiyjmylrfqlf" ], "stream": true, "tools": [ @@ -31,26 +31,26 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 1 + "seed": 6 } }, "responses": { "200": { "body": { - "id": "ejh", - "object": "jdlektbtkmlafuey", - "created": 13, - "model": "s", + "id": "dcg", + "object": "wivjwjboly", + "created": 19, + "model": "qldstnckyzhqgwmtprnuabvo", "choices": [ { - "index": 20, + "index": 4, "message": { "role": "system", - "content": "buywjxoocqnus", + "content": "vuvdcwlbndzfi", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "jxt" + "id": "mflczsywc" } ] }, @@ -59,9 +59,9 @@ ], "usage": { "capacity_type": "usage", - "completion_tokens": 15, - "prompt_tokens": 26, - "total_tokens": 18 + "completion_tokens": 5, + "prompt_tokens": 5, + "total_tokens": 16 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index c2bbf5cc38bd..a9e12f64a7e2 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,25 +14,25 @@ "responses": { "200": { "body": { - "id": "ejh", - "object": "jdlektbtkmlafuey", - "created": 13, - "model": "s", + "id": "dcg", + "object": "wivjwjboly", + "created": 19, + "model": "qldstnckyzhqgwmtprnuabvo", "choices": [ { - "index": 20, + "index": 4, "message": { "role": "system", - "content": "buywjxoocqnus" + "content": "vuvdcwlbndzfi" }, "finish_reason": "stop" } ], "usage": { "capacity_type": "usage", - "completion_tokens": 15, - "prompt_tokens": 26, - "total_tokens": 18 + "completion_tokens": 5, + "prompt_tokens": 5, + "total_tokens": 16 } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index f681b9608410..e37a07bf26dd 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -4,13 +4,13 @@ "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "keqnpizxpgkjtrphualhgo", + "azureml-model-deployment": "fiuodvwqlkchmjbjoqagki", "body": { "extras": { - "key4791": "wlkccycrgulewayprqmixvcqoeh" + "key8343": "qddzhpbcstky" }, "input": [ - "omeboabffdok" + "dfkpylslenbtzjwqmgkksutgr" ], "input_type": "text" } @@ -18,24 +18,24 @@ "responses": { "200": { "body": { - "id": "uhcfa", + "id": "nrqfmq", "data": [ { "embedding": [ - 12 + 25 ], - "index": 14, - "object": "acrufadzyvaxlfihmkngxqcaxj" + "index": 11, + "object": "fg" } ], "usage": { "capacity_type": "usage", - "input_tokens": 26, - "prompt_tokens": 13, - "total_tokens": 20 + "input_tokens": 23, + "prompt_tokens": 4, + "total_tokens": 29 }, - "object": "jeihlrgdjmkyjdk", - "model": "pgjmftxyblmvutylczqjj" + "object": "namwykxalaom", + "model": "ncpr" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index c5d44ff68509..5e8b3236caa5 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "kctpevtlklpvjk" + "cumohaewuxedzvq" ] } }, "responses": { "200": { "body": { - "id": "uhcfa", + "id": "nrqfmq", "data": [ { "embedding": [ - 12 + 25 ], - "index": 14, - "object": "acrufadzyvaxlfihmkngxqcaxj" + "index": 11, + "object": "fg" } ], "usage": { "capacity_type": "usage", - "input_tokens": 26, - "prompt_tokens": 13, - "total_tokens": 20 + "input_tokens": 23, + "prompt_tokens": 4, + "total_tokens": 29 }, - "object": "jeihlrgdjmkyjdk", - "model": "pgjmftxyblmvutylczqjj" + "object": "namwykxalaom", + "model": "ncpr" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json index 19ffefa62fcf..b18b69198126 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -4,28 +4,28 @@ "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "mqyhplyskslifaoxuvho", + "azureml-model-deployment": "o", "body": { "extras": { - "key9873": "mjwetwlps" + "key9241": "zxstvlctwofjyhmzfmkipesjyh" }, - "prompt": "pwodoqb", - "size": "kzf", + "prompt": "drhwtcjlhngujxxjelhft", + "size": "olcavqmhbqfzlqbyvlplgayrn", "quality": "standard", "response_format": "url", - "seed": 2 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "ijyymqifsiaekwavwtcmrbn", - "created": 17, - "model": "m", + "id": "nfdnjvqylmcnkrtuylex", + "created": 9, + "model": "roqaaqlfiqkehzlnur", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "ehfcbuotnxovacoh" + "b64_json": "yuulxvoxaifcvhgagjemmll" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json index 5a8fd21e7369..a01b76bdfcc3 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "jiftc", - "size": "qrvtgulvssvxuba" + "prompt": "femuuaemgwpg", + "size": "kiot" } }, "responses": { "200": { "body": { - "id": "ijyymqifsiaekwavwtcmrbn", - "created": 17, - "model": "m", + "id": "nfdnjvqylmcnkrtuylex", + "created": 9, + "model": "roqaaqlfiqkehzlnur", "data": [ {} ] From 3f67808667ee3e853c50ab7388aaec009ae91240 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 5 Apr 2024 08:53:11 -0700 Subject: [PATCH 045/343] Delta models for streaming --- .../GetChatCompletions_MaximumSet_Gen.json | 69 ------------ .../GetChatCompletions_MinimumSet_Gen.json | 40 ------- .../GetEmbeddings_MaximumSet_Gen.json | 42 -------- .../GetEmbeddings_MinimumSet_Gen.json | 36 ------- .../GetImageGenerations_MaximumSet_Gen.json | 34 ------ .../GetImageGenerations_MinimumSet_Gen.json | 23 ---- .../ModelClient/models/chat_completions.tsp | 69 +++++++++--- .../GetChatCompletions_MaximumSet_Gen.json | 69 ------------ .../GetChatCompletions_MinimumSet_Gen.json | 40 ------- .../GetEmbeddings_MaximumSet_Gen.json | 42 -------- .../GetEmbeddings_MinimumSet_Gen.json | 36 ------- .../GetImageGenerations_MaximumSet_Gen.json | 34 ------ .../GetImageGenerations_MinimumSet_Gen.json | 23 ---- .../preview/2024-04-01-preview/openapi.json | 101 +++++++++++++----- 14 files changed, 127 insertions(+), 531 deletions(-) delete mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json delete mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json delete mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json delete mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json delete mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json delete mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json delete mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json delete mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json delete mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json delete mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json delete mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json delete mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json deleted file mode 100644 index 51a27be1e76e..000000000000 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "title": "maximum set chat completion", - "operationId": "GetChatCompletions", - "parameters": { - "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "ucrufeucw", - "body": { - "extras": { - "key4009": "guzqcyes" - }, - "messages": [ - { - "role": "ChatRequestMessage" - } - ], - "frequency_penalty": 1, - "presence_penalty": 0, - "temperature": 0, - "top_p": 0, - "max_tokens": 0, - "response_format": { - "type": "ChatCompletionsResponseFormat" - }, - "stop": [ - "eztyfqipgwftuccuiyjmylrfqlf" - ], - "stream": true, - "tools": [ - { - "type": "ChatCompletionsToolDefinition" - } - ], - "seed": 6 - } - }, - "responses": { - "200": { - "body": { - "id": "dcg", - "object": "wivjwjboly", - "created": 19, - "model": "qldstnckyzhqgwmtprnuabvo", - "choices": [ - { - "index": 4, - "message": { - "role": "system", - "content": "vuvdcwlbndzfi", - "tool_calls": [ - { - "type": "ChatCompletionsToolCall", - "id": "mflczsywc" - } - ] - }, - "finish_reason": "stop" - } - ], - "usage": { - "capacity_type": "usage", - "completion_tokens": 5, - "prompt_tokens": 5, - "total_tokens": 16 - } - } - } - } -} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json deleted file mode 100644 index a9e12f64a7e2..000000000000 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "title": "minimum set chat completion", - "operationId": "GetChatCompletions", - "parameters": { - "api-version": "2024-04-01-preview", - "body": { - "messages": [ - { - "role": "ChatRequestMessage" - } - ] - } - }, - "responses": { - "200": { - "body": { - "id": "dcg", - "object": "wivjwjboly", - "created": 19, - "model": "qldstnckyzhqgwmtprnuabvo", - "choices": [ - { - "index": 4, - "message": { - "role": "system", - "content": "vuvdcwlbndzfi" - }, - "finish_reason": "stop" - } - ], - "usage": { - "capacity_type": "usage", - "completion_tokens": 5, - "prompt_tokens": 5, - "total_tokens": 16 - } - } - } - } -} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json deleted file mode 100644 index e37a07bf26dd..000000000000 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "title": "maximum set embeddings", - "operationId": "GetEmbeddings", - "parameters": { - "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "fiuodvwqlkchmjbjoqagki", - "body": { - "extras": { - "key8343": "qddzhpbcstky" - }, - "input": [ - "dfkpylslenbtzjwqmgkksutgr" - ], - "input_type": "text" - } - }, - "responses": { - "200": { - "body": { - "id": "nrqfmq", - "data": [ - { - "embedding": [ - 25 - ], - "index": 11, - "object": "fg" - } - ], - "usage": { - "capacity_type": "usage", - "input_tokens": 23, - "prompt_tokens": 4, - "total_tokens": 29 - }, - "object": "namwykxalaom", - "model": "ncpr" - } - } - } -} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json deleted file mode 100644 index 5e8b3236caa5..000000000000 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "title": "minimum set embeddings", - "operationId": "GetEmbeddings", - "parameters": { - "api-version": "2024-04-01-preview", - "body": { - "input": [ - "cumohaewuxedzvq" - ] - } - }, - "responses": { - "200": { - "body": { - "id": "nrqfmq", - "data": [ - { - "embedding": [ - 25 - ], - "index": 11, - "object": "fg" - } - ], - "usage": { - "capacity_type": "usage", - "input_tokens": 23, - "prompt_tokens": 4, - "total_tokens": 29 - }, - "object": "namwykxalaom", - "model": "ncpr" - } - } - } -} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json deleted file mode 100644 index b18b69198126..000000000000 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "title": "maximum set image generation", - "operationId": "GetImageGenerations", - "parameters": { - "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "o", - "body": { - "extras": { - "key9241": "zxstvlctwofjyhmzfmkipesjyh" - }, - "prompt": "drhwtcjlhngujxxjelhft", - "size": "olcavqmhbqfzlqbyvlplgayrn", - "quality": "standard", - "response_format": "url", - "seed": 21 - } - }, - "responses": { - "200": { - "body": { - "id": "nfdnjvqylmcnkrtuylex", - "created": 9, - "model": "roqaaqlfiqkehzlnur", - "data": [ - { - "url": "https://microsoft.com/a", - "b64_json": "yuulxvoxaifcvhgagjemmll" - } - ] - } - } - } -} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json deleted file mode 100644 index a01b76bdfcc3..000000000000 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "title": "minimum set image generation", - "operationId": "GetImageGenerations", - "parameters": { - "api-version": "2024-04-01-preview", - "body": { - "prompt": "femuuaemgwpg", - "size": "kiot" - } - }, - "responses": { - "200": { - "body": { - "id": "nfdnjvqylmcnkrtuylex", - "created": 9, - "model": "roqaaqlfiqkehzlnur", - "data": [ - {} - ] - } - } - } -} diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 32e0540d556f..3a3e8e65e8ed 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -96,12 +96,7 @@ alias ChatCompletionsOptions = { seed?: int64; }; -@doc(""" -Representation of the response data from a chat completions request. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") -model ChatCompletions { +alias ChatCompletionsCommon = { @doc("A unique identifier associated with this chat completions response.") id: string; @@ -118,6 +113,20 @@ model ChatCompletions { @doc("The model used for the chat completion.") `model`: string; + @doc(""" + Usage information for tokens processed and generated as part of this completions operation. + """) + usage: CompletionsUsage; +}; + +@doc(""" +Representation of the response data from a chat completions request. +Completions support a wide variety of tasks and generate text that continues from or "completes" +provided prompt data. +""") +model ChatCompletions { + ...ChatCompletionsCommon; + @doc(""" The collection of completions choices associated with this completions response. Generally, `n` choices are generated per provided prompt with a default value of 1. @@ -125,11 +134,24 @@ model ChatCompletions { """) @minItems(1) choices: ChatChoice[]; +} + +@doc(""" +Represents a response update to a chat completions request, when the service is streaming updates +using Server Sent Events (SSE). +Completions support a wide variety of tasks and generate text that continues from or "completes" +provided prompt data. +""") +model ChatCompletionsDelta { + ...ChatCompletionsCommon; @doc(""" - Usage information for tokens processed and generated as part of this completions operation. - """) - usage: CompletionsUsage; + An update to the collection of completion choices associated with this completions response. + Generally, `n` choices are generated per provided prompt with a default value of 1. + Token limits and other settings may limit the number of choices generated. + """) + @minItems(1) + choices: ChatChoiceDelta[]; } @doc(""" @@ -213,22 +235,39 @@ model ChatCompletionsJsonResponseFormat extends ChatCompletionsResponseFormat { type: "json_object"; } +alias ChatChoiceCommon = { + @doc("The ordered index associated with this chat completions choice.") + index: int32; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" + #suppress "@azure-tools/typespec-autorest/union-unsupported" "OpenAPI v2 support deferred" + @doc("The reason that this chat completions choice completed its generated.") + finish_reason: CompletionsFinishReason | null; +}; + @doc(""" The representation of a single prompt completion as part of an overall chat completions request. Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated. """) model ChatChoice { - @doc("The ordered index associated with this chat completions choice.") - index: int32; + ...ChatChoiceCommon; @doc("The chat message for a given chat completions prompt.") message: ChatResponseMessage; +} - #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" - #suppress "@azure-tools/typespec-autorest/union-unsupported" "OpenAPI v2 support deferred" - @doc("The reason that this chat completions choice completed its generated.") - finish_reason: CompletionsFinishReason | null; +@doc(""" +Represents an update to a single prompt completion when the service is streaming updates +using Server Sent Events (SSE). +Generally, `n` choices are generated per provided prompt with a default value of 1. +Token limits and other settings may limit the number of choices generated. +""") +model ChatChoiceDelta { + ...ChatChoiceCommon; + + @doc("An update to the chat message for a given chat completions prompt.") + delta: ChatResponseMessage; } @discriminator("role") diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json deleted file mode 100644 index 51a27be1e76e..000000000000 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "title": "maximum set chat completion", - "operationId": "GetChatCompletions", - "parameters": { - "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "ucrufeucw", - "body": { - "extras": { - "key4009": "guzqcyes" - }, - "messages": [ - { - "role": "ChatRequestMessage" - } - ], - "frequency_penalty": 1, - "presence_penalty": 0, - "temperature": 0, - "top_p": 0, - "max_tokens": 0, - "response_format": { - "type": "ChatCompletionsResponseFormat" - }, - "stop": [ - "eztyfqipgwftuccuiyjmylrfqlf" - ], - "stream": true, - "tools": [ - { - "type": "ChatCompletionsToolDefinition" - } - ], - "seed": 6 - } - }, - "responses": { - "200": { - "body": { - "id": "dcg", - "object": "wivjwjboly", - "created": 19, - "model": "qldstnckyzhqgwmtprnuabvo", - "choices": [ - { - "index": 4, - "message": { - "role": "system", - "content": "vuvdcwlbndzfi", - "tool_calls": [ - { - "type": "ChatCompletionsToolCall", - "id": "mflczsywc" - } - ] - }, - "finish_reason": "stop" - } - ], - "usage": { - "capacity_type": "usage", - "completion_tokens": 5, - "prompt_tokens": 5, - "total_tokens": 16 - } - } - } - } -} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json deleted file mode 100644 index a9e12f64a7e2..000000000000 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "title": "minimum set chat completion", - "operationId": "GetChatCompletions", - "parameters": { - "api-version": "2024-04-01-preview", - "body": { - "messages": [ - { - "role": "ChatRequestMessage" - } - ] - } - }, - "responses": { - "200": { - "body": { - "id": "dcg", - "object": "wivjwjboly", - "created": 19, - "model": "qldstnckyzhqgwmtprnuabvo", - "choices": [ - { - "index": 4, - "message": { - "role": "system", - "content": "vuvdcwlbndzfi" - }, - "finish_reason": "stop" - } - ], - "usage": { - "capacity_type": "usage", - "completion_tokens": 5, - "prompt_tokens": 5, - "total_tokens": 16 - } - } - } - } -} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json deleted file mode 100644 index e37a07bf26dd..000000000000 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "title": "maximum set embeddings", - "operationId": "GetEmbeddings", - "parameters": { - "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "fiuodvwqlkchmjbjoqagki", - "body": { - "extras": { - "key8343": "qddzhpbcstky" - }, - "input": [ - "dfkpylslenbtzjwqmgkksutgr" - ], - "input_type": "text" - } - }, - "responses": { - "200": { - "body": { - "id": "nrqfmq", - "data": [ - { - "embedding": [ - 25 - ], - "index": 11, - "object": "fg" - } - ], - "usage": { - "capacity_type": "usage", - "input_tokens": 23, - "prompt_tokens": 4, - "total_tokens": 29 - }, - "object": "namwykxalaom", - "model": "ncpr" - } - } - } -} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json deleted file mode 100644 index 5e8b3236caa5..000000000000 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "title": "minimum set embeddings", - "operationId": "GetEmbeddings", - "parameters": { - "api-version": "2024-04-01-preview", - "body": { - "input": [ - "cumohaewuxedzvq" - ] - } - }, - "responses": { - "200": { - "body": { - "id": "nrqfmq", - "data": [ - { - "embedding": [ - 25 - ], - "index": 11, - "object": "fg" - } - ], - "usage": { - "capacity_type": "usage", - "input_tokens": 23, - "prompt_tokens": 4, - "total_tokens": 29 - }, - "object": "namwykxalaom", - "model": "ncpr" - } - } - } -} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json deleted file mode 100644 index b18b69198126..000000000000 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "title": "maximum set image generation", - "operationId": "GetImageGenerations", - "parameters": { - "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "o", - "body": { - "extras": { - "key9241": "zxstvlctwofjyhmzfmkipesjyh" - }, - "prompt": "drhwtcjlhngujxxjelhft", - "size": "olcavqmhbqfzlqbyvlplgayrn", - "quality": "standard", - "response_format": "url", - "seed": 21 - } - }, - "responses": { - "200": { - "body": { - "id": "nfdnjvqylmcnkrtuylex", - "created": 9, - "model": "roqaaqlfiqkehzlnur", - "data": [ - { - "url": "https://microsoft.com/a", - "b64_json": "yuulxvoxaifcvhgagjemmll" - } - ] - } - } - } -} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json deleted file mode 100644 index a01b76bdfcc3..000000000000 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "title": "minimum set image generation", - "operationId": "GetImageGenerations", - "parameters": { - "api-version": "2024-04-01-preview", - "body": { - "prompt": "femuuaemgwpg", - "size": "kiot" - } - }, - "responses": { - "200": { - "body": { - "id": "nfdnjvqylmcnkrtuylex", - "created": 9, - "model": "roqaaqlfiqkehzlnur", - "data": [ - {} - ] - } - } - } -} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 58b8e741b993..a95fa183af69 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -153,14 +153,6 @@ } } } - }, - "x-ms-examples": { - "maximum set image generation": { - "$ref": "./examples/GetImageGenerations_MaximumSet_Gen.json" - }, - "minimum set image generation": { - "$ref": "./examples/GetImageGenerations_MinimumSet_Gen.json" - } } } }, @@ -336,14 +328,6 @@ } } } - }, - "x-ms-examples": { - "maximum set chat completion": { - "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" - }, - "minimum set chat completion": { - "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" - } } } }, @@ -448,14 +432,6 @@ } } } - }, - "x-ms-examples": { - "maximum set embeddings": { - "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" - }, - "minimum set embeddings": { - "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" - } } } } @@ -555,20 +531,45 @@ "format": "int32", "description": "The ordered index associated with this chat completions choice." }, + "finish_reason": { + "$ref": "#/definitions/CompletionsFinishReason", + "description": "The reason that this chat completions choice completed its generated.", + "x-nullable": true + }, "message": { "$ref": "#/definitions/ChatResponseMessage", "description": "The chat message for a given chat completions prompt." + } + }, + "required": [ + "index", + "finish_reason", + "message" + ] + }, + "ChatChoiceDelta": { + "type": "object", + "description": "Represents an update to a single prompt completion when the service is streaming updates \nusing Server Sent Events (SSE).\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "properties": { + "index": { + "type": "integer", + "format": "int32", + "description": "The ordered index associated with this chat completions choice." }, "finish_reason": { "$ref": "#/definitions/CompletionsFinishReason", "description": "The reason that this chat completions choice completed its generated.", "x-nullable": true + }, + "delta": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "An update to the chat message for a given chat completions prompt." } }, "required": [ "index", - "message", - "finish_reason" + "finish_reason", + "delta" ] }, "ChatCompletions": { @@ -592,6 +593,10 @@ "type": "string", "description": "The model used for the chat completion." }, + "usage": { + "$ref": "#/definitions/CompletionsUsage", + "description": "Usage information for tokens processed and generated as part of this completions operation." + }, "choices": { "type": "array", "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", @@ -600,10 +605,50 @@ "$ref": "#/definitions/ChatChoice" }, "x-ms-identifiers": [] + } + }, + "required": [ + "id", + "object", + "created", + "model", + "usage", + "choices" + ] + }, + "ChatCompletionsDelta": { + "type": "object", + "description": "Represents a response update to a chat completions request, when the service is streaming updates \nusing Server Sent Events (SSE).\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier associated with this chat completions response." + }, + "object": { + "type": "string", + "description": "The response object type, which is always `chat.completion`." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "model": { + "type": "string", + "description": "The model used for the chat completion." }, "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." + }, + "choices": { + "type": "array", + "description": "An update to the collection of completion choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ChatChoiceDelta" + }, + "x-ms-identifiers": [] } }, "required": [ @@ -611,8 +656,8 @@ "object", "created", "model", - "choices", - "usage" + "usage", + "choices" ] }, "ChatCompletionsFunctionToolCall": { From 0053febfe9c1a4951e32ba8cd9d23d2c4d4f3c94 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 5 Apr 2024 12:13:33 -0700 Subject: [PATCH 046/343] Set usage and access of 'Delta' models --- specification/ai/ModelClient/client.tsp | 7 ++ .../GetChatCompletions_MaximumSet_Gen.json | 69 +++++++++++++++++++ .../GetChatCompletions_MinimumSet_Gen.json | 40 +++++++++++ .../GetEmbeddings_MaximumSet_Gen.json | 42 +++++++++++ .../GetEmbeddings_MinimumSet_Gen.json | 36 ++++++++++ .../GetImageGenerations_MaximumSet_Gen.json | 34 +++++++++ .../GetImageGenerations_MinimumSet_Gen.json | 23 +++++++ .../GetChatCompletions_MaximumSet_Gen.json | 69 +++++++++++++++++++ .../GetChatCompletions_MinimumSet_Gen.json | 40 +++++++++++ .../GetEmbeddings_MaximumSet_Gen.json | 42 +++++++++++ .../GetEmbeddings_MinimumSet_Gen.json | 36 ++++++++++ .../GetImageGenerations_MaximumSet_Gen.json | 34 +++++++++ .../GetImageGenerations_MinimumSet_Gen.json | 23 +++++++ .../preview/2024-04-01-preview/openapi.json | 24 +++++++ 14 files changed, 519 insertions(+) create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 9cfaeccaaa88..38b7387b3098 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -3,3 +3,10 @@ import "@azure-tools/typespec-client-generator-core"; import "./main.tsp"; using Azure.ClientGenerator.Core; + +// The "Delta" models are used by the hand-written operation method that supports streaming. +// We need to declare their usage and public access, otherwise they won't be emited in the generated code. +@@access(ModelClient.ChatCompletionsDelta, Access.public); +@@usage(ModelClient.ChatCompletionsDelta, Usage.output); +@@access(ModelClient.ChatChoiceDelta, Access.public); +@@usage(ModelClient.ChatChoiceDelta, Usage.output); diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f8260b8a08b --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "maximum set chat completion", + "operationId": "GetChatCompletions", + "parameters": { + "api-version": "2024-04-01-preview", + "extra-parameters": "error", + "azureml-model-deployment": "zbobisswkcotdgbbwiurhrhml", + "body": { + "extras": { + "key4651": "snfmcizlbmqsfhshejzxbruor" + }, + "messages": [ + { + "role": "ChatRequestMessage" + } + ], + "frequency_penalty": 0, + "presence_penalty": 0, + "temperature": 0, + "top_p": 0, + "max_tokens": 0, + "response_format": { + "type": "ChatCompletionsResponseFormat" + }, + "stop": [ + "dqiuvgjcylbhsfznlrxtpzad" + ], + "stream": true, + "tools": [ + { + "type": "ChatCompletionsToolDefinition" + } + ], + "seed": 26 + } + }, + "responses": { + "200": { + "body": { + "id": "nzohkobbjocneadrqnk", + "object": "fdmrqc", + "created": 19, + "model": "gjgkvrs", + "usage": { + "capacity_type": "usage", + "completion_tokens": 7, + "prompt_tokens": 21, + "total_tokens": 10 + }, + "choices": [ + { + "index": 4, + "finish_reason": "stop", + "message": { + "role": "system", + "content": "trwdvopeymycscxgrqtvimdhycmgem", + "tool_calls": [ + { + "type": "ChatCompletionsToolCall", + "id": "boesquowsgsssaoiefbh" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json new file mode 100644 index 000000000000..ecc1d1aace55 --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "minimum set chat completion", + "operationId": "GetChatCompletions", + "parameters": { + "api-version": "2024-04-01-preview", + "body": { + "messages": [ + { + "role": "ChatRequestMessage" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "nzohkobbjocneadrqnk", + "object": "fdmrqc", + "created": 19, + "model": "gjgkvrs", + "usage": { + "capacity_type": "usage", + "completion_tokens": 7, + "prompt_tokens": 21, + "total_tokens": 10 + }, + "choices": [ + { + "index": 4, + "finish_reason": "stop", + "message": { + "role": "system", + "content": "trwdvopeymycscxgrqtvimdhycmgem" + } + } + ] + } + } + } +} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json new file mode 100644 index 000000000000..d86b7ae7c763 --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "maximum set embeddings", + "operationId": "GetEmbeddings", + "parameters": { + "api-version": "2024-04-01-preview", + "extra-parameters": "error", + "azureml-model-deployment": "guycbryz", + "body": { + "extras": { + "key9223": "ektbeb" + }, + "input": [ + "xphznudteahxyjjbuq" + ], + "input_type": "text" + } + }, + "responses": { + "200": { + "body": { + "id": "ppyeteghxlkoqpoyapsf", + "data": [ + { + "embedding": [ + 12 + ], + "index": 23, + "object": "dcptrnsxqyfdidbqanw" + } + ], + "usage": { + "capacity_type": "usage", + "input_tokens": 23, + "prompt_tokens": 2, + "total_tokens": 29 + }, + "object": "pzeciowfdjqmnhdjvuopzb", + "model": "nknfvafwgd" + } + } + } +} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json new file mode 100644 index 000000000000..fbee83c571f2 --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "minimum set embeddings", + "operationId": "GetEmbeddings", + "parameters": { + "api-version": "2024-04-01-preview", + "body": { + "input": [ + "tlrvjs" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "ppyeteghxlkoqpoyapsf", + "data": [ + { + "embedding": [ + 12 + ], + "index": 23, + "object": "dcptrnsxqyfdidbqanw" + } + ], + "usage": { + "capacity_type": "usage", + "input_tokens": 23, + "prompt_tokens": 2, + "total_tokens": 29 + }, + "object": "pzeciowfdjqmnhdjvuopzb", + "model": "nknfvafwgd" + } + } + } +} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json new file mode 100644 index 000000000000..f090bb19c8fb --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "title": "maximum set image generation", + "operationId": "GetImageGenerations", + "parameters": { + "api-version": "2024-04-01-preview", + "extra-parameters": "error", + "azureml-model-deployment": "lhibwaecjxaemspygcijgtqgjc", + "body": { + "extras": { + "key7781": "qet" + }, + "prompt": "itqynwbspxteegkzukgl", + "size": "zplsbfstdrwficzdc", + "quality": "standard", + "response_format": "url", + "seed": 19 + } + }, + "responses": { + "200": { + "body": { + "id": "dbuhzrudyuoiecpbiinhtopsm", + "created": 16, + "model": "vbswrxus", + "data": [ + { + "url": "https://microsoft.com/a", + "b64_json": "qtvmtunfognznex" + } + ] + } + } + } +} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json new file mode 100644 index 000000000000..2b2947510f1c --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "title": "minimum set image generation", + "operationId": "GetImageGenerations", + "parameters": { + "api-version": "2024-04-01-preview", + "body": { + "prompt": "kqostymhvq", + "size": "wxflieizgipflr" + } + }, + "responses": { + "200": { + "body": { + "id": "dbuhzrudyuoiecpbiinhtopsm", + "created": 16, + "model": "vbswrxus", + "data": [ + {} + ] + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f8260b8a08b --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "maximum set chat completion", + "operationId": "GetChatCompletions", + "parameters": { + "api-version": "2024-04-01-preview", + "extra-parameters": "error", + "azureml-model-deployment": "zbobisswkcotdgbbwiurhrhml", + "body": { + "extras": { + "key4651": "snfmcizlbmqsfhshejzxbruor" + }, + "messages": [ + { + "role": "ChatRequestMessage" + } + ], + "frequency_penalty": 0, + "presence_penalty": 0, + "temperature": 0, + "top_p": 0, + "max_tokens": 0, + "response_format": { + "type": "ChatCompletionsResponseFormat" + }, + "stop": [ + "dqiuvgjcylbhsfznlrxtpzad" + ], + "stream": true, + "tools": [ + { + "type": "ChatCompletionsToolDefinition" + } + ], + "seed": 26 + } + }, + "responses": { + "200": { + "body": { + "id": "nzohkobbjocneadrqnk", + "object": "fdmrqc", + "created": 19, + "model": "gjgkvrs", + "usage": { + "capacity_type": "usage", + "completion_tokens": 7, + "prompt_tokens": 21, + "total_tokens": 10 + }, + "choices": [ + { + "index": 4, + "finish_reason": "stop", + "message": { + "role": "system", + "content": "trwdvopeymycscxgrqtvimdhycmgem", + "tool_calls": [ + { + "type": "ChatCompletionsToolCall", + "id": "boesquowsgsssaoiefbh" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json new file mode 100644 index 000000000000..ecc1d1aace55 --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "minimum set chat completion", + "operationId": "GetChatCompletions", + "parameters": { + "api-version": "2024-04-01-preview", + "body": { + "messages": [ + { + "role": "ChatRequestMessage" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "nzohkobbjocneadrqnk", + "object": "fdmrqc", + "created": 19, + "model": "gjgkvrs", + "usage": { + "capacity_type": "usage", + "completion_tokens": 7, + "prompt_tokens": 21, + "total_tokens": 10 + }, + "choices": [ + { + "index": 4, + "finish_reason": "stop", + "message": { + "role": "system", + "content": "trwdvopeymycscxgrqtvimdhycmgem" + } + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json new file mode 100644 index 000000000000..d86b7ae7c763 --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "maximum set embeddings", + "operationId": "GetEmbeddings", + "parameters": { + "api-version": "2024-04-01-preview", + "extra-parameters": "error", + "azureml-model-deployment": "guycbryz", + "body": { + "extras": { + "key9223": "ektbeb" + }, + "input": [ + "xphznudteahxyjjbuq" + ], + "input_type": "text" + } + }, + "responses": { + "200": { + "body": { + "id": "ppyeteghxlkoqpoyapsf", + "data": [ + { + "embedding": [ + 12 + ], + "index": 23, + "object": "dcptrnsxqyfdidbqanw" + } + ], + "usage": { + "capacity_type": "usage", + "input_tokens": 23, + "prompt_tokens": 2, + "total_tokens": 29 + }, + "object": "pzeciowfdjqmnhdjvuopzb", + "model": "nknfvafwgd" + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json new file mode 100644 index 000000000000..fbee83c571f2 --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "minimum set embeddings", + "operationId": "GetEmbeddings", + "parameters": { + "api-version": "2024-04-01-preview", + "body": { + "input": [ + "tlrvjs" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "ppyeteghxlkoqpoyapsf", + "data": [ + { + "embedding": [ + 12 + ], + "index": 23, + "object": "dcptrnsxqyfdidbqanw" + } + ], + "usage": { + "capacity_type": "usage", + "input_tokens": 23, + "prompt_tokens": 2, + "total_tokens": 29 + }, + "object": "pzeciowfdjqmnhdjvuopzb", + "model": "nknfvafwgd" + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json new file mode 100644 index 000000000000..f090bb19c8fb --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "title": "maximum set image generation", + "operationId": "GetImageGenerations", + "parameters": { + "api-version": "2024-04-01-preview", + "extra-parameters": "error", + "azureml-model-deployment": "lhibwaecjxaemspygcijgtqgjc", + "body": { + "extras": { + "key7781": "qet" + }, + "prompt": "itqynwbspxteegkzukgl", + "size": "zplsbfstdrwficzdc", + "quality": "standard", + "response_format": "url", + "seed": 19 + } + }, + "responses": { + "200": { + "body": { + "id": "dbuhzrudyuoiecpbiinhtopsm", + "created": 16, + "model": "vbswrxus", + "data": [ + { + "url": "https://microsoft.com/a", + "b64_json": "qtvmtunfognznex" + } + ] + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json new file mode 100644 index 000000000000..2b2947510f1c --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "title": "minimum set image generation", + "operationId": "GetImageGenerations", + "parameters": { + "api-version": "2024-04-01-preview", + "body": { + "prompt": "kqostymhvq", + "size": "wxflieizgipflr" + } + }, + "responses": { + "200": { + "body": { + "id": "dbuhzrudyuoiecpbiinhtopsm", + "created": 16, + "model": "vbswrxus", + "data": [ + {} + ] + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index a95fa183af69..394d597ec678 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -153,6 +153,14 @@ } } } + }, + "x-ms-examples": { + "maximum set image generation": { + "$ref": "./examples/GetImageGenerations_MaximumSet_Gen.json" + }, + "minimum set image generation": { + "$ref": "./examples/GetImageGenerations_MinimumSet_Gen.json" + } } } }, @@ -328,6 +336,14 @@ } } } + }, + "x-ms-examples": { + "maximum set chat completion": { + "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" + }, + "minimum set chat completion": { + "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" + } } } }, @@ -432,6 +448,14 @@ } } } + }, + "x-ms-examples": { + "maximum set embeddings": { + "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" + }, + "minimum set embeddings": { + "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" + } } } } From a017d31c9ae9b03291e9099bf80bcf228f66158f Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Sun, 7 Apr 2024 10:39:46 -0700 Subject: [PATCH 047/343] Add /info route --- .../GetChatCompletions_MaximumSet_Gen.json | 34 +++--- .../GetChatCompletions_MinimumSet_Gen.json | 20 ++-- .../GetEmbeddings_MaximumSet_Gen.json | 24 ++-- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++-- .../GetImageGenerations_MaximumSet_Gen.json | 22 ++-- .../GetImageGenerations_MinimumSet_Gen.json | 12 +- .../GetModelInformation_MaximumSet_Gen.json | 16 +++ .../GetModelInformation_MinimumSet_Gen.json | 16 +++ .../ai/ModelClient/models/model_info.tsp | 36 ++++++ specification/ai/ModelClient/routes.tsp | 7 ++ .../GetChatCompletions_MaximumSet_Gen.json | 34 +++--- .../GetChatCompletions_MinimumSet_Gen.json | 20 ++-- .../GetEmbeddings_MaximumSet_Gen.json | 24 ++-- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++-- .../GetImageGenerations_MaximumSet_Gen.json | 22 ++-- .../GetImageGenerations_MinimumSet_Gen.json | 12 +- .../GetModelInformation_MaximumSet_Gen.json | 16 +++ .../GetModelInformation_MinimumSet_Gen.json | 16 +++ .../preview/2024-04-01-preview/openapi.json | 110 +++++++++++++++++- 19 files changed, 343 insertions(+), 138 deletions(-) create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json create mode 100644 specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json create mode 100644 specification/ai/ModelClient/models/model_info.tsp create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json create mode 100644 specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 9f8260b8a08b..bce63eb7c86d 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -1,21 +1,21 @@ { - "title": "maximum set chat completion", + "title": "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "zbobisswkcotdgbbwiurhrhml", + "azureml-model-deployment": "azimtdabpjdflaypzbgytmkwoqqb", "body": { "extras": { - "key4651": "snfmcizlbmqsfhshejzxbruor" + "key3925": "lymrbnvmm" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, - "presence_penalty": 0, + "frequency_penalty": -1, + "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -23,7 +23,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "dqiuvgjcylbhsfznlrxtpzad" + "ml" ], "stream": true, "tools": [ @@ -31,33 +31,33 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 26 + "seed": 19 } }, "responses": { "200": { "body": { - "id": "nzohkobbjocneadrqnk", - "object": "fdmrqc", - "created": 19, - "model": "gjgkvrs", + "id": "cayolp", + "object": "bkazrtmqqd", + "created": 15, + "model": "ilrofrphi", "usage": { "capacity_type": "usage", - "completion_tokens": 7, - "prompt_tokens": 21, - "total_tokens": 10 + "completion_tokens": 4, + "prompt_tokens": 28, + "total_tokens": 27 }, "choices": [ { - "index": 4, + "index": 11, "finish_reason": "stop", "message": { "role": "system", - "content": "trwdvopeymycscxgrqtvimdhycmgem", + "content": "h", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "boesquowsgsssaoiefbh" + "id": "vkvngkngdkwhzninlisebxx" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index ecc1d1aace55..66263180d5e0 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "minimum set chat completion", + "title": "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "nzohkobbjocneadrqnk", - "object": "fdmrqc", - "created": 19, - "model": "gjgkvrs", + "id": "cayolp", + "object": "bkazrtmqqd", + "created": 15, + "model": "ilrofrphi", "usage": { "capacity_type": "usage", - "completion_tokens": 7, - "prompt_tokens": 21, - "total_tokens": 10 + "completion_tokens": 4, + "prompt_tokens": 28, + "total_tokens": 27 }, "choices": [ { - "index": 4, + "index": 11, "finish_reason": "stop", "message": { "role": "system", - "content": "trwdvopeymycscxgrqtvimdhycmgem" + "content": "h" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index d86b7ae7c763..670dc556bfe4 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -1,16 +1,16 @@ { - "title": "maximum set embeddings", + "title": "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "guycbryz", + "azureml-model-deployment": "fcruwuln", "body": { "extras": { - "key9223": "ektbeb" + "key1695": "moqwfsditimjjgbi" }, "input": [ - "xphznudteahxyjjbuq" + "icxscvychtbwuijbitoktieoa" ], "input_type": "text" } @@ -18,24 +18,24 @@ "responses": { "200": { "body": { - "id": "ppyeteghxlkoqpoyapsf", + "id": "bugdoymlinklzttjiwbapbt", "data": [ { "embedding": [ - 12 + 6 ], "index": 23, - "object": "dcptrnsxqyfdidbqanw" + "object": "scbznjgln" } ], "usage": { "capacity_type": "usage", - "input_tokens": 23, - "prompt_tokens": 2, - "total_tokens": 29 + "input_tokens": 19, + "prompt_tokens": 25, + "total_tokens": 7 }, - "object": "pzeciowfdjqmnhdjvuopzb", - "model": "nknfvafwgd" + "object": "d", + "model": "bvjkc" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index fbee83c571f2..13402051ed63 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -1,35 +1,35 @@ { - "title": "minimum set embeddings", + "title": "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", "body": { "input": [ - "tlrvjs" + "hjopbwybqrmcgtorpb" ] } }, "responses": { "200": { "body": { - "id": "ppyeteghxlkoqpoyapsf", + "id": "bugdoymlinklzttjiwbapbt", "data": [ { "embedding": [ - 12 + 6 ], "index": 23, - "object": "dcptrnsxqyfdidbqanw" + "object": "scbznjgln" } ], "usage": { "capacity_type": "usage", - "input_tokens": 23, - "prompt_tokens": 2, - "total_tokens": 29 + "input_tokens": 19, + "prompt_tokens": 25, + "total_tokens": 7 }, - "object": "pzeciowfdjqmnhdjvuopzb", - "model": "nknfvafwgd" + "object": "d", + "model": "bvjkc" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json index f090bb19c8fb..45c32a2547d4 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -1,31 +1,31 @@ { - "title": "maximum set image generation", + "title": "GetImageGenerations_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "lhibwaecjxaemspygcijgtqgjc", + "azureml-model-deployment": "rycvycz", "body": { "extras": { - "key7781": "qet" + "key3837": "pjqpyrlnndtwpidn" }, - "prompt": "itqynwbspxteegkzukgl", - "size": "zplsbfstdrwficzdc", + "prompt": "tqborqvwtmvebb", + "size": "hnbllq", "quality": "standard", "response_format": "url", - "seed": 19 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "dbuhzrudyuoiecpbiinhtopsm", - "created": 16, - "model": "vbswrxus", + "id": "irmxxwflyjxylijuongqc", + "created": 18, + "model": "dtjznkhucamp", "data": [ { - "url": "https://microsoft.com/a", - "b64_json": "qtvmtunfognznex" + "url": "https://microsoft.com/ayeb", + "b64_json": "bhqafrsrtgvlvmwhbxrp" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json index 2b2947510f1c..eb61f841e536 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -1,19 +1,19 @@ { - "title": "minimum set image generation", + "title": "GetImageGenerations_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "kqostymhvq", - "size": "wxflieizgipflr" + "prompt": "ahatelmwtxzcbamvbqsz", + "size": "viyaps" } }, "responses": { "200": { "body": { - "id": "dbuhzrudyuoiecpbiinhtopsm", - "created": 16, - "model": "vbswrxus", + "id": "irmxxwflyjxylijuongqc", + "created": 18, + "model": "dtjznkhucamp", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json new file mode 100644 index 000000000000..32aa2477e47c --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "GetModelInformation_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "GetModelInformation", + "parameters": { + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "model_type": "embeddings", + "model_provider": "frysrdaa", + "model_name": "jjrcmatptdlqqdg" + } + } + } +} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json new file mode 100644 index 000000000000..bbd0bd30729d --- /dev/null +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "GetModelInformation_MaximumSet_Gen - generated by [MinimumSet] rule", + "operationId": "GetModelInformation", + "parameters": { + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "model_type": "embeddings", + "model_provider": "frysrdaa", + "model_name": "jjrcmatptdlqqdg" + } + } + } +} diff --git a/specification/ai/ModelClient/models/model_info.tsp b/specification/ai/ModelClient/models/model_info.tsp new file mode 100644 index 000000000000..7184cc4c1f07 --- /dev/null +++ b/specification/ai/ModelClient/models/model_info.tsp @@ -0,0 +1,36 @@ +import "@typespec/rest"; +import "@typespec/http"; + +using TypeSpec.Rest; +using TypeSpec.Http; + +namespace ModelClient; + +@doc("Represents some basic information about the AI model.") +model ModelInformation { + @doc("The type of the AI model.") + model_type: ModelType; + + @doc("The model provider.") + model_provider: string; + + @doc("The name of the AI model.") + model_name: string; +} + +@doc("The type of AI model") +union ModelType { + string, + + @doc("Embeddings.") + embeddings: "embeddings", + + @doc("Custom model.") + custom: "custom", + + @doc("Chat completions") + chat: "chat", + + @doc("Image generation") + image_generation: "image_generation", +} diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 1d7015f77943..46ee0c63c287 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -7,6 +7,7 @@ import "./models/common.tsp"; import "./models/chat_completions.tsp"; import "./models/embeddings.tsp"; import "./models/image_generation.tsp"; +import "./models/model_info.tsp"; using TypeSpec.Rest; using TypeSpec.Http; @@ -51,3 +52,9 @@ op getImageGenerations is Azure.Core.RpcOperation< }, ImageGenerations >; + +@doc("Returns information about the AI model.") +@actionSeparator("/") +@route("info") +@get +op getModelInformation is Azure.Core.RpcOperation<{}, ModelInformation>; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 9f8260b8a08b..bce63eb7c86d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -1,21 +1,21 @@ { - "title": "maximum set chat completion", + "title": "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "zbobisswkcotdgbbwiurhrhml", + "azureml-model-deployment": "azimtdabpjdflaypzbgytmkwoqqb", "body": { "extras": { - "key4651": "snfmcizlbmqsfhshejzxbruor" + "key3925": "lymrbnvmm" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, - "presence_penalty": 0, + "frequency_penalty": -1, + "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -23,7 +23,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "dqiuvgjcylbhsfznlrxtpzad" + "ml" ], "stream": true, "tools": [ @@ -31,33 +31,33 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 26 + "seed": 19 } }, "responses": { "200": { "body": { - "id": "nzohkobbjocneadrqnk", - "object": "fdmrqc", - "created": 19, - "model": "gjgkvrs", + "id": "cayolp", + "object": "bkazrtmqqd", + "created": 15, + "model": "ilrofrphi", "usage": { "capacity_type": "usage", - "completion_tokens": 7, - "prompt_tokens": 21, - "total_tokens": 10 + "completion_tokens": 4, + "prompt_tokens": 28, + "total_tokens": 27 }, "choices": [ { - "index": 4, + "index": 11, "finish_reason": "stop", "message": { "role": "system", - "content": "trwdvopeymycscxgrqtvimdhycmgem", + "content": "h", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "boesquowsgsssaoiefbh" + "id": "vkvngkngdkwhzninlisebxx" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index ecc1d1aace55..66263180d5e0 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "minimum set chat completion", + "title": "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "nzohkobbjocneadrqnk", - "object": "fdmrqc", - "created": 19, - "model": "gjgkvrs", + "id": "cayolp", + "object": "bkazrtmqqd", + "created": 15, + "model": "ilrofrphi", "usage": { "capacity_type": "usage", - "completion_tokens": 7, - "prompt_tokens": 21, - "total_tokens": 10 + "completion_tokens": 4, + "prompt_tokens": 28, + "total_tokens": 27 }, "choices": [ { - "index": 4, + "index": 11, "finish_reason": "stop", "message": { "role": "system", - "content": "trwdvopeymycscxgrqtvimdhycmgem" + "content": "h" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index d86b7ae7c763..670dc556bfe4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -1,16 +1,16 @@ { - "title": "maximum set embeddings", + "title": "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "guycbryz", + "azureml-model-deployment": "fcruwuln", "body": { "extras": { - "key9223": "ektbeb" + "key1695": "moqwfsditimjjgbi" }, "input": [ - "xphznudteahxyjjbuq" + "icxscvychtbwuijbitoktieoa" ], "input_type": "text" } @@ -18,24 +18,24 @@ "responses": { "200": { "body": { - "id": "ppyeteghxlkoqpoyapsf", + "id": "bugdoymlinklzttjiwbapbt", "data": [ { "embedding": [ - 12 + 6 ], "index": 23, - "object": "dcptrnsxqyfdidbqanw" + "object": "scbznjgln" } ], "usage": { "capacity_type": "usage", - "input_tokens": 23, - "prompt_tokens": 2, - "total_tokens": 29 + "input_tokens": 19, + "prompt_tokens": 25, + "total_tokens": 7 }, - "object": "pzeciowfdjqmnhdjvuopzb", - "model": "nknfvafwgd" + "object": "d", + "model": "bvjkc" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index fbee83c571f2..13402051ed63 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -1,35 +1,35 @@ { - "title": "minimum set embeddings", + "title": "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", "body": { "input": [ - "tlrvjs" + "hjopbwybqrmcgtorpb" ] } }, "responses": { "200": { "body": { - "id": "ppyeteghxlkoqpoyapsf", + "id": "bugdoymlinklzttjiwbapbt", "data": [ { "embedding": [ - 12 + 6 ], "index": 23, - "object": "dcptrnsxqyfdidbqanw" + "object": "scbznjgln" } ], "usage": { "capacity_type": "usage", - "input_tokens": 23, - "prompt_tokens": 2, - "total_tokens": 29 + "input_tokens": 19, + "prompt_tokens": 25, + "total_tokens": 7 }, - "object": "pzeciowfdjqmnhdjvuopzb", - "model": "nknfvafwgd" + "object": "d", + "model": "bvjkc" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json index f090bb19c8fb..45c32a2547d4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -1,31 +1,31 @@ { - "title": "maximum set image generation", + "title": "GetImageGenerations_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", "extra-parameters": "error", - "azureml-model-deployment": "lhibwaecjxaemspygcijgtqgjc", + "azureml-model-deployment": "rycvycz", "body": { "extras": { - "key7781": "qet" + "key3837": "pjqpyrlnndtwpidn" }, - "prompt": "itqynwbspxteegkzukgl", - "size": "zplsbfstdrwficzdc", + "prompt": "tqborqvwtmvebb", + "size": "hnbllq", "quality": "standard", "response_format": "url", - "seed": 19 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "dbuhzrudyuoiecpbiinhtopsm", - "created": 16, - "model": "vbswrxus", + "id": "irmxxwflyjxylijuongqc", + "created": 18, + "model": "dtjznkhucamp", "data": [ { - "url": "https://microsoft.com/a", - "b64_json": "qtvmtunfognznex" + "url": "https://microsoft.com/ayeb", + "b64_json": "bhqafrsrtgvlvmwhbxrp" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json index 2b2947510f1c..eb61f841e536 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -1,19 +1,19 @@ { - "title": "minimum set image generation", + "title": "GetImageGenerations_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "kqostymhvq", - "size": "wxflieizgipflr" + "prompt": "ahatelmwtxzcbamvbqsz", + "size": "viyaps" } }, "responses": { "200": { "body": { - "id": "dbuhzrudyuoiecpbiinhtopsm", - "created": 16, - "model": "vbswrxus", + "id": "irmxxwflyjxylijuongqc", + "created": 18, + "model": "dtjznkhucamp", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json new file mode 100644 index 000000000000..32aa2477e47c --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "GetModelInformation_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "GetModelInformation", + "parameters": { + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "model_type": "embeddings", + "model_provider": "frysrdaa", + "model_name": "jjrcmatptdlqqdg" + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json new file mode 100644 index 000000000000..bbd0bd30729d --- /dev/null +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "GetModelInformation_MaximumSet_Gen - generated by [MinimumSet] rule", + "operationId": "GetModelInformation", + "parameters": { + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "model_type": "embeddings", + "model_provider": "frysrdaa", + "model_name": "jjrcmatptdlqqdg" + } + } + } +} diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 394d597ec678..f7a48104a2b1 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -155,15 +155,54 @@ } }, "x-ms-examples": { - "maximum set image generation": { + "GetImageGenerations_MaximumSet_Gen - generated by [MaximumSet] rule": { "$ref": "./examples/GetImageGenerations_MaximumSet_Gen.json" }, - "minimum set image generation": { + "GetImageGenerations_MaximumSet_Gen - generated by [MinimumSet] rule": { "$ref": "./examples/GetImageGenerations_MinimumSet_Gen.json" } } } }, + "/info": { + "get": { + "operationId": "GetModelInformation", + "description": "Returns information about the AI model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ModelInformation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "GetModelInformation_MaximumSet_Gen - generated by [MaximumSet] rule": { + "$ref": "./examples/GetModelInformation_MaximumSet_Gen.json" + }, + "GetModelInformation_MaximumSet_Gen - generated by [MinimumSet] rule": { + "$ref": "./examples/GetModelInformation_MinimumSet_Gen.json" + } + } + } + }, "/v1/chat/completions": { "post": { "operationId": "GetChatCompletions", @@ -338,10 +377,10 @@ } }, "x-ms-examples": { - "maximum set chat completion": { + "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "minimum set chat completion": { + "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -450,10 +489,10 @@ } }, "x-ms-examples": { - "maximum set embeddings": { + "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "minimum set embeddings": { + "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } @@ -1339,6 +1378,65 @@ "data" ] }, + "ModelInformation": { + "type": "object", + "description": "Represents some basic information about the AI model.", + "properties": { + "model_type": { + "$ref": "#/definitions/ModelType", + "description": "The type of the AI model." + }, + "model_provider": { + "type": "string", + "description": "The model provider." + }, + "model_name": { + "type": "string", + "description": "The name of the AI model." + } + }, + "required": [ + "model_type", + "model_provider", + "model_name" + ] + }, + "ModelType": { + "type": "string", + "description": "The type of AI model", + "enum": [ + "embeddings", + "custom", + "chat", + "image_generation" + ], + "x-ms-enum": { + "name": "ModelType", + "modelAsString": true, + "values": [ + { + "name": "embeddings", + "value": "embeddings", + "description": "Embeddings." + }, + { + "name": "custom", + "value": "custom", + "description": "Custom model." + }, + { + "name": "chat", + "value": "chat", + "description": "Chat completions" + }, + { + "name": "image_generation", + "value": "image_generation", + "description": "Image generation" + } + ] + } + }, "Versions": { "type": "string", "description": "The ModelClient service versions.", From a0228f4cd8e7797b889ee15f20ad341a5e9759ac Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 8 Apr 2024 08:29:06 -0700 Subject: [PATCH 048/343] Update to Record --- specification/ai/ModelClient/models/common.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index adb2e88988df..7f568f9b2b3c 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -56,5 +56,5 @@ alias ExtraRequestParameters = { How the service handles these extra parameters depends on the value of the `extra-parameters` HTTP request header. """) - extras?: Record; + extras?: Record; }; From 2186f31ebe22c5b278396d76924452cdac6f3da1 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 8 Apr 2024 10:56:20 -0700 Subject: [PATCH 049/343] Try to define HTTP request header to deal with extra parameters as a client constructor argument instead of operator argument --- .../GetChatCompletions_MaximumSet_Gen.json | 31 ++-- .../GetChatCompletions_MinimumSet_Gen.json | 20 +-- .../GetEmbeddings_MaximumSet_Gen.json | 27 ++- .../GetEmbeddings_MinimumSet_Gen.json | 22 +-- .../GetImageGenerations_MaximumSet_Gen.json | 23 ++- .../GetImageGenerations_MinimumSet_Gen.json | 12 +- .../GetModelInformation_MaximumSet_Gen.json | 6 +- .../GetModelInformation_MinimumSet_Gen.json | 6 +- specification/ai/ModelClient/main.tsp | 12 ++ .../ai/ModelClient/models/common.tsp | 6 +- .../ai/ModelClient/models/model_info.tsp | 3 + .../GetChatCompletions_MaximumSet_Gen.json | 31 ++-- .../GetChatCompletions_MinimumSet_Gen.json | 20 +-- .../GetEmbeddings_MaximumSet_Gen.json | 27 ++- .../GetEmbeddings_MinimumSet_Gen.json | 22 +-- .../GetImageGenerations_MaximumSet_Gen.json | 23 ++- .../GetImageGenerations_MinimumSet_Gen.json | 12 +- .../GetModelInformation_MaximumSet_Gen.json | 6 +- .../GetModelInformation_MinimumSet_Gen.json | 6 +- .../preview/2024-04-01-preview/openapi.json | 170 +++++++----------- 20 files changed, 220 insertions(+), 265 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index bce63eb7c86d..8c051e3ecf1c 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -1,13 +1,12 @@ { - "title": "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "azimtdabpjdflaypzbgytmkwoqqb", + "azureml-model-deployment": "bvsezcowubjngusknyib", "body": { "extras": { - "key3925": "lymrbnvmm" + "key2228": "tkqdnjypjmxfsquraxizilysq" }, "messages": [ { @@ -23,7 +22,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "ml" + "qsihlwl" ], "stream": true, "tools": [ @@ -31,33 +30,33 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 19 + "seed": 9 } }, "responses": { "200": { "body": { - "id": "cayolp", - "object": "bkazrtmqqd", - "created": 15, - "model": "ilrofrphi", + "id": "hqyheznbmuxwawu", + "object": "lmbgumzseoymleqwimdvzvwactpzv", + "created": 8, + "model": "qzfbxwepwzhuxchehssngb", "usage": { "capacity_type": "usage", - "completion_tokens": 4, - "prompt_tokens": 28, - "total_tokens": 27 + "completion_tokens": 14, + "prompt_tokens": 1, + "total_tokens": 7 }, "choices": [ { - "index": 11, + "index": 24, "finish_reason": "stop", "message": { "role": "system", - "content": "h", + "content": "jdmyrhruiqynrborpgjbkcim", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "vkvngkngdkwhzninlisebxx" + "id": "ipbmzovcarmhotczhtakzkrxgvpcr" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 66263180d5e0..3de24421911c 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "cayolp", - "object": "bkazrtmqqd", - "created": 15, - "model": "ilrofrphi", + "id": "hqyheznbmuxwawu", + "object": "lmbgumzseoymleqwimdvzvwactpzv", + "created": 8, + "model": "qzfbxwepwzhuxchehssngb", "usage": { "capacity_type": "usage", - "completion_tokens": 4, - "prompt_tokens": 28, - "total_tokens": 27 + "completion_tokens": 14, + "prompt_tokens": 1, + "total_tokens": 7 }, "choices": [ { - "index": 11, + "index": 24, "finish_reason": "stop", "message": { "role": "system", - "content": "h" + "content": "jdmyrhruiqynrborpgjbkcim" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 670dc556bfe4..eb383f21f525 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -1,16 +1,15 @@ { - "title": "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set embeddings", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "fcruwuln", + "azureml-model-deployment": "ijrpix", "body": { "extras": { - "key1695": "moqwfsditimjjgbi" + "key9576": "ajjlesarwpmihluolaoryamqzk" }, "input": [ - "icxscvychtbwuijbitoktieoa" + "pdtzermq" ], "input_type": "text" } @@ -18,24 +17,24 @@ "responses": { "200": { "body": { - "id": "bugdoymlinklzttjiwbapbt", + "id": "zajttbytyztuezzsslffdudbzjeliy", "data": [ { "embedding": [ - 6 + 21 ], - "index": 23, - "object": "scbznjgln" + "index": 12, + "object": "lwdhyaqdtoa" } ], "usage": { "capacity_type": "usage", - "input_tokens": 19, - "prompt_tokens": 25, - "total_tokens": 7 + "input_tokens": 2, + "prompt_tokens": 10, + "total_tokens": 12 }, - "object": "d", - "model": "bvjkc" + "object": "zqealwvitcfttjgzugqpvmsqhd", + "model": "irejnneucalzrrtikbnsabscvdvms" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 13402051ed63..39b2e42dfba5 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -1,35 +1,35 @@ { - "title": "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set embeddings", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", "body": { "input": [ - "hjopbwybqrmcgtorpb" + "vmlsrvlkvzlitdbnifbvsomlhodjo" ] } }, "responses": { "200": { "body": { - "id": "bugdoymlinklzttjiwbapbt", + "id": "zajttbytyztuezzsslffdudbzjeliy", "data": [ { "embedding": [ - 6 + 21 ], - "index": 23, - "object": "scbznjgln" + "index": 12, + "object": "lwdhyaqdtoa" } ], "usage": { "capacity_type": "usage", - "input_tokens": 19, - "prompt_tokens": 25, - "total_tokens": 7 + "input_tokens": 2, + "prompt_tokens": 10, + "total_tokens": 12 }, - "object": "d", - "model": "bvjkc" + "object": "zqealwvitcfttjgzugqpvmsqhd", + "model": "irejnneucalzrrtikbnsabscvdvms" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json index 45c32a2547d4..ade658b2c43d 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -1,31 +1,30 @@ { - "title": "GetImageGenerations_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set image generation", "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "rycvycz", + "azureml-model-deployment": "pfsaudkhqmtqwhzxuaxbpbk", "body": { "extras": { - "key3837": "pjqpyrlnndtwpidn" + "key2287": "abjvumamrhnftlmmfiewmcpqep" }, - "prompt": "tqborqvwtmvebb", - "size": "hnbllq", + "prompt": "dzozjnvmqbwbqtecyg", + "size": "aixteeovqwxubpeetzezy", "quality": "standard", "response_format": "url", - "seed": 21 + "seed": 13 } }, "responses": { "200": { "body": { - "id": "irmxxwflyjxylijuongqc", - "created": 18, - "model": "dtjznkhucamp", + "id": "ghvxomcpjdraphlusvktejwrfxcfmi", + "created": 29, + "model": "seozcbdj", "data": [ { - "url": "https://microsoft.com/ayeb", - "b64_json": "bhqafrsrtgvlvmwhbxrp" + "url": "https://microsoft.com/a", + "b64_json": "weivyzmgsujjrpbukvtj" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json index eb61f841e536..fccdef2ca6a8 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -1,19 +1,19 @@ { - "title": "GetImageGenerations_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set image generation", "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "ahatelmwtxzcbamvbqsz", - "size": "viyaps" + "prompt": "zav", + "size": "ojsrmildubrchpnyqwxkqvvzmnx" } }, "responses": { "200": { "body": { - "id": "irmxxwflyjxylijuongqc", - "created": 18, - "model": "dtjznkhucamp", + "id": "ghvxomcpjdraphlusvktejwrfxcfmi", + "created": 29, + "model": "seozcbdj", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json index 32aa2477e47c..85ddfd5a4911 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetModelInformation_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set model information", "operationId": "GetModelInformation", "parameters": { "api-version": "2024-04-01-preview" @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "frysrdaa", - "model_name": "jjrcmatptdlqqdg" + "model_provider": "cjhrqypowpu", + "model_name": "bbfpstlifmufujjqleiovodgfseae" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json index bbd0bd30729d..a277c3357caa 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetModelInformation_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set model information", "operationId": "GetModelInformation", "parameters": { "api-version": "2024-04-01-preview" @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "frysrdaa", - "model_name": "jjrcmatptdlqqdg" + "model_provider": "cjhrqypowpu", + "model_name": "bbfpstlifmufujjqleiovodgfseae" } } } diff --git a/specification/ai/ModelClient/main.tsp b/specification/ai/ModelClient/main.tsp index cec7bc48489f..2596cb56178c 100644 --- a/specification/ai/ModelClient/main.tsp +++ b/specification/ai/ModelClient/main.tsp @@ -13,6 +13,18 @@ using Azure.Core; @service({ title: "AI Model Inference", }) +@server( + "{endpoint}", + "An AI endpoint that does chat completions, embeddings or image-generation", + { + @doc("The Document Intelligence service endpoint.") + endpoint: string, + + @doc("Controls what happens if extra parameters are passed in the request payload.") + @header("extra-parameters") + extra_parameters?: ExtraParameters, + } +) @versioned(ModelClient.Versions) namespace ModelClient; diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 7f568f9b2b3c..7a9701942c16 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -21,10 +21,6 @@ union ExtraParameters { } alias AdditionalRequestHeaders = { - @doc("Controls what happens if extra parameters are passed in the request payload.") - @header("extra-parameters") - extra_parameters?: ExtraParameters; - @doc(""" Name of the deployment to which you would like to route the request. Relevant only to Model-as-a-Platform (MaaP) deployments. Typically used when you want to target a test environment instead of production environment. @@ -56,5 +52,5 @@ alias ExtraRequestParameters = { How the service handles these extra parameters depends on the value of the `extra-parameters` HTTP request header. """) - extras?: Record; + extras?: Record; }; diff --git a/specification/ai/ModelClient/models/model_info.tsp b/specification/ai/ModelClient/models/model_info.tsp index 7184cc4c1f07..72362715e499 100644 --- a/specification/ai/ModelClient/models/model_info.tsp +++ b/specification/ai/ModelClient/models/model_info.tsp @@ -31,6 +31,9 @@ union ModelType { @doc("Chat completions") chat: "chat", + @doc("Text generation") + text_generation: "text_generation", + @doc("Image generation") image_generation: "image_generation", } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index bce63eb7c86d..8c051e3ecf1c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -1,13 +1,12 @@ { - "title": "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "azimtdabpjdflaypzbgytmkwoqqb", + "azureml-model-deployment": "bvsezcowubjngusknyib", "body": { "extras": { - "key3925": "lymrbnvmm" + "key2228": "tkqdnjypjmxfsquraxizilysq" }, "messages": [ { @@ -23,7 +22,7 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "ml" + "qsihlwl" ], "stream": true, "tools": [ @@ -31,33 +30,33 @@ "type": "ChatCompletionsToolDefinition" } ], - "seed": 19 + "seed": 9 } }, "responses": { "200": { "body": { - "id": "cayolp", - "object": "bkazrtmqqd", - "created": 15, - "model": "ilrofrphi", + "id": "hqyheznbmuxwawu", + "object": "lmbgumzseoymleqwimdvzvwactpzv", + "created": 8, + "model": "qzfbxwepwzhuxchehssngb", "usage": { "capacity_type": "usage", - "completion_tokens": 4, - "prompt_tokens": 28, - "total_tokens": 27 + "completion_tokens": 14, + "prompt_tokens": 1, + "total_tokens": 7 }, "choices": [ { - "index": 11, + "index": 24, "finish_reason": "stop", "message": { "role": "system", - "content": "h", + "content": "jdmyrhruiqynrborpgjbkcim", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "vkvngkngdkwhzninlisebxx" + "id": "ipbmzovcarmhotczhtakzkrxgvpcr" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 66263180d5e0..3de24421911c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "cayolp", - "object": "bkazrtmqqd", - "created": 15, - "model": "ilrofrphi", + "id": "hqyheznbmuxwawu", + "object": "lmbgumzseoymleqwimdvzvwactpzv", + "created": 8, + "model": "qzfbxwepwzhuxchehssngb", "usage": { "capacity_type": "usage", - "completion_tokens": 4, - "prompt_tokens": 28, - "total_tokens": 27 + "completion_tokens": 14, + "prompt_tokens": 1, + "total_tokens": 7 }, "choices": [ { - "index": 11, + "index": 24, "finish_reason": "stop", "message": { "role": "system", - "content": "h" + "content": "jdmyrhruiqynrborpgjbkcim" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 670dc556bfe4..eb383f21f525 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -1,16 +1,15 @@ { - "title": "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set embeddings", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "fcruwuln", + "azureml-model-deployment": "ijrpix", "body": { "extras": { - "key1695": "moqwfsditimjjgbi" + "key9576": "ajjlesarwpmihluolaoryamqzk" }, "input": [ - "icxscvychtbwuijbitoktieoa" + "pdtzermq" ], "input_type": "text" } @@ -18,24 +17,24 @@ "responses": { "200": { "body": { - "id": "bugdoymlinklzttjiwbapbt", + "id": "zajttbytyztuezzsslffdudbzjeliy", "data": [ { "embedding": [ - 6 + 21 ], - "index": 23, - "object": "scbznjgln" + "index": 12, + "object": "lwdhyaqdtoa" } ], "usage": { "capacity_type": "usage", - "input_tokens": 19, - "prompt_tokens": 25, - "total_tokens": 7 + "input_tokens": 2, + "prompt_tokens": 10, + "total_tokens": 12 }, - "object": "d", - "model": "bvjkc" + "object": "zqealwvitcfttjgzugqpvmsqhd", + "model": "irejnneucalzrrtikbnsabscvdvms" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 13402051ed63..39b2e42dfba5 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -1,35 +1,35 @@ { - "title": "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set embeddings", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", "body": { "input": [ - "hjopbwybqrmcgtorpb" + "vmlsrvlkvzlitdbnifbvsomlhodjo" ] } }, "responses": { "200": { "body": { - "id": "bugdoymlinklzttjiwbapbt", + "id": "zajttbytyztuezzsslffdudbzjeliy", "data": [ { "embedding": [ - 6 + 21 ], - "index": 23, - "object": "scbznjgln" + "index": 12, + "object": "lwdhyaqdtoa" } ], "usage": { "capacity_type": "usage", - "input_tokens": 19, - "prompt_tokens": 25, - "total_tokens": 7 + "input_tokens": 2, + "prompt_tokens": 10, + "total_tokens": 12 }, - "object": "d", - "model": "bvjkc" + "object": "zqealwvitcfttjgzugqpvmsqhd", + "model": "irejnneucalzrrtikbnsabscvdvms" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json index 45c32a2547d4..ade658b2c43d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -1,31 +1,30 @@ { - "title": "GetImageGenerations_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set image generation", "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", - "extra-parameters": "error", - "azureml-model-deployment": "rycvycz", + "azureml-model-deployment": "pfsaudkhqmtqwhzxuaxbpbk", "body": { "extras": { - "key3837": "pjqpyrlnndtwpidn" + "key2287": "abjvumamrhnftlmmfiewmcpqep" }, - "prompt": "tqborqvwtmvebb", - "size": "hnbllq", + "prompt": "dzozjnvmqbwbqtecyg", + "size": "aixteeovqwxubpeetzezy", "quality": "standard", "response_format": "url", - "seed": 21 + "seed": 13 } }, "responses": { "200": { "body": { - "id": "irmxxwflyjxylijuongqc", - "created": 18, - "model": "dtjznkhucamp", + "id": "ghvxomcpjdraphlusvktejwrfxcfmi", + "created": 29, + "model": "seozcbdj", "data": [ { - "url": "https://microsoft.com/ayeb", - "b64_json": "bhqafrsrtgvlvmwhbxrp" + "url": "https://microsoft.com/a", + "b64_json": "weivyzmgsujjrpbukvtj" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json index eb61f841e536..fccdef2ca6a8 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -1,19 +1,19 @@ { - "title": "GetImageGenerations_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set image generation", "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "ahatelmwtxzcbamvbqsz", - "size": "viyaps" + "prompt": "zav", + "size": "ojsrmildubrchpnyqwxkqvvzmnx" } }, "responses": { "200": { "body": { - "id": "irmxxwflyjxylijuongqc", - "created": 18, - "model": "dtjznkhucamp", + "id": "ghvxomcpjdraphlusvktejwrfxcfmi", + "created": 29, + "model": "seozcbdj", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json index 32aa2477e47c..85ddfd5a4911 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetModelInformation_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set model information", "operationId": "GetModelInformation", "parameters": { "api-version": "2024-04-01-preview" @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "frysrdaa", - "model_name": "jjrcmatptdlqqdg" + "model_provider": "cjhrqypowpu", + "model_name": "bbfpstlifmufujjqleiovodgfseae" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json index bbd0bd30729d..a277c3357caa 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetModelInformation_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set model information", "operationId": "GetModelInformation", "parameters": { "api-version": "2024-04-01-preview" @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "frysrdaa", - "model_name": "jjrcmatptdlqqdg" + "model_provider": "cjhrqypowpu", + "model_name": "bbfpstlifmufujjqleiovodgfseae" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index f7a48104a2b1..11873e51f023 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -12,6 +12,52 @@ "schemes": [ "https" ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "The Document Intelligence service endpoint.", + "required": true, + "type": "string" + }, + { + "name": "extra_parameters", + "in": "path", + "description": "Controls what happens if extra parameters are passed in the request payload.", + "required": false, + "type": "string", + "enum": [ + "error", + "ignore", + "allow" + ], + "x-ms-enum": { + "name": "ExtraParameters", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "error", + "description": "The service should error when it sees extra parameters in the request payload. This is the default behavior if the service." + }, + { + "name": "ignore", + "value": "ignore", + "description": "The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model." + }, + { + "name": "allow", + "value": "allow", + "description": "The service should pass extra parameters to the back-end AI model." + } + ] + } + } + ] + }, "produces": [ "application/json" ], @@ -28,40 +74,6 @@ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, - { - "name": "extra-parameters", - "in": "header", - "description": "Controls what happens if extra parameters are passed in the request payload.", - "required": false, - "type": "string", - "enum": [ - "error", - "ignore", - "allow" - ], - "x-ms-enum": { - "name": "ExtraParameters", - "modelAsString": true, - "values": [ - { - "name": "error", - "value": "error", - "description": "The service should error when it sees extra parameters in the request payload. This is the default behavior if the service." - }, - { - "name": "ignore", - "value": "ignore", - "description": "The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model." - }, - { - "name": "allow", - "value": "allow", - "description": "The service should pass extra parameters to the back-end AI model." - } - ] - }, - "x-ms-client-name": "extra_parameters" - }, { "name": "azureml-model-deployment", "in": "header", @@ -155,10 +167,10 @@ } }, "x-ms-examples": { - "GetImageGenerations_MaximumSet_Gen - generated by [MaximumSet] rule": { + "maximum set image generation": { "$ref": "./examples/GetImageGenerations_MaximumSet_Gen.json" }, - "GetImageGenerations_MaximumSet_Gen - generated by [MinimumSet] rule": { + "minimum set image generation": { "$ref": "./examples/GetImageGenerations_MinimumSet_Gen.json" } } @@ -194,10 +206,10 @@ } }, "x-ms-examples": { - "GetModelInformation_MaximumSet_Gen - generated by [MaximumSet] rule": { + "maximum set model information": { "$ref": "./examples/GetModelInformation_MaximumSet_Gen.json" }, - "GetModelInformation_MaximumSet_Gen - generated by [MinimumSet] rule": { + "minimum set model information": { "$ref": "./examples/GetModelInformation_MinimumSet_Gen.json" } } @@ -211,40 +223,6 @@ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, - { - "name": "extra-parameters", - "in": "header", - "description": "Controls what happens if extra parameters are passed in the request payload.", - "required": false, - "type": "string", - "enum": [ - "error", - "ignore", - "allow" - ], - "x-ms-enum": { - "name": "ExtraParameters", - "modelAsString": true, - "values": [ - { - "name": "error", - "value": "error", - "description": "The service should error when it sees extra parameters in the request payload. This is the default behavior if the service." - }, - { - "name": "ignore", - "value": "ignore", - "description": "The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model." - }, - { - "name": "allow", - "value": "allow", - "description": "The service should pass extra parameters to the back-end AI model." - } - ] - }, - "x-ms-client-name": "extra_parameters" - }, { "name": "azureml-model-deployment", "in": "header", @@ -377,10 +355,10 @@ } }, "x-ms-examples": { - "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule": { + "maximum set chat completion": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule": { + "minimum set chat completion": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -394,40 +372,6 @@ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, - { - "name": "extra-parameters", - "in": "header", - "description": "Controls what happens if extra parameters are passed in the request payload.", - "required": false, - "type": "string", - "enum": [ - "error", - "ignore", - "allow" - ], - "x-ms-enum": { - "name": "ExtraParameters", - "modelAsString": true, - "values": [ - { - "name": "error", - "value": "error", - "description": "The service should error when it sees extra parameters in the request payload. This is the default behavior if the service." - }, - { - "name": "ignore", - "value": "ignore", - "description": "The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model." - }, - { - "name": "allow", - "value": "allow", - "description": "The service should pass extra parameters to the back-end AI model." - } - ] - }, - "x-ms-client-name": "extra_parameters" - }, { "name": "azureml-model-deployment", "in": "header", @@ -489,10 +433,10 @@ } }, "x-ms-examples": { - "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule": { + "maximum set embeddings": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule": { + "minimum set embeddings": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } @@ -1408,6 +1352,7 @@ "embeddings", "custom", "chat", + "text_generation", "image_generation" ], "x-ms-enum": { @@ -1429,6 +1374,11 @@ "value": "chat", "description": "Chat completions" }, + { + "name": "text_generation", + "value": "text_generation", + "description": "Text generation" + }, { "name": "image_generation", "value": "image_generation", From b3d686fc38bec4615cc1230e144e55b14d57caa3 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 8 Apr 2024 11:14:34 -0700 Subject: [PATCH 050/343] Fix service title --- specification/ai/ModelClient/main.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/main.tsp b/specification/ai/ModelClient/main.tsp index 2596cb56178c..a6e37e6720b9 100644 --- a/specification/ai/ModelClient/main.tsp +++ b/specification/ai/ModelClient/main.tsp @@ -17,7 +17,7 @@ using Azure.Core; "{endpoint}", "An AI endpoint that does chat completions, embeddings or image-generation", { - @doc("The Document Intelligence service endpoint.") + @doc("The AI model service endpoint.") endpoint: string, @doc("Controls what happens if extra parameters are passed in the request payload.") From c02f3db37446a0fd701fa1327bfd100c752f4fde Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 9 Apr 2024 21:58:46 -0700 Subject: [PATCH 051/343] Remove 'stream' from chat completion options --- .../GetChatCompletions_MaximumSet_Gen.json | 31 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 24 +++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++++------ .../GetImageGenerations_MaximumSet_Gen.json | 16 +++++----- .../GetImageGenerations_MinimumSet_Gen.json | 8 ++--- .../GetModelInformation_MaximumSet_Gen.json | 4 +-- .../GetModelInformation_MinimumSet_Gen.json | 4 +-- .../ModelClient/models/chat_completions.tsp | 5 --- .../GetChatCompletions_MaximumSet_Gen.json | 31 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 24 +++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++++------ .../GetImageGenerations_MaximumSet_Gen.json | 16 +++++----- .../GetImageGenerations_MinimumSet_Gen.json | 8 ++--- .../GetModelInformation_MaximumSet_Gen.json | 4 +-- .../GetModelInformation_MinimumSet_Gen.json | 4 +-- .../preview/2024-04-01-preview/openapi.json | 7 +---- 18 files changed, 125 insertions(+), 137 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 8c051e3ecf1c..b5818ffba200 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,17 +3,17 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "bvsezcowubjngusknyib", + "azureml-model-deployment": "xdcuvm", "body": { "extras": { - "key2228": "tkqdnjypjmxfsquraxizilysq" + "key8044": "jwvwp" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": -2, "presence_penalty": 1, "temperature": 0, "top_p": 0, @@ -22,41 +22,40 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "qsihlwl" + "mfchofxicdwayopm" ], - "stream": true, "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 9 + "seed": 1 } }, "responses": { "200": { "body": { - "id": "hqyheznbmuxwawu", - "object": "lmbgumzseoymleqwimdvzvwactpzv", - "created": 8, - "model": "qzfbxwepwzhuxchehssngb", + "id": "tqfaprssitqequawdfniy", + "object": "jomwqfcoe", + "created": 27, + "model": "iv", "usage": { "capacity_type": "usage", - "completion_tokens": 14, - "prompt_tokens": 1, - "total_tokens": 7 + "completion_tokens": 29, + "prompt_tokens": 8, + "total_tokens": 2 }, "choices": [ { - "index": 24, + "index": 4, "finish_reason": "stop", "message": { "role": "system", - "content": "jdmyrhruiqynrborpgjbkcim", + "content": "durmwp", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "ipbmzovcarmhotczhtakzkrxgvpcr" + "id": "qubdbjztonbgsvxjyjie" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 3de24421911c..26a2ebcdd8fd 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "hqyheznbmuxwawu", - "object": "lmbgumzseoymleqwimdvzvwactpzv", - "created": 8, - "model": "qzfbxwepwzhuxchehssngb", + "id": "tqfaprssitqequawdfniy", + "object": "jomwqfcoe", + "created": 27, + "model": "iv", "usage": { "capacity_type": "usage", - "completion_tokens": 14, - "prompt_tokens": 1, - "total_tokens": 7 + "completion_tokens": 29, + "prompt_tokens": 8, + "total_tokens": 2 }, "choices": [ { - "index": 24, + "index": 4, "finish_reason": "stop", "message": { "role": "system", - "content": "jdmyrhruiqynrborpgjbkcim" + "content": "durmwp" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index eb383f21f525..5b89ef8c84c6 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "ijrpix", + "azureml-model-deployment": "twhpzepkvqokqlqsjnvusucwd", "body": { "extras": { - "key9576": "ajjlesarwpmihluolaoryamqzk" + "key5076": "uitznbkdrbtkrusg" }, "input": [ - "pdtzermq" + "xovbrzfh" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "zajttbytyztuezzsslffdudbzjeliy", + "id": "ttwxucrdzaxzhihfvychvwa", "data": [ { "embedding": [ - 21 + 22 ], - "index": 12, - "object": "lwdhyaqdtoa" + "index": 16, + "object": "rkizkkmhy" } ], "usage": { "capacity_type": "usage", - "input_tokens": 2, - "prompt_tokens": 10, - "total_tokens": 12 + "input_tokens": 8, + "prompt_tokens": 9, + "total_tokens": 6 }, - "object": "zqealwvitcfttjgzugqpvmsqhd", - "model": "irejnneucalzrrtikbnsabscvdvms" + "object": "atintmxdvjceloboib", + "model": "gthzj" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 39b2e42dfba5..3cc747a60cbd 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "vmlsrvlkvzlitdbnifbvsomlhodjo" + "rndmhsxvp" ] } }, "responses": { "200": { "body": { - "id": "zajttbytyztuezzsslffdudbzjeliy", + "id": "ttwxucrdzaxzhihfvychvwa", "data": [ { "embedding": [ - 21 + 22 ], - "index": 12, - "object": "lwdhyaqdtoa" + "index": 16, + "object": "rkizkkmhy" } ], "usage": { "capacity_type": "usage", - "input_tokens": 2, - "prompt_tokens": 10, - "total_tokens": 12 + "input_tokens": 8, + "prompt_tokens": 9, + "total_tokens": 6 }, - "object": "zqealwvitcfttjgzugqpvmsqhd", - "model": "irejnneucalzrrtikbnsabscvdvms" + "object": "atintmxdvjceloboib", + "model": "gthzj" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json index ade658b2c43d..8d92153768fb 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "pfsaudkhqmtqwhzxuaxbpbk", + "azureml-model-deployment": "ekhhlbr", "body": { "extras": { - "key2287": "abjvumamrhnftlmmfiewmcpqep" + "key3687": "ptvrrzntdngxuch" }, - "prompt": "dzozjnvmqbwbqtecyg", - "size": "aixteeovqwxubpeetzezy", + "prompt": "fgdfetfkhdayfarouklcbmpwxztjn", + "size": "kugstw", "quality": "standard", "response_format": "url", - "seed": 13 + "seed": 28 } }, "responses": { "200": { "body": { - "id": "ghvxomcpjdraphlusvktejwrfxcfmi", + "id": "bvwuzp", "created": 29, - "model": "seozcbdj", + "model": "ayk", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "weivyzmgsujjrpbukvtj" + "b64_json": "ivvbzyylygvvciwzg" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json index fccdef2ca6a8..800053e0a123 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "zav", - "size": "ojsrmildubrchpnyqwxkqvvzmnx" + "prompt": "luntgmmwbotsxfrfhhnj", + "size": "wcsbmiwodzmdrunxj" } }, "responses": { "200": { "body": { - "id": "ghvxomcpjdraphlusvktejwrfxcfmi", + "id": "bvwuzp", "created": 29, - "model": "seozcbdj", + "model": "ayk", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json index 85ddfd5a4911..47edda41547b 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "cjhrqypowpu", - "model_name": "bbfpstlifmufujjqleiovodgfseae" + "model_provider": "rlwgwqzp", + "model_name": "wwp" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json index a277c3357caa..a932f27d3296 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "cjhrqypowpu", - "model_name": "bbfpstlifmufujjqleiovodgfseae" + "model_provider": "rlwgwqzp", + "model_name": "wwp" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 3a3e8e65e8ed..8eda1d2770a9 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -74,11 +74,6 @@ alias ChatCompletionsOptions = { @minItems(1) stop?: string[]; - @doc(""" - A value indicating whether chat completions should be streamed for this request. - """) - stream?: boolean = false; - @doc("The available tool definitions that the chat completions request can use, including caller-defined functions.") @minItems(1) tools?: ChatCompletionsToolDefinition[]; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 8c051e3ecf1c..b5818ffba200 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,17 +3,17 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "bvsezcowubjngusknyib", + "azureml-model-deployment": "xdcuvm", "body": { "extras": { - "key2228": "tkqdnjypjmxfsquraxizilysq" + "key8044": "jwvwp" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": -2, "presence_penalty": 1, "temperature": 0, "top_p": 0, @@ -22,41 +22,40 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "qsihlwl" + "mfchofxicdwayopm" ], - "stream": true, "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 9 + "seed": 1 } }, "responses": { "200": { "body": { - "id": "hqyheznbmuxwawu", - "object": "lmbgumzseoymleqwimdvzvwactpzv", - "created": 8, - "model": "qzfbxwepwzhuxchehssngb", + "id": "tqfaprssitqequawdfniy", + "object": "jomwqfcoe", + "created": 27, + "model": "iv", "usage": { "capacity_type": "usage", - "completion_tokens": 14, - "prompt_tokens": 1, - "total_tokens": 7 + "completion_tokens": 29, + "prompt_tokens": 8, + "total_tokens": 2 }, "choices": [ { - "index": 24, + "index": 4, "finish_reason": "stop", "message": { "role": "system", - "content": "jdmyrhruiqynrborpgjbkcim", + "content": "durmwp", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "ipbmzovcarmhotczhtakzkrxgvpcr" + "id": "qubdbjztonbgsvxjyjie" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 3de24421911c..26a2ebcdd8fd 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "hqyheznbmuxwawu", - "object": "lmbgumzseoymleqwimdvzvwactpzv", - "created": 8, - "model": "qzfbxwepwzhuxchehssngb", + "id": "tqfaprssitqequawdfniy", + "object": "jomwqfcoe", + "created": 27, + "model": "iv", "usage": { "capacity_type": "usage", - "completion_tokens": 14, - "prompt_tokens": 1, - "total_tokens": 7 + "completion_tokens": 29, + "prompt_tokens": 8, + "total_tokens": 2 }, "choices": [ { - "index": 24, + "index": 4, "finish_reason": "stop", "message": { "role": "system", - "content": "jdmyrhruiqynrborpgjbkcim" + "content": "durmwp" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index eb383f21f525..5b89ef8c84c6 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "ijrpix", + "azureml-model-deployment": "twhpzepkvqokqlqsjnvusucwd", "body": { "extras": { - "key9576": "ajjlesarwpmihluolaoryamqzk" + "key5076": "uitznbkdrbtkrusg" }, "input": [ - "pdtzermq" + "xovbrzfh" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "zajttbytyztuezzsslffdudbzjeliy", + "id": "ttwxucrdzaxzhihfvychvwa", "data": [ { "embedding": [ - 21 + 22 ], - "index": 12, - "object": "lwdhyaqdtoa" + "index": 16, + "object": "rkizkkmhy" } ], "usage": { "capacity_type": "usage", - "input_tokens": 2, - "prompt_tokens": 10, - "total_tokens": 12 + "input_tokens": 8, + "prompt_tokens": 9, + "total_tokens": 6 }, - "object": "zqealwvitcfttjgzugqpvmsqhd", - "model": "irejnneucalzrrtikbnsabscvdvms" + "object": "atintmxdvjceloboib", + "model": "gthzj" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 39b2e42dfba5..3cc747a60cbd 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "vmlsrvlkvzlitdbnifbvsomlhodjo" + "rndmhsxvp" ] } }, "responses": { "200": { "body": { - "id": "zajttbytyztuezzsslffdudbzjeliy", + "id": "ttwxucrdzaxzhihfvychvwa", "data": [ { "embedding": [ - 21 + 22 ], - "index": 12, - "object": "lwdhyaqdtoa" + "index": 16, + "object": "rkizkkmhy" } ], "usage": { "capacity_type": "usage", - "input_tokens": 2, - "prompt_tokens": 10, - "total_tokens": 12 + "input_tokens": 8, + "prompt_tokens": 9, + "total_tokens": 6 }, - "object": "zqealwvitcfttjgzugqpvmsqhd", - "model": "irejnneucalzrrtikbnsabscvdvms" + "object": "atintmxdvjceloboib", + "model": "gthzj" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json index ade658b2c43d..8d92153768fb 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "pfsaudkhqmtqwhzxuaxbpbk", + "azureml-model-deployment": "ekhhlbr", "body": { "extras": { - "key2287": "abjvumamrhnftlmmfiewmcpqep" + "key3687": "ptvrrzntdngxuch" }, - "prompt": "dzozjnvmqbwbqtecyg", - "size": "aixteeovqwxubpeetzezy", + "prompt": "fgdfetfkhdayfarouklcbmpwxztjn", + "size": "kugstw", "quality": "standard", "response_format": "url", - "seed": 13 + "seed": 28 } }, "responses": { "200": { "body": { - "id": "ghvxomcpjdraphlusvktejwrfxcfmi", + "id": "bvwuzp", "created": 29, - "model": "seozcbdj", + "model": "ayk", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "weivyzmgsujjrpbukvtj" + "b64_json": "ivvbzyylygvvciwzg" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json index fccdef2ca6a8..800053e0a123 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "zav", - "size": "ojsrmildubrchpnyqwxkqvvzmnx" + "prompt": "luntgmmwbotsxfrfhhnj", + "size": "wcsbmiwodzmdrunxj" } }, "responses": { "200": { "body": { - "id": "ghvxomcpjdraphlusvktejwrfxcfmi", + "id": "bvwuzp", "created": 29, - "model": "seozcbdj", + "model": "ayk", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json index 85ddfd5a4911..47edda41547b 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "cjhrqypowpu", - "model_name": "bbfpstlifmufujjqleiovodgfseae" + "model_provider": "rlwgwqzp", + "model_name": "wwp" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json index a277c3357caa..a932f27d3296 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "cjhrqypowpu", - "model_name": "bbfpstlifmufujjqleiovodgfseae" + "model_provider": "rlwgwqzp", + "model_name": "wwp" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 11873e51f023..8ad767c4148a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -19,7 +19,7 @@ { "name": "endpoint", "in": "path", - "description": "The Document Intelligence service endpoint.", + "description": "The AI model service endpoint.", "required": true, "type": "string" }, @@ -304,11 +304,6 @@ "type": "string" } }, - "stream": { - "type": "boolean", - "description": "A value indicating whether chat completions should be streamed for this request.", - "default": false - }, "tools": { "type": "array", "description": "The available tool definitions that the chat completions request can use, including caller-defined functions.", From 27eb2a5146502d091041fcbfb19aa035725dbda5 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 10 Apr 2024 08:01:36 -0700 Subject: [PATCH 052/343] Disable 'extra_parameters' for now --- specification/ai/ModelClient/main.tsp | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/specification/ai/ModelClient/main.tsp b/specification/ai/ModelClient/main.tsp index a6e37e6720b9..14597e02fa1a 100644 --- a/specification/ai/ModelClient/main.tsp +++ b/specification/ai/ModelClient/main.tsp @@ -13,18 +13,19 @@ using Azure.Core; @service({ title: "AI Model Inference", }) -@server( - "{endpoint}", - "An AI endpoint that does chat completions, embeddings or image-generation", - { - @doc("The AI model service endpoint.") - endpoint: string, - - @doc("Controls what happens if extra parameters are passed in the request payload.") - @header("extra-parameters") - extra_parameters?: ExtraParameters, - } -) +// Is this the right way to do this? This results in an error in the emitted Python code. +// @server( +// "{endpoint}", +// "An AI endpoint that does chat completions, embeddings or image-generation", +// { +// @doc("The AI model service endpoint.") +// endpoint: string, +// +// @doc("Controls what happens if extra parameters are passed in the request payload.") +// @header("extra-parameters") +// extra_parameters?: ExtraParameters, +// } +// ) @versioned(ModelClient.Versions) namespace ModelClient; From 178c216eabb49f96cf6eabbd8e34f3d026757208 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 10 Apr 2024 08:03:43 -0700 Subject: [PATCH 053/343] Refresh examples --- .../GetChatCompletions_MaximumSet_Gen.json | 32 ++++++------- .../GetChatCompletions_MinimumSet_Gen.json | 18 ++++---- .../GetEmbeddings_MaximumSet_Gen.json | 24 +++++----- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++---- .../GetImageGenerations_MaximumSet_Gen.json | 18 ++++---- .../GetImageGenerations_MinimumSet_Gen.json | 10 ++-- .../GetModelInformation_MaximumSet_Gen.json | 4 +- .../GetModelInformation_MinimumSet_Gen.json | 4 +- .../GetChatCompletions_MaximumSet_Gen.json | 32 ++++++------- .../GetChatCompletions_MinimumSet_Gen.json | 18 ++++---- .../GetEmbeddings_MaximumSet_Gen.json | 24 +++++----- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++---- .../GetImageGenerations_MaximumSet_Gen.json | 18 ++++---- .../GetImageGenerations_MinimumSet_Gen.json | 10 ++-- .../GetModelInformation_MaximumSet_Gen.json | 4 +- .../GetModelInformation_MinimumSet_Gen.json | 4 +- .../preview/2024-04-01-preview/openapi.json | 46 ------------------- 17 files changed, 130 insertions(+), 176 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index b5818ffba200..0b235dd802cd 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,18 +3,18 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "xdcuvm", + "azureml-model-deployment": "arjeawalykuwefcg", "body": { "extras": { - "key8044": "jwvwp" + "key5815": "cvhukjkybbunvzj" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, - "presence_penalty": 1, + "frequency_penalty": -1, + "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -22,40 +22,40 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "mfchofxicdwayopm" + "dxrbzgcs" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 1 + "seed": 20 } }, "responses": { "200": { "body": { - "id": "tqfaprssitqequawdfniy", - "object": "jomwqfcoe", - "created": 27, - "model": "iv", + "id": "zxvaywagaxbgovdcidylzyagy", + "object": "gswuglohgrqdzqtezkgofidotdn", + "created": 7, + "model": "ct", "usage": { "capacity_type": "usage", - "completion_tokens": 29, - "prompt_tokens": 8, - "total_tokens": 2 + "completion_tokens": 8, + "prompt_tokens": 25, + "total_tokens": 25 }, "choices": [ { - "index": 4, + "index": 7, "finish_reason": "stop", "message": { "role": "system", - "content": "durmwp", + "content": "kmsqvkwll", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "qubdbjztonbgsvxjyjie" + "id": "ahmjyckhthizppmb" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 26a2ebcdd8fd..c5613db258e9 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "tqfaprssitqequawdfniy", - "object": "jomwqfcoe", - "created": 27, - "model": "iv", + "id": "zxvaywagaxbgovdcidylzyagy", + "object": "gswuglohgrqdzqtezkgofidotdn", + "created": 7, + "model": "ct", "usage": { "capacity_type": "usage", - "completion_tokens": 29, - "prompt_tokens": 8, - "total_tokens": 2 + "completion_tokens": 8, + "prompt_tokens": 25, + "total_tokens": 25 }, "choices": [ { - "index": 4, + "index": 7, "finish_reason": "stop", "message": { "role": "system", - "content": "durmwp" + "content": "kmsqvkwll" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 5b89ef8c84c6..34756ab337ee 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "twhpzepkvqokqlqsjnvusucwd", + "azureml-model-deployment": "yrjgqrtitmgcpfwvinzdzrqsd", "body": { "extras": { - "key5076": "uitznbkdrbtkrusg" + "key5695": "wxrhwosmgecvefo" }, "input": [ - "xovbrzfh" + "vdldkfelrg" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "ttwxucrdzaxzhihfvychvwa", + "id": "xgjpijtcydnuqix", "data": [ { "embedding": [ - 22 + 6 ], - "index": 16, - "object": "rkizkkmhy" + "index": 20, + "object": "jccngbtzssnximgybewzqjpe" } ], "usage": { "capacity_type": "usage", - "input_tokens": 8, - "prompt_tokens": 9, - "total_tokens": 6 + "input_tokens": 11, + "prompt_tokens": 13, + "total_tokens": 4 }, - "object": "atintmxdvjceloboib", - "model": "gthzj" + "object": "joiplxffmfzhxkpwxzteqho", + "model": "mlstapssr" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 3cc747a60cbd..7421b61236e3 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "rndmhsxvp" + "xclsloueu" ] } }, "responses": { "200": { "body": { - "id": "ttwxucrdzaxzhihfvychvwa", + "id": "xgjpijtcydnuqix", "data": [ { "embedding": [ - 22 + 6 ], - "index": 16, - "object": "rkizkkmhy" + "index": 20, + "object": "jccngbtzssnximgybewzqjpe" } ], "usage": { "capacity_type": "usage", - "input_tokens": 8, - "prompt_tokens": 9, - "total_tokens": 6 + "input_tokens": 11, + "prompt_tokens": 13, + "total_tokens": 4 }, - "object": "atintmxdvjceloboib", - "model": "gthzj" + "object": "joiplxffmfzhxkpwxzteqho", + "model": "mlstapssr" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json index 8d92153768fb..3abe3d47d4e8 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "ekhhlbr", + "azureml-model-deployment": "sncngpxinfjmynfuzh", "body": { "extras": { - "key3687": "ptvrrzntdngxuch" + "key4581": "gkzvup" }, - "prompt": "fgdfetfkhdayfarouklcbmpwxztjn", - "size": "kugstw", + "prompt": "pxkthxkra", + "size": "xabphlagaoxdfaaj", "quality": "standard", "response_format": "url", - "seed": 28 + "seed": 25 } }, "responses": { "200": { "body": { - "id": "bvwuzp", - "created": 29, - "model": "ayk", + "id": "tjgzxczrixiiugyccsaby", + "created": 24, + "model": "byrkqow", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "ivvbzyylygvvciwzg" + "b64_json": "v" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json index 800053e0a123..4e4adeb56f12 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "luntgmmwbotsxfrfhhnj", - "size": "wcsbmiwodzmdrunxj" + "prompt": "udhueailreqfsltbskypgogaivzev", + "size": "i" } }, "responses": { "200": { "body": { - "id": "bvwuzp", - "created": 29, - "model": "ayk", + "id": "tjgzxczrixiiugyccsaby", + "created": 24, + "model": "byrkqow", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json index 47edda41547b..3fdd03f02dbb 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "rlwgwqzp", - "model_name": "wwp" + "model_provider": "glfrarmshuxkgslpbieunqyh", + "model_name": "wlcddyfcmgjaz" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json index a932f27d3296..030246d44184 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "rlwgwqzp", - "model_name": "wwp" + "model_provider": "glfrarmshuxkgslpbieunqyh", + "model_name": "wlcddyfcmgjaz" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index b5818ffba200..0b235dd802cd 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,18 +3,18 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "xdcuvm", + "azureml-model-deployment": "arjeawalykuwefcg", "body": { "extras": { - "key8044": "jwvwp" + "key5815": "cvhukjkybbunvzj" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, - "presence_penalty": 1, + "frequency_penalty": -1, + "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -22,40 +22,40 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "mfchofxicdwayopm" + "dxrbzgcs" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 1 + "seed": 20 } }, "responses": { "200": { "body": { - "id": "tqfaprssitqequawdfniy", - "object": "jomwqfcoe", - "created": 27, - "model": "iv", + "id": "zxvaywagaxbgovdcidylzyagy", + "object": "gswuglohgrqdzqtezkgofidotdn", + "created": 7, + "model": "ct", "usage": { "capacity_type": "usage", - "completion_tokens": 29, - "prompt_tokens": 8, - "total_tokens": 2 + "completion_tokens": 8, + "prompt_tokens": 25, + "total_tokens": 25 }, "choices": [ { - "index": 4, + "index": 7, "finish_reason": "stop", "message": { "role": "system", - "content": "durmwp", + "content": "kmsqvkwll", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "qubdbjztonbgsvxjyjie" + "id": "ahmjyckhthizppmb" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 26a2ebcdd8fd..c5613db258e9 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "tqfaprssitqequawdfniy", - "object": "jomwqfcoe", - "created": 27, - "model": "iv", + "id": "zxvaywagaxbgovdcidylzyagy", + "object": "gswuglohgrqdzqtezkgofidotdn", + "created": 7, + "model": "ct", "usage": { "capacity_type": "usage", - "completion_tokens": 29, - "prompt_tokens": 8, - "total_tokens": 2 + "completion_tokens": 8, + "prompt_tokens": 25, + "total_tokens": 25 }, "choices": [ { - "index": 4, + "index": 7, "finish_reason": "stop", "message": { "role": "system", - "content": "durmwp" + "content": "kmsqvkwll" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 5b89ef8c84c6..34756ab337ee 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "twhpzepkvqokqlqsjnvusucwd", + "azureml-model-deployment": "yrjgqrtitmgcpfwvinzdzrqsd", "body": { "extras": { - "key5076": "uitznbkdrbtkrusg" + "key5695": "wxrhwosmgecvefo" }, "input": [ - "xovbrzfh" + "vdldkfelrg" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "ttwxucrdzaxzhihfvychvwa", + "id": "xgjpijtcydnuqix", "data": [ { "embedding": [ - 22 + 6 ], - "index": 16, - "object": "rkizkkmhy" + "index": 20, + "object": "jccngbtzssnximgybewzqjpe" } ], "usage": { "capacity_type": "usage", - "input_tokens": 8, - "prompt_tokens": 9, - "total_tokens": 6 + "input_tokens": 11, + "prompt_tokens": 13, + "total_tokens": 4 }, - "object": "atintmxdvjceloboib", - "model": "gthzj" + "object": "joiplxffmfzhxkpwxzteqho", + "model": "mlstapssr" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 3cc747a60cbd..7421b61236e3 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "rndmhsxvp" + "xclsloueu" ] } }, "responses": { "200": { "body": { - "id": "ttwxucrdzaxzhihfvychvwa", + "id": "xgjpijtcydnuqix", "data": [ { "embedding": [ - 22 + 6 ], - "index": 16, - "object": "rkizkkmhy" + "index": 20, + "object": "jccngbtzssnximgybewzqjpe" } ], "usage": { "capacity_type": "usage", - "input_tokens": 8, - "prompt_tokens": 9, - "total_tokens": 6 + "input_tokens": 11, + "prompt_tokens": 13, + "total_tokens": 4 }, - "object": "atintmxdvjceloboib", - "model": "gthzj" + "object": "joiplxffmfzhxkpwxzteqho", + "model": "mlstapssr" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json index 8d92153768fb..3abe3d47d4e8 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GetImageGenerations", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "ekhhlbr", + "azureml-model-deployment": "sncngpxinfjmynfuzh", "body": { "extras": { - "key3687": "ptvrrzntdngxuch" + "key4581": "gkzvup" }, - "prompt": "fgdfetfkhdayfarouklcbmpwxztjn", - "size": "kugstw", + "prompt": "pxkthxkra", + "size": "xabphlagaoxdfaaj", "quality": "standard", "response_format": "url", - "seed": 28 + "seed": 25 } }, "responses": { "200": { "body": { - "id": "bvwuzp", - "created": 29, - "model": "ayk", + "id": "tjgzxczrixiiugyccsaby", + "created": 24, + "model": "byrkqow", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "ivvbzyylygvvciwzg" + "b64_json": "v" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json index 800053e0a123..4e4adeb56f12 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "luntgmmwbotsxfrfhhnj", - "size": "wcsbmiwodzmdrunxj" + "prompt": "udhueailreqfsltbskypgogaivzev", + "size": "i" } }, "responses": { "200": { "body": { - "id": "bvwuzp", - "created": 29, - "model": "ayk", + "id": "tjgzxczrixiiugyccsaby", + "created": 24, + "model": "byrkqow", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json index 47edda41547b..3fdd03f02dbb 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "rlwgwqzp", - "model_name": "wwp" + "model_provider": "glfrarmshuxkgslpbieunqyh", + "model_name": "wlcddyfcmgjaz" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json index a932f27d3296..030246d44184 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "rlwgwqzp", - "model_name": "wwp" + "model_provider": "glfrarmshuxkgslpbieunqyh", + "model_name": "wlcddyfcmgjaz" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 8ad767c4148a..c30a53192269 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -12,52 +12,6 @@ "schemes": [ "https" ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "description": "The AI model service endpoint.", - "required": true, - "type": "string" - }, - { - "name": "extra_parameters", - "in": "path", - "description": "Controls what happens if extra parameters are passed in the request payload.", - "required": false, - "type": "string", - "enum": [ - "error", - "ignore", - "allow" - ], - "x-ms-enum": { - "name": "ExtraParameters", - "modelAsString": true, - "values": [ - { - "name": "error", - "value": "error", - "description": "The service should error when it sees extra parameters in the request payload. This is the default behavior if the service." - }, - { - "name": "ignore", - "value": "ignore", - "description": "The service should ignore extra parameters in the request payload. They will not be passed to the back-end AI model." - }, - { - "name": "allow", - "value": "allow", - "description": "The service should pass extra parameters to the back-end AI model." - } - ] - } - } - ] - }, "produces": [ "application/json" ], From 72ddb1ab4a60c67859dc60d4675fd14ff5106d7d Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 11 Apr 2024 23:09:45 -0700 Subject: [PATCH 054/343] First set of changes following SDK review --- specification/ai/ModelClient/client.tsp | 10 +- ...son => GenerateImages_MaximumSet_Gen.json} | 20 +- ...son => GenerateImages_MinimumSet_Gen.json} | 12 +- .../GetChatCompletions_MaximumSet_Gen.json | 36 +- .../GetChatCompletions_MinimumSet_Gen.json | 18 +- .../GetEmbeddings_MaximumSet_Gen.json | 24 +- .../GetEmbeddings_MinimumSet_Gen.json | 20 +- .../GetModelInfo_MaximumSet_Gen.json} | 6 +- .../GetModelInfo_MinimumSet_Gen.json} | 6 +- .../ModelClient/models/chat_completions.tsp | 46 ++- specification/ai/ModelClient/routes.tsp | 4 +- ...son => GenerateImages_MaximumSet_Gen.json} | 20 +- ...son => GenerateImages_MinimumSet_Gen.json} | 12 +- .../GetChatCompletions_MaximumSet_Gen.json | 36 +- .../GetChatCompletions_MinimumSet_Gen.json | 18 +- .../GetEmbeddings_MaximumSet_Gen.json | 24 +- .../GetEmbeddings_MinimumSet_Gen.json | 20 +- .../GetModelInfo_MaximumSet_Gen.json} | 6 +- .../GetModelInfo_MinimumSet_Gen.json} | 6 +- .../preview/2024-04-01-preview/openapi.json | 308 +++++++++--------- 20 files changed, 315 insertions(+), 337 deletions(-) rename specification/ai/ModelClient/examples/2024-04-01-preview/{GetImageGenerations_MaximumSet_Gen.json => GenerateImages_MaximumSet_Gen.json} (52%) rename specification/ai/ModelClient/examples/2024-04-01-preview/{GetImageGenerations_MinimumSet_Gen.json => GenerateImages_MinimumSet_Gen.json} (53%) rename specification/ai/{data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json => ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json} (59%) rename specification/ai/{data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json => ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json} (59%) rename specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/{GetImageGenerations_MaximumSet_Gen.json => GenerateImages_MaximumSet_Gen.json} (52%) rename specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/{GetImageGenerations_MinimumSet_Gen.json => GenerateImages_MinimumSet_Gen.json} (53%) rename specification/ai/{ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json => data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json} (59%) rename specification/ai/{ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json => data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json} (59%) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 38b7387b3098..56cd2cfed8c8 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -4,9 +4,9 @@ import "./main.tsp"; using Azure.ClientGenerator.Core; -// The "Delta" models are used by the hand-written operation method that supports streaming. +// The "Update" models are used by the hand-written operation method that supports streaming. // We need to declare their usage and public access, otherwise they won't be emited in the generated code. -@@access(ModelClient.ChatCompletionsDelta, Access.public); -@@usage(ModelClient.ChatCompletionsDelta, Usage.output); -@@access(ModelClient.ChatChoiceDelta, Access.public); -@@usage(ModelClient.ChatChoiceDelta, Usage.output); +@@access(ModelClient.ChatCompletionsUpdate, Access.public); +@@usage(ModelClient.ChatCompletionsUpdate, Usage.output); +@@access(ModelClient.ChatChoiceUpdate, Access.public); +@@usage(ModelClient.ChatChoiceUpdate, Usage.output); diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json similarity index 52% rename from specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json rename to specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json index 3abe3d47d4e8..3834ef979194 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json @@ -1,30 +1,30 @@ { "title": "maximum set image generation", - "operationId": "GetImageGenerations", + "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "sncngpxinfjmynfuzh", + "azureml-model-deployment": "njtnglmdxkmvackygi", "body": { "extras": { - "key4581": "gkzvup" + "key8167": "ynvtwkqhvplksdvgpvdlzrifbhkyxh" }, - "prompt": "pxkthxkra", - "size": "xabphlagaoxdfaaj", + "prompt": "cz", + "size": "hsdiiicbq", "quality": "standard", "response_format": "url", - "seed": 25 + "seed": 15 } }, "responses": { "200": { "body": { - "id": "tjgzxczrixiiugyccsaby", - "created": 24, - "model": "byrkqow", + "id": "uxttljr", + "created": 13, + "model": "begitgujngratbxhkravzlpttvmz", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "v" + "b64_json": "rdipydnucijiqd" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json similarity index 53% rename from specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json rename to specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json index 4e4adeb56f12..10eb5caf4256 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json @@ -1,19 +1,19 @@ { "title": "minimum set image generation", - "operationId": "GetImageGenerations", + "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "udhueailreqfsltbskypgogaivzev", - "size": "i" + "prompt": "imvemauweqfnyj", + "size": "zdwugwbtynqbmlvyncmij" } }, "responses": { "200": { "body": { - "id": "tjgzxczrixiiugyccsaby", - "created": 24, - "model": "byrkqow", + "id": "uxttljr", + "created": 13, + "model": "begitgujngratbxhkravzlpttvmz", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 0b235dd802cd..6e31dbe78237 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,59 +3,57 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "arjeawalykuwefcg", + "azureml-model-deployment": "udwzxzqvnsporlajx", "body": { "extras": { - "key5815": "cvhukjkybbunvzj" + "key9114": "pbx" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, - "presence_penalty": -1, + "frequency_penalty": 0, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, - "response_format": { - "type": "ChatCompletionsResponseFormat" - }, + "response_format": "text", "stop": [ - "dxrbzgcs" + "yrejk" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 20 + "seed": 3 } }, "responses": { "200": { "body": { - "id": "zxvaywagaxbgovdcidylzyagy", - "object": "gswuglohgrqdzqtezkgofidotdn", - "created": 7, - "model": "ct", + "id": "qolgsfuprlsagpnquxez", + "object": "nudszoomjya", + "created": 23, + "model": "q", "usage": { "capacity_type": "usage", - "completion_tokens": 8, - "prompt_tokens": 25, - "total_tokens": 25 + "completion_tokens": 3, + "prompt_tokens": 30, + "total_tokens": 23 }, "choices": [ { - "index": 7, + "index": 22, "finish_reason": "stop", "message": { "role": "system", - "content": "kmsqvkwll", + "content": "mechuq", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "ahmjyckhthizppmb" + "id": "wzpgjqtjdpkwovo" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index c5613db258e9..7a35758e80a9 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "zxvaywagaxbgovdcidylzyagy", - "object": "gswuglohgrqdzqtezkgofidotdn", - "created": 7, - "model": "ct", + "id": "qolgsfuprlsagpnquxez", + "object": "nudszoomjya", + "created": 23, + "model": "q", "usage": { "capacity_type": "usage", - "completion_tokens": 8, - "prompt_tokens": 25, - "total_tokens": 25 + "completion_tokens": 3, + "prompt_tokens": 30, + "total_tokens": 23 }, "choices": [ { - "index": 7, + "index": 22, "finish_reason": "stop", "message": { "role": "system", - "content": "kmsqvkwll" + "content": "mechuq" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 34756ab337ee..9773759ffdc5 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "yrjgqrtitmgcpfwvinzdzrqsd", + "azureml-model-deployment": "awzdgxncarxhkvivafpmhde", "body": { "extras": { - "key5695": "wxrhwosmgecvefo" + "key8446": "ejosmkleisupnx" }, "input": [ - "vdldkfelrg" + "cjnwlxpkteeawbxwqeptix" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "xgjpijtcydnuqix", + "id": "bzwrh", "data": [ { "embedding": [ - 6 + 16 ], - "index": 20, - "object": "jccngbtzssnximgybewzqjpe" + "index": 6, + "object": "waxubsltefsfymbkowprrv" } ], "usage": { "capacity_type": "usage", - "input_tokens": 11, - "prompt_tokens": 13, - "total_tokens": 4 + "input_tokens": 6, + "prompt_tokens": 3, + "total_tokens": 5 }, - "object": "joiplxffmfzhxkpwxzteqho", - "model": "mlstapssr" + "object": "bkyqqqugdugngw", + "model": "mcnikaorrsysltpjjv" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 7421b61236e3..051f44b91957 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "xclsloueu" + "lzdjeyxfb" ] } }, "responses": { "200": { "body": { - "id": "xgjpijtcydnuqix", + "id": "bzwrh", "data": [ { "embedding": [ - 6 + 16 ], - "index": 20, - "object": "jccngbtzssnximgybewzqjpe" + "index": 6, + "object": "waxubsltefsfymbkowprrv" } ], "usage": { "capacity_type": "usage", - "input_tokens": 11, - "prompt_tokens": 13, - "total_tokens": 4 + "input_tokens": 6, + "prompt_tokens": 3, + "total_tokens": 5 }, - "object": "joiplxffmfzhxkpwxzteqho", - "model": "mlstapssr" + "object": "bkyqqqugdugngw", + "model": "mcnikaorrsysltpjjv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json similarity index 59% rename from specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json rename to specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json index 3fdd03f02dbb..679623884c9f 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -1,6 +1,6 @@ { "title": "maximum set model information", - "operationId": "GetModelInformation", + "operationId": "GetModelInfo", "parameters": { "api-version": "2024-04-01-preview" }, @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "glfrarmshuxkgslpbieunqyh", - "model_name": "wlcddyfcmgjaz" + "model_provider": "apwodtbnvecfbblkhjjfhkoi", + "model_name": "kegyzpmuwuzgxzicwslhnjrfymunz" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json similarity index 59% rename from specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json rename to specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json index 030246d44184..1e701478bb8c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInformation_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -1,6 +1,6 @@ { "title": "minimum set model information", - "operationId": "GetModelInformation", + "operationId": "GetModelInfo", "parameters": { "api-version": "2024-04-01-preview" }, @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "glfrarmshuxkgslpbieunqyh", - "model_name": "wlcddyfcmgjaz" + "model_provider": "apwodtbnvecfbblkhjjfhkoi", + "model_name": "kegyzpmuwuzgxzicwslhnjrfymunz" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 8eda1d2770a9..85b1ea677e05 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -137,7 +137,7 @@ using Server Sent Events (SSE). Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data. """) -model ChatCompletionsDelta { +model ChatCompletionsUpdate { ...ChatCompletionsCommon; @doc(""" @@ -146,7 +146,7 @@ model ChatCompletionsDelta { Token limits and other settings may limit the number of choices generated. """) @minItems(1) - choices: ChatChoiceDelta[]; + choices: ChatChoiceUpdate[]; } @doc(""" @@ -204,30 +204,22 @@ union ChatRole { } @doc(""" -An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON +An representation of a response format configuration usable by Chat Completions. Can be used to enable JSON mode. """) -@discriminator("type") -model ChatCompletionsResponseFormat { - @doc("The discriminated type for the response format.") - type: string; -} +union ChatCompletionsResponseFormat { + string, -@doc(""" -The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response -content that adheres to a specific schema. -""") -model ChatCompletionsTextResponseFormat extends ChatCompletionsResponseFormat { - @doc("The discriminated object type, which is always 'text' for this format.") - type: "text"; -} + @doc(""" + The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response + content that adheres to a specific schema. + """) + text: "text", -@doc(""" -A response format for Chat Completions that restricts responses to emitting valid JSON objects. -""") -model ChatCompletionsJsonResponseFormat extends ChatCompletionsResponseFormat { - @doc("The discriminated object type, which is always 'json_object' for this format.") - type: "json_object"; + @doc(""" + A response format for Chat Completions that restricts responses to emitting valid JSON objects. + """) + json_object: "json_object", } alias ChatChoiceCommon = { @@ -258,7 +250,7 @@ using Server Sent Events (SSE). Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated. """) -model ChatChoiceDelta { +model ChatChoiceUpdate { ...ChatChoiceCommon; @doc("An update to the chat message for a given chat completions prompt.") @@ -276,7 +268,7 @@ model ChatRequestMessage { A request chat message containing system instructions that influence how the model will generate a chat completions response. """) -model ChatRequestSystemMessage extends ChatRequestMessage { +model SystemMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'system' for system messages.") role: ChatRole.system; @@ -285,7 +277,7 @@ model ChatRequestSystemMessage extends ChatRequestMessage { } @doc("A request chat message representing user input to the assistant.") -model ChatRequestUserMessage extends ChatRequestMessage { +model UserMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'user' for user messages.") role: ChatRole.user; @@ -294,7 +286,7 @@ model ChatRequestUserMessage extends ChatRequestMessage { } @doc("A request chat message representing response or action from the assistant.") -model ChatRequestAssistantMessage extends ChatRequestMessage { +model AssistantMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'assistant' for assistant messages.") role: ChatRole.assistant; @@ -304,7 +296,7 @@ model ChatRequestAssistantMessage extends ChatRequestMessage { } @doc("A request chat message representing requested output from a configured tool.") -model ChatRequestToolMessage extends ChatRequestMessage { +model ToolMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'tool' for tool messages.") role: ChatRole.tool; diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 46ee0c63c287..687e311c06a1 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -45,7 +45,7 @@ op getEmbeddings is Azure.Core.RpcOperation< @doc("Creates images given a prompt.") @actionSeparator("/") @route("images/generations") -op getImageGenerations is Azure.Core.RpcOperation< +op generateImages is Azure.Core.RpcOperation< { ...ImageGenerationOptions; ...AdditionalRequestHeaders; @@ -57,4 +57,4 @@ op getImageGenerations is Azure.Core.RpcOperation< @actionSeparator("/") @route("info") @get -op getModelInformation is Azure.Core.RpcOperation<{}, ModelInformation>; +op getModelInfo is Azure.Core.RpcOperation<{}, ModelInformation>; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json similarity index 52% rename from specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json rename to specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json index 3abe3d47d4e8..3834ef979194 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json @@ -1,30 +1,30 @@ { "title": "maximum set image generation", - "operationId": "GetImageGenerations", + "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "sncngpxinfjmynfuzh", + "azureml-model-deployment": "njtnglmdxkmvackygi", "body": { "extras": { - "key4581": "gkzvup" + "key8167": "ynvtwkqhvplksdvgpvdlzrifbhkyxh" }, - "prompt": "pxkthxkra", - "size": "xabphlagaoxdfaaj", + "prompt": "cz", + "size": "hsdiiicbq", "quality": "standard", "response_format": "url", - "seed": 25 + "seed": 15 } }, "responses": { "200": { "body": { - "id": "tjgzxczrixiiugyccsaby", - "created": 24, - "model": "byrkqow", + "id": "uxttljr", + "created": 13, + "model": "begitgujngratbxhkravzlpttvmz", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "v" + "b64_json": "rdipydnucijiqd" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json similarity index 53% rename from specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json rename to specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json index 4e4adeb56f12..10eb5caf4256 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetImageGenerations_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json @@ -1,19 +1,19 @@ { "title": "minimum set image generation", - "operationId": "GetImageGenerations", + "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "udhueailreqfsltbskypgogaivzev", - "size": "i" + "prompt": "imvemauweqfnyj", + "size": "zdwugwbtynqbmlvyncmij" } }, "responses": { "200": { "body": { - "id": "tjgzxczrixiiugyccsaby", - "created": 24, - "model": "byrkqow", + "id": "uxttljr", + "created": 13, + "model": "begitgujngratbxhkravzlpttvmz", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 0b235dd802cd..6e31dbe78237 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,59 +3,57 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "arjeawalykuwefcg", + "azureml-model-deployment": "udwzxzqvnsporlajx", "body": { "extras": { - "key5815": "cvhukjkybbunvzj" + "key9114": "pbx" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, - "presence_penalty": -1, + "frequency_penalty": 0, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, - "response_format": { - "type": "ChatCompletionsResponseFormat" - }, + "response_format": "text", "stop": [ - "dxrbzgcs" + "yrejk" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 20 + "seed": 3 } }, "responses": { "200": { "body": { - "id": "zxvaywagaxbgovdcidylzyagy", - "object": "gswuglohgrqdzqtezkgofidotdn", - "created": 7, - "model": "ct", + "id": "qolgsfuprlsagpnquxez", + "object": "nudszoomjya", + "created": 23, + "model": "q", "usage": { "capacity_type": "usage", - "completion_tokens": 8, - "prompt_tokens": 25, - "total_tokens": 25 + "completion_tokens": 3, + "prompt_tokens": 30, + "total_tokens": 23 }, "choices": [ { - "index": 7, + "index": 22, "finish_reason": "stop", "message": { "role": "system", - "content": "kmsqvkwll", + "content": "mechuq", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "ahmjyckhthizppmb" + "id": "wzpgjqtjdpkwovo" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index c5613db258e9..7a35758e80a9 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "zxvaywagaxbgovdcidylzyagy", - "object": "gswuglohgrqdzqtezkgofidotdn", - "created": 7, - "model": "ct", + "id": "qolgsfuprlsagpnquxez", + "object": "nudszoomjya", + "created": 23, + "model": "q", "usage": { "capacity_type": "usage", - "completion_tokens": 8, - "prompt_tokens": 25, - "total_tokens": 25 + "completion_tokens": 3, + "prompt_tokens": 30, + "total_tokens": 23 }, "choices": [ { - "index": 7, + "index": 22, "finish_reason": "stop", "message": { "role": "system", - "content": "kmsqvkwll" + "content": "mechuq" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 34756ab337ee..9773759ffdc5 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "yrjgqrtitmgcpfwvinzdzrqsd", + "azureml-model-deployment": "awzdgxncarxhkvivafpmhde", "body": { "extras": { - "key5695": "wxrhwosmgecvefo" + "key8446": "ejosmkleisupnx" }, "input": [ - "vdldkfelrg" + "cjnwlxpkteeawbxwqeptix" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "xgjpijtcydnuqix", + "id": "bzwrh", "data": [ { "embedding": [ - 6 + 16 ], - "index": 20, - "object": "jccngbtzssnximgybewzqjpe" + "index": 6, + "object": "waxubsltefsfymbkowprrv" } ], "usage": { "capacity_type": "usage", - "input_tokens": 11, - "prompt_tokens": 13, - "total_tokens": 4 + "input_tokens": 6, + "prompt_tokens": 3, + "total_tokens": 5 }, - "object": "joiplxffmfzhxkpwxzteqho", - "model": "mlstapssr" + "object": "bkyqqqugdugngw", + "model": "mcnikaorrsysltpjjv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 7421b61236e3..051f44b91957 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "xclsloueu" + "lzdjeyxfb" ] } }, "responses": { "200": { "body": { - "id": "xgjpijtcydnuqix", + "id": "bzwrh", "data": [ { "embedding": [ - 6 + 16 ], - "index": 20, - "object": "jccngbtzssnximgybewzqjpe" + "index": 6, + "object": "waxubsltefsfymbkowprrv" } ], "usage": { "capacity_type": "usage", - "input_tokens": 11, - "prompt_tokens": 13, - "total_tokens": 4 + "input_tokens": 6, + "prompt_tokens": 3, + "total_tokens": 5 }, - "object": "joiplxffmfzhxkpwxzteqho", - "model": "mlstapssr" + "object": "bkyqqqugdugngw", + "model": "mcnikaorrsysltpjjv" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json similarity index 59% rename from specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json rename to specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 3fdd03f02dbb..679623884c9f 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -1,6 +1,6 @@ { "title": "maximum set model information", - "operationId": "GetModelInformation", + "operationId": "GetModelInfo", "parameters": { "api-version": "2024-04-01-preview" }, @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "glfrarmshuxkgslpbieunqyh", - "model_name": "wlcddyfcmgjaz" + "model_provider": "apwodtbnvecfbblkhjjfhkoi", + "model_name": "kegyzpmuwuzgxzicwslhnjrfymunz" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json similarity index 59% rename from specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json rename to specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 030246d44184..1e701478bb8c 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInformation_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -1,6 +1,6 @@ { "title": "minimum set model information", - "operationId": "GetModelInformation", + "operationId": "GetModelInfo", "parameters": { "api-version": "2024-04-01-preview" }, @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "glfrarmshuxkgslpbieunqyh", - "model_name": "wlcddyfcmgjaz" + "model_provider": "apwodtbnvecfbblkhjjfhkoi", + "model_name": "kegyzpmuwuzgxzicwslhnjrfymunz" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index c30a53192269..8cba62eb0eaf 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -22,7 +22,7 @@ "paths": { "/images/generations": { "post": { - "operationId": "GetImageGenerations", + "operationId": "GenerateImages", "description": "Creates images given a prompt.", "parameters": [ { @@ -122,17 +122,17 @@ }, "x-ms-examples": { "maximum set image generation": { - "$ref": "./examples/GetImageGenerations_MaximumSet_Gen.json" + "$ref": "./examples/GenerateImages_MaximumSet_Gen.json" }, "minimum set image generation": { - "$ref": "./examples/GetImageGenerations_MinimumSet_Gen.json" + "$ref": "./examples/GenerateImages_MinimumSet_Gen.json" } } } }, "/info": { "get": { - "operationId": "GetModelInformation", + "operationId": "GetModelInfo", "description": "Returns information about the AI model.", "parameters": [ { @@ -161,10 +161,10 @@ }, "x-ms-examples": { "maximum set model information": { - "$ref": "./examples/GetModelInformation_MaximumSet_Gen.json" + "$ref": "./examples/GetModelInfo_MaximumSet_Gen.json" }, "minimum set model information": { - "$ref": "./examples/GetModelInformation_MinimumSet_Gen.json" + "$ref": "./examples/GetModelInfo_MinimumSet_Gen.json" } } } @@ -393,6 +393,26 @@ } }, "definitions": { + "AssistantMessage": { + "type": "object", + "description": "A request chat message representing response or action from the assistant.", + "properties": { + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "assistant" + }, "Azure.Core.Foundations.Error": { "type": "object", "description": "The error object.", @@ -503,7 +523,7 @@ "message" ] }, - "ChatChoiceDelta": { + "ChatChoiceUpdate": { "type": "object", "description": "Represents an update to a single prompt completion when the service is streaming updates \nusing Server Sent Events (SSE).\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { @@ -572,50 +592,6 @@ "choices" ] }, - "ChatCompletionsDelta": { - "type": "object", - "description": "Represents a response update to a chat completions request, when the service is streaming updates \nusing Server Sent Events (SSE).\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", - "properties": { - "id": { - "type": "string", - "description": "A unique identifier associated with this chat completions response." - }, - "object": { - "type": "string", - "description": "The response object type, which is always `chat.completion`." - }, - "created": { - "type": "integer", - "format": "unixtime", - "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." - }, - "model": { - "type": "string", - "description": "The model used for the chat completion." - }, - "usage": { - "$ref": "#/definitions/CompletionsUsage", - "description": "Usage information for tokens processed and generated as part of this completions operation." - }, - "choices": { - "type": "array", - "description": "An update to the collection of completion choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", - "minItems": 1, - "items": { - "$ref": "#/definitions/ChatChoiceDelta" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "id", - "object", - "created", - "model", - "usage", - "choices" - ] - }, "ChatCompletionsFunctionToolCall": { "type": "object", "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\na function invocation needed for a subsequent chat completions request to resolve.", @@ -654,16 +630,6 @@ ], "x-ms-discriminator-value": "function" }, - "ChatCompletionsJsonResponseFormat": { - "type": "object", - "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects.", - "allOf": [ - { - "$ref": "#/definitions/ChatCompletionsResponseFormat" - } - ], - "x-ms-discriminator-value": "json_object" - }, "ChatCompletionsNamedToolSelection": { "type": "object", "description": "An abstract representation of an explicit, named tool selection to use for a chat completions request.", @@ -679,28 +645,28 @@ ] }, "ChatCompletionsResponseFormat": { - "type": "object", - "description": "An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON\nmode.", - "properties": { - "type": { - "type": "string", - "description": "The discriminated type for the response format." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "ChatCompletionsTextResponseFormat": { - "type": "object", - "description": "The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response\ncontent that adheres to a specific schema.", - "allOf": [ - { - "$ref": "#/definitions/ChatCompletionsResponseFormat" - } + "type": "string", + "description": "An representation of a response format configuration usable by Chat Completions. Can be used to enable JSON\nmode.", + "enum": [ + "text", + "json_object" ], - "x-ms-discriminator-value": "text" + "x-ms-enum": { + "name": "ChatCompletionsResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "text", + "value": "text", + "description": "The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response\ncontent that adheres to a specific schema." + }, + { + "name": "json_object", + "value": "json_object", + "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects." + } + ] + } }, "ChatCompletionsToolCall": { "type": "object", @@ -759,25 +725,49 @@ ] } }, - "ChatRequestAssistantMessage": { + "ChatCompletionsUpdate": { "type": "object", - "description": "A request chat message representing response or action from the assistant.", + "description": "Represents a response update to a chat completions request, when the service is streaming updates \nusing Server Sent Events (SSE).\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { - "content": { + "id": { "type": "string", - "description": "The content of the message.", - "x-nullable": true + "description": "A unique identifier associated with this chat completions response." + }, + "object": { + "type": "string", + "description": "The response object type, which is always `chat.completion`." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "model": { + "type": "string", + "description": "The model used for the chat completion." + }, + "usage": { + "$ref": "#/definitions/CompletionsUsage", + "description": "Usage information for tokens processed and generated as part of this completions operation." + }, + "choices": { + "type": "array", + "description": "An update to the collection of completion choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ChatChoiceUpdate" + }, + "x-ms-identifiers": [] } }, "required": [ - "content" - ], - "allOf": [ - { - "$ref": "#/definitions/ChatRequestMessage" - } - ], - "x-ms-discriminator-value": "assistant" + "id", + "object", + "created", + "model", + "usage", + "choices" + ] }, "ChatRequestMessage": { "type": "object", @@ -793,70 +783,6 @@ "role" ] }, - "ChatRequestSystemMessage": { - "type": "object", - "description": "A request chat message containing system instructions that influence how the model will generate a chat completions\nresponse.", - "properties": { - "content": { - "type": "string", - "description": "The contents of the system message." - } - }, - "required": [ - "content" - ], - "allOf": [ - { - "$ref": "#/definitions/ChatRequestMessage" - } - ], - "x-ms-discriminator-value": "system" - }, - "ChatRequestToolMessage": { - "type": "object", - "description": "A request chat message representing requested output from a configured tool.", - "properties": { - "content": { - "type": "string", - "description": "The content of the message.", - "x-nullable": true - }, - "tool_call_id": { - "type": "string", - "description": "The ID of the tool call resolved by the provided content.", - "x-ms-client-name": "toolCallId" - } - }, - "required": [ - "content", - "tool_call_id" - ], - "allOf": [ - { - "$ref": "#/definitions/ChatRequestMessage" - } - ], - "x-ms-discriminator-value": "tool" - }, - "ChatRequestUserMessage": { - "type": "object", - "description": "A request chat message representing user input to the assistant.", - "properties": { - "content": { - "type": "string", - "description": "The contents of the user message, with available input types varying by selected model." - } - }, - "required": [ - "content" - ], - "allOf": [ - { - "$ref": "#/definitions/ChatRequestMessage" - } - ], - "x-ms-discriminator-value": "user" - }, "ChatResponseMessage": { "type": "object", "description": "A representation of a chat message as received in a response.", @@ -1336,6 +1262,70 @@ ] } }, + "SystemMessage": { + "type": "object", + "description": "A request chat message containing system instructions that influence how the model will generate a chat completions\nresponse.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the system message." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "system" + }, + "ToolMessage": { + "type": "object", + "description": "A request chat message representing requested output from a configured tool.", + "properties": { + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call resolved by the provided content.", + "x-ms-client-name": "toolCallId" + } + }, + "required": [ + "content", + "tool_call_id" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "tool" + }, + "UserMessage": { + "type": "object", + "description": "A request chat message representing user input to the assistant.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the user message, with available input types varying by selected model." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "user" + }, "Versions": { "type": "string", "description": "The ModelClient service versions.", From 00b1841e43d2bbf5b100128ae8c2faff520ba7e2 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 12 Apr 2024 00:43:27 -0700 Subject: [PATCH 055/343] Attempt to create seperate clients --- specification/ai/ModelClient/client.tsp | 36 +++++++++++++++++++ .../GenerateImages_MaximumSet_Gen.json | 18 +++++----- .../GenerateImages_MinimumSet_Gen.json | 10 +++--- .../GetChatCompletions_MaximumSet_Gen.json | 30 ++++++++-------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++----- .../GetEmbeddings_MaximumSet_Gen.json | 22 ++++++------ .../GetEmbeddings_MinimumSet_Gen.json | 18 +++++----- .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- .../GenerateImages_MaximumSet_Gen.json | 18 +++++----- .../GenerateImages_MinimumSet_Gen.json | 10 +++--- .../GetChatCompletions_MaximumSet_Gen.json | 30 ++++++++-------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++----- .../GetEmbeddings_MaximumSet_Gen.json | 22 ++++++------ .../GetEmbeddings_MinimumSet_Gen.json | 18 +++++----- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +-- 17 files changed, 160 insertions(+), 124 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 56cd2cfed8c8..67d7292d9e34 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -3,6 +3,10 @@ import "@azure-tools/typespec-client-generator-core"; import "./main.tsp"; using Azure.ClientGenerator.Core; +using TypeSpec.Versioning; + +@useDependency(ModelClient.Versions.v2024_04_01_Preview) +namespace Customizations; // The actual name here doesn't matter and is here for organization purposes only // The "Update" models are used by the hand-written operation method that supports streaming. // We need to declare their usage and public access, otherwise they won't be emited in the generated code. @@ -10,3 +14,35 @@ using Azure.ClientGenerator.Core; @@usage(ModelClient.ChatCompletionsUpdate, Usage.output); @@access(ModelClient.ChatChoiceUpdate, Access.public); @@usage(ModelClient.ChatChoiceUpdate, Usage.output); + +@client({ + name: "ChatClient", + service: ModelClient, +}) +interface Client1 { + getChatCompletions is ModelClient.getChatCompletions; +} + +@client({ + name: "EmbeddingsClient", + service: ModelClient, +}) +interface Client2 { + getEmbeddings is ModelClient.getEmbeddings; +} + +@client({ + name: "ImageGenerationClient", + service: ModelClient, +}) +interface Client3 { + generateImages is ModelClient.generateImages; +} + +@client({ + name: "ModelInfoClient", + service: ModelClient, +}) +interface Client4 { + getModelInfo is ModelClient.getModelInfo; +} diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json index 3834ef979194..3bc306a84cc0 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "njtnglmdxkmvackygi", + "azureml-model-deployment": "elvjzhpk", "body": { "extras": { - "key8167": "ynvtwkqhvplksdvgpvdlzrifbhkyxh" + "key9110": "jnbrlxbnwhpfflmuwtxkpqprkpp" }, - "prompt": "cz", - "size": "hsdiiicbq", + "prompt": "tqtkdd", + "size": "ccquloztcoeg", "quality": "standard", "response_format": "url", - "seed": 15 + "seed": 9 } }, "responses": { "200": { "body": { - "id": "uxttljr", - "created": 13, - "model": "begitgujngratbxhkravzlpttvmz", + "id": "ypgvadyo", + "created": 4, + "model": "v", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "rdipydnucijiqd" + "b64_json": "unevzy" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json index 10eb5caf4256..d4eac58f9399 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "imvemauweqfnyj", - "size": "zdwugwbtynqbmlvyncmij" + "prompt": "qofkbjhzv", + "size": "ioppyisosgmq" } }, "responses": { "200": { "body": { - "id": "uxttljr", - "created": 13, - "model": "begitgujngratbxhkravzlpttvmz", + "id": "ypgvadyo", + "created": 4, + "model": "v", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 6e31dbe78237..2881301e7376 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,10 +3,10 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "udwzxzqvnsporlajx", + "azureml-model-deployment": "lbgientqkzdvtzcktekmhl", "body": { "extras": { - "key9114": "pbx" + "key6817": "pfjxtjuafvjwphkecztbogqerdajko" }, "messages": [ { @@ -14,46 +14,46 @@ } ], "frequency_penalty": 0, - "presence_penalty": 0, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "yrejk" + "awpcxsdpwn" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 3 + "seed": 17 } }, "responses": { "200": { "body": { - "id": "qolgsfuprlsagpnquxez", - "object": "nudszoomjya", - "created": 23, - "model": "q", + "id": "bdjzk", + "object": "ydorz", + "created": 17, + "model": "arpizakusszhfbsdb", "usage": { "capacity_type": "usage", - "completion_tokens": 3, - "prompt_tokens": 30, - "total_tokens": 23 + "completion_tokens": 6, + "prompt_tokens": 29, + "total_tokens": 7 }, "choices": [ { - "index": 22, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "mechuq", + "content": "lzgyduetyz", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "wzpgjqtjdpkwovo" + "id": "nf" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 7a35758e80a9..6efcb2e01672 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "qolgsfuprlsagpnquxez", - "object": "nudszoomjya", - "created": 23, - "model": "q", + "id": "bdjzk", + "object": "ydorz", + "created": 17, + "model": "arpizakusszhfbsdb", "usage": { "capacity_type": "usage", - "completion_tokens": 3, - "prompt_tokens": 30, - "total_tokens": 23 + "completion_tokens": 6, + "prompt_tokens": 29, + "total_tokens": 7 }, "choices": [ { - "index": 22, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "mechuq" + "content": "lzgyduetyz" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 9773759ffdc5..fc6973f1abe7 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "awzdgxncarxhkvivafpmhde", + "azureml-model-deployment": "ofcfpeocrezfhatkvxgpdbycll", "body": { "extras": { - "key8446": "ejosmkleisupnx" + "key4322": "diknxqmagdnain" }, "input": [ - "cjnwlxpkteeawbxwqeptix" + "mfmmdxrywtijvg" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "bzwrh", + "id": "sgmozzeaojqle", "data": [ { "embedding": [ 16 ], - "index": 6, - "object": "waxubsltefsfymbkowprrv" + "index": 26, + "object": "zwtzkagmvtx" } ], "usage": { "capacity_type": "usage", - "input_tokens": 6, - "prompt_tokens": 3, - "total_tokens": 5 + "input_tokens": 9, + "prompt_tokens": 10, + "total_tokens": 7 }, - "object": "bkyqqqugdugngw", - "model": "mcnikaorrsysltpjjv" + "object": "ygzyqxyjgnguzvgermxhpihg", + "model": "omvfcbhawdjiwnz" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 051f44b91957..4c071b67ae9a 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "lzdjeyxfb" + "zngawpxlb" ] } }, "responses": { "200": { "body": { - "id": "bzwrh", + "id": "sgmozzeaojqle", "data": [ { "embedding": [ 16 ], - "index": 6, - "object": "waxubsltefsfymbkowprrv" + "index": 26, + "object": "zwtzkagmvtx" } ], "usage": { "capacity_type": "usage", - "input_tokens": 6, - "prompt_tokens": 3, - "total_tokens": 5 + "input_tokens": 9, + "prompt_tokens": 10, + "total_tokens": 7 }, - "object": "bkyqqqugdugngw", - "model": "mcnikaorrsysltpjjv" + "object": "ygzyqxyjgnguzvgermxhpihg", + "model": "omvfcbhawdjiwnz" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json index 679623884c9f..9c1a4822edb1 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "apwodtbnvecfbblkhjjfhkoi", - "model_name": "kegyzpmuwuzgxzicwslhnjrfymunz" + "model_provider": "zmgrlxirgyemio", + "model_name": "oqwrneptvuvyfipjwxhpt" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json index 1e701478bb8c..6be38bdd3bdd 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "apwodtbnvecfbblkhjjfhkoi", - "model_name": "kegyzpmuwuzgxzicwslhnjrfymunz" + "model_provider": "zmgrlxirgyemio", + "model_name": "oqwrneptvuvyfipjwxhpt" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json index 3834ef979194..3bc306a84cc0 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "njtnglmdxkmvackygi", + "azureml-model-deployment": "elvjzhpk", "body": { "extras": { - "key8167": "ynvtwkqhvplksdvgpvdlzrifbhkyxh" + "key9110": "jnbrlxbnwhpfflmuwtxkpqprkpp" }, - "prompt": "cz", - "size": "hsdiiicbq", + "prompt": "tqtkdd", + "size": "ccquloztcoeg", "quality": "standard", "response_format": "url", - "seed": 15 + "seed": 9 } }, "responses": { "200": { "body": { - "id": "uxttljr", - "created": 13, - "model": "begitgujngratbxhkravzlpttvmz", + "id": "ypgvadyo", + "created": 4, + "model": "v", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "rdipydnucijiqd" + "b64_json": "unevzy" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json index 10eb5caf4256..d4eac58f9399 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "imvemauweqfnyj", - "size": "zdwugwbtynqbmlvyncmij" + "prompt": "qofkbjhzv", + "size": "ioppyisosgmq" } }, "responses": { "200": { "body": { - "id": "uxttljr", - "created": 13, - "model": "begitgujngratbxhkravzlpttvmz", + "id": "ypgvadyo", + "created": 4, + "model": "v", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 6e31dbe78237..2881301e7376 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,10 +3,10 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "udwzxzqvnsporlajx", + "azureml-model-deployment": "lbgientqkzdvtzcktekmhl", "body": { "extras": { - "key9114": "pbx" + "key6817": "pfjxtjuafvjwphkecztbogqerdajko" }, "messages": [ { @@ -14,46 +14,46 @@ } ], "frequency_penalty": 0, - "presence_penalty": 0, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "yrejk" + "awpcxsdpwn" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 3 + "seed": 17 } }, "responses": { "200": { "body": { - "id": "qolgsfuprlsagpnquxez", - "object": "nudszoomjya", - "created": 23, - "model": "q", + "id": "bdjzk", + "object": "ydorz", + "created": 17, + "model": "arpizakusszhfbsdb", "usage": { "capacity_type": "usage", - "completion_tokens": 3, - "prompt_tokens": 30, - "total_tokens": 23 + "completion_tokens": 6, + "prompt_tokens": 29, + "total_tokens": 7 }, "choices": [ { - "index": 22, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "mechuq", + "content": "lzgyduetyz", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "wzpgjqtjdpkwovo" + "id": "nf" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 7a35758e80a9..6efcb2e01672 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "qolgsfuprlsagpnquxez", - "object": "nudszoomjya", - "created": 23, - "model": "q", + "id": "bdjzk", + "object": "ydorz", + "created": 17, + "model": "arpizakusszhfbsdb", "usage": { "capacity_type": "usage", - "completion_tokens": 3, - "prompt_tokens": 30, - "total_tokens": 23 + "completion_tokens": 6, + "prompt_tokens": 29, + "total_tokens": 7 }, "choices": [ { - "index": 22, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "mechuq" + "content": "lzgyduetyz" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 9773759ffdc5..fc6973f1abe7 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "awzdgxncarxhkvivafpmhde", + "azureml-model-deployment": "ofcfpeocrezfhatkvxgpdbycll", "body": { "extras": { - "key8446": "ejosmkleisupnx" + "key4322": "diknxqmagdnain" }, "input": [ - "cjnwlxpkteeawbxwqeptix" + "mfmmdxrywtijvg" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "bzwrh", + "id": "sgmozzeaojqle", "data": [ { "embedding": [ 16 ], - "index": 6, - "object": "waxubsltefsfymbkowprrv" + "index": 26, + "object": "zwtzkagmvtx" } ], "usage": { "capacity_type": "usage", - "input_tokens": 6, - "prompt_tokens": 3, - "total_tokens": 5 + "input_tokens": 9, + "prompt_tokens": 10, + "total_tokens": 7 }, - "object": "bkyqqqugdugngw", - "model": "mcnikaorrsysltpjjv" + "object": "ygzyqxyjgnguzvgermxhpihg", + "model": "omvfcbhawdjiwnz" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 051f44b91957..4c071b67ae9a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "lzdjeyxfb" + "zngawpxlb" ] } }, "responses": { "200": { "body": { - "id": "bzwrh", + "id": "sgmozzeaojqle", "data": [ { "embedding": [ 16 ], - "index": 6, - "object": "waxubsltefsfymbkowprrv" + "index": 26, + "object": "zwtzkagmvtx" } ], "usage": { "capacity_type": "usage", - "input_tokens": 6, - "prompt_tokens": 3, - "total_tokens": 5 + "input_tokens": 9, + "prompt_tokens": 10, + "total_tokens": 7 }, - "object": "bkyqqqugdugngw", - "model": "mcnikaorrsysltpjjv" + "object": "ygzyqxyjgnguzvgermxhpihg", + "model": "omvfcbhawdjiwnz" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 679623884c9f..9c1a4822edb1 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "apwodtbnvecfbblkhjjfhkoi", - "model_name": "kegyzpmuwuzgxzicwslhnjrfymunz" + "model_provider": "zmgrlxirgyemio", + "model_name": "oqwrneptvuvyfipjwxhpt" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 1e701478bb8c..6be38bdd3bdd 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "apwodtbnvecfbblkhjjfhkoi", - "model_name": "kegyzpmuwuzgxzicwslhnjrfymunz" + "model_provider": "zmgrlxirgyemio", + "model_name": "oqwrneptvuvyfipjwxhpt" } } } From 81608d0c0d2f6b2053342632cc372d96cbb13005 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 12 Apr 2024 01:02:08 -0700 Subject: [PATCH 056/343] Attempt to add getModelInfo to each client --- specification/ai/ModelClient/client.tsp | 9 ++---- .../GenerateImages_MaximumSet_Gen.json | 18 +++++------ .../GenerateImages_MinimumSet_Gen.json | 10 +++--- .../GetChatCompletions_MaximumSet_Gen.json | 32 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 22 ++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 18 +++++------ .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- .../GenerateImages_MaximumSet_Gen.json | 18 +++++------ .../GenerateImages_MinimumSet_Gen.json | 10 +++--- .../GetChatCompletions_MaximumSet_Gen.json | 32 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 22 ++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 18 +++++------ .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +-- 17 files changed, 128 insertions(+), 133 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 67d7292d9e34..10ab2d15632b 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -21,6 +21,7 @@ namespace Customizations; // The actual name here doesn't matter and is here for }) interface Client1 { getChatCompletions is ModelClient.getChatCompletions; + getModelInfo is ModelClient.getModelInfo; } @client({ @@ -29,6 +30,7 @@ interface Client1 { }) interface Client2 { getEmbeddings is ModelClient.getEmbeddings; + getModelInfo is ModelClient.getModelInfo; } @client({ @@ -37,12 +39,5 @@ interface Client2 { }) interface Client3 { generateImages is ModelClient.generateImages; -} - -@client({ - name: "ModelInfoClient", - service: ModelClient, -}) -interface Client4 { getModelInfo is ModelClient.getModelInfo; } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json index 3bc306a84cc0..59c49dd8768a 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "elvjzhpk", + "azureml-model-deployment": "a", "body": { "extras": { - "key9110": "jnbrlxbnwhpfflmuwtxkpqprkpp" + "key4311": "qiottmuixwaxzz" }, - "prompt": "tqtkdd", - "size": "ccquloztcoeg", + "prompt": "doa", + "size": "h", "quality": "standard", "response_format": "url", - "seed": 9 + "seed": 10 } }, "responses": { "200": { "body": { - "id": "ypgvadyo", - "created": 4, - "model": "v", + "id": "scamaur", + "created": 18, + "model": "asqiabox", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "unevzy" + "b64_json": "grkrkserylcapvhlp" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json index d4eac58f9399..e5360d2ffd80 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "qofkbjhzv", - "size": "ioppyisosgmq" + "prompt": "zvmsxomixyqxivjrzabmpm", + "size": "eojzkdoiowpsywetzhthllm" } }, "responses": { "200": { "body": { - "id": "ypgvadyo", - "created": 4, - "model": "v", + "id": "scamaur", + "created": 18, + "model": "asqiabox", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 2881301e7376..1041e5003e62 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,57 +3,57 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "lbgientqkzdvtzcktekmhl", + "azureml-model-deployment": "nzecawdsuid", "body": { "extras": { - "key6817": "pfjxtjuafvjwphkecztbogqerdajko" + "key3499": "kkyensjnmpdtqpqydbgkraozdwia" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, - "presence_penalty": -2, + "frequency_penalty": -1, + "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "awpcxsdpwn" + "tpdzxjn" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 17 + "seed": 27 } }, "responses": { "200": { "body": { - "id": "bdjzk", - "object": "ydorz", - "created": 17, - "model": "arpizakusszhfbsdb", + "id": "frqhszkvdckecquzayqxnzltatx", + "object": "wmhdjvndgpiejgpwirktwt", + "created": 30, + "model": "yrxbgp", "usage": { "capacity_type": "usage", - "completion_tokens": 6, - "prompt_tokens": 29, - "total_tokens": 7 + "completion_tokens": 9, + "prompt_tokens": 3, + "total_tokens": 23 }, "choices": [ { - "index": 18, + "index": 6, "finish_reason": "stop", "message": { "role": "system", - "content": "lzgyduetyz", + "content": "zmkrkidvd", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "nf" + "id": "dyqicoynxqexbhxbewef" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 6efcb2e01672..3473d42a1770 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "bdjzk", - "object": "ydorz", - "created": 17, - "model": "arpizakusszhfbsdb", + "id": "frqhszkvdckecquzayqxnzltatx", + "object": "wmhdjvndgpiejgpwirktwt", + "created": 30, + "model": "yrxbgp", "usage": { "capacity_type": "usage", - "completion_tokens": 6, - "prompt_tokens": 29, - "total_tokens": 7 + "completion_tokens": 9, + "prompt_tokens": 3, + "total_tokens": 23 }, "choices": [ { - "index": 18, + "index": 6, "finish_reason": "stop", "message": { "role": "system", - "content": "lzgyduetyz" + "content": "zmkrkidvd" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index fc6973f1abe7..9a73db12bfc9 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "ofcfpeocrezfhatkvxgpdbycll", + "azureml-model-deployment": "zioljzndmjrhwvpkgwinwgqwzlueva", "body": { "extras": { - "key4322": "diknxqmagdnain" + "key2781": "sidjiheocvtczjolpqhsq" }, "input": [ - "mfmmdxrywtijvg" + "dlxyrnfwdjdogkuitnrpw" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "sgmozzeaojqle", + "id": "qgaqgvmdukdpddgcwi", "data": [ { "embedding": [ - 16 + 12 ], "index": 26, - "object": "zwtzkagmvtx" + "object": "oq" } ], "usage": { "capacity_type": "usage", - "input_tokens": 9, - "prompt_tokens": 10, - "total_tokens": 7 + "input_tokens": 10, + "prompt_tokens": 7, + "total_tokens": 22 }, - "object": "ygzyqxyjgnguzvgermxhpihg", - "model": "omvfcbhawdjiwnz" + "object": "djxlywtgjitzpvq", + "model": "kcnuiypqefgdpz" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 4c071b67ae9a..b2b70f97f553 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "zngawpxlb" + "fkmbthb" ] } }, "responses": { "200": { "body": { - "id": "sgmozzeaojqle", + "id": "qgaqgvmdukdpddgcwi", "data": [ { "embedding": [ - 16 + 12 ], "index": 26, - "object": "zwtzkagmvtx" + "object": "oq" } ], "usage": { "capacity_type": "usage", - "input_tokens": 9, - "prompt_tokens": 10, - "total_tokens": 7 + "input_tokens": 10, + "prompt_tokens": 7, + "total_tokens": 22 }, - "object": "ygzyqxyjgnguzvgermxhpihg", - "model": "omvfcbhawdjiwnz" + "object": "djxlywtgjitzpvq", + "model": "kcnuiypqefgdpz" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json index 9c1a4822edb1..4770d1a26616 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "zmgrlxirgyemio", - "model_name": "oqwrneptvuvyfipjwxhpt" + "model_provider": "bplxhewopmyy", + "model_name": "xaxbtvkqixkakkgalxdnxpnoaf" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json index 6be38bdd3bdd..bec2c674c796 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "zmgrlxirgyemio", - "model_name": "oqwrneptvuvyfipjwxhpt" + "model_provider": "bplxhewopmyy", + "model_name": "xaxbtvkqixkakkgalxdnxpnoaf" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json index 3bc306a84cc0..59c49dd8768a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "elvjzhpk", + "azureml-model-deployment": "a", "body": { "extras": { - "key9110": "jnbrlxbnwhpfflmuwtxkpqprkpp" + "key4311": "qiottmuixwaxzz" }, - "prompt": "tqtkdd", - "size": "ccquloztcoeg", + "prompt": "doa", + "size": "h", "quality": "standard", "response_format": "url", - "seed": 9 + "seed": 10 } }, "responses": { "200": { "body": { - "id": "ypgvadyo", - "created": 4, - "model": "v", + "id": "scamaur", + "created": 18, + "model": "asqiabox", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "unevzy" + "b64_json": "grkrkserylcapvhlp" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json index d4eac58f9399..e5360d2ffd80 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "qofkbjhzv", - "size": "ioppyisosgmq" + "prompt": "zvmsxomixyqxivjrzabmpm", + "size": "eojzkdoiowpsywetzhthllm" } }, "responses": { "200": { "body": { - "id": "ypgvadyo", - "created": 4, - "model": "v", + "id": "scamaur", + "created": 18, + "model": "asqiabox", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 2881301e7376..1041e5003e62 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,57 +3,57 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "lbgientqkzdvtzcktekmhl", + "azureml-model-deployment": "nzecawdsuid", "body": { "extras": { - "key6817": "pfjxtjuafvjwphkecztbogqerdajko" + "key3499": "kkyensjnmpdtqpqydbgkraozdwia" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, - "presence_penalty": -2, + "frequency_penalty": -1, + "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "awpcxsdpwn" + "tpdzxjn" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 17 + "seed": 27 } }, "responses": { "200": { "body": { - "id": "bdjzk", - "object": "ydorz", - "created": 17, - "model": "arpizakusszhfbsdb", + "id": "frqhszkvdckecquzayqxnzltatx", + "object": "wmhdjvndgpiejgpwirktwt", + "created": 30, + "model": "yrxbgp", "usage": { "capacity_type": "usage", - "completion_tokens": 6, - "prompt_tokens": 29, - "total_tokens": 7 + "completion_tokens": 9, + "prompt_tokens": 3, + "total_tokens": 23 }, "choices": [ { - "index": 18, + "index": 6, "finish_reason": "stop", "message": { "role": "system", - "content": "lzgyduetyz", + "content": "zmkrkidvd", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "nf" + "id": "dyqicoynxqexbhxbewef" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 6efcb2e01672..3473d42a1770 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "bdjzk", - "object": "ydorz", - "created": 17, - "model": "arpizakusszhfbsdb", + "id": "frqhszkvdckecquzayqxnzltatx", + "object": "wmhdjvndgpiejgpwirktwt", + "created": 30, + "model": "yrxbgp", "usage": { "capacity_type": "usage", - "completion_tokens": 6, - "prompt_tokens": 29, - "total_tokens": 7 + "completion_tokens": 9, + "prompt_tokens": 3, + "total_tokens": 23 }, "choices": [ { - "index": 18, + "index": 6, "finish_reason": "stop", "message": { "role": "system", - "content": "lzgyduetyz" + "content": "zmkrkidvd" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index fc6973f1abe7..9a73db12bfc9 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "ofcfpeocrezfhatkvxgpdbycll", + "azureml-model-deployment": "zioljzndmjrhwvpkgwinwgqwzlueva", "body": { "extras": { - "key4322": "diknxqmagdnain" + "key2781": "sidjiheocvtczjolpqhsq" }, "input": [ - "mfmmdxrywtijvg" + "dlxyrnfwdjdogkuitnrpw" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "sgmozzeaojqle", + "id": "qgaqgvmdukdpddgcwi", "data": [ { "embedding": [ - 16 + 12 ], "index": 26, - "object": "zwtzkagmvtx" + "object": "oq" } ], "usage": { "capacity_type": "usage", - "input_tokens": 9, - "prompt_tokens": 10, - "total_tokens": 7 + "input_tokens": 10, + "prompt_tokens": 7, + "total_tokens": 22 }, - "object": "ygzyqxyjgnguzvgermxhpihg", - "model": "omvfcbhawdjiwnz" + "object": "djxlywtgjitzpvq", + "model": "kcnuiypqefgdpz" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 4c071b67ae9a..b2b70f97f553 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "zngawpxlb" + "fkmbthb" ] } }, "responses": { "200": { "body": { - "id": "sgmozzeaojqle", + "id": "qgaqgvmdukdpddgcwi", "data": [ { "embedding": [ - 16 + 12 ], "index": 26, - "object": "zwtzkagmvtx" + "object": "oq" } ], "usage": { "capacity_type": "usage", - "input_tokens": 9, - "prompt_tokens": 10, - "total_tokens": 7 + "input_tokens": 10, + "prompt_tokens": 7, + "total_tokens": 22 }, - "object": "ygzyqxyjgnguzvgermxhpihg", - "model": "omvfcbhawdjiwnz" + "object": "djxlywtgjitzpvq", + "model": "kcnuiypqefgdpz" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 9c1a4822edb1..4770d1a26616 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "zmgrlxirgyemio", - "model_name": "oqwrneptvuvyfipjwxhpt" + "model_provider": "bplxhewopmyy", + "model_name": "xaxbtvkqixkakkgalxdnxpnoaf" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 6be38bdd3bdd..bec2c674c796 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "zmgrlxirgyemio", - "model_name": "oqwrneptvuvyfipjwxhpt" + "model_provider": "bplxhewopmyy", + "model_name": "xaxbtvkqixkakkgalxdnxpnoaf" } } } From 09dca826e0d1e85d00400f1c5ab527e90c84167c Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 12 Apr 2024 01:33:59 -0700 Subject: [PATCH 057/343] Fix CapacityType --- specification/ai/ModelClient/client.tsp | 2 +- .../GenerateImages_MaximumSet_Gen.json | 18 +++++------ .../GenerateImages_MinimumSet_Gen.json | 10 +++---- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 22 +++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 18 +++++------ .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- .../ai/ModelClient/models/common.tsp | 4 +-- .../GenerateImages_MaximumSet_Gen.json | 18 +++++------ .../GenerateImages_MinimumSet_Gen.json | 10 +++---- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 22 +++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 18 +++++------ .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +-- .../preview/2024-04-01-preview/openapi.json | 4 +-- 19 files changed, 129 insertions(+), 129 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 10ab2d15632b..dd8ddbb83b37 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -16,7 +16,7 @@ namespace Customizations; // The actual name here doesn't matter and is here for @@usage(ModelClient.ChatChoiceUpdate, Usage.output); @client({ - name: "ChatClient", + name: "ChatCompletionsClient", service: ModelClient, }) interface Client1 { diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json index 59c49dd8768a..e05b5003830b 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "a", + "azureml-model-deployment": "htvqxydkekncnpymnhqsdelqgrszm", "body": { "extras": { - "key4311": "qiottmuixwaxzz" + "key6365": "snsxhvtujtpjjgoqtz" }, - "prompt": "doa", - "size": "h", + "prompt": "dhjvogvnuftokj", + "size": "ibnfps", "quality": "standard", "response_format": "url", - "seed": 10 + "seed": 5 } }, "responses": { "200": { "body": { - "id": "scamaur", - "created": 18, - "model": "asqiabox", + "id": "tkkvudvgguol", + "created": 2, + "model": "fuemakla", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "grkrkserylcapvhlp" + "b64_json": "wdthgkpci" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json index e5360d2ffd80..3db1fc47c70d 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "zvmsxomixyqxivjrzabmpm", - "size": "eojzkdoiowpsywetzhthllm" + "prompt": "nemueodnxxxa", + "size": "fvglnzh" } }, "responses": { "200": { "body": { - "id": "scamaur", - "created": 18, - "model": "asqiabox", + "id": "tkkvudvgguol", + "created": 2, + "model": "fuemakla", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 1041e5003e62..bd8ca8ed554f 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,57 +3,57 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "nzecawdsuid", + "azureml-model-deployment": "vgivbgwpqsdxbdfkkssnmeygifch", "body": { "extras": { - "key3499": "kkyensjnmpdtqpqydbgkraozdwia" + "key4415": "yhbhukhnxzbybudhbmfwdwhxjyu" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": -2, "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "tpdzxjn" + "fieqqklpzxuhfhwrxjfflq" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 27 + "seed": 5 } }, "responses": { "200": { "body": { - "id": "frqhszkvdckecquzayqxnzltatx", - "object": "wmhdjvndgpiejgpwirktwt", - "created": 30, - "model": "yrxbgp", + "id": "nyuhsogwugvfffagspvlkbctmhgy", + "object": "j", + "created": 20, + "model": "dwjgccoerov", "usage": { "capacity_type": "usage", - "completion_tokens": 9, - "prompt_tokens": 3, - "total_tokens": 23 + "completion_tokens": 4, + "prompt_tokens": 29, + "total_tokens": 24 }, "choices": [ { - "index": 6, + "index": 27, "finish_reason": "stop", "message": { "role": "system", - "content": "zmkrkidvd", + "content": "yhkwlhkgmhdzzlarhdllrwtdoov", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "dyqicoynxqexbhxbewef" + "id": "otfsiibjffhnnm" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 3473d42a1770..4fcd7adc02a4 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "frqhszkvdckecquzayqxnzltatx", - "object": "wmhdjvndgpiejgpwirktwt", - "created": 30, - "model": "yrxbgp", + "id": "nyuhsogwugvfffagspvlkbctmhgy", + "object": "j", + "created": 20, + "model": "dwjgccoerov", "usage": { "capacity_type": "usage", - "completion_tokens": 9, - "prompt_tokens": 3, - "total_tokens": 23 + "completion_tokens": 4, + "prompt_tokens": 29, + "total_tokens": 24 }, "choices": [ { - "index": 6, + "index": 27, "finish_reason": "stop", "message": { "role": "system", - "content": "zmkrkidvd" + "content": "yhkwlhkgmhdzzlarhdllrwtdoov" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 9a73db12bfc9..522e853351f8 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "zioljzndmjrhwvpkgwinwgqwzlueva", + "azureml-model-deployment": "yhvqsxxmovwgud", "body": { "extras": { - "key2781": "sidjiheocvtczjolpqhsq" + "key7699": "gtoiwmsixgnoqt" }, "input": [ - "dlxyrnfwdjdogkuitnrpw" + "jqdzisnqggkwvnijrshupxgiumf" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "qgaqgvmdukdpddgcwi", + "id": "hrnxhhuclykokrdkuli", "data": [ { "embedding": [ - 12 + 13 ], - "index": 26, - "object": "oq" + "index": 19, + "object": "upuylpsjuboekwxj" } ], "usage": { "capacity_type": "usage", "input_tokens": 10, - "prompt_tokens": 7, - "total_tokens": 22 + "prompt_tokens": 27, + "total_tokens": 12 }, - "object": "djxlywtgjitzpvq", - "model": "kcnuiypqefgdpz" + "object": "ur", + "model": "osqeawsibcjedoil" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index b2b70f97f553..7661e414e92e 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "fkmbthb" + "jcw" ] } }, "responses": { "200": { "body": { - "id": "qgaqgvmdukdpddgcwi", + "id": "hrnxhhuclykokrdkuli", "data": [ { "embedding": [ - 12 + 13 ], - "index": 26, - "object": "oq" + "index": 19, + "object": "upuylpsjuboekwxj" } ], "usage": { "capacity_type": "usage", "input_tokens": 10, - "prompt_tokens": 7, - "total_tokens": 22 + "prompt_tokens": 27, + "total_tokens": 12 }, - "object": "djxlywtgjitzpvq", - "model": "kcnuiypqefgdpz" + "object": "ur", + "model": "osqeawsibcjedoil" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json index 4770d1a26616..fef8949b9f66 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "bplxhewopmyy", - "model_name": "xaxbtvkqixkakkgalxdnxpnoaf" + "model_provider": "nkbelpkxpqsbgujjbiifxylf", + "model_name": "mzyolrapnadkkp" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json index bec2c674c796..68ec723eff75 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "bplxhewopmyy", - "model_name": "xaxbtvkqixkakkgalxdnxpnoaf" + "model_provider": "nkbelpkxpqsbgujjbiifxylf", + "model_name": "mzyolrapnadkkp" } } } diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 7a9701942c16..18afdf711a67 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -39,10 +39,10 @@ union CapacityType { string, @doc("Your capacity has been affected by the usage amount (token count) reported here.") - error: "usage", + usage: "usage", @doc("Your capacity has not been affected by the usage amount (token count) reported here.") - ignore: "fixed", + fixed: "fixed", } alias ExtraRequestParameters = { diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json index 59c49dd8768a..e05b5003830b 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "a", + "azureml-model-deployment": "htvqxydkekncnpymnhqsdelqgrszm", "body": { "extras": { - "key4311": "qiottmuixwaxzz" + "key6365": "snsxhvtujtpjjgoqtz" }, - "prompt": "doa", - "size": "h", + "prompt": "dhjvogvnuftokj", + "size": "ibnfps", "quality": "standard", "response_format": "url", - "seed": 10 + "seed": 5 } }, "responses": { "200": { "body": { - "id": "scamaur", - "created": 18, - "model": "asqiabox", + "id": "tkkvudvgguol", + "created": 2, + "model": "fuemakla", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "grkrkserylcapvhlp" + "b64_json": "wdthgkpci" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json index e5360d2ffd80..3db1fc47c70d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "zvmsxomixyqxivjrzabmpm", - "size": "eojzkdoiowpsywetzhthllm" + "prompt": "nemueodnxxxa", + "size": "fvglnzh" } }, "responses": { "200": { "body": { - "id": "scamaur", - "created": 18, - "model": "asqiabox", + "id": "tkkvudvgguol", + "created": 2, + "model": "fuemakla", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 1041e5003e62..bd8ca8ed554f 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,57 +3,57 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "nzecawdsuid", + "azureml-model-deployment": "vgivbgwpqsdxbdfkkssnmeygifch", "body": { "extras": { - "key3499": "kkyensjnmpdtqpqydbgkraozdwia" + "key4415": "yhbhukhnxzbybudhbmfwdwhxjyu" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": -2, "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "tpdzxjn" + "fieqqklpzxuhfhwrxjfflq" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 27 + "seed": 5 } }, "responses": { "200": { "body": { - "id": "frqhszkvdckecquzayqxnzltatx", - "object": "wmhdjvndgpiejgpwirktwt", - "created": 30, - "model": "yrxbgp", + "id": "nyuhsogwugvfffagspvlkbctmhgy", + "object": "j", + "created": 20, + "model": "dwjgccoerov", "usage": { "capacity_type": "usage", - "completion_tokens": 9, - "prompt_tokens": 3, - "total_tokens": 23 + "completion_tokens": 4, + "prompt_tokens": 29, + "total_tokens": 24 }, "choices": [ { - "index": 6, + "index": 27, "finish_reason": "stop", "message": { "role": "system", - "content": "zmkrkidvd", + "content": "yhkwlhkgmhdzzlarhdllrwtdoov", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "dyqicoynxqexbhxbewef" + "id": "otfsiibjffhnnm" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 3473d42a1770..4fcd7adc02a4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "frqhszkvdckecquzayqxnzltatx", - "object": "wmhdjvndgpiejgpwirktwt", - "created": 30, - "model": "yrxbgp", + "id": "nyuhsogwugvfffagspvlkbctmhgy", + "object": "j", + "created": 20, + "model": "dwjgccoerov", "usage": { "capacity_type": "usage", - "completion_tokens": 9, - "prompt_tokens": 3, - "total_tokens": 23 + "completion_tokens": 4, + "prompt_tokens": 29, + "total_tokens": 24 }, "choices": [ { - "index": 6, + "index": 27, "finish_reason": "stop", "message": { "role": "system", - "content": "zmkrkidvd" + "content": "yhkwlhkgmhdzzlarhdllrwtdoov" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 9a73db12bfc9..522e853351f8 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "zioljzndmjrhwvpkgwinwgqwzlueva", + "azureml-model-deployment": "yhvqsxxmovwgud", "body": { "extras": { - "key2781": "sidjiheocvtczjolpqhsq" + "key7699": "gtoiwmsixgnoqt" }, "input": [ - "dlxyrnfwdjdogkuitnrpw" + "jqdzisnqggkwvnijrshupxgiumf" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "qgaqgvmdukdpddgcwi", + "id": "hrnxhhuclykokrdkuli", "data": [ { "embedding": [ - 12 + 13 ], - "index": 26, - "object": "oq" + "index": 19, + "object": "upuylpsjuboekwxj" } ], "usage": { "capacity_type": "usage", "input_tokens": 10, - "prompt_tokens": 7, - "total_tokens": 22 + "prompt_tokens": 27, + "total_tokens": 12 }, - "object": "djxlywtgjitzpvq", - "model": "kcnuiypqefgdpz" + "object": "ur", + "model": "osqeawsibcjedoil" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index b2b70f97f553..7661e414e92e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "fkmbthb" + "jcw" ] } }, "responses": { "200": { "body": { - "id": "qgaqgvmdukdpddgcwi", + "id": "hrnxhhuclykokrdkuli", "data": [ { "embedding": [ - 12 + 13 ], - "index": 26, - "object": "oq" + "index": 19, + "object": "upuylpsjuboekwxj" } ], "usage": { "capacity_type": "usage", "input_tokens": 10, - "prompt_tokens": 7, - "total_tokens": 22 + "prompt_tokens": 27, + "total_tokens": 12 }, - "object": "djxlywtgjitzpvq", - "model": "kcnuiypqefgdpz" + "object": "ur", + "model": "osqeawsibcjedoil" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 4770d1a26616..fef8949b9f66 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "bplxhewopmyy", - "model_name": "xaxbtvkqixkakkgalxdnxpnoaf" + "model_provider": "nkbelpkxpqsbgujjbiifxylf", + "model_name": "mzyolrapnadkkp" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index bec2c674c796..68ec723eff75 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "bplxhewopmyy", - "model_name": "xaxbtvkqixkakkgalxdnxpnoaf" + "model_provider": "nkbelpkxpqsbgujjbiifxylf", + "model_name": "mzyolrapnadkkp" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index 8cba62eb0eaf..c6c115043c24 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -486,12 +486,12 @@ "modelAsString": true, "values": [ { - "name": "error", + "name": "usage", "value": "usage", "description": "Your capacity has been affected by the usage amount (token count) reported here." }, { - "name": "ignore", + "name": "fixed", "value": "fixed", "description": "Your capacity has not been affected by the usage amount (token count) reported here." } From ba7fc3487151ec4216541717cd87c1d85f06c5fd Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 12 Apr 2024 10:49:37 -0700 Subject: [PATCH 058/343] Use 'client' as common operator name. Split models into their own folders --- .../chat_completions.tsp | 0 specification/ai/ModelClient/client.tsp | 6 +-- .../ModelClient/{models => common}/common.tsp | 32 +++++++++++++++ .../{models => embeddings}/embeddings.tsp | 0 .../GenerateImages_MaximumSet_Gen.json | 18 ++++----- .../GenerateImages_MinimumSet_Gen.json | 10 ++--- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++++++------- .../GetChatCompletions_MinimumSet_Gen.json | 18 ++++----- .../GetEmbeddings_MaximumSet_Gen.json | 24 ++++++------ .../GetEmbeddings_MinimumSet_Gen.json | 20 +++++----- .../GetModelInfo_MaximumSet_Gen.json | 4 +- .../GetModelInfo_MinimumSet_Gen.json | 4 +- .../image_generation.tsp | 0 .../ai/ModelClient/models/model_info.tsp | 39 ------------------- specification/ai/ModelClient/routes.tsp | 9 ++--- .../GenerateImages_MaximumSet_Gen.json | 18 ++++----- .../GenerateImages_MinimumSet_Gen.json | 10 ++--- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++++++------- .../GetChatCompletions_MinimumSet_Gen.json | 18 ++++----- .../GetEmbeddings_MaximumSet_Gen.json | 24 ++++++------ .../GetEmbeddings_MinimumSet_Gen.json | 20 +++++----- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +- 23 files changed, 167 insertions(+), 175 deletions(-) rename specification/ai/ModelClient/{models => chat.completions}/chat_completions.tsp (100%) rename specification/ai/ModelClient/{models => common}/common.tsp (76%) rename specification/ai/ModelClient/{models => embeddings}/embeddings.tsp (100%) rename specification/ai/ModelClient/{models => image.generation}/image_generation.tsp (100%) delete mode 100644 specification/ai/ModelClient/models/model_info.tsp diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/chat.completions/chat_completions.tsp similarity index 100% rename from specification/ai/ModelClient/models/chat_completions.tsp rename to specification/ai/ModelClient/chat.completions/chat_completions.tsp diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index dd8ddbb83b37..75537db3c384 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -20,7 +20,7 @@ namespace Customizations; // The actual name here doesn't matter and is here for service: ModelClient, }) interface Client1 { - getChatCompletions is ModelClient.getChatCompletions; + create is ModelClient.getChatCompletions; getModelInfo is ModelClient.getModelInfo; } @@ -29,7 +29,7 @@ interface Client1 { service: ModelClient, }) interface Client2 { - getEmbeddings is ModelClient.getEmbeddings; + create is ModelClient.getEmbeddings; getModelInfo is ModelClient.getModelInfo; } @@ -38,6 +38,6 @@ interface Client2 { service: ModelClient, }) interface Client3 { - generateImages is ModelClient.generateImages; + create is ModelClient.generateImages; getModelInfo is ModelClient.getModelInfo; } diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/common/common.tsp similarity index 76% rename from specification/ai/ModelClient/models/common.tsp rename to specification/ai/ModelClient/common/common.tsp index 18afdf711a67..60b36a367bf1 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/common/common.tsp @@ -6,6 +6,38 @@ using TypeSpec.Http; namespace ModelClient; +@doc("Represents some basic information about the AI model.") +model ModelInformation { + @doc("The type of the AI model.") + model_type: ModelType; + + @doc("The model provider.") + model_provider: string; + + @doc("The name of the AI model.") + model_name: string; +} + +@doc("The type of AI model") +union ModelType { + string, + + @doc("Embeddings.") + embeddings: "embeddings", + + @doc("Custom model.") + custom: "custom", + + @doc("Chat completions") + chat: "chat", + + @doc("Text generation") + text_generation: "text_generation", + + @doc("Image generation") + image_generation: "image_generation", +} + @doc("Defines the service behavior when extra parameters are passed in the request payload.") union ExtraParameters { string, diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/embeddings/embeddings.tsp similarity index 100% rename from specification/ai/ModelClient/models/embeddings.tsp rename to specification/ai/ModelClient/embeddings/embeddings.tsp diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json index e05b5003830b..63fa46e3e4a4 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "htvqxydkekncnpymnhqsdelqgrszm", + "azureml-model-deployment": "pxmcfsjcxfzcvyyewxkqnsqpf", "body": { "extras": { - "key6365": "snsxhvtujtpjjgoqtz" + "key321": "jwfslhuxb" }, - "prompt": "dhjvogvnuftokj", - "size": "ibnfps", + "prompt": "cjyxrtpwacngidhuqlzuv", + "size": "bbrlybbmjwluntrylmwtt", "quality": "standard", "response_format": "url", - "seed": 5 + "seed": 7 } }, "responses": { "200": { "body": { - "id": "tkkvudvgguol", - "created": 2, - "model": "fuemakla", + "id": "muckxbcmxcwjqrmxq", + "created": 30, + "model": "cgoewbpodd", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "wdthgkpci" + "b64_json": "xhfksftpjmfquluclpcgrkb" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json index 3db1fc47c70d..8fb3e087f579 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "nemueodnxxxa", - "size": "fvglnzh" + "prompt": "cz", + "size": "qbipakgkikdhclywm" } }, "responses": { "200": { "body": { - "id": "tkkvudvgguol", - "created": 2, - "model": "fuemakla", + "id": "muckxbcmxcwjqrmxq", + "created": 30, + "model": "cgoewbpodd", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index bd8ca8ed554f..8c4596838cd0 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,10 +3,10 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "vgivbgwpqsdxbdfkkssnmeygifch", + "azureml-model-deployment": "duedshvpgwqtfwblxrjmfqub", "body": { "extras": { - "key4415": "yhbhukhnxzbybudhbmfwdwhxjyu" + "key7873": "qio" }, "messages": [ { @@ -14,46 +14,46 @@ } ], "frequency_penalty": -2, - "presence_penalty": -1, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "fieqqklpzxuhfhwrxjfflq" + "ypudkhkwozhaefan" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 5 + "seed": 8 } }, "responses": { "200": { "body": { - "id": "nyuhsogwugvfffagspvlkbctmhgy", - "object": "j", - "created": 20, - "model": "dwjgccoerov", + "id": "g", + "object": "rwddsayntqhjhmmvnlbmialid", + "created": 7, + "model": "l", "usage": { "capacity_type": "usage", - "completion_tokens": 4, - "prompt_tokens": 29, - "total_tokens": 24 + "completion_tokens": 24, + "prompt_tokens": 30, + "total_tokens": 27 }, "choices": [ { - "index": 27, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "yhkwlhkgmhdzzlarhdllrwtdoov", + "content": "tbjiwxsdnpvkhymgxtux", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "otfsiibjffhnnm" + "id": "wlkamr" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 4fcd7adc02a4..7e896b2eb842 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "nyuhsogwugvfffagspvlkbctmhgy", - "object": "j", - "created": 20, - "model": "dwjgccoerov", + "id": "g", + "object": "rwddsayntqhjhmmvnlbmialid", + "created": 7, + "model": "l", "usage": { "capacity_type": "usage", - "completion_tokens": 4, - "prompt_tokens": 29, - "total_tokens": 24 + "completion_tokens": 24, + "prompt_tokens": 30, + "total_tokens": 27 }, "choices": [ { - "index": 27, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "yhkwlhkgmhdzzlarhdllrwtdoov" + "content": "tbjiwxsdnpvkhymgxtux" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 522e853351f8..3b92c1cbde55 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "yhvqsxxmovwgud", + "azureml-model-deployment": "un", "body": { "extras": { - "key7699": "gtoiwmsixgnoqt" + "key6027": "fqmhzpczqlhotdmwfzfwaiuqldptzn" }, "input": [ - "jqdzisnqggkwvnijrshupxgiumf" + "wzsxcsxmnsqosvcpblqkatcvhmibk" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "hrnxhhuclykokrdkuli", + "id": "gnsdnxipztsgfur", "data": [ { "embedding": [ - 13 + 25 ], - "index": 19, - "object": "upuylpsjuboekwxj" + "index": 8, + "object": "aubkfghzjnywzqrwphvqqjee" } ], "usage": { "capacity_type": "usage", - "input_tokens": 10, - "prompt_tokens": 27, - "total_tokens": 12 + "input_tokens": 28, + "prompt_tokens": 10, + "total_tokens": 9 }, - "object": "ur", - "model": "osqeawsibcjedoil" + "object": "nxullznlgjegnduap", + "model": "vb" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 7661e414e92e..d079288ba431 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "jcw" + "aagjoqwxc" ] } }, "responses": { "200": { "body": { - "id": "hrnxhhuclykokrdkuli", + "id": "gnsdnxipztsgfur", "data": [ { "embedding": [ - 13 + 25 ], - "index": 19, - "object": "upuylpsjuboekwxj" + "index": 8, + "object": "aubkfghzjnywzqrwphvqqjee" } ], "usage": { "capacity_type": "usage", - "input_tokens": 10, - "prompt_tokens": 27, - "total_tokens": 12 + "input_tokens": 28, + "prompt_tokens": 10, + "total_tokens": 9 }, - "object": "ur", - "model": "osqeawsibcjedoil" + "object": "nxullznlgjegnduap", + "model": "vb" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json index fef8949b9f66..edfc6382e478 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "nkbelpkxpqsbgujjbiifxylf", - "model_name": "mzyolrapnadkkp" + "model_provider": "jopdezqephtlduqodmsyglq", + "model_name": "neeuviflfymkfczaauqgsffd" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json index 68ec723eff75..d2467414c5a7 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "nkbelpkxpqsbgujjbiifxylf", - "model_name": "mzyolrapnadkkp" + "model_provider": "jopdezqephtlduqodmsyglq", + "model_name": "neeuviflfymkfczaauqgsffd" } } } diff --git a/specification/ai/ModelClient/models/image_generation.tsp b/specification/ai/ModelClient/image.generation/image_generation.tsp similarity index 100% rename from specification/ai/ModelClient/models/image_generation.tsp rename to specification/ai/ModelClient/image.generation/image_generation.tsp diff --git a/specification/ai/ModelClient/models/model_info.tsp b/specification/ai/ModelClient/models/model_info.tsp deleted file mode 100644 index 72362715e499..000000000000 --- a/specification/ai/ModelClient/models/model_info.tsp +++ /dev/null @@ -1,39 +0,0 @@ -import "@typespec/rest"; -import "@typespec/http"; - -using TypeSpec.Rest; -using TypeSpec.Http; - -namespace ModelClient; - -@doc("Represents some basic information about the AI model.") -model ModelInformation { - @doc("The type of the AI model.") - model_type: ModelType; - - @doc("The model provider.") - model_provider: string; - - @doc("The name of the AI model.") - model_name: string; -} - -@doc("The type of AI model") -union ModelType { - string, - - @doc("Embeddings.") - embeddings: "embeddings", - - @doc("Custom model.") - custom: "custom", - - @doc("Chat completions") - chat: "chat", - - @doc("Text generation") - text_generation: "text_generation", - - @doc("Image generation") - image_generation: "image_generation", -} diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 687e311c06a1..f48b6f4d8ba1 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -3,11 +3,10 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/versioning"; -import "./models/common.tsp"; -import "./models/chat_completions.tsp"; -import "./models/embeddings.tsp"; -import "./models/image_generation.tsp"; -import "./models/model_info.tsp"; +import "./common/common.tsp"; +import "./chat.completions/chat_completions.tsp"; +import "./embeddings/embeddings.tsp"; +import "./image.generation/image_generation.tsp"; using TypeSpec.Rest; using TypeSpec.Http; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json index e05b5003830b..63fa46e3e4a4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "htvqxydkekncnpymnhqsdelqgrszm", + "azureml-model-deployment": "pxmcfsjcxfzcvyyewxkqnsqpf", "body": { "extras": { - "key6365": "snsxhvtujtpjjgoqtz" + "key321": "jwfslhuxb" }, - "prompt": "dhjvogvnuftokj", - "size": "ibnfps", + "prompt": "cjyxrtpwacngidhuqlzuv", + "size": "bbrlybbmjwluntrylmwtt", "quality": "standard", "response_format": "url", - "seed": 5 + "seed": 7 } }, "responses": { "200": { "body": { - "id": "tkkvudvgguol", - "created": 2, - "model": "fuemakla", + "id": "muckxbcmxcwjqrmxq", + "created": 30, + "model": "cgoewbpodd", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "wdthgkpci" + "b64_json": "xhfksftpjmfquluclpcgrkb" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json index 3db1fc47c70d..8fb3e087f579 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "nemueodnxxxa", - "size": "fvglnzh" + "prompt": "cz", + "size": "qbipakgkikdhclywm" } }, "responses": { "200": { "body": { - "id": "tkkvudvgguol", - "created": 2, - "model": "fuemakla", + "id": "muckxbcmxcwjqrmxq", + "created": 30, + "model": "cgoewbpodd", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index bd8ca8ed554f..8c4596838cd0 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,10 +3,10 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "vgivbgwpqsdxbdfkkssnmeygifch", + "azureml-model-deployment": "duedshvpgwqtfwblxrjmfqub", "body": { "extras": { - "key4415": "yhbhukhnxzbybudhbmfwdwhxjyu" + "key7873": "qio" }, "messages": [ { @@ -14,46 +14,46 @@ } ], "frequency_penalty": -2, - "presence_penalty": -1, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "fieqqklpzxuhfhwrxjfflq" + "ypudkhkwozhaefan" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 5 + "seed": 8 } }, "responses": { "200": { "body": { - "id": "nyuhsogwugvfffagspvlkbctmhgy", - "object": "j", - "created": 20, - "model": "dwjgccoerov", + "id": "g", + "object": "rwddsayntqhjhmmvnlbmialid", + "created": 7, + "model": "l", "usage": { "capacity_type": "usage", - "completion_tokens": 4, - "prompt_tokens": 29, - "total_tokens": 24 + "completion_tokens": 24, + "prompt_tokens": 30, + "total_tokens": 27 }, "choices": [ { - "index": 27, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "yhkwlhkgmhdzzlarhdllrwtdoov", + "content": "tbjiwxsdnpvkhymgxtux", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "otfsiibjffhnnm" + "id": "wlkamr" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 4fcd7adc02a4..7e896b2eb842 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "nyuhsogwugvfffagspvlkbctmhgy", - "object": "j", - "created": 20, - "model": "dwjgccoerov", + "id": "g", + "object": "rwddsayntqhjhmmvnlbmialid", + "created": 7, + "model": "l", "usage": { "capacity_type": "usage", - "completion_tokens": 4, - "prompt_tokens": 29, - "total_tokens": 24 + "completion_tokens": 24, + "prompt_tokens": 30, + "total_tokens": 27 }, "choices": [ { - "index": 27, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "yhkwlhkgmhdzzlarhdllrwtdoov" + "content": "tbjiwxsdnpvkhymgxtux" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 522e853351f8..3b92c1cbde55 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "yhvqsxxmovwgud", + "azureml-model-deployment": "un", "body": { "extras": { - "key7699": "gtoiwmsixgnoqt" + "key6027": "fqmhzpczqlhotdmwfzfwaiuqldptzn" }, "input": [ - "jqdzisnqggkwvnijrshupxgiumf" + "wzsxcsxmnsqosvcpblqkatcvhmibk" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "hrnxhhuclykokrdkuli", + "id": "gnsdnxipztsgfur", "data": [ { "embedding": [ - 13 + 25 ], - "index": 19, - "object": "upuylpsjuboekwxj" + "index": 8, + "object": "aubkfghzjnywzqrwphvqqjee" } ], "usage": { "capacity_type": "usage", - "input_tokens": 10, - "prompt_tokens": 27, - "total_tokens": 12 + "input_tokens": 28, + "prompt_tokens": 10, + "total_tokens": 9 }, - "object": "ur", - "model": "osqeawsibcjedoil" + "object": "nxullznlgjegnduap", + "model": "vb" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 7661e414e92e..d079288ba431 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "jcw" + "aagjoqwxc" ] } }, "responses": { "200": { "body": { - "id": "hrnxhhuclykokrdkuli", + "id": "gnsdnxipztsgfur", "data": [ { "embedding": [ - 13 + 25 ], - "index": 19, - "object": "upuylpsjuboekwxj" + "index": 8, + "object": "aubkfghzjnywzqrwphvqqjee" } ], "usage": { "capacity_type": "usage", - "input_tokens": 10, - "prompt_tokens": 27, - "total_tokens": 12 + "input_tokens": 28, + "prompt_tokens": 10, + "total_tokens": 9 }, - "object": "ur", - "model": "osqeawsibcjedoil" + "object": "nxullznlgjegnduap", + "model": "vb" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index fef8949b9f66..edfc6382e478 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "nkbelpkxpqsbgujjbiifxylf", - "model_name": "mzyolrapnadkkp" + "model_provider": "jopdezqephtlduqodmsyglq", + "model_name": "neeuviflfymkfczaauqgsffd" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 68ec723eff75..d2467414c5a7 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "nkbelpkxpqsbgujjbiifxylf", - "model_name": "mzyolrapnadkkp" + "model_provider": "jopdezqephtlduqodmsyglq", + "model_name": "neeuviflfymkfczaauqgsffd" } } } From 511f2bfb9f71b5513bd7e8805f5caa259768b41a Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 12 Apr 2024 11:42:40 -0700 Subject: [PATCH 059/343] Try model folders without a dot --- .../chat_completions.tsp | 0 .../GenerateImages_MaximumSet_Gen.json | 18 +++++------ .../GenerateImages_MinimumSet_Gen.json | 10 +++---- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 +++++----- .../GetEmbeddings_MaximumSet_Gen.json | 24 +++++++-------- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++++------- .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- .../image_generation.tsp | 0 specification/ai/ModelClient/routes.tsp | 4 +-- 11 files changed, 65 insertions(+), 65 deletions(-) rename specification/ai/ModelClient/{chat.completions => chat}/chat_completions.tsp (100%) rename specification/ai/ModelClient/{image.generation => image}/image_generation.tsp (100%) diff --git a/specification/ai/ModelClient/chat.completions/chat_completions.tsp b/specification/ai/ModelClient/chat/chat_completions.tsp similarity index 100% rename from specification/ai/ModelClient/chat.completions/chat_completions.tsp rename to specification/ai/ModelClient/chat/chat_completions.tsp diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json index 63fa46e3e4a4..d5420aaffcc1 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "pxmcfsjcxfzcvyyewxkqnsqpf", + "azureml-model-deployment": "xguti", "body": { "extras": { - "key321": "jwfslhuxb" + "key1109": "srfumisjuxqumwzmscqa" }, - "prompt": "cjyxrtpwacngidhuqlzuv", - "size": "bbrlybbmjwluntrylmwtt", + "prompt": "fsntsifrbjpgciuhyyvrjdfpjalswh", + "size": "xkgsiclesfapmggylg", "quality": "standard", "response_format": "url", - "seed": 7 + "seed": 26 } }, "responses": { "200": { "body": { - "id": "muckxbcmxcwjqrmxq", - "created": 30, - "model": "cgoewbpodd", + "id": "mfwnswhimajvb", + "created": 6, + "model": "itswkx", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "xhfksftpjmfquluclpcgrkb" + "b64_json": "axd" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json index 8fb3e087f579..380225ca5406 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "cz", - "size": "qbipakgkikdhclywm" + "prompt": "qoxre", + "size": "ld" } }, "responses": { "200": { "body": { - "id": "muckxbcmxcwjqrmxq", - "created": 30, - "model": "cgoewbpodd", + "id": "mfwnswhimajvb", + "created": 6, + "model": "itswkx", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 8c4596838cd0..03e7dc407aac 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,57 +3,57 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "duedshvpgwqtfwblxrjmfqub", + "azureml-model-deployment": "ogxzwbwbqxmhxzawlewjaifoqibrl", "body": { "extras": { - "key7873": "qio" + "key8214": "ktkmtwksjy" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, - "presence_penalty": -2, + "frequency_penalty": -1, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "ypudkhkwozhaefan" + "igfzbcmqrwfpcrrxoegcyavp" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 8 + "seed": 7 } }, "responses": { "200": { "body": { - "id": "g", - "object": "rwddsayntqhjhmmvnlbmialid", - "created": 7, - "model": "l", + "id": "mtdakybxqiompj", + "object": "viwdpmnvpuawqvmbx", + "created": 5, + "model": "cysrkwdqfxsipcxo", "usage": { "capacity_type": "usage", "completion_tokens": 24, - "prompt_tokens": 30, - "total_tokens": 27 + "prompt_tokens": 6, + "total_tokens": 20 }, "choices": [ { - "index": 18, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "tbjiwxsdnpvkhymgxtux", + "content": "mjptfjjwlrjzqqbymgiwhnziwt", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "wlkamr" + "id": "c" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 7e896b2eb842..6819293fcacd 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "g", - "object": "rwddsayntqhjhmmvnlbmialid", - "created": 7, - "model": "l", + "id": "mtdakybxqiompj", + "object": "viwdpmnvpuawqvmbx", + "created": 5, + "model": "cysrkwdqfxsipcxo", "usage": { "capacity_type": "usage", "completion_tokens": 24, - "prompt_tokens": 30, - "total_tokens": 27 + "prompt_tokens": 6, + "total_tokens": 20 }, "choices": [ { - "index": 18, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "tbjiwxsdnpvkhymgxtux" + "content": "mjptfjjwlrjzqqbymgiwhnziwt" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 3b92c1cbde55..145dc160c00c 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "un", + "azureml-model-deployment": "djrdgxsueubqycsoqmjoungfsos", "body": { "extras": { - "key6027": "fqmhzpczqlhotdmwfzfwaiuqldptzn" + "key5616": "rxbiq" }, "input": [ - "wzsxcsxmnsqosvcpblqkatcvhmibk" + "knlcgpeunfmjbjtvdkzvjtm" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "gnsdnxipztsgfur", + "id": "sjpxwu", "data": [ { "embedding": [ - 25 + 21 ], - "index": 8, - "object": "aubkfghzjnywzqrwphvqqjee" + "index": 3, + "object": "oyfxaoangnehu" } ], "usage": { "capacity_type": "usage", - "input_tokens": 28, - "prompt_tokens": 10, - "total_tokens": 9 + "input_tokens": 16, + "prompt_tokens": 18, + "total_tokens": 15 }, - "object": "nxullznlgjegnduap", - "model": "vb" + "object": "kkwiicznbj", + "model": "lyojlkvvapvymd" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index d079288ba431..7d4be700a0d6 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "aagjoqwxc" + "pqumsrbfxq" ] } }, "responses": { "200": { "body": { - "id": "gnsdnxipztsgfur", + "id": "sjpxwu", "data": [ { "embedding": [ - 25 + 21 ], - "index": 8, - "object": "aubkfghzjnywzqrwphvqqjee" + "index": 3, + "object": "oyfxaoangnehu" } ], "usage": { "capacity_type": "usage", - "input_tokens": 28, - "prompt_tokens": 10, - "total_tokens": 9 + "input_tokens": 16, + "prompt_tokens": 18, + "total_tokens": 15 }, - "object": "nxullznlgjegnduap", - "model": "vb" + "object": "kkwiicznbj", + "model": "lyojlkvvapvymd" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json index edfc6382e478..667aae7bc22c 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "jopdezqephtlduqodmsyglq", - "model_name": "neeuviflfymkfczaauqgsffd" + "model_provider": "xsgza", + "model_name": "ubqwngwiluncsjoudcrmohisjfavn" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json index d2467414c5a7..2f10a102e0dc 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "jopdezqephtlduqodmsyglq", - "model_name": "neeuviflfymkfczaauqgsffd" + "model_provider": "xsgza", + "model_name": "ubqwngwiluncsjoudcrmohisjfavn" } } } diff --git a/specification/ai/ModelClient/image.generation/image_generation.tsp b/specification/ai/ModelClient/image/image_generation.tsp similarity index 100% rename from specification/ai/ModelClient/image.generation/image_generation.tsp rename to specification/ai/ModelClient/image/image_generation.tsp diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index f48b6f4d8ba1..981c0f8dfe31 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -4,9 +4,9 @@ import "@typespec/http"; import "@typespec/versioning"; import "./common/common.tsp"; -import "./chat.completions/chat_completions.tsp"; +import "./chat/chat_completions.tsp"; import "./embeddings/embeddings.tsp"; -import "./image.generation/image_generation.tsp"; +import "./image/image_generation.tsp"; using TypeSpec.Rest; using TypeSpec.Http; From 78e7193dec65e6ee806ed71337064a5f334966c4 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 12 Apr 2024 13:06:40 -0700 Subject: [PATCH 060/343] Move models back into the models folder --- .../GenerateImages_MaximumSet_Gen.json | 18 +++++------ .../GenerateImages_MinimumSet_Gen.json | 10 +++--- .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++++-------- .../GetChatCompletions_MinimumSet_Gen.json | 16 +++++----- .../GetEmbeddings_MaximumSet_Gen.json | 24 +++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 20 ++++++------ .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- .../{chat => models}/chat_completions.tsp | 0 .../ModelClient/{common => models}/common.tsp | 0 .../{embeddings => models}/embeddings.tsp | 0 .../{image => models}/image_generation.tsp | 0 specification/ai/ModelClient/routes.tsp | 8 ++--- .../GenerateImages_MaximumSet_Gen.json | 18 +++++------ .../GenerateImages_MinimumSet_Gen.json | 10 +++--- .../GetChatCompletions_MaximumSet_Gen.json | 32 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 22 ++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 18 +++++------ .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +-- 21 files changed, 128 insertions(+), 128 deletions(-) rename specification/ai/ModelClient/{chat => models}/chat_completions.tsp (100%) rename specification/ai/ModelClient/{common => models}/common.tsp (100%) rename specification/ai/ModelClient/{embeddings => models}/embeddings.tsp (100%) rename specification/ai/ModelClient/{image => models}/image_generation.tsp (100%) diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json index d5420aaffcc1..5e82daa152f6 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "xguti", + "azureml-model-deployment": "ksleredmpxxh", "body": { "extras": { - "key1109": "srfumisjuxqumwzmscqa" + "key1229": "yvmhauqrswyvfg" }, - "prompt": "fsntsifrbjpgciuhyyvrjdfpjalswh", - "size": "xkgsiclesfapmggylg", + "prompt": "rjwzvwaukiavqeqnyuifvxftbinpbh", + "size": "agjbhdpgwhcofiixq", "quality": "standard", "response_format": "url", - "seed": 26 + "seed": 27 } }, "responses": { "200": { "body": { - "id": "mfwnswhimajvb", - "created": 6, - "model": "itswkx", + "id": "c", + "created": 28, + "model": "tybattpnvyhhusahurlfdaawt", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "axd" + "b64_json": "awjfdxadcurpzmapofopn" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json index 380225ca5406..ebd88ef57ea5 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "qoxre", - "size": "ld" + "prompt": "rzosjkuhxnykplq", + "size": "wkbw" } }, "responses": { "200": { "body": { - "id": "mfwnswhimajvb", - "created": 6, - "model": "itswkx", + "id": "c", + "created": 28, + "model": "tybattpnvyhhusahurlfdaawt", "data": [ {} ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json index 03e7dc407aac..b0899b98e068 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,10 +3,10 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "ogxzwbwbqxmhxzawlewjaifoqibrl", + "azureml-model-deployment": "muwjnj", "body": { "extras": { - "key8214": "ktkmtwksjy" + "key6826": "niltykdjbwfkbnujcfypzffhtpx" }, "messages": [ { @@ -14,13 +14,13 @@ } ], "frequency_penalty": -1, - "presence_penalty": 0, + "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "igfzbcmqrwfpcrrxoegcyavp" + "jntnucydlgvohzozgjq" ], "tools": [ { @@ -33,27 +33,27 @@ "responses": { "200": { "body": { - "id": "mtdakybxqiompj", - "object": "viwdpmnvpuawqvmbx", - "created": 5, - "model": "cysrkwdqfxsipcxo", + "id": "ssz", + "object": "ikerfo", + "created": 8, + "model": "x", "usage": { "capacity_type": "usage", - "completion_tokens": 24, + "completion_tokens": 7, "prompt_tokens": 6, - "total_tokens": 20 + "total_tokens": 11 }, "choices": [ { - "index": 12, + "index": 16, "finish_reason": "stop", "message": { "role": "system", - "content": "mjptfjjwlrjzqqbymgiwhnziwt", + "content": "nuqiefesdnlfhwo", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "c" + "id": "pbccsrumrhb" } ] } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json index 6819293fcacd..31158d4ae449 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "mtdakybxqiompj", - "object": "viwdpmnvpuawqvmbx", - "created": 5, - "model": "cysrkwdqfxsipcxo", + "id": "ssz", + "object": "ikerfo", + "created": 8, + "model": "x", "usage": { "capacity_type": "usage", - "completion_tokens": 24, + "completion_tokens": 7, "prompt_tokens": 6, - "total_tokens": 20 + "total_tokens": 11 }, "choices": [ { - "index": 12, + "index": 16, "finish_reason": "stop", "message": { "role": "system", - "content": "mjptfjjwlrjzqqbymgiwhnziwt" + "content": "nuqiefesdnlfhwo" } } ] diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json index 145dc160c00c..dab618953f78 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "djrdgxsueubqycsoqmjoungfsos", + "azureml-model-deployment": "ymunuuwoddcrfydwmzpgntuuqxwk", "body": { "extras": { - "key5616": "rxbiq" + "key8593": "b" }, "input": [ - "knlcgpeunfmjbjtvdkzvjtm" + "ysmhrgaavdoufdlkrccu" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "sjpxwu", + "id": "bn", "data": [ { "embedding": [ - 21 + 3 ], - "index": 3, - "object": "oyfxaoangnehu" + "index": 15, + "object": "xuppwipfglvlykmpxkvf" } ], "usage": { "capacity_type": "usage", - "input_tokens": 16, - "prompt_tokens": 18, - "total_tokens": 15 + "input_tokens": 14, + "prompt_tokens": 19, + "total_tokens": 9 }, - "object": "kkwiicznbj", - "model": "lyojlkvvapvymd" + "object": "ff", + "model": "stjiawdlzl" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json index 7d4be700a0d6..27faa1cc5cd4 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "pqumsrbfxq" + "valclauxppvqrgdtykxizlmmhteo" ] } }, "responses": { "200": { "body": { - "id": "sjpxwu", + "id": "bn", "data": [ { "embedding": [ - 21 + 3 ], - "index": 3, - "object": "oyfxaoangnehu" + "index": 15, + "object": "xuppwipfglvlykmpxkvf" } ], "usage": { "capacity_type": "usage", - "input_tokens": 16, - "prompt_tokens": 18, - "total_tokens": 15 + "input_tokens": 14, + "prompt_tokens": 19, + "total_tokens": 9 }, - "object": "kkwiicznbj", - "model": "lyojlkvvapvymd" + "object": "ff", + "model": "stjiawdlzl" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json index 667aae7bc22c..5988c3f1e6b4 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "xsgza", - "model_name": "ubqwngwiluncsjoudcrmohisjfavn" + "model_provider": "cvtoxkgb", + "model_name": "eblflvqrlwamgadqsl" } } } diff --git a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json index 2f10a102e0dc..e5fe84f6593d 100644 --- a/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-04-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "xsgza", - "model_name": "ubqwngwiluncsjoudcrmohisjfavn" + "model_provider": "cvtoxkgb", + "model_name": "eblflvqrlwamgadqsl" } } } diff --git a/specification/ai/ModelClient/chat/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp similarity index 100% rename from specification/ai/ModelClient/chat/chat_completions.tsp rename to specification/ai/ModelClient/models/chat_completions.tsp diff --git a/specification/ai/ModelClient/common/common.tsp b/specification/ai/ModelClient/models/common.tsp similarity index 100% rename from specification/ai/ModelClient/common/common.tsp rename to specification/ai/ModelClient/models/common.tsp diff --git a/specification/ai/ModelClient/embeddings/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp similarity index 100% rename from specification/ai/ModelClient/embeddings/embeddings.tsp rename to specification/ai/ModelClient/models/embeddings.tsp diff --git a/specification/ai/ModelClient/image/image_generation.tsp b/specification/ai/ModelClient/models/image_generation.tsp similarity index 100% rename from specification/ai/ModelClient/image/image_generation.tsp rename to specification/ai/ModelClient/models/image_generation.tsp diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 981c0f8dfe31..0eaad761d391 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -3,10 +3,10 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/versioning"; -import "./common/common.tsp"; -import "./chat/chat_completions.tsp"; -import "./embeddings/embeddings.tsp"; -import "./image/image_generation.tsp"; +import "./models/common.tsp"; +import "./models/chat_completions.tsp"; +import "./models/image_generation.tsp"; +import "./models/embeddings.tsp"; using TypeSpec.Rest; using TypeSpec.Http; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json index 63fa46e3e4a4..5e82daa152f6 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MaximumSet_Gen.json @@ -3,28 +3,28 @@ "operationId": "GenerateImages", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "pxmcfsjcxfzcvyyewxkqnsqpf", + "azureml-model-deployment": "ksleredmpxxh", "body": { "extras": { - "key321": "jwfslhuxb" + "key1229": "yvmhauqrswyvfg" }, - "prompt": "cjyxrtpwacngidhuqlzuv", - "size": "bbrlybbmjwluntrylmwtt", + "prompt": "rjwzvwaukiavqeqnyuifvxftbinpbh", + "size": "agjbhdpgwhcofiixq", "quality": "standard", "response_format": "url", - "seed": 7 + "seed": 27 } }, "responses": { "200": { "body": { - "id": "muckxbcmxcwjqrmxq", - "created": 30, - "model": "cgoewbpodd", + "id": "c", + "created": 28, + "model": "tybattpnvyhhusahurlfdaawt", "data": [ { "url": "https://microsoft.com/a", - "b64_json": "xhfksftpjmfquluclpcgrkb" + "b64_json": "awjfdxadcurpzmapofopn" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json index 8fb3e087f579..ebd88ef57ea5 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GenerateImages_MinimumSet_Gen.json @@ -4,16 +4,16 @@ "parameters": { "api-version": "2024-04-01-preview", "body": { - "prompt": "cz", - "size": "qbipakgkikdhclywm" + "prompt": "rzosjkuhxnykplq", + "size": "wkbw" } }, "responses": { "200": { "body": { - "id": "muckxbcmxcwjqrmxq", - "created": 30, - "model": "cgoewbpodd", + "id": "c", + "created": 28, + "model": "tybattpnvyhhusahurlfdaawt", "data": [ {} ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 8c4596838cd0..b0899b98e068 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,57 +3,57 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "duedshvpgwqtfwblxrjmfqub", + "azureml-model-deployment": "muwjnj", "body": { "extras": { - "key7873": "qio" + "key6826": "niltykdjbwfkbnujcfypzffhtpx" }, "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, - "presence_penalty": -2, + "frequency_penalty": -1, + "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "ypudkhkwozhaefan" + "jntnucydlgvohzozgjq" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 8 + "seed": 7 } }, "responses": { "200": { "body": { - "id": "g", - "object": "rwddsayntqhjhmmvnlbmialid", - "created": 7, - "model": "l", + "id": "ssz", + "object": "ikerfo", + "created": 8, + "model": "x", "usage": { "capacity_type": "usage", - "completion_tokens": 24, - "prompt_tokens": 30, - "total_tokens": 27 + "completion_tokens": 7, + "prompt_tokens": 6, + "total_tokens": 11 }, "choices": [ { - "index": 18, + "index": 16, "finish_reason": "stop", "message": { "role": "system", - "content": "tbjiwxsdnpvkhymgxtux", + "content": "nuqiefesdnlfhwo", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "wlkamr" + "id": "pbccsrumrhb" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 7e896b2eb842..31158d4ae449 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,23 +14,23 @@ "responses": { "200": { "body": { - "id": "g", - "object": "rwddsayntqhjhmmvnlbmialid", - "created": 7, - "model": "l", + "id": "ssz", + "object": "ikerfo", + "created": 8, + "model": "x", "usage": { "capacity_type": "usage", - "completion_tokens": 24, - "prompt_tokens": 30, - "total_tokens": 27 + "completion_tokens": 7, + "prompt_tokens": 6, + "total_tokens": 11 }, "choices": [ { - "index": 18, + "index": 16, "finish_reason": "stop", "message": { "role": "system", - "content": "tbjiwxsdnpvkhymgxtux" + "content": "nuqiefesdnlfhwo" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 3b92c1cbde55..dab618953f78 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,13 +3,13 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-04-01-preview", - "azureml-model-deployment": "un", + "azureml-model-deployment": "ymunuuwoddcrfydwmzpgntuuqxwk", "body": { "extras": { - "key6027": "fqmhzpczqlhotdmwfzfwaiuqldptzn" + "key8593": "b" }, "input": [ - "wzsxcsxmnsqosvcpblqkatcvhmibk" + "ysmhrgaavdoufdlkrccu" ], "input_type": "text" } @@ -17,24 +17,24 @@ "responses": { "200": { "body": { - "id": "gnsdnxipztsgfur", + "id": "bn", "data": [ { "embedding": [ - 25 + 3 ], - "index": 8, - "object": "aubkfghzjnywzqrwphvqqjee" + "index": 15, + "object": "xuppwipfglvlykmpxkvf" } ], "usage": { "capacity_type": "usage", - "input_tokens": 28, - "prompt_tokens": 10, + "input_tokens": 14, + "prompt_tokens": 19, "total_tokens": 9 }, - "object": "nxullznlgjegnduap", - "model": "vb" + "object": "ff", + "model": "stjiawdlzl" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index d079288ba431..27faa1cc5cd4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,31 +5,31 @@ "api-version": "2024-04-01-preview", "body": { "input": [ - "aagjoqwxc" + "valclauxppvqrgdtykxizlmmhteo" ] } }, "responses": { "200": { "body": { - "id": "gnsdnxipztsgfur", + "id": "bn", "data": [ { "embedding": [ - 25 + 3 ], - "index": 8, - "object": "aubkfghzjnywzqrwphvqqjee" + "index": 15, + "object": "xuppwipfglvlykmpxkvf" } ], "usage": { "capacity_type": "usage", - "input_tokens": 28, - "prompt_tokens": 10, + "input_tokens": 14, + "prompt_tokens": 19, "total_tokens": 9 }, - "object": "nxullznlgjegnduap", - "model": "vb" + "object": "ff", + "model": "stjiawdlzl" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index edfc6382e478..5988c3f1e6b4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "jopdezqephtlduqodmsyglq", - "model_name": "neeuviflfymkfczaauqgsffd" + "model_provider": "cvtoxkgb", + "model_name": "eblflvqrlwamgadqsl" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index d2467414c5a7..e5fe84f6593d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -8,8 +8,8 @@ "200": { "body": { "model_type": "embeddings", - "model_provider": "jopdezqephtlduqodmsyglq", - "model_name": "neeuviflfymkfczaauqgsffd" + "model_provider": "cvtoxkgb", + "model_name": "eblflvqrlwamgadqsl" } } } From 5f6a8a4fa74662a0814774a54f3118c601857e0a Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 6 May 2024 15:09:51 -0700 Subject: [PATCH 061/343] Fix typo --- specification/ai/ModelClient/models/embeddings.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index 46481717b941..f536f7840408 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -75,7 +75,7 @@ model EmbeddingsUsage { input_tokens: int32; @doc(""" - Number of tokens used for the prompt sent to the AI model. Typically identical to`input_tokens`. + Number of tokens used for the prompt sent to the AI model. Typically identical to `input_tokens`. However, certain AI models may add extra tokens to the input hence the number can be higher. (for example when input_type="query"). """) From bb3d704e0c28cfc61ec003f043df332c154f5146 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 6 May 2024 16:02:36 -0700 Subject: [PATCH 062/343] Fix openapi.json --- .../ModelClient/preview/2024-04-01-preview/openapi.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json index c6c115043c24..6c10dda45d2e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-04-01-preview/openapi.json @@ -1018,7 +1018,7 @@ "prompt_tokens": { "type": "integer", "format": "int32", - "description": "Number of tokens used for the prompt sent to the AI model. Typically identical to`input_tokens`.\nHowever, certain AI models may add extra tokens to the input hence the number can be higher.\n(for example when input_type=\"query\")." + "description": "Number of tokens used for the prompt sent to the AI model. Typically identical to `input_tokens`.\nHowever, certain AI models may add extra tokens to the input hence the number can be higher.\n(for example when input_type=\"query\")." }, "total_tokens": { "type": "integer", From 85197a8ac03b83614b7265c1d7d087af267a91fd Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 6 May 2024 17:12:24 -0700 Subject: [PATCH 063/343] Suppress IntegerTypeMustHaveFormat --- specification/ai/data-plane/ModelClient/readme.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/ai/data-plane/ModelClient/readme.md b/specification/ai/data-plane/ModelClient/readme.md index 8b0733d3bf71..8b8973b22e9f 100644 --- a/specification/ai/data-plane/ModelClient/readme.md +++ b/specification/ai/data-plane/ModelClient/readme.md @@ -37,6 +37,16 @@ These settings apply only when `--tag=package-2024-04-01-preview` is specified o input-file: - preview/2024-04-01-preview/openapi.json ``` + +## Suppression + +``` yaml +directive: + - suppress: IntegerTypeMustHaveFormat + from: openapi.json + reason: We are using the format "unixtime" which is not supported by linter at the moment. +``` + \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationTag.json new file mode 100644 index 000000000000..066bacf9a0fc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationTag.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "operationId": "59d6bb8f1f7fab13dc67ec9a", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiPolicy.json new file mode 100644 index 000000000000..231e577f53bc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiPolicy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b59475ff190048040001", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRelease.json new file mode 100644 index 000000000000..42e80bbf5131 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRelease.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "5a7cb545298324c53224a799", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "updatedDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRevision.json new file mode 100644 index 000000000000..aaac0d655a04 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRevision.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api;rev=3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=3", + "properties": { + "displayName": "Service", + "apiRevision": "3", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "fixed bug in contract" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiSchema.json new file mode 100644 index 000000000000..48846cfacaba --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiSchema.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTag.json new file mode 100644 index 000000000000..3ebc6b9f08f5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTagDescription.json new file mode 100644 index 000000000000..18f9839115a8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTagDescription.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagDescriptionId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/tagDescriptions/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "displayName": "tag1", + "description": null, + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiVersionSet.json new file mode 100644 index 000000000000..bec4cb30047b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiVersionSet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "vs1", + "properties": { + "displayName": "Version Set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiWiki.json new file mode 100644 index 000000000000..47306235837c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiWiki.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorization.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorization.json new file mode 100644 index 000000000000..c9f3dcf188d8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorization.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "status": "Connected" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json new file mode 100644 index 000000000000..830e8a3d349b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1", + "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json new file mode 100644 index 000000000000..71aab04d8668 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1", + "parameters": { + "postLoginRedirectUrl": "https://www.bing.com/" + } + }, + "responses": { + "200": { + "body": { + "loginLink": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1/login?data=eyJMb2dpbklkIjoiY2YtODNmYzQ5N2YyZWYxNDA4MzlmNDdjZDU3YWY3MmZmODctYW5nYW50aS1wcmV2aWV3X2FhZC1hdXRoY29kZV9vYXV0aDItY29kZV90b2tlbiIsIlNlc3Npb25JZCI6IiIsIkxvZ0Nvbm5lY3Rpb25JZCI6ImF1dGh6MiIsIkxvZ0Nvbm5lY3RvcklkIjoiYWFkLWF1dGhjb2RlIiwiTG9nRW52aXJvbm1lbnRJZCI6ImFuZ2FudGktcHJld" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationProvider.json new file mode 100644 index 000000000000..4848c41e70ce --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationProvider.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "aadwithauthcode", + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", + "scopes": "User.Read.All Group.Read.All", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "tenantId": "common" + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationServer.json new file mode 100644 index 000000000000..bfc481adb31c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationServer.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authsid": "newauthServer2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer2", + "properties": { + "displayName": "test3", + "useInTestConsole": false, + "useInApiDocumentation": true, + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "clientAuthenticationMethod": [ + "Basic" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetBackend.json new file mode 100644 index 000000000000..eb1f97c1b23f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetBackend.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "backendId": "sfbackend" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCache.json new file mode 100644 index 000000000000..2d6e41e63c19 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCache.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "cacheId": "c1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "type": "Microsoft.ApiManagement/service/caches", + "name": "c1", + "properties": { + "useFromLocation": "default", + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificate.json new file mode 100644 index 000000000000..1d90cf8fecb5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "templateCert1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCert1", + "properties": { + "subject": "CN=mutual-authcert", + "thumbprint": "EBA**********************8594A6", + "expirationDate": "2017-04-23T17:03:41Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json new file mode 100644 index 000000000000..ef67ddb8bdad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "templateCertkv" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentType.json new file mode 100644 index 000000000000..6140bb9ead43 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentType.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/contentTypes/page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "name": "page", + "properties": { + "name": "Page", + "description": "A regular page", + "schema": { + "properties": { + "en_us": { + "type": "object", + "properties": { + "title": { + "title": "Title", + "description": "Page title. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "description": { + "title": "Description", + "description": "Page description. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "keywords": { + "title": "Keywords", + "description": "Page keywords. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "permalink": { + "title": "Permalink", + "description": "Page permalink, e.g. '/about'.", + "type": "string", + "indexed": true + }, + "documentId": { + "title": "Document ID", + "description": "Reference to page content document.", + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "title", + "permalink", + "documentId" + ] + } + }, + "additionalProperties": false + }, + "version": "1.0.0" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentTypeContentItem.json new file mode 100644 index 000000000000..1096a810d80e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentTypeContentItem.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8" + }, + "responses": { + "200": { + "body": { + "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "properties": { + "en_us": { + "title": "About", + "description": "Short story about the company.", + "keywords": "company, about", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "permalink": "/about" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDeletedServiceByName.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDeletedServiceByName.json new file mode 100644 index 000000000000..338bd9938e55 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDeletedServiceByName.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService3", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", + "name": "apimService3", + "type": "Microsoft.ApiManagement/deletedservices", + "location": "West US", + "properties": { + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3", + "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", + "deletionDate": "2017-05-27T15:33:55.5426123Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDiagnostic.json new file mode 100644 index 000000000000..17e9c397ad7f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDiagnostic.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDocumentation.json new file mode 100644 index 000000000000..c948fe608faa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDocumentation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "documentationId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "name": "57d1f7558aa04f15146d9d8a", + "properties": { + "title": "Title", + "content": "content" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGateway.json new file mode 100644 index 000000000000..46db91e995db --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGateway.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "type": "Microsoft.ApiManagement/service/gateways", + "name": "a1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json new file mode 100644 index 000000000000..e0a045885e00 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "certificateId": "cert1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "name": "cert1", + "properties": { + "isTrusted": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayConfigConnection.json new file mode 100644 index 000000000000..5f3dec635217 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayConfigConnection.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayName": "standard-gw-01", + "configConnectionName": "gcc-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", + "name": "gcc-1", + "type": "Microsoft.ApiManagement/gateways/configConnections", + "etag": "AAAAAAAWN/4=", + "properties": { + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001", + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json new file mode 100644 index 000000000000..5490fa0081e9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "hcId": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "name": "default", + "properties": { + "hostname": "*", + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "negotiateClientCertificate": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema1.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema1.json new file mode 100644 index 000000000000..40212becc172 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema1.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schemaId": "schema1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema2.json new file mode 100644 index 000000000000..9df63055f4ab --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema2.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schemaId": "schema2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema2", + "properties": { + "description": "sample schema description", + "schemaType": "json", + "document": { + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Person", + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + }, + "age": { + "description": "Age in years which must be equal to or greater than zero.", + "type": "integer", + "minimum": 0 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolver.json new file mode 100644 index 000000000000..64b8de6aac0c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolver.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "resolverId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "Query Users", + "path": "Query/users", + "description": "A GraphQL Resolver example" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json new file mode 100644 index 000000000000..63d263d5117d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b539c53f5b0062040001", + "resolverId": "5600b53ac53f5b0062080006", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/resolvers/5600b53ac53f5b0062080006/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGroup.json new file mode 100644 index 000000000000..81b6a62d753c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGroup.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/groups", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "description": "awesome group of people", + "builtIn": false, + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIdentityProvider.json new file mode 100644 index 000000000000..ef225e74b78e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIdentityProvider.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "identityProviderName": "aadB2C" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "AadB2C", + "properties": { + "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5", + "type": "aadB2C", + "authority": "login.microsoftonline.com", + "signinTenant": "contosoaadb2c.onmicrosoft.com", + "allowedTenants": [ + "contosoaadb2c.onmicrosoft.com", + "contoso2aadb2c.onmicrosoft.com" + ], + "signupPolicyName": "B2C_1_policy-signup", + "signinPolicyName": "B2C_1_policy-signin" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIssue.json new file mode 100644 index 000000000000..4942290a5318 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIssue.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetLogger.json new file mode 100644 index 000000000000..e85d7752985a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetLogger.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "loggerId": "templateLogger" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/kloudapilogger1", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "kloudapilogger1", + "properties": { + "loggerType": "azureEventHub", + "description": "testeventhub3again", + "credentials": { + "name": "testeventhub4", + "connectionString": "Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************" + }, + "isBuffered": true, + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValue.json new file mode 100644 index 000000000000..18a63dffd478 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValue.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testarmTemplateproperties2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testarmTemplateproperties2", + "properties": { + "displayName": "propName", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json new file mode 100644 index 000000000000..4a9ba5318ca1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testprop6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNotification.json new file mode 100644 index 000000000000..5f7a8db3c9c3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNotification.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "RequestPublisherNotificationMessage", + "properties": { + "title": "Subscription requests (requiring approval)", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json new file mode 100644 index 000000000000..3f9362d7490f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "opid": "templateOpenIdConnect2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect2", + "properties": { + "displayName": "templateoidprovider2", + "description": "open id provider template2", + "metadataEndpoint": "https://oidprovider-template2.net", + "clientId": "oidprovidertemplate2", + "useInTestConsole": false, + "useInApiDocumentation": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationResult.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationResult.json new file mode 100644 index 000000000000..73a5971641c7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationResult.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "operationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "westus2" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/locations/westus2/operationResults/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?api-version=2023-09-01-preview" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationStatus.json new file mode 100644 index 000000000000..8b5602cda538 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationStatus.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "operationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "testLocation" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicy.json new file mode 100644 index 000000000000..47684433be3f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicy.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFormat.json new file mode 100644 index 000000000000..1f55da178ca7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFormat.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyId": "policy", + "format": "rawxml" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "format": "rawxml", + "value": "\r\n\r\n\t\r\n\t\t\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\r\n\t\r\n\t\r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragment.json new file mode 100644 index 000000000000..8543fcfac121 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragment.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "id": "policyFragment1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json new file mode 100644 index 000000000000..17b4e49aa007 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "id": "policyFragment1", + "format": "rawxml" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "rawxml", + "description": "A policy fragment example", + "value": "\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyRestriction.json new file mode 100644 index 000000000000..938225e138e8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyRestriction.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyRestrictionId": "policyRestriction1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "name": "policyRestriction1", + "properties": { + "scope": "Sample Path to the policy document.", + "requireBase": "true" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPortalRevision.json new file mode 100644 index 000000000000..18e314d74e14 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPortalRevision.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "portalRevisionId": "20201112101010" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "name": "20201112101010", + "properties": { + "description": "portal revision 1", + "statusDetails": null, + "status": "completed", + "isCurrent": true, + "createdDateTime": "2020-11-12T22:51:36.47Z", + "updatedDateTime": "2020-11-12T22:52:00.097Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..6723a957d4a6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateEndpointConnectionName": "privateEndpointConnectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "name": "privateEndpointProxyName", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request, thanks", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json new file mode 100644 index 000000000000..46850aaabeca --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateLinkSubResourceName": "privateLinkSubResourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", + "name": "Gateway", + "type": "Microsoft.ApiManagement/service/privateLinkResources", + "properties": { + "groupId": "Gateway", + "requiredMembers": [ + "Gateway" + ], + "requiredZoneNames": [ + "privateLink.azure-api.net" + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProduct.json new file mode 100644 index 000000000000..6209a155bff1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProduct.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "unlimited" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", + "type": "Microsoft.ApiManagement/service/products", + "name": "unlimited", + "properties": { + "displayName": "Unlimited", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductApiLink.json new file mode 100644 index 000000000000..5f18ccf67704 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductApiLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "apiLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductGroupLink.json new file mode 100644 index 000000000000..9b891be98a91 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductGroupLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "groupLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinks/link1", + "type": "Microsoft.ApiManagement/service/products/groupLinks", + "name": "link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductPolicy.json new file mode 100644 index 000000000000..ae20c0dd95c1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductPolicy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "kjoshiarmTemplateProduct4", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmTemplateProduct4/policies/policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductTag.json new file mode 100644 index 000000000000..194e05406a1d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductWiki.json new file mode 100644 index 000000000000..efe7d2a9efd4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductWiki.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeys.json new file mode 100644 index 000000000000..afbac20a311e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeys.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "quotaCounterKey": "ba" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "counterKey": "ba", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "periodEndTime": "2018-02-08T16:54:40Z", + "value": { + "callsCount": 5, + "kbTransferred": 2.5830078125 + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json new file mode 100644 index 000000000000..0fb607af8fac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "quotaCounterKey": "ba", + "quotaPeriodKey": "0_P3Y6M4DT12H30M5S" + }, + "responses": { + "200": { + "body": { + "counterKey": "ba", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "periodEndTime": "2018-02-08T16:54:40Z", + "value": { + "callsCount": 0, + "kbTransferred": 2.5625 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByApi.json new file mode 100644 index 000000000000..fdce8e383d6b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByApi.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Echo API", + "apiId": "/apis/5600b59475ff190048040001", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "httpbin", + "apiId": "/apis/57a03a13e4bbd5119c8b19e9", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByGeo.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByGeo.json new file mode 100644 index 000000000000..34d9b8183401 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByGeo.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "country": "US", + "region": "WA", + "zip": "98052", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByOperation.json new file mode 100644 index 000000000000..3063ebfb2484 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByOperation.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "get", + "apiId": "/apis/57a03a13e4bbd5119c8b19e9", + "operationId": "/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + }, + { + "name": "GetWeatherInformation", + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "GetCityForecastByZIP", + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByProduct.json new file mode 100644 index 000000000000..ba0854f61dd0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByProduct.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Starter", + "productId": "/products/5600b59475ff190048060001", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "Unlimited", + "productId": "/products/5600b59475ff190048060002", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByRequest.json new file mode 100644 index 000000000000..47f3c514f7f4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByRequest.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", + "productId": "/products/-", + "userId": "/users/1", + "method": "GET", + "url": "https://apimService1.azure-api.net/echo/resource?param1=sample", + "ipAddress": "207.xx.155.xx", + "responseCode": 404, + "responseSize": 405, + "timestamp": "2017-06-03T00:17:00.1649134Z", + "cache": "none", + "apiTime": 221.1544, + "serviceTime": 0.0, + "apiRegion": "East Asia", + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "requestId": "63e7119c-26aa-433c-96d7-f6f3267ff52f", + "requestSize": 0 + }, + { + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", + "productId": "/products/-", + "userId": "/users/1", + "method": "POST", + "url": "https://apimService1.azure-api.net/echo/resource", + "ipAddress": "207.xx.155.xx", + "responseCode": 404, + "responseSize": 403, + "timestamp": "2017-06-03T00:17:20.5255131Z", + "cache": "none", + "apiTime": 6.6754000000000007, + "serviceTime": 0.0, + "apiRegion": "East Asia", + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04", + "requestSize": 0 + } + ], + "count": 2 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsBySubscription.json new file mode 100644 index 000000000000..ee253698eca7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsBySubscription.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "userId": "/users/1", + "productId": "/products/5600b59475ff190048060001", + "subscriptionId": "/subscriptions/5600b59475ff190048070001", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "", + "userId": "/users/1", + "productId": "/products/5600b59475ff190048060002", + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + }, + { + "name": "", + "userId": "/users/1", + "productId": "/products/5702e97e5157a50f48dce801", + "subscriptionId": "/subscriptions/5702e97e5157a50a9c733303", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByTime.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByTime.json new file mode 100644 index 000000000000..c6b7f3967f9a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByTime.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "interval": "PT15M" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timestamp": "2017-06-03T00:15:00Z", + "interval": "PT15M", + "callCountSuccess": 4, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 4, + "bandwidth": 3243, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1337.46335, + "apiTimeMin": 885.0839000000001, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 1255.917425, + "serviceTimeMin": 882.8264, + "serviceTimeMax": 1697.3612 + }, + { + "timestamp": "2017-06-03T00:30:00Z", + "interval": "PT15M", + "callCountSuccess": 9, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 10, + "bandwidth": 7776, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 872.7818777777778, + "apiTimeMin": 330.3206, + "apiTimeMax": 1093.8407, + "serviceTimeAvg": 824.2847111111112, + "serviceTimeMin": 215.24, + "serviceTimeMax": 973.2262000000001 + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByUser.json new file mode 100644 index 000000000000..fb685c5fc7de --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByUser.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Administrator", + "userId": "/users/1", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + }, + { + "name": "Samir Solanki", + "userId": "/users/56eaec62baf08b06e46d27fd", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "Anonymous", + "userId": "/users/54c800b332965a0035030000", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetSubscription.json new file mode 100644 index 000000000000..bac62817ea72 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetSubscription.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sid": "5931a769d8d14f0ad8ce13b8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "5931a769d8d14f0ad8ce13b8", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "Unlimited", + "state": "submitted", + "createdDate": "2017-06-02T17:59:06.223Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTag.json new file mode 100644 index 000000000000..9172f41f4626 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTag.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagApiLink.json new file mode 100644 index 000000000000..11542720819a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagApiLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "apiLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagOperationLink.json new file mode 100644 index 000000000000..bb46ad66a0d8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagOperationLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "operationLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "name": "link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagProductLink.json new file mode 100644 index 000000000000..a59f4589c29d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagProductLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "productLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "name": "link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTemplate.json new file mode 100644 index 000000000000..bcd129ab1045 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTemplate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "NewIssueNotificationMessage", + "properties": { + "subject": "Your request $IssueName was received", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

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

\r\n

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

\r\n

Best,

\r\n

The $OrganizationName API Team

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

Dear $DevFirstName $DevLastName,

\r\n

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

\r\n

Best,

\r\n

The $OrganizationName API Team

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

Dear $DevFirstName $DevLastName,

\r\n

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

\r\n

Best,

\r\n

The $OrganizationName API Team

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

Dear $DevFirstName $DevLastName,

\r\n

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

\r\n

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

\r\n

Best,

\r\n

The $OrganizationName API Team

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

Legal Terms

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

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

Legal Terms

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

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

Legal Terms

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

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

Legal Terms

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

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

Legal Terms

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

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

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

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

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

Come one guys, lets go for lunch together.

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

Come one guys, lets go for lunch together.

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

This place for lunch? 

\r\n

\"image\"

", + "attachments": [ + { + "id": "0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73", + "attachmentType": "image", + "name": "image", + "url": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/original?api-version=2023-07-01-preview", + "previewUrl": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages/1700844519132/teamsInterop/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/small?api-version=2023-07-01-preview" + } + ] + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:37.6830000Z", + "metadata": { + "amsreferences": "[\"0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73\"]" + }, + "senderCommunicationIdentifier": { + "rawId": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "id": "1593107077683", + "type": "text", + "sequenceId": "4", + "version": "1593107077683", + "content": { + "message": "Let's use this chat to decide what to get for lunch today." + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:37.6830000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "id": "1593107046498", + "type": "text", + "sequenceId": "3", + "version": "1593107046498", + "content": { + "message": "Good morning everyone!" + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:06.4980000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "id": "1593106976785", + "type": "topicUpdated", + "sequenceId": "2", + "version": "1593106976785", + "content": { + "initiatorCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "topic": "Lunch" + }, + "createdOn": "2020-06-25T17:42:56.7850000Z" + }, + { + "id": "1593106976753", + "type": "participantAdded", + "version": "1593106976753", + "sequenceId": "1", + "content": { + "initiatorCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + } + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce" + } + } + } + ] + }, + "createdOn": "2020-06-25T17:42:56.7530000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2024-06-05-preview" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendChatMessage.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendChatMessage.json new file mode 100644 index 000000000000..be79e19effb5 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendChatMessage.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "sendChatMessageRequest": { + "content": "Let's head out for lunch in 15 minutes.", + "senderDisplayName": "Jane", + "metadata": { + "someKey1": "someValue1", + "someKey2": "someValue2" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708" + }, + "body": { + "id": "1593072104708" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendTypingNotification.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendTypingNotification.json new file mode 100644 index 000000000000..be6bf22f627d --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendTypingNotification.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "sendTypingNotificationRequest": { + "senderDisplayName": "Jane" + } + }, + "responses": { + "200": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_UpdateChatMessage.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_UpdateChatMessage.json new file mode 100644 index 000000000000..92fa7dcfeae9 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_UpdateChatMessage.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "content-type": "application/merge-patch+json", + "api-version": "2024-06-05-preview", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318", + "updateChatMessageRequest": { + "content": "Updated message content", + "metadata": { + "someKey1": "someValue1", + "someKey2": "someValue2" + } + } + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_AddChatParticipants.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_AddChatParticipants.json new file mode 100644 index 000000000000..b1a48b3138f9 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_AddChatParticipants.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "addChatParticipantsRequest": { + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Peter", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce" + } + }, + "displayName": "Rama", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ] + } + }, + "responses": { + "201": { + "body": { + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "code": "404", + "message": "Not found" + } + ] + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_ListChatParticipantsWithPageSize.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_ListChatParticipantsWithPageSize.json new file mode 100644 index 000000000000..959dd3a631d7 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_ListChatParticipantsWithPageSize.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "maxPageSize": 2 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/participants?skip=2&maxPageSize=2&api-version=2024-06-05-preview" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_RemoveChatParticipant.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_RemoveChatParticipant.json new file mode 100644 index 000000000000..fdeadcf66d7e --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_RemoveChatParticipant.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "participantCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThread.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThread.json new file mode 100644 index 000000000000..a0115eebeac8 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThread.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Jane" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Alex" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a" + } + }, + "displayName": "Bob" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b" + } + }, + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + } + }, + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "code": "404", + "message": "Not found" + } + ] + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThreadWithIdempotencyToken.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThreadWithIdempotencyToken.json new file mode 100644 index 000000000000..51011449d4b1 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThreadWithIdempotencyToken.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "idempotency-token": "35dd6e71-251b-5e29-8376-ba93d09c3fbf", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Jane" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Alex" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a" + } + }, + "displayName": "Bob" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b" + } + }, + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + } + }, + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "code": "404", + "message": "Not found" + } + ] + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_DeleteChatThread.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_DeleteChatThread.json new file mode 100644 index 000000000000..243167721b3a --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_DeleteChatThread.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:9525281ac1f947fc884bcee1a9f983c2@thread.v2" + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_GetChatThread.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_GetChatThread.json new file mode 100644 index 000000000000..d3a96dbcee19 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_GetChatThread.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "responses": { + "200": { + "body": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "messagingPolicy": { + "textOnlyChat": false + } + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_ListChatThreadsWithPageSize.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_ListChatThreadsWithPageSize.json new file mode 100644 index 000000000000..c74d16378e31 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_ListChatThreadsWithPageSize.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "maxPageSize": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Chat with Samantha", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:a0dfe5fc10e04a7f8d8a64d455f4196d@thread.v2", + "topic": "Presentation Brainstorming", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_n242d2bzammtwxiib7pbjtozeevjqzavzn654ku3dajocexfo2na@thread.v2", + "topic": "Chat with Alex", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:0062022a28be4e0983734f7e45cd8566@thread.v2", + "topic": "Lunch", + "deletedOn": "2020-07-07T05:55:41.6460000Z", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpe@thread.v2", + "topic": "Chat with Bob", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2024-06-05-preview&maxPageSize=5" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_UpdateChatThreadTopic.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_UpdateChatThreadTopic.json new file mode 100644 index 000000000000..822393251639 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_UpdateChatThreadTopic.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "content-type": "application/merge-patch+json", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "updateChatThreadRequest": { + "topic": "Updated Thread Topic" + } + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/readme.md b/specification/communication/data-plane/Chat/readme.md index 76da29a67609..273da7ea5e61 100644 --- a/specification/communication/data-plane/Chat/readme.md +++ b/specification/communication/data-plane/Chat/readme.md @@ -194,6 +194,17 @@ title: Azure Communication Services ``` +### Tag: package-2024-06-05-preview + +These settings apply only when `--tag=package-2024-06-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-06-05-preview' +input-file: + - preview/2024-06-05-preview/communicationserviceschat.json +title: + Azure Communication Services +``` + --- # Code Generation From 86b70ce378f0005c26b58ba0bcf96907bfa3a966 Mon Sep 17 00:00:00 2001 From: pjohari-ms <84465928+pjohari-ms@users.noreply.github.com> Date: Fri, 7 Jun 2024 15:56:05 -0500 Subject: [PATCH 130/343] [Microsoft.DocumentDB] Bug fix for preview API Version 2024-05-15-preview (#29344) * Bug fix for version 05-15-preview * Renamed models for better naming --- .../preview/2024-05-15-preview/services.json | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-05-15-preview/services.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-05-15-preview/services.json index 242e5ea9b239..34b08bbbc4f8 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-05-15-preview/services.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-05-15-preview/services.json @@ -310,7 +310,6 @@ "type": "object", "properties": { "properties": { - "x-ms-client-flatten": true, "$ref": "#/definitions/ServiceResourceCreateUpdateProperties" } } @@ -396,8 +395,8 @@ } } }, - "DataTransferServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for DataTransferServiceResource", + "DataTransferServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for DataTransferServiceResource", "type": "object", "x-ms-discriminator-value": "DataTransfer", "allOf": [ @@ -406,8 +405,8 @@ } ] }, - "SqlDedicatedGatewayServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for SqlDedicatedGatewayServiceResource", + "SqlDedicatedGatewayServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for SqlDedicatedGatewayServiceResource", "type": "object", "x-ms-discriminator-value": "SqlDedicatedGateway", "allOf": [ @@ -504,8 +503,8 @@ } } }, - "GraphAPIComputeServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for GraphAPIComputeServiceResource", + "GraphAPIComputeServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for GraphAPIComputeServiceResource", "type": "object", "x-ms-discriminator-value": "GraphAPICompute", "allOf": [ @@ -544,8 +543,8 @@ } } }, - "MaterializedViewsBuilderServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for MaterializedViewsBuilderServiceResource", + "MaterializedViewsBuilderServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for MaterializedViewsBuilderServiceResource", "type": "object", "x-ms-discriminator-value": "MaterializedViewsBuilder", "allOf": [ From e90dc8b10a5721c156af287729e41263b15ac379 Mon Sep 17 00:00:00 2001 From: Konrad Jamrozik Date: Fri, 7 Jun 2024 14:26:15 -0700 Subject: [PATCH 131/343] Update uniform-versioning.md and glossary.md: minor fixups (#29368) * Update uniform-versioning.md * Update glossary.md --- documentation/glossary.md | 2 +- documentation/uniform-versioning.md | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/documentation/glossary.md b/documentation/glossary.md index d55bbf11b9ff..84810756d853 100644 --- a/documentation/glossary.md +++ b/documentation/glossary.md @@ -39,7 +39,7 @@ A data-plane service has a path of form: > [!NOTE] > Some existing services follow different directory structure layouts. -> All such layouts are legacy, deprecated, and not allowed going forward. +> All such layouts are legacy, deprecated, and strongly discouraged going forward. For example, [`specification/containerservice/resource-manager/Microsoft.ContainerService/aks`] is a folder for the `aks` service within the `Microsoft.ContainerService` ARM Resource Provider namespace. diff --git a/documentation/uniform-versioning.md b/documentation/uniform-versioning.md index 923e8c2c0ed4..7a085b44b857 100644 --- a/documentation/uniform-versioning.md +++ b/documentation/uniform-versioning.md @@ -1,3 +1,6 @@ +| Short Link: | [aka.ms/azsdk/uniform-versioning](https://aka.ms/azsdk/uniform-versioning) | +|--|--| + # Uniform versioning > [!NOTE] @@ -11,7 +14,7 @@ In brief, it means: > If a new service API version is released, also a new documentation reference must be released to describe it. > Similarly, a new version of given SDK package must be released to refer to the new service version. -Each `service` within a `service group` can version independently of each other. +Each `service` within a `service group` or `grouping directory` can version independently of each other. ## Uniform versioning rules @@ -55,7 +58,7 @@ The **uniform versioning** has several implications and implementation decisions ### No API version mixing within a service - Nowhere within a service, documentation for it, or SDK referencing it, - can multiple service API versions be mixed. as such: + can multiple service API versions be mixed. As such: - `preview` API versions cannot be mixed with `stable` API versions. - No HTTP API endpoint for given API version can have any kind of dependency on service endpoint from any other API version. - The above apply to a stand-alone service as well as to a service that is a member of a `service group`. From 25afa22a250c0ad5a28671003f961b9cd20d60f6 Mon Sep 17 00:00:00 2001 From: Libba Lawrence Date: Fri, 7 Jun 2024 16:16:19 -0700 Subject: [PATCH 132/343] [EG] mark internal all (#29366) * internal csharp * remove - apply to all * update - js doesnt recognize internal? * try this * tsp format * update * update version --- .../Azure.Messaging.EventGrid/client.tsp | 32 +++++++++++++++++-- .../Azure.Messaging.EventGrid/tspconfig.yaml | 2 +- 2 files changed, 31 insertions(+), 3 deletions(-) diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp index c5bfa4531cdd..efc120374ada 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp @@ -118,11 +118,16 @@ namespace Customizations { // All Language customizations -// publishCloudEvent access level +//Operation Access Level @@access(publishCloudEvent, Access.internal, "python"); +@@access(publishCloudEvent, Access.internal, "csharp"); +@@access(publishCloudEvent, Access.internal, "java"); +@@access(publishCloudEvent, Access.internal, "javascript"); -// publishCloudEvents access level @@access(publishCloudEvents, Access.internal, "python"); +@@access(publishCloudEvents, Access.internal, "csharp"); +@@access(publishCloudEvents, Access.internal, "java"); +@@access(publishCloudEvents, Access.internal, "javascript"); @@access(receiveCloudEvents, Access.internal, "python"); @@access(acknowledgeCloudEvents, Access.internal, "python"); @@ -130,6 +135,26 @@ namespace Customizations { @@access(rejectCloudEvents, Access.internal, "python"); @@access(renewCloudEventLocks, Access.internal, "python"); +@@access(receiveCloudEvents, Access.internal, "csharp"); +@@access(acknowledgeCloudEvents, Access.internal, "csharp"); +@@access(releaseCloudEvents, Access.internal, "csharp"); +@@access(rejectCloudEvents, Access.internal, "csharp"); +@@access(renewCloudEventLocks, Access.internal, "csharp"); + +@@access(receiveCloudEvents, Access.internal, "java"); +@@access(acknowledgeCloudEvents, Access.internal, "java"); +@@access(releaseCloudEvents, Access.internal, "java"); +@@access(rejectCloudEvents, Access.internal, "java"); +@@access(renewCloudEventLocks, Access.internal, "java"); + +@@access(receiveCloudEvents, Access.internal, "javascript"); +@@access(acknowledgeCloudEvents, Access.internal, "javascript"); +@@access(releaseCloudEvents, Access.internal, "javascript"); +@@access(rejectCloudEvents, Access.internal, "javascript"); +@@access(renewCloudEventLocks, Access.internal, "javascript"); + +//Mark models as public (except ReceiveResult, PublishResult) +//BUG: Bypassing Go for now as it marks all models as internal @@access(AcknowledgeResult, Access.public); @@access(ReleaseResult, Access.public); @@access(RejectResult, Access.public); @@ -137,12 +162,15 @@ namespace Customizations { @@access(ReleaseDelay, Access.public); @@access(FailedLockToken, Access.public); +//Rename Enum @@clientName(ReleaseDelay.By0Seconds, "NoDelay"); @@clientName(ReleaseDelay.By10Seconds, "TenSeconds"); @@clientName(ReleaseDelay.By3600Seconds, "OneHour"); @@clientName(ReleaseDelay.By600Seconds, "TenMinutes"); @@clientName(ReleaseDelay.By60Seconds, "OneMinute"); +//Rename RenewLocksResult @@clientName(RenewCloudEventLocksResult, "RenewLocksResult"); +//Rename value to details (ReceiveResult internal) @@clientName(ReceiveResult.value, "details"); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml index 3cb17a6f89e0..714857f61985 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml @@ -17,7 +17,7 @@ options: azure-resource-provider-folder: "data-plane" "@azure-tools/typespec-python": package-pprint-name: '"Azure Event Grid"' - package-version: 4.12.0b1 + package-version: 4.20.0 package-dir: "azure-eventgrid" package-name: "{package-dir}" emitter-output-dir: "{project-root}/{service-dir}/{package-name}" From e8ead1c7c2e2d656d3e648ae45db07581da86932 Mon Sep 17 00:00:00 2001 From: nnagarajanmsft <94897071+nnagarajanmsft@users.noreply.github.com> Date: Sun, 9 Jun 2024 21:27:21 +0530 Subject: [PATCH 133/343] Nnagarajanmsft elasticsan microsoft.elastic san 2024 05 01 (#28828) * Adds base for updating Microsoft.ElasticSan from version stable/2023-01-01 to version 2024-05-01 * Updates readme * Updates API version in new specs and examples * Add EnforceDataIntegrityCheck and generate and validate examples * Run swagger prettier check for files reported in checks * Run prettier for all jsons * add modelerfour to disable flatten to avoid JS breaking * Add new field in VolumeGroupUpdateProperties --------- Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- .../stable/2024-05-01/elasticsan.json | 2687 +++++++++++++++++ .../ElasticSans_Create_MaximumSet_Gen.json | 165 + .../ElasticSans_Create_MinimumSet_Gen.json | 99 + .../ElasticSans_Delete_MaximumSet_Gen.json | 19 + .../ElasticSans_Delete_MinimumSet_Gen.json | 19 + .../ElasticSans_Get_MaximumSet_Gen.json | 78 + .../ElasticSans_Get_MinimumSet_Gen.json | 78 + ...ns_ListByResourceGroup_MaximumSet_Gen.json | 82 + ...ns_ListByResourceGroup_MinimumSet_Gen.json | 14 + ...ans_ListBySubscription_MaximumSet_Gen.json | 81 + ...ans_ListBySubscription_MinimumSet_Gen.json | 13 + .../ElasticSans_Update_MaximumSet_Gen.json | 93 + .../ElasticSans_Update_MinimumSet_Gen.json | 84 + .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + ...ointConnections_Create_MaximumSet_Gen.json | 87 + ...ointConnections_Create_MinimumSet_Gen.json | 79 + ...ointConnections_Delete_MaximumSet_Gen.json | 20 + ...ointConnections_Delete_MinimumSet_Gen.json | 20 + ...ndpointConnections_Get_MaximumSet_Gen.json | 42 + ...ndpointConnections_Get_MinimumSet_Gen.json | 42 + ...dpointConnections_List_MaximumSet_Gen.json | 46 + ...dpointConnections_List_MinimumSet_Gen.json | 15 + ...urces_ListByElasticSan_MaximumSet_Gen.json | 41 + ...urces_ListByElasticSan_MinimumSet_Gen.json | 15 + .../examples/Skus_List_MaximumSet_Gen.json | 40 + .../examples/Skus_List_MinimumSet_Gen.json | 13 + .../VolumeGroups_Create_MaximumSet_Gen.json | 211 ++ .../VolumeGroups_Create_MinimumSet_Gen.json | 150 + .../VolumeGroups_Delete_MaximumSet_Gen.json | 20 + .../VolumeGroups_Delete_MinimumSet_Gen.json | 20 + .../VolumeGroups_Get_MaximumSet_Gen.json | 95 + .../VolumeGroups_Get_MinimumSet_Gen.json | 16 + ...roups_ListByElasticSan_MaximumSet_Gen.json | 99 + ...roups_ListByElasticSan_MinimumSet_Gen.json | 15 + .../VolumeGroups_Update_MaximumSet_Gen.json | 131 + .../VolumeGroups_Update_MinimumSet_Gen.json | 22 + ...VolumeSnapshots_Create_MaximumSet_Gen.json | 70 + ...VolumeSnapshots_Create_MinimumSet_Gen.json | 70 + ...VolumeSnapshots_Delete_MaximumSet_Gen.json | 21 + ...VolumeSnapshots_Delete_MinimumSet_Gen.json | 21 + .../VolumeSnapshots_Get_MaximumSet_Gen.json | 37 + .../VolumeSnapshots_Get_MinimumSet_Gen.json | 37 + ...hots_ListByVolumeGroup_MaximumSet_Gen.json | 42 + ...hots_ListByVolumeGroup_MinimumSet_Gen.json | 16 + .../Volumes_Create_MaximumSet_Gen.json | 97 + .../Volumes_Create_MinimumSet_Gen.json | 90 + .../Volumes_Delete_MaximumSet_Gen.json | 23 + .../Volumes_Delete_MinimumSet_Gen.json | 21 + .../examples/Volumes_Get_MaximumSet_Gen.json | 48 + .../examples/Volumes_Get_MinimumSet_Gen.json | 48 + ...umes_ListByVolumeGroup_MaximumSet_Gen.json | 52 + ...umes_ListByVolumeGroup_MinimumSet_Gen.json | 16 + .../Volumes_Update_MaximumSet_Gen.json | 61 + .../Volumes_Update_MinimumSet_Gen.json | 54 + .../elasticsan/resource-manager/readme.md | 13 +- .../resource-manager/readme.typescript.md | 5 + 57 files changed, 5631 insertions(+), 2 deletions(-) create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MaximumSet_Gen.json create mode 100644 specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MinimumSet_Gen.json diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json new file mode 100644 index 000000000000..2504c483f15c --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json @@ -0,0 +1,2687 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01", + "title": "ElasticSanManagement" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ElasticSans", + "description": "APIs for ElasticSan operations." + }, + { + "name": "ElasticSanOperations", + "description": "APIs for ElasticSan operations," + }, + { + "name": "VolumeGroups", + "description": "APIs for Volume Group operations." + }, + { + "name": "Volumes", + "description": "APIs for Volume operations." + } + ], + "paths": { + "/providers/Microsoft.ElasticSan/operations": { + "get": { + "tags": [ + "Elastic San Operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of ElasticSan operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/skus": { + "get": { + "tags": [ + "Elastic San Skus" + ], + "summary": "List all the available Skus in the region and information related to them", + "operationId": "Skus_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='location eq ' to filter on location.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Lists the available SKUs supported by Microsoft.ElasticSan for given subscription.", + "schema": { + "$ref": "#/definitions/SkuInformationList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Skus_List_MaximumSet_Gen": { + "$ref": "./examples/Skus_List_MaximumSet_Gen.json" + }, + "Skus_List_MinimumSet_Gen": { + "$ref": "./examples/Skus_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/elasticSans": { + "get": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_ListBySubscription", + "description": "Gets a list of ElasticSans in a subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved Elastic San by subscription", + "schema": { + "$ref": "#/definitions/ElasticSanList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticSans_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json" + }, + "ElasticSans_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans": { + "get": { + "tags": [ + "ElasticSan" + ], + "operationId": "ElasticSans_ListByResourceGroup", + "description": "Gets a list of ElasticSan in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved elasticSans by resource group", + "schema": { + "$ref": "#/definitions/ElasticSanList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticSans_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json" + }, + "ElasticSans_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}": { + "put": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Create", + "description": "Create ElasticSan.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticSan" + }, + "description": "Elastic San object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ElasticSans_Create_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Update", + "description": "Update a Elastic San.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticSanUpdate" + }, + "description": "Elastic San object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- ElasticSAN properties updated successfully.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ElasticSans_Update_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Delete", + "description": "Delete a Elastic San.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete operation completed successfully." + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent --ElasticSAN does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ElasticSans_Delete_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Delete_MaximumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Get", + "description": "Get a ElasticSan.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved ElasticSan.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticSans_Get_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumeGroups": { + "get": { + "tags": [ + "VolumeGroups" + ], + "description": "List VolumeGroups.", + "operationId": "VolumeGroups_ListByElasticSan", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved Volume Group List.", + "schema": { + "$ref": "#/definitions/VolumeGroupList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VolumeGroups_ListByElasticSan_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}": { + "put": { + "tags": [ + "VolumeGroups" + ], + "description": "Create a Volume Group.", + "operationId": "VolumeGroups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VolumeGroup" + }, + "description": "Volume Group object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeGroups_Create_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "VolumeGroups" + ], + "description": "Update an VolumeGroup.", + "operationId": "VolumeGroups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VolumeGroupUpdate" + }, + "description": "Volume Group object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeGroups_Update_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "VolumeGroups" + ], + "description": "Delete an VolumeGroup.", + "operationId": "VolumeGroups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete operation completed successfully." + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeGroups_Delete_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Delete_MaximumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "VolumeGroups" + ], + "description": "Get an VolumeGroups.", + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved iSCSI Target.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}": { + "put": { + "tags": [ + "Volumes" + ], + "description": "Create a Volume.", + "operationId": "Volumes_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Volume" + }, + "description": "Volume object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Create_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "description": "Update an Volume.", + "operationId": "Volumes_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VolumeUpdate" + }, + "description": "Volume object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "description": "Delete an Volume.", + "operationId": "Volumes_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-delete-snapshots", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "x-ms-delete-snapshots", + "modelAsString": true + }, + "description": "Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false." + }, + { + "name": "x-ms-force-delete", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "x-ms-force-delete", + "modelAsString": true + }, + "description": "Optional, used to delete volume if active sessions present. Allowed value are only true or false. Default value is false." + } + ], + "responses": { + "200": { + "description": "Delete operation completed successfully." + }, + "202": { + "description": "Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Delete_MaximumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "Volumes" + ], + "description": "Get an Volume.", + "operationId": "Volumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved Volume.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes": { + "get": { + "tags": [ + "Volumes" + ], + "description": "List Volumes in a VolumeGroup.", + "operationId": "Volumes_ListByVolumeGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved volumes in a volume group.", + "schema": { + "$ref": "#/definitions/VolumeList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Volumes_ListByVolumeGroup_MaximumSet_Gen": { + "$ref": "./examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Update the state of specified private endpoint connection associated with the Elastic San", + "operationId": "PrivateEndpointConnections_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Private Endpoint Connection Approval object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error from Elastic SAN resource provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PrivateEndpointConnections_Create_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the specified private endpoint connection associated with the Elastic San", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error from Elastic SAN resource provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes the specified private endpoint connection associated with the Elastic San", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully" + }, + "202": { + "description": "Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Private Endpoint Connection does not exist." + }, + "default": { + "description": "Error from Elastic SAN resource provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List all Private Endpoint Connections associated with the Elastic San.", + "operationId": "PrivateEndpointConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "PrivateEndpointConnections_List_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_List_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByElasticSan", + "description": "Gets the private link resources that need to be created for a elastic San.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListByElasticSan_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "description": "List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter", + "operationId": "VolumeSnapshots_ListByVolumeGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='volumeName eq ' to filter on volume.", + "required": false, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved snapshots in a volume group.", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}": { + "put": { + "tags": [ + "Snapshots" + ], + "description": "Create a Volume Snapshot.", + "operationId": "VolumeSnapshots_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "Snapshot object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the create operation is successfully completed.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "Created -- Resource Created; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeSnapshots_Create_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "description": "Delete a Volume Snapshot.", + "operationId": "VolumeSnapshots_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete operation completed successfully." + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeSnapshots_Delete_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Delete_MaximumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "Snapshots" + ], + "description": "Get a Volume Snapshot.", + "operationId": "VolumeSnapshots_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved Volume Snapshot.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeSnapshots_Get_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Get_MaximumSet_Gen.json" + } + } + } + } + }, + "parameters": { + "ElasticSanNameParameter": { + "name": "elasticSanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ElasticSan.", + "pattern": "^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$", + "minLength": 3, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "VolumeGroupNameParameter": { + "name": "volumeGroupName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the VolumeGroup.", + "pattern": "^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "VolumeNameParameter": { + "name": "volumeName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the Volume.", + "pattern": "^[a-z0-9]+(-[a-z0-9A-Z]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the Private Endpoint connection.", + "x-ms-parameter-location": "method" + }, + "SnapshotNameParameter": { + "name": "snapshotName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the volume snapshot within the given volume group.", + "pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*$", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ElasticSanList": { + "type": "object", + "description": "List of Elastic Sans", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Elastic San objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ElasticSan" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticSan": { + "type": "object", + "description": "Response for ElasticSan request.", + "required": [ + "properties", + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of ElasticSan.", + "$ref": "#/definitions/ElasticSanProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticSanProperties": { + "type": "object", + "description": "Elastic San response properties.", + "required": [ + "baseSizeTiB", + "extendedCapacitySizeTiB", + "sku" + ], + "properties": { + "sku": { + "description": "resource sku", + "$ref": "#/definitions/Sku" + }, + "availabilityZones": { + "type": "array", + "description": "Logical zone for Elastic San resource; example: [\"1\"].", + "items": { + "$ref": "#/definitions/AvailabilityZone" + } + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "baseSizeTiB": { + "description": "Base size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedCapacitySizeTiB": { + "description": "Extended size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "totalVolumeSizeGiB": { + "description": "Total size of the provisioned Volumes in GiB.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "volumeGroupCount": { + "description": "Total number of volume groups in this Elastic San appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "totalIops": { + "description": "Total Provisioned IOPS of the Elastic San appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "totalMBps": { + "description": "Total Provisioned MBps Elastic San appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "totalSizeTiB": { + "description": "Total size of the Elastic San appliance in TB.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of Private Endpoint Connections." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "description": "Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'." + } + } + }, + "ElasticSanUpdate": { + "type": "object", + "description": "Response for ElasticSan update request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of ElasticSan.", + "$ref": "#/definitions/ElasticSanUpdateProperties" + }, + "tags": { + "type": "object", + "description": "Update tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ElasticSanUpdateProperties": { + "type": "object", + "description": "Elastic San update properties.", + "properties": { + "baseSizeTiB": { + "description": "Base size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "update" + ] + }, + "extendedCapacitySizeTiB": { + "description": "Extended size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "update" + ] + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "description": "Allow or disallow public network access to ElasticSan Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'." + } + } + }, + "AvailabilityZone": { + "type": "string", + "description": "Availability zone." + }, + "SkuInformationList": { + "description": "List of SKU Information objects", + "type": "object", + "properties": { + "value": { + "description": "List of ResourceType Sku", + "type": "array", + "items": { + "$ref": "#/definitions/SkuInformation" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "SkuInformation": { + "description": "ElasticSAN SKU and its properties", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Sku Name", + "$ref": "#/definitions/SkuName" + }, + "tier": { + "type": "string", + "description": "Sku Tier", + "$ref": "#/definitions/SkuTier" + }, + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + }, + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)." + }, + "locationInfo": { + "description": "Availability of the SKU for the location/zone", + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "capabilities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "x-ms-identifiers": [], + "description": "The capability information in the specified SKU." + } + } + }, + "SKUCapability": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of capability." + }, + "value": { + "readOnly": true, + "type": "string", + "description": "A string value to indicate states of given capability." + } + }, + "description": "The capability information in the specified SKU.", + "type": "object" + }, + "SkuLocationInfo": { + "description": "The location info.", + "type": "object", + "properties": { + "location": { + "description": "The location.", + "type": "string", + "readOnly": true + }, + "zones": { + "description": "The zones.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "Sku": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "$ref": "#/definitions/SkuName" + }, + "tier": { + "$ref": "#/definitions/SkuTier" + } + }, + "description": "The SKU name. Required for account creation; optional for update." + }, + "SkuName": { + "type": "string", + "enum": [ + "Premium_LRS", + "Premium_ZRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "value": "Premium_LRS", + "description": "Premium locally redundant storage" + }, + { + "value": "Premium_ZRS", + "description": "Premium zone redundant storage" + } + ] + }, + "description": "The sku name." + }, + "SkuTier": { + "type": "string", + "enum": [ + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Premium Tier" + } + ] + }, + "description": "The sku tier." + }, + "IscsiTargetInfo": { + "type": "object", + "description": "Iscsi target information", + "readOnly": true, + "properties": { + "targetIqn": { + "type": "string", + "description": "iSCSI Target IQN (iSCSI Qualified Name); example: \"iqn.2005-03.org.iscsi:server\".", + "readOnly": true + }, + "targetPortalHostname": { + "type": "string", + "description": "iSCSI Target Portal Host Name", + "readOnly": true + }, + "targetPortalPort": { + "type": "integer", + "format": "int32", + "description": "iSCSI Target Portal Port", + "readOnly": true + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "status": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status of the iSCSI Target." + } + } + }, + "VolumeGroup": { + "type": "object", + "description": "Response for Volume Group request.", + "properties": { + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of VolumeGroup.", + "$ref": "#/definitions/VolumeGroupProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "Identity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity." + } + }, + "required": [ + "type" + ], + "description": "Identity for the resource." + }, + "VolumeGroupList": { + "type": "object", + "description": "List of Volume Groups", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Volume Groups objects.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "VolumeGroupProperties": { + "type": "object", + "description": "VolumeGroup response properties.", + "properties": { + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "protocolType": { + "description": "Type of storage target", + "$ref": "#/definitions/StorageTargetType" + }, + "encryption": { + "description": "Type of encryption", + "$ref": "#/definitions/EncryptionType" + }, + "encryptionProperties": { + "description": "Encryption Properties describing Key Vault and Identity information", + "$ref": "#/definitions/EncryptionProperties" + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of Private Endpoint Connections." + }, + "enforceDataIntegrityCheckForIscsi": { + "type": "boolean", + "description": "A boolean indicating whether or not Data Integrity Check is enabled" + } + } + }, + "EncryptionProperties": { + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "x-ms-client-name": "KeyVaultProperties", + "description": "Properties provided by key vault." + }, + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "x-ms-client-name": "EncryptionIdentity", + "description": "The identity to be used with service-side encryption at rest." + } + }, + "description": "The encryption settings on the volume group." + }, + "EncryptionIdentity": { + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group.", + "x-ms-client-name": "EncryptionUserAssignedIdentity" + } + }, + "description": "Encryption identity for the volume group." + }, + "KeyVaultProperties": { + "type": "object", + "description": "Properties of key vault.", + "properties": { + "keyName": { + "type": "string", + "description": "The name of KeyVault key.", + "x-ms-client-name": "KeyName" + }, + "keyVersion": { + "type": "string", + "description": "The version of KeyVault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault.", + "x-ms-client-name": "KeyVaultUri", + "format": "uri" + }, + "currentVersionedKeyIdentifier": { + "type": "string", + "readOnly": true, + "description": "The object identifier of the current versioned Key Vault Key in use.", + "x-ms-client-name": "CurrentVersionedKeyIdentifier" + }, + "lastKeyRotationTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Timestamp of last rotation of the Key Vault Key.", + "x-ms-client-name": "LastKeyRotationTimestamp" + }, + "currentVersionedKeyExpirationTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption.", + "x-ms-client-name": "CurrentVersionedKeyExpirationTimestamp" + } + } + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client ID of the identity." + } + }, + "description": "UserAssignedIdentity for the resource." + }, + "VolumeGroupUpdate": { + "type": "object", + "description": "Volume Group request.", + "properties": { + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of VolumeGroup.", + "$ref": "#/definitions/VolumeGroupUpdateProperties" + } + } + }, + "VolumeGroupUpdateProperties": { + "type": "object", + "description": "VolumeGroup response properties.", + "properties": { + "protocolType": { + "description": "Type of storage target", + "$ref": "#/definitions/StorageTargetType" + }, + "encryption": { + "description": "Type of encryption", + "$ref": "#/definitions/EncryptionType" + }, + "encryptionProperties": { + "description": "Encryption Properties describing Key Vault and Identity information", + "$ref": "#/definitions/EncryptionProperties" + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations.", + "x-ms-mutability": [ + "update" + ] + }, + "enforceDataIntegrityCheckForIscsi": { + "type": "boolean", + "description": "A boolean indicating whether or not Data Integrity Check is enabled" + } + } + }, + "Volume": { + "type": "object", + "description": "Response for Volume request.", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of Volume.", + "$ref": "#/definitions/VolumeProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VolumeList": { + "type": "object", + "description": "List of Volumes", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Volume objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "VolumeProperties": { + "type": "object", + "required": [ + "sizeGiB" + ], + "description": "Volume response properties.", + "properties": { + "volumeId": { + "description": "Unique Id of the volume in GUID format", + "type": "string", + "readOnly": true + }, + "creationData": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/SourceCreationData" + }, + "sizeGiB": { + "description": "Volume size.", + "type": "integer", + "format": "int64" + }, + "storageTarget": { + "description": "Storage target information", + "$ref": "#/definitions/IscsiTargetInfo" + }, + "managedBy": { + "description": "Parent resource information.", + "$ref": "#/definitions/ManagedByInfo" + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "ManagedByInfo": { + "type": "object", + "description": "Parent resource information.", + "properties": { + "resourceId": { + "type": "string", + "x-ms-client-name": "ResourceId", + "description": "Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use." + } + } + }, + "VolumeUpdate": { + "type": "object", + "description": "Response for Volume request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of Volume.", + "$ref": "#/definitions/VolumeUpdateProperties" + } + } + }, + "VolumeUpdateProperties": { + "type": "object", + "description": "Volume response properties.", + "properties": { + "sizeGiB": { + "description": "Volume size.", + "type": "integer", + "format": "int64" + }, + "managedBy": { + "description": "Parent resource information.", + "$ref": "#/definitions/ManagedByInfo" + } + } + }, + "SourceCreationData": { + "type": "object", + "description": "Data source used when creating the volume.", + "properties": { + "createSource": { + "type": "string", + "enum": [ + "None", + "VolumeSnapshot", + "DiskSnapshot", + "Disk", + "DiskRestorePoint" + ], + "x-ms-enum": { + "name": "VolumeCreateOption", + "modelAsString": true + }, + "description": "This enumerates the possible sources of a volume creation." + }, + "sourceId": { + "type": "string", + "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" + } + } + }, + "ProvisioningState": { + "type": "string", + "enum": [ + "Invalid", + "Succeeded", + "Failed", + "Canceled", + "Pending", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningStates", + "modelAsString": true + }, + "description": "Provisioning state of the iSCSI Target.", + "readOnly": true + }, + "OperationalStatus": { + "type": "string", + "enum": [ + "Invalid", + "Unknown", + "Healthy", + "Unhealthy", + "Updating", + "Running", + "Stopped", + "Stopped (deallocated)" + ], + "x-ms-enum": { + "name": "OperationalStatus", + "modelAsString": true + }, + "description": "Operational status of the resource." + }, + "StorageTargetType": { + "type": "string", + "enum": [ + "Iscsi", + "None" + ], + "x-ms-enum": { + "name": "StorageTargetType", + "modelAsString": true + }, + "description": "Storage Target type." + }, + "EncryptionType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk.", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerManagedKey" + ], + "x-ms-enum": { + "name": "EncryptionType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithPlatformKey", + "description": "Volume is encrypted at rest with Platform managed key. It is the default encryption type." + }, + { + "value": "EncryptionAtRestWithCustomerManagedKey", + "description": "Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer." + } + ] + } + }, + "NetworkRuleSet": { + "type": "object", + "properties": { + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility." + }, + "VirtualNetworkRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "x-ms-client-name": "VirtualNetworkResourceId", + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}." + }, + "action": { + "type": "string", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": true + }, + "default": "Allow", + "description": "The action of virtual network rule." + } + }, + "required": [ + "id" + ], + "description": "Virtual Network rule." + }, + "PrivateEndpointConnection": { + "type": "object", + "description": " Response for PrivateEndpoint Connection object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Private Endpoint Connection Properties.", + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ] + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": " Response for PrivateEndpoint connection properties", + "properties": { + "provisioningState": { + "description": "Provisioning State of Private Endpoint connection resource", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "privateEndpoint": { + "description": "Private Endpoint resource", + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Private Link Service Connection State.", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "groupIds": { + "description": " List of resources private endpoint is mapped", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Response for PrivateEndpoint", + "properties": { + "id": { + "type": "string", + "description": "The ARM identifier for Private Endpoint", + "readOnly": true + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "Response for Private Link Service Connection state", + "properties": { + "status": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + } + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Failed", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + }, + "description": "List of private endpoint connections associated with SAN" + }, + "Snapshot": { + "type": "object", + "required": [ + "properties" + ], + "description": "Response for Volume Snapshot request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of Volume Snapshot.", + "$ref": "#/definitions/SnapshotProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SnapshotList": { + "type": "object", + "description": "List of Snapshots", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Snapshot objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "SnapshotProperties": { + "type": "object", + "required": [ + "creationData" + ], + "description": "Properties for Snapshot.", + "properties": { + "creationData": { + "description": "Data used when creating a volume snapshot.", + "$ref": "#/definitions/SnapshotCreationData" + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "sourceVolumeSizeGiB": { + "description": "Size of Source Volume", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "volumeName": { + "description": "Source Volume Name of a snapshot", + "type": "string", + "readOnly": true + } + } + }, + "SnapshotCreationData": { + "type": "object", + "required": [ + "sourceId" + ], + "description": "Data used when creating a volume snapshot.", + "properties": { + "sourceId": { + "type": "string", + "description": "Fully qualified resource ID of the volume. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}\"" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..cbda8291e491 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MaximumSet_Gen.json @@ -0,0 +1,165 @@ +{ + "title": "ElasticSans_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "ElasticSans_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "bgyobptiableh" + ], + "baseSizeTiB": 9, + "extendedCapacitySizeTiB": 6, + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key8999": "kzpsnqodjgfjyasktlxiboklydek" + }, + "location": "France Central" + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "bgyobptiableh" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 9, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 24, + "volumeGroupCount": 17, + "totalIops": 19, + "totalMBps": 18, + "totalSizeTiB": 26, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key8999": "kzpsnqodjgfjyasktlxiboklydek" + }, + "location": "vcofgqbwmrplgsmhgz", + "id": "radhnqz", + "name": "amqtxb", + "type": "bvllurxfpbivtswcfgi", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "bgyobptiableh" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 9, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 24, + "volumeGroupCount": 17, + "totalIops": 19, + "totalMBps": 18, + "totalSizeTiB": 26, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key8999": "kzpsnqodjgfjyasktlxiboklydek" + }, + "location": "vcofgqbwmrplgsmhgz", + "id": "radhnqz", + "name": "amqtxb", + "type": "bvllurxfpbivtswcfgi", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..ae6765549121 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MinimumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "ElasticSans_Create", + "operationId": "ElasticSans_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": { + "properties": { + "sku": { + "name": "Premium_LRS" + }, + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 27 + }, + "location": "France Central" + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "publicNetworkAccess": "Enabled" + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "publicNetworkAccess": "Enabled" + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..599f5cc067e9 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "ElasticSans_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "ElasticSans_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..258fbf64dc84 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "ElasticSans_Delete", + "operationId": "ElasticSans_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..10f6eaa79e3e --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MaximumSet_Gen.json @@ -0,0 +1,78 @@ +{ + "title": "ElasticSans_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "ElasticSans_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "bgyobptiableh" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 9, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 24, + "volumeGroupCount": 17, + "totalIops": 19, + "totalMBps": 18, + "totalSizeTiB": 26, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key8999": "kzpsnqodjgfjyasktlxiboklydek" + }, + "location": "vcofgqbwmrplgsmhgz", + "id": "radhnqz", + "name": "amqtxb", + "type": "bvllurxfpbivtswcfgi", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..c0744c9c0d57 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MinimumSet_Gen.json @@ -0,0 +1,78 @@ +{ + "title": "ElasticSans_Get", + "operationId": "ElasticSans_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..f0388a9d742c --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,82 @@ +{ + "title": "ElasticSans_ListByResourceGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "ElasticSans_ListByResourceGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "bgyobptiableh" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 9, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 24, + "volumeGroupCount": 17, + "totalIops": 19, + "totalMBps": 18, + "totalSizeTiB": 26, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key8999": "kzpsnqodjgfjyasktlxiboklydek" + }, + "location": "vcofgqbwmrplgsmhgz", + "id": "radhnqz", + "name": "amqtxb", + "type": "bvllurxfpbivtswcfgi", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "nextLink": "xc" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..d0c991ddfeea --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "ElasticSans_ListByResourceGroup_MaximumSet_Gen - generated by [MinimumSet] rule", + "operationId": "ElasticSans_ListByResourceGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae7384dabbce --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "ElasticSans_ListBySubscription_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "ElasticSans_ListBySubscription", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "bgyobptiableh" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 9, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 24, + "volumeGroupCount": 17, + "totalIops": 19, + "totalMBps": 18, + "totalSizeTiB": 26, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key8999": "kzpsnqodjgfjyasktlxiboklydek" + }, + "location": "vcofgqbwmrplgsmhgz", + "id": "radhnqz", + "name": "amqtxb", + "type": "bvllurxfpbivtswcfgi", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "nextLink": "xc" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..efda0421bf04 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "ElasticSans_ListBySubscription_MaximumSet_Gen - generated by [MinimumSet] rule", + "operationId": "ElasticSans_ListBySubscription", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca05bcb96ae5 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MaximumSet_Gen.json @@ -0,0 +1,93 @@ +{ + "title": "ElasticSans_Update_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "ElasticSans_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": { + "properties": { + "baseSizeTiB": 28, + "extendedCapacitySizeTiB": 3, + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key6131": "pdmdonshncaahcffdtegnx" + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "bgyobptiableh" + ], + "provisioningState": "Invalid", + "baseSizeTiB": 9, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 24, + "volumeGroupCount": 17, + "totalIops": 19, + "totalMBps": 18, + "totalSizeTiB": 26, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key8999": "kzpsnqodjgfjyasktlxiboklydek" + }, + "location": "vcofgqbwmrplgsmhgz", + "id": "radhnqz", + "name": "amqtxb", + "type": "bvllurxfpbivtswcfgi", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..0fd8f9ae9296 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MinimumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "ElasticSans_Update", + "operationId": "ElasticSans_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": {}, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..821aa2273048 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "zbrta", + "isDataAction": true, + "display": { + "provider": "xamdcragdhcamzyzsghhl", + "resource": "dauaewvxffac", + "operation": "poyvvbdqmmmvcufnlywfuqhrgrtr", + "description": "qahdwwduqwmmisgycfpzvlwltpauw" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "ktcqaydmfmdauponwftdkhcnkmdnso" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..962f10ce0a4b --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MaximumSet_Gen - generated by [MinimumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..2349ba34809e --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -0,0 +1,87 @@ +{ + "title": "PrivateEndpointConnections_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "parameters": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..2976b7bb7a08 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "title": "PrivateEndpointConnections_Create", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": {} + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..905b61b01c8a --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "PrivateEndpointConnections_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..e5b6f9eaa4bb --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "PrivateEndpointConnections_Delete", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..7fc0adef52d6 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..bb6df8e27c77 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "bgurjvijz", + "createdByType": "User", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-25T17:40:52.453Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..5071011bfcae --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_List_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_List", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "nextLink": "vdihsllodbbxlzcfiqszwlrktlwrav" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..e404336c6440 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateEndpointConnections_List", + "operationId": "PrivateEndpointConnections_List", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json new file mode 100644 index 000000000000..c053ddc7082b --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResources_ListByElasticSan_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "PrivateLinkResources_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "gkbsulftmpqpozh", + "requiredMembers": [ + "szkaywtzokirfvzzjcbgdz" + ], + "requiredZoneNames": [ + "ywhuefrajpqyjmsc" + ] + }, + "id": "pnlckzrwuffnjrhcccbnjf", + "name": "nyiyoefzspdzxadboqsllzczkcth", + "type": "xqtfesv", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "nextLink": "kkpnmehaubvkfnuzaypwycbgr" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json new file mode 100644 index 000000000000..0748cec0b9c2 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateLinkResources_ListByElasticSan", + "operationId": "PrivateLinkResources_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..b04febc89d23 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "Skus_List_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "Skus_List", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2024-05-01", + "$filter": "twwceymshjxhmzyvgww" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Premium_LRS", + "tier": "Premium", + "resourceType": "qdkvccmffzxkwalsnsrtfxsuxwzogg", + "locations": [ + "hdzfsztvrmfhrqr" + ], + "locationInfo": [ + { + "location": "klfwnyxxlgthi", + "zones": [ + "szjimumzhjysuqcqg" + ] + } + ], + "capabilities": [ + { + "name": "bokdo", + "value": "y" + } + ] + } + ], + "nextLink": "vzzaecvtz" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..b2cc60121174 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "Skus_List_MaximumSet_Gen - generated by [MinimumSet] rule", + "operationId": "Skus_List", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..f7b19ffc8e93 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MaximumSet_Gen.json @@ -0,0 +1,211 @@ +{ + "title": "VolumeGroups_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "VolumeGroups_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key6160": {} + } + }, + "properties": { + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "oaamyfynvyzxlpdyadfiptxgex", + "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyVaultUri": "https://microsoft.com/a" + }, + "identity": { + "userAssignedIdentity": "xu" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "dcywtkhbwqoaayzvj", + "action": "Allow" + } + ] + }, + "enforceDataIntegrityCheckForIscsi": true + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "waiuktshnm", + "tenantId": "rjltknjpqnd", + "type": "None", + "userAssignedIdentities": { + "key6160": { + "principalId": "evse", + "clientId": "biabkgbordaxlmbgfgmkyvh" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "oaamyfynvyzxlpdyadfiptxgex", + "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "qaqgnsrfjua", + "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", + "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + }, + "identity": { + "userAssignedIdentity": "xu" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "dcywtkhbwqoaayzvj", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "wawodajygzedvsz", + "name": "jacnlsnxssywuk", + "type": "kbvsfyul", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "principalId": "waiuktshnm", + "tenantId": "rjltknjpqnd", + "type": "None", + "userAssignedIdentities": { + "key6160": { + "principalId": "evse", + "clientId": "biabkgbordaxlmbgfgmkyvh" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "oaamyfynvyzxlpdyadfiptxgex", + "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "qaqgnsrfjua", + "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", + "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + }, + "identity": { + "userAssignedIdentity": "xu" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "dcywtkhbwqoaayzvj", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "wawodajygzedvsz", + "name": "jacnlsnxssywuk", + "type": "kbvsfyul", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..5454bc57d85c --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MinimumSet_Gen.json @@ -0,0 +1,150 @@ +{ + "title": "VolumeGroups_Create", + "operationId": "VolumeGroups_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": {}, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "ihsiwrwdofymkhquaxcrtfmmrsygw", + "tenantId": "gtkzkjsy", + "type": "None", + "userAssignedIdentities": { + "key7482": { + "principalId": "vfdzizicxcfcqecgsmshz", + "clientId": "jaczsquolgxwpznljbmdupn" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "sftaiernmrzypnrkpakrrawxcbsqzc", + "keyVersion": "c", + "keyVaultUri": "https://microsoft.com/axmblwp", + "currentVersionedKeyIdentifier": "rnpxhtzkquzyoepwbwktbwb", + "lastKeyRotationTimestamp": "2023-08-23T12:16:11.388Z", + "currentVersionedKeyExpirationTimestamp": "2023-08-23T12:16:11.388Z" + }, + "identity": { + "userAssignedIdentity": "im" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "ehxmltubeltzmgcqxocakaansat" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "nahklgxicbqjbbvcdrkljqdhprruys", + "actionsRequired": "sairafcqpvucoy" + }, + "groupIds": [ + "bolviufgqnyid" + ] + }, + "id": "opcjchensdf", + "name": "gewxykc", + "type": "ailymcedgvxbqklmqtlty", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "identity": { + "principalId": "ihsiwrwdofymkhquaxcrtfmmrsygw", + "tenantId": "gtkzkjsy", + "type": "None", + "userAssignedIdentities": { + "key7482": { + "principalId": "vfdzizicxcfcqecgsmshz", + "clientId": "jaczsquolgxwpznljbmdupn" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "sftaiernmrzypnrkpakrrawxcbsqzc", + "keyVersion": "c", + "keyVaultUri": "https://microsoft.com/axmblwp", + "currentVersionedKeyIdentifier": "rnpxhtzkquzyoepwbwktbwb", + "lastKeyRotationTimestamp": "2023-08-23T12:16:11.388Z", + "currentVersionedKeyExpirationTimestamp": "2023-08-23T12:16:11.388Z" + }, + "identity": { + "userAssignedIdentity": "im" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow" + } + ] + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..ac9b3fe4c91f --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VolumeGroups_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "VolumeGroups_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..f176d21ae1a9 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VolumeGroups_Delete", + "operationId": "VolumeGroups_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd3699566906 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "VolumeGroups_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "VolumeGroups_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "waiuktshnm", + "tenantId": "rjltknjpqnd", + "type": "None", + "userAssignedIdentities": { + "key6160": { + "principalId": "evse", + "clientId": "biabkgbordaxlmbgfgmkyvh" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "oaamyfynvyzxlpdyadfiptxgex", + "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "qaqgnsrfjua", + "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", + "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + }, + "identity": { + "userAssignedIdentity": "xu" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "dcywtkhbwqoaayzvj", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "wawodajygzedvsz", + "name": "jacnlsnxssywuk", + "type": "kbvsfyul", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..d636bc0b55f9 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VolumeGroups_Get", + "operationId": "VolumeGroups_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json new file mode 100644 index 000000000000..25e26bfebb22 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "VolumeGroups_ListByElasticSan_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "VolumeGroups_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "principalId": "waiuktshnm", + "tenantId": "rjltknjpqnd", + "type": "None", + "userAssignedIdentities": { + "key6160": { + "principalId": "evse", + "clientId": "biabkgbordaxlmbgfgmkyvh" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "oaamyfynvyzxlpdyadfiptxgex", + "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "qaqgnsrfjua", + "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", + "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + }, + "identity": { + "userAssignedIdentity": "xu" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "dcywtkhbwqoaayzvj", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "wawodajygzedvsz", + "name": "jacnlsnxssywuk", + "type": "kbvsfyul", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "nextLink": "daaeyyyw" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json new file mode 100644 index 000000000000..9c619f8574e1 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VolumeGroups_ListByElasticSan", + "operationId": "VolumeGroups_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..330b763d33e7 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MaximumSet_Gen.json @@ -0,0 +1,131 @@ +{ + "title": "VolumeGroups_Update_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "VolumeGroups_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key6160": {} + } + }, + "properties": { + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "oaamyfynvyzxlpdyadfiptxgex", + "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyVaultUri": "https://microsoft.com/a" + }, + "identity": { + "userAssignedIdentity": "xu" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "dcywtkhbwqoaayzvj", + "action": "Allow" + } + ] + }, + "enforceDataIntegrityCheckForIscsi": true + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "waiuktshnm", + "tenantId": "rjltknjpqnd", + "type": "None", + "userAssignedIdentities": { + "key6160": { + "principalId": "evse", + "clientId": "biabkgbordaxlmbgfgmkyvh" + } + } + }, + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "encryptionProperties": { + "keyVaultProperties": { + "keyName": "oaamyfynvyzxlpdyadfiptxgex", + "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyVaultUri": "https://microsoft.com/a", + "currentVersionedKeyIdentifier": "qaqgnsrfjua", + "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", + "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + }, + "identity": { + "userAssignedIdentity": "xu" + } + }, + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "dcywtkhbwqoaayzvj", + "action": "Allow" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Invalid", + "privateEndpoint": { + "id": "pwvla" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "iyhfjnligaieovq", + "actionsRequired": "jnyswa" + }, + "groupIds": [ + "szjqerjjtbcxjxsaqlfcexperaoc" + ] + }, + "id": "kjmlgsuyzzimq", + "name": "uolibxojvjdp", + "type": "tlajrvzuisxmtgsswn", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "enforceDataIntegrityCheckForIscsi": true + }, + "id": "wawodajygzedvsz", + "name": "jacnlsnxssywuk", + "type": "kbvsfyul", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..a486223a5273 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VolumeGroups_Update", + "operationId": "VolumeGroups_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": {}, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..a84039665d2e --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "VolumeSnapshots_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "VolumeSnapshots_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "parameters": { + "properties": { + "creationData": { + "sourceId": "o" + } + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationData": { + "sourceId": "o" + }, + "provisioningState": "Invalid", + "sourceVolumeSizeGiB": 18, + "volumeName": "whboeudd" + }, + "id": "tzrkidbbzldzqehoztnddmzkpam", + "name": "oughhb", + "type": "nmkshfnfxxsduacbp", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "creationData": { + "sourceId": "o" + }, + "provisioningState": "Invalid", + "sourceVolumeSizeGiB": 18, + "volumeName": "whboeudd" + }, + "id": "tzrkidbbzldzqehoztnddmzkpam", + "name": "oughhb", + "type": "nmkshfnfxxsduacbp", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..b556eae88362 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MinimumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "VolumeSnapshots_Create", + "operationId": "VolumeSnapshots_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "parameters": { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + } + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + }, + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "creationData": { + "sourceId": "vfirlleqvpepxnptyyrz" + }, + "provisioningState": "Invalid", + "sourceVolumeSizeGiB": 28, + "volumeName": "o" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..1b9d3424af58 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VolumeSnapshots_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "VolumeSnapshots_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..10b83e5ae84e --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VolumeSnapshots_Delete", + "operationId": "VolumeSnapshots_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f0e49b65e11d --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "VolumeSnapshots_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "VolumeSnapshots_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationData": { + "sourceId": "o" + }, + "provisioningState": "Invalid", + "sourceVolumeSizeGiB": 18, + "volumeName": "whboeudd" + }, + "id": "tzrkidbbzldzqehoztnddmzkpam", + "name": "oughhb", + "type": "nmkshfnfxxsduacbp", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..6431f0f58151 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MinimumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "VolumeSnapshots_Get", + "operationId": "VolumeSnapshots_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "snapshotName": "snapshotname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationData": { + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" + }, + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" + }, + "id": "bbqqgzxagggqgkdgjqq", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", + "systemData": { + "createdBy": "f", + "createdByType": "User", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-06T06:58:45.864Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..829a2cb36e4d --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "VolumeSnapshots_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "$filter": "znhowhiiiika", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "creationData": { + "sourceId": "o" + }, + "provisioningState": "Invalid", + "sourceVolumeSizeGiB": 18, + "volumeName": "whboeudd" + }, + "id": "tzrkidbbzldzqehoztnddmzkpam", + "name": "oughhb", + "type": "nmkshfnfxxsduacbp", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "nextLink": "eiz" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..44b54dfda483 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VolumeSnapshots_ListByVolumeGroup", + "operationId": "VolumeSnapshots_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..9fca4f0344b5 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "Volumes_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "Volumes_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": { + "properties": { + "creationData": { + "createSource": "None", + "sourceId": "fkackofx" + }, + "sizeGiB": 10, + "managedBy": { + "resourceId": "fyodcxvtqlspavsxygxc" + } + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "zknqnsqrk", + "creationData": { + "createSource": "None", + "sourceId": "fkackofx" + }, + "sizeGiB": 10, + "storageTarget": { + "targetIqn": "uwcmcmnijctbcjbkjfnzsa", + "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", + "targetPortalPort": 9, + "provisioningState": "Invalid", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "fyodcxvtqlspavsxygxc" + }, + "provisioningState": "Invalid" + }, + "id": "jdx", + "name": "erxwbvxsi", + "type": "atcxo", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "volumeId": "zknqnsqrk", + "creationData": { + "createSource": "None", + "sourceId": "fkackofx" + }, + "sizeGiB": 10, + "storageTarget": { + "targetIqn": "uwcmcmnijctbcjbkjfnzsa", + "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", + "targetPortalPort": 9, + "provisioningState": "Invalid", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "fyodcxvtqlspavsxygxc" + }, + "provisioningState": "Invalid" + }, + "id": "jdx", + "name": "erxwbvxsi", + "type": "atcxo", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..8d47a2f024ba --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MinimumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "title": "Volumes_Create", + "operationId": "Volumes_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": { + "properties": { + "sizeGiB": 9 + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..063d3ba462a7 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MaximumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "title": "Volumes_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "Volumes_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2024-05-01", + "x-ms-delete-snapshots": "true", + "x-ms-force-delete": "true" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..3140739f22ae --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Volumes_Delete", + "operationId": "Volumes_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a53c25a8827a --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "Volumes_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "Volumes_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "zknqnsqrk", + "creationData": { + "createSource": "None", + "sourceId": "fkackofx" + }, + "sizeGiB": 10, + "storageTarget": { + "targetIqn": "uwcmcmnijctbcjbkjfnzsa", + "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", + "targetPortalPort": 9, + "provisioningState": "Invalid", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "fyodcxvtqlspavsxygxc" + }, + "provisioningState": "Invalid" + }, + "id": "jdx", + "name": "erxwbvxsi", + "type": "atcxo", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..8fb0bb404424 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MinimumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "Volumes_Get", + "operationId": "Volumes_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..9218a72fcf6a --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "Volumes_ListByVolumeGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "Volumes_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "volumeId": "zknqnsqrk", + "creationData": { + "createSource": "None", + "sourceId": "fkackofx" + }, + "sizeGiB": 10, + "storageTarget": { + "targetIqn": "uwcmcmnijctbcjbkjfnzsa", + "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", + "targetPortalPort": 9, + "provisioningState": "Invalid", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "fyodcxvtqlspavsxygxc" + }, + "provisioningState": "Invalid" + }, + "id": "jdx", + "name": "erxwbvxsi", + "type": "atcxo", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + ], + "nextLink": "wjkvqvvzdqoxzs" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..f8559c164593 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "Volumes_ListByVolumeGroup", + "operationId": "Volumes_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..dbd24c57d9f6 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "Volumes_Update_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "Volumes_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": { + "properties": { + "sizeGiB": 30, + "managedBy": { + "resourceId": "fyodcxvtqlspavsxygxc" + } + } + }, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "zknqnsqrk", + "creationData": { + "createSource": "None", + "sourceId": "fkackofx" + }, + "sizeGiB": 10, + "storageTarget": { + "targetIqn": "uwcmcmnijctbcjbkjfnzsa", + "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", + "targetPortalPort": 9, + "provisioningState": "Invalid", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "fyodcxvtqlspavsxygxc" + }, + "provisioningState": "Invalid" + }, + "id": "jdx", + "name": "erxwbvxsi", + "type": "atcxo", + "systemData": { + "createdBy": "cuwjnszrvrxht", + "createdByType": "User", + "createdAt": "2024-05-13T06:23:45.838Z", + "lastModifiedBy": "snlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-05-13T06:23:45.838Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..ca17777d267b --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MinimumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "Volumes_Update", + "operationId": "Volumes_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": {}, + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", + "creationData": { + "createSource": "None", + "sourceId": "ARM Id of Resource" + }, + "sizeGiB": 9, + "storageTarget": { + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", + "status": "Invalid" + }, + "managedBy": { + "resourceId": "mtkeip" + }, + "provisioningState": "Invalid" + }, + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/readme.md b/specification/elasticsan/resource-manager/readme.md index f5f15602867b..3be0f264aabc 100644 --- a/specification/elasticsan/resource-manager/readme.md +++ b/specification/elasticsan/resource-manager/readme.md @@ -26,18 +26,27 @@ These are the global settings for the storagepool. ``` yaml openapi-type: arm -tag: package-2023-01 +tag: package-2024-05 ``` +### Tag: package-2024-05 + +These settings apply only when `--tag=package-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-2024-05' +input-file: + - Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json +``` ### Tag: package-2023-01 These settings apply only when `--tag=package-2023-01` is specified on the command line. -```yaml $(tag) == 'package-2023-01' +``` yaml $(tag) == 'package-2023-01' input-file: - Microsoft.ElasticSan/stable/2023-01-01/elasticsan.json ``` + ### Tag: package-preview-2022-12 These settings apply only when `--tag=package-preview-2022-12` is specified on the command line. diff --git a/specification/elasticsan/resource-manager/readme.typescript.md b/specification/elasticsan/resource-manager/readme.typescript.md index 10bc066af217..270fa94887e3 100644 --- a/specification/elasticsan/resource-manager/readme.typescript.md +++ b/specification/elasticsan/resource-manager/readme.typescript.md @@ -3,6 +3,11 @@ These settings apply only when `--typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. +``` yaml +modelerfour: + flatten-models: false +``` + ```yaml $(typescript) typescript: azure-arm: true From c2f037e49f15654488a8cd67b9154c76611b7229 Mon Sep 17 00:00:00 2001 From: Steven Nguyen <30740718+snguyen64@users.noreply.github.com> Date: Sun, 9 Jun 2024 11:57:40 -0400 Subject: [PATCH 134/343] update(acns): advanced networking profile to note addition costs (#29146) --- .../aks/preview/2024-03-02-preview/managedClusters.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-03-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-03-02-preview/managedClusters.json index 3d8580dc0551..576ed80bfc45 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-03-02-preview/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-03-02-preview/managedClusters.json @@ -8809,7 +8809,7 @@ }, "AdvancedNetworking": { "type": "object", - "description": "Advanced Networking profile for enabling observability on a cluster. For more information see aka.ms/aksadvancednetworking.", + "description": "Advanced Networking profile for enabling observability on a cluster. Note that enabling advanced networking features may incur additional costs. For more information see aka.ms/aksadvancednetworking.", "properties": { "observability": { "$ref": "#/definitions/AdvancedNetworkingObservability" From 224f1c73471189290b2a973166d1f4148e0a5ba0 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Mon, 10 Jun 2024 00:01:56 +0800 Subject: [PATCH 135/343] vmware, mgmt, tsp, bug fix for leaseTime to int64 (#29351) --- specification/vmware/Microsoft.AVS/models.tsp | 2 +- .../Microsoft.AVS/stable/2023-09-01/vmware.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/vmware/Microsoft.AVS/models.tsp b/specification/vmware/Microsoft.AVS/models.tsp index 48f2c432c69b..a9c4f74bce4a 100644 --- a/specification/vmware/Microsoft.AVS/models.tsp +++ b/specification/vmware/Microsoft.AVS/models.tsp @@ -1360,7 +1360,7 @@ model WorkloadNetworkDhcpServer extends WorkloadNetworkDhcpEntity { serverAddress?: string; @doc("DHCP Server Lease Time.") - leaseTime?: int32; + leaseTime?: int64; @doc("Type of DHCP: SERVER or RELAY.") dhcpType: DhcpTypeEnum.SERVER; diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json index 7df2413fac30..e50c56d874fe 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json @@ -10304,7 +10304,7 @@ }, "leaseTime": { "type": "integer", - "format": "int32", + "format": "int64", "description": "DHCP Server Lease Time." } }, @@ -10325,7 +10325,7 @@ }, "leaseTime": { "type": "integer", - "format": "int32", + "format": "int64", "description": "DHCP Server Lease Time." } }, From 1cb8cb0a95c20513c5d767614888f415be99245d Mon Sep 17 00:00:00 2001 From: InbalZim <48387592+InbalZim@users.noreply.github.com> Date: Mon, 10 Jun 2024 10:48:40 +0300 Subject: [PATCH 136/343] [Microsoft.StorageMover] [UploadLimitSchedule] [v2024-07-01] (#29082) * Implemented ULS - copied v2024-07-01 files (incl. readme) from RPSaaSMaster branch * Removed reference to `v2024-05-01-preview` --- .../Agents_CreateOrUpdate_MaximumSet.json | 84 + .../Agents_CreateOrUpdate_MinimumSet.json | 46 + ...rUpdate_UploadLimitSchedule_Overnight.json | 134 + .../2024-07-01/examples/Agents_Delete.json | 20 + .../examples/Agents_Get_MaximumSet.json | 59 + .../examples/Agents_Get_MinimumSet.json | 40 + .../examples/Agents_List_MaximumSet.json | 138 + .../examples/Agents_List_MinimumSet.json | 16 + .../2024-07-01/examples/Agents_Update.json | 82 + ...ateOrUpdate_AzureStorageBlobContainer.json | 35 + ...eateOrUpdate_AzureStorageSmbFileShare.json | 35 + .../Endpoints_CreateOrUpdate_NfsMount.json | 36 + .../Endpoints_CreateOrUpdate_SmbMount.json | 45 + .../2024-07-01/examples/Endpoints_Delete.json | 19 + ...dpoints_Get_AzureStorageBlobContainer.json | 27 + ...ndpoints_Get_AzureStorageSmbFileShare.json | 27 + .../examples/Endpoints_Get_NfsMount.json | 28 + .../examples/Endpoints_Get_SmbMount.json | 32 + .../2024-07-01/examples/Endpoints_List.json | 56 + ...ints_Update_AzureStorageBlobContainer.json | 33 + ...oints_Update_AzureStorageSmbFileShare.json | 33 + .../examples/Endpoints_Update_NfsMount.json | 34 + .../examples/Endpoints_Update_SmbMount.json | 43 + .../JobDefinitions_CreateOrUpdate.json | 45 + .../examples/JobDefinitions_Delete.json | 20 + .../examples/JobDefinitions_Get.json | 34 + .../examples/JobDefinitions_List.json | 86 + .../examples/JobDefinitions_StartJob.json | 17 + .../examples/JobDefinitions_StopJob.json | 17 + .../examples/JobDefinitions_Update.json | 40 + .../2024-07-01/examples/JobRuns_Get.json | 48 + .../2024-07-01/examples/JobRuns_List.json | 118 + .../2024-07-01/examples/Operations_List.json | 44 + .../examples/Projects_CreateOrUpdate.json | 26 + .../2024-07-01/examples/Projects_Delete.json | 19 + .../2024-07-01/examples/Projects_Get.json | 21 + .../2024-07-01/examples/Projects_List.json | 41 + .../2024-07-01/examples/Projects_Update.json | 26 + .../StorageMovers_CreateOrUpdate.json | 43 + .../examples/StorageMovers_Delete.json | 18 + .../examples/StorageMovers_Get.json | 33 + .../examples/StorageMovers_List.json | 79 + .../StorageMovers_ListBySubscription.json | 78 + .../examples/StorageMovers_Update.json | 38 + .../stable/2024-07-01/storagemover.json | 2893 +++++++++++++++++ .../storagemover/resource-manager/readme.md | 14 +- 46 files changed, 4898 insertions(+), 2 deletions(-) create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_MaximumSet.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_MinimumSet.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_UploadLimitSchedule_Overnight.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Delete.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Get_MaximumSet.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Get_MinimumSet.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_List_MaximumSet.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_List_MinimumSet.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Update.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_AzureStorageBlobContainer.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_AzureStorageSmbFileShare.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_NfsMount.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_SmbMount.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Delete.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_AzureStorageBlobContainer.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_AzureStorageSmbFileShare.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_NfsMount.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_SmbMount.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_List.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_AzureStorageBlobContainer.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_AzureStorageSmbFileShare.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_NfsMount.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_SmbMount.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_CreateOrUpdate.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Delete.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Get.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_List.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_StartJob.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_StopJob.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Update.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobRuns_Get.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobRuns_List.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Operations_List.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_CreateOrUpdate.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Delete.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Get.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_List.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Update.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_CreateOrUpdate.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Delete.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Get.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_List.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_ListBySubscription.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Update.json create mode 100644 specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/storagemover.json diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_MaximumSet.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_MaximumSet.json new file mode 100644 index 000000000000..be3c19b0015f --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_MaximumSet.json @@ -0,0 +1,84 @@ +{ + "operationId": "Agents_CreateOrUpdate", + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName", + "api-version": "2024-07-01", + "agent": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "description": "Example Agent Description", + "uploadLimitSchedule": { + "weeklyRecurrences": [ + { + "days": [ + "Monday" + ], + "startTime": { + "hour": 9, + "minute": 0 + }, + "endTime": { + "hour": 18, + "minute": 30 + }, + "limitInMbps": 2000 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "description": "Example Agent Description", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 4096, + "numberOfCores": 8, + "uptimeInSeconds": 522, + "timeZone": "Eastern Standard Time", + "uploadLimitSchedule": { + "weeklyRecurrences": [ + { + "days": [ + "Monday" + ], + "startTime": { + "hour": 9, + "minute": 0 + }, + "endTime": { + "hour": 18, + "minute": 30 + }, + "limitInMbps": 2000 + } + ] + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName", + "name": "examples-agentName", + "type": "Microsoft.StorageMover/storageMovers/agents" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_MinimumSet.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_MinimumSet.json new file mode 100644 index 000000000000..1c62cb55ddf1 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_MinimumSet.json @@ -0,0 +1,46 @@ +{ + "operationId": "Agents_CreateOrUpdate", + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName", + "api-version": "2024-07-01", + "agent": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 4096, + "numberOfCores": 8, + "uptimeInSeconds": 522, + "timeZone": "Eastern Standard Time", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName", + "name": "examples-agentName", + "type": "Microsoft.StorageMover/storageMovers/agents" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_UploadLimitSchedule_Overnight.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_UploadLimitSchedule_Overnight.json new file mode 100644 index 000000000000..d20777ac71f1 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_CreateOrUpdate_UploadLimitSchedule_Overnight.json @@ -0,0 +1,134 @@ +{ + "operationId": "Agents_CreateOrUpdate", + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName", + "api-version": "2024-07-01", + "agent": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "uploadLimitSchedule": { + "weeklyRecurrences": [ + { + "days": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "startTime": { + "hour": 18, + "minute": 0 + }, + "endTime": { + "hour": 24, + "minute": 0 + }, + "limitInMbps": 2000 + }, + { + "days": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "startTime": { + "hour": 0, + "minute": 0 + }, + "endTime": { + "hour": 9, + "minute": 0 + }, + "limitInMbps": 2000 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 4096, + "numberOfCores": 8, + "uptimeInSeconds": 522, + "timeZone": "Eastern Standard Time", + "uploadLimitSchedule": { + "weeklyRecurrences": [ + { + "days": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "startTime": { + "hour": 18, + "minute": 0 + }, + "endTime": { + "hour": 24, + "minute": 0 + }, + "limitInMbps": 2000 + }, + { + "days": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "startTime": { + "hour": 0, + "minute": 0 + }, + "endTime": { + "hour": 9, + "minute": 0 + }, + "limitInMbps": 2000 + } + ] + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName", + "name": "examples-agentName", + "type": "Microsoft.StorageMover/storageMovers/agents" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Delete.json new file mode 100644 index 000000000000..28339629b7d9 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "Agents_Delete", + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName", + "api-version": "2024-07-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/locations/SWEDENCENTRAL/operationStatuses/6ba7b810-9dad-11d1-80b4-00c04fd430c8?api-version=2024-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/locations/SWEDENCENTRAL/operationStatuses/6ba7b810-9dad-11d1-80b4-00c04fd430c8?api-version=2024-07-01" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Get_MaximumSet.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Get_MaximumSet.json new file mode 100644 index 000000000000..1b9bdd7a47c4 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Get_MaximumSet.json @@ -0,0 +1,59 @@ +{ + "operationId": "Agents_Get", + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "description": "Example Agent Description", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 4096, + "numberOfCores": 8, + "uptimeInSeconds": 522, + "timeZone": "Eastern Standard Time", + "uploadLimitSchedule": { + "weeklyRecurrences": [ + { + "days": [ + "Monday" + ], + "startTime": { + "hour": 9, + "minute": 0 + }, + "endTime": { + "hour": 18, + "minute": 30 + }, + "limitInMbps": 2000 + } + ] + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName", + "name": "examples-agentName", + "type": "Microsoft.StorageMover/storageMovers/agents" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Get_MinimumSet.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Get_MinimumSet.json new file mode 100644 index 000000000000..89f88c4f81a0 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Get_MinimumSet.json @@ -0,0 +1,40 @@ +{ + "operationId": "Agents_Get", + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 4096, + "numberOfCores": 8, + "uptimeInSeconds": 522, + "timeZone": "Eastern Standard Time", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName", + "name": "examples-agentName", + "type": "Microsoft.StorageMover/storageMovers/agents" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_List_MaximumSet.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_List_MaximumSet.json new file mode 100644 index 000000000000..1c775191e950 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_List_MaximumSet.json @@ -0,0 +1,138 @@ +{ + "operationId": "Agents_List", + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName1", + "name": "examples-agentName1", + "type": "Microsoft.StorageMover/storageMovers/agents", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName1", + "description": "Example Agent 1 Description", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 4096, + "numberOfCores": 8, + "uptimeInSeconds": 522, + "timeZone": "Eastern Standard Time", + "uploadLimitSchedule": { + "weeklyRecurrences": [ + { + "days": [ + "Monday" + ], + "startTime": { + "hour": 9, + "minute": 0 + }, + "endTime": { + "hour": 18, + "minute": 30 + }, + "limitInMbps": 2000 + } + ] + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName2", + "name": "examples-agentName2", + "type": "Microsoft.StorageMover/storageMovers/agents", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName2", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "arcVmUuid": "147a1f84-7bbf-4e99-9a6a-a1735a91dfd5", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 4096, + "numberOfCores": 8, + "uptimeInSeconds": 877, + "timeZone": "Eastern Standard Time", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName3", + "name": "examples-agentName3", + "type": "Microsoft.StorageMover/storageMovers/agents", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName3", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "arcVmUuid": "648a7958-f99e-4268-b20e-94c96558dc0d", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 100024, + "numberOfCores": 32, + "uptimeInSeconds": 1025, + "errorDetails": { + "code": "SampleErrorCode", + "message": "Detailed sample error message." + }, + "timeZone": "Eastern Standard Time", + "uploadLimitSchedule": { + "weeklyRecurrences": [ + { + "days": [ + "Saturday", + "Sunday" + ], + "startTime": { + "hour": 0, + "minute": 0 + }, + "endTime": { + "hour": 24, + "minute": 0 + }, + "limitInMbps": 5000 + } + ] + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_List_MinimumSet.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_List_MinimumSet.json new file mode 100644 index 000000000000..ec33924086c6 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_List_MinimumSet.json @@ -0,0 +1,16 @@ +{ + "operationId": "Agents_List", + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Update.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Update.json new file mode 100644 index 000000000000..2739afb31f45 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Update.json @@ -0,0 +1,82 @@ +{ + "operationId": "Agents_Update", + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName", + "api-version": "2024-07-01", + "agent": { + "properties": { + "description": "Example Agent Description", + "uploadLimitSchedule": { + "weeklyRecurrences": [ + { + "days": [ + "Monday" + ], + "startTime": { + "hour": 9, + "minute": 0 + }, + "endTime": { + "hour": 18, + "minute": 30 + }, + "limitInMbps": 2000 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "description": "Example Agent Description", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 4096, + "numberOfCores": 8, + "uptimeInSeconds": 522, + "timeZone": "Eastern Standard Time", + "uploadLimitSchedule": { + "weeklyRecurrences": [ + { + "days": [ + "Monday" + ], + "startTime": { + "hour": 9, + "minute": 0 + }, + "endTime": { + "hour": 18, + "minute": 30 + }, + "limitInMbps": 2000 + } + ] + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName", + "name": "examples-agentName", + "type": "Microsoft.StorageMover/storageMovers/agents" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_AzureStorageBlobContainer.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_AzureStorageBlobContainer.json new file mode 100644 index 000000000000..b45f026a8667 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_AzureStorageBlobContainer.json @@ -0,0 +1,35 @@ +{ + "title": "Endpoints_CreateOrUpdate_AzureStorageBlobContainer", + "operationId": "Endpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer", + "description": "Example Storage Blob Container Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer", + "description": "Example Storage Blob Container Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_AzureStorageSmbFileShare.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_AzureStorageSmbFileShare.json new file mode 100644 index 000000000000..582e9f8c6ee6 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_AzureStorageSmbFileShare.json @@ -0,0 +1,35 @@ +{ + "title": "Endpoints_CreateOrUpdate_AzureStorageSmbFileShare", + "operationId": "Endpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "fileShareName": "examples-fileshare", + "description": "Example Storage File Share Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "fileShareName": "examples-fileshare", + "description": "Example Storage File Share Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_NfsMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_NfsMount.json new file mode 100644 index 000000000000..301a1b1b8f5a --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_NfsMount.json @@ -0,0 +1,36 @@ +{ + "title": "Endpoints_CreateOrUpdate_NfsMount", + "operationId": "Endpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "export": "examples-exportName", + "description": "Example NFS Mount Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "export": "examples-exportName", + "nfsVersion": "NFSauto", + "description": "Example NFS Mount Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_SmbMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_SmbMount.json new file mode 100644 index 000000000000..522d9f4d0f41 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_CreateOrUpdate_SmbMount.json @@ -0,0 +1,45 @@ +{ + "title": "Endpoints_CreateOrUpdate_SmbMount", + "operationId": "Endpoints_CreateOrUpdate", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "SmbMount", + "host": "0.0.0.0", + "shareName": "examples-shareName", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-password" + }, + "description": "Example SMB Mount Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "SmbMount", + "host": "0.0.0.0", + "shareName": "examples-shareName", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-password" + }, + "description": "Example SMB Mount Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Delete.json new file mode 100644 index 000000000000..3d1da0c5d1ad --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/operationResults/delete0", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.StorageMover/operationStatuses/delete0" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_AzureStorageBlobContainer.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_AzureStorageBlobContainer.json new file mode 100644 index 000000000000..a30fddca843f --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_AzureStorageBlobContainer.json @@ -0,0 +1,27 @@ +{ + "title": "Endpoints_Get_AzureStorageBlobContainer", + "operationId": "Endpoints_Get", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer", + "description": "Example Storage Blob Container Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_AzureStorageSmbFileShare.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_AzureStorageSmbFileShare.json new file mode 100644 index 000000000000..298c2de28978 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_AzureStorageSmbFileShare.json @@ -0,0 +1,27 @@ +{ + "title": "Endpoints_Get_AzureStorageSmbFileShare", + "operationId": "Endpoints_Get", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "fileShareName": "examples-fileshare", + "description": "Example Storage File Share Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_NfsMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_NfsMount.json new file mode 100644 index 000000000000..6b6727baddec --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_NfsMount.json @@ -0,0 +1,28 @@ +{ + "title": "Endpoints_Get_NfsMount", + "operationId": "Endpoints_Get", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "export": "examples-exportName", + "nfsVersion": "NFSauto", + "description": "Example NFS Mount Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_SmbMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_SmbMount.json new file mode 100644 index 000000000000..6297dcfce3b2 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Get_SmbMount.json @@ -0,0 +1,32 @@ +{ + "title": "Endpoints_Get_SmbMount", + "operationId": "Endpoints_Get", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "SmbMount", + "host": "0.0.0.0", + "shareName": "examples-shareName", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-password" + }, + "description": "Example SMB Mount Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_List.json new file mode 100644 index 000000000000..01a17450a48e --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_List.json @@ -0,0 +1,56 @@ +{ + "title": "Endpoints_List", + "operationId": "Endpoints_List", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName1", + "name": "examples-endpointName1", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer1", + "description": "Example Storage Container Endpoint 1 Description", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName2", + "name": "examples-endpointName2", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "nfsVersion": "NFSv4", + "description": "Example Storage Container Endpoint 2 Description", + "export": "/", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName3", + "name": "examples-endpointName3", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer3", + "description": "Example Storage Container Endpoint 3 Description", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_AzureStorageBlobContainer.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_AzureStorageBlobContainer.json new file mode 100644 index 000000000000..c03bd991939c --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_AzureStorageBlobContainer.json @@ -0,0 +1,33 @@ +{ + "title": "Endpoints_Update_AzureStorageBlobContainer", + "operationId": "Endpoints_Update", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "AzureStorageBlobContainer", + "description": "Updated Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer", + "description": "Updated Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_AzureStorageSmbFileShare.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_AzureStorageSmbFileShare.json new file mode 100644 index 000000000000..bbab65db9438 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_AzureStorageSmbFileShare.json @@ -0,0 +1,33 @@ +{ + "title": "Endpoints_Update_AzureStorageSmbFileShare", + "operationId": "Endpoints_Update", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "description": "Updated Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "fileShareName": "examples-fileshare", + "description": "Updated Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_NfsMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_NfsMount.json new file mode 100644 index 000000000000..8dd04d37776a --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_NfsMount.json @@ -0,0 +1,34 @@ +{ + "title": "Endpoints_Update_NfsMount", + "operationId": "Endpoints_Update", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "NfsMount", + "description": "Updated Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "export": "examples-exportName", + "nfsVersion": "NFSauto", + "description": "Updated Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_SmbMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_SmbMount.json new file mode 100644 index 000000000000..5c7cf6eb1a89 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Endpoints_Update_SmbMount.json @@ -0,0 +1,43 @@ +{ + "title": "Endpoints_Update_SmbMount", + "operationId": "Endpoints_Update", + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "SmbMount", + "description": "Updated Endpoint Description", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-updated-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-updated-password" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "SmbMount", + "host": "0.0.0.0", + "shareName": "examples-shareName", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-updated-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-updated-password" + }, + "description": "Updated Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_CreateOrUpdate.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_CreateOrUpdate.json new file mode 100644 index 000000000000..10f58eb60538 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_CreateOrUpdate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName", + "jobDefinition": { + "properties": { + "description": "Example Job Definition Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName", + "targetSubpath": "/", + "agentName": "migration-agent" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName/jobDefinitions/examples-jobDefinitionName", + "name": "examples-jobDefinitionName", + "type": "Microsoft.StorageMover/storageMovers/projectName/jobDefinitionName", + "properties": { + "description": "Example Job Definition Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Delete.json new file mode 100644 index 000000000000..b659e9085f8f --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/operationResults/delete0", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.StorageMover/operationStatuses/delete0" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Get.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Get.json new file mode 100644 index 000000000000..6531cb1a21a1 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName", + "name": "examples-jobDefinitionName", + "type": "Microsoft.StorageMover/storageMovers/jobDefinitions", + "properties": { + "description": "Example Job Definition Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_List.json new file mode 100644 index 000000000000..e8ace730b7da --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_List.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName1", + "name": "examples-jobDefinitionName1", + "type": "Microsoft.StorageMover/storageMovers/jobDefinitions", + "properties": { + "description": "Example Job Definition 1 Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName1", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName1", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName1", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName1", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName2", + "name": "examples-jobDefinitionName2", + "type": "Microsoft.StorageMover/storageMovers/jobDefinitions", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Job Definition 2 Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName2", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName2", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName2", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName2", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName3", + "name": "examples-jobDefinitionName3", + "type": "Microsoft.StorageMover/storageMovers/jobDefinitions", + "properties": { + "description": "Example Job Definition 3 Description", + "copyMode": "Mirror", + "sourceName": "examples-sourceEndpointName3", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName3", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName3", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName3", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers/jobDefinitions?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_StartJob.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_StartJob.json new file mode 100644 index 000000000000..a7f686ff1ae5 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_StartJob.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName" + }, + "responses": { + "200": { + "body": { + "jobRunResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName/jobRuns/examples-jobRunName" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_StopJob.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_StopJob.json new file mode 100644 index 000000000000..a7f686ff1ae5 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_StopJob.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName" + }, + "responses": { + "200": { + "body": { + "jobRunResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName/jobRuns/examples-jobRunName" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Update.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Update.json new file mode 100644 index 000000000000..83747e2be672 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobDefinitions_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName", + "jobDefinition": { + "properties": { + "description": "Updated Job Definition Description", + "agentName": "updatedAgentName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName/jobDefinitions/examples-jobDefinitionName", + "name": "examples-jobDefinitionName", + "type": "Microsoft.StorageMover/storageMovers/projectName/jobDefinitionName", + "properties": { + "description": "Updated Job Definition Description", + "copyMode": "Additive", + "sourceName": "updatedSource", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/updatedSource", + "sourceSubpath": "/", + "targetName": "updatedTarget", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/updatedTarget", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "updatedAgentName", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobRuns_Get.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobRuns_Get.json new file mode 100644 index 000000000000..44c23e1d3709 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobRuns_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName", + "jobRunName": "examples-jobRunName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName/jobDefinitions/examples-jobDefinitionName/jobRuns/examples-jobRunName", + "name": "examples-jobRunName", + "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns", + "properties": { + "status": "Running", + "scanStatus": "Scanning", + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent", + "executionStartTime": "2023-07-01T02:11:01.1075056Z", + "executionEndTime": null, + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "sourceName": "sourceEndpoint", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint", + "sourceProperties": {}, + "targetName": "targetEndpoint", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint", + "targetProperties": {}, + "jobDefinitionProperties": {}, + "itemsScanned": 351, + "itemsExcluded": 50, + "itemsUnsupported": 27, + "itemsNoTransferNeeded": 150, + "itemsFailed": 3, + "itemsTransferred": 100, + "bytesScanned": 49951162777600, + "bytesExcluded": 995116277760, + "bytesUnsupported": 495116277760, + "bytesNoTransferNeeded": 2995116277760, + "bytesFailed": 5116277760, + "bytesTransferred": 1995116277760 + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobRuns_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobRuns_List.json new file mode 100644 index 000000000000..e3505142058a --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/JobRuns_List.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projectName/examples-projectName/jobDefinitions/examples-jobDefinitionName1/jobRuns/examples-jobRunName1", + "name": "examples-jobRunName1", + "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns", + "properties": { + "status": "Running", + "scanStatus": "Scanning", + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent", + "executionStartTime": "2023-07-01T02:11:01.1075056Z", + "executionEndTime": null, + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "sourceName": "sourceEndpoint", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint", + "sourceProperties": {}, + "targetName": "targetEndpoint", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint", + "targetProperties": {}, + "jobDefinitionProperties": {}, + "itemsScanned": 351, + "itemsExcluded": 50, + "itemsUnsupported": 27, + "itemsNoTransferNeeded": 150, + "itemsFailed": 3, + "itemsTransferred": 100, + "bytesScanned": 49951162777600, + "bytesExcluded": 995116277760, + "bytesUnsupported": 495116277760, + "bytesNoTransferNeeded": 2995116277760, + "bytesFailed": 5116277760, + "bytesTransferred": 1995116277760 + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projectName/examples-projectName/jobDefinitions/examples-jobDefinitionName1/jobRuns/examples-jobRunName2", + "name": "examples-jobRunName2", + "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns", + "properties": { + "status": "Failed", + "scanStatus": "Scanning", + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent", + "executionStartTime": "2023-07-01T02:11:01.1075056Z", + "executionEndTime": null, + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "sourceName": "sourceEndpoint", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint", + "sourceProperties": {}, + "targetName": "targetEndpoint", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint", + "targetProperties": {}, + "jobDefinitionProperties": {}, + "itemsScanned": 351, + "itemsExcluded": 50, + "itemsUnsupported": 27, + "itemsNoTransferNeeded": 150, + "itemsFailed": 3, + "itemsTransferred": 100, + "bytesScanned": 49951162777600, + "bytesExcluded": 995116277760, + "bytesUnsupported": 495116277760, + "bytesNoTransferNeeded": 2995116277760, + "bytesFailed": 5116277760, + "bytesTransferred": 1995116277760 + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projectName/examples-projectName/jobDefinitions/examples-jobDefinitionName1/jobRuns/examples-jobRunName3", + "name": "examples-jobRunName3", + "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns", + "properties": { + "status": "Failed", + "scanStatus": "Scanning", + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent", + "executionStartTime": "2023-07-01T02:11:01.1075056Z", + "executionEndTime": null, + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "sourceName": "sourceEndpoint", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint", + "sourceProperties": {}, + "targetName": "targetEndpoint", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint", + "targetProperties": {}, + "jobDefinitionProperties": {}, + "itemsScanned": 351, + "itemsExcluded": 50, + "itemsUnsupported": 27, + "itemsNoTransferNeeded": 150, + "itemsFailed": 3, + "itemsTransferred": 100, + "bytesScanned": 49951162777600, + "bytesExcluded": 995116277760, + "bytesUnsupported": 495116277760, + "bytesNoTransferNeeded": 2995116277760, + "bytesFailed": 5116277760, + "bytesTransferred": 1995116277760 + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Operations_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Operations_List.json new file mode 100644 index 000000000000..31e85cf07936 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Operations_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.StorageMover/storageMovers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft StorageMover", + "resource": "StorageMovers", + "operation": "Get or List StorageMover resource(s).", + "description": "Gets or Lists existing StorageMover resource(s)." + } + }, + { + "name": "Microsoft.StorageMover/storageMovers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft StorageMover", + "resource": "StorageMovers", + "operation": "Create or Update StorageMover resource.", + "description": "Creates or Updates StorageMover resource." + } + }, + { + "name": "Microsoft.StorageMover/storageMovers/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft StorageMover", + "resource": "StorageMovers", + "operation": "Delete StorageMover resource.", + "description": "Deletes StorageMover resource." + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/operations?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_CreateOrUpdate.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_CreateOrUpdate.json new file mode 100644 index 000000000000..dea91afc5009 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_CreateOrUpdate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "project": { + "properties": { + "description": "Example Project Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName", + "name": "examples-projectName", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Delete.json new file mode 100644 index 000000000000..e45e5ac62538 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/operationResults/delete0", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.StorageMover/operationStatuses/delete0" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Get.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Get.json new file mode 100644 index 000000000000..f1f3d39eff6a --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName", + "name": "examples-projectName", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_List.json new file mode 100644 index 000000000000..5f4103402205 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName1", + "name": "examples-projectName1", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project 1 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName2", + "name": "examples-projectName2", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project 2 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName2", + "name": "examples-projectName3", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project 3 Description" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers/projects?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Update.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Update.json new file mode 100644 index 000000000000..390e84dbd430 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Projects_Update.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "project": { + "properties": { + "description": "Example Project Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-projectName", + "name": "examples-projectName", + "type": "Microsoft.StorageMover/storageMovers/projectName", + "properties": { + "description": "Example Project Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_CreateOrUpdate.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_CreateOrUpdate.json new file mode 100644 index 000000000000..af8e6599da0e --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_CreateOrUpdate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "storageMover": { + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "Example Storage Mover Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName", + "name": "examples-storageMoverName", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Delete.json new file mode 100644 index 000000000000..56554b316736 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/operationResults/delete0", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.StorageMover/operationStatuses/delete0" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Get.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Get.json new file mode 100644 index 000000000000..9ba3110cf155 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName", + "name": "examples-storageMoverName", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_List.json new file mode 100644 index 000000000000..3a94a4bb294e --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_List.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName1", + "name": "examples-storageMoverResourceName1", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 1 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName2", + "name": "examples-storageMoverResourceName2", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 2 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName3", + "name": "examples-storageMoverResourceName3", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 3 Description" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_ListBySubscription.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_ListBySubscription.json new file mode 100644 index 000000000000..fdd601b615af --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_ListBySubscription.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName1", + "name": "examples-storageMoverResourceName1", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 1 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg2/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName2", + "name": "examples-storageMoverResourceName2", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 2 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName3", + "name": "examples-storageMoverResourceName3", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 3 Description" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Update.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Update.json new file mode 100644 index 000000000000..60adc614b8c8 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/StorageMovers_Update.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "storageMover": { + "properties": { + "description": "Updated Storage Mover Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName", + "name": "examples-storageMoverName", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Updated Storage Mover Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/storagemover.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/storagemover.json new file mode 100644 index 000000000000..f073e9d55069 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/storagemover.json @@ -0,0 +1,2893 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-07-01", + "title": "StorageMoverClient", + "description": "The Azure Storage Mover REST API." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.StorageMover/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all the supported operations for the Azure Storage Mover REST API.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of supported operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageMover/storageMovers": { + "get": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_ListBySubscription", + "description": "Lists all Storage Movers in a subscription.", + "x-ms-examples": { + "StorageMovers_List": { + "$ref": "./examples/StorageMovers_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Storage Movers.", + "schema": { + "$ref": "#/definitions/StorageMoverList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers": { + "get": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_List", + "description": "Lists all Storage Movers in a resource group.", + "x-ms-examples": { + "StorageMovers_List": { + "$ref": "./examples/StorageMovers_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Storage Movers.", + "schema": { + "$ref": "#/definitions/StorageMoverList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}": { + "get": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_Get", + "description": "Gets a Storage Mover resource.", + "x-ms-examples": { + "StorageMovers_Get": { + "$ref": "./examples/StorageMovers_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Storage Mover resource.", + "schema": { + "$ref": "#/definitions/StorageMover" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_CreateOrUpdate", + "description": "Creates or updates a top-level Storage Mover resource.", + "x-ms-examples": { + "StorageMovers_CreateOrUpdate": { + "$ref": "./examples/StorageMovers_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "storageMover", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageMover" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Storage Mover resource.", + "schema": { + "$ref": "#/definitions/StorageMover" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_Update", + "description": "Updates properties for a Storage Mover resource. Properties not specified in the request body will be unchanged.", + "x-ms-examples": { + "StorageMovers_Update": { + "$ref": "./examples/StorageMovers_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "storageMover", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageMoverUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Storage Mover resource.", + "schema": { + "$ref": "#/definitions/StorageMover" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_Delete", + "description": "Deletes a Storage Mover resource.", + "x-ms-examples": { + "StorageMovers_Delete": { + "$ref": "./examples/StorageMovers_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Storage Mover." + }, + "202": { + "description": "Accepted. Storage Mover delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Storage Mover does not exist in the subscription." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents": { + "get": { + "tags": [ + "Agents" + ], + "operationId": "Agents_List", + "description": "Lists all Agents in a Storage Mover.", + "x-ms-examples": { + "Agents_List_MinimumSet": { + "$ref": "./examples/Agents_List_MinimumSet.json" + }, + "Agents_List_MaximumSet": { + "$ref": "./examples/Agents_List_MaximumSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Agents.", + "schema": { + "$ref": "#/definitions/AgentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents/{agentName}": { + "get": { + "tags": [ + "Agents" + ], + "operationId": "Agents_Get", + "description": "Gets an Agent resource.", + "x-ms-examples": { + "Agents_Get_MinimumSet": { + "$ref": "./examples/Agents_Get_MinimumSet.json" + }, + "Agents_Get_MaximumSet": { + "$ref": "./examples/Agents_Get_MaximumSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/AgentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Agent resource.", + "schema": { + "$ref": "#/definitions/Agent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Agents" + ], + "operationId": "Agents_CreateOrUpdate", + "description": "Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs.", + "x-ms-examples": { + "Agents_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/Agents_CreateOrUpdate_MinimumSet.json" + }, + "Agents_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/Agents_CreateOrUpdate_MaximumSet.json" + }, + "Agents_CreateOrUpdate_WithOvernightUploadLimitSchedule": { + "$ref": "./examples/Agents_CreateOrUpdate_UploadLimitSchedule_Overnight.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/AgentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "agent", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Agent" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Agent resource.", + "schema": { + "$ref": "#/definitions/Agent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Agents" + ], + "operationId": "Agents_Update", + "description": "Creates or updates an Agent resource.", + "x-ms-examples": { + "Agents_Update": { + "$ref": "./examples/Agents_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/AgentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "agent", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Agent resource.", + "schema": { + "$ref": "#/definitions/Agent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Agents" + ], + "operationId": "Agents_Delete", + "description": "Deletes an Agent resource.", + "x-ms-examples": { + "Agents_Delete": { + "$ref": "./examples/Agents_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/AgentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Agent." + }, + "202": { + "description": "Accepted. Agent delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Agent does not exist for this Storage Mover." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_List", + "description": "Lists all Endpoints in a Storage Mover.", + "x-ms-examples": { + "Endpoints_List": { + "$ref": "./examples/Endpoints_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Endpoints.", + "schema": { + "$ref": "#/definitions/EndpointList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Get", + "description": "Gets an Endpoint resource.", + "x-ms-examples": { + "Endpoints_Get_AzureStorageBlobContainer": { + "$ref": "./examples/Endpoints_Get_AzureStorageBlobContainer.json" + }, + "Endpoints_Get_AzureStorageSmbFileShare": { + "$ref": "./examples/Endpoints_Get_AzureStorageSmbFileShare.json" + }, + "Endpoints_Get_NfsMount": { + "$ref": "./examples/Endpoints_Get_NfsMount.json" + }, + "Endpoints_Get_SmbMount": { + "$ref": "./examples/Endpoints_Get_SmbMount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Endpoint resource.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_CreateOrUpdate", + "description": "Creates or updates an Endpoint resource, which represents a data transfer source or destination.", + "x-ms-examples": { + "Endpoints_CreateOrUpdate_AzureStorageBlobContainer": { + "$ref": "./examples/Endpoints_CreateOrUpdate_AzureStorageBlobContainer.json" + }, + "Endpoints_CreateOrUpdate_AzureStorageSmbFileShare": { + "$ref": "./examples/Endpoints_CreateOrUpdate_AzureStorageSmbFileShare.json" + }, + "Endpoints_CreateOrUpdate_NfsMount": { + "$ref": "./examples/Endpoints_CreateOrUpdate_NfsMount.json" + }, + "Endpoints_CreateOrUpdate_SmbMount": { + "$ref": "./examples/Endpoints_CreateOrUpdate_SmbMount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "endpoint", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Endpoint resource.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Update", + "description": "Updates properties for an Endpoint resource. Properties not specified in the request body will be unchanged.", + "x-ms-examples": { + "Endpoints_Update_AzureStorageBlobContainer": { + "$ref": "./examples/Endpoints_Update_AzureStorageBlobContainer.json" + }, + "Endpoints_Update_AzureStorageSmbFileShare": { + "$ref": "./examples/Endpoints_Update_AzureStorageSmbFileShare.json" + }, + "Endpoints_Update_NfsMount": { + "$ref": "./examples/Endpoints_Update_NfsMount.json" + }, + "Endpoints_Update_SmbMount": { + "$ref": "./examples/Endpoints_Update_SmbMount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "endpoint", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointBaseUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Endpoint resource.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Delete", + "description": "Deletes an Endpoint resource.", + "x-ms-examples": { + "Endpoints_Delete": { + "$ref": "./examples/Endpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Endpoint." + }, + "202": { + "description": "Accepted. Endpoint delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Endpoint does not exist for this Storage Mover." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects": { + "get": { + "tags": [ + "Projects" + ], + "operationId": "Projects_List", + "description": "Lists all Projects in a Storage Mover.", + "x-ms-examples": { + "Projects_List": { + "$ref": "./examples/Projects_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Projects.", + "schema": { + "$ref": "#/definitions/ProjectList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}": { + "get": { + "tags": [ + "Projects" + ], + "operationId": "Projects_Get", + "description": "Gets a Project resource.", + "x-ms-examples": { + "Projects_Get": { + "$ref": "./examples/Projects_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Project resource.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Projects" + ], + "operationId": "Projects_CreateOrUpdate", + "description": "Creates or updates a Project resource, which is a logical grouping of related jobs.", + "x-ms-examples": { + "Projects_CreateOrUpdate": { + "$ref": "./examples/Projects_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "project", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Project resource.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Projects" + ], + "operationId": "Projects_Update", + "description": "Updates properties for a Project resource. Properties not specified in the request body will be unchanged.", + "x-ms-examples": { + "Projects_Update": { + "$ref": "./examples/Projects_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "project", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Project resource.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Projects" + ], + "operationId": "Projects_Delete", + "description": "Deletes a Project resource.", + "x-ms-examples": { + "Projects_Delete": { + "$ref": "./examples/Projects_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Project." + }, + "202": { + "description": "Accepted. Project delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Project does not exist for this Storage Mover." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions": { + "get": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_List", + "description": "Lists all Job Definitions in a Project.", + "x-ms-examples": { + "JobDefinitions_List": { + "$ref": "./examples/JobDefinitions_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Job Definitions.", + "schema": { + "$ref": "#/definitions/JobDefinitionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}": { + "get": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_Get", + "description": "Gets a Job Definition resource.", + "x-ms-examples": { + "JobDefinitions_Get": { + "$ref": "./examples/JobDefinitions_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Job Definition resource.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_CreateOrUpdate", + "description": "Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.", + "x-ms-examples": { + "JobDefinitions_CreateOrUpdate": { + "$ref": "./examples/JobDefinitions_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "jobDefinition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Job Definition resource.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_Update", + "description": "Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.", + "x-ms-examples": { + "JobDefinitions_Update": { + "$ref": "./examples/JobDefinitions_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "jobDefinition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinitionUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Job Definition resource.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_Delete", + "description": "Deletes a Job Definition resource.", + "x-ms-examples": { + "Projects_Delete": { + "$ref": "./examples/JobDefinitions_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Job Definition." + }, + "202": { + "description": "Accepted. Job Definition delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Job Definition does not exist for this Project." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/startJob": { + "post": { + "consumes": [ + "application/json", + "application/x-www-form-urlencoded" + ], + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_StartJob", + "description": "Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.", + "x-ms-examples": { + "JobDefinitions_StartJob": { + "$ref": "./examples/JobDefinitions_StartJob.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested job to start.", + "schema": { + "$ref": "#/definitions/JobRunResourceId" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/stopJob": { + "post": { + "consumes": [ + "application/json", + "application/x-www-form-urlencoded" + ], + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_StopJob", + "description": "Requests the Agent of any active instance of this Job Definition to stop.", + "x-ms-examples": { + "JobDefinitions_StopJob": { + "$ref": "./examples/JobDefinitions_StopJob.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested running job to stop, if any.", + "schema": { + "$ref": "#/definitions/JobRunResourceId" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/jobRuns": { + "get": { + "tags": [ + "JobRuns" + ], + "operationId": "JobRuns_List", + "description": "Lists all Job Runs in a Job Definition.", + "x-ms-examples": { + "JobRuns_List": { + "$ref": "./examples/JobRuns_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Job Runs.", + "schema": { + "$ref": "#/definitions/JobRunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/jobRuns/{jobRunName}": { + "get": { + "tags": [ + "JobRuns" + ], + "operationId": "JobRuns_Get", + "description": "Gets a Job Run resource.", + "x-ms-examples": { + "JobRuns_Get": { + "$ref": "./examples/JobRuns_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "#/parameters/JobRunNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Job Run resource.", + "schema": { + "$ref": "#/definitions/JobRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AgentProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Agent." + }, + "agentVersion": { + "type": "string", + "description": "The Agent version.", + "readOnly": true + }, + "arcResourceId": { + "type": "string", + "description": "The fully qualified resource ID of the Hybrid Compute resource for the Agent.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "arcVmUuid": { + "type": "string", + "description": "The VM UUID of the Hybrid Compute resource for the Agent.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "agentStatus": { + "description": "The Agent status.", + "enum": [ + "Registering", + "Offline", + "Online", + "Executing", + "RequiresAttention", + "Unregistering" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentStatus", + "modelAsString": true + }, + "readOnly": true + }, + "lastStatusUpdate": { + "type": "string", + "format": "date-time", + "description": "The last updated time of the Agent status.", + "readOnly": true + }, + "localIPAddress": { + "type": "string", + "description": "Local IP address reported by the Agent.", + "readOnly": true + }, + "memoryInMB": { + "type": "integer", + "format": "int64", + "description": "Available memory reported by the Agent, in MB.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int64", + "description": "Available compute cores reported by the Agent.", + "readOnly": true + }, + "uptimeInSeconds": { + "type": "integer", + "format": "int64", + "description": "Uptime of the Agent in seconds.", + "readOnly": true + }, + "timeZone": { + "description": "The agent's local time zone represented in Windows format.", + "type": "string", + "readOnly": true + }, + "uploadLimitSchedule": { + "description": "The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time.", + "$ref": "#/definitions/UploadLimitSchedule" + }, + "errorDetails": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code reported by Agent" + }, + "message": { + "type": "string", + "description": "Expanded description of reported error code" + } + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "arcResourceId", + "arcVmUuid" + ] + }, + "Agent": { + "description": "The Agent resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AgentProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AgentUpdateProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Agent." + }, + "uploadLimitSchedule": { + "description": "The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time.", + "$ref": "#/definitions/UploadLimitSchedule" + } + } + }, + "AgentUpdateParameters": { + "description": "The Agent resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AgentUpdateProperties" + } + } + }, + "AgentList": { + "description": "List of Agents.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Agent" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "UploadLimitSchedule": { + "description": "The WAN-link upload limit schedule. Overlapping recurrences are not allowed.", + "type": "object", + "properties": { + "weeklyRecurrences": { + "description": "The set of weekly repeating recurrences of the WAN-link upload limit schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/UploadLimitWeeklyRecurrence" + }, + "x-ms-identifiers": [] + } + } + }, + "Recurrence": { + "description": "The schedule recurrence.", + "type": "object", + "properties": { + "startTime": { + "description": "The start time of the schedule recurrence. Full hour and 30-minute intervals are supported.", + "$ref": "#/definitions/Time" + }, + "endTime": { + "description": "The end time of the schedule recurrence. Full hour and 30-minute intervals are supported.", + "$ref": "#/definitions/Time" + } + }, + "required": [ + "startTime", + "endTime" + ] + }, + "WeeklyRecurrence": { + "type": "object", + "description": "The weekly recurrence of the schedule.", + "properties": { + "days": { + "description": "The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence.", + "type": "array", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + } + }, + "required": [ + "days" + ], + "allOf": [ + { + "$ref": "#/definitions/Recurrence" + } + ] + }, + "DayOfWeek": { + "description": "The day of week.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "UploadLimit": { + "description": "The WAN-link upload limit.", + "type": "object", + "properties": { + "limitInMbps": { + "description": "The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary.", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 2147483647 + } + }, + "required": [ + "limitInMbps" + ] + }, + "UploadLimitWeeklyRecurrence": { + "description": "The weekly recurrence of the WAN-link upload limit schedule. The start time must be earlier in the day than the end time. The recurrence must not span across multiple days.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WeeklyRecurrence" + }, + { + "$ref": "#/definitions/UploadLimit" + } + ] + }, + "Time": { + "description": "The time of day.", + "type": "object", + "properties": { + "hour": { + "description": "The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0.", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 24 + }, + "minute": { + "description": "The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0.", + "type": "integer", + "format": "int32", + "enum": [ + 0, + 30 + ], + "default": 0, + "x-ms-enum": { + "name": "Minute", + "modelAsString": true + } + } + }, + "required": [ + "hour" + ] + }, + "StorageMoverProperties": { + "description": "The resource specific properties for the Storage Mover resource.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Storage Mover." + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "StorageMover": { + "description": "The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageMoverProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "StorageMoverUpdateProperties": { + "description": "The resource specific properties for the Storage Mover resource.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Storage Mover." + } + } + }, + "StorageMoverUpdateParameters": { + "description": "The Storage Mover resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageMoverUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + } + }, + "StorageMoverList": { + "description": "List of Storage Movers.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageMover" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "EndpointBaseProperties": { + "description": "The resource specific properties for the Storage Mover resource.", + "type": "object", + "discriminator": "endpointType", + "properties": { + "endpointType": { + "description": "The Endpoint resource type.", + "$ref": "#/definitions/EndpointType", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "description": { + "type": "string", + "description": "A description for the Endpoint." + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "endpointType" + ] + }, + "Endpoint": { + "description": "The Endpoint resource, which contains information about file sources and targets.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EndpointBaseProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "EndpointBaseUpdateProperties": { + "description": "The Endpoint resource, which contains information about file sources and targets.", + "type": "object", + "discriminator": "endpointType", + "properties": { + "endpointType": { + "description": "The Endpoint resource type.", + "$ref": "#/definitions/EndpointType", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "description": { + "type": "string", + "description": "A description for the Endpoint." + } + }, + "required": [ + "endpointType" + ] + }, + "EndpointBaseUpdateParameters": { + "description": "The Endpoint resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + } + }, + "EndpointList": { + "description": "List of Endpoints.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "AzureStorageBlobContainerEndpointProperties": { + "type": "object", + "description": "The properties of Azure Storage blob container endpoint.", + "x-ms-discriminator-value": "AzureStorageBlobContainer", + "properties": { + "storageAccountResourceId": { + "description": "The Azure Resource ID of the storage account that is the target destination.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "blobContainerName": { + "description": "The name of the Storage blob container that is the target destination.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "storageAccountResourceId", + "blobContainerName" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseProperties" + } + ] + }, + "AzureStorageBlobContainerEndpointUpdateProperties": { + "type": "object", + "x-ms-discriminator-value": "AzureStorageBlobContainer", + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + ] + }, + "NfsMountEndpointProperties": { + "type": "object", + "description": "The properties of NFS share endpoint.", + "x-ms-discriminator-value": "NfsMount", + "properties": { + "host": { + "description": "The host name or IP address of the server exporting the file system.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nfsVersion": { + "description": "The NFS protocol version.", + "enum": [ + "NFSauto", + "NFSv3", + "NFSv4" + ], + "type": "string", + "x-ms-enum": { + "name": "NfsVersion", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "export": { + "description": "The directory being exported from the server.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "host", + "export" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseProperties" + } + ] + }, + "NfsMountEndpointUpdateProperties": { + "type": "object", + "x-ms-discriminator-value": "NfsMount", + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + ] + }, + "AzureStorageSmbFileShareEndpointProperties": { + "type": "object", + "description": "The properties of Azure Storage SMB file share endpoint.", + "x-ms-discriminator-value": "AzureStorageSmbFileShare", + "properties": { + "storageAccountResourceId": { + "description": "The Azure Resource ID of the storage account.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "fileShareName": { + "description": "The name of the Azure Storage file share.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "storageAccountResourceId", + "fileShareName" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseProperties" + } + ] + }, + "AzureStorageSmbFileShareEndpointUpdateProperties": { + "type": "object", + "x-ms-discriminator-value": "AzureStorageSmbFileShare", + "description": "The properties of Azure Storage SMB file share endpoint to update.", + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + ] + }, + "SmbMountEndpointProperties": { + "type": "object", + "description": "The properties of SMB share endpoint.", + "x-ms-discriminator-value": "SmbMount", + "properties": { + "host": { + "description": "The host name or IP address of the server exporting the file system.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "shareName": { + "description": "The name of the SMB share being exported from the server.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "credentials": { + "description": "The Azure Key Vault secret URIs which store the required credentials to access the SMB share.", + "$ref": "#/definitions/AzureKeyVaultSmbCredentials" + } + }, + "required": [ + "host", + "shareName" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseProperties" + } + ] + }, + "SmbMountEndpointUpdateProperties": { + "type": "object", + "x-ms-discriminator-value": "SmbMount", + "description": "The properties of SMB share endpoint to update.", + "properties": { + "credentials": { + "description": "The Azure Key Vault secret URIs which store the required credentials to access the SMB share.", + "$ref": "#/definitions/AzureKeyVaultSmbCredentials" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + ] + }, + "EndpointType": { + "description": "The Endpoint resource type.", + "enum": [ + "AzureStorageBlobContainer", + "NfsMount", + "AzureStorageSmbFileShare", + "SmbMount" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "CredentialType": { + "description": "The Credentials type.", + "enum": [ + "AzureKeyVaultSmb" + ], + "type": "string", + "x-ms-enum": { + "name": "CredentialType", + "modelAsString": true + } + }, + "Credentials": { + "description": "The Credentials.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The Credentials type.", + "$ref": "#/definitions/CredentialType", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "type" + ] + }, + "AzureKeyVaultSmbCredentials": { + "description": "The Azure Key Vault secret URIs which store the credentials.", + "type": "object", + "x-ms-discriminator-value": "AzureKeyVaultSmb", + "properties": { + "usernameUri": { + "description": "The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.", + "type": "string" + }, + "passwordUri": { + "description": "The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ] + }, + "JobDefinitionProperties": { + "description": "Job definition properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Job Definition." + }, + "copyMode": { + "type": "string", + "description": "Strategy to use for copy.", + "x-ms-enum": { + "name": "CopyMode", + "modelAsString": true + }, + "enum": [ + "Additive", + "Mirror" + ] + }, + "sourceName": { + "type": "string", + "description": "The name of the source Endpoint.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sourceResourceId": { + "type": "string", + "description": "Fully qualified resource ID of the source Endpoint.", + "readOnly": true + }, + "sourceSubpath": { + "type": "string", + "description": "The subpath to use when reading from the source Endpoint.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetName": { + "type": "string", + "description": "The name of the target Endpoint.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceId": { + "type": "string", + "description": "Fully qualified resource ID of the target Endpoint.", + "readOnly": true + }, + "targetSubpath": { + "type": "string", + "description": "The subpath to use when writing to the target Endpoint.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "latestJobRunName": { + "type": "string", + "description": "The name of the Job Run in a non-terminal state, if exists.", + "readOnly": true + }, + "latestJobRunResourceId": { + "type": "string", + "description": "The fully qualified resource ID of the Job Run in a non-terminal state, if exists.", + "readOnly": true + }, + "latestJobRunStatus": { + "enum": [ + "Queued", + "Started", + "Running", + "CancelRequested", + "Canceling", + "Canceled", + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "JobRunStatus", + "modelAsString": true + }, + "description": "The current status of the Job Run in a non-terminal state, if exists.", + "readOnly": true + }, + "agentName": { + "type": "string", + "description": "Name of the Agent to assign for new Job Runs of this Job Definition." + }, + "agentResourceId": { + "type": "string", + "description": "Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "copyMode", + "sourceName", + "targetName" + ] + }, + "JobDefinition": { + "description": "The Job Definition resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JobDefinitionProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "JobDefinitionUpdateProperties": { + "description": "Job definition properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Job Definition." + }, + "copyMode": { + "type": "string", + "description": "Strategy to use for copy.", + "x-ms-enum": { + "name": "CopyMode", + "modelAsString": true + }, + "enum": [ + "Additive", + "Mirror" + ] + }, + "agentName": { + "type": "string", + "description": "Name of the Agent to assign for new Job Runs of this Job Definition." + } + } + }, + "JobDefinitionUpdateParameters": { + "description": "The Job Definition resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JobDefinitionUpdateProperties" + } + } + }, + "JobDefinitionList": { + "description": "List of Job Definitions.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobDefinition" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "JobRunError": { + "type": "object", + "description": "Error type", + "properties": { + "code": { + "type": "string", + "description": "Error code of the given entry." + }, + "message": { + "type": "string", + "description": "Error message of the given entry." + }, + "target": { + "type": "string", + "description": "Target of the given error entry." + } + } + }, + "JobRunProperties": { + "description": "Job run properties.", + "type": "object", + "properties": { + "status": { + "readOnly": true, + "enum": [ + "Queued", + "Started", + "Running", + "CancelRequested", + "Canceling", + "Canceled", + "Failed", + "Succeeded", + "PausedByBandwidthManagement" + ], + "type": "string", + "x-ms-enum": { + "name": "JobRunStatus", + "modelAsString": true + }, + "description": "The state of the job execution." + }, + "scanStatus": { + "readOnly": true, + "enum": [ + "NotStarted", + "Scanning", + "Completed" + ], + "type": "string", + "x-ms-enum": { + "name": "JobRunScanStatus", + "modelAsString": true + }, + "description": "The status of Agent's scanning of source." + }, + "agentName": { + "readOnly": true, + "type": "string", + "description": "Name of the Agent assigned to this run." + }, + "agentResourceId": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource id of the Agent assigned to this run." + }, + "executionStartTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the run. Null if no Agent reported that the job has started." + }, + "executionEndTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the run. Null if Agent has not reported that the job has ended." + }, + "lastStatusUpdate": { + "type": "string", + "format": "date-time", + "description": "The last updated time of the Job Run.", + "readOnly": true + }, + "itemsScanned": { + "type": "integer", + "format": "int64", + "description": "Number of items scanned so far in source.", + "readOnly": true + }, + "itemsExcluded": { + "type": "integer", + "format": "int64", + "description": "Number of items that will not be transferred, as they are excluded by user configuration.", + "readOnly": true + }, + "itemsUnsupported": { + "type": "integer", + "format": "int64", + "description": "Number of items that will not be transferred, as they are unsupported on target.", + "readOnly": true + }, + "itemsNoTransferNeeded": { + "type": "integer", + "format": "int64", + "description": "Number of items that will not be transferred, as they are already found on target (e.g. mirror mode).", + "readOnly": true + }, + "itemsFailed": { + "type": "integer", + "format": "int64", + "description": "Number of items that were attempted to transfer and failed.", + "readOnly": true + }, + "itemsTransferred": { + "type": "integer", + "format": "int64", + "description": "Number of items successfully transferred to target.", + "readOnly": true + }, + "bytesScanned": { + "type": "integer", + "format": "int64", + "description": "Bytes of data scanned so far in source.", + "readOnly": true + }, + "bytesExcluded": { + "type": "integer", + "format": "int64", + "description": "Bytes of data that will not be transferred, as they are excluded by user configuration.", + "readOnly": true + }, + "bytesUnsupported": { + "type": "integer", + "format": "int64", + "description": "Bytes of data that will not be transferred, as they are unsupported on target.", + "readOnly": true + }, + "bytesNoTransferNeeded": { + "type": "integer", + "format": "int64", + "description": "Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode).", + "readOnly": true + }, + "bytesFailed": { + "type": "integer", + "format": "int64", + "description": "Bytes of data that were attempted to transfer and failed.", + "readOnly": true + }, + "bytesTransferred": { + "type": "integer", + "format": "int64", + "description": "Bytes of data successfully transferred to target.", + "readOnly": true + }, + "sourceName": { + "type": "string", + "description": "Name of source Endpoint resource. This resource may no longer exist.", + "readOnly": true + }, + "sourceResourceId": { + "type": "string", + "description": "Fully qualified resource id of source Endpoint. This id may no longer exist.", + "readOnly": true + }, + "sourceProperties": { + "type": "object", + "description": "Copy of source Endpoint resource's properties at time of Job Run creation.", + "readOnly": true + }, + "targetName": { + "type": "string", + "description": "Name of target Endpoint resource. This resource may no longer exist.", + "readOnly": true + }, + "targetResourceId": { + "type": "string", + "description": "Fully qualified resource id of of Endpoint. This id may no longer exist.", + "readOnly": true + }, + "targetProperties": { + "type": "object", + "description": "Copy of Endpoint resource's properties at time of Job Run creation.", + "readOnly": true + }, + "jobDefinitionProperties": { + "type": "object", + "description": "Copy of parent Job Definition's properties at time of Job Run creation.", + "readOnly": true + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/JobRunError", + "description": "Error details." + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "JobRun": { + "description": "The Job Run resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JobRunProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "JobRunResourceId": { + "description": "Response that identifies a Job Run.", + "type": "object", + "properties": { + "jobRunResourceId": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource id of the Job Run." + } + } + }, + "JobRunList": { + "description": "List of Job Runs.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobRun" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "ProjectProperties": { + "description": "Project properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Project." + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "Project": { + "description": "The Project resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ProjectUpdateProperties": { + "description": "Project properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Project." + } + } + }, + "ProjectUpdateParameters": { + "description": "The Project resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectUpdateProperties" + } + } + }, + "ProjectList": { + "description": "List of Project resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "ProvisioningState": { + "description": "The provisioning state of a resource.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "parameters": { + "AgentNameParameter": { + "name": "agentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Agent resource.", + "x-ms-parameter-location": "method" + }, + "StorageMoverNameParameter": { + "name": "storageMoverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Storage Mover resource.", + "x-ms-parameter-location": "method" + }, + "EndpointNameParameter": { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Endpoint resource.", + "x-ms-parameter-location": "method" + }, + "JobDefinitionNameParameter": { + "name": "jobDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Job Definition resource.", + "x-ms-parameter-location": "method" + }, + "JobRunNameParameter": { + "name": "jobRunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Job Run resource.", + "x-ms-parameter-location": "method" + }, + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Project resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/storagemover/resource-manager/readme.md b/specification/storagemover/resource-manager/readme.md index dd6cc524d258..ecff19c7ab9d 100644 --- a/specification/storagemover/resource-manager/readme.md +++ b/specification/storagemover/resource-manager/readme.md @@ -27,18 +27,28 @@ These are the global settings for the storagemover. ``` yaml openapi-type: arm openapi-subtype: providerHub -tag: package-2023-10 +tag: package-2024-07 ``` +### Tag: package-2024-07 + +These settings apply only when `--tag=package-2024-07` is specified on the command line. + +```yaml $(tag) == 'package-2024-07' +input-file: + - Microsoft.StorageMover/stable/2024-07-01/storagemover.json +``` + ### Tag: package-2023-10 These settings apply only when `--tag=package-2023-10` is specified on the command line. -```yaml $(tag) == 'package-2023-10' +``` yaml $(tag) == 'package-2023-10' input-file: - Microsoft.StorageMover/stable/2023-10-01/storagemover.json ``` + ### Tag: package-preview-2023-07 These settings apply only when `--tag=package-preview-2023-07` is specified on the command line. From f45a76fc39f033947ed12faf4b6416e1e19724cd Mon Sep 17 00:00:00 2001 From: Ayush Gupta - SQL <166794972+guptaayush007@users.noreply.github.com> Date: Mon, 10 Jun 2024 13:20:39 +0530 Subject: [PATCH 137/343] Downgraded the version of ManagedInstances to generate .Net SDK for sql/resource manager (#29316) * Downgraded the version of ManagedInstances and DistributedAvailabilityGroups Api due to .Net Sdk build failures caused by error : MembersMustExist in these API's * restored the version of ManagedInstance Api as previous * Update the version of ManagedInstance APi to previous version 22-08-01 as having build erros while building .net sdk with error 'implementation but it does exist in the contract.' --------- Co-authored-by: Ji Wang --- specification/sql/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 2e84f8a3645e..99630ad97c3d 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -1415,6 +1415,7 @@ input-file: - ./Microsoft.Sql/preview/2023-02-01-preview/Databases.json - ./Microsoft.Sql/preview/2022-08-01-preview/ElasticPools.json - ./Microsoft.Sql/preview/2022-08-01-preview/ManagedDatabases.json +- ./Microsoft.Sql/preview/2022-08-01-preview/ManagedInstances.json - ./Microsoft.Sql/preview/2022-08-01-preview/ManagedLedgerDigestUploads.json - ./Microsoft.Sql/preview/2022-08-01-preview/RecoverableDatabases.json - ./Microsoft.Sql/preview/2022-08-01-preview/RestorableDroppedDatabases.json @@ -1439,7 +1440,6 @@ input-file: - ./Microsoft.Sql/preview/2023-05-01-preview/InstancePools.json - ./Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionBackups.json - ./Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionPolicies.json -- ./Microsoft.Sql/preview/2023-05-01-preview/ManagedInstances.json - ./Microsoft.Sql/preview/2023-05-01-preview/Servers.json - ./Microsoft.Sql/preview/2023-05-01-preview/ReplicationLinks.json From 4478a53653c41d21cad9f560106177b6d139eed4 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 10 Jun 2024 07:59:52 -0700 Subject: [PATCH 138/343] Support image input in chat completions --- specification/ai/ModelClient/client.tsp | 5 + .../GetChatCompletions_MaximumSet_Gen.json | 26 ++--- .../GetChatCompletions_MinimumSet_Gen.json | 16 +-- .../GetEmbeddings_MaximumSet_Gen.json | 18 ++-- .../GetEmbeddings_MinimumSet_Gen.json | 16 +-- .../GetImageEmbeddings_MaximumSet_Gen.json | 18 ++-- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 +-- .../GetModelInfo_MaximumSet_Gen.json | 4 +- .../GetModelInfo_MinimumSet_Gen.json | 4 +- .../ModelClient/models/chat_completions.tsp | 61 ++++++++++- specification/ai/ModelClient/tspconfig.yaml | 2 +- .../GetChatCompletions_MaximumSet_Gen.json | 26 ++--- .../GetChatCompletions_MinimumSet_Gen.json | 16 +-- .../GetEmbeddings_MaximumSet_Gen.json | 18 ++-- .../GetEmbeddings_MinimumSet_Gen.json | 16 +-- .../GetImageEmbeddings_MaximumSet_Gen.json | 18 ++-- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 +-- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +- .../preview/2024-05-01-preview/openapi.json | 102 +++++++++++++++++- 20 files changed, 285 insertions(+), 121 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 0d6edea81614..ecfb31e4d8e8 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -48,6 +48,11 @@ namespace Customizations; // The actual name here doesn't matter and is here for @@access(ModelClient.ModelInfo, Access.public); @@access(ModelClient.StreamingChatChoiceUpdate, Access.public, "python"); @@access(ModelClient.StreamingChatCompletionsUpdate, Access.public, "python"); +@@access(ModelClient.ChatMessageContentItem, Access.public); +@@access(ModelClient.ChatMessageTextContentItem, Access.public); +@@access(ModelClient.ChatMessageImageContentItem, Access.public); +@@access(ModelClient.ChatMessageImageUrl, Access.public); +@@access(ModelClient.ChatMessageImageDetailLevel, Access.public); // The operators need to be hidden, since we hand-write the public versions of those to // 1. Add chat completions streaming (to getChatCompletions operator) diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index ea6505f21888..b70571ec9a23 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,46 +10,46 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": 1, "stream": true, - "presence_penalty": 1, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "xvqcawyltsgxp" + "ftfcfmwymaiaxq" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 7 + "seed": 28 } }, "responses": { "200": { "body": { - "id": "j", - "created": 8, - "model": "seescrvpjgzsypchxgxfywnhaqo", + "id": "lucg", + "created": 11, + "model": "tsqex", "usage": { - "completion_tokens": 4, - "prompt_tokens": 11, - "total_tokens": 29 + "completion_tokens": 10, + "prompt_tokens": 14, + "total_tokens": 7 }, "choices": [ { - "index": 22, + "index": 4, "finish_reason": "stop", "message": { "role": "system", - "content": "mypcazxgotv", + "content": "xtrirgreezabshxirfhi", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "rwnxvsfequsocsyxlj" + "id": "kicdohgtfw" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index a316ee0bec64..acac41858e43 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "j", - "created": 8, - "model": "seescrvpjgzsypchxgxfywnhaqo", + "id": "lucg", + "created": 11, + "model": "tsqex", "usage": { - "completion_tokens": 4, - "prompt_tokens": 11, - "total_tokens": 29 + "completion_tokens": 10, + "prompt_tokens": 14, + "total_tokens": 7 }, "choices": [ { - "index": 22, + "index": 4, "finish_reason": "stop", "message": { "role": "system", - "content": "mypcazxgotv" + "content": "xtrirgreezabshxirfhi" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index fb19a5770dfb..c5dc5f119751 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "lldxiwoooquzs" + "udxqxeltsnnnojgwpppb" ], - "dimensions": 17, + "dimensions": 1, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "bosctybzvexfttpdci", + "id": "fwajvrkzedj", "data": [ { "embedding": [ - 22 + 3 ], - "index": 10 + "index": 15 } ], "usage": { - "input_tokens": 12, - "prompt_tokens": 6, - "total_tokens": 12 + "input_tokens": 4, + "prompt_tokens": 27, + "total_tokens": 14 }, - "model": "qwtvuoqzjbkybpijoedy" + "model": "rzfpwylkkwnqoerjogdqgf" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index 472a47e314a4..64a044a5ed1b 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "ykddkctmxmqgueem" + "abhxkxorcejjnfwidhhbf" ] } }, "responses": { "200": { "body": { - "id": "bosctybzvexfttpdci", + "id": "fwajvrkzedj", "data": [ { "embedding": [ - 22 + 3 ], - "index": 10 + "index": 15 } ], "usage": { - "input_tokens": 12, - "prompt_tokens": 6, - "total_tokens": 12 + "input_tokens": 4, + "prompt_tokens": 27, + "total_tokens": 14 }, - "model": "qwtvuoqzjbkybpijoedy" + "model": "rzfpwylkkwnqoerjogdqgf" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index a21f2d325348..d691d32bd4e3 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,8 +7,8 @@ "body": { "input": [ { - "image": "nqywwlco", - "text": "lwdsmegnaxqwwayjp" + "image": "jwbxrzdcafrxmhrztwepxmsrgys", + "text": "tmsxeneoqsimdpezbblrmvscvee" } ], "dimensions": 16, @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "bosctybzvexfttpdci", + "id": "fwajvrkzedj", "data": [ { "embedding": [ - 22 + 3 ], - "index": 10 + "index": 15 } ], "usage": { - "input_tokens": 12, - "prompt_tokens": 6, - "total_tokens": 12 + "input_tokens": 4, + "prompt_tokens": 27, + "total_tokens": 14 }, - "model": "qwtvuoqzjbkybpijoedy" + "model": "rzfpwylkkwnqoerjogdqgf" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 9743a7f692bd..21729c14e1b3 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "nqywwlco" + "image": "jwbxrzdcafrxmhrztwepxmsrgys" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "bosctybzvexfttpdci", + "id": "fwajvrkzedj", "data": [ { "embedding": [ - 22 + 3 ], - "index": 10 + "index": 15 } ], "usage": { - "input_tokens": 12, - "prompt_tokens": 6, - "total_tokens": 12 + "input_tokens": 4, + "prompt_tokens": 27, + "total_tokens": 14 }, - "model": "qwtvuoqzjbkybpijoedy" + "model": "rzfpwylkkwnqoerjogdqgf" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index 9b18173d4325..b4dac1c13edc 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "pvjlbwovpsotsvsioii", + "model_name": "gqhcghuvgajmrjva", "model_type": "embeddings", - "model_provider_name": "hjprgnvy" + "model_provider_name": "fqkylpirzwbklhcbgc" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index bb62f42b1741..eff3b0646089 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "pvjlbwovpsotsvsioii", + "model_name": "gqhcghuvgajmrjva", "model_type": "embeddings", - "model_provider_name": "hjprgnvy" + "model_provider_name": "fqkylpirzwbklhcbgc" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 479742cc42a7..571968d27549 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -294,8 +294,9 @@ model ChatRequestUserMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'user' for user messages.") role: ChatRole.user; + #suppress "@azure-tools/typespec-autorest/union-unsupported" "External API shape is defined in OpenAPI 3.0 as oneOf." @doc("The contents of the user message, with available input types varying by selected model.") - content: string; + content: string | ChatMessageContentItem[]; } @doc("A request chat message representing response or action from the assistant.") @@ -473,3 +474,61 @@ model FunctionCall { """) arguments: string; } + +@doc("An abstract representation of a structured content item within a chat message.") +@discriminator("type") +model ChatMessageContentItem { + @doc("The discriminated object type.") + type: string; +} + +@doc("A structured chat content item containing plain text.") +model ChatMessageTextContentItem extends ChatMessageContentItem { + @doc("The discriminated object type: always 'text' for this type.") + type: "text"; + + @doc("The content of the message.") + text: string; +} + +@doc("A structured chat content item containing an image reference.") +model ChatMessageImageContentItem extends ChatMessageContentItem { + @doc("The discriminated object type: always 'image_url' for this type.") + type: "image_url"; + + @doc("An internet location, which must be accessible to the model,from which the image may be retrieved.") + @encodedName("application/json", "image_url") + imageUrl: ChatMessageImageUrl; +} + +@doc("An internet location from which the model may retrieve an image.") +model ChatMessageImageUrl { + @doc("The URL of the image.") + url: url; + + @doc(""" + The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and + accuracy. + """) + detail?: ChatMessageImageDetailLevel; +} + +@doc("A representation of the possible image detail levels for image-based chat completions message content.") +union ChatMessageImageDetailLevel { + string, + + @doc("Specifies that the model should determine which detail level to apply using heuristics like image size.") + auto: "auto", + + @doc(""" + Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer + tokens but may also be less accurate for highly detailed images. + """) + low: "low", + + @doc(""" + Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed + images but may also be slower and consume more tokens. + """) + high: "high", +} diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index 8c7c4d75c64e..4524b2bcd7f4 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -8,7 +8,7 @@ emit: - "@azure-tools/typespec-autorest" linter: extends: - - "@azure-tools/typespec-azure-core/all" + - "@azure-tools/typespec-azure-rulesets/data-plane" disable: "@azure-tools/typespec-azure-core/casing-style": "Disabled since JSON payload in REST API does not conform to Azure guidelines with regards to casing" options: diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index ea6505f21888..b70571ec9a23 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,46 +10,46 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": 1, "stream": true, - "presence_penalty": 1, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "xvqcawyltsgxp" + "ftfcfmwymaiaxq" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 7 + "seed": 28 } }, "responses": { "200": { "body": { - "id": "j", - "created": 8, - "model": "seescrvpjgzsypchxgxfywnhaqo", + "id": "lucg", + "created": 11, + "model": "tsqex", "usage": { - "completion_tokens": 4, - "prompt_tokens": 11, - "total_tokens": 29 + "completion_tokens": 10, + "prompt_tokens": 14, + "total_tokens": 7 }, "choices": [ { - "index": 22, + "index": 4, "finish_reason": "stop", "message": { "role": "system", - "content": "mypcazxgotv", + "content": "xtrirgreezabshxirfhi", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "rwnxvsfequsocsyxlj" + "id": "kicdohgtfw" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index a316ee0bec64..acac41858e43 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "j", - "created": 8, - "model": "seescrvpjgzsypchxgxfywnhaqo", + "id": "lucg", + "created": 11, + "model": "tsqex", "usage": { - "completion_tokens": 4, - "prompt_tokens": 11, - "total_tokens": 29 + "completion_tokens": 10, + "prompt_tokens": 14, + "total_tokens": 7 }, "choices": [ { - "index": 22, + "index": 4, "finish_reason": "stop", "message": { "role": "system", - "content": "mypcazxgotv" + "content": "xtrirgreezabshxirfhi" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index fb19a5770dfb..c5dc5f119751 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "lldxiwoooquzs" + "udxqxeltsnnnojgwpppb" ], - "dimensions": 17, + "dimensions": 1, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "bosctybzvexfttpdci", + "id": "fwajvrkzedj", "data": [ { "embedding": [ - 22 + 3 ], - "index": 10 + "index": 15 } ], "usage": { - "input_tokens": 12, - "prompt_tokens": 6, - "total_tokens": 12 + "input_tokens": 4, + "prompt_tokens": 27, + "total_tokens": 14 }, - "model": "qwtvuoqzjbkybpijoedy" + "model": "rzfpwylkkwnqoerjogdqgf" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 472a47e314a4..64a044a5ed1b 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "ykddkctmxmqgueem" + "abhxkxorcejjnfwidhhbf" ] } }, "responses": { "200": { "body": { - "id": "bosctybzvexfttpdci", + "id": "fwajvrkzedj", "data": [ { "embedding": [ - 22 + 3 ], - "index": 10 + "index": 15 } ], "usage": { - "input_tokens": 12, - "prompt_tokens": 6, - "total_tokens": 12 + "input_tokens": 4, + "prompt_tokens": 27, + "total_tokens": 14 }, - "model": "qwtvuoqzjbkybpijoedy" + "model": "rzfpwylkkwnqoerjogdqgf" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index a21f2d325348..d691d32bd4e3 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,8 +7,8 @@ "body": { "input": [ { - "image": "nqywwlco", - "text": "lwdsmegnaxqwwayjp" + "image": "jwbxrzdcafrxmhrztwepxmsrgys", + "text": "tmsxeneoqsimdpezbblrmvscvee" } ], "dimensions": 16, @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "bosctybzvexfttpdci", + "id": "fwajvrkzedj", "data": [ { "embedding": [ - 22 + 3 ], - "index": 10 + "index": 15 } ], "usage": { - "input_tokens": 12, - "prompt_tokens": 6, - "total_tokens": 12 + "input_tokens": 4, + "prompt_tokens": 27, + "total_tokens": 14 }, - "model": "qwtvuoqzjbkybpijoedy" + "model": "rzfpwylkkwnqoerjogdqgf" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 9743a7f692bd..21729c14e1b3 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "nqywwlco" + "image": "jwbxrzdcafrxmhrztwepxmsrgys" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "bosctybzvexfttpdci", + "id": "fwajvrkzedj", "data": [ { "embedding": [ - 22 + 3 ], - "index": 10 + "index": 15 } ], "usage": { - "input_tokens": 12, - "prompt_tokens": 6, - "total_tokens": 12 + "input_tokens": 4, + "prompt_tokens": 27, + "total_tokens": 14 }, - "model": "qwtvuoqzjbkybpijoedy" + "model": "rzfpwylkkwnqoerjogdqgf" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 9b18173d4325..b4dac1c13edc 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "pvjlbwovpsotsvsioii", + "model_name": "gqhcghuvgajmrjva", "model_type": "embeddings", - "model_provider_name": "hjprgnvy" + "model_provider_name": "fqkylpirzwbklhcbgc" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index bb62f42b1741..eff3b0646089 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "pvjlbwovpsotsvsioii", + "model_name": "gqhcghuvgajmrjva", "model_type": "embeddings", - "model_provider_name": "hjprgnvy" + "model_provider_name": "fqkylpirzwbklhcbgc" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json index 530b4b29bafa..e7a769627aa4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json @@ -754,6 +754,107 @@ ] } }, + "ChatMessageContentItem": { + "type": "object", + "description": "An abstract representation of a structured content item within a chat message.", + "properties": { + "type": { + "type": "string", + "description": "The discriminated object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatMessageImageContentItem": { + "type": "object", + "description": "A structured chat content item containing an image reference.", + "properties": { + "image_url": { + "$ref": "#/definitions/ChatMessageImageUrl", + "description": "An internet location, which must be accessible to the model,from which the image may be retrieved.", + "x-ms-client-name": "imageUrl" + } + }, + "required": [ + "image_url" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatMessageContentItem" + } + ], + "x-ms-discriminator-value": "image_url" + }, + "ChatMessageImageDetailLevel": { + "type": "string", + "description": "A representation of the possible image detail levels for image-based chat completions message content.", + "enum": [ + "auto", + "low", + "high" + ], + "x-ms-enum": { + "name": "ChatMessageImageDetailLevel", + "modelAsString": true, + "values": [ + { + "name": "auto", + "value": "auto", + "description": "Specifies that the model should determine which detail level to apply using heuristics like image size." + }, + { + "name": "low", + "value": "low", + "description": "Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer\ntokens but may also be less accurate for highly detailed images." + }, + { + "name": "high", + "value": "high", + "description": "Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed\nimages but may also be slower and consume more tokens." + } + ] + } + }, + "ChatMessageImageUrl": { + "type": "object", + "description": "An internet location from which the model may retrieve an image.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the image." + }, + "detail": { + "$ref": "#/definitions/ChatMessageImageDetailLevel", + "description": "The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and\naccuracy." + } + }, + "required": [ + "url" + ] + }, + "ChatMessageTextContentItem": { + "type": "object", + "description": "A structured chat content item containing plain text.", + "properties": { + "text": { + "type": "string", + "description": "The content of the message." + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatMessageContentItem" + } + ], + "x-ms-discriminator-value": "text" + }, "ChatRequestAssistantMessage": { "type": "object", "description": "A request chat message representing response or action from the assistant.", @@ -843,7 +944,6 @@ "description": "A request chat message representing user input to the assistant.", "properties": { "content": { - "type": "string", "description": "The contents of the user message, with available input types varying by selected model." } }, From 1e69395f5faeb9916a3ae88c7dfd4d508ac8e50c Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 10 Jun 2024 11:20:08 -0700 Subject: [PATCH 139/343] limit scope of text and image embedding clients to Python only --- specification/ai/ModelClient/client.tsp | 17 +++++++------- .../GetChatCompletions_MaximumSet_Gen.json | 22 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 14 ++++++------ .../GetEmbeddings_MaximumSet_Gen.json | 18 +++++++-------- .../GetEmbeddings_MinimumSet_Gen.json | 16 +++++++------- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 ++++++++--------- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 +++++++------- .../GetModelInfo_MaximumSet_Gen.json | 4 ++-- .../GetModelInfo_MinimumSet_Gen.json | 4 ++-- .../GetChatCompletions_MaximumSet_Gen.json | 22 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 14 ++++++------ .../GetEmbeddings_MaximumSet_Gen.json | 18 +++++++-------- .../GetEmbeddings_MinimumSet_Gen.json | 16 +++++++------- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 ++++++++--------- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 +++++++------- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 ++-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 ++-- 17 files changed, 122 insertions(+), 123 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index ecfb31e4d8e8..0a09a4560473 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -8,15 +8,14 @@ using TypeSpec.Versioning; @useDependency(ModelClient.Versions.v2024_05_01_Preview) namespace Customizations; // The actual name here doesn't matter and is here for organization purposes only -// These models are used by the hand-written operator methods. -// We need to declare their usage and public access, otherwise they won't be emited in the generated code. -@@usage(ModelClient.StreamingChatChoiceUpdate, Usage.output); +// Are these needed? @@usage(ModelClient.ChatCompletions, Usage.output); -@@usage(ModelClient.StreamingChatCompletionsUpdate, Usage.output); @@usage(ModelClient.ModelInfo, Usage.output); +@@usage(ModelClient.StreamingChatChoiceUpdate, Usage.output); +@@usage(ModelClient.StreamingChatCompletionsUpdate, Usage.output); -// Since we made all operator methods internal, we need to expliclty say we still want the models they use -// to be public. +// Since we made all operator methods internal, we need to expliclty +// say we still want the models they use to be public. @@access(ModelClient.ChatChoice, Access.public); @@access(ModelClient.ChatCompletions, Access.public); @@access(ModelClient.ChatCompletionsFunctionToolCall, Access.public); @@ -57,7 +56,7 @@ namespace Customizations; // The actual name here doesn't matter and is here for // The operators need to be hidden, since we hand-write the public versions of those to // 1. Add chat completions streaming (to getChatCompletions operator) // 2. Add hyper-params (to getChatCompletions/Embeddings/ImageEmbeddings, all clients) -// 3. Cache model info (to getModelInfo, all clients) +// 3. Cache model info (to getModelInfo, all clients, Python only) @@access(ModelClient.getChatCompletions, Access.internal, "python"); @@access(ModelClient.getEmbeddings, Access.internal, "python"); @@access(ModelClient.getImageEmbeddings, Access.internal, "python"); @@ -75,7 +74,7 @@ interface Client1 { @client({ name: "EmbeddingsClient", service: ModelClient, -}) +}, "python") interface Client2 { embed is ModelClient.getEmbeddings; getModelInfo is ModelClient.getModelInfo; @@ -84,7 +83,7 @@ interface Client2 { @client({ name: "ImageEmbeddingsClient", service: ModelClient, -}) +}, "python") interface Client3 { embed is ModelClient.getImageEmbeddings; getModelInfo is ModelClient.getModelInfo; diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index b70571ec9a23..cc91bbf107f9 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, + "frequency_penalty": -2, "stream": true, "presence_penalty": 0, "temperature": 0, @@ -18,38 +18,38 @@ "max_tokens": 0, "response_format": "text", "stop": [ - "ftfcfmwymaiaxq" + "jsgknsbxaqse" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 28 + "seed": 16 } }, "responses": { "200": { "body": { - "id": "lucg", - "created": 11, - "model": "tsqex", + "id": "vttvkvwbbvgjtqphyswtfjq", + "created": 12, + "model": "yyxicqgwvohxtfgwaymlypcyuyskgl", "usage": { - "completion_tokens": 10, + "completion_tokens": 19, "prompt_tokens": 14, - "total_tokens": 7 + "total_tokens": 16 }, "choices": [ { - "index": 4, + "index": 1, "finish_reason": "stop", "message": { "role": "system", - "content": "xtrirgreezabshxirfhi", + "content": "vjwamdxrsbqojpolqr", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "kicdohgtfw" + "id": "pmmdjgalvahbkafjqir" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index acac41858e43..9c70badfd10d 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "lucg", - "created": 11, - "model": "tsqex", + "id": "vttvkvwbbvgjtqphyswtfjq", + "created": 12, + "model": "yyxicqgwvohxtfgwaymlypcyuyskgl", "usage": { - "completion_tokens": 10, + "completion_tokens": 19, "prompt_tokens": 14, - "total_tokens": 7 + "total_tokens": 16 }, "choices": [ { - "index": 4, + "index": 1, "finish_reason": "stop", "message": { "role": "system", - "content": "xtrirgreezabshxirfhi" + "content": "vjwamdxrsbqojpolqr" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index c5dc5f119751..e88b306bdc19 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "udxqxeltsnnnojgwpppb" + "uwfwjjkuc" ], - "dimensions": 1, + "dimensions": 20, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "fwajvrkzedj", + "id": "vjtifrodzwydvynddmbudnno", "data": [ { "embedding": [ - 3 + 16 ], - "index": 15 + "index": 1 } ], "usage": { - "input_tokens": 4, - "prompt_tokens": 27, - "total_tokens": 14 + "input_tokens": 20, + "prompt_tokens": 28, + "total_tokens": 2 }, - "model": "rzfpwylkkwnqoerjogdqgf" + "model": "obwfxvadcvvziooogpswzqkn" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index 64a044a5ed1b..7d15e7c1a297 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "abhxkxorcejjnfwidhhbf" + "ujqrjllpyke" ] } }, "responses": { "200": { "body": { - "id": "fwajvrkzedj", + "id": "vjtifrodzwydvynddmbudnno", "data": [ { "embedding": [ - 3 + 16 ], - "index": 15 + "index": 1 } ], "usage": { - "input_tokens": 4, - "prompt_tokens": 27, - "total_tokens": 14 + "input_tokens": 20, + "prompt_tokens": 28, + "total_tokens": 2 }, - "model": "rzfpwylkkwnqoerjogdqgf" + "model": "obwfxvadcvvziooogpswzqkn" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index d691d32bd4e3..1e1cfdef0d20 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "jwbxrzdcafrxmhrztwepxmsrgys", - "text": "tmsxeneoqsimdpezbblrmvscvee" + "image": "rlwzmtmuitzvs", + "text": "htjxmfwdiw" } ], - "dimensions": 16, + "dimensions": 26, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "fwajvrkzedj", + "id": "vjtifrodzwydvynddmbudnno", "data": [ { "embedding": [ - 3 + 16 ], - "index": 15 + "index": 1 } ], "usage": { - "input_tokens": 4, - "prompt_tokens": 27, - "total_tokens": 14 + "input_tokens": 20, + "prompt_tokens": 28, + "total_tokens": 2 }, - "model": "rzfpwylkkwnqoerjogdqgf" + "model": "obwfxvadcvvziooogpswzqkn" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 21729c14e1b3..35b045e1a21e 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "jwbxrzdcafrxmhrztwepxmsrgys" + "image": "rlwzmtmuitzvs" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "fwajvrkzedj", + "id": "vjtifrodzwydvynddmbudnno", "data": [ { "embedding": [ - 3 + 16 ], - "index": 15 + "index": 1 } ], "usage": { - "input_tokens": 4, - "prompt_tokens": 27, - "total_tokens": 14 + "input_tokens": 20, + "prompt_tokens": 28, + "total_tokens": 2 }, - "model": "rzfpwylkkwnqoerjogdqgf" + "model": "obwfxvadcvvziooogpswzqkn" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index b4dac1c13edc..ae964061c70f 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "gqhcghuvgajmrjva", + "model_name": "uvbxltprmh", "model_type": "embeddings", - "model_provider_name": "fqkylpirzwbklhcbgc" + "model_provider_name": "uuklhgbngggjryjphasqjiyk" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index eff3b0646089..70ef42df2ba4 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "gqhcghuvgajmrjva", + "model_name": "uvbxltprmh", "model_type": "embeddings", - "model_provider_name": "fqkylpirzwbklhcbgc" + "model_provider_name": "uuklhgbngggjryjphasqjiyk" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index b70571ec9a23..cc91bbf107f9 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, + "frequency_penalty": -2, "stream": true, "presence_penalty": 0, "temperature": 0, @@ -18,38 +18,38 @@ "max_tokens": 0, "response_format": "text", "stop": [ - "ftfcfmwymaiaxq" + "jsgknsbxaqse" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 28 + "seed": 16 } }, "responses": { "200": { "body": { - "id": "lucg", - "created": 11, - "model": "tsqex", + "id": "vttvkvwbbvgjtqphyswtfjq", + "created": 12, + "model": "yyxicqgwvohxtfgwaymlypcyuyskgl", "usage": { - "completion_tokens": 10, + "completion_tokens": 19, "prompt_tokens": 14, - "total_tokens": 7 + "total_tokens": 16 }, "choices": [ { - "index": 4, + "index": 1, "finish_reason": "stop", "message": { "role": "system", - "content": "xtrirgreezabshxirfhi", + "content": "vjwamdxrsbqojpolqr", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "kicdohgtfw" + "id": "pmmdjgalvahbkafjqir" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index acac41858e43..9c70badfd10d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "lucg", - "created": 11, - "model": "tsqex", + "id": "vttvkvwbbvgjtqphyswtfjq", + "created": 12, + "model": "yyxicqgwvohxtfgwaymlypcyuyskgl", "usage": { - "completion_tokens": 10, + "completion_tokens": 19, "prompt_tokens": 14, - "total_tokens": 7 + "total_tokens": 16 }, "choices": [ { - "index": 4, + "index": 1, "finish_reason": "stop", "message": { "role": "system", - "content": "xtrirgreezabshxirfhi" + "content": "vjwamdxrsbqojpolqr" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index c5dc5f119751..e88b306bdc19 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "udxqxeltsnnnojgwpppb" + "uwfwjjkuc" ], - "dimensions": 1, + "dimensions": 20, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "fwajvrkzedj", + "id": "vjtifrodzwydvynddmbudnno", "data": [ { "embedding": [ - 3 + 16 ], - "index": 15 + "index": 1 } ], "usage": { - "input_tokens": 4, - "prompt_tokens": 27, - "total_tokens": 14 + "input_tokens": 20, + "prompt_tokens": 28, + "total_tokens": 2 }, - "model": "rzfpwylkkwnqoerjogdqgf" + "model": "obwfxvadcvvziooogpswzqkn" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 64a044a5ed1b..7d15e7c1a297 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "abhxkxorcejjnfwidhhbf" + "ujqrjllpyke" ] } }, "responses": { "200": { "body": { - "id": "fwajvrkzedj", + "id": "vjtifrodzwydvynddmbudnno", "data": [ { "embedding": [ - 3 + 16 ], - "index": 15 + "index": 1 } ], "usage": { - "input_tokens": 4, - "prompt_tokens": 27, - "total_tokens": 14 + "input_tokens": 20, + "prompt_tokens": 28, + "total_tokens": 2 }, - "model": "rzfpwylkkwnqoerjogdqgf" + "model": "obwfxvadcvvziooogpswzqkn" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index d691d32bd4e3..1e1cfdef0d20 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "jwbxrzdcafrxmhrztwepxmsrgys", - "text": "tmsxeneoqsimdpezbblrmvscvee" + "image": "rlwzmtmuitzvs", + "text": "htjxmfwdiw" } ], - "dimensions": 16, + "dimensions": 26, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "fwajvrkzedj", + "id": "vjtifrodzwydvynddmbudnno", "data": [ { "embedding": [ - 3 + 16 ], - "index": 15 + "index": 1 } ], "usage": { - "input_tokens": 4, - "prompt_tokens": 27, - "total_tokens": 14 + "input_tokens": 20, + "prompt_tokens": 28, + "total_tokens": 2 }, - "model": "rzfpwylkkwnqoerjogdqgf" + "model": "obwfxvadcvvziooogpswzqkn" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 21729c14e1b3..35b045e1a21e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "jwbxrzdcafrxmhrztwepxmsrgys" + "image": "rlwzmtmuitzvs" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "fwajvrkzedj", + "id": "vjtifrodzwydvynddmbudnno", "data": [ { "embedding": [ - 3 + 16 ], - "index": 15 + "index": 1 } ], "usage": { - "input_tokens": 4, - "prompt_tokens": 27, - "total_tokens": 14 + "input_tokens": 20, + "prompt_tokens": 28, + "total_tokens": 2 }, - "model": "rzfpwylkkwnqoerjogdqgf" + "model": "obwfxvadcvvziooogpswzqkn" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index b4dac1c13edc..ae964061c70f 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "gqhcghuvgajmrjva", + "model_name": "uvbxltprmh", "model_type": "embeddings", - "model_provider_name": "fqkylpirzwbklhcbgc" + "model_provider_name": "uuklhgbngggjryjphasqjiyk" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index eff3b0646089..70ef42df2ba4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "gqhcghuvgajmrjva", + "model_name": "uvbxltprmh", "model_type": "embeddings", - "model_provider_name": "fqkylpirzwbklhcbgc" + "model_provider_name": "uuklhgbngggjryjphasqjiyk" } } } From ac08a31e802b0bfbd2644b20ee5f706a1ea97feb Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 10 Jun 2024 12:04:19 -0700 Subject: [PATCH 140/343] Add missing public access of ModelType --- specification/ai/ModelClient/client.tsp | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 0a09a4560473..60ac5343a495 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -45,6 +45,7 @@ namespace Customizations; // The actual name here doesn't matter and is here for @@access(ModelClient.FunctionCall, Access.public); @@access(ModelClient.FunctionDefinition, Access.public); @@access(ModelClient.ModelInfo, Access.public); +@@access(ModelClient.ModelType, Access.public); @@access(ModelClient.StreamingChatChoiceUpdate, Access.public, "python"); @@access(ModelClient.StreamingChatCompletionsUpdate, Access.public, "python"); @@access(ModelClient.ChatMessageContentItem, Access.public); From 36d9e575521d4aa5cc7ae3978e32dbfa3959ca4e Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 10 Jun 2024 12:06:34 -0700 Subject: [PATCH 141/343] Regenerate examples --- specification/ai/ModelClient/client.tsp | 22 ++++++++++------ .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++++------ .../GetEmbeddings_MaximumSet_Gen.json | 16 ++++++------ .../GetEmbeddings_MinimumSet_Gen.json | 14 +++++----- .../GetImageEmbeddings_MaximumSet_Gen.json | 18 ++++++------- .../GetImageEmbeddings_MinimumSet_Gen.json | 14 +++++----- .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++++------ .../GetEmbeddings_MaximumSet_Gen.json | 16 ++++++------ .../GetEmbeddings_MinimumSet_Gen.json | 14 +++++----- .../GetImageEmbeddings_MaximumSet_Gen.json | 18 ++++++------- .../GetImageEmbeddings_MinimumSet_Gen.json | 14 +++++----- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +-- 17 files changed, 126 insertions(+), 120 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 60ac5343a495..5a07ece4dc32 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -72,19 +72,25 @@ interface Client1 { getModelInfo is ModelClient.getModelInfo; } -@client({ - name: "EmbeddingsClient", - service: ModelClient, -}, "python") +@client( + { + name: "EmbeddingsClient", + service: ModelClient, + }, + "python" +) interface Client2 { embed is ModelClient.getEmbeddings; getModelInfo is ModelClient.getModelInfo; } -@client({ - name: "ImageEmbeddingsClient", - service: ModelClient, -}, "python") +@client( + { + name: "ImageEmbeddingsClient", + service: ModelClient, + }, + "python" +) interface Client3 { embed is ModelClient.getImageEmbeddings; getModelInfo is ModelClient.getModelInfo; diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index cc91bbf107f9..abef43dd158f 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,46 +10,46 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": -1, "stream": true, - "presence_penalty": 0, + "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "jsgknsbxaqse" + "hyjmwlrxwyixwbx" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 16 + "seed": 22 } }, "responses": { "200": { "body": { - "id": "vttvkvwbbvgjtqphyswtfjq", - "created": 12, - "model": "yyxicqgwvohxtfgwaymlypcyuyskgl", + "id": "xljaucrjqaqjipmc", + "created": 29, + "model": "q", "usage": { - "completion_tokens": 19, - "prompt_tokens": 14, - "total_tokens": 16 + "completion_tokens": 18, + "prompt_tokens": 12, + "total_tokens": 8 }, "choices": [ { - "index": 1, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "vjwamdxrsbqojpolqr", + "content": "bvltz", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "pmmdjgalvahbkafjqir" + "id": "zoerkv" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index 9c70badfd10d..63a37dc3a6a4 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "vttvkvwbbvgjtqphyswtfjq", - "created": 12, - "model": "yyxicqgwvohxtfgwaymlypcyuyskgl", + "id": "xljaucrjqaqjipmc", + "created": 29, + "model": "q", "usage": { - "completion_tokens": 19, - "prompt_tokens": 14, - "total_tokens": 16 + "completion_tokens": 18, + "prompt_tokens": 12, + "total_tokens": 8 }, "choices": [ { - "index": 1, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "vjwamdxrsbqojpolqr" + "content": "bvltz" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index e88b306bdc19..29eb363cc5db 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "uwfwjjkuc" + "wlux" ], - "dimensions": 20, + "dimensions": 27, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "vjtifrodzwydvynddmbudnno", + "id": "kedirjyccyaebyn", "data": [ { "embedding": [ 16 ], - "index": 1 + "index": 18 } ], "usage": { - "input_tokens": 20, - "prompt_tokens": 28, - "total_tokens": 2 + "input_tokens": 21, + "prompt_tokens": 6, + "total_tokens": 16 }, - "model": "obwfxvadcvvziooogpswzqkn" + "model": "zdfajtcsw" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index 7d15e7c1a297..f20af8ae1b7d 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "ujqrjllpyke" + "gpopqlqlmaqsmnndd" ] } }, "responses": { "200": { "body": { - "id": "vjtifrodzwydvynddmbudnno", + "id": "kedirjyccyaebyn", "data": [ { "embedding": [ 16 ], - "index": 1 + "index": 18 } ], "usage": { - "input_tokens": 20, - "prompt_tokens": 28, - "total_tokens": 2 + "input_tokens": 21, + "prompt_tokens": 6, + "total_tokens": 16 }, - "model": "obwfxvadcvvziooogpswzqkn" + "model": "zdfajtcsw" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index 1e1cfdef0d20..d8ba8c9e70d2 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "rlwzmtmuitzvs", - "text": "htjxmfwdiw" + "image": "grfazklprgwztlcy", + "text": "alnrjrixfnv" } ], - "dimensions": 26, + "dimensions": 4, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "vjtifrodzwydvynddmbudnno", + "id": "kedirjyccyaebyn", "data": [ { "embedding": [ 16 ], - "index": 1 + "index": 18 } ], "usage": { - "input_tokens": 20, - "prompt_tokens": 28, - "total_tokens": 2 + "input_tokens": 21, + "prompt_tokens": 6, + "total_tokens": 16 }, - "model": "obwfxvadcvvziooogpswzqkn" + "model": "zdfajtcsw" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 35b045e1a21e..8caeb9e0b5f6 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "rlwzmtmuitzvs" + "image": "grfazklprgwztlcy" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "vjtifrodzwydvynddmbudnno", + "id": "kedirjyccyaebyn", "data": [ { "embedding": [ 16 ], - "index": 1 + "index": 18 } ], "usage": { - "input_tokens": 20, - "prompt_tokens": 28, - "total_tokens": 2 + "input_tokens": 21, + "prompt_tokens": 6, + "total_tokens": 16 }, - "model": "obwfxvadcvvziooogpswzqkn" + "model": "zdfajtcsw" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index ae964061c70f..2e9777adc418 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "uvbxltprmh", + "model_name": "ayxxrduegvgjomzmfcpndvdmvg", "model_type": "embeddings", - "model_provider_name": "uuklhgbngggjryjphasqjiyk" + "model_provider_name": "sursnucghq" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index 70ef42df2ba4..eca3b6cdd7b1 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "uvbxltprmh", + "model_name": "ayxxrduegvgjomzmfcpndvdmvg", "model_type": "embeddings", - "model_provider_name": "uuklhgbngggjryjphasqjiyk" + "model_provider_name": "sursnucghq" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index cc91bbf107f9..abef43dd158f 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,46 +10,46 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": -1, "stream": true, - "presence_penalty": 0, + "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "jsgknsbxaqse" + "hyjmwlrxwyixwbx" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 16 + "seed": 22 } }, "responses": { "200": { "body": { - "id": "vttvkvwbbvgjtqphyswtfjq", - "created": 12, - "model": "yyxicqgwvohxtfgwaymlypcyuyskgl", + "id": "xljaucrjqaqjipmc", + "created": 29, + "model": "q", "usage": { - "completion_tokens": 19, - "prompt_tokens": 14, - "total_tokens": 16 + "completion_tokens": 18, + "prompt_tokens": 12, + "total_tokens": 8 }, "choices": [ { - "index": 1, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "vjwamdxrsbqojpolqr", + "content": "bvltz", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "pmmdjgalvahbkafjqir" + "id": "zoerkv" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 9c70badfd10d..63a37dc3a6a4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "vttvkvwbbvgjtqphyswtfjq", - "created": 12, - "model": "yyxicqgwvohxtfgwaymlypcyuyskgl", + "id": "xljaucrjqaqjipmc", + "created": 29, + "model": "q", "usage": { - "completion_tokens": 19, - "prompt_tokens": 14, - "total_tokens": 16 + "completion_tokens": 18, + "prompt_tokens": 12, + "total_tokens": 8 }, "choices": [ { - "index": 1, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "vjwamdxrsbqojpolqr" + "content": "bvltz" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index e88b306bdc19..29eb363cc5db 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "uwfwjjkuc" + "wlux" ], - "dimensions": 20, + "dimensions": 27, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "vjtifrodzwydvynddmbudnno", + "id": "kedirjyccyaebyn", "data": [ { "embedding": [ 16 ], - "index": 1 + "index": 18 } ], "usage": { - "input_tokens": 20, - "prompt_tokens": 28, - "total_tokens": 2 + "input_tokens": 21, + "prompt_tokens": 6, + "total_tokens": 16 }, - "model": "obwfxvadcvvziooogpswzqkn" + "model": "zdfajtcsw" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 7d15e7c1a297..f20af8ae1b7d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "ujqrjllpyke" + "gpopqlqlmaqsmnndd" ] } }, "responses": { "200": { "body": { - "id": "vjtifrodzwydvynddmbudnno", + "id": "kedirjyccyaebyn", "data": [ { "embedding": [ 16 ], - "index": 1 + "index": 18 } ], "usage": { - "input_tokens": 20, - "prompt_tokens": 28, - "total_tokens": 2 + "input_tokens": 21, + "prompt_tokens": 6, + "total_tokens": 16 }, - "model": "obwfxvadcvvziooogpswzqkn" + "model": "zdfajtcsw" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index 1e1cfdef0d20..d8ba8c9e70d2 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "rlwzmtmuitzvs", - "text": "htjxmfwdiw" + "image": "grfazklprgwztlcy", + "text": "alnrjrixfnv" } ], - "dimensions": 26, + "dimensions": 4, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "vjtifrodzwydvynddmbudnno", + "id": "kedirjyccyaebyn", "data": [ { "embedding": [ 16 ], - "index": 1 + "index": 18 } ], "usage": { - "input_tokens": 20, - "prompt_tokens": 28, - "total_tokens": 2 + "input_tokens": 21, + "prompt_tokens": 6, + "total_tokens": 16 }, - "model": "obwfxvadcvvziooogpswzqkn" + "model": "zdfajtcsw" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 35b045e1a21e..8caeb9e0b5f6 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "rlwzmtmuitzvs" + "image": "grfazklprgwztlcy" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "vjtifrodzwydvynddmbudnno", + "id": "kedirjyccyaebyn", "data": [ { "embedding": [ 16 ], - "index": 1 + "index": 18 } ], "usage": { - "input_tokens": 20, - "prompt_tokens": 28, - "total_tokens": 2 + "input_tokens": 21, + "prompt_tokens": 6, + "total_tokens": 16 }, - "model": "obwfxvadcvvziooogpswzqkn" + "model": "zdfajtcsw" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index ae964061c70f..2e9777adc418 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "uvbxltprmh", + "model_name": "ayxxrduegvgjomzmfcpndvdmvg", "model_type": "embeddings", - "model_provider_name": "uuklhgbngggjryjphasqjiyk" + "model_provider_name": "sursnucghq" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 70ef42df2ba4..eca3b6cdd7b1 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "uvbxltprmh", + "model_name": "ayxxrduegvgjomzmfcpndvdmvg", "model_type": "embeddings", - "model_provider_name": "uuklhgbngggjryjphasqjiyk" + "model_provider_name": "sursnucghq" } } } From 4ee530691c4f6a3c4659ed05b29c47e554aabfc4 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 10 Jun 2024 16:53:36 -0700 Subject: [PATCH 142/343] Move Python class renaming to client.tsp --- specification/ai/ModelClient/client.tsp | 23 ++++++++++++++++++ .../GetChatCompletions_MaximumSet_Gen.json | 24 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++++------- .../GetEmbeddings_MaximumSet_Gen.json | 18 +++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 16 ++++++------- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 ++++++++-------- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 ++++++------- .../GetModelInfo_MaximumSet_Gen.json | 4 ++-- .../GetModelInfo_MinimumSet_Gen.json | 4 ++-- .../ModelClient/models/chat_completions.tsp | 4 ---- .../GetChatCompletions_MaximumSet_Gen.json | 24 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++++------- .../GetEmbeddings_MaximumSet_Gen.json | 18 +++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 16 ++++++------- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 ++++++++-------- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 ++++++------- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 ++-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 ++-- 18 files changed, 141 insertions(+), 122 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 5a07ece4dc32..3af2820c1f07 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -63,6 +63,29 @@ namespace Customizations; // The actual name here doesn't matter and is here for @@access(ModelClient.getImageEmbeddings, Access.internal, "python"); @@access(ModelClient.getModelInfo, Access.internal, "python"); +// We use shorter names in the Python client library +@@clientName(ModelClient.ChatRequestSystemMessage, "SystemMessage", "python"); +@@clientName(ModelClient.ChatRequestUserMessage, "UserMessage", "python"); +@@clientName(ModelClient.ChatRequestAssistantMessage, + "AssistantMessage", + "python" +); +@@clientName(ModelClient.ChatRequestToolMessage, "ToolMessage", "python"); +@@clientName(ModelClient.ChatMessageContentItem, "ContentItem", "python"); +@@clientName(ModelClient.ChatMessageTextContentItem, + "TextContentItem", + "python" +); +@@clientName(ModelClient.ChatMessageImageContentItem, + "ImageContentItem", + "python" +); +@@clientName(ModelClient.ChatMessageImageUrl, "ImageUrl", "python"); +@@clientName(ModelClient.ChatMessageImageDetailLevel, + "ImageDetailLevel", + "python" +); + @client({ name: "ChatCompletionsClient", service: ModelClient, diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index abef43dd158f..4ff8acaaead7 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": -2, "stream": true, "presence_penalty": -1, "temperature": 0, @@ -18,38 +18,38 @@ "max_tokens": 0, "response_format": "text", "stop": [ - "hyjmwlrxwyixwbx" + "frovutrcmwrzcoszelrglkuvpbukzu" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 22 + "seed": 6 } }, "responses": { "200": { "body": { - "id": "xljaucrjqaqjipmc", - "created": 29, - "model": "q", + "id": "hpcvgnonpjyzffximnagg", + "created": 27, + "model": "iextgrfegfy", "usage": { - "completion_tokens": 18, - "prompt_tokens": 12, - "total_tokens": 8 + "completion_tokens": 22, + "prompt_tokens": 9, + "total_tokens": 7 }, "choices": [ { - "index": 12, + "index": 10, "finish_reason": "stop", "message": { "role": "system", - "content": "bvltz", + "content": "kjzmsqcgjl", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "zoerkv" + "id": "maltrnwbhsjytwjfgxdshcbwup" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index 63a37dc3a6a4..b2bc30ea4e5b 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "xljaucrjqaqjipmc", - "created": 29, - "model": "q", + "id": "hpcvgnonpjyzffximnagg", + "created": 27, + "model": "iextgrfegfy", "usage": { - "completion_tokens": 18, - "prompt_tokens": 12, - "total_tokens": 8 + "completion_tokens": 22, + "prompt_tokens": 9, + "total_tokens": 7 }, "choices": [ { - "index": 12, + "index": 10, "finish_reason": "stop", "message": { "role": "system", - "content": "bvltz" + "content": "kjzmsqcgjl" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index 29eb363cc5db..c96b52844d7c 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "wlux" + "mhldnzatps" ], - "dimensions": 27, + "dimensions": 28, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "kedirjyccyaebyn", + "id": "eydebtydwpajdafhqiqtfdklcgrln", "data": [ { "embedding": [ - 16 + 15 ], - "index": 18 + "index": 7 } ], "usage": { - "input_tokens": 21, - "prompt_tokens": 6, - "total_tokens": 16 + "input_tokens": 18, + "prompt_tokens": 30, + "total_tokens": 30 }, - "model": "zdfajtcsw" + "model": "bxrwbixgoipxiqouemwamsccfmpwut" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index f20af8ae1b7d..9ce30dd55f38 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "gpopqlqlmaqsmnndd" + "mjcfkghomsiauazvrqizay" ] } }, "responses": { "200": { "body": { - "id": "kedirjyccyaebyn", + "id": "eydebtydwpajdafhqiqtfdklcgrln", "data": [ { "embedding": [ - 16 + 15 ], - "index": 18 + "index": 7 } ], "usage": { - "input_tokens": 21, - "prompt_tokens": 6, - "total_tokens": 16 + "input_tokens": 18, + "prompt_tokens": 30, + "total_tokens": 30 }, - "model": "zdfajtcsw" + "model": "bxrwbixgoipxiqouemwamsccfmpwut" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index d8ba8c9e70d2..4361c7f71835 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "grfazklprgwztlcy", - "text": "alnrjrixfnv" + "image": "eplktjwsrhtw", + "text": "esoizlgwokdrrxvlmtz" } ], - "dimensions": 4, + "dimensions": 27, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "kedirjyccyaebyn", + "id": "eydebtydwpajdafhqiqtfdklcgrln", "data": [ { "embedding": [ - 16 + 15 ], - "index": 18 + "index": 7 } ], "usage": { - "input_tokens": 21, - "prompt_tokens": 6, - "total_tokens": 16 + "input_tokens": 18, + "prompt_tokens": 30, + "total_tokens": 30 }, - "model": "zdfajtcsw" + "model": "bxrwbixgoipxiqouemwamsccfmpwut" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 8caeb9e0b5f6..4d64fd232563 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "grfazklprgwztlcy" + "image": "eplktjwsrhtw" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "kedirjyccyaebyn", + "id": "eydebtydwpajdafhqiqtfdklcgrln", "data": [ { "embedding": [ - 16 + 15 ], - "index": 18 + "index": 7 } ], "usage": { - "input_tokens": 21, - "prompt_tokens": 6, - "total_tokens": 16 + "input_tokens": 18, + "prompt_tokens": 30, + "total_tokens": 30 }, - "model": "zdfajtcsw" + "model": "bxrwbixgoipxiqouemwamsccfmpwut" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index 2e9777adc418..d482cf194f94 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "ayxxrduegvgjomzmfcpndvdmvg", + "model_name": "aakbqaphhuvebuxpcrve", "model_type": "embeddings", - "model_provider_name": "sursnucghq" + "model_provider_name": "mokbftoapmemqczizfxzibtt" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index eca3b6cdd7b1..0f5b7fef7433 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "ayxxrduegvgjomzmfcpndvdmvg", + "model_name": "aakbqaphhuvebuxpcrve", "model_type": "embeddings", - "model_provider_name": "sursnucghq" + "model_provider_name": "mokbftoapmemqczizfxzibtt" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 571968d27549..6de8a3f1003a 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -279,7 +279,6 @@ model ChatRequestMessage { A request chat message containing system instructions that influence how the model will generate a chat completions response. """) -@clientName("SystemMessage", "python") model ChatRequestSystemMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'system' for system messages.") role: ChatRole.system; @@ -289,7 +288,6 @@ model ChatRequestSystemMessage extends ChatRequestMessage { } @doc("A request chat message representing user input to the assistant.") -@clientName("UserMessage", "python") model ChatRequestUserMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'user' for user messages.") role: ChatRole.user; @@ -300,7 +298,6 @@ model ChatRequestUserMessage extends ChatRequestMessage { } @doc("A request chat message representing response or action from the assistant.") -@clientName("AssistantMessage", "python") model ChatRequestAssistantMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'assistant' for assistant messages.") role: ChatRole.assistant; @@ -318,7 +315,6 @@ model ChatRequestAssistantMessage extends ChatRequestMessage { } @doc("A request chat message representing requested output from a configured tool.") -@clientName("ToolMessage", "python") model ChatRequestToolMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'tool' for tool messages.") role: ChatRole.tool; diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index abef43dd158f..4ff8acaaead7 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": -2, "stream": true, "presence_penalty": -1, "temperature": 0, @@ -18,38 +18,38 @@ "max_tokens": 0, "response_format": "text", "stop": [ - "hyjmwlrxwyixwbx" + "frovutrcmwrzcoszelrglkuvpbukzu" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 22 + "seed": 6 } }, "responses": { "200": { "body": { - "id": "xljaucrjqaqjipmc", - "created": 29, - "model": "q", + "id": "hpcvgnonpjyzffximnagg", + "created": 27, + "model": "iextgrfegfy", "usage": { - "completion_tokens": 18, - "prompt_tokens": 12, - "total_tokens": 8 + "completion_tokens": 22, + "prompt_tokens": 9, + "total_tokens": 7 }, "choices": [ { - "index": 12, + "index": 10, "finish_reason": "stop", "message": { "role": "system", - "content": "bvltz", + "content": "kjzmsqcgjl", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "zoerkv" + "id": "maltrnwbhsjytwjfgxdshcbwup" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 63a37dc3a6a4..b2bc30ea4e5b 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "xljaucrjqaqjipmc", - "created": 29, - "model": "q", + "id": "hpcvgnonpjyzffximnagg", + "created": 27, + "model": "iextgrfegfy", "usage": { - "completion_tokens": 18, - "prompt_tokens": 12, - "total_tokens": 8 + "completion_tokens": 22, + "prompt_tokens": 9, + "total_tokens": 7 }, "choices": [ { - "index": 12, + "index": 10, "finish_reason": "stop", "message": { "role": "system", - "content": "bvltz" + "content": "kjzmsqcgjl" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 29eb363cc5db..c96b52844d7c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "wlux" + "mhldnzatps" ], - "dimensions": 27, + "dimensions": 28, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "kedirjyccyaebyn", + "id": "eydebtydwpajdafhqiqtfdklcgrln", "data": [ { "embedding": [ - 16 + 15 ], - "index": 18 + "index": 7 } ], "usage": { - "input_tokens": 21, - "prompt_tokens": 6, - "total_tokens": 16 + "input_tokens": 18, + "prompt_tokens": 30, + "total_tokens": 30 }, - "model": "zdfajtcsw" + "model": "bxrwbixgoipxiqouemwamsccfmpwut" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index f20af8ae1b7d..9ce30dd55f38 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "gpopqlqlmaqsmnndd" + "mjcfkghomsiauazvrqizay" ] } }, "responses": { "200": { "body": { - "id": "kedirjyccyaebyn", + "id": "eydebtydwpajdafhqiqtfdklcgrln", "data": [ { "embedding": [ - 16 + 15 ], - "index": 18 + "index": 7 } ], "usage": { - "input_tokens": 21, - "prompt_tokens": 6, - "total_tokens": 16 + "input_tokens": 18, + "prompt_tokens": 30, + "total_tokens": 30 }, - "model": "zdfajtcsw" + "model": "bxrwbixgoipxiqouemwamsccfmpwut" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index d8ba8c9e70d2..4361c7f71835 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "grfazklprgwztlcy", - "text": "alnrjrixfnv" + "image": "eplktjwsrhtw", + "text": "esoizlgwokdrrxvlmtz" } ], - "dimensions": 4, + "dimensions": 27, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "kedirjyccyaebyn", + "id": "eydebtydwpajdafhqiqtfdklcgrln", "data": [ { "embedding": [ - 16 + 15 ], - "index": 18 + "index": 7 } ], "usage": { - "input_tokens": 21, - "prompt_tokens": 6, - "total_tokens": 16 + "input_tokens": 18, + "prompt_tokens": 30, + "total_tokens": 30 }, - "model": "zdfajtcsw" + "model": "bxrwbixgoipxiqouemwamsccfmpwut" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 8caeb9e0b5f6..4d64fd232563 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "grfazklprgwztlcy" + "image": "eplktjwsrhtw" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "kedirjyccyaebyn", + "id": "eydebtydwpajdafhqiqtfdklcgrln", "data": [ { "embedding": [ - 16 + 15 ], - "index": 18 + "index": 7 } ], "usage": { - "input_tokens": 21, - "prompt_tokens": 6, - "total_tokens": 16 + "input_tokens": 18, + "prompt_tokens": 30, + "total_tokens": 30 }, - "model": "zdfajtcsw" + "model": "bxrwbixgoipxiqouemwamsccfmpwut" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 2e9777adc418..d482cf194f94 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "ayxxrduegvgjomzmfcpndvdmvg", + "model_name": "aakbqaphhuvebuxpcrve", "model_type": "embeddings", - "model_provider_name": "sursnucghq" + "model_provider_name": "mokbftoapmemqczizfxzibtt" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index eca3b6cdd7b1..0f5b7fef7433 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "ayxxrduegvgjomzmfcpndvdmvg", + "model_name": "aakbqaphhuvebuxpcrve", "model_type": "embeddings", - "model_provider_name": "sursnucghq" + "model_provider_name": "mokbftoapmemqczizfxzibtt" } } } From d11c3b1201ca8472d04117a356653061ccea9669 Mon Sep 17 00:00:00 2001 From: johnkoh-msft <113449581+johnkoh-msft@users.noreply.github.com> Date: Tue, 11 Jun 2024 00:39:05 -0400 Subject: [PATCH 143/343] Release azuredatatransfer microsoft.azure data transfer stable/2024 05 07 (#29211) * Copy files from stable/2024-01-25 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-05-07 Updated the API version from stable/2024-01-25 to stable/2024-05-07. * Added tag for 2024-05-07 in readme file * Add new flow types * Run prettier * Run prettier for all files * Add schema direction * Add Standard flow type * Replace Blob with Standard in examples --- .../stable/2024-05-07/azuredatatransfer.json | 2400 +++++++++++++++++ .../examples/approveOrRejectConnection.json | 31 + .../examples/createOrUpdateConnection.json | 42 + .../examples/createOrUpdateFlow.json | 36 + .../examples/createOrUpdatePipeline.json | 30 + .../2024-05-07/examples/deleteConnection.json | 16 + .../2024-05-07/examples/deleteFlow.json | 17 + .../2024-05-07/examples/deletePipeline.json | 16 + .../examples/enableOrDisableFlow.json | 23 + .../2024-05-07/examples/getConnection.json | 17 + .../stable/2024-05-07/examples/getFlow.json | 18 + .../2024-05-07/examples/getPipeline.json | 17 + .../2024-05-07/examples/linkConnection.json | 25 + .../stable/2024-05-07/examples/linkFlow.json | 26 + .../listConnectionsByResourceGroup.json | 37 + .../listConnectionsBySubscription.json | 36 + .../examples/listFlowsByConnection.json | 44 + .../2024-05-07/examples/listOperations.json | 43 + .../examples/listPendingConnections.json | 34 + .../2024-05-07/examples/listPendingFlows.json | 34 + .../listPipelinesByResourceGroup.json | 33 + .../examples/listPipelinesBySubscription.json | 32 + .../2024-05-07/examples/listSchemas.json | 24 + .../2024-05-07/examples/patchConnection.json | 47 + .../stable/2024-05-07/examples/patchFlow.json | 54 + .../2024-05-07/examples/patchPipeline.json | 43 + .../examples/postListApprovedSchemas.json | 21 + .../examples/postValidateSchema.json | 16 + .../resource-manager/readme.md | 11 +- 29 files changed, 3222 insertions(+), 1 deletion(-) create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/azuredatatransfer.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/approveOrRejectConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdatePipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deletePipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/enableOrDisableFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getPipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsByResourceGroup.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsBySubscription.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listFlowsByConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listOperations.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingConnections.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingFlows.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesByResourceGroup.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesBySubscription.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listSchemas.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchPipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postListApprovedSchemas.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postValidateSchema.json diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/azuredatatransfer.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/azuredatatransfer.json new file mode 100644 index 000000000000..f70189067610 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/azuredatatransfer.json @@ -0,0 +1,2400 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-07", + "title": "azuredatatransferrp", + "description": "Azure Data Transfer service resource provider" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.AzureDataTransfer/validateSchema": { + "post": { + "description": "Validates a schema for Azure Data Transfer.", + "x-ms-examples": { + "Performs action request": { + "$ref": "examples/postValidateSchema.json" + } + }, + "operationId": "AzureDataTransfer_validateSchema", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "schema", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/schema" + }, + "description": "The schema to validate" + } + ], + "responses": { + "200": { + "description": "Result of the schema validation.", + "schema": { + "$ref": "#/definitions/validateSchemaResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.AzureDataTransfer/listApprovedSchemas": { + "post": { + "description": "Lists approved schemas for Azure Data Transfer.", + "x-ms-examples": { + "Performs action request": { + "$ref": "examples/postListApprovedSchemas.json" + } + }, + "operationId": "AzureDataTransfer_listApprovedSchemas", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/listApprovedSchemasRequest" + }, + "description": "The request to list approved schemas." + } + ], + "responses": { + "200": { + "description": "List of approved schemas.", + "schema": { + "$ref": "#/definitions/schemasListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}": { + "get": { + "description": "Gets flow resource.", + "x-ms-examples": { + "Gets flow resource": { + "$ref": "examples/getFlow.json" + } + }, + "operationId": "Flows_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates the flow resource.", + "operationId": "Flows_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates the flow resource": { + "$ref": "examples/createOrUpdateFlow.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/flow" + } + } + ], + "responses": { + "200": { + "description": "Created the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "201": { + "description": "Accepted creation the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes the flow resource.", + "x-ms-examples": { + "Deletes the flow resource": { + "$ref": "examples/deleteFlow.json" + } + }, + "operationId": "Flows_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete the flows resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the flows resource." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "description": "Updates the flow resource.", + "operationId": "Flows_Update", + "x-ms-examples": { + "Updates the flow resource": { + "$ref": "examples/patchFlow.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/flowsPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Accepted update to the flows resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/enable": { + "post": { + "description": "Enables the specified flow.", + "x-ms-examples": { + "Enables the specified flow": { + "$ref": "examples/enableOrDisableFlow.json" + } + }, + "operationId": "Flows_Enable", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Enables a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Enables a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/disable": { + "post": { + "description": "Disables the specified flow", + "x-ms-examples": { + "Disables the specified flow": { + "$ref": "examples/enableOrDisableFlow.json" + } + }, + "operationId": "Flows_Disable", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Disables a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Disables a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/link": { + "post": { + "description": "Links the specified flow.", + "x-ms-examples": { + "Links the specified flow": { + "$ref": "examples/linkFlow.json" + } + }, + "operationId": "Flows_Link", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Links a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Links a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows": { + "get": { + "description": "Gets flows in a connection.", + "x-ms-examples": { + "Gets flows in a connection": { + "$ref": "examples/listFlowsByConnection.json" + } + }, + "operationId": "Flows_ListByConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Listed all flows under the resource group.", + "schema": { + "$ref": "#/definitions/flowsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}": { + "get": { + "description": "Gets connection resource.", + "x-ms-examples": { + "Gets connection resource": { + "$ref": "examples/getConnection.json" + } + }, + "operationId": "Connections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates the connection resource.", + "operationId": "Connections_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates the connection resource": { + "$ref": "examples/createOrUpdateConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/connection" + } + } + ], + "responses": { + "200": { + "description": "Created the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "201": { + "description": "Accepted create of the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes the connection resource.", + "x-ms-examples": { + "Deletes the connection resource": { + "$ref": "examples/deleteConnection.json" + } + }, + "operationId": "Connections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete the connections resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the connections resource." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "description": "Updates the connection resource.", + "operationId": "Connections_Update", + "x-ms-examples": { + "Updates the connection resource": { + "$ref": "examples/patchConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/connectionsPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Accepted update to the connections resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/link": { + "post": { + "description": "Links the connection to its pending connection.", + "x-ms-examples": { + "Links the specified connection": { + "$ref": "examples/linkConnection.json" + } + }, + "operationId": "Connections_Link", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Links a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Links a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingConnections": { + "post": { + "description": "Lists all pending connections for a connection.", + "x-ms-examples": { + "Lists a list of pending connections": { + "$ref": "examples/listPendingConnections.json" + } + }, + "operationId": "ListPendingConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pending connections.", + "schema": { + "$ref": "#/definitions/pendingConnectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingFlows": { + "post": { + "description": "Lists all pending flows for a connection.", + "x-ms-examples": { + "Lists a list of pending flows": { + "$ref": "examples/listPendingFlows.json" + } + }, + "operationId": "ListPendingFlows_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the resource group.", + "schema": { + "$ref": "#/definitions/pendingFlowsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections": { + "get": { + "description": "Gets connections in a resource group.", + "x-ms-examples": { + "Gets connections in a resource group": { + "$ref": "examples/listConnectionsByResourceGroup.json" + } + }, + "operationId": "Connections_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the resource group.", + "schema": { + "$ref": "#/definitions/connectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/connections": { + "get": { + "description": "Gets connections in a subscription.", + "x-ms-examples": { + "Gets connections in a subscription": { + "$ref": "examples/listConnectionsBySubscription.json" + } + }, + "operationId": "Connections_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the subscription.", + "schema": { + "$ref": "#/definitions/connectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}": { + "get": { + "description": "Gets pipeline resource.", + "x-ms-examples": { + "Gets pipeline resource": { + "$ref": "examples/getPipeline.json" + } + }, + "operationId": "Pipelines_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates the pipeline resource.", + "operationId": "Pipelines_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates the pipeline resource": { + "$ref": "examples/createOrUpdatePipeline.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "description": "Pipeline body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/pipeline" + } + } + ], + "responses": { + "200": { + "description": "Created the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "201": { + "description": "Accepted create of the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes the pipeline resource.", + "x-ms-examples": { + "Deletes the pipeline resource": { + "$ref": "examples/deletePipeline.json" + } + }, + "operationId": "Pipelines_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete of the pipelines resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the pipelines resource." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "description": "Updates the pipeline resource.", + "operationId": "Pipelines_Update", + "x-ms-examples": { + "Updates the pipeline resource": { + "$ref": "examples/patchPipeline.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "description": "Pipeline body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/pipelinesPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "202": { + "description": "Accepted update to the pipelines resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/approveConnection": { + "post": { + "description": "Approves the specified connection in a pipeline.", + "x-ms-examples": { + "Approves the specified connection in a pipeline": { + "$ref": "examples/approveOrRejectConnection.json" + } + }, + "operationId": "Pipelines_ApproveConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Approves a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Approves a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/rejectConnection": { + "post": { + "description": "Rejects the specified connection in a pipeline.", + "x-ms-examples": { + "Rejects the specified connection in a pipeline": { + "$ref": "examples/approveOrRejectConnection.json" + } + }, + "operationId": "Pipelines_RejectConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Rejects a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Rejects a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listSchemas": { + "post": { + "description": "Lists the schemas for the specified connection in a pipeline.", + "x-ms-examples": { + "Lists schemas for a pipeline": { + "$ref": "examples/listSchemas.json" + } + }, + "operationId": "ListSchemas_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "schema", + "description": "Schema(s) to retrieve", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/schema" + } + } + ], + "responses": { + "200": { + "description": "Approves a connection.", + "schema": { + "description": "The schemas for this connection", + "$ref": "#/definitions/schemasListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines": { + "get": { + "description": "Gets pipelines in a resource group.", + "x-ms-examples": { + "Gets pipelines in a resource group": { + "$ref": "examples/listPipelinesByResourceGroup.json" + } + }, + "operationId": "Pipelines_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pipelines under the resource group.", + "schema": { + "$ref": "#/definitions/pipelinesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/pipelines": { + "get": { + "description": "Gets pipelines in a subscription.", + "x-ms-examples": { + "Gets pipelines in a subscription": { + "$ref": "examples/listPipelinesBySubscription.json" + } + }, + "operationId": "Pipelines_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pipelines under the subscription.", + "schema": { + "$ref": "#/definitions/pipelinesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AzureDataTransfer/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/listOperations.json" + } + }, + "description": "Lists all of the available Microsoft.AzureDataTransfer REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all of the available operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "validateSchemaResult": { + "type": "object", + "description": "Result of the schema validation.", + "properties": { + "status": { + "enum": [ + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "validateSchemaStatus", + "modelAsString": true + }, + "description": "Validation status of the schema" + }, + "message": { + "type": "string", + "description": "Message describing the schema validation" + } + } + }, + "listApprovedSchemasRequest": { + "type": "object", + "properties": { + "pipeline": { + "type": "string", + "description": "The name of the pipeline to filter approved schemas." + }, + "direction": { + "description": "The direction pipeline to filter approved schemas.", + "enum": [ + "Send", + "Receive" + ], + "type": "string", + "x-ms-enum": { + "name": "listApprovedSchemasDirection", + "modelAsString": true + } + } + } + }, + "selectedResource": { + "type": "object", + "description": "A resource selected from ARM", + "properties": { + "name": { + "type": "string", + "description": "Name of the connection" + }, + "id": { + "type": "string", + "description": "Id of the connection" + }, + "location": { + "type": "string", + "description": "Location of the connection", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "subscriptionName": { + "type": "string", + "description": "Name of the subscription with the connection" + } + }, + "required": [ + "id" + ] + }, + "flowProperties": { + "type": "object", + "properties": { + "connection": { + "$ref": "#/definitions/selectedResource", + "description": "The connection associated with this flow" + }, + "flowId": { + "type": "string", + "description": "Dataflow GUID associated with this flow", + "readOnly": true + }, + "keyVaultUri": { + "type": "string", + "description": "AME, PME, or TORUS only! AKV Chain Containing SAS Token" + }, + "linkStatus": { + "enum": [ + "Linked", + "Unlinked" + ], + "type": "string", + "x-ms-enum": { + "name": "linkStatusFlow", + "modelAsString": true + }, + "description": "Link status of the current flow", + "readOnly": true + }, + "linkedFlowId": { + "type": "string", + "description": "Resource ID of the linked flow", + "readOnly": true + }, + "status": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "flowStatus", + "modelAsString": true + }, + "description": "Status of the current flow" + }, + "storageAccountName": { + "type": "string", + "description": "Storage Account" + }, + "storageAccountId": { + "type": "string", + "format": "arm-id", + "description": "Storage Account ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "*" + ], + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "storageContainerName": { + "type": "string", + "description": "Storage Container Name" + }, + "serviceBusQueueId": { + "type": "string", + "format": "arm-id", + "description": "Service Bus Queue ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "*" + ], + "type": "Microsoft.Storage/namespaces/queues" + } + ] + } + }, + "flowType": { + "$ref": "#/definitions/flowType", + "description": "The flow type for this flow" + }, + "dataType": { + "enum": [ + "Blob", + "Table" + ], + "type": "string", + "x-ms-enum": { + "name": "dataType", + "modelAsString": true + }, + "description": "Transfer Storage Blobs or Tables" + }, + "provisioningState": { + "description": "Provisioning state of the flow", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this flow", + "items": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/schema", + "description": "The selected schema for this flow" + }, + "messagingOptions": { + "$ref": "#/definitions/messagingOptions", + "description": "The messaging options for this flow" + } + }, + "description": "Properties of flow" + }, + "flow": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/flowProperties" + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed identity of the flow resource, if configured." + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The flow resource definition." + }, + "pendingFlow": { + "type": "object", + "description": "Pending flow object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID of the pending flow.", + "readOnly": true + }, + "connectionId": { + "type": "string", + "description": "Connection ID of the pending flow.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/flowProperties" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "flowsPatch": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed identity of the flow resource, if configured." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The flows resource patch definition." + }, + "flowsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/flow" + }, + "description": "Flows array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The flows list result." + }, + "connectionProperties": { + "type": "object", + "properties": { + "pipeline": { + "type": "string", + "description": "Pipeline to use to transfer data" + }, + "direction": { + "description": "Direction of data movement", + "enum": [ + "Send", + "Receive" + ], + "type": "string", + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + }, + "justification": { + "type": "string", + "description": "Justification for the connection request" + }, + "status": { + "description": "Status of the connection", + "enum": [ + "InReview", + "Approved", + "Rejected", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + }, + "readOnly": true + }, + "statusReason": { + "type": "string", + "description": "Reason for status", + "readOnly": true + }, + "linkStatus": { + "enum": [ + "Linked", + "Unlinked" + ], + "type": "string", + "x-ms-enum": { + "name": "linkStatus", + "modelAsString": true + }, + "description": "Link status of the current connection", + "readOnly": true + }, + "linkedConnectionId": { + "type": "string", + "description": "Resource ID of the linked connection", + "readOnly": true + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types being requested for this connection" + }, + "requirementId": { + "description": "Requirement ID of the connection", + "type": "string" + }, + "remoteSubscriptionId": { + "description": "Subscription ID to link cloud subscriptions together", + "type": "string" + }, + "approver": { + "description": "Approver of this connection request", + "type": "string", + "readOnly": true + }, + "pin": { + "description": "PIN to link requests together", + "type": "string" + }, + "dateSubmitted": { + "type": "string", + "format": "date-time", + "description": "The timestamp that this connection request was submitted at", + "readOnly": true + }, + "primaryContact": { + "type": "string", + "description": "The primary contact for this connection request" + }, + "secondaryContacts": { + "type": "array", + "description": "The secondary contacts for this connection request", + "items": { + "type": "string" + } + }, + "provisioningState": { + "description": "Provisioning state of the connection", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this connection", + "items": { + "type": "string" + } + }, + "schemas": { + "description": "The schemas for this connection", + "$ref": "#/definitions/schemas" + } + }, + "required": [ + "pipeline" + ], + "description": "Properties of connection" + }, + "connection": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/connectionProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The connection resource definition." + }, + "pendingConnection": { + "type": "object", + "description": "Pending connection object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID of the pending connection.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/connectionProperties" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "connectionsPatch": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The connections resource patch definition." + }, + "connectionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/connection" + }, + "description": "Connections array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "pendingConnectionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pendingConnection" + }, + "description": "Connections array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "pendingFlowsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pendingFlow" + }, + "description": "flows array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "operationStatusProperties": { + "type": "object", + "description": "Operation status associated with the last patch request", + "properties": { + "status": { + "enum": [ + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "operationStatusEnum", + "modelAsString": true + }, + "description": "Operation status for the last patch request for this connection.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "Operation status ID of the last patch request for this connection.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Message for the operation for the last patch request for this connection.", + "readOnly": true + } + } + }, + "internalMetadataProperties": { + "type": "object", + "description": "Internal metadata of the connection inside pipeline.", + "properties": { + "operationStatus": { + "$ref": "#/definitions/operationStatusProperties" + }, + "statusSetBy": { + "type": "string", + "description": "User that last set the approved status for this connection", + "readOnly": true + } + }, + "additionalProperties": {} + }, + "pipelineConnection": { + "description": "Connection body inside a pipeline", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Connection id inside pipeline" + }, + "name": { + "type": "string", + "description": "Connection name inside pipeline", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Connection type inside pipeline", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Connection location inside pipeline", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "etag": { + "type": "string", + "description": "Connection etag inside pipeline", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + }, + "properties": { + "type": "object", + "description": "Connection properties inside pipeline", + "properties": { + "internalMetadata": { + "$ref": "#/definitions/internalMetadataProperties" + } + }, + "additionalProperties": {} + } + }, + "additionalProperties": {}, + "required": [ + "id" + ] + }, + "pipelineProperties": { + "type": "object", + "properties": { + "remoteCloud": { + "type": "string", + "description": "Remote cloud of the data to be transferred or received" + }, + "displayName": { + "type": "string", + "description": "Display name of this pipeline" + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/pipelineConnection" + }, + "description": "Connections associated with pipeline", + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + }, + "subscribers": { + "type": "array", + "items": { + "$ref": "#/definitions/subscriber" + }, + "x-ms-identifiers": [], + "description": "Subscribers of this resource" + }, + "provisioningState": { + "description": "Provisioning state of the pipeline", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this pipeline", + "items": { + "type": "string" + } + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types allowed for this pipeline" + } + }, + "required": [ + "remoteCloud" + ], + "description": "Properties of pipeline" + }, + "pipeline": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/pipelineProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The pipeline resource definition." + }, + "pipelinesPatch": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/pipelineConnection" + }, + "description": "Connections associated with pipeline", + "x-ms-identifiers": [ + "id" + ] + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types allowed for this pipeline" + } + }, + "description": "Properties of pipelines patch body." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The pipelines resource patch definition." + }, + "pipelinesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pipeline" + }, + "description": "Pipelines array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The pipelines list result." + }, + "subscriber": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Email of the subscriber" + }, + "notifications": { + "type": "integer", + "format": "int64", + "description": "Number specifying what notifications to receive" + } + } + }, + "schemas": { + "type": "array", + "description": "The schemas for this connection", + "x-ms-identifiers": [ + "connectionId", + "name" + ], + "items": { + "$ref": "#/definitions/schema" + } + }, + "schema": { + "type": "object", + "description": "The schema object.", + "properties": { + "id": { + "type": "string", + "description": "ID associated with this schema" + }, + "connectionId": { + "type": "string", + "description": "Connection ID associated with this schema" + }, + "status": { + "enum": [ + "New", + "Approved" + ], + "type": "string", + "x-ms-enum": { + "name": "schemaStatus", + "modelAsString": true + }, + "description": "Status of the schema" + }, + "name": { + "type": "string", + "description": "Name of the schema" + }, + "content": { + "type": "string", + "description": "Content of the schema" + }, + "direction": { + "description": "The direction of the schema.", + "enum": [ + "Send", + "Receive" + ], + "type": "string", + "x-ms-enum": { + "name": "schemaDirection", + "modelAsString": true + } + } + } + }, + "schemasListResult": { + "type": "object", + "properties": { + "value": { + "description": "Schemas array.", + "$ref": "#/definitions/schemas" + } + }, + "description": "The schemas list result." + }, + "flowTypes": { + "type": "array", + "description": "The flow types that are allowed for this resource", + "items": { + "$ref": "#/definitions/flowType" + } + }, + "flowType": { + "enum": [ + "Unknown", + "Complex", + "DevSecOps", + "Messaging", + "Mission", + "MicrosoftInternal", + "BasicFiles", + "Data", + "Standard", + "StreamingVideo", + "Opaque", + "MissionOpaqueXML" + ], + "type": "string", + "x-ms-enum": { + "name": "flowType", + "modelAsString": true + }, + "description": "Flow type for the specified resource" + }, + "resourceBody": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the resource." + }, + "statusReason": { + "type": "string", + "description": "Reason for resource operation." + } + }, + "required": [ + "id" + ], + "description": "The resource to reference." + }, + "messagingOptions": { + "type": "object", + "properties": { + "billingTier": { + "enum": [ + "BlobTransport", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "flowBillingTier", + "modelAsString": true + }, + "description": "Billing tier for this messaging flow" + } + }, + "description": "The option associated with messaging flows." + } + }, + "parameters": { + "flowNameParameter": { + "x-ms-parameter-location": "method", + "name": "flowName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$", + "maxLength": 64, + "minLength": 3, + "description": "The name for the flow that is to be onboarded." + }, + "connectionNameParameter": { + "x-ms-parameter-location": "method", + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$", + "maxLength": 64, + "minLength": 3, + "description": "The name for the connection that is to be requested." + }, + "pipelineNameParameter": { + "x-ms-parameter-location": "method", + "name": "pipelineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$", + "maxLength": 64, + "minLength": 3, + "description": "The name for the pipeline that is to be requested." + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/approveOrRejectConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/approveOrRejectConnection.json new file mode 100644 index 000000000000..e3d72dc8dd90 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/approveOrRejectConnection.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "statusReason": "Example reason" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateConnection.json new file mode 100644 index 000000000000..319f0db0e75c --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateConnection.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateFlow.json new file mode 100644 index 000000000000..56f3179a2f64 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdateFlow.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": { + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + } + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdatePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdatePipeline.json new file mode 100644 index 000000000000..265c5695e3fd --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/createOrUpdatePipeline.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": { + "properties": { + "remoteCloud": "testdc" + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteConnection.json new file mode 100644 index 000000000000..11ba85eddd3e --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteConnection.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteFlow.json new file mode 100644 index 000000000000..f9ef8d7853f9 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deleteFlow.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deletePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deletePipeline.json new file mode 100644 index 000000000000..c9a9ff7bdbc9 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/deletePipeline.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/enableOrDisableFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/enableOrDisableFlow.json new file mode 100644 index 000000000000..b256b3b9425d --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/enableOrDisableFlow.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getConnection.json new file mode 100644 index 000000000000..720b677100ff --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getConnection.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connection/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getFlow.json new file mode 100644 index 000000000000..9c8b4e0ccfa6 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getFlow.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getPipeline.json new file mode 100644 index 000000000000..d0b8a32bdbef --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/getPipeline.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkConnection.json new file mode 100644 index 000000000000..752823ea5b0f --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkConnection.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connection", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkFlow.json new file mode 100644 index 000000000000..4f39abfc5385 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/linkFlow.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsByResourceGroup.json new file mode 100644 index 000000000000..c266030c70c0 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsBySubscription.json new file mode 100644 index 000000000000..34432d1b8a73 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listConnectionsBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listFlowsByConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listFlowsByConnection.json new file mode 100644 index 000000000000..9a87876e7792 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listFlowsByConnection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listOperations.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listOperations.json new file mode 100644 index 000000000000..3034f110a90e --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listOperations.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "teleportalClient", + "api-version": "2024-05-07", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureDataTransfer/read", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Read flows", + "description": "Read flows" + } + }, + { + "name": "Microsoft.AzureDataTransfer/write", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Update flows", + "description": "Update flows" + } + }, + { + "name": "Microsoft.AzureDataTransfer/delete", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Delete flows", + "description": "Delete flows" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingConnections.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingConnections.json new file mode 100644 index 000000000000..37357e5953c7 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingConnections.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "location": "East US", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + }, + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "location": "East US", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingFlows.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingFlows.json new file mode 100644 index 000000000000..133d21a90312 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPendingFlows.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testFlow", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob" + }, + { + "name": "testInstallation2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesByResourceGroup.json new file mode 100644 index 000000000000..56dece17d741 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesByResourceGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesBySubscription.json new file mode 100644 index 000000000000..db2e706c6ba4 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listPipelinesBySubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listSchemas.json new file mode 100644 index 000000000000..fc625b991ce5 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/listSchemas.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schema": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "name": "test.xsd" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchConnection.json new file mode 100644 index 000000000000..60e92ca408c6 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchConnection.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchFlow.json new file mode 100644 index 000000000000..b6f94cb4e9d3 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchFlow.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchPipeline.json new file mode 100644 index 000000000000..e4fee607cd51 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/patchPipeline.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-05-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-05-07" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postListApprovedSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postListApprovedSchemas.json new file mode 100644 index 000000000000..112204607668 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postListApprovedSchemas.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-05-07", + "pipeline": { + "pipeline": "test", + "direction": "Send" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postValidateSchema.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postValidateSchema.json new file mode 100644 index 000000000000..9b2c3871b48f --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-05-07/examples/postValidateSchema.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-07", + "schema": { + "name": "schema.xml" + } + }, + "responses": { + "200": { + "body": { + "status": "Failed", + "message": "Validation failed" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/readme.md b/specification/azuredatatransfer/resource-manager/readme.md index ef5fc181349f..4fa16a5b3e8e 100644 --- a/specification/azuredatatransfer/resource-manager/readme.md +++ b/specification/azuredatatransfer/resource-manager/readme.md @@ -27,10 +27,19 @@ These are the global settings for the azuredatatransfer. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-01 +tag: package-2024-05 ``` +### Tag: package-2024-05 + +These settings apply only when `--tag=package-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-2024-05' +input-file: + - Microsoft.AzureDataTransfer/stable/2024-05-07/azuredatatransfer.json +``` + ### Tag: package-2024-01 These settings apply only when `--tag=package-2024-01` is specified on the command line. From 82846235e39ef4ee910772d2ff1ef58a349bfdb6 Mon Sep 17 00:00:00 2001 From: hamshavathimunibyraiah <125092972+hamshavathimunibyraiah@users.noreply.github.com> Date: Mon, 10 Jun 2024 23:44:23 -0700 Subject: [PATCH 144/343] Adding documentation for properties (#29382) * Adding documentation of properties and making some changes to java and js SDK generation * Reverting the tspconfig change * fixing formatting * Fixing typeSpec validation error on build --- package-lock.json | 14 +++++++------- .../Azure.AI.DocumentTranslation/models.tsp | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index dbaa7f94bbe2..1637d0e1fb9d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1925,12 +1925,12 @@ } }, "node_modules/braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", "dev": true, "dependencies": { - "fill-range": "^7.0.1" + "fill-range": "^7.1.1" }, "engines": { "node": ">=8" @@ -2319,9 +2319,9 @@ } }, "node_modules/fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", "dev": true, "dependencies": { "to-regex-range": "^5.0.1" diff --git a/specification/translation/Azure.AI.DocumentTranslation/models.tsp b/specification/translation/Azure.AI.DocumentTranslation/models.tsp index 0b1c6116e494..73ec6c09922c 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/models.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/models.tsp @@ -84,10 +84,10 @@ union StorageSource { @doc("List of possible additional output formats") union AdditionalOutputFileFormat { - /** No additional format */ + @doc("No additional format") None: "None", - /** OpenXmlWord format */ + @doc("OpenXmlWord format") OpenXmlWord: "OpenXmlWord", string, From 0bfaa5127dd7dfea140acb630da3d1a2d8b41ffd Mon Sep 17 00:00:00 2001 From: ZhidaLiu Date: Mon, 10 Jun 2024 23:46:00 -0700 Subject: [PATCH 145/343] Fix Account Key Type and CogServices SKU Location (#29025) * Account Key Type * Account key Preview Spec * "Sku Updates" * Remove Endpoint Type from Schema * Add x-ms-secret to account key property --------- Co-authored-by: Matthew Ferrari <124112629+matferrari-msft@users.noreply.github.com> Co-authored-by: Matthew Ferrari --- .../examples/Endpoint/Deployment/create.json | 2 - .../examples/Endpoint/Deployment/get.json | 1 - .../Endpoint/Deployment/getDeployments.json | 1 - .../Endpoint/Deployment/getInWorkspace.json | 1 - .../WorkspaceConnection/createDeployment.json | 3 - .../WorkspaceConnection/getDeployment.json | 1 - .../WorkspaceConnection/listDeployments.json | 1 - .../2024-04-01-preview/workspaceRP.json | 83 +++++-------------- .../2024-04-01/machineLearningServices.json | 12 ++- 9 files changed, 30 insertions(+), 75 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/create.json index 0d7c5d38400f..5b8b152044e2 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/create.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/create.json @@ -8,7 +8,6 @@ "api-version": "2024-04-01-preview", "body": { "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", @@ -31,7 +30,6 @@ "name": "text-davinci-003", "type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments", "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/get.json index d78ff733ba16..139d7cadbe81 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/get.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/get.json @@ -20,7 +20,6 @@ "name": "text-davinci-003", "type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments", "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/getDeployments.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/getDeployments.json index 555ad524d752..000a604af11e 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/getDeployments.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/getDeployments.json @@ -21,7 +21,6 @@ "name": "text-davinci-003", "type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments", "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/getInWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/getInWorkspace.json index a10bd84719b2..adb99272c435 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/getInWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/Endpoint/Deployment/getInWorkspace.json @@ -20,7 +20,6 @@ "name": "text-davinci-003", "type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments", "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/createDeployment.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/createDeployment.json index 0e63735ca681..4ca24a7da91f 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/createDeployment.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/createDeployment.json @@ -8,7 +8,6 @@ "api-version": "2024-04-01-preview", "body": { "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", @@ -31,7 +30,6 @@ "name": "text-davinci-003", "type": "Microsoft.MachineLearningServices/workspaces/connections/deployments", "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", @@ -56,7 +54,6 @@ "name": "text-davinci-003", "type": "Microsoft.MachineLearningServices/workspaces/connections/deployments", "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/getDeployment.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/getDeployment.json index e7ece185d1d8..d02138d739d1 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/getDeployment.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/getDeployment.json @@ -20,7 +20,6 @@ "name": "text-davinci-003", "type": "Microsoft.MachineLearningServices/workspaces/connections/deployments", "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/listDeployments.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/listDeployments.json index 98edc266d7fd..14f2caf80ba5 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/listDeployments.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/examples/WorkspaceConnection/listDeployments.json @@ -21,7 +21,6 @@ "name": "text-davinci-003", "type": "Microsoft.MachineLearningServices/workspaces/connections/deployments", "properties": { - "type": "Azure.OpenAI", "model": { "format": "OpenAI", "name": "text-davinci-003", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json index 716135740c2b..6991301becf7 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json @@ -3756,7 +3756,7 @@ ], "properties": { "credentials": { - "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" + "$ref": "#/definitions/WorkspaceConnectionAccountKey" } }, "x-ms-discriminator-value": "AccountKey" @@ -3928,9 +3928,6 @@ "type": "string", "description": "The name of RAI policy." }, - "sku": { - "$ref": "#/definitions/CognitiveServicesSku" - }, "versionUpgradeOption": { "description": "Deployment model version upgrade option.", "type": "string", @@ -4125,18 +4122,6 @@ "modelAsString": true } }, - "ContentSafetyEndpointDeploymentResourceProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CognitiveServiceEndpointDeploymentResourceProperties" - }, - { - "$ref": "#/definitions/EndpointDeploymentResourceProperties" - } - ], - "x-ms-discriminator-value": "Azure.ContentSafety" - }, "ContentSafetyEndpointResourceProperties": { "type": "object", "allOf": [ @@ -4518,27 +4503,18 @@ } }, "EndpointDeploymentResourceProperties": { - "required": [ - "type" - ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServiceEndpointDeploymentResourceProperties" + } + ], "properties": { - "failureReason": { - "description": "The failure reason if the creation failed.", - "type": "string" - }, "provisioningState": { "description": "Read-only provision state status property.", "$ref": "#/definitions/DefaultResourceProvisioningState" - }, - "type": { - "description": "Kind of the deployment.", - "minLength": 1, - "pattern": "[a-zA-Z0-9._]", - "type": "string" } - }, - "discriminator": "type" + } }, "EndpointDeploymentResourcePropertiesBasicResource": { "required": [ @@ -4553,6 +4529,9 @@ "properties": { "properties": { "$ref": "#/definitions/EndpointDeploymentResourceProperties" + }, + "sku": { + "$ref": "#/definitions/CognitiveServicesSku" } } }, @@ -4975,15 +4954,6 @@ "modelAsString": true } }, - "ManagedOnlineEndpointDeploymentResourceProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EndpointDeploymentResourceProperties" - } - ], - "x-ms-discriminator-value": "managedOnlineEndpoint" - }, "ManagedOnlineEndpointResourceProperties": { "type": "object", "allOf": [ @@ -5164,18 +5134,6 @@ }, "x-ms-discriminator-value": "OAuth2" }, - "OpenAIEndpointDeploymentResourceProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CognitiveServiceEndpointDeploymentResourceProperties" - }, - { - "$ref": "#/definitions/EndpointDeploymentResourceProperties" - } - ], - "x-ms-discriminator-value": "Azure.OpenAI" - }, "OpenAIEndpointResourceProperties": { "type": "object", "allOf": [ @@ -5992,18 +5950,6 @@ } } }, - "SpeechEndpointDeploymentResourceProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CognitiveServiceEndpointDeploymentResourceProperties" - }, - { - "$ref": "#/definitions/EndpointDeploymentResourceProperties" - } - ], - "x-ms-discriminator-value": "Azure.Speech" - }, "SpeechEndpointResourceProperties": { "type": "object", "allOf": [ @@ -6279,6 +6225,15 @@ } } }, + "WorkspaceConnectionAccountKey": { + "type": "object", + "properties": { + "key": { + "type": "string", + "x-ms-secret": true + } + } + }, "WorkspaceConnectionUpdateParameter": { "description": "The properties that the machine learning workspace connection will be updated with.", "type": "object", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/machineLearningServices.json index de9a74144b7f..a4933d897ebf 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/machineLearningServices.json @@ -6692,6 +6692,16 @@ }, "additionalProperties": false }, + "WorkspaceConnectionAccountKey": { + "type": "object", + "properties": { + "key": { + "type": "string", + "x-ms-secret": true + } + }, + "additionalProperties": false + }, "SASAuthTypeWorkspaceConnectionProperties": { "type": "object", "allOf": [ @@ -7103,7 +7113,7 @@ ], "properties": { "credentials": { - "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" + "$ref": "#/definitions/WorkspaceConnectionAccountKey" } }, "x-ms-discriminator-value": "AccountKey" From e5597e43d46493da4a7aa8d1cf8adcd4d164018e Mon Sep 17 00:00:00 2001 From: FumingZhang <81607949+FumingZhang@users.noreply.github.com> Date: Tue, 11 Jun 2024 14:47:14 +0800 Subject: [PATCH 146/343] Review request for Microsoft.ContainerService/aks to add version preview/2024-04-02-preview (#29061) * Adds base for updating Microsoft.ContainerService/aks from version preview/2024-03-02-preview to version 2024-04-02-preview * Updates readme * Updates API version in new specs and examples * add undrainableNodeBehavior property (#28919) * add undrainableNodeBehavior property * fix some spell errors * fix some grammer issues * MixSku Pool Autoscale mode API Change (#29052) * MixSku Pool Autoscale mode API Change * Prettier --------- Co-authored-by: wenxuanW * Add swagger defination for IMDS restriction feature (#29044) * Add swagger defination for IMDS restriction feature * update swagger * fix spell * add none to outbound type in aks managedCluster (#29095) * add componentsByReleases (#29002) * update(retina): update adv networking to note additional costs (#29245) * apply code review (#29272) * apply code review * remove wireserver description because it's not link local address * apply code review * remove(monitoring): remove network monitoring profile from api 04-02 preview (#29279) --------- Co-authored-by: zjpjack-github <136433002+zjpjack-github@users.noreply.github.com> Co-authored-by: Thalia Wang <58485997+wenxuan0923@users.noreply.github.com> Co-authored-by: wenxuanW Co-authored-by: Tongyao Si Co-authored-by: Fan Shang Xiang Co-authored-by: Shaoru Hu <49520642+HuShaoRu@users.noreply.github.com> Co-authored-by: Steven Nguyen <30740718+snguyen64@users.noreply.github.com> --- cSpell.json | 5 +- .../examples/AgentPoolsAbortOperation.json | 18 + .../examples/AgentPoolsAssociate_CRG.json | 54 + .../AgentPoolsCreate_CustomNodeConfig.json | 124 + .../AgentPoolsCreate_DedicatedHostGroup.json | 54 + .../AgentPoolsCreate_EnableCustomCATrust.json | 54 + ...entPoolsCreate_EnableEncryptionAtHost.json | 54 + .../examples/AgentPoolsCreate_EnableFIPS.json | 54 + .../AgentPoolsCreate_EnableUltraSSD.json | 54 + .../examples/AgentPoolsCreate_Ephemeral.json | 58 + .../examples/AgentPoolsCreate_GPUMIG.json | 127 + .../AgentPoolsCreate_MessageOfTheDay.json | 60 + .../examples/AgentPoolsCreate_OSSKU.json | 127 + .../examples/AgentPoolsCreate_PPG.json | 54 + .../examples/AgentPoolsCreate_Snapshot.json | 63 + .../examples/AgentPoolsCreate_Spot.json | 86 + .../AgentPoolsCreate_TypeVirtualMachines.json | 136 + ...sCreate_TypeVirtualMachines_Autoscale.json | 139 + .../examples/AgentPoolsCreate_Update.json | 87 + .../examples/AgentPoolsCreate_WasmWasi.json | 60 + ...PoolsCreate_WindowsDisableOutboundNAT.json | 63 + .../AgentPoolsCreate_WindowsOSSKU.json | 54 + .../examples/AgentPoolsDelete.json | 17 + .../examples/AgentPoolsDeleteMachines.json | 22 + ...PoolsDelete_IgnorePodDisruptionBudget.json | 18 + .../examples/AgentPoolsGet.json | 31 + ...entPoolsGetAgentPoolAvailableVersions.json | 32 + .../examples/AgentPoolsGetUpgradeProfile.json | 28 + .../examples/AgentPoolsList.json | 31 + .../AgentPoolsUpgradeNodeImageVersion.json | 34 + .../examples/AgentPools_Start.json | 52 + .../examples/AgentPools_Stop.json | 52 + .../examples/AgentPools_Update.json | 75 + .../ContainerServiceGetOSOptions.json | 28 + .../examples/GetGuardrailsVersions.json | 21 + .../examples/GetSafeguardsVersions.json | 21 + .../examples/KubernetesVersions_List.json | 97 + .../examples/ListGuardrailsVersions.json | 24 + .../examples/ListSafeguardsVersions.json | 24 + .../LoadBalancers_Create_Or_Update.json | 42 + .../examples/LoadBalancers_Delete.json | 17 + .../examples/LoadBalancers_Get.json | 23 + .../examples/LoadBalancers_List.json | 26 + .../examples/LoadBalancers_Rebalance.json | 20 + .../examples/MachineGet.json | 34 + .../examples/MachineList.json | 38 + ...aintenanceConfigurationsCreate_Update.json | 94 + ...ationsCreate_Update_MaintenanceWindow.json | 116 + .../MaintenanceConfigurationsDelete.json | 13 + ...onfigurationsDelete_MaintenanceWindow.json | 13 + .../MaintenanceConfigurationsGet.json | 42 + ...ceConfigurationsGet_MaintenanceWindow.json | 48 + .../MaintenanceConfigurationsList.json | 37 + ...eConfigurationsList_MaintenanceWindow.json | 61 + .../ManagedClusterSnapshotsCreate.json | 96 + .../ManagedClusterSnapshotsDelete.json | 12 + .../examples/ManagedClusterSnapshotsGet.json | 47 + .../examples/ManagedClusterSnapshotsList.json | 49 + ...edClusterSnapshotsListByResourceGroup.json | 50 + .../ManagedClusterSnapshotsUpdateTags.json | 53 + .../ManagedClustersAbortOperation.json | 17 + .../ManagedClustersAssociate_CRG.json | 254 + ...rsCreate_AzureKeyvaultSecretsProvider.json | 259 + ...anagedClustersCreate_AzureServiceMesh.json | 346 + ...agedClustersCreate_DedicatedHostGroup.json | 251 + ...nagedClustersCreate_DisableRunCommand.json | 265 + ...gedClustersCreate_DualStackNetworking.json | 321 + ...stersCreate_EnableAIToolchainOperator.json | 236 + ...gedClustersCreate_EnableCustomCATrust.json | 269 + ...ClustersCreate_EnableEncryptionAtHost.json | 254 + .../ManagedClustersCreate_EnableUltraSSD.json | 254 + .../ManagedClustersCreate_EnabledFIPS.json | 254 + .../ManagedClustersCreate_GPUMIG.json | 281 + .../ManagedClustersCreate_HTTPProxy.json | 278 + ...rsCreate_IngressProfile_WebAppRouting.json | 249 + .../ManagedClustersCreate_MCSnapshot.json | 222 + ...nagedClustersCreate_ManagedNATGateway.json | 231 + ...edClustersCreate_NodeAutoProvisioning.json | 229 + ...agedClustersCreate_NodePublicIPPrefix.json | 254 + .../examples/ManagedClustersCreate_OSSKU.json | 281 + .../examples/ManagedClustersCreate_PPG.json | 254 + .../ManagedClustersCreate_PodIdentity.json | 263 + .../ManagedClustersCreate_Premium.json | 270 + ...ersCreate_PrivateClusterFQDNSubdomain.json | 264 + ...ustersCreate_PrivateClusterPublicFQDN.json | 268 + ...ManagedClustersCreate_SecurityProfile.json | 251 + .../ManagedClustersCreate_Snapshot.json | 263 + .../ManagedClustersCreate_Update.json | 315 + ...nagedClustersCreate_UpdateWindowsGmsa.json | 299 + .../ManagedClustersCreate_UpdateWithAHUB.json | 293 + ...stersCreate_UpdateWithEnableAzureRBAC.json | 282 + ...te_UpdateWithEnableNamespaceResources.json | 269 + ...ClustersCreate_UserAssignedNATGateway.json | 198 + ...ManagedClustersCreate_VirtualMachines.json | 229 + .../examples/ManagedClustersDelete.json | 16 + .../examples/ManagedClustersGet.json | 114 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 49 + ...anagedClustersGet_MeshRevisionProfile.json | 53 + ...ManagedClustersGet_MeshUpgradeProfile.json | 35 + .../examples/ManagedClustersList.json | 67 + .../ManagedClustersListByResourceGroup.json | 66 + ...edClustersListClusterCredentialResult.json | 20 + ...agedClustersList_MeshRevisionProfiles.json | 56 + ...nagedClustersList_MeshUpgradeProfiles.json | 38 + .../ManagedClustersResetAADProfile.json | 22 + ...dClustersResetServicePrincipalProfile.json | 20 + ...agedClustersRotateClusterCertificates.json | 16 + ...ustersRotateServiceAccountSigningKeys.json | 16 + .../examples/ManagedClustersStart.json | 16 + .../examples/ManagedClustersStop.json | 16 + .../examples/ManagedClustersUpdateTags.json | 68 + .../examples/OperationStatusResultGet.json | 20 + .../OperationStatusResultGetByAgentPool.json | 21 + .../examples/OperationStatusResultList.json | 34 + .../examples/Operation_List.json | 3583 ++++++ ...boundNetworkDependenciesEndpointsList.json | 242 + .../PrivateEndpointConnectionsDelete.json | 13 + .../PrivateEndpointConnectionsGet.json | 27 + .../PrivateEndpointConnectionsList.json | 30 + .../PrivateEndpointConnectionsUpdate.json | 50 + .../examples/PrivateLinkResourcesList.json | 25 + .../examples/ResolvePrivateLinkServiceId.json | 18 + .../examples/RunCommandRequest.json | 33 + .../examples/RunCommandResultFailed.json | 25 + .../examples/RunCommandResultSucceed.json | 28 + .../examples/SnapshotsCreate.json | 80 + .../examples/SnapshotsDelete.json | 12 + .../examples/SnapshotsGet.json | 39 + .../examples/SnapshotsList.json | 41 + .../SnapshotsListByResourceGroup.json | 42 + .../examples/SnapshotsUpdateTags.json | 45 + ...stedAccessRoleBindings_CreateOrUpdate.json | 48 + .../TrustedAccessRoleBindings_Delete.json | 17 + .../TrustedAccessRoleBindings_Get.json | 25 + .../TrustedAccessRoleBindings_List.json | 28 + .../examples/TrustedAccessRoles_List.json | 34 + .../2024-04-02-preview/managedClusters.json | 10224 ++++++++++++++++ .../aks/readme.java.md | 14 + .../Microsoft.ContainerService/aks/readme.md | 10 +- .../aks/readme.python.md | 13 +- 141 files changed, 27374 insertions(+), 3 deletions(-) create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsAssociate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Ephemeral.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Spot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WasmWasi.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDeleteMachines.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Start.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Stop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ContainerServiceGetOSOptions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/GetGuardrailsVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/GetSafeguardsVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/KubernetesVersions_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ListGuardrailsVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ListSafeguardsVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Create_Or_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Delete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Get.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Rebalance.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MachineGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MachineList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsCreate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersAssociate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_HTTPProxy.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_MCSnapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PodIdentity.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Premium.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_SecurityProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_VirtualMachines.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersListClusterCredentialResult.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersRotateClusterCertificates.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersStart.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersStop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultGetByAgentPool.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/Operation_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateLinkResourcesList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ResolvePrivateLinkServiceId.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandRequest.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandResultFailed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandResultSucceed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsCreate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_Delete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_Get.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoles_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json diff --git a/cSpell.json b/cSpell.json index e72217ed3b24..bf6503e69ecf 100644 --- a/cSpell.json +++ b/cSpell.json @@ -190,7 +190,10 @@ "words": [ "vtpm", "trustedlaunch", - "aksadvancednetworking" + "aksadvancednetworking", + "PDBs", + "undrainable", + "Undrainable" ] }, { diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..e90a963d6bed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsAssociate_CRG.json new file mode 100644 index 000000000000..7fb699beb532 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsAssociate_CRG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..fb6891b4c9be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..27887e110a7d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json new file mode 100644 index 000000000000..57eefe6ffe3a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableCustomCATrust": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableCustomCATrust": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableCustomCATrust": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..2b16ea5cd589 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..1fa610703e9e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..4147741eb1c3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..a18c9ccb8a9b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..be7ce9f3afc5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json new file mode 100644 index 000000000000..9993c2ecd916 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..d59964bad0ba --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..fa536e24f657 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..53e3e5d06b43 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..78f38e12259e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json new file mode 100644 index 000000000000..014425cfc62f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "1.9.6", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "count": 5 + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "count": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "count": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json new file mode 100644 index 000000000000..b66a78a550b6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "1.29.0", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "autoscale": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "minCount": 1, + "maxCount": 5 + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.29.0", + "currentOrchestratorVersion": "1.29.0", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "autoscale": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "minCount": 1, + "maxCount": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 1 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.29.0", + "currentOrchestratorVersion": "1.29.0", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "autoscale": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "minCount": 1, + "maxCount": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 1 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..a8e558bbef2c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..4562c20e0663 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json new file mode 100644 index 000000000000..a9e86399713a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..7b22bf9f2d12 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..f9710ff75722 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDeleteMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDeleteMachines.json new file mode 100644 index 000000000000..90ca63e3033b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDeleteMachines.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machines": { + "machineNames": [ + "aks-nodepool1-42263519-vmss00000a", + "aks-nodepool1-42263519-vmss00000b" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json new file mode 100644 index 000000000000..309f2dc1bf05 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "ignorePodDisruptionBudget": true + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..0c6f34882cd7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "eTag": "ebwiyfneowv", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..9c3bcff991c5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..8ad559cabe83 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsList.json new file mode 100644 index 000000000000..e403b15d3d77 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "eTag": "ewnfuib" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..85ca2317c75a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Start.json new file mode 100644 index 000000000000..019ec4f37ce3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..387d1ec18f75 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Update.json new file mode 100644 index 000000000000..edfdcd8dd2c9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ContainerServiceGetOSOptions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ContainerServiceGetOSOptions.json new file mode 100644 index 000000000000..e51cf98e458b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ContainerServiceGetOSOptions.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/osOptions/default", + "name": "default", + "type": "Microsoft.ContainerService/locations/osOptions", + "properties": { + "osOptionPropertyList": [ + { + "os-type": "Linux", + "enable-fips-image": false + }, + { + "os-type": "Windows", + "enable-fips-image": false + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/GetGuardrailsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/GetGuardrailsVersions.json new file mode 100644 index 000000000000..a08ab6803ff0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/GetGuardrailsVersions.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "version": "v1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/guardrailsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/GetSafeguardsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/GetSafeguardsVersions.json new file mode 100644 index 000000000000..e3e2b4c09cc0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/GetSafeguardsVersions.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "version": "v1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/safeguardsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..a19c6466bfbd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/KubernetesVersions_List.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "isDefault": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "isPreview": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ListGuardrailsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ListGuardrailsVersions.json new file mode 100644 index 000000000000..572ece810c08 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ListGuardrailsVersions.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/guardrailsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ListSafeguardsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ListSafeguardsVersions.json new file mode 100644 index 000000000000..70bd5671a8c1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ListSafeguardsVersions.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/safeguardsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Create_Or_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Create_Or_Update.json new file mode 100644 index 000000000000..780dbfd71b8b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Create_Or_Update.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "loadBalancerName": "kubernetes", + "parameters": { + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentpool1", + "allowServicePlacement": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Delete.json new file mode 100644 index 000000000000..84a69939cf3c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "loadBalancerName": "kubernetes" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-04-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Get.json new file mode 100644 index 000000000000..9d7f4ae84889 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "loadBalancerName": "kubernetes" + }, + "responses": { + "200": { + "body": { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_List.json new file mode 100644 index 000000000000..3250241e7735 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Rebalance.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Rebalance.json new file mode 100644 index 000000000000..ef56cbb27c95 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/LoadBalancers_Rebalance.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "loadBalancerNames": [ + "kubernetes" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-04-02-preview" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MachineGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MachineGet.json new file mode 100644 index 000000000000..a9a40087b307 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MachineGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machineName": "aks-nodepool1-42263519-vmss00000t" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MachineList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MachineList.json new file mode 100644 index 000000000000..6283816a51e2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MachineList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + ], + "nextLink": "http://xxxx.azure.com?encodedToken=c2tpcFRva2VuPTE" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..4b3b30331d76 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..f53be7a44cc0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "aksManagedAutoUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "aksManagedAutoUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..c6c46af832f1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..a70acf221c45 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..40aa1ec94839 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..e3561e2f6edf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedNodeOSUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..6c4c81a6e63b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..02a7e5ecaaed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsCreate.json new file mode 100644 index 000000000000..1372893fa814 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsCreate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsDelete.json new file mode 100644 index 000000000000..a4bd15832e82 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsGet.json new file mode 100644 index 000000000000..842fcc97d797 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsList.json new file mode 100644 index 000000000000..5e34ef196740 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..8a670a1ff69d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json new file mode 100644 index 000000000000..856d64ca70bc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..ab2e455791c1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersAssociate_CRG.json new file mode 100644 index 000000000000..019942c3e08e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersAssociate_CRG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..0367f1a4d1b9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json new file mode 100644 index 000000000000..e6a82eaf793b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json @@ -0,0 +1,346 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + } + } + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..1c7bba73e0dc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..48848f7978cb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..a35a8456d8f6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,321 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json new file mode 100644 index 000000000000..e7f4e578ed2a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json new file mode 100644 index 000000000000..abd560006bce --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json @@ -0,0 +1,269 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableCustomCATrust": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableCustomCATrust": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableCustomCATrust": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..5e5532e35e12 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..5ffa3a6c5779 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..e4d3dd00a21d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..ad045345bb09 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..07ffe559bea7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json new file mode 100644 index 000000000000..12038eed0736 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_MCSnapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_MCSnapshot.json new file mode 100644 index 000000000000..65abf93a3e4a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_MCSnapshot.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..6a1848d35d2b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json new file mode 100644 index 000000000000..6799bde4958c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..04c12807bb27 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..beb0e9626f71 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..23509c3f911b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..0e8409ccca18 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..edb56d09a508 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..34424a0b54c7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,264 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..4f74ed2262db --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,268 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..8f4cda5dd003 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..9a18674cee8f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..f96cf9dfe308 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,315 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..637215730ffb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,299 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..9aade68a95d1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..92fd821be1b9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json new file mode 100644 index 000000000000..67fb4a9b6b9a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json @@ -0,0 +1,269 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "enableNamespaceResources": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "enableNamespaceResources": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "enableNamespaceResources": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..303bb65d1c1c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_VirtualMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_VirtualMachines.json new file mode 100644 index 000000000000..7f35e95f88a1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersCreate_VirtualMachines.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachines", + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachines", + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachines", + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..4c70d33042ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..5c71215a2c34 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "eTag": "beywbwei", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "eTag": "nvewbvoi", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..3ec62d351f38 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..d654003181b8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json new file mode 100644 index 000000000000..394ed9cdd3f1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json new file mode 100644 index 000000000000..ff253749e77b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList.json new file mode 100644 index 000000000000..a0f8fc8e1a55 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "eTag": "nvweuib", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "eTag": "byuefvwi" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..8ccc01685983 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..55a6f629708a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json new file mode 100644 index 000000000000..e9963a850c52 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json new file mode 100644 index 000000000000..0d492f8b524f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..731f190ce69b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..43aa4e3df558 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..4c70d33042ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..4c70d33042ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..4c70d33042ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..4c70d33042ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..90e7d112a6dc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultGet.json new file mode 100644 index 000000000000..b5cfd8c65559 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "operationId": "00000000-0000-0000-0000-000000000001" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/00000000-0000-0000-0000-000000000001", + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultGetByAgentPool.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultGetByAgentPool.json new file mode 100644 index 000000000000..3fbd1de1c9e2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultGetByAgentPool.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "operationId": "00000000-0000-0000-0000-000000000001" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/operations/00000000-0000-0000-0000-000000000001", + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultList.json new file mode 100644 index 000000000000..70ee2d8e48e0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OperationStatusResultList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/d11edb09-6e27-429f-9fe5-17baf773bc4a", + "name": "d11edb09-6e27-429f-9fe5-17baf773bc4a", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/d11edb09-6e27-429f-9fe5-17baf773bc4b", + "name": "d11edb09-6e27-429f-9fe5-17baf773bc4b", + "status": "Failed", + "startTime": "2023-07-26T12:14:26.3179428Z", + "endTime": "2023-07-26T12:14:50.3179428Z", + "error": { + "code": "ReconcileAgentPoolIdentityError", + "message": "Reconcile agent pool nodepool1 identity failed" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/Operation_List.json new file mode 100644 index 000000000000..f905ed721dbc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/Operation_List.json @@ -0,0 +1,3583 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets OS options", + "operation": "Get OS Options", + "provider": "Microsoft Container Service", + "resource": "OSOptions" + }, + "name": "Microsoft.ContainerService/locations/osOptions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..6a5e30a3b3d3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..eb528467e996 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..7b97441e5e29 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..ae9c981d2dbf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..c45af313971a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..1375b78a20f6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..f16026fc49df --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandRequest.json new file mode 100644 index 000000000000..424d6e64abd7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-04-02-preview" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..c31aecd1c6e1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-04-02-preview" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..7fe9cb6f6fae --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-04-02-preview" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..d77be77026bc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..a4bd15832e82 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsGet.json new file mode 100644 index 000000000000..be16101bd3ce --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsList.json new file mode 100644 index 000000000000..ebaca77c63eb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..14c7446e4ce9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..ba1147adfa78 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json new file mode 100644 index 000000000000..7ba278bde849 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1", + "trustedAccessRoleBinding": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_Delete.json new file mode 100644 index 000000000000..fbbd340c40c5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_Get.json new file mode 100644 index 000000000000..38f5f16dfea4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_List.json new file mode 100644 index 000000000000..ba71b2d3e324 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoleBindings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoles_List.json new file mode 100644 index 000000000000..ce8d035e14ab --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/examples/TrustedAccessRoles_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sourceResourceType": "Microsoft.MachineLearningServices/workspaces", + "name": "reader", + "rules": [ + { + "verbs": [ + "get" + ], + "apiGroups": [ + "" + ], + "resources": [ + "pods" + ], + "resourceNames": [], + "nonResourceURLs": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json new file mode 100644 index 000000000000..6543f78e4a2c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json @@ -0,0 +1,10224 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2024-04-02-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetOSOptions", + "summary": "Gets supported OS options in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ResourceTypeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSOptionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Container Service OS Options": { + "$ref": "./examples/ContainerServiceGetOSOptions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "The request should only proceed if no entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create/Update Managed Cluster with EnableNamespaceResources": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure Key Vault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create/Update Managed Cluster with Azure Service Mesh": { + "$ref": "./examples/ManagedClustersCreate_AzureServiceMesh.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with Web App Routing Ingress Profile configured": { + "$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create Managed Cluster using a managed cluster snapshot": { + "$ref": "./examples/ManagedClustersCreate_MCSnapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Associate Managed Cluster with Capacity Reservation Group": { + "$ref": "./examples/ManagedClustersAssociate_CRG.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + }, + "Create Managed Cluster with CustomCATrustCertificates populated and CustomCATrust enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableCustomCATrust.json" + }, + "Create Managed Cluster with VirtualMachines pool type": { + "$ref": "./examples/ManagedClustersCreate_VirtualMachines.json" + }, + "Create Managed Cluster with AI Toolchain Operator enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableAIToolchainOperator.json" + }, + "Create Managed Cluster with Node Auto Provisioning": { + "$ref": "./examples/ManagedClustersCreate_NodeAutoProvisioning.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + }, + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + }, + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + }, + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + }, + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "The request should only proceed if no entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Windows Agent Pool with disabling OutboundNAT": { + "$ref": "./examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Create Agent Pool with Message of the Day": { + "$ref": "./examples/AgentPoolsCreate_MessageOfTheDay.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Associate Agent Pool with Capacity Reservation Group": { + "$ref": "./examples/AgentPoolsAssociate_CRG.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + }, + "Create Agent Pool with CustomCATrust enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableCustomCATrust.json" + }, + "Create Agent Pool with VirtualMachines pool type": { + "$ref": "./examples/AgentPoolsCreate_TypeVirtualMachines.json" + }, + "Create Agent Pool with VirtualMachines pool type with autoscaling enabled": { + "$ref": "./examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + }, + "Delete Agent Pool by ignoring PodDisruptionBudget": { + "$ref": "./examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_DeleteMachines", + "summary": "Deletes specific machines in an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "machines", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPoolDeleteMachinesParameter" + }, + "description": "A list of machines from the agent pool to be deleted." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Specific Machines in an Agent Pool": { + "$ref": "./examples/AgentPoolsDeleteMachines.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines": { + "get": { + "tags": [ + "Machines" + ], + "operationId": "Machines_List", + "summary": "Gets a list of machines in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Machines in an Agentpool by Managed Cluster": { + "$ref": "./examples/MachineList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName}": { + "get": { + "tags": [ + "Machines" + ], + "operationId": "Machines_Get", + "summary": "Get a specific machine in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a Machine in an Agent Pools by Managed Cluster": { + "$ref": "./examples/MachineGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "command running in progress", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_List", + "summary": "Gets a list of operations in the specified managedCluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List of OperationStatusResult": { + "$ref": "./examples/OperationStatusResultList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations/{operationId}": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_Get", + "summary": "Get the status of a specific operation in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatusResult": { + "$ref": "./examples/OperationStatusResultGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/operations/{operationId}": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_GetByAgentPool", + "summary": "Get the status of a specific operation in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatusResult": { + "$ref": "./examples/OperationStatusResultGetByAgentPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_List", + "summary": "Gets a list of managed cluster snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Cluster Snapshots": { + "$ref": "./examples/ManagedClusterSnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_ListByResourceGroup", + "summary": "Lists managed cluster snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Cluster Snapshots by Resource Group": { + "$ref": "./examples/ManagedClusterSnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots/{resourceName}": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Get", + "summary": "Gets a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_CreateOrUpdate", + "summary": "Creates or updates a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The managed cluster snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "201": { + "description": "The new managed cluster snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_UpdateTags", + "summary": "Updates tags on a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update managed cluster snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Managed Cluster Snapshot Tags": { + "$ref": "./examples/ManagedClusterSnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Delete", + "summary": "Deletes a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoles_List", + "summary": "List supported trusted access roles.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access roles": { + "$ref": "./examples/TrustedAccessRoles_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_List", + "summary": "List trusted access role bindings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBindingListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access role bindings": { + "$ref": "./examples/TrustedAccessRoleBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Get", + "summary": "Get a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_CreateOrUpdate", + "summary": "Create or update a trusted access role binding", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + }, + { + "name": "trustedAccessRoleBinding", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "A trusted access role binding" + } + ], + "responses": { + "200": { + "description": "The existing trusted access role binding was successfully updated.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "201": { + "description": "The new trusted access role binding was successfully created.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Delete", + "summary": "Delete a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions/{version}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetGuardrailsVersions", + "summary": "Gets supported Guardrails version in the specified subscription and location.", + "description": "Contains Guardrails version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/VersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuardrailsAvailableVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get guardrails available versions": { + "$ref": "./examples/GetGuardrailsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListGuardrailsVersions", + "summary": "Gets a list of supported Guardrails versions in the specified subscription and location.", + "description": "Contains list of Guardrails version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuardrailsAvailableVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Guardrails Versions": { + "$ref": "./examples/ListGuardrailsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions/{version}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetSafeguardsVersions", + "summary": "Gets supported Safeguards version in the specified subscription and location.", + "description": "Contains Safeguards version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/VersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SafeguardsAvailableVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Safeguards available versions": { + "$ref": "./examples/GetSafeguardsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListSafeguardsVersions", + "summary": "Gets a list of supported Safeguards versions in the specified subscription and location.", + "description": "Contains list of Safeguards version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SafeguardsAvailableVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Safeguards Versions": { + "$ref": "./examples/ListSafeguardsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshRevisionProfiles", + "summary": "Lists mesh revision profiles for all meshes in the specified location.", + "description": "Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List mesh revision profiles in a location": { + "$ref": "./examples/ManagedClustersList_MeshRevisionProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshRevisionProfile", + "summary": "Gets a mesh revision profile for a specified mesh in the specified location.", + "description": "Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a mesh revision profile for a mesh mode": { + "$ref": "./examples/ManagedClustersGet_MeshRevisionProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshUpgradeProfiles", + "summary": "Lists available upgrades for all service meshes in a specific cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists version compatibility and upgrade profile for all service meshes in a cluster": { + "$ref": "./examples/ManagedClustersList_MeshUpgradeProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshUpgradeProfile", + "summary": "Gets available upgrades for a service mesh in a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets version compatibility and upgrade profile for a service mesh in a cluster": { + "$ref": "./examples/ManagedClustersGet_MeshUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/loadBalancers": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_ListByManagedCluster", + "summary": "Gets a list of load balancers in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LoadBalancerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Load Balancers by Managed Cluster": { + "$ref": "./examples/LoadBalancers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rebalanceLoadBalancers": { + "post": { + "tags": [ + "LoadBalancers" + ], + "operationId": "ManagedClusters_RebalanceLoadBalancers", + "summary": "Rebalance nodes across specific load balancers.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RebalanceLoadBalancersRequestBody" + }, + "description": "The names of the load balancers to be rebalanced. If set to empty, all load balancers will be rebalanced." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/LoadBalancers_Rebalance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/loadBalancers/{loadBalancerName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Get", + "summary": "Gets the specified load balancer.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/LoadBalancerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Load Balancer": { + "$ref": "./examples/LoadBalancers_Get.json" + } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_CreateOrUpdate", + "summary": "Creates or updates a load balancer in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/LoadBalancerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "The load balancer to create or update." + } + ], + "responses": { + "200": { + "description": "The existing load balancer has been successfully updated", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "201": { + "description": "The new load balancer has been successfully created", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update a Load Balancer": { + "$ref": "./examples/LoadBalancers_Create_Or_Update.json" + } + } + }, + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Delete", + "summary": "Deletes a load balancer in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/LoadBalancerNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a Load Balancer": { + "$ref": "./examples/LoadBalancers_Delete.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "VirtualMachinesProfile": { + "type": "object", + "properties": { + "scale": { + "$ref": "#/definitions/ScaleProfile", + "description": "Specifications on how to scale a VirtualMachines agent pool." + } + }, + "description": "Specifications on VirtualMachines agent pool." + }, + "ScaleProfile": { + "type": "object", + "properties": { + "manual": { + "type": "array", + "items": { + "$ref": "#/definitions/ManualScaleProfile" + }, + "x-ms-identifiers": [], + "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size. Currently, at most one ManualScaleProfile is allowed." + }, + "autoscale": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoScaleProfile" + }, + "x-ms-identifiers": [], + "description": "Specifications on how to auto-scale the VirtualMachines agent pool within a predefined size range. Currently, at most one AutoScaleProfile is allowed." + } + }, + "description": "Specifications on how to scale a VirtualMachines agent pool." + }, + "ManualScaleProfile": { + "type": "object", + "properties": { + "sizes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of allowed vm sizes e.g. ['Standard_E4s_v3', 'Standard_E16s_v3', 'Standard_D16s_v5']. AKS will use the first available one when scaling. If a VM size is unavailable (e.g. due to quota or regional capacity reasons), AKS will use the next size." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of nodes." + } + }, + "description": "Specifications on number of machines." + }, + "AutoScaleProfile": { + "type": "object", + "properties": { + "sizes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of allowed vm sizes e.g. ['Standard_E4s_v3', 'Standard_E16s_v3', 'Standard_D16s_v5']. AKS will use the first available one when auto scaling. If a VM size is unavailable (e.g. due to quota or regional capacity reasons), AKS will use the next size." + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes of the specified sizes." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes of the specified sizes." + } + }, + "description": "Specifications on auto-scaling." + }, + "VirtualMachineNodesStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineNodes" + }, + "x-ms-identifiers": [], + "description": "The status of nodes in a VirtualMachines agent pool." + }, + "VirtualMachineNodes": { + "type": "object", + "properties": { + "size": { + "type": "string", + "description": "The VM size of the agents used to host this group of nodes." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of nodes." + } + }, + "description": "Current status on a group of nodes of the same vm size." + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "messageOfTheDay": { + "type": "string", + "title": "Message of the day for Linux nodes, base64-encoded.", + "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)." + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podIPAllocationMode": { + "$ref": "#/definitions/PodIPAllocationMode" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes running on the Agent Pool.", + "description": "If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "title": "Whether the Agent Pool is running or stopped.", + "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "enableCustomCATrust": { + "type": "boolean", + "title": "Whether to enable Custom CA Trust feature.", + "description": "When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "nodeInitializationTaints": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Taints added on the nodes during creation that will not be reconciled by AKS.", + "description": "These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with `kubectl taint nodes node1 key1=value1:NoSchedule-`" + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "capacityReservationGroupID": { + "$ref": "#/definitions/CapacityReservationGroupID", + "description": "AKS will associate the specified agent pool with the Capacity Reservation Group." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + }, + "windowsProfile": { + "$ref": "#/definitions/AgentPoolWindowsProfile", + "description": "The Windows agent pool's specific profile." + }, + "networkProfile": { + "$ref": "#/definitions/AgentPoolNetworkProfile", + "description": "Network-related settings of an agent pool." + }, + "securityProfile": { + "$ref": "#/definitions/AgentPoolSecurityProfile", + "description": "The security settings of an agent pool." + }, + "gpuProfile": { + "$ref": "#/definitions/AgentPoolGPUProfile", + "description": "The GPU settings of an agent pool." + }, + "artifactStreamingProfile": { + "$ref": "#/definitions/AgentPoolArtifactStreamingProfile", + "description": "Configuration for using artifact streaming on AKS." + }, + "virtualMachinesProfile": { + "$ref": "#/definitions/VirtualMachinesProfile" + }, + "virtualMachineNodesStatus": { + "$ref": "#/definitions/VirtualMachineNodesStatus" + }, + "gatewayProfile": { + "$ref": "#/definitions/AgentPoolGatewayProfile", + "description": "Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "AgentPoolNetworkProfile": { + "type": "object", + "properties": { + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + }, + "allowedHostPorts": { + "type": "array", + "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationSecurityGroups" + } + ] + } + }, + "description": "The IDs of the application security groups which agent pool will associate when created." + } + }, + "description": "Network settings of an agent pool." + }, + "NodePublicIPTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of tags associated with the node public IP address." + }, + "IPTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: RoutingPreference." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: Internet." + } + }, + "description": "Contains the IPTag associated with the object." + }, + "PortRange": { + "type": "object", + "description": "The port range.", + "properties": { + "portStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd." + }, + "portEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart." + }, + "protocol": { + "type": "string", + "description": "The network protocol of the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP", + "description": "TCP protocol." + }, + { + "value": "UDP", + "description": "UDP protocol." + } + ] + } + } + } + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet", + "VirtualMachines" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + }, + { + "value": "VirtualMachines", + "description": "Create an Agent Pool backed by a Single Instance VM orchestration mode." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User", + "Gateway" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + }, + { + "value": "Gateway", + "description": "Gateway agent pools are dedicated to providing static egress IPs to pods. For more details, see https://aka.ms/aks/static-egress-gateway." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "title": "The drain timeout for a node", + "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "nodeSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 30, + "minimum": 0, + "title": "The soak duration for a node", + "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes." + }, + "undrainableNodeBehavior": { + "type": "string", + "description": "Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.", + "enum": [ + "Schedule", + "Cordon" + ], + "x-ms-enum": { + "name": "UndrainableNodeBehavior", + "modelAsString": true, + "values": [ + { + "value": "Cordon", + "description": "AKS will cordon the blocked nodes and replace them with surge nodes during upgrade. The blocked nodes will be cordoned and replaced by surge nodes. The blocked nodes will have label 'kubernetes.azure.com/upgrade-status:Quarantined'. A surge node will be retained for each blocked node. A best-effort attempt will be made to delete all other surge nodes. If there are enough surge nodes to replace blocked nodes, then the upgrade operation and the managed cluster will be in failed state. Otherwise, the upgrade operation and the managed cluster will be in canceled state." + }, + { + "value": "Schedule", + "description": "AKS will mark the blocked nodes schedulable, but the blocked nodes are not upgraded. A best-effort attempt will be made to delete all surge nodes. The upgrade operation and the managed cluster will be in failed state if there are any blocked nodes." + } + ] + } + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "MachineListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [ + "id" + ], + "items": { + "$ref": "#/definitions/Machine" + }, + "description": "The list of Machines in cluster." + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The URL to get the next set of machine results.", + "readOnly": true + } + }, + "description": "The response from the List Machines operation." + }, + "Machine": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The properties of the machine" + } + }, + "description": "A machine. Contains details about the underlying virtual machine. A machine may be visible here but not in kubectl get nodes; if so it may be because the machine has not been registered with the Kubernetes API Server yet." + }, + "MachineProperties": { + "type": "object", + "readOnly": true, + "description": "The properties of the machine", + "properties": { + "network": { + "$ref": "#/definitions/MachineNetworkProperties" + }, + "resourceId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/virtualMachines" + } + ] + }, + "description": "Arm resource id of the machine. It can be used to GET underlying VM Instance" + } + } + }, + "MachineNetworkProperties": { + "type": "object", + "readOnly": true, + "description": "network properties of the machine", + "properties": { + "ipAddresses": { + "type": "array", + "x-ms-identifiers": [], + "readOnly": true, + "description": "IPv4, IPv6 addresses of the machine", + "items": { + "$ref": "#/definitions/MachineIpAddress" + } + } + } + }, + "MachineIpAddress": { + "type": "object", + "readOnly": true, + "description": "The machine IP address details.", + "properties": { + "ip": { + "type": "string", + "readOnly": true, + "description": "IPv4 or IPv6 address of the machine" + }, + "family": { + "$ref": "#/definitions/ipFamily", + "readOnly": true, + "description": "To determine if address belongs IPv4 or IPv6 family." + } + } + }, + "ipFamily": { + "type": "string", + "description": "To determine if address belongs IPv4 or IPv6 family.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true, + "values": [ + { + "value": "IPv4", + "description": "IPv4 family" + }, + { + "value": "IPv6", + "description": "IPv6 family" + } + ] + } + }, + "PodLinkLocalAccess": { + "type": "string", + "description": "Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. If not specified, the default is 'IMDS'.", + "enum": [ + "IMDS", + "None" + ], + "x-ms-enum": { + "name": "PodLinkLocalAccess", + "modelAsString": true, + "values": [ + { + "value": "IMDS", + "description": "Pods with hostNetwork=false can access Azure Instance Metadata Service (IMDS) without restriction." + }, + { + "value": "None", + "description": "Pods with hostNetwork=false cannot access Azure Instance Metadata Service (IMDS)." + } + ] + } + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Restriction:** Cannot end in \".\"

**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

**Minimum-length:** 1 character

**Max-length:** 20 characters" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + }, + "gmsaProfile": { + "$ref": "#/definitions/WindowsGmsaProfile", + "description": "The Windows gMSA Profile in the Managed Cluster." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "WindowsGmsaProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable Windows gMSA.", + "description": "Specifies whether to enable Windows gMSA in the managed cluster." + }, + "dnsServer": { + "type": "string", + "description": "Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + }, + "rootDomainName": { + "type": "string", + "description": "Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ManagedClusterNodeResourceGroupProfile": { + "type": "object", + "properties": { + "restrictionLevel": { + "type": "string", + "enum": [ + "Unrestricted", + "ReadOnly" + ], + "x-ms-enum": { + "name": "RestrictionLevel", + "modelAsString": true, + "values": [ + { + "value": "Unrestricted", + "description": "All RBAC permissions are allowed on the managed node resource group" + }, + { + "value": "ReadOnly", + "description": "Only */read RBAC permissions allowed on the managed node resource group" + } + ] + }, + "description": "The restriction level applied to the cluster's node resource group" + } + }, + "description": "Node resource group lockdown profile for a managed cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "$ref": "#/definitions/NetworkPlugin", + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "$ref": "#/definitions/NetworkPluginMode", + "description": "Network plugin mode used for building the Kubernetes network." + }, + "networkPolicy": { + "$ref": "#/definitions/NetworkPolicy", + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "$ref": "#/definitions/NetworkMode", + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "$ref": "#/definitions/NetworkDataplane", + "description": "Network dataplane used in the Kubernetes cluster." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway", + "none" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + }, + { + "value": "none", + "description": "The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/" + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "$ref": "#/definitions/LoadBalancerSku", + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "staticEgressGatewayProfile": { + "$ref": "#/definitions/ManagedClusterStaticEgressGatewayProfile", + "description": "The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign pod IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign service cluster IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "$ref": "#/definitions/ipFamily", + "description": "The IP version to use for cluster networking and IP assignment." + }, + "title": "The IP families used to specify IP versions available to the cluster.", + "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + }, + "podLinkLocalAccess": { + "$ref": "#/definitions/PodLinkLocalAccess", + "description": "Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. if not specified, the default is 'IMDS'." + }, + "kubeProxyConfig": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable on kube-proxy on the cluster (if no 'kubeProxyConfig' exists, kube-proxy is enabled in AKS by default without these customizations)." + }, + "mode": { + "type": "string", + "enum": [ + "IPTABLES", + "IPVS" + ], + "x-ms-enum": { + "name": "mode", + "modelAsString": true, + "values": [ + { + "value": "IPTABLES", + "description": "IPTables proxy mode" + }, + { + "value": "IPVS", + "description": "IPVS proxy mode. Must be using Kubernetes version >= 1.22." + } + ] + }, + "description": "Specify which proxy mode to use ('IPTABLES' or 'IPVS')" + }, + "ipvsConfig": { + "type": "object", + "properties": { + "scheduler": { + "type": "string", + "enum": [ + "RoundRobin", + "LeastConnection" + ], + "x-ms-enum": { + "name": "ipvsScheduler", + "modelAsString": true, + "values": [ + { + "value": "RoundRobin", + "description": "Round Robin" + }, + { + "value": "LeastConnection", + "description": "Least Connection" + } + ] + }, + "description": "IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html." + }, + "tcpTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value." + }, + "tcpFinTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value." + }, + "udpTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value." + } + }, + "description": "Holds configuration customizations for IPVS. May only be specified if 'mode' is set to 'IPVS'." + } + }, + "description": "Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be '1-23'." + }, + "advancedNetworking": { + "$ref": "#/definitions/AdvancedNetworking" + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "x-ms-identifiers": [], + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First." + }, + { + "value": "Second", + "description": "Second." + }, + { + "value": "Third", + "description": "Third." + }, + { + "value": "Fourth", + "description": "Fourth." + }, + { + "value": "Last", + "description": "Last." + } + ] + }, + "title": "The week index.", + "description": "Specifies on which instance of the allowed days specified in daysOfWeek the maintenance occurs." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "title": "A date range.", + "description": "For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + }, + "backendPoolType": { + "type": "string", + "x-ms-enum": { + "name": "BackendPoolType", + "modelAsString": true, + "values": [ + { + "value": "NodeIPConfiguration", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + }, + { + "value": "NodeIP", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + } + ] + }, + "enum": [ + "NodeIPConfiguration", + "NodeIP" + ], + "description": "The type of the managed inbound Load Balancer BackendPool.", + "default": "NodeIPConfiguration" + }, + "clusterServiceLoadBalancerHealthProbeMode": { + "type": "string", + "x-ms-enum": { + "name": "ClusterServiceLoadBalancerHealthProbeMode", + "modelAsString": true, + "values": [ + { + "value": "ServiceNodePort", + "description": "Each External Traffic Policy Cluster service will have its own health probe targeting service nodePort." + }, + { + "value": "Shared", + "description": "All External Traffic Policy Cluster services in a Standard Load Balancer will have a dedicated health probe targeting the backend nodes' kube-proxy health check port 10256." + } + ] + }, + "enum": [ + "ServiceNodePort", + "Shared" + ], + "description": "The health probing behavior for External Traffic Policy Cluster services.", + "default": "ServiceNodePort" + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ManagedClusterStaticEgressGatewayProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "title": "Enable Static Egress Gateway addon", + "description": "Indicates if Static Egress Gateway addon is enabled or not." + } + }, + "description": "The Static Egress Gateway addon configuration for the cluster." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + }, + "kind": { + "type": "string", + "description": "This is primarily used to expose different UI experiences in the portal for different kinds" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot." + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is requested to run.", + "description": "When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes the Managed Cluster is running." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "nodeResourceGroupProfile": { + "$ref": "#/definitions/ManagedClusterNodeResourceGroupProfile", + "description": "The node resource group configuration profile." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp." + }, + "enableNamespaceResources": { + "type": "boolean", + "title": "Enable namespace as Azure resource.", + "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "daemonset-eviction-for-empty-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from empty nodes", + "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "daemonset-eviction-for-occupied-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from non-empty nodes", + "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "ignore-daemonsets-utilization": { + "type": "boolean", + "title": "Should CA ignore DaemonSet pods when calculating resource utilization for scaling down", + "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions." + }, + "expander": { + "type": "string", + "title": "Type of node group expander to be used in scale up. Set to be deprecated, please use 'expanders' flag in the future.", + "description": "Available values are: 'least-waste', 'most-pods', 'priority', 'random'.", + "$ref": "#/definitions/expander" + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "ingressProfile": { + "$ref": "#/definitions/ManagedClusterIngressProfile", + "description": "Ingress profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Inbound/Outbound to the managedCluster is allowed." + }, + { + "value": "Disabled", + "description": "Inbound traffic to managedCluster is disabled, traffic from managedCluster is allowed." + }, + { + "value": "SecuredByPerimeter", + "description": "Inbound/Outbound traffic is managed by Microsoft.Network/NetworkSecurityPerimeters." + } + ] + }, + "title": "PublicNetworkAccess of the managedCluster", + "description": "Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + }, + "safeguardsProfile": { + "$ref": "#/definitions/SafeguardsProfile", + "description": "The Safeguards profile holds all the safeguards information for a given cluster" + }, + "serviceMeshProfile": { + "$ref": "#/definitions/ServiceMeshProfile" + }, + "resourceUID": { + "readOnly": true, + "type": "string", + "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)" + }, + "metricsProfile": { + "$ref": "#/definitions/ManagedClusterMetricsProfile", + "description": "Optional cluster metrics configuration." + }, + "aiToolchainOperatorProfile": { + "$ref": "#/definitions/ManagedClusterAIToolchainOperatorProfile", + "description": "AI toolchain operator settings that apply to the whole cluster." + }, + "nodeProvisioningProfile": { + "$ref": "#/definitions/ManagedClusterNodeProvisioningProfile", + "description": "Node provisioning settings that apply to the whole cluster." + }, + "bootstrapProfile": { + "$ref": "#/definitions/ManagedClusterBootstrapProfile", + "description": "Profile of the cluster bootstrap configuration." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + }, + "enableVnetIntegration": { + "type": "boolean", + "description": "Whether to enable apiserver vnet integration for the cluster or not." + }, + "subnetId": { + "type": "string", + "title": "The subnet to be used when apiserver vnet integration is enabled.", + "description": "It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "componentsByReleases": { + "$ref": "#/definitions/ComponentsByReleases" + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "SecurityPatch", + "NodeImage" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially, and will be patched at some later time by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "SecurityPatch", + "description": "AKS will update the nodes VHD with patches from the image maintainer labelled \"security only\" on a regular basis. Where possible, patches will also be applied without reimaging to existing nodes. Some patches, such as kernel patches, cannot be applied to existing nodes without disruption. For such patches, the VHD will be updated, and machines will be rolling reimaged to that VHD following maintenance windows and surge settings. This option incurs the extra cost of hosting the VHDs in your node resource group." + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + } + ] + }, + "title": "Manner in which the OS on your nodes is updated", + "description": "The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "componentsByReleases": { + "$ref": "#/definitions/ComponentsByReleases" + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "PodIPAllocationMode": { + "type": "string", + "enum": [ + "DynamicIndividual", + "StaticBlock" + ], + "x-ms-enum": { + "name": "PodIPAllocationMode", + "modelAsString": true, + "values": [ + { + "value": "DynamicIndividual", + "description": "Each pod gets a single IP address assigned. This is better for maximizing a small to medium subnet of size /16 or smaller. The Azure CNI cluster with dynamic IP allocation defaults to this mode if the customer does not explicitly specify a podIPAllocationMode" + }, + { + "value": "StaticBlock", + "description": "Each node is statically allocated CIDR block(s) of size /28 = 16 IPs per block to satisfy the maxPods per node. Number of CIDR blocks >= (maxPods / 16). The block, rather than a single IP, counts against the Azure Vnet Private IP limit of 65K. Therefore block mode is suitable for running larger workloads with more than the current limit of 65K pods in a cluster. This mode is better suited to scale with larger subnets of /15 or bigger" + } + ] + }, + "title": "Pod IP Allocation Mode", + "description": "The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner", + "Mariner", + "AzureLinux", + "Windows2019", + "Windows2022", + "WindowsAnnual" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "Mariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + }, + { + "value": "WindowsAnnual", + "description": "Use Windows Annual Channel version as the OS for node images. Unsupported for system node pools. Details about supported container images and kubernetes versions under different AKS Annual Channel versions could be seen in https://aka.ms/aks/windows-annual-channel-details." + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base", + "Automatic" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + }, + { + "value": "Automatic", + "description": "Automatic clusters are optimized to run most production workloads with configuration that follows AKS best practices and recommendations for cluster and workload setup, scalability, and security. For more details about Automatic clusters see aka.ms/aks/automatic." + } + ] + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Premium", + "Standard", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi", + "KataMshvVmIsolation" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + }, + { + "value": "KataMshvVmIsolation", + "description": "Nodes can use (Kata + Cloud Hypervisor + Hyper-V) to enable Nested VM-based pods (Preview). Due to the use Hyper-V, AKS node OS itself is a nested VM (the root OS) of Hyper-V. Thus it can only be used with VM series that support Nested Virtualization such as Dv3 series." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "AgentPoolWindowsProfile": { + "type": "object", + "description": "The Windows agent pool's specific profile.", + "properties": { + "disableOutboundNat": { + "type": "boolean", + "title": "Whether to disable OutboundNAT in windows nodes", + "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled." + } + } + }, + "AgentPoolSecurityProfile": { + "type": "object", + "properties": { + "sshAccess": { + "$ref": "#/definitions/AgentPoolSSHAccess", + "description": "SSH access method of an agent pool." + }, + "enableVTPM": { + "type": "boolean", + "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + }, + "enableSecureBoot": { + "type": "boolean", + "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + } + }, + "description": "The security settings of an agent pool." + }, + "AgentPoolGPUProfile": { + "type": "object", + "properties": { + "installGPUDriver": { + "type": "boolean", + "title": "Whether to auto install GPU drivers or not.", + "description": "The default value is true when the vmSize of the agent pool contains a GPU, false otherwise. GPU Driver Installation can only be set true when VM has an associated GPU resource. Setting this field to false prevents automatic GPU driver installation. In that case, in order for the GPU to be usable, the user must perform GPU driver installation themselves." + } + } + }, + "AgentPoolArtifactStreamingProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Artifact streaming speeds up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false." + } + } + }, + "AgentPoolSSHAccess": { + "type": "string", + "enum": [ + "LocalUser", + "Disabled" + ], + "x-ms-enum": { + "name": "AgentPoolSSHAccess", + "modelAsString": true, + "values": [ + { + "value": "LocalUser", + "description": "Can SSH onto the node as a local user using private key." + }, + { + "value": "Disabled", + "description": "SSH service will be turned off on the node." + } + ] + }, + "description": "SSH access method of an agent pool." + }, + "AgentPoolGatewayProfile": { + "description": "Profile of the managed cluster gateway agent pool.", + "type": "object", + "properties": { + "publicIPPrefixSize": { + "type": "integer", + "format": "int32", + "maximum": 31, + "minimum": 28, + "description": "The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.", + "default": 31 + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "effectiveNoProxy": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "OSOptionProperty": { + "type": "object", + "properties": { + "os-type": { + "type": "string", + "description": "The OS type." + }, + "enable-fips-image": { + "type": "boolean", + "description": "Whether the image is FIPS-enabled." + } + }, + "required": [ + "os-type", + "enable-fips-image" + ], + "description": "OS option property." + }, + "OSOptionPropertyList": { + "type": "object", + "properties": { + "osOptionPropertyList": { + "type": "array", + "items": { + "$ref": "#/definitions/OSOptionProperty" + }, + "x-ms-identifiers": [], + "description": "The list of OS options." + } + }, + "required": [ + "osOptionPropertyList" + ], + "description": "The list of OS option properties." + }, + "OSOptionProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the OS option resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the OS option resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the OS option resource." + }, + "properties": { + "$ref": "#/definitions/OSOptionPropertyList", + "description": "The list of OS options.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The OS option profile." + }, + "GuardrailsAvailableVersionsProperties": { + "type": "object", + "description": "Whether the version is default or not and support info.", + "properties": { + "isDefaultVersion": { + "type": "boolean", + "readOnly": true + }, + "support": { + "type": "string", + "enum": [ + "Preview", + "Stable" + ], + "x-ms-enum": { + "name": "GuardrailsSupport", + "modelAsString": true, + "values": [ + { + "value": "Preview", + "description": "The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases." + }, + { + "value": "Stable", + "description": "The version is stable and can be used on critical production clusters." + } + ] + }, + "description": "Whether the version is preview or stable.", + "readOnly": true + } + } + }, + "GuardrailsAvailableVersion": { + "type": "object", + "description": "Available Guardrails Version", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/GuardrailsAvailableVersionsProperties" + } + }, + "required": [ + "properties" + ] + }, + "GuardrailsAvailableVersionsList": { + "type": "object", + "description": "Hold values properties, which is array of GuardrailsVersions", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuardrailsAvailableVersion" + }, + "description": "Array of AKS supported Guardrails versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next Guardrails available version.", + "readOnly": true + } + } + }, + "SafeguardsAvailableVersionsProperties": { + "type": "object", + "description": "Whether the version is default or not and support info.", + "properties": { + "isDefaultVersion": { + "type": "boolean", + "readOnly": true + }, + "support": { + "type": "string", + "enum": [ + "Preview", + "Stable" + ], + "x-ms-enum": { + "name": "SafeguardsSupport", + "modelAsString": true, + "values": [ + { + "value": "Preview", + "description": "The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases." + }, + { + "value": "Stable", + "description": "The version is stable and can be used on critical production clusters." + } + ] + }, + "description": "Whether the version is preview or stable.", + "readOnly": true + } + } + }, + "SafeguardsAvailableVersion": { + "type": "object", + "description": "Available Safeguards Version", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SafeguardsAvailableVersionsProperties" + } + }, + "required": [ + "properties" + ] + }, + "SafeguardsAvailableVersionsList": { + "type": "object", + "description": "Hold values properties, which is array of SafeguardsVersions", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SafeguardsAvailableVersion" + }, + "description": "Array of AKS supported Safeguards versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next Safeguards available version.", + "readOnly": true + } + } + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + }, + "imageIntegrity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageIntegrity", + "description": "Image integrity is a feature that works with Azure Policy to verify image integrity by signature. This will not have any effect unless Azure Policy is applied to enforce image signatures. See https://aka.ms/aks/image-integrity for how to use this feature via policy." + }, + "nodeRestriction": { + "$ref": "#/definitions/ManagedClusterSecurityProfileNodeRestriction", + "description": "[Node Restriction](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#noderestriction) settings for the security profile." + }, + "customCATrustCertificates": { + "$ref": "#/definitions/ManagedClusterSecurityProfileCustomCATrustCertificates", + "description": "A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority)" + } + }, + "description": "Security profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "title": "Network access of the key vault", + "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "ManagedClusterIngressProfile": { + "type": "object", + "properties": { + "webAppRouting": { + "$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting", + "description": "Web App Routing settings for the ingress profile." + } + }, + "description": "Ingress profile for the container service cluster." + }, + "ManagedClusterIngressProfileWebAppRouting": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Web App Routing." + }, + "dnsZoneResourceIds": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/dnszones" + }, + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + } + }, + "maxItems": 5, + "description": "Resource IDs of the DNS zones to be associated with the Web App Routing add-on. Used only when Web App Routing is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group." + }, + "identity": { + "readOnly": true, + "type": "object", + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Managed identity of the Web Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions." + } + }, + "description": "Web App Routing settings for the ingress profile." + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterSecurityProfileImageIntegrity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable image integrity. The default value is false." + } + }, + "description": "Image integrity related settings for the security profile." + }, + "ManagedClusterSecurityProfileNodeRestriction": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Node Restriction" + } + }, + "description": "Node Restriction settings for the security profile." + }, + "ManagedClusterSecurityProfileCustomCATrustCertificates": { + "type": "array", + "items": { + "type": "string", + "format": "byte" + }, + "minItems": 0, + "maxItems": 10, + "title": "The list of base64 encoded certificate strings that will be added to the node trust store. At most 10 strings can be provided.", + "description": "Certificates will only be added to trust stores on node pools that have enableCustomCATrust field set to true. If updated, the new list of certificates will be installed in the trust store in place of the old certificates. The certificates are applied asynchronously and will be available a short time after the list is updated." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + }, + "version": { + "type": "string", + "description": "The version of AzureDisk CSI Driver. The default value is v1." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "ManagedClusterSnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The list of managed cluster snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Cluster Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "ManagedClusterSnapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a managed cluster snapshot.", + "$ref": "#/definitions/ManagedClusterSnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A managed cluster snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "ManagedClusterSnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "managedClusterPropertiesReadOnly": { + "$ref": "#/definitions/ManagedClusterPropertiesForSnapshot", + "description": "What the properties will be showed when getting managed cluster snapshot. Those properties are read-only." + } + }, + "description": "Properties for a managed cluster snapshot." + }, + "ManagedClusterPropertiesForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The current kubernetes version." + }, + "sku": { + "type": "object", + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The current managed cluster sku." + }, + "enableRbac": { + "type": "boolean", + "description": "Whether the cluster has enabled Kubernetes Role-Based Access Control or not." + }, + "networkProfile": { + "type": "object", + "$ref": "#/definitions/NetworkProfileForSnapshot", + "description": "The current network profile." + } + }, + "description": "managed cluster properties for snapshot, these properties are read only." + }, + "NetworkProfileForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "networkPlugin": { + "$ref": "#/definitions/NetworkPlugin", + "description": "networkPlugin for managed cluster snapshot." + }, + "networkPluginMode": { + "$ref": "#/definitions/NetworkPluginMode", + "description": "NetworkPluginMode for managed cluster snapshot." + }, + "networkPolicy": { + "$ref": "#/definitions/NetworkPolicy", + "description": "networkPolicy for managed cluster snapshot." + }, + "networkMode": { + "$ref": "#/definitions/NetworkMode", + "description": "networkMode for managed cluster snapshot." + }, + "loadBalancerSku": { + "$ref": "#/definitions/LoadBalancerSku", + "description": "loadBalancerSku for managed cluster snapshot." + } + }, + "description": "network profile for managed cluster snapshot, these properties are read only." + }, + "NetworkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "Do not use a network plugin. A custom CNI will need to be installed after cluster creation for networking functionality." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "NetworkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet reference plugins host-local and bridge." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "NetworkPolicy": { + "type": "string", + "enum": [ + "none", + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Network policies will not be enforced. This is the default value when NetworkPolicy is not specified." + }, + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "NetworkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "NetworkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "AdvancedNetworking": { + "type": "object", + "description": "Advanced Networking profile for enabling observability on a cluster. Note that enabling advanced networking features may incur additional costs. For more information see aka.ms/aksadvancednetworking.", + "properties": { + "observability": { + "$ref": "#/definitions/AdvancedNetworkingObservability" + } + } + }, + "AdvancedNetworkingObservability": { + "type": "object", + "description": "Observability profile to enable advanced network metrics and flow logs with historical contexts.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates the enablement of Advanced Networking observability functionalities on clusters." + } + } + }, + "LoadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool", + "ManagedCluster" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + }, + { + "value": "ManagedCluster", + "description": "The snapshot is a snapshot of a managed cluster." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "CapacityReservationGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/CapacityReservationGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}'. Customers use it to create an agentpool and to update an existing agentpool with a CapacityReservationGroupID. If customers explicitly specify this CapacityReservationGroupID as an empty string, AKS will disassociate the existing CRG from the nodepool. For more information see [Capacity Reservation](https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview)" + }, + "TrustedAccessRoleRule": { + "type": "object", + "description": "Rule for trusted access role", + "properties": { + "verbs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed verbs" + }, + "apiGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed apiGroups" + }, + "resources": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed resources" + }, + "resourceNames": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed names" + }, + "nonResourceURLs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed nonResourceURLs" + } + } + }, + "TrustedAccessRole": { + "type": "object", + "description": "Trusted access role definition.", + "properties": { + "sourceResourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type of Azure resource" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of role, name is unique under a source resource type" + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRoleRule" + }, + "x-ms-identifiers": [], + "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)." + } + } + }, + "TrustedAccessRoleListResult": { + "type": "object", + "description": "List of trusted access roles", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRole" + }, + "x-ms-identifiers": [ + "sourceResourceType", + "name" + ], + "description": "Role list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TrustedAccessRoleBindingProperties": { + "type": "object", + "description": "Properties for trusted access role binding", + "required": [ + "sourceResourceId", + "roles" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of trusted access role binding.", + "enum": [ + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "TrustedAccessRoleBindingProvisioningState", + "modelAsString": true + } + }, + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource ID of source resource that trusted access is configured for." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'." + } + } + }, + "TrustedAccessRoleBinding": { + "type": "object", + "description": "Defines binding between a resource and role", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedAccessRoleBindingProperties", + "x-ms-client-flatten": true + } + } + }, + "TrustedAccessRoleBindingListResult": { + "type": "object", + "description": "List of trusted access role bindings", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "Role binding list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA add-on in cluster. Default value is false.", + "default": false + }, + "addonAutoscaling": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AddonAutoscaling", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Feature to autoscale AKS-managed add-ons is enabled. The default VPA update mode is Initial mode." + }, + { + "value": "Disabled", + "description": "Feature to autoscale AKS-managed add-ons is disabled." + } + ] + }, + "description": "Whether VPA add-on is enabled and configured to scale AKS-managed add-ons.", + "default": "Disabled" + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Prometheus addon profile for the container service cluster", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + }, + "containerInsights": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileContainerInsights" + }, + "appMonitoring": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoring" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics for prometheus addon profile for the container service cluster", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotations keys that will be used in the resource's labels metric. " + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the prometheus service addon", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the Prometheus collector" + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "SafeguardsProfile": { + "type": "object", + "properties": { + "systemExcludedNamespaces": { + "readOnly": true, + "type": "array", + "description": "List of namespaces specified by AKS to be excluded from Safeguards", + "items": { + "type": "string" + } + }, + "version": { + "type": "string", + "description": "The version of constraints to use" + }, + "level": { + "type": "string", + "enum": [ + "Off", + "Warning", + "Enforcement" + ], + "x-ms-enum": { + "name": "level", + "modelAsString": true + }, + "description": "The Safeguards level to be used. By default, Safeguards is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces" + }, + "excludedNamespaces": { + "description": "List of namespaces excluded from Safeguards checks", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "level" + ], + "description": "The Safeguards profile." + }, + "ServiceMeshProfile": { + "type": "object", + "description": "Service mesh profile for a managed cluster.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of the service mesh.", + "enum": [ + "Istio", + "Disabled" + ], + "x-ms-enum": { + "name": "ServiceMeshMode", + "modelAsString": true, + "values": [ + { + "value": "Istio", + "description": "Istio deployed as an AKS addon." + }, + { + "value": "Disabled", + "description": "Mesh is disabled." + } + ] + } + }, + "istio": { + "$ref": "#/definitions/IstioServiceMesh" + } + }, + "required": [ + "mode" + ] + }, + "IstioServiceMesh": { + "type": "object", + "description": "Istio service mesh configuration.", + "properties": { + "components": { + "$ref": "#/definitions/IstioComponents" + }, + "certificateAuthority": { + "$ref": "#/definitions/IstioCertificateAuthority" + }, + "revisions": { + "type": "array", + "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade", + "items": { + "type": "string" + }, + "uniqueItems": true, + "maxItems": 2 + } + } + }, + "IstioComponents": { + "type": "object", + "description": "Istio components configuration.", + "properties": { + "ingressGateways": { + "type": "array", + "description": "Istio ingress gateways.", + "items": { + "$ref": "#/definitions/IstioIngressGateway" + }, + "x-ms-identifiers": [] + }, + "egressGateways": { + "type": "array", + "description": "Istio egress gateways.", + "items": { + "$ref": "#/definitions/IstioEgressGateway" + }, + "x-ms-identifiers": [] + } + } + }, + "IstioIngressGateway": { + "type": "object", + "description": "Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of an ingress gateway.", + "enum": [ + "External", + "Internal" + ], + "x-ms-enum": { + "name": "IstioIngressGatewayMode", + "modelAsString": true, + "values": [ + { + "value": "External", + "description": "The ingress gateway is assigned a public IP address and is publicly accessible." + }, + { + "value": "Internal", + "description": "The ingress gateway is assigned an internal IP address and cannot is accessed publicly." + } + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable the ingress gateway." + } + }, + "required": [ + "mode", + "enabled" + ] + }, + "IstioCertificateAuthority": { + "type": "object", + "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca", + "properties": { + "plugin": { + "$ref": "#/definitions/IstioPluginCertificateAuthority" + } + } + }, + "IstioPluginCertificateAuthority": { + "type": "object", + "description": "Plugin certificates information for Service Mesh.", + "properties": { + "keyVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Key Vault." + }, + "certObjectName": { + "type": "string", + "description": "Intermediate certificate object name in Azure Key Vault." + }, + "keyObjectName": { + "type": "string", + "description": "Intermediate certificate private key object name in Azure Key Vault." + }, + "rootCertObjectName": { + "type": "string", + "description": "Root certificate object name in Azure Key Vault." + }, + "certChainObjectName": { + "type": "string", + "description": "Certificate chain object name in Azure Key Vault." + } + } + }, + "IstioEgressGateway": { + "type": "object", + "description": "Istio egress gateway configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the egress gateway." + } + }, + "required": [ + "enabled" + ] + }, + "MeshRevisionProfileList": { + "type": "object", + "description": "Holds an array of MeshRevisionsProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevisionProfile" + }, + "description": "Array of service mesh add-on revision profiles for all supported mesh modes." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh revision profile.", + "readOnly": true + } + } + }, + "MeshRevisionProfile": { + "type": "object", + "description": "Mesh revision profile for a mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshRevisionProfileProperties" + } + } + }, + "MeshRevisionProfileProperties": { + "type": "object", + "description": "Mesh revision profile properties for a mesh", + "properties": { + "meshRevisions": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevision" + } + } + } + }, + "MeshUpgradeProfileList": { + "type": "object", + "description": "Holds an array of MeshUpgradeProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshUpgradeProfile" + }, + "description": "Array of supported service mesh add-on upgrade profiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh upgrade profile.", + "readOnly": true + } + } + }, + "MeshUpgradeProfile": { + "type": "object", + "description": "Upgrade profile for given mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshUpgradeProfileProperties" + } + } + }, + "MeshUpgradeProfileProperties": { + "type": "object", + "description": "Mesh upgrade profile properties for a major.minor release.", + "allOf": [ + { + "$ref": "#/definitions/MeshRevision" + } + ] + }, + "MeshRevision": { + "type": "object", + "description": "Holds information on upgrades and compatibility for given major.minor mesh release.", + "properties": { + "revision": { + "type": "string", + "description": "The revision of the mesh release." + }, + "upgrades": { + "type": "array", + "description": "List of revisions available for upgrade of a specific mesh revision", + "items": { + "type": "string", + "description": "An upgradeable mesh revision" + } + }, + "compatibleWith": { + "type": "array", + "description": "List of items this revision of service mesh is compatible with, and their associated versions.", + "items": { + "$ref": "#/definitions/CompatibleVersions" + }, + "x-ms-identifiers": [] + } + } + }, + "CompatibleVersions": { + "type": "object", + "description": "Version information about a product/service that is compatible with a service mesh revision.", + "properties": { + "name": { + "type": "string", + "description": "The product/service name." + }, + "versions": { + "type": "array", + "description": "Product/service versions compatible with a service mesh add-on revision.", + "items": { + "type": "string", + "description": "A compatible product/service version." + } + } + } + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isDefault": { + "type": "boolean", + "description": "Whether this version is default." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + }, + "ManagedClusterAzureMonitorProfileContainerInsights": { + "type": "object", + "description": "Azure Monitor Container Insights Profile for Kubernetes Events, Inventory and Container stdout & stderr logs etc. See aka.ms/AzureMonitorContainerInsights for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Azure Monitor Container Insights Logs Addon is enabled or not." + }, + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Fully Qualified ARM Resource Id of Azure Log Analytics Workspace for storing Azure Monitor Container Insights Logs." + }, + "syslogPort": { + "type": "integer", + "format": "int64", + "description": "The syslog host port. If not specified, the default port is 28330." + }, + "disableCustomMetrics": { + "type": "boolean", + "description": "Indicates whether custom metrics collection has to be disabled or not. If not specified the default is false. No custom metrics will be emitted if this field is false but the container insights enabled field is false" + }, + "disablePrometheusMetricsScraping": { + "type": "boolean", + "description": "Indicates whether prometheus metrics scraping is disabled or not. If not specified the default is false. No prometheus metrics will be emitted if this field is false but the container insights enabled field is false" + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoring": { + "type": "object", + "description": "Application Monitoring Profile for Kubernetes Application Container. Collects application logs, metrics and traces through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "autoInstrumentation": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringAutoInstrumentation" + }, + "openTelemetryMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics" + }, + "openTelemetryLogs": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryLogs" + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringAutoInstrumentation": { + "type": "object", + "description": "Application Monitoring Auto Instrumentation for Kubernetes Application Container. Deploys web hook to auto-instrument Azure Monitor OpenTelemetry based SDKs to collect OpenTelemetry metrics, logs and traces of the application. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Auto Instrumentation is enabled or not." + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics": { + "type": "object", + "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Metrics. Collects OpenTelemetry metrics of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Open Telemetry Metrics is enabled or not." + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The Open Telemetry host port for Open Telemetry metrics. If not specified, the default port is 28333." + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryLogs": { + "type": "object", + "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Logs and Traces. Collects OpenTelemetry logs and traces of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Open Telemetry Logs and traces is enabled or not." + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The Open Telemetry host port for Open Telemetry logs and traces. If not specified, the default port is 28331." + } + } + }, + "ManagedClusterMetricsProfile": { + "type": "object", + "description": "The metrics profile for the ManagedCluster.", + "properties": { + "costAnalysis": { + "$ref": "#/definitions/ManagedClusterCostAnalysis", + "title": "The configuration for detailed per-Kubernetes resource cost analysis." + } + } + }, + "ManagedClusterCostAnalysis": { + "type": "object", + "description": "The cost analysis configuration for the cluster", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable cost analysis", + "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis." + } + } + }, + "ManagedClusterAIToolchainOperatorProfile": { + "type": "object", + "description": "When enabling the operator, a set of AKS managed CRDs and controllers will be installed in the cluster. The operator automates the deployment of OSS models for inference and/or training purposes. It provides a set of preset models and enables distributed inference against them.", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable AI toolchain operator to the cluster", + "description": "Indicates if AI toolchain operator enabled or not." + } + } + }, + "ManagedClusterNodeProvisioningProfile": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "enum": [ + "Manual", + "Auto" + ], + "x-ms-enum": { + "name": "NodeProvisioningMode", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Nodes are provisioned manually by the user" + }, + { + "value": "Auto", + "description": "Nodes are provisioned automatically by AKS using Karpenter. Fixed size Node Pools can still be created, but autoscaling Node Pools cannot be. (See aka.ms/aks/nap for more details)." + } + ] + }, + "title": "The node provisioning mode. If not specified, the default is Manual.", + "description": "Once the mode it set to Auto, it cannot be changed back to Manual." + } + } + }, + "ManagedClusterBootstrapProfile": { + "description": "The bootstrap profile.", + "properties": { + "artifactSource": { + "type": "string", + "enum": [ + "Direct", + "Cache" + ], + "x-ms-enum": { + "name": "ArtifactSource", + "modelAsString": true, + "values": [ + { + "value": "Cache", + "description": "pull images from Azure Container Registry with cache" + }, + { + "value": "Direct", + "description": "pull images from Microsoft Artifact Registry" + } + ] + }, + "default": "Direct", + "title": "The artifact source.", + "description": "The source where the artifacts are downloaded from." + }, + "containerRegistryId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ContainerRegistry/registries" + } + ] + }, + "description": "The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy." + } + }, + "type": "object" + }, + "AgentPoolDeleteMachinesParameter": { + "type": "object", + "properties": { + "machineNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The agent pool machine names." + } + }, + "required": [ + "machineNames" + ], + "description": "Specifies a list of machine names from the agent pool to be deleted." + }, + "OperationStatusResultList": { + "description": "The operations list. It contains an URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations", + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + }, + "LoadBalancerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "The list of Load Balancers." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of load balancer results.", + "readOnly": true + } + }, + "description": "The response from the List Load Balancers operation." + }, + "LoadBalancer": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LoadBalancerProperties", + "description": "The properties of the load balancer.", + "x-ms-client-flatten": true + } + }, + "required": [ + "name" + ], + "description": "The configurations regarding multiple standard load balancers. If not supplied, single load balancer mode will be used. Multiple standard load balancers mode will be used if at lease one configuration is supplied. There has to be a configuration named `kubernetes`." + }, + "LoadBalancerProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the public load balancer. There will be an internal load balancer created if needed, and the name will be `-internal`. The internal lb shares the same configurations as the external one. The internal lbs are not needed to be included in LoadBalancer list. There must be a name of kubernetes in the list." + }, + "primaryAgentPoolName": { + "type": "string", + "description": "Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer." + }, + "allowServicePlacement": { + "type": "boolean", + "description": "Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it." + }, + "serviceLabelSelector": { + "$ref": "#/definitions/LabelSelector", + "description": "Only services that must match this selector can be placed on this load balancer." + }, + "serviceNamespaceSelector": { + "$ref": "#/definitions/LabelSelector", + "description": "Services created in namespaces that match the selector can be placed on this load balancer." + }, + "nodeSelector": { + "$ref": "#/definitions/LabelSelector", + "description": "Nodes that match this selector will be possible members of this load balancer." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + } + }, + "required": [ + "name", + "primaryAgentPoolName" + ] + }, + "LabelSelector": { + "type": "object", + "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.", + "properties": { + "matchLabels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is `key`, the operator is `In`, and the values array contains only `value`. The requirements are ANDed." + }, + "matchExpressions": { + "type": "array", + "items": { + "$ref": "#/definitions/LabelSelectorRequirement" + }, + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed." + } + } + }, + "LabelSelectorRequirement": { + "type": "object", + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "properties": { + "key": { + "type": "string", + "description": "key is the label key that the selector applies to." + }, + "operator": { + "type": "string", + "enum": [ + "In", + "NotIn", + "Exists", + "DoesNotExist" + ], + "x-ms-enum": { + "name": "operator", + "modelAsString": true, + "values": [ + { + "value": "In", + "description": "The value of the key should be in the given list." + }, + { + "value": "NotIn", + "description": "The value of the key should not be in the given list." + }, + { + "value": "Exists", + "description": "The value of the key should exist." + }, + { + "value": "DoesNotExist", + "description": "The value of the key should not exist." + } + ] + }, + "description": "operator represents a key's relationship to a set of values. Valid operators are In and NotIn" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "values is an array of string values, the values array must be non-empty." + } + } + }, + "RebalanceLoadBalancersRequestBody": { + "type": "object", + "properties": { + "loadBalancerNames": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [], + "description": "The load balancer names list." + } + }, + "description": "The names of the load balancers to rebalance. If set to empty, all load balancers will be rebalanced." + }, + "Component": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Component name." + }, + "version": { + "type": "string", + "description": "Component version." + }, + "hasBreakingChanges": { + "type": "boolean", + "description": "If upgraded component version contains breaking changes from the current version. To see a detailed description of what the breaking changes are, visit https://learn.microsoft.com/azure/aks/supported-kubernetes-versions?tabs=azure-cli#aks-components-breaking-changes-by-version." + } + } + }, + "ComponentsByReleases": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor)." + }, + "components": { + "type": "array", + "items": { + "$ref": "#/definitions/Component" + }, + "description": "components of current or upgraded Kubernetes version in the cluster." + } + }, + "description": "components of given Kubernetes version." + } + }, + "parameters": { + "LoadBalancerNameParameter": { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the load balancer.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "AgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + }, + "IgnorePodDisruptionBudgetParameter": { + "name": "ignore-pod-disruption-budget", + "in": "query", + "required": false, + "type": "boolean", + "description": "ignore-pod-disruption-budget=true to delete those pods on a node without considering Pod Disruption Budget", + "x-ms-parameter-location": "method" + }, + "TrustedAccessRoleBindingNameParameter": { + "name": "trustedAccessRoleBindingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of trusted access role binding.", + "pattern": "^([A-Za-z0-9-])+$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "MeshModeParameter": { + "name": "mode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The mode of the mesh.", + "x-ms-parameter-location": "method" + }, + "MachineNameParameter": { + "type": "string", + "description": "host name of the machine", + "name": "machineName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$", + "x-ms-parameter-location": "method" + }, + "VersionParameter": { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "description": "Safeguards version", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md index 13e3239c9e7f..796eab88cc62 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md @@ -98,6 +98,20 @@ batch: - tag: package-preview-2024-02 - tag: package-2024-02 - tag: package-preview-2024-03 + - tag: package-preview-2024-04 +``` + +### Tag: package-preview-2024-04 and java + +These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-preview-2024-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2024_04_02_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2024_04_02_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-preview-2024-03 and java diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index 1efea73b5be9..24cc58a27dfa 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -34,9 +34,17 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-preview-2024-03 +tag: package-preview-2024-04 ``` +### Tag: package-preview-2024-04 + +These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2024-04' +input-file: + - preview/2024-04-02-preview/managedClusters.json +``` ### Tag: package-preview-2024-03 diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md index 8950a68bd321..779869c9f997 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md @@ -16,9 +16,10 @@ no-namespace-folders: true Generate all API versions currently shipped for this package ```yaml $(python) -default-api-version: "2024-03-02-preview" +default-api-version: "2024-04-02-preview" multiapi: true batch: + - tag: package-preview-2024-04 - tag: package-preview-2024-03 - tag: package-2024-02 - tag: package-preview-2024-02 @@ -105,6 +106,16 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-preview-2024-04 and python + +These settings apply only when `--tag=package-preview-2024-04 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2024-04' && $(python) +namespace: azure.mgmt.containerservice.v2024_04_02_preview +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2024_04_02_preview +``` + ### Tag: package-preview-2024-03 and python These settings apply only when `--tag=package-preview-2024-03 --python` is specified on the command line. From f489d22ed80137239645a43d845ee4f226d745c1 Mon Sep 17 00:00:00 2001 From: srinivaskmsft <162558186+srinivaskmsft@users.noreply.github.com> Date: Mon, 10 Jun 2024 23:47:47 -0700 Subject: [PATCH 147/343] Added Stable Version changes for Saved Query API (#29094) * Added saved query to a stable version * Fixed the lint errors * Fixed the semantic and lint errors * Added example for 201 * Removued unused example * Prettier check updated * Added previous stable version api's as well * added changes for previous stable version for graph query * Added top level subscription id changes and added a new api which will fetch all the saved queries from subscription id * Added swagger prettier checks --- .../2019-04-01/examples/GraphQueryAdd.json | 49 ++ .../2019-04-01/examples/GraphQueryDelete.json | 14 + .../2019-04-01/examples/GraphQueryGet.json | 27 + .../2019-04-01/examples/GraphQueryList.json | 44 ++ .../2019-04-01/examples/GraphQueryUpdate.json | 35 ++ .../stable/2019-04-01/graphquery.json | 527 ++++++++++++++++++ .../2021-03-01/examples/GraphQueryAdd.json | 49 ++ .../2021-03-01/examples/GraphQueryDelete.json | 14 + .../2021-03-01/examples/GraphQueryGet.json | 27 + .../2021-03-01/examples/GraphQueryList.json | 44 ++ .../2021-03-01/examples/GraphQueryUpdate.json | 35 ++ .../stable/2021-03-01/graphquery.json | 527 ++++++++++++++++++ .../2022-10-01/examples/GraphQueryAdd.json | 49 ++ .../2022-10-01/examples/GraphQueryDelete.json | 14 + .../2022-10-01/examples/GraphQueryGet.json | 27 + .../2022-10-01/examples/GraphQueryList.json | 44 ++ .../2022-10-01/examples/GraphQueryUpdate.json | 35 ++ .../stable/2022-10-01/graphquery.json | 527 ++++++++++++++++++ .../resourcegraph/resource-manager/readme.md | 3 + 19 files changed, 2091 insertions(+) create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryAdd.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryDelete.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryGet.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryList.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryUpdate.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/graphquery.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryAdd.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryDelete.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryGet.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryList.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryUpdate.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/graphquery.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryAdd.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryDelete.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryGet.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryList.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryUpdate.json create mode 100644 specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/graphquery.json diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryAdd.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryAdd.json new file mode 100644 index 000000000000..094d7e162777 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryAdd.json @@ -0,0 +1,49 @@ +{ + "title": "Create a saved query", + "description": "Create new saved query resource.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2019-04-01", + "properties": { + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'" + } + } + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + }, + "201": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryDelete.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryDelete.json new file mode 100644 index 000000000000..503950121340 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryDelete.json @@ -0,0 +1,14 @@ +{ + "title": "Delete a saved query", + "description": "Delete a saved query resource by subid, resource group, and resource name.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVM", + "api-version": "2019-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryGet.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryGet.json new file mode 100644 index 000000000000..57c76c593180 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryGet.json @@ -0,0 +1,27 @@ +{ + "title": "Get a saved query", + "description": "Get a saved query resource by subid, resource group, and resource name.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2019-04-01" + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": null, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryList.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryList.json new file mode 100644 index 000000000000..49492c548c2b --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryList.json @@ -0,0 +1,44 @@ +{ + "title": "Get a list of saved queries", + "description": "Get a list of saved queries within subscription id and resource group.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "api-version": "2019-04-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.ResourceGraph/queries?api-version=2019-09-01-preview&$top=10&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/87f4f8b0-83c1-4aa9-b318-5237aeb15264/resources/rid1/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "tags": {}, + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + }, + { + "id": "/subscriptions/6abb2f31-3e6a-4134-9968-219a596012a0/resources/rid2/providers/Microsoft.ResourceGraph/queries/MyTestVMs", + "name": "MyTestVMs", + "type": "Microsoft.ResourceGraph/queries", + "tags": {}, + "etag": "b0809832-ca62-4133-8f13-0c46580f9db1", + "properties": { + "description": "Test VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'test'", + "resultKind": "basic", + "timeModified": "2019-03-13T13:51:13-07:00" + } + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryUpdate.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryUpdate.json new file mode 100644 index 000000000000..b7196dcbb4ec --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/examples/GraphQueryUpdate.json @@ -0,0 +1,35 @@ +{ + "title": "Update a saved query", + "description": "Update the existing saved query resource.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2019-04-01", + "body": { + "tags": null, + "etag": "b0809832-ca62-4133-8f13-0c46580f9db1", + "properties": { + "description": "Modified description", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'" + } + } + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "73811091-6188-4523-97b7-b5e7134e7fd9", + "tags": null, + "properties": { + "description": "Modified description", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-14T13:51:13-07:00" + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/graphquery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/graphquery.json new file mode 100644 index 000000000000..3d385f2dcf5d --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/graphquery.json @@ -0,0 +1,527 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Resource Graph Query", + "description": "Azure Resource Graph Query API Reference", + "version": "2019-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceGraph/queries": { + "get": { + "tags": [ + "GraphQuery" + ], + "description": "Get all graph queries defined within a specified subscription.", + "operationId": "GraphQuery_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more graph queries.", + "schema": { + "$ref": "#/definitions/GraphQueryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of Graph Queries": { + "$ref": "./examples/GraphQueryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries": { + "get": { + "tags": [ + "GraphQuery" + ], + "description": "Get all graph queries defined within a specified subscription and resource group.", + "operationId": "GraphQuery_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more graph queries.", + "schema": { + "$ref": "#/definitions/GraphQueryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of Graph Queries": { + "$ref": "./examples/GraphQueryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries/{resourceName}": { + "get": { + "tags": [ + "GraphQuery" + ], + "description": "Get a single graph query by its resourceName.", + "operationId": "GraphQuery_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A graph query definition.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Get Graph Query": { + "$ref": "./examples/GraphQueryGet.json" + } + } + }, + "delete": { + "tags": [ + "GraphQuery" + ], + "description": "Delete a graph query.", + "operationId": "GraphQuery_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The graph query has been successfully deleted." + }, + "204": { + "description": "The resource doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Delete Graph Query": { + "$ref": "./examples/GraphQueryDelete.json" + } + } + }, + "put": { + "tags": [ + "GraphQuery" + ], + "description": "Create a new graph query.", + "operationId": "GraphQuery_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "description": "Properties that need to be specified to create a new graph query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + } + ], + "responses": { + "200": { + "description": "The newly created graph query.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "201": { + "description": "The newly created graph query.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Create Graph Query": { + "$ref": "./examples/GraphQueryAdd.json" + } + } + }, + "patch": { + "description": "Updates a graph query that has already been added.", + "operationId": "GraphQuery_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Properties that need to be specified to create a new graph query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GraphQueryUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The graph query definition updated.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Update Graph Query": { + "$ref": "./examples/GraphQueryUpdate.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name. This is GUID value. The display name should be assigned within properties field." + }, + "location": { + "type": "string", + "readOnly": false, + "description": "The location of the resource" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "etag": { + "type": "string", + "description": "This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "GraphQueryListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of queries.", + "type": "string" + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/GraphQueryResource" + }, + "description": "An array of graph queries." + } + }, + "description": "Graph query list result." + }, + "GraphQueryResource": { + "type": "object", + "description": "Graph Query entity definition.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Metadata describing a graph query for an Azure resource.", + "$ref": "#/definitions/GraphQueryProperties" + } + } + }, + "GraphQueryProperties": { + "type": "object", + "description": "Properties that contain a graph query.", + "required": [ + "query" + ], + "properties": { + "timeModified": { + "type": "string", + "description": "Date and time in UTC of the last modification that was made to this graph query definition.", + "format": "date-time", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of a graph query." + }, + "query": { + "type": "string", + "description": "KQL query that will be graph." + }, + "resultKind": { + "description": "Enum indicating a type of graph query.", + "readOnly": true, + "type": "string", + "enum": [ + "basic" + ], + "x-ms-enum": { + "name": "ResultKind", + "modelAsString": true + } + } + } + }, + "GraphQueryUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "etag": { + "type": "string", + "description": "This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Metadata describing a graph query for an Azure resource.", + "$ref": "#/definitions/GraphQueryPropertiesUpdateParameters" + } + }, + "description": "The parameters that can be provided when updating workbook properties properties." + }, + "GraphQueryPropertiesUpdateParameters": { + "type": "object", + "description": "Properties that contain a workbook for PATCH operation.", + "properties": { + "description": { + "type": "string", + "description": "The description of a graph query." + }, + "query": { + "type": "string", + "description": "KQL query that will be graph." + } + } + }, + "ErrorFieldContract": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Property level error code." + }, + "message": { + "type": "string", + "description": "Human-readable representation of property-level error." + }, + "target": { + "type": "string", + "description": "Property name." + } + }, + "description": "Error Field contract." + }, + "GraphQueryError": { + "type": "object", + "properties": { + "error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." + }, + "message": { + "type": "string", + "description": "Human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorFieldContract" + }, + "description": "The list of invalid fields send in request, in case of validation error." + } + } + } + }, + "description": "Error message body that will indicate why the operation failed." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription Id.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "method" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "GraphQueryResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Graph Query resource.", + "pattern": "^[^<>&:\\?]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryAdd.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryAdd.json new file mode 100644 index 000000000000..798876689707 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryAdd.json @@ -0,0 +1,49 @@ +{ + "title": "Create a saved query", + "description": "Create new saved query resource.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2021-03-01", + "properties": { + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'" + } + } + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + }, + "201": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryDelete.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryDelete.json new file mode 100644 index 000000000000..4a92ccb789e0 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryDelete.json @@ -0,0 +1,14 @@ +{ + "title": "Delete a saved query", + "description": "Delete a saved query resource by subid, resource group, and resource name.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVM", + "api-version": "2021-03-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryGet.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryGet.json new file mode 100644 index 000000000000..2b4936f6b96c --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryGet.json @@ -0,0 +1,27 @@ +{ + "title": "Get a saved query", + "description": "Get a saved query resource by subid, resource group, and resource name.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2021-03-01" + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": null, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryList.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryList.json new file mode 100644 index 000000000000..226bdef1b024 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryList.json @@ -0,0 +1,44 @@ +{ + "title": "Get a list of saved queries", + "description": "Get a list of saved queries within subscription id and resource group.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "api-version": "2021-03-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.ResourceGraph/queries?api-version=2019-09-01-preview&$top=10&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/87f4f8b0-83c1-4aa9-b318-5237aeb15264/resources/rid1/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "tags": {}, + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + }, + { + "id": "/subscriptions/6abb2f31-3e6a-4134-9968-219a596012a0/resources/rid2/providers/Microsoft.ResourceGraph/queries/MyTestVMs", + "name": "MyTestVMs", + "type": "Microsoft.ResourceGraph/queries", + "tags": {}, + "etag": "b0809832-ca62-4133-8f13-0c46580f9db1", + "properties": { + "description": "Test VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'test'", + "resultKind": "basic", + "timeModified": "2019-03-13T13:51:13-07:00" + } + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryUpdate.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryUpdate.json new file mode 100644 index 000000000000..4f1d60fd45c6 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/examples/GraphQueryUpdate.json @@ -0,0 +1,35 @@ +{ + "title": "Update a saved query", + "description": "Update the existing saved query resource.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2021-03-01", + "body": { + "tags": null, + "etag": "b0809832-ca62-4133-8f13-0c46580f9db1", + "properties": { + "description": "Modified description", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'" + } + } + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "73811091-6188-4523-97b7-b5e7134e7fd9", + "tags": null, + "properties": { + "description": "Modified description", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-14T13:51:13-07:00" + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/graphquery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/graphquery.json new file mode 100644 index 000000000000..82da104c4a53 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/graphquery.json @@ -0,0 +1,527 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Resource Graph Query", + "description": "Azure Resource Graph Query API Reference", + "version": "2021-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceGraph/queries": { + "get": { + "tags": [ + "GraphQuery" + ], + "description": "Get all graph queries defined within a specified subscription.", + "operationId": "GraphQuery_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more graph queries.", + "schema": { + "$ref": "#/definitions/GraphQueryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of Graph Queries": { + "$ref": "./examples/GraphQueryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries": { + "get": { + "tags": [ + "GraphQuery" + ], + "description": "Get all graph queries defined within a specified subscription and resource group.", + "operationId": "GraphQuery_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more graph queries.", + "schema": { + "$ref": "#/definitions/GraphQueryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of Graph Queries": { + "$ref": "./examples/GraphQueryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries/{resourceName}": { + "get": { + "tags": [ + "GraphQuery" + ], + "description": "Get a single graph query by its resourceName.", + "operationId": "GraphQuery_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A graph query definition.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Get Graph Query": { + "$ref": "./examples/GraphQueryGet.json" + } + } + }, + "delete": { + "tags": [ + "GraphQuery" + ], + "description": "Delete a graph query.", + "operationId": "GraphQuery_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The graph query has been successfully deleted." + }, + "204": { + "description": "The resource doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Delete Graph Query": { + "$ref": "./examples/GraphQueryDelete.json" + } + } + }, + "put": { + "tags": [ + "GraphQuery" + ], + "description": "Create a new graph query.", + "operationId": "GraphQuery_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "description": "Properties that need to be specified to create a new graph query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + } + ], + "responses": { + "200": { + "description": "The newly created graph query.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "201": { + "description": "The newly created graph query.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Create Graph Query": { + "$ref": "./examples/GraphQueryAdd.json" + } + } + }, + "patch": { + "description": "Updates a graph query that has already been added.", + "operationId": "GraphQuery_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Properties that need to be specified to create a new graph query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GraphQueryUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The graph query definition updated.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Update Graph Query": { + "$ref": "./examples/GraphQueryUpdate.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name. This is GUID value. The display name should be assigned within properties field." + }, + "location": { + "type": "string", + "readOnly": false, + "description": "The location of the resource" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "etag": { + "type": "string", + "description": "This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "GraphQueryListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of queries.", + "type": "string" + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/GraphQueryResource" + }, + "description": "An array of graph queries." + } + }, + "description": "Graph query list result." + }, + "GraphQueryResource": { + "type": "object", + "description": "Graph Query entity definition.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Metadata describing a graph query for an Azure resource.", + "$ref": "#/definitions/GraphQueryProperties" + } + } + }, + "GraphQueryProperties": { + "type": "object", + "description": "Properties that contain a graph query.", + "required": [ + "query" + ], + "properties": { + "timeModified": { + "type": "string", + "description": "Date and time in UTC of the last modification that was made to this graph query definition.", + "format": "date-time", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of a graph query." + }, + "query": { + "type": "string", + "description": "KQL query that will be graph." + }, + "resultKind": { + "description": "Enum indicating a type of graph query.", + "readOnly": true, + "type": "string", + "enum": [ + "basic" + ], + "x-ms-enum": { + "name": "ResultKind", + "modelAsString": true + } + } + } + }, + "GraphQueryUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "etag": { + "type": "string", + "description": "This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Metadata describing a graph query for an Azure resource.", + "$ref": "#/definitions/GraphQueryPropertiesUpdateParameters" + } + }, + "description": "The parameters that can be provided when updating workbook properties properties." + }, + "GraphQueryPropertiesUpdateParameters": { + "type": "object", + "description": "Properties that contain a workbook for PATCH operation.", + "properties": { + "description": { + "type": "string", + "description": "The description of a graph query." + }, + "query": { + "type": "string", + "description": "KQL query that will be graph." + } + } + }, + "ErrorFieldContract": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Property level error code." + }, + "message": { + "type": "string", + "description": "Human-readable representation of property-level error." + }, + "target": { + "type": "string", + "description": "Property name." + } + }, + "description": "Error Field contract." + }, + "GraphQueryError": { + "type": "object", + "properties": { + "error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." + }, + "message": { + "type": "string", + "description": "Human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorFieldContract" + }, + "description": "The list of invalid fields send in request, in case of validation error." + } + } + } + }, + "description": "Error message body that will indicate why the operation failed." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription Id.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "method" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "GraphQueryResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Graph Query resource.", + "pattern": "^[^<>&:\\?]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryAdd.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryAdd.json new file mode 100644 index 000000000000..00e73d050416 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryAdd.json @@ -0,0 +1,49 @@ +{ + "title": "Create a saved query", + "description": "Create new saved query resource.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2022-10-01", + "properties": { + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'" + } + } + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + }, + "201": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": {}, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryDelete.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryDelete.json new file mode 100644 index 000000000000..9fd52a66a536 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryDelete.json @@ -0,0 +1,14 @@ +{ + "title": "Delete a saved query", + "description": "Delete a saved query resource by subid, resource group, and resource name.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVM", + "api-version": "2022-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryGet.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryGet.json new file mode 100644 index 000000000000..ed3a56b6e611 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryGet.json @@ -0,0 +1,27 @@ +{ + "title": "Get a saved query", + "description": "Get a saved query resource by subid, resource group, and resource name.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2022-10-01" + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "tags": null, + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryList.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryList.json new file mode 100644 index 000000000000..b837b661c920 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryList.json @@ -0,0 +1,44 @@ +{ + "title": "Get a list of saved queries", + "description": "Get a list of saved queries within subscription id and resource group.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "api-version": "2022-10-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.ResourceGraph/queries?api-version=2019-09-01-preview&$top=10&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/87f4f8b0-83c1-4aa9-b318-5237aeb15264/resources/rid1/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "tags": {}, + "etag": "5d64408e-4ca3-41f7-b725-6914f3012afa", + "properties": { + "description": "Docker VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-12T13:51:13-07:00" + } + }, + { + "id": "/subscriptions/6abb2f31-3e6a-4134-9968-219a596012a0/resources/rid2/providers/Microsoft.ResourceGraph/queries/MyTestVMs", + "name": "MyTestVMs", + "type": "Microsoft.ResourceGraph/queries", + "tags": {}, + "etag": "b0809832-ca62-4133-8f13-0c46580f9db1", + "properties": { + "description": "Test VMs in PROD", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'test'", + "resultKind": "basic", + "timeModified": "2019-03-13T13:51:13-07:00" + } + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryUpdate.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryUpdate.json new file mode 100644 index 000000000000..82408e6e6e6b --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/examples/GraphQueryUpdate.json @@ -0,0 +1,35 @@ +{ + "title": "Update a saved query", + "description": "Update the existing saved query resource.", + "parameters": { + "subscriptionId": "024e2271-06fa-46b6-9079-f1ed3c7b070e", + "resourceGroupName": "my-resource-group", + "resourceName": "MyDockerVMs", + "api-version": "2022-10-01", + "body": { + "tags": null, + "etag": "b0809832-ca62-4133-8f13-0c46580f9db1", + "properties": { + "description": "Modified description", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'" + } + } + }, + "responses": { + "200": { + "body": { + "id": " /subscriptions/024e2271-06fa-46b6-9079-f1ed3c7b070e/resources/my-resource-group/providers/Microsoft.ResourceGraph/queries/MyDockerVMs", + "name": "MyDockerVMs", + "type": "Microsoft.ResourceGraph/queries", + "etag": "73811091-6188-4523-97b7-b5e7134e7fd9", + "tags": null, + "properties": { + "description": "Modified description", + "query": "where isnotnull(tags['Prod']) and properties.extensions[0].Name == 'docker'", + "resultKind": "basic", + "timeModified": "2019-03-14T13:51:13-07:00" + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/graphquery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/graphquery.json new file mode 100644 index 000000000000..a6d1acd0455b --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2022-10-01/graphquery.json @@ -0,0 +1,527 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Resource Graph Query", + "description": "Azure Resource Graph Query API Reference", + "version": "2022-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceGraph/queries": { + "get": { + "tags": [ + "GraphQuery" + ], + "description": "Get all graph queries defined within a specified subscription.", + "operationId": "GraphQuery_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more graph queries.", + "schema": { + "$ref": "#/definitions/GraphQueryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of Graph Queries": { + "$ref": "./examples/GraphQueryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries": { + "get": { + "tags": [ + "GraphQuery" + ], + "description": "Get all graph queries defined within a specified subscription and resource group.", + "operationId": "GraphQuery_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more graph queries.", + "schema": { + "$ref": "#/definitions/GraphQueryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of Graph Queries": { + "$ref": "./examples/GraphQueryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries/{resourceName}": { + "get": { + "tags": [ + "GraphQuery" + ], + "description": "Get a single graph query by its resourceName.", + "operationId": "GraphQuery_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A graph query definition.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Get Graph Query": { + "$ref": "./examples/GraphQueryGet.json" + } + } + }, + "delete": { + "tags": [ + "GraphQuery" + ], + "description": "Delete a graph query.", + "operationId": "GraphQuery_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The graph query has been successfully deleted." + }, + "204": { + "description": "The resource doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Delete Graph Query": { + "$ref": "./examples/GraphQueryDelete.json" + } + } + }, + "put": { + "tags": [ + "GraphQuery" + ], + "description": "Create a new graph query.", + "operationId": "GraphQuery_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "description": "Properties that need to be specified to create a new graph query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + } + ], + "responses": { + "200": { + "description": "The newly created graph query.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "201": { + "description": "The newly created graph query.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Create Graph Query": { + "$ref": "./examples/GraphQueryAdd.json" + } + } + }, + "patch": { + "description": "Updates a graph query that has already been added.", + "operationId": "GraphQuery_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/GraphQueryResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Properties that need to be specified to create a new graph query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GraphQueryUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The graph query definition updated.", + "schema": { + "$ref": "#/definitions/GraphQueryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GraphQueryError" + } + } + }, + "x-ms-examples": { + "Update Graph Query": { + "$ref": "./examples/GraphQueryUpdate.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name. This is GUID value. The display name should be assigned within properties field." + }, + "location": { + "type": "string", + "readOnly": false, + "description": "The location of the resource" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "etag": { + "type": "string", + "description": "This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "GraphQueryListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of queries.", + "type": "string" + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/GraphQueryResource" + }, + "description": "An array of graph queries." + } + }, + "description": "Graph query list result." + }, + "GraphQueryResource": { + "type": "object", + "description": "Graph Query entity definition.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Metadata describing a graph query for an Azure resource.", + "$ref": "#/definitions/GraphQueryProperties" + } + } + }, + "GraphQueryProperties": { + "type": "object", + "description": "Properties that contain a graph query.", + "required": [ + "query" + ], + "properties": { + "timeModified": { + "type": "string", + "description": "Date and time in UTC of the last modification that was made to this graph query definition.", + "format": "date-time", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of a graph query." + }, + "query": { + "type": "string", + "description": "KQL query that will be graph." + }, + "resultKind": { + "description": "Enum indicating a type of graph query.", + "readOnly": true, + "type": "string", + "enum": [ + "basic" + ], + "x-ms-enum": { + "name": "ResultKind", + "modelAsString": true + } + } + } + }, + "GraphQueryUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "etag": { + "type": "string", + "description": "This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Metadata describing a graph query for an Azure resource.", + "$ref": "#/definitions/GraphQueryPropertiesUpdateParameters" + } + }, + "description": "The parameters that can be provided when updating workbook properties properties." + }, + "GraphQueryPropertiesUpdateParameters": { + "type": "object", + "description": "Properties that contain a workbook for PATCH operation.", + "properties": { + "description": { + "type": "string", + "description": "The description of a graph query." + }, + "query": { + "type": "string", + "description": "KQL query that will be graph." + } + } + }, + "ErrorFieldContract": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Property level error code." + }, + "message": { + "type": "string", + "description": "Human-readable representation of property-level error." + }, + "target": { + "type": "string", + "description": "Property name." + } + }, + "description": "Error Field contract." + }, + "GraphQueryError": { + "type": "object", + "properties": { + "error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." + }, + "message": { + "type": "string", + "description": "Human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorFieldContract" + }, + "description": "The list of invalid fields send in request, in case of validation error." + } + } + } + }, + "description": "Error message body that will indicate why the operation failed." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription Id.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "method" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "GraphQueryResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Graph Query resource.", + "pattern": "^[^<>&:\\?]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/resourcegraph/resource-manager/readme.md b/specification/resourcegraph/resource-manager/readme.md index 44d2aec69757..791a98fafafa 100644 --- a/specification/resourcegraph/resource-manager/readme.md +++ b/specification/resourcegraph/resource-manager/readme.md @@ -60,6 +60,7 @@ These settings apply only when `--tag=package-2022-10` is specified on the comma ``` yaml $(tag) == 'package-2022-10' input-file: - Microsoft.ResourceGraph/stable/2022-10-01/resourcegraph.json + - Microsoft.ResourceGraph/stable/2022-10-01/graphquery.json - Microsoft.ResourceGraph/preview/2021-06-01-preview/resourceshistory.json - Microsoft.ResourceGraph/preview/2020-09-01-preview/resourcechanges.json ``` @@ -92,6 +93,7 @@ These settings apply only when `--tag=package-2021-03` is specified on the comma ``` yaml $(tag) == 'package-2021-03' input-file: - Microsoft.ResourceGraph/stable/2021-03-01/resourcegraph.json + - Microsoft.ResourceGraph/stable/2021-03-01/graphquery.json ``` ### Tag: package-preview-2020-09 @@ -123,6 +125,7 @@ These settings apply only when `--tag=package-2019-04` is specified on the comma ``` yaml $(tag) == 'package-2019-04' input-file: - Microsoft.ResourceGraph/stable/2019-04-01/resourcegraph.json + - Microsoft.ResourceGraph/stable/2019-04-01/graphquery.json ``` ### Tag: package-2018-09-preview From a64415b52ed498416e9200802a307289e4606f37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Au=C3=B0unn?= Date: Tue, 11 Jun 2024 09:49:05 +0300 Subject: [PATCH 148/343] [NetAppFiles] Release netapp microsoft.net app 2023 11 01 preview (#29206) * Copy files from stable/2023-11-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2023-11-01-preview Updated the API version from stable/2023-11-01 to preview/2023-11-01-preview. * Added tag for 2023-11-01-preview in readme file * apply 2023-11-01 * pretty * remove extra example * spelling * Accounts_GetChangeKeyVaultInformation * Arm-id * coolnessperiod minimum fix * Add protocolTypes to volumePatchProperties --- .../examples/Accounts_ChangeKeyVault.json | 26 + .../examples/Accounts_CreateOrUpdate.json | 36 + .../examples/Accounts_CreateOrUpdateAD.json | 81 + .../examples/Accounts_Delete.json | 16 + .../examples/Accounts_Get.json | 36 + ...Accounts_GetChangeKeyVaultInformation.json | 15 + .../examples/Accounts_List.json | 24 + .../Accounts_MigrateEncryptionKey.json | 20 + .../examples/Accounts_RenewCredentials.json | 17 + .../examples/Accounts_Update.json | 46 + .../examples/BackupPolicies_Create.json | 51 + .../examples/BackupPolicies_Delete.json | 18 + .../examples/BackupPolicies_Get.json | 33 + .../examples/BackupPolicies_List.json | 29 + .../examples/BackupPolicies_Update.json | 70 + .../examples/BackupVaults_Create.json | 36 + .../examples/BackupVaults_Delete.json | 18 + .../examples/BackupVaults_Get.json | 25 + .../examples/BackupVaults_List.json | 28 + .../examples/BackupVaults_Update.json | 48 + .../examples/BackupsUnderAccount_Migrate.json | 19 + .../BackupsUnderBackupVault_Create.json | 50 + .../BackupsUnderBackupVault_Delete.json | 19 + .../examples/BackupsUnderBackupVault_Get.json | 29 + .../BackupsUnderBackupVault_List.json | 32 + ...upsUnderBackupVault_SingleFileRestore.json | 24 + .../BackupsUnderBackupVault_Update.json | 49 + .../examples/BackupsUnderVolume_Migrate.json | 21 + .../examples/CheckFilePathAvailability.json | 18 + .../examples/CheckNameAvailability.json | 19 + .../examples/CheckQuotaAvailability.json | 19 + .../examples/GroupIdListForLDAPUser.json | 29 + .../examples/NetworkSiblingSet_Query.json | 42 + .../examples/NetworkSiblingSet_Update.json | 49 + .../examples/OperationList.json | 1565 +++ .../examples/Pools_CreateOrUpdate.json | 51 + .../examples/Pools_Delete.json | 17 + .../examples/Pools_Get.json | 28 + .../examples/Pools_List.json | 30 + .../examples/Pools_Update.json | 34 + .../examples/QuotaLimits_Get.json | 21 + .../examples/QuotaLimits_List.json | 87 + .../examples/RegionInfo.json | 20 + .../examples/RegionInfos_Get.json | 33 + .../examples/RegionInfos_List.json | 37 + .../examples/SnapshotPolicies_Create.json | 104 + .../examples/SnapshotPolicies_Delete.json | 18 + .../examples/SnapshotPolicies_Get.json | 44 + .../examples/SnapshotPolicies_List.json | 47 + .../SnapshotPolicies_ListVolumes.json | 36 + .../examples/SnapshotPolicies_Update.json | 107 + .../examples/Snapshots_Create.json | 31 + .../examples/Snapshots_Delete.json | 20 + .../examples/Snapshots_Get.json | 26 + .../examples/Snapshots_List.json | 29 + .../examples/Snapshots_SingleFileRestore.json | 25 + .../examples/Snapshots_Update.json | 32 + .../examples/Subvolumes_Create.json | 42 + .../examples/Subvolumes_Delete.json | 20 + .../examples/Subvolumes_Get.json | 24 + .../examples/Subvolumes_List.json | 28 + .../examples/Subvolumes_Metadata.json | 35 + .../examples/Subvolumes_Update.json | 34 + .../examples/VolumeGroups_Create_Oracle.json | 965 ++ .../examples/VolumeGroups_Create_SapHana.json | 406 + .../examples/VolumeGroups_Delete.json | 18 + .../examples/VolumeGroups_Get_Oracle.json | 510 + .../examples/VolumeGroups_Get_SapHana.json | 220 + .../examples/VolumeGroups_List_Oracle.json | 31 + .../examples/VolumeGroups_List_SapHana.json | 31 + .../examples/VolumeQuotaRules_Create.json | 52 + .../examples/VolumeQuotaRules_Delete.json | 20 + .../examples/VolumeQuotaRules_Get.json | 27 + .../examples/VolumeQuotaRules_List.json | 31 + .../examples/VolumeQuotaRules_Update.json | 37 + .../Volumes_AuthorizeReplication.json | 21 + .../examples/Volumes_BreakFileLocks.json | 22 + .../examples/Volumes_BreakReplication.json | 21 + ...umes_CreateOnPremMigrationReplication.json | 23 + .../examples/Volumes_CreateOrUpdate.json | 58 + .../examples/Volumes_Delete.json | 18 + .../examples/Volumes_DeleteReplication.json | 22 + .../Volumes_FinalizeOnPremMigration.json | 17 + .../examples/Volumes_FinalizeRelocation.json | 22 + .../examples/Volumes_Get.json | 32 + .../examples/Volumes_LatestBackupStatus.json | 24 + .../examples/Volumes_LatestRestoreStatus.json | 22 + .../examples/Volumes_List.json | 35 + .../examples/Volumes_ListReplications.json | 27 + ...Volumes_PeerClusterForOnPremMigration.json | 33 + .../Volumes_PerformReplicationTransfer.json | 21 + .../examples/Volumes_PoolChange.json | 21 + .../Volumes_PopulateAvailabilityZones.json | 37 + .../Volumes_ReInitializeReplication.json | 22 + .../Volumes_ReestablishReplication.json | 20 + .../examples/Volumes_Relocate.json | 19 + .../examples/Volumes_ReplicationStatus.json | 25 + .../examples/Volumes_ResetCifsPassword.json | 21 + .../examples/Volumes_ResyncReplication.json | 22 + .../examples/Volumes_Revert.json | 21 + .../examples/Volumes_RevertRelocation.json | 22 + .../examples/Volumes_SplitClone.json | 17 + .../examples/Volumes_Update.json | 43 + .../preview/2023-11-01-preview/netapp.json | 10459 ++++++++++++++++ .../stable/2023-11-01/netapp.json | 13 +- .../netapp/resource-manager/readme.md | 13 +- 106 files changed, 17255 insertions(+), 3 deletions(-) create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_ChangeKeyVault.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_CreateOrUpdateAD.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_MigrateEncryptionKey.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_RenewCredentials.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderAccount_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderVolume_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckFilePathAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckNameAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckQuotaAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/GroupIdListForLDAPUser.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/NetworkSiblingSet_Query.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/NetworkSiblingSet_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/OperationList.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/QuotaLimits_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/QuotaLimits_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfo.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfos_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfos_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_ListVolumes.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Metadata.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Create_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Create_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Get_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Get_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_List_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_List_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_AuthorizeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_BreakFileLocks.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_BreakReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_CreateOnPremMigrationReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_DeleteReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_FinalizeOnPremMigration.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_FinalizeRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_LatestBackupStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_LatestRestoreStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ListReplications.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PeerClusterForOnPremMigration.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PerformReplicationTransfer.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PoolChange.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PopulateAvailabilityZones.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReInitializeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReestablishReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Relocate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReplicationStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ResetCifsPassword.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ResyncReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Revert.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_RevertRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_SplitClone.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/netapp.json diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_ChangeKeyVault.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_ChangeKeyVault.json new file mode 100644 index 000000000000..7da7d08c15f2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_ChangeKeyVault.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview", + "body": { + "keyVaultUri": "https://my-key-vault.managedhsm.azure.net", + "keyName": "rsakey", + "keyVaultResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm", + "keyVaultPrivateEndpoints": [ + { + "virtualNetworkId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1", + "privateEndpointId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..82b653327183 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..b06b4f198982 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": { + "activeDirectories": [ + { + "site": "SiteName", + "username": "ad_user_name", + "password": "ad_password", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Delete.json new file mode 100644 index 000000000000..6a4a6bb0385a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Get.json new file mode 100644 index 000000000000..3309f22b31fa --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "site": "SiteName", + "activeDirectoryId": "02da3711-6c58-2d64-098a-e3af7afaf936", + "username": "ad_user_name", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "status": "InUse", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "statusDetails": "Status Details", + "aesEncryption": true, + "ldapSigning": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json new file mode 100644 index 000000000000..2992adc58f00 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_List.json new file mode 100644 index 000000000000..19fd363b0d43 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_MigrateEncryptionKey.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_MigrateEncryptionKey.json new file mode 100644 index 000000000000..edc9aae29c8d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_MigrateEncryptionKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview", + "body": { + "virtualNetworkId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1", + "privateEndpointId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..71e2c6c41695 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Update.json new file mode 100644 index 000000000000..d1e98f49226c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2023-11-01-preview&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Patching", + "encryption": { + "keySource": "Microsoft.NetApp" + } + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..1bf8125e63ea --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2023-11-01-preview", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..b48b357d3224 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupPolicyName": "backupPolicyName", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..36e01388fad6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..1b03493bfb79 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicy1", + "name": "account1/backupPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..22720713a611 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupPolicies_Update.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2023-11-01-preview", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2023-11-01-preview" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Create.json new file mode 100644 index 000000000000..b12b67042479 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Create.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Delete.json new file mode 100644 index 000000000000..9c9c11a25369 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Get.json new file mode 100644 index 000000000000..7b4c120ddbd8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_List.json new file mode 100644 index 000000000000..e3c26979f0e4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Update.json new file mode 100644 index 000000000000..f71da4718454 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupVaults_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2023-11-01-preview", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderAccount_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderAccount_Migrate.json new file mode 100644 index 000000000000..82e8f575d23b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderAccount_Migrate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Create.json new file mode 100644 index 000000000000..0838cde7cdf1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Create.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2023-11-01-preview", + "body": { + "properties": { + "label": "myLabel", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Delete.json new file mode 100644 index 000000000000..9c5c89910e80 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Get.json new file mode 100644 index 000000000000..6a1b874e504d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_List.json new file mode 100644 index 000000000000..a244069c5e7f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json new file mode 100644 index 000000000000..1b369d0a91a6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2023-11-01-preview", + "body": { + "fileList": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ], + "destinationVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Update.json new file mode 100644 index 000000000000..fce06f01ee44 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderBackupVault_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2023-11-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2023-11-01-preview" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderVolume_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderVolume_Migrate.json new file mode 100644 index 000000000000..6d3f06a9c5e4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/BackupsUnderVolume_Migrate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..165d313741d3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-11-01-preview", + "body": { + "name": "my-exact-filepth", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..a3ad262608d8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-11-01-preview", + "body": { + "name": "accName", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..f455725cae3e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-11-01-preview", + "body": { + "name": "resource1", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..8bd1ca9bae73 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/GroupIdListForLDAPUser.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "username": "user1" + } + }, + "responses": { + "200": { + "body": { + "groupIdsForLdapUser": [ + "123", + "224" + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..b44a2ae569b7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-11-01-preview", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..ba586c147bb7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-11-01-preview", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2023-01-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..36a671f86cf6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.NetApp/register/action", + "display": { + "provider": "Microsoft.NetApp", + "resource": "Subscription", + "operation": "Subscription Registration Action", + "description": "Subscription Registration Action" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume resource", + "description": "Reads a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write volume resource", + "description": "Writes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete volume resource", + "description": "Deletes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/Revert/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert volume resource", + "description": "Revert volume to specific snapshot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BreakReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Break volume replication resource", + "description": "Break volume replication relations" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ListReplications/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReInitializeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Re-Initialize replication", + "description": "Attempts to re-initialize an uninitialized replication" + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "AverageReadLatency", + "displayName": "Average read latency", + "displayDescription": "Average read latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageReadLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "AverageWriteLatency", + "displayName": "Average write latency", + "displayDescription": "Average write latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageWriteLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeLogicalSize", + "displayName": "Volume Consumed Size", + "displayDescription": "Logical size of the volume (used bytes)", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeSnapshotSize", + "displayName": "Volume snapshot size", + "displayDescription": "Size of all snapshots in volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadIops", + "displayName": "Read iops", + "displayDescription": "Read In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteIops", + "displayName": "Write iops", + "displayDescription": "Write In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeAllocatedSize", + "displayName": "Volume allocated size", + "displayDescription": "The provisioned size of a volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierSize", + "displayName": "Volume cool tier size", + "displayDescription": "Volume Footprint for Cool Tier", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataReadSize", + "displayName": "Volume cool tier data read size", + "displayDescription": "Data read in using GET per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataReadSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataWriteSize", + "displayName": "Volume cool tier data write size", + "displayDescription": "Data tiered out using PUT per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataWriteSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferDuration", + "displayName": "Volume replication last transfer duration", + "displayDescription": "The amount of time in seconds it took for the last transfer to complete.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferDuration", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferSize", + "displayName": "Volume replication last transfer size", + "displayDescription": "The total number of bytes transferred as part of the last transfer.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationHealthy", + "displayName": "Is volume replication status healthy", + "displayDescription": "Condition of the relationship, 1 or 0.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationHealthy", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLagTime", + "displayName": "Volume replication lag time", + "displayDescription": "The amount of time in seconds by which the data on the mirror lags behind the source.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLagTime", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationTotalTransferBytes", + "displayName": "Volume replication total transfer", + "displayDescription": "Cumulative bytes transferred for the relationship.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationTotalTransferBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipProgress", + "displayName": "Volume replication progress", + "displayDescription": "Total amount of data transferred for the current transfer operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipProgress", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipTransferring", + "displayName": "Is volume replication transferring", + "displayDescription": "Whether the status of the Volume Replication is 'transferring'.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipTransferring", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeLogicalBackupBytes", + "displayName": "Volume Backup Bytes", + "displayDescription": "Total bytes backed up for this Volume.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeLogicalBackupBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeProtected", + "displayName": "Is Volume Backup Enabled", + "displayDescription": "Is backup enabled for the volume? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeProtected", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeBackupActive", + "displayName": "Is Volume Backup suspended", + "displayDescription": "Is the backup policy suspended for the volume? 0 if yes, 1 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeBackupActive", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationTransferredBytes", + "displayName": "Volume Backup Last Transferred Bytes", + "displayDescription": "Total bytes transferred for last backup or restore operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationTransferredBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationComplete", + "displayName": "Is Volume Backup Operation Complete", + "displayDescription": "Did the last volume backup or restore operation complete successfully? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationComplete", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeConsumedSizePercentage", + "displayName": "Percentage Volume Consumed Size", + "displayDescription": "The percentage of the volume consumed including snapshots.", + "unit": "Percent", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeConsumedSizePercentage", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "OtherThroughput", + "displayName": "Other throughput", + "displayDescription": "Other throughput (that is not read or write) in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "OtherThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadThroughput", + "displayName": "Read throughput", + "displayDescription": "Read throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "TotalThroughput", + "displayName": "Total throughput", + "displayDescription": "Sum of all throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "TotalThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteThroughput", + "displayName": "Write throughput", + "displayDescription": "Write throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/AuthorizeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Authorize Replication", + "description": "Authorize the source volume replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ResyncReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Resync Replication", + "description": "Resync the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/DeleteReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete Replication", + "description": "Delete the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/MountTargets/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read mount target resource", + "description": "Reads a mount target resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BackupStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RestoreStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/PoolChange/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Change pool for volume", + "description": "Moves volume to another pool." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RelocateVolume/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Relocate volume to a new stamp.", + "description": "Relocate volume to a new stamp." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/FinalizeRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Finalize relocation of volume.", + "description": "Finalize relocation by cleaning up the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RevertRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert the relocation of volume.", + "description": "Revert the relocation and revert back to the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Read account resource", + "description": "Reads an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Write account resource", + "description": "Writes an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Delete account resource", + "description": "Deletes a account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/RenewCredentials/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Renew MSI credentials, if possible.", + "description": "Renews MSI credentials of account, if account has MSI credentials that are due for renewal." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read pool resource", + "description": "Reads a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write pool resource", + "description": "Writes a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Delete pool resource", + "description": "Deletes a pool resource." + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "VolumePoolAllocatedUsed", + "displayName": "Pool Allocated To Volume Size", + "displayDescription": "Allocated used size of the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedUsed", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalLogicalSize", + "displayName": "Pool Consumed Size", + "displayDescription": "Sum of the logical size of all the volumes belonging to the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedSize", + "displayName": "Pool Allocated Size", + "displayDescription": "Provisioned size of this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalSnapshotSize", + "displayName": "Total Snapshot size for the pool", + "displayDescription": "Sum of snapshot size of all volumes in this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolProvisionedThroughput", + "displayName": "Provisioned throughput for the pool", + "displayDescription": "Provisioned throughput of this pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolProvisionedThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedToVolumeThroughput", + "displayName": "Pool allocated throughput", + "displayDescription": "Sum of the throughput of all the volumes belonging to the pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedToVolumeThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Autoscale", + "displayName": "Capacity Pool Autoscaled" + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read log definitions.", + "description": "Gets the log definitions for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Read snapshot resource", + "description": "Reads a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Write snapshot resource", + "description": "Writes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Delete snapshot resource", + "description": "Deletes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/RestoreFiles/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Single File Snapshot Restore", + "description": "Restores files from a snapshot resource" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Write subvolume Resource", + "description": "Write a subvolume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/GetMetadata/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Subvolume Metadata resource.", + "description": "Read subvolume metadata resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Read snapshot policy resource", + "description": "Reads a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Write snapshot policy resource", + "description": "Writes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Delete snapshot policy resource", + "description": "Deletes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/Volumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/ListVolumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Read backup resource.", + "description": "Reads a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Write backup resource.", + "description": "Writes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Delete backup resource", + "description": "Deletes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Read backup policy resource.", + "description": "Reads a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Write backup policy resource.", + "description": "Writes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Delete backup policy resource", + "description": "Deletes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/vaults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Vault resource type", + "operation": "Read vault resource.", + "description": "Reads a vault resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Read an account backup resource.", + "description": "Reads an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Write an account backup resource.", + "description": "Writes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Delete an account backup resource.", + "description": "Deletes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Read volume group resource", + "description": "Reads a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Write volume group resource", + "description": "Writes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Delete volume group resource", + "description": "Deletes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/quotaLimits/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "QuotaLimit resource type", + "operation": "Read QuotaLimit resource type", + "description": "Reads a Quotalimit resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/Operations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operations resource type", + "operation": "Read operation resource", + "description": "Reads an operation resources." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/operationresults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operation results resource type", + "operation": "Read operation result resource", + "description": "Reads an operation result resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Location wide operation", + "operation": "Read location wide operation", + "description": "Reads a location wide operation." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checknameavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "NetApp resources", + "operation": "Check if resource name is available", + "description": "Check if resource name is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkfilepathavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Check if file path is available", + "description": "Check if file path is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/unregister/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subscription", + "operation": "Unregister Subscription for Azure NetApp Files", + "description": "Unregisters Subscription with Microsoft.NetApp resource provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkinventory/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "ReservedCapacity reservation resource.", + "operation": "Checks ReservedCapacity inventory.", + "description": "Checks ReservedCapacity inventory." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..2ab36f6e3170 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": { + "size": 4398046511104, + "serviceLevel": "Premium", + "qosType": "Auto" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Delete.json new file mode 100644 index 000000000000..18a808534c73 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..80919d6b3090 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_List.json new file mode 100644 index 000000000000..18308f01e607 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Update.json new file mode 100644 index 000000000000..565ff7a6a6e4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Pools_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-11-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..2c7e530ca2c6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..40a2162c1e4a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/accountsPerSubscription", + "name": "eastus/accountsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/poolsPerAccount", + "name": "eastus/poolsPerAccount", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 25, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/volumesPerPool", + "name": "eastus/volumesPerPool", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/snapshotsPerVolume", + "name": "eastus/snapshotsPerVolume", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 255, + "default": 255 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalTiBsPerSubscription", + "name": "eastus/totalTiBsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 1000, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalDPVolumesPerSubscription", + "name": "eastus/totalDPVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalVolumesPerSubscription", + "name": "eastus/totalVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfo.json new file mode 100644 index 000000000000..77def9a2fa9c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfos_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfos_Get.json new file mode 100644 index 000000000000..27de71b6629f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfos_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfos_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfos_List.json new file mode 100644 index 000000000000..4708852dca17 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/RegionInfos_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..309c7d56ec04 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..a01df113ebca --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..0b688e49a53d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..37d1453b063e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "location": "eastus", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..ae1676a7031a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_ListVolumes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..0b4c41fb1dfa --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/SnapshotPolicies_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2023-11-01-preview&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Create.json new file mode 100644 index 000000000000..5b25181dd431 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Create.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2023-11-01-preview", + "location": "eastus", + "body": { + "location": "eastus" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..8baf4d564608 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Get.json new file mode 100644 index 000000000000..489fe75b248b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_List.json new file mode 100644 index 000000000000..c330316c25cc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..8ec44fdc1033 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_SingleFileRestore.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2023-11-01-preview", + "body": { + "filePaths": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Update.json new file mode 100644 index 000000000000..2f092afdf793 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Snapshots_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2023-11-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..860790dfb84f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-11-01-preview", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Succeeded", + "size": 0 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..9ea622024143 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..815ccaaafb5b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_List.json new file mode 100644 index 000000000000..7a70e35de70d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..e6b46b6e2f9f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Metadata.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1/metadata", + "name": "account1/pool1/volume1/subvolume1/metadata", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/metadata", + "properties": { + "path": "/pathToSubvol", + "size": 5, + "bytesUsed": 5, + "permissions": "777", + "creationTimeStamp": "2017-08-15T13:23:33Z", + "accessedTimeStamp": "2017-08-15T13:23:33Z", + "modifiedTimeStamp": "2017-08-15T13:23:33Z", + "changedTimeStamp": "2017-08-15T13:23:33Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..5d19f649ac07 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Subvolumes_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-11-01-preview", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolume1", + "properties": { + "path": "/subvolumePath", + "size": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..7bea3272d238 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Create_Oracle.json @@ -0,0 +1,965 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2023-11-01-preview", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data1", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data1", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data2", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data2", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data3", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data3", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data4", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data4", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data5", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data5", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data6", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data6", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data7", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data7", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data8", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data8", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log-mirror", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log-mirror", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-binary", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-binary", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..e0b4a9da79f8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Create_SapHana.json @@ -0,0 +1,406 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2023-11-01-preview", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "name": "test-data-mnt00001", + "properties": { + "creationToken": "test-data-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-mnt00001", + "properties": { + "creationToken": "test-log-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-shared", + "properties": { + "creationToken": "test-shared", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "shared", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-data-backup", + "properties": { + "creationToken": "test-data-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-backup", + "properties": { + "creationToken": "test-log-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-shared", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..cab9c920e2f8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..334b41786216 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Get_Oracle.json @@ -0,0 +1,510 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2", + "volumesCount": 12 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..a27bb224ad7f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_Get_SapHana.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-shared", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..561f936e8979 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_List_Oracle.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "DEV", + "volumesCount": 12 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..5f0e5dd39f6c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeGroups_List_SapHana.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..c36f6ef63a15 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Create.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2023-11-01-preview", + "body": { + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Creating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..ae6f2240190b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..818f764e1ffc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..0c2ea5e019b4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..03f60b863bc5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/VolumeQuotaRules_Update.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2023-11-01-preview", + "body": { + "properties": { + "quotaSizeInKiBs": 100009 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "provisioningState": "Patching", + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..33a3b80eab71 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_AuthorizeReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "remoteVolumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRemoteRG/providers/Microsoft.NetApp/netAppAccounts/remoteAccount1/capacityPools/remotePool1/volumes/remoteVolume1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..142e613b7f31 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_BreakFileLocks.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "clientIp": "101.102.103.104", + "confirmRunningDisruptiveOperation": true + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..f2106777c25d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_BreakReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "forceBreakReplication": false + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_CreateOnPremMigrationReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_CreateOnPremMigrationReplication.json new file mode 100644 index 000000000000..b8dba434f115 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_CreateOnPremMigrationReplication.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "svmPeeringCommand": "vserver peer accept -vserver OnPremSvm -peer-vserver AnfSvm" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..2bdc43a269c6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": { + "creationToken": "my-unique-file-path", + "serviceLevel": "Premium", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Delete.json new file mode 100644 index 000000000000..973de7dbc946 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..3f60674abbf8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_DeleteReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_FinalizeOnPremMigration.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_FinalizeOnPremMigration.json new file mode 100644 index 000000000000..d4875bfdbe9f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_FinalizeOnPremMigration.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..c84fecf1940c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_FinalizeRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-011-11&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Get.json new file mode 100644 index 000000000000..3a3da807f057 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_LatestBackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_LatestBackupStatus.json new file mode 100644 index 000000000000..2cb8d377c4cb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_LatestBackupStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "unhealthyReason": "", + "errorMessage": "", + "lastTransferSize": 100000, + "lastTransferType": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_LatestRestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_LatestRestoreStatus.json new file mode 100644 index 000000000000..9788e1e4538e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_LatestRestoreStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Uninitialized", + "unhealthyReason": "", + "errorMessage": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_List.json new file mode 100644 index 000000000000..bb027f018ff1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..e852834d66de --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ListReplications.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "replicationSchedule": "daily", + "remoteVolumeResourceId": "/subscriptions/36e85c76-e720-473e-881f-e2fe72f462d0/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-5999/capacityPools/pool-0977/volumes/volume-4508", + "remoteVolumeRegion": "westus" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PeerClusterForOnPremMigration.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PeerClusterForOnPremMigration.json new file mode 100644 index 000000000000..09ab6ace654a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PeerClusterForOnPremMigration.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "peerAddresses": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ] + } + }, + "responses": { + "200": { + "body": { + "peerAcceptCommand": "cluster peer create -ipspace replication -encryption-protocol-proposed tls-psk -passphrase passphraseString -peer-addrs 1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4,1.1.1.5,1.1.1.6" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PerformReplicationTransfer.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PerformReplicationTransfer.json new file mode 100644 index 000000000000..f5077c2f6175 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PerformReplicationTransfer.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..f1b5c2a05e2f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PoolChange.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "newPoolResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..8eb301bbaaa5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_PopulateAvailabilityZones.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..3f60674abbf8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReInitializeReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..4d7739367096 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReestablishReplication.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "sourceVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/mySourceRG/providers/Microsoft.NetApp/netAppAccounts/sourceAccount1/capacityPools/sourcePool1/volumes/sourceVolume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..83337f8d8fb6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Relocate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..1399d6a0fec3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ReplicationStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "totalProgress": "1048576", + "errorMessage": "" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..f5077c2f6175 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ResetCifsPassword.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..3f60674abbf8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_ResyncReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Revert.json new file mode 100644 index 000000000000..57c2b8edc991 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Revert.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "snapshotId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..3f60674abbf8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_RevertRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_SplitClone.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_SplitClone.json new file mode 100644 index 000000000000..d4875bfdbe9f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_SplitClone.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Update.json new file mode 100644 index 000000000000..050512eca205 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/examples/Volumes_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-11-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2", + "dataProtection": { + "snapshot": { + "snapshotPolicyId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2023-11-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/netapp.json new file mode 100644 index 000000000000..64317bb0eed1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-11-01-preview/netapp.json @@ -0,0 +1,10459 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2023-11-01-preview", + "x-ms-code-generation-settings": { + "name": "AzureNetAppFilesManagementClient" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "host": "management.azure.com", + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.NetApp/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Describes the Resource Provider", + "description": "Lists all of the available Microsoft.NetApp Rest API operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationList": { + "$ref": "examples/OperationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check resource name availability", + "description": "Check if a resource name is available.", + "operationId": "NetAppResource_CheckNameAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check file path availability", + "description": "Check if a file path is available.", + "operationId": "NetAppResource_CheckFilePathAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "File path availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/FilePathAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckFilePathAvailability": { + "$ref": "examples/CheckFilePathAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check quota availability", + "description": "Check if a quota is available.", + "operationId": "NetAppResource_CheckQuotaAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Quota availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "examples/CheckQuotaAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current limits for quotas", + "operationId": "NetAppResourceQuotaLimits_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current subscription quota limit", + "operationId": "NetAppResourceQuotaLimits_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaLimitName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResource_QueryRegionInfo", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfo_Query": { + "$ref": "examples/RegionInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides region specific information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfosList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_List": { + "$ref": "examples/RegionInfos_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_Get": { + "$ref": "examples/RegionInfos_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Describe a network sibling set", + "description": "Get details of the specified network sibling set.", + "operationId": "NetAppResource_QueryNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Network sibling set to query.", + "required": true, + "schema": { + "$ref": "#/definitions/QueryNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkSiblingSet_Query": { + "$ref": "examples/NetworkSiblingSet_Query.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Update the network features of a network sibling set", + "description": "Update the network features of the specified network sibling set.", + "operationId": "NetAppResource_UpdateNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Update for the specified network sibling set.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkFeatures_Update": { + "$ref": "examples/NetworkSiblingSet_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a subscription", + "description": "List and describe all NetApp accounts in the subscription.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a resource group", + "description": "List and describe all NetApp accounts in the resource group.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { + "get": { + "summary": "Describe a NetApp Account", + "description": "Get the NetApp account", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "summary": "Create or update a NetApp account", + "description": "Create or update the specified NetApp account within the resource group", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "201": { + "description": "Account created", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "examples/Accounts_CreateOrUpdate.json" + }, + "Accounts_CreateOrUpdateWithActiveDirectory": { + "$ref": "examples/Accounts_CreateOrUpdateAD.json" + } + } + }, + "delete": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Delete", + "summary": "Delete a NetApp account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "Delete the specified NetApp account", + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "examples/Accounts_Delete.json" + } + } + }, + "patch": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Update", + "summary": "Update a NetApp account", + "description": "Patch the specified NetApp account", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccountPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "examples/Accounts_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_RenewCredentials", + "summary": "Renew identity credentials", + "description": "Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_RenewCredentials": { + "$ref": "examples/Accounts_RenewCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateEncryption": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_MigrateEncryptionKey", + "summary": "Migrate volumes encryption key source.", + "description": "Migrates all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "The required parameters to perform encryption migration.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/encryptionMigrationRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_MigrateEncryptionKey": { + "$ref": "examples/Accounts_MigrateEncryptionKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/getKeyVaultStatus": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_GetChangeKeyVaultInformation", + "summary": "Get information about how volumes under NetApp account are encrypted.", + "description": "Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_GetChangeKeyVaultInformation": { + "$ref": "examples/Accounts_GetChangeKeyVaultInformation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/changeKeyVault": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ChangeKeyVault", + "summary": "Change Key Vault/Managed HSM that is used for encryption of volumes under NetApp account.", + "description": "Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports MHSM to Key Vault, Key Vault to MHSM, MHSM to MHSM and Key Vault to Key Vault.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "The required parameters to perform encryption migration.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/changeKeyVault" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_ChangeKeyVault": { + "$ref": "examples/Accounts_ChangeKeyVault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { + "get": { + "summary": "Describe all Capacity Pools", + "description": "List all capacity pools in the NetApp Account", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_List": { + "$ref": "examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { + "get": { + "summary": "Describe a Capacity Pool", + "description": "Get details of the specified capacity pool", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "examples/Pools_Get.json" + } + } + }, + "put": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_CreateOrUpdate", + "summary": "Create or Update the specified capacity pool within the resource group", + "description": "Create or Update a capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - pool updated", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "201": { + "description": "Pool created", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "examples/Pools_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Update", + "summary": "Update a capacity pool", + "description": "Patch the specified capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPoolPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "examples/Pools_Update.json" + } + } + }, + "delete": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Delete", + "summary": "Delete a capacity pool", + "description": "Delete the specified capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { + "get": { + "summary": "Describe all volumes", + "description": "List all volumes within the capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volumes" + ], + "operationId": "Volumes_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_List": { + "$ref": "examples/Volumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { + "get": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Get", + "summary": "Describe a volume", + "description": "Get the details of the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get": { + "$ref": "examples/Volumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_CreateOrUpdate", + "summary": "Create or Update a volume", + "description": "Create or update the specified volume within the capacity pool", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volume" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - volume updated", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "201": { + "description": "Volume created", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Volumes_CreateOrUpdate": { + "$ref": "examples/Volumes_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Update", + "summary": "Update a volume", + "description": "Patch the specified volume", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update": { + "$ref": "examples/Volumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Delete", + "summary": "Delete a volume", + "description": "Delete the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "in": "query", + "name": "forceDelete", + "type": "boolean", + "description": "An option to force delete the volume. Will cleanup resources connected to the particular volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete": { + "$ref": "examples/Volumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone": { + "post": { + "tags": [ + "Volumes" + ], + "summary": "Populate Availability Zone", + "description": "This operation will populate availability zone information for a volume", + "operationId": "Volumes_PopulateAvailabilityZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- populate availability zone accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PopulateAvailabilityZones": { + "$ref": "examples/Volumes_PopulateAvailabilityZones.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revert": { + "post": { + "tags": [ + "Volumes Revert" + ], + "summary": "Revert a volume to one of its snapshots", + "description": "Revert a volume to the snapshot specified in the body", + "operationId": "Volumes_Revert", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Object for snapshot to revert supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeRevert" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Revert": { + "$ref": "examples/Volumes_Revert.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resetCifsPassword": { + "post": { + "tags": [ + "Reset Cifs Password" + ], + "summary": "Reset cifs password", + "description": "Reset cifs password from volume", + "operationId": "Volumes_ResetCifsPassword", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_ResetCifsPassword": { + "$ref": "examples/Volumes_ResetCifsPassword.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/splitCloneFromParent": { + "post": { + "tags": [ + "Split clone volume" + ], + "summary": "Split clone from parent volume", + "description": " Split operation to convert clone volume to an independent volume.", + "operationId": "Volumes_SplitCloneFromParent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_SplitClone": { + "$ref": "examples/Volumes_SplitClone.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks": { + "post": { + "tags": [ + "File Locks" + ], + "summary": "Break file locks", + "description": "Break all the file locks on a volume", + "operationId": "Volumes_BreakFileLocks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to provide the ability to clear file locks with selected options", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakFileLocksRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakFileLocks": { + "$ref": "examples/Volumes_BreakFileLocks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser": { + "post": { + "tags": [ + "Group Id List for LDAP User" + ], + "summary": " Get Group Id List for LDAP User", + "description": "Returns the list of group Ids for a specific LDAP User", + "operationId": "Volumes_ListGetGroupIdListForLdapUser", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Returns group Id list for a specific LDAP user", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "GetGroupIdListForUser": { + "$ref": "examples/GroupIdListForLDAPUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Break volume replication", + "description": "Break the replication connection on the destination volume", + "operationId": "Volumes_BreakReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to force break the replication.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakReplicationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakReplication": { + "$ref": "examples/Volumes_BreakReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Re-establish volume replication", + "description": "Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots", + "operationId": "Volumes_ReestablishReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "body for the id of the source volume.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/reestablishReplicationRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReestablishReplication": { + "$ref": "examples/Volumes_ReestablishReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus": { + "get": { + "tags": [ + "Volumes Replication" + ], + "summary": "Get volume replication status", + "description": "Get the status of the replication", + "operationId": "Volumes_ReplicationStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/replicationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ReplicationStatus": { + "$ref": "examples/Volumes_ReplicationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "List replications for volume", + "description": "List all replications for a specified volume", + "operationId": "Volumes_ListReplications", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/listReplications" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ListReplications": { + "$ref": "examples/Volumes_ListReplications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Resync volume replication", + "description": "Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.", + "operationId": "Volumes_ResyncReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ResyncReplication": { + "$ref": "examples/Volumes_ResyncReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Delete volume replication", + "description": "Delete the replication connection on the destination volume, and send release to the source replication", + "operationId": "Volumes_DeleteReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_DeleteReplication": { + "$ref": "examples/Volumes_DeleteReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Authorize source volume replication", + "description": "Authorize the replication connection on the source volume", + "operationId": "Volumes_AuthorizeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Authorize request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/authorizeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_AuthorizeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "ReInitialize volume replication", + "description": "Re-Initializes the replication connection on the destination volume", + "operationId": "Volumes_ReInitializeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReInitializeReplication": { + "$ref": "examples/Volumes_ReInitializeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/peerClusterForOnPremMigration": { + "post": { + "summary": "Start Cluster peering", + "description": "Starts peering the cluster for this migration volume", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_PeerClusterForOnPremMigration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Cluster peer request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/peerClusterForVolumeMigrationRequest" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/clusterPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_PeerClusterForOnPremMigration": { + "$ref": "examples/Volumes_PeerClusterForOnPremMigration.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/clusterPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/createOnPremMigrationReplication": { + "post": { + "summary": "Start migration process", + "description": "Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVMs have been peered a SnapMirror will be created", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_CreateOnPremMigrationReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/svmPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_CreateOnPremMigrationReplication": { + "$ref": "examples/Volumes_CreateOnPremMigrationReplication.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/svmPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeOnPremMigration": { + "post": { + "summary": "Finalize migration process", + "description": "Finalizes the migration of a volume by performing a final sync on the replication, breaking and releasing the replication, and breaking the cluster peering if no other migration is active.", + "tags": [ + "Volumes OnPrem Migration Finalize" + ], + "operationId": "Volumes_FinalizeOnPremMigration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_FinalizeOnPremMigration": { + "$ref": "examples/Volumes_FinalizeOnPremMigration.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/performReplicationTransfer": { + "post": { + "tags": [ + "Volumes OnPrem Migration" + ], + "summary": "Perform a replication transfer", + "description": "Performs an adhoc replication transfer on a volume with volumeType Migration", + "operationId": "Volumes_PerformReplicationTransfer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PerformReplicationTransfer": { + "$ref": "examples/Volumes_PerformReplicationTransfer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/poolChange": { + "post": { + "tags": [ + "Pool Change" + ], + "summary": "Change pool for volume", + "description": "Moves volume to another pool", + "operationId": "Volumes_PoolChange", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Move volume to the pool supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/poolChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_PoolChange.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/relocate": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Relocate volume", + "description": "Relocates volume to a new stamp", + "operationId": "Volumes_Relocate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Relocate volume request", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/relocateVolumeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_Relocate": { + "$ref": "examples/Volumes_Relocate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Finalize volume relocation", + "description": "Finalizes the relocation of the volume and cleans up the old volume.", + "operationId": "Volumes_FinalizeRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_FinalizeRelocation": { + "$ref": "examples/Volumes_FinalizeRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revertRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Revert volume relocation", + "description": "Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.", + "operationId": "Volumes_RevertRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_RevertRelocation": { + "$ref": "examples/Volumes_RevertRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Describe all snapshots", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all snapshots associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_List": { + "$ref": "examples/Snapshots_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Describe a snapshot", + "description": "Get details of the specified snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_Get": { + "$ref": "examples/Snapshots_Get.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Create", + "summary": "Create a snapshot", + "description": "Create the specified snapshot within the given volume", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Snapshot created", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Create": { + "$ref": "examples/Snapshots_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "summary": "Update a snapshot", + "description": "Patch a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Update": { + "$ref": "examples/Snapshots_Update.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Delete a snapshot", + "description": "Delete snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Delete": { + "$ref": "examples/Snapshots_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RestoreFiles", + "summary": "Create a new Snapshot Restore Files request", + "description": "Restore the specified files from the specified snapshot to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_SingleFileRestore": { + "$ref": "examples/Snapshots_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies": { + "get": { + "operationId": "SnapshotPolicies_List", + "description": "List snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_List": { + "$ref": "examples/SnapshotPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}": { + "get": { + "operationId": "SnapshotPolicies_Get", + "description": "Get a snapshot Policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_Get": { + "$ref": "examples/SnapshotPolicies_Get.json" + } + } + }, + "put": { + "operationId": "SnapshotPolicies_Create", + "description": "Create a snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - snapshot Policy updated", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "201": { + "description": "Snapshot Policy created", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "SnapshotPolicies_Create": { + "$ref": "examples/SnapshotPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Update", + "description": "Patch a snapshot policy", + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicyPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Update": { + "$ref": "examples/SnapshotPolicies_Update.json" + } + } + }, + "delete": { + "operationId": "SnapshotPolicies_Delete", + "description": "Delete snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Delete": { + "$ref": "examples/SnapshotPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes": { + "get": { + "tags": [ + "Snapshot Policy List Volumes" + ], + "summary": "Get volumes for snapshot policy", + "description": "Get volumes associated with snapshot policy", + "operationId": "SnapshotPolicies_ListVolumes", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicyVolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_ListVolumes": { + "$ref": "examples/SnapshotPolicies_ListVolumes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "List backup policies", + "description": "List backup policies for Netapp Account", + "operationId": "BackupPolicies_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupPolicies_List": { + "$ref": "examples/BackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "Get a backup Policy", + "description": "Get a particular backup Policy", + "operationId": "BackupPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_Get": { + "$ref": "examples/BackupPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Policy" + ], + "summary": "Create a backup policy", + "description": "Create a backup policy for Netapp Account", + "operationId": "BackupPolicies_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicy" + } + } + ], + "responses": { + "200": { + "description": "Backup Policy created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Create": { + "$ref": "examples/BackupPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backup Policy" + ], + "summary": "Patch a backup policy", + "description": "Patch a backup policy for Netapp Account", + "operationId": "BackupPolicies_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicyPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Update": { + "$ref": "examples/BackupPolicies_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backup Policy" + ], + "summary": "Delete a backup policy", + "description": "Delete backup policy", + "operationId": "BackupPolicies_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupPolicies_Delete": { + "$ref": "examples/BackupPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_ListByVolume", + "summary": "Get all quota rules for a volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all quota rules associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_List": { + "$ref": "examples/VolumeQuotaRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Get", + "summary": "Describe a quota rule", + "description": "Get details of the specified quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_Get": { + "$ref": "examples/VolumeQuotaRules_Get.json" + } + } + }, + "put": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Create", + "summary": "Create a quota rule", + "description": "Create the specified quota rule within the given volume", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - VolumeQuotaRule updated", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "201": { + "description": "Quota rule Created", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Create": { + "$ref": "examples/VolumeQuotaRules_Create.json" + } + } + }, + "patch": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Update", + "summary": "Update a quota rule", + "description": "Patch a quota rule", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRulePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Update": { + "$ref": "examples/VolumeQuotaRules_Update.json" + } + } + }, + "delete": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Delete", + "summary": "Delete a quota rule", + "description": "Delete quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Delete": { + "$ref": "examples/VolumeQuotaRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups": { + "get": { + "summary": "Describe all volume groups", + "description": "List all volume groups for given account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_ListByNetAppAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_List_SapHana": { + "$ref": "examples/VolumeGroups_List_SapHana.json" + }, + "VolumeGroups_List_Oracle": { + "$ref": "examples/VolumeGroups_List_Oracle.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}": { + "get": { + "summary": "Describe a Volume Group", + "description": "Get details of the specified volume group", + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_SapHana": { + "$ref": "examples/VolumeGroups_Get_SapHana.json" + }, + "VolumeGroups_Get_Oracle": { + "$ref": "examples/VolumeGroups_Get_Oracle.json" + } + } + }, + "put": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Create", + "summary": "Create the specified volume group and volumes. Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter.", + "description": "Create a volume group along with specified volumes", + "parameters": [ + { + "name": "body", + "description": "Volume Group object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Volume group created", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Create_SapHana": { + "$ref": "examples/VolumeGroups_Create_SapHana.json" + }, + "VolumeGroups_Create_Oracle": { + "$ref": "examples/VolumeGroups_Create_Oracle.json" + } + } + }, + "delete": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Delete", + "summary": "Delete a volume group", + "description": "Delete the specified volume group only if there are no volumes under volume group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Delete": { + "$ref": "examples/VolumeGroups_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes": { + "get": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_ListByVolume", + "summary": "List of all the subvolumes", + "description": "Returns a list of the subvolumes in the volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_List": { + "$ref": "examples/Subvolumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}": { + "get": { + "tags": [ + "Subvolumes" + ], + "summary": "Get the path associated with the subvolumeName", + "description": "Returns the path associated with the subvolumeName provided", + "operationId": "Subvolumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_Get": { + "$ref": "examples/Subvolumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Subvolumes" + ], + "summary": "Create or clone a new subvolume", + "description": "Creates a subvolume in the path or clones the subvolume mentioned in the parentPath", + "operationId": "Subvolumes_Create", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - updated", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "201": { + "description": "Subvolume created", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Create": { + "$ref": "examples/Subvolumes_Create.json" + } + } + }, + "patch": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Update", + "summary": "Update a subvolume", + "description": "Patch a subvolume", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumePatchRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/subvolumeInfo" + }, + "description": "OK" + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Update": { + "$ref": "examples/Subvolumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Delete", + "summary": "Delete a subvolume", + "description": "Delete subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Delete": { + "$ref": "examples/Subvolumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata": { + "post": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_GetMetadata", + "summary": "Describe a subvolume", + "description": "Get details of the specified subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeModel" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Metadata": { + "$ref": "examples/Subvolumes_Metadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get the latest backup status of a volume", + "description": "Get the latest status of the backup for a volume", + "operationId": "Backups_GetLatestStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_BackupStatus": { + "$ref": "examples/Volumes_LatestBackupStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current": { + "get": { + "tags": [ + "Restore" + ], + "summary": "Get the latest restore status of a volume", + "description": "Get the latest status of the restore for a volume", + "operationId": "Backups_GetVolumeLatestRestoreStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/restoreStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_RestoreStatus": { + "$ref": "examples/Volumes_LatestRestoreStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "summary": "List Backups", + "description": "List all backups Under a Backup Vault", + "operationId": "Backups_ListByVault", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "in": "query", + "name": "$filter", + "type": "string", + "description": "An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_List": { + "$ref": "examples/BackupsUnderBackupVault_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}": { + "get": { + "summary": "Describe the Backup under Backup Vault", + "description": "Get the specified Backup under Backup Vault.", + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Get": { + "$ref": "examples/BackupsUnderBackupVault_Get.json" + } + } + }, + "put": { + "tags": [ + "Backups" + ], + "summary": "Create a backup", + "description": "Create a backup under the Backup Vault", + "operationId": "Backups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backup" + } + } + ], + "responses": { + "200": { + "description": "OK - backup created updated", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Create": { + "$ref": "examples/BackupsUnderBackupVault_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backups" + ], + "summary": "Patch a backup", + "description": "Patch a Backup under the Backup Vault", + "operationId": "Backups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "schema": { + "$ref": "#/definitions/backupPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backup" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Update": { + "$ref": "examples/BackupsUnderBackupVault_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backups" + ], + "summary": "Delete backup", + "description": "Delete a Backup under the Backup Vault", + "operationId": "Backups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Delete": { + "$ref": "examples/BackupsUnderBackupVault_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults": { + "get": { + "summary": "Describe all Backup Vaults", + "description": "List and describe all Backup Vaults in the NetApp account.", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_ListByNetAppAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVaultsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_List": { + "$ref": "examples/BackupVaults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}": { + "get": { + "summary": "Describe the Backup Vault", + "description": "Get the Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_Get": { + "$ref": "examples/BackupVaults_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Vaults" + ], + "summary": "Create or Update a Backup Vault", + "description": "Create or update the specified Backup Vault in the NetApp account", + "operationId": "BackupVaults_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "BackupVault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVault" + } + } + ], + "responses": { + "200": { + "description": "OK - backupVault updated", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "201": { + "description": "backupVault created", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupVault_CreateOrUpdate": { + "$ref": "examples/BackupVaults_Create.json" + } + } + }, + "patch": { + "summary": "Update NetApp Backup Vault", + "description": "Patch the specified NetApp Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup Vault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVaultPatch" + } + } + ], + "responses": { + "200": { + "description": "OK - Backup Vault updated.", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/backupVault" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Update": { + "$ref": "examples/BackupVaults_Update.json" + } + } + }, + "delete": { + "summary": "Delete NetApp Backup Vault", + "description": "Delete the specified Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Delete": { + "$ref": "examples/BackupVaults_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderBackupVault_RestoreFiles", + "summary": "Create a new Backup Restore Files request", + "description": "Restore the specified files from the specified backup to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Backups_SingleFileRestore": { + "$ref": "examples/BackupsUnderBackupVault_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderVolume_MigrateBackups", + "summary": "Create a new migrate request for backups under volume", + "description": "Migrate the backups under volume to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under volume payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderVolume_Migrate": { + "$ref": "examples/BackupsUnderVolume_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderAccount_MigrateBackups", + "summary": "Create a new migrate request for backups under account", + "description": "Migrate the backups under a NetApp account to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under an account payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderAccount_Migrate": { + "$ref": "examples/BackupsUnderAccount_Migrate.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Microsoft.NetApp REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft NetApp.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "description": "Log specification of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Average" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "boolean" + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + }, + "isInternal": { + "description": "Whether the metric is internal.", + "type": "boolean" + } + } + }, + "LogSpecification": { + "description": "Log Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "description": "Name of log specification.", + "type": "string" + }, + "displayName": { + "description": "Display name of log specification.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "CheckAvailabilityResponse": { + "description": "Information regarding availability of a resource.", + "type": "object", + "properties": { + "isAvailable": { + "description": "true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "InAvailabilityReasonType", + "modelAsString": true + } + }, + "message": { + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.", + "type": "string" + } + } + }, + "regionInfosList": { + "description": "List of regionInfo resources", + "type": "object", + "properties": { + "value": { + "description": "A list of regionInfo resources", + "type": "array", + "items": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "regionInfoResource": { + "description": "Information regarding regionInfo Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "regionInfo properties", + "$ref": "#/definitions/regionInfo", + "x-ms-client-flatten": true + } + } + }, + "regionInfo": { + "description": "Provides region specific information.", + "type": "object", + "properties": { + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information in the region.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2", + "T1AndT2", + "T1AndAcrossT2", + "T2AndAcrossT2", + "T1AndT2AndAcrossT2" + ], + "x-ms-enum": { + "name": "RegionStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 network connectivity." + }, + { + "value": "T1AndT2", + "description": "Standard T1 and T2 network connectivity." + }, + { + "value": "T1AndAcrossT2", + "description": "Standard T1 and AcrossT2 network connectivity." + }, + { + "value": "T2AndAcrossT2", + "description": "Standard T2 and AcrossT2 network connectivity." + }, + { + "value": "T1AndT2AndAcrossT2", + "description": "Standard T1, T2 and AcrossT2 network connectivity." + } + ] + }, + "example": "T2" + }, + "availabilityZoneMappings": { + "title": "Logical availability zone mappings.", + "description": "Provides logical availability zone mappings for the subscription for a region.", + "type": "array", + "x-ms-identifiers": [ + "availabilityZone" + ], + "items": { + "type": "object", + "properties": { + "availabilityZone": { + "description": "Logical availability zone.", + "type": "string", + "example": "1" + }, + "isAvailable": { + "description": "Available availability zone", + "type": "boolean", + "example": true + } + } + } + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "FilePathAvailabilityRequest": { + "description": "File path availability request content - availability is based on the name and the subnetId.", + "required": [ + "name", + "subnetId" + ], + "type": "object", + "properties": { + "name": { + "description": "File path to verify.", + "type": "string" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "availabilityZone": { + "title": "Logical availability zone", + "type": "string", + "example": "1", + "x-nullable": true, + "description": "The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed." + } + } + }, + "QuotaAvailabilityRequest": { + "description": "Quota availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the resource to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckQuotaNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "SubscriptionQuotaItemList": { + "description": "List of Subscription Quota Items", + "type": "object", + "properties": { + "value": { + "description": "A list of SubscriptionQuotaItems", + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + } + } + }, + "SubscriptionQuotaItem": { + "description": "Information regarding Subscription Quota Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SubscriptionQuotaItem properties", + "$ref": "#/definitions/SubscriptionQuotaItemProperties", + "x-ms-client-flatten": true + } + } + }, + "SubscriptionQuotaItemProperties": { + "description": "SubscriptionQuotaItem Properties", + "type": "object", + "properties": { + "current": { + "description": "The current quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "default": { + "description": "The default quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "netAppAccountList": { + "description": "List of NetApp account resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Multiple NetApp accounts", + "items": { + "$ref": "#/definitions/netAppAccount" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "netAppAccount": { + "description": "NetApp account resource", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "netAppAccountPatch": { + "description": "NetApp account patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "accountProperties": { + "description": "NetApp account properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "activeDirectories": { + "description": "Active Directories", + "type": "array", + "items": { + "$ref": "#/definitions/activeDirectory" + }, + "x-ms-identifiers": [ + "activeDirectoryId" + ] + }, + "encryption": { + "description": "Encryption settings", + "$ref": "#/definitions/accountEncryption" + }, + "disableShowmount": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "Shows the status of disableShowmount for all volumes under the subscription, null equals false" + }, + "nfsV4IDDomain": { + "type": "string", + "description": "Domain for NFSv4 user ID mapping. This property will be set for all NetApp accounts in the subscription and region and only affect non ldap NFSv4 volumes.", + "maxLength": 255, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9.-]{0,253}[a-zA-Z0-9]$", + "x-nullable": true, + "example": "defaultv4IDDomain.com" + }, + "isMultiAdEnabled": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "This will have true value only if account is Multiple AD enabled." + } + } + }, + "activeDirectory": { + "description": "Active Directory", + "type": "object", + "properties": { + "activeDirectoryId": { + "type": "string", + "x-nullable": true, + "description": "Id of the Active Directory" + }, + "username": { + "type": "string", + "description": "A domain user account with permission to create machine accounts" + }, + "password": { + "type": "string", + "x-ms-secret": true, + "maxLength": 64, + "description": "Plain text password of Active Directory domain administrator, value is masked in the response" + }, + "domain": { + "type": "string", + "description": "Name of the Active Directory domain" + }, + "dns": { + "type": "string", + "description": "Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "example": "101.102.103.104,101.102.103.105" + }, + "status": { + "type": "string", + "description": "Status of the Active Directory", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "ActiveDirectoryStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "Active Directory created but not in use" + }, + { + "value": "InUse", + "description": "Active Directory in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "Active Directory Deleted" + }, + { + "value": "Error", + "description": "Error with the Active Directory" + }, + { + "value": "Updating", + "description": "Active Directory Updating" + } + ] + } + }, + "statusDetails": { + "type": "string", + "description": "Any details in regards to the Status of the Active Directory", + "readOnly": true + }, + "smbServerName": { + "type": "string", + "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes" + }, + "organizationalUnit": { + "type": "string", + "default": "CN=Computers", + "description": "The Organizational Unit (OU) within the Windows Active Directory" + }, + "site": { + "type": "string", + "description": "The Active Directory site the service will limit Domain Controller discovery to" + }, + "backupOperators": { + "description": "Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "administrators": { + "description": "Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "kdcIP": { + "type": "string", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "description": "kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.", + "example": "101.102.103.104" + }, + "adName": { + "type": "string", + "maxLength": 64, + "minLength": 1, + "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", + "example": "ADServerName" + }, + "serverRootCACertificate": { + "type": "string", + "maxLength": 10240, + "minLength": 1, + "description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.", + "x-ms-secret": true, + "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" + }, + "aesEncryption": { + "type": "boolean", + "description": "If enabled, AES encryption will be enabled for SMB communication." + }, + "ldapSigning": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be signed." + }, + "securityOperators": { + "type": "array", + "description": "Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "ldapOverTLS": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be secured via TLS." + }, + "allowLocalNfsUsersWithLdap": { + "type": "boolean", + "description": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes." + }, + "encryptDCConnections": { + "type": "boolean", + "description": "If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted." + }, + "ldapSearchScope": { + "description": "LDAP Search scope options", + "$ref": "#/definitions/ldapSearchScopeOpt" + }, + "preferredServersForLdapClient": { + "type": "string", + "maxLength": 32, + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))?)?$", + "description": "Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.", + "example": "101.102.103.104, 101.102.103.105" + } + } + }, + "ldapSearchScopeOpt": { + "type": "object", + "description": "LDAP search scope ", + "properties": { + "userDN": { + "type": "string", + "description": "This specifies the user DN, which overrides the base DN for user lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupDN": { + "type": "string", + "description": "This specifies the group DN, which overrides the base DN for group lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupMembershipFilter": { + "type": "string", + "description": "This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.", + "maxLength": 255, + "example": "cn=*99" + } + } + }, + "accountEncryption": { + "type": "object", + "description": "Encryption settings", + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'." + }, + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'." + } + } + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "type": "object", + "required": [ + "keyVaultUri", + "keyName", + "keyVaultResourceId" + ], + "properties": { + "keyVaultId": { + "type": "string", + "description": "UUID v4 used to identify the Azure Key Vault configuration", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVaultResourceId": { + "type": "string", + "description": "The resource ID of KeyVault." + }, + "status": { + "type": "string", + "description": "Status of the KeyVault connection.", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "KeyVaultStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "KeyVault connection created but not in use" + }, + { + "value": "InUse", + "description": "KeyVault connection in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "KeyVault connection Deleted" + }, + { + "value": "Error", + "description": "Error with the KeyVault connection" + }, + { + "value": "Updating", + "description": "KeyVault connection Updating" + } + ] + } + } + } + }, + "EncryptionIdentity": { + "description": "Identity used to authenticate with key vault.", + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.", + "readOnly": true + }, + "userAssignedIdentity": { + "type": "string", + "description": "The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities." + } + } + }, + "capacityPoolList": { + "description": "List of capacity pool resources", + "type": "object", + "properties": { + "value": { + "description": "List of Capacity pools", + "type": "array", + "items": { + "$ref": "#/definitions/capacityPool" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "capacityPool": { + "description": "Capacity pool resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolProperties", + "x-ms-client-flatten": true + } + } + }, + "poolProperties": { + "description": "Pool properties", + "type": "object", + "required": [ + "size", + "serviceLevel" + ], + "properties": { + "poolId": { + "title": "poolId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Pool", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 1099511627776).", + "default": 4398046511104 + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "totalThroughputMibps": { + "type": "number", + "description": "Total throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "utilizedThroughputMibps": { + "type": "number", + "description": "Utilized throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "default": false, + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + }, + "encryptionType": { + "title": "encryptionType", + "type": "string", + "x-nullable": true, + "description": "Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Single", + "Double" + ], + "x-ms-enum": { + "name": "encryptionType", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "EncryptionType Single, volumes will use single encryption at rest" + }, + { + "value": "Double", + "description": "EncryptionType Double, volumes will use double encryption at rest" + } + ] + }, + "example": "Single", + "default": "Single" + } + } + }, + "capacityPoolPatch": { + "description": "Capacity pool patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "poolPatchProperties": { + "description": "Patchable pool properties", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 4398046511104).", + "default": 4398046511104 + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + } + } + }, + "volumeList": { + "description": "List of volume resources", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "volume": { + "description": "Volume resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "resourceIdentity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "description": "Object id of the identity resource", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of Identity. Supported values are: 'None', 'SystemAssigned'", + "type": "string" + } + } + }, + "resourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource" + }, + "volumeProperties": { + "description": "Volume properties", + "type": "object", + "required": [ + "creationToken", + "usageThreshold", + "subnetId" + ], + "properties": { + "fileSystemId": { + "title": "FileSystem ID", + "type": "string", + "readOnly": true, + "description": "Unique FileSystem Identifier.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "creationToken": { + "title": "Creation Token or File Path", + "type": "string", + "description": "A unique file path for the volume. Used when creating mount targets", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,79}$", + "minLength": 1, + "maxLength": 80, + "example": "some-amazing-filepath" + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.", + "minimum": 107374182400, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "snapshotId": { + "title": "Snapshot ID", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Snapshot.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + }, + "deleteBaseSnapshot": { + "type": "boolean", + "description": "If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false" + }, + "backupId": { + "title": "Backup ID", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Backup.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1" + }, + "baremetalTenantId": { + "title": "Baremetal Tenant ID", + "type": "string", + "readOnly": true, + "description": "Unique Baremetal Tenant Identifier.", + "example": "9560acf5-4e3a-12e7-9bdb-02007cca7779" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for the the group of volumes sharing networking resources.", + "type": "string", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information for the volume.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2" + ], + "readOnly": true, + "x-ms-enum": { + "name": "VolumeStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic storage to network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 storage to network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 storage to network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 storage to network connectivity." + } + ] + }, + "example": "T1" + }, + "mountTargets": { + "title": "mountTargets", + "type": "array", + "readOnly": true, + "description": "List of mount targets", + "items": { + "$ref": "#/definitions/mountTargetProperties" + }, + "x-ms-identifiers": [ + "fileSystemId" + ] + }, + "volumeType": { + "type": "string", + "description": "What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone", + "example": "DataProtection" + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "replication": { + "title": "Replication", + "description": "Replication properties", + "type": "object", + "$ref": "#/definitions/replicationObject" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + }, + "volumeRelocation": { + "title": "VolumeRelocation", + "description": "VolumeRelocation properties", + "type": "object", + "$ref": "#/definitions/volumeRelocationProperties" + } + } + }, + "acceptGrowCapacityPoolForShortTermCloneSplit": { + "title": "acceptGrowCapacityPoolForShortTermCloneSplit", + "type": "string", + "description": "While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Accepted", + "Declined" + ], + "x-ms-enum": { + "name": "acceptGrowCapacityPoolForShortTermCloneSplit", + "modelAsString": true, + "values": [ + { + "value": "Accepted", + "description": "Auto grow capacity pool for short term clone split is accepted." + }, + { + "value": "Declined", + "description": "Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool." + } + ] + }, + "example": "Accepted" + }, + "isRestoring": { + "type": "boolean", + "description": "Restoring" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "default": true, + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true)." + }, + "kerberosEnabled": { + "type": "boolean", + "description": "Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later", + "x-ms-mutability": [ + "read", + "create" + ], + "example": false, + "default": false + }, + "securityStyle": { + "type": "string", + "description": "The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol", + "default": "unix", + "enum": [ + "ntfs", + "unix" + ], + "x-ms-enum": { + "name": "SecurityStyle", + "modelAsString": true + } + }, + "smbEncryption": { + "type": "boolean", + "description": "Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later", + "example": false, + "default": false + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + }, + "smbContinuouslyAvailable": { + "type": "boolean", + "description": "Enables continuously available share property for smb volume. Only applicable for SMB volume", + "example": false, + "default": false + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "x-nullable": true, + "example": 128.223 + }, + "actualThroughputMibps": { + "type": "number", + "description": "Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel", + "example": 164.221, + "readOnly": true + }, + "encryptionKeySource": { + "description": "Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'", + "type": "string", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultPrivateEndpointResourceId": { + "type": "string", + "description": "The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'." + }, + "ldapEnabled": { + "type": "boolean", + "description": "Specifies whether LDAP is enabled or not for a given NFS volume.", + "example": false, + "default": false + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false, + "default": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "cloneProgress": { + "description": "When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.", + "type": "integer", + "format": "int32", + "example": 10, + "x-nullable": true, + "readOnly": true + }, + "fileAccessLogs": { + "type": "string", + "description": "Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "fileAccessLogs", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "fileAccessLogs are enabled" + }, + { + "value": "Disabled", + "description": "fileAccessLogs are not enabled" + } + ] + }, + "example": "Disabled", + "default": "Disabled" + }, + "avsDataStore": { + "title": "avsDataStore", + "type": "string", + "description": "Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "avsDataStore", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "avsDataStore is enabled" + }, + { + "value": "Disabled", + "description": "avsDataStore is disabled" + } + ] + }, + "example": "Enabled", + "default": "Disabled" + }, + "dataStoreResourceId": { + "title": "dataStoreResourceId", + "description": "Data store resource unique identifier", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "maximumNumberOfFiles": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.", + "example": 100000000 + }, + "volumeGroupName": { + "type": "string", + "description": "Volume Group Name", + "readOnly": true + }, + "capacityPoolResourceId": { + "type": "string", + "description": "Pool Resource Id used in case of creating a volume through volume group" + }, + "proximityPlacementGroup": { + "type": "string", + "description": "Proximity placement group associated with the volume", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.Compute/proximityPlacementGroups/testppg" + }, + "t2Network": { + "type": "string", + "description": "T2 network information", + "example": "Test-T2-Alias", + "readOnly": true + }, + "volumeSpecName": { + "type": "string", + "description": "Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log", + "example": "Data" + }, + "encrypted": { + "type": "boolean", + "description": "Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.", + "readOnly": true + }, + "placementRules": { + "title": "Volume placement rules", + "description": "Application specific placement rules for the particular volume", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "enableSubvolumes": { + "type": "string", + "description": "Flag indicating whether subvolume operations are enabled on the volume", + "example": "Enabled", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "enableSubvolumes", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "subvolumes are enabled" + }, + { + "value": "Disabled", + "description": "subvolumes are not enabled" + } + ] + } + }, + "provisionedAvailabilityZone": { + "title": "Provisioned Availability Zone", + "type": "string", + "readOnly": true, + "description": "The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.", + "example": "2", + "x-nullable": true + }, + "isLargeVolume": { + "title": "Is Large Volume", + "type": "boolean", + "description": "Specifies whether volume is a Large Volume or Regular Volume.", + "example": false, + "default": false + }, + "originatingResourceId": { + "title": "Originating Resource Id", + "type": "string", + "description": "Id of the snapshot or backup that the volume is restored from.", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.NetApp/netAppAccounts/accountOriginatingResourceId/capacityPools/originatingResourceIdPool/volumes/theOriginalVolume/snapshots/theSnapshot", + "readOnly": true, + "x-nullable": true + }, + "inheritedSizeInBytes": { + "title": "inheritedSizeInBytes", + "type": "integer", + "format": "int64", + "description": "Space shared by short term clone volume with parent volume in bytes.", + "readOnly": true, + "x-nullable": true + }, + "language": { + "title": "language", + "$ref": "#/definitions/VolumeLanguage" + } + } + }, + "exportPolicyRule": { + "description": "Volume Export Policy Rule", + "type": "object", + "properties": { + "ruleIndex": { + "type": "integer", + "description": "Order index", + "format": "int32" + }, + "unixReadOnly": { + "type": "boolean", + "description": "Read only access" + }, + "unixReadWrite": { + "type": "boolean", + "description": "Read and write access" + }, + "kerberos5ReadOnly": { + "type": "boolean", + "description": "Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5ReadWrite": { + "type": "boolean", + "description": "Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadOnly": { + "type": "boolean", + "description": "Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadWrite": { + "type": "boolean", + "description": "Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadOnly": { + "type": "boolean", + "description": "Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadWrite": { + "type": "boolean", + "description": "Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "cifs": { + "type": "boolean", + "description": "Allows CIFS protocol" + }, + "nfsv3": { + "type": "boolean", + "description": "Allows NFSv3 protocol. Enable only for NFSv3 type volumes" + }, + "nfsv41": { + "type": "boolean", + "description": "Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes" + }, + "allowedClients": { + "type": "string", + "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names" + }, + "hasRootAccess": { + "type": "boolean", + "description": "Has root access to volume", + "example": true, + "default": true + }, + "chownMode": { + "type": "string", + "description": "This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.", + "default": "Restricted", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "ChownMode", + "modelAsString": true + } + } + } + }, + "replicationObject": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "description": "Id", + "readOnly": true + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume. Required for cross region and cross zone replication", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "$ref": "#/definitions/remotePath", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "required": [ + "externalHostName", + "serverName", + "volumeName" + ], + "properties": { + "externalHostName": { + "type": "string", + "description": "The Path to a ONTAP Host" + }, + "serverName": { + "type": "string", + "description": "The name of a server on the ONTAP Host" + }, + "volumeName": { + "type": "string", + "description": "The name of a volume on the server" + } + } + }, + "replication": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the replication.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "5ee41ce4-8f44-4ecd-ad89-8c1e573fe3b8" + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "volumeRelocationProperties": { + "description": "Volume relocation properties", + "type": "object", + "properties": { + "relocationRequested": { + "type": "boolean", + "description": "Has relocation been requested for this volume" + }, + "readyToBeFinalized": { + "type": "boolean", + "readOnly": true, + "description": "Has relocation finished and is ready to be cleaned up" + } + } + }, + "volumeSnapshotProperties": { + "description": "Volume Snapshot Properties", + "type": "object", + "properties": { + "snapshotPolicyId": { + "type": "string", + "description": "Snapshot Policy ResourceId" + } + } + }, + "replicationStatus": { + "description": "Replication status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "description": "Replication health check" + }, + "relationshipStatus": { + "type": "string", + "description": "Status of the mirror relationship", + "enum": [ + "Idle", + "Transferring" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "description": "The status of the replication", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "totalProgress": { + "type": "string", + "description": "The progress of the replication" + }, + "errorMessage": { + "type": "string", + "description": "Displays error message if the replication is in an error state" + } + } + }, + "listReplications": { + "description": "List Replications", + "type": "object", + "properties": { + "value": { + "description": "A list of replications", + "type": "array", + "items": { + "$ref": "#/definitions/replication" + }, + "x-ms-identifiers": [] + } + } + }, + "volumePatch": { + "description": "Volume patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Patchable volume properties", + "$ref": "#/definitions/volumePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "volumePatchProperties": { + "description": "Patchable volume properties", + "type": "object", + "properties": { + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.", + "minimum": 107374182400, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "example": 128.22 + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + } + } + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots." + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + } + } + }, + "mountTarget": { + "description": "Mount Target", + "type": "object", + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Mount Target Properties", + "$ref": "#/definitions/mountTargetProperties", + "x-ms-client-flatten": true + } + } + }, + "mountTargetProperties": { + "description": "Mount target properties", + "type": "object", + "required": [ + "fileSystemId" + ], + "properties": { + "mountTargetId": { + "title": "mountTargetId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "fileSystemId": { + "title": "fileSystemId", + "type": "string", + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "ipAddress": { + "title": "ipAddress", + "description": "The mount target's IPv4 address", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "smbServerFqdn": { + "title": "smbServerFQDN", + "description": "The SMB server's Fully Qualified Domain Name, FQDN", + "type": "string", + "example": "fullyqualified.domainname.com" + } + } + }, + "snapshotsList": { + "description": "List of Snapshots", + "type": "object", + "properties": { + "value": { + "description": "A list of Snapshots", + "type": "array", + "items": { + "$ref": "#/definitions/snapshot" + } + } + } + }, + "snapshot": { + "description": "Snapshot of a Volume", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "description": "Snapshot Properties", + "$ref": "#/definitions/snapshotProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "properties": {} + }, + "snapshotProperties": { + "description": "Snapshot properties", + "type": "object", + "properties": { + "snapshotId": { + "title": "snapshotId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Snapshot", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "created": { + "title": "name", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the snapshot", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicyProperties": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "hourlySchedule": { + "title": "hourlySchedule", + "description": "Schedule for hourly snapshots", + "type": "object", + "$ref": "#/definitions/hourlySchedule" + }, + "dailySchedule": { + "title": "dailySchedule", + "description": "Schedule for daily snapshots", + "type": "object", + "$ref": "#/definitions/dailySchedule" + }, + "weeklySchedule": { + "title": "weeklySchedule", + "description": "Schedule for weekly snapshots", + "type": "object", + "$ref": "#/definitions/weeklySchedule" + }, + "monthlySchedule": { + "title": "monthlySchedule", + "description": "Schedule for monthly snapshots", + "type": "object", + "$ref": "#/definitions/monthlySchedule" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicy": { + "description": "Snapshot policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPoliciesList": { + "description": "List of Snapshot Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of snapshot policies", + "type": "array", + "items": { + "$ref": "#/definitions/snapshotPolicy" + } + } + } + }, + "snapshotPolicyDetails": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyPatch": { + "description": "Snapshot policy Details for create and update", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot Policy properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyVolumeList": { + "description": "Volumes associated with snapshot policy", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + } + } + }, + "hourlySchedule": { + "description": "Hourly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Hourly snapshot count to keep", + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "dailySchedule": { + "description": "Daily Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Daily snapshot count to keep", + "format": "int32" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "weeklySchedule": { + "description": "Weekly Schedule properties, make a snapshot every week at a specific day or days", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Weekly snapshot count to keep", + "format": "int32" + }, + "day": { + "type": "string", + "description": "Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english", + "example": "Sunday,Monday" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "monthlySchedule": { + "description": "Monthly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Monthly snapshot count to keep", + "format": "int32" + }, + "daysOfMonth": { + "type": "string", + "description": "Indicates which days of the month snapshot should be taken. A comma delimited string.", + "example": "1,11,21" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "volumeRevert": { + "description": "revert a volume to the snapshot", + "type": "object", + "properties": { + "snapshotId": { + "type": "string", + "description": "Resource id of the snapshot" + } + } + }, + "authorizeRequest": { + "description": "Authorize request", + "type": "object", + "properties": { + "remoteVolumeResourceId": { + "type": "string", + "description": "Resource id of the remote volume" + } + } + }, + "breakReplicationRequest": { + "description": "Break replication request", + "type": "object", + "properties": { + "forceBreakReplication": { + "type": "boolean", + "description": "If replication is in status transferring and you want to force break the replication, set to true" + } + } + }, + "reestablishReplicationRequest": { + "description": "Re-establish request object supplied in the body of the operation.", + "type": "object", + "properties": { + "sourceVolumeId": { + "type": "string", + "description": "Resource id of the source volume for the replication" + } + } + }, + "relocateVolumeRequest": { + "description": "Relocate volume request", + "type": "object", + "properties": { + "creationToken": { + "type": "string", + "description": "New creation token for the volume that controls the mount point name" + } + } + }, + "breakFileLocksRequest": { + "description": "Break file locks request", + "type": "object", + "properties": { + "clientIp": { + "type": "string", + "description": "To clear file locks on a volume for a particular client", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "example": "101.102.103.104" + }, + "confirmRunningDisruptiveOperation": { + "type": "boolean", + "description": "Break File locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true.", + "default": false + } + } + }, + "poolChangeRequest": { + "description": "Pool change request", + "type": "object", + "required": [ + "newPoolResourceId" + ], + "properties": { + "newPoolResourceId": { + "type": "string", + "description": "Resource id of the pool to move volume to" + } + } + }, + "backupPolicyProperties": { + "description": "Backup policy properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "readOnly": true, + "description": "Backup Policy Resource ID" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "dailyBackupsToKeep": { + "type": "integer", + "description": "Daily backups count to keep", + "format": "int32" + }, + "weeklyBackupsToKeep": { + "type": "integer", + "description": "Weekly backups count to keep", + "format": "int32" + }, + "monthlyBackupsToKeep": { + "type": "integer", + "description": "Monthly backups count to keep", + "format": "int32" + }, + "volumesAssigned": { + "type": "integer", + "readOnly": true, + "description": "Volumes using current backup policy", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "volumeBackups": { + "description": "A list of volumes assigned to this policy", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/volumeBackups" + }, + "x-ms-identifiers": [ + "volumeName" + ] + } + } + }, + "backupPolicy": { + "description": "Backup policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPoliciesList": { + "description": "List of Backup Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of backup policies", + "type": "array", + "items": { + "$ref": "#/definitions/backupPolicy" + } + } + } + }, + "backupPolicyPatch": { + "description": "Backup policy Details for create and update", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeBackups": { + "description": "Volume details using the backup policy", + "type": "object", + "readOnly": true, + "properties": { + "volumeName": { + "type": "string", + "description": "Volume name" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "backupsCount": { + "type": "integer", + "description": "Total count of backups for volume", + "format": "int32" + }, + "policyEnabled": { + "type": "boolean", + "description": "Policy enabled" + } + } + }, + "restoreStatus": { + "description": "Restore status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Restore health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the restore SnapMirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the restore", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy restore relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the restore is in an error state" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + } + } + }, + "getGroupIdListForLDAPUserRequest": { + "description": "Get group Id list for LDAP User request", + "type": "object", + "required": [ + "username" + ], + "properties": { + "username": { + "type": "string", + "description": "username is required to fetch the group to which user is part of", + "maxLength": 255, + "minLength": 1 + } + } + }, + "getGroupIdListForLDAPUserResponse": { + "description": "Group Id list for Ldap user", + "type": "object", + "properties": { + "groupIdsForLdapUser": { + "description": "Group Id list", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "123", + "224" + ] + } + } + }, + "cloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/cloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "cloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "description": "An error response from the service." + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra", + "StandardZRS" + ], + "default": "Premium", + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + }, + { + "value": "StandardZRS", + "description": "Zone redundant storage service level" + } + ] + } + }, + "VolumeLanguage": { + "title": "VolumeLanguage", + "type": "string", + "x-nullable": true, + "description": "Language supported for volume.", + "enum": [ + "c.utf-8", + "utf8mb4", + "ar", + "ar.utf-8", + "hr", + "hr.utf-8", + "cs", + "cs.utf-8", + "da", + "da.utf-8", + "nl", + "nl.utf-8", + "en", + "en.utf-8", + "fi", + "fi.utf-8", + "fr", + "fr.utf-8", + "de", + "de.utf-8", + "he", + "he.utf-8", + "hu", + "hu.utf-8", + "it", + "it.utf-8", + "ja", + "ja.utf-8", + "ja-v1", + "ja-v1.utf-8", + "ja-jp.pck", + "ja-jp.pck.utf-8", + "ja-jp.932", + "ja-jp.932.utf-8", + "ja-jp.pck-v2", + "ja-jp.pck-v2.utf-8", + "ko", + "ko.utf-8", + "no", + "no.utf-8", + "pl", + "pl.utf-8", + "pt", + "pt.utf-8", + "c", + "ro", + "ro.utf-8", + "ru", + "ru.utf-8", + "zh", + "zh.utf-8", + "zh.gbk", + "zh.gbk.utf-8", + "zh-tw.big5", + "zh-tw.big5.utf-8", + "zh-tw", + "zh-tw.utf-8", + "sk", + "sk.utf-8", + "sl", + "sl.utf-8", + "es", + "es.utf-8", + "sv", + "sv.utf-8", + "tr", + "tr.utf-8", + "en-us", + "en-us.utf-8" + ], + "x-ms-enum": { + "name": "VolumeLanguage", + "modelAsString": true, + "values": [ + { + "value": "c.utf-8", + "description": "Posix with UTF-8" + }, + { + "value": "utf8mb4", + "description": "UTF-8 with 4 byte character support" + }, + { + "value": "ar", + "description": "Arabic - Deprecated" + }, + { + "value": "ar.utf-8", + "description": "Arabic with UTF-8" + }, + { + "value": "hr", + "description": "Croatian - Deprecated" + }, + { + "value": "hr.utf-8", + "description": "Croatian with UTF-8" + }, + { + "value": "cs", + "description": "Czech - Deprecated" + }, + { + "value": "cs.utf-8", + "description": "Czech with UTF-8" + }, + { + "value": "da", + "description": "Danish - Deprecated" + }, + { + "value": "da.utf-8", + "description": "Danish with UTF-8" + }, + { + "value": "nl", + "description": "Dutch - Deprecated" + }, + { + "value": "nl.utf-8", + "description": "Dutch with UTF-8" + }, + { + "value": "en", + "description": "English - Deprecated" + }, + { + "value": "en.utf-8", + "description": "English with UTF-8" + }, + { + "value": "fi", + "description": "Finnish - Deprecated" + }, + { + "value": "fi.utf-8", + "description": "Finnish with UTF-8" + }, + { + "value": "fr", + "description": "French - Deprecated" + }, + { + "value": "fr.utf-8", + "description": "French with UTF-8" + }, + { + "value": "de", + "description": "German - Deprecated" + }, + { + "value": "de.utf-8", + "description": "German with UTF-8" + }, + { + "value": "he", + "description": "Hebrew - Deprecated" + }, + { + "value": "he.utf-8", + "description": "Hebrew with UTF-8" + }, + { + "value": "hu", + "description": "Hungarian - Deprecated" + }, + { + "value": "hu.utf-8", + "description": "Hungarian with UTF-8" + }, + { + "value": "it", + "description": "Italian - Deprecated" + }, + { + "value": "it.utf-8", + "description": "Italian with UTF-8" + }, + { + "value": "ja", + "description": "Japanese euc-j - Deprecated" + }, + { + "value": "ja.utf-8", + "description": "Japanese euc-j with UTF-8" + }, + { + "value": "ja-v1", + "description": "Japanese euc-j - Deprecated" + }, + { + "value": "ja-v1.utf-8", + "description": "Japanese euc-j with UTF-8" + }, + { + "value": "ja-jp.pck", + "description": "Japanese pck" + }, + { + "value": "ja-jp.pck.utf-8", + "description": "Japanese pck with UTF-8 - Deprecated" + }, + { + "value": "ja-jp.932", + "description": "Japanese cp932" + }, + { + "value": "ja-jp.932.utf-8", + "description": "Japanese cp932 with UTF-8 - Deprecated" + }, + { + "value": "ja-jp.pck-v2", + "description": "Japanese pck - sjis" + }, + { + "value": "ja-jp.pck-v2.utf-8", + "description": "Japanese pck - sjis with UTF-8 - Deprecated" + }, + { + "value": "ko", + "description": "Korean - Deprecated" + }, + { + "value": "ko.utf-8", + "description": "Korean with UTF-8" + }, + { + "value": "no", + "description": "Norwegian - Deprecated" + }, + { + "value": "no.utf-8", + "description": "Norwegian with UTF-8" + }, + { + "value": "pl", + "description": "Polish - Deprecated" + }, + { + "value": "pl.utf-8", + "description": "Polish with UTF-8" + }, + { + "value": "pt", + "description": "Portuguese - Deprecated" + }, + { + "value": "pt.utf-8", + "description": "Portuguese with UTF-8" + }, + { + "value": "c", + "description": "Posix - Deprecated" + }, + { + "value": "ro", + "description": "Romanian - Deprecated" + }, + { + "value": "ro.utf-8", + "description": "Romanian with UTF-8" + }, + { + "value": "ru", + "description": "Russian - Deprecated" + }, + { + "value": "ru.utf-8", + "description": "Russian with UTF-8" + }, + { + "value": "zh", + "description": "Simplified Chinese - Deprecated" + }, + { + "value": "zh.utf-8", + "description": "Simplified Chinese with UTF-8" + }, + { + "value": "zh.gbk", + "description": "Simplified gbk Chinese" + }, + { + "value": "zh.gbk.utf-8", + "description": "Simplified gbk Chinese with UTF-8 - Deprecated" + }, + { + "value": "zh-tw.big5", + "description": "Traditional Chinese BIG 5" + }, + { + "value": "zh-tw.big5.utf-8", + "description": "Traditional Chinese BIG 5 with UTF-8 - Deprecated" + }, + { + "value": "zh-tw", + "description": "Traditional Chinese EUC-TW" + }, + { + "value": "zh-tw.utf-8", + "description": "Traditional Chinese EUC-TW with UTF-8 - Deprecated" + }, + { + "value": "sk", + "description": "Slovak - Deprecated" + }, + { + "value": "sk.utf-8", + "description": "Slovak with UTF-8" + }, + { + "value": "sl", + "description": "Slovenian - Deprecated" + }, + { + "value": "sl.utf-8", + "description": "Slovenian with UTF-8" + }, + { + "value": "es", + "description": "Spanish - Deprecated" + }, + { + "value": "es.utf-8", + "description": "Spanish with UTF-8" + }, + { + "value": "sv", + "description": "Swedish - Deprecated" + }, + { + "value": "sv.utf-8", + "description": "Swedish with UTF-8" + }, + { + "value": "tr", + "description": "Turkish - Deprecated" + }, + { + "value": "tr.utf-8", + "description": "Turkish with UTF-8" + }, + { + "value": "en-us", + "description": "US English - Deprecated" + }, + { + "value": "en-us.utf-8", + "description": "US English with UTF-8" + } + ] + } + }, + "volumeQuotaRulesList": { + "description": "List of Volume Quota Rules", + "type": "object", + "properties": { + "value": { + "description": "A list of Volume Quota Rules", + "type": "array", + "items": { + "$ref": "#/definitions/volumeQuotaRule" + } + } + } + }, + "volumeQuotaRule": { + "description": "Quota Rule of a Volume", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulePatch": { + "description": "Patchable Quota Rule of a Volume", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulesProperties": { + "description": "Volume Quota Rule properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/netappProvisioningState" + }, + "quotaSizeInKiBs": { + "type": "integer", + "description": "Size of quota", + "format": "int64", + "example": "100006" + }, + "quotaType": { + "title": "quotaType", + "type": "string", + "description": "Type of quota", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "DefaultUserQuota", + "DefaultGroupQuota", + "IndividualUserQuota", + "IndividualGroupQuota" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "DefaultUserQuota", + "description": "Default user quota" + }, + { + "value": "DefaultGroupQuota", + "description": "Default group quota" + }, + { + "value": "IndividualUserQuota", + "description": "Individual user quota" + }, + { + "value": "IndividualGroupQuota", + "description": "Individual group quota" + } + ] + }, + "example": "DefaultUserQuota" + }, + "quotaTarget": { + "type": "string", + "description": "UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "volumeGroupList": { + "description": "List of volume group resources", + "type": "object", + "properties": { + "value": { + "description": "List of volume Groups", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroup" + } + } + } + }, + "volumeGroup": { + "description": "Volume group resource", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupListProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupDetails": { + "description": "Volume group resource for create", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupMetaData": { + "description": "Volume group properties", + "type": "object", + "properties": { + "groupDescription": { + "type": "string", + "description": "Group Description", + "example": "group description" + }, + "applicationType": { + "type": "string", + "description": "Application Type", + "enum": [ + "SAP-HANA", + "ORACLE" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "example": "SAP-HANA" + }, + "applicationIdentifier": { + "type": "string", + "description": "Application specific identifier", + "example": "SH1" + }, + "globalPlacementRules": { + "title": "Global volume placement rules", + "description": "Application specific placement rules for the volume group", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "volumesCount": { + "type": "integer", + "format": "int64", + "description": "Number of volumes in volume group", + "example": 5, + "readOnly": true + } + } + }, + "volumeGroupProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + }, + "volumes": { + "description": "List of volumes from group", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroupVolumeProperties" + } + } + } + }, + "volumeGroupListProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + } + } + }, + "volumeGroupVolumeProperties": { + "description": "Volume resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "properties" + ], + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "placementKeyValuePairs": { + "description": "Application specific parameters for the placement of volumes in the volume group", + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key for an application specific parameter for the placement of volumes in the volume group", + "example": "key1" + }, + "value": { + "type": "string", + "description": "Value for an application specific parameter for the placement of volumes in the volume group", + "example": "value1" + } + } + }, + "networkSiblingSet": { + "title": "Network sibling set", + "description": "Describes the contents of a network sibling set.", + "type": "object", + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "provisioningState": { + "$ref": "#/definitions/networkSiblingSetProvisioningState" + }, + "nicInfoList": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of NIC information", + "items": { + "$ref": "#/definitions/nicInfo" + } + } + } + }, + "QueryNetworkSiblingSetRequest": { + "title": "QueryNetworkSiblingSetRequest", + "description": "Network sibling set query.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + } + } + }, + "UpdateNetworkSiblingSetRequest": { + "title": "UpdateNetworkSiblingSetRequest", + "description": "Network sibling set update.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId", + "networkSiblingSetStateId", + "networkFeatures" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "Network features available to the volume." + } + } + }, + "networkFeatures": { + "title": "Network features", + "description": "Network features available to the volume, or current state of update.", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Basic_Standard", + "Standard_Basic" + ], + "x-ms-enum": { + "name": "NetworkFeatures", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic network features." + }, + { + "value": "Standard", + "description": "Standard network features." + }, + { + "value": "Basic_Standard", + "description": "Updating from Basic to Standard network features." + }, + { + "value": "Standard_Basic", + "description": "Updating from Standard to Basic network features." + } + ] + }, + "example": "Standard", + "default": "Basic" + }, + "networkSiblingSetProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the NetworkSiblingSet at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "NetworkSiblingSetProvisioningState", + "modelAsString": true + } + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.", + "type": "string", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "networkSiblingSetStateId": { + "title": "Network sibling set state Id", + "description": "Network sibling set state Id identifying the current state of the sibling set.", + "type": "string", + "example": "12345_44420.8001578125" + }, + "nicInfo": { + "title": "NIC information", + "description": "NIC information and list of volumes for which the NIC has the primary mount ip address.", + "type": "object", + "properties": { + "ipAddress": { + "$ref": "#/definitions/ipAddress" + }, + "volumeResourceIds": { + "$ref": "#/definitions/volumeResourceIds" + } + } + }, + "ipAddress": { + "title": "ipAddress", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "volumeResourceIds": { + "title": "Volume resource Ids", + "type": "array", + "items": { + "title": "Resource Id of volume", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + } + }, + "subnetId": { + "title": "Subnet resource Id", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "snapshotRestoreFiles": { + "description": "Restore payload for Single File Snapshot Restore", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "filePaths" + ], + "properties": { + "filePaths": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "destinationPath": { + "description": "Destination folder where the files will be restored", + "type": "string", + "example": "/AVSdataStore" + } + } + }, + "subvolumesList": { + "description": "List of Subvolumes", + "type": "object", + "properties": { + "value": { + "description": "A list of Subvolumes", + "type": "array", + "items": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "subvolumeInfo": { + "description": "Subvolume Information properties", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumeProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchRequest": { + "description": "Subvolume Patch Request properties", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumePatchParams", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchParams": { + "description": "Parameters with which a subvolume can be updated", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "path": { + "title": "path", + "type": "string", + "description": "path to the subvolume", + "example": "/pathToSubvolume" + } + } + }, + "subvolumeProperties": { + "description": "This represents path associated with the subvolume", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "parentPath": { + "title": "name", + "x-nullable": true, + "type": "string", + "description": "parent path to the subvolume", + "example": "/parentPath" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "readOnly": true, + "example": "Available" + } + } + }, + "subvolumeModel": { + "description": "Result of the post subvolume and action is to get metadata of the subvolume.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "It represents the minimal properties of the subvolume.", + "$ref": "#/definitions/subvolumeModelProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumeModelProperties": { + "description": "Properties which represents actual subvolume model which is stored as a file in the system.", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "parentPath": { + "title": "parentpath", + "type": "string", + "description": "Path to the parent subvolume", + "example": "/parentPath" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Size of subvolume", + "example": 5 + }, + "bytesUsed": { + "title": "bytesUsed", + "type": "integer", + "format": "int64", + "description": "Bytes used", + "example": 5 + }, + "permissions": { + "title": "permissions", + "type": "string", + "description": "Permissions of the subvolume", + "example": "777" + }, + "creationTimeStamp": { + "title": "creationTimeStamp", + "type": "string", + "format": "date-time", + "description": "Creation time and date", + "example": "2017-08-15T13:23:33Z" + }, + "accessedTimeStamp": { + "title": "accessedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent access time and date", + "example": "2017-08-15T13:23:33Z" + }, + "modifiedTimeStamp": { + "title": "modifiedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent modification time and date", + "example": "2017-08-15T13:23:33Z" + }, + "changedTimeStamp": { + "title": "changedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent change time and date", + "example": "2017-08-15T13:23:33Z" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available" + } + } + }, + "netappProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the VolumeQuotaRule at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Patching", + "Deleting", + "Moving", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "encryptionMigrationRequest": { + "description": "Encryption migration request", + "type": "object", + "required": [ + "virtualNetworkId", + "privateEndpointId" + ], + "properties": { + "virtualNetworkId": { + "title": "virtualNetworkId", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + }, + "description": "Identifier for the virtual network", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "privateEndpointId": { + "title": "privateEndpointId", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateEndpoints" + } + ] + }, + "description": "Identifier of the private endpoint to reach the Azure Key Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1" + } + } + }, + "coolAccessRetrievalPolicy": { + "type": "string", + "description": "coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage.", + "enum": [ + "Default", + "OnRead", + "Never" + ], + "x-ms-enum": { + "name": "coolAccessRetrievalPolicy", + "modelAsString": true + } + }, + "smbAccessBasedEnumeration": { + "title": "smbAccessBasedEnumeration", + "type": "string", + "description": "Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbAccessBasedEnumeration", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbAccessBasedEnumeration share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbAccessBasedEnumeration share setting is enabled" + } + ] + }, + "x-nullable": true, + "example": "Enabled" + }, + "smbNonBrowsable": { + "title": "smbNonBrowsable", + "type": "string", + "description": "Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbNonBrowsable", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbNonBrowsable share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbNonBrowsable share setting is enabled" + } + ] + }, + "example": "Enabled" + }, + "backupRestoreFiles": { + "description": "Restore payload for Single File Backup Restore", + "type": "object", + "required": [ + "fileList", + "destinationVolumeId" + ], + "properties": { + "fileList": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 8, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "restoreFilePath": { + "description": "Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default", + "type": "string", + "pattern": "^\\/.*$", + "example": "/AVSdataStore" + }, + "destinationVolumeId": { + "description": "Resource Id of the destination volume on which the files need to be restored", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + } + }, + "volumeBackupProperties": { + "description": "Volume Backup Properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupVaultId": { + "type": "string", + "description": "Backup Vault Resource ID" + } + } + }, + "backupsList": { + "description": "List of Backups", + "type": "object", + "properties": { + "value": { + "description": "A list of Backups", + "type": "array", + "items": { + "$ref": "#/definitions/backup" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backup": { + "description": "Backup under a Backup Vault", + "type": "object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Backup Properties", + "$ref": "#/definitions/backupProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPatch": { + "description": "Backup patch", + "type": "object", + "properties": { + "properties": { + "description": "Backup Patch Properties", + "$ref": "#/definitions/backupPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "backupProperties": { + "description": "Backup properties", + "type": "object", + "required": [ + "volumeResourceId" + ], + "properties": { + "backupId": { + "title": "backupId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Backup", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "creationDate": { + "title": "creationDate", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the backup", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "size": { + "type": "integer", + "readOnly": true, + "description": "Size of backup in bytes", + "format": "int64" + }, + "label": { + "type": "string", + "description": "Label for backup" + }, + "backupType": { + "title": "backupType", + "type": "string", + "readOnly": true, + "description": "Type of backup Manual or Scheduled", + "enum": [ + "Manual", + "Scheduled" + ], + "x-ms-enum": { + "name": "backupType", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Manual backup" + }, + { + "value": "Scheduled", + "description": "Scheduled backup" + } + ] + }, + "example": "Manual" + }, + "failureReason": { + "type": "string", + "readOnly": true, + "description": "Failure reason" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "x-ms-mutability": [ + "read", + "create" + ], + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "useExistingSnapshot": { + "type": "boolean", + "description": "Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups", + "example": true, + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "snapshotName": { + "type": "string", + "description": "The name of the snapshot", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupPolicyResourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId used to identify the backup policy", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + } + } + } + }, + "backupPatchProperties": { + "description": "Backup patch properties", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Label for backup" + } + } + }, + "backupStatus": { + "description": "Backup status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Backup health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the backup mirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the backup", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy backup relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the backup is in an error state" + }, + "lastTransferSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the last transfer size" + }, + "lastTransferType": { + "type": "string", + "readOnly": true, + "description": "Displays the last transfer type" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + }, + "transferProgressBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total number of bytes transferred for the ongoing operation" + } + } + }, + "backupVaultsList": { + "description": "List of Backup Vaults", + "type": "object", + "properties": { + "value": { + "description": "A list of Backup Vaults", + "type": "array", + "items": { + "$ref": "#/definitions/backupVault" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backupVault": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Backup Vault Properties", + "$ref": "#/definitions/backupVaultProperties", + "x-ms-client-flatten": true + } + } + }, + "backupVaultPatch": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + } + } + }, + "backupVaultProperties": { + "description": "Backup Vault properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "backupsMigrationRequest": { + "description": "Migrate Backups Request", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "backupVaultId" + ], + "properties": { + "backupVaultId": { + "type": "string", + "description": "The ResourceId of the Backup Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + } + }, + "changeKeyVault": { + "description": "Change key vault request", + "type": "object", + "required": [ + "keyVaultUri", + "keyName", + "keyVaultResourceId", + "keyVaultPrivateEndpoints" + ], + "properties": { + "keyVaultUri": { + "title": "keyVaultUri", + "description": "The URI of the key vault/managed HSM that should be used for encryption.", + "type": "string", + "example": "https://my-key-vault.managedhsm.azure.net" + }, + "keyName": { + "title": "keyName", + "description": "The name of the key that should be used for encryption.", + "type": "string", + "example": "rsaKeyName" + }, + "keyVaultResourceId": { + "title": "keyVaultResourceId", + "description": "Azure resource ID of the key vault/managed HSM that should be used for encryption.", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm" + }, + "keyVaultPrivateEndpoints": { + "title": "keyVaultPrivateEndpoints", + "description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/keyVaultPrivateEndpoint" + }, + "x-ms-identifiers": [ + "virtualNetworkId" + ] + } + } + }, + "keyVaultPrivateEndpoint": { + "title": "keyVaultPrivateEndpoint", + "description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.", + "type": "object", + "properties": { + "virtualNetworkId": { + "title": "virtualNetworkId", + "type": "string", + "description": "Identifier for the virtual network id", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "privateEndpointId": { + "title": "privateEndpointId", + "type": "string", + "description": "Identifier of the private endpoint to reach the Azure Key Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1" + } + } + }, + "clusterPeerCommandResponse": { + "description": "Information about cluster peering process", + "type": "object", + "properties": { + "peerAcceptCommand": { + "description": "A command that needs to be run on the external ONTAP to accept cluster peering. Will only be present if clusterPeeringStatus is pending", + "type": "string" + } + } + }, + "svmPeerCommandResponse": { + "description": "Information about SVM peering process", + "type": "object", + "properties": { + "svmPeeringCommand": { + "description": "A command that needs to be run on the external ONTAP to accept SVM peering. Will only be present if svmPeeringStatus is pending", + "type": "string" + } + } + }, + "peerClusterForVolumeMigrationRequest": { + "description": "Source cluster properties for a cluster peer request", + "type": "object", + "required": [ + "peerAddresses" + ], + "properties": { + "peerAddresses": { + "type": "array", + "minItems": 1, + "description": "A list of IC-LIF IPs that can be used to connect to the on-prem cluster", + "example": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ], + "items": { + "type": "string" + } + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "$ref": "#/definitions/remotePath", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + } + }, + "parameters": { + "AccountName": { + "name": "accountName", + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,127}$", + "in": "path", + "required": true, + "description": "The name of the NetApp account", + "x-ms-parameter-location": "method" + }, + "PoolName": { + "name": "poolName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the capacity pool", + "x-ms-parameter-location": "method" + }, + "VolumeName": { + "name": "volumeName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volume", + "x-ms-parameter-location": "method" + }, + "MountTargetName": { + "name": "mountTargetName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the mount target", + "x-ms-parameter-location": "method" + }, + "SnapshotName": { + "name": "snapshotName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot", + "x-ms-parameter-location": "method" + }, + "SnapshotPolicyName": { + "name": "snapshotPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot policy", + "x-ms-parameter-location": "method" + }, + "BackupPolicyName": { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Backup policy Name which uniquely identify backup policy.", + "x-ms-parameter-location": "method" + }, + "QuotaLimitName": { + "name": "quotaLimitName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the Quota Limit", + "x-ms-parameter-location": "method" + }, + "VolumeGroupName": { + "name": "volumeGroupName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volumeGroup", + "x-ms-parameter-location": "method" + }, + "SubvolumeName": { + "name": "subvolumeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subvolume.", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "VolumeQuotaRuleName": { + "name": "volumeQuotaRuleName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of volume quota rule", + "x-ms-parameter-location": "method" + }, + "BackupName": { + "name": "backupName", + "type": "string", + "in": "path", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_.]{0,255}$", + "required": true, + "description": "The name of the backup", + "x-ms-parameter-location": "method" + }, + "BackupVaultName": { + "name": "backupVaultName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "type": "string", + "description": "The name of the Backup Vault", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-01/netapp.json index 8a783b13e97c..c870dd3f0c38 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-01/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-01/netapp.json @@ -6606,7 +6606,7 @@ "type": "integer", "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", "example": 7, - "minimum": 7, + "minimum": 2, "maximum": 183, "format": "int32" }, @@ -7136,6 +7136,17 @@ } } }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, "throughputMibps": { "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", "type": "number", diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index ca3881394a07..7034493e594a 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -28,7 +28,16 @@ These are the global settings for the Azure NetApp Files API. title: NetAppManagementClient description: Microsoft NetApp Files Azure Resource Provider specification openapi-type: arm -tag: package-netapp-2023-11-01 +tag: package-preview-2023-11 +``` + +### Tag: package-preview-2023-11 + +These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-11' +input-file: + - Microsoft.NetApp/preview/2023-11-01-preview/netapp.json ``` ### Tag: package-netapp-2023-11-01 @@ -65,7 +74,7 @@ These settings apply only when `--tag=package-preview-2023-05` is specified on t ``` yaml $(tag) == 'package-preview-2023-05' input-file: - Microsoft.NetApp/preview/2023-05-01-preview/netapp.json -tag: package-2023-07 +tag: package-preview-2023-11 ``` ### Tag: package-netapp-2023-05-01 From 75731b44dbf23b73d03cb1698c558f1edfe58f69 Mon Sep 17 00:00:00 2001 From: Anand Bulusu <71119784+anand-bulusu@users.noreply.github.com> Date: Tue, 11 Jun 2024 12:19:39 +0530 Subject: [PATCH 149/343] Added missing continuation settings for execute dataflow activity (#29230) * Update Pipeline.json with continuation settings for execute dataflow activity * Update continuation settings for dataflow - Synapse * Lint fix * Lint fix * Prettier fix * Removed x-ms-format for synapse swagger --- .../2018-06-01/entityTypes/Pipeline.json | 25 +++++++++++++++++++ .../2020-12-01/entityTypes/Pipeline.json | 22 ++++++++++++++++ 2 files changed, 47 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index d094cd8aa3c1..3914b9560d42 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -8359,6 +8359,10 @@ "description": "The integration runtime reference.", "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" }, + "continuationSettings": { + "description": "Continuation settings for execute data flow activity.", + "$ref": "#/definitions/ContinuationSettingsReference" + }, "compute": { "description": "Compute properties for data flow activity.", "type": "object", @@ -8400,6 +8404,27 @@ "dataFlow" ] }, + "ContinuationSettingsReference": { + "description": "Continuation settings for execute data flow activity.", + "type": "object", + "properties": { + "continuationTtlInMinutes": { + "description": "Continuation TTL in minutes.", + "x-ms-format": "dfe-int", + "type": "object" + }, + "idleCondition": { + "description": "Idle condition.", + "x-ms-format": "dfe-string", + "type": "object" + }, + "customizedCheckpointKey": { + "description": "Customized checkpoint key.", + "x-ms-format": "dfe-string", + "type": "object" + } + } + }, "ExecutePowerQueryActivityTypeProperties": { "description": "Execute power query data flow activity properties.", "type": "object", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index e7fe05e9e3e5..ebed021dcfb7 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -7411,6 +7411,10 @@ "description": "The integration runtime reference.", "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" }, + "continuationSettings": { + "description": "Continuation settings for execute data flow activity.", + "$ref": "#/definitions/ContinuationSettingsReference" + }, "compute": { "description": "Compute properties for data flow activity.", "type": "object", @@ -7446,6 +7450,24 @@ "dataflow" ] }, + "ContinuationSettingsReference": { + "description": "Continuation settings for execute data flow activity.", + "type": "object", + "properties": { + "continuationTtlInMinutes": { + "description": "Continuation TTL in minutes.", + "type": "object" + }, + "idleCondition": { + "description": "Idle condition.", + "type": "object" + }, + "customizedCheckpointKey": { + "description": "Customized checkpoint key.", + "type": "object" + } + } + }, "DataFlowComputeType": { "description": "All available DataFlowComputeType values.", "type": "string", From 0b17872255d025c072ce970752c470a02c9723a7 Mon Sep 17 00:00:00 2001 From: virginiaho-ms <111312414+virginiaho-ms@users.noreply.github.com> Date: Mon, 10 Jun 2024 23:50:17 -0700 Subject: [PATCH 150/343] Replace apiKey with more obvious dummy value (#29268) --- .../stable/2015-05-01/examples/APIKeysCreate.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/APIKeysCreate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/APIKeysCreate.json index ca44f85cbb91..6e5496b52716 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/APIKeysCreate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/APIKeysCreate.json @@ -18,7 +18,7 @@ "responses": { "200": { "body": { - "id": "/subscriptions/subid/resourcegroups/my-resource-group/providers/Microsoft.Insights/components/my-component/apikeys/fe2e0138-47c1-46c5-8726-872f54c1ca08", + "id": "/subscriptions/subid/resourcegroups/my-resource-group/providers/Microsoft.Insights/components/my-component/apikeys/00000000-0000-0000-0000-000000000000", "name": "test", "linkedReadProperties": [ "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component/api", @@ -27,7 +27,7 @@ "linkedWriteProperties": [ "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component/annotations" ], - "apiKey": "eip8wlzuzlf4wzczhnzao54zcswew25azs4kadhb", + "apiKey": "0000000000000000000000000000000000000000", "createdDate": "Thu, 28 Sep 2017 16:58:52 GMT" } } From 6ab56f07ee3f346dd6e26c39b37e14e9f9f15559 Mon Sep 17 00:00:00 2001 From: justbelieve Date: Tue, 11 Jun 2024 12:23:33 +0530 Subject: [PATCH 151/343] Azure site recovery Swagger for 2024-04-01 Api version (#29277) * Copy files from stable/2024-02-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-04-01 Updated the API version from stable/2024-02-01 to stable/2024-04-01. * Added tag for 2024-04-01 in readme file * Fixed style check * Fixed style * fixed prettier --------- Co-authored-by: Roopesh Manda Co-authored-by: Himanshu Agarwal --- .../examples/ClusterRecoveryPoint_Get.json | 33 + ...ts_ListByReplicationProtectionCluster.json | 36 + .../examples/MigrationRecoveryPoints_Get.json | 28 + ...oints_ListByReplicationMigrationItems.json | 40 + .../2024-04-01/examples/Operations_List.json | 1228 + .../examples/RecoveryPoints_Get.json | 28 + ...oints_ListByReplicationProtectedItems.json | 40 + .../ReplicationAlertSettings_Create.json | 37 + .../ReplicationAlertSettings_Get.json | 28 + .../ReplicationAlertSettings_List.json | 31 + .../examples/ReplicationAppliances_List.json | 27 + .../ReplicationEligibilityResults_Get.json | 32 + .../ReplicationEligibilityResults_List.json | 43 + .../examples/ReplicationEvents_Get.json | 37 + .../examples/ReplicationEvents_List.json | 68 + .../ReplicationFabrics_CheckConsistency.json | 43 + .../examples/ReplicationFabrics_Create.json | 50 + .../examples/ReplicationFabrics_Delete.json | 22 + .../examples/ReplicationFabrics_Get.json | 37 + .../examples/ReplicationFabrics_List.json | 40 + .../ReplicationFabrics_MigrateToAad.json | 22 + .../examples/ReplicationFabrics_Purge.json | 22 + ...ReplicationFabrics_ReassociateGateway.json | 55 + .../ReplicationFabrics_RenewCertificate.json | 48 + .../ReplicationInfrastructure_Delete.json | 17 + .../examples/ReplicationJobs_Cancel.json | 60 + .../examples/ReplicationJobs_Export.json | 51 + .../examples/ReplicationJobs_Get.json | 62 + .../examples/ReplicationJobs_List.json | 73 + .../examples/ReplicationJobs_Restart.json | 61 + .../examples/ReplicationJobs_Resume.json | 84 + .../ReplicationLogicalNetworks_Get.json | 28 + ...icalNetworks_ListByReplicationFabrics.json | 42 + .../ReplicationMigrationItems_Create.json | 73 + .../ReplicationMigrationItems_Delete.json | 24 + .../ReplicationMigrationItems_Get.json | 46 + .../ReplicationMigrationItems_List.json | 47 + ...ListByReplicationProtectionContainers.json | 49 + .../ReplicationMigrationItems_Migrate.json | 60 + ...cationMigrationItems_PauseReplication.json | 53 + ...ationMigrationItems_ResumeReplication.json | 56 + .../ReplicationMigrationItems_Resync.json | 59 + ...ReplicationMigrationItems_TestMigrate.json | 60 + ...tionMigrationItems_TestMigrateCleanup.json | 56 + .../ReplicationMigrationItems_Update.json | 58 + .../ReplicationNetworkMappings_Create.json | 51 + .../ReplicationNetworkMappings_Delete.json | 24 + .../ReplicationNetworkMappings_Get.json | 36 + .../ReplicationNetworkMappings_List.json | 38 + ...orkMappings_ListByReplicationNetworks.json | 39 + .../ReplicationNetworkMappings_Update.json | 51 + .../examples/ReplicationNetworks_Get.json | 28 + .../examples/ReplicationNetworks_List.json | 52 + ...tionNetworks_ListByReplicationFabrics.json | 53 + .../examples/ReplicationPolicies_Create.json | 40 + .../examples/ReplicationPolicies_Delete.json | 22 + .../examples/ReplicationPolicies_Get.json | 27 + .../examples/ReplicationPolicies_List.json | 30 + .../examples/ReplicationPolicies_Update.json | 40 + .../ReplicationProtectableItems_Get.json | 35 + ...ListByReplicationProtectionContainers.json | 56 + .../ReplicationProtectedItems_AddDisks.json | 81 + ...tionProtectedItems_ApplyRecoveryPoint.json | 74 + .../ReplicationProtectedItems_Create.json | 72 + .../ReplicationProtectedItems_Delete.json | 31 + ...licationProtectedItems_FailoverCancel.json | 64 + ...licationProtectedItems_FailoverCommit.json | 65 + .../ReplicationProtectedItems_Get.json | 57 + .../ReplicationProtectedItems_List.json | 58 + ...ListByReplicationProtectionContainers.json | 60 + ...icationProtectedItems_PlannedFailover.json | 74 + .../ReplicationProtectedItems_Purge.json | 24 + ...ReplicationProtectedItems_RemoveDisks.json | 76 + ...ationProtectedItems_RepairReplication.json | 63 + .../ReplicationProtectedItems_Reprotect.json | 74 + ...ionProtectedItems_ResolveHealthErrors.json | 76 + ...licationProtectedItems_SwitchProvider.json | 77 + ...eplicationProtectedItems_TestFailover.json | 71 + ...ionProtectedItems_TestFailoverCleanup.json | 71 + ...ationProtectedItems_UnplannedFailover.json | 75 + .../ReplicationProtectedItems_Update.json | 88 + ...icationProtectedItems_UpdateAppliance.json | 76 + ...nProtectedItems_UpdateMobilityService.json | 67 + ...ProtectionClusters_ApplyRecoveryPoint.json | 178 + .../ReplicationProtectionClusters_Create.json | 191 + ...tionProtectionClusters_FailoverCommit.json | 165 + .../ReplicationProtectionClusters_Get.json | 145 + ...rotectionClusters_GetOperationResults.json | 96 + .../ReplicationProtectionClusters_List.json | 107 + ...ListByReplicationProtectionContainers.json | 109 + .../ReplicationProtectionClusters_Purge.json | 21 + ...nProtectionClusters_RepairReplication.json | 152 + ...cationProtectionClusters_TestFailover.json | 180 + ...rotectionClusters_TestFailoverCleanup.json | 172 + ...nProtectionClusters_UnplannedFailover.json | 180 + ...ionProtectionContainerMappings_Create.json | 51 + ...ionProtectionContainerMappings_Delete.json | 29 + ...cationProtectionContainerMappings_Get.json | 35 + ...ationProtectionContainerMappings_List.json | 36 + ...ListByReplicationProtectionContainers.json | 38 + ...tionProtectionContainerMappings_Purge.json | 24 + ...ionProtectionContainerMappings_Update.json | 57 + ...eplicationProtectionContainers_Create.json | 45 + ...eplicationProtectionContainers_Delete.json | 23 + ...ionContainers_DiscoverProtectableItem.json | 43 + .../ReplicationProtectionContainers_Get.json | 30 + .../ReplicationProtectionContainers_List.json | 32 + ...onContainers_ListByReplicationFabrics.json | 33 + ...ionContainers_SwitchClusterProtection.json | 69 + ...ProtectionContainers_SwitchProtection.json | 44 + .../ReplicationProtectionIntents_Create.json | 43 + .../ReplicationProtectionIntents_Get.json | 34 + .../ReplicationProtectionIntents_List.json | 37 + .../ReplicationRecoveryPlans_Create.json | 88 + .../ReplicationRecoveryPlans_Delete.json | 22 + ...plicationRecoveryPlans_FailoverCancel.json | 51 + ...plicationRecoveryPlans_FailoverCommit.json | 88 + .../ReplicationRecoveryPlans_Get.json | 73 + .../ReplicationRecoveryPlans_List.json | 41 + ...licationRecoveryPlans_PlannedFailover.json | 99 + .../ReplicationRecoveryPlans_Reprotect.json | 88 + ...ReplicationRecoveryPlans_TestFailover.json | 96 + ...tionRecoveryPlans_TestFailoverCleanup.json | 93 + ...cationRecoveryPlans_UnplannedFailover.json | 100 + .../ReplicationRecoveryPlans_Update.json | 119 + ...ationRecoveryServicesProviders_Create.json | 61 + ...ationRecoveryServicesProviders_Delete.json | 23 + ...licationRecoveryServicesProviders_Get.json | 36 + ...icationRecoveryServicesProviders_List.json | 38 + ...cesProviders_ListByReplicationFabrics.json | 39 + ...cationRecoveryServicesProviders_Purge.json | 23 + ...veryServicesProviders_RefreshProvider.json | 42 + ...nStorageClassificationMappings_Create.json | 37 + ...nStorageClassificationMappings_Delete.json | 24 + ...tionStorageClassificationMappings_Get.json | 26 + ...ionStorageClassificationMappings_List.json | 27 + ...stByReplicationStorageClassifications.json | 29 + ...ReplicationStorageClassifications_Get.json | 25 + ...eplicationStorageClassifications_List.json | 27 + ...ssifications_ListByReplicationFabrics.json | 28 + .../examples/ReplicationVaultHealth_Get.json | 44 + .../ReplicationVaultHealth_Refresh.json | 37 + .../ReplicationVaultSetting_Create.json | 29 + .../examples/ReplicationVaultSetting_Get.json | 24 + .../ReplicationVaultSetting_List.json | 28 + .../examples/ReplicationvCenters_Create.json | 47 + .../examples/ReplicationvCenters_Delete.json | 23 + .../examples/ReplicationvCenters_Get.json | 32 + .../examples/ReplicationvCenters_List.json | 34 + ...tionvCenters_ListByReplicationFabrics.json | 35 + .../examples/ReplicationvCenters_Update.json | 43 + .../SupportedOperatingSystems_Get.json | 48 + ...Sizes_ListByReplicationProtectedItems.json | 57 + .../stable/2024-04-01/service.json | 28093 ++++++++++++++++ .../resource-manager/readme.md | 11 +- 155 files changed, 37716 insertions(+), 1 deletion(-) create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ClusterRecoveryPoint_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ClusterRecoveryPoints_ListByReplicationProtectionCluster.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/MigrationRecoveryPoints_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Operations_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/RecoveryPoints_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAppliances_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEligibilityResults_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEligibilityResults_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEvents_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEvents_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_CheckConsistency.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_MigrateToAad.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Purge.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_ReassociateGateway.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_RenewCertificate.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationInfrastructure_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Cancel.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Export.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Restart.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Resume.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationLogicalNetworks_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Migrate.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_PauseReplication.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_ResumeReplication.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Resync.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_TestMigrate.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectableItems_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_AddDisks.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_FailoverCancel.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_FailoverCommit.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_PlannedFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Purge.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_RemoveDisks.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_RepairReplication.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Reprotect.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_SwitchProvider.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_TestFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UnplannedFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UpdateAppliance.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UpdateMobilityService.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_ApplyRecoveryPoint.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_FailoverCommit.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_GetOperationResults.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Purge.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_RepairReplication.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_TestFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_TestFailoverCleanup.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_UnplannedFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Purge.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_SwitchClusterProtection.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_SwitchProtection.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_FailoverCancel.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_FailoverCommit.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_PlannedFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Reprotect.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_TestFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Purge.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultHealth_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultHealth_Refresh.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/SupportedOperatingSystems_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/service.json diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ClusterRecoveryPoint_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ClusterRecoveryPoint_Get.json new file mode 100644 index 000000000000..686e003f5fa5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ClusterRecoveryPoint_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "testcluster", + "protectionContainerName": "pri-cloud-eastus", + "fabricName": "fabric-pri-eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "recoveryPointName": "06b9ae7f-f21d-4a76-9897-5cf5d6004d80" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/06b9ae7f-f21d-4a76-9897-5cf5d6004d80", + "name": "06b9ae7f-f21d-4a76-9897-5cf5d6004d80", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters/recoveryPoints", + "properties": { + "recoveryPointTime": "2024-01-19T10:51:29.6329144Z", + "recoveryPointType": "CrashConsistent", + "providerSpecificDetails": { + "instanceType": "A2A", + "recoveryPointSyncType": "MultiVmSyncRecoveryPoint", + "nodes": [ + "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/kdUdWvpVnm3QgOQPHoVMX8YAtAO8OC4kKNjt40ERSr4", + "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/yNdYnDYKZ7hYU7zyVeBychFBCyAbEkrJcJNUarDrXio" + ] + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ClusterRecoveryPoints_ListByReplicationProtectionCluster.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ClusterRecoveryPoints_ListByReplicationProtectionCluster.json new file mode 100644 index 000000000000..66fb0aea12a7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ClusterRecoveryPoints_ListByReplicationProtectionCluster.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "testcluster", + "protectionContainerName": "pri-cloud-eastus", + "fabricName": "fabric-pri-eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "name": "cc48b7f3-b267-432b-ad76-45528974dc62", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters/recoveryPoints", + "properties": { + "recoveryPointTime": "2024-01-19T08:55:51.1764251Z", + "recoveryPointType": "CrashConsistent", + "providerSpecificDetails": { + "instanceType": "A2A", + "recoveryPointSyncType": "MultiVmSyncRecoveryPoint", + "nodes": [ + "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/kdUdWvpVnm3QgOQPHoVMX8YAtAO8OC4kKNjt40ERSr4", + "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/yNdYnDYKZ7hYU7zyVeBychFBCyAbEkrJcJNUarDrXio" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/MigrationRecoveryPoints_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/MigrationRecoveryPoints_Get.json new file mode 100644 index 000000000000..9a735dda260d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/MigrationRecoveryPoints_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationRecoveryPointName": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json new file mode 100644 index 000000000000..38c432a5723f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "648336ef-2d70-4d98-b100-8c299f97cd41", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/648336ef-2d70-4d98-b100-8c299f97cd41", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + { + "name": "34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "properties": { + "recoveryPointTime": "2017-04-26T07:37:30.9722019Z", + "recoveryPointType": "CrashConsistent" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Operations_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Operations_List.json new file mode 100644 index 000000000000..4839fe9754e7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Operations_List.json @@ -0,0 +1,1228 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.RecoveryServices/Vaults/vaultTokens/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Vault Token", + "description": "The Vault Token operation can be used to get Vault Token for vault level backend operations." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Register Service Container", + "description": "The Register Service Container operation can be used to register a container with Recovery Service." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Operation Results", + "description": "The Get Operation Results operation can be used get the operation status and result for the asynchronously submitted operation" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Containers", + "description": "The Get Containers operation can be used get the containers registered for a resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Unregister Service Container", + "description": "The UnRegister Container operation can be used to unregister a container." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/certificates/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Update Resource Certificate", + "description": "The Update Resource Certificate operation updates the resource/vault credential certificate." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationAlertSettings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Alerts Settings", + "operation": "Read Alerts Settings", + "description": "Read Any Alerts Settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationAlertSettings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Alerts Settings", + "operation": "Create or Update Alerts Settings", + "description": "Create or Update Any Alerts Settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationEvents/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Events", + "operation": "Read Events", + "description": "Read Any Events" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Networks", + "operation": "Read Networks", + "description": "Read Any Networks" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Read Network Mappings", + "description": "Read Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Create or Update Network Mappings", + "description": "Create or Update Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Delete Network Mappings", + "description": "Delete Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protectable Items", + "operation": "Read Protectable Items", + "description": "Read Any Protectable Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Read Protection Container Mappings", + "description": "Read Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Create or Update Protection Container Mappings", + "description": "Create or Update Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Remove Protection Container Mapping", + "description": "Remove Protection Container Mapping" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Delete Protection Container Mappings", + "description": "Delete Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Replication Recovery Points", + "operation": "Read Replication Recovery Points", + "description": "Read Any Replication Recovery Points" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Read Protected Items", + "description": "Read Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Create or Update Protected Items", + "description": "Create or Update Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Delete Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Remove Protected Item", + "description": "Remove Protected Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/plannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Planned Failover", + "description": "Planned Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/unplannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Failover", + "description": "Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/testFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Test Failover", + "description": "Test Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/testFailoverCleanup/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Test Failover Cleanup", + "description": "Test Failover Cleanup" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/failoverCommit/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Failover Commit", + "description": "Failover Commit" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/reProtect/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "ReProtect Protected Item", + "description": "ReProtect Protected Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/updateMobilityService/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Update Mobility Service", + "description": "Update Mobility Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/repairReplication/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Repair replication", + "description": "Repair replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/applyRecoveryPoint/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Apply Recovery Point", + "description": "Apply Recovery Point" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Read Jobs", + "description": "Read Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/cancel/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Cancel Job", + "description": "Cancel Job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/restart/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Restart job", + "description": "Restart job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/resume/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Resume Job", + "description": "Resume Job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Read Protection Containers", + "description": "Read Any Protection Containers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/discoverProtectableItem/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Discover Protectable Item", + "description": "Discover Protectable Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Create or Update Protection Containers", + "description": "Create or Update Any Protection Containers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Remove Protection Container", + "description": "Remove Protection Container" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/switchprotection/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Switch Protection Container", + "description": "Switch Protection Container" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Read Policies", + "description": "Read Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Create or Update Policies", + "description": "Create or Update Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Delete Policies", + "description": "Delete Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Read Recovery Plans", + "description": "Read Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Create or Update Recovery Plans", + "description": "Create or Update Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Delete Recovery Plans", + "description": "Delete Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/plannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Planned Failover Recovery Plan", + "description": "Planned Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/unplannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Failover Recovery Plan", + "description": "Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/testFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Test Failover Recovery Plan", + "description": "Test Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/testFailoverCleanup/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Test Failover Cleanup Recovery Plan", + "description": "Test Failover Cleanup Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/failoverCommit/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Failover Commit Recovery Plan", + "description": "Failover Commit Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/reProtect/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "ReProtect Recovery Plan", + "description": "ReProtect Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Read Recovery Services Providers", + "description": "Read Any Recovery Services Providers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Remove Recovery Services Provider", + "description": "Remove Recovery Services Provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Delete Recovery Services Providers", + "description": "Delete Any Recovery Services Providers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/refreshProvider/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Refresh Provider", + "description": "Refresh Provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Read Fabrics", + "description": "Read Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Create or Update Fabrics", + "description": "Create or Update Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Remove Fabric", + "description": "Remove Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/checkConsistency/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Checks Consistency of the Fabric", + "description": "Checks Consistency of the Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Delete Fabrics", + "description": "Delete Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/renewcertificate/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Renew Certificate for Fabric", + "description": "Renew Certificate for Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/deployProcessServerImage/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Deploy Process Server Image", + "description": "Deploy Process Server Image" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/reassociateGateway/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Reassociate Gateway", + "description": "Reassociate Gateway" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classifications", + "operation": "Read Storage Classifications", + "description": "Read Any Storage Classifications" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Read Storage Classification Mappings", + "description": "Read Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Create or Update Storage Classification Mappings", + "description": "Create or Update Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Delete Storage Classification Mappings", + "description": "Delete Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/usages/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Vault Usages", + "operation": "Read Vault Usages", + "description": "Read Any Vault Usages" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Read Jobs", + "description": "Read Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Create or Update Jobs", + "description": "Create or Update Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Delete Jobs", + "description": "Delete Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/usages/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Usage", + "operation": "Recovery Services Vault usage details.", + "description": "Returns usage details for a Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupUsageSummaries/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Usages Summaries", + "operation": "Recovery Services Protected Items and Protected Servers usage summaries details.", + "description": "Returns summaries for Protected Items and Protected Servers for a Recovery Services ." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/storageConfig/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Storage Config", + "operation": "Get Resource Storage Config", + "description": "Returns Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/storageConfig/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Storage Config", + "operation": "Write Resource Storage Config", + "description": "Updates Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupconfig/vaultconfig/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Config", + "operation": "Get Resource Config", + "description": "Returns Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupconfig/vaultconfig/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Config", + "operation": "Update Resource Config", + "description": "Updates Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/tokenInfo/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Token Info", + "operation": "Get Vault Token Info", + "description": "Returns token information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupSecurityPIN/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "SecurityPINInfo", + "operation": "Get Security PIN Info", + "description": "Returns Security PIN Information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupManagementMetaData/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Management Metadata", + "operation": "Get Backup Management Metadata", + "description": "Returns Backup Management Metadata for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupOperationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupOperations/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs", + "operation": "Get Jobs", + "description": "Returns all Job Objects" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/cancel/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs", + "operation": "Cancel Jobs", + "description": "Cancel the Job" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobsExport/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Export Backup Jobs", + "operation": "Export Jobs", + "description": "Export Jobs" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs Operation Results", + "operation": "Get Job Operation Result", + "description": "Returns the Result of Job Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobsExport/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Export Backup Jobs Operation Results", + "operation": "Get Export Job Operation Result", + "description": "Returns the Result of Export Job Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Get Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/restore/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Restore Recovery Points", + "description": "Restore Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/provisionInstantItemRecovery/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Provision Instant Item Recovery for Protected Item", + "description": "Provision Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/revokeInstantItemRecovery/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Revoke Instant Item Recovery for Protected Item", + "description": "Revoke Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Get Protection Policy", + "description": "Returns all Protection Policies" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Create Protection Policy", + "description": "Creates Protection Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Delete Protection Policy", + "description": "Delete a Protection Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policy Operation Results", + "operation": "Get Policy Operation Results", + "description": "Get Results of Policy Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/operationStatus/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policy Operation Status", + "operation": "Get Policy Operation Status", + "description": "Get Status of Policy Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Get Protected Item Details", + "description": "Returns object details of the Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectedItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Get All Protected Items", + "description": "Returns the list of all Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Create Backup Protected Item", + "description": "Create a backup Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Deletes Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Item Operation Results", + "operation": "Get Protected Items Operation Results", + "description": "Gets Result of Operation Performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/operationStatus/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Item Operation Status", + "operation": "Get Protected Items operation status", + "description": "Returns the status of Operation performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/backup/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Backup Protected Item", + "description": "Performs Backup for Protected Item." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectableItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Protectable Items", + "operation": "Get Protectable Items", + "description": "Returns list of all Protectable Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/refreshContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Refresh Containers", + "operation": "Refresh container", + "description": "Refreshes the container list" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Refresh Containers Operation Results", + "operation": "Get Operation Results", + "description": "Returns status of the operation" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectionContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Protection Containers", + "operation": "Get Containers In Subscription", + "description": "Returns all containers belonging to the subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protection Containers", + "operation": "Get Registered Container", + "description": "Returns all registered containers" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protection Containers Operation Results", + "operation": "Get Container Operation Results", + "description": "Gets result of Operation performed on Protection Container." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupEngines", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Engines", + "operation": "List of backup management servers.", + "description": "Returns all the backup management servers registered with vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupStatus", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Create Vault", + "description": "Create Vault operation creates an Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Vault", + "description": "The Get Vault operation gets an object representing the Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Delete Vault", + "description": "The Delete Vault operation deletes the specified Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/locations/allocatedStamp/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "locations/allocatedStamp", + "operation": "Get Allocated Stamp", + "description": "GetAllocatedStamp is internal operation used by service" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/locations/allocateStamp/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "locations/allocateStamp", + "operation": "Allocated Stamp Action", + "description": "AllocateStamp is internal operation used by service" + }, + "origin": "user" + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/RecoveryPoints_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/RecoveryPoints_Get.json new file mode 100644 index 000000000000..0487a57a7914 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/RecoveryPoints_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPointName": "b22134ea-620c-474b-9fa5-3c1cb47708e3" + }, + "responses": { + "200": { + "body": { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json new file mode 100644 index 000000000000..697a1d43bc18 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + { + "name": "34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "properties": { + "recoveryPointTime": "2017-04-26T07:37:30.9722019Z", + "recoveryPointType": "CrashConsistent" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_Create.json new file mode 100644 index 000000000000..82f765ae9f0b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_Create.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "alertSettingName": "defaultAlertSetting", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "request": { + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_Get.json new file mode 100644 index 000000000000..dfbd497127c4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "alertSettingName": "defaultAlertSetting", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_List.json new file mode 100644 index 000000000000..148f9b63a5e0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAlertSettings_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAppliances_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAppliances_List.json new file mode 100644 index 000000000000..b5c53ede1dfa --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationAppliances_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "providerSpecificDetails": { + "instanceType": "InMageRcm", + "appliances": [] + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEligibilityResults_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEligibilityResults_Get.json new file mode 100644 index 000000000000..fcf88084f94b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEligibilityResults_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "virtualMachineName": "testVm1", + "resourceGroupName": "testRg1", + "subscriptionId": "d90d145a-4cdd-45a3-b2c4-971d69775278" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.RecoveryServices/replicationEligibilityResults", + "id": "/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm1/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default", + "properties": { + "clientRequestId": "7d72ade7-b9f7-4d9b-8a19-15d9728c6190", + "errors": [ + { + "code": "A2AOperatingSystemNotSupported", + "message": "The A2A operation could not be completed as the virtual machine is running OS 'ubuntu' with version '18.04' which is not supported for replication.", + "possibleCauses": "OS version not supported.", + "recommendedAction": "The virtual machine is running unsupported Operating system. Refer to the documentation for supported OS versions - https://aka.ms/a2a-os-support-matrix.", + "status": "Error" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEligibilityResults_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEligibilityResults_List.json new file mode 100644 index 000000000000..3cd196dfd043 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEligibilityResults_List.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "virtualMachineName": "testVm2", + "resourceGroupName": "testRg1", + "subscriptionId": "d90d145a-4cdd-45a3-b2c4-971d69775278" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.RecoveryServices/replicationEligibilityResults", + "id": "/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default", + "properties": { + "clientRequestId": "a62c81df-e26e-47ea-ab4b-f1fcc1e5b135", + "errors": [ + { + "code": "AzureVmIsNotInDesiredProvisioningState", + "message": "Azure virtual machine with Id (/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2) is with provisioning state 'failed'. To enable replication, VM's provisioning state should be 'succeeded'.", + "possibleCauses": "Virtual machine is not in desired state.", + "recommendedAction": "\n Ensure that the VM's provisioning state is 'succeeded'.\n Refer to https://aka.ms/a2a-vm-state-issues to troubleshoot VM provisioning state issues.\n ", + "status": "Error" + }, + { + "code": "AzureVmIsNotInDesiredPowerState", + "message": "Azure virtual machine with Id (/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2) is with power status 'deallocated'. To enable replication, VM's power status should be 'running'.", + "possibleCauses": "Virtual machine is not in desired state.", + "recommendedAction": "\n Ensure that the VM's power status is 'running'.\n You can check the power status in 'VM > Settings > Properties > Status' in Azure portal.\n ", + "status": "Error" + } + ] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEvents_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEvents_Get.json new file mode 100644 index 000000000000..d8da5e6b5eb1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEvents_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "eventName": "654b71d0-b2ce-4e6e-a861-98528d4bd375", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "name": "VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "properties": { + "eventCode": "d9a07b07-c7b5-49ca-ab6c-6926596dfe47", + "description": "Virtual machine health is OK", + "eventType": "VmHealth", + "affectedObjectFriendlyName": "vm1", + "severity": "OK", + "timeOfOccurrence": "2017-05-02T14:28:28.5071531Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEvents_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEvents_List.json new file mode 100644 index 000000000000..e591ae6b8740 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationEvents_List.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/JobStatusMonitoringEvent;9091989892524070155_4ed6f1a6-9b6d-4048-9079-1307dd24b814", + "name": "JobStatusMonitoringEvent;9091989892524070155_4ed6f1a6-9b6d-4048-9079-1307dd24b814", + "properties": { + "eventCode": "d32574f6-f59e-4545-b5ac-bc88d545f089", + "description": "TestFailover - Failed", + "eventType": "JobStatus", + "affectedObjectFriendlyName": "vm1", + "severity": "Critical", + "timeOfOccurrence": "2017-05-02T16:00:33.0705652Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [ + { + "errorCode": "499", + "errorMessage": "An internal error occurred.", + "possibleCauses": "The operation failed due to an internal error.", + "recommendedAction": "Retry the last action. If the issue persists, contact Support." + } + ] + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "name": "VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "properties": { + "eventCode": "d9a07b07-c7b5-49ca-ab6c-6926596dfe47", + "description": "Virtual machine health is OK", + "eventType": "VmHealth", + "affectedObjectFriendlyName": "vm1", + "severity": "OK", + "timeOfOccurrence": "2017-05-02T14:28:28.5071531Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_CheckConsistency.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_CheckConsistency.json new file mode 100644 index 000000000000..ef95fcc7fa8c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_CheckConsistency.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Create.json new file mode 100644 index 000000000000..d4696627ade1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Create.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "customDetails": { + "instanceType": "FabricSpecificCreationInput" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Delete.json new file mode 100644 index 000000000000..0f94daf70ba8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Get.json new file mode 100644 index 000000000000..89cb0b73b603 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_List.json new file mode 100644 index 000000000000..b880a19f57c3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_MigrateToAad.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_MigrateToAad.json new file mode 100644 index 000000000000..0f94daf70ba8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_MigrateToAad.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Purge.json new file mode 100644 index 000000000000..0f94daf70ba8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_Purge.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_ReassociateGateway.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_ReassociateGateway.json new file mode 100644 index 000000000000..40fd4324a3ab --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_ReassociateGateway.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "fabricName": "GRACE-V2A-1", + "api-version": "2024-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "failoverProcessServerRequest": { + "properties": { + "containerName": "cloud_1f3c15af-2256-4568-9e06-e1ef4f728f75", + "sourceProcessServerId": "AFA0EC54-1894-4E44-9CAB02DB8854B117", + "targetProcessServerId": "5D3ED340-85AE-C646-B338641E015DA405", + "vmsToMigrate": [ + "Vm1", + "Vm2" + ], + "updateType": "ServerLevel" + } + } + }, + "responses": { + "200": { + "body": { + "name": "bc15edf300344660d9c2965f5d9225593d99734f6580613c997033abc3512a56", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/bc15edf300344660d9c2965f5d9225593d99734f6580613c997033abc3512a56", + "properties": { + "friendlyName": "GRACE-V2A-1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "1f3c15af-2256-4568-9e06-e1ef4f728f75", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "VMware" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_RenewCertificate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_RenewCertificate.json new file mode 100644 index 000000000000..cf6902184174 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationFabrics_RenewCertificate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "renewCertificate": { + "properties": { + "renewCertificateType": "Cloud" + } + } + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationInfrastructure_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationInfrastructure_Delete.json new file mode 100644 index 000000000000..d2f7b0b77424 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationInfrastructure_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Cancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Cancel.json new file mode 100644 index 000000000000..cb45b2295b2b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Cancel.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "jobName": "2653c648-fc72-4316-86f3-fdf8eaa0066b", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2653c648-fc72-4316-86f3-fdf8eaa0066b", + "name": "2653c648-fc72-4316-86f3-fdf8eaa0066b", + "properties": { + "activityId": "bfbbf6dd-9cbb-4cbc-98a6-faecc8891579 ActivityId: 07cc35ca-b63f-4e42-83c9-81ae0191c322", + "scenarioName": "PlannedFailover", + "friendlyName": "Planned failover", + "state": "Cancelling", + "stateDescription": "Cancelling", + "tasks": [], + "errors": [], + "startTime": "2017-05-03T06:16:06.3235186Z", + "allowedActions": [], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": { + "PrimaryVmId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "PrimaryVmName": "vm1", + "RecoveryVmId": "", + "RecoveryVmName": "vm1", + "ProtectionProfileId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "PrimaryCloudId": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryCloudName": "cloud1", + "RecoveryCloudId": "d38048d4-b460-4791-8ece-108395ee8478", + "RecoveryCloudName": "Microsoft Azure", + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "RecoveryVmmName": "Microsoft Azure", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Export.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Export.json new file mode 100644 index 000000000000..ae6426e78085 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Export.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "jobQueryParameter": { + "startTime": "2017-04-27T14:26:51.9161395Z", + "endTime": "2017-05-04T14:26:51.9161395Z", + "affectedObjectTypes": "", + "jobStatus": "" + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/37e0fc2b-13f2-4817-aafa-0cd807d46842", + "name": "37e0fc2b-13f2-4817-aafa-0cd807d46842", + "properties": { + "activityId": "36841d27-34f6-49ad-b572-e7dc263f100b-2017-05-04 14:26:47Z-Ibz ActivityId: c124df21-7661-4541-b32a-3c723ebbb045", + "scenarioName": "ExportJobs", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-04T14:33:42.2765562Z", + "endTime": "2017-05-04T14:33:43Z", + "allowedActions": [], + "targetObjectId": "", + "targetObjectName": "", + "targetInstanceType": "Other", + "customDetails": { + "blobUri": "", + "sasToken": "", + "instanceType": "ExportJobDetails", + "affectedObjectDetails": {} + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Get.json new file mode 100644 index 000000000000..f6812c88dae1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "jobName": "58776d0b-3141-48b2-a377-9ad863eb160d", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/32ea4b9e-de62-49a1-b062-7864d5c3b897", + "name": "32ea4b9e-de62-49a1-b062-7864d5c3b897", + "properties": { + "activityId": "fc8e9c8f-0e76-4b6b-8e7e-d37c1b31eba0 ActivityId: c506b6ba-0711-411e-8b09-1f3f4dcb824b", + "scenarioName": "DeleteRecoveryPlan", + "friendlyName": "Delete a recovery plan", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [ + { + "taskId": "763326a2-01c9-4257-b2a1-0aac56465014", + "name": "DeleteRecoveryPlanTask", + "startTime": "2017-04-27T11:25:57.3029434Z", + "endTime": "2017-04-27T11:25:57.318574Z", + "allowedActions": [], + "friendlyName": "Delete a recovery plan task", + "state": "Succeeded", + "stateDescription": "Completed", + "taskType": "TaskDetails", + "customDetails": { + "instanceType": "ManualActionTaskDetails" + }, + "errors": [] + } + ], + "errors": [], + "startTime": "2017-04-27T11:25:56.800358Z", + "endTime": "2017-04-27T11:25:57Z", + "allowedActions": [], + "targetObjectId": "966c33bb-66e7-4567-9786-f80b0694f5f9", + "targetObjectName": "RPtest1", + "targetInstanceType": "RecoveryPlan", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": { + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_List.json new file mode 100644 index 000000000000..cee487e25c7f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_List.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/1557d73f-6244-491e-8f0b-d300f752240b", + "name": "1557d73f-6244-491e-8f0b-d300f752240b", + "properties": { + "scenarioName": "AddProtectionProfile", + "friendlyName": "Create replication policy", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-04-27T12:46:04.641851Z", + "endTime": "2017-04-27T12:46:11Z", + "allowedActions": [], + "targetObjectId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "targetObjectName": "protectionprofile1", + "targetInstanceType": "ProtectionProfile" + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/0236416a-7573-4913-a4a1-6a286fbb1ceb", + "name": "0236416a-7573-4913-a4a1-6a286fbb1ceb", + "properties": { + "scenarioName": "RegisterDra", + "friendlyName": "Register the Azure Site Recovery Provider", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-02T14:07:19.2784338Z", + "endTime": "2017-05-02T14:07:21Z", + "allowedActions": [], + "targetObjectId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "targetObjectName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "targetInstanceType": "Server" + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2438d560-80f0-420b-839e-5c8ee0af90a1", + "name": "2438d560-80f0-420b-839e-5c8ee0af90a1", + "properties": { + "scenarioName": "CreateSite", + "friendlyName": "Create a site", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-02T05:56:14.569095Z", + "endTime": "2017-05-02T05:56:16Z", + "allowedActions": [], + "targetObjectId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "targetObjectName": "cloud1", + "targetInstanceType": "Server" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Restart.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Restart.json new file mode 100644 index 000000000000..1ab56bf8fe54 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Restart.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "jobName": "0664564c-353e-401a-ab0c-722257c10e25", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/42c7d13b-790c-4609-8e0b-0936f1c5e5fb", + "name": "42c7d13b-790c-4609-8e0b-0936f1c5e5fb", + "properties": { + "activityId": "2443a5b4-e675-499f-8983-4126ea0e232c ActivityId: 2a776896-5e56-470b-af55-3c981283c4bc", + "scenarioName": "RestartJob", + "friendlyName": "Restart job", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [ + { + "taskId": "RemediateWfTask", + "name": "RemediateTask", + "startTime": "2017-05-03T10:45:13.5677237Z", + "endTime": "2017-05-03T10:45:13.6458467Z", + "allowedActions": [], + "friendlyName": "Restarting job", + "state": "Succeeded", + "stateDescription": "Completed", + "taskType": "TaskDetails", + "customDetails": { + "instanceType": "ManualActionTaskDetails" + }, + "errors": [] + } + ], + "errors": [], + "startTime": "2017-05-03T10:45:12.1320757Z", + "endTime": "2017-05-03T10:45:14Z", + "allowedActions": [], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": {} + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Resume.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Resume.json new file mode 100644 index 000000000000..63129be8ef49 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationJobs_Resume.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "jobName": "58776d0b-3141-48b2-a377-9ad863eb160d", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "resumeJobParams": { + "properties": { + "comments": " " + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/58776d0b-3141-48b2-a377-9ad863eb160d", + "name": "58776d0b-3141-48b2-a377-9ad863eb160d", + "properties": { + "activityId": "1b808dfe-0451-44ac-894c-c7270711cd8c ActivityId: 9f6f849e-922a-43ec-a7a6-0be45fc85c56", + "scenarioName": "TestFailover", + "friendlyName": "Test failover", + "state": "Suspended", + "stateDescription": "WaitingForStopTestFailover", + "tasks": [], + "errors": [], + "startTime": "2017-04-25T09:57:57.0357829Z", + "allowedActions": [ + "Cancel", + "Resume" + ], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "TestFailoverJobDetails", + "testFailoverStatus": "Completed", + "comments": " ", + "networkName": "vnetavrai", + "networkFriendlyName": "vnetavrai", + "networkType": "VmNetworkAsInput", + "protectedItemDetails": [ + { + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "friendlyName": "vm1", + "testVmName": "vm1-test", + "testVmFriendlyName": "vm1-test", + "networkConnectionStatus": "Connected", + "networkFriendlyName": "vnetavrai", + "subnet": "Subnet1" + } + ], + "affectedObjectDetails": { + "PrimaryVmId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "PrimaryVmName": "vm1", + "RecoveryVmId": "", + "RecoveryVmName": "vm1", + "ProtectionProfileId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "PrimaryCloudId": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryCloudName": "cloud1", + "RecoveryCloudId": "d38048d4-b460-4791-8ece-108395ee8478", + "RecoveryCloudName": "Microsoft Azure", + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "RecoveryVmmName": "Microsoft Azure", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationLogicalNetworks_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationLogicalNetworks_Get.json new file mode 100644 index 000000000000..837c8734c4f3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationLogicalNetworks_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "logicalNetworkName": "87ab394f-165f-4aa9-bd84-b018500b4509", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "name": "87ab394f-165f-4aa9-bd84-b018500b4509", + "properties": { + "friendlyName": "corp", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsNotIsolated" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json new file mode 100644 index 000000000000..a16577d0e1e3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "name": "87ab394f-165f-4aa9-bd84-b018500b4509", + "properties": { + "friendlyName": "corp", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsNotIsolated" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/87ab394f-165f-4aa9-bd84-b018500b4509", + "name": "53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "properties": { + "friendlyName": "LN-VLANNetwork-4", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsIsolated" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Create.json new file mode 100644 index 000000000000..c9c44a6a1eeb --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Create.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "disksToInclude": [ + { + "diskId": "disk1", + "isOSDisk": "true", + "logStorageAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Storage/storageAccounts/logStorageAccount1", + "logStorageAccountSasSecretName": "logStorageSas" + } + ], + "vmwareMachineId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/machines/virtualmachine1", + "targetNetworkId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1", + "targetResourceGroupId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1", + "snapshotRunAsAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/runasaccounts/snapshotRunAsAccount1", + "dataMoverRunAsAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/runasaccounts/dataMoverRunAsAccount1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Delete.json new file mode 100644 index 000000000000..318201241b9b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Get.json new file mode 100644 index 000000000000..6513364ff2a2 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_List.json new file mode 100644 index 000000000000..4f3f27accd63 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..8e23e36557a3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Migrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Migrate.json new file mode 100644 index 000000000000..d68f678c9c6d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Migrate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "migrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "performShutdown": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_PauseReplication.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_PauseReplication.json new file mode 100644 index 000000000000..f4e78cb1c368 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_PauseReplication.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "pauseReplicationInput": { + "properties": { + "instanceType": "VMwareCbt" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "ProtectionSuspended", + "migrationStateDescription": "Paused", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "DisableMigration" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_ResumeReplication.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_ResumeReplication.json new file mode 100644 index 000000000000..3a680fffe918 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_ResumeReplication.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "resumeReplicationInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "deleteMigrationResources": "false" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "ResumeInitiated", + "migrationStateDescription": "Resuming", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "DisableMigration" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Resync.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Resync.json new file mode 100644 index 000000000000..299bd0308587 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Resync.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "skipCbtReset": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_TestMigrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_TestMigrate.json new file mode 100644 index 000000000000..912f3a8bc4c6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_TestMigrate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "recoveryPointId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/9e737191-317e-43d0-8c83-e32ac3b34686", + "networkId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json new file mode 100644 index 000000000000..8bf003c24b15 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateCleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Update.json new file mode 100644 index 000000000000..b7e477cd8455 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationMigrationItems_Update.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Create.json new file mode 100644 index 000000000000..502ca5c30bdd --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2024-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap", + "input": { + "properties": { + "recoveryFabricName": "Microsoft Azure", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "fabricSpecificDetails": { + "instanceType": "VmmToAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Delete.json new file mode 100644 index 000000000000..a8fbcb6176b2 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2024-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Get.json new file mode 100644 index 000000000000..685b930a954b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2024-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_List.json new file mode 100644 index 000000000000..ff65bed5c8f5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServicesBVTD2/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json new file mode 100644 index 000000000000..930e4f6ced30 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2024-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Update.json new file mode 100644 index 000000000000..9c4a735e06db --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworkMappings_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2024-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap", + "input": { + "properties": { + "recoveryFabricName": "Microsoft Azure", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai2", + "fabricSpecificDetails": { + "instanceType": "VmmToAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai2", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai2", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_Get.json new file mode 100644 index 000000000000..e35081cfa453 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2024-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "93ce99d7-1219-4914-aa61-73fe5023988e" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_List.json new file mode 100644 index 000000000000..4f869a4bab35 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_List.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "name": "b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_NoIso", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "name": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "corp", + "networkType": "NoIsolation" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_ListByReplicationFabrics.json new file mode 100644 index 000000000000..96d97505f9ec --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationNetworks_ListByReplicationFabrics.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2024-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "name": "b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_NoIso", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "name": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "corp", + "networkType": "NoIsolation" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Create.json new file mode 100644 index 000000000000..30ddd6b34c1a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Create.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "providerSpecificInput": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Delete.json new file mode 100644 index 000000000000..6d5584fb2a92 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Get.json new file mode 100644 index 000000000000..c4706b9305df --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_List.json new file mode 100644 index 000000000000..06e7f475c241 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Update.json new file mode 100644 index 000000000000..ec8e5b7b46ff --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationPolicies_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "replicationProviderSettings": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectableItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectableItems_Get.json new file mode 100644 index 000000000000..bb1e4d1ba61e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectableItems_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectableItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "name": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm2", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "ReplicationGroupDetails" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..44c3485e2454 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "name": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm2", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "ReplicationGroupDetails" + } + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm1", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "ReplicationGroupDetails" + } + } + } + ], + "nextLink": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems?api-version=2021-06-01&%24skipToken=ReplicationGroup%3aBegin" + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_AddDisks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_AddDisks.json new file mode 100644 index 000000000000..e51a87b661e7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_AddDisks.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "addDisksInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "vmDisks": [ + { + "diskUri": "https://vmstorage.blob.core.windows.net/vhds/datadisk1.vhd", + "recoveryAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/recoveryResource/providers/Microsoft.Storage/storageAccounts/recoverystorage", + "primaryStagingAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/primaryResource/providers/Microsoft.Storage/storageAccounts/vmcachestorage" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json new file mode 100644 index 000000000000..1a413aced4b5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "applyRecoveryPointInput": { + "properties": { + "recoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/e4d05fe9-5dfd-47be-b50b-aad306b2802d", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "UnplannedFailoverCommitPendingStatesBegin", + "protectionStateDescription": "Failover completed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Critical", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T08:42:33.0996129Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/e4d05fe9-5dfd-47be-b50b-aad306b2802d", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Create.json new file mode 100644 index 000000000000..2c6fa029b087 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Create.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Delete.json new file mode 100644 index 000000000000..eb3681501cfc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "disableProtectionInput": { + "properties": { + "replicationProviderInput": { + "instanceType": "DisableProtectionProviderSpecificInput" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_FailoverCancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_FailoverCancel.json new file mode 100644 index 000000000000..d2a0c3bcf097 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_FailoverCancel.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "cloud1", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "cloud1", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2021-02-24T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "1601-01-01T00:00:00.0000000Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "2021-02-24T07:17:23.1358752Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "InMageRcmFailback" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_FailoverCommit.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_FailoverCommit.json new file mode 100644 index 000000000000..e5dd9ab94b8c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_FailoverCommit.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverStatesBegin", + "protectionStateDescription": "Planned failover committed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "DisableProtection", + "Failback" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Get.json new file mode 100644 index 000000000000..5787d79d3072 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_List.json new file mode 100644 index 000000000000..963571fc0402 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_List.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..2e0b8afaa8ec --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_PlannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_PlannedFailover.json new file mode 100644 index 000000000000..c2b44ef0d4b0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_PlannedFailover.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "failoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverCommitRequired", + "protectionStateDescription": "Planned failover finished", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Purge.json new file mode 100644 index 000000000000..9a8be4e1027c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Purge.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_RemoveDisks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_RemoveDisks.json new file mode 100644 index 000000000000..26ae37836701 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_RemoveDisks.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "removeDisksInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "vmDisksUris": [ + "https://vmstorage.blob.core.windows.net/vhds/datadisk1.vhd" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_RepairReplication.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_RepairReplication.json new file mode 100644 index 000000000000..0b1a144d39aa --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_RepairReplication.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Reprotect.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Reprotect.json new file mode 100644 index 000000000000..db7856c3adcf --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Reprotect.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "reprotectInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json new file mode 100644 index 000000000000..701f8c504a0f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "resolveHealthInput": { + "properties": { + "healthErrors": [ + { + "healthErrorId": "3:8020" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_SwitchProvider.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_SwitchProvider.json new file mode 100644 index 000000000000..89ba83e299e1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_SwitchProvider.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "switchProviderInput": { + "properties": { + "targetInstanceType": "InMageRcm", + "providerSpecificDetails": { + "instanceType": "InMageAzureV2", + "targetVaultID": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault2", + "targetFabricID": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "targetApplianceID": "5efaa202-e958-435e-8171-706bf735fcc4" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverCommitRequired", + "protectionStateDescription": "Planned failover finished", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_TestFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_TestFailover.json new file mode 100644 index 000000000000..f4e60e8ca36a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_TestFailover.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "testfailoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "networkType": "VmNetworkAsInput", + "networkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Cleanup test failover pending", + "activeLocation": "Primary", + "testFailoverState": "WaitingForCompletion", + "testFailoverStateDescription": "Waiting for user input", + "allowedOperations": [ + "TestFailoverCleanup" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "TestFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2838f9b4-2609-4f76-a7e9-07e6387c5e98", + "startTime": "2017-04-25T09:57:57.0357829Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/0689d0d0-3518-4793-8c98-c26bf94526f6", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json new file mode 100644 index 000000000000..182b17f905f8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "cleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UnplannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UnplannedFailover.json new file mode 100644 index 000000000000..be5ee56f4095 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UnplannedFailover.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "failoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "sourceSiteOperations": "NotRequired", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "UnplannedFailoverCommitPendingStatesBegin", + "protectionStateDescription": "Failover completed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T08:42:33.0996129Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b2c7b208-0999-40a4-804f-8ee1019c8f76", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Update.json new file mode 100644 index 000000000000..657eb5d399a4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "updateProtectionInput": { + "properties": { + "recoveryAzureVMName": "vm1", + "recoveryAzureVMSize": "Basic_A0", + "selectedRecoveryAzureNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "vmNics": [ + { + "nicId": "TWljcm9zb2Z0OkY4NDkxRTRGLTgxN0EtNDBERC1BOTBDLUFGNzczOTc4Qzc1Qlw3NjAwMzMxRS03NDk4LTQ0QTQtQjdDNy0xQjY1NkJDREQ1MkQ=", + "selectionType": "SelectedByUser", + "ipConfigs": [ + { + "ipConfigName": "ipconfig1", + "isPrimary": true, + "recoverySubnetName": "subnet1", + "recoveryStaticIPAddress": "10.0.2.46" + } + ] + } + ], + "licenseType": "WindowsServer", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UpdateAppliance.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UpdateAppliance.json new file mode 100644 index 000000000000..95a271dfea92 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UpdateAppliance.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "idclab-vcen67_50158124-8857-3e08-0893-2ddf8ebb8c1f", + "protectionContainerName": "Ayan-0106-SA-Vaultreplicationcontainer", + "fabricName": "Ayan-0106-SA-Vaultreplicationfabric", + "resourceName": "Ayan-0106-SA-Vault", + "resourceGroupName": "Ayan-0106-SA-RG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "applianceUpdateInput": { + "properties": { + "targetApplianceId": "", + "providerSpecificDetails": { + "instanceType": "InMageRcm", + "runAsAccountId": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationFabrics/Ayan-0106-SA-Vaultreplicationfabric/replicationProtectionContainers/Ayan-0106-SA-Vaultreplicationcontainer/replicationProtectedItems/idclab-vcen67_50158124-8857-3e08-0893-2ddf8ebb8c1f", + "name": "idclab-vcen67_50158124-8857-3e08-0893-2ddf8ebb8c1f", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "Ayan-RHEL7-Test2", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationFabrics/Ayan-0106-SA-Vaultreplicationfabric/replicationRecoveryServicesProviders/a552cf2d-bbb3-4d78-8145-e1992ecb31d1", + "primaryFabricFriendlyName": "Ayan-0106-SA-Vaultreplicationfabric", + "primaryFabricProvider": "InMageRcmFabric", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "Ayan-0106-SA-Vaultreplicationcontainer", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationPolicies/24-hour-replication-policy", + "policyFriendlyName": "24-hour-replication-policy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "InMageRcm" + }, + "recoveryContainerId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478", + "eventCorrelationId": "fb40d161-cffd-44d9-a252-0b7978e1f73c" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UpdateMobilityService.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UpdateMobilityService.json new file mode 100644 index 000000000000..f46a8c41d89d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectedItems_UpdateMobilityService.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "79dd20ab-2b40-11e7-9791-0050568f387e", + "protectionContainerName": "cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0", + "fabricName": "WIN-JKKJ31QI8U2", + "resourceName": "WCUSVault", + "resourceGroupName": "wcusValidations", + "subscriptionId": "b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c", + "updateMobilityServiceRequest": { + "properties": { + "runAsAccountId": "2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "79dd20ab-2b40-11e7-9791-0050568f387e", + "id": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationProtectionContainers/cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0/replicationProtectedItems/79dd20ab-2b40-11e7-9791-0050568f387e", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "MMR-LIN-V2A-3", + "protectedItemType": "", + "protectableItemId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationProtectionContainers/cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0/replicationProtectableItems/79dd20ab-2b40-11e7-9791-0050568f387e", + "recoveryServicesProviderId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationRecoveryServicesProviders/c6780228-83bd-4f3e-a70e-cb46b7da33a0", + "primaryFabricFriendlyName": "WIN-JKKJ31QI8U2", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "WIN-JKKJ31QI8U2", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationPolicies/MadhaviPolicyNew", + "policyFriendlyName": "MadhaviPolicyNew", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "InMageAzureV2" + }, + "recoveryContainerId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_ApplyRecoveryPoint.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_ApplyRecoveryPoint.json new file mode 100644 index 000000000000..dd9b6e284bfe --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_ApplyRecoveryPoint.json @@ -0,0 +1,178 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "testcluster", + "protectionContainerName": "pri-cloud-eastus", + "fabricName": "fabric-pri-eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "applyClusterRecoveryPointInput": { + "properties": { + "clusterRecoveryPointId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/shashankvaultpvt/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "individualNodeRecoveryPoints": [ + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/shashankvaultpvt/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/testVM/recoveryPoints/b5c2051b-79e3-41ad-9d25-244f6ef8ce7d" + ], + "providerSpecificDetails": { + "instanceType": "A2A" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster", + "name": "testcluster", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": "WindowsServerFailoverCluster", + "primaryFabricFriendlyName": "East US", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "West US", + "recoveryFabricId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus", + "primaryProtectionContainerFriendlyName": "East US", + "recoveryProtectionContainerFriendlyName": "pri-cloud-eastus", + "protectionState": "FailoverCompleted", + "protectionStateDescription": "Failover completed.", + "activeLocation": "Recovery", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "CommitFailoverProtectionCluster", + "ChangePitProtectionCluster", + "PurgeProtectionCluster" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": "2024-01-22T09:31:13.1605059Z", + "lastSuccessfulTestFailoverTime": "2024-01-22T06:08:01.7440966Z", + "policyFriendlyName": "klncksan", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "recoveryContainerId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus/replicationProtectionContainers/rec-cloud-westus", + "agentClusterId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "clusterFqdn": "sdgqlc", + "clusterNodeFqdns": [ + "sdgql0", + "sdgql1" + ], + "clusterProtectedItemIds": [ + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/yNdYnDYKZ7hYU7zyVeBychFBCyAbEkrJcJNUarDrXio", + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/kdUdWvpVnm3QgOQPHoVMX8YAtAO8OC4kKNjt40ERSr4" + ], + "provisioningState": "Created", + "areAllClusterNodesRegistered": true, + "clusterRegisteredNodes": [ + { + "clusterNodeFqdn": "sdgql0", + "machineId": "3794026b-6792-4d12-9c0c-de0c79376c90", + "biosId": "37D0059C-9118-4220-AA1D-58A10EFA7660", + "isSharedDiskVirtualNode": false + }, + { + "clusterNodeFqdn": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "machineId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "biosId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "isSharedDiskVirtualNode": true + }, + { + "clusterNodeFqdn": "sdgql1", + "machineId": "cb27913a-a5f2-4691-9eba-78b67f45a57a", + "biosId": "83CCE932-67EC-4C13-AB29-ACF5F8F7ED48", + "isSharedDiskVirtualNode": false + } + ], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": "a7ef77cb-ae59-545f-a32a-bf30575ab1c6", + "multiVmGroupName": "testcluster", + "multiVmGroupCreateOption": "UserSpecified", + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "clusterManagementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "rpoInSeconds": 3213, + "lastRpoCalculatedTime": "2024-01-22T10:19:11.0490433Z", + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "westus", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": "3d523ab9-8c6d-40af-850d-ccee06513dc6" + }, + "sharedDiskProperties": { + "protectionState": "UnplannedFailoverCommitRequired", + "testFailoverState": "None", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "unprotectedDisks": null, + "protectedManagedDisks": [ + { + "diskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourcegroups/clustertestrg-19-01/providers/microsoft.compute/disks/sdgql-datadisk0", + "recoveryResourceGroupId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr", + "recoveryTargetDiskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr/providers/Microsoft.Compute/disks/sdgql-datadisk0", + "recoveryReplicaDiskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr/providers/Microsoft.Compute/disks/sdgql-datadisk0-ASRReplica", + "recoveryOrignalTargetDiskId": null, + "recoveryReplicaDiskAccountType": "Premium_LRS", + "recoveryTargetDiskAccountType": "Premium_LRS", + "recoveryDiskEncryptionSetId": null, + "primaryDiskEncryptionSetId": null, + "diskName": "sdgql-datadisk0", + "diskCapacityInBytes": 274877906944, + "primaryStagingAzureStorageAccountId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.Storage/storageAccounts/ix701lshashankvaasrcache", + "diskType": "Data", + "resyncRequired": false, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "dataPendingInStagingStorageAccountInMB": 0.0, + "dataPendingAtSourceAgentInMB": 0.0, + "diskState": "Protected", + "allowedDiskLevelOperation": [], + "isDiskEncrypted": false, + "secretIdentifier": null, + "dekKeyVaultArmId": null, + "isDiskKeyEncrypted": false, + "keyIdentifier": null, + "kekKeyVaultArmId": null, + "failoverDiskName": "sdgql-datadisk0", + "tfoDiskName": "sdgql-datadisk0-ASRtest" + } + ], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": 10, + "lastRpoCalculatedTime": "2024-01-22T09:20:35.9303505Z", + "sharedDiskIRErrors": null + } + }, + "policyId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/klncksan" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/operationresults/76e220ab-8ae8-4047-b6e0-e6c0f6fc2241?api-version=2024-04-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/49660b52-ccaa-4f22-87p6-a9c8f0b17674?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Create.json new file mode 100644 index 000000000000..4889443e4915 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Create.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "cluster12", + "protectionContainerName": "eastus-container", + "fabricName": "eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "replicationProtectionCluster": { + "properties": { + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/24-hour-retention-policy", + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap/replicationProtectionContainers/centraluseuap-container", + "providerSpecificDetails": { + "instanceType": "A2A" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectionClusters/cluster12", + "name": "cluster12", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": null, + "primaryFabricFriendlyName": "eastus", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "centraluseuap", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap", + "primaryProtectionContainerFriendlyName": "eastus", + "recoveryProtectionContainerFriendlyName": "eastus-container", + "protectionState": "NotProtected", + "protectionStateDescription": "NotProtected", + "activeLocation": "Primary", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": null, + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/24-hour-retention-policy", + "policyFriendlyName": "24-hour-retention-policy", + "currentScenario": null, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap/replicationProtectionContainers/centraluseuap-container", + "agentClusterId": null, + "clusterFqdn": null, + "clusterNodeFqdns": [], + "clusterProtectedItemIds": [], + "provisioningState": "Created", + "areAllClusterNodesRegistered": false, + "clusterRegisteredNodes": [], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": null, + "multiVmGroupName": null, + "multiVmGroupCreateOption": null, + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "clusterManagementId": "4b8c1c01-5ad7-4958-a98d-daf7cca6a124", + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "centraluseuap", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": "d5f6f011-7ef5-4c78-80fe-6e1b28401c4d" + }, + "sharedDiskProperties": { + "protectionState": "EnablingProtection", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "4b8c1c01-5ad7-4958-a98d-daf7cca6a124", + "unprotectedDisks": null, + "protectedManagedDisks": [], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "sharedDiskIRErrors": null + } + } + } + } + }, + "201": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectionClusters/cluster12/operationresults/bcf9605f-1611-484c-8f52-4eb0c076d0f8?api-version=2024-04-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/bcf9605f-1611-484c-8f52-4eb0c076d0f8?api-version=2024-04-01", + "Retry-After": 30 + }, + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectionClusters/cluster12", + "name": "cluster12", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": null, + "primaryFabricFriendlyName": "eastus", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "centraluseuap", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap", + "primaryProtectionContainerFriendlyName": "eastus", + "recoveryProtectionContainerFriendlyName": "eastus-container", + "protectionState": "NotProtected", + "protectionStateDescription": "NotProtected", + "activeLocation": "Primary", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": null, + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/24-hour-retention-policy", + "policyFriendlyName": "24-hour-retention-policy", + "currentScenario": null, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap/replicationProtectionContainers/centraluseuap-container", + "agentClusterId": null, + "clusterFqdn": null, + "clusterNodeFqdns": [], + "clusterProtectedItemIds": [], + "provisioningState": "Created", + "areAllClusterNodesRegistered": false, + "clusterRegisteredNodes": [], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": null, + "multiVmGroupName": null, + "multiVmGroupCreateOption": null, + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "clusterManagementId": "4b8c1c01-5ad7-4958-a98d-daf7cca6a124", + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "centraluseuap", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": "d5f6f011-7ef5-4c78-80fe-6e1b28401c4d" + }, + "sharedDiskProperties": { + "protectionState": "EnablingProtection", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "4b8c1c01-5ad7-4958-a98d-daf7cca6a124", + "unprotectedDisks": null, + "protectedManagedDisks": [], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "sharedDiskIRErrors": null + } + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_FailoverCommit.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_FailoverCommit.json new file mode 100644 index 000000000000..02716583b32b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_FailoverCommit.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "testcluster", + "protectionContainerName": "pri-cloud-eastus", + "fabricName": "fabric-pri-eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster", + "name": "testcluster", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": "WindowsServerFailoverCluster", + "primaryFabricFriendlyName": "East US", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "West US", + "recoveryFabricId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus", + "primaryProtectionContainerFriendlyName": "East US", + "recoveryProtectionContainerFriendlyName": "pri-cloud-eastus", + "protectionState": "FailoverCommited", + "protectionStateDescription": "Failover committed.", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PurgeProtectionCluster" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": "2024-01-22T09:31:13.1605059Z", + "lastSuccessfulTestFailoverTime": "2024-01-22T06:08:01.7440966Z", + "policyFriendlyName": "klncksan", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "recoveryContainerId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus/replicationProtectionContainers/rec-cloud-westus", + "agentClusterId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "clusterFqdn": "sdgqlc", + "clusterNodeFqdns": [ + "sdgql0", + "sdgql1" + ], + "clusterProtectedItemIds": [ + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/yNdYnDYKZ7hYU7zyVeBychFBCyAbEkrJcJNUarDrXio", + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/kdUdWvpVnm3QgOQPHoVMX8YAtAO8OC4kKNjt40ERSr4" + ], + "provisioningState": "Created", + "areAllClusterNodesRegistered": true, + "clusterRegisteredNodes": [ + { + "clusterNodeFqdn": "sdgql0", + "machineId": "3794026b-6792-4d12-9c0c-de0c79376c90", + "biosId": "37D0059C-9118-4220-AA1D-58A10EFA7660", + "isSharedDiskVirtualNode": false + }, + { + "clusterNodeFqdn": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "machineId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "biosId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "isSharedDiskVirtualNode": true + }, + { + "clusterNodeFqdn": "sdgql1", + "machineId": "cb27913a-a5f2-4691-9eba-78b67f45a57a", + "biosId": "83CCE932-67EC-4C13-AB29-ACF5F8F7ED48", + "isSharedDiskVirtualNode": false + } + ], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": "a7ef77cb-ae59-545f-a32a-bf30575ab1c6", + "multiVmGroupName": "testcluster", + "multiVmGroupCreateOption": "UserSpecified", + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "clusterManagementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "rpoInSeconds": 156107, + "lastRpoCalculatedTime": "2024-01-24T04:47:24.3271066Z", + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "westus", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": "3d523ab9-8c6d-40af-850d-ccee06513dc6" + }, + "sharedDiskProperties": { + "protectionState": "UnplannedFailoverCommitted", + "testFailoverState": "None", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "unprotectedDisks": null, + "protectedManagedDisks": [ + { + "diskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourcegroups/clustertestrg-19-01/providers/microsoft.compute/disks/sdgql-datadisk0", + "recoveryResourceGroupId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr", + "recoveryTargetDiskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr/providers/Microsoft.Compute/disks/sdgql-datadisk0", + "recoveryReplicaDiskId": "", + "recoveryOrignalTargetDiskId": null, + "recoveryReplicaDiskAccountType": "Premium_LRS", + "recoveryTargetDiskAccountType": "Premium_LRS", + "recoveryDiskEncryptionSetId": null, + "primaryDiskEncryptionSetId": null, + "diskName": "sdgql-datadisk0", + "diskCapacityInBytes": 274877906944, + "primaryStagingAzureStorageAccountId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.Storage/storageAccounts/ix701lshashankvaasrcache", + "diskType": "Data", + "resyncRequired": false, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "dataPendingInStagingStorageAccountInMB": 0.0, + "dataPendingAtSourceAgentInMB": 0.0, + "diskState": "Protected", + "allowedDiskLevelOperation": [], + "isDiskEncrypted": false, + "secretIdentifier": null, + "dekKeyVaultArmId": null, + "isDiskKeyEncrypted": false, + "keyIdentifier": null, + "kekKeyVaultArmId": null, + "failoverDiskName": "sdgql-datadisk0", + "tfoDiskName": "sdgql-datadisk0-ASRtest" + } + ], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": 10, + "lastRpoCalculatedTime": "2024-01-22T09:20:35.9303505Z", + "sharedDiskIRErrors": null + } + }, + "policyId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/klncksan" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/operationresults/76e220ab-8ae8-4047-b6e0-e6c0f6fc2241?api-version=2024-04-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/76e220ab-8ae8-4047-b6e0-e6c0f6fc2241?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Get.json new file mode 100644 index 000000000000..9544ca53712b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Get.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "cluster1", + "protectionContainerName": "eastus-container", + "fabricName": "eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectionClusters/cluster1", + "name": "cluster1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": "WindowsServerFailoverCluster", + "primaryFabricFriendlyName": "eastus", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "centraluseuap", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap", + "primaryProtectionContainerFriendlyName": "eastus", + "recoveryProtectionContainerFriendlyName": "eastus-container", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": null, + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/24-hour-retention-policy", + "policyFriendlyName": "24-hour-retention-policy", + "currentScenario": null, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap/replicationProtectionContainers/centraluseuap-container", + "agentClusterId": "dd9925cf-5f90-49e9-bd6d-d4cbdcec956b", + "clusterFqdn": "ad45f2fc-f9d6-42ac-8a7c-1c5380c88c28", + "clusterNodeFqdns": [], + "clusterProtectedItemIds": [ + "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectedItems/cluster2vm0", + "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectedItems/cluster2vm1" + ], + "provisioningState": "Created", + "areAllClusterNodesRegistered": true, + "clusterRegisteredNodes": [ + { + "clusterNodeFqdn": "VM0", + "machineId": "a7eaf02d-60d9-45be-a444-d1b945f1c7b2", + "biosId": "eed7a457-b11f-420e-8e4f-384833a6b7c9", + "isSharedDiskVirtualNode": true + } + ], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": "4c2988ed-7e2a-566e-9c5f-c33835621e83", + "multiVmGroupName": "multiVmGroupName1111", + "multiVmGroupCreateOption": "UserSpecified", + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "clusterManagementId": "1ed32804-ae51-4752-9448-9f686ae27d7b", + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "centraluseuap", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": null + }, + "sharedDiskProperties": { + "protectionState": "Protected", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "1ed32804-ae51-4752-9448-9f686ae27d7b", + "unprotectedDisks": [ + { + "diskLunId": 1, + "diskAutoProtectionStatus": "Disabled" + }, + { + "diskLunId": 2, + "diskAutoProtectionStatus": "Disabled" + } + ], + "protectedManagedDisks": [ + { + "diskId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/resourceGroupPS2/providers/microsoft.compute/disks/cluster2-datadisk0", + "recoveryResourceGroupId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1", + "recoveryTargetDiskId": null, + "recoveryReplicaDiskId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Compute/disks/cluster2-datadisk0-ASRReplica", + "recoveryOrignalTargetDiskId": null, + "recoveryReplicaDiskAccountType": "Premium_LRS", + "recoveryTargetDiskAccountType": "Premium_LRS", + "recoveryDiskEncryptionSetId": null, + "primaryDiskEncryptionSetId": null, + "diskName": "cluster2-datadisk0", + "diskCapacityInBytes": 0, + "primaryStagingAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS2/providers/Microsoft.Storage/storageAccounts/eastus1210192341", + "diskType": "Data", + "resyncRequired": true, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "dataPendingInStagingStorageAccountInMB": 100.0, + "dataPendingAtSourceAgentInMB": 10.0, + "diskState": "Unavailable", + "allowedDiskLevelOperation": [], + "isDiskEncrypted": false, + "secretIdentifier": null, + "dekKeyVaultArmId": null, + "isDiskKeyEncrypted": false, + "keyIdentifier": null, + "kekKeyVaultArmId": null, + "failoverDiskName": "cluster2-datadisk0", + "tfoDiskName": "cluster2-datadisk0-ASRtest" + } + ], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": 300, + "lastRpoCalculatedTime": "2022-11-11T07:34:58.856Z", + "sharedDiskIRErrors": null + } + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_GetOperationResults.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_GetOperationResults.json new file mode 100644 index 000000000000..25a677c972ad --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_GetOperationResults.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "cluster1", + "protectionContainerName": "eastus-container", + "fabricName": "eastus", + "jobId": "ea63a935-59d5-4b12-aff2-98773f63c116", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectionClusters/cluster12", + "name": "cluster12", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": null, + "primaryFabricFriendlyName": "eastus", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "centraluseuap", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap", + "primaryProtectionContainerFriendlyName": "eastus", + "recoveryProtectionContainerFriendlyName": "eastus-container", + "protectionState": "NotProtected", + "protectionStateDescription": "NotProtected", + "activeLocation": "Primary", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": null, + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/24-hour-retention-policy", + "policyFriendlyName": "24-hour-retention-policy", + "currentScenario": null, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap/replicationProtectionContainers/centraluseuap-container", + "agentClusterId": null, + "clusterFqdn": null, + "clusterNodeFqdns": [], + "clusterProtectedItemIds": [], + "provisioningState": "Created", + "areAllClusterNodesRegistered": false, + "clusterRegisteredNodes": [], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": null, + "multiVmGroupName": null, + "multiVmGroupCreateOption": null, + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "clusterManagementId": "4b8c1c01-5ad7-4958-a98d-daf7cca6a124", + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "centraluseuap", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": "d5f6f011-7ef5-4c78-80fe-6e1b28401c4d" + }, + "sharedDiskProperties": { + "protectionState": "EnablingProtection", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "4b8c1c01-5ad7-4958-a98d-daf7cca6a124", + "unprotectedDisks": null, + "protectedManagedDisks": [], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "sharedDiskIRErrors": null + } + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_List.json new file mode 100644 index 000000000000..dd3e4adcc72f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectionClusters/cluster1", + "name": "cluster1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": "WindowsServerFailoverCluster", + "primaryFabricFriendlyName": "eastus", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "centraluseuap", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap", + "primaryProtectionContainerFriendlyName": "eastus", + "recoveryProtectionContainerFriendlyName": "eastus-container", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": null, + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/24-hour-retention-policy", + "policyFriendlyName": "24-hour-retention-policy", + "currentScenario": null, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap/replicationProtectionContainers/centraluseuap-container", + "agentClusterId": "dd9925cf-5f90-49e9-bd6d-d4cbdcec956b", + "clusterFqdn": "ad45f2fc-f9d6-42ac-8a7c-1c5380c88c28", + "clusterNodeFqdns": [], + "clusterProtectedItemIds": [ + "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectedItems/cluster2vm0", + "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectedItems/cluster2vm1" + ], + "provisioningState": "Created", + "areAllClusterNodesRegistered": true, + "clusterRegisteredNodes": [ + { + "clusterNodeFqdn": "VM0", + "machineId": "a7eaf02d-60d9-45be-a444-d1b945f1c7b2", + "biosId": "eed7a457-b11f-420e-8e4f-384833a6b7c9", + "isSharedDiskVirtualNode": true + } + ], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": "4c2988ed-7e2a-566e-9c5f-c33835621e83", + "multiVmGroupName": "multiVmGroupName1111", + "multiVmGroupCreateOption": "UserSpecified", + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "clusterManagementId": "1ed32804-ae51-4752-9448-9f686ae27d7b", + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "centraluseuap", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": null + }, + "sharedDiskProperties": { + "protectionState": "Protected", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "1ed32804-ae51-4752-9448-9f686ae27d7b", + "unprotectedDisks": null, + "protectedManagedDisks": null, + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": 300, + "lastRpoCalculatedTime": "2022-11-11T07:34:58.856Z", + "sharedDiskIRErrors": null + } + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..b3c40e2d87b5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_ListByReplicationProtectionContainers.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "protectionContainerName": "eastus-container", + "fabricName": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectionClusters/cluster1", + "name": "cluster1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": "WindowsServerFailoverCluster", + "primaryFabricFriendlyName": "eastus", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "centraluseuap", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap", + "primaryProtectionContainerFriendlyName": "eastus", + "recoveryProtectionContainerFriendlyName": "eastus-container", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": null, + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/24-hour-retention-policy", + "policyFriendlyName": "24-hour-retention-policy", + "currentScenario": null, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap/replicationProtectionContainers/centraluseuap-container", + "agentClusterId": "dd9925cf-5f90-49e9-bd6d-d4cbdcec956b", + "clusterFqdn": "ad45f2fc-f9d6-42ac-8a7c-1c5380c88c28", + "clusterNodeFqdns": [], + "clusterProtectedItemIds": [ + "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectedItems/cluster2vm0", + "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectedItems/cluster2vm1" + ], + "provisioningState": "Created", + "areAllClusterNodesRegistered": true, + "clusterRegisteredNodes": [ + { + "clusterNodeFqdn": "VM0", + "machineId": "a7eaf02d-60d9-45be-a444-d1b945f1c7b2", + "biosId": "eed7a457-b11f-420e-8e4f-384833a6b7c9", + "isSharedDiskVirtualNode": true + } + ], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": "4c2988ed-7e2a-566e-9c5f-c33835621e83", + "multiVmGroupName": "multiVmGroupName1111", + "multiVmGroupCreateOption": "UserSpecified", + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "clusterManagementId": "1ed32804-ae51-4752-9448-9f686ae27d7b", + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "centraluseuap", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": null + }, + "sharedDiskProperties": { + "protectionState": "Protected", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "1ed32804-ae51-4752-9448-9f686ae27d7b", + "unprotectedDisks": null, + "protectedManagedDisks": null, + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": 300, + "lastRpoCalculatedTime": "2022-11-11T07:34:58.856Z", + "sharedDiskIRErrors": null + } + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Purge.json new file mode 100644 index 000000000000..4c79d0fff073 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_Purge.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "cluster1", + "protectionContainerName": "eastus-container", + "fabricName": "eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectionClusters/cluster12/operationresults/bcf9605f-1611-484c-8f52-4eb0c076d0f8?api-version=2024-04-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/bcf9605f-1611-484c-8f52-4eb0c076d0f8?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_RepairReplication.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_RepairReplication.json new file mode 100644 index 000000000000..57a0f87da8d7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_RepairReplication.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "cluster12", + "protectionContainerName": "eastus-container", + "fabricName": "eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectionClusters/cluster1", + "name": "cluster1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": "WindowsServerFailoverCluster", + "primaryFabricFriendlyName": "eastus", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "centraluseuap", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap", + "primaryProtectionContainerFriendlyName": "eastus", + "recoveryProtectionContainerFriendlyName": "eastus-container", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": null, + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/24-hour-retention-policy", + "policyFriendlyName": "24-hour-retention-policy", + "currentScenario": null, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/centraluseuap/replicationProtectionContainers/centraluseuap-container", + "agentClusterId": "dd9925cf-5f90-49e9-bd6d-d4cbdcec956b", + "clusterFqdn": "ad45f2fc-f9d6-42ac-8a7c-1c5380c88c28", + "clusterNodeFqdns": [], + "clusterProtectedItemIds": [ + "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectedItems/cluster2vm0", + "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/eastus/replicationProtectionContainers/eastus-container/replicationProtectedItems/cluster2vm1" + ], + "provisioningState": "Created", + "areAllClusterNodesRegistered": true, + "clusterRegisteredNodes": [ + { + "clusterNodeFqdn": "VM0", + "machineId": "a7eaf02d-60d9-45be-a444-d1b945f1c7b2", + "biosId": "eed7a457-b11f-420e-8e4f-384833a6b7c9", + "isSharedDiskVirtualNode": true + } + ], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": "4c2988ed-7e2a-566e-9c5f-c33835621e83", + "multiVmGroupName": "multiVmGroupName1111", + "multiVmGroupCreateOption": "UserSpecified", + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "clusterManagementId": "1ed32804-ae51-4752-9448-9f686ae27d7b", + "rpoInSeconds": null, + "lastRpoCalculatedTime": null, + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "centraluseuap", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": null + }, + "sharedDiskProperties": { + "protectionState": "Protected", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "1ed32804-ae51-4752-9448-9f686ae27d7b", + "unprotectedDisks": [ + { + "diskLunId": 1, + "diskAutoProtectionStatus": "Disabled" + }, + { + "diskLunId": 2, + "diskAutoProtectionStatus": "Disabled" + } + ], + "protectedManagedDisks": [ + { + "diskId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/resourceGroupPS2/providers/microsoft.compute/disks/cluster2-datadisk0", + "recoveryResourceGroupId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1", + "recoveryTargetDiskId": null, + "recoveryReplicaDiskId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Compute/disks/cluster2-datadisk0-ASRReplica", + "recoveryOrignalTargetDiskId": null, + "recoveryReplicaDiskAccountType": "Premium_LRS", + "recoveryTargetDiskAccountType": "Premium_LRS", + "recoveryDiskEncryptionSetId": null, + "primaryDiskEncryptionSetId": null, + "diskName": "cluster2-datadisk0", + "diskCapacityInBytes": 0, + "primaryStagingAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS2/providers/Microsoft.Storage/storageAccounts/eastus1210192341", + "diskType": "Data", + "resyncRequired": true, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "dataPendingInStagingStorageAccountInMB": 100.0, + "dataPendingAtSourceAgentInMB": 10.0, + "diskState": "Unavailable", + "allowedDiskLevelOperation": [], + "isDiskEncrypted": false, + "secretIdentifier": null, + "dekKeyVaultArmId": null, + "isDiskKeyEncrypted": false, + "keyIdentifier": null, + "kekKeyVaultArmId": null, + "failoverDiskName": "cluster2-datadisk0", + "tfoDiskName": "cluster2-datadisk0-ASRtest" + } + ], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "centraluseuap", + "failoverRecoveryPointId": null, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": 300, + "lastRpoCalculatedTime": "2022-11-11T07:34:58.856Z", + "sharedDiskIRErrors": null + } + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/operationresults/76e220ab-8ae8-4047-b6e0-e6c0f6fc2241?api-version=2024-04-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/bcf9605f-1611-484c-8f52-4eb0c076d0f8?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_TestFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_TestFailover.json new file mode 100644 index 000000000000..41340c28e291 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_TestFailover.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "testcluster", + "protectionContainerName": "pri-cloud-eastus", + "fabricName": "fabric-pri-eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "failoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "networkType": "VmNetworkAsInput", + "networkId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr/providers/Microsoft.Network/virtualNetworks/adVNET-asr", + "providerSpecificDetails": { + "instanceType": "A2A", + "clusterRecoveryPointId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "individualNodeRecoveryPoints": [ + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/testVM/recoveryPoints/b5c2051b-79e3-41ad-9d25-244f6ef8ce7d" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster", + "name": "testcluster", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": "WindowsServerFailoverCluster", + "primaryFabricFriendlyName": "East US", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "West US", + "recoveryFabricId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus", + "primaryProtectionContainerFriendlyName": "East US", + "recoveryProtectionContainerFriendlyName": "pri-cloud-eastus", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "WaitingForCleanup", + "testFailoverStateDescription": "Waiting for Test Failover Cleanup to start", + "allowedOperations": [ + "ClusterTestFailoverCleanup", + "PurgeProtectionCluster" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": null, + "lastSuccessfulTestFailoverTime": "2024-01-22T06:08:01.7440966Z", + "policyFriendlyName": "klncksan", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "recoveryContainerId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus/replicationProtectionContainers/rec-cloud-westus", + "agentClusterId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "clusterFqdn": "sdgqlc", + "clusterNodeFqdns": [ + "sdgql0", + "sdgql1" + ], + "clusterProtectedItemIds": [ + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/yNdYnDYKZ7hYU7zyVeBychFBCyAbEkrJcJNUarDrXio", + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/kdUdWvpVnm3QgOQPHoVMX8YAtAO8OC4kKNjt40ERSr4" + ], + "provisioningState": "Created", + "areAllClusterNodesRegistered": true, + "clusterRegisteredNodes": [ + { + "clusterNodeFqdn": "sdgql0", + "machineId": "3794026b-6792-4d12-9c0c-de0c79376c90", + "biosId": "37D0059C-9118-4220-AA1D-58A10EFA7660", + "isSharedDiskVirtualNode": false + }, + { + "clusterNodeFqdn": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "machineId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "biosId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "isSharedDiskVirtualNode": true + }, + { + "clusterNodeFqdn": "sdgql1", + "machineId": "cb27913a-a5f2-4691-9eba-78b67f45a57a", + "biosId": "83CCE932-67EC-4C13-AB29-ACF5F8F7ED48", + "isSharedDiskVirtualNode": false + } + ], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": "a7ef77cb-ae59-545f-a32a-bf30575ab1c6", + "multiVmGroupName": "testcluster", + "multiVmGroupCreateOption": "UserSpecified", + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": null, + "clusterManagementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "rpoInSeconds": 192, + "lastRpoCalculatedTime": "2024-01-22T06:12:49.8370065Z", + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "westus", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": "3d523ab9-8c6d-40af-850d-ccee06513dc6" + }, + "sharedDiskProperties": { + "protectionState": "Protected", + "testFailoverState": "WaitingForCompletion", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "unprotectedDisks": null, + "protectedManagedDisks": [ + { + "diskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourcegroups/clustertestrg-19-01/providers/microsoft.compute/disks/sdgql-datadisk0", + "recoveryResourceGroupId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr", + "recoveryTargetDiskId": null, + "recoveryReplicaDiskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr/providers/Microsoft.Compute/disks/sdgql-datadisk0-ASRReplica", + "recoveryOrignalTargetDiskId": null, + "recoveryReplicaDiskAccountType": "Premium_LRS", + "recoveryTargetDiskAccountType": "Premium_LRS", + "recoveryDiskEncryptionSetId": null, + "primaryDiskEncryptionSetId": null, + "diskName": "sdgql-datadisk0", + "diskCapacityInBytes": 274877906944, + "primaryStagingAzureStorageAccountId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.Storage/storageAccounts/ix701lshashankvaasrcache", + "diskType": "Data", + "resyncRequired": false, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "dataPendingInStagingStorageAccountInMB": 0.0, + "dataPendingAtSourceAgentInMB": 0.0, + "diskState": "Protected", + "allowedDiskLevelOperation": [], + "isDiskEncrypted": false, + "secretIdentifier": null, + "dekKeyVaultArmId": null, + "isDiskKeyEncrypted": false, + "keyIdentifier": null, + "kekKeyVaultArmId": null, + "failoverDiskName": "sdgql-datadisk0", + "tfoDiskName": "sdgql-datadisk0-ASRtest" + } + ], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": null, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": 195, + "lastRpoCalculatedTime": "2024-01-22T06:12:52.499131Z", + "sharedDiskIRErrors": null + } + }, + "policyId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/klncksan" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/operationresults/76e220ab-8ae8-4047-b6e0-e6c0f6fc2241?api-version=2024-04-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/49660b52-ccaa-4f22-87d6-a9c8f0b17674?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_TestFailoverCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_TestFailoverCleanup.json new file mode 100644 index 000000000000..fd80ef8b61ca --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_TestFailoverCleanup.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "testcluster", + "protectionContainerName": "pri-cloud-eastus", + "fabricName": "fabric-pri-eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "cleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster", + "name": "testcluster", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": "WindowsServerFailoverCluster", + "primaryFabricFriendlyName": "East US", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "West US", + "recoveryFabricId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus", + "primaryProtectionContainerFriendlyName": "East US", + "recoveryProtectionContainerFriendlyName": "pri-cloud-eastus", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PurgeProtectionCluster", + "UnplannedFailoverProtectionCluster", + "TestFailoverProtectionCluster" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": null, + "lastSuccessfulTestFailoverTime": "2024-01-22T06:08:01.7440966Z", + "policyFriendlyName": "klncksan", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "recoveryContainerId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus/replicationProtectionContainers/rec-cloud-westus", + "agentClusterId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "clusterFqdn": "sdgqlc", + "clusterNodeFqdns": [ + "sdgql0", + "sdgql1" + ], + "clusterProtectedItemIds": [ + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/yNdYnDYKZ7hYU7zyVeBychFBCyAbEkrJcJNUarDrXio", + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/kdUdWvpVnm3QgOQPHoVMX8YAtAO8OC4kKNjt40ERSr4" + ], + "provisioningState": "Created", + "areAllClusterNodesRegistered": true, + "clusterRegisteredNodes": [ + { + "clusterNodeFqdn": "sdgql0", + "machineId": "3794026b-6792-4d12-9c0c-de0c79376c90", + "biosId": "37D0059C-9118-4220-AA1D-58A10EFA7660", + "isSharedDiskVirtualNode": false + }, + { + "clusterNodeFqdn": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "machineId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "biosId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "isSharedDiskVirtualNode": true + }, + { + "clusterNodeFqdn": "sdgql1", + "machineId": "cb27913a-a5f2-4691-9eba-78b67f45a57a", + "biosId": "83CCE932-67EC-4C13-AB29-ACF5F8F7ED48", + "isSharedDiskVirtualNode": false + } + ], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": "a7ef77cb-ae59-545f-a32a-bf30575ab1c6", + "multiVmGroupName": "testcluster", + "multiVmGroupCreateOption": "UserSpecified", + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": null, + "clusterManagementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "rpoInSeconds": 258, + "lastRpoCalculatedTime": "2024-01-22T09:14:51.8546369Z", + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "westus", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": "3d523ab9-8c6d-40af-850d-ccee06513dc6" + }, + "sharedDiskProperties": { + "protectionState": "Protected", + "testFailoverState": "None", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "unprotectedDisks": null, + "protectedManagedDisks": [ + { + "diskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourcegroups/clustertestrg-19-01/providers/microsoft.compute/disks/sdgql-datadisk0", + "recoveryResourceGroupId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr", + "recoveryTargetDiskId": null, + "recoveryReplicaDiskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr/providers/Microsoft.Compute/disks/sdgql-datadisk0-ASRReplica", + "recoveryOrignalTargetDiskId": null, + "recoveryReplicaDiskAccountType": "Premium_LRS", + "recoveryTargetDiskAccountType": "Premium_LRS", + "recoveryDiskEncryptionSetId": null, + "primaryDiskEncryptionSetId": null, + "diskName": "sdgql-datadisk0", + "diskCapacityInBytes": 274877906944, + "primaryStagingAzureStorageAccountId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.Storage/storageAccounts/ix701lshashankvaasrcache", + "diskType": "Data", + "resyncRequired": false, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "dataPendingInStagingStorageAccountInMB": 0.0, + "dataPendingAtSourceAgentInMB": 0.0, + "diskState": "Protected", + "allowedDiskLevelOperation": [], + "isDiskEncrypted": false, + "secretIdentifier": null, + "dekKeyVaultArmId": null, + "isDiskKeyEncrypted": false, + "keyIdentifier": null, + "kekKeyVaultArmId": null, + "failoverDiskName": "sdgql-datadisk0", + "tfoDiskName": "sdgql-datadisk0-ASRtest" + } + ], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": null, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": 180, + "lastRpoCalculatedTime": "2024-01-22T09:13:33.52001Z", + "sharedDiskIRErrors": null + } + }, + "policyId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/klncksan" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/operationresults/76e220ab-8ae8-4047-b6e0-e6c0f6fc2241?api-version=2024-04-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/5fda1f8f-7c2a-4c9e-bb73-3cf018e9df41?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_UnplannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_UnplannedFailover.json new file mode 100644 index 000000000000..edcd0633f989 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionClusters_UnplannedFailover.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicationProtectionClusterName": "testcluster", + "protectionContainerName": "pri-cloud-eastus", + "fabricName": "fabric-pri-eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "failoverInput": { + "properties": { + "failoverDirection": "primarytorecovery", + "sourceSiteOperations": "NotRequired", + "providerSpecificDetails": { + "clusterRecoveryPointId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "individualNodeRecoveryPoints": [ + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/testVM/recoveryPoints/b5c2051b-79e3-41ad-9d25-244f6ef8ce7d" + ], + "instanceType": "A2A" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster", + "name": "testcluster", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters", + "properties": { + "protectionClusterType": "WindowsServerFailoverCluster", + "primaryFabricFriendlyName": "East US", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "West US", + "recoveryFabricId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus", + "primaryProtectionContainerFriendlyName": "East US", + "recoveryProtectionContainerFriendlyName": "pri-cloud-eastus", + "protectionState": "FailoverCompleted", + "protectionStateDescription": "Failover completed.", + "activeLocation": "Recovery", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "CommitFailoverProtectionCluster", + "ChangePitProtectionCluster", + "PurgeProtectionCluster" + ], + "replicationHealth": "Normal", + "healthErrors": [], + "lastSuccessfulFailoverTime": "2024-01-22T09:31:13.1605059Z", + "lastSuccessfulTestFailoverTime": "2024-01-22T06:08:01.7440966Z", + "policyFriendlyName": "klncksan", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "recoveryContainerId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus/replicationProtectionContainers/rec-cloud-westus", + "agentClusterId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "clusterFqdn": "sdgqlc", + "clusterNodeFqdns": [ + "sdgql0", + "sdgql1" + ], + "clusterProtectedItemIds": [ + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/yNdYnDYKZ7hYU7zyVeBychFBCyAbEkrJcJNUarDrXio", + "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectedItems/kdUdWvpVnm3QgOQPHoVMX8YAtAO8OC4kKNjt40ERSr4" + ], + "provisioningState": "Created", + "areAllClusterNodesRegistered": true, + "clusterRegisteredNodes": [ + { + "clusterNodeFqdn": "sdgql0", + "machineId": "3794026b-6792-4d12-9c0c-de0c79376c90", + "biosId": "37D0059C-9118-4220-AA1D-58A10EFA7660", + "isSharedDiskVirtualNode": false + }, + { + "clusterNodeFqdn": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "machineId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "biosId": "aeeca6a3-171b-4c9d-ae22-0e4adb6416a0", + "isSharedDiskVirtualNode": true + }, + { + "clusterNodeFqdn": "sdgql1", + "machineId": "cb27913a-a5f2-4691-9eba-78b67f45a57a", + "biosId": "83CCE932-67EC-4C13-AB29-ACF5F8F7ED48", + "isSharedDiskVirtualNode": false + } + ], + "providerSpecificDetails": { + "instanceType": "A2A", + "multiVmGroupId": "a7ef77cb-ae59-545f-a32a-bf30575ab1c6", + "multiVmGroupName": "testcluster", + "multiVmGroupCreateOption": "UserSpecified", + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "clusterManagementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "rpoInSeconds": 3213, + "lastRpoCalculatedTime": "2024-01-22T10:19:11.0490433Z", + "initialPrimaryZone": "", + "initialPrimaryFabricLocation": "eastus", + "initialRecoveryZone": "", + "initialRecoveryFabricLocation": "westus", + "initialPrimaryExtendedLocation": null, + "initialRecoveryExtendedLocation": null, + "primaryAvailabilityZone": null, + "recoveryAvailabilityZone": null, + "primaryExtendedLocation": null, + "recoveryExtendedLocation": null, + "lifecycleId": "3d523ab9-8c6d-40af-850d-ccee06513dc6" + }, + "sharedDiskProperties": { + "protectionState": "UnplannedFailoverCommitRequired", + "testFailoverState": "None", + "activeLocation": null, + "allowedOperations": [], + "replicationHealth": "Normal", + "healthErrors": [], + "currentScenario": null, + "sharedDiskProviderSpecificDetails": { + "instanceType": "A2A", + "managementId": "a24d47b2-a80b-4553-9c16-499c30c3be07", + "unprotectedDisks": null, + "protectedManagedDisks": [ + { + "diskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourcegroups/clustertestrg-19-01/providers/microsoft.compute/disks/sdgql-datadisk0", + "recoveryResourceGroupId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr", + "recoveryTargetDiskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr/providers/Microsoft.Compute/disks/sdgql-datadisk0", + "recoveryReplicaDiskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr/providers/Microsoft.Compute/disks/sdgql-datadisk0-ASRReplica", + "recoveryOrignalTargetDiskId": null, + "recoveryReplicaDiskAccountType": "Premium_LRS", + "recoveryTargetDiskAccountType": "Premium_LRS", + "recoveryDiskEncryptionSetId": null, + "primaryDiskEncryptionSetId": null, + "diskName": "sdgql-datadisk0", + "diskCapacityInBytes": 274877906944, + "primaryStagingAzureStorageAccountId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.Storage/storageAccounts/ix701lshashankvaasrcache", + "diskType": "Data", + "resyncRequired": false, + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "dataPendingInStagingStorageAccountInMB": 0.0, + "dataPendingAtSourceAgentInMB": 0.0, + "diskState": "Protected", + "allowedDiskLevelOperation": [], + "isDiskEncrypted": false, + "secretIdentifier": null, + "dekKeyVaultArmId": null, + "isDiskKeyEncrypted": false, + "keyIdentifier": null, + "kekKeyVaultArmId": null, + "failoverDiskName": "sdgql-datadisk0", + "tfoDiskName": "sdgql-datadisk0-ASRtest" + } + ], + "primaryFabricLocation": "eastus", + "recoveryFabricLocation": "westus", + "failoverRecoveryPointId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/recoveryPoints/cc48b7f3-b267-432b-ad76-45528974dc62", + "monitoringPercentageCompletion": null, + "monitoringJobType": null, + "rpoInSeconds": 10, + "lastRpoCalculatedTime": "2024-01-22T09:20:35.9303505Z", + "sharedDiskIRErrors": null + } + }, + "policyId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/klncksan" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/operationresults/76e220ab-8ae8-4047-b6e0-e6c0f6fc2241?api-version=2024-04-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/95637b63-f239-48e0-8bbc-bd6b3c638a39?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Create.json new file mode 100644 index 000000000000..e79de7ce4d8a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "creationInput": { + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "providerSpecificInput": { + "instanceType": "ReplicationProviderSpecificContainerMappingInput" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Delete.json new file mode 100644 index 000000000000..d0fbb330f88f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "removalInput": { + "properties": { + "providerSpecificInput": {} + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Get.json new file mode 100644 index 000000000000..4b79548873aa --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_List.json new file mode 100644 index 000000000000..06be92b0830b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..406ca518e0f1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Purge.json new file mode 100644 index 000000000000..7c9b3c198b20 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Purge.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Update.json new file mode 100644 index 000000000000..ff141c7fadce --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainerMappings_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "updateInput": { + "properties": { + "providerSpecificInput": { + "instanceType": "A2A", + "agentAutoUpdateStatus": "Enabled", + "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "A2A", + "agentAutoUpdateStatus": "Enabled", + "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1", + "scheduleName": "cloud1protectionprofile1_a85ea38f-62a8-471b-93cc-69b74fd9578c", + "jobScheduleName": "ffd503ec-5f88-4b58-97c8-841466e7aa47" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Create.json new file mode 100644 index 000000000000..78ea24c2c39c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Create.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "creationInput": { + "properties": { + "providerSpecificInput": [ + { + "instanceType": "ReplicationProviderSpecificContainerCreationInput" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Delete.json new file mode 100644 index 000000000000..d33a142ea18c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json new file mode 100644 index 000000000000..2e681ffef180 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectionContainerName": "cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "fabricName": "V2A-W2K12-660", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "discoverProtectableItemRequest": { + "properties": { + "friendlyName": "Test", + "ipAddress": "10.150.2.3", + "osType": "Windows" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationProtectionContainers/cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "name": "cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "V2A-W2K12-660", + "friendlyName": "V2A-W2K12-660", + "fabricType": "VMware", + "protectedItemCount": 2, + "pairingStatus": "Paired", + "role": "Primary" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Get.json new file mode 100644 index 000000000000..e589b9c42cda --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_List.json new file mode 100644 index 000000000000..d4dce2de06cd --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json new file mode 100644 index 000000000000..5c5497120bad --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_SwitchClusterProtection.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_SwitchClusterProtection.json new file mode 100644 index 000000000000..202d7da65d42 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_SwitchClusterProtection.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectionContainerName": "pri-cloud-eastus", + "fabricName": "fabric-pri-eastus", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "switchInput": { + "properties": { + "replicationProtectionClusterName": "testcluster", + "providerSpecificDetails": { + "instanceType": "A2A", + "recoveryContainerId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-rec-westus/replicationProtectionContainers/rec-cloud-westus", + "policyId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/klncksan", + "protectedItemsDetail": [ + { + "recoveryResourceGroupId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr", + "replicationProtectedItemName": "yNdYnDYKZ7hYU7zyVeBychFBCyAbEkrJcJNUarDrXio", + "vmManagedDisks": [ + { + "diskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourcegroups/clustertestrg-19-01/providers/microsoft.compute/disks/sdgql0-osdisk", + "recoveryResourceGroupId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr", + "primaryStagingAzureStorageAccountId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/clustertestrg-19-01/providers/Microsoft.Storage/storageAccounts/ix701lvaasrcache" + } + ] + }, + { + "recoveryResourceGroupId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr", + "replicationProtectedItemName": "kdUdWvpVnm3QgOQPHoVMX8YAtAO8OC4kKNjt40ERSr4", + "vmManagedDisks": [ + { + "diskId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourcegroups/clustertestrg-19-01/providers/microsoft.compute/disks/sdgql1-osdisk", + "recoveryResourceGroupId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/ClusterTestRG-19-01-asr", + "primaryStagingAzureStorageAccountId": "/subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/clustertestrg-19-01/providers/Microsoft.Storage/storageAccounts/ix701lvaasrcache" + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus", + "name": "pri-cloud-eastus", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "East US", + "friendlyName": "pri-cloud-eastus", + "fabricType": "Azure", + "protectedItemCount": 13, + "pairingStatus": "Paired", + "role": "Primary", + "fabricSpecificDetails": null + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/fabric-pri-eastus/replicationProtectionContainers/pri-cloud-eastus/replicationProtectionClusters/testcluster/operationresults/76e220ab-8ae8-4047-b6e0-e6c0f6fc2241?api-version=2024-04-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/5fda1f8f-7c2a-4c9e-bb73-9cf018e9df41?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_SwitchProtection.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_SwitchProtection.json new file mode 100644 index 000000000000..be68ecdedad8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionContainers_SwitchProtection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "protectionContainerName": "CentralUSCancloud", + "fabricName": "CentralUSCanSite", + "resourceName": "priyanponeboxvault", + "resourceGroupName": "priyanprg", + "subscriptionId": "42195872-7e70-4f8a-837f-84b28ecbb78b", + "switchInput": { + "properties": { + "replicationProtectedItemName": "a2aSwapOsVm", + "providerSpecificDetails": { + "instanceType": "A2A" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/42195872-7e70-4f8a-837f-84b28ecbb78b/resourceGroups/priyanprg/providers/Microsoft.RecoveryServices/vaults/priyanponeboxvault/replicationFabrics/EUSCanSite/replicationProtectionContainers/euscancloud", + "name": "euscancloud", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "East US 2 EUAP", + "friendlyName": "euscancloud", + "fabricType": "Azure", + "protectedItemCount": 0, + "pairingStatus": "Paired", + "role": "Primary" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/42195872-7e70-4f8a-837f-84b28ecbb78b/resourceGroups/priyanprg/providers/Microsoft.RecoveryServices/vaults/priyanponeboxvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/42195872-7e70-4f8a-837f-84b28ecbb78b/resourceGroups/priyanprg/providers/Microsoft.RecoveryServices/vaults/priyanponeboxvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_Create.json new file mode 100644 index 000000000000..62ac94768498 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "intentObjectName": "vm1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single", + "recoveryResourceGroupId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne-asr" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "recoveryAvailabilityType": "Single" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_Get.json new file mode 100644 index 000000000000..a0abe24d711a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "intentObjectName": "vm1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_List.json new file mode 100644 index 000000000000..809302f73ab4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationProtectionIntents_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "2007vttp", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/2007vttp/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Create.json new file mode 100644 index 000000000000..1b1aa74a1ff0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Create.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "recoveryFabricId": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "groups": [ + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Delete.json new file mode 100644 index 000000000000..ff1dd0262c05 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_FailoverCancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_FailoverCancel.json new file mode 100644 index 000000000000..96a59d3119a9 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_FailoverCancel.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "recoveryFabricFriendlyName": "cloud1", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "InMageRcmFailback" + ], + "allowedOperations": [ + "PlannedFailover" + ], + "lastPlannedFailoverTime": "2021-02-24T07:33:49.1372448Z", + "lastTestFailoverTime": "1601-01-01T00:00:00.0000000Z", + "currentScenario": { + "scenarioName": "CancelFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/5276a7bc-12a3-43a1-bc53-9bf80e0be87b", + "startTime": "2021-02-24T08:52:42.1587592Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_FailoverCommit.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_FailoverCommit.json new file mode 100644 index 000000000000..9017a0301bdb --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_FailoverCommit.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "CommitFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/5276a7bc-12a3-43a1-bc53-9bf80e0be87b", + "startTime": "2017-04-27T08:52:42.1587592Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Get.json new file mode 100644 index 000000000000..98f2426dc455 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Get.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_List.json new file mode 100644 index 000000000000..ede65c48904b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_PlannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_PlannedFailover.json new file mode 100644 index 000000000000..b1a68c894ef9 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_PlannedFailover.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover", + "Commit" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "PlannedFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/d4821a53-90da-4fcb-bc11-a280d13e3350", + "startTime": "2017-04-27T07:34:02.6176524Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Reprotect.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Reprotect.json new file mode 100644 index 000000000000..a837035201c8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Reprotect.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T08:58:35.9062813Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "ReverseReplication", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/edf01dfb-b649-4802-91e4-3d55ce3bebf0", + "startTime": "2017-04-27T09:52:16.9818841Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_TestFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_TestFailover.json new file mode 100644 index 000000000000..1b5d6bee0914 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_TestFailover.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "networkType": "VmNetworkAsInput", + "networkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "TestFailoverCleanup" + ], + "currentScenario": { + "scenarioName": "TestFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/d40bfb40-aaaa-4c0d-87d3-41b15439a84b", + "startTime": "2017-04-27T07:00:58.8191916Z" + }, + "currentScenarioStatus": "Suspended", + "currentScenarioStatusDescription": "WaitingForStopTestFailover", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json new file mode 100644 index 000000000000..551710af70c4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "TestFailoverCleanup", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/4ae8eaa8-a384-42cb-9768-152cb5b8a1ff", + "startTime": "2017-04-27T07:10:52.8424747Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json new file mode 100644 index 000000000000..a5758f051666 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "sourceSiteOperations": "Required", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover", + "Commit" + ], + "lastPlannedFailoverTime": "2017-04-27T08:58:35.9062813Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "UnplannedFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/60b84068-9adb-4867-a49d-88be40bff14b", + "startTime": "2017-04-27T10:03:03.2206946Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Update.json new file mode 100644 index 000000000000..b35fadf0eb45 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryPlans_Update.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Create.json new file mode 100644 index 000000000000..df50c4a3e3b1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Create.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "providerName": "vmwareprovider1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "addProviderInput": { + "properties": { + "machineName": "vmwareprovider1", + "authenticationIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + }, + "resourceAccessIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/vmwareprovider1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "vmwareprovider1", + "properties": { + "fabricType": "VMwareV2", + "friendlyName": "vmwareprovider1", + "providerVersion": "5.1.3688.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "vmwarefabric1", + "lastHeartBeat": "2017-04-27T09:16:04.9405768Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Delete.json new file mode 100644 index 000000000000..377c5231c5fc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Get.json new file mode 100644 index 000000000000..5afbfc013928 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:16:04.9405768Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_List.json new file mode 100644 index 000000000000..9bf2402dc40a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:06:38.2728455Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json new file mode 100644 index 000000000000..a64395e7eb13 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:06:38.2728455Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Purge.json new file mode 100644 index 000000000000..377c5231c5fc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_Purge.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json new file mode 100644 index 000000000000..6c8d5d7e4412 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:48:36.6528303Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Create.json new file mode 100644 index 000000000000..0d354f0d6d49 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Create.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "pairingInput": { + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Delete.json new file mode 100644 index 000000000000..7bc84fb94e73 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Get.json new file mode 100644 index 000000000000..84df6c947b03 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_List.json new file mode 100644 index 000000000000..6a89c73358a0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json new file mode 100644 index 000000000000..37fbc978787e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_Get.json new file mode 100644 index 000000000000..3349c37996bc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_List.json new file mode 100644 index 000000000000..ed05da68a7e6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json new file mode 100644 index 000000000000..9cc6fb819b54 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultHealth_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultHealth_Get.json new file mode 100644 index 000000000000..e45a6e74c70f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultHealth_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultHealth", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth/Default", + "properties": { + "vaultErrors": [], + "protectedItemsHealth": { + "resourceCount": 6, + "issues": [ + { + "summaryCode": "10008", + "category": "Replication", + "severity": "Error", + "summaryMessage": "RPO Throttled", + "affectedResourceType": "replicationProtectedItems", + "affectedResourceSubtype": "", + "affectedResourceCorrelationIds": [ + "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "c183865e-6077-46f2-a3b1-ceb0a4c3751e" + ] + } + ] + }, + "fabricsHealth": { + "resourceCount": 1, + "issues": [] + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultHealth_Refresh.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultHealth_Refresh.json new file mode 100644 index 000000000000..912e8f3008f3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultHealth_Refresh.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultHealth", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth/Default", + "properties": { + "vaultErrors": [], + "protectedItemsHealth": { + "resourceCount": 2, + "issues": [] + }, + "fabricsHealth": { + "resourceCount": 1, + "issues": [] + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_Create.json new file mode 100644 index 000000000000..11074e3ca831 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_Create.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vaultSettingName": "default", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_Get.json new file mode 100644 index 000000000000..cec7ce707240 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "vaultSettingName": "default", + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_List.json new file mode 100644 index 000000000000..0bb7c820caec --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationVaultSetting_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + ], + "nextLink": null + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Create.json new file mode 100644 index 000000000000..38e9d2ef8086 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Create.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2024-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "addVCenterRequest": { + "properties": { + "friendlyName": "esx-78", + "ipAddress": "inmtest78", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "port": "443", + "runAsAccountId": "2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Delete.json new file mode 100644 index 000000000000..4d66d8c022eb --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2024-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Get.json new file mode 100644 index 000000000000..0821ecfc9c48 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2024-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_List.json new file mode 100644 index 000000000000..a3c4a781187e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_ListByReplicationFabrics.json new file mode 100644 index 000000000000..195489f486be --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_ListByReplicationFabrics.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "fabricName": "MadhaviFabric", + "api-version": "2024-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Update.json new file mode 100644 index 000000000000..7df5a36cac77 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/ReplicationvCenters_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2024-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "updateVCenterRequest": { + "properties": { + "ipAddress": "10.150.109.25" + } + } + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "10.150.109.25", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/SupportedOperatingSystems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/SupportedOperatingSystems_Get.json new file mode 100644 index 000000000000..6b35fc5ef1d6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/SupportedOperatingSystems_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationSupportedOperatingSystems", + "id": "/Subscriptions/bc403605-c2b0-43dd-abe9-0162124b1ee1/resourceGroups/oneBoxRG/providers/Microsoft.RecoveryServices/vaults/oneBoxRSVault/replicationSupportedOperatingSystems/Default", + "properties": { + "supportedOsList": [ + { + "instanceType": "A2A", + "supportedOs": [ + { + "osName": "centos", + "osType": "linux", + "osVersions": [ + { + "version": "6.0" + } + ] + }, + { + "osName": "Windows Server 2008 R2 Datacenter", + "osType": "windows", + "osVersions": [ + { + "version": "6.1", + "servicePack": "1" + } + ] + } + ] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json new file mode 100644 index 000000000000..74adb13a9a49 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "replicatedProtectedItemName": "468c912d-b1ab-4ea2-97eb-4b5095155db2", + "protectionContainerName": "asr-a2a-default-centraluseuap-container", + "fabricName": "asr-a2a-default-centraluseuap", + "resourceName": "avraiMgDiskVault", + "resourceGroupName": "avraiMgDiskVaultRG", + "subscriptionId": "6808dbbc-98c7-431f-a1b1-9580902423b7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationFabrics/asr-a2a-default-centraluseuap/replicationProtectionContainers/asr-a2a-default-centraluseuap-container/replicationProtectedItems/468c912d-b1ab-4ea2-97eb-4b5095155db2/targetComputeSizes/Basic_A0", + "name": "Basic_A0", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/targetComputeSizes", + "properties": { + "name": "Basic_A0", + "friendlyName": "Basic_A0", + "cpuCoresCount": 1, + "memoryInGB": 0.75, + "maxDataDiskCount": 1, + "maxNicsCount": 2, + "errors": null, + "highIopsSupported": "NotSupported" + } + }, + { + "id": "/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationFabrics/asr-a2a-default-centraluseuap/replicationProtectionContainers/asr-a2a-default-centraluseuap-container/replicationProtectedItems/468c912d-b1ab-4ea2-97eb-4b5095155db2/targetComputeSizes/Standard_A0", + "name": "Standard_A0", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/targetComputeSizes", + "properties": { + "name": "Standard_A0", + "friendlyName": "Standard_A0", + "cpuCoresCount": 1, + "vCPUsAvailable": 1, + "memoryInGB": 0.75, + "maxDataDiskCount": 1, + "maxNicsCount": 2, + "errors": null, + "highIopsSupported": "NotSupported", + "hyperVGenerations": [ + "V1" + ] + } + } + ], + "nextLink": null + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/service.json new file mode 100644 index 000000000000..2a78047148f0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/service.json @@ -0,0 +1,28093 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "SiteRecoveryManagementClient", + "x-ms-code-generation-settings": { + "header": "MICROSOFT_MIT_NO_VERSION" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Returns the list of available operations.", + "description": "Operation to return the list of available operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsDiscoveryCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns the list of available operations.": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings": { + "get": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Gets the list of configured email notification(alert) configurations.", + "description": "Gets the list of email notification(alert) configurations for the vault.", + "operationId": "ReplicationAlertSettings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of configured email notification(alert) configurations.": { + "$ref": "./examples/ReplicationAlertSettings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName}": { + "get": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Gets an email notification(alert) configuration.", + "description": "Gets the details of the specified email notification(alert) configuration.", + "operationId": "ReplicationAlertSettings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "alertSettingName", + "in": "path", + "description": "The name of the email notification configuration.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "x-ms-examples": { + "Gets an email notification(alert) configuration.": { + "$ref": "./examples/ReplicationAlertSettings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Configures email notifications for this vault.", + "description": "Create or update an email notification(alert) configuration.", + "operationId": "ReplicationAlertSettings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "alertSettingName", + "in": "path", + "description": "The name of the email notification(alert) configuration.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "The input to configure the email notification(alert).", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigureAlertRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "x-ms-examples": { + "Configures email notifications for this vault.": { + "$ref": "./examples/ReplicationAlertSettings_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAppliances": { + "get": { + "tags": [ + "ReplicationAppliances" + ], + "summary": "Gets the list of appliances.", + "description": "Gets the list of Azure Site Recovery appliances for the vault.", + "operationId": "ReplicationAppliances_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplianceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ApplianceQueryParameter", + "x-ms-examples": { + "Gets the list of appliances.": { + "$ref": "./examples/ReplicationAppliances_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults": { + "get": { + "tags": [ + "ReplicationEligibilityResults" + ], + "summary": "Gets the validation errors in case the VM is unsuitable for protection.", + "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", + "operationId": "ReplicationEligibilityResults_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "Virtual Machine name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationEligibilityResultsCollection" + } + } + }, + "x-ms-examples": { + "Gets the validation errors in case the VM is unsuitable for protection.": { + "$ref": "./examples/ReplicationEligibilityResults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default": { + "get": { + "tags": [ + "ReplicationEligibilityResults" + ], + "summary": "Gets the validation errors in case the VM is unsuitable for protection.", + "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", + "operationId": "ReplicationEligibilityResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "Virtual Machine name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationEligibilityResults" + } + } + }, + "x-ms-examples": { + "Gets the validation errors in case the VM is unsuitable for protection.": { + "$ref": "./examples/ReplicationEligibilityResults_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents": { + "get": { + "tags": [ + "ReplicationEvents" + ], + "summary": "Gets the list of Azure Site Recovery events.", + "description": "Gets the list of Azure Site Recovery events for the vault.", + "operationId": "ReplicationEvents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/EventQueryParameter", + "x-ms-examples": { + "Gets the list of Azure Site Recovery events.": { + "$ref": "./examples/ReplicationEvents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents/{eventName}": { + "get": { + "tags": [ + "ReplicationEvents" + ], + "summary": "Get the details of an Azure Site recovery event.", + "description": "The operation to get the details of an Azure Site recovery event.", + "operationId": "ReplicationEvents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "eventName", + "in": "path", + "description": "The name of the Azure Site Recovery event.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Event" + } + } + }, + "x-ms-examples": { + "Get the details of an Azure Site recovery event.": { + "$ref": "./examples/ReplicationEvents_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics": { + "get": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Gets the list of ASR fabrics.", + "description": "Gets a list of the Azure Site Recovery fabrics in the vault.", + "operationId": "ReplicationFabrics_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FabricCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of ASR fabrics.": { + "$ref": "./examples/ReplicationFabrics_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}": { + "get": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Gets the details of an ASR fabric.", + "description": "Gets the details of an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + } + }, + "x-ms-odata": "#/definitions/FabricQueryParameter", + "x-ms-examples": { + "Gets the details of an ASR fabric.": { + "$ref": "./examples/ReplicationFabrics_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Creates an Azure Site Recovery fabric.", + "description": "The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).", + "operationId": "ReplicationFabrics_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the ASR fabric.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Fabric creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/FabricCreationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates an Azure Site Recovery fabric.": { + "$ref": "./examples/ReplicationFabrics_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Purges the site.", + "description": "The operation to purge(force delete) an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to purge.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges the site.": { + "$ref": "./examples/ReplicationFabrics_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/checkConsistency": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Checks the consistency of the ASR fabric.", + "description": "The operation to perform a consistency check on the fabric.", + "operationId": "ReplicationFabrics_CheckConsistency", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Checks the consistency of the ASR fabric.": { + "$ref": "./examples/ReplicationFabrics_CheckConsistency.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/migratetoaad": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Migrates the site to AAD.", + "description": "The operation to migrate an Azure Site Recovery fabric to AAD.", + "operationId": "ReplicationFabrics_MigrateToAad", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to migrate.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Migrates the site to AAD.": { + "$ref": "./examples/ReplicationFabrics_MigrateToAad.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/reassociateGateway": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Perform failover of the process server.", + "description": "The operation to move replications from a process server to another process server.", + "operationId": "ReplicationFabrics_ReassociateGateway", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric containing the process server.", + "required": true, + "type": "string" + }, + { + "name": "failoverProcessServerRequest", + "in": "body", + "description": "The input to the failover process server operation.", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverProcessServerRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Perform failover of the process server.": { + "$ref": "./examples/ReplicationFabrics_ReassociateGateway.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/remove": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Deletes the site.", + "description": "The operation to delete or remove an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the site.": { + "$ref": "./examples/ReplicationFabrics_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/renewCertificate": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Renews certificate for the fabric.", + "description": "Renews the connection certificate for the ASR replication fabric.", + "operationId": "ReplicationFabrics_RenewCertificate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "fabric name to renew certs for.", + "required": true, + "type": "string" + }, + { + "name": "renewCertificate", + "in": "body", + "description": "Renew certificate input.", + "required": true, + "schema": { + "$ref": "#/definitions/RenewCertificateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Renews certificate for the fabric.": { + "$ref": "./examples/ReplicationFabrics_RenewCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/removeInfra": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Removes the appliance's infrastructure under the fabric.", + "operationId": "ReplicationFabrics_RemoveInfra", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes the appliance's infrastructure under the fabric.": { + "$ref": "./examples/ReplicationInfrastructure_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks": { + "get": { + "tags": [ + "ReplicationLogicalNetworks" + ], + "summary": "Gets the list of logical networks under a fabric.", + "description": "Lists all the logical networks of the Azure Site Recovery fabric.", + "operationId": "ReplicationLogicalNetworks_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicalNetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of logical networks under a fabric.": { + "$ref": "./examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks/{logicalNetworkName}": { + "get": { + "tags": [ + "ReplicationLogicalNetworks" + ], + "summary": "Gets a logical network with specified server id and logical network name.", + "description": "Gets the details of a logical network.", + "operationId": "ReplicationLogicalNetworks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + }, + { + "name": "logicalNetworkName", + "in": "path", + "description": "Logical network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + } + }, + "x-ms-examples": { + "Gets a logical network with specified server id and logical network name.": { + "$ref": "./examples/ReplicationLogicalNetworks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets the list of networks under a fabric.", + "description": "Lists the networks available for a fabric.", + "operationId": "ReplicationNetworks_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of networks under a fabric.": { + "$ref": "./examples/ReplicationNetworks_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets a network with specified server id and network name.", + "description": "Gets the details of a network.", + "operationId": "ReplicationNetworks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Network" + } + } + }, + "x-ms-examples": { + "Gets a network with specified server id and network name.": { + "$ref": "./examples/ReplicationNetworks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets all the network mappings under a network.", + "description": "Lists all ASR network mappings for the specified network.", + "operationId": "ReplicationNetworkMappings_ListByReplicationNetworks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all the network mappings under a network.": { + "$ref": "./examples/ReplicationNetworkMappings_ListByReplicationNetworks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets network mapping by name.", + "description": "Gets the details of an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + } + }, + "x-ms-examples": { + "Gets network mapping by name.": { + "$ref": "./examples/ReplicationNetworkMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Creates network mapping.", + "description": "The operation to create an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create network mapping input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateNetworkMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Delete network mapping.", + "description": "The operation to delete a network mapping.", + "operationId": "ReplicationNetworkMappings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "ARM Resource Name for network mapping.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Updates network mapping.", + "description": "The operation to update an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update network mapping input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the list of protection container for a fabric.", + "description": "Lists the protection containers in the specified fabric.", + "operationId": "ReplicationProtectionContainers_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of protection container for a fabric.": { + "$ref": "./examples/ReplicationProtectionContainers_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the protection container details.", + "description": "Gets the details of a protection container.", + "operationId": "ReplicationProtectionContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + } + }, + "x-ms-examples": { + "Gets the protection container details.": { + "$ref": "./examples/ReplicationProtectionContainers_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Create a protection container.", + "description": "Operation to create a protection container.", + "operationId": "ReplicationProtectionContainers_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric ARM name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Unique protection container ARM name.", + "required": true, + "type": "string" + }, + { + "name": "creationInput", + "in": "body", + "description": "Creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionContainerInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/discoverProtectableItem": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Adds a protectable item to the replication protection container.", + "description": "The operation to a add a protectable item to a protection container(Add physical server).", + "operationId": "ReplicationProtectionContainers_DiscoverProtectableItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the protection container.", + "required": true, + "type": "string" + }, + { + "name": "discoverProtectableItemRequest", + "in": "body", + "description": "The request object to add a protectable item.", + "required": true, + "schema": { + "$ref": "#/definitions/DiscoverProtectableItemRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Adds a protectable item to the replication protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_DiscoverProtectableItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/remove": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Removes a protection container.", + "description": "Operation to remove a protection container.", + "operationId": "ReplicationProtectionContainers_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric ARM name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Unique protection container ARM name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes a protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the list of migration items in the protection container.", + "description": "Gets the list of ASR migration items in the protection container.", + "operationId": "ReplicationMigrationItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/MigrationItemsQueryParameter", + "x-ms-examples": { + "Gets the list of migration items in the protection container.": { + "$ref": "./examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the details of a migration item.", + "operationId": "ReplicationMigrationItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Enables migration.", + "description": "The operation to create an ASR migration item (enable migration).", + "operationId": "ReplicationMigrationItems_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Enable migration input.", + "required": true, + "schema": { + "$ref": "#/definitions/EnableMigrationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Enables migration.": { + "$ref": "./examples/ReplicationMigrationItems_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Delete the migration item.", + "description": "The operation to delete an ASR migration item.", + "operationId": "ReplicationMigrationItems_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "deleteOption", + "in": "query", + "description": "The delete option.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Updates migration item.", + "description": "The operation to update the recovery settings of an ASR migration item.", + "operationId": "ReplicationMigrationItems_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update migration item input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMigrationItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Migrate item.", + "description": "The operation to initiate migration of the item.", + "operationId": "ReplicationMigrationItems_Migrate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "migrateInput", + "in": "body", + "description": "Migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/MigrateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints": { + "get": { + "tags": [ + "MigrationRecoveryPoints" + ], + "summary": "Gets the recovery points for a migration item.", + "operationId": "MigrationRecoveryPoints_ListByReplicationMigrationItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationRecoveryPointCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the recovery points for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints/{migrationRecoveryPointName}": { + "get": { + "tags": [ + "MigrationRecoveryPoints" + ], + "summary": "Gets a recovery point for a migration item.", + "operationId": "MigrationRecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "migrationRecoveryPointName", + "in": "path", + "description": "The migration recovery point name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationRecoveryPoint" + } + } + }, + "x-ms-examples": { + "Gets a recovery point for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/pauseReplication": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Pause replication.", + "description": "The operation to initiate pause replication of the item.", + "operationId": "ReplicationMigrationItems_PauseReplication", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "pauseReplicationInput", + "in": "body", + "description": "Pause replication input.", + "required": true, + "schema": { + "$ref": "#/definitions/PauseReplicationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Pause replication.": { + "$ref": "./examples/ReplicationMigrationItems_PauseReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resumeReplication": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Resume replication.", + "description": "The operation to initiate resume replication of the item.", + "operationId": "ReplicationMigrationItems_ResumeReplication", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "resumeReplicationInput", + "in": "body", + "description": "Resume replication input.", + "required": true, + "schema": { + "$ref": "#/definitions/ResumeReplicationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resume replication.": { + "$ref": "./examples/ReplicationMigrationItems_ResumeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resync": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Resynchronizes replication.", + "description": "The operation to resynchronize replication of an ASR migration item.", + "operationId": "ReplicationMigrationItems_Resync", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Resync input.", + "required": true, + "schema": { + "$ref": "#/definitions/ResyncInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resynchronizes replication.": { + "$ref": "./examples/ReplicationMigrationItems_Resync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Test migrate item.", + "description": "The operation to initiate test migration of the item.", + "operationId": "ReplicationMigrationItems_TestMigrate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "testMigrateInput", + "in": "body", + "description": "Test migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestMigrateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Test migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrateCleanup": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Test migrate cleanup.", + "description": "The operation to initiate test migrate cleanup.", + "operationId": "ReplicationMigrationItems_TestMigrateCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "testMigrateCleanupInput", + "in": "body", + "description": "Test migrate cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestMigrateCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Test migrate cleanup.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrateCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems": { + "get": { + "tags": [ + "ReplicationProtectableItems" + ], + "summary": "Gets the list of protectable items.", + "description": "Lists the protectable items in a protection container.", + "operationId": "ReplicationProtectableItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$take", + "in": "query", + "description": "take OData query parameter.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken OData query parameter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProtectableItemQueryParameter", + "x-ms-examples": { + "Gets the list of protectable items.": { + "$ref": "./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName}": { + "get": { + "tags": [ + "ReplicationProtectableItems" + ], + "summary": "Gets the details of a protectable item.", + "description": "The operation to get the details of a protectable item.", + "operationId": "ReplicationProtectableItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "protectableItemName", + "in": "path", + "description": "Protectable item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a protectable item.": { + "$ref": "./examples/ReplicationProtectableItems_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the list of Replication protected items.", + "description": "Gets the list of ASR replication protected items in the protection container.", + "operationId": "ReplicationProtectedItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of Replication protected items.": { + "$ref": "./examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the details of a Replication protected item.", + "description": "Gets the details of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a Replication protected item.": { + "$ref": "./examples/ReplicationProtectedItems_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Enables protection.", + "description": "The operation to create an ASR replication protected item (Enable replication).", + "operationId": "ReplicationProtectedItems_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "A name for the replication protected item.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Enable Protection Input.", + "required": true, + "schema": { + "$ref": "#/definitions/EnableProtectionInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Enables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Purges protection.", + "description": "The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.", + "operationId": "ReplicationProtectedItems_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges protection.": { + "$ref": "./examples/ReplicationProtectedItems_Purge.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Updates the replication protected item settings.", + "description": "The operation to update the recovery settings of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "updateProtectionInput", + "in": "body", + "description": "Update protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateReplicationProtectedItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the replication protected Item settings.": { + "$ref": "./examples/ReplicationProtectedItems_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Add disk(s) for protection.", + "description": "Operation to add disks(s) to the replication protected item.", + "operationId": "ReplicationProtectedItems_AddDisks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "addDisksInput", + "in": "body", + "description": "Add disks input.", + "required": true, + "schema": { + "$ref": "#/definitions/AddDisksInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add disk(s) for protection.": { + "$ref": "./examples/ReplicationProtectedItems_AddDisks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Change or apply recovery point.", + "description": "The operation to change the recovery point of a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_ApplyRecoveryPoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The ARM fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replicated protected item name.", + "required": true, + "type": "string" + }, + { + "name": "applyRecoveryPointInput", + "in": "body", + "description": "The ApplyRecoveryPointInput.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplyRecoveryPointInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Change or apply recovery point.": { + "$ref": "./examples/ReplicationProtectedItems_ApplyRecoveryPoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute cancel failover.", + "description": "Operation to cancel the failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_FailoverCancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute cancel failover.": { + "$ref": "./examples/ReplicationProtectedItems_FailoverCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute commit failover.", + "description": "Operation to commit the failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_FailoverCommit", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute commit failover.": { + "$ref": "./examples/ReplicationProtectedItems_FailoverCommit.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute planned failover.", + "description": "Operation to initiate a planned failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_PlannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Planned failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/PlannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute planned failover.": { + "$ref": "./examples/ReplicationProtectedItems_PlannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "summary": "Gets the list of recovery points for a replication protected item.", + "description": "Lists the available recovery points for a replication protected item.", + "operationId": "RecoveryPoints_ListByReplicationProtectedItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of recovery points for a replication protected item.": { + "$ref": "./examples/RecoveryPoints_ListByReplicationProtectedItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "summary": "Gets a recovery point.", + "description": "Get the details of specified recovery point.", + "operationId": "RecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointName", + "in": "path", + "description": "The recovery point name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPoint" + } + } + }, + "x-ms-examples": { + "Gets a recovery point.": { + "$ref": "./examples/RecoveryPoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Disables protection.", + "description": "The operation to disable replication on a replication protected item. This will also remove the item.", + "operationId": "ReplicationProtectedItems_Delete", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "disableProtectionInput", + "in": "body", + "description": "Disable protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/DisableProtectionInput" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Disables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Removes disk(s).", + "description": "Operation to remove disk(s) from the replication protected item.", + "operationId": "ReplicationProtectedItems_RemoveDisks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "removeDisksInput", + "in": "body", + "description": "Remove disks input.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveDisksInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes disk(s).": { + "$ref": "./examples/ReplicationProtectedItems_RemoveDisks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Resynchronize or repair replication.", + "description": "The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.", + "operationId": "ReplicationProtectedItems_RepairReplication", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the container.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The name of the replication protected item.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resynchronize or repair replication.": { + "$ref": "./examples/ReplicationProtectedItems_RepairReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute Reverse Replication\\Reprotect.", + "description": "Operation to reprotect or reverse replicate a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_Reprotect", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "reprotectInput", + "in": "body", + "description": "Reverse replication input.", + "required": true, + "schema": { + "$ref": "#/definitions/ReverseReplicationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute Reverse Replication\\Reprotect.": { + "$ref": "./examples/ReplicationProtectedItems_Reprotect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Resolve health errors.", + "description": "Operation to resolve health issues of the replication protected item.", + "operationId": "ReplicationProtectedItems_ResolveHealthErrors", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "resolveHealthInput", + "in": "body", + "description": "Health issue input object.", + "required": true, + "schema": { + "$ref": "#/definitions/ResolveHealthInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resolve health errors.": { + "$ref": "./examples/ReplicationProtectedItems_ResolveHealthErrors.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/switchProvider": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute switch provider.", + "description": "Operation to initiate a switch provider of the replication protected item.", + "operationId": "ReplicationProtectedItems_SwitchProvider", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "switchProviderInput", + "in": "body", + "description": "Switch provider input.", + "required": true, + "schema": { + "$ref": "#/definitions/SwitchProviderInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Execute switch provider.": { + "$ref": "./examples/ReplicationProtectedItems_SwitchProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes": { + "get": { + "tags": [ + "TargetComputeSizes" + ], + "summary": "Gets the list of target compute sizes for the replication protected item.", + "description": "Lists the available target compute sizes for a replication protected item.", + "operationId": "TargetComputeSizes_ListByReplicationProtectedItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TargetComputeSizeCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of target compute sizes for the replication protected item.": { + "$ref": "./examples/TargetComputeSizes_ListByReplicationProtectedItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute test failover.", + "description": "Operation to perform a test failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "testfailoverInput", + "in": "body", + "description": "Test failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover.": { + "$ref": "./examples/ReplicationProtectedItems_TestFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute test failover cleanup.", + "description": "Operation to clean up the test failover of a replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "cleanupInput", + "in": "body", + "description": "Test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover cleanup.": { + "$ref": "./examples/ReplicationProtectedItems_TestFailoverCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute unplanned failover.", + "description": "Operation to initiate a failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/UnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute unplanned failover.": { + "$ref": "./examples/ReplicationProtectedItems_UnplannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Updates appliance for replication protected Item.", + "description": "The operation to update appliance of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_UpdateAppliance", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "applianceUpdateInput", + "in": "body", + "description": "Appliance update protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates appliance for replication protected Item.": { + "$ref": "./examples/ReplicationProtectedItems_UpdateAppliance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateMobilityService": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Update the mobility service on a protected item.", + "description": "The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.", + "operationId": "ReplicationProtectedItems_UpdateMobilityService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the container containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The name of the protected item on which the agent is to be updated.", + "required": true, + "type": "string" + }, + { + "name": "updateMobilityServiceRequest", + "in": "body", + "description": "Request to update the mobility service on the protected item.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMobilityServiceRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Update the mobility service on a protected item.": { + "$ref": "./examples/ReplicationProtectedItems_UpdateMobilityService.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters": { + "get": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Gets the list of Replication protection clusters in fabric, container.", + "description": "Gets the list of ASR replication protected clusters in the protection container.", + "operationId": "ReplicationProtectionClusters_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionClusterCollection" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of Replication protection clusters in fabric, container.": { + "$ref": "./examples/ReplicationProtectionClusters_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}": { + "get": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Gets the details of a Replication protection cluster.", + "description": "Gets the details of an ASR replication protection cluster.", + "operationId": "ReplicationProtectionClusters_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets the details of a Replication protection cluster.": { + "$ref": "./examples/ReplicationProtectionClusters_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Create Replication protection Cluster.", + "description": "The operation to create an ASR replication protection cluster item.", + "operationId": "ReplicationProtectionClusters_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + }, + { + "name": "replicationProtectionCluster", + "in": "body", + "description": "Create replication protection cluster Input.", + "required": true, + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Replication protection Cluster.": { + "$ref": "./examples/ReplicationProtectionClusters_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Purge the replication protection cluster.", + "description": "The operation to purge the replication protection cluster. This operation will force delete the replication protection cluster. Use the remove operation on replication protection cluster to perform a clean disable replication protection cluster.", + "operationId": "ReplicationProtectionClusters_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + }, + "Retry-After": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Purge the replication protection cluster.": { + "$ref": "./examples/ReplicationProtectionClusters_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/applyRecoveryPoint": { + "post": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Execute the change recovery point operation for cluster.", + "description": "Operation to apply a new cluster recovery point on the Protection cluster.", + "operationId": "ReplicationProtectionClusters_ApplyRecoveryPoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + }, + { + "name": "applyClusterRecoveryPointInput", + "in": "body", + "description": "Apply recovery point input.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplyClusterRecoveryPointInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + }, + "Retry-After": { + "type": "string" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Execute the change recovery point operation for cluster.": { + "$ref": "./examples/ReplicationProtectionClusters_ApplyRecoveryPoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/failoverCommit": { + "post": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Execute commit failover for cluster.", + "description": "Operation to initiate commit failover of the replication protection cluster.", + "operationId": "ReplicationProtectionClusters_FailoverCommit", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + }, + "Retry-After": { + "type": "string" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Execute commit failover for cluster.": { + "$ref": "./examples/ReplicationProtectionClusters_FailoverCommit.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/operationResults/{jobId}": { + "get": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Tracks the Replication protection cluster async operation.", + "description": "Track the results of an asynchronous operation on the replication protection cluster.", + "operationId": "ReplicationProtectionClusters_GetOperationResults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + }, + { + "name": "jobId", + "in": "path", + "description": "job id to track.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Tracks the Replication protection cluster async operation.": { + "$ref": "./examples/ReplicationProtectionClusters_GetOperationResults.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/recoveryPoints": { + "get": { + "tags": [ + "ClusterRecoveryPoints" + ], + "summary": "Gets the list of cluster recovery points.", + "description": "The list of cluster recovery points.", + "operationId": "ClusterRecoveryPoints_ListByReplicationProtectionCluster", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterRecoveryPointCollection" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of cluster recovery points.": { + "$ref": "./examples/ClusterRecoveryPoints_ListByReplicationProtectionCluster.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/recoveryPoints/{recoveryPointName}": { + "get": { + "tags": [ + "ClusterRecoveryPoint" + ], + "summary": "Gets a recovery point.", + "description": "Get the details of specified recovery point.", + "operationId": "ClusterRecoveryPoint_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + }, + { + "name": "recoveryPointName", + "in": "path", + "description": "The recovery point name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterRecoveryPoint" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a recovery point.": { + "$ref": "./examples/ClusterRecoveryPoint_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/repairReplication": { + "post": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Resynchronize or repair replication of protection cluster.", + "description": "The operation to repair replication protection cluster.", + "operationId": "ReplicationProtectionClusters_RepairReplication", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + }, + "Retry-After": { + "type": "string" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Resynchronize or repair replication of protection cluster.": { + "$ref": "./examples/ReplicationProtectionClusters_RepairReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/testFailover": { + "post": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Execute test failover for cluster.", + "description": "Operation to initiate a failover of the replication protection cluster.", + "operationId": "ReplicationProtectionClusters_TestFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Cluster test failover input body.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterTestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + }, + "Retry-After": { + "type": "string" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Execute test failover for cluster.": { + "$ref": "./examples/ReplicationProtectionClusters_TestFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Execute test failover cleanup for cluster.", + "description": "Operation to clean up the test failover of a replication protected cluster.", + "operationId": "ReplicationProtectionClusters_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + }, + { + "name": "cleanupInput", + "in": "body", + "description": "Test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterTestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + }, + "Retry-After": { + "type": "string" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Execute test failover cleanup for cluster.": { + "$ref": "./examples/ReplicationProtectionClusters_TestFailoverCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Execute unplanned cluster failover.", + "description": "Operation to initiate a failover of the replication protection cluster.", + "operationId": "ReplicationProtectionClusters_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "$ref": "#/parameters/ReplicationProtectionClusterName" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + }, + "Retry-After": { + "type": "string" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Execute unplanned cluster failover.": { + "$ref": "./examples/ReplicationProtectionClusters_UnplannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets the list of protection container mappings for a protection container.", + "description": "Lists the protection container mappings for a protection container.", + "operationId": "ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of protection container mappings for a protection container.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets a protection container mapping.", + "description": "Gets the details of a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection Container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + } + }, + "x-ms-examples": { + "Gets a protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Create protection container mapping.", + "description": "The operation to create a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "creationInput", + "in": "body", + "description": "Mapping creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Purge protection container mapping.", + "description": "The operation to purge(force delete) a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purge protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Purge.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Update protection container mapping.", + "description": "The operation to update protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "updateInput", + "in": "body", + "description": "Mapping update input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove": { + "post": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Remove protection container mapping.", + "description": "The operation to delete or remove a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Delete", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "removalInput", + "in": "body", + "description": "Removal input.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveProtectionContainerMappingInput" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Remove protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchClusterProtection": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Switches protection from one container to another.", + "description": "Operation to switch protection from one container to another.", + "operationId": "ReplicationProtectionContainers_SwitchClusterProtection", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/FabricName" + }, + { + "$ref": "#/parameters/ProtectionContainerName" + }, + { + "name": "switchInput", + "in": "body", + "description": "Switch protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/SwitchClusterProtectionInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + }, + "Retry-After": { + "type": "string" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Switches protection from one container to another or one replication provider to another.": { + "$ref": "./examples/ReplicationProtectionContainers_SwitchClusterProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Switches protection from one container to another or one replication provider to another.", + "description": "Operation to switch protection from one container to another or one replication provider to another.", + "operationId": "ReplicationProtectionContainers_SwitchProtection", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "switchInput", + "in": "body", + "description": "Switch protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/SwitchProtectionInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + }, + "Retry-After": { + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Switches protection from one container to another or one replication provider to another.": { + "$ref": "./examples/ReplicationProtectionContainers_SwitchProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the list of registered recovery services providers for the fabric.", + "description": "Lists the registered recovery services providers for the specified fabric.", + "operationId": "ReplicationRecoveryServicesProviders_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProviderCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of registered recovery services providers for the fabric.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the details of a recovery services provider.", + "description": "Gets the details of registered recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + } + }, + "x-ms-examples": { + "Gets the details of a recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Adds a recovery services provider.", + "description": "The operation to add a recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + }, + { + "name": "addProviderInput", + "in": "body", + "description": "Add provider input.", + "required": true, + "schema": { + "$ref": "#/definitions/AddRecoveryServicesProviderInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Adds a recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Purges recovery service provider from fabric.", + "description": "The operation to purge(force delete) a recovery services provider from the vault.", + "operationId": "ReplicationRecoveryServicesProviders_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges recovery service provider from fabric.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/refreshProvider": { + "post": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Refresh details from the recovery services provider.", + "description": "The operation to refresh the information from the recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_RefreshProvider", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Refresh details from the recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_RefreshProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/remove": { + "post": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).", + "description": "The operation to removes/delete(unregister) a recovery services provider from the vault.", + "operationId": "ReplicationRecoveryServicesProviders_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the list of storage classification objects under a fabric.", + "description": "Lists the storage classifications available in the specified fabric.", + "operationId": "ReplicationStorageClassifications_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Site name of interest.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification objects under a fabric.": { + "$ref": "./examples/ReplicationStorageClassifications_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the details of a storage classification.", + "description": "Gets the details of the specified storage classification.", + "operationId": "ReplicationStorageClassifications_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassification" + } + } + }, + "x-ms-examples": { + "Gets the details of a storage classification.": { + "$ref": "./examples/ReplicationStorageClassifications_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the list of storage classification mappings objects under a storage.", + "description": "Lists the storage classification mappings for the fabric.", + "operationId": "ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification mappings objects under a storage.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings/{storageClassificationMappingName}": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the details of a storage classification mapping.", + "description": "Gets the details of the specified storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMapping" + } + } + }, + "x-ms-examples": { + "Gets the details of a storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Create storage classification mapping.", + "description": "The operation to create a storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + }, + { + "name": "pairingInput", + "in": "body", + "description": "Pairing input.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageClassificationMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Delete a storage classification mapping.", + "description": "The operation to delete a storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the list of vCenter registered under a fabric.", + "description": "Lists the vCenter servers registered in a fabric.", + "operationId": "ReplicationvCenters_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenterCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vCenter registered under a fabric.": { + "$ref": "./examples/ReplicationvCenters_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the details of a vCenter.", + "description": "Gets the details of a registered vCenter server(Add vCenter server).", + "operationId": "ReplicationvCenters_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + } + }, + "x-ms-examples": { + "Gets the details of a vCenter.": { + "$ref": "./examples/ReplicationvCenters_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Add vCenter.", + "description": "The operation to create a vCenter object..", + "operationId": "ReplicationvCenters_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + }, + { + "name": "addVCenterRequest", + "in": "body", + "description": "The input to the add vCenter operation.", + "required": true, + "schema": { + "$ref": "#/definitions/AddVCenterRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add vCenter.": { + "$ref": "./examples/ReplicationvCenters_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Remove vcenter operation.", + "description": "The operation to remove(unregister) a registered vCenter server from the vault.", + "operationId": "ReplicationvCenters_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Remove vCenter operation.": { + "$ref": "./examples/ReplicationvCenters_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Update vCenter operation.", + "description": "The operation to update a registered vCenter.", + "operationId": "ReplicationvCenters_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + }, + { + "name": "updateVCenterRequest", + "in": "body", + "description": "The input to the update vCenter operation.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateVCenterRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update vCenter operation.": { + "$ref": "./examples/ReplicationvCenters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs": { + "get": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Gets the list of jobs.", + "description": "Gets the list of Azure Site Recovery Jobs for the vault.", + "operationId": "ReplicationJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobQueryParameter", + "x-ms-examples": { + "Gets the list of jobs.": { + "$ref": "./examples/ReplicationJobs_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}": { + "get": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Gets the job details.", + "description": "Get the details of an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + } + }, + "x-ms-examples": { + "Gets the job details.": { + "$ref": "./examples/ReplicationJobs_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/cancel": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Cancels the specified job.", + "description": "The operation to cancel an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Cancels the specified job.": { + "$ref": "./examples/ReplicationJobs_Cancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/restart": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Restarts the specified job.", + "description": "The operation to restart an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Restart", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Restarts the specified job.": { + "$ref": "./examples/ReplicationJobs_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/resume": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Resumes the specified job.", + "description": "The operation to resume an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Resume", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + }, + { + "name": "resumeJobParams", + "in": "body", + "description": "Resume rob comments.", + "required": true, + "schema": { + "$ref": "#/definitions/ResumeJobParams" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resumes the specified job.": { + "$ref": "./examples/ReplicationJobs_Resume.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/export": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Exports the details of the Azure Site Recovery jobs of the vault.", + "description": "The operation to export the details of the Azure Site Recovery jobs of the vault.", + "operationId": "ReplicationJobs_Export", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobQueryParameter", + "in": "body", + "description": "job query filter.", + "required": true, + "schema": { + "$ref": "#/definitions/JobQueryParameter" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Exports the details of the Azure Site Recovery jobs of the vault.": { + "$ref": "./examples/ReplicationJobs_Export.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationMigrationItems": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the list of migration items in the vault.", + "operationId": "ReplicationMigrationItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/MigrationItemsQueryParameter", + "x-ms-examples": { + "Gets the list of migration items in the vault.": { + "$ref": "./examples/ReplicationMigrationItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets all the network mappings under a vault.", + "description": "Lists all ASR network mappings in the vault.", + "operationId": "ReplicationNetworkMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all the network mappings under a vault.": { + "$ref": "./examples/ReplicationNetworkMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworks": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets the list of networks. View-only API.", + "description": "Lists the networks available in a vault.", + "operationId": "ReplicationNetworks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of networks. View-only API.": { + "$ref": "./examples/ReplicationNetworks_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies": { + "get": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Gets the list of replication policies.", + "description": "Lists the replication policies for a vault.", + "operationId": "ReplicationPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of replication policies.": { + "$ref": "./examples/ReplicationPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName}": { + "get": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Gets the requested policy.", + "description": "Gets the details of a replication policy.", + "operationId": "ReplicationPolicies_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + } + }, + "x-ms-examples": { + "Gets the requested policy.": { + "$ref": "./examples/ReplicationPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Creates the policy.", + "description": "The operation to create a replication policy.", + "operationId": "ReplicationPolicies_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create policy input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreatePolicyInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates the policy.": { + "$ref": "./examples/ReplicationPolicies_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Delete the policy.", + "description": "The operation to delete a replication policy.", + "operationId": "ReplicationPolicies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the policy.": { + "$ref": "./examples/ReplicationPolicies_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Updates the policy.", + "description": "The operation to update a replication policy.", + "operationId": "ReplicationPolicies_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Policy Id.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update Policy Input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdatePolicyInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the policy.": { + "$ref": "./examples/ReplicationPolicies_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the list of replication protected items.", + "description": "Gets the list of ASR replication protected items in the vault.", + "operationId": "ReplicationProtectedItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token. Possible values: \"FabricId\" or \"FabricId_CloudId\" or null.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProtectedItemsQueryParameter", + "x-ms-examples": { + "Gets the list of replication protected items.": { + "$ref": "./examples/ReplicationProtectedItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionClusters": { + "get": { + "tags": [ + "ReplicationProtectionClusters" + ], + "summary": "Gets the list of Replication protection clusters in vault.", + "description": "Gets the list of ASR replication protected clusters in the vault.", + "operationId": "ReplicationProtectionClusters_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token. Possible values: \"FabricId\" or \"FabricId_CloudId\" or null.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionClusterCollection" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProtectedClustersQueryParameter", + "x-ms-examples": { + "Gets the list of Replication protection clusters in vault.": { + "$ref": "./examples/ReplicationProtectionClusters_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainerMappings": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets the list of all protection container mappings in a vault.", + "description": "Lists the protection container mappings in the vault.", + "operationId": "ReplicationProtectionContainerMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of all protection container mappings in a vault.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainers": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the list of all protection containers in a vault.", + "description": "Lists the protection containers in a vault.", + "operationId": "ReplicationProtectionContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of all protection containers in a vault.": { + "$ref": "./examples/ReplicationProtectionContainers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents": { + "get": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Gets the list of replication protection intent objects.", + "description": "Gets the list of ASR replication protection intent objects in the vault.", + "operationId": "ReplicationProtectionIntents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntentCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of replication protection intent objects.": { + "$ref": "./examples/ReplicationProtectionIntents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName}": { + "get": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Gets the details of a Replication protection intent item.", + "description": "Gets the details of an ASR replication protection intent.", + "operationId": "ReplicationProtectionIntents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Replication protection intent name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + } + }, + "x-ms-examples": { + "Gets the details of a Replication protection intent item.": { + "$ref": "./examples/ReplicationProtectionIntents_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Create protection intent Resource.", + "description": "The operation to create an ASR replication protection intent item.", + "operationId": "ReplicationProtectionIntents_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "A name for the replication protection item.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create Protection Intent Input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionIntentInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + } + }, + "x-ms-examples": { + "Create protection intent Resource.": { + "$ref": "./examples/ReplicationProtectionIntents_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans": { + "get": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Gets the list of recovery plans.", + "description": "Lists the recovery plans in the vault.", + "operationId": "ReplicationRecoveryPlans_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlanCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of recovery plans.": { + "$ref": "./examples/ReplicationRecoveryPlans_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}": { + "get": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Gets the requested recovery plan.", + "description": "Gets the details of the recovery plan.", + "operationId": "ReplicationRecoveryPlans_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Name of the recovery plan.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + } + }, + "x-ms-examples": { + "Gets the requested recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Creates a recovery plan with the given details.", + "description": "The operation to create a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery Plan creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateRecoveryPlanInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates a recovery plan with the given details.": { + "$ref": "./examples/ReplicationRecoveryPlans_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Deletes the specified recovery plan.", + "description": "Delete a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the specified recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Updates the given recovery plan.", + "description": "The operation to update a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update recovery plan input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateRecoveryPlanInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the given recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCancel": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute cancel failover of the recovery plan.", + "description": "The operation to cancel the failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_FailoverCancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute cancel failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_FailoverCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCommit": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute commit failover of the recovery plan.", + "description": "The operation to commit the failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_FailoverCommit", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute commit failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_FailoverCommit.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute planned failover of the recovery plan.", + "description": "The operation to start the planned failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_PlannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanPlannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute planned failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_PlannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/reProtect": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute reprotect of the recovery plan.", + "description": "The operation to reprotect(reverse replicate) a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Reprotect", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute reprotect of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Reprotect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute test failover of the recovery plan.", + "description": "The operation to start the test failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_TestFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan test failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanTestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_TestFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute test failover cleanup of the recovery plan.", + "description": "The operation to cleanup test failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover cleanup of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_TestFailoverCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute unplanned failover of the recovery plan.", + "description": "The operation to start the unplanned failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan unplanned failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute unplanned failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_UnplannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryServicesProviders": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the list of registered recovery services providers in the vault. This is a view only api.", + "description": "Lists the registered recovery services providers in the vault.", + "operationId": "ReplicationRecoveryServicesProviders_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProviderCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of registered recovery services providers in the vault. This is a view only api.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassificationMappings": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the list of storage classification mappings objects under a vault.", + "description": "Lists the storage classification mappings in the vault.", + "operationId": "ReplicationStorageClassificationMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification mappings objects under a vault.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassifications": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the list of storage classification objects under a vault.", + "description": "Lists the storage classifications in the vault.", + "operationId": "ReplicationStorageClassifications_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification objects under a vault.": { + "$ref": "./examples/ReplicationStorageClassifications_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationSupportedOperatingSystems": { + "get": { + "tags": [ + "SupportedOperatingSystems" + ], + "summary": "Gets the data of supported operating systems by SRS.", + "operationId": "SupportedOperatingSystems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "instanceType", + "in": "query", + "description": "The instance type.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SupportedOperatingSystems" + } + } + }, + "x-ms-examples": { + "Gets the data of supported operating systems by SRS.": { + "$ref": "./examples/SupportedOperatingSystems_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth": { + "get": { + "tags": [ + "ReplicationVaultHealth" + ], + "summary": "Gets the health summary for the vault.", + "description": "Gets the health details of the vault.", + "operationId": "ReplicationVaultHealth_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultHealthDetails" + } + } + }, + "x-ms-examples": { + "Gets the health summary for the vault.": { + "$ref": "./examples/ReplicationVaultHealth_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth/default/refresh": { + "post": { + "tags": [ + "ReplicationVaultHealth" + ], + "summary": "Refreshes health summary of the vault.", + "operationId": "ReplicationVaultHealth_Refresh", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultHealthDetails" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Refreshes health summary of the vault.": { + "$ref": "./examples/ReplicationVaultHealth_Refresh.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings": { + "get": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Gets the list of vault setting.", + "description": "Gets the list of vault setting. This includes the Migration Hub connection settings.", + "operationId": "ReplicationVaultSetting_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSettingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vault setting.": { + "$ref": "./examples/ReplicationVaultSetting_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings/{vaultSettingName}": { + "get": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Gets the vault setting.", + "description": "Gets the vault setting. This includes the Migration Hub connection settings.", + "operationId": "ReplicationVaultSetting_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "vaultSettingName", + "in": "path", + "description": "Vault setting name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSetting" + } + } + }, + "x-ms-examples": { + "Gets the vault setting.": { + "$ref": "./examples/ReplicationVaultSetting_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.", + "description": "The operation to configure vault setting.", + "operationId": "ReplicationVaultSetting_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "vaultSettingName", + "in": "path", + "description": "Vault setting name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Vault setting creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/VaultSettingCreationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSetting" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.": { + "$ref": "./examples/ReplicationVaultSetting_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationvCenters": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the list of vCenter registered under the vault.", + "description": "Lists the vCenter servers registered in the vault.", + "operationId": "ReplicationvCenters_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenterCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vCenter registered under the vault.": { + "$ref": "./examples/ReplicationvCenters_List.json" + } + } + } + } + }, + "definitions": { + "A2AAddDisksInput": { + "description": "A2A add disk(s) input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AddDisksProviderSpecificInput" + } + ], + "properties": { + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AApplyClusterRecoveryPointInput": { + "description": "A2A provider specific input for apply cluster recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyClusterRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2A" + }, + "A2AClusterRecoveryPointDetails": { + "description": "A2A provider specific cluster recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClusterProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "recoveryPointSyncType": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "enum": [ + "MultiVmSyncRecoveryPoint" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointSyncType", + "modelAsString": true + } + }, + "nodes": { + "description": "The list of nodes representing the cluster.", + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems" + } + ] + } + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to A2A provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2A" + }, + "A2AClusterTestFailoverInput": { + "description": "A2A provider specific input for test cluster failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClusterTestFailoverProviderSpecificInput" + } + ], + "properties": { + "clusterRecoveryPointId": { + "description": "The cluster recovery point id to be passed to failover to a particular recovery point.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters/recoveryPoints" + } + ] + } + }, + "individualNodeRecoveryPoints": { + "description": "The list of individual node recovery points.", + "type": "array", + "items": { + "type": "string", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints" + } + ] + } + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AClusterUnplannedFailoverInput": { + "description": "A2A provider specific input for unplanned cluster failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClusterUnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "clusterRecoveryPointId": { + "description": "The cluster recovery point id to be passed to failover to a particular recovery point.", + "type": "string" + }, + "individualNodeRecoveryPoints": { + "description": "The list of individual node recovery points.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AContainerCreationInput": { + "description": "A2A cloud creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2A" + }, + "A2AContainerMappingInput": { + "description": "A2A container mapping input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the type authentication to use for automation Account.", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ACreateProtectionIntentInput": { + "description": "A2A create protection intent input.", + "required": [ + "fabricObjectId", + "primaryLocation", + "recoveryLocation", + "recoverySubscriptionId", + "recoveryAvailabilityType", + "recoveryResourceGroupId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryLocation": { + "description": "The primary location for the virtual machine.", + "type": "string" + }, + "recoveryLocation": { + "description": "The recovery location for the virtual machine.", + "type": "string" + }, + "recoverySubscriptionId": { + "description": "The recovery subscription Id of the virtual machine.", + "type": "string" + }, + "recoveryAvailabilityType": { + "description": "The recovery availability type of the virtual machine.", + "enum": [ + "Single", + "AvailabilitySet", + "AvailabilityZone" + ], + "type": "string", + "x-ms-enum": { + "name": "A2ARecoveryAvailabilityType", + "modelAsString": true + } + }, + "protectionProfileCustomInput": { + "$ref": "#/definitions/ProtectionProfileCustomDetails", + "description": "The protection profile custom inputs." + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + }, + "recoveryAvailabilitySetCustomInput": { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", + "description": "The recovery availability set input." + }, + "recoveryVirtualNetworkCustomInput": { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", + "description": "The recovery virtual network input." + }, + "recoveryProximityPlacementGroupCustomInput": { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", + "description": "The recovery proximity placement group custom input." + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of vm disk inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The boot diagnostic storage account." + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the authentication type for automation account. The default value is \"RunAsAccount\".", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ACrossClusterMigrationApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to A2ACrossClusterMigration provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationContainerCreationInput": { + "description": "A2ACrossClusterMigration cloud creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationEnableProtectionInput": { + "description": "A2A Cross-Cluster Migration enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationPolicyCreationInput": { + "description": "A2A Cross-Cluster Migration Policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationReplicationDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "osType": { + "description": "The type of operating system.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "lifecycleId": { + "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2AEnableProtectionInput": { + "description": "A2A enable protection input.", + "required": [ + "fabricObjectId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "protectionClusterId": { + "description": "The replication protection cluster Id.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters" + } + ] + } + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery extended location." + }, + "recoveryAzureNetworkId": { + "description": "The recovery Azure virtual network ARM id.", + "type": "string" + }, + "recoverySubnetName": { + "description": "The recovery subnet name.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The virtual machine scale set Id.", + "type": "string" + }, + "recoveryCapacityReservationGroupId": { + "description": "The recovery capacity reservation group Id.", + "type": "string" + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AEventDetails": { + "description": "Model class for event details of a A2A event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item arm name.", + "type": "string" + }, + "fabricObjectId": { + "description": "The azure vm arm id.", + "type": "string" + }, + "fabricName": { + "description": "Fabric arm name.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "type": "string" + }, + "remoteFabricName": { + "description": "Remote fabric arm name.", + "type": "string" + }, + "remoteFabricLocation": { + "description": "Remote fabric location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AExtendedLocationDetails": { + "description": "ExtendedLocation details data.", + "type": "object", + "properties": { + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary ExtendedLocation." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery ExtendedLocation." + } + } + }, + "A2AFabricSpecificLocationDetails": { + "description": "ExtendedLocation details data.", + "type": "object", + "properties": { + "initialPrimaryZone": { + "description": "The initial source zone info.", + "type": "string" + }, + "initialRecoveryZone": { + "description": "The initial target zone info.", + "type": "string" + }, + "initialPrimaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial primary ExtendedLocation." + }, + "initialRecoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial recovery ExtendedLocation." + }, + "initialPrimaryFabricLocation": { + "description": "Initial primary fabric location info.", + "type": "string" + }, + "initialRecoveryFabricLocation": { + "description": "The initial recovery fabric location info.", + "type": "string" + }, + "primaryZone": { + "description": "Source zone info.", + "type": "string" + }, + "recoveryZone": { + "description": "The target zone info.", + "type": "string" + }, + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary ExtendedLocation." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery ExtendedLocation." + }, + "primaryFabricLocation": { + "description": "Primary fabric location info.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location info.", + "type": "string" + } + } + }, + "A2APolicyCreationInput": { + "description": "A2A Policy creation input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2APolicyDetails": { + "description": "A2A specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AProtectedDiskDetails": { + "description": "A2A protected disk details.", + "type": "object", + "properties": { + "diskUri": { + "description": "The disk uri.", + "type": "string" + }, + "recoveryAzureStorageAccountId": { + "description": "The recovery disk storage account.", + "type": "string" + }, + "primaryDiskAzureStorageAccountId": { + "description": "The primary disk storage account.", + "type": "string" + }, + "recoveryDiskUri": { + "description": "Recovery disk uri.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account.", + "type": "string" + }, + "diskType": { + "description": "The type of disk.", + "type": "string" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "boolean" + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "dataPendingInStagingStorageAccountInMB": { + "format": "double", + "description": "The data pending for replication in MB at staging account.", + "type": "number" + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source virtual machine in MB.", + "type": "number" + }, + "diskState": { + "description": "The disk state.", + "type": "string" + }, + "allowedDiskLevelOperation": { + "description": "The disk level operations list.", + "type": "array", + "items": { + "type": "string" + } + }, + "isDiskEncrypted": { + "description": "A value indicating whether vm has encrypted os disk or not.", + "type": "boolean" + }, + "secretIdentifier": { + "description": "The secret URL / identifier (BEK).", + "type": "string" + }, + "dekKeyVaultArmId": { + "description": "The KeyVault resource id for secret (BEK).", + "type": "string" + }, + "isDiskKeyEncrypted": { + "description": "A value indicating whether disk key got encrypted or not.", + "type": "boolean" + }, + "keyIdentifier": { + "description": "The key URL / identifier (KEK).", + "type": "string" + }, + "kekKeyVaultArmId": { + "description": "The KeyVault resource id for key (KEK).", + "type": "string" + }, + "failoverDiskName": { + "description": "The failover name for the managed disk.", + "type": "string" + }, + "tfoDiskName": { + "description": "The test failover name for the managed disk.", + "type": "string" + } + } + }, + "A2AProtectedItemDetail": { + "description": "A2A specific switch cluster protection input.", + "type": "object", + "properties": { + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set.", + "type": "string" + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The virtual machine scale set id.", + "type": "string" + }, + "recoveryCapacityReservationGroupId": { + "description": "The recovery capacity reservation group Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information." + }, + "replicationProtectedItemName": { + "description": "The Replication Protected item name.", + "type": "string" + } + } + }, + "A2AProtectedManagedDiskDetails": { + "description": "A2A protected managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The managed disk Arm id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The recovery disk resource group Arm Id.", + "type": "string" + }, + "recoveryTargetDiskId": { + "description": "Recovery target disk Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskId": { + "description": "Recovery replica disk Arm Id.", + "type": "string" + }, + "recoveryOrignalTargetDiskId": { + "description": "Recovery original target disk Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "primaryDiskEncryptionSetId": { + "description": "The primary disk encryption set Id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account.", + "type": "string" + }, + "diskType": { + "description": "The type of disk.", + "type": "string" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "boolean" + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "dataPendingInStagingStorageAccountInMB": { + "format": "double", + "description": "The data pending for replication in MB at staging account.", + "type": "number" + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source virtual machine in MB.", + "type": "number" + }, + "diskState": { + "description": "The disk state.", + "type": "string" + }, + "allowedDiskLevelOperation": { + "description": "The disk level operations list.", + "type": "array", + "items": { + "type": "string" + } + }, + "isDiskEncrypted": { + "description": "A value indicating whether vm has encrypted os disk or not.", + "type": "boolean" + }, + "secretIdentifier": { + "description": "The secret URL / identifier (BEK).", + "type": "string" + }, + "dekKeyVaultArmId": { + "description": "The KeyVault resource id for secret (BEK).", + "type": "string" + }, + "isDiskKeyEncrypted": { + "description": "A value indicating whether disk key got encrypted or not.", + "type": "boolean" + }, + "keyIdentifier": { + "description": "The key URL / identifier (KEK).", + "type": "string" + }, + "kekKeyVaultArmId": { + "description": "The KeyVault resource id for key (KEK).", + "type": "string" + }, + "failoverDiskName": { + "description": "The failover name for the managed disk.", + "type": "string" + }, + "tfoDiskName": { + "description": "The test failover name for the managed disk.", + "type": "string" + } + } + }, + "A2AProtectionContainerMappingDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the type authentication to use for automation Account.", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + }, + "scheduleName": { + "description": "The schedule arm name.", + "type": "string" + }, + "jobScheduleName": { + "description": "The job schedule arm name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AProtectionIntentDiskInputDetails": { + "description": "Azure VM unmanaged disk input details.", + "required": [ + "diskUri" + ], + "type": "object", + "properties": { + "diskUri": { + "description": "The disk Uri.", + "type": "string" + }, + "recoveryAzureStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The recovery VHD storage account input." + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + } + } + }, + "A2AProtectionIntentManagedDiskInputDetails": { + "description": "Azure VM managed disk input details.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + }, + "recoveryResourceGroupCustomInput": { + "$ref": "#/definitions/RecoveryResourceGroupCustomDetails", + "description": "The recovery resource group input." + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for one / single pass flows)." + } + } + }, + "A2ARecoveryPointDetails": { + "description": "A2A provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "recoveryPointSyncType": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "enum": [ + "MultiVmSyncRecoveryPoint", + "PerVmRecoveryPoint" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointSyncType", + "modelAsString": true + } + }, + "disks": { + "description": "List of disk ids representing a recovery point.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ARemoveDisksInput": { + "description": "A2A remove disk(s) input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RemoveDisksProviderSpecificInput" + } + ], + "properties": { + "vmDisksUris": { + "description": "The list of vm disk vhd URIs.", + "type": "array", + "items": { + "type": "string" + } + }, + "vmManagedDisksIds": { + "description": "The list of vm managed disk Ids.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReplicationDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "initialPrimaryZone": { + "description": "The initial primary availability zone.", + "type": "string", + "readOnly": true + }, + "initialPrimaryFabricLocation": { + "description": "The initial primary fabric location.", + "type": "string", + "readOnly": true + }, + "initialRecoveryZone": { + "description": "The initial recovery availability zone.", + "type": "string", + "readOnly": true + }, + "initialPrimaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial primary extended location." + }, + "initialRecoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial recovery extended location." + }, + "initialRecoveryFabricLocation": { + "description": "The initial recovery fabric location.", + "type": "string", + "readOnly": true + }, + "multiVmGroupId": { + "description": "The multi vm group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupCreateOption": { + "description": "Whether Multi VM group is auto created or specified by user.", + "enum": [ + "AutoCreated", + "UserSpecified" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmGroupCreateOption", + "modelAsString": true + } + }, + "managementId": { + "description": "The management Id.", + "type": "string" + }, + "protectionClusterId": { + "description": "The replication protection cluster Id.", + "type": "string" + }, + "isClusterInfraReady": { + "description": "A value indicating if the cluster infra is ready or not.", + "type": "boolean" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedDiskDetails" + } + }, + "unprotectedDisks": { + "description": "The list of unprotected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AUnprotectedDiskDetails" + } + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedManagedDiskDetails" + } + }, + "recoveryBootDiagStorageAccountId": { + "description": "The recovery boot diagnostic storage account Arm Id.", + "type": "string" + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + }, + "osType": { + "description": "The type of operating system.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The size of recovery virtual machine.", + "type": "string" + }, + "recoveryAzureVMName": { + "description": "The name of recovery virtual machine.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The recovery resource group.", + "type": "string" + }, + "recoveryCloudService": { + "description": "The recovery cloud service.", + "type": "string" + }, + "recoveryAvailabilitySet": { + "description": "The recovery availability set.", + "type": "string" + }, + "selectedRecoveryAzureNetworkId": { + "description": "The recovery virtual network.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The test failover virtual network.", + "type": "string" + }, + "vmNics": { + "description": "The virtual machine nic details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmSyncedConfigDetails": { + "$ref": "#/definitions/AzureToAzureVmSyncedConfigDetails", + "description": "The synced configuration details." + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "isReplicationAgentUpdateRequired": { + "description": "A value indicating whether replication agent update is required.", + "type": "boolean" + }, + "agentCertificateExpiryDate": { + "format": "date-time", + "description": "Agent certificate expiry date.", + "type": "string", + "readOnly": true + }, + "isReplicationAgentCertificateUpdateRequired": { + "description": "A value indicating whether agent certificate update is required.", + "type": "boolean" + }, + "recoveryFabricObjectId": { + "description": "The recovery fabric object Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "lifecycleId": { + "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing.", + "type": "string" + }, + "testFailoverRecoveryFabricObjectId": { + "description": "The test failover fabric object Id.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The last RPO value in seconds.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The time (in UTC) when the last RPO value was calculated by Protection Service.", + "type": "string" + }, + "primaryAvailabilityZone": { + "description": "The primary availability zone.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary Extended Location." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery Extended Location." + }, + "vmEncryptionType": { + "description": "The encryption type of the VM.", + "type": "string", + "readOnly": true, + "enum": [ + "NotEncrypted", + "OnePassEncrypted", + "TwoPassEncrypted" + ], + "x-ms-enum": { + "name": "VmEncryptionType", + "modelAsString": true + } + }, + "tfoAzureVMName": { + "description": "The test failover vm name.", + "type": "string" + }, + "recoveryAzureGeneration": { + "description": "The recovery azure generation.", + "type": "string", + "readOnly": true + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The recovery virtual machine scale set id.", + "type": "string" + }, + "recoveryCapacityReservationGroupId": { + "description": "The recovery capacity reservation group Id.", + "type": "string" + }, + "churnOptionSelected": { + "description": "A value indicating the churn option selected by user.", + "type": "string", + "readOnly": true, + "enum": [ + "Normal", + "High" + ], + "x-ms-enum": { + "name": "ChurnOptionSelected", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReplicationIntentDetails": { + "description": "A2A provider specific settings.", + "required": [ + "recoveryAvailabilityType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryLocation": { + "description": "The primary location for the virtual machine.", + "type": "string" + }, + "recoveryLocation": { + "description": "The recovery location for the virtual machine.", + "type": "string" + }, + "recoverySubscriptionId": { + "description": "The recovery subscription Id of the virtual machine.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group id.", + "type": "string" + }, + "protectionProfile": { + "$ref": "#/definitions/ProtectionProfileCustomDetails", + "description": "The protection profile custom details." + }, + "primaryStagingStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account details." + }, + "recoveryAvailabilitySet": { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", + "description": "The recovery availability set details." + }, + "recoveryVirtualNetwork": { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", + "description": "The recovery virtual network details." + }, + "recoveryProximityPlacementGroup": { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", + "description": "The recovery proximity placement group custom details." + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The boot diagnostic storage account." + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryAvailabilityType": { + "description": "The recovery availability type of the virtual machine.", + "type": "string" + }, + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the type authentication to use for automation Account.", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReplicationProtectionClusterDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationClusterProviderSpecificSettings" + } + ], + "properties": { + "multiVmGroupId": { + "description": "The multi vm group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupCreateOption": { + "description": "Whether Multi VM group is auto created or specified by user.", + "enum": [ + "AutoCreated", + "UserSpecified" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmGroupCreateOption", + "modelAsString": true + } + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + }, + "failoverRecoveryPointId": { + "description": "The recovery point Id to which the cluster was failed over.", + "type": "string" + }, + "clusterManagementId": { + "description": "The cluster management Id.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The last RPO value in seconds.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The time (in UTC) when the last RPO value was calculated by Protection Service.", + "type": "string" + }, + "initialPrimaryZone": { + "description": "The initial primary availability zone.", + "type": "string" + }, + "initialPrimaryFabricLocation": { + "description": "The initial primary fabric location.", + "type": "string" + }, + "initialRecoveryZone": { + "description": "The initial recovery availability zone.", + "type": "string" + }, + "initialRecoveryFabricLocation": { + "description": "The initial recovery fabric location.", + "type": "string" + }, + "initialPrimaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial primary extended location." + }, + "initialRecoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial recovery extended location." + }, + "primaryAvailabilityZone": { + "description": "The primary availability zone.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary Extended Location." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery Extended Location." + }, + "lifecycleId": { + "description": "An id that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected cluster even though other internal Ids/ARM Id might be changing.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReprotectInput": { + "description": "Azure specific reprotect input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ASharedDiskIRErrorDetails": { + "description": "Extended location of the resource.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorCodeEnum": { + "description": "The error code enum.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + } + } + }, + "A2ASharedDiskReplicationDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedDiskReplicationProviderSpecificSettings" + } + ], + "properties": { + "managementId": { + "description": "The management Id.", + "type": "string" + }, + "unprotectedDisks": { + "description": "The list of unprotected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AUnprotectedDiskDetails" + }, + "x-ms-identifiers": [ + "diskLunId" + ] + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedManagedDiskDetails" + }, + "x-ms-identifiers": [ + "diskId" + ] + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + }, + "failoverRecoveryPointId": { + "description": "The recovery point id to which the Virtual node was failed over.", + "type": "string" + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The last RPO value in seconds.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The time (in UTC) when the last RPO value was calculated by Protection Service.", + "type": "string" + }, + "sharedDiskIRErrors": { + "description": "The IR Errors.", + "type": "array", + "items": { + "$ref": "#/definitions/A2ASharedDiskIRErrorDetails" + }, + "x-ms-identifiers": [ + "errorCode" + ] + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ASwitchClusterProtectionInput": { + "description": "A2A specific switch cluster protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SwitchClusterProtectionProviderSpecificInput" + } + ], + "properties": { + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "protectedItemsDetail": { + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedItemDetail" + }, + "x-ms-identifiers": [ + "replicationProtectedItemName" + ] + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ASwitchProtectionInput": { + "description": "A2A specific switch protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SwitchProtectionProviderSpecificInput" + } + ], + "properties": { + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The virtual machine scale set id.", + "type": "string" + }, + "recoveryCapacityReservationGroupId": { + "description": "The recovery capacity reservation group Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information." + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ATestFailoverInput": { + "description": "A2A provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for TFO or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUnplannedFailoverInput": { + "description": "A2A provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for failover or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUnprotectedDiskDetails": { + "description": "A2A unprotected disk details.", + "type": "object", + "properties": { + "diskLunId": { + "format": "int32", + "description": "The source lun Id for the data disk.", + "type": "integer" + }, + "diskAutoProtectionStatus": { + "description": "A value indicating whether the disk auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + } + } + }, + "A2AUpdateContainerMappingInput": { + "description": "A2A update protection container mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the type authentication to use for automation Account.", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUpdateReplicationProtectedItemInput": { + "description": "InMage Azure V2 input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryCloudServiceId": { + "description": "The target cloud service ARM Id (for V1).", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The target resource group ARM Id (for V2).", + "type": "string" + }, + "managedDiskUpdateDetails": { + "description": "Managed disk update details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskUpdateDetails" + } + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery os disk encryption information." + }, + "tfoAzureVMName": { + "description": "The user given name for Test Failover VM.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The recovery virtual machine scale set Id.", + "type": "string" + }, + "recoveryCapacityReservationGroupId": { + "description": "The recovery capacity reservation group Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AVmDiskInputDetails": { + "description": "A2A disk input details.", + "required": [ + "diskUri", + "recoveryAzureStorageAccountId", + "primaryStagingAzureStorageAccountId" + ], + "type": "object", + "properties": { + "diskUri": { + "description": "The disk Uri.", + "type": "string" + }, + "recoveryAzureStorageAccountId": { + "description": "The recovery VHD storage account Id.", + "type": "string" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account Id.", + "type": "string" + } + } + }, + "A2AVmManagedDiskInputDetails": { + "description": "A2A managed disk input details.", + "required": [ + "diskId", + "primaryStagingAzureStorageAccountId", + "recoveryResourceGroupId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account Arm Id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The target resource group Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for one / single pass flows)." + } + } + }, + "A2AVmManagedDiskUpdateDetails": { + "description": "A2A Vm managed disk update details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type before failover.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type before failover.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery os disk encryption information." + }, + "failoverDiskName": { + "description": "The target disk name for unplanned failover operation.", + "type": "string" + }, + "tfoDiskName": { + "description": "The target disk name for test failover operation.", + "type": "string" + } + } + }, + "A2AZoneDetails": { + "description": "Zone details data.", + "type": "object", + "properties": { + "source": { + "description": "Source zone info.", + "type": "string" + }, + "target": { + "description": "The target zone info.", + "type": "string" + } + } + }, + "AddDisksInput": { + "description": "Input for add disk(s) operation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddDisksInputProperties", + "description": "Add disks input properties." + } + } + }, + "AddDisksInputProperties": { + "description": "Add Disks input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/AddDisksProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "AddDisksProviderSpecificInput": { + "description": "Add Disks provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "AddRecoveryServicesProviderInput": { + "description": "Input required to add a provider.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddRecoveryServicesProviderInputProperties", + "description": "The properties of an add provider request." + } + } + }, + "AddRecoveryServicesProviderInputProperties": { + "description": "The properties of an add provider request.", + "required": [ + "machineName", + "authenticationIdentityInput", + "resourceAccessIdentityInput" + ], + "type": "object", + "properties": { + "machineName": { + "description": "The name of the machine where the provider is getting added.", + "type": "string" + }, + "machineId": { + "description": "The Id of the machine where the provider is getting added.", + "type": "string" + }, + "biosId": { + "description": "The Bios Id of the machine.", + "type": "string" + }, + "authenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for DRA authentication." + }, + "resourceAccessIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for resource access." + }, + "dataPlaneAuthenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for data plane authentication." + } + } + }, + "AddVCenterRequest": { + "description": "Input required to add vCenter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddVCenterRequestProperties", + "description": "The properties of an add vCenter request." + } + } + }, + "AddVCenterRequestProperties": { + "description": "The properties of an add vCenter request.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the vCenter.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter to be discovered.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id from where the discovery is orchestrated.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The account Id which has privileges to discover the vCenter.", + "type": "string" + } + } + }, + "AgentDetails": { + "description": "Agent details.", + "type": "object", + "properties": { + "agentId": { + "description": "The Id of the agent running on the server.", + "type": "string", + "readOnly": true + }, + "machineId": { + "description": "The Id of the machine to which the agent is registered.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The machine BIOS Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The machine FQDN.", + "type": "string", + "readOnly": true + }, + "disks": { + "description": "The disks.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDiskDetails" + }, + "readOnly": true + } + } + }, + "AgentDiskDetails": { + "description": "Agent disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "lunId": { + "format": "int32", + "description": "The lun of disk.", + "type": "integer", + "readOnly": true + } + } + }, + "Alert": { + "description": "Implements the Alert class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AlertProperties", + "description": "Alert related data." + } + } + }, + "AlertCollection": { + "description": "Collection of alerts.", + "type": "object", + "properties": { + "value": { + "description": "The list of alerts.", + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "AlertProperties": { + "description": "The properties of an alert.", + "type": "object", + "properties": { + "sendToOwners": { + "description": "A value indicating whether to send email to subscription administrator.", + "type": "string" + }, + "customEmailAddresses": { + "description": "The custom email address for sending emails.", + "type": "array", + "items": { + "type": "string" + } + }, + "locale": { + "description": "The locale for the email notification.", + "type": "string" + } + } + }, + "ApplianceCollection": { + "description": "Collection of appliance details.", + "type": "object", + "properties": { + "value": { + "description": "The appliance details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationAppliance" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ApplianceMonitoringDetails": { + "description": "Appliance details of the migration item.", + "type": "object", + "properties": { + "cpuDetails": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The appliance CPU details.", + "readOnly": true + }, + "ramDetails": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The appliance RAM details.", + "readOnly": true + }, + "datastoreSnapshot": { + "description": "The appliance datastore snapshot details.", + "type": "array", + "items": { + "$ref": "#/definitions/DataStoreUtilizationDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disksReplicationDetails": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The disk replication details.", + "readOnly": true + }, + "esxiNfcBuffer": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The ESXi NFC buffer details.", + "readOnly": true + }, + "networkBandwidth": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The appliance network bandwidth details.", + "readOnly": true + } + } + }, + "ApplianceQueryParameter": { + "description": "Query parameter to get appliance.", + "type": "object", + "properties": { + "providerType": { + "description": "The providerType to be used for fetching appliance details.", + "type": "string" + } + } + }, + "ApplianceResourceDetails": { + "description": "Details of the appliance resource.", + "type": "object", + "properties": { + "capacity": { + "format": "int64", + "description": "A value indicating the total capacity of appliance resource.", + "type": "integer", + "readOnly": true + }, + "processUtilization": { + "format": "double", + "description": "A value indicating the utilization percentage by gateway agent on appliance.", + "type": "number", + "readOnly": true + }, + "totalUtilization": { + "format": "double", + "description": "A value indicating the total utilization percentage for all processes on the appliance.", + "type": "number", + "readOnly": true + }, + "status": { + "description": "A value indicating the status of appliance resource.", + "type": "string", + "readOnly": true + } + } + }, + "ApplianceSpecificDetails": { + "description": "Appliance specific details.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType", + "required": [ + "instanceType" + ] + }, + "ApplyClusterRecoveryPointInput": { + "description": "Input definition for apply cluster recovery point.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ApplyClusterRecoveryPointInputProperties", + "description": "The properties to apply cluster recovery point input." + } + } + }, + "ApplyClusterRecoveryPointInputProperties": { + "description": "Input definition for apply cluster recovery point properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "clusterRecoveryPointId": { + "description": "The cluster recovery point id to be passed to failover to a particular recovery point.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters/recoveryPoints" + } + ] + } + }, + "individualNodeRecoveryPoints": { + "description": "The list of individual node recovery points.", + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems" + } + ] + } + } + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ApplyClusterRecoveryPointProviderSpecificInput", + "description": "The provider specific input for applying cluster recovery point." + } + } + }, + "ApplyClusterRecoveryPointProviderSpecificInput": { + "description": "Provider specific input for apply cluster recovery point.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ApplyRecoveryPointInput": { + "description": "Input to apply recovery point.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ApplyRecoveryPointInputProperties", + "description": "The input properties to apply recovery point." + } + } + }, + "ApplyRecoveryPointInputProperties": { + "description": "Input properties to apply recovery point.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput", + "description": "Provider specific input for applying recovery point." + } + } + }, + "ApplyRecoveryPointProviderSpecificInput": { + "description": "Provider specific input for apply recovery point.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "AsrJobDetails": { + "description": "This class represents job details based on specific job type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "AsrJobDetails" + }, + "ASRTask": { + "description": "Task of the Job.", + "type": "object", + "properties": { + "taskId": { + "description": "The Id.", + "type": "string" + }, + "name": { + "description": "The unique Task name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "allowedActions": { + "description": "The state/actions applicable on this task.", + "type": "array", + "items": { + "type": "string" + } + }, + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "state": { + "description": "The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.", + "type": "string" + }, + "stateDescription": { + "description": "The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.", + "type": "string" + }, + "taskType": { + "description": "The type of task. Details in CustomDetails property depend on this type.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/TaskTypeDetails", + "description": "The custom task details based on the task type." + }, + "groupTaskCustomDetails": { + "$ref": "#/definitions/GroupTaskDetails", + "description": "The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it." + }, + "errors": { + "description": "The task error details.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + } + } + }, + "AutomationRunbookTaskDetails": { + "description": "This class represents the task details for an automation runbook.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The recovery plan task name.", + "type": "string" + }, + "cloudServiceName": { + "description": "The cloud service of the automation runbook account.", + "type": "string" + }, + "subscriptionId": { + "description": "The subscription Id of the automation runbook account.", + "type": "string" + }, + "accountName": { + "description": "The automation account name of the runbook.", + "type": "string" + }, + "runbookId": { + "description": "The runbook Id.", + "type": "string" + }, + "runbookName": { + "description": "The runbook name.", + "type": "string" + }, + "jobId": { + "description": "The job Id of the runbook execution.", + "type": "string" + }, + "jobOutput": { + "description": "The execution output of the runbook.", + "type": "string" + }, + "isPrimarySideScript": { + "description": "A value indicating whether it is a primary side script or not.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "AutomationRunbookTaskDetails" + }, + "AzureFabricCreationInput": { + "description": "Fabric provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "location": { + "description": "The Location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Azure" + }, + "AzureFabricSpecificDetails": { + "description": "Azure Fabric Specific Details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "location": { + "description": "The Location for the Azure fabric.", + "type": "string" + }, + "containerIds": { + "description": "The container Ids for the Azure fabric.", + "type": "array", + "items": { + "type": "string" + } + }, + "zones": { + "description": "The zones.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AZoneDetails" + } + }, + "extendedLocations": { + "description": "The ExtendedLocations.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AExtendedLocationDetails" + }, + "x-ms-identifiers": [] + }, + "locationDetails": { + "description": "The location details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AFabricSpecificLocationDetails" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "Azure" + }, + "AzureToAzureCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to Azure to Azure Network mapping.", + "required": [ + "primaryNetworkId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": { + "primaryNetworkId": { + "description": "The primary azure vnet Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureNetworkMappingSettings": { + "description": "A2A Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": { + "primaryFabricLocation": { + "description": "The primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureUpdateNetworkMappingInput": { + "description": "Updates network mappings input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": { + "primaryNetworkId": { + "description": "The primary azure vnet Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureVmSyncedConfigDetails": { + "description": "Azure to Azure VM synced configuration details.", + "type": "object", + "properties": { + "tags": { + "description": "The Azure VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "inputEndpoints": { + "description": "The Azure VM input endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/InputEndpoint" + } + } + } + }, + "AzureVmDiskDetails": { + "description": "Disk details for E2A provider.", + "type": "object", + "properties": { + "vhdType": { + "description": "VHD type.", + "type": "string" + }, + "vhdId": { + "description": "The VHD id.", + "type": "string" + }, + "diskId": { + "description": "The disk resource id.", + "type": "string" + }, + "vhdName": { + "description": "VHD name.", + "type": "string" + }, + "maxSizeMB": { + "description": "Max side in MB.", + "type": "string" + }, + "targetDiskLocation": { + "description": "Blob uri of the Azure disk.", + "type": "string" + }, + "targetDiskName": { + "description": "The target Azure disk name.", + "type": "string" + }, + "lunId": { + "description": "Ordinal\\LunId of the disk for the Azure VM.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + }, + "customTargetDiskName": { + "description": "The custom target Azure disk name.", + "type": "string" + } + } + }, + "ClusterFailoverJobDetails": { + "description": "This class represents the details for a failover job of cluster.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-discriminator-value": "ClusterFailoverJobDetails" + }, + "ClusterProviderSpecificRecoveryPointDetails": { + "description": "Replication provider specific cluster recovery point details.", + "type": "object", + "required": [ + "instanceType" + ], + "properties": { + "instanceType": { + "description": "Gets the provider type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "ClusterRecoveryPoint": { + "description": "Recovery point.", + "type": "object", + "properties": { + "id": { + "description": "The recovery point Id.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters/recoveryPoints" + } + ] + } + }, + "name": { + "description": "The name of the recovery point.", + "type": "string" + }, + "type": { + "description": "The resource type.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ClusterRecoveryPointProperties", + "description": "The recovery point properties." + } + } + }, + "ClusterRecoveryPointCollection": { + "description": "Collection of cluster recovery point details.", + "type": "object", + "properties": { + "value": { + "description": "The cluster recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterRecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ClusterRecoveryPointProperties": { + "description": "Cluster recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string" + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "NotSpecified", + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "ClusterRecoveryPointType", + "modelAsString": true + } + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ClusterProviderSpecificRecoveryPointDetails", + "description": "The provider specific details for the recovery point." + } + } + }, + "ClusterSwitchProtectionJobDetails": { + "description": "This class represents details for switch cluster protection job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "newReplicationProtectionClusterId": { + "description": "ARM Id of the new replication protection cluster.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ClusterSwitchProtectionJobDetails" + }, + "ClusterTestFailoverCleanupInput": { + "description": "Input definition for test failover cleanup for cluster.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ClusterTestFailoverCleanupInputProperties", + "description": "Test failover cleanup input properties." + } + } + }, + "ClusterTestFailoverCleanupInputProperties": { + "description": "Input definition for test failover cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test failover cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "ClusterTestFailoverInput": { + "description": "Input definition for test cluster failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ClusterTestFailoverInputProperties", + "description": "Test failover input properties." + } + } + }, + "ClusterTestFailoverInputProperties": { + "description": "Input definition for test failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "FailoverDirection", + "modelAsString": true + } + }, + "networkType": { + "description": "Network type to be used for test failover.", + "type": "string" + }, + "networkId": { + "description": "The id of the network to be used for test failover.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + } + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ClusterTestFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "ClusterTestFailoverJobDetails": { + "description": "This class represents the details for a test failover job of cluster.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "testFailoverStatus": { + "description": "The test failover status.", + "type": "string" + }, + "comments": { + "description": "The test failover comments.", + "type": "string" + }, + "networkName": { + "description": "The test network name.", + "type": "string" + }, + "networkFriendlyName": { + "description": "The test network friendly name.", + "type": "string" + }, + "networkType": { + "description": "The test network type (see TestFailoverInput enum for possible values).", + "type": "string" + }, + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + } + } + }, + "x-ms-discriminator-value": "ClusterTestFailoverJobDetails" + }, + "ClusterTestFailoverProviderSpecificInput": { + "description": "Provider specific test cluster failover input.", + "type": "object", + "required": [ + "instanceType" + ], + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ClusterUnplannedFailoverInput": { + "description": "Input definition for unplanned cluster failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ClusterUnplannedFailoverInputProperties", + "description": "Unplanned failover input properties." + } + } + }, + "ClusterUnplannedFailoverInputProperties": { + "description": "Input definition for unplanned failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "sourceSiteOperations": { + "description": "Source site operations status.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ClusterUnplannedFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "ClusterUnplannedFailoverProviderSpecificInput": { + "description": "Provider specific unplanned cluster failover input.", + "type": "object", + "required": [ + "instanceType" + ], + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ComputeSizeErrorDetails": { + "description": "Represents the error used to indicate why the target compute size is not applicable.", + "type": "object", + "properties": { + "message": { + "description": "The error message.", + "type": "string" + }, + "severity": { + "description": "The severity of the error.", + "type": "string" + } + } + }, + "ConfigurationSettings": { + "description": "Replication provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ConfigureAlertRequest": { + "description": "Request to configure alerts for the system.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigureAlertRequestProperties", + "description": "The properties of a configure alert request." + } + } + }, + "ConfigureAlertRequestProperties": { + "description": "Properties of a configure alert request.", + "type": "object", + "properties": { + "sendToOwners": { + "description": "A value indicating whether to send email to subscription administrator.", + "type": "string" + }, + "customEmailAddresses": { + "description": "The custom email address for sending emails.", + "type": "array", + "items": { + "type": "string" + } + }, + "locale": { + "description": "The locale for the email notification.", + "type": "string" + } + } + }, + "ConsistencyCheckTaskDetails": { + "description": "This class contains monitoring details of all the inconsistent Protected Entities in Vmm.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "vmDetails": { + "description": "The list of inconsistent Vm details.", + "type": "array", + "items": { + "$ref": "#/definitions/InconsistentVmDetails" + } + } + }, + "x-ms-discriminator-value": "ConsistencyCheckTaskDetails" + }, + "CreateNetworkMappingInput": { + "description": "Create network mappings input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateNetworkMappingInputProperties", + "description": "Input properties for creating network mapping." + } + } + }, + "CreateNetworkMappingInputProperties": { + "description": "Common input details for network mapping operation.", + "required": [ + "recoveryNetworkId" + ], + "type": "object", + "properties": { + "recoveryFabricName": { + "description": "Recovery fabric Name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "Recovery network Id.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput", + "description": "Fabric specific input properties." + } + } + }, + "CreatePolicyInput": { + "description": "Protection Policy input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreatePolicyInputProperties", + "description": "Policy creation properties." + } + } + }, + "CreatePolicyInputProperties": { + "description": "Policy creation properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/PolicyProviderSpecificInput", + "description": "The ReplicationProviderSettings." + } + } + }, + "CreateProtectionContainerInput": { + "description": "Create protection container input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionContainerInputProperties", + "description": "Create protection container input properties." + } + } + }, + "CreateProtectionContainerInputProperties": { + "description": "Create protection container input properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "description": "Provider specific inputs for container creation.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + } + } + }, + "CreateProtectionContainerMappingInput": { + "description": "Configure pairing input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionContainerMappingInputProperties", + "description": "Configure protection input properties." + } + } + }, + "CreateProtectionContainerMappingInputProperties": { + "description": "Configure pairing input properties.", + "type": "object", + "properties": { + "targetProtectionContainerId": { + "description": "The target unique protection container name.", + "type": "string" + }, + "policyId": { + "description": "Applicable policy.", + "type": "string" + }, + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput", + "description": "Provider specific input for pairing." + } + } + }, + "CreateProtectionIntentInput": { + "description": "Create protection intent input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionIntentProperties", + "description": "Create protection intent input properties." + } + } + }, + "CreateProtectionIntentProperties": { + "description": "Create protection intent input properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails", + "description": "The ReplicationProviderInput. For A2A provider, it will be A2ACreateProtectionIntentInput object." + } + } + }, + "CreateProtectionIntentProviderSpecificDetails": { + "description": "Create protection intent provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "CreateRecoveryPlanInput": { + "description": "Create recovery plan input class.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateRecoveryPlanInputProperties", + "description": "Recovery plan creation properties." + } + } + }, + "CreateRecoveryPlanInputProperties": { + "description": "Recovery plan creation properties.", + "required": [ + "primaryFabricId", + "recoveryFabricId", + "groups" + ], + "type": "object", + "properties": { + "primaryFabricId": { + "description": "The primary fabric Id.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The recovery fabric Id.", + "type": "string" + }, + "failoverDeploymentModel": { + "description": "The failover deployment model.", + "enum": [ + "NotApplicable", + "Classic", + "ResourceManager" + ], + "type": "string", + "x-ms-enum": { + "name": "FailoverDeploymentModel", + "modelAsString": true + } + }, + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + }, + "providerSpecificInput": { + "description": "The provider specific input.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" + } + } + } + }, + "CriticalJobHistoryDetails": { + "description": "Critical past job details of the migration item.", + "type": "object", + "properties": { + "jobName": { + "description": "The job name.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The ARM Id of the job being executed.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + }, + "jobStatus": { + "description": "The job state.", + "type": "string", + "readOnly": true + } + } + }, + "CurrentJobDetails": { + "description": "Current job details of the migration item.", + "type": "object", + "properties": { + "jobName": { + "description": "The job name.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The ARM Id of the job being executed.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + } + } + }, + "CurrentScenarioDetails": { + "description": "Current scenario details of the protected entity.", + "type": "object", + "properties": { + "scenarioName": { + "description": "Scenario name.", + "type": "string" + }, + "jobId": { + "description": "ARM Id of the job being executed.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Start time of the workflow.", + "type": "string" + } + } + }, + "DataStore": { + "description": "The datastore details of the MT.", + "type": "object", + "properties": { + "symbolicName": { + "description": "The symbolic name of data store.", + "type": "string" + }, + "uuid": { + "description": "The uuid of data store.", + "type": "string" + }, + "capacity": { + "description": "The capacity of data store in GBs.", + "type": "string" + }, + "freeSpace": { + "description": "The free space of data store in GBs.", + "type": "string" + }, + "type": { + "description": "The type of data store.", + "type": "string" + } + } + }, + "DataStoreUtilizationDetails": { + "description": "Details of the appliance resource.", + "type": "object", + "properties": { + "totalSnapshotsSupported": { + "format": "int64", + "description": "The total count of snapshots supported by the datastore.", + "type": "integer", + "readOnly": true + }, + "totalSnapshotsCreated": { + "format": "int64", + "description": "The total snapshots created for server migration in the datastore.", + "type": "integer", + "readOnly": true + }, + "dataStoreName": { + "description": "The datastore name.", + "type": "string", + "readOnly": true + } + } + }, + "DisableProtectionInput": { + "description": "Disable protection input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DisableProtectionInputProperties", + "description": "Disable protection input properties." + } + } + }, + "DisableProtectionInputProperties": { + "description": "Disable protection input properties.", + "type": "object", + "properties": { + "disableProtectionReason": { + "description": "Disable protection reason. It can have values NotSpecified/MigrationComplete.", + "enum": [ + "NotSpecified", + "MigrationComplete" + ], + "type": "string", + "x-ms-enum": { + "name": "DisableProtectionReason", + "modelAsString": true + } + }, + "replicationProviderInput": { + "$ref": "#/definitions/DisableProtectionProviderSpecificInput", + "description": "Replication provider specific input." + } + } + }, + "DisableProtectionProviderSpecificInput": { + "description": "Disable protection provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "DiscoverProtectableItemRequest": { + "description": "Request to add a physical machine as a protectable item in a container.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DiscoverProtectableItemRequestProperties", + "description": "The properties of a discover protectable item request." + } + } + }, + "DiscoverProtectableItemRequestProperties": { + "description": "Discover protectable item properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the physical machine.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the physical machine to be discovered.", + "type": "string" + }, + "osType": { + "description": "The OS type on the physical machine.", + "type": "string" + } + } + }, + "DiskDetails": { + "description": "Onprem disk details data.", + "type": "object", + "properties": { + "maxSizeMB": { + "format": "int64", + "description": "The hard disk max size in MB.", + "type": "integer" + }, + "vhdType": { + "description": "The type of the volume.", + "type": "string" + }, + "vhdId": { + "description": "The VHD Id.", + "type": "string" + }, + "vhdName": { + "description": "The VHD name.", + "type": "string" + } + } + }, + "DiskAccountType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "PremiumV2_LRS", + "UltraSSD_LRS", + "StandardSSD_ZRS", + "Premium_ZRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "DiskEncryptionInfo": { + "description": "Recovery disk encryption info (BEK and KEK).", + "type": "object", + "properties": { + "diskEncryptionKeyInfo": { + "$ref": "#/definitions/DiskEncryptionKeyInfo", + "description": "The recovery KeyVault reference for secret." + }, + "keyEncryptionKeyInfo": { + "$ref": "#/definitions/KeyEncryptionKeyInfo", + "description": "The recovery KeyVault reference for key." + } + } + }, + "DiskEncryptionKeyInfo": { + "description": "Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).", + "type": "object", + "properties": { + "secretIdentifier": { + "description": "The secret url / identifier.", + "type": "string" + }, + "keyVaultResourceArmId": { + "description": "The KeyVault resource ARM id for secret.", + "type": "string" + } + } + }, + "DiskVolumeDetails": { + "description": "Volume details.", + "type": "object", + "properties": { + "label": { + "description": "The volume label.", + "type": "string" + }, + "name": { + "description": "The volume name.", + "type": "string" + } + } + }, + "SecurityConfiguration": { + "description": "Security configuration state.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityConfiguration", + "modelAsString": true + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.", + "type": "object", + "properties": { + "provider": { + "description": "The provider. The localized friendly form of the resource provider name - it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\".", + "type": "string" + }, + "resource": { + "description": "The resource. The localized friendly form of the resource related to this action/operation - it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent's display.resource field). e.g. \"Virtual Machines\" or \"Scheduler Job Collections\", or \"Virtual Machine VM Sizes\" or \"Scheduler Jobs\".", + "type": "string" + }, + "operation": { + "description": "The operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'.", + "type": "string" + }, + "description": { + "description": "The description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise - it will be used in tool tips and detailed views. Prescriptive guidance for namespaces: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespaces: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'.", + "type": "string" + } + } + }, + "DraDetails": { + "description": "DRA details.", + "type": "object", + "properties": { + "id": { + "description": "The DRA Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The DRA name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The DRA Bios Id.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the DRA.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "forwardProtectedItemCount": { + "format": "int32", + "description": "The count of protected items which are protected in forward direction.", + "type": "integer", + "readOnly": true + }, + "reverseProtectedItemCount": { + "format": "int32", + "description": "The count of protected items which are protected in reverse direction.", + "type": "integer", + "readOnly": true + } + } + }, + "EnableMigrationInput": { + "description": "Enable migration input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EnableMigrationInputProperties", + "description": "Enable migration input properties." + } + } + }, + "EnableMigrationInputProperties": { + "description": "Enable migration input properties.", + "required": [ + "policyId", + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "policyId": { + "description": "The policy Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "EnableMigrationProviderSpecificInput": { + "description": "Enable migration provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EnableProtectionInput": { + "description": "Enable protection input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EnableProtectionInputProperties", + "description": "Enable protection input properties." + } + } + }, + "EnableProtectionInputProperties": { + "description": "Enable protection input properties.", + "type": "object", + "properties": { + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "protectableItemId": { + "description": "The protectable item Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "EnableProtectionProviderSpecificInput": { + "description": "Enable protection provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EncryptionDetails": { + "description": "Encryption details for the fabric.", + "type": "object", + "properties": { + "kekState": { + "description": "The key encryption key state for the Vmm.", + "type": "string" + }, + "kekCertThumbprint": { + "description": "The key encryption key certificate thumbprint.", + "type": "string" + }, + "kekCertExpiryDate": { + "format": "date-time", + "description": "The key encryption key certificate expiry date.", + "type": "string" + } + } + }, + "Event": { + "description": "Implements the Event class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventProperties", + "description": "Event related data." + } + } + }, + "EventCollection": { + "description": "Collection of fabric details.", + "type": "object", + "properties": { + "value": { + "description": "The list of events.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "EventProperties": { + "description": "The properties of a monitoring event.", + "type": "object", + "properties": { + "eventCode": { + "description": "The Id of the monitoring event.", + "type": "string" + }, + "description": { + "description": "The event name.", + "type": "string" + }, + "eventType": { + "description": "The type of the event. for example: VM Health, Server Health, Job Failure etc.", + "type": "string" + }, + "affectedObjectFriendlyName": { + "description": "The friendly name of the source of the event on which it is raised (for example, VM, VMM etc).", + "type": "string" + }, + "affectedObjectCorrelationId": { + "description": "The affected object correlationId for the event.", + "type": "string" + }, + "severity": { + "description": "The severity of the event.", + "type": "string" + }, + "timeOfOccurrence": { + "format": "date-time", + "description": "The time of occurrence of the event.", + "type": "string" + }, + "fabricId": { + "description": "The ARM ID of the fabric.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EventProviderSpecificDetails", + "description": "The provider specific settings." + }, + "eventSpecificDetails": { + "$ref": "#/definitions/EventSpecificDetails", + "description": "The event specific settings." + }, + "healthErrors": { + "description": "The list of errors / warnings capturing details associated with the issue(s).", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + } + }, + "EventProviderSpecificDetails": { + "description": "Model class for provider specific details for an event.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EventQueryParameter": { + "description": "Implements the event query parameter.", + "type": "object", + "properties": { + "eventCode": { + "description": "The source id of the events to be queried.", + "type": "string" + }, + "severity": { + "description": "The severity of the events to be queried.", + "type": "string" + }, + "eventType": { + "description": "The type of the events to be queried.", + "type": "string" + }, + "fabricName": { + "description": "The affected object server id of the events to be queried.", + "type": "string" + }, + "affectedObjectFriendlyName": { + "description": "The affected object name of the events to be queried.", + "type": "string" + }, + "affectedObjectCorrelationId": { + "description": "The affected object correlationId for the events to be queried.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time of the time range within which the events are to be queried.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time of the time range within which the events are to be queried.", + "type": "string" + } + } + }, + "EventSpecificDetails": { + "description": "Model class for event specific details for an event.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ExistingProtectionProfile": { + "description": "Existing storage account input.", + "required": [ + "protectionProfileId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionProfileCustomDetails" + } + ], + "properties": { + "protectionProfileId": { + "description": "The protection profile Arm Id. Throw error, if resource does not exists.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryAvailabilitySet": { + "description": "Existing recovery availability set input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails" + } + ], + "properties": { + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id. Will throw error, if resource does not exist.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryProximityPlacementGroup": { + "description": "Existing recovery proximity placement group input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails" + } + ], + "properties": { + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id. Will throw error, if resource does not exist.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryRecoveryResourceGroup": { + "description": "Existing recovery resource group input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryResourceGroupCustomDetails" + } + ], + "properties": { + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryVirtualNetwork": { + "description": "Existing recovery virtual network input.", + "required": [ + "recoveryVirtualNetworkId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" + } + ], + "properties": { + "recoveryVirtualNetworkId": { + "description": "The recovery virtual network Id. Will throw error, if resource does not exist.", + "type": "string" + }, + "recoverySubnetName": { + "description": "The recovery subnet name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingStorageAccount": { + "description": "Existing storage account input.", + "required": [ + "azureStorageAccountId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StorageAccountCustomDetails" + } + ], + "properties": { + "azureStorageAccountId": { + "description": "The storage account Arm Id. Throw error, if resource does not exists.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExportJobDetails": { + "description": "This class represents details for export jobs workflow.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "blobUri": { + "description": "BlobUri of the exported jobs.", + "type": "string" + }, + "sasToken": { + "description": "The sas token to access blob.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ExportJobDetails" + }, + "ExtendedLocation": { + "description": "Extended location of the resource.", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the extended location.", + "type": "string" + }, + "type": { + "description": "The extended location type.", + "enum": [ + "EdgeZone" + ], + "type": "string", + "x-ms-enum": { + "name": "ExtendedLocationType", + "modelAsString": true + } + } + } + }, + "Fabric": { + "description": "Fabric definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FabricProperties", + "description": "Fabric related data." + } + } + }, + "FabricCollection": { + "description": "Collection of fabric details.", + "type": "object", + "properties": { + "value": { + "description": "The fabric details.", + "type": "array", + "items": { + "$ref": "#/definitions/Fabric" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "FabricCreationInput": { + "description": "Site details provided during the time of site creation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FabricCreationInputProperties", + "description": "Fabric creation input." + } + } + }, + "FabricCreationInputProperties": { + "description": "Properties of site details provided during the time of site creation.", + "type": "object", + "properties": { + "customDetails": { + "$ref": "#/definitions/FabricSpecificCreationInput", + "description": "Fabric provider specific creation input." + } + } + }, + "FabricProperties": { + "description": "Fabric properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the fabric.", + "type": "string" + }, + "encryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Encryption details for the fabric." + }, + "rolloverEncryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Rollover encryption details for the fabric." + }, + "internalIdentifier": { + "description": "Dra Registration Id.", + "type": "string" + }, + "bcdrState": { + "description": "BCDR state of the fabric.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/FabricSpecificDetails", + "description": "Fabric specific settings." + }, + "healthErrorDetails": { + "description": "Fabric health error details.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "health": { + "description": "Health of fabric.", + "type": "string" + } + } + }, + "FabricQueryParameter": { + "description": "Query parameter to get fabric.", + "type": "object", + "properties": { + "zoneToZoneMappings": { + "description": "A value indicating whether the zone to zone mappings are to be returned.", + "type": "string" + }, + "extendedLocationMappings": { + "description": "A value indicating whether the Extended Location mappings are to be returned.", + "type": "string" + }, + "locationDetails": { + "description": "A value indicating whether the location details are to be returned.", + "type": "string" + }, + "fetchAgentDetails": { + "description": "A value indicating whether the agent details are to be fetched.", + "type": "string" + }, + "biosId": { + "description": "The BIOS Id to be used for fetching agent details.", + "type": "string" + }, + "fqdn": { + "description": "The FQDN to be used for fetching agent details.", + "type": "string" + }, + "discoveryType": { + "description": "The type of the discovered machine to be used for fetching agent details.", + "type": "string" + }, + "osType": { + "description": "The OS type to be used for fetching agent details.", + "type": "string" + } + } + }, + "FabricReplicationGroupTaskDetails": { + "description": "This class represents the fabric replication group task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobTaskDetails" + } + ], + "properties": { + "skippedReason": { + "description": "The skipped reason.", + "type": "string" + }, + "skippedReasonString": { + "description": "The skipped reason string.", + "type": "string" + } + }, + "x-ms-discriminator-value": "FabricReplicationGroupTaskDetails" + }, + "FabricSpecificCreateNetworkMappingInput": { + "description": "Input details specific to fabrics during Network Mapping.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificCreationInput": { + "description": "Fabric provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificDetails": { + "description": "Fabric specific details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificUpdateNetworkMappingInput": { + "description": "Input details specific to fabrics during Network Mapping.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FailoverJobDetails": { + "description": "This class represents the details for a failover job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + } + } + }, + "x-ms-discriminator-value": "FailoverJobDetails" + }, + "FailoverProcessServerRequest": { + "description": "Request to failover a process server.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FailoverProcessServerRequestProperties", + "description": "The properties of the PS Failover request." + } + } + }, + "FailoverProcessServerRequestProperties": { + "description": "The properties of the Failover Process Server request.", + "type": "object", + "properties": { + "containerName": { + "description": "The container identifier.", + "type": "string" + }, + "sourceProcessServerId": { + "description": "The source process server.", + "type": "string" + }, + "targetProcessServerId": { + "description": "The new process server.", + "type": "string" + }, + "vmsToMigrate": { + "description": "The VMS to migrate.", + "type": "array", + "items": { + "type": "string" + } + }, + "updateType": { + "description": "A value for failover type. It can be systemlevel/serverlevel.", + "type": "string" + } + } + }, + "FailoverReplicationProtectedItemDetails": { + "description": "Failover details for a replication protected item.", + "type": "object", + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name.", + "type": "string" + }, + "testVmName": { + "description": "The test Vm name.", + "type": "string" + }, + "testVmFriendlyName": { + "description": "The test Vm friendly name.", + "type": "string" + }, + "networkConnectionStatus": { + "description": "The network connection status.", + "type": "string" + }, + "networkFriendlyName": { + "description": "The network friendly name.", + "type": "string" + }, + "subnet": { + "description": "The network subnet.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string" + } + } + }, + "GatewayOperationDetails": { + "description": "Details of the gateway operation.", + "type": "object", + "properties": { + "state": { + "description": "A value indicating the state of gateway operation.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "A value indicating the progress percentage of gateway operation.", + "type": "integer", + "readOnly": true + }, + "timeElapsed": { + "format": "int64", + "description": "A value indicating the time elapsed for the operation in milliseconds.", + "type": "integer", + "readOnly": true + }, + "timeRemaining": { + "format": "int64", + "description": "A value indicating the time remaining for the operation in milliseconds.", + "type": "integer", + "readOnly": true + }, + "uploadSpeed": { + "format": "int64", + "description": "A value indicating the upload speed in bytes per second.", + "type": "integer", + "readOnly": true + }, + "hostName": { + "description": "A value indicating the ESXi host name.", + "type": "string", + "readOnly": true + }, + "dataStores": { + "description": "A value indicating the datastore collection.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vmwareReadThroughput": { + "format": "int64", + "description": "A value indicating the VMware read throughput in bytes per second.", + "type": "integer", + "readOnly": true + } + } + }, + "GroupTaskDetails": { + "description": "This class represents the group task details when parent child relationship exists in the drill down.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The type of task details.", + "type": "string" + }, + "childTasks": { + "description": "The child tasks.", + "type": "array", + "items": { + "$ref": "#/definitions/ASRTask" + } + } + }, + "discriminator": "instanceType" + }, + "HealthError": { + "description": "Health Error.", + "type": "object", + "properties": { + "innerHealthErrors": { + "description": "The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", + "type": "array", + "items": { + "$ref": "#/definitions/InnerHealthError" + } + }, + "errorSource": { + "description": "Source of error.", + "type": "string" + }, + "errorType": { + "description": "Type of error.", + "type": "string" + }, + "errorLevel": { + "description": "Level of error.", + "type": "string" + }, + "errorCategory": { + "description": "Category of error.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "summaryMessage": { + "description": "Summary message of the entity.", + "type": "string" + }, + "errorMessage": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "creationTimeUtc": { + "format": "date-time", + "description": "Error creation time (UTC).", + "type": "string" + }, + "recoveryProviderErrorMessage": { + "description": "DRA error message.", + "type": "string" + }, + "entityId": { + "description": "ID of the entity.", + "type": "string" + }, + "errorId": { + "description": "The health error unique id.", + "type": "string" + }, + "customerResolvability": { + "description": "Value indicating whether the health error is customer resolvable.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCustomerResolvability", + "modelAsString": true + } + } + } + }, + "HealthErrorSummary": { + "description": "class to define the summary of the health error details.", + "type": "object", + "properties": { + "summaryCode": { + "description": "The code of the health error.", + "type": "string" + }, + "category": { + "description": "The category of the health error.", + "enum": [ + "None", + "Replication", + "TestFailover", + "Configuration", + "FabricInfrastructure", + "VersionExpiry", + "AgentAutoUpdateInfra", + "AgentAutoUpdateArtifactDeleted", + "AgentAutoUpdateRunAsAccount", + "AgentAutoUpdateRunAsAccountExpiry", + "AgentAutoUpdateRunAsAccountExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCategory", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of error.", + "enum": [ + "NONE", + "Warning", + "Error", + "Info" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "summaryMessage": { + "description": "The summary message of the health error.", + "type": "string" + }, + "affectedResourceType": { + "description": "The type of affected ARM resource.", + "type": "string" + }, + "affectedResourceSubtype": { + "description": "The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable.", + "type": "string" + }, + "affectedResourceCorrelationIds": { + "description": "The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HyperVHostDetails": { + "description": "Hyper-V host details.", + "type": "object", + "properties": { + "id": { + "description": "The Hyper-V host Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Hyper-V host name.", + "type": "string", + "readOnly": true + }, + "marsAgentVersion": { + "description": "The Mars agent version.", + "type": "string", + "readOnly": true + } + } + }, + "HyperVReplica2012EventDetails": { + "description": "Model class for event details of a HyperVReplica E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplica2012R2EventDetails": { + "description": "Model class for event details of a HyperVReplica blue E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaAzureApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to HyperVReplicaAzure provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "The primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "The secondary kek certificate pfx.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureDiskInputDetails": { + "description": "Disk input details.", + "type": "object", + "properties": { + "diskId": { + "description": "The DiskId.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The LogStorageAccountId.", + "type": "string" + }, + "diskType": { + "$ref": "#/definitions/DiskAccountType" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + }, + "sectorSizeInBytes": { + "format": "int32", + "description": "The logical sector size (in bytes), 512 by default.", + "type": "integer" + } + } + }, + "HyperVReplicaAzureEnableProtectionInput": { + "description": "HyperVReplicaAzure specific enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "hvHostVmId": { + "description": "The Hyper-V host VM Id.", + "type": "string" + }, + "vmName": { + "description": "The VM Name.", + "type": "string" + }, + "osType": { + "description": "The OS type associated with VM.", + "type": "string" + }, + "userSelectedOSName": { + "description": "The OS name selected by user.", + "type": "string" + }, + "vhdId": { + "description": "The OS disk VHD id associated with VM.", + "type": "string" + }, + "targetStorageAccountId": { + "description": "The storage account Id.", + "type": "string" + }, + "targetAzureNetworkId": { + "description": "The selected target Azure network Id.", + "type": "string" + }, + "targetAzureSubnetId": { + "description": "The selected target Azure subnet Id.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "targetAzureVmName": { + "description": "The target azure VM Name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "disksToInclude": { + "description": "The list of VHD Ids of disks to be protected.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetAzureV1ResourceGroupId": { + "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created.", + "type": "string" + }, + "targetAzureV2ResourceGroupId": { + "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id for resource manager deployment.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmSecurityProfile": { + "$ref": "#/definitions/SecurityProfileProperties", + "description": "The target VM security profile." + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" + }, + "useManagedDisksForReplication": { + "description": "A value indicating whether managed disks should be used during replication.", + "type": "string" + }, + "diskType": { + "$ref": "#/definitions/DiskAccountType" + }, + "disksToIncludeForManagedDisks": { + "description": "The disks to include list for managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVReplicaAzureDiskInputDetails" + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureEventDetails": { + "description": "Model class for event details of a HyperVReplica E2A event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureFailbackProviderInput": { + "description": "HyperVReplicaAzureFailback specific planned failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "dataSyncOption": { + "description": "Data sync option.", + "type": "string" + }, + "recoveryVmCreationOption": { + "description": "ALR options to create alternate recovery.", + "type": "string" + }, + "providerIdForAlternateRecovery": { + "description": "Provider Id for alternate location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzureFailback" + }, + "HyperVReplicaAzureManagedDiskDetails": { + "description": "Hyper-V Managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "seedManagedDiskId": { + "description": "Seed managed disk Id.", + "type": "string" + }, + "replicaDiskType": { + "description": "The replica disk type.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The disk encryption set ARM Id.", + "type": "string" + }, + "targetDiskAccountType": { + "$ref": "#/definitions/DiskAccountType" + }, + "sectorSizeInBytes": { + "format": "int32", + "description": "The logical sector size (in bytes), 512 by default.", + "type": "integer" + } + } + }, + "HyperVReplicaAzurePlannedFailoverProviderInput": { + "description": "HyperVReplicaAzure specific planned failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzurePolicyDetails": { + "description": "Hyper-V Replica Azure specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryDurationInHours": { + "format": "int32", + "description": "The duration (in hours) to which point the recovery history needs to be maintained.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.", + "type": "integer" + }, + "replicationInterval": { + "format": "int32", + "description": "The replication interval.", + "type": "integer" + }, + "onlineReplicationStartTime": { + "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.", + "type": "string" + }, + "encryption": { + "description": "A value indicating whether encryption is enabled for virtual machines in this cloud.", + "type": "string" + }, + "activeStorageAccountId": { + "description": "The active storage account Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzurePolicyInput": { + "description": "Hyper-V Replica Azure specific input for creating a protection profile.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryDuration": { + "format": "int32", + "description": "The duration (in hours) to which point the recovery history needs to be maintained.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.", + "type": "integer" + }, + "replicationInterval": { + "format": "int32", + "description": "The replication interval.", + "type": "integer" + }, + "onlineReplicationStartTime": { + "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.", + "type": "string" + }, + "storageAccounts": { + "description": "The list of storage accounts to which the VMs in the primary cloud can replicate to.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureReplicationDetails": { + "description": "Hyper V Replica Azure provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "azureVmDiskDetails": { + "description": "Azure VM Disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureVmDiskDetails" + } + }, + "recoveryAzureVmName": { + "description": "Recovery Azure given name.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The Recovery Azure VM size.", + "type": "string" + }, + "recoveryAzureStorageAccount": { + "description": "The recovery Azure storage account.", + "type": "string" + }, + "recoveryAzureLogStorageAccountId": { + "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.", + "type": "string" + }, + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "Last RPO value.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "selectedRecoveryAzureNetworkId": { + "description": "The selected recovery azure network Id.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "encryption": { + "description": "The encryption info.", + "type": "string" + }, + "oSDetails": { + "$ref": "#/definitions/OSDetails", + "description": "The operating system info." + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVReplicaAzureManagedDiskDetails" + }, + "x-ms-identifiers": [] + }, + "allAvailableOSUpgradeConfigurations": { + "description": "A value indicating all available inplace OS Upgrade configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/OSUpgradeSupportedVersions" + }, + "x-ms-identifiers": [] + }, + "targetVmSecurityProfile": { + "$ref": "#/definitions/SecurityProfileProperties", + "description": "The target VM security profile." + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureReprotectInput": { + "description": "Azure specific reprotect input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "hvHostVmId": { + "description": "The Hyper-V host Vm Id.", + "type": "string" + }, + "vmName": { + "description": "The Vm Name.", + "type": "string" + }, + "osType": { + "description": "The OS type associated with vm.", + "type": "string" + }, + "vHDId": { + "description": "The OS disk VHD id associated with vm.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureTestFailoverInput": { + "description": "HvrA provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureUnplannedFailoverInput": { + "description": "HvrA provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureUpdateReplicationProtectedItemInput": { + "description": "HyperV replica Azure input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryAzureV1ResourceGroupId": { + "description": "The recovery Azure resource group Id for classic deployment.", + "type": "string" + }, + "recoveryAzureV2ResourceGroupId": { + "description": "The recovery Azure resource group Id for resource manager deployment.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "diskIdToDiskEncryptionMap": { + "description": "The dictionary of disk resource Id to disk encryption set ARM Id.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateDiskInput" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaBaseEventDetails": { + "description": "Abstract model class for event details of a HyperVReplica E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaBaseEventDetails" + }, + "HyperVReplicaBasePolicyDetails": { + "description": "Base class for HyperVReplica policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaBasePolicyDetails" + }, + "HyperVReplicaBaseReplicationDetails": { + "description": "Hyper V replica provider specific settings base class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaBaseReplicationDetails" + }, + "HyperVReplicaBluePolicyDetails": { + "description": "Hyper-V Replica Blue specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "replicationFrequencyInSeconds": { + "format": "int32", + "description": "A value indicating the replication interval.", + "type": "integer" + }, + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaBluePolicyInput": { + "description": "HyperV Replica Blue policy input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HyperVReplicaPolicyInput" + } + ], + "properties": { + "replicationFrequencyInSeconds": { + "format": "int32", + "description": "A value indicating the replication interval.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaBlueReplicationDetails": { + "description": "HyperV replica 2012 R2 (Blue) replication details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaPolicyDetails": { + "description": "Hyper-V Replica Blue specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplicaPolicyInput": { + "description": "Hyper-V Replica specific policy Input.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletion": { + "description": "A value indicating whether the VM has to be auto deleted.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplicaReplicationDetails": { + "description": "HyperV replica 2012 replication details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVSiteDetails": { + "description": "HyperVSite fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "hyperVHosts": { + "description": "The list of Hyper-V hosts associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVHostDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVSite" + }, + "HyperVVirtualMachineDetails": { + "description": "Single Host fabric provider specific VM settings.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": { + "sourceItemId": { + "description": "The source id of the object.", + "type": "string" + }, + "generation": { + "description": "The id of the object in fabric.", + "type": "string" + }, + "osDetails": { + "$ref": "#/definitions/OSDetails", + "description": "The Last replication time." + }, + "diskDetails": { + "description": "The Last successful failover time.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + }, + "hasPhysicalDisk": { + "description": "A value indicating whether the VM has a physical disk attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hasFibreChannelAdapter": { + "description": "A value indicating whether the VM has a fibre channel adapter attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hasSharedVhd": { + "description": "A value indicating whether the VM has a shared VHD attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hyperVHostId": { + "description": "The Id of the hyper-v host in fabric.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "HyperVVirtualMachine" + }, + "IdentityProviderDetails": { + "description": "Identity provider details.", + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "applicationId": { + "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "objectId": { + "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "audience": { + "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "aadAuthority": { + "description": "The base authority for Azure Active Directory authentication.", + "type": "string" + } + } + }, + "IdentityProviderInput": { + "description": "Identity provider input.", + "required": [ + "tenantId", + "applicationId", + "objectId", + "audience", + "aadAuthority" + ], + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "applicationId": { + "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "objectId": { + "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "audience": { + "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "aadAuthority": { + "description": "The base authority for Azure Active Directory authentication.", + "type": "string" + } + } + }, + "InconsistentVmDetails": { + "description": "This class stores the monitoring details for consistency check of inconsistent Protected Entity.", + "type": "object", + "properties": { + "vmName": { + "description": "The Vm name.", + "type": "string" + }, + "cloudName": { + "description": "The Cloud name.", + "type": "string" + }, + "details": { + "description": "The list of details regarding state of the Protected Entity in SRS and On prem.", + "type": "array", + "items": { + "type": "string" + } + }, + "errorIds": { + "description": "The list of error ids.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "InitialReplicationDetails": { + "description": "Initial replication details.", + "type": "object", + "properties": { + "initialReplicationType": { + "description": "Initial replication type.", + "type": "string" + }, + "initialReplicationProgressPercentage": { + "description": "The initial replication progress percentage.", + "type": "string" + } + } + }, + "InlineWorkflowTaskDetails": { + "description": "This class represents the inline workflow task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GroupTaskDetails" + } + ], + "properties": { + "workflowIds": { + "description": "The list of child workflow ids.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InlineWorkflowTaskDetails" + }, + "InMageAgentDetails": { + "description": "The details of the InMage agent.", + "type": "object", + "properties": { + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentUpdateStatus": { + "description": "A value indicating whether installed agent needs to be updated.", + "type": "string" + }, + "postUpdateRebootStatus": { + "description": "A value indicating whether reboot is required after update is applied.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + } + } + }, + "InMageAzureV2ApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to InMageAzureV2 provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2DiskInputDetails": { + "description": "Disk input details.", + "type": "object", + "properties": { + "diskId": { + "description": "The DiskId.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The LogStorageAccountId.", + "type": "string" + }, + "diskType": { + "$ref": "#/definitions/DiskAccountType" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + } + } + }, + "InMageAzureV2EnableProtectionInput": { + "description": "VMware Azure specific enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi VM group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2DiskInputDetails" + } + }, + "targetAzureNetworkId": { + "description": "The selected target Azure network Id.", + "type": "string" + }, + "targetAzureSubnetId": { + "description": "The selected target Azure subnet Id.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target VM after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "targetAzureVmName": { + "description": "The target azure VM Name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "targetAzureV1ResourceGroupId": { + "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created.", + "type": "string" + }, + "targetAzureV2ResourceGroupId": { + "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.", + "type": "string" + }, + "diskType": { + "$ref": "#/definitions/DiskAccountType" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id for resource manager deployment.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2EventDetails": { + "description": "Model class for event details of a VMwareAzureV2 event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "eventType": { + "description": "InMage Event type. Takes one of the values of InMageDataContract.InMageMonitoringEventType.", + "type": "string" + }, + "category": { + "description": "InMage Event Category.", + "type": "string" + }, + "component": { + "description": "InMage Event Component.", + "type": "string" + }, + "correctiveAction": { + "description": "Corrective Action string for the event.", + "type": "string" + }, + "details": { + "description": "InMage Event Details.", + "type": "string" + }, + "summary": { + "description": "InMage Event Summary.", + "type": "string" + }, + "siteName": { + "description": "VMware Site name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ManagedDiskDetails": { + "description": "InMageAzureV2 Managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "seedManagedDiskId": { + "description": "Seed managed disk Id.", + "type": "string" + }, + "replicaDiskType": { + "description": "The replica disk type.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + } + } + }, + "InMageAzureV2PolicyDetails": { + "description": "InMage Azure v2 specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + }, + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2PolicyInput": { + "description": "VMWare Azure specific policy Input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ProtectedDiskDetails": { + "description": "InMageAzureV2 protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "healthErrorCode": { + "description": "The health error code for the disk.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "resyncDurationInSeconds": { + "format": "int64", + "description": "The resync duration in seconds.", + "type": "integer" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "fileSystemCapacityInBytes": { + "format": "int64", + "description": "The disk file system capacity in bytes.", + "type": "integer" + }, + "sourceDataInMegaBytes": { + "format": "double", + "description": "The source data transit in MB.", + "type": "number" + }, + "psDataInMegaBytes": { + "format": "double", + "description": "The PS data transit in MB.", + "type": "number" + }, + "targetDataInMegaBytes": { + "format": "double", + "description": "The target data transit in MB.", + "type": "number" + }, + "diskResized": { + "description": "A value indicating whether disk is resized.", + "type": "string" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes.", + "type": "integer" + }, + "resyncTotalTransferredBytes": { + "format": "int64", + "description": "The resync total transferred bytes.", + "type": "integer" + }, + "resyncLast15MinutesTransferredBytes": { + "format": "int64", + "description": "The resync last 15 minutes transferred bytes.", + "type": "integer" + }, + "resyncLastDataTransferTimeUTC": { + "format": "date-time", + "description": "The last data transfer time in UTC.", + "type": "string" + }, + "resyncStartTime": { + "format": "date-time", + "description": "The resync start time.", + "type": "string" + }, + "progressHealth": { + "description": "The Progress Health.", + "type": "string" + }, + "progressStatus": { + "description": "The Progress Status.", + "type": "string" + }, + "secondsToTakeSwitchProvider": { + "format": "int64", + "description": "The seconds to take for switch provider.", + "type": "integer" + } + } + }, + "InMageAzureV2RecoveryPointDetails": { + "description": "InMage Azure V2 provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "isMultiVmSyncPoint": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ReplicationDetails": { + "description": "InMageAzureV2 provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "infrastructureVmId": { + "description": "The infrastructure VM Id.", + "type": "string" + }, + "vCenterInfrastructureId": { + "description": "The vCenter infrastructure Id.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "compressedDataRateInMB": { + "format": "double", + "description": "The compressed data change rate in MB.", + "type": "number" + }, + "uncompressedDataRateInMB": { + "format": "double", + "description": "The uncompressed data change rate in MB.", + "type": "number" + }, + "ipAddress": { + "description": "The source IP address.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "isAgentUpdateRequired": { + "description": "A value indicating whether installed agent needs to be updated.", + "type": "string" + }, + "isRebootAfterUpdateRequired": { + "description": "A value indicating whether the source server requires a restart after update.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "processServerName": { + "description": "The process server name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi vm sync is enabled or disabled.", + "type": "string" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2ProtectedDiskDetails" + } + }, + "diskResized": { + "description": "A value indicating whether any disk is resized for this VM.", + "type": "string" + }, + "masterTargetId": { + "description": "The master target Id.", + "type": "string" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string" + }, + "vhdName": { + "description": "The OS disk VHD name.", + "type": "string" + }, + "osDiskId": { + "description": "The id of the disk containing the OS.", + "type": "string" + }, + "azureVMDiskDetails": { + "description": "Azure VM Disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureVmDiskDetails" + } + }, + "recoveryAzureVMName": { + "description": "Recovery Azure given name.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The Recovery Azure VM size.", + "type": "string" + }, + "recoveryAzureStorageAccount": { + "description": "The recovery Azure storage account.", + "type": "string" + }, + "recoveryAzureLogStorageAccountId": { + "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "selectedRecoveryAzureNetworkId": { + "description": "The selected recovery azure network Id.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The test failover virtual network.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "datastores": { + "description": "The datastores of the on-premise machine. Value can be list of strings that contain datastore names.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetVmId": { + "description": "The ARM Id of the target Azure VM. This value will be null until the VM is failed over. Only after failure it will be populated with the ARM Id of the Azure VM.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "validationErrors": { + "description": "The validation errors of the on-premise machine Value can be list of validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "lastUpdateReceivedTime": { + "format": "date-time", + "description": "The last update time received from on-prem components.", + "type": "string" + }, + "replicaId": { + "description": "The replica id of the protected item.", + "type": "string" + }, + "osVersion": { + "description": "The OS Version of the protected item.", + "type": "string" + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2ManagedDiskDetails" + } + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type of this protected item.", + "type": "string" + }, + "azureVmGeneration": { + "description": "The target generation for this protected item.", + "type": "string" + }, + "isAdditionalStatsAvailable": { + "description": "A value indicating whether additional IR stats are available or not.", + "type": "boolean" + }, + "totalDataTransferred": { + "format": "int64", + "description": "The total transferred data in bytes.", + "type": "integer" + }, + "totalProgressHealth": { + "description": "The progress health.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "switchProviderBlockingErrorDetails": { + "description": "The switch provider blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2SwitchProviderBlockingErrorDetails" + } + }, + "switchProviderDetails": { + "$ref": "#/definitions/InMageAzureV2SwitchProviderDetails", + "description": "The switch provider blocking error information." + }, + "supportedOSVersions": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "allAvailableOSUpgradeConfigurations": { + "description": "A value indicating all available inplace OS Upgrade configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/OSUpgradeSupportedVersions" + }, + "x-ms-identifiers": [] + }, + "osName": { + "description": "The name of the OS on the VM.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ReprotectInput": { + "description": "InMageAzureV2 specific provider input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2SwitchProviderBlockingErrorDetails": { + "description": "InMageAzureV2 switch provider blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageAzureV2SwitchProviderDetails": { + "description": "InMageAzureV2 switch provider details.", + "type": "object", + "properties": { + "targetVaultId": { + "description": "The target vault Id.", + "type": "string", + "readOnly": true + }, + "targetResourceId": { + "description": "The target resource Id.", + "type": "string", + "readOnly": true + }, + "targetFabricId": { + "description": "The target fabric Id.", + "type": "string", + "readOnly": true + }, + "targetApplianceId": { + "description": "The target appliance Id.", + "type": "string", + "readOnly": true + } + } + }, + "InMageAzureV2SwitchProviderProviderInput": { + "description": "Provider specific input for InMageAzureV2 switch provider.", + "required": [ + "targetVaultID", + "targetFabricID", + "targetApplianceID" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SwitchProviderProviderSpecificInput" + } + ], + "properties": { + "targetVaultID": { + "description": "The target vault Id.", + "type": "string" + }, + "targetFabricID": { + "description": "The target fabric Id.", + "type": "string" + }, + "targetApplianceID": { + "description": "The target appliance Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2TestFailoverInput": { + "description": "InMageAzureV2 provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2UnplannedFailoverInput": { + "description": "InMageAzureV2 provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2UpdateReplicationProtectedItemInput": { + "description": "InMage Azure V2 input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryAzureV1ResourceGroupId": { + "description": "The recovery Azure resource group Id for classic deployment.", + "type": "string" + }, + "recoveryAzureV2ResourceGroupId": { + "description": "The recovery Azure resource group Id for resource manager deployment.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateDiskInput" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageBasePolicyDetails": { + "description": "Base class for the policies of providers using InMage replication.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageBasePolicyDetails" + }, + "InMageDisableProtectionProviderSpecificInput": { + "description": "InMage disable protection provider specific input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisableProtectionProviderSpecificInput" + } + ], + "properties": { + "replicaVmDeletionStatus": { + "description": "A value indicating whether the replica VM should be destroyed or retained. Values from Delete and Retain.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageDiskDetails": { + "description": "VMware/Physical specific Disk Details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskSizeInMB": { + "description": "The disk size in MB.", + "type": "string" + }, + "diskType": { + "description": "Whether disk is system disk or data disk.", + "type": "string" + }, + "diskConfiguration": { + "description": "Whether disk is dynamic disk or basic disk.", + "type": "string" + }, + "volumeList": { + "description": "Volumes of the disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskVolumeDetails" + } + } + } + }, + "InMageDiskExclusionInput": { + "description": "DiskExclusionInput when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "volumeOptions": { + "description": "The volume label based option for disk exclusion.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageVolumeExclusionOptions" + } + }, + "diskSignatureOptions": { + "description": "The guest disk signature based option for disk exclusion.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageDiskSignatureExclusionOptions" + } + } + } + }, + "InMageDiskSignatureExclusionOptions": { + "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "diskSignature": { + "description": "The guest signature of disk to be excluded from replication.", + "type": "string" + } + } + }, + "InMageEnableProtectionInput": { + "description": "VMware Azure specific enable protection input.", + "required": [ + "masterTargetId", + "processServerId", + "retentionDrive", + "multiVmGroupId", + "multiVmGroupName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "vmFriendlyName": { + "description": "The VM Name.", + "type": "string" + }, + "masterTargetId": { + "description": "The Master Target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "retentionDrive": { + "description": "The retention drive to use on the MT.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi VM group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "diskExclusionInput": { + "$ref": "#/definitions/InMageDiskExclusionInput", + "description": "The enable disk exclusion input." + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageFabricSwitchProviderBlockingErrorDetails": { + "description": "InMageFabric switch provider blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMagePolicyDetails": { + "description": "InMage specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMagePolicyInput": { + "description": "VMWare Azure specific protection profile Input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageProtectedDiskDetails": { + "description": "InMage protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "healthErrorCode": { + "description": "The health error code for the disk.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "resyncDurationInSeconds": { + "format": "int64", + "description": "The resync duration in seconds.", + "type": "integer" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "fileSystemCapacityInBytes": { + "format": "int64", + "description": "The file system capacity in bytes.", + "type": "integer" + }, + "sourceDataInMB": { + "format": "double", + "description": "The source data transit in MB.", + "type": "number" + }, + "psDataInMB": { + "format": "double", + "description": "The PS data transit in MB.", + "type": "number" + }, + "targetDataInMB": { + "format": "double", + "description": "The target data transit in MB.", + "type": "number" + }, + "diskResized": { + "description": "A value indicating whether disk is resized.", + "type": "string" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes.", + "type": "integer" + }, + "resyncTotalTransferredBytes": { + "format": "int64", + "description": "The resync total transferred bytes.", + "type": "integer" + }, + "resyncLast15MinutesTransferredBytes": { + "format": "int64", + "description": "The resync last 15 minutes transferred bytes.", + "type": "integer" + }, + "resyncLastDataTransferTimeUTC": { + "format": "date-time", + "description": "The last data transfer time in UTC.", + "type": "string" + }, + "resyncStartTime": { + "format": "date-time", + "description": "The resync start time.", + "type": "string" + }, + "progressHealth": { + "description": "The Progress Health.", + "type": "string" + }, + "progressStatus": { + "description": "The Progress Status.", + "type": "string" + } + } + }, + "InMageRcmAddDisksInput": { + "description": "InMageRcm add disk(s) input.", + "required": [ + "disks" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AddDisksProviderSpecificInput" + } + ], + "properties": { + "disks": { + "description": "The list of disk details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmDiskInput" + }, + "x-ms-identifiers": [ + "diskId" + ] + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmAgentUpgradeBlockingErrorDetails": { + "description": "InMageRcm source agent upgrade blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmApplianceDetails": { + "description": "InMageRcm appliance details.", + "type": "object", + "properties": { + "id": { + "description": "The appliance Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The appliance name.", + "type": "string", + "readOnly": true + }, + "fabricArmId": { + "description": "The fabric ARM Id.", + "type": "string", + "readOnly": true + }, + "processServer": { + "$ref": "#/definitions/ProcessServerDetails", + "description": "The process server.", + "readOnly": true + }, + "rcmProxy": { + "$ref": "#/definitions/RcmProxyDetails", + "description": "The of RCM proxy.", + "readOnly": true + }, + "pushInstaller": { + "$ref": "#/definitions/PushInstallerDetails", + "description": "The push installer.", + "readOnly": true + }, + "replicationAgent": { + "$ref": "#/definitions/ReplicationAgentDetails", + "description": "The replication agent.", + "readOnly": true + }, + "reprotectAgent": { + "$ref": "#/definitions/ReprotectAgentDetails", + "description": "The reprotect agent.", + "readOnly": true + }, + "marsAgent": { + "$ref": "#/definitions/MarsAgentDetails", + "description": "The Mars agent.", + "readOnly": true + }, + "dra": { + "$ref": "#/definitions/DraDetails", + "description": "The DRA.", + "readOnly": true + }, + "switchProviderBlockingErrorDetails": { + "description": "The switch provider blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFabricSwitchProviderBlockingErrorDetails" + }, + "readOnly": true + } + } + }, + "InMageRcmApplianceSpecificDetails": { + "description": "InMageRcm appliance specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplianceSpecificDetails" + } + ], + "properties": { + "appliances": { + "description": "The list of appliances.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmApplianceDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to InMageRcm provider.", + "required": [ + "recoveryPointId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmDiscoveredProtectedVmDetails": { + "description": "InMageRcm discovered protected VM details.", + "type": "object", + "properties": { + "vCenterId": { + "description": "The VCenter Id.", + "type": "string", + "readOnly": true + }, + "vCenterFqdn": { + "description": "The VCenter fqdn.", + "type": "string", + "readOnly": true + }, + "datastores": { + "description": "The list of datastores.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ipAddresses": { + "description": "The list of IP addresses.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vmwareToolsStatus": { + "description": "The VMware tools status.", + "type": "string", + "readOnly": true + }, + "powerStatus": { + "description": "The VM power status.", + "type": "string", + "readOnly": true + }, + "vmFqdn": { + "description": "The VM fqdn.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "The VM's OS name.", + "type": "string", + "readOnly": true + }, + "createdTimestamp": { + "format": "date-time", + "description": "The SDS created timestamp.", + "type": "string", + "readOnly": true + }, + "updatedTimestamp": { + "format": "date-time", + "description": "The SDS updated timestamp.", + "type": "string", + "readOnly": true + }, + "isDeleted": { + "description": "A value indicating whether the VM is deleted.", + "type": "boolean", + "readOnly": true + }, + "lastDiscoveryTimeInUtc": { + "format": "date-time", + "description": "The last time when SDS information discovered in SRS.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmDiskInput": { + "description": "InMageRcm disk input.", + "required": [ + "diskId", + "logStorageAccountId", + "diskType" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "$ref": "#/definitions/DiskAccountType" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "sectorSizeInBytes": { + "format": "int32", + "description": "The logical sector size (in bytes), 512 by default.", + "type": "integer" + } + } + }, + "InMageRcmDisksDefaultInput": { + "description": "InMageRcm disk input.", + "required": [ + "logStorageAccountId", + "diskType" + ], + "type": "object", + "properties": { + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "$ref": "#/definitions/DiskAccountType" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "sectorSizeInBytes": { + "format": "int32", + "description": "The logical sector size (in bytes), 512 by default.", + "type": "integer" + } + } + }, + "InMageRcmEnableProtectionInput": { + "description": "InMageRcm specific enable protection input.", + "required": [ + "fabricDiscoveryMachineId", + "targetResourceGroupId", + "processServerId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricDiscoveryMachineId": { + "description": "The ARM Id of discovered machine.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmDiskInput" + } + }, + "disksDefault": { + "$ref": "#/definitions/InMageRcmDisksDefaultInput", + "description": "The default disk input." + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The selected target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The selected test network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The selected target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "The selected test subnet name.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "userSelectedOSName": { + "description": "The OS name selected by user.", + "type": "string" + }, + "targetVmSecurityProfile": { + "$ref": "#/definitions/SecurityProfileProperties", + "description": "The target VM security profile." + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmEventDetails": { + "description": "Event details for InMageRcm provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "vmName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "latestAgentVersion": { + "description": "The latest agent version.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The job Id.", + "type": "string", + "readOnly": true + }, + "fabricName": { + "description": "The fabric name.", + "type": "string", + "readOnly": true + }, + "applianceName": { + "description": "The appliance name.", + "type": "string", + "readOnly": true + }, + "serverType": { + "description": "The server type.", + "type": "string", + "readOnly": true + }, + "componentDisplayName": { + "description": "The component display name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricCreationInput": { + "description": "InMageRcm fabric provider specific settings.", + "required": [ + "vmwareSiteId", + "physicalSiteId", + "sourceAgentIdentity" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string" + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string" + }, + "sourceAgentIdentity": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for source agent authentication." + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricSpecificDetails": { + "description": "InMageRcm fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string", + "readOnly": true + }, + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true + }, + "serviceResourceId": { + "description": "The service resource Id.", + "type": "string", + "readOnly": true + }, + "serviceContainerId": { + "description": "The service container Id.", + "type": "string", + "readOnly": true + }, + "dataPlaneUri": { + "description": "The data plane Uri.", + "type": "string", + "readOnly": true + }, + "controlPlaneUri": { + "description": "The control plane Uri.", + "type": "string", + "readOnly": true + }, + "sourceAgentIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The source agent identity details." + }, + "processServers": { + "description": "The list of process servers.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServerDetails" + }, + "readOnly": true + }, + "rcmProxies": { + "description": "The list of RCM proxies.", + "type": "array", + "items": { + "$ref": "#/definitions/RcmProxyDetails" + }, + "readOnly": true + }, + "pushInstallers": { + "description": "The list of push installers.", + "type": "array", + "items": { + "$ref": "#/definitions/PushInstallerDetails" + }, + "readOnly": true + }, + "replicationAgents": { + "description": "The list of replication agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationAgentDetails" + }, + "readOnly": true + }, + "reprotectAgents": { + "description": "The list of reprotect agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReprotectAgentDetails" + }, + "readOnly": true + }, + "marsAgents": { + "description": "The list of Mars agents.", + "type": "array", + "items": { + "$ref": "#/definitions/MarsAgentDetails" + }, + "readOnly": true + }, + "dras": { + "description": "The list of DRAs.", + "type": "array", + "items": { + "$ref": "#/definitions/DraDetails" + }, + "readOnly": true + }, + "agentDetails": { + "description": "The list of agent details.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricSwitchProviderBlockingErrorDetails": { + "description": "InMageRcmFabric switch provider blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmFailbackDiscoveredProtectedVmDetails": { + "description": "InMageRcmFailback discovered VM details.", + "type": "object", + "properties": { + "vCenterId": { + "description": "The VCenter Id.", + "type": "string", + "readOnly": true + }, + "vCenterFqdn": { + "description": "The VCenter fqdn.", + "type": "string", + "readOnly": true + }, + "datastores": { + "description": "The list of datastores.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ipAddresses": { + "description": "The list of IP addresses.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vmwareToolsStatus": { + "description": "The VMware tools status.", + "type": "string", + "readOnly": true + }, + "powerStatus": { + "description": "The VM power status.", + "type": "string", + "readOnly": true + }, + "vmFqdn": { + "description": "The VM fqdn.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "The VM's OS name.", + "type": "string", + "readOnly": true + }, + "createdTimestamp": { + "format": "date-time", + "description": "The SDS created timestamp.", + "type": "string", + "readOnly": true + }, + "updatedTimestamp": { + "format": "date-time", + "description": "The SDS updated timestamp.", + "type": "string", + "readOnly": true + }, + "isDeleted": { + "description": "A value indicating whether the VM is deleted.", + "type": "boolean", + "readOnly": true + }, + "lastDiscoveryTimeInUtc": { + "format": "date-time", + "description": "The last time when SDS information discovered in SRS.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackEventDetails": { + "description": "Event details for InMageRcmFailback provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "vmName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "applianceName": { + "description": "The appliance name.", + "type": "string", + "readOnly": true + }, + "serverType": { + "description": "The server type.", + "type": "string", + "readOnly": true + }, + "componentDisplayName": { + "description": "The component display name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackMobilityAgentDetails": { + "description": "InMageRcmFailback mobility agent details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest agent version available.", + "type": "string", + "readOnly": true + }, + "driverVersion": { + "description": "The driver version.", + "type": "string", + "readOnly": true + }, + "latestUpgradableVersionWithoutReboot": { + "description": "The latest upgradeable version available without reboot.", + "type": "string", + "readOnly": true + }, + "agentVersionExpiryDate": { + "format": "date-time", + "description": "The agent version expiry date.", + "type": "string", + "readOnly": true + }, + "driverVersionExpiryDate": { + "format": "date-time", + "description": "The driver version expiry date.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The time of the last heartbeat received from the agent.", + "type": "string", + "readOnly": true + }, + "reasonsBlockingUpgrade": { + "description": "The whether update is possible or not.", + "type": "array", + "items": { + "enum": [ + "AlreadyOnLatestVersion", + "RebootRequired", + "AgentNoHeartbeat", + "RcmProxyNoHeartbeat", + "ProcessServerNoHeartbeat", + "IncompatibleApplianceVersion", + "NotProtected", + "UnsupportedProtectionScenario", + "DistroIsNotReported", + "DistroNotSupportedForUpgrade", + "MissingUpgradePath", + "InvalidAgentVersion", + "InvalidDriverVersion", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentUpgradeBlockedReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "isUpgradeable": { + "description": "A value indicating whether agent is upgradeable or not.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackNicDetails": { + "description": "InMageRcmFailback NIC details.", + "type": "object", + "properties": { + "macAddress": { + "description": "The mac address.", + "type": "string", + "readOnly": true + }, + "networkName": { + "description": "The network name.", + "type": "string", + "readOnly": true + }, + "adapterType": { + "description": "The adapter type.", + "type": "string", + "readOnly": true + }, + "sourceIpAddress": { + "description": "The IP address.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackPlannedFailoverProviderInput": { + "description": "Provider specific input for InMageRcmFailback failover.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageRcmFailbackRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackPolicyCreationInput": { + "description": "InMageRcmFailback policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackPolicyDetails": { + "description": "InMageRcm failback specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackProtectedDiskDetails": { + "description": "InMageRcmFailback protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id (reported by source agent).", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "diskUuid": { + "description": "The disk Uuid (reported by vCenter).", + "type": "string", + "readOnly": true + }, + "dataPendingInLogDataStoreInMB": { + "format": "double", + "description": "The data pending in log data store in MB.", + "type": "number", + "readOnly": true + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source agent in MB.", + "type": "number", + "readOnly": true + }, + "isInitialReplicationComplete": { + "description": "A value indicating whether initial replication is complete or not.", + "type": "string", + "readOnly": true + }, + "irDetails": { + "$ref": "#/definitions/InMageRcmFailbackSyncDetails", + "description": "The initial replication details." + }, + "resyncDetails": { + "$ref": "#/definitions/InMageRcmFailbackSyncDetails", + "description": "The resync details." + }, + "lastSyncTime": { + "format": "date-time", + "description": "The last sync time.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackReplicationDetails": { + "description": "InMageRcmFailback provider specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "internalIdentifier": { + "description": "The virtual machine internal identifier.", + "type": "string", + "readOnly": true + }, + "azureVirtualMachineId": { + "description": "The ARM Id of the azure VM.", + "type": "string", + "readOnly": true + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string", + "readOnly": true + }, + "reprotectAgentId": { + "description": "The reprotect agent Id.", + "type": "string", + "readOnly": true + }, + "reprotectAgentName": { + "description": "The reprotect agent name.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "targetvCenterId": { + "description": "The target vCenter Id.", + "type": "string", + "readOnly": true + }, + "targetDataStoreName": { + "description": "The target datastore name.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string", + "readOnly": true + }, + "initialReplicationProgressPercentage": { + "format": "int32", + "description": "The initial replication progress percentage.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProcessedBytes": { + "format": "int64", + "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationTransferredBytes": { + "format": "int64", + "description": "The initial replication transferred bytes from source VM to target for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProgressHealth": { + "description": "The initial replication progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer", + "readOnly": true + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "resyncTransferredBytes": { + "format": "int64", + "description": "The resync transferred bytes from source VM to target for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProgressHealth": { + "description": "The resync progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFailbackProtectedDiskDetails" + } + }, + "mobilityAgentDetails": { + "$ref": "#/definitions/InMageRcmFailbackMobilityAgentDetails", + "description": "The mobility agent information." + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFailbackNicDetails" + } + }, + "lastPlannedFailoverStartTime": { + "format": "date-time", + "description": "The last planned failover start time.", + "type": "string", + "readOnly": true + }, + "lastPlannedFailoverStatus": { + "description": "The last planned failover status.", + "enum": [ + "Succeeded", + "Failed", + "Cancelled", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PlannedFailoverStatus", + "modelAsString": true + } + }, + "discoveredVmDetails": { + "$ref": "#/definitions/InMageRcmFailbackDiscoveredProtectedVmDetails", + "description": "The discovered VM information." + }, + "lastUsedPolicyId": { + "description": "The policy Id used by the forward replication.", + "type": "string", + "readOnly": true + }, + "lastUsedPolicyFriendlyName": { + "description": "The policy friendly name used by the forward replication.", + "type": "string", + "readOnly": true + }, + "isAgentRegistrationSuccessfulAfterFailover": { + "description": "A value indicating whether agent registration was successful after failover.", + "type": "boolean", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackReprotectInput": { + "description": "InMageRcmFailback specific provider input.", + "required": [ + "processServerId", + "policyId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The run as account Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackSyncDetails": { + "description": "InMageRcmFailback disk level sync details.", + "type": "object", + "properties": { + "progressHealth": { + "description": "The progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress", + "Queued" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskReplicationProgressHealth", + "modelAsString": true + } + }, + "transferredBytes": { + "format": "int64", + "description": "The transferred bytes from source VM to azure for the disk.", + "type": "integer", + "readOnly": true + }, + "last15MinutesTransferredBytes": { + "format": "int64", + "description": "The bytes transferred in last 15 minutes from source VM to target.", + "type": "integer", + "readOnly": true + }, + "lastDataTransferTimeUtc": { + "description": "The time of the last data transfer from source VM to target.", + "type": "string", + "readOnly": true + }, + "processedBytes": { + "format": "int64", + "description": "The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes.", + "type": "integer", + "readOnly": true + }, + "startTime": { + "description": "The start time.", + "type": "string", + "readOnly": true + }, + "lastRefreshTime": { + "description": "The last refresh time.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", + "type": "integer", + "readOnly": true + } + } + }, + "InMageRcmLastAgentUpgradeErrorDetails": { + "description": "InMageRcm last source agent upgrade error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmMobilityAgentDetails": { + "description": "InMageRcm mobility agent details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest agent version available.", + "type": "string", + "readOnly": true + }, + "latestAgentReleaseDate": { + "description": "The latest agent version release date.", + "type": "string", + "readOnly": true + }, + "driverVersion": { + "description": "The driver version.", + "type": "string", + "readOnly": true + }, + "latestUpgradableVersionWithoutReboot": { + "description": "The latest upgradeable version available without reboot.", + "type": "string", + "readOnly": true + }, + "agentVersionExpiryDate": { + "format": "date-time", + "description": "The agent version expiry date.", + "type": "string", + "readOnly": true + }, + "driverVersionExpiryDate": { + "format": "date-time", + "description": "The driver version expiry date.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The time of the last heartbeat received from the agent.", + "type": "string", + "readOnly": true + }, + "reasonsBlockingUpgrade": { + "description": "The whether update is possible or not.", + "type": "array", + "items": { + "enum": [ + "AlreadyOnLatestVersion", + "RebootRequired", + "AgentNoHeartbeat", + "RcmProxyNoHeartbeat", + "ProcessServerNoHeartbeat", + "IncompatibleApplianceVersion", + "NotProtected", + "UnsupportedProtectionScenario", + "DistroIsNotReported", + "DistroNotSupportedForUpgrade", + "MissingUpgradePath", + "InvalidAgentVersion", + "InvalidDriverVersion", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentUpgradeBlockedReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "isUpgradeable": { + "description": "A value indicating whether agent is upgradeable or not.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmNicDetails": { + "description": "InMageRcm NIC details.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string", + "readOnly": true + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string" + }, + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "sourceSubnetName": { + "description": "Source subnet name.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", + "type": "string" + }, + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "Test subnet name.", + "type": "string" + }, + "testIPAddress": { + "description": "The test IP address.", + "type": "string" + }, + "testIPAddressType": { + "description": "The test IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + } + } + }, + "InMageRcmNicInput": { + "description": "InMageRcm NIC input.", + "required": [ + "nicId", + "isPrimaryNic" + ], + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string" + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string" + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The target static IP address.", + "type": "string" + }, + "testSubnetName": { + "description": "The test subnet name.", + "type": "string" + }, + "testStaticIPAddress": { + "description": "The test static IP address.", + "type": "string" + } + } + }, + "InMageRcmPolicyCreationInput": { + "description": "InMageRcm policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmPolicyDetails": { + "description": "InMageRcm specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmProtectedDiskDetails": { + "description": "InMageRcm protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "diskState": { + "description": "The disk state.", + "enum": [ + "Unavailable", + "InitialReplicationPending", + "InitialReplicationFailed", + "Protected" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskState", + "modelAsString": true + } + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "seedBlobUri": { + "description": "The uri of the seed blob.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "diskType": { + "$ref": "#/definitions/DiskAccountType" + }, + "dataPendingInLogDataStoreInMB": { + "format": "double", + "description": "The data pending in log data store in MB.", + "type": "number", + "readOnly": true + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source agent in MB.", + "type": "number", + "readOnly": true + }, + "isInitialReplicationComplete": { + "description": "A value indicating whether initial replication is complete or not.", + "type": "string", + "readOnly": true + }, + "irDetails": { + "$ref": "#/definitions/InMageRcmSyncDetails", + "description": "The initial replication details." + }, + "resyncDetails": { + "$ref": "#/definitions/InMageRcmSyncDetails", + "description": "The resync details." + }, + "customTargetDiskName": { + "description": "The custom target Azure disk name.", + "type": "string" + }, + "sectorSizeInBytes": { + "format": "int32", + "description": "The logical sector size (in bytes), 512 by default.", + "type": "integer" + } + } + }, + "InMageRcmUnProtectedDiskDetails": { + "description": "InMageRcm un-protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + } + } + }, + "InMageRcmProtectionContainerMappingDetails": { + "description": "InMageRcm provider specific container mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "enableAgentAutoUpgrade": { + "description": "A value indicating whether the flag for enable agent auto upgrade.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmRecoveryPointDetails": { + "description": "InMageRcm provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "isMultiVmSyncPoint": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmReplicationDetails": { + "description": "InMageRcm provider specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "internalIdentifier": { + "description": "The virtual machine internal identifier.", + "type": "string", + "readOnly": true + }, + "fabricDiscoveryMachineId": { + "description": "The ARM Id of the discovered VM.", + "type": "string", + "readOnly": true + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string", + "readOnly": true + }, + "discoveryType": { + "description": "The type of the discovered VM.", + "type": "string", + "readOnly": true + }, + "processServerId": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "processorCoreCount": { + "format": "int32", + "description": "The processor core count.", + "type": "integer", + "readOnly": true + }, + "allocatedMemoryInMB": { + "format": "double", + "description": "The allocated memory in MB.", + "type": "number", + "readOnly": true + }, + "processServerName": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type.", + "type": "string", + "readOnly": true + }, + "primaryNicIpAddress": { + "description": "The IP address of the primary network interface.", + "type": "string", + "readOnly": true + }, + "targetGeneration": { + "description": "The target generation.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "storageAccountId": { + "description": "The replication storage account ARM Id. This is applicable only for the blob based replication test hook.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "Target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network Id.", + "type": "string" + }, + "failoverRecoveryPointId": { + "description": "The recovery point Id to which the VM was failed over.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "lastRpoInSeconds": { + "format": "int64", + "description": "The last recovery point objective value.", + "type": "integer", + "readOnly": true + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last recovery point objective calculated time.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointId": { + "description": "The last recovery point Id.", + "type": "string", + "readOnly": true + }, + "initialReplicationProgressPercentage": { + "format": "int32", + "description": "The initial replication progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProcessedBytes": { + "format": "int64", + "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationTransferredBytes": { + "format": "int64", + "description": "The initial replication transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProgressHealth": { + "description": "The initial replication progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "resyncTransferredBytes": { + "format": "int64", + "description": "The resync transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProgressHealth": { + "description": "The resync progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "agentUpgradeState": { + "description": "The agent auto upgrade state.", + "enum": [ + "None", + "Started", + "Completed", + "Commit" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MobilityAgentUpgradeState", + "modelAsString": true + } + }, + "lastAgentUpgradeType": { + "description": "The last agent upgrade type.", + "type": "string", + "readOnly": true + }, + "agentUpgradeJobId": { + "description": "The agent upgrade job Id.", + "type": "string", + "readOnly": true + }, + "agentUpgradeAttemptToVersion": { + "description": "The agent version to which last agent upgrade was attempted.", + "type": "string", + "readOnly": true + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmProtectedDiskDetails" + } + }, + "unprotectedDisks": { + "description": "The list of unprotected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmUnProtectedDiskDetails" + }, + "x-ms-identifiers": [ + "diskId" + ] + }, + "isLastUpgradeSuccessful": { + "description": "A value indicating whether last agent upgrade was successful or not.", + "type": "string", + "readOnly": true + }, + "isAgentRegistrationSuccessfulAfterFailover": { + "description": "A value indicating whether agent registration was successful after failover.", + "type": "boolean", + "readOnly": true + }, + "mobilityAgentDetails": { + "$ref": "#/definitions/InMageRcmMobilityAgentDetails", + "description": "The mobility agent information." + }, + "lastAgentUpgradeErrorDetails": { + "description": "The last agent upgrade error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmLastAgentUpgradeErrorDetails" + } + }, + "agentUpgradeBlockingErrorDetails": { + "description": "The agent upgrade blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmAgentUpgradeBlockingErrorDetails" + } + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmNicDetails" + } + }, + "discoveredVmDetails": { + "$ref": "#/definitions/InMageRcmDiscoveredProtectedVmDetails", + "description": "The discovered VM details." + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "supportedOSVersions": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "array", + "items": { + "type": "string" + } + }, + "osName": { + "description": "The OS name associated with VM.", + "type": "string" + }, + "targetVmSecurityProfile": { + "$ref": "#/definitions/SecurityProfileProperties", + "description": "The target VM security profile." + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmReprotectInput": { + "description": "InMageRcm specific provider input.", + "required": [ + "reprotectAgentId", + "datastoreName", + "logStorageAccountId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "reprotectAgentId": { + "description": "The reprotect agent Id.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmSyncDetails": { + "description": "InMageRcm disk level sync details.", + "type": "object", + "properties": { + "progressHealth": { + "description": "The progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress", + "Queued" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskReplicationProgressHealth", + "modelAsString": true + } + }, + "transferredBytes": { + "format": "int64", + "description": "The transferred bytes from source VM to azure for the disk.", + "type": "integer", + "readOnly": true + }, + "last15MinutesTransferredBytes": { + "format": "int64", + "description": "The bytes transferred in last 15 minutes from source VM to azure.", + "type": "integer", + "readOnly": true + }, + "lastDataTransferTimeUtc": { + "description": "The time of the last data transfer from source VM to azure.", + "type": "string", + "readOnly": true + }, + "processedBytes": { + "format": "int64", + "description": "The total processed bytes. This includes bytes that are transferred from source VM to azure and matched bytes.", + "type": "integer", + "readOnly": true + }, + "startTime": { + "description": "The start time.", + "type": "string", + "readOnly": true + }, + "lastRefreshTime": { + "description": "The last refresh time.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", + "type": "integer", + "readOnly": true + } + } + }, + "InMageRcmTestFailoverInput": { + "description": "InMageRcm provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "networkId": { + "description": "The test network Id.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUnplannedFailoverInput": { + "description": "InMageRcm provider specific input for unplanned failover.", + "required": [ + "performShutdown" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateApplianceForReplicationProtectedItemInput": { + "description": "InMageRcm provider specific input to update appliance for replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput" + } + ], + "properties": { + "runAsAccountId": { + "description": "The run as account Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateContainerMappingInput": { + "description": "InMageRcm update protection container mapping.", + "required": [ + "enableAgentAutoUpgrade" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" + } + ], + "properties": { + "enableAgentAutoUpgrade": { + "description": "A value indicating whether agent auto upgrade has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateReplicationProtectedItemInput": { + "description": "InMageRcm provider specific input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmNicInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "array", + "items": { + "$ref": "#/definitions/UserCreatedResourceTag" + }, + "x-ms-identifiers": [ + "tagName" + ] + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageReplicationDetails": { + "description": "InMage provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "activeSiteType": { + "description": "The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always.", + "type": "string" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "osDetails": { + "$ref": "#/definitions/OSDiskDetails", + "description": "The OS details." + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "resyncDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "The resync details of the machine." + }, + "retentionWindowStart": { + "format": "date-time", + "description": "The retention window start time.", + "type": "string" + }, + "retentionWindowEnd": { + "format": "date-time", + "description": "The retention window end time.", + "type": "string" + }, + "compressedDataRateInMB": { + "format": "double", + "description": "The compressed data change rate in MB.", + "type": "number" + }, + "uncompressedDataRateInMB": { + "format": "double", + "description": "The uncompressed data change rate in MB.", + "type": "number" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageProtectedDiskDetails" + } + }, + "ipAddress": { + "description": "The source IP address.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "masterTargetId": { + "description": "The master target Id.", + "type": "string" + }, + "consistencyPoints": { + "description": "The collection of Consistency points.", + "type": "object", + "additionalProperties": { + "format": "date-time", + "type": "string" + } + }, + "diskResized": { + "description": "A value indicating whether any disk is resized for this VM.", + "type": "string" + }, + "rebootAfterUpdateStatus": { + "description": "A value indicating whether the source server requires a restart after update.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group Id, if any.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name, if any.", + "type": "string" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether the multi vm sync is enabled or disabled.", + "type": "string" + }, + "agentDetails": { + "$ref": "#/definitions/InMageAgentDetails", + "description": "The agent details." + }, + "vCenterInfrastructureId": { + "description": "The vCenter infrastructure Id.", + "type": "string" + }, + "infrastructureVmId": { + "description": "The infrastructure VM Id.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine.", + "type": "string" + }, + "azureStorageAccountId": { + "description": "A value indicating the underlying Azure storage account. If the VM is not running in Azure, this value shall be set to null.", + "type": "string" + }, + "datastores": { + "description": "The datastores of the on-premise machine Value can be list of strings that contain datastore names.", + "type": "array", + "items": { + "type": "string" + } + }, + "validationErrors": { + "description": "The validation errors of the on-premise machine Value can be list of validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "lastUpdateReceivedTime": { + "format": "date-time", + "description": "The last update time received from on-prem components.", + "type": "string" + }, + "replicaId": { + "description": "The replica id of the protected item.", + "type": "string" + }, + "osVersion": { + "description": "The OS Version of the protected item.", + "type": "string" + }, + "isAdditionalStatsAvailable": { + "description": "A value indicating whether additional IR stats are available or not.", + "type": "boolean" + }, + "totalDataTransferred": { + "format": "int64", + "description": "The total transferred data in bytes.", + "type": "integer" + }, + "totalProgressHealth": { + "description": "The progress health.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageReprotectInput": { + "description": "InMageAzureV2 specific provider input.", + "required": [ + "masterTargetId", + "processServerId", + "retentionDrive", + "profileId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master Target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "retentionDrive": { + "description": "The retention drive to use on the MT.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "diskExclusionInput": { + "$ref": "#/definitions/InMageDiskExclusionInput", + "description": "The enable disk exclusion input." + }, + "profileId": { + "description": "The Policy Id.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageTestFailoverInput": { + "description": "Provider specific input for InMage test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageUnplannedFailoverInput": { + "description": "Provider specific input for InMage unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageVolumeExclusionOptions": { + "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "volumeLabel": { + "description": "The volume label. The disk having any volume with this label will be excluded from replication.", + "type": "string" + }, + "onlyExcludeIfSingleVolume": { + "description": "The value indicating whether to exclude multi volume disk or not. If a disk has multiple volumes and one of the volume has label matching with VolumeLabel this disk will be excluded from replication if OnlyExcludeIfSingleVolume is false.", + "type": "string" + } + } + }, + "InnerHealthError": { + "description": "Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", + "type": "object", + "properties": { + "errorSource": { + "description": "Source of error.", + "type": "string" + }, + "errorType": { + "description": "Type of error.", + "type": "string" + }, + "errorLevel": { + "description": "Level of error.", + "type": "string" + }, + "errorCategory": { + "description": "Category of error.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "summaryMessage": { + "description": "Summary message of the entity.", + "type": "string" + }, + "errorMessage": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "creationTimeUtc": { + "format": "date-time", + "description": "Error creation time (UTC).", + "type": "string" + }, + "recoveryProviderErrorMessage": { + "description": "DRA error message.", + "type": "string" + }, + "entityId": { + "description": "ID of the entity.", + "type": "string" + }, + "errorId": { + "description": "The health error unique id.", + "type": "string" + }, + "customerResolvability": { + "description": "Value indicating whether the health error is customer resolvable.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCustomerResolvability", + "modelAsString": true + } + } + } + }, + "InputEndpoint": { + "type": "object", + "properties": { + "endpointName": { + "type": "string" + }, + "privatePort": { + "format": "int32", + "type": "integer" + }, + "publicPort": { + "format": "int32", + "type": "integer" + }, + "protocol": { + "type": "string" + } + } + }, + "Job": { + "description": "Job details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The custom data." + } + } + }, + "JobCollection": { + "description": "Collection of jobs.", + "type": "object", + "properties": { + "value": { + "description": "The list of jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/Job" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "JobDetails": { + "description": "Job details based on specific job type.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the type of job details (see JobDetailsTypes enum for possible values).", + "type": "string" + }, + "affectedObjectDetails": { + "description": "The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "discriminator": "instanceType" + }, + "JobEntity": { + "description": "This class contains the minimal job details required to navigate to the desired drill down.", + "type": "object", + "properties": { + "jobId": { + "description": "The job id.", + "type": "string" + }, + "jobFriendlyName": { + "description": "The job display name.", + "type": "string" + }, + "targetObjectId": { + "description": "The object id.", + "type": "string" + }, + "targetObjectName": { + "description": "The object name.", + "type": "string" + }, + "targetInstanceType": { + "description": "The workflow affected object type.", + "type": "string" + }, + "jobScenarioName": { + "description": "The job name. Enum type ScenarioName.", + "type": "string" + } + } + }, + "JobErrorDetails": { + "description": "This class contains the error details per object.", + "type": "object", + "properties": { + "serviceErrorDetails": { + "$ref": "#/definitions/ServiceError", + "description": "The Service error details." + }, + "providerErrorDetails": { + "$ref": "#/definitions/ProviderError", + "description": "The Provider error details." + }, + "errorLevel": { + "description": "Error level of error.", + "type": "string" + }, + "creationTime": { + "format": "date-time", + "description": "The creation time of job error.", + "type": "string" + }, + "taskId": { + "description": "The Id of the task.", + "type": "string" + } + } + }, + "JobProperties": { + "description": "Job custom data details.", + "type": "object", + "properties": { + "activityId": { + "description": "The activity id.", + "type": "string" + }, + "scenarioName": { + "description": "The ScenarioName.", + "type": "string" + }, + "friendlyName": { + "description": "The DisplayName.", + "type": "string" + }, + "state": { + "description": "The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.", + "type": "string" + }, + "stateDescription": { + "description": "The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.", + "type": "string" + }, + "tasks": { + "description": "The tasks.", + "type": "array", + "items": { + "$ref": "#/definitions/ASRTask" + } + }, + "errors": { + "description": "The errors.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "allowedActions": { + "description": "The Allowed action the job.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetObjectId": { + "description": "The affected Object Id.", + "type": "string" + }, + "targetObjectName": { + "description": "The name of the affected object.", + "type": "string" + }, + "targetInstanceType": { + "description": "The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/JobDetails", + "description": "The custom job details like test failover job details." + } + } + }, + "JobQueryParameter": { + "description": "Query parameter to enumerate jobs.", + "type": "object", + "properties": { + "startTime": { + "description": "Date time to get jobs from.", + "type": "string" + }, + "endTime": { + "description": "Date time to get jobs upto.", + "type": "string" + }, + "fabricId": { + "description": "The Id of the fabric to search jobs under.", + "type": "string" + }, + "affectedObjectTypes": { + "description": "The type of objects.", + "type": "string" + }, + "jobStatus": { + "description": "The states of the job to be filtered can be in.", + "type": "string" + }, + "jobOutputType": { + "description": "The output type of the jobs.", + "enum": [ + "Json", + "Xml", + "Excel" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportJobOutputSerializationType", + "modelAsString": true + } + }, + "jobName": { + "description": "The job Name.", + "type": "string" + }, + "timezoneOffset": { + "format": "double", + "description": "The timezone offset for the location of the request (in minutes).", + "type": "number" + } + } + }, + "JobStatusEventDetails": { + "description": "Model class for event details of a job status event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSpecificDetails" + } + ], + "properties": { + "jobId": { + "description": "Job arm id for the event.", + "type": "string" + }, + "jobFriendlyName": { + "description": "JobName for the Event.", + "type": "string" + }, + "jobStatus": { + "description": "JobStatus for the Event.", + "type": "string" + }, + "affectedObjectType": { + "description": "AffectedObjectType for the event.", + "type": "string" + } + }, + "x-ms-discriminator-value": "JobStatus" + }, + "JobTaskDetails": { + "description": "This class represents a task which is actually a workflow so that one can navigate to its individual drill down.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "jobTask": { + "$ref": "#/definitions/JobEntity", + "description": "The job entity." + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "JobTaskDetails" + }, + "KeyEncryptionKeyInfo": { + "description": "Key Encryption Key (KEK) information.", + "type": "object", + "properties": { + "keyIdentifier": { + "description": "The key URL / identifier.", + "type": "string" + }, + "keyVaultResourceArmId": { + "description": "The KeyVault resource ARM Id for key.", + "type": "string" + } + } + }, + "LogicalNetwork": { + "description": "Logical network data model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LogicalNetworkProperties", + "description": "The Logical Network Properties." + } + } + }, + "LogicalNetworkCollection": { + "description": "List of logical networks.", + "type": "object", + "properties": { + "value": { + "description": "The Logical Networks list details.", + "type": "array", + "items": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "LogicalNetworkProperties": { + "description": "Logical Network Properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The Friendly Name.", + "type": "string" + }, + "networkVirtualizationStatus": { + "description": "A value indicating whether Network Virtualization is enabled for the logical network.", + "type": "string" + }, + "logicalNetworkUsage": { + "description": "A value indicating whether logical network is used as private test network by test failover.", + "type": "string" + }, + "logicalNetworkDefinitionsStatus": { + "description": "A value indicating whether logical network definitions are isolated.", + "type": "string" + } + } + }, + "ManagedRunCommandScriptInput": { + "description": "Managed RunCommand script input", + "required": [ + "stepName", + "scriptUrl", + "scriptParameters" + ], + "type": "object", + "properties": { + "stepName": { + "description": "The step name.", + "type": "string" + }, + "scriptUrl": { + "description": "The script url.", + "type": "string" + }, + "scriptParameters": { + "description": "The script parameters.", + "type": "string" + } + } + }, + "ManualActionTaskDetails": { + "description": "This class represents the manual action task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "instructions": { + "description": "The instructions.", + "type": "string" + }, + "observation": { + "description": "The observation.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManualActionTaskDetails" + }, + "MarsAgentDetails": { + "description": "Mars agent details.", + "type": "object", + "properties": { + "id": { + "description": "The Mars agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Mars agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The Mars agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The Mars agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the Mars agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the Mars agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "MasterTargetServer": { + "description": "Details of a Master Target Server.", + "type": "object", + "properties": { + "id": { + "description": "The server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the server.", + "type": "string" + }, + "name": { + "description": "The server name.", + "type": "string" + }, + "osType": { + "description": "The OS type of the server.", + "type": "string" + }, + "agentVersion": { + "description": "The version of the scout component on the server.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "retentionVolumes": { + "description": "The retention volumes of Master target Server.", + "type": "array", + "items": { + "$ref": "#/definitions/RetentionVolume" + } + }, + "dataStores": { + "description": "The list of data stores in the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/DataStore" + } + }, + "validationErrors": { + "description": "Validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "diskCount": { + "format": "int32", + "description": "Disk count of the master target.", + "type": "integer" + }, + "osVersion": { + "description": "OS Version of the master target.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "marsAgentVersion": { + "description": "MARS agent version.", + "type": "string" + }, + "marsAgentExpiryDate": { + "format": "date-time", + "description": "MARS agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "Agent version details." + }, + "marsAgentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "Mars agent version details." + } + } + }, + "MigrateInput": { + "description": "Input for migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrateInputProperties", + "description": "Migrate input properties." + } + } + }, + "MigrateInputProperties": { + "description": "Migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/MigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "MigrateProviderSpecificInput": { + "description": "Migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "MigrationItem": { + "description": "Migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationItemProperties", + "description": "The migration item properties." + } + } + }, + "MigrationItemCollection": { + "description": "Migration item collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of migration items.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationItemProperties": { + "description": "Migration item properties.", + "type": "object", + "properties": { + "machineName": { + "description": "The on-premise virtual machine name.", + "type": "string", + "readOnly": true + }, + "policyId": { + "description": "The ARM Id of policy governing this item.", + "type": "string", + "readOnly": true + }, + "policyFriendlyName": { + "description": "The name of policy governing this item.", + "type": "string", + "readOnly": true + }, + "recoveryServicesProviderId": { + "description": "The recovery services provider ARM Id.", + "type": "string", + "readOnly": true + }, + "replicationStatus": { + "description": "The replication status.", + "type": "string", + "readOnly": true + }, + "migrationState": { + "description": "The migration status.", + "enum": [ + "None", + "EnableMigrationInProgress", + "EnableMigrationFailed", + "DisableMigrationInProgress", + "DisableMigrationFailed", + "InitialSeedingInProgress", + "InitialSeedingFailed", + "Replicating", + "MigrationInProgress", + "MigrationSucceeded", + "MigrationFailed", + "ResumeInProgress", + "ResumeInitiated", + "SuspendingProtection", + "ProtectionSuspended", + "MigrationCompletedWithInformation", + "MigrationPartiallySucceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "migrationStateDescription": { + "description": "The migration state description.", + "type": "string", + "readOnly": true + }, + "lastTestMigrationTime": { + "format": "date-time", + "description": "The last test migration time.", + "type": "string", + "readOnly": true + }, + "lastTestMigrationStatus": { + "description": "The status of the last test migration.", + "type": "string", + "readOnly": true + }, + "lastMigrationTime": { + "format": "date-time", + "description": "The last migration time.", + "type": "string", + "readOnly": true + }, + "lastMigrationStatus": { + "description": "The status of the last migration.", + "type": "string", + "readOnly": true + }, + "testMigrateState": { + "description": "The test migrate state.", + "enum": [ + "None", + "TestMigrationInProgress", + "TestMigrationSucceeded", + "TestMigrationFailed", + "TestMigrationCleanupInProgress", + "TestMigrationCompletedWithInformation", + "TestMigrationPartiallySucceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TestMigrationState", + "modelAsString": true + } + }, + "testMigrateStateDescription": { + "description": "The test migrate state description.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The consolidated health.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The list of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "allowedOperations": { + "description": "The allowed operations on the migration item based on the current migration state of the item.", + "type": "array", + "items": { + "enum": [ + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup", + "Migrate", + "StartResync", + "PauseReplication", + "ResumeReplication" + ], + "type": "string", + "x-ms-enum": { + "name": "MigrationItemOperation", + "modelAsString": true + } + }, + "readOnly": true + }, + "currentJob": { + "$ref": "#/definitions/CurrentJobDetails", + "description": "The current job details.", + "readOnly": true + }, + "criticalJobHistory": { + "description": "The critical past job details.", + "type": "array", + "items": { + "$ref": "#/definitions/CriticalJobHistoryDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "eventCorrelationId": { + "description": "The correlation Id for events associated with this migration item.", + "type": "string", + "readOnly": true + }, + "providerSpecificDetails": { + "$ref": "#/definitions/MigrationProviderSpecificSettings", + "description": "The migration provider custom settings." + } + } + }, + "MigrationItemsQueryParameter": { + "description": "Query parameter to enumerate migration items.", + "type": "object", + "properties": { + "sourceFabricName": { + "description": "The source fabric name filter.", + "type": "string" + }, + "sourceContainerName": { + "description": "The source container name filter.", + "type": "string" + }, + "instanceType": { + "description": "The replication provider type.", + "type": "string" + } + } + }, + "MigrationProviderSpecificSettings": { + "description": "Migration provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "MigrationRecoveryPoint": { + "description": "Recovery point for a migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationRecoveryPointProperties", + "description": "Recovery point properties." + } + } + }, + "MigrationRecoveryPointCollection": { + "description": "Collection of migration recovery points.", + "type": "object", + "properties": { + "value": { + "description": "The migration recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationRecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationRecoveryPointProperties": { + "description": "Migration item recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string", + "readOnly": true + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "NotSpecified", + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationRecoveryPointType", + "modelAsString": true + } + } + } + }, + "MobilityServiceUpdate": { + "description": "The Mobility Service update details.", + "type": "object", + "properties": { + "version": { + "description": "The version of the latest update.", + "type": "string" + }, + "rebootStatus": { + "description": "The reboot status of the update - whether it is required or not.", + "type": "string" + }, + "osType": { + "description": "The OS type.", + "type": "string" + } + } + }, + "Network": { + "description": "Network model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkProperties", + "description": "The Network Properties." + } + } + }, + "NetworkCollection": { + "description": "List of networks.", + "type": "object", + "properties": { + "value": { + "description": "The Networks list details.", + "type": "array", + "items": { + "$ref": "#/definitions/Network" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "NetworkMapping": { + "description": "Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkMappingProperties", + "description": "The Network Mapping Properties." + } + } + }, + "NetworkMappingCollection": { + "description": "List of network mappings. As with NetworkMapping, it should be possible to reuse a prev version of this class. It doesn't seem likely this class could be anything more than a slightly bespoke collection of NetworkMapping. Hence it makes sense to override Load with Base.NetworkMapping instead of existing CurrentVersion.NetworkMapping.", + "type": "object", + "properties": { + "value": { + "description": "The Network Mappings list.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "NetworkMappingFabricSpecificSettings": { + "description": "Network Mapping fabric specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "NetworkMappingProperties": { + "description": "Network Mapping Properties.", + "type": "object", + "properties": { + "state": { + "description": "The pairing state for network mapping.", + "type": "string" + }, + "primaryNetworkFriendlyName": { + "description": "The primary network friendly name.", + "type": "string" + }, + "primaryNetworkId": { + "description": "The primary network id for network mapping.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The primary fabric friendly name.", + "type": "string" + }, + "recoveryNetworkFriendlyName": { + "description": "The recovery network friendly name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "The recovery network id for network mapping.", + "type": "string" + }, + "recoveryFabricArmId": { + "description": "The recovery fabric ARM id.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The recovery fabric friendly name.", + "type": "string" + }, + "fabricSpecificSettings": { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings", + "description": "The fabric specific settings." + } + } + }, + "NetworkProperties": { + "description": "Network Properties.", + "type": "object", + "properties": { + "fabricType": { + "description": "The Fabric Type.", + "type": "string" + }, + "subnets": { + "description": "The List of subnets.", + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + } + }, + "friendlyName": { + "description": "The Friendly Name.", + "type": "string" + }, + "networkType": { + "description": "The Network Type.", + "type": "string" + } + } + }, + "NewProtectionProfile": { + "description": "New Protection profile input.", + "required": [ + "policyName", + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionProfileCustomDetails" + } + ], + "properties": { + "policyName": { + "description": "The protection profile input.", + "type": "string" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "New" + }, + "NewRecoveryVirtualNetwork": { + "description": "Recovery virtual network input to create new virtual network from given source network.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" + } + ], + "properties": { + "recoveryVirtualNetworkResourceGroupName": { + "description": "The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM.", + "type": "string" + }, + "recoveryVirtualNetworkName": { + "description": "The recovery virtual network name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "New" + }, + "OperationsDiscovery": { + "description": "Operations discovery class.", + "type": "object", + "properties": { + "name": { + "description": "Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the \"{Resource Provider Namespace}/register/action\" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release).", + "type": "string" + }, + "display": { + "$ref": "#/definitions/Display", + "description": "Object type." + }, + "origin": { + "description": "Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is \"user,system\".", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationsDiscoveryProperties", + "description": "Properties. Reserved for future use." + } + } + }, + "OperationsDiscoveryCollection": { + "description": "Collection of ClientDiscovery details.", + "type": "object", + "properties": { + "value": { + "description": "The ClientDiscovery details.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationsDiscovery" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "OperationsDiscoveryProperties": { + "description": "ClientDiscovery properties.", + "type": "object", + "properties": {} + }, + "OSDetails": { + "description": "Disk Details.", + "type": "object", + "properties": { + "osType": { + "description": "VM Disk details.", + "type": "string" + }, + "productType": { + "description": "Product type.", + "type": "string" + }, + "osEdition": { + "description": "The OSEdition.", + "type": "string" + }, + "oSVersion": { + "description": "The OS Version.", + "type": "string" + }, + "oSMajorVersion": { + "description": "The OS Major Version.", + "type": "string" + }, + "oSMinorVersion": { + "description": "The OS Minor Version.", + "type": "string" + }, + "userSelectedOSName": { + "description": "The OS name selected by user.", + "type": "string" + } + } + }, + "OSDiskDetails": { + "description": "Details of the OS Disk.", + "type": "object", + "properties": { + "osVhdId": { + "description": "The id of the disk containing the OS.", + "type": "string" + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string" + }, + "vhdName": { + "description": "The OS disk VHD name.", + "type": "string" + } + } + }, + "OSUpgradeSupportedVersions": { + "description": "Supported OS upgrade versions.", + "type": "object", + "properties": { + "supportedSourceOsVersion": { + "description": "The source OS version name.", + "type": "string", + "readOnly": true + }, + "supportedTargetOsVersions": { + "description": "The target OS version names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "OSVersionWrapper": { + "description": "Wrapper model for OSVersion to include version and service pack info.", + "type": "object", + "properties": { + "version": { + "description": "The version.", + "type": "string" + }, + "servicePack": { + "description": "The service pack.", + "type": "string" + } + } + }, + "PauseReplicationInput": { + "description": "Pause replication input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PauseReplicationInputProperties", + "description": "Pause replication input properties." + } + } + }, + "PauseReplicationInputProperties": { + "description": "Pause replication input properties.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + } + }, + "PlannedFailoverInput": { + "description": "Input definition for planned failover.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PlannedFailoverInputProperties", + "description": "Planned failover input properties." + } + } + }, + "PlannedFailoverInputProperties": { + "description": "Input definition for planned failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput", + "description": "Provider specific settings." + } + } + }, + "PlannedFailoverProviderSpecificFailoverInput": { + "description": "Provider specific failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "Policy": { + "description": "Protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PolicyProperties", + "description": "The custom data." + } + } + }, + "PolicyCollection": { + "description": "Protection Profile Collection details.", + "type": "object", + "properties": { + "value": { + "description": "The policy details.", + "type": "array", + "items": { + "$ref": "#/definitions/Policy" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "PolicyProperties": { + "description": "Protection profile custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The FriendlyName.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/PolicyProviderSpecificDetails", + "description": "The ReplicationChannelSetting." + } + } + }, + "PolicyProviderSpecificDetails": { + "description": "Base class for Provider specific details for policies.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "PolicyProviderSpecificInput": { + "description": "Base class for provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ProcessServer": { + "description": "Details of the Process Server.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The Process Server's friendly name.", + "type": "string" + }, + "id": { + "description": "The Process Server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the server.", + "type": "string" + }, + "osType": { + "description": "The OS type of the server.", + "type": "string" + }, + "agentVersion": { + "description": "The version of the scout component on the server.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "mobilityServiceUpdates": { + "description": "The list of the mobility service updates available on the Process Server.", + "type": "array", + "items": { + "$ref": "#/definitions/MobilityServiceUpdate" + } + }, + "hostId": { + "description": "The agent generated Id.", + "type": "string" + }, + "machineCount": { + "description": "The servers configured with this PS.", + "type": "string" + }, + "replicationPairCount": { + "description": "The number of replication pairs configured in this PS.", + "type": "string" + }, + "systemLoad": { + "description": "The percentage of the system load.", + "type": "string" + }, + "systemLoadStatus": { + "description": "The system load status.", + "type": "string" + }, + "cpuLoad": { + "description": "The percentage of the CPU load.", + "type": "string" + }, + "cpuLoadStatus": { + "description": "The CPU load status.", + "type": "string" + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer" + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer" + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "type": "string" + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total space.", + "type": "integer" + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available space.", + "type": "integer" + }, + "spaceUsageStatus": { + "description": "The space usage status.", + "type": "string" + }, + "psServiceStatus": { + "description": "The PS service status.", + "type": "string" + }, + "sslCertExpiryDate": { + "format": "date-time", + "description": "The PS SSL cert expiry date.", + "type": "string" + }, + "sslCertExpiryRemainingDays": { + "format": "int32", + "description": "CS SSL cert expiry date.", + "type": "integer" + }, + "osVersion": { + "description": "OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0.", + "type": "string" + }, + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The agent version details." + }, + "health": { + "description": "The health of Process Server.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "psStatsRefreshTime": { + "format": "date-time", + "description": "The process server stats refresh time.", + "type": "string", + "readOnly": true + }, + "throughputUploadPendingDataInBytes": { + "format": "int64", + "description": "The uploading pending data in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputInMBps": { + "format": "int64", + "description": "The throughput in MBps.", + "type": "integer", + "readOnly": true + }, + "throughputInBytes": { + "format": "int64", + "description": "The throughput in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputStatus": { + "description": "The throughput status.", + "type": "string", + "readOnly": true + }, + "marsCommunicationStatus": { + "description": "The MARS communication status.", + "type": "string", + "readOnly": true + }, + "marsRegistrationStatus": { + "description": "The MARS registration status.", + "type": "string", + "readOnly": true + } + } + }, + "ProcessServerDetails": { + "description": "Process server details.", + "type": "object", + "properties": { + "id": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The process server Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The process server Fqdn.", + "type": "string", + "readOnly": true + }, + "ipAddresses": { + "description": "The list of IP addresses for communicating with the RCM component.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the process server.", + "type": "string", + "readOnly": true + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer", + "readOnly": true + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer", + "readOnly": true + }, + "usedMemoryInBytes": { + "format": "int64", + "description": "The used memory.", + "type": "integer", + "readOnly": true + }, + "memoryUsagePercentage": { + "format": "double", + "description": "The memory usage percentage.", + "type": "number", + "readOnly": true + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total disk space.", + "type": "integer", + "readOnly": true + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available disk space.", + "type": "integer", + "readOnly": true + }, + "usedSpaceInBytes": { + "format": "int64", + "description": "The used disk space.", + "type": "integer", + "readOnly": true + }, + "freeSpacePercentage": { + "format": "double", + "description": "The free disk space percentage.", + "type": "number", + "readOnly": true + }, + "throughputUploadPendingDataInBytes": { + "format": "int64", + "description": "The uploading pending data in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputInBytes": { + "format": "int64", + "description": "The throughput in bytes.", + "type": "integer", + "readOnly": true + }, + "processorUsagePercentage": { + "format": "double", + "description": "The processor usage percentage.", + "type": "number", + "readOnly": true + }, + "throughputStatus": { + "description": "The throughput status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "systemLoad": { + "format": "int64", + "description": "The system load.", + "type": "integer", + "readOnly": true + }, + "systemLoadStatus": { + "description": "The system load status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "diskUsageStatus": { + "description": "The disk usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "processorUsageStatus": { + "description": "The processor usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "health": { + "description": "The health of the process server.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "protectedItemCount": { + "format": "int32", + "description": "The protected item count.", + "type": "integer", + "readOnly": true + }, + "historicHealth": { + "description": "The historic health of the process server based on the health in last 24 hours.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + } + } + }, + "ProtectableItem": { + "description": "Replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectableItemProperties", + "description": "The custom data." + } + } + }, + "ProtectableItemCollection": { + "description": "Protectable item collection.", + "type": "object", + "properties": { + "value": { + "description": "The Protectable item details.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectableItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ProtectableItemProperties": { + "description": "Replication protected item custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "protectionStatus": { + "description": "The protection status.", + "type": "string" + }, + "replicationProtectedItemId": { + "description": "The ARM resource of protected items.", + "type": "string" + }, + "recoveryServicesProviderId": { + "description": "The recovery provider ARM Id.", + "type": "string" + }, + "protectionReadinessErrors": { + "description": "The Current protection readiness errors.", + "type": "array", + "items": { + "type": "string" + } + }, + "supportedReplicationProviders": { + "description": "The list of replication providers supported for the protectable item.", + "type": "array", + "items": { + "type": "string" + } + }, + "customDetails": { + "$ref": "#/definitions/ConfigurationSettings", + "description": "The Replication provider custom settings." + } + } + }, + "ProtectableItemQueryParameter": { + "description": "Query parameter to enumerate Protectable items.", + "type": "object", + "properties": { + "state": { + "description": "State of the Protectable item query filter.", + "type": "string" + } + } + }, + "ProtectedItemsQueryParameter": { + "description": "Query parameter to enumerate protected items.", + "type": "object", + "properties": { + "sourceFabricName": { + "description": "The source fabric name filter.", + "type": "string" + }, + "recoveryPlanName": { + "description": "The recovery plan filter.", + "type": "string" + }, + "sourceFabricLocation": { + "description": "The source fabric location filter.", + "type": "string" + }, + "fabricObjectId": { + "description": "The fabric object Id filter.", + "type": "string" + }, + "vCenterName": { + "description": "The vCenter name filter.", + "type": "string" + }, + "instanceType": { + "description": "The replication provider type.", + "type": "string" + }, + "multiVmGroupCreateOption": { + "description": "Whether Multi VM group is auto created or specified by user.", + "enum": [ + "AutoCreated", + "UserSpecified" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmGroupCreateOption", + "modelAsString": true + } + }, + "processServerId": { + "description": "The process server Id filter.", + "type": "string" + } + } + }, + "ProtectionContainer": { + "description": "Protection container details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainerProperties", + "description": "The custom data." + } + } + }, + "ProtectionContainerCollection": { + "description": "Protection Container collection.", + "type": "object", + "properties": { + "value": { + "description": "The Protection Container details.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ProtectionContainerFabricSpecificDetails": { + "description": "Base class for fabric specific details of container.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + } + }, + "ProtectionContainerMapping": { + "description": "Protection container mapping object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainerMappingProperties", + "description": "The custom data." + } + } + }, + "ProtectionContainerMappingCollection": { + "description": "Protection container mapping collection class.", + "type": "object", + "properties": { + "value": { + "description": "List of container mappings.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "nextLink": { + "description": "Link to fetch rest of the data.", + "type": "string" + } + } + }, + "ProtectionContainerMappingProperties": { + "description": "Protection container mapping properties.", + "type": "object", + "properties": { + "targetProtectionContainerId": { + "description": "Paired protection container ARM ID.", + "type": "string" + }, + "targetProtectionContainerFriendlyName": { + "description": "Friendly name of paired container.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails", + "description": "Provider specific provider details." + }, + "health": { + "description": "Health of pairing.", + "type": "string" + }, + "healthErrorDetails": { + "description": "Health error.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "policyId": { + "description": "Policy ARM Id.", + "type": "string" + }, + "state": { + "description": "Association Status.", + "type": "string" + }, + "sourceProtectionContainerFriendlyName": { + "description": "Friendly name of source protection container.", + "type": "string" + }, + "sourceFabricFriendlyName": { + "description": "Friendly name of source fabric.", + "type": "string" + }, + "targetFabricFriendlyName": { + "description": "Friendly name of target fabric.", + "type": "string" + }, + "policyFriendlyName": { + "description": "Friendly name of replication policy.", + "type": "string" + } + } + }, + "ProtectionContainerMappingProviderSpecificDetails": { + "description": "Container mapping provider specific details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ProtectionContainerProperties": { + "description": "Protection profile custom data details.", + "type": "object", + "properties": { + "fabricFriendlyName": { + "description": "Fabric friendly name.", + "type": "string" + }, + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "fabricType": { + "description": "The fabric type.", + "type": "string" + }, + "protectedItemCount": { + "format": "int32", + "description": "Number of protected PEs.", + "type": "integer" + }, + "pairingStatus": { + "description": "The pairing status of this cloud.", + "type": "string" + }, + "role": { + "description": "The role of this cloud.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/ProtectionContainerFabricSpecificDetails", + "description": "Fabric specific details." + } + } + }, + "ProtectionProfileCustomDetails": { + "description": "Protection Profile custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "ProviderError": { + "description": "This class contains the error details per object.", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "The Error code.", + "type": "integer" + }, + "errorMessage": { + "description": "The Error message.", + "type": "string" + }, + "errorId": { + "description": "The Provider error Id.", + "type": "string" + }, + "possibleCauses": { + "description": "The possible causes for the error.", + "type": "string" + }, + "recommendedAction": { + "description": "The recommended action to resolve the error.", + "type": "string" + } + } + }, + "ProviderSpecificRecoveryPointDetails": { + "description": "Replication provider specific recovery point details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the provider type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "PushInstallerDetails": { + "description": "Push installer details.", + "type": "object", + "properties": { + "id": { + "description": "The push installer Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The push installer name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The push installer Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The push installer Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the push installer.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the push installer.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "RcmProxyDetails": { + "description": "RCM proxy details.", + "type": "object", + "properties": { + "id": { + "description": "The RCM proxy Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The RCM proxy name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The RCM proxy Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The RCM proxy Fqdn.", + "type": "string", + "readOnly": true + }, + "clientAuthenticationType": { + "description": "The client authentication type.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the RCM proxy.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the RCM proxy.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "RecoveryAvailabilitySetCustomDetails": { + "description": "Recovery Availability Set custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryPlan": { + "description": "Recovery plan details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanProperties", + "description": "The custom details." + } + } + }, + "RecoveryPlanA2ADetails": { + "description": "Recovery plan A2A specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" + } + ], + "properties": { + "primaryZone": { + "description": "The primary zone.", + "type": "string" + }, + "recoveryZone": { + "description": "The recovery zone.", + "type": "string" + }, + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary extended location." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery extended location." + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanA2AFailoverInput": { + "description": "Recovery plan A2A failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "A2ARpRecoveryPointType", + "modelAsString": true + } + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for TFO or not.", + "type": "string" + }, + "multiVmSyncPointOption": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "enum": [ + "UseMultiVmSyncRecoveryPoint", + "UsePerVmRecoveryPoint" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmSyncPointOption", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanA2AInput": { + "description": "Recovery plan A2A input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" + } + ], + "properties": { + "primaryZone": { + "description": "The primary zone.", + "type": "string" + }, + "recoveryZone": { + "description": "The recovery zone.", + "type": "string" + }, + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary extended location." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery extended location." + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanAction": { + "description": "Recovery plan action details.", + "required": [ + "actionName", + "failoverTypes", + "failoverDirections", + "customDetails" + ], + "type": "object", + "properties": { + "actionName": { + "description": "The action name.", + "type": "string" + }, + "failoverTypes": { + "description": "The list of failover types.", + "type": "array", + "items": { + "enum": [ + "ReverseReplicate", + "Commit", + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover", + "TestFailoverCleanup", + "Failback", + "FinalizeFailback", + "CancelFailover", + "ChangePit", + "RepairReplication", + "SwitchProtection", + "CompleteMigration" + ], + "type": "string", + "x-ms-enum": { + "name": "ReplicationProtectedItemOperation", + "modelAsString": true + } + } + }, + "failoverDirections": { + "description": "The list of failover directions.", + "type": "array", + "items": { + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + } + }, + "customDetails": { + "$ref": "#/definitions/RecoveryPlanActionDetails", + "description": "The custom details." + } + } + }, + "RecoveryPlanActionDetails": { + "description": "Recovery plan action custom details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values).", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanAutomationRunbookActionDetails": { + "description": "Recovery plan Automation runbook action details.", + "required": [ + "fabricLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "runbookId": { + "description": "The runbook ARM Id.", + "type": "string" + }, + "timeout": { + "description": "The runbook timeout.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "enum": [ + "Primary", + "Recovery" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanActionLocation", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AutomationRunbookActionDetails" + }, + "RecoveryPlanCollection": { + "description": "Recovery plan collection details.", + "type": "object", + "properties": { + "value": { + "description": "The list of recovery plans.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryPlanGroup": { + "description": "Recovery plan group details.", + "required": [ + "groupType" + ], + "type": "object", + "properties": { + "groupType": { + "description": "The group type.", + "enum": [ + "Shutdown", + "Boot", + "Failover" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanGroupType", + "modelAsString": true + } + }, + "replicationProtectedItems": { + "description": "The list of protected items.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProtectedItem" + } + }, + "startGroupActions": { + "description": "The start group actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanAction" + } + }, + "endGroupActions": { + "description": "The end group actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanAction" + } + } + } + }, + "RecoveryPlanGroupTaskDetails": { + "description": "This class represents the recovery plan group task.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GroupTaskDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "groupId": { + "description": "The group identifier.", + "type": "string" + }, + "rpGroupType": { + "description": "The group type.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "RecoveryPlanGroupTaskDetails" + }, + "RecoveryPlanHyperVReplicaAzureFailbackInput": { + "description": "Recovery plan HVR Azure failback input.", + "required": [ + "dataSyncOption", + "recoveryVmCreationOption" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "dataSyncOption": { + "description": "The data sync option.", + "enum": [ + "ForDownTime", + "ForSynchronization" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSyncStatus", + "modelAsString": true + } + }, + "recoveryVmCreationOption": { + "description": "The ALR option.", + "enum": [ + "CreateVmIfNotFound", + "NoAction" + ], + "type": "string", + "x-ms-enum": { + "name": "AlternateLocationRecoveryOption", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzureFailback" + }, + "RecoveryPlanHyperVReplicaAzureFailoverInput": { + "description": "Recovery plan HVR Azure failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "The primary KEK certificate PFX.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "The secondary KEK certificate PFX.", + "type": "string" + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "HyperVReplicaAzureRpRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "RecoveryPlanInMageAzureV2FailoverInput": { + "description": "Recovery plan InMageAzureV2 failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageV2RpRecoveryPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "RecoveryPlanInMageFailoverInput": { + "description": "Recovery plan InMage failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RpInMageRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "RecoveryPlanInMageRcmFailbackFailoverInput": { + "description": "Recovery plan InMageRcmFailback failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageRcmFailbackRecoveryPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "RecoveryPlanInMageRcmFailoverInput": { + "description": "Recovery plan InMageRcm failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "RecoveryPlanManualActionDetails": { + "description": "Recovery plan manual action details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "description": { + "description": "The manual action description.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManualActionDetails" + }, + "RecoveryPlanPlannedFailoverInput": { + "description": "Recovery plan planned failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanPlannedFailoverInputProperties", + "description": "The recovery plan planned failover input properties." + } + } + }, + "RecoveryPlanPlannedFailoverInputProperties": { + "description": "Recovery plan planned failover input properties.", + "required": [ + "failoverDirection" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPlanProperties": { + "description": "Recovery plan properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name.", + "type": "string" + }, + "primaryFabricId": { + "description": "The primary fabric Id.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The primary fabric friendly name.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The recovery fabric Id.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The recovery fabric friendly name.", + "type": "string" + }, + "failoverDeploymentModel": { + "description": "The failover deployment model.", + "type": "string" + }, + "replicationProviders": { + "description": "The list of replication providers.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedOperations": { + "description": "The list of allowed operations.", + "type": "array", + "items": { + "type": "string" + } + }, + "lastPlannedFailoverTime": { + "format": "date-time", + "description": "The start time of the last planned failover.", + "type": "string" + }, + "lastUnplannedFailoverTime": { + "format": "date-time", + "description": "The start time of the last unplanned failover.", + "type": "string" + }, + "lastTestFailoverTime": { + "format": "date-time", + "description": "The start time of the last test failover.", + "type": "string" + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario details." + }, + "currentScenarioStatus": { + "description": "The recovery plan status.", + "type": "string" + }, + "currentScenarioStatusDescription": { + "description": "The recovery plan status description.", + "type": "string" + }, + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + }, + "providerSpecificDetails": { + "description": "The provider id and provider specific details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" + } + } + } + }, + "RecoveryPlanProtectedItem": { + "description": "Recovery plan protected item.", + "type": "object", + "properties": { + "id": { + "description": "The ARM Id of the recovery plan protected item.", + "type": "string" + }, + "virtualMachineId": { + "description": "The virtual machine Id.", + "type": "string" + } + } + }, + "RecoveryPlanProviderSpecificDetails": { + "description": "Recovery plan provider specific details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanProviderSpecificFailoverInput": { + "description": "Recovery plan provider specific failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanProviderSpecificInput": { + "description": "Recovery plan provider specific input base class.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanScriptActionDetails": { + "description": "Recovery plan script action details.", + "required": [ + "path", + "fabricLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "path": { + "description": "The script path.", + "type": "string" + }, + "timeout": { + "description": "The script timeout.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "enum": [ + "Primary", + "Recovery" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanActionLocation", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "ScriptActionDetails" + }, + "RecoveryPlanShutdownGroupTaskDetails": { + "description": "This class represents the recovery plan shutdown group task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanGroupTaskDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "RecoveryPlanShutdownGroupTaskDetails" + }, + "RecoveryPlanTestFailoverCleanupInput": { + "description": "Recovery plan test failover cleanup input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInputProperties", + "description": "The recovery plan test failover cleanup input properties." + } + } + }, + "RecoveryPlanTestFailoverCleanupInputProperties": { + "description": "Recovery plan test failover cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "The test failover cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "RecoveryPlanTestFailoverInput": { + "description": "Recovery plan test failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanTestFailoverInputProperties", + "description": "The recovery plan test failover input properties." + } + } + }, + "RecoveryPlanTestFailoverInputProperties": { + "description": "Recovery plan test failover input properties.", + "required": [ + "failoverDirection", + "networkType" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "networkType": { + "description": "The network type to be used for test failover.", + "type": "string" + }, + "networkId": { + "description": "The Id of the network to be used for test failover.", + "type": "string" + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "maxLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPlanUnplannedFailoverInput": { + "description": "Recovery plan unplanned failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInputProperties", + "description": "The recovery plan unplanned failover input properties." + } + } + }, + "RecoveryPlanUnplannedFailoverInputProperties": { + "description": "Recovery plan unplanned failover input properties.", + "required": [ + "failoverDirection", + "sourceSiteOperations" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "sourceSiteOperations": { + "description": "A value indicating whether source site operations are required.", + "enum": [ + "Required", + "NotRequired" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceSiteOperations", + "modelAsString": true + } + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "maxLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPoint": { + "description": "Recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPointProperties", + "description": "The recovery point properties." + } + } + }, + "RecoveryPointCollection": { + "description": "Collection of recovery point details.", + "type": "object", + "properties": { + "value": { + "description": "The recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryPointProperties": { + "description": "Recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string" + }, + "recoveryPointType": { + "description": "The recovery point type: ApplicationConsistent, CrashConsistent.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails", + "description": "The provider specific details for the recovery point." + } + } + }, + "RecoveryProximityPlacementGroupCustomDetails": { + "description": "Recovery Proximity placement group custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryResourceGroupCustomDetails": { + "description": "Recovery Resource Group custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryServicesProvider": { + "description": "Provider details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryServicesProviderProperties", + "description": "Provider properties." + } + } + }, + "RecoveryServicesProviderCollection": { + "description": "Collection of providers.", + "type": "object", + "properties": { + "value": { + "description": "The Servers details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryServicesProviderProperties": { + "description": "Recovery services provider properties.", + "type": "object", + "properties": { + "fabricType": { + "description": "Type of the site.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of the DRA.", + "type": "string" + }, + "providerVersion": { + "description": "The provider version.", + "type": "string" + }, + "serverVersion": { + "description": "The fabric provider.", + "type": "string" + }, + "providerVersionState": { + "description": "DRA version status.", + "type": "string" + }, + "providerVersionExpiryDate": { + "format": "date-time", + "description": "Expiry date of the version.", + "type": "string" + }, + "fabricFriendlyName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "lastHeartBeat": { + "format": "date-time", + "description": "Time when last heartbeat was sent by the DRA.", + "type": "string" + }, + "connectionStatus": { + "description": "A value indicating whether DRA is responsive.", + "type": "string" + }, + "protectedItemCount": { + "format": "int32", + "description": "Number of protected VMs currently managed by the DRA.", + "type": "integer" + }, + "allowedScenarios": { + "description": "The scenarios allowed on this provider.", + "type": "array", + "items": { + "type": "string" + } + }, + "healthErrorDetails": { + "description": "The recovery services provider health error details.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "draIdentifier": { + "description": "The DRA Id.", + "type": "string" + }, + "machineId": { + "description": "The machine Id.", + "type": "string" + }, + "machineName": { + "description": "The machine name.", + "type": "string" + }, + "biosId": { + "description": "The Bios Id.", + "type": "string" + }, + "authenticationIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The authentication identity details." + }, + "resourceAccessIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The resource access identity details." + }, + "dataPlaneAuthenticationIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The data plane authentication identity details." + }, + "providerVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The provider version details." + } + } + }, + "RecoveryVirtualNetworkCustomDetails": { + "description": "Recovery Virtual network custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RegisteredClusterNodes": { + "description": "Extended location of the resource.", + "type": "object", + "properties": { + "clusterNodeFqdn": { + "description": "The cluster node name.", + "type": "string" + }, + "machineId": { + "description": "The machine ID.", + "type": "string" + }, + "biosId": { + "description": "The BIOS ID.", + "type": "string" + }, + "isSharedDiskVirtualNode": { + "description": "A value indicating whether this represents virtual entity hosting all the shared disks.", + "type": "boolean" + } + } + }, + "RemoveDisksInput": { + "description": "Input for remove disk(s) operation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoveDisksInputProperties", + "description": "Remove disk input properties." + } + } + }, + "RemoveDisksInputProperties": { + "description": "Remove Disk input properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/RemoveDisksProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "RemoveDisksProviderSpecificInput": { + "description": "Remove Disk provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RemoveProtectionContainerMappingInput": { + "description": "Container unpairing input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoveProtectionContainerMappingInputProperties", + "description": "Configure protection input properties." + } + } + }, + "RemoveProtectionContainerMappingInputProperties": { + "description": "Unpairing input properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderContainerUnmappingInput", + "description": "Provider specific input for unpairing." + } + } + }, + "RenewCertificateInput": { + "description": "Certificate renewal input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RenewCertificateInputProperties", + "description": "Renew certificate input properties." + } + } + }, + "RenewCertificateInputProperties": { + "description": "Renew Certificate input properties.", + "type": "object", + "properties": { + "renewCertificateType": { + "description": "Renew certificate type.", + "type": "string" + } + } + }, + "ReplicationAgentDetails": { + "description": "Replication agent details.", + "type": "object", + "properties": { + "id": { + "description": "The replication agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The replication agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The replication agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The replication agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the replication agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the replication agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "ReplicationAppliance": { + "description": "Replication appliance definition.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationApplianceProperties", + "description": "Appliance related data." + } + } + }, + "ReplicationApplianceProperties": { + "description": "Replication appliance properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/ApplianceSpecificDetails", + "description": "Provider specific settings." + } + } + }, + "ReplicationClusterProviderSpecificSettings": { + "description": "Replication cluster provider specific settings.", + "type": "object", + "required": [ + "instanceType" + ], + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationEligibilityResults": { + "description": "Replication eligibility results response model.", + "type": "object", + "properties": { + "name": { + "description": "Gets the name of this object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Gets the object type.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Gets Unique ARM identifier for this object.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ReplicationEligibilityResultsProperties", + "description": "Gets properties model for replication eligibility results API.", + "readOnly": true + } + } + }, + "ReplicationEligibilityResultsCollection": { + "description": "Replication eligibility results collection response model.", + "type": "object", + "properties": { + "value": { + "description": "The replication eligibility results details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationEligibilityResults" + } + } + } + }, + "ReplicationEligibilityResultsErrorInfo": { + "description": "Error model that can be exposed to the user.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string" + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string" + }, + "status": { + "description": "The error status.", + "readOnly": true, + "type": "string" + } + } + }, + "ReplicationEligibilityResultsProperties": { + "description": "Properties model for replication eligibility results API.", + "type": "object", + "properties": { + "clientRequestId": { + "description": "The client request Id.", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "The error details.", + "type": "array", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/ReplicationEligibilityResultsErrorInfo" + } + } + } + }, + "ReplicationGroupDetails": { + "description": "Replication group details. This will be used in case of San.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "ReplicationGroupDetails" + }, + "ReplicationProtectedItem": { + "description": "Replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationProtectedItemProperties", + "description": "The custom data." + } + } + }, + "ReplicationProtectedItemCollection": { + "description": "Replication protected item collection.", + "type": "object", + "properties": { + "value": { + "description": "The Replication protected item details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ReplicationProtectedItemProperties": { + "description": "Replication protected item custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "protectedItemType": { + "description": "The type of protected item type.", + "type": "string" + }, + "protectableItemId": { + "description": "The protected item ARM Id.", + "type": "string" + }, + "recoveryServicesProviderId": { + "description": "The recovery provider ARM Id.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The friendly name of the primary fabric.", + "type": "string" + }, + "primaryFabricProvider": { + "description": "The fabric provider of the primary fabric.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The friendly name of recovery fabric.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The Arm Id of recovery fabric.", + "type": "string" + }, + "primaryProtectionContainerFriendlyName": { + "description": "The name of primary protection container friendly name.", + "type": "string" + }, + "recoveryProtectionContainerFriendlyName": { + "description": "The name of recovery container friendly name.", + "type": "string" + }, + "protectionState": { + "description": "The protection status.", + "type": "string" + }, + "protectionStateDescription": { + "description": "The protection state description.", + "type": "string" + }, + "activeLocation": { + "description": "The Current active location of the PE.", + "type": "string" + }, + "testFailoverState": { + "description": "The Test failover state.", + "type": "string" + }, + "testFailoverStateDescription": { + "description": "The Test failover state description.", + "type": "string" + }, + "switchProviderState": { + "description": "The switch provider state.", + "type": "string" + }, + "switchProviderStateDescription": { + "description": "The switch provider state description.", + "type": "string" + }, + "allowedOperations": { + "description": "The allowed operations on the Replication protected item.", + "type": "array", + "items": { + "type": "string" + } + }, + "replicationHealth": { + "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.", + "type": "string" + }, + "failoverHealth": { + "description": "The consolidated failover health for the VM.", + "type": "string" + }, + "healthErrors": { + "description": "List of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "policyId": { + "description": "The ID of Policy governing this PE.", + "type": "string" + }, + "policyFriendlyName": { + "description": "The name of Policy governing this PE.", + "type": "string" + }, + "lastSuccessfulFailoverTime": { + "format": "date-time", + "description": "The Last successful failover time.", + "type": "string" + }, + "lastSuccessfulTestFailoverTime": { + "format": "date-time", + "description": "The Last successful test failover time.", + "type": "string" + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario." + }, + "failoverRecoveryPointId": { + "description": "The recovery point ARM Id to which the Vm was failed over.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReplicationProviderSpecificSettings", + "description": "The Replication provider custom settings." + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "eventCorrelationId": { + "description": "The correlation Id for events associated with this protected item.", + "type": "string" + } + } + }, + "ReplicationProtectionCluster": { + "description": "Replication protection Cluster.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "description": "The protection cluster Id.", + "type": "string" + }, + "name": { + "readOnly": true, + "description": "The name of the protection cluster.", + "type": "string" + }, + "type": { + "readOnly": true, + "description": "The Type of the object.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ReplicationProtectionClusterProperties", + "description": "The custom data." + } + }, + "x-ms-azure-resource": true + }, + "ReplicationProtectionClusterCollection": { + "description": "Replication protected item collection.", + "type": "object", + "properties": { + "value": { + "description": "The Replication protection cluster details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProtectionCluster" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ReplicationProtectionClusterProperties": { + "description": "Replication protection cluster custom data details.", + "type": "object", + "properties": { + "protectionClusterType": { + "description": "The type of protection cluster type.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The friendly name of the primary fabric.", + "type": "string" + }, + "primaryFabricProvider": { + "description": "The fabric provider of the primary fabric.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The friendly name of recovery fabric.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The Arm Id of recovery fabric.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics" + } + ] + } + }, + "primaryProtectionContainerFriendlyName": { + "description": "The name of primary protection container friendly name.", + "type": "string" + }, + "recoveryProtectionContainerFriendlyName": { + "description": "The name of recovery container friendly name.", + "type": "string" + }, + "protectionState": { + "description": "The protection status.", + "type": "string" + }, + "protectionStateDescription": { + "description": "The protection state description.", + "type": "string" + }, + "activeLocation": { + "description": "The Current active location of the Protection cluster.", + "type": "string" + }, + "testFailoverState": { + "description": "The Test failover state.", + "type": "string" + }, + "testFailoverStateDescription": { + "description": "The Test failover state description.", + "type": "string" + }, + "allowedOperations": { + "description": "The allowed operations on the Replication protection cluster.", + "type": "array", + "items": { + "type": "string" + } + }, + "replicationHealth": { + "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.", + "type": "string" + }, + "healthErrors": { + "description": "List of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "x-ms-identifiers": [] + }, + "lastSuccessfulFailoverTime": { + "format": "date-time", + "description": "The last successful failover time.", + "type": "string" + }, + "lastSuccessfulTestFailoverTime": { + "format": "date-time", + "description": "The last successful test failover time.", + "type": "string" + }, + "policyFriendlyName": { + "description": "The name of Policy governing this PE.", + "type": "string" + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario." + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers" + } + ] + } + }, + "agentClusterId": { + "description": "The Agent cluster Id.", + "type": "string" + }, + "clusterFqdn": { + "description": "The cluster FQDN.", + "type": "string" + }, + "clusterNodeFqdns": { + "description": "The List of cluster Node FQDNs.", + "type": "array", + "items": { + "type": "string" + } + }, + "clusterProtectedItemIds": { + "description": "The List of Protected Item Id's.", + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems" + } + ] + } + } + }, + "provisioningState": { + "description": "The provisioning state of the cluster.", + "type": "string", + "readOnly": true + }, + "areAllClusterNodesRegistered": { + "description": "A value indicating whether all nodes of the cluster are registered or not.", + "type": "boolean" + }, + "clusterRegisteredNodes": { + "description": "The registered node details.", + "type": "array", + "items": { + "$ref": "#/definitions/RegisteredClusterNodes" + }, + "x-ms-identifiers": [ + "clusterNodeFqdn" + ] + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReplicationClusterProviderSpecificSettings", + "description": "The Replication cluster provider custom settings." + }, + "sharedDiskProperties": { + "$ref": "#/definitions/SharedDiskReplicationItemProperties", + "description": "The shared disk properties." + }, + "policyId": { + "description": "The Policy Id.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies" + } + ] + } + } + } + }, + "ReplicationProtectionIntent": { + "description": "Replication protection intent.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationProtectionIntentProperties", + "description": "The custom data." + } + } + }, + "ReplicationProtectionIntentCollection": { + "description": "Replication protection intent objects collection.", + "type": "object", + "properties": { + "value": { + "description": "The Replication protection intent details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ReplicationProtectionIntentProperties": { + "description": "Replication protection intent custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "jobId": { + "description": "The job Id.", + "type": "string", + "readOnly": true + }, + "jobState": { + "description": "The job state.", + "type": "string", + "readOnly": true + }, + "isActive": { + "description": "A value indicating whether the intent object is active.", + "type": "boolean", + "readOnly": true + }, + "creationTimeUTC": { + "description": "The creation time in UTC.", + "type": "string", + "readOnly": true + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings", + "description": "The Replication provider custom settings." + } + } + }, + "ReplicationProtectionIntentProviderSpecificSettings": { + "description": "Replication provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderContainerUnmappingInput": { + "description": "Provider specific input for unpairing operations.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + } + }, + "ReplicationProviderSpecificContainerCreationInput": { + "description": "Provider specific input for container creation operation.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificContainerMappingInput": { + "description": "Provider specific input for pairing operations.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificSettings": { + "description": "Replication provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificUpdateContainerMappingInput": { + "description": "Provider specific input for update pairing operations.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReprotectAgentDetails": { + "description": "Reprotect agent details.", + "type": "object", + "properties": { + "id": { + "description": "The reprotect agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The reprotect agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The reprotect agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The reprotect agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the reprotect agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the reprotect agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "x-ms-identifier": [ + "errorCode" + ], + "readOnly": true + }, + "protectedItemCount": { + "format": "int32", + "description": "The protected item count.", + "type": "integer", + "readOnly": true + }, + "accessibleDatastores": { + "description": "The list of accessible datastores fetched from discovery.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vcenterId": { + "description": "The Vcenter Id.", + "type": "string", + "readOnly": true + }, + "lastDiscoveryInUtc": { + "format": "date-time", + "description": "The last time when SDS information discovered in SRS.", + "type": "string", + "readOnly": true + } + } + }, + "ResolveHealthError": { + "description": "Resolve health errors input properties.", + "type": "object", + "properties": { + "healthErrorId": { + "description": "Health error id.", + "type": "string" + } + } + }, + "ResolveHealthInput": { + "description": "Resolve health input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResolveHealthInputProperties", + "description": "Disable resolve health input properties." + } + } + }, + "ResolveHealthInputProperties": { + "description": "Resolve health input properties.", + "type": "object", + "properties": { + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ResolveHealthError" + } + } + } + }, + "Resource": { + "description": "Azure resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource Type", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource Location", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "ResourceHealthSummary": { + "description": "Base class to define the health summary of the resources contained under an Arm resource.", + "type": "object", + "properties": { + "resourceCount": { + "format": "int32", + "description": "The count of total resources under the container.", + "type": "integer" + }, + "issues": { + "description": "The list of summary of health errors across the resources under the container.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthErrorSummary" + } + }, + "categorizedResourceCounts": { + "description": "The categorized resource counts.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + } + } + }, + "ResumeJobParams": { + "description": "Resume job params.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResumeJobParamsProperties", + "description": "Resume job properties." + } + } + }, + "ResumeJobParamsProperties": { + "description": "Resume job properties.", + "type": "object", + "properties": { + "comments": { + "description": "Resume job comments.", + "type": "string" + } + } + }, + "ResumeReplicationInput": { + "description": "Resume replication input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResumeReplicationInputProperties", + "description": "Resume replication input properties." + } + } + }, + "ResumeReplicationInputProperties": { + "description": "Resume replication input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/ResumeReplicationProviderSpecificInput", + "description": "The provider specific input for resume replication." + } + } + }, + "ResumeReplicationProviderSpecificInput": { + "description": "Resume replication provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ResyncInput": { + "description": "Resync input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResyncInputProperties", + "description": "Resync input properties." + } + } + }, + "ResyncInputProperties": { + "description": "Resync input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/ResyncProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "ResyncProviderSpecificInput": { + "description": "Resync provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RetentionVolume": { + "description": "The retention details of the MT.", + "type": "object", + "properties": { + "volumeName": { + "description": "The volume name.", + "type": "string" + }, + "capacityInBytes": { + "format": "int64", + "description": "The volume capacity.", + "type": "integer" + }, + "freeSpaceInBytes": { + "format": "int64", + "description": "The free space available in this volume.", + "type": "integer" + }, + "thresholdPercentage": { + "format": "int32", + "description": "The threshold percentage.", + "type": "integer" + } + } + }, + "ReverseReplicationInput": { + "description": "Reverse replication input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ReverseReplicationInputProperties", + "description": "Reverse replication properties." + } + } + }, + "ReverseReplicationInputProperties": { + "description": "Reverse replication input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput", + "description": "Provider specific reverse replication input." + } + } + }, + "ReverseReplicationProviderSpecificInput": { + "description": "Provider specific reverse replication input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RoleAssignment": { + "description": "Azure role assignment details.", + "type": "object", + "properties": { + "id": { + "description": "The ARM Id of the role assignment.", + "type": "string" + }, + "name": { + "description": "The name of the role assignment.", + "type": "string" + }, + "scope": { + "description": "Role assignment scope.", + "type": "string" + }, + "principalId": { + "description": "Principal Id.", + "type": "string" + }, + "roleDefinitionId": { + "description": "Role definition id.", + "type": "string" + } + } + }, + "RunAsAccount": { + "description": "CS Accounts Details.", + "type": "object", + "properties": { + "accountId": { + "description": "The CS RunAs account Id.", + "type": "string" + }, + "accountName": { + "description": "The CS RunAs account name.", + "type": "string" + } + } + }, + "ScriptActionTaskDetails": { + "description": "This class represents the script action task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "path": { + "description": "The path.", + "type": "string" + }, + "output": { + "description": "The output.", + "type": "string" + }, + "isPrimarySideScript": { + "description": "A value indicating whether it is a primary side script or not.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "ScriptActionTaskDetails" + }, + "SecurityProfileProperties": { + "description": "Security profile input.", + "type": "object", + "properties": { + "targetVmSecurityType": { + "description": "The target VM security type.", + "enum": [ + "None", + "TrustedLaunch", + "ConfidentialVM" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityType", + "modelAsString": true + } + }, + "targetVmSecureBoot": { + "$ref": "#/definitions/SecurityConfiguration", + "description": "A value indicating whether secure boot to be enabled." + }, + "targetVmTpm": { + "$ref": "#/definitions/SecurityConfiguration", + "description": "A value indicating whether trusted platform module to be enabled." + }, + "targetVmMonitoring": { + "$ref": "#/definitions/SecurityConfiguration", + "description": "A value indicating whether integrity monitoring to be enabled." + }, + "targetVmConfidentialEncryption": { + "$ref": "#/definitions/SecurityConfiguration", + "description": "A value indicating whether confidential compute encryption to be enabled." + } + } + }, + "ServiceError": { + "description": "ASR error model.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "activityId": { + "description": "Activity Id.", + "type": "string" + } + } + }, + "SharedDiskReplicationItemProperties": { + "description": "Shared Disk Replication item custom data details.", + "type": "object", + "properties": { + "protectionState": { + "description": "The protection state of shared disk.", + "type": "string" + }, + "testFailoverState": { + "description": "The tfo state of shared disk.", + "type": "string" + }, + "activeLocation": { + "description": "The Current active location of the PE.", + "type": "string" + }, + "allowedOperations": { + "description": "The allowed operations on the Replication protected item.", + "type": "array", + "items": { + "type": "string" + } + }, + "replicationHealth": { + "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.", + "type": "string" + }, + "healthErrors": { + "description": "List of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "x-ms-identifiers": [ + "errorCode" + ] + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario." + }, + "sharedDiskProviderSpecificDetails": { + "$ref": "#/definitions/SharedDiskReplicationProviderSpecificSettings", + "description": "The Replication provider custom settings." + } + } + }, + "SharedDiskReplicationProviderSpecificSettings": { + "description": "Replication provider specific settings.", + "type": "object", + "required": [ + "instanceType" + ], + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "IPConfigDetails": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "isPrimary": { + "type": "boolean" + }, + "subnetName": { + "type": "string" + }, + "staticIPAddress": { + "type": "string" + }, + "ipAddressType": { + "type": "string" + }, + "isSeletedForFailover": { + "type": "boolean" + }, + "recoverySubnetName": { + "type": "string" + }, + "recoveryStaticIPAddress": { + "type": "string" + }, + "recoveryIPAddressType": { + "type": "string" + }, + "recoveryPublicIPAddressId": { + "type": "string" + }, + "recoveryLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tfoSubnetName": { + "type": "string" + }, + "tfoStaticIPAddress": { + "type": "string" + }, + "tfoPublicIPAddressId": { + "type": "string" + }, + "tfoLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IPConfigInputDetails": { + "type": "object", + "properties": { + "ipConfigName": { + "type": "string" + }, + "isPrimary": { + "type": "boolean" + }, + "isSeletedForFailover": { + "type": "boolean" + }, + "recoverySubnetName": { + "type": "string" + }, + "recoveryStaticIPAddress": { + "type": "string" + }, + "recoveryPublicIPAddressId": { + "type": "string" + }, + "recoveryLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tfoSubnetName": { + "type": "string" + }, + "tfoStaticIPAddress": { + "type": "string" + }, + "tfoPublicIPAddressId": { + "type": "string" + }, + "tfoLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StorageAccountCustomDetails": { + "description": "Storage account custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "StorageClassification": { + "description": "Storage object definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageClassificationProperties", + "description": "Properties of the storage object." + } + } + }, + "StorageClassificationCollection": { + "description": "Collection of storage details.", + "type": "object", + "properties": { + "value": { + "description": "The storage details.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageClassification" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "StorageClassificationMapping": { + "description": "Storage mapping object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageClassificationMappingProperties", + "description": "Properties of the storage mapping object." + } + } + }, + "StorageClassificationMappingCollection": { + "description": "Collection of storage mapping details.", + "type": "object", + "properties": { + "value": { + "description": "The storage details.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageClassificationMapping" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "StorageClassificationMappingInput": { + "description": "Storage mapping input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/StorageMappingInputProperties", + "description": "Storage mapping input properties." + } + } + }, + "StorageClassificationMappingProperties": { + "description": "Storage mapping properties.", + "type": "object", + "properties": { + "targetStorageClassificationId": { + "description": "Target storage object Id.", + "type": "string" + } + } + }, + "StorageClassificationProperties": { + "description": "Storage object properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the Storage classification.", + "type": "string" + } + } + }, + "StorageMappingInputProperties": { + "description": "Storage mapping input properties.", + "type": "object", + "properties": { + "targetStorageClassificationId": { + "description": "The ID of the storage object.", + "type": "string" + } + } + }, + "Subnet": { + "description": "Subnets of the network.", + "type": "object", + "properties": { + "name": { + "description": "The subnet name.", + "type": "string" + }, + "friendlyName": { + "description": "The subnet friendly name.", + "type": "string" + }, + "addressList": { + "description": "The list of addresses for the subnet.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SupportedOperatingSystems": { + "description": "Supported operating systems.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportedOSProperties", + "description": "The supported operating systems properties." + } + } + }, + "SupportedOSDetails": { + "description": "Supported operating system details.", + "type": "object", + "properties": { + "osName": { + "description": "The name.", + "type": "string" + }, + "osType": { + "description": "The type.", + "type": "string" + }, + "osVersions": { + "description": "The list of version for operating system.", + "type": "array", + "items": { + "$ref": "#/definitions/OSVersionWrapper" + } + } + } + }, + "SupportedOSProperties": { + "description": "Supported operating systems properties.", + "type": "object", + "properties": { + "supportedOsList": { + "description": "The supported operating systems property list.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedOSProperty" + } + } + } + }, + "SupportedOSProperty": { + "description": "Supported operating systems property.", + "type": "object", + "properties": { + "instanceType": { + "description": "The replication provider type.", + "type": "string" + }, + "supportedOs": { + "description": "The list of supported operating systems.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedOSDetails" + } + } + } + }, + "SwitchClusterProtectionInput": { + "description": "Switch cluster protection input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SwitchClusterProtectionInputProperties", + "description": "Switch cluster protection properties." + } + } + }, + "SwitchClusterProtectionInputProperties": { + "description": "Switch cluster protection input properties.", + "type": "object", + "properties": { + "replicationProtectionClusterName": { + "description": "The unique replication protection cluster name.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/SwitchClusterProtectionProviderSpecificInput", + "description": "Provider specific switch protection input." + } + } + }, + "SwitchClusterProtectionProviderSpecificInput": { + "description": "Provider specific switch cluster protection input.", + "type": "object", + "required": [ + "instanceType" + ], + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "SwitchProtectionInput": { + "description": "Switch protection input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SwitchProtectionInputProperties", + "description": "Switch protection properties." + } + } + }, + "SwitchProtectionInputProperties": { + "description": "Switch protection input properties.", + "type": "object", + "properties": { + "replicationProtectedItemName": { + "description": "The unique replication protected item name.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/SwitchProtectionProviderSpecificInput", + "description": "Provider specific switch protection input." + } + } + }, + "SwitchProtectionJobDetails": { + "description": "This class represents details for switch protection job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "newReplicationProtectedItemId": { + "description": "ARM Id of the new replication protected item.", + "type": "string" + } + }, + "x-ms-discriminator-value": "SwitchProtectionJobDetails" + }, + "SwitchProtectionProviderSpecificInput": { + "description": "Provider specific switch protection input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "SwitchProviderInput": { + "description": "Input definition for switch provider.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SwitchProviderInputProperties", + "description": "Switch provider input properties." + } + } + }, + "SwitchProviderInputProperties": { + "description": "Input definition for switch provider input properties.", + "type": "object", + "properties": { + "targetInstanceType": { + "description": "Target provider type.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/SwitchProviderProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "SwitchProviderProviderSpecificInput": { + "description": "Provider specific switch provider input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TargetComputeSize": { + "description": "Represents applicable recovery vm sizes.", + "type": "object", + "properties": { + "id": { + "description": "The Id.", + "type": "string" + }, + "name": { + "description": "The name.", + "type": "string" + }, + "type": { + "description": "The Type of the object.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/TargetComputeSizeProperties", + "description": "The custom data." + } + } + }, + "TargetComputeSizeCollection": { + "description": "Target compute size collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of target compute sizes.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetComputeSize" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "TargetComputeSizeProperties": { + "description": "Represents applicable recovery vm sizes properties.", + "type": "object", + "properties": { + "name": { + "description": "Target compute size name.", + "type": "string" + }, + "friendlyName": { + "description": "Target compute size display name.", + "type": "string" + }, + "cpuCoresCount": { + "format": "int32", + "description": "The maximum cpu cores count supported by target compute size.", + "type": "integer" + }, + "vCPUsAvailable": { + "format": "int32", + "description": "The Available vCPUs supported by target compute size.", + "type": "integer", + "readOnly": true + }, + "memoryInGB": { + "format": "double", + "description": "The maximum memory in GB supported by target compute size.", + "type": "number" + }, + "maxDataDiskCount": { + "format": "int32", + "description": "The maximum data disks count supported by target compute size.", + "type": "integer" + }, + "maxNicsCount": { + "format": "int32", + "description": "The maximum Nics count supported by target compute size.", + "type": "integer" + }, + "errors": { + "description": "The reasons why the target compute size is not applicable for the protected item.", + "type": "array", + "items": { + "$ref": "#/definitions/ComputeSizeErrorDetails" + } + }, + "highIopsSupported": { + "description": "The value indicating whether the target compute size supports high Iops.", + "type": "string" + }, + "hyperVGenerations": { + "description": "The supported HyperV Generations.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TaskTypeDetails": { + "description": "Task details based on specific task type.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The type of task details.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TestFailoverCleanupInput": { + "description": "Input definition for test failover cleanup.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestFailoverCleanupInputProperties", + "description": "Test failover cleanup input properties." + } + } + }, + "TestFailoverCleanupInputProperties": { + "description": "Input definition for test failover cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test failover cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "TestFailoverInput": { + "description": "Input definition for test failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestFailoverInputProperties", + "description": "Test failover input properties." + } + } + }, + "TestFailoverInputProperties": { + "description": "Input definition for test failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Test failover direction.", + "type": "string" + }, + "networkType": { + "description": "Network type to be used for test failover.", + "type": "string" + }, + "networkId": { + "description": "The id of the network to be used for test failover.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/TestFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "TestFailoverJobDetails": { + "description": "This class represents the details for a test failover job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "testFailoverStatus": { + "description": "The test failover status.", + "type": "string" + }, + "comments": { + "description": "The test failover comments.", + "type": "string" + }, + "networkName": { + "description": "The test network name.", + "type": "string" + }, + "networkFriendlyName": { + "description": "The test network friendly name.", + "type": "string" + }, + "networkType": { + "description": "The test network type (see TestFailoverInput enum for possible values).", + "type": "string" + }, + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + } + } + }, + "x-ms-discriminator-value": "TestFailoverJobDetails" + }, + "TestFailoverProviderSpecificInput": { + "description": "Provider specific test failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TestMigrateCleanupInput": { + "description": "Input for test migrate cleanup.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateCleanupInputProperties", + "description": "Test migrate cleanup input properties." + } + } + }, + "TestMigrateCleanupInputProperties": { + "description": "Test migrate cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test migrate cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "TestMigrateInput": { + "description": "Input for test migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateInputProperties", + "description": "Test migrate input properties." + } + } + }, + "TestMigrateInputProperties": { + "description": "Test migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/TestMigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "TestMigrateProviderSpecificInput": { + "description": "Test migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UnplannedFailoverInput": { + "description": "Input definition for unplanned failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UnplannedFailoverInputProperties", + "description": "Unplanned failover input properties." + } + } + }, + "UnplannedFailoverInputProperties": { + "description": "Input definition for unplanned failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "sourceSiteOperations": { + "description": "Source site operations status.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "UnplannedFailoverProviderSpecificInput": { + "description": "Provider specific unplanned failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateApplianceForReplicationProtectedItemInput": { + "description": "Update appliance for replication protected item input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemInputProperties", + "description": "Update appliance replication protected item properties." + } + } + }, + "UpdateApplianceForReplicationProtectedItemInputProperties": { + "description": "Update appliance for protected item input properties.", + "required": [ + "targetApplianceId", + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "targetApplianceId": { + "description": "The target appliance Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput", + "description": "The provider specific input to update replication protected item." + } + } + }, + "UpdateApplianceForReplicationProtectedItemProviderSpecificInput": { + "description": "Update replication protected item provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateDiskInput": { + "description": "Disk input for update.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + } + } + }, + "UpdateMigrationItemInput": { + "description": "Update migration item input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateMigrationItemInputProperties", + "description": "Update migration item input properties." + } + } + }, + "UpdateMigrationItemInputProperties": { + "description": "Update migration item input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput", + "description": "The provider specific input to update migration item." + } + } + }, + "UpdateMigrationItemProviderSpecificInput": { + "description": "Update migration item provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateMobilityServiceRequest": { + "description": "Request to update the mobility service on a protected item.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateMobilityServiceRequestProperties", + "description": "The properties of the update mobility service request." + } + } + }, + "UpdateMobilityServiceRequestProperties": { + "description": "The properties of an update mobility service request.", + "type": "object", + "properties": { + "runAsAccountId": { + "description": "The CS run as account Id.", + "type": "string" + } + } + }, + "UpdateNetworkMappingInput": { + "description": "Update network mapping input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateNetworkMappingInputProperties", + "description": "The input properties needed to update network mapping." + } + } + }, + "UpdateNetworkMappingInputProperties": { + "description": "Common input details for network mapping operation.", + "type": "object", + "properties": { + "recoveryFabricName": { + "description": "Recovery fabric name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "Recovery network Id.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput", + "description": "Fabrics specific input network Id." + } + } + }, + "UpdatePolicyInput": { + "description": "Update policy input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdatePolicyInputProperties", + "description": "The ReplicationProviderSettings." + } + } + }, + "UpdatePolicyInputProperties": { + "description": "Policy update properties.", + "type": "object", + "properties": { + "replicationProviderSettings": { + "$ref": "#/definitions/PolicyProviderSpecificInput", + "description": "The ReplicationProviderSettings." + } + } + }, + "UpdateProtectionContainerMappingInput": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInputProperties", + "description": "Update protection container mapping input properties." + } + } + }, + "UpdateProtectionContainerMappingInputProperties": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput", + "description": "Provider specific input for updating protection container mapping." + } + } + }, + "UpdateRecoveryPlanInput": { + "description": "Update recovery plan input class.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateRecoveryPlanInputProperties", + "description": "Recovery plan update properties." + } + } + }, + "UpdateRecoveryPlanInputProperties": { + "description": "Recovery plan update properties.", + "type": "object", + "properties": { + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + } + } + }, + "UpdateReplicationProtectedItemInput": { + "description": "Update replication protected item input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateReplicationProtectedItemInputProperties", + "description": "Update replication protected item properties." + } + } + }, + "UpdateReplicationProtectedItemInputProperties": { + "description": "Update protected item input properties.", + "type": "object", + "properties": { + "recoveryAzureVMName": { + "description": "Target Azure VM name given by the user.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "Target Azure VM size.", + "type": "string" + }, + "selectedRecoveryAzureNetworkId": { + "description": "Target Azure Network Id.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The Azure Network Id for test failover.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "vmNics": { + "description": "The list of VM nic details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicInputDetails" + } + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "recoveryAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput", + "description": "The provider specific input to update replication protected item." + } + } + }, + "UpdateReplicationProtectedItemProviderInput": { + "description": "Update replication protected item provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateVCenterRequest": { + "description": "Input required to update vCenter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateVCenterRequestProperties", + "description": "The update VCenter Request Properties." + } + } + }, + "UpdateVCenterRequestProperties": { + "description": "The properties of an update vCenter request.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the vCenter.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter to be discovered.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id from where the update can be orchestrated.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id which has privileges to update the vCenter.", + "type": "string" + } + } + }, + "UserCreatedResourceTag": { + "description": "Resource tag input.", + "type": "object", + "properties": { + "tagName": { + "description": "The tag name. Please read for more information: https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources#limitations", + "maxLength": 512, + "type": "string" + }, + "tagValue": { + "description": "The tag value. Please read her for more information: https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources#limitations", + "maxLength": 256, + "type": "string" + } + } + }, + "VaultHealthDetails": { + "description": "Vault health details definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultHealthProperties", + "description": "The vault health related data." + } + } + }, + "VaultHealthProperties": { + "description": "class to define the health summary of the Vault.", + "type": "object", + "properties": { + "vaultErrors": { + "description": "The list of errors on the vault.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "protectedItemsHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the protected items in the vault." + }, + "fabricsHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the fabrics in the vault." + }, + "containersHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the containers in the vault." + } + } + }, + "VaultSetting": { + "description": "Vault setting.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultSettingProperties", + "description": "The vault setting properties." + } + } + }, + "VaultSettingCollection": { + "description": "Vault setting collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of vault setting.", + "type": "array", + "items": { + "$ref": "#/definitions/VaultSetting" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "VaultSettingCreationInput": { + "description": "Input to create vault setting.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/VaultSettingCreationInputProperties", + "description": "Vault setting creation input properties." + } + } + }, + "VaultSettingCreationInputProperties": { + "description": "Input to create vault setting.", + "type": "object", + "properties": { + "migrationSolutionId": { + "description": "The migration solution Id.", + "type": "string" + }, + "vmwareToAzureProviderType": { + "description": "VMware to Azure provider type.", + "type": "string" + } + } + }, + "VaultSettingProperties": { + "description": "Vault setting properties.", + "type": "object", + "properties": { + "migrationSolutionId": { + "description": "The migration solution ARM Id.", + "type": "string" + }, + "vmwareToAzureProviderType": { + "description": "VMware to Azure provider type.", + "type": "string" + } + } + }, + "VCenter": { + "description": "vCenter definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VCenterProperties", + "description": "VCenter related data." + } + } + }, + "VCenterCollection": { + "description": "Collection of vCenter details.", + "type": "object", + "properties": { + "value": { + "description": "The vCenter details.", + "type": "array", + "items": { + "$ref": "#/definitions/VCenter" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "VCenterProperties": { + "description": "vCenter properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the vCenter.", + "type": "string" + }, + "internalId": { + "description": "VCenter internal ID.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The time when the last heartbeat was received by vCenter.", + "type": "string" + }, + "discoveryStatus": { + "description": "The VCenter discovery status.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter.", + "type": "string" + }, + "infrastructureId": { + "description": "The infrastructure Id of vCenter.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The account Id which has privileges to discover the vCenter.", + "type": "string" + }, + "fabricArmResourceName": { + "description": "The ARM resource name of the fabric containing this VCenter.", + "type": "string" + }, + "healthErrors": { + "description": "The health errors for this VCenter.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + } + }, + "VersionDetails": { + "description": "Version related details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string" + }, + "expiryDate": { + "format": "date-time", + "description": "Version expiry date.", + "type": "string" + }, + "status": { + "description": "A value indicating whether security update required.", + "enum": [ + "Supported", + "NotSupported", + "Deprecated", + "UpdateRequired", + "SecurityUpdateRequired" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentVersionStatus", + "modelAsString": true + } + } + } + }, + "VirtualMachineTaskDetails": { + "description": "This class represents the virtual machine task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobTaskDetails" + } + ], + "properties": { + "skippedReason": { + "description": "The skipped reason.", + "type": "string" + }, + "skippedReasonString": { + "description": "The skipped reason string.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VirtualMachineTaskDetails" + }, + "VmmDetails": { + "description": "VMM fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VMM" + }, + "VmmToAzureCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to Vmm to Azure Network mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToAzureNetworkMappingSettings": { + "description": "E2A Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToAzureUpdateNetworkMappingInput": { + "description": "Update network mappings input properties/behavior specific to vmm to azure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToVmmCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to vmm to vmm Network mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmToVmmNetworkMappingSettings": { + "description": "E2E Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmToVmmUpdateNetworkMappingInput": { + "description": "Update network mappings input properties/behavior specific to vmm to vmm.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmVirtualMachineDetails": { + "description": "VMM fabric provider specific VM settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HyperVVirtualMachineDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmVirtualMachine" + }, + "VMNicDetails": { + "description": "Hyper V VM network details.", + "type": "object", + "properties": { + "nicId": { + "description": "The nic Id.", + "type": "string" + }, + "replicaNicId": { + "description": "The replica nic Id.", + "type": "string" + }, + "sourceNicArmId": { + "description": "The source nic ARM Id.", + "type": "string" + }, + "vMNetworkName": { + "description": "VM network name.", + "type": "string" + }, + "recoveryVMNetworkId": { + "description": "Recovery VM network Id.", + "type": "string" + }, + "ipConfigs": { + "description": "The IP configurations of the NIC.", + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigDetails" + } + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "recoveryNetworkSecurityGroupId": { + "description": "The id of the NSG associated with the NIC.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "A value indicating whether the NIC has accelerated networking enabled.", + "type": "boolean" + }, + "tfoVMNetworkId": { + "description": "The network to be used by NIC during test failover.", + "type": "string" + }, + "tfoNetworkSecurityGroupId": { + "description": "The NSG to be used by NIC during test failover.", + "type": "string" + }, + "enableAcceleratedNetworkingOnTfo": { + "description": "Whether the TFO NIC has accelerated networking enabled.", + "type": "boolean" + }, + "recoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs.", + "type": "string" + }, + "recoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs.", + "type": "string" + }, + "reuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.", + "type": "boolean", + "default": false + }, + "tfoRecoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoRecoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoReuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.", + "type": "boolean", + "default": false + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + } + } + }, + "VMNicInputDetails": { + "description": "Hyper V VM network input details.", + "type": "object", + "properties": { + "nicId": { + "description": "The nic Id.", + "type": "string" + }, + "ipConfigs": { + "description": "The IP configurations to be used by NIC during test failover and failover.", + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigInputDetails" + } + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "recoveryNetworkSecurityGroupId": { + "description": "The id of the NSG associated with the NIC.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "Whether the NIC has accelerated networking enabled.", + "type": "boolean" + }, + "tfoNetworkSecurityGroupId": { + "description": "The NSG to be used by NIC during test failover.", + "type": "string" + }, + "enableAcceleratedNetworkingOnTfo": { + "description": "Whether the test NIC has accelerated networking enabled.", + "type": "boolean" + }, + "recoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs.", + "type": "string" + }, + "recoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs.", + "type": "string" + }, + "reuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.", + "type": "boolean" + }, + "tfoNicName": { + "description": "The name of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoReuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.", + "type": "boolean" + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + } + } + }, + "VmNicUpdatesTaskDetails": { + "description": "This class represents the vm NicUpdates task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "vmId": { + "description": "Virtual machine Id.", + "type": "string" + }, + "nicId": { + "description": "Nic Id.", + "type": "string" + }, + "name": { + "description": "Name of the Nic.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VmNicUpdatesTaskDetails" + }, + "VMwareCbtContainerCreationInput": { + "description": "VMwareCbt container creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtContainerMappingInput": { + "description": "VMwareCbt container mapping input.", + "required": [ + "storageAccountId", + "targetLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string" + }, + "keyVaultUri": { + "description": "The target key vault URL.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string" + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string" + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtDiskInput": { + "description": "VMwareCbt disk input.", + "required": [ + "diskId", + "isOSDisk", + "logStorageAccountId", + "logStorageAccountSasSecretName" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "diskType": { + "$ref": "#/definitions/DiskAccountType" + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "sectorSizeInBytes": { + "format": "int32", + "description": "The logical sector size (in bytes), 512 by default.", + "type": "integer" + } + } + }, + "VMwareCbtEnableMigrationInput": { + "description": "VMwareCbt specific enable migration input.", + "required": [ + "vmwareMachineId", + "disksToInclude", + "dataMoverRunAsAccountId", + "snapshotRunAsAccountId", + "targetResourceGroupId", + "targetNetworkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtDiskInput" + } + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "linuxLicenseType": { + "description": "The license type for Linux VM's.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "LinuxServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LinuxLicenseType", + "modelAsString": true + } + }, + "performSqlBulkRegistration": { + "description": "A value indicating whether bulk SQL RP registration to be done.", + "type": "string" + }, + "dataMoverRunAsAccountId": { + "description": "The data mover run as account Id.", + "type": "string" + }, + "snapshotRunAsAccountId": { + "description": "The snapshot run as account Id.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The selected test network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "The selected test subnet name.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group ARM Id.", + "type": "string" + }, + "confidentialVmKeyVaultId": { + "description": "The confidential VM key vault Id for ADE installation.", + "type": "string" + }, + "targetVmSecurityProfile": { + "$ref": "#/definitions/VMwareCbtSecurityProfileProperties", + "description": "The target VM security profile." + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedDiskTags": { + "description": "The tags for the seed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "userSelectedOSName": { + "description": "The OS name selected by user.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtEventDetails": { + "description": "Event details for VMwareCbt provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "migrationItemName": { + "description": "The migration item name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrateInput": { + "description": "VMwareCbt specific migrate input.", + "required": [ + "performShutdown", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrateProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + }, + "postMigrationSteps": { + "description": "The managed run command script input.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRunCommandScriptInput" + }, + "x-ms-identifiers": [ + "stepName" + ] + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrationDetails": { + "description": "VMwareCbt provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrationProviderSpecificSettings" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "The name of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type.", + "type": "string", + "readOnly": true + }, + "targetGeneration": { + "description": "The target generation.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "linuxLicenseType": { + "description": "The license type for Linux VM's.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "LinuxServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LinuxLicenseType", + "modelAsString": true + } + }, + "dataMoverRunAsAccountId": { + "description": "The data mover run as account Id.", + "type": "string", + "readOnly": true + }, + "snapshotRunAsAccountId": { + "description": "The snapshot run as account Id.", + "type": "string", + "readOnly": true + }, + "storageAccountId": { + "description": "The replication storage account ARM Id. This is applicable only for the blob based replication test hook.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "Target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true + }, + "targetResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "confidentialVmKeyVaultId": { + "description": "The confidential VM key vault Id for ADE installation.", + "type": "string" + }, + "targetVmSecurityProfile": { + "$ref": "#/definitions/VMwareCbtSecurityProfileProperties", + "description": "The target VM security profile." + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtProtectedDiskDetails" + } + }, + "targetNetworkId": { + "description": "The target network Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network Id.", + "type": "string" + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicDetails" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "migrationRecoveryPointId": { + "description": "The recovery point Id to which the VM was migrated.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointId": { + "description": "The last recovery point Id.", + "type": "string", + "readOnly": true + }, + "initialSeedingProgressPercentage": { + "format": "int32", + "description": "The initial seeding progress percentage.", + "type": "integer", + "readOnly": true + }, + "migrationProgressPercentage": { + "format": "int32", + "description": "The migration progress percentage.", + "type": "integer", + "readOnly": true + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer", + "readOnly": true + }, + "resumeProgressPercentage": { + "format": "int32", + "description": "The resume progress percentage.", + "type": "integer", + "readOnly": true + }, + "deltaSyncProgressPercentage": { + "format": "int32", + "description": "The delta sync progress percentage.", + "type": "integer", + "readOnly": true + }, + "isCheckSumResyncCycle": { + "description": "A value indicating whether checksum resync cycle is in progress.", + "type": "string", + "readOnly": true + }, + "initialSeedingRetryCount": { + "format": "int64", + "description": "The initial seeding retry count.", + "type": "integer", + "readOnly": true + }, + "resyncRetryCount": { + "format": "int64", + "description": "The resync retry count.", + "type": "integer", + "readOnly": true + }, + "resumeRetryCount": { + "format": "int64", + "description": "The resume retry count.", + "type": "integer", + "readOnly": true + }, + "deltaSyncRetryCount": { + "format": "int64", + "description": "The delta sync retry count.", + "type": "integer", + "readOnly": true + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "seedDiskTags": { + "description": "The tags for the seed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "supportedOSVersions": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "array", + "items": { + "type": "string" + } + }, + "applianceMonitoringDetails": { + "$ref": "#/definitions/ApplianceMonitoringDetails", + "description": "A value indicating the appliance monitoring details.", + "readOnly": true + }, + "gatewayOperationDetails": { + "$ref": "#/definitions/GatewayOperationDetails", + "description": "A value indicating the gateway operation details.", + "readOnly": true + }, + "operationName": { + "description": "A value indicating the SRS operation name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtNicDetails": { + "description": "VMwareCbt NIC details.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string", + "readOnly": true + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", + "type": "string" + }, + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "testNetworkId": { + "description": "Source network Id.", + "type": "string" + }, + "testSubnetName": { + "description": "Test subnet name.", + "type": "string" + }, + "testIPAddress": { + "description": "The test IP address.", + "type": "string" + }, + "testIPAddressType": { + "description": "The test IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + }, + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", + "type": "string" + } + } + }, + "VMwareCbtNicInput": { + "description": "VMwareCbt NIC input.", + "required": [ + "nicId", + "isPrimaryNic" + ], + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string" + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The static IP address.", + "type": "string" + }, + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", + "type": "string" + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + }, + "testSubnetName": { + "description": "The test subnet name.", + "type": "string" + }, + "testStaticIPAddress": { + "description": "The test static IP address.", + "type": "string" + } + } + }, + "VMwareCbtPolicyCreationInput": { + "description": "VMware Cbt policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VmwareCbtPolicyDetails": { + "description": "VMware Cbt specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtProtectedDiskDetails": { + "description": "VMwareCbt protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "diskType": { + "$ref": "#/definitions/DiskAccountType" + }, + "diskPath": { + "description": "The disk path.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string", + "readOnly": true + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "seedBlobUri": { + "description": "The uri of the seed blob.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "targetBlobUri": { + "description": "The uri of the target blob.", + "type": "string", + "readOnly": true + }, + "targetDiskName": { + "description": "The name for the target managed disk.", + "type": "string" + }, + "gatewayOperationDetails": { + "$ref": "#/definitions/GatewayOperationDetails", + "description": "A value indicating the gateway operation details.", + "readOnly": true + }, + "sectorSizeInBytes": { + "format": "int32", + "description": "The logical sector size (in bytes), 512 by default.", + "type": "integer" + } + } + }, + "VMwareCbtProtectionContainerMappingDetails": { + "description": "VMwareCbt provider specific container mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string", + "readOnly": true + }, + "keyVaultUri": { + "description": "The target key vault URI.", + "type": "string", + "readOnly": true + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string", + "readOnly": true + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string", + "readOnly": true + }, + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true + }, + "roleSizeToNicCountMap": { + "description": "The role size to NIC count map.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "excludedSkus": { + "description": "The SKUs to be excluded.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtResumeReplicationInput": { + "description": "VMwareCbt specific resume replication input.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResumeReplicationProviderSpecificInput" + } + ], + "properties": { + "deleteMigrationResources": { + "description": "A value indicating whether Migration resources to be deleted.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtResyncInput": { + "description": "VMwareCbt specific resync input.", + "required": [ + "skipCbtReset", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResyncProviderSpecificInput" + } + ], + "properties": { + "skipCbtReset": { + "description": "A value indicating whether CBT is to be reset.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtSecurityProfileProperties": { + "description": "VMwareCbt security profile input.", + "type": "object", + "properties": { + "targetVmSecurityType": { + "description": "The target VM security type.", + "enum": [ + "None", + "TrustedLaunch", + "ConfidentialVM" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityType", + "modelAsString": true + } + }, + "isTargetVmSecureBootEnabled": { + "description": "A value indicating whether secure boot to be enabled.", + "type": "string" + }, + "isTargetVmTpmEnabled": { + "description": "A value indicating whether trusted platform module to be enabled.", + "type": "string" + }, + "isTargetVmIntegrityMonitoringEnabled": { + "description": "A value indicating whether integrity monitoring to be enabled.", + "type": "string" + }, + "isTargetVmConfidentialEncryptionEnabled": { + "description": "A value indicating whether confidential compute encryption to be enabled.", + "type": "string" + } + } + }, + "VMwareCbtTestMigrateInput": { + "description": "VMwareCbt specific test migrate input.", + "required": [ + "recoveryPointId", + "networkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestMigrateProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "networkId": { + "description": "The test network Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicInput" + }, + "x-ms-identifiers": [] + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + }, + "postMigrationSteps": { + "description": "The managed run command script input.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRunCommandScriptInput" + }, + "x-ms-identifiers": [ + "stepName" + ] + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtUpdateDiskInput": { + "description": "VMwareCbt disk input for update.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string" + } + } + }, + "VMwareCbtUpdateMigrationItemInput": { + "description": "VMwareCbt specific update migration item input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group ARM Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicInput" + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtUpdateDiskInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "linuxLicenseType": { + "description": "The license type for Linux VM's.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "LinuxServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LinuxLicenseType", + "modelAsString": true + } + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareDetails": { + "description": "Store the fabric details specific to the VMware fabric.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "processServers": { + "description": "The list of Process Servers associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServer" + } + }, + "masterTargetServers": { + "description": "The list of Master Target servers associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/MasterTargetServer" + } + }, + "runAsAccounts": { + "description": "The list of run as accounts created on the server.", + "type": "array", + "items": { + "$ref": "#/definitions/RunAsAccount" + } + }, + "replicationPairCount": { + "description": "The number of replication pairs configured in this CS.", + "type": "string" + }, + "processServerCount": { + "description": "The number of process servers.", + "type": "string" + }, + "agentCount": { + "description": "The number of source and target servers configured to talk to this CS.", + "type": "string" + }, + "protectedServers": { + "description": "The number of protected servers.", + "type": "string" + }, + "systemLoad": { + "description": "The percentage of the system load.", + "type": "string" + }, + "systemLoadStatus": { + "description": "The system load status.", + "type": "string" + }, + "cpuLoad": { + "description": "The percentage of the CPU load.", + "type": "string" + }, + "cpuLoadStatus": { + "description": "The CPU load status.", + "type": "string" + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer" + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer" + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "type": "string" + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total space.", + "type": "integer" + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available space.", + "type": "integer" + }, + "spaceUsageStatus": { + "description": "The space usage status.", + "type": "string" + }, + "webLoad": { + "description": "The web load.", + "type": "string" + }, + "webLoadStatus": { + "description": "The web load status.", + "type": "string" + }, + "databaseServerLoad": { + "description": "The database server load.", + "type": "string" + }, + "databaseServerLoadStatus": { + "description": "The database server load status.", + "type": "string" + }, + "csServiceStatus": { + "description": "The CS service status.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address.", + "type": "string" + }, + "agentVersion": { + "description": "The agent Version.", + "type": "string" + }, + "hostName": { + "description": "The host name.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from CS server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "sslCertExpiryDate": { + "format": "date-time", + "description": "CS SSL cert expiry date.", + "type": "string" + }, + "sslCertExpiryRemainingDays": { + "format": "int32", + "description": "CS SSL cert expiry date.", + "type": "integer" + }, + "psTemplateVersion": { + "description": "PS template version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The agent version details." + }, + "switchProviderBlockingErrorDetails": { + "description": "The switch provider blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageFabricSwitchProviderBlockingErrorDetails" + } + } + }, + "x-ms-discriminator-value": "VMware" + }, + "VMwareV2FabricCreationInput": { + "description": "VMwareV2 fabric provider specific settings.", + "required": [ + "migrationSolutionId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string" + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string" + }, + "migrationSolutionId": { + "description": "The ARM Id of the migration solution.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareV2" + }, + "VMwareV2FabricSpecificDetails": { + "description": "VMwareV2 fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string", + "readOnly": true + }, + "migrationSolutionId": { + "description": "The Migration solution ARM Id.", + "type": "string", + "readOnly": true + }, + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true + }, + "serviceResourceId": { + "description": "The service resource Id.", + "type": "string", + "readOnly": true + }, + "serviceContainerId": { + "description": "The service container Id.", + "type": "string", + "readOnly": true + }, + "processServers": { + "description": "The list of process servers.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServerDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareV2" + }, + "VMwareVirtualMachineDetails": { + "description": "VMware provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": { + "agentGeneratedId": { + "description": "The ID generated by the InMage agent after it gets installed on guest. This is the ID to be used during InMage CreateProtection.", + "type": "string" + }, + "agentInstalled": { + "description": "The value indicating if InMage scout agent is installed on guest.", + "type": "string" + }, + "osType": { + "description": "The OsType installed on VM.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address.", + "type": "string" + }, + "poweredOn": { + "description": "The value indicating whether VM is powered on.", + "type": "string" + }, + "vCenterInfrastructureId": { + "description": "The VCenter infrastructure Id.", + "type": "string" + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", + "type": "string" + }, + "diskDetails": { + "description": "The disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageDiskDetails" + } + }, + "validationErrors": { + "description": "The validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + }, + "x-ms-discriminator-value": "VMwareVirtualMachine" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + }, + "FabricName": { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + "ProtectionContainerName": { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + "ReplicationProtectionClusterName": { + "name": "replicationProtectionClusterName", + "in": "path", + "description": "Replication protection cluster name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.md b/specification/recoveryservicessiterecovery/resource-manager/readme.md index 40f68642dea2..aa60de9f2b30 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.md @@ -63,7 +63,7 @@ These are the global settings for the RecoveryServicesSiteRecovery API. ``` yaml openapi-type: arm -tag: package-2024-02 +tag: package-2024-04 directive: - where: - $.paths @@ -72,6 +72,15 @@ directive: ``` +### Tag: package-2024-04 + +These settings apply only when `--tag=package-2024-04` is specified on the command line. + +```yaml $(tag) == 'package-2024-04' +input-file: + - Microsoft.RecoveryServices/stable/2024-04-01/service.json +``` + ### Tag: package-2024-02 These settings apply only when `--tag=package-2024-02` is specified on the command line. From e9f47ec88eb06646c53f2a561f3b27434ac5ac57 Mon Sep 17 00:00:00 2001 From: v-maksymm <161892853+v-maksymm@users.noreply.github.com> Date: Mon, 10 Jun 2024 23:54:58 -0700 Subject: [PATCH 152/343] Oracle.Database. Typespec preview introduced (#29305) * Oracle.Database. Typespec preview introduced * Oracle.Database. Added systemversionname to cSpell.json * Oracle.Database. Rolled back readme files * Oracle.Database. Fixed DbNodes_listByParent operationId incosistency * Oracle.Database. Added options for sdk emitters --- cSpell.json | 6 + .../autonomousDatabaseBackup_create.json | 71 + .../autonomousDatabaseBackup_delete.json | 20 + .../autonomousDatabaseBackup_get.json | 37 + ...autonomousDatabaseBackup_listByParent.json | 40 + .../autonomousDatabaseBackup_patch.json | 41 + .../autonomousDatabaseCharacterSet_get.json | 21 + ...usDatabaseCharacterSet_listByLocation.json | 32 + .../autonomousDatabaseClone_create.json | 141 ++ ...omousDatabaseNationalCharacterSet_get.json | 21 + ...seNationalCharacterSet_listByLocation.json | 25 + .../autonomousDatabaseVersion_get.json | 21 + ...onomousDatabaseVersion_listByLocation.json | 25 + .../autonomousDatabase_create.json | 136 ++ .../autonomousDatabase_delete.json | 19 + .../autonomousDatabase_failover.json | 90 ++ .../autonomousDatabase_generateWallet.json | 25 + .../autonomousDatabase_get.json | 63 + ...utonomousDatabase_listByResourceGroup.json | 67 + ...autonomousDatabase_listBySubscription.json | 66 + .../autonomousDatabase_patch.json | 73 + .../autonomousDatabase_restore.json | 80 + .../autonomousDatabase_shrink.json | 77 + .../autonomousDatabase_switchover.json | 89 ++ .../2023-09-01-preview/dbNodes_action.json | 50 + .../2023-09-01-preview/dbNodes_get.json | 41 + .../dbNodes_listByParent.json | 45 + .../2023-09-01-preview/dbServers_get.json | 42 + .../dbServers_listByParent.json | 46 + .../dbSystemShapes_get.json | 40 + .../dbSystemShapes_listByLocation.json | 44 + .../dnsPrivateViews_get.json | 27 + .../dnsPrivateViews_listByLocation.json | 44 + .../dnsPrivateZones_get.json | 29 + .../dnsPrivateZones_listByLocation.json | 48 + .../exaInfra_addStorageCapacity.json | 95 ++ .../2023-09-01-preview/exaInfra_create.json | 184 +++ .../2023-09-01-preview/exaInfra_delete.json | 19 + .../2023-09-01-preview/exaInfra_get.json | 89 ++ .../exaInfra_listByResourceGroup.json | 93 ++ .../exaInfra_listBySubscription.json | 92 ++ .../2023-09-01-preview/exaInfra_patch.json | 102 ++ .../2023-09-01-preview/giVersions_get.json | 21 + .../giVersions_listByLocation.json | 25 + .../2023-09-01-preview/operations_list.json | 25 + .../oracleSubscriptions_create.json | 56 + .../oracleSubscriptions_delete.json | 17 + .../oracleSubscriptions_get.json | 29 + ...acleSubscriptions_listActivationLinks.json | 22 + ...racleSubscriptions_listBySubscription.json | 34 + ...Subscriptions_listCloudAccountDetails.json | 22 + ...criptions_listSaasSubscriptionDetails.json | 32 + .../oracleSubscriptions_patch.json | 43 + .../systemVersions_get.json | 20 + .../systemVersions_listByLocation.json | 24 + .../virtualNetworkAddresses_create.json | 48 + .../virtualNetworkAddresses_delete.json | 20 + .../virtualNetworkAddresses_get.json | 29 + .../virtualNetworkAddresses_listByParent.json | 33 + .../2023-09-01-preview/vmClusters_addVms.json | 102 ++ .../2023-09-01-preview/vmClusters_create.json | 224 +++ .../2023-09-01-preview/vmClusters_delete.json | 19 + .../2023-09-01-preview/vmClusters_get.json | 104 ++ .../vmClusters_listByResourceGroup.json | 95 ++ .../vmClusters_listBySubscription.json | 94 ++ .../vmClusters_listPrivateIpAddresses.json | 27 + .../2023-09-01-preview/vmClusters_patch.json | 101 ++ .../vmClusters_removeVms.json | 102 ++ specification/oracle/Oracle.Database/main.tsp | 40 + .../autonomousDatabaseBackupOperations.tsp | 43 + ...tonomousDatabaseCharacterSetOperations.tsp | 20 + ...DatabaseNationalCharacterSetOperations.tsp | 20 + .../autonomousDatabaseOperations.tsp | 102 ++ .../autonomousDatabaseVersionOperations.tsp | 21 + .../Oracle.Database/operations/commons.tsp | 72 + .../operations/exadata/dbNodesOperations.tsp | 24 + .../exadata/dbServersOperations.tsp | 22 + .../exadata/dbSystemShapeOperations.tsp | 18 + .../exadata/dnsPrivateViewsOperations.tsp | 18 + .../exadata/dnsPrivateZonesOperations.tsp | 18 + .../exadatainfrastructureOperations.tsp | 51 + .../exadata/giVersionOperations.tsp | 18 + .../exadata/systemVersionOperations.tsp | 19 + .../virtualNetworkAddressOperations.tsp | 35 + .../exadata/vmclusterOperations.tsp | 64 + .../oracleSubscriptionOperations.tsp | 80 + .../oracle/Oracle.Database/tspconfig.yaml | 29 + .../oracle/Oracle.Database/versions.tsp | 11 + .../models/autonomousdatabase/adbCommon.tsp | 19 + .../autonomousdatabase/autonomousDatabase.tsp | 982 ++++++++++++ .../autonomousDatabaseBackup.tsp | 133 ++ .../autonomousDatabaseCharacterSet.tsp | 30 + ...autonomousDatabaseNationalCharacterSet.tsp | 30 + .../autonomousDatabaseVersion.tsp | 50 + specification/oracle/models/common.tsp | 203 +++ .../oracle/models/exadata/dbNodes.tsp | 179 +++ .../oracle/models/exadata/dbServers.tsp | 167 ++ .../oracle/models/exadata/dbSystemShapes.tsp | 102 ++ .../oracle/models/exadata/dnsPrivateViews.tsp | 70 + .../oracle/models/exadata/dnsPrivateZones.tsp | 94 ++ .../oracle/models/exadata/exadatainfra.tsp | 269 ++++ .../oracle/models/exadata/giVersions.tsp | 26 + .../models/exadata/privateIpAddresses.tsp | 35 + .../oracle/models/exadata/systemVersions.tsp | 36 + .../models/exadata/virtualNetworkAddress.tsp | 84 + .../oracle/models/exadata/vmcluster.tsp | 396 +++++ .../oraclesubscription/oracleSubscription.tsp | 177 +++ .../autonomousDatabaseBackup_create.json | 28 +- .../autonomousDatabaseBackup_delete.json | 4 +- .../autonomousDatabaseBackup_get.json | 17 +- ...autonomousDatabaseBackup_listByParent.json | 16 +- .../autonomousDatabaseBackup_patch.json | 16 +- .../autonomousDatabaseClone_create.json | 2 +- .../examples/autonomousDatabase_create.json | 2 +- .../examples/autonomousDatabase_restore.json | 80 + .../examples/autonomousDatabase_shrink.json | 77 + .../examples/dbNodes_listByParent.json | 4 +- .../examples/systemVersions_get.json | 20 + .../systemVersions_listByLocation.json | 24 + .../preview/2023-09-01-preview/openapi.json | 1376 ++++++++++++----- specification/oracle/suppressions.yaml | 3 - 121 files changed, 8790 insertions(+), 470 deletions(-) create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseClone_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_failover.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_generateWallet.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_restore.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_shrink.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_switchover.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_action.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_addStorageCapacity.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/operations_list.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listActivationLinks.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listCloudAccountDetails.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_addVms.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listPrivateIpAddresses.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_removeVms.json create mode 100644 specification/oracle/Oracle.Database/main.tsp create mode 100644 specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/commons.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/dbNodesOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/dbServersOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/dbSystemShapeOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/dnsPrivateViewsOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/dnsPrivateZonesOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/exadatainfrastructureOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/giVersionOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/systemVersionOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/virtualNetworkAddressOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/exadata/vmclusterOperations.tsp create mode 100644 specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp create mode 100644 specification/oracle/Oracle.Database/tspconfig.yaml create mode 100644 specification/oracle/Oracle.Database/versions.tsp create mode 100644 specification/oracle/models/autonomousdatabase/adbCommon.tsp create mode 100644 specification/oracle/models/autonomousdatabase/autonomousDatabase.tsp create mode 100644 specification/oracle/models/autonomousdatabase/autonomousDatabaseBackup.tsp create mode 100644 specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp create mode 100644 specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp create mode 100644 specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp create mode 100644 specification/oracle/models/common.tsp create mode 100644 specification/oracle/models/exadata/dbNodes.tsp create mode 100644 specification/oracle/models/exadata/dbServers.tsp create mode 100644 specification/oracle/models/exadata/dbSystemShapes.tsp create mode 100644 specification/oracle/models/exadata/dnsPrivateViews.tsp create mode 100644 specification/oracle/models/exadata/dnsPrivateZones.tsp create mode 100644 specification/oracle/models/exadata/exadatainfra.tsp create mode 100644 specification/oracle/models/exadata/giVersions.tsp create mode 100644 specification/oracle/models/exadata/privateIpAddresses.tsp create mode 100644 specification/oracle/models/exadata/systemVersions.tsp create mode 100644 specification/oracle/models/exadata/virtualNetworkAddress.tsp create mode 100644 specification/oracle/models/exadata/vmcluster.tsp create mode 100644 specification/oracle/models/oraclesubscription/oracleSubscription.tsp create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_restore.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_shrink.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/systemVersions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/systemVersions_listByLocation.json delete mode 100644 specification/oracle/suppressions.yaml diff --git a/cSpell.json b/cSpell.json index bf6503e69ecf..016c6a42c54b 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1332,6 +1332,12 @@ "Unhold", "transferor's" ] + }, + { + "filename": "**/specification/oracle/resource-manager/Oracle.Database/**/*.json", + "words": [ + "systemversionname" + ] } ], "enableFiletypes": [ diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..be930819f8cc --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..57eb4f861cfe --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..b1fae97c1bd6 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_listByParent.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..4ebe52f4191c --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..c1c4a32ec58c --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..48ed1d27bc6a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..3a2e0bd2ebfb --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseClone_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..7046e1177614 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..f9f6a9fc1db7 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..bd21f832616a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..4af807342ed2 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..62d77ad126b9 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_create.json new file mode 100644 index 000000000000..18862f95d313 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_delete.json new file mode 100644 index 000000000000..75a2a168ed15 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_failover.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_failover.json new file mode 100644 index 000000000000..6372bac80b72 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_generateWallet.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..f40c03f51d16 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_get.json new file mode 100644 index 000000000000..bbddccbc654a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..286dc9d862b1 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..197d047a6ad5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_patch.json new file mode 100644 index 000000000000..bb2da07ae025 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_restore.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_restore.json new file mode 100644 index 000000000000..6ad6cbccc9e3 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_shrink.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..47e5b0aca287 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_switchover.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..3d7b2f4e4822 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_action.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_action.json new file mode 100644 index 000000000000..37863366d8c0 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_get.json new file mode 100644 index 000000000000..505022eb89aa --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_listByParent.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_listByParent.json new file mode 100644 index 000000000000..8599aa52b6e6 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_get.json new file mode 100644 index 000000000000..3c27e71aad9e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_listByParent.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_listByParent.json new file mode 100644 index 000000000000..9473e254c85b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_get.json new file mode 100644 index 000000000000..bb0bc5a7cdfc --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..24d821e42829 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_get.json new file mode 100644 index 000000000000..f0be492fc661 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..809a370e806b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_get.json new file mode 100644 index 000000000000..d79d214d7b2a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..f0909b5e1841 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_addStorageCapacity.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..3d04a8453244 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_create.json new file mode 100644 index 000000000000..f7699d0b8f66 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_delete.json new file mode 100644 index 000000000000..1a603b9757e7 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_get.json new file mode 100644 index 000000000000..43d9d881581e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..26bf4cbe7adf --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..e734d16fcdee --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_patch.json new file mode 100644 index 000000000000..0d416f6de7e5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_get.json new file mode 100644 index 000000000000..6179e07cd607 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_listByLocation.json new file mode 100644 index 000000000000..3fa00083d048 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/operations_list.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/operations_list.json new file mode 100644 index 000000000000..1b7dcaa8a17a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2023-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_create.json new file mode 100644 index 000000000000..9c2c825bbd1a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..8cbd3f41ad03 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_get.json new file mode 100644 index 000000000000..2e9ab0c177bf --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listActivationLinks.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..0a64b6a1434e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..241c0939cd74 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..25cb82413da0 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..a4a6c030dbf2 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..bb6419ded628 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_get.json new file mode 100644 index 000000000000..c4313c80653d --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_listByLocation.json new file mode 100644 index 000000000000..82998fab4b3a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..18fb92433686 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..0d618107426e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..d9ddb1b2ee39 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_listByParent.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..72a9e47fa4dc --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_addVms.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_addVms.json new file mode 100644 index 000000000000..a57af269ee8b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_create.json new file mode 100644 index 000000000000..647a5a79dbe9 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_delete.json new file mode 100644 index 000000000000..733197e4a5b2 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_get.json new file mode 100644 index 000000000000..af68d767155d --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..234dd768ca1e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..13a02f4821e1 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listPrivateIpAddresses.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..f20c1e0c29f8 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_patch.json new file mode 100644 index 000000000000..9f03443f90ca --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_removeVms.json b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_removeVms.json new file mode 100644 index 000000000000..2c4e837e5be3 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/main.tsp b/specification/oracle/Oracle.Database/main.tsp new file mode 100644 index 000000000000..616a085c1a96 --- /dev/null +++ b/specification/oracle/Oracle.Database/main.tsp @@ -0,0 +1,40 @@ +import "./operations/exadata/exadatainfrastructureOperations.tsp"; +import "./operations/exadata/dbServersOperations.tsp"; +import "./operations/exadata/vmclusterOperations.tsp"; +import "./operations/exadata/virtualNetworkAddressOperations.tsp"; +import "./operations/exadata/systemVersionOperations.tsp"; +import "./operations/oraclesubscription/oracleSubscriptionOperations.tsp"; +import "./operations/exadata/dbNodesOperations.tsp"; +import "./operations/exadata/giVersionOperations.tsp"; +import "./operations/exadata/dbSystemShapeOperations.tsp"; +import "./operations/exadata/dnsPrivateViewsOperations.tsp"; +import "./operations/exadata/dnsPrivateZonesOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp"; + +import "./versions.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using OpenAPI; +using Autorest; + +@armProviderNamespace +@service({ + title: "Oracle Database Resource Manager", +}) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +@versioned(Oracle.Database.Versions) +namespace Oracle.Database; + +interface Operations extends Azure.ResourceManager.Operations {} + +@@example(Operations.list, + "./examples/operations_list.json", + "List Operations" +); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp new file mode 100644 index 000000000000..b7a0bde9287d --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp @@ -0,0 +1,43 @@ +import "../../../models/autonomousdatabase/autonomousDatabaseBackup.tsp"; +import "../commons.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations(AutonomousDatabaseBackup) +interface AutonomousDatabaseBackups + extends OracleChildResource< + AutonomousDatabaseBackup, + AutonomousDatabaseBackupProperties + > { + @example( + "./examples/autonomousDatabaseBackup_patch.json", + "Patch Autonomous Database Backup." + ) + update is ArmResourcePatchAsync< + AutonomousDatabaseBackup, + AutonomousDatabaseBackupProperties + >; + + @example( + "./examples/autonomousDatabaseBackup_listByParent.json", + "List Autonomous Database Backups by Autonomous Database." + ) + listByParent is ArmResourceListByParent; +} + +@@example(AutonomousDatabaseBackups.createOrUpdate, + "./examples/autonomousDatabaseBackup_create.json", + "Create Autonomous Database Backup." +); +@@example(AutonomousDatabaseBackups.get, + "./examples/autonomousDatabaseBackup_get.json", + "Get Autonomous Database Backup." +); +@@example(AutonomousDatabaseBackups.delete, + "./examples/autonomousDatabaseBackup_delete.json", + "Delete Autonomous Database Backup." +); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp new file mode 100644 index 000000000000..e08e8e50f1c6 --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp @@ -0,0 +1,20 @@ +import "../../../models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface AutonomousDatabaseCharacterSets + extends OracleLocationBasedResource {} + +@@example(AutonomousDatabaseCharacterSets.listByLocation, + "./examples/autonomousDatabaseCharacterSet_listByLocation.json", + "List autonomous db character sets by location" +); +@@example(AutonomousDatabaseCharacterSets.get, + "./examples/autonomousDatabaseCharacterSet_get.json", + "Get autonomous db character set" +); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp new file mode 100644 index 000000000000..68265c9e2271 --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp @@ -0,0 +1,20 @@ +import "../../../models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface AutonomousDatabaseNationalCharacterSets + extends OracleLocationBasedResource {} + +@@example(AutonomousDatabaseNationalCharacterSets.listByLocation, + "./examples/autonomousDatabaseNationalCharacterSet_listByLocation.json", + "List autonomous db national character sets by location" +); +@@example(AutonomousDatabaseNationalCharacterSets.get, + "./examples/autonomousDatabaseNationalCharacterSet_get.json", + "Get autonomous db national character set" +); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseOperations.tsp b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseOperations.tsp new file mode 100644 index 000000000000..904388c44365 --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseOperations.tsp @@ -0,0 +1,102 @@ +import "../../../models/autonomousdatabase/autonomousDatabase.tsp"; +import "../commons.tsp"; + +using Azure.ResourceManager; +using Autorest; +namespace Oracle.Database; + +@armResourceOperations(AutonomousDatabase) +interface AutonomousDatabases + extends OracleTrackedResource< + AutonomousDatabase, + AutonomousDatabaseBaseProperties + > { + //OCI switchover API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/SwitchoverAutonomousDatabase + @doc("Perform switchover action on Autonomous Database") + @example( + "./examples/autonomousDatabase_switchover.json", + "Perform switchover action on Autonomous Database" + ) + switchover is ArmResourceActionAsync< + AutonomousDatabase, + PeerDbDetails, + AutonomousDatabase + >; + + //OCI failover API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/FailOverAutonomousDatabase + @doc("Perform failover action on Autonomous Database") + @example( + "./examples/autonomousDatabase_failover.json", + "Perform failover action on Autonomous Database" + ) + failover is ArmResourceActionAsync< + AutonomousDatabase, + PeerDbDetails, + AutonomousDatabase + >; + + //OCI generate wallet API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/GenerateAutonomousDatabaseWallet + @doc("Generate wallet action on Autonomous Database") + @example( + "./examples/autonomousDatabase_generateWallet.json", + "Generate wallet action on Autonomous Database" + ) + generateWallet is ArmResourceActionSync< + AutonomousDatabase, + GenerateAutonomousDatabaseWalletDetails, + AutonomousDatabaseWalletFile + >; + + //OCI RestoreAutonomousDatabase API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/RestoreAutonomousDatabase + @doc("Restores an Autonomous Database based on the provided request parameters.") + @example( + "./examples/autonomousDatabase_restore.json", + "Perform restore action on Autonomous Database" + ) + restore is ArmResourceActionAsync< + AutonomousDatabase, + RestoreAutonomousDatabaseDetails, + AutonomousDatabase + >; + + //OCI ShrinkAutonomousDatabase API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ShrinkAutonomousDatabase + @doc("This operation shrinks the current allocated storage down to the current actual used data storage.") + @example( + "./examples/autonomousDatabase_shrink.json", + "Perform shrink action on Autonomous Database" + ) + shrink is ArmResourceActionAsync< + AutonomousDatabase, + void, + AutonomousDatabase + >; +} + +@@example(AutonomousDatabases.listBySubscription, + "./examples/autonomousDatabase_listBySubscription.json", + "List Autonomous Database by subscription" +); +@@example(AutonomousDatabases.listByResourceGroup, + "./examples/autonomousDatabase_listByResourceGroup.json", + "List Autonomous Database by resource group" +); +@@example(AutonomousDatabases.createOrUpdate, + "./examples/autonomousDatabase_create.json", + "Create Autonomous Database" +); +@@example(AutonomousDatabases.createOrUpdate, + "./examples/autonomousDatabaseClone_create.json", + "Create clone Autonomous Database" +); +@@example(AutonomousDatabases.get, + "./examples/autonomousDatabase_get.json", + "Get Autonomous Database" +); +@@example(AutonomousDatabases.update, + "./examples/autonomousDatabase_patch.json", + "Patch Autonomous Database" +); +@@example(AutonomousDatabases.delete, + "./examples/autonomousDatabase_delete.json", + "Delete Autonomous Database" +); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp new file mode 100644 index 000000000000..55e19cb00a8e --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp @@ -0,0 +1,21 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "../../../models/autonomousdatabase/autonomousDatabaseVersion.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface AutonomousDatabaseVersions + extends OracleLocationBasedResource {} + +@@example(AutonomousDatabaseVersions.listByLocation, + "./examples/autonomousDatabaseVersion_listByLocation.json", + "List an autonomous versions by location" +); +@@example(AutonomousDatabaseVersions.get, + "./examples/autonomousDatabaseVersion_get.json", + "Get an autonomous version" +); diff --git a/specification/oracle/Oracle.Database/operations/commons.tsp b/specification/oracle/Oracle.Database/operations/commons.tsp new file mode 100644 index 000000000000..822a0dcb58ca --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/commons.tsp @@ -0,0 +1,72 @@ +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using OpenAPI; + +using Azure.ResourceManager.Foundations; + +namespace Oracle.Database; + +@armResourceOperations(T) +interface OracleSubscriptionLevelResource< + T extends Foundations.Resource, + TProperties extends TypeSpec.Reflection.Model +> + extends ResourceListBySubscription, + ResourceCreateAsync, + ResourceRead, + ResourceUpdateAsync, + ResourceDeleteWithoutOkAsync {} + +@armResourceOperations(T) +interface OracleTrackedResource< + T extends Foundations.Resource, + TProperties extends TypeSpec.Reflection.Model +> extends OracleSubscriptionLevelResource { + listByResourceGroup is ArmResourceListByParent; +} + +@armResourceOperations(T) +interface OracleReadOnlyResource { + // TODO: Swagger generator bug, cannot be extracted to interface + // listByParent is ArmResourceListByParent; + get is ArmResourceRead; +} + +@armResourceOperations(T) +interface OracleLocationBasedResource + extends OracleReadOnlyResource { + listByLocation is ArmResourceListByParent; +} + +@armResourceOperations(T) +interface OracleChildResource< + T extends Foundations.Resource, + TProperties extends TypeSpec.Reflection.Model +> + extends ResourceCreateAsync, + ResourceRead, + ResourceDeleteWithoutOkAsync {} + +@armResourceOperations +interface ListActions { + @doc("Generic Async Get operation") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + @autoRoute + @armResourceAction(TResource) + @post + ArmResourceGetActionAsync< + TResource extends Foundations.Resource, + TResponse, + TBaseParameters = BaseParameters + >( + ...ResourceInstanceParameters, + ): ArmResponse | ArmAcceptedLroResponse | ErrorResponse; +} diff --git a/specification/oracle/Oracle.Database/operations/exadata/dbNodesOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/dbNodesOperations.tsp new file mode 100644 index 000000000000..79680dd6061c --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/dbNodesOperations.tsp @@ -0,0 +1,24 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "../../../models/exadata/dbNodes.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface DbNodes extends OracleReadOnlyResource { + // TODO: Swagger generator bug, cannot be extracted to interface + @example("./examples/dbNodes_listByParent.json", "List DbNodes by VM Cluster") + listByParent is ArmResourceListByParent; + + @doc("VM actions on DbNode of VM Cluster by the provided filter") + @example( + "./examples/dbNodes_action.json", + "VM actions on DbNodes of VM Cluster" + ) + action is ArmResourceActionAsync; +} + +@@example(DbNodes.get, "./examples/dbNodes_get.json", "Get DbNode"); diff --git a/specification/oracle/Oracle.Database/operations/exadata/dbServersOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/dbServersOperations.tsp new file mode 100644 index 000000000000..01a98b2d27af --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/dbServersOperations.tsp @@ -0,0 +1,22 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "../../../models/exadata/dbServers.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface DbServers extends OracleReadOnlyResource { + @example( + "./examples/dbServers_listByParent.json", + "List DbServers by Exadata Infrastructure" + ) + listByParent is ArmResourceListByParent; +} + +@@example(DbServers.get, + "./examples/dbServers_get.json", + "Get DbServer by parent" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/dbSystemShapeOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/dbSystemShapeOperations.tsp new file mode 100644 index 000000000000..ec298b0f12e2 --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/dbSystemShapeOperations.tsp @@ -0,0 +1,18 @@ +import "../../../models/exadata/dbSystemShapes.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface DbSystemShapes extends OracleLocationBasedResource {} + +@@example(DbSystemShapes.listByLocation, + "./examples/dbSystemShapes_listByLocation.json", + "List DbSystemShapes by location" +); +@@example(DbSystemShapes.get, + "./examples/dbSystemShapes_get.json", + "Get a DbSystemShape by name" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateViewsOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateViewsOperations.tsp new file mode 100644 index 000000000000..4fc9dd100bfd --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateViewsOperations.tsp @@ -0,0 +1,18 @@ +import "../../../models/exadata/dnsPrivateViews.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface DnsPrivateViews extends OracleLocationBasedResource {} + +@@example(DnsPrivateViews.listByLocation, + "./examples/dnsPrivateViews_listByLocation.json", + "List DnsPrivateViews by location" +); +@@example(DnsPrivateViews.get, + "./examples/dnsPrivateViews_get.json", + "Get a DnsPrivateView by name" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateZonesOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateZonesOperations.tsp new file mode 100644 index 000000000000..a1d18acd98ca --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateZonesOperations.tsp @@ -0,0 +1,18 @@ +import "../../../models/exadata/dnsPrivateZones.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface DnsPrivateZones extends OracleLocationBasedResource {} + +@@example(DnsPrivateZones.listByLocation, + "./examples/dnsPrivateZones_listByLocation.json", + "List DnsPrivateZones by location" +); +@@example(DnsPrivateZones.get, + "./examples/dnsPrivateZones_get.json", + "Get a DnsPrivateZone by name" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/exadatainfrastructureOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/exadatainfrastructureOperations.tsp new file mode 100644 index 000000000000..d4afa8337da0 --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/exadatainfrastructureOperations.tsp @@ -0,0 +1,51 @@ +import "../commons.tsp"; +import "../../../models/exadata/exadatainfra.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations(CloudExadataInfrastructure) +interface CloudExadataInfrastructures + extends OracleTrackedResource< + CloudExadataInfrastructure, + CloudExadataInfrastructureProperties + > { + //OCI addStorageCapacityCloudExadataInfrastructure API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/AddStorageCapacityCloudExadataInfrastructure + @doc("Perform add storage capacity on exadata infra") + @example( + "./examples/exaInfra_addStorageCapacity.json", + "Perform add storage capacity on exadata infra" + ) + addStorageCapacity is ArmResourceActionAsync< + CloudExadataInfrastructure, + void, + CloudExadataInfrastructure + >; +} + +@@example(CloudExadataInfrastructures.listBySubscription, + "./examples/exaInfra_listBySubscription.json", + "List Exadata Infrastructure by subscription" +); +@@example(CloudExadataInfrastructures.listByResourceGroup, + "./examples/exaInfra_listByResourceGroup.json", + "List Exadata Infrastructure by resource group" +); +@@example(CloudExadataInfrastructures.createOrUpdate, + "./examples/exaInfra_create.json", + "Create Exadata Infrastructure" +); +@@example(CloudExadataInfrastructures.get, + "./examples/exaInfra_get.json", + "Get Exadata Infrastructure" +); +@@example(CloudExadataInfrastructures.update, + "./examples/exaInfra_patch.json", + "Patch Exadata Infrastructure" +); +@@example(CloudExadataInfrastructures.delete, + "./examples/exaInfra_delete.json", + "Delete Exadata Infrastructure" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/giVersionOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/giVersionOperations.tsp new file mode 100644 index 000000000000..9e8f2f617ebd --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/giVersionOperations.tsp @@ -0,0 +1,18 @@ +import "../../../models/exadata/giVersions.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface GiVersions extends OracleLocationBasedResource {} + +@@example(GiVersions.listByLocation, + "./examples/giVersions_listByLocation.json", + "List GiVersions by location" +); +@@example(GiVersions.get, + "./examples/giVersions_get.json", + "Get a GiVersion by name" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/systemVersionOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/systemVersionOperations.tsp new file mode 100644 index 000000000000..481648c95039 --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/systemVersionOperations.tsp @@ -0,0 +1,19 @@ +import "../../../models/exadata/systemVersions.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface SystemVersions extends OracleLocationBasedResource {} + +@@example(SystemVersions.listByLocation, + "./examples/systemVersions_listByLocation.json", + "List Exadata System Versions by the provided filter" +); + +@@example(SystemVersions.get, + "./examples/systemVersions_get.json", + "Get Exadata System Version" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/virtualNetworkAddressOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/virtualNetworkAddressOperations.tsp new file mode 100644 index 000000000000..b70cd518221e --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/virtualNetworkAddressOperations.tsp @@ -0,0 +1,35 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "../../../models/exadata/virtualNetworkAddress.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface VirtualNetworkAddresses + extends OracleChildResource< + VirtualNetworkAddress, + VirtualNetworkAddressProperties + > { + // TODO: Swagger generator bug, cannot be extracted to interface + @example( + "./examples/virtualNetworkAddresses_listByParent.json", + "List Virtual Network Addresses by VM Cluster" + ) + listByParent is ArmResourceListByParent; +} + +@@example(VirtualNetworkAddresses.createOrUpdate, + "./examples/virtualNetworkAddresses_create.json", + "Create Virtual Network Address" +); +@@example(VirtualNetworkAddresses.get, + "./examples/virtualNetworkAddresses_get.json", + "Get Virtual Network Address" +); +@@example(VirtualNetworkAddresses.delete, + "./examples/virtualNetworkAddresses_delete.json", + "Delete Virtual Network Address" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/vmclusterOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/vmclusterOperations.tsp new file mode 100644 index 000000000000..d5bcd6ce3ed0 --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/exadata/vmclusterOperations.tsp @@ -0,0 +1,64 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "../../../models/exadata/vmcluster.tsp"; +import "../../../models/exadata/privateIpAddresses.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface CloudVmClusters + extends OracleTrackedResource { + @doc("Add VMs to the VM Cluster") + @example("./examples/vmClusters_addVms.json", "Add VMs to VM Cluster") + addVms is ArmResourceActionAsync< + CloudVmCluster, + AddRemoveDbNode, + CloudVmCluster + >; + + @doc("Remove VMs from the VM Cluster") + @example("./examples/vmClusters_removeVms.json", "Remove VMs from VM Cluster") + removeVms is ArmResourceActionAsync< + CloudVmCluster, + AddRemoveDbNode, + CloudVmCluster + >; + + @doc("List Private IP Addresses by the provided filter") + @example( + "./examples/vmClusters_listPrivateIpAddresses.json", + "List Private IP Addresses for VM Cluster" + ) + listPrivateIpAddresses is ArmResourceActionSync< + CloudVmCluster, + PrivateIpAddressesFilter, + Array + >; +} + +@@example(CloudVmClusters.listBySubscription, + "./examples/vmClusters_listBySubscription.json", + "List VM Clusters by subscription" +); +@@example(CloudVmClusters.createOrUpdate, + "./examples/vmClusters_create.json", + "Create VM Cluster" +); +@@example(CloudVmClusters.get, + "./examples/vmClusters_get.json", + "Get VM Cluster" +); +@@example(CloudVmClusters.update, + "./examples/vmClusters_patch.json", + "Patch VM Cluster" +); +@@example(CloudVmClusters.delete, + "./examples/vmClusters_delete.json", + "Delete VM Cluster" +); +@@example(CloudVmClusters.listByResourceGroup, + "./examples/vmClusters_listByResourceGroup.json", + "List VM Clusters by resource group" +); diff --git a/specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp b/specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp new file mode 100644 index 000000000000..24189714b5ba --- /dev/null +++ b/specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp @@ -0,0 +1,80 @@ +import "../../../models/oraclesubscription/oracleSubscription.tsp"; + +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations(OracleSubscription) +interface OracleSubscriptions + extends OracleSubscriptionLevelResource< + OracleSubscription, + OracleSubscriptionProperties + > { + @doc("List Cloud Account Details") + @example( + "./examples/oracleSubscriptions_listCloudAccountDetails.json", + "List Cloud Account details for the Oracle Subscription" + ) + listCloudAccountDetails is ListActions.ArmResourceGetActionAsync< + OracleSubscription, + CloudAccountDetails + >; + + @doc("List Saas Subscription Details") + @example( + "./examples/oracleSubscriptions_listSaasSubscriptionDetails.json", + "List Saas Subscription details for the Oracle Subscription" + ) + listSaasSubscriptionDetails is ListActions.ArmResourceGetActionAsync< + OracleSubscription, + SaasSubscriptionDetails + >; + + @doc("List Activation Links") + @example( + "./examples/oracleSubscriptions_listActivationLinks.json", + "List Activation Links for the Oracle Subscription" + ) + listActivationLinks is ListActions.ArmResourceGetActionAsync< + OracleSubscription, + ActivationLinks + >; + + /** + * @dev Update a resource using the asynchronous call pattern. + * @template Resource The ArmResource to update. + * @template Properties RP-specific property bag for the resource + * @template BaseParameters The http parameters that are part of the request + */ + update is ArmCustomPatchAsync< + OracleSubscription, + ResourceUpdateModel< + OracleSubscription, + OracleSubscriptionProperties + >, + DefaultBaseParameters> + >; +} + +@@example(OracleSubscriptions.listBySubscription, + "./examples/oracleSubscriptions_listBySubscription.json", + "List Oracle Subscriptions by subscription" +); +@@example(OracleSubscriptions.createOrUpdate, + "./examples/oracleSubscriptions_create.json", + "Create or Update Oracle Subscription" +); +@@example(OracleSubscriptions.get, + "./examples/oracleSubscriptions_get.json", + "Get Oracle Subscription" +); +@@example(OracleSubscriptions.update, + "./examples/oracleSubscriptions_patch.json", + "Patch Oracle Subscription" +); +@@example(OracleSubscriptions.delete, + "./examples/oracleSubscriptions_delete.json", + "Delete Oracle Subscription" +); diff --git a/specification/oracle/Oracle.Database/tspconfig.yaml b/specification/oracle/Oracle.Database/tspconfig.yaml new file mode 100644 index 000000000000..c7f8c641b6e4 --- /dev/null +++ b/specification/oracle/Oracle.Database/tspconfig.yaml @@ -0,0 +1,29 @@ +emit: + - "@azure-tools/typespec-autorest" + +options: + "@azure-tools/typespec-autorest": + arm-types-dir: "../../../../../common-types/resource-management" + use-read-only-status-schema: true + azure-resource-provider-folder: "resource-manager" + emitter-output-dir: "{project-root}/.." + examples-directory: "examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" + "@azure-tools/typespec-ts": + package-dir: "arm-oracledatabase" + packageDetails: + name: "@azure/arm-oracledatabase" + flavor: azure + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-oracledatabase" + namespace: com.azure.resourcemanager.oracledatabase + partial-update: true + flavor: azure + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-oracledatabase" + package-name: "{package-dir}" + flavor: azure + +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/oracle/Oracle.Database/versions.tsp b/specification/oracle/Oracle.Database/versions.tsp new file mode 100644 index 000000000000..d9316d37da43 --- /dev/null +++ b/specification/oracle/Oracle.Database/versions.tsp @@ -0,0 +1,11 @@ +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@doc("Versions for API") +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("2023-09-01-preview") + v20230901: "2023-09-01-preview", +} diff --git a/specification/oracle/models/autonomousdatabase/adbCommon.tsp b/specification/oracle/models/autonomousdatabase/adbCommon.tsp new file mode 100644 index 000000000000..6fdf436c7d2a --- /dev/null +++ b/specification/oracle/models/autonomousdatabase/adbCommon.tsp @@ -0,0 +1,19 @@ +using OpenAPI; +using TypeSpec.Versioning; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.Core; + +namespace Oracle.Database; + +scalar AutonomousDatabaseId + extends armResourceIdentifier<[ + { + type: "Oracle.Database/autonomousDatabases", + } + ]>; + +@doc("Retention period, in days, for backups.") +@minValue(90) +@maxValue(2558) +scalar RetentionPeriod extends int32; diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabase.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabase.tsp new file mode 100644 index 000000000000..d0f523f1b912 --- /dev/null +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabase.tsp @@ -0,0 +1,982 @@ +import "../common.tsp"; +import "./adbCommon.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +namespace Oracle.Database; + +//https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase + +@minLength(1) +@maxLength(1024) +@doc("The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']") +scalar aclString extends string; + +@doc("Autonomous database lifecycle state enum") +union AutonomousDatabaseLifecycleState { + @doc("Indicates that resource in Provisioning state") + Provisioning: "Provisioning", + + @doc("Indicates that resource in Available state") + Available: "Available", + + @doc("Indicates that resource in Stopping state") + Stopping: "Stopping", + + @doc("Indicates that resource in Stopped state") + Stopped: "Stopped", + + @doc("Indicates that resource in Starting state") + Starting: "Starting", + + @doc("Indicates that resource in Terminating state") + Terminating: "Terminating", + + @doc("Indicates that resource in Terminated state") + Terminated: "Terminated", + + @doc("Indicates that resource in Unavailable state") + Unavailable: "Unavailable", + + @doc("Indicates that resource in RestoreInProgress state") + RestoreInProgress: "RestoreInProgress", + + @doc("Indicates that resource in RestoreFailed state") + RestoreFailed: "RestoreFailed", + + @doc("Indicates that resource in BackupInProgress state") + BackupInProgress: "BackupInProgress", + + @doc("Indicates that resource in ScaleInProgress state") + ScaleInProgress: "ScaleInProgress", + + @doc("Indicates that resource is available but needs attention") + AvailableNeedsAttention: "AvailableNeedsAttention", + + @doc("Indicates that resource in Updating state") + Updating: "Updating", + + @doc("Indicates that resource maintenance in progress state") + MaintenanceInProgress: "MaintenanceInProgress", + + @doc("Indicates that resource in Restarting state") + Restarting: "Restarting", + + @doc("Indicates that resource in Recreating state") + Recreating: "Recreating", + + @doc("Indicates that resource role change in progress state") + RoleChangeInProgress: "RoleChangeInProgress", + + @doc("Indicates that resource in Upgrading state") + Upgrading: "Upgrading", + + @doc("IIndicates that resource in Inaccessible state") + Inaccessible: "Inaccessible", + + @doc("Indicates that resource in Standby state") + Standby: "Standby", + + string, +} + +@doc("Refreshable model type enum") +union RefreshableModelType { + @doc("Automatic refreshable model type") + Automatic: "Automatic", + + @doc("Manual refreshable model type") + Manual: "Manual", + + string, +} + +@doc("Repeat cadence type enum") +union RepeatCadenceType { + @doc("Repeat one time") + OneTime: "OneTime", + + @doc("Repeat weekly") + Weekly: "Weekly", + + @doc("Repeat monthly") + Monthly: "Monthly", + + @doc("Repeat yearly") + Yearly: "Yearly", + + string, +} + +@doc("Database type enum") +union DataBaseType { + @doc("Regular DB") + Regular: "Regular", + + @doc("Clone DB") + Clone: "Clone", + + string, +} + +@doc("Compute model enum") +union ComputeModel { + @doc("ECPU model type") + ECPU: "ECPU", + + @doc("OCPU model type") + OCPU: "OCPU", + + string, +} + +@doc("Clone type enum") +union CloneType { + @doc("Full clone") + Full: "Full", + + @doc("Metadata only") + Metadata: "Metadata", + + string, +} + +@doc("Autonomous database maintenance schedule type enum.") +union AutonomousMaintenanceScheduleType { + @doc("Early maintenance schedule") + Early: "Early", + + @doc("Regular maintenance schedule") + Regular: "Regular", + + string, +} + +@doc("Source type enum.") +union SourceType { + @doc("None source") + None: "None", + + @doc("Database source") + Database: "Database", + + @doc("Backup from ID source") + BackupFromId: "BackupFromId", + + @doc("Backup from timestamp source") + BackupFromTimestamp: "BackupFromTimestamp", + + @doc("Clone to refreshable source") + CloneToRefreshable: "CloneToRefreshable", + + @doc("Cross region dataguard source") + CrossRegionDataguard: "CrossRegionDataguard", + + @doc("cross region disaster recovery source") + CrossRegionDisasterRecovery: "CrossRegionDisasterRecovery", + + string, +} + +@doc("TLS authentication type enum.") +union TlsAuthenticationType { + @doc("Server authentication") + Server: "Server", + + @doc("Mutual TLS") + Mutual: "Mutual", + + string, +} + +@doc("Syntax format type enum.") +union SyntaxFormatType { + @doc("Long format") + Long: "Long", + + @doc("Ezconnect format") + Ezconnect: "Ezconnect", + + @doc("Ezconnectplus format") + Ezconnectplus: "Ezconnectplus", + + string, +} + +@doc("Session mode type enum.") +union SessionModeType { + @doc("Direct session mode") + Direct: "Direct", + + @doc("Redirect session mode") + Redirect: "Redirect", + + string, +} + +@doc("Protocol type enum.") +union ProtocolType { + @doc("TCP protocol") + TCP: "TCP", + + @doc("TCPS protocol") + TCPS: "TCPS", + + string, +} + +@doc("Host format type enum.") +union HostFormatType { + @doc("FQDN format") + Fqdn: "Fqdn", + + @doc("IP format") + Ip: "Ip", + + string, +} + +@doc("Consumer group enum.") +union ConsumerGroup { + @doc("High group") + High: "High", + + @doc("Medium group") + Medium: "Medium", + + @doc("Low group") + Low: "Low", + + @doc("TP group") + Tp: "Tp", + + @doc("TPurgent group") + Tpurgent: "Tpurgent", + + string, +} + +@doc("DataSafe status type enum.") +union DataSafeStatusType { + @doc("Registering status") + Registering: "Registering", + + @doc("Registered status") + Registered: "Registered", + + @doc("Deregistering status") + Deregistering: "Deregistering", + + @doc("NotRegistered status") + NotRegistered: "NotRegistered", + + @doc("Failed status") + Failed: "Failed", + + string, +} + +@doc("Permission level type enum.") +union PermissionLevelType { + @doc("Restricted permission level") + Restricted: "Restricted", + + @doc("Unrestricted permission level") + Unrestricted: "Unrestricted", + + string, +} + +@doc("Database edition type enum.") +union DatabaseEditionType { + @doc("Standard edition") + StandardEdition: "StandardEdition", + + @doc("Enterprise edition") + EnterpriseEdition: "EnterpriseEdition", + + string, +} + +@doc("Open mode type enum.") +union OpenModeType { + @doc("ReadOnly mode") + ReadOnly: "ReadOnly", + + @doc("ReadWrite mode") + ReadWrite: "ReadWrite", + + string, +} + +@doc("Operations Insights status type enum.") +union OperationsInsightsStatusType { + @doc("Enabling status") + Enabling: "Enabling", + + @doc("Enabled status") + Enabled: "Enabled", + + @doc("Disabling status") + Disabling: "Disabling", + + @doc("NotEnabled status") + NotEnabled: "NotEnabled", + + @doc("FailedEnabling status") + FailedEnabling: "FailedEnabling", + + @doc("FailedDisabling status") + FailedDisabling: "FailedDisabling", + + string, +} + +@doc("Role type enum.") +union RoleType { + @doc("Primary role") + Primary: "Primary", + + @doc("Standby role") + Standby: "Standby", + + @doc("DisabledStandby role") + DisabledStandby: "DisabledStandby", + + @doc("BackupCopy role") + BackupCopy: "BackupCopy", + + @doc("SnapshotStandby role") + SnapshotStandby: "SnapshotStandby", + + string, +} + +@doc("Refreshable status type enum.") +union RefreshableStatusType { + @doc("Refreshing status") + Refreshing: "Refreshing", + + @doc("NotRefreshing status") + NotRefreshing: "NotRefreshing", + + string, +} + +@doc("Disaster recovery type enum.") +union DisasterRecoveryType { + @doc("ADG type") + Adg: "Adg", + + @doc("Backup based type") + BackupBased: "BackupBased", + + string, +} + +@doc("Generate type enum") +union GenerateType { + @doc("Generate single") + Single: "Single", + + @doc("Generate all") + All: "All", + + string, +} + +@doc("PeerDb Details") +model PeerDbDetails { + @doc("The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.") + @minLength(1) + @maxLength(255) + peerDbId?: string; +} + +@doc("Autonomous Disaster Recovery standby database details.") +model AutonomousDatabaseStandbySummary { + @doc("The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover.") + lagTimeInSeconds?: int32; + + @doc("The current state of the Autonomous Database.") + lifecycleState?: AutonomousDatabaseLifecycleState; + + @doc("Additional information about the current lifecycle state.") + lifecycleDetails?: string; + + @doc("The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.") + timeDataGuardRoleChanged?: string; + + @doc("The date and time the Disaster Recovery role was switched for the standby Autonomous Database.") + timeDisasterRecoveryRoleChanged?: string; +} + +@doc("Details for the long-term backup schedule.") +model LongTermBackUpScheduleDetails { + @doc("The frequency of the long-term backup schedule") + repeatCadence?: RepeatCadenceType; + + @doc("The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month.") + timeOfBackup?: utcDateTime; + + @doc("Retention period, in days, for backups.") + retentionPeriodInDays?: RetentionPeriod; + + @doc("Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`.") + isDisabled?: boolean; +} + +@doc("Information about Oracle APEX Application Development.") +model ApexDetailsType { + @doc("The Oracle APEX Application Development version.") + apexVersion?: string; + + @doc("The Oracle REST Data Services (ORDS) version.") + ordsVersion?: string; +} + +@doc("The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.") +model AllConnectionStringType { + @doc("The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.") + @minLength(10) + @maxLength(255) + high?: string; + + @doc("The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.") + @minLength(10) + @maxLength(255) + low?: string; + + @doc("The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.") + @minLength(10) + @maxLength(255) + medium?: string; +} + +@doc("The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.") +model ConnectionUrlType { + @doc("Oracle Application Express (APEX) URL.") + @minLength(10) + @maxLength(512) + apexUrl?: string; + + @doc("The URL of the Database Transforms for the Autonomous Database.") + @minLength(10) + @maxLength(512) + databaseTransformsUrl?: string; + + @doc("The URL of the Graph Studio for the Autonomous Database.") + @minLength(10) + @maxLength(512) + graphStudioUrl?: string; + + @doc("The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.") + @minLength(10) + @maxLength(512) + machineLearningNotebookUrl?: string; + + @doc("The URL of the MongoDB API for the Autonomous Database.") + @minLength(10) + @maxLength(512) + mongoDbUrl?: string; + + @doc("The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.") + @minLength(10) + @maxLength(512) + ordsUrl?: string; + + @doc("Oracle SQL Developer Web URL.") + @minLength(10) + @maxLength(512) + sqlDevWebUrl?: string; +} + +@doc("The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.") +model ProfileType { + @doc("Consumer group used by the connection.") + consumerGroup?: ConsumerGroup; + + @doc("A user-friendly name for the connection.") + @minLength(1) + @maxLength(255) + displayName: string; + + @doc("Host format used in connection string.") + hostFormat: HostFormatType; + + @doc("True for a regional connection string, applicable to cross-region DG only.") + isRegional?: boolean; + + @doc("Protocol used by the connection.") + protocol: ProtocolType; + + @doc("Specifies whether the listener performs a direct hand-off of the session, or redirects the session.") + sessionMode: SessionModeType; + + @doc("Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format.") + syntaxFormat: SyntaxFormatType; + + @doc("Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication.") + tlsAuthentication?: TlsAuthenticationType; + + @doc("Connection string value.") + value: string; +} + +@doc("Connection strings to connect to an Oracle Autonomous Database.") +model ConnectionStringType { + @doc("Returns all connection strings that can be used to connect to the Autonomous Database.") + allConnectionStrings?: AllConnectionStringType; + + @doc("The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.") + @minLength(10) + @maxLength(255) + dedicated?: string; + + @doc("The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.") + @minLength(10) + @maxLength(255) + high?: string; + + @doc("The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.") + @minLength(10) + @maxLength(255) + low?: string; + + @doc("The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.") + @minLength(10) + @maxLength(255) + medium?: string; + + @doc("A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.") + @OpenAPI.extension("x-ms-identifiers", []) + profiles?: ProfileType[]; +} + +@doc("The list of scheduled operations.") +model ScheduledOperationsType { + @doc("Day of week") + dayOfWeek: DayOfWeek; + + @doc("auto start time. value must be of ISO-8601 format HH:mm") + @minLength(1) + @maxLength(50) + scheduledStartTime?: string; + + @doc("auto stop time. value must be of ISO-8601 format HH:mm") + @minLength(1) + @maxLength(50) + scheduledStopTime?: string; +} + +@doc("Autonomous Database resource model.") +model AutonomousDatabase is TrackedResource { + @doc("The database name.") + @key("autonomousdatabasename") + @path + @segment("autonomousDatabases") + @minLength(1) + @maxLength(30) + @pattern(".*") + name: string; +} + +@doc("Autonomous Database resource model.") +model AutonomousDatabaseProperties extends AutonomousDatabaseBaseProperties { + @doc("Database type to be created.") + dataBaseType: DataBaseType.Regular; +} + +@doc("Autonomous Database clone resource model.") +model AutonomousDatabaseCloneProperties + extends AutonomousDatabaseBaseProperties { + @doc("Database type to be created.") + dataBaseType: DataBaseType.Clone; + + @doc("The source of the database.") + @visibility("create") + source?: SourceType; + + @doc("The Azure ID of the Autonomous Database that was cloned to create the current Autonomous Database.") + @visibility("create", "read") + sourceId: AutonomousDatabaseId; + + @doc("The Autonomous Database clone type.") + @visibility("create") + cloneType: CloneType; + + @doc("Indicates if the refreshable clone can be reconnected to its source database.") + @visibility("read") + isReconnectCloneEnabled?: boolean; + + @doc("Indicates if the Autonomous Database is a refreshable clone.") + @visibility("read") + isRefreshableClone?: boolean; + + @doc("The refresh mode of the clone.") + @visibility("create") + refreshableModel?: RefreshableModelType; + + @doc("The refresh status of the clone.") + @visibility("read") + refreshableStatus?: RefreshableStatusType; + + @doc("The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.") + @visibility("read", "update") + timeUntilReconnectCloneEnabled?: string; +} + +@discriminator("dataBaseType") +@doc("Autonomous Database base resource model.") +model AutonomousDatabaseBaseProperties { + @doc("Admin password.") + @visibility("create", "update") + @minLength(12) + @maxLength(30) + adminPassword?: Password; + + @doc("Database type to be created.") + @visibility("create") + dataBaseType: DataBaseType; + + @doc("The maintenance schedule type of the Autonomous Database Serverless.") + @visibility("create", "read", "update") + autonomousMaintenanceScheduleType?: AutonomousMaintenanceScheduleType; + + @doc("The character set for the autonomous database.") + @visibility("create", "read") + @minLength(1) + @maxLength(255) + characterSet?: string; + + @doc("The compute amount (CPUs) available to the database.") + @visibility("create", "read", "update") + @minValue(0.1) + @maxValue(512) + computeCount?: float32; + + @doc("The compute model of the Autonomous Database.") + @visibility("create", "read") + computeModel?: ComputeModel; + + @doc("The number of CPU cores to be made available to the database.") + @visibility("create", "read", "update") + @minValue(1) + @maxValue(128) + cpuCoreCount?: int32; + + @doc("Customer Contacts.") + @visibility("create", "read", "update") + @OpenAPI.extension("x-ms-identifiers", []) + customerContacts?: CustomerContact[]; + + @doc("The quantity of data in the database, in terabytes.") + @visibility("create", "read", "update") + @minValue(1) + @maxValue(384) + dataStorageSizeInTbs?: int32; + + @doc("The size, in gigabytes, of the data volume that will be created and attached to the database.") + @visibility("create", "read", "update") + @minValue(20) + @maxValue(393216) + dataStorageSizeInGbs?: int32; + + @doc("A valid Oracle Database version for Autonomous Database.") + @visibility("create", "read") + @minLength(1) + @maxLength(255) + dbVersion?: string; + + @doc("The Autonomous Database workload type") + @visibility("create", "read") + dbWorkload?: WorkloadType; + + @doc("The user-friendly name for the Autonomous Database.") + @visibility("create", "read", "update") + @minLength(1) + @maxLength(255) + displayName?: string; + + @doc("Indicates if auto scaling is enabled for the Autonomous Database CPU core count.") + @visibility("create", "read", "update") + isAutoScalingEnabled?: boolean; + + @doc("Indicates if auto scaling is enabled for the Autonomous Database storage.") + @visibility("create", "read", "update") + isAutoScalingForStorageEnabled?: boolean; + + @doc("The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.") + @visibility("read") + peerDbIds?: string[]; + + @doc("The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.") + @visibility("update") + @minLength(1) + @maxLength(255) + peerDbId?: string; + + @doc("Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.") + @visibility("create", "read", "update") + isLocalDataGuardEnabled?: boolean; + + @doc("Indicates whether the Autonomous Database has Cross Region Data Guard enabled.") + @visibility("read") + isRemoteDataGuardEnabled?: boolean; + + @doc("Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance.Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover.Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.") + @visibility("read") + localDisasterRecoveryType?: DisasterRecoveryType; + + @doc("Local Autonomous Disaster Recovery standby database details.") + @visibility("read") + localStandbyDb?: AutonomousDatabaseStandbySummary; + + @doc("Indicates the number of seconds of data loss for a Data Guard failover.") + @visibility("read") + failedDataRecoveryInSeconds?: int32; + + @doc("Specifies if the Autonomous Database requires mTLS connections.") + @visibility("create", "read", "update") + isMtlsConnectionRequired?: boolean; + + @doc("Specifies if the Autonomous Database preview version is being provisioned.") + @visibility("create") + isPreviewVersionWithServiceTermsAccepted?: boolean; + + @doc("The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.") + @visibility("create", "read", "update") + licenseModel?: LicenseModel; + + @doc("The character set for the Autonomous Database.") + @visibility("create", "read") + @minLength(1) + @maxLength(255) + ncharacterSet?: string; + + @doc("Additional information about the current lifecycle state.") + @visibility("read") + lifecycleDetails?: string; + + @doc("Azure resource provisioning state.") + @visibility("read") + provisioningState?: AzureResourceProvisioningState; + + @doc("Views lifecycleState") + @visibility("read") + lifecycleState?: AutonomousDatabaseLifecycleState; + + @doc("The list of scheduled operations.") + @visibility("create", "read", "update") + scheduledOperations?: ScheduledOperationsType; + + @doc("The private endpoint Ip address for the resource.") + @visibility("create", "read") + privateEndpointIp?: string; + + @doc("The resource's private endpoint label.") + @visibility("create", "read") + privateEndpointLabel?: string; + + @doc("HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.") + @visibility("read") + ociUrl?: string; + + @doc("Client subnet") + @visibility("create", "read") + subnetId?: SubnetId; + + @doc("VNET for network connectivity") + @visibility("create", "read") + vnetId?: VnetId; + + @doc("The date and time that the database was created.") + @visibility("read") + timeCreated?: utcDateTime; + + @doc("The date and time when maintenance will begin.") + @visibility("read") + timeMaintenanceBegin?: utcDateTime; + + @doc("The date and time when maintenance will end.") + @visibility("read") + timeMaintenanceEnd?: utcDateTime; + + @doc("The current amount of storage in use for user and system data, in terabytes (TB).") + @visibility("read") + actualUsedDataStorageSizeInTbs?: float64; + + @doc("The amount of storage currently allocated for the database tables and billed for, rounded up.") + @visibility("read") + allocatedStorageSizeInTbs?: float64; + + @doc("Information about Oracle APEX Application Development.") + @visibility("read") + apexDetails?: ApexDetailsType; + + @doc("List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.") + @visibility("read") + availableUpgradeVersions?: string[]; + + @doc("The connection string used to connect to the Autonomous Database.") + @visibility("read") + connectionStrings?: ConnectionStringType; + + @doc("The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. ") + @visibility("read") + connectionUrls?: ConnectionUrlType; + + @doc("Status of the Data Safe registration for this Autonomous Database.") + @visibility("read") + dataSafeStatus?: DataSafeStatusType; + + @doc("The Oracle Database Edition that applies to the Autonomous databases.") + @visibility("create", "read", "update") + databaseEdition?: DatabaseEditionType; + + @doc("Autonomous Database ID") + @visibility("create", "read") + autonomousDatabaseId?: AutonomousDatabaseId; + + @doc("The area assigned to In-Memory tables in Autonomous Database.") + @visibility("read") + inMemoryAreaInGbs?: int32; + + @doc("The date and time when the next long-term backup would be created.") + @visibility("read") + nextLongTermBackupTimeStamp?: utcDateTime; + + @doc("Details for the long-term backup schedule.") + @visibility("read", "update") + longTermBackupSchedule?: LongTermBackUpScheduleDetails; + + @doc("Indicates if the Autonomous Database version is a preview version.") + @visibility("read") + isPreview?: boolean; + + @doc("Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard") + @visibility("update", "read") + @minValue(0) + @maxValue(3600) + localAdgAutoFailoverMaxDataLossLimit?: int32; + + @doc("The amount of memory (in GBs) enabled per ECPU or OCPU.") + @visibility("read") + memoryPerOracleComputeUnitInGbs?: int32; + + @doc("Indicates the Autonomous Database mode.") + @visibility("update", "read") + openMode?: OpenModeType; + + @doc("Status of Operations Insights for this Autonomous Database.") + @visibility("read") + operationsInsightsStatus?: OperationsInsightsStatusType; + + @doc("The Autonomous Database permission level.") + @visibility("read", "update") + permissionLevel?: PermissionLevelType; + + @doc("The private endpoint for the resource.") + @visibility("read") + privateEndpoint?: string; + + @doc("An array of CPU values that an Autonomous Database can be scaled to.") + @visibility("read") + provisionableCpus?: int32[]; + + @doc("The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.") + @visibility("read", "update") + role?: RoleType; + + @doc("The URL of the Service Console for the Autonomous Database.") + @visibility("read") + @minLength(10) + @maxLength(255) + serviceConsoleUrl?: string; + + @doc("The SQL Web Developer URL for the Oracle Autonomous Database.") + @visibility("read") + @minLength(10) + @maxLength(2048) + sqlWebDeveloperUrl?: string; + + @doc("The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.") + @visibility("read") + @maxItems(50) + supportedRegionsToCloneTo?: string[]; + + @doc("The date and time the Autonomous Data Guard role was switched for the Autonomous Database.") + @visibility("read") + timeDataGuardRoleChanged?: string; + + @doc("The date and time the Always Free database will be automatically deleted because of inactivity.") + @visibility("read") + timeDeletionOfFreeAutonomousDatabase?: string; + + @doc("The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.") + @visibility("read") + timeLocalDataGuardEnabled?: string; + + @doc("The timestamp of the last failover operation.") + @visibility("read") + timeOfLastFailover?: string; + + @doc("The date and time when last refresh happened.") + @visibility("read") + timeOfLastRefresh?: string; + + @doc("The refresh point timestamp (UTC).") + @visibility("read") + timeOfLastRefreshPoint?: string; + + @doc("The timestamp of the last switchover operation for the Autonomous Database.") + @visibility("read") + timeOfLastSwitchover?: string; + + @doc("The date and time the Always Free database will be stopped because of inactivity.") + @visibility("read") + timeReclamationOfFreeAutonomousDatabase?: string; + + @doc("The storage space consumed by Autonomous Database in GBs.") + @visibility("read") + usedDataStorageSizeInGbs?: int32; + + @doc("The amount of storage that has been used, in terabytes.") + @visibility("read") + usedDataStorageSizeInTbs?: int32; + + @doc("Database ocid") + @visibility("read") + ocid?: Ocid; + + @doc("Retention period, in days, for long-term backups") + @visibility("create", "read", "update") + backupRetentionPeriodInDays?: int32; + + @doc("The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']") + @visibility("create", "read", "update") + whitelistedIps?: aclString[]; +} + +@doc("Autonomous Database Generate Wallet resource model.") +model GenerateAutonomousDatabaseWalletDetails { + @doc("The type of wallet to generate.") + generateType?: GenerateType; + + @doc("True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only.") + isRegional?: boolean; + + @doc("The password to encrypt the keys inside the wallet") + @minLength(8) + password: Password; +} + +@doc("Autonomous Database Wallet File resource model.") +model AutonomousDatabaseWalletFile { + @doc("The base64 encoded wallet files") + walletFiles: string; +} diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseBackup.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseBackup.tsp new file mode 100644 index 000000000000..e361dadf15b4 --- /dev/null +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseBackup.tsp @@ -0,0 +1,133 @@ +import "../common.tsp"; +import "./adbCommon.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +namespace Oracle.Database; + +// https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/ + +@doc("Autonomous database backup lifecycle state enum") +union AutonomousDatabaseBackupLifecycleState { + @doc("AutonomousDatabase backup is creating") + Creating: "Creating", + + @doc("AutonomousDatabase backup is active") + Active: "Active", + + @doc("AutonomousDatabase backup is deleting") + Deleting: "Deleting", + + @doc("AutonomousDatabase backup is failed") + Failed: "Failed", + + @doc("AutonomousDatabase backup is updating") + Updating: "Updating", + + string, +} + +@doc("Autonomous database backup type enum") +union AutonomousDatabaseBackupType { + @doc("Incremental backup") + Incremental: "Incremental", + + @doc("Full backup") + Full: "Full", + + @doc("LongTerm backup") + LongTerm: "LongTerm", + + string, +} + +@doc("AutonomousDatabaseBackup resource definition") +@parentResource(AutonomousDatabase) +model AutonomousDatabaseBackup + is ProxyResource { + @doc("AutonomousDatabaseBackup id") + @key("adbbackupid") + @path + @segment("autonomousDatabaseBackups") + @pattern(".*") + name: string; +} + +@doc("AutonomousDatabaseBackup resource model") +model AutonomousDatabaseBackupProperties { + @doc("The OCID of the Autonomous Database.") + @visibility("read") + autonomousDatabaseOcid?: Ocid; + + @doc("The size of the database in terabytes at the time the backup was taken.") + @visibility("read") + databaseSizeInTbs?: float64; + + @doc("A valid Oracle Database version for Autonomous Database.") + @visibility("read") + dbVersion?: string; + + @doc("The user-friendly name for the backup. The name does not have to be unique.") + @visibility("create", "read") + displayName?: string; + + @doc("The OCID of the Autonomous Database backup.") + @visibility("read") + ocid?: Ocid; + + @doc("Indicates whether the backup is user-initiated or automatic.") + @visibility("read") + isAutomatic?: boolean; + + @doc("Indicates whether the backup can be used to restore the associated Autonomous Database.") + @visibility("read") + isRestorable?: boolean; + + @doc("Additional information about the current lifecycle state.") + @visibility("read") + lifecycleDetails?: string; + + @doc("The current state of the backup.") + @visibility("read") + lifecycleState?: AutonomousDatabaseBackupLifecycleState; + + @doc("Retention period, in days, for long-term backups.") + @minValue(60) + @maxValue(3650) + @visibility("read", "create", "update") + retentionPeriodInDays?: int32; + + @doc("The backup size in terabytes (TB).") + @visibility("read") + sizeInTbs?: float64; + + @doc("Timestamp until when the backup will be available.") + @visibility("read") + timeAvailableTil?: utcDateTime; + + @doc("The date and time the backup started.") + @visibility("read") + timeStarted?: string; + + @doc("The date and time the backup completed.") + @visibility("read") + timeEnded?: string; + + @doc("The type of backup.") + @visibility("read") + backupType?: AutonomousDatabaseBackupType; + + @doc("Azure resource provisioning state.") + @visibility("read") + provisioningState?: AzureResourceProvisioningState; +} + +@doc("Details to restore an Oracle Autonomous Database.") +model RestoreAutonomousDatabaseDetails { + @doc("The time to restore the database to.") + timestamp: utcDateTime; +} diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp new file mode 100644 index 000000000000..c7068156c821 --- /dev/null +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp @@ -0,0 +1,30 @@ +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +//https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets + +@doc("AutonomousDatabaseCharacterSets resource definition") +@parentResource(SubscriptionLocationResource) +model AutonomousDatabaseCharacterSet + is ProxyResource { + @doc("AutonomousDatabaseCharacterSet name") + @key("adbscharsetname") + @path + @segment("autonomousDatabaseCharacterSets") + @pattern(".*") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Read-only resource. No provisioning state provided." +@doc("AutonomousDatabaseCharacterSet resource model") +model AutonomousDatabaseCharacterSetProperties { + @doc("The Oracle Autonomous Database supported character sets.") + @visibility("read") + @minLength(1) + @maxLength(255) + characterSet: string; +} diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp new file mode 100644 index 000000000000..91891da25d0d --- /dev/null +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp @@ -0,0 +1,30 @@ +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +//https://docs.oracle.com/en-us/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html + +@doc("AutonomousDatabaseNationalCharacterSets resource definition") +@parentResource(SubscriptionLocationResource) +model AutonomousDatabaseNationalCharacterSet + is ProxyResource { + @doc("AutonomousDatabaseNationalCharacterSets name") + @key("adbsncharsetname") + @path + @segment("autonomousDatabaseNationalCharacterSets") + @pattern(".*") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Read-only resource. No provisioning state provided." +@doc("AutonomousDatabaseNationalCharacterSet resource model") +model AutonomousDatabaseNationalCharacterSetProperties { + @doc("The Oracle Autonomous Database supported national character sets.") + @visibility("read") + @minLength(1) + @maxLength(255) + characterSet: string; +} diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp new file mode 100644 index 000000000000..8560d62b80fe --- /dev/null +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp @@ -0,0 +1,50 @@ +import "../common.tsp"; + +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Rest; + +namespace Oracle.Database; + +//https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary + +@doc("AutonomousDbVersion resource definition") +@parentResource(SubscriptionLocationResource) +model AutonomousDbVersion is ProxyResource { + @doc("AutonomousDbVersion name") + @key("autonomousdbversionsname") + @path + @segment("autonomousDbVersions") + @pattern(".*") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Read-only resource. No provisioning state provided." +@doc("AutonomousDbVersion resource model") +model AutonomousDbVersionProperties { + @doc("Supported Autonomous Db versions.") + @visibility("read") + @minLength(1) + @maxLength(255) + version: string; + + @doc("The Autonomous Database workload type") + @visibility("read") + dbWorkload?: WorkloadType; + + @doc("True if this version of the Oracle Database software's default is free.") + @visibility("read") + isDefaultForFree?: boolean; + + @doc("True if this version of the Oracle Database software's default is paid.") + @visibility("read") + isDefaultForPaid?: boolean; + + @doc("True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.") + @visibility("read") + isFreeTierEnabled?: boolean; + + @doc("True if this version of the Oracle Database software has payments enabled.") + @visibility("read") + isPaidEnabled?: boolean; +} diff --git a/specification/oracle/models/common.tsp b/specification/oracle/models/common.tsp new file mode 100644 index 000000000000..1770a9ab6873 --- /dev/null +++ b/specification/oracle/models/common.tsp @@ -0,0 +1,203 @@ +using OpenAPI; +using TypeSpec.Versioning; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.Core; + +namespace Oracle.Database; + +scalar SubnetId + extends armResourceIdentifier<[ + { + type: "Microsoft.Network/virtualNetworks/subnets", + } + ]>; + +scalar VnetId + extends armResourceIdentifier<[ + { + type: "Microsoft.Network/virtualNetworks", + } + ]>; + +@doc("Azure Resource Provisioning State enum") +union AzureResourceProvisioningState { + ResourceProvisioningState, + + @doc("Indicates that resource in Provisioning state") + Provisioning: "Provisioning", + + string, +} + +@doc("WorkloadType enum") +union WorkloadType { + @doc("OLTP - indicates an Autonomous Transaction Processing database") + OLTP: "OLTP", + + @doc("DW - indicates an Autonomous Data Warehouse database") + DW: "DW", + + @doc("AJD - indicates an Autonomous JSON Database") + AJD: "AJD", + + @doc("APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.") + APEX: "APEX", + + string, +} + +@doc("DayOfWeek resource properties") +model DayOfWeek { + @doc("Name of the day of the week.") + name: DayOfWeekName; +} + +@doc("The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.") +@minLength(1) +@maxLength(255) +scalar Ocid extends string; + +@doc("LicenseModel enum") +union LicenseModel { + @doc("License included") + LicenseIncluded: "LicenseIncluded", + + @doc("Bring Your Own License") + BringYourOwnLicense: "BringYourOwnLicense", + + string, +} + +@doc("validation result") +model ValidationResult { + @doc("validation status") + status: ValidationStatus; + + @doc("validation error") + error: ValidationError; +} + +@doc("validation status") +union ValidationStatus { + @doc("Validation succeeded") + Succeeded: "Succeeded", + + @doc("Validation failed") + Failed: "Failed", + + string, +} + +@doc("validation error") +model ValidationError { + @doc("error code") + code: string; + + @doc("error message") + message: string; +} + +@doc("CustomerContact resource properties") +model CustomerContact { + @doc("The email address used by Oracle to send notifications regarding databases and infrastructure.") + @minLength(1) + @maxLength(320) + email: string; +} + +@secret +@doc("Password string.") +scalar Password extends string; + +@doc("MonthName enum") +union MonthName { + @doc("January value") + January: "January", + + @doc("February value") + February: "February", + + @doc("March value") + March: "March", + + @doc("April value") + April: "April", + + @doc("May value") + May: "May", + + @doc("June value") + June: "June", + + @doc("July value") + July: "July", + + @doc("August value") + August: "August", + + @doc("September value") + September: "September", + + @doc("October value") + October: "October", + + @doc("November value") + November: "November", + + @doc("December value") + December: "December", + + string, +} + +@doc("DayOfWeekName enum") +union DayOfWeekName { + @doc("Monday value") + Monday: "Monday", + + @doc("Tuesday value") + Tuesday: "Tuesday", + + @doc("Wednesday value") + Wednesday: "Wednesday", + + @doc("Thursday value") + Thursday: "Thursday", + + @doc("Friday value") + Friday: "Friday", + + @doc("Saturday value") + Saturday: "Saturday", + + @doc("Sunday value") + Sunday: "Sunday", + + string, +} + +@doc("Month resource properties") +model Month { + @doc("Name of the month of the year.") + name: MonthName; +} + +@doc("Header to distinguish between resource creation or update") +model MsRpaasNewResourceHeader { + @header("x-ms-rpaas-new-resource") + @doc("Boolean parameter to distinguish between resource creation or update") + @extension("x-default-description", true) + msRpaasNewResource?: boolean; +} + +// only properties are passed for Create Validation extension +model CreateValidationDetails { + ...MsRpaasNewResourceHeader; + properties: T; +} + +// only properties are passed for Patch Validation extension +model PatchValidationDetails { + properties: T; +} diff --git a/specification/oracle/models/exadata/dbNodes.tsp b/specification/oracle/models/exadata/dbNodes.tsp new file mode 100644 index 000000000000..bfb4a295cbaf --- /dev/null +++ b/specification/oracle/models/exadata/dbNodes.tsp @@ -0,0 +1,179 @@ +import "../common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.ResourceManager; + +namespace Oracle.Database; + +@doc("The DbNode resource belonging to vmCluster") +@parentResource(CloudVmCluster) +model DbNode is ProxyResource { + @doc("DbNode OCID.") + @key("dbnodeocid") + @segment("dbNodes") + @path + @pattern(".*") + name: Ocid; +} + +// https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DbNodeSummary +@doc("The properties of DbNodeResource") +model DbNodeProperties { + @doc("DbNode OCID") + @visibility("read") + ocid: Ocid; + + @doc("Additional information about the planned maintenance.") + @visibility("read") + additionalDetails?: string; + + @doc("The OCID of the backup IP address associated with the database node.") + @visibility("read") + backupIpId?: Ocid; + + @doc("The OCID of the second backup VNIC.") + @visibility("read") + backupVnic2Id?: Ocid; + + @doc("The OCID of the backup VNIC.") + @visibility("read") + backupVnicId?: Ocid; + + @doc("The number of CPU cores enabled on the Db node.") + @visibility("read") + cpuCoreCount?: int32; + + @doc("The allocated local node storage in GBs on the Db node.") + @visibility("read") + dbNodeStorageSizeInGbs?: int32; + + @doc("The OCID of the Exacc Db server associated with the database node.") + @visibility("read") + dbServerId?: Ocid; + + @doc("The OCID of the DB system.") + @visibility("read") + dbSystemId: Ocid; + + @doc("The name of the Fault Domain the instance is contained in.") + @minLength(1) + @maxLength(255) + @visibility("read") + faultDomain?: string; + + @doc("The OCID of the host IP address associated with the database node.") + @visibility("read") + hostIpId?: Ocid; + + @doc("The host name for the database node.") + @visibility("read") + hostname?: string; + + @doc("The current state of the database node.") + @visibility("read") + lifecycleState?: DbNodeProvisioningState; + + @doc("Lifecycle details of Db Node.") + @visibility("read") + lifecycleDetails?: string; + + @doc("The type of database node maintenance.") + @visibility("read") + maintenanceType?: DbNodeMaintenanceType; + + @doc("The allocated memory in GBs on the Db node.") + @visibility("read") + memorySizeInGbs?: int32; + + @doc("The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.") + @visibility("read") + softwareStorageSizeInGb?: int32; + + @doc("The date and time that the database node was created.") + @visibility("read") + timeCreated?: utcDateTime; + + @doc("End date and time of maintenance window.") + @visibility("read") + timeMaintenanceWindowEnd?: utcDateTime; + + @doc("Start date and time of maintenance window.") + @visibility("read") + timeMaintenanceWindowStart?: utcDateTime; + + @doc("The OCID of the second VNIC.") + @visibility("read") + vnic2Id?: Ocid; + + @doc("The OCID of the VNIC.") + @visibility("read") + vnicId?: Ocid; + + @doc("Azure resource provisioning state.") + @visibility("read") + provisioningState?: ResourceProvisioningState; +} + +@doc("The type of database node maintenance.") +union DbNodeMaintenanceType { + @doc("VMDB reboot migration maintenance type") + VmdbRebootMigration: "VmdbRebootMigration", + + string, +} + +@doc("DnNode provisioning state enum") +union DbNodeProvisioningState { + @doc("Indicates that resource in Provisioning state") + Provisioning: "Provisioning", + + @doc("Indicates that resource in Available state") + Available: "Available", + + @doc("Indicates that resource in Updating state") + Updating: "Updating", + + @doc("Indicates that resource in Stopping state") + Stopping: "Stopping", + + @doc("Indicates that resource in Stopped state") + Stopped: "Stopped", + + @doc("Indicates that resource in Starting state") + Starting: "Starting", + + @doc("Indicates that resource in Terminating state") + Terminating: "Terminating", + + @doc("Indicates that resource in Terminated state") + Terminated: "Terminated", + + @doc("Indicates that resource in Failed state") + Failed: "Failed", + + string, +} + +@doc("DbNode action enum") +union DbNodeActionEnum { + @doc("Start DbNode") + Start: "Start", + + @doc("Stop DbNode") + Stop: "Stop", + + @doc("Soft reset DbNode") + SoftReset: "SoftReset", + + @doc("Reset DbNode") + Reset: "Reset", + + string, +} + +@doc("DbNode action object") +model DbNodeAction { + @doc("Db action") + action: DbNodeActionEnum; +} diff --git a/specification/oracle/models/exadata/dbServers.tsp b/specification/oracle/models/exadata/dbServers.tsp new file mode 100644 index 000000000000..c89a45af5796 --- /dev/null +++ b/specification/oracle/models/exadata/dbServers.tsp @@ -0,0 +1,167 @@ +import "../common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.ResourceManager; + +namespace Oracle.Database; + +@doc("DbServer resource model") +@parentResource(CloudExadataInfrastructure) +model DbServer is ProxyResource { + @key("dbserverocid") + @doc("DbServer OCID.") + @segment("dbServers") + @path + @pattern(".*") + name: Ocid; +} + +@doc("DB Server patching status enum") +union DbServerPatchingStatus { + @doc("Patching scheduled") + Scheduled: "Scheduled", + + @doc("Patching in progress") + MaintenanceInProgress: "MaintenanceInProgress", + + @doc("Patching failed") + Failed: "Failed", + + @doc("Patching completed") + Complete: "Complete", + + string, +} + +@doc("DbServer Patching Properties") +model DbServerPatchingDetails { + @doc("Estimated Patch Duration") + @visibility("read") + @minValue(1) + @maxValue(3000) + estimatedPatchDuration?: int32; + + @doc("Patching Status") + @visibility("read") + patchingStatus?: DbServerPatchingStatus; + + @doc("Time Patching Ended") + @visibility("read") + timePatchingEnded?: utcDateTime; + + @doc("Time Patching Started") + @visibility("read") + timePatchingStarted?: utcDateTime; +} + +// https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DbServerSummary +@doc("DbServer resource properties") +model DbServerProperties { + @doc("Db server name.") + @visibility("read") + ocid?: Ocid; + + @doc("The name for the Db Server.") + @minLength(1) + @maxLength(255) + @visibility("read") + displayName?: string; + + @doc("The OCID of the compartment.") + @visibility("read") + compartmentId?: Ocid; + + @doc("The OCID of the Exadata infrastructure.") + @visibility("read") + exadataInfrastructureId?: Ocid; + + @doc("The number of CPU cores enabled on the Db server.") + @visibility("read") + cpuCoreCount?: int32; + + @doc("dbServerPatching details of the Db server.") + @visibility("read") + dbServerPatchingDetails?: DbServerPatchingDetails; + + @doc("The total memory available in GBs.") + @visibility("read") + maxMemoryInGbs?: int32; + + @doc("The allocated local node storage in GBs on the Db server.") + @visibility("read") + dbNodeStorageSizeInGbs?: int32; + + @doc("The OCID of the VM Clusters associated with the Db server.") + @visibility("read") + vmClusterIds?: Ocid[]; + + @doc("The OCID of the Db nodes associated with the Db server.") + @visibility("read") + dbNodeIds?: Ocid[]; + + @doc("Lifecycle details of dbServer.") + @visibility("read") + lifecycleDetails?: string; + + @doc("DbServer provisioning state.") + @visibility("read") + lifecycleState?: DbServerProvisioningState; + + @doc("The total number of CPU cores available.") + @visibility("read") + maxCpuCount?: int32; + + @doc("The list of OCIDs of the Autonomous VM Clusters associated with the Db server.") + @visibility("read") + autonomousVmClusterIds?: Ocid[]; + + @doc("The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.") + @visibility("read") + autonomousVirtualMachineIds?: Ocid[]; + + @doc("The total max dbNode storage in GBs.") + @visibility("read") + maxDbNodeStorageInGbs?: int32; + + @doc("The total memory size in GBs.") + @visibility("read") + memorySizeInGbs?: int32; + + @doc("The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.") + @visibility("read") + @minLength(1) + @maxLength(255) + shape?: string; + + @doc("The date and time that the Db Server was created.") + @visibility("read") + timeCreated?: utcDateTime; + + @doc("Azure resource provisioning state.") + @visibility("read") + provisioningState?: ResourceProvisioningState; +} + +@doc("DbServerProvisioningState enum") +union DbServerProvisioningState { + @doc("Indicates that resource in Creating state") + Creating: "Creating", + + @doc("Indicates that resource in Available state") + Available: "Available", + + @doc("Indicates that resource in Unavailable state") + Unavailable: "Unavailable", + + @doc("Indicates that resource in Deleting state") + Deleting: "Deleting", + + @doc("Indicates that resource in Deleted state") + Deleted: "Deleted", + + @doc("Indicates that resource maintenance in progress state") + MaintenanceInProgress: "MaintenanceInProgress", + + string, +} diff --git a/specification/oracle/models/exadata/dbSystemShapes.tsp b/specification/oracle/models/exadata/dbSystemShapes.tsp new file mode 100644 index 000000000000..c76cf13f1f79 --- /dev/null +++ b/specification/oracle/models/exadata/dbSystemShapes.tsp @@ -0,0 +1,102 @@ +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Rest; + +namespace Oracle.Database; + +@doc("DbSystemShape resource definition") +@parentResource(SubscriptionLocationResource) +model DbSystemShape is ProxyResource { + @doc("DbSystemShape name") + @key("dbsystemshapename") + @path + @segment("dbSystemShapes") + @pattern(".*") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Read-only resource. No provisioning state provided." +@doc("DbSystemShape resource model") +model DbSystemShapeProperties { + @doc("The family of the shape used for the DB system.") + @visibility("read") + @minLength(1) + @maxLength(255) + shapeFamily?: string; + + @doc("The maximum number of CPU cores that can be enabled on the DB system for this shape.") + @visibility("read") + availableCoreCount: int32; + + @doc("The minimum number of CPU cores that can be enabled on the DB system for this shape.") + @visibility("read") + minimumCoreCount?: int32; + + @doc("The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.") + @visibility("read") + runtimeMinimumCoreCount?: int32; + + @doc("The discrete number by which the CPU core count for this shape can be increased or decreased.") + @visibility("read") + coreCountIncrement?: int32; + + @doc("The minimum number of Exadata storage servers available for the Exadata infrastructure.") + @visibility("read") + minStorageCount?: int32; + + @doc("The maximum number of Exadata storage servers available for the Exadata infrastructure.") + @visibility("read") + maxStorageCount?: int32; + + @doc("The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.") + @visibility("read") + availableDataStoragePerServerInTbs?: float64; + + @doc("The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.") + @visibility("read") + availableMemoryPerNodeInGbs?: int32; + + @doc("The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.") + @visibility("read") + availableDbNodePerNodeInGbs?: int32; + + @doc("The minimum number of CPU cores that can be enabled per node for this shape.") + @visibility("read") + minCoreCountPerNode?: int32; + + @doc("The maximum memory that can be enabled for this shape.") + @visibility("read") + availableMemoryInGbs?: int32; + + @doc("The minimum memory that need be allocated per node for this shape.") + @visibility("read") + minMemoryPerNodeInGbs?: int32; + + @doc("The maximum Db Node storage that can be enabled for this shape.") + @visibility("read") + availableDbNodeStorageInGbs?: int32; + + @doc("The minimum Db Node storage that need be allocated per node for this shape.") + @visibility("read") + minDbNodeStoragePerNodeInGbs?: int32; + + @doc("The maximum DATA storage that can be enabled for this shape.") + @visibility("read") + availableDataStorageInTbs?: int32; + + @doc("The minimum data storage that need be allocated for this shape.") + @visibility("read") + minDataStorageInTbs?: int32; + + @doc("The minimum number of database nodes available for this shape.") + @visibility("read") + minimumNodeCount?: int32; + + @doc("The maximum number of database nodes available for this shape.") + @visibility("read") + maximumNodeCount?: int32; + + @doc("The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.") + @visibility("read") + availableCoreCountPerNode?: int32; +} diff --git a/specification/oracle/models/exadata/dnsPrivateViews.tsp b/specification/oracle/models/exadata/dnsPrivateViews.tsp new file mode 100644 index 000000000000..d697db6a5313 --- /dev/null +++ b/specification/oracle/models/exadata/dnsPrivateViews.tsp @@ -0,0 +1,70 @@ +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Rest; + +namespace Oracle.Database; + +// https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/ + +@doc("DnsPrivateView resource definition") +@parentResource(SubscriptionLocationResource) +model DnsPrivateView is ProxyResource { + @doc("DnsPrivateView OCID") + @key("dnsprivateviewocid") + @path + @segment("dnsPrivateViews") + @pattern(".*") + name: Ocid; +} + +@doc("Views resource model") +model DnsPrivateViewProperties { + @doc("The OCID of the view") + @visibility("read") + ocid: Ocid; + + @doc("The display name of the view resource") + @visibility("read") + displayName?: string; + + @doc("A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.") + @visibility("read") + isProtected: boolean; + + @doc("Views lifecycleState") + @visibility("read") + lifecycleState?: DnsPrivateViewsLifecycleState; + + @doc("The canonical absolute URL of the resource.") + @visibility("read") + self: string; + + @doc("views timeCreated") + @visibility("read") + timeCreated: utcDateTime; + + @doc("views timeCreated") + @visibility("read") + timeUpdated: utcDateTime; + + @doc("Azure resource provisioning state.") + @visibility("read") + provisioningState?: ResourceProvisioningState; +} + +@doc("DNS Private Views lifecycle state enum") +union DnsPrivateViewsLifecycleState { + @doc("DNS Private View is active") + Active: "Active", + + @doc("DNS Private View is deleted") + Deleted: "Deleted", + + @doc("DNS Private View is deleting") + Deleting: "Deleting", + + @doc("DNS Private View is updating") + Updating: "Updating", + + string, +} diff --git a/specification/oracle/models/exadata/dnsPrivateZones.tsp b/specification/oracle/models/exadata/dnsPrivateZones.tsp new file mode 100644 index 000000000000..7713ed63fb9b --- /dev/null +++ b/specification/oracle/models/exadata/dnsPrivateZones.tsp @@ -0,0 +1,94 @@ +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.Core; +using Azure.ResourceManager; +using OpenAPI; + +namespace Oracle.Database; + +// https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/ + +@doc("DnsPrivateZone resource definition") +@parentResource(SubscriptionLocationResource) +model DnsPrivateZone is ProxyResource { + @doc("DnsPrivateZone name") + @key("dnsprivatezonename") + @path + @segment("dnsPrivateZones") + @pattern(".*") + name: string; +} + +@doc("Zones resource model") +model DnsPrivateZoneProperties { + @doc("The OCID of the Zone") + @visibility("read") + ocid: Ocid; + + @doc("A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.") + @visibility("read") + isProtected: boolean; + + @doc("Zones lifecycleState") + @visibility("read") + lifecycleState?: DnsPrivateZonesLifecycleState; + + @doc("The canonical absolute URL of the resource.") + @visibility("read") + self: string; + + @doc("The current serial of the zone. As seen in the zone's SOA record.") + @visibility("read") + serial: int32; + + @doc("Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.") + @visibility("read") + version: string; + + @doc("The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.") + @visibility("read") + viewId?: Ocid; + + @doc("The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.") + @visibility("read") + zoneType: ZoneType; + + @doc("Zones timeCreated") + @visibility("read") + timeCreated: utcDateTime; + + @doc("Azure resource provisioning state.") + @visibility("read") + provisioningState?: ResourceProvisioningState; +} + +@doc("DNS Private Zones lifecycle state enum") +union DnsPrivateZonesLifecycleState { + @doc("DNS Private Zones is active") + Active: "Active", + + @doc("DNS Private Zones is creating") + Creating: "Creating", + + @doc("DNS Private Zones is deleted") + Deleted: "Deleted", + + @doc("DNS Private Zones is deleting") + Deleting: "Deleting", + + @doc("DNS Private Zones is updating") + Updating: "Updating", + + string, +} + +@doc("Zone type enum") +union ZoneType { + @doc("Primary zone") + Primary: "Primary", + + @doc("Secondary zone") + Secondary: "Secondary", + + string, +} diff --git a/specification/oracle/models/exadata/exadatainfra.tsp b/specification/oracle/models/exadata/exadatainfra.tsp new file mode 100644 index 000000000000..418513e20dc7 --- /dev/null +++ b/specification/oracle/models/exadata/exadatainfra.tsp @@ -0,0 +1,269 @@ +import "../common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.Core; +using Azure.ResourceManager; +using OpenAPI; + +namespace Oracle.Database; + +@doc("Patching mode enum") +union PatchingMode { + @doc("Rolling patching") + Rolling: "Rolling", + + @doc("Non Rolling patching") + NonRolling: "NonRolling", + + string, +} + +@doc("Preference enum") +union Preference { + @doc("No preference") + NoPreference: "NoPreference", + + @doc("Custom preference") + CustomPreference: "CustomPreference", + + string, +} + +@doc("CloudExadataInfrastructureLifecycleState enum") +union CloudExadataInfrastructureLifecycleState { + @doc("Indicates that resource in Provisioning state") + Provisioning: "Provisioning", + + @doc("Indicates that resource in Available state") + Available: "Available", + + @doc("Indicates that resource in Updating state") + Updating: "Updating", + + @doc("Indicates that resource in Terminating state") + Terminating: "Terminating", + + @doc("Indicates that resource in Terminated state") + Terminated: "Terminated", + + @doc("Indicates that resource maintenance in progress state") + MaintenanceInProgress: "MaintenanceInProgress", + + @doc("Indicates that resource in Failed state") + Failed: "Failed", + + string, +} + +@doc("MaintenanceWindow resource properties") +model MaintenanceWindow { + @doc("The maintenance window scheduling preference.") + preference?: Preference; + + @doc("Months during the year when maintenance should be performed.") + @extension("x-ms-identifiers", ["name"]) + months?: Month[]; + + @doc("Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ") + weeksOfMonth?: int32[]; + + @doc("Days during the week when maintenance should be performed.") + @extension("x-ms-identifiers", ["name"]) + daysOfWeek?: DayOfWeek[]; + + @doc("The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC") + hoursOfDay?: int32[]; + + @doc("Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ") + leadTimeInWeeks?: int32; + + @doc("Cloud Exadata infrastructure node patching method.") + patchingMode?: PatchingMode; + + // OCI Docs say min value is 15, but when making the call in OCI, observed a value of 0, so setting minimum value to 0. + // Link: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow + @doc("Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).") + @minValue(0) + @maxValue(120) + customActionTimeoutInMins?: int32; + + @doc("If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.") + isCustomActionTimeoutEnabled?: boolean; + + // isMonthlyPatchingEnabled parameter was found in response in OCI, but is not found in OCI Docs: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow + @doc("is Monthly Patching Enabled") + isMonthlyPatchingEnabled?: boolean; +} + +@doc("The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).") +model EstimatedPatchingTime { + @doc("The estimated time required in minutes for database server patching.") + @minValue(1) + @maxValue(3000) + @visibility("read") + estimatedDbServerPatchingTime?: int32; + + @doc("The estimated time required in minutes for network switch patching.") + @minValue(1) + @maxValue(3000) + @visibility("read") + estimatedNetworkSwitchesPatchingTime?: int32; + + @doc("The estimated time required in minutes for storage server patching.") + @minValue(1) + @maxValue(3000) + @visibility("read") + estimatedStorageServerPatchingTime?: int32; + + @doc("The estimated total time required in minutes for all patching operations.") + @minValue(1) + @maxValue(3000) + @visibility("read") + totalEstimatedPatchingTime?: int32; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" +@doc("CloudExadataInfrastructure resource definition") +model CloudExadataInfrastructure + is TrackedResource { + @doc("CloudExadataInfrastructure name") + @key("cloudexadatainfrastructurename") + @path + @segment("cloudExadataInfrastructures") + @pattern(".*") + name: string; + + @doc("CloudExadataInfrastructure zones") + zones: string[]; +} + +@doc("CloudExadataInfrastructure resource model") +model CloudExadataInfrastructureProperties { + @doc("Exadata infra ocid") + @visibility("read") + ocid?: Ocid; + + @doc("The number of compute servers for the cloud Exadata infrastructure.") + @visibility("create", "read", "update") + computeCount?: int32; + + @doc("The number of storage servers for the cloud Exadata infrastructure.") + @visibility("create", "read", "update") + storageCount?: int32; + + @doc("The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).") + @visibility("read") + totalStorageSizeInGbs?: int32; + + @doc("The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).") + @visibility("read") + availableStorageSizeInGbs?: int32; + + @doc("The date and time the cloud Exadata infrastructure resource was created.") + @visibility("read") + timeCreated?: string; + + @doc("Additional information about the current lifecycle state.") + @visibility("read") + lifecycleDetails?: string; + + @doc("maintenanceWindow property") + @visibility("create", "read", "update") + maintenanceWindow?: MaintenanceWindow; + + @doc("The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).") + @visibility("read") + estimatedPatchingTime?: EstimatedPatchingTime; + + @doc("The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ") + @extension("x-ms-identifiers", []) + @visibility("create", "read", "update") + customerContacts?: CustomerContact[]; + + @doc("CloudExadataInfrastructure provisioning state") + @visibility("read") + provisioningState?: AzureResourceProvisioningState; + + @doc("CloudExadataInfrastructure lifecycle state") + @visibility("read") + lifecycleState?: CloudExadataInfrastructureLifecycleState; + + @doc("The model name of the cloud Exadata infrastructure resource.") + @visibility("create", "read") + shape: string; + + @doc("HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.") + @visibility("read") + ociUrl?: url; + + @doc("The total number of CPU cores allocated.") + @visibility("read") + cpuCount?: int32; + + @doc("The total number of CPU cores available.") + @visibility("read") + maxCpuCount?: int32; + + @doc("The memory allocated in GBs.") + @visibility("read") + memorySizeInGbs?: int32; + + @doc("The total memory available in GBs.") + @visibility("read") + maxMemoryInGbs?: int32; + + @doc("The local node storage to be allocated in GBs.") + @visibility("read") + dbNodeStorageSizeInGbs?: int32; + + @doc("The total local node storage available in GBs.") + @visibility("read") + maxDbNodeStorageSizeInGbs?: int32; + + @doc("The quantity of data in the database, in terabytes.") + @visibility("read") + dataStorageSizeInTbs?: float64; + + @doc("The total available DATA disk group size.") + @visibility("read") + maxDataStorageInTbs?: float64; + + @doc("The software version of the database servers (dom0) in the Exadata infrastructure.") + @visibility("read") + dbServerVersion?: string; + + @doc("The software version of the storage servers (cells) in the Exadata infrastructure.") + @visibility("read") + storageServerVersion?: string; + + @doc("The requested number of additional storage servers activated for the Exadata infrastructure.") + @visibility("read") + activatedStorageCount?: int32; + + @doc("The requested number of additional storage servers for the Exadata infrastructure.") + @visibility("read") + additionalStorageCount?: int32; + + @doc("The name for the Exadata infrastructure.") + @visibility("create", "read", "update") + @minLength(1) + @maxLength(255) + displayName: string; + + @doc("The OCID of the last maintenance run.") + @visibility("read") + lastMaintenanceRunId?: Ocid; + + @doc("The OCID of the next maintenance run.") + @visibility("read") + nextMaintenanceRunId?: Ocid; + + @doc("Monthly Db Server version") + @visibility("read") + monthlyDbServerVersion?: string; + + @doc("Monthly Storage Server version") + @visibility("read") + monthlyStorageServerVersion?: string; +} diff --git a/specification/oracle/models/exadata/giVersions.tsp b/specification/oracle/models/exadata/giVersions.tsp new file mode 100644 index 000000000000..b61ac14c9d23 --- /dev/null +++ b/specification/oracle/models/exadata/giVersions.tsp @@ -0,0 +1,26 @@ +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Rest; + +namespace Oracle.Database; + +@doc("GiVersion resource definition") +@parentResource(SubscriptionLocationResource) +model GiVersion is ProxyResource { + @doc("GiVersion name") + @key("giversionname") + @path + @segment("giVersions") + @pattern(".*") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Read-only resource. No provisioning state provided." +@doc("GiVersion resource model") +model GiVersionProperties { + @doc("A valid Oracle Grid Infrastructure (GI) software version.") + @visibility("read") + @minLength(1) + @maxLength(255) + version: string; +} diff --git a/specification/oracle/models/exadata/privateIpAddresses.tsp b/specification/oracle/models/exadata/privateIpAddresses.tsp new file mode 100644 index 000000000000..b49500206555 --- /dev/null +++ b/specification/oracle/models/exadata/privateIpAddresses.tsp @@ -0,0 +1,35 @@ +import "../common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.Core; + +namespace Oracle.Database; + +@doc("Private Ip Addresses filter") +model PrivateIpAddressesFilter { + @doc("Subnet OCID") + subnetId: Ocid; + + @doc("VCN OCID") + vnicId: Ocid; +} + +@doc("PrivateIpAddress resource properties") +model PrivateIpAddressProperties { + @doc("PrivateIpAddresses displayName") + displayName: string; + + @doc("PrivateIpAddresses hostnameLabel") + hostnameLabel: string; + + @doc("PrivateIpAddresses Id") + ocid: Ocid; + + @doc("PrivateIpAddresses ipAddress") + ipAddress: string; + + @doc("PrivateIpAddresses subnetId") + subnetId: Ocid; +} diff --git a/specification/oracle/models/exadata/systemVersions.tsp b/specification/oracle/models/exadata/systemVersions.tsp new file mode 100644 index 000000000000..bfd2ed4af0d8 --- /dev/null +++ b/specification/oracle/models/exadata/systemVersions.tsp @@ -0,0 +1,36 @@ +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Rest; + +namespace Oracle.Database; + +@doc("SystemVersion resource Definition") +@parentResource(SubscriptionLocationResource) +model SystemVersion is ProxyResource { + @doc("SystemVersion name") + @key("systemversionname") + @path + @segment("systemVersions") + @pattern(".*") + name: string; +} + +@doc("SystemVersions filter") +model SystemVersionsFilter { + @doc("Grid Infrastructure version") + giVersion: string; + + @doc("Exadata shape") + shape: string; + + @doc("Check If we have to list only latest versions") + isLatestVersion?: boolean; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Read-only resource. No provisioning state provided." +@doc("System Version Resource model") +model SystemVersionProperties { + @doc("A valid Oracle System Version") + @visibility("read") + systemVersion: string; +} diff --git a/specification/oracle/models/exadata/virtualNetworkAddress.tsp b/specification/oracle/models/exadata/virtualNetworkAddress.tsp new file mode 100644 index 000000000000..bd67d5ee610a --- /dev/null +++ b/specification/oracle/models/exadata/virtualNetworkAddress.tsp @@ -0,0 +1,84 @@ +import "../common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.Core; +using Azure.ResourceManager; +using OpenAPI; + +namespace Oracle.Database; + +// https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ApplicationVip/ + +@doc("VirtualNetworkAddressLifecycleState enum") +union VirtualNetworkAddressLifecycleState { + @doc("Indicates that resource in Provisioning state") + Provisioning: "Provisioning", + + @doc("Indicates that resource in Available state") + Available: "Available", + + @doc("Indicates that resource in Terminating state") + Terminating: "Terminating", + + @doc("Indicates that resource in Terminated state") + Terminated: "Terminated", + + @doc("Indicates that resource in Failed state") + Failed: "Failed", + + string, +} + +@doc("Virtual IP resource belonging to a vm cluster resource.") +@parentResource(CloudVmCluster) +model VirtualNetworkAddress is ProxyResource { + @doc("Virtual IP address hostname.") + @key("virtualnetworkaddressname") + @path + @segment("virtualNetworkAddresses") + @minLength(1) + @maxLength(63) + @pattern(".*") + name: string; +} + +@doc("virtualNetworkAddress resource properties") +model VirtualNetworkAddressProperties { + @doc("Virtual network Address address.") + @visibility("create", "read") + ipAddress?: string; + + @doc("Virtual Machine OCID.") + @visibility("create", "read") + vmOcid?: Ocid; + + @doc("Application VIP OCID.") + @visibility("read") + ocid?: Ocid; + + @doc("Virtual network address fully qualified domain name.") + @visibility("read") + domain?: string; + + @doc("Additional information about the current lifecycle state of the application virtual IP (VIP) address.") + @visibility("read") + lifecycleDetails?: string; + + //Subnet should be retrieved from the VM Cluster + // @doc("Client subnet") + // @visibility("create", "read") + // subnetId?: SubnetId; + + @doc("Azure resource provisioning state.") + @visibility("read") + provisioningState?: AzureResourceProvisioningState; + + @doc("virtual network address lifecycle state.") + @visibility("read") + lifecycleState?: VirtualNetworkAddressLifecycleState; + + @doc("The date and time when the create operation for the application virtual IP (VIP) address completed.") + @visibility("read") + timeAssigned?: utcDateTime; +} diff --git a/specification/oracle/models/exadata/vmcluster.tsp b/specification/oracle/models/exadata/vmcluster.tsp new file mode 100644 index 000000000000..e3ea86bd0e51 --- /dev/null +++ b/specification/oracle/models/exadata/vmcluster.tsp @@ -0,0 +1,396 @@ +import "../common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using OpenAPI; + +namespace Oracle.Database; + +scalar CloudExadataInfrastructureId + extends armResourceIdentifier<[ + { + type: "Oracle.Database/cloudExadataInfrastructures", + } + ]>; + +@doc("DataCollectionOptions resource properties") +model DataCollectionOptions { + @doc("Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS.") + isDiagnosticsEventsEnabled?: boolean = false; + + @doc("Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.") + isHealthMonitoringEnabled?: boolean = false; + + @doc("Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.") + isIncidentLogsEnabled?: boolean = false; +} + +@doc("Update action enum") +union UpdateAction { + @doc("Rolling apply action") + RollingApply: "RollingApply", + + @doc("Non rolling apply action") + NonRollingApply: "NonRollingApply", + + @doc("Pre-check action") + PreCheck: "PreCheck", + + @doc("Rollback action") + RollBack: "RollBack", + + string, +} + +@doc("ExadataIormConfig for cloud vm cluster") +model ExadataIormConfig { + @doc("An array of IORM settings for all the database in the Exadata DB system.") + @extension("x-ms-identifiers", []) + dbPlans?: DbIormConfig[]; + + @doc("Additional information about the current lifecycleState.") + lifecycleDetails?: string; + + @doc("The current state of IORM configuration for the Exadata DB system.") + lifecycleState?: IormLifecycleState; + + @doc("The current value for the IORM objective. The default is AUTO.") + objective?: Objective; +} + +@doc("DbIormConfig for cloud vm cluster") +model DbIormConfig { + @doc("The database name. For the default DbPlan, the dbName is default.") + dbName?: string; + + @doc("The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.") + flashCacheLimit?: string; + + @doc("The relative priority of this database.") + @minValue(1) + @maxValue(32) + share?: int32; +} + +@doc("Objective enum") +union Objective { + @doc("Low latency objective") + LowLatency: "LowLatency", + + @doc("High throughput objective") + HighThroughput: "HighThroughput", + + @doc("Balanced objective") + Balanced: "Balanced", + + @doc("Auto objective") + Auto: "Auto", + + @doc("Basic objective") + Basic: "Basic", + + string, +} + +@doc("ORM lifecycle state enum") +union IormLifecycleState { + @doc("Indicates that resource in Provisioning state") + BootStrapping: "BootStrapping", + + @doc("Indicates that resource in Enabled state") + Enabled: "Enabled", + + @doc("Indicates that resource in Disabled state") + Disabled: "Disabled", + + @doc("Indicates that resource in Updating state") + Updating: "Updating", + + @doc("Indicates that resource in Failed state") + Failed: "Failed", + + string, +} + +@doc("Disk redundancy enum") +union DiskRedundancy { + @doc("High redundancy") + High: "High", + + @doc("Normal redundancy") + Normal: "Normal", + + string, +} + +@doc("Cloud VM Cluster lifecycle state enum") +union CloudVmClusterLifecycleState { + @doc("Indicates that resource in Provisioning state") + Provisioning: "Provisioning", + + @doc("Indicates that resource in Available state") + Available: "Available", + + @doc("Indicates that resource in Updating state") + Updating: "Updating", + + @doc("Indicates that resource in Terminating state") + Terminating: "Terminating", + + @doc("Indicates that resource in Terminated state") + Terminated: "Terminated", + + @doc("Indicates that resource Maintenance in progress state") + MaintenanceInProgress: "MaintenanceInProgress", + + @doc("Indicates that resource in Failed state") + Failed: "Failed", + + string, +} + +@doc("CloudVmCluster resource definition") +model CloudVmCluster is TrackedResource { + @doc("CloudVmCluster name") + @key("cloudvmclustername") + @path + @segment("cloudVmClusters") + @pattern(".*") + name: string; +} + +@doc("Port Range to specify particular destination ports for TCP rules.") +model PortRange { + @doc("The minimum port number, which must not be greater than the maximum port number.") + @minValue(1) + @maxValue(65535) + min: int32; + + @doc("The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.") + @minValue(1) + @maxValue(65535) + max: int32; +} + +@doc("A rule for allowing inbound (INGRESS) IP packets") +model NsgCidr { + @doc("Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.") + @minLength(1) + @maxLength(128) + source: string; + + @doc("Destination port range to specify particular destination ports for TCP rules.") + destinationPortRange?: PortRange; +} + +@doc("CloudVmCluster resource model") +model CloudVmClusterProperties { + @doc("Cloud VM Cluster ocid") + @visibility("read") + ocid?: Ocid; + + @doc("The port number configured for the listener on the cloud VM cluster.") + @visibility("read") + listenerPort?: int64; + + @doc("The number of nodes in the cloud VM cluster. ") + @visibility("read") + nodeCount?: int32; + + @doc("The data disk group size to be allocated in GBs per VM.") + @visibility("read", "update") + storageSizeInGbs?: int32; + + @doc("The data disk group size to be allocated in TBs.") + dataStorageSizeInTbs?: float64; + + @doc("The local node storage to be allocated in GBs.") + dbNodeStorageSizeInGbs?: int32; + + @doc("The memory to be allocated in GBs.") + memorySizeInGbs?: int32; + + @doc("The date and time that the cloud VM cluster was created.") + @visibility("read") + timeCreated?: utcDateTime; + + @doc("Additional information about the current lifecycle state.") + @visibility("read") + lifecycleDetails?: string; + + @doc("The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm).") + @visibility("create", "read") + @minLength(1) + @maxLength(255) + timeZone?: string; + + @doc("The OCID of the zone the cloud VM cluster is associated with.") + @visibility("create", "read") + zoneId?: Ocid; + + @doc("The hostname for the cloud VM cluster.") + @visibility("create", "read") + @minLength(1) + @maxLength(23) + hostname: string; + + @doc("The domain name for the cloud VM cluster.") + @visibility("create", "read") + domain?: string; + + @doc("The number of CPU cores enabled on the cloud VM cluster.") + cpuCoreCount: int32; + + @doc("The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.") + ocpuCount?: float32; + + @doc("The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ") + @visibility("create", "read") + @minLength(1) + @maxLength(11) + clusterName?: string; + + @doc("The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ") + @visibility("create", "read") + dataStoragePercentage?: int32; + + @doc("If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ") + @visibility("create", "read") + isLocalBackupEnabled?: boolean = false; + + @doc("Cloud Exadata Infrastructure ID") + @visibility("create", "read") + cloudExadataInfrastructureId: CloudExadataInfrastructureId; + + @doc("If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ") + @visibility("create", "read") + isSparseDiskgroupEnabled?: boolean = false; + + @doc("Operating system version of the image.") + @visibility("create", "read") + @minLength(1) + @maxLength(255) + systemVersion?: string; + + @doc("The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.") + sshPublicKeys: string[]; + + @doc("The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ") + licenseModel?: LicenseModel; + + @doc("The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ") + @visibility("read") + diskRedundancy?: DiskRedundancy; + + @doc("The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.") + @visibility("read") + scanIpIds?: string[]; + + @doc("The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.") + @visibility("read") + vipIds?: string[]; + + @doc("The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ") + @visibility("read") + @minLength(1) + @maxLength(72) + scanDnsName?: string; + + @doc("The TCP Single Client Access Name (SCAN) port. The default port is 1521.") + @visibility("create", "read") + scanListenerPortTcp?: int32; + + @doc("The TCPS Single Client Access Name (SCAN) port. The default port is 2484.") + @visibility("create", "read") + scanListenerPortTcpSsl?: int32; + + @doc("The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.") + @visibility("read") + scanDnsRecordId?: Ocid; + + @doc("The model name of the Exadata hardware running the cloud VM cluster.") + @visibility("read") + @minLength(1) + @maxLength(255) + shape?: string; + + @doc("CloudVmCluster provisioning state") + @visibility("read") + provisioningState?: AzureResourceProvisioningState; + + @doc("CloudVmCluster lifecycle state") + @visibility("read") + lifecycleState?: CloudVmClusterLifecycleState; + + @doc("VNET for network connectivity") + @visibility("create", "read") + vnetId: VnetId; + + @doc("Oracle Grid Infrastructure (GI) software version") + @visibility("create", "read") + giVersion: string; + + @doc("HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.") + @visibility("read") + ociUrl?: url; + + @doc("HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.") + @visibility("read") + nsgUrl?: url; + + @doc("Client subnet") + @visibility("create", "read") + subnetId: SubnetId; + + @doc("Client OCI backup subnet CIDR, default is 192.168.252.0/22") + @visibility("create", "read") + @minLength(1) + @maxLength(32) + backupSubnetCidr?: string; + + @doc("CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.") + @visibility("create", "read") + @extension("x-ms-identifiers", []) + nsgCidrs?: NsgCidr[]; + + @doc("Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.") + dataCollectionOptions?: DataCollectionOptions; + + @doc("Display Name") + @minLength(1) + @maxLength(255) + displayName: string; + + @doc("The list of compute servers to be added to the cloud VM cluster.") + @visibility("update") + computeNodes?: Ocid[]; + + @doc("iormConfigCache details for cloud VM cluster.") + @visibility("read") + iormConfigCache?: ExadataIormConfig; + + @doc("The OCID of the last maintenance update history entry.") + @visibility("read") + lastUpdateHistoryEntryId?: Ocid; + + @doc("The list of DB servers.") + @visibility("create", "read") + dbServers?: Ocid[]; + + @doc("Cluster compartmentId") + @visibility("read") + compartmentId?: Ocid; + + @doc("Cluster subnet ocid") + @visibility("read") + subnetOcid?: Ocid; +} + +@doc("Add/Remove (Virtual Machine) DbNode model") +model AddRemoveDbNode { + @doc("Db servers ocids") + dbServers: Array; +} diff --git a/specification/oracle/models/oraclesubscription/oracleSubscription.tsp b/specification/oracle/models/oraclesubscription/oracleSubscription.tsp new file mode 100644 index 000000000000..35f57cae1404 --- /dev/null +++ b/specification/oracle/models/oraclesubscription/oracleSubscription.tsp @@ -0,0 +1,177 @@ +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.ResourceManager; + +namespace Oracle.Database; + +@doc("OracleSubscriptionProvisioningState enum") +union OracleSubscriptionProvisioningState { + ResourceProvisioningState, + string, +} + +@singleton +@subscriptionResource +@doc("OracleSubscription resource definition") +@friendlyName("OracleSubscription") +model OracleSubscription + is ProxyResource { + @doc("OracleSubscription name") + @key("oraclesubscriptionname") + @path + @segment("oracleSubscriptions") + @pattern(".*") + name: string; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" + @doc("Details of the resource plan.") + plan?: ResourcePlanType; +} + +// Azure specs do not support update model for resource plan +@doc("ResourcePlanTypeUpdate model definition") +model PlanUpdate { + @doc("A user defined name of the 3rd Party Artifact that is being procured.") + name?: string; + + @doc("The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic") + publisher?: string; + + @doc("The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ") + product?: string; + + @doc("A publisher provided promotion code as provisioned in Data Market for the said product/artifact.") + promotionCode?: string; + + @doc("The version of the desired product/artifact.") + version?: string; +} + +@doc("CloudAccountProvisioningState enum") +union CloudAccountProvisioningState { + @doc("Pending - Initial state when Oracle cloud account is not configured") + Pending: "Pending", + + @doc("Provisioning - State when Oracle cloud account is being provisioned") + Provisioning: "Provisioning", + + @doc("Available - State when Oracle cloud account cloud linking is complete and it is available") + Available: "Available", + + string, +} + +@doc("Intent enum") +union Intent { + @doc("Retain intent") + Retain: "Retain", + + @doc("Reset intent") + Reset: "Reset", + + string, +} + +@doc("Cloud Account Details model") +model CloudAccountDetails { + @doc("Cloud Account name") + @visibility("read") + cloudAccountName?: string; + + @doc("Cloud Account Home region") + @visibility("read") + cloudAccountHomeRegion?: string; +} + +@doc("SaaS Subscription Details model") +model SaasSubscriptionDetails { + @doc("Purchased SaaS subscription ID") + @visibility("read") + id?: string; + + @doc("SaaS subscription name") + @visibility("read") + subscriptionName?: string; + + @doc("Creation Date and Time") + @visibility("read") + timeCreated?: utcDateTime; + + @doc("Purchased offer ID") + @visibility("read") + offerId?: string; + + @doc("Purchased offer's plan ID") + @visibility("read") + planId?: string; + + @doc("Indicates the status of the Subscription.") + @visibility("read") + saasSubscriptionStatus?: string; + + @doc("Publisher ID") + @visibility("read") + publisherId?: string; + + @doc("Purchaser Email ID") + @visibility("read") + purchaserEmailId?: string; + + @doc("Purchaser Tenant ID") + @visibility("read") + purchaserTenantId?: string; + + @doc("Purchase Term Unit") + @visibility("read") + termUnit?: string; + + @doc("AutoRenew flag") + @visibility("read") + isAutoRenew?: boolean; + + @doc("FreeTrial flag") + @visibility("read") + isFreeTrial?: boolean; +} + +@doc("Activation Links model") +model ActivationLinks { + @doc("New Cloud Account Activation Link") + @visibility("read") + newCloudAccountActivationLink?: string; + + @doc("Existing Cloud Account Activation Link") + @visibility("read") + existingCloudAccountActivationLink?: string; +} + +@doc("Oracle Subscription resource model") +model OracleSubscriptionProperties { + @doc("OracleSubscriptionProvisioningState provisioning state") + @visibility("read") + provisioningState?: OracleSubscriptionProvisioningState; + + @doc("SAAS subscription ID generated by Marketplace") + @visibility("read") + saasSubscriptionId?: string; + + @doc("Cloud Account Id") + @visibility("read") + cloudAccountId?: Ocid; + + @doc("Cloud Account provisioning state.") + @visibility("read") + cloudAccountState?: CloudAccountProvisioningState; + + @doc("Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601") + @visibility("create", "read") + termUnit?: string; + + @doc("Product code for the term unit") + @visibility("update") + productCode?: string; + + @doc("Intent for the update operation") + @visibility("update") + intent?: Intent; +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_create.json index af715c1ea733..be930819f8cc 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_create.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_create.json @@ -9,7 +9,7 @@ "adbbackupid": "1711644130", "resource": { "properties": { - "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", "displayName": "Nightly Backup", "retentionPeriodInDays": 365 } @@ -18,11 +18,11 @@ "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130", - "type": "Oracle.Database/autonomousDatabaseBackups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", "properties": { - "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", - "databaseSizeInTBs": 2, + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, "dbVersion": "19.6.0.0", "displayName": "Nightly Backup", "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", @@ -31,10 +31,11 @@ "lifecycleDetails": "Backup completed successfully", "lifecycleState": "Active", "retentionPeriodInDays": 365, - "sizeInTBs": 2, + "sizeInTbs": 2, "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", "timeEnded": "2024-01-09T20:44:09.466Z", - "type": "Full", + "backupType": "Full", "provisioningState": "Succeeded" } } @@ -44,11 +45,11 @@ "Retry-After": 100 }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/backupdb1", - "type": "Oracle.Database/autonomousDatabaseBackups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", "properties": { - "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", - "databaseSizeInTBs": 2, + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, "dbVersion": "19.6.0.0", "displayName": "Nightly Backup", "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", @@ -57,10 +58,11 @@ "lifecycleDetails": "Backup completed successfully", "lifecycleState": "Active", "retentionPeriodInDays": 365, - "sizeInTBs": 2, + "sizeInTbs": 2, "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", "timeEnded": "2024-01-09T20:44:09.466Z", - "type": "Full", + "backupType": "Full", "provisioningState": "Succeeded" } } diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_delete.json index 0f35771dc60a..57eb4f861cfe 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_delete.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_delete.json @@ -1,6 +1,6 @@ { - "operationId": "AutonomousDatabaseBackups_delete", - "title": "AutonomousDatabaseBackups_delete", + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", "parameters": { "api-version": "2023-09-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_get.json index 0befc17879f0..b1fae97c1bd6 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_get.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_get.json @@ -1,6 +1,6 @@ { - "operationId": "AutonomousDatabaseBackups_get", - "title": "AutonomousDatabaseBackups_get", + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", "parameters": { "api-version": "2023-09-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -11,11 +11,11 @@ "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130", - "type": "Oracle.Database/autonomousDatabaseBackups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", "properties": { - "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", - "databaseSizeInTBs": 2, + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, "dbVersion": "19.6.0.0", "displayName": "Nightly Backup", "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", @@ -24,10 +24,11 @@ "lifecycleDetails": "Backup completed successfully", "lifecycleState": "Active", "retentionPeriodInDays": 365, - "sizeInTBs": 2, + "sizeInTbs": 2, "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", "timeEnded": "2024-01-09T20:44:09.466Z", - "type": "Full", + "backupType": "Full", "provisioningState": "Succeeded" } } diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_listByParent.json index d85a57cd54a8..4ebe52f4191c 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_listByParent.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_listByParent.json @@ -1,6 +1,6 @@ { - "operationId": "AutonomousDatabaseBackups_listByResourceGroup", - "title": "AutonomousDatabaseBackups_listByResourceGroup", + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", "parameters": { "api-version": "2023-09-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -12,11 +12,11 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130", - "type": "Oracle.Database/autonomousDatabaseBackups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", "properties": { - "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", - "databaseSizeInTBs": 2, + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, "dbVersion": "19.6.0.0", "displayName": "Nightly Backup", "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", @@ -25,10 +25,10 @@ "lifecycleDetails": "Backup completed successfully", "lifecycleState": "Active", "retentionPeriodInDays": 365, - "sizeInTBs": 2, + "sizeInTbs": 2, "timeAvailableTil": "2025-01-09T20:44:09.466Z", "timeEnded": "2024-01-09T20:44:09.466Z", - "type": "Full", + "backupType": "Full", "provisioningState": "Succeeded" } } diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_patch.json index b7fb3546ca5e..c1c4a32ec58c 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_patch.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseBackup_patch.json @@ -1,6 +1,6 @@ { - "operationId": "AutonomousDatabaseBackups_update", - "title": "AutonomousDatabaseBackups_update", + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", "parameters": { "api-version": "2023-09-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -12,11 +12,11 @@ "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130", - "type": "Oracle.Database/autonomousDatabaseBackups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", "properties": { - "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", - "databaseSizeInTBs": 2, + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, "dbVersion": "19.6.0.0", "displayName": "Nightly Backup", "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", @@ -25,8 +25,8 @@ "lifecycleDetails": "Backup updated successfully", "lifecycleState": "Active", "retentionPeriodInDays": 400, - "sizeInTBs": 2, - "type": "Full", + "sizeInTbs": 2, + "backupType": "Full", "provisioningState": "Succeeded" } } diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseClone_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseClone_create.json index d71aca700dd0..7046e1177614 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseClone_create.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabaseClone_create.json @@ -17,7 +17,7 @@ "dataStorageSizeInTbs": 1, "characterSet": "AL32UTF8", "ncharacterSet": "AL16UTF16", - "adminPassword": "", + "adminPassword": "********", "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" }, diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_create.json index 72d9f2dc923d..18862f95d313 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_create.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_create.json @@ -13,7 +13,7 @@ "computeModel": "ECPU", "computeCount": 2, "dataStorageSizeInTbs": 1, - "adminPassword": "", + "adminPassword": "********", "dbVersion": "18.4.0.0", "characterSet": "AL32UTF8", "ncharacterSet": "AL16UTF16", diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_restore.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_restore.json new file mode 100644 index 000000000000..6ad6cbccc9e3 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_shrink.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..47e5b0aca287 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/dbNodes_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/dbNodes_listByParent.json index ad295a90ed7c..8599aa52b6e6 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/dbNodes_listByParent.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/dbNodes_listByParent.json @@ -1,6 +1,6 @@ { - "operationId": "DbNodes_listByCloudVmCluster", - "title": "DbNodes_listByCloudVmCluster", + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", "parameters": { "api-version": "2023-09-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/systemVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/systemVersions_get.json new file mode 100644 index 000000000000..c4313c80653d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/systemVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/systemVersions_listByLocation.json new file mode 100644 index 000000000000..82998fab4b3a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json index a3e7e33400e7..7240ac650bcc 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json @@ -2,7 +2,12 @@ "swagger": "2.0", "info": { "title": "Oracle Database Resource Manager", - "version": "2023-09-01-preview" + "version": "2023-09-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, "schemes": [ "https" @@ -48,6 +53,9 @@ { "name": "VirtualNetworkAddresses" }, + { + "name": "SystemVersions" + }, { "name": "OracleSubscriptions" }, @@ -300,7 +308,8 @@ "in": "path", "description": "AutonomousDatabaseCharacterSet name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -388,7 +397,8 @@ "in": "path", "description": "AutonomousDatabaseNationalCharacterSets name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -476,7 +486,8 @@ "in": "path", "description": "AutonomousDbVersion name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -564,7 +575,8 @@ "in": "path", "description": "DbSystemShape name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -654,7 +666,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 255 + "maxLength": 255, + "pattern": ".*" } ], "responses": { @@ -742,7 +755,8 @@ "in": "path", "description": "DnsPrivateZone name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -830,7 +844,8 @@ "in": "path", "description": "GiVersion name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -854,6 +869,101 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions": { + "get": { + "operationId": "SystemVersions_ListByLocation", + "tags": [ + "SystemVersions" + ], + "description": "List SystemVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata System Versions by the provided filter": { + "$ref": "./examples/systemVersions_listByLocation.json" + }, + "systemVersions_listByLocation": { + "$ref": "./examples/systemVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions/{systemversionname}": { + "get": { + "operationId": "SystemVersions_Get", + "tags": [ + "SystemVersions" + ], + "description": "Get a SystemVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "systemversionname", + "in": "path", + "description": "SystemVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata System Version": { + "$ref": "./examples/systemVersions_get.json" + }, + "systemVersions_listSystemVersions": { + "$ref": "./examples/systemVersions_get.json" + } + } + } + }, "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions": { "get": { "operationId": "OracleSubscriptions_ListBySubscription", @@ -1021,14 +1131,14 @@ "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1067,14 +1177,14 @@ "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1124,14 +1234,14 @@ "202": { "description": "Resource operation accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1178,14 +1288,14 @@ "202": { "description": "Resource operation accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1232,14 +1342,14 @@ "202": { "description": "Resource operation accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1327,7 +1437,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" } ], "responses": { @@ -1345,6 +1456,9 @@ } }, "x-ms-examples": { + "AutonomousDatabases_Get": { + "$ref": "./examples/autonomousDatabase_get.json" + }, "Get Autonomous Database": { "$ref": "./examples/autonomousDatabase_get.json" } @@ -1373,7 +1487,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" }, { "name": "resource", @@ -1413,6 +1528,12 @@ } }, "x-ms-examples": { + "AutonomousDatabases_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "AutonomousDatabases_CreateOrUpdate_clone": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + }, "Create Autonomous Database": { "$ref": "./examples/autonomousDatabase_create.json" }, @@ -1448,7 +1569,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" }, { "name": "properties", @@ -1470,14 +1592,14 @@ "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1521,21 +1643,22 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" } ], "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1584,7 +1707,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" } ], "responses": { @@ -1602,6 +1726,9 @@ } }, "x-ms-examples": { + "AutonomousDatabaseBackups_ListByAutonomousDatabase": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + }, "List Autonomous Database Backups by Autonomous Database.": { "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" } @@ -1635,14 +1762,16 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" }, { "name": "adbbackupid", "in": "path", "description": "AutonomousDatabaseBackup id", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -1660,6 +1789,9 @@ } }, "x-ms-examples": { + "AutonomousDatabaseBackups_Get": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + }, "Get Autonomous Database Backup.": { "$ref": "./examples/autonomousDatabaseBackup_get.json" } @@ -1688,14 +1820,16 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" }, { "name": "adbbackupid", "in": "path", "description": "AutonomousDatabaseBackup id", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "resource", @@ -1735,6 +1869,9 @@ } }, "x-ms-examples": { + "AutonomousDatabaseBackups_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + }, "Create Autonomous Database Backup.": { "$ref": "./examples/autonomousDatabaseBackup_create.json" } @@ -1767,14 +1904,16 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" }, { "name": "adbbackupid", "in": "path", "description": "AutonomousDatabaseBackup id", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "properties", @@ -1796,14 +1935,14 @@ "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1815,6 +1954,9 @@ } }, "x-ms-examples": { + "AutonomousDatabaseBackups_Update": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + }, "Patch Autonomous Database Backup.": { "$ref": "./examples/autonomousDatabaseBackup_patch.json" } @@ -1847,28 +1989,30 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" }, { "name": "adbbackupid", "in": "path", "description": "AutonomousDatabaseBackup id", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1883,6 +2027,9 @@ } }, "x-ms-examples": { + "AutonomousDatabaseBackups_Delete": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + }, "Delete Autonomous Database Backup.": { "$ref": "./examples/autonomousDatabaseBackup_delete.json" } @@ -1917,7 +2064,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" }, { "name": "body", @@ -1939,14 +2087,14 @@ "202": { "description": "Resource operation accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1958,6 +2106,9 @@ } }, "x-ms-examples": { + "AutonomousDatabases_Failover": { + "$ref": "./examples/autonomousDatabase_failover.json" + }, "Perform failover action on Autonomous Database": { "$ref": "./examples/autonomousDatabase_failover.json" } @@ -1992,7 +2143,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" }, { "name": "body", @@ -2025,13 +2177,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/switchover": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/restore": { "post": { - "operationId": "AutonomousDatabases_Switchover", + "operationId": "AutonomousDatabases_Restore", "tags": [ "AutonomousDatabases" ], - "description": "Perform switchover action on Autonomous Database", + "description": "Restores an Autonomous Database based on the provided request parameters.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -2049,7 +2201,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 30 + "maxLength": 30, + "pattern": ".*" }, { "name": "body", @@ -2057,7 +2210,7 @@ "description": "The content of the action request", "required": true, "schema": { - "$ref": "#/definitions/PeerDbDetails" + "$ref": "#/definitions/RestoreAutonomousDatabaseDetails" } } ], @@ -2071,14 +2224,160 @@ "202": { "description": "Resource operation accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Restore": { + "$ref": "./examples/autonomousDatabase_restore.json" + }, + "Perform restore action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_restore.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/shrink": { + "post": { + "operationId": "AutonomousDatabases_Shrink", + "tags": [ + "AutonomousDatabases" + ], + "description": "This operation shrinks the current allocated storage down to the current actual used data storage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Perform shrink action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_shrink.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/switchover": { + "post": { + "operationId": "AutonomousDatabases_Switchover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform switchover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, @@ -2090,6 +2389,9 @@ } }, "x-ms-examples": { + "AutonomousDatabases_Switchover": { + "$ref": "./examples/autonomousDatabase_switchover.json" + }, "Perform switchover action on Autonomous Database": { "$ref": "./examples/autonomousDatabase_switchover.json" } @@ -2164,7 +2466,8 @@ "in": "path", "description": "CloudExadataInfrastructure name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -2208,7 +2511,8 @@ "in": "path", "description": "CloudExadataInfrastructure name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "resource", @@ -2278,7 +2582,8 @@ "in": "path", "description": "CloudExadataInfrastructure name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "properties", @@ -2300,14 +2605,14 @@ "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2349,21 +2654,22 @@ "in": "path", "description": "CloudExadataInfrastructure name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2410,7 +2716,8 @@ "in": "path", "description": "CloudExadataInfrastructure name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -2423,14 +2730,14 @@ "202": { "description": "Resource operation accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2474,7 +2781,8 @@ "in": "path", "description": "CloudExadataInfrastructure name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -2523,7 +2831,8 @@ "in": "path", "description": "CloudExadataInfrastructure name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "dbserverocid", @@ -2532,7 +2841,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 255 + "maxLength": 255, + "pattern": ".*" } ], "responses": { @@ -2620,7 +2930,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -2664,7 +2975,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "resource", @@ -2734,7 +3046,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "properties", @@ -2756,14 +3069,14 @@ "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2805,21 +3118,22 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2866,7 +3180,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "body", @@ -2888,14 +3203,14 @@ "202": { "description": "Resource operation accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2939,7 +3254,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -2988,7 +3304,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "dbnodeocid", @@ -2997,7 +3314,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 255 + "maxLength": 255, + "pattern": ".*" } ], "responses": { @@ -3043,7 +3361,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "dbnodeocid", @@ -3052,7 +3371,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 255 + "maxLength": 255, + "pattern": ".*" }, { "name": "body", @@ -3074,14 +3394,14 @@ "202": { "description": "Resource operation accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -3093,6 +3413,9 @@ } }, "x-ms-examples": { + "DbNodes_Action": { + "$ref": "./examples/dbNodes_action.json" + }, "VM actions on DbNodes of VM Cluster": { "$ref": "./examples/dbNodes_action.json" } @@ -3125,7 +3448,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "body", @@ -3184,7 +3508,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "body", @@ -3206,14 +3531,14 @@ "202": { "description": "Resource operation accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -3257,7 +3582,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" } ], "responses": { @@ -3306,7 +3632,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "virtualnetworkaddressname", @@ -3315,7 +3642,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": ".*" } ], "responses": { @@ -3359,7 +3687,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "virtualnetworkaddressname", @@ -3368,7 +3697,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": ".*" }, { "name": "resource", @@ -3438,7 +3768,8 @@ "in": "path", "description": "CloudVmCluster name", "required": true, - "type": "string" + "type": "string", + "pattern": ".*" }, { "name": "virtualnetworkaddressname", @@ -3447,21 +3778,22 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": ".*" } ], "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -3600,7 +3932,7 @@ }, "AutonomousDatabaseBackupLifecycleState": { "type": "string", - "description": "AutonomousDatabaseBackupLifecycleState enum", + "description": "Autonomous database backup lifecycle state enum", "enum": [ "Creating", "Active", @@ -3610,7 +3942,34 @@ ], "x-ms-enum": { "name": "AutonomousDatabaseBackupLifecycleState", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "AutonomousDatabase backup is creating" + }, + { + "name": "Active", + "value": "Active", + "description": "AutonomousDatabase backup is active" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "AutonomousDatabase backup is deleting" + }, + { + "name": "Failed", + "value": "Failed", + "description": "AutonomousDatabase backup is failed" + }, + { + "name": "Updating", + "value": "Updating", + "description": "AutonomousDatabase backup is updating" + } + ] } }, "AutonomousDatabaseBackupListResult": { @@ -3627,8 +3986,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -3639,14 +3997,14 @@ "type": "object", "description": "AutonomousDatabaseBackup resource model", "properties": { - "autonomousDatabaseId": { - "$ref": "#/definitions/AutonomousDatabaseId", + "autonomousDatabaseOcid": { + "$ref": "#/definitions/Ocid", "description": "The OCID of the Autonomous Database.", "readOnly": true }, - "databaseSizeInTBs": { - "type": "integer", - "format": "int32", + "databaseSizeInTbs": { + "type": "number", + "format": "double", "description": "The size of the database in terabytes at the time the backup was taken.", "readOnly": true }, @@ -3692,7 +4050,7 @@ "type": "integer", "format": "int32", "description": "Retention period, in days, for long-term backups.", - "minimum": 90, + "minimum": 60, "maximum": 3650, "x-ms-mutability": [ "read", @@ -3700,9 +4058,9 @@ "create" ] }, - "sizeInTBs": { - "type": "integer", - "format": "int32", + "sizeInTbs": { + "type": "number", + "format": "double", "description": "The backup size in terabytes (TB).", "readOnly": true }, @@ -3712,12 +4070,17 @@ "description": "Timestamp until when the backup will be available.", "readOnly": true }, + "timeStarted": { + "type": "string", + "description": "The date and time the backup started.", + "readOnly": true + }, "timeEnded": { "type": "string", "description": "The date and time the backup completed.", "readOnly": true }, - "type": { + "backupType": { "$ref": "#/definitions/AutonomousDatabaseBackupType", "description": "The type of backup.", "readOnly": true @@ -3727,14 +4090,11 @@ "description": "Azure resource provisioning state.", "readOnly": true } - }, - "required": [ - "autonomousDatabaseId" - ] + } }, "AutonomousDatabaseBackupType": { "type": "string", - "description": "AutonomousDatabaseBackupType enum", + "description": "Autonomous database backup type enum", "enum": [ "Incremental", "Full", @@ -3742,7 +4102,24 @@ ], "x-ms-enum": { "name": "AutonomousDatabaseBackupType", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Incremental", + "value": "Incremental", + "description": "Incremental backup" + }, + { + "name": "Full", + "value": "Full", + "description": "Full backup" + }, + { + "name": "LongTerm", + "value": "LongTerm", + "description": "LongTerm backup" + } + ] } }, "AutonomousDatabaseBackupUpdate": { @@ -3763,7 +4140,7 @@ "type": "integer", "format": "int32", "description": "Retention period, in days, for long-term backups.", - "minimum": 90, + "minimum": 60, "maximum": 3650, "x-ms-mutability": [ "read", @@ -4153,6 +4530,20 @@ "description": "The area assigned to In-Memory tables in Autonomous Database.", "readOnly": true }, + "nextLongTermBackupTimeStamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the next long-term backup would be created.", + "readOnly": true + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, "isPreview": { "type": "boolean", "description": "Indicates if the Autonomous Database version is a preview version.", @@ -4360,8 +4751,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -4466,7 +4856,7 @@ }, "AutonomousDatabaseLifecycleState": { "type": "string", - "description": "AutonomousDatabaseLifecycleState enum", + "description": "Autonomous database lifecycle state enum", "enum": [ "Provisioning", "Available", @@ -4497,107 +4887,107 @@ { "name": "Provisioning", "value": "Provisioning", - "description": "PROVISIONING value" + "description": "Indicates that resource in Provisioning state" }, { "name": "Available", "value": "Available", - "description": "AVAILABLE value" + "description": "Indicates that resource in Available state" }, { "name": "Stopping", "value": "Stopping", - "description": "STOPPING value" + "description": "Indicates that resource in Stopping state" }, { "name": "Stopped", "value": "Stopped", - "description": "STOPPED value" + "description": "Indicates that resource in Stopped state" }, { "name": "Starting", "value": "Starting", - "description": "STARTING value" + "description": "Indicates that resource in Starting state" }, { "name": "Terminating", "value": "Terminating", - "description": "TERMINATING value" + "description": "Indicates that resource in Terminating state" }, { "name": "Terminated", "value": "Terminated", - "description": "TERMINATED value" + "description": "Indicates that resource in Terminated state" }, { "name": "Unavailable", "value": "Unavailable", - "description": "UNAVAILABLE value" + "description": "Indicates that resource in Unavailable state" }, { "name": "RestoreInProgress", "value": "RestoreInProgress", - "description": "RESTORE_IN_PROGRESS value" + "description": "Indicates that resource in RestoreInProgress state" }, { "name": "RestoreFailed", "value": "RestoreFailed", - "description": "RESTORE_FAILED value" + "description": "Indicates that resource in RestoreFailed state" }, { "name": "BackupInProgress", "value": "BackupInProgress", - "description": "BACKUP_IN_PROGRESS value" + "description": "Indicates that resource in BackupInProgress state" }, { "name": "ScaleInProgress", "value": "ScaleInProgress", - "description": "SCALE_IN_PROGRESS value" + "description": "Indicates that resource in ScaleInProgress state" }, { "name": "AvailableNeedsAttention", "value": "AvailableNeedsAttention", - "description": "AVAILABLE_NEEDS_ATTENTION value" + "description": "Indicates that resource is available but needs attention" }, { "name": "Updating", "value": "Updating", - "description": "UPDATING value" + "description": "Indicates that resource in Updating state" }, { "name": "MaintenanceInProgress", "value": "MaintenanceInProgress", - "description": "MAINTENANCE_IN_PROGRESS value" + "description": "Indicates that resource maintenance in progress state" }, { "name": "Restarting", "value": "Restarting", - "description": "RESTARTING value" + "description": "Indicates that resource in Restarting state" }, { "name": "Recreating", "value": "Recreating", - "description": "RECREATING value" + "description": "Indicates that resource in Recreating state" }, { "name": "RoleChangeInProgress", "value": "RoleChangeInProgress", - "description": "ROLE_CHANGE_IN_PROGRESS value" + "description": "Indicates that resource role change in progress state" }, { "name": "Upgrading", "value": "Upgrading", - "description": "UPGRADING value" + "description": "Indicates that resource in Upgrading state" }, { "name": "Inaccessible", "value": "Inaccessible", - "description": "INACCESSIBLE value" + "description": "IIndicates that resource in Inaccessible state" }, { "name": "Standby", "value": "Standby", - "description": "STANDBY value" + "description": "Indicates that resource in Standby state" } ] } @@ -4616,8 +5006,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -4658,8 +5047,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -4903,6 +5291,14 @@ "create" ] }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, "localAdgAutoFailoverMaxDataLossLimit": { "type": "integer", "format": "int32", @@ -5009,8 +5405,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -5060,7 +5455,7 @@ }, "AutonomousMaintenanceScheduleType": { "type": "string", - "description": "AutonomousMaintenanceScheduleType enum.", + "description": "Autonomous database maintenance schedule type enum.", "enum": [ "Early", "Regular" @@ -5072,12 +5467,12 @@ { "name": "Early", "value": "Early", - "description": "EARLY value" + "description": "Early maintenance schedule" }, { "name": "Regular", "value": "Regular", - "description": "REGULAR value" + "description": "Regular maintenance schedule" } ] } @@ -5144,7 +5539,7 @@ { "name": "Provisioning", "value": "Provisioning", - "description": "Provisioning value" + "description": "Indicates that resource in Provisioning state" } ] }, @@ -5152,7 +5547,7 @@ }, "CloneType": { "type": "string", - "description": "CloneType enum", + "description": "Clone type enum", "enum": [ "Full", "Metadata" @@ -5164,12 +5559,12 @@ { "name": "Full", "value": "Full", - "description": "FULL value" + "description": "Full clone" }, { "name": "Metadata", "value": "Metadata", - "description": "METADATA value" + "description": "Metadata only" } ] } @@ -5205,17 +5600,17 @@ { "name": "Pending", "value": "Pending", - "description": "Pending value" + "description": "Pending - Initial state when Oracle cloud account is not configured" }, { "name": "Provisioning", "value": "Provisioning", - "description": "Provisioning value" + "description": "Provisioning - State when Oracle cloud account is being provisioned" }, { "name": "Available", "value": "Available", - "description": "Available value" + "description": "Available - State when Oracle cloud account cloud linking is complete and it is available" } ] } @@ -5281,37 +5676,37 @@ { "name": "Provisioning", "value": "Provisioning", - "description": "PROVISIONING value" + "description": "Indicates that resource in Provisioning state" }, { "name": "Available", "value": "Available", - "description": "AVAILABLE value" + "description": "Indicates that resource in Available state" }, { "name": "Updating", "value": "Updating", - "description": "UPDATING value" + "description": "Indicates that resource in Updating state" }, { "name": "Terminating", "value": "Terminating", - "description": "TERMINATING value" + "description": "Indicates that resource in Terminating state" }, { "name": "Terminated", "value": "Terminated", - "description": "TERMINATED value" + "description": "Indicates that resource in Terminated state" }, { "name": "MaintenanceInProgress", "value": "MaintenanceInProgress", - "description": "MAINTENANCE_IN_PROGRESS value" + "description": "Indicates that resource maintenance in progress state" }, { "name": "Failed", "value": "Failed", - "description": "FAILED value" + "description": "Indicates that resource in Failed state" } ] } @@ -5330,8 +5725,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -5436,6 +5830,7 @@ }, "ociUrl": { "type": "string", + "format": "uri", "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", "readOnly": true }, @@ -5476,8 +5871,8 @@ "readOnly": true }, "dataStorageSizeInTbs": { - "type": "integer", - "format": "int32", + "type": "number", + "format": "double", "description": "The quantity of data in the database, in terabytes.", "readOnly": true }, @@ -5651,7 +6046,7 @@ }, "CloudVmClusterLifecycleState": { "type": "string", - "description": "CloudVmClusterLifecycleState enum", + "description": "Cloud VM Cluster lifecycle state enum", "enum": [ "Provisioning", "Available", @@ -5668,37 +6063,37 @@ { "name": "Provisioning", "value": "Provisioning", - "description": "PROVISIONING value" + "description": "Indicates that resource in Provisioning state" }, { "name": "Available", "value": "Available", - "description": "AVAILABLE value" + "description": "Indicates that resource in Available state" }, { "name": "Updating", "value": "Updating", - "description": "UPDATING value" + "description": "Indicates that resource in Updating state" }, { "name": "Terminating", "value": "Terminating", - "description": "TERMINATING value" + "description": "Indicates that resource in Terminating state" }, { "name": "Terminated", "value": "Terminated", - "description": "TERMINATED value" + "description": "Indicates that resource in Terminated state" }, { "name": "MaintenanceInProgress", "value": "MaintenanceInProgress", - "description": "MAINTENANCE_IN_PROGRESS value" + "description": "Indicates that resource Maintenance in progress state" }, { "name": "Failed", "value": "Failed", - "description": "FAILED value" + "description": "Indicates that resource in Failed state" } ] } @@ -5717,8 +6112,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -5877,7 +6271,10 @@ "description": "Operating system version of the image.", "minLength": 1, "maxLength": 255, - "readOnly": true + "x-ms-mutability": [ + "read", + "create" + ] }, "sshPublicKeys": { "type": "array", @@ -5976,11 +6373,13 @@ }, "ociUrl": { "type": "string", + "format": "uri", "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", "readOnly": true }, "nsgUrl": { "type": "string", + "format": "uri", "description": "HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.", "readOnly": true }, @@ -6006,7 +6405,7 @@ "type": "array", "description": "CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.", "items": { - "$ref": "#/definitions/NSGCidr" + "$ref": "#/definitions/NsgCidr" }, "x-ms-identifiers": [], "x-ms-mutability": [ @@ -6167,7 +6566,7 @@ }, "ComputeModel": { "type": "string", - "description": "ComputeModel enum", + "description": "Compute model enum", "enum": [ "ECPU", "OCPU" @@ -6179,12 +6578,12 @@ { "name": "ECPU", "value": "ECPU", - "description": "ECPU value" + "description": "ECPU model type" }, { "name": "OCPU", "value": "OCPU", - "description": "OCPU value" + "description": "OCPU model type" } ] } @@ -6281,7 +6680,7 @@ }, "ConsumerGroup": { "type": "string", - "description": "ConsumerGroup enum.", + "description": "Consumer group enum.", "enum": [ "High", "Medium", @@ -6296,27 +6695,27 @@ { "name": "High", "value": "High", - "description": "HIGH value" + "description": "High group" }, { "name": "Medium", "value": "Medium", - "description": "MEDIUM value" + "description": "Medium group" }, { "name": "Low", "value": "Low", - "description": "LOW value" + "description": "Low group" }, { "name": "Tp", "value": "Tp", - "description": "TP value" + "description": "TP group" }, { "name": "Tpurgent", "value": "Tpurgent", - "description": "TPURGENT value" + "description": "TPurgent group" } ] } @@ -6338,7 +6737,7 @@ }, "DataBaseType": { "type": "string", - "description": "DataBaseType enum", + "description": "Database type enum", "enum": [ "Regular", "Clone" @@ -6350,12 +6749,12 @@ { "name": "Regular", "value": "Regular", - "description": "REGULAR value" + "description": "Regular DB" }, { "name": "Clone", "value": "Clone", - "description": "CLONE value" + "description": "Clone DB" } ] } @@ -6383,7 +6782,7 @@ }, "DataSafeStatusType": { "type": "string", - "description": "DataSafeStatusType enum.", + "description": "DataSafe status type enum.", "enum": [ "Registering", "Registered", @@ -6398,34 +6797,34 @@ { "name": "Registering", "value": "Registering", - "description": "REGISTERING value" + "description": "Registering status" }, { "name": "Registered", "value": "Registered", - "description": "REGISTERED value" + "description": "Registered status" }, { "name": "Deregistering", "value": "Deregistering", - "description": "DEREGISTERING value" + "description": "Deregistering status" }, { "name": "NotRegistered", "value": "NotRegistered", - "description": "NOT_REGISTERED value" + "description": "NotRegistered status" }, { "name": "Failed", "value": "Failed", - "description": "FAILED value" + "description": "Failed status" } ] } }, "DatabaseEditionType": { "type": "string", - "description": "DatabaseEditionType enum.", + "description": "Database edition type enum.", "enum": [ "StandardEdition", "EnterpriseEdition" @@ -6437,12 +6836,12 @@ { "name": "StandardEdition", "value": "StandardEdition", - "description": "STANDARD_EDITION value" + "description": "Standard edition" }, { "name": "EnterpriseEdition", "value": "EnterpriseEdition", - "description": "ENTERPRISE_EDITION value" + "description": "Enterprise edition" } ] } @@ -6628,8 +7027,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -6649,7 +7047,7 @@ { "name": "VmdbRebootMigration", "value": "VmdbRebootMigration", - "description": "Provisioning value" + "description": "VMDB reboot migration maintenance type" } ] } @@ -6809,47 +7207,47 @@ { "name": "Provisioning", "value": "Provisioning", - "description": "PROVISIONING value" + "description": "Indicates that resource in Provisioning state" }, { "name": "Available", "value": "Available", - "description": "AVAILABLE value" + "description": "Indicates that resource in Available state" }, { "name": "Updating", "value": "Updating", - "description": "UPDATING value" + "description": "Indicates that resource in Updating state" }, { "name": "Stopping", "value": "Stopping", - "description": "STOPPING value" + "description": "Indicates that resource in Stopping state" }, { "name": "Stopped", "value": "Stopped", - "description": "STOPPED value" + "description": "Indicates that resource in Stopped state" }, { "name": "Starting", "value": "Starting", - "description": "STARTING value" + "description": "Indicates that resource in Starting state" }, { "name": "Terminating", "value": "Terminating", - "description": "TERMINATING value" + "description": "Indicates that resource in Terminating state" }, { "name": "Terminated", "value": "Terminated", - "description": "TERMINATED value" + "description": "Indicates that resource in Terminated state" }, { "name": "Failed", "value": "Failed", - "description": "FAILED value" + "description": "Indicates that resource in Failed state" } ] } @@ -6888,8 +7286,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -6929,7 +7326,7 @@ }, "DbServerPatchingStatus": { "type": "string", - "description": "Db Server patching status enum", + "description": "DB Server patching status enum", "enum": [ "Scheduled", "MaintenanceInProgress", @@ -6943,22 +7340,22 @@ { "name": "Scheduled", "value": "Scheduled", - "description": "SCHEDULED value" + "description": "Patching scheduled" }, { "name": "MaintenanceInProgress", "value": "MaintenanceInProgress", - "description": "MAINTENANCE_IN_PROGRESS value" + "description": "Patching in progress" }, { "name": "Failed", "value": "Failed", - "description": "FAILED value" + "description": "Patching failed" }, { "name": "Complete", "value": "Complete", - "description": "COMPLETE value" + "description": "Patching completed" } ] } @@ -7110,32 +7507,32 @@ { "name": "Creating", "value": "Creating", - "description": "CREATING value" + "description": "Indicates that resource in Creating state" }, { "name": "Available", "value": "Available", - "description": "AVAILABLE value" + "description": "Indicates that resource in Available state" }, { "name": "Unavailable", "value": "Unavailable", - "description": "UNAVAILABLE value" + "description": "Indicates that resource in Unavailable state" }, { "name": "Deleting", "value": "Deleting", - "description": "DELETING value" + "description": "Indicates that resource in Deleting state" }, { "name": "Deleted", "value": "Deleted", - "description": "DELETED value" + "description": "Indicates that resource in Deleted state" }, { "name": "MaintenanceInProgress", "value": "MaintenanceInProgress", - "description": "MAINTENANCE_IN_PROGRESS value" + "description": "Indicates that resource maintenance in progress state" } ] } @@ -7174,8 +7571,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -7314,7 +7710,7 @@ }, "DisasterRecoveryType": { "type": "string", - "description": "DisasterRecoveryType enum.", + "description": "Disaster recovery type enum.", "enum": [ "Adg", "BackupBased" @@ -7326,19 +7722,19 @@ { "name": "Adg", "value": "Adg", - "description": "ADG value" + "description": "ADG type" }, { "name": "BackupBased", "value": "BackupBased", - "description": "BACKUP_BASED value" + "description": "Backup based type" } ] } }, "DiskRedundancy": { "type": "string", - "description": "DiskRedundancy enum", + "description": "Disk redundancy enum", "enum": [ "High", "Normal" @@ -7350,12 +7746,12 @@ { "name": "High", "value": "High", - "description": "High value" + "description": "High redundancy" }, { "name": "Normal", "value": "Normal", - "description": "Normal value" + "description": "Normal redundancy" } ] } @@ -7394,8 +7790,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -7459,7 +7854,7 @@ }, "DnsPrivateViewsLifecycleState": { "type": "string", - "description": "DnsPrivateViews lifecycle state enum", + "description": "DNS Private Views lifecycle state enum", "enum": [ "Active", "Deleted", @@ -7473,22 +7868,22 @@ { "name": "Active", "value": "Active", - "description": "Active value" + "description": "DNS Private View is active" }, { "name": "Deleted", "value": "Deleted", - "description": "Deleted value" + "description": "DNS Private View is deleted" }, { "name": "Deleting", "value": "Deleting", - "description": "Deleting value" + "description": "DNS Private View is deleting" }, { "name": "Updating", "value": "Updating", - "description": "Updating value" + "description": "DNS Private View is updating" } ] } @@ -7527,8 +7922,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -7604,7 +7998,7 @@ }, "DnsPrivateZonesLifecycleState": { "type": "string", - "description": "DnsPrivateZones lifecycle state enum", + "description": "DNS Private Zones lifecycle state enum", "enum": [ "Active", "Creating", @@ -7619,27 +8013,27 @@ { "name": "Active", "value": "Active", - "description": "Active value" + "description": "DNS Private Zones is active" }, { "name": "Creating", "value": "Creating", - "description": "Creating value" + "description": "DNS Private Zones is creating" }, { "name": "Deleted", "value": "Deleted", - "description": "Deleted value" + "description": "DNS Private Zones is deleted" }, { "name": "Deleting", "value": "Deleting", - "description": "Deleting value" + "description": "DNS Private Zones is deleting" }, { "name": "Updating", "value": "Updating", - "description": "Updating value" + "description": "DNS Private Zones is updating" } ] } @@ -7732,7 +8126,7 @@ }, "GenerateType": { "type": "string", - "description": "GenerateType enum", + "description": "Generate type enum", "enum": [ "Single", "All" @@ -7744,12 +8138,12 @@ { "name": "Single", "value": "Single", - "description": "SINGLE value" + "description": "Generate single" }, { "name": "All", "value": "All", - "description": "ALL value" + "description": "Generate all" } ] } @@ -7788,8 +8182,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -7814,7 +8207,7 @@ }, "HostFormatType": { "type": "string", - "description": "HostFormatType enum.", + "description": "Host format type enum.", "enum": [ "Fqdn", "Ip" @@ -7826,12 +8219,12 @@ { "name": "Fqdn", "value": "Fqdn", - "description": "FQDN value" + "description": "FQDN format" }, { "name": "Ip", "value": "Ip", - "description": "IP value" + "description": "IP format" } ] } @@ -7850,19 +8243,19 @@ { "name": "Retain", "value": "Retain", - "description": "Retain value" + "description": "Retain intent" }, { "name": "Reset", "value": "Reset", - "description": "Reset value" + "description": "Reset intent" } ] } }, "IormLifecycleState": { "type": "string", - "description": "IORMLifecycleState enum", + "description": "ORM lifecycle state enum", "enum": [ "BootStrapping", "Enabled", @@ -7877,27 +8270,27 @@ { "name": "BootStrapping", "value": "BootStrapping", - "description": "BOOTSTRAPPING value" + "description": "Indicates that resource in Provisioning state" }, { "name": "Enabled", "value": "Enabled", - "description": "ENABLED value" + "description": "Indicates that resource in Enabled state" }, { "name": "Disabled", "value": "Disabled", - "description": "DISABLED value" + "description": "Indicates that resource in Disabled state" }, { "name": "Updating", "value": "Updating", - "description": "UPDATING value" + "description": "Indicates that resource in Updating state" }, { "name": "Failed", "value": "Failed", - "description": "FAILED value" + "description": "Indicates that resource in Failed state" } ] } @@ -7916,16 +8309,39 @@ { "name": "LicenseIncluded", "value": "LicenseIncluded", - "description": "LicenseIncluded value" + "description": "License included" }, { "name": "BringYourOwnLicense", "value": "BringYourOwnLicense", - "description": "BringYourOwnLicense value" + "description": "Bring Your Own License" } ] } }, + "LongTermBackUpScheduleDetails": { + "type": "object", + "description": "Details for the long-term backup schedule.", + "properties": { + "repeatCadence": { + "$ref": "#/definitions/RepeatCadenceType", + "description": "The frequency of the long-term backup schedule" + }, + "timeOfBackup": { + "type": "string", + "format": "date-time", + "description": "The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month." + }, + "retentionPeriodInDays": { + "$ref": "#/definitions/RetentionPeriod", + "description": "Retention period, in days, for backups." + }, + "isDisabled": { + "type": "boolean", + "description": "Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`." + } + } + }, "MaintenanceWindow": { "type": "object", "description": "MaintenanceWindow resource properties", @@ -8093,7 +8509,11 @@ ] } }, - "NSGCidr": { + "MsRpaasNewResourceHeader": { + "type": "object", + "description": "Header to distinguish between resource creation or update" + }, + "NsgCidr": { "type": "object", "description": "A rule for allowing inbound (INGRESS) IP packets", "properties": { @@ -8129,27 +8549,27 @@ { "name": "LowLatency", "value": "LowLatency", - "description": "LOW_LATENCY value" + "description": "Low latency objective" }, { "name": "HighThroughput", "value": "HighThroughput", - "description": "HIGH_THROUGHPUT value" + "description": "High throughput objective" }, { "name": "Balanced", "value": "Balanced", - "description": "BALANCED value" + "description": "Balanced objective" }, { "name": "Auto", "value": "Auto", - "description": "AUTO value" + "description": "Auto objective" }, { "name": "Basic", "value": "Basic", - "description": "BASIC value" + "description": "Basic objective" } ] } @@ -8162,7 +8582,7 @@ }, "OpenModeType": { "type": "string", - "description": "OpenModeType enum.", + "description": "Open mode type enum.", "enum": [ "ReadOnly", "ReadWrite" @@ -8174,19 +8594,19 @@ { "name": "ReadOnly", "value": "ReadOnly", - "description": "READ_ONLY value" + "description": "ReadOnly mode" }, { "name": "ReadWrite", "value": "ReadWrite", - "description": "READ_WRITE value" + "description": "ReadWrite mode" } ] } }, "OperationsInsightsStatusType": { "type": "string", - "description": "OperationsInsightsStatusType enum.", + "description": "Operations Insights status type enum.", "enum": [ "Enabling", "Enabled", @@ -8202,32 +8622,32 @@ { "name": "Enabling", "value": "Enabling", - "description": "ENABLING value" + "description": "Enabling status" }, { "name": "Enabled", "value": "Enabled", - "description": "ENABLED value" + "description": "Enabled status" }, { "name": "Disabling", "value": "Disabling", - "description": "DISABLING value" + "description": "Disabling status" }, { "name": "NotEnabled", "value": "NotEnabled", - "description": "NOT_ENABLED value" + "description": "NotEnabled status" }, { "name": "FailedEnabling", "value": "FailedEnabling", - "description": "FAILED_ENABLING value" + "description": "FailedEnabling status" }, { "name": "FailedDisabling", "value": "FailedDisabling", - "description": "FAILED_DISABLING value" + "description": "FailedDisabling status" } ] } @@ -8270,8 +8690,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -8362,7 +8781,7 @@ "description": "The type used for update operations of the OracleSubscription.", "properties": { "plan": { - "$ref": "#/definitions/ResourcePlanTypeUpdate", + "$ref": "#/definitions/PlanUpdate", "description": "Details of the resource plan." }, "properties": { @@ -8399,7 +8818,7 @@ }, "PatchingMode": { "type": "string", - "description": "PatchingMode enum", + "description": "Patching mode enum", "enum": [ "Rolling", "NonRolling" @@ -8411,12 +8830,12 @@ { "name": "Rolling", "value": "Rolling", - "description": "Rolling value" + "description": "Rolling patching" }, { "name": "NonRolling", "value": "NonRolling", - "description": "Non Rolling value" + "description": "Non Rolling patching" } ] } @@ -8435,7 +8854,7 @@ }, "PermissionLevelType": { "type": "string", - "description": "PermissionLevelType enum.", + "description": "Permission level type enum.", "enum": [ "Restricted", "Unrestricted" @@ -8447,16 +8866,42 @@ { "name": "Restricted", "value": "Restricted", - "description": "RESTRICTED value" + "description": "Restricted permission level" }, { "name": "Unrestricted", "value": "Unrestricted", - "description": "UNRESTRICTED value" + "description": "Unrestricted permission level" } ] } }, + "PlanUpdate": { + "type": "object", + "description": "ResourcePlanTypeUpdate model definition", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + } + }, "PortRange": { "type": "object", "description": "Port Range to specify particular destination ports for TCP rules.", @@ -8495,12 +8940,12 @@ { "name": "NoPreference", "value": "NoPreference", - "description": "NoPreference value" + "description": "No preference" }, { "name": "CustomPreference", "value": "CustomPreference", - "description": "CustomPreference value" + "description": "Custom preference" } ] } @@ -8610,7 +9055,7 @@ }, "ProtocolType": { "type": "string", - "description": "ProtocolType enum.", + "description": "Protocol type enum.", "enum": [ "TCP", "TCPS" @@ -8622,19 +9067,19 @@ { "name": "TCP", "value": "TCP", - "description": "TCP value" + "description": "TCP protocol" }, { "name": "TCPS", "value": "TCPS", - "description": "TCPS value" + "description": "TCPS protocol" } ] } }, "RefreshableModelType": { "type": "string", - "description": "RefreshableModelType enum", + "description": "Refreshable model type enum", "enum": [ "Automatic", "Manual" @@ -8646,19 +9091,19 @@ { "name": "Automatic", "value": "Automatic", - "description": "AUTOMATIC value" + "description": "Automatic refreshable model type" }, { "name": "Manual", "value": "Manual", - "description": "MANUAL value" + "description": "Manual refreshable model type" } ] } }, "RefreshableStatusType": { "type": "string", - "description": "RefreshableStatusType enum.", + "description": "Refreshable status type enum.", "enum": [ "Refreshing", "NotRefreshing" @@ -8670,45 +9115,76 @@ { "name": "Refreshing", "value": "Refreshing", - "description": "REFRESHING value" + "description": "Refreshing status" }, { "name": "NotRefreshing", "value": "NotRefreshing", - "description": "NOT_REFRESHING value" + "description": "NotRefreshing status" + } + ] + } + }, + "RepeatCadenceType": { + "type": "string", + "description": "Repeat cadence type enum", + "enum": [ + "OneTime", + "Weekly", + "Monthly", + "Yearly" + ], + "x-ms-enum": { + "name": "RepeatCadenceType", + "modelAsString": true, + "values": [ + { + "name": "OneTime", + "value": "OneTime", + "description": "Repeat one time" + }, + { + "name": "Weekly", + "value": "Weekly", + "description": "Repeat weekly" + }, + { + "name": "Monthly", + "value": "Monthly", + "description": "Repeat monthly" + }, + { + "name": "Yearly", + "value": "Yearly", + "description": "Repeat yearly" } ] } }, - "ResourcePlanTypeUpdate": { + "RestoreAutonomousDatabaseDetails": { "type": "object", - "description": "ResourcePlanTypeUpdate model definition", + "description": "Details to restore an Oracle Autonomous Database.", "properties": { - "name": { - "type": "string", - "description": "A user defined name of the 3rd Party Artifact that is being procured." - }, - "publisher": { - "type": "string", - "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" - }, - "product": { - "type": "string", - "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " - }, - "promotionCode": { - "type": "string", - "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." - }, - "version": { + "timestamp": { "type": "string", - "description": "The version of the desired product/artifact." + "format": "date-time", + "description": "The time to restore the database to." } - } + }, + "required": [ + "timestamp" + ] + }, + "RetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for backups.", + "minimum": 90, + "maximum": 2558 }, "RoleType": { "type": "string", - "description": "RoleType enum.", + "description": "Role type enum.", "enum": [ "Primary", "Standby", @@ -8723,27 +9199,27 @@ { "name": "Primary", "value": "Primary", - "description": "PRIMARY value" + "description": "Primary role" }, { "name": "Standby", "value": "Standby", - "description": "STANDBY value" + "description": "Standby role" }, { "name": "DisabledStandby", "value": "DisabledStandby", - "description": "DISABLED_STANDBY value" + "description": "DisabledStandby role" }, { "name": "BackupCopy", "value": "BackupCopy", - "description": "BACKUP_COPY value" + "description": "BackupCopy role" }, { "name": "SnapshotStandby", "value": "SnapshotStandby", - "description": "SNAPSHOT_STANDBY value" + "description": "SnapshotStandby role" } ] } @@ -8864,7 +9340,7 @@ }, "SessionModeType": { "type": "string", - "description": "SessionModeType enum.", + "description": "Session mode type enum.", "enum": [ "Direct", "Redirect" @@ -8876,19 +9352,19 @@ { "name": "Direct", "value": "Direct", - "description": "DIRECT value" + "description": "Direct session mode" }, { "name": "Redirect", "value": "Redirect", - "description": "REDIRECT value" + "description": "Redirect session mode" } ] } }, "SourceType": { "type": "string", - "description": "SourceType enum.", + "description": "Source type enum.", "enum": [ "None", "Database", @@ -8905,37 +9381,37 @@ { "name": "None", "value": "None", - "description": "NONE value" + "description": "None source" }, { "name": "Database", "value": "Database", - "description": "DATABASE value" + "description": "Database source" }, { "name": "BackupFromId", "value": "BackupFromId", - "description": "BACKUP_FROM_ID value" + "description": "Backup from ID source" }, { "name": "BackupFromTimestamp", "value": "BackupFromTimestamp", - "description": "BACKUP_FROM_TIMESTAMP value" + "description": "Backup from timestamp source" }, { "name": "CloneToRefreshable", "value": "CloneToRefreshable", - "description": "CLONE_TO_REFRESHABLE value" + "description": "Clone to refreshable source" }, { "name": "CrossRegionDataguard", "value": "CrossRegionDataguard", - "description": "CROSS_REGION_DATAGUARD value" + "description": "Cross region dataguard source" }, { "name": "CrossRegionDisasterRecovery", "value": "CrossRegionDisasterRecovery", - "description": "CROSS_REGION_DISASTER_RECOVERY value" + "description": "cross region disaster recovery source" } ] } @@ -8954,7 +9430,7 @@ }, "SyntaxFormatType": { "type": "string", - "description": "SyntaxFormatType enum.", + "description": "Syntax format type enum.", "enum": [ "Long", "Ezconnect", @@ -8967,24 +9443,101 @@ { "name": "Long", "value": "Long", - "description": "LONG value" + "description": "Long format" }, { "name": "Ezconnect", "value": "Ezconnect", - "description": "EZCONNECT value" + "description": "Ezconnect format" }, { "name": "Ezconnectplus", "value": "Ezconnectplus", - "description": "EZCONNECTPLUS value" + "description": "Ezconnectplus format" } ] } }, + "SystemVersion": { + "type": "object", + "description": "SystemVersion resource Definition", + "properties": { + "properties": { + "$ref": "#/definitions/SystemVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SystemVersionListResult": { + "type": "object", + "description": "The response of a SystemVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SystemVersion items on this page", + "items": { + "$ref": "#/definitions/SystemVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SystemVersionProperties": { + "type": "object", + "description": "System Version Resource model", + "properties": { + "systemVersion": { + "type": "string", + "description": "A valid Oracle System Version", + "readOnly": true + } + }, + "required": [ + "systemVersion" + ] + }, + "SystemVersionsFilter": { + "type": "object", + "description": "SystemVersions filter", + "properties": { + "giVersion": { + "type": "string", + "description": "Grid Infrastructure version" + }, + "shape": { + "type": "string", + "description": "Exadata shape" + }, + "isLatestVersion": { + "type": "boolean", + "description": "Check If we have to list only latest versions" + } + }, + "required": [ + "giVersion", + "shape" + ] + }, "TlsAuthenticationType": { "type": "string", - "description": "TlsAuthenticationType enum.", + "description": "TLS authentication type enum.", "enum": [ "Server", "Mutual" @@ -8996,19 +9549,19 @@ { "name": "Server", "value": "Server", - "description": "SERVER value" + "description": "Server authentication" }, { "name": "Mutual", "value": "Mutual", - "description": "MUTUAL value" + "description": "Mutual TLS" } ] } }, "UpdateAction": { "type": "string", - "description": "UpdateAction enum", + "description": "Update action enum", "enum": [ "RollingApply", "NonRollingApply", @@ -9022,22 +9575,22 @@ { "name": "RollingApply", "value": "RollingApply", - "description": "ROLLING_APPLY value" + "description": "Rolling apply action" }, { "name": "NonRollingApply", "value": "NonRollingApply", - "description": "NON_ROLLING_APPLY value" + "description": "Non rolling apply action" }, { "name": "PreCheck", "value": "PreCheck", - "description": "PRECHECK value" + "description": "Pre-check action" }, { "name": "RollBack", "value": "RollBack", - "description": "ROLLBACK value" + "description": "Rollback action" } ] } @@ -9092,41 +9645,17 @@ { "name": "Succeeded", "value": "Succeeded", - "description": "Succeeded value" + "description": "Validation succeeded" }, { "name": "Failed", "value": "Failed", - "description": "Failed value" + "description": "Validation failed" } ] }, "readOnly": true }, - "Versions": { - "type": "string", - "description": "Versions for API", - "enum": [ - "2023-09-01-preview", - "internal" - ], - "x-ms-enum": { - "name": "Versions", - "modelAsString": true, - "values": [ - { - "name": "v20230901", - "value": "2023-09-01-preview", - "description": "2023-09-01-preview" - }, - { - "name": "vInternalApi", - "value": "internal", - "description": "internal api - RPaaS to ORP" - } - ] - } - }, "VirtualNetworkAddress": { "type": "object", "description": "Virtual IP resource belonging to a vm cluster resource.", @@ -9164,27 +9693,27 @@ { "name": "Provisioning", "value": "Provisioning", - "description": "Provisioning value" + "description": "Indicates that resource in Provisioning state" }, { "name": "Available", "value": "Available", - "description": "Available value" + "description": "Indicates that resource in Available state" }, { "name": "Terminating", "value": "Terminating", - "description": "Terminating value" + "description": "Indicates that resource in Terminating state" }, { "name": "Terminated", "value": "Terminated", - "description": "Terminated value" + "description": "Indicates that resource in Terminated state" }, { "name": "Failed", "value": "Failed", - "description": "Failed value" + "description": "Indicates that resource in Failed state" } ] } @@ -9203,8 +9732,7 @@ "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "The link to the next page of items" } }, "required": [ @@ -9314,7 +9842,7 @@ }, "ZoneType": { "type": "string", - "description": "ZoneType enum", + "description": "Zone type enum", "enum": [ "Primary", "Secondary" @@ -9326,12 +9854,12 @@ { "name": "Primary", "value": "Primary", - "description": "Primary value" + "description": "Primary zone" }, { "name": "Secondary", "value": "Secondary", - "description": "Secondary value" + "description": "Secondary zone" } ] } diff --git a/specification/oracle/suppressions.yaml b/specification/oracle/suppressions.yaml deleted file mode 100644 index b7ac232bac09..000000000000 --- a/specification/oracle/suppressions.yaml +++ /dev/null @@ -1,3 +0,0 @@ -- tool: TypeSpecRequirement - path: resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json - reason: Private Preview version, TypeSpec will be added as fast follow \ No newline at end of file From d1bbbb3df368b5728e9fe5ccb53d8c380b398efa Mon Sep 17 00:00:00 2001 From: Wei Hu Date: Tue, 11 Jun 2024 15:47:56 +0800 Subject: [PATCH 153/343] Update TypeSpec for DeviceRegistry (#29319) * Update TypeSpec for DeviceRegistry * add client.tsp * fix model validation * fix example * fix example * remove unused csharp option * update client.tsp * fix tsp validation * fix more tsp validation * update csharp option --- .../assetEndpointProfiles.tsp | 6 +- .../DeviceRegistry.Management/assets.tsp | 9 +- .../DeviceRegistry.Management/client.tsp | 18 ++ .../2023-11-01-preview/Update_Asset.json | 8 +- .../Update_AssetEndpointProfile.json | 5 + .../DeviceRegistry.Management/tspconfig.yaml | 4 + .../2023-11-01-preview/deviceregistry.json | 230 +----------------- .../examples/Update_Asset.json | 8 +- .../examples/Update_AssetEndpointProfile.json | 5 + 9 files changed, 58 insertions(+), 235 deletions(-) create mode 100644 specification/deviceregistry/DeviceRegistry.Management/client.tsp diff --git a/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp b/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp index d47412e98703..14b4184ba0f8 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp @@ -122,10 +122,8 @@ interface AssetEndpointProfiles { createOrReplace is ArmResourceCreateOrReplaceAsync; - update is ArmResourcePatchAsync< - AssetEndpointProfile, - AssetEndpointProfileProperties - >; + @parameterVisibility + update is ArmCustomPatchAsync; delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/deviceregistry/DeviceRegistry.Management/assets.tsp b/specification/deviceregistry/DeviceRegistry.Management/assets.tsp index 155d378ccea6..6a695b570fa0 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/assets.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/assets.tsp @@ -56,7 +56,7 @@ model AssetProperties { @doc("A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must have the format /.") @visibility("read", "create") - assetEndpointProfileUri: string; + assetEndpointProfileUri: url; @doc("An integer that is incremented each time the resource is modified.") @visibility("read") @@ -66,7 +66,7 @@ model AssetProperties { manufacturer?: string; @doc("Asset manufacturer URI.") - manufacturerUri?: string; + manufacturerUri?: url; @doc("Asset model name.") // `model` is a reserved keyname. Wrap in double quotes @@ -82,7 +82,7 @@ model AssetProperties { softwareRevision?: string; @doc("Reference to the documentation.") - documentationUri?: string; + documentationUri?: url; @doc("Asset serial number.") serialNumber?: string; @@ -207,7 +207,8 @@ interface Assets { createOrReplace is ArmResourceCreateOrReplaceAsync; - update is ArmResourcePatchAsync; + @parameterVisibility + update is ArmCustomPatchAsync; delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/deviceregistry/DeviceRegistry.Management/client.tsp b/specification/deviceregistry/DeviceRegistry.Management/client.tsp new file mode 100644 index 000000000000..d676677d0a04 --- /dev/null +++ b/specification/deviceregistry/DeviceRegistry.Management/client.tsp @@ -0,0 +1,18 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +namespace Microsoft.DeviceRegistry; + +@@clientName(Asset, "DeviceRegistryAsset", "csharp"); +@@clientName(AssetEndpointProfile, + "DeviceRegistryAssetEndpointProfile", + "csharp" +); +@@clientName(ExtendedLocation, "DeviceRegistryExtendedLocation", "csharp"); +@@clientName(Event, "AssetEvent", "csharp"); +@@clientName(ProvisioningState, "DeviceRegistryProvisioningState", "csharp"); +@@clientName(ExtendedLocation.type, "ExtendedLocationType", "csharp"); +@@access(OperationStatus.get, Access.internal, "csharp"); +@@access(Operations.list, Access.internal, "csharp"); diff --git a/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json b/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json index 356d96faab2a..554f1c4f70a6 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json +++ b/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json @@ -8,9 +8,15 @@ "resourceGroupName": "myResourceGroup", "assetName": "my-asset", "properties": { + "location": "West Europe", "properties": { "enabled": false, - "displayName": "NewAssetDisplayName" + "displayName": "NewAssetDisplayName", + "assetEndpointProfileUri": "https://www.example.com/myAssetEndpointProfile" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1" } } }, diff --git a/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json b/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json index e4c17fcd8789..bc2ec7d92277 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json +++ b/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json @@ -8,8 +8,13 @@ "resourceGroupName": "myResourceGroup", "assetEndpointProfileName": "my-assetendpointprofile", "properties": { + "location": "West Europe", "properties": { "targetAddress": "https://www.example.com/myTargetAddress" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1" } } }, diff --git a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml index 2eb6b856421a..2d9ea203974c 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml +++ b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml @@ -17,6 +17,10 @@ options: namespace: "com.azure.resourcemanager.deviceregistry" service-name: "Device Registry" examples-directory: "examples" + "@azure-tools/typespec-csharp": + package-dir: "Azure.ResourceManager.DeviceRegistry" + namespace: "{package-dir}" + flavor: "azure" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json index 91e1f1a92e08..5991aaddadb6 100644 --- a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json +++ b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json @@ -404,7 +404,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AssetEndpointProfileUpdate" + "$ref": "#/definitions/AssetEndpointProfile" } } ], @@ -713,7 +713,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AssetUpdate" + "$ref": "#/definitions/Asset" } } ], @@ -939,46 +939,6 @@ "targetAddress" ] }, - "AssetEndpointProfileUpdate": { - "type": "object", - "description": "The type used for update operations of the AssetEndpointProfile.", - "properties": { - "tags": { - "type": "object", - "description": "Resource tags.", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/AssetEndpointProfileUpdateProperties", - "x-ms-client-flatten": true - } - } - }, - "AssetEndpointProfileUpdateProperties": { - "type": "object", - "description": "The updatable properties of the AssetEndpointProfile.", - "properties": { - "targetAddress": { - "type": "string", - "format": "uri", - "description": "The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration." - }, - "userAuthentication": { - "$ref": "#/definitions/UserAuthenticationUpdate", - "description": "Defines the client authentication mechanism to the server." - }, - "transportAuthentication": { - "$ref": "#/definitions/TransportAuthenticationUpdate", - "description": "Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device." - }, - "additionalConfiguration": { - "type": "string", - "description": "Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF)." - } - } - }, "AssetListResult": { "type": "object", "description": "The response of a Asset list operation.", @@ -1035,6 +995,7 @@ }, "assetEndpointProfileUri": { "type": "string", + "format": "uri", "description": "A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must have the format /.", "x-ms-mutability": [ "read", @@ -1053,6 +1014,7 @@ }, "manufacturerUri": { "type": "string", + "format": "uri", "description": "Asset manufacturer URI." }, "model": { @@ -1073,6 +1035,7 @@ }, "documentationUri": { "type": "string", + "format": "uri", "description": "Reference to the documentation." }, "serialNumber": { @@ -1157,106 +1120,6 @@ } } }, - "AssetUpdate": { - "type": "object", - "description": "The type used for update operations of the Asset.", - "properties": { - "tags": { - "type": "object", - "description": "Resource tags.", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/AssetUpdateProperties", - "x-ms-client-flatten": true - } - } - }, - "AssetUpdateProperties": { - "type": "object", - "description": "The updatable properties of the Asset.", - "properties": { - "assetType": { - "type": "string", - "description": "Resource path to asset type (model) definition." - }, - "enabled": { - "type": "boolean", - "description": "Enabled/Disabled status of the asset." - }, - "displayName": { - "type": "string", - "description": "Human-readable display name." - }, - "description": { - "type": "string", - "description": "Human-readable description of the asset." - }, - "manufacturer": { - "type": "string", - "description": "Asset manufacturer name." - }, - "manufacturerUri": { - "type": "string", - "description": "Asset manufacturer URI." - }, - "model": { - "type": "string", - "description": "Asset model name." - }, - "productCode": { - "type": "string", - "description": "Asset product code." - }, - "hardwareRevision": { - "type": "string", - "description": "Revision number of the hardware." - }, - "softwareRevision": { - "type": "string", - "description": "Revision number of the software." - }, - "documentationUri": { - "type": "string", - "description": "Reference to the documentation." - }, - "serialNumber": { - "type": "string", - "description": "Asset serial number." - }, - "attributes": { - "type": "object", - "description": "A set of key-value pairs that contain custom attributes set by the customer.", - "additionalProperties": {} - }, - "defaultDataPointsConfiguration": { - "type": "string", - "description": "Protocol-specific default configuration for all data points. Each data point can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol." - }, - "defaultEventsConfiguration": { - "type": "string", - "description": "Protocol-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol." - }, - "dataPoints": { - "type": "array", - "description": "Array of data points that are part of the asset. Each data point can reference an asset type capability and have per-data point configuration. See below for more details for the definition of the dataPoints element.", - "items": { - "$ref": "#/definitions/DataPoint" - }, - "x-ms-identifiers": [] - }, - "events": { - "type": "array", - "description": "Array of events that are part of the asset. Each event can reference an asset type capability and have per-event configuration. See below for more details about the definition of the events element.", - "items": { - "$ref": "#/definitions/Event" - }, - "x-ms-identifiers": [] - } - } - }, "DataPoint": { "type": "object", "description": "Defines the data point properties.", @@ -1465,20 +1328,6 @@ "ownCertificates" ] }, - "TransportAuthenticationUpdate": { - "type": "object", - "description": "Definition of the authentication mechanism for the southbound connector.", - "properties": { - "ownCertificates": { - "type": "array", - "description": "Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.", - "items": { - "$ref": "#/definitions/OwnCertificate" - }, - "x-ms-identifiers": [] - } - } - }, "UserAuthentication": { "type": "object", "description": "Definition of the client authentication mechanism to the server.", @@ -1527,51 +1376,6 @@ "mode" ] }, - "UserAuthenticationUpdate": { - "type": "object", - "description": "Definition of the client authentication mechanism to the server.", - "properties": { - "mode": { - "type": "string", - "description": "Defines the mode to authenticate the user of the client at the server.", - "default": "Certificate", - "enum": [ - "Anonymous", - "Certificate", - "UsernamePassword" - ], - "x-ms-enum": { - "name": "UserAuthenticationMode", - "modelAsString": true, - "values": [ - { - "name": "Anonymous", - "value": "Anonymous", - "description": "The user authentication mode is anonymous." - }, - { - "name": "Certificate", - "value": "Certificate", - "description": "The user authentication mode is an x509 certificate." - }, - { - "name": "UsernamePassword", - "value": "UsernamePassword", - "description": "The user authentication mode is a username and password." - } - ] - } - }, - "usernamePasswordCredentials": { - "$ref": "#/definitions/UsernamePasswordCredentialsUpdate", - "description": "Defines the username and password references when UsernamePassword user authentication mode is selected." - }, - "x509Credentials": { - "$ref": "#/definitions/X509CredentialsUpdate", - "description": "Defines the certificate reference when Certificate user authentication mode is selected." - } - } - }, "UsernamePasswordCredentials": { "type": "object", "description": "The credentials for authentication mode UsernamePassword.", @@ -1590,20 +1394,6 @@ "passwordReference" ] }, - "UsernamePasswordCredentialsUpdate": { - "type": "object", - "description": "The credentials for authentication mode UsernamePassword.", - "properties": { - "usernameReference": { - "type": "string", - "description": "A reference to secret containing the username." - }, - "passwordReference": { - "type": "string", - "description": "A reference to secret containing the password." - } - } - }, "X509Credentials": { "type": "object", "description": "The x509 certificate for authentication mode Certificate.", @@ -1616,16 +1406,6 @@ "required": [ "certificateReference" ] - }, - "X509CredentialsUpdate": { - "type": "object", - "description": "The x509 certificate for authentication mode Certificate.", - "properties": { - "certificateReference": { - "type": "string", - "description": "A reference to secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx)." - } - } } }, "parameters": {} diff --git a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_Asset.json b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_Asset.json index 356d96faab2a..554f1c4f70a6 100644 --- a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_Asset.json +++ b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_Asset.json @@ -8,9 +8,15 @@ "resourceGroupName": "myResourceGroup", "assetName": "my-asset", "properties": { + "location": "West Europe", "properties": { "enabled": false, - "displayName": "NewAssetDisplayName" + "displayName": "NewAssetDisplayName", + "assetEndpointProfileUri": "https://www.example.com/myAssetEndpointProfile" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1" } } }, diff --git a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_AssetEndpointProfile.json b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_AssetEndpointProfile.json index e4c17fcd8789..bc2ec7d92277 100644 --- a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_AssetEndpointProfile.json +++ b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_AssetEndpointProfile.json @@ -8,8 +8,13 @@ "resourceGroupName": "myResourceGroup", "assetEndpointProfileName": "my-assetendpointprofile", "properties": { + "location": "West Europe", "properties": { "targetAddress": "https://www.example.com/myTargetAddress" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1" } } }, From 99f53b4a8ca9b033437bf2d2fc790a61d1bc8a5b Mon Sep 17 00:00:00 2001 From: seanwang051 <99415155+seanwang051@users.noreply.github.com> Date: Tue, 11 Jun 2024 15:49:52 +0800 Subject: [PATCH 154/343] Enable UAMI auth for Data Factory Sql Server connector (#29205) * update * remove SAMI --------- Co-authored-by: seanwang051 Co-authored-by: Razvan Badea <156206747+razvanbadea-msft@users.noreply.github.com> --- .../stable/2018-06-01/entityTypes/LinkedService.json | 7 ++++++- .../stable/2020-12-01/entityTypes/LinkedService.json | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 632413244135..22a1f81ad6e5 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -460,7 +460,8 @@ }, "enum": [ "SQL", - "Windows" + "Windows", + "UserAssignedManagedIdentity" ], "type": "string", "description": "The type used for authentication. Type: string." @@ -481,6 +482,10 @@ "alwaysEncryptedSettings": { "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 38b9bd7b9079..523cf94b76a2 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -412,7 +412,8 @@ }, "enum": [ "SQL", - "Windows" + "Windows", + "UserAssignedManagedIdentity" ], "type": "string", "description": "The type used for authentication. Type: string." @@ -432,6 +433,10 @@ "alwaysEncryptedSettings": { "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." + }, + "credential": { + "$ref": "../artifacts.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } } }, From e37bdcd79a8d8fadf19c06dbc71155137a89830b Mon Sep 17 00:00:00 2001 From: James Suplizio Date: Tue, 11 Jun 2024 13:31:21 -0700 Subject: [PATCH 155/343] Move CODEOWNERS file to .github directory and see what happens (#29401) --- CODEOWNERS => .github/CODEOWNERS | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CODEOWNERS => .github/CODEOWNERS (100%) diff --git a/CODEOWNERS b/.github/CODEOWNERS similarity index 100% rename from CODEOWNERS rename to .github/CODEOWNERS From 4ee6d9fd7687d4b67117c5a167c191a7e7e70b53 Mon Sep 17 00:00:00 2001 From: Davide Montanari Date: Tue, 11 Jun 2024 15:14:30 -0700 Subject: [PATCH 156/343] Revert "Update TypeSpec for DeviceRegistry (#29319)" (#29398) This reverts commit d1bbbb3df368b5728e9fe5ccb53d8c380b398efa. Co-authored-by: Roopesh Manda --- .../assetEndpointProfiles.tsp | 6 +- .../DeviceRegistry.Management/assets.tsp | 9 +- .../DeviceRegistry.Management/client.tsp | 18 -- .../2023-11-01-preview/Update_Asset.json | 8 +- .../Update_AssetEndpointProfile.json | 5 - .../DeviceRegistry.Management/tspconfig.yaml | 4 - .../2023-11-01-preview/deviceregistry.json | 230 +++++++++++++++++- .../examples/Update_Asset.json | 8 +- .../examples/Update_AssetEndpointProfile.json | 5 - 9 files changed, 235 insertions(+), 58 deletions(-) delete mode 100644 specification/deviceregistry/DeviceRegistry.Management/client.tsp diff --git a/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp b/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp index 14b4184ba0f8..d47412e98703 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp @@ -122,8 +122,10 @@ interface AssetEndpointProfiles { createOrReplace is ArmResourceCreateOrReplaceAsync; - @parameterVisibility - update is ArmCustomPatchAsync; + update is ArmResourcePatchAsync< + AssetEndpointProfile, + AssetEndpointProfileProperties + >; delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/deviceregistry/DeviceRegistry.Management/assets.tsp b/specification/deviceregistry/DeviceRegistry.Management/assets.tsp index 6a695b570fa0..155d378ccea6 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/assets.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/assets.tsp @@ -56,7 +56,7 @@ model AssetProperties { @doc("A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must have the format /.") @visibility("read", "create") - assetEndpointProfileUri: url; + assetEndpointProfileUri: string; @doc("An integer that is incremented each time the resource is modified.") @visibility("read") @@ -66,7 +66,7 @@ model AssetProperties { manufacturer?: string; @doc("Asset manufacturer URI.") - manufacturerUri?: url; + manufacturerUri?: string; @doc("Asset model name.") // `model` is a reserved keyname. Wrap in double quotes @@ -82,7 +82,7 @@ model AssetProperties { softwareRevision?: string; @doc("Reference to the documentation.") - documentationUri?: url; + documentationUri?: string; @doc("Asset serial number.") serialNumber?: string; @@ -207,8 +207,7 @@ interface Assets { createOrReplace is ArmResourceCreateOrReplaceAsync; - @parameterVisibility - update is ArmCustomPatchAsync; + update is ArmResourcePatchAsync; delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/deviceregistry/DeviceRegistry.Management/client.tsp b/specification/deviceregistry/DeviceRegistry.Management/client.tsp deleted file mode 100644 index d676677d0a04..000000000000 --- a/specification/deviceregistry/DeviceRegistry.Management/client.tsp +++ /dev/null @@ -1,18 +0,0 @@ -import "./main.tsp"; -import "@azure-tools/typespec-client-generator-core"; - -using Azure.ClientGenerator.Core; - -namespace Microsoft.DeviceRegistry; - -@@clientName(Asset, "DeviceRegistryAsset", "csharp"); -@@clientName(AssetEndpointProfile, - "DeviceRegistryAssetEndpointProfile", - "csharp" -); -@@clientName(ExtendedLocation, "DeviceRegistryExtendedLocation", "csharp"); -@@clientName(Event, "AssetEvent", "csharp"); -@@clientName(ProvisioningState, "DeviceRegistryProvisioningState", "csharp"); -@@clientName(ExtendedLocation.type, "ExtendedLocationType", "csharp"); -@@access(OperationStatus.get, Access.internal, "csharp"); -@@access(Operations.list, Access.internal, "csharp"); diff --git a/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json b/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json index 554f1c4f70a6..356d96faab2a 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json +++ b/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json @@ -8,15 +8,9 @@ "resourceGroupName": "myResourceGroup", "assetName": "my-asset", "properties": { - "location": "West Europe", "properties": { "enabled": false, - "displayName": "NewAssetDisplayName", - "assetEndpointProfileUri": "https://www.example.com/myAssetEndpointProfile" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1" + "displayName": "NewAssetDisplayName" } } }, diff --git a/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json b/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json index bc2ec7d92277..e4c17fcd8789 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json +++ b/specification/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json @@ -8,13 +8,8 @@ "resourceGroupName": "myResourceGroup", "assetEndpointProfileName": "my-assetendpointprofile", "properties": { - "location": "West Europe", "properties": { "targetAddress": "https://www.example.com/myTargetAddress" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1" } } }, diff --git a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml index 2d9ea203974c..2eb6b856421a 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml +++ b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml @@ -17,10 +17,6 @@ options: namespace: "com.azure.resourcemanager.deviceregistry" service-name: "Device Registry" examples-directory: "examples" - "@azure-tools/typespec-csharp": - package-dir: "Azure.ResourceManager.DeviceRegistry" - namespace: "{package-dir}" - flavor: "azure" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json index 5991aaddadb6..91e1f1a92e08 100644 --- a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json +++ b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json @@ -404,7 +404,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AssetEndpointProfile" + "$ref": "#/definitions/AssetEndpointProfileUpdate" } } ], @@ -713,7 +713,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/Asset" + "$ref": "#/definitions/AssetUpdate" } } ], @@ -939,6 +939,46 @@ "targetAddress" ] }, + "AssetEndpointProfileUpdate": { + "type": "object", + "description": "The type used for update operations of the AssetEndpointProfile.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AssetEndpointProfileUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AssetEndpointProfileUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AssetEndpointProfile.", + "properties": { + "targetAddress": { + "type": "string", + "format": "uri", + "description": "The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration." + }, + "userAuthentication": { + "$ref": "#/definitions/UserAuthenticationUpdate", + "description": "Defines the client authentication mechanism to the server." + }, + "transportAuthentication": { + "$ref": "#/definitions/TransportAuthenticationUpdate", + "description": "Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device." + }, + "additionalConfiguration": { + "type": "string", + "description": "Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF)." + } + } + }, "AssetListResult": { "type": "object", "description": "The response of a Asset list operation.", @@ -995,7 +1035,6 @@ }, "assetEndpointProfileUri": { "type": "string", - "format": "uri", "description": "A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must have the format /.", "x-ms-mutability": [ "read", @@ -1014,7 +1053,6 @@ }, "manufacturerUri": { "type": "string", - "format": "uri", "description": "Asset manufacturer URI." }, "model": { @@ -1035,7 +1073,6 @@ }, "documentationUri": { "type": "string", - "format": "uri", "description": "Reference to the documentation." }, "serialNumber": { @@ -1120,6 +1157,106 @@ } } }, + "AssetUpdate": { + "type": "object", + "description": "The type used for update operations of the Asset.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AssetUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AssetUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Asset.", + "properties": { + "assetType": { + "type": "string", + "description": "Resource path to asset type (model) definition." + }, + "enabled": { + "type": "boolean", + "description": "Enabled/Disabled status of the asset." + }, + "displayName": { + "type": "string", + "description": "Human-readable display name." + }, + "description": { + "type": "string", + "description": "Human-readable description of the asset." + }, + "manufacturer": { + "type": "string", + "description": "Asset manufacturer name." + }, + "manufacturerUri": { + "type": "string", + "description": "Asset manufacturer URI." + }, + "model": { + "type": "string", + "description": "Asset model name." + }, + "productCode": { + "type": "string", + "description": "Asset product code." + }, + "hardwareRevision": { + "type": "string", + "description": "Revision number of the hardware." + }, + "softwareRevision": { + "type": "string", + "description": "Revision number of the software." + }, + "documentationUri": { + "type": "string", + "description": "Reference to the documentation." + }, + "serialNumber": { + "type": "string", + "description": "Asset serial number." + }, + "attributes": { + "type": "object", + "description": "A set of key-value pairs that contain custom attributes set by the customer.", + "additionalProperties": {} + }, + "defaultDataPointsConfiguration": { + "type": "string", + "description": "Protocol-specific default configuration for all data points. Each data point can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol." + }, + "defaultEventsConfiguration": { + "type": "string", + "description": "Protocol-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol." + }, + "dataPoints": { + "type": "array", + "description": "Array of data points that are part of the asset. Each data point can reference an asset type capability and have per-data point configuration. See below for more details for the definition of the dataPoints element.", + "items": { + "$ref": "#/definitions/DataPoint" + }, + "x-ms-identifiers": [] + }, + "events": { + "type": "array", + "description": "Array of events that are part of the asset. Each event can reference an asset type capability and have per-event configuration. See below for more details about the definition of the events element.", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [] + } + } + }, "DataPoint": { "type": "object", "description": "Defines the data point properties.", @@ -1328,6 +1465,20 @@ "ownCertificates" ] }, + "TransportAuthenticationUpdate": { + "type": "object", + "description": "Definition of the authentication mechanism for the southbound connector.", + "properties": { + "ownCertificates": { + "type": "array", + "description": "Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.", + "items": { + "$ref": "#/definitions/OwnCertificate" + }, + "x-ms-identifiers": [] + } + } + }, "UserAuthentication": { "type": "object", "description": "Definition of the client authentication mechanism to the server.", @@ -1376,6 +1527,51 @@ "mode" ] }, + "UserAuthenticationUpdate": { + "type": "object", + "description": "Definition of the client authentication mechanism to the server.", + "properties": { + "mode": { + "type": "string", + "description": "Defines the mode to authenticate the user of the client at the server.", + "default": "Certificate", + "enum": [ + "Anonymous", + "Certificate", + "UsernamePassword" + ], + "x-ms-enum": { + "name": "UserAuthenticationMode", + "modelAsString": true, + "values": [ + { + "name": "Anonymous", + "value": "Anonymous", + "description": "The user authentication mode is anonymous." + }, + { + "name": "Certificate", + "value": "Certificate", + "description": "The user authentication mode is an x509 certificate." + }, + { + "name": "UsernamePassword", + "value": "UsernamePassword", + "description": "The user authentication mode is a username and password." + } + ] + } + }, + "usernamePasswordCredentials": { + "$ref": "#/definitions/UsernamePasswordCredentialsUpdate", + "description": "Defines the username and password references when UsernamePassword user authentication mode is selected." + }, + "x509Credentials": { + "$ref": "#/definitions/X509CredentialsUpdate", + "description": "Defines the certificate reference when Certificate user authentication mode is selected." + } + } + }, "UsernamePasswordCredentials": { "type": "object", "description": "The credentials for authentication mode UsernamePassword.", @@ -1394,6 +1590,20 @@ "passwordReference" ] }, + "UsernamePasswordCredentialsUpdate": { + "type": "object", + "description": "The credentials for authentication mode UsernamePassword.", + "properties": { + "usernameReference": { + "type": "string", + "description": "A reference to secret containing the username." + }, + "passwordReference": { + "type": "string", + "description": "A reference to secret containing the password." + } + } + }, "X509Credentials": { "type": "object", "description": "The x509 certificate for authentication mode Certificate.", @@ -1406,6 +1616,16 @@ "required": [ "certificateReference" ] + }, + "X509CredentialsUpdate": { + "type": "object", + "description": "The x509 certificate for authentication mode Certificate.", + "properties": { + "certificateReference": { + "type": "string", + "description": "A reference to secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx)." + } + } } }, "parameters": {} diff --git a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_Asset.json b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_Asset.json index 554f1c4f70a6..356d96faab2a 100644 --- a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_Asset.json +++ b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_Asset.json @@ -8,15 +8,9 @@ "resourceGroupName": "myResourceGroup", "assetName": "my-asset", "properties": { - "location": "West Europe", "properties": { "enabled": false, - "displayName": "NewAssetDisplayName", - "assetEndpointProfileUri": "https://www.example.com/myAssetEndpointProfile" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1" + "displayName": "NewAssetDisplayName" } } }, diff --git a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_AssetEndpointProfile.json b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_AssetEndpointProfile.json index bc2ec7d92277..e4c17fcd8789 100644 --- a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_AssetEndpointProfile.json +++ b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/examples/Update_AssetEndpointProfile.json @@ -8,13 +8,8 @@ "resourceGroupName": "myResourceGroup", "assetEndpointProfileName": "my-assetendpointprofile", "properties": { - "location": "West Europe", "properties": { "targetAddress": "https://www.example.com/myTargetAddress" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1" } } }, From de1f3772629b6f4d3ac01548a5f6d719bfb97c9e Mon Sep 17 00:00:00 2001 From: Chris Stackhouse Date: Tue, 11 Jun 2024 18:24:43 -0700 Subject: [PATCH 157/343] Change readme.md to allow generation of latest python SDK (#29345) * Fix 2023-04-01 policy package issue preventing pythin SDK generation * python config * Fix for additional breaking change. * Update policyDefinitionVersions.json * Update policySetDefinitionVersions.json --------- Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: Yuchao Yan Co-authored-by: Roopesh Manda --- .../stable/2023-04-01/policyDefinitionVersions.json | 6 ++++-- .../stable/2023-04-01/policySetDefinitionVersions.json | 6 ++++-- specification/resources/resource-manager/readme.python.md | 1 + 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policyDefinitionVersions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policyDefinitionVersions.json index e67a246707f0..b5ba4e61e8fa 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policyDefinitionVersions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policyDefinitionVersions.json @@ -786,7 +786,8 @@ "required": true, "type": "string", "pattern": "^[^<>*%&:\\?.+/]*[^<>*%&:\\?.+/ ]+$", - "description": "The name of the policy definition." + "description": "The name of the policy definition.", + "x-ms-parameter-location": "method" }, "PolicyDefinitionVersion": { "name": "policyDefinitionVersion", @@ -794,7 +795,8 @@ "required": true, "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$", - "description": "The policy definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number" + "description": "The policy definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number", + "x-ms-parameter-location": "method" }, "PolicyDefinitionsFilterParameter": { "name": "$filter", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json index 762c3043d623..a814c951f329 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json @@ -786,7 +786,8 @@ "required": true, "type": "string", "pattern": "^[^<>*%&:\\?.+/]*[^<>*%&:\\?.+/ ]+$", - "description": "The name of the policy set definition." + "description": "The name of the policy set definition.", + "x-ms-parameter-location": "method" }, "PolicySetDefinitionVersion": { "name": "policyDefinitionVersion", @@ -794,7 +795,8 @@ "required": true, "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$", - "description": "The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number" + "description": "The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number", + "x-ms-parameter-location": "method" }, "PolicySetDefinitionsFilterParameter": { "name": "$filter", diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index 6f0202da90ca..47b1ef774a77 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -33,6 +33,7 @@ batch: - multiapiscript-locks: true - tag: package-managedapplications-2019-07 - multiapiscript-managedapplications: true + - tag: package-policy-2023-04-only - tag: package-policy-2022-08-preview-only - tag: package-policy-2022-07-preview-only - tag: package-policy-2022-06-only From 6c4f3c695f0250dcb261598a62004f0aef10b9db Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 12 Jun 2024 14:46:13 +0800 Subject: [PATCH 158/343] [scvmm&azure fleet&oracle] update python config (#29393) * update python config * update python config for azure fleet * update python config for oracle --- specification/azurefleet/AzureFleet.Management/client.tsp | 6 ++++++ .../azurefleet/AzureFleet.Management/tspconfig.yaml | 4 ++++ specification/oracle/Oracle.Database/client.tsp | 6 ++++++ specification/oracle/Oracle.Database/tspconfig.yaml | 3 +++ specification/scvmm/ScVmm.Management/client.tsp | 6 ++++++ specification/scvmm/ScVmm.Management/tspconfig.yaml | 7 +++++++ 6 files changed, 32 insertions(+) create mode 100644 specification/azurefleet/AzureFleet.Management/client.tsp create mode 100644 specification/oracle/Oracle.Database/client.tsp create mode 100644 specification/scvmm/ScVmm.Management/client.tsp diff --git a/specification/azurefleet/AzureFleet.Management/client.tsp b/specification/azurefleet/AzureFleet.Management/client.tsp new file mode 100644 index 000000000000..490f92718e21 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/client.tsp @@ -0,0 +1,6 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.AzureFleet, "ComputeFleetMgmt", "python"); diff --git a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml index de88829850b6..766d0dc18cb5 100644 --- a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml +++ b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml @@ -23,3 +23,7 @@ options: namespace: "{package-dir}" # Added to support generic model conversion from compute VM types use-model-reader-writer: true + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-computefleet" + package-name: "{package-dir}" + flavor: "azure" diff --git a/specification/oracle/Oracle.Database/client.tsp b/specification/oracle/Oracle.Database/client.tsp new file mode 100644 index 000000000000..fbea85d30927 --- /dev/null +++ b/specification/oracle/Oracle.Database/client.tsp @@ -0,0 +1,6 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Oracle.Database, "OracleDatabaseMgmt", "python"); diff --git a/specification/oracle/Oracle.Database/tspconfig.yaml b/specification/oracle/Oracle.Database/tspconfig.yaml index c7f8c641b6e4..3c83003a4bed 100644 --- a/specification/oracle/Oracle.Database/tspconfig.yaml +++ b/specification/oracle/Oracle.Database/tspconfig.yaml @@ -1,3 +1,6 @@ +parameters: + "service-dir": + default: "sdk/oracledatabase" emit: - "@azure-tools/typespec-autorest" diff --git a/specification/scvmm/ScVmm.Management/client.tsp b/specification/scvmm/ScVmm.Management/client.tsp new file mode 100644 index 000000000000..06a15e529806 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/client.tsp @@ -0,0 +1,6 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.ScVmm, "ScVmmMgmtClient", "python"); diff --git a/specification/scvmm/ScVmm.Management/tspconfig.yaml b/specification/scvmm/ScVmm.Management/tspconfig.yaml index 8345bf5a9d7e..c8328383295e 100644 --- a/specification/scvmm/ScVmm.Management/tspconfig.yaml +++ b/specification/scvmm/ScVmm.Management/tspconfig.yaml @@ -1,3 +1,6 @@ +parameters: + "service-dir": + default: "sdk/scvmm" emit: - "@azure-tools/typespec-autorest" options: @@ -8,6 +11,10 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/scvmm.json" examples-directory: "{project-root}/examples" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-scvmm" + package-name: "{package-dir}" + flavor: "azure" linter: disable: extends: From 7d872886ebffebe09c128a300a2dd5d3d7f6a726 Mon Sep 17 00:00:00 2001 From: ddumesnil-microsoft <112983087+ddumesnil-microsoft@users.noreply.github.com> Date: Wed, 12 Jun 2024 01:01:52 -0700 Subject: [PATCH 159/343] Release purview microsoft.purview preview/2024 04 01 preview (#28792) * Initial commit for adding 2024-04-01-preview API version * Changes for 2024-04-01-preview API version * PR Feedback --- .../Accounts_AddRootCollectionAdmin.json | 22 + .../Accounts_CheckNameAvailability.json | 24 + .../examples/Accounts_CreateOrUpdate.json | 98 + .../examples/Accounts_Delete.json | 39 + .../examples/Accounts_Get.json | 91 + .../Accounts_ListByResourceGroup.json | 144 + .../examples/Accounts_ListBySubscription.json | 143 + .../examples/Accounts_ListKeys.json | 23 + .../examples/Accounts_Update.json | 129 + .../examples/DefaultAccounts_Get.json | 27 + .../examples/DefaultAccounts_Remove.json | 28 + .../examples/DefaultAccounts_Set.json | 32 + .../examples/Features_AccountGet.json | 31 + .../examples/Features_SubscriptionGet.json | 30 + ...estionPrivateEndpointConnections_List.json | 51 + ...ivateEndpointConnections_UpdateStatus.json | 27 + .../KafkaConfigurations_CreateOrUpdate.json | 79 + .../examples/KafkaConfigurations_Delete.json | 13 + .../examples/KafkaConfigurations_Get.json | 38 + .../KafkaConfigurations_ListByAccount.json | 43 + .../examples/Operations_List.json | 75 + ...ateEndpointConnections_CreateOrUpdate.json | 69 + .../PrivateEndpointConnections_Delete.json | 40 + .../PrivateEndpointConnections_Get.json | 35 + ...vateEndpointConnections_ListByAccount.json | 53 + .../PrivateLinkResources_GetByGroupId.json | 34 + .../PrivateLinkResources_ListByAccount.json | 51 + .../examples/Usages_Get.json | 42 + .../preview/2024-04-01-preview/purview.json | 3060 +++++++++++++++++ .../purview/resource-manager/readme.md | 13 +- 30 files changed, 4582 insertions(+), 2 deletions(-) create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_AddRootCollectionAdmin.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_CheckNameAvailability.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_CreateOrUpdate.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Delete.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Get.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListByResourceGroup.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListBySubscription.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListKeys.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Update.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Get.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Remove.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Set.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Features_AccountGet.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Features_SubscriptionGet.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/IngestionPrivateEndpointConnections_List.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/IngestionPrivateEndpointConnections_UpdateStatus.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_CreateOrUpdate.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_Delete.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_Get.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_ListByAccount.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Operations_List.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_CreateOrUpdate.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_Delete.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_Get.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_ListByAccount.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateLinkResources_GetByGroupId.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateLinkResources_ListByAccount.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Usages_Get.json create mode 100644 specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/purview.json diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_AddRootCollectionAdmin.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_AddRootCollectionAdmin.json new file mode 100644 index 000000000000..c3250bf6baa5 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_AddRootCollectionAdmin.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview", + "collectionAdminUpdate": { + "objectId": "7e8de0e7-2bfc-4e1f-9659-2a5785e4356f" + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_CheckNameAvailability.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_CheckNameAvailability.json new file mode 100644 index 000000000000..f0c9448a752a --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_CheckNameAvailability.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "checkNameAvailabilityRequest": { + "name": "account1", + "type": "Microsoft.Purview/accounts" + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_CreateOrUpdate.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..f394c32ed045 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview", + "account": { + "location": "West US 2" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "friendlyName": "friendly-account1", + "provisioningState": "Creating", + "accountStatus": { + "accountProvisioningState": "Succeeded", + "errorDetails": {} + }, + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled" + } + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "provisioningState": "Succeeded", + "accountStatus": { + "accountProvisioningState": "Succeeded", + "errorDetails": {} + }, + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled", + "managedResourceGroupName": "custom-rgname", + "managedResourcesPublicNetworkAccess": "Enabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + }, + "ingestionStorage": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/ingestion-storage-rg-mwjotkl", + "primaryEndpoint": "https://ingestioneastusddnpkar.z31.blob.storage.azure.net/", + "publicNetworkAccess": "Enabled" + }, + "tenantEndpointState": "Disabled" + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Delete.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Delete.json new file mode 100644 index 000000000000..b3adff3a32f2 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Delete.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + }, + "202": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2021-07-01" + } + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Get.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Get.json new file mode 100644 index 000000000000..0c6543391a1b --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Get.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "provisioningState": "Succeeded", + "accountStatus": { + "accountProvisioningState": "Succeeded", + "errorDetails": {} + }, + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com" + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection, thanks.", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "type": "Microsoft.Purview/accounts/privateEndpointConnections" + } + ], + "publicNetworkAccess": "Enabled", + "managedResourceGroupName": "managed-rg-mwjotkl", + "managedResourcesPublicNetworkAccess": "Enabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + }, + "ingestionStorage": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/ingestion-storage-rg-mwjotkl", + "primaryEndpoint": "https://ingestioneastusddnpkar.z31.blob.storage.azure.net/", + "publicNetworkAccess": "Enabled" + }, + "mergeInfo": { + "accountLocation": "westus2", + "accountName": "otherAccount", + "accountResourceGroupName": "otherAccountRG", + "accountSubscriptionId": "92d4ce06-0032-4e6b-9103-88ba3e159551", + "typeOfAccount": "Secondary", + "mergeStatus": "Succeeded", + "deprovisioned": false + }, + "defaultDomain": "account1", + "tenantEndpointState": "Disabled" + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListByResourceGroup.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListByResourceGroup.json new file mode 100644 index 000000000000..3e284955734f --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListByResourceGroup.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" + }, + "body": { + "value": [ + { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "provisioningState": "Succeeded", + "accountStatus": { + "accountProvisioningState": "Succeeded", + "errorDetails": {} + }, + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com" + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection, thanks.", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "type": "Microsoft.Purview/accounts/privateEndpointConnections" + } + ], + "publicNetworkAccess": "Enabled", + "managedResourceGroupName": "managed-rg-mwjotkl", + "managedResourcesPublicNetworkAccess": "Enabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + }, + "ingestionStorage": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/ingestion-storage-rg-mwjotkl", + "primaryEndpoint": "https://ingestioneastusddnpkar.z31.blob.storage.azure.net/", + "publicNetworkAccess": "Enabled" + } + } + }, + { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account2", + "name": "account2", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account2", + "provisioningState": "Succeeded", + "accountStatus": { + "accountProvisioningState": "Succeeded", + "errorDetails": {} + }, + "endpoints": { + "catalog": "https://account2.catalog.purview.azure-test.com", + "scan": "https://account2.scan.purview.azure-test.com" + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection, thanks.", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "type": "Microsoft.Purview/accounts/privateEndpointConnections" + } + ], + "publicNetworkAccess": "Enabled", + "managedResourceGroupName": "managed-rg-mwjotkl", + "managedResourcesPublicNetworkAccess": "Enabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + }, + "ingestionStorage": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/ingestion-storage-rg-mwjotkl", + "primaryEndpoint": "https://ingestioneastusddnpkar.z31.blob.storage.azure.net/", + "publicNetworkAccess": "Enabled" + } + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListBySubscription.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListBySubscription.json new file mode 100644 index 000000000000..0912545f98f4 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListBySubscription.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" + }, + "body": { + "value": [ + { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "provisioningState": "Succeeded", + "accountStatus": { + "accountProvisioningState": "Succeeded", + "errorDetails": {} + }, + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com" + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection, thanks.", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "type": "Microsoft.Purview/accounts/privateEndpointConnections" + } + ], + "publicNetworkAccess": "Enabled", + "managedResourceGroupName": "managed-rg-mwjotkl", + "managedResourcesPublicNetworkAccess": "Enabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + }, + "ingestionStorage": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/ingestion-storage-rg-mwjotkl", + "primaryEndpoint": "https://ingestioneastusddnpkar.z31.blob.storage.azure.net/", + "publicNetworkAccess": "Enabled" + } + } + }, + { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account2", + "name": "account2", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account2", + "provisioningState": "Succeeded", + "accountStatus": { + "accountProvisioningState": "Succeeded", + "errorDetails": {} + }, + "endpoints": { + "catalog": "https://account2.catalog.purview.azure-test.com", + "scan": "https://account2.scan.purview.azure-test.com" + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection, thanks.", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "type": "Microsoft.Purview/accounts/privateEndpointConnections" + } + ], + "publicNetworkAccess": "Enabled", + "managedResourceGroupName": "managed-rg-mwjotkl", + "managedResourcesPublicNetworkAccess": "Enabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + }, + "ingestionStorage": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/ingestion-storage-rg-mwjotkl", + "primaryEndpoint": "https://ingestioneastusddnpkar.z31.blob.storage.azure.net/", + "publicNetworkAccess": "Enabled" + } + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListKeys.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListKeys.json new file mode 100644 index 000000000000..eadb136f81cf --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_ListKeys.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "atlasKafkaPrimaryEndpoint": "Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=ASDASasdfmasdf123412341234=", + "atlasKafkaSecondaryEndpoint": "Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=AlternateSharedAccessKey;SharedAccessKey=BSDASasdfmasdf123412341234=" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Update.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Update.json new file mode 100644 index 000000000000..db8c1d594d06 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Accounts_Update.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview", + "accountUpdateParameters": { + "properties": { + "cloudConnectors": {}, + "publicNetworkAccess": "Disabled", + "managedResourcesPublicNetworkAccess": "Disabled", + "ingestionStorage": { + "publicNetworkAccess": "Disabled" + } + }, + "tags": { + "newTag": "New tag value." + } + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "provisioningState": "Succeeded", + "accountStatus": { + "accountProvisioningState": "Succeeded", + "errorDetails": {} + }, + "endpoints": { + "catalog": "https://account2.catalog.purview.azure-test.com", + "scan": "https://account2.scan.purview.azure-test.com" + }, + "publicNetworkAccess": "Disabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + }, + "ingestionStorage": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/ingestion-storage-rg-mwjotkl", + "primaryEndpoint": "https://ingestioneastusddnpkar.z31.blob.storage.azure.net/", + "publicNetworkAccess": "Disabled" + }, + "tenantEndpointState": "Disabled" + }, + "tags": { + "newTag": "New tag value." + } + } + }, + "202": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2021-07-01" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account2.catalog.purview.azure-test.com", + "scan": "https://account2.scan.purview.azure-test.com" + }, + "publicNetworkAccess": "Disabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + }, + "ingestionStorage": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/ingestion-storage-rg-mwjotkl", + "primaryEndpoint": "https://ingestioneastusddnpkar.z31.blob.storage.azure.net/", + "publicNetworkAccess": "Disabled" + }, + "tenantEndpointState": "Disabled" + }, + "tags": { + "newTag": "New tag value." + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Get.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Get.json new file mode 100644 index 000000000000..68ec56027047 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "scopeTenantId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-1234-12345678abcd", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "scopeTenantId": "12345678-1234-1234-1234-12345678abcd", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-1234-12345678abcd", + "accountName": "myDefaultAccount", + "resourceGroupName": "rg-1", + "subscriptionId": "12345678-1234-1234-1234-12345678aaaa" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Remove.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Remove.json new file mode 100644 index 000000000000..0a293adb9156 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Remove.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "scopeTenantId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-1234-12345678abcd", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Set.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Set.json new file mode 100644 index 000000000000..8f5f4e730192 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/DefaultAccounts_Set.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "defaultAccountPayload": { + "scopeTenantId": "12345678-1234-1234-1234-12345678abcd", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-1234-12345678abcd", + "accountName": "myDefaultAccount", + "resourceGroupName": "rg-1", + "subscriptionId": "12345678-1234-1234-1234-12345678aaaa" + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "scopeTenantId": "12345678-1234-1234-1234-12345678abcd", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-1234-12345678abcd", + "accountName": "myDefaultAccount", + "resourceGroupName": "rg-1", + "subscriptionId": "12345678-1234-1234-1234-12345678aaaa" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Features_AccountGet.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Features_AccountGet.json new file mode 100644 index 000000000000..089be2f1eb7a --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Features_AccountGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "featureRequest": { + "features": [ + "Feature1", + "Feature2", + "FeatureThatDoesntExist" + ] + }, + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "features": { + "Feature1": true, + "Feature2": false + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Features_SubscriptionGet.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Features_SubscriptionGet.json new file mode 100644 index 000000000000..cb9389619390 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Features_SubscriptionGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "locations": "eastus", + "featureRequest": { + "features": [ + "Feature1", + "Feature2", + "FeatureThatDoesntExist" + ] + }, + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "features": { + "Feature1": true, + "Feature2": false + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/IngestionPrivateEndpointConnections_List.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/IngestionPrivateEndpointConnections_List.json new file mode 100644 index 000000000000..c185136f60c5 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/IngestionPrivateEndpointConnections_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" + }, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/ingestionPrivateEndpointConnections/privateEndpointConnection1", + "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/ingestionPrivateEndpointConnections/privateEndpointConnection2", + "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections", + "properties": { + "provisioningState": "Deleting", + "privateEndpoint": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "Rejected by johndoe@company.com" + } + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/IngestionPrivateEndpointConnections_UpdateStatus.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/IngestionPrivateEndpointConnections_UpdateStatus.json new file mode 100644 index 000000000000..38151c3a276a --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/IngestionPrivateEndpointConnections_UpdateStatus.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview", + "request": { + "privateEndpointId": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "status": "Approved" + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "privateEndpointId": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "status": "Approved" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_CreateOrUpdate.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_CreateOrUpdate.json new file mode 100644 index 000000000000..6c83a5ab9970 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_CreateOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rgpurview", + "accountName": "account1", + "kafkaConfigurationName": "kafkaConfigName", + "kafkaConfiguration": { + "properties": { + "eventStreamingState": "Enabled", + "eventStreamingType": "Azure", + "consumerGroup": "consumerGroup", + "credentials": { + "identityId": "/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId", + "type": "UserAssigned" + }, + "eventHubType": "Notification", + "eventHubPartitionId": "partitionId", + "eventHubResourceId": "/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName" + } + }, + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "kafkaConfigName", + "properties": { + "eventStreamingState": "Enabled", + "eventStreamingType": "Azure", + "consumerGroup": "consumerGroup", + "credentials": { + "identityId": "/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId", + "type": "UserAssigned" + }, + "eventHubType": "Notification", + "eventHubPartitionId": "aaaaa", + "eventHubResourceId": "/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/kafkaConfigurations/default", + "systemData": { + "createdAt": "2022-03-09T01:36:27.637Z", + "createdBy": "User@user", + "createdByType": "User", + "lastModifiedAt": "2022-03-09T01:36:27.637Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User" + }, + "type": "Microsoft.Purview/accounts/kafkaconfiguration" + } + }, + "201": { + "body": { + "name": "kafkaConfigName", + "properties": { + "eventStreamingState": "Enabled", + "eventStreamingType": "Azure", + "consumerGroup": "consumerGroup", + "credentials": { + "identityId": "/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId", + "type": "UserAssigned" + }, + "eventHubType": "Notification", + "eventHubPartitionId": "aaaaa", + "eventHubResourceId": "/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/kafkaConfigurations/default", + "systemData": { + "createdAt": "2022-03-09T01:36:27.637Z", + "createdBy": "User@user", + "createdByType": "User", + "lastModifiedAt": "2022-03-09T01:36:27.637Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User" + }, + "type": "Microsoft.Purview/accounts/kafkaconfiguration" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_Delete.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_Delete.json new file mode 100644 index 000000000000..8ebda25640de --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rgpurview", + "accountName": "account1", + "kafkaConfigurationName": "kafkaConfigName", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_Get.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_Get.json new file mode 100644 index 000000000000..4d80562730e7 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rgpurview", + "accountName": "account1", + "kafkaConfigurationName": "kafkaConfigName", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "eventStreamingState": "Enabled", + "eventStreamingType": "Azure", + "consumerGroup": "consumerGroup", + "credentials": { + "identityId": "/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId", + "type": "UserAssigned" + }, + "eventHubType": "Notification", + "eventHubPartitionId": "partitionId", + "eventHubResourceId": "/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/kafkaConfigurations/default", + "name": "kafkaConfigName", + "systemData": { + "createdAt": "2022-03-09T01:36:27.637Z", + "createdBy": "User@user", + "createdByType": "User", + "lastModifiedAt": "2022-03-09T01:36:27.637Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User" + }, + "type": "Microsoft.Purview/accounts/kafkaconfiguration" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_ListByAccount.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_ListByAccount.json new file mode 100644 index 000000000000..6e681dfa89a2 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/KafkaConfigurations_ListByAccount.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rgpurview", + "accountName": "account1", + "api-version": "2024-04-01-preview", + "$skipToken": "token" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/kafkaConfigurations/default", + "name": "kafkaconfigName", + "type": "Microsoft.Purview/accounts/kafkaconfiguration", + "properties": { + "eventStreamingState": "Disabled", + "eventStreamingType": "None", + "consumerGroup": "consumerGroup", + "credentials": { + "identityId": "/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId", + "type": "UserAssigned" + }, + "eventHubType": "Notification", + "eventHubPartitionId": "partitionId", + "eventHubResourceId": "/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName" + }, + "systemData": { + "createdAt": "2022-03-17T04:23:24.157Z", + "createdBy": "user", + "createdByType": "User", + "lastModifiedAt": "2022-03-17T04:23:24.157Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Operations_List.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..61f85e4e6f43 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Operations_List.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "name": "Microsoft.Purview/operations/read", + "display": { + "provider": "Microsoft Purview", + "resource": "Operations", + "operation": "Read all operations", + "description": "Reads all available operations in Purview Resource Provider." + } + }, + { + "name": "Microsoft.Purview/register/action", + "display": { + "provider": "Microsoft Purview", + "resource": "Purview Resource Provider", + "operation": "Register Purview Resource Provider", + "description": "Register the subscription for Purview Resource Provider" + } + }, + { + "name": "Microsoft.Purview/unregister/action", + "display": { + "provider": "Microsoft Purview", + "resource": "Purview Resource Provider", + "operation": "Unregister Purview Resource Provider", + "description": "Unregister the subscription for Purview Resource Provider" + } + }, + { + "name": "Microsoft.Purview/accounts/read", + "display": { + "provider": "Microsoft Purview", + "resource": "Account", + "operation": "Read account resource", + "description": "Read account resource for Purview Resource Provider." + } + }, + { + "name": "Microsoft.Purview/accounts/write", + "display": { + "provider": "Microsoft Purview", + "resource": "Account", + "operation": "Write account resource", + "description": "Write account resource for Purview Resource Provider." + } + }, + { + "name": "Microsoft.Purview/accounts/delete", + "display": { + "provider": "Microsoft Purview", + "resource": "Account", + "operation": "Delete account resource", + "description": "Delete account resource for Purview Resource Provider." + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_CreateOrUpdate.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_CreateOrUpdate.json new file mode 100644 index 000000000000..5acc2c03ddfc --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "privateEndpointConnectionName": "privateEndpointConnection1", + "api-version": "2024-04-01-preview", + "request": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://management.azure.com/subscriptions34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1?api-version=2021-07-01" + }, + "body": { + "name": "privateEndpointConnection1", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "name": "privateEndpointConnection1", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_Delete.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..ffee7596c5aa --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_Delete.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "privateEndpointConnectionName": "privateEndpointConnection1", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + }, + "202": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://management.azure.com/subscriptions34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1?api-version=2021-07-01" + } + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_Get.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..0b9a27185891 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "privateEndpointConnectionName": "privateEndpointConnection1", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "name": "privateEndpointConnection1", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_ListByAccount.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_ListByAccount.json new file mode 100644 index 000000000000..9ea1f47d8543 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateEndpointConnections_ListByAccount.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" + }, + "body": { + "value": [ + { + "name": "privateEndpointConnection1", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + }, + { + "name": "privateEndpointConnection2", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection2", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Deleting", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "Rejected by johndoe@company.com" + } + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateLinkResources_GetByGroupId.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateLinkResources_GetByGroupId.json new file mode 100644 index 000000000000..bc28978dda88 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateLinkResources_GetByGroupId.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "groupId": "group1", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateLinkResources/plr1", + "name": "plr1", + "type": "Microsoft.Purview/accounts/privateLinkResources", + "properties": { + "groupId": "group1", + "requiredMembers": [ + "group1" + ], + "requiredZoneNames": [ + "privatelinkzone1.service.azure.com" + ] + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateLinkResources_ListByAccount.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateLinkResources_ListByAccount.json new file mode 100644 index 000000000000..9bc245ff260c --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/PrivateLinkResources_ListByAccount.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateLinkResources/plr1", + "name": "plr1", + "type": "Microsoft.Purview/accounts/privateLinkResources", + "properties": { + "groupId": "account1", + "requiredMembers": [ + "account1" + ], + "requiredZoneNames": [ + "privatelinkzone1.service.azure.com" + ] + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateLinkResources/plr2", + "name": "plr2", + "type": "Microsoft.Purview/accounts/privateLinkResources", + "properties": { + "groupId": "account2", + "requiredMembers": [ + "account2" + ], + "requiredZoneNames": [ + "privatelinkzone2.service.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Usages_Get.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Usages_Get.json new file mode 100644 index 000000000000..0e179735916b --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/examples/Usages_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "location": "West US 2", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 1, + "limit": 3, + "id": "", + "name": { + "value": "Purview-Account-Subscription", + "localizedValue": "Purview-Account-Subscription" + } + }, + { + "unit": "Count", + "currentValue": 2, + "limit": 3, + "id": "", + "name": { + "value": "Purview-Account-Tenant", + "localizedValue": "Purview-Account-Tenant" + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/purview.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/purview.json new file mode 100644 index 000000000000..4e6d9614bb85 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2024-04-01-preview/purview.json @@ -0,0 +1,3060 @@ +{ + "swagger": "2.0", + "info": { + "title": "PurviewManagementClient", + "description": "Creates a Microsoft.Purview management client.", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts": { + "get": { + "tags": [ + "Account" + ], + "summary": "Gets the accounts resources by subscription.", + "description": "List accounts in Subscription", + "operationId": "Accounts_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "query", + "name": "$skipToken", + "description": "The skip token.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Accounts_ListBySubscription": { + "$ref": "./examples/Accounts_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts": { + "get": { + "tags": [ + "Account" + ], + "summary": "Gets the accounts resources by resource group.", + "description": "List accounts in ResourceGroup", + "operationId": "Accounts_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "query", + "name": "$skipToken", + "description": "The skip token.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Accounts_ListByResourceGroup": { + "$ref": "./examples/Accounts_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}": { + "get": { + "tags": [ + "Account" + ], + "summary": "Gets the account resource.", + "description": "Get an account", + "operationId": "Accounts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "./examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "Account" + ], + "summary": "Create or update an account resource.", + "description": "Creates or updates an account", + "operationId": "Accounts_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "account", + "description": "The account.", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "./examples/Accounts_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Account" + ], + "summary": "Deletes the account resource.", + "description": "Deletes an account resource", + "operationId": "Accounts_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "./examples/Accounts_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Account" + ], + "summary": "Patches the account resource.", + "description": "Updates an account", + "operationId": "Accounts_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "accountUpdateParameters", + "description": "The account update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AccountUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "./examples/Accounts_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin": { + "post": { + "tags": [ + "Account" + ], + "summary": "Add the administrator for root collection.", + "description": "Add the administrator for root collection associated with this account.", + "operationId": "Accounts_AddRootCollectionAdmin", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "collectionAdminUpdate", + "description": "The collection admin update payload.", + "required": true, + "schema": { + "$ref": "#/definitions/CollectionAdminUpdate" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_AddRootCollectionAdmin": { + "$ref": "./examples/Accounts_AddRootCollectionAdmin.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys": { + "post": { + "tags": [ + "Account" + ], + "summary": "Lists the keys asynchronous.", + "description": "List the authorization keys associated with this account.", + "operationId": "Accounts_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_ListKeys": { + "$ref": "./examples/Accounts_ListKeys.json" + } + } + } + }, + "/providers/Microsoft.Purview/getDefaultAccount": { + "get": { + "tags": [ + "DefaultAccount" + ], + "summary": "Gets the default account information set for the scope.", + "description": "Get the default account for the scope.", + "operationId": "DefaultAccounts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "scopeTenantId", + "description": "The tenant ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "scopeType", + "description": "The scope for the default account.", + "required": true, + "type": "string", + "enum": [ + "Tenant", + "Subscription" + ], + "x-ms-enum": { + "name": "ScopeType", + "modelAsString": true + } + }, + { + "in": "query", + "name": "scope", + "description": "The Id of the scope object, for example if the scope is \"Subscription\" then it is the ID of that subscription.", + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DefaultAccountPayload" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DefaultAccounts_Get": { + "$ref": "./examples/DefaultAccounts_Get.json" + } + } + } + }, + "/providers/Microsoft.Purview/removeDefaultAccount": { + "post": { + "tags": [ + "DefaultAccount" + ], + "summary": "Removes the default account from the scope.", + "description": "Removes the default account from the scope.", + "operationId": "DefaultAccounts_Remove", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "scopeTenantId", + "description": "The tenant ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "scopeType", + "description": "The scope for the default account.", + "required": true, + "type": "string", + "enum": [ + "Tenant", + "Subscription" + ], + "x-ms-enum": { + "name": "ScopeType", + "modelAsString": true + } + }, + { + "in": "query", + "name": "scope", + "description": "The Id of the scope object, for example if the scope is \"Subscription\" then it is the ID of that subscription.", + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DefaultAccounts_Remove": { + "$ref": "./examples/DefaultAccounts_Remove.json" + } + } + } + }, + "/providers/Microsoft.Purview/setDefaultAccount": { + "post": { + "tags": [ + "DefaultAccount" + ], + "summary": "Sets the default account for the scope.", + "description": "Sets the default account for the scope.", + "operationId": "DefaultAccounts_Set", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "defaultAccountPayload", + "description": "The payload containing the default account information and the scope.", + "required": true, + "schema": { + "$ref": "#/definitions/DefaultAccountPayload" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DefaultAccountPayload" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DefaultAccounts_Set": { + "$ref": "./examples/DefaultAccounts_Set.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/locations/{locations}/listFeatures": { + "post": { + "tags": [ + "Feature" + ], + "summary": "Gets a list of features and their status for the location and subscription.\r\nStatus of enabled features will be true. Status of disabled features will be false.\r\nFeatures that don't exist will be excluded from the results.", + "description": "Gets details from a list of feature names.", + "operationId": "Features_SubscriptionGet", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "in": "path", + "name": "locations", + "description": "Location of feature.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "featureRequest", + "description": "Request body with feature names.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchFeatureRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchFeatureStatus" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Features_SubscriptionGet": { + "$ref": "./examples/Features_SubscriptionGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listFeatures": { + "post": { + "tags": [ + "Feature" + ], + "summary": "Gets a list of features and their status for the account.\r\nStatus of enabled features will be true. Status of disabled features will be false.\r\nFeatures that don't exist will be excluded from the results.", + "description": "Gets details from a list of feature names.", + "operationId": "Features_AccountGet", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "featureRequest", + "description": "Request body with feature names.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchFeatureRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchFeatureStatus" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Features_AccountGet": { + "$ref": "./examples/Features_AccountGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/ingestionPrivateEndpointConnections": { + "get": { + "tags": [ + "IngestionPrivateEndpoint" + ], + "summary": "Lists all ingestion private endpoint connections.", + "description": "Lists all ingestion private endpoint connections", + "operationId": "IngestionPrivateEndpointConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IngestionPrivateEndpointConnections_List": { + "$ref": "./examples/IngestionPrivateEndpointConnections_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/ingestionPrivateEndpointConnectionStatus": { + "post": { + "tags": [ + "IngestionPrivateEndpoint" + ], + "summary": "Updates ingestion private endpoint connection status.", + "description": "Update ingestion private endpoint connection status", + "operationId": "IngestionPrivateEndpointConnections_UpdateStatus", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "request", + "description": "The ingestion private endpoint connection status update request.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionStatusUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionStatusUpdateResponse" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "IngestionPrivateEndpointConnections_UpdateStatus": { + "$ref": "./examples/IngestionPrivateEndpointConnections_UpdateStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations": { + "get": { + "tags": [ + "KafkaConfiguration" + ], + "summary": "Gets the list of Kafka configurations for the account.", + "description": "Lists the Kafka configurations in the Account", + "operationId": "KafkaConfigurations_ListByAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "query", + "name": "$skipToken", + "description": "The skip token.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KafkaConfigurationList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "KafkaConfigurations_ListByAccount": { + "$ref": "./examples/KafkaConfigurations_ListByAccount.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}": { + "get": { + "tags": [ + "KafkaConfiguration" + ], + "summary": "Gets the kafka configuration.", + "description": "Gets the kafka configuration for the account", + "operationId": "KafkaConfigurations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "in": "path", + "name": "kafkaConfigurationName", + "description": "Name of kafka configuration.", + "required": true, + "type": "string", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KafkaConfiguration" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "KafkaConfigurations_Get": { + "$ref": "./examples/KafkaConfigurations_Get.json" + } + } + }, + "put": { + "tags": [ + "KafkaConfiguration" + ], + "summary": "Create or update the kafka configuration.", + "description": "Create or update Kafka Configuration", + "operationId": "KafkaConfigurations_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "in": "path", + "name": "kafkaConfigurationName", + "description": "The kafka configuration name.", + "required": true, + "type": "string", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "kafkaConfiguration", + "description": "The kafka configuration of the account.", + "required": true, + "schema": { + "$ref": "#/definitions/KafkaConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Create or Update Successful", + "schema": { + "$ref": "#/definitions/KafkaConfiguration" + } + }, + "201": { + "description": "Create or Update Successful", + "schema": { + "$ref": "#/definitions/KafkaConfiguration" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "KafkaConfigurations_CreateOrUpdate": { + "$ref": "./examples/KafkaConfigurations_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "KafkaConfiguration" + ], + "summary": "Deletes the kafka configuration on the account.", + "description": "Deletes a KafkaConfiguration resource.", + "operationId": "KafkaConfigurations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "in": "path", + "name": "kafkaConfigurationName", + "description": "Name of kafka configuration.", + "required": true, + "type": "string", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "KafkaConfigurations_Delete": { + "$ref": "./examples/KafkaConfigurations_Delete.json" + } + } + } + }, + "/providers/Microsoft.Purview/operations": { + "get": { + "tags": [ + "Operation" + ], + "summary": "Lists the available operations", + "description": "List of available operations", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Gets private endpoint connections.", + "description": "Get private endpoint connections for account", + "operationId": "PrivateEndpointConnections_ListByAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "query", + "name": "$skipToken", + "description": "The skip token.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByAccount": { + "$ref": "./examples/PrivateEndpointConnections_ListByAccount.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Gets private endpoint connection information.", + "description": "Get a private endpoint connection", + "operationId": "PrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get": { + "$ref": "./examples/PrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Approves/Rejects private endpoint connection request.", + "description": "Create or update a private endpoint connection", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "request", + "description": "The request.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_CreateOrUpdate": { + "$ref": "./examples/PrivateEndpointConnections_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Deletes private endpoint connection.", + "description": "Delete a private endpoint connection", + "operationId": "PrivateEndpointConnections_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/PrivateEndpointConnections_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "summary": "Gets a list of privately linkable resources for an account.", + "description": "Gets a list of privately linkable resources for an account", + "operationId": "PrivateLinkResources_ListByAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResources_ListByAccount": { + "$ref": "./examples/PrivateLinkResources_ListByAccount.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "summary": "Gets a privately linkable resources for an account with given group identifier.", + "description": "Gets a privately linkable resources for an account with given group identifier", + "operationId": "PrivateLinkResources_GetByGroupId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "in": "path", + "name": "groupId", + "description": "The group identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_GetByGroupId": { + "$ref": "./examples/PrivateLinkResources_GetByGroupId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/checkNameAvailability": { + "post": { + "tags": [ + "Provider" + ], + "summary": "Checks the account name availability.", + "description": "Checks if account name is available.", + "operationId": "Accounts_CheckNameAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "checkNameAvailabilityRequest", + "description": "The check name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_CheckNameAvailability": { + "$ref": "./examples/Accounts_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "summary": "Gets the Usage quota configuration.", + "description": "Get the usage quota configuration", + "operationId": "Usages_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "in": "path", + "name": "location", + "description": "The region.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "query", + "name": "$filter", + "description": "The filter, currently unused.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UsageList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Usages_Get": { + "$ref": "./examples/Usages_Get.json" + } + } + } + } + }, + "definitions": { + "AccessKeys": { + "description": "The Purview Account access keys.", + "type": "object", + "properties": { + "atlasKafkaPrimaryEndpoint": { + "description": "Gets or sets the primary connection string.", + "type": "string" + }, + "atlasKafkaSecondaryEndpoint": { + "description": "Gets or sets the secondary connection string.", + "type": "string" + } + } + }, + "Account": { + "description": "Account resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Gets or sets the Sku.", + "allOf": [ + { + "$ref": "#/definitions/AccountSku" + } + ] + } + } + }, + "AccountEndpoints": { + "description": "The account endpoints", + "type": "object", + "properties": { + "catalog": { + "description": "Gets the catalog endpoint.", + "type": "string", + "readOnly": true + }, + "scan": { + "description": "Gets the scan endpoint.", + "type": "string", + "readOnly": true + } + } + }, + "AccountList": { + "description": "Paged list of Account resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "x-ms-identifiers": [] + } + } + }, + "AccountMergeInfo": { + "description": "The public Account Merge Info model.", + "type": "object", + "properties": { + "accountLocation": { + "description": "The account location of the *other* account in the merge operation.", + "type": "string", + "readOnly": true + }, + "accountName": { + "description": "The account name of the *other* account in the merge operation.", + "type": "string", + "readOnly": true + }, + "accountResourceGroupName": { + "description": "The resource group name of the *other* account in the merge operation.", + "type": "string", + "readOnly": true + }, + "accountSubscriptionId": { + "description": "The subscription id of the *other* account in the merge operation.", + "type": "string", + "readOnly": true + }, + "deprovisioned": { + "description": "The deprovisioned status of the account.\r\nOnly applicable for the secondary account.", + "type": "boolean", + "readOnly": true + }, + "mergeStatus": { + "description": "The status of the merge operation.", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MergeStatus", + "modelAsString": true + } + }, + "typeOfAccount": { + "description": "The account's type for the merge operation.", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MergeAccountType", + "modelAsString": true + } + } + } + }, + "AccountProperties": { + "description": "The account properties", + "type": "object", + "properties": { + "accountStatus": { + "description": "Gets or sets the status of the account.", + "allOf": [ + { + "$ref": "#/definitions/AccountStatus" + } + ], + "readOnly": true + }, + "cloudConnectors": { + "$ref": "#/definitions/CloudConnectors" + }, + "createdAt": { + "format": "date-time", + "description": "Gets the time at which the entity was created.", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "Gets the creator of the entity.", + "type": "string", + "readOnly": true + }, + "createdByObjectId": { + "description": "Gets the creators of the entity's object id.", + "type": "string", + "readOnly": true + }, + "defaultDomain": { + "description": "Gets the default domain in the account.", + "type": "string", + "readOnly": true + }, + "endpoints": { + "description": "The URIs that are the public endpoints of the account.", + "allOf": [ + { + "$ref": "#/definitions/AccountEndpoints" + } + ], + "readOnly": true + }, + "friendlyName": { + "description": "Gets or sets the friendly name.", + "type": "string", + "readOnly": true + }, + "ingestionStorage": { + "$ref": "#/definitions/IngestionStorage" + }, + "managedEventHubState": { + "description": "Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.", + "default": "NotSpecified", + "enum": [ + "NotSpecified", + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedEventHubState", + "modelAsString": true + } + }, + "managedResourceGroupName": { + "description": "Gets or sets the managed resource group name", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedResources": { + "description": "Gets the resource identifiers of the managed resources.", + "allOf": [ + { + "$ref": "#/definitions/ManagedResources" + } + ], + "readOnly": true + }, + "managedResourcesPublicNetworkAccess": { + "description": "Gets or sets the public network access for managed resources.", + "default": "NotSpecified", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "mergeInfo": { + "description": "Gets or sets the Merge Info.", + "$ref": "#/definitions/AccountMergeInfo" + }, + "privateEndpointConnections": { + "description": "Gets the private endpoint connections information.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "provisioningState": { + "description": "Gets or sets the state of the provisioning.", + "enum": [ + "Unknown", + "Creating", + "Moving", + "Deleting", + "SoftDeleting", + "SoftDeleted", + "Failed", + "Succeeded", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "publicNetworkAccess": { + "description": "Gets or sets the public network access.", + "default": "Enabled", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "tenantEndpointState": { + "description": "Gets or sets the state of tenant endpoint.", + "enum": [ + "NotSpecified", + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TenantEndpointState", + "modelAsString": true + } + } + } + }, + "AccountSku": { + "description": "The Sku", + "type": "object", + "properties": { + "capacity": { + "format": "int32", + "description": "Gets or sets the sku capacity.", + "type": "integer" + }, + "name": { + "description": "Gets or sets the sku name.", + "enum": [ + "Standard", + "Free" + ], + "type": "string", + "x-ms-enum": { + "name": "AccountSkuName", + "modelAsString": true + } + } + } + }, + "AccountStatus": { + "description": "The account status.", + "type": "object", + "properties": { + "accountProvisioningState": { + "description": "Gets the account status code.", + "enum": [ + "Unknown", + "Creating", + "Updating", + "Moving", + "Deleting", + "SoftDeleting", + "SoftDeleted", + "Failed", + "Succeeded", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AccountProvisioningState", + "modelAsString": true + } + }, + "errorDetails": { + "description": "Gets the account error details.", + "allOf": [ + { + "$ref": "#/definitions/ErrorModel" + } + ], + "readOnly": true + } + } + }, + "AccountUpdateParameters": { + "description": "The account update properties.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/Identity" + }, + "properties": { + "$ref": "#/definitions/AccountProperties", + "x-ms-client-flatten": true + }, + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BatchFeatureRequest": { + "description": "Feature request model", + "type": "object", + "properties": { + "features": { + "description": "Set of features", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "BatchFeatureStatus": { + "description": "List of features with enabled status", + "type": "object", + "properties": { + "features": { + "description": "Features with enabled status", + "type": "object", + "additionalProperties": { + "type": "boolean" + }, + "readOnly": true + } + } + }, + "CheckNameAvailabilityRequest": { + "description": "The request payload for CheckNameAvailability API", + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify for availability", + "type": "string" + }, + "type": { + "description": "Fully qualified resource type which includes provider namespace", + "type": "string" + } + } + }, + "CheckNameAvailabilityResult": { + "description": "The response payload for CheckNameAvailability API", + "type": "object", + "properties": { + "message": { + "description": "Error message", + "type": "string" + }, + "nameAvailable": { + "description": "Indicates if name is valid and available.", + "type": "boolean" + }, + "reason": { + "description": "The reason the name is not available.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "reason", + "modelAsString": true + } + } + } + }, + "CloudConnectors": { + "description": "External Cloud Service connectors", + "type": "object", + "properties": { + "awsExternalId": { + "description": "AWS external identifier.\r\nConfigured in AWS to allow use of the role arn used for scanning", + "type": "string", + "readOnly": true + } + } + }, + "CollectionAdminUpdate": { + "description": "Collection administrator update.", + "type": "object", + "properties": { + "objectId": { + "description": "Gets or sets the object identifier of the admin.", + "type": "string" + } + } + }, + "Consent": { + "description": "Consent extension resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Gets or sets the consent kind.", + "enum": [ + "Metadata", + "Governance" + ], + "type": "string", + "x-ms-enum": { + "name": "ConsentKind", + "modelAsString": true + } + }, + "properties": { + "$ref": "#/definitions/ConsentProperties", + "x-ms-client-flatten": true + } + } + }, + "ConsentProperties": { + "description": "The consent properties", + "type": "object", + "properties": { + "scope": { + "type": "string", + "readOnly": true + }, + "scopeType": { + "description": "Defines consent scope type.", + "enum": [ + "Azure", + "Fabric", + "Databricks", + "Snowflake", + "S3" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConsentScopeType", + "modelAsString": true + } + }, + "status": { + "description": "Defines consent status.", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConsentStatus", + "modelAsString": true + } + } + } + }, + "Credentials": { + "description": "Credentials to access the event streaming service attached to the purview account.", + "type": "object", + "properties": { + "identityId": { + "description": "Identity identifier for UserAssign type.", + "type": "string" + }, + "type": { + "description": "Identity Type.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "KafkaConfigurationIdentityType", + "modelAsString": true + } + } + } + }, + "DefaultAccountPayload": { + "description": "Payload to get and set the default account in the given scope", + "type": "object", + "properties": { + "accountName": { + "description": "The name of the account that is set as the default.", + "type": "string" + }, + "resourceGroupName": { + "description": "The resource group name of the account that is set as the default.", + "type": "string" + }, + "scope": { + "description": "The scope object ID. For example, sub ID or tenant ID.", + "type": "string" + }, + "scopeTenantId": { + "description": "The scope tenant in which the default account is set.", + "type": "string" + }, + "scopeType": { + "description": "The scope where the default account is set.", + "enum": [ + "Tenant", + "Subscription" + ], + "type": "string", + "x-ms-enum": { + "name": "ScopeType", + "modelAsString": true + } + }, + "subscriptionId": { + "description": "The subscription ID of the account that is set as the default.", + "type": "string" + } + } + }, + "DimensionProperties": { + "description": "properties for dimension", + "type": "object", + "properties": { + "displayName": { + "description": "localized display name of the dimension to customer", + "type": "string" + }, + "name": { + "description": "dimension name", + "type": "string" + }, + "toBeExportedForCustomer": { + "description": "flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox)", + "type": "boolean" + } + } + }, + "ErrorModel": { + "description": "Default error model", + "type": "object", + "properties": { + "code": { + "description": "Gets or sets the code.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Gets or sets the details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorModel" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "message": { + "description": "Gets or sets the messages.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Gets or sets the target.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponseModel": { + "description": "Default error response model", + "type": "object", + "properties": { + "error": { + "description": "Gets or sets the error.", + "allOf": [ + { + "$ref": "#/definitions/ErrorModel" + } + ], + "readOnly": true + } + } + }, + "Identity": { + "description": "The Managed Identity of the resource", + "type": "object", + "properties": { + "principalId": { + "description": "Service principal object Id", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant Id", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Identity Type", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "description": "User Assigned Identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "IngestionStorage": { + "description": "Ingestion Storage Account Info", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the Id.", + "type": "string", + "readOnly": true + }, + "primaryEndpoint": { + "description": "Gets or sets the primary endpoint.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "description": "Gets or sets the public network access setting", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + } + } + }, + "KafkaConfiguration": { + "description": "The configuration of the event streaming service resource attached to the Purview account for kafka notifications.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/KafkaConfigurationProperties", + "x-ms-client-flatten": true + } + } + }, + "KafkaConfigurationList": { + "description": "Paged list of kafka configuration resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "type": "array", + "items": { + "$ref": "#/definitions/KafkaConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "KafkaConfigurationProperties": { + "description": "The kafka configuration properties of the event streaming service attached to the Purview account for kafka notifications.", + "type": "object", + "properties": { + "consumerGroup": { + "description": "Consumer group for hook event hub.", + "type": "string" + }, + "credentials": { + "$ref": "#/definitions/Credentials" + }, + "eventHubPartitionId": { + "description": "Optional partition Id for notification event hub. If not set, all partitions will be leveraged.", + "type": "string" + }, + "eventHubResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.EventHub/namespaces/eventHubs" + } + ] + } + }, + "eventHubType": { + "description": "The event hub type.", + "enum": [ + "Notification", + "Hook" + ], + "type": "string", + "x-ms-enum": { + "name": "EventHubType", + "modelAsString": true + } + }, + "eventStreamingState": { + "description": "The state of the event streaming service", + "default": "Enabled", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EventStreamingState", + "modelAsString": true + } + }, + "eventStreamingType": { + "description": "The event streaming service type", + "default": "None", + "enum": [ + "None", + "Managed", + "Azure" + ], + "type": "string", + "x-ms-enum": { + "name": "EventStreamingType", + "modelAsString": true + } + } + } + }, + "ManagedResources": { + "description": "The managed resources in customer subscription.", + "type": "object", + "properties": { + "eventHubNamespace": { + "description": "Gets the managed event hub namespace resource identifier.", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.", + "type": "string", + "readOnly": true + }, + "storageAccount": { + "description": "Gets the managed storage account resource identifier.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "Operation resource", + "type": "object", + "properties": { + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "isDataAction": { + "description": "Whether operation is a data action", + "type": "boolean" + }, + "name": { + "description": "Operation name for display purposes", + "type": "string" + }, + "origin": { + "description": "origin of the operation", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "x-ms-client-flatten": true + } + } + }, + "OperationDisplay": { + "description": "The response model for get operation properties", + "type": "object", + "properties": { + "description": { + "description": "Description of the operation for display purposes", + "type": "string" + }, + "operation": { + "description": "Name of the operation for display purposes", + "type": "string" + }, + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "Name of the resource type for display purposes", + "type": "string" + } + } + }, + "OperationList": { + "description": "Paged list of operation resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "count": { + "format": "int64", + "description": "Total item count.", + "type": "integer" + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [] + } + } + }, + "OperationMetaLogSpecification": { + "description": "log specifications for operation api", + "type": "object", + "properties": { + "blobDuration": { + "description": "blob duration of the log", + "type": "string" + }, + "displayName": { + "description": "localized name of the log category", + "type": "string" + }, + "name": { + "description": "name of the log category", + "type": "string" + } + } + }, + "OperationMetaMetricSpecification": { + "description": "metric specifications for the operation", + "type": "object", + "properties": { + "aggregationType": { + "description": "aggregation type of metric", + "type": "string" + }, + "dimensions": { + "description": "properties for dimension", + "type": "array", + "items": { + "$ref": "#/definitions/DimensionProperties" + }, + "x-ms-identifiers": [] + }, + "displayDescription": { + "description": "description of the metric", + "type": "string" + }, + "displayName": { + "description": "localized name of the metric", + "type": "string" + }, + "enableRegionalMdmAccount": { + "description": "enable regional mdm account", + "type": "string" + }, + "internalMetricName": { + "description": "internal metric name", + "type": "string" + }, + "name": { + "description": "name of the metric", + "type": "string" + }, + "resourceIdDimensionNameOverride": { + "description": "dimension name use to replace resource id if specified", + "type": "string" + }, + "sourceMdmNamespace": { + "description": "Metric namespace.\r\nOnly set the namespace if different from the default value, \r\nleaving it empty makes it use the value from the ARM manifest.", + "type": "string" + }, + "supportedAggregationTypes": { + "description": "supported aggregation types", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "supportedTimeGrainTypes": { + "description": "supported time grain types", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "unit": { + "description": "units for the metric", + "type": "string" + } + } + }, + "OperationMetaServiceSpecification": { + "description": "The operation meta service specification", + "type": "object", + "properties": { + "logSpecifications": { + "description": "log specifications for the operation", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetaLogSpecification" + }, + "x-ms-identifiers": [] + }, + "metricSpecifications": { + "description": "metric specifications for the operation", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetaMetricSpecification" + }, + "x-ms-identifiers": [] + } + } + }, + "OperationProperties": { + "description": "properties on meta info", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/OperationMetaServiceSpecification" + } + } + }, + "PrivateEndpoint": { + "description": "A private endpoint class.", + "type": "object", + "properties": { + "id": { + "description": "The private endpoint identifier.", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The connection identifier.", + "x-ms-client-flatten": true + } + } + }, + "PrivateEndpointConnectionList": { + "description": "Paged list of private endpoint connections", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "x-ms-identifiers": [] + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "A private endpoint connection properties class.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint information." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "The private link service connection state." + }, + "provisioningState": { + "description": "The provisioning state.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnectionStatusUpdateRequest": { + "description": "A private endpoint connection status update request class.", + "type": "object", + "properties": { + "privateEndpointId": { + "description": "The private endpoint resource identifier.", + "type": "string" + }, + "status": { + "description": "The private endpoint connection status.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionStatusUpdateResponse": { + "description": "A private endpoint connection status update response class.", + "type": "object", + "properties": { + "privateEndpointId": { + "description": "The private endpoint resource identifier.", + "type": "string" + }, + "status": { + "description": "The private endpoint connection status.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "A privately linkable resource.", + "type": "object", + "properties": { + "id": { + "description": "The private link resource identifier.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The private link resource name.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "The private link resource properties.", + "readOnly": true, + "x-ms-client-flatten": true + }, + "type": { + "description": "The private link resource type.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkResourceList": { + "description": "Paged list of private link resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "x-ms-identifiers": [] + } + } + }, + "PrivateLinkResourceProperties": { + "description": "A privately linkable resource properties.", + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group identifier.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "This translates to how many Private IPs should be created for each privately linkable resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "description": "The required zone names for private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The private link service connection state.", + "type": "object", + "properties": { + "actionsRequired": { + "description": "The required actions.", + "type": "string" + }, + "description": { + "description": "The description.", + "type": "string" + }, + "status": { + "description": "The status.", + "enum": [ + "Unknown", + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateEndpointConnectionStatus", + "modelAsString": true + } + } + } + }, + "ProxyResource": { + "description": "Proxy Azure Resource", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Gets or sets the name.", + "type": "string", + "readOnly": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "allOf": [ + { + "$ref": "#/definitions/SystemData" + } + ], + "readOnly": true + }, + "type": { + "description": "Gets or sets the type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "QuotaName": { + "description": "Quota name", + "type": "object", + "properties": { + "localizedValue": { + "description": "Gets or sets the localized name value.", + "type": "string" + }, + "value": { + "description": "Gets or sets the name value.", + "type": "string" + } + } + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "The identity that created the resource.", + "type": "string", + "readOnly": true + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of the last modification the resource (UTC).", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string", + "readOnly": true + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + } + } + }, + "TrackedResource": { + "description": "Azure ARM Tracked Resource", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Identity" + }, + "location": { + "description": "Gets or sets the location.", + "type": "string" + }, + "name": { + "description": "Gets or sets the name.", + "type": "string", + "readOnly": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "allOf": [ + { + "$ref": "#/definitions/SystemData" + } + ], + "readOnly": true + }, + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "type": { + "description": "Gets or sets the type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "Usage": { + "description": "Response for usage information", + "type": "object", + "properties": { + "currentValue": { + "format": "int32", + "description": "Current usage quota value", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "Fully qualified resource Id", + "type": "string", + "readOnly": true + }, + "limit": { + "format": "int32", + "description": "Usage quota limit", + "type": "integer", + "readOnly": true + }, + "name": { + "description": "Quota name", + "allOf": [ + { + "$ref": "#/definitions/QuotaName" + } + ], + "readOnly": true + }, + "unit": { + "description": "Quota usage unit.", + "type": "string", + "readOnly": true + } + } + }, + "UsageList": { + "description": "List of usage information", + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next link.", + "type": "string" + }, + "value": { + "description": "Collection of usage values.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "readOnly": true + } + } + }, + "UserAssignedIdentity": { + "description": "Uses client ID and Principal ID", + "type": "object", + "properties": { + "clientId": { + "description": "Gets or Sets Client ID", + "type": "string", + "readOnly": true + }, + "principalId": { + "description": "Gets or Sets Principal ID", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionId": { + "in": "path", + "name": "subscriptionId", + "description": "The subscription identifier", + "required": true, + "type": "string" + }, + "api-version": { + "in": "query", + "name": "api-version", + "description": "The api version to use.", + "required": true, + "type": "string" + }, + "accountName": { + "in": "path", + "name": "accountName", + "description": "The name of the account.", + "required": true, + "type": "string", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", + "x-ms-parameter-location": "method" + }, + "resourceGroupName": { + "in": "path", + "name": "resourceGroupName", + "description": "The resource group name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/purview/resource-manager/readme.md b/specification/purview/resource-manager/readme.md index 9130731657cc..42b8438911b5 100644 --- a/specification/purview/resource-manager/readme.md +++ b/specification/purview/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the Purview API. ``` yaml openapi-type: arm -tag: package-2023-05-01-preview +tag: package-2024-04-01-preview +``` + +### Tag: package-2024-04-01-preview + +These settings apply only when `--tag=package-2024-04-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-04-01-preview' +input-file: +- Microsoft.Purview/preview/2024-04-01-preview/purview.json ``` ### Tag: package-2023-05-01-preview @@ -126,7 +135,7 @@ directive: - $.definitions.CheckNameAvailabilityResult.properties.nameAvailable - $.definitions.DimensionProperties.properties.toBeExportedForCustomer reason: - - Check name model is set by ARM team https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/proxy-api-reference.md#check-name-availability-requests + - Check name model is set by ARM team https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/proxy-api-reference.md#check-name-availability-requests - suppress: R2025 # NextLinkPropertyMustExist where: - $.definitions.UsageList.properties.nextLink From 8e8e199280a7e0f75038aefe014647059d2499ac Mon Sep 17 00:00:00 2001 From: Tomer Shaiman Date: Wed, 12 Jun 2024 11:05:58 +0300 Subject: [PATCH 160/343] Video Indexer Private Endpoint Onboarding (#29266) * base commit * docs * adding private link support * examples for private endpoint * register AllowPublicAccess field for Private Endpoint * allign common types version * no default on Patch * MI * OperationListResult * privare link resource pageble * move to common-types operations * video-indexer instead analyzer --- ...vateEndpointConnection_CreateOrUpdate.json | 61 + .../PrivateEndpointConnection_Delete.json | 17 + .../PrivateEndpointConnection_Get.json | 32 + ...ivateEndpointConnection_ListByAccount.json | 35 + .../PrivateLinkResources_Get.json | 27 + .../PrivateLinkResources_ListByAccount.json | 30 + .../ViAccountCheckNameAvailabilityFree.json | 17 + .../ViAccountCheckNameAvailabilityTaken.json | 19 + .../examples/ViAccountDelete.json | 13 + .../examples/ViAccountGet.json | 46 + .../PatchAccountWithSystemAssignedMi.json | 48 + .../PatchAccountWithUserAssignedMi.json | 65 + ...ountToArmAccountUsingSystemAssignedMI.json | 70 + ...ccountToArmAccountUsingUserAssignedMi.json | 84 ++ ...teOrUpdateAccountWithSystemAssignedMi.json | 78 + ...eateOrUpdateAccountWithUserAssignedMi.json | 104 ++ .../examples/ViAccountsList.json | 49 + .../ViAccountsListByResourceGroup.json | 50 + ...GenerateAccountContributerAccessToken.json | 19 + .../ViGenerateAccountReaderAccessToken.json | 19 + ...GenerateProjectContributerAccessToken.json | 20 + .../ViGenerateProjectReaderAccessToken.json | 20 + ...ViGenerateVideoContributerAccessToken.json | 20 + .../ViGenerateVideoReaderAccessToken.json | 20 + ...ateAccountRestrictedViewerAccessToken.json | 18 + ...ateProjectRestrictedViewerAccessToken.json | 19 + ...erateVideoRestrictedViewerAccessToken.json | 19 + .../examples/ViOperationsList.json | 40 + .../preview/2024-06-01-preview/vi.json | 1328 +++++++++++++++++ specification/vi/resource-manager/readme.md | 11 + 30 files changed, 2398 insertions(+) create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateLinkResources/PrivateLinkResources_Get.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountCheckNameAvailabilityFree.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountCheckNameAvailabilityTaken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountDelete.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountGet.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountsListByResourceGroup.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViOperationsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/vi.json diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json new file mode 100644 index 000000000000..839065af8e8c --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "accountName": "contoso", + "privateEndpointConnectionName": "peexample01", + "api-version": "2024-06-01-preview", + "body": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.VideoIndexer/accounts/contoso/privateEndpointConnections/peexample01", + "name": "peexample01", + "type": "Microsoft.VideoIndexer/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "groupId" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.VideoIndexer/accounts/contoso/privateEndpointConnections/peexample01", + "name": "peexample01", + "type": "Microsoft.VideoIndexer/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "groupId" + ] + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json new file mode 100644 index 000000000000..7b615f168dcf --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "accountName": "contoso", + "privateEndpointConnectionName": "peexample01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.VideoIndexer/locations/westus2/operationStatuses/00000000-0000-0000-0000-000000000000*427E3E07F4C0A3DCD66951C42FD7BCD794AEAC5E321728AFBDCAA7C02E9CD4D3?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json new file mode 100644 index 000000000000..fe2f9ae01f22 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "accountName": "contoso", + "privateEndpointConnectionName": "peexample01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.VideoIndexer/accounts/contoso/privateEndpointConnections/peexample01", + "name": "peexample01", + "type": "Microsoft.VideoIndexer/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "groupId" + ] + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json new file mode 100644 index 000000000000..c744cf4e62ee --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "accountName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.VideoIndexer/accounts/contoso/privateEndpointConnections/peexample01", + "name": "peexample01", + "type": "Microsoft.VideoIndexer/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "groupId" + ] + } + } + ] + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateLinkResources/PrivateLinkResources_Get.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateLinkResources/PrivateLinkResources_Get.json new file mode 100644 index 000000000000..2e84d44c9e85 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateLinkResources/PrivateLinkResources_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "accountName": "contoso", + "groupId": "avi", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.VideoIndexer/accounts/contoso/privateLinkResources/avi", + "name": "avi", + "type": "Microsoft.VideoIndexer/accounts/privateLinkResources", + "properties": { + "groupId": "avi", + "requiredMembers": [ + "avi" + ], + "requiredZoneNames": [ + "privatelink.avi.microsoft.com" + ] + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json new file mode 100644 index 000000000000..8dd3d43457d8 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "accountName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.VideoIndexer/accounts/contoso/privateLinkResources/avi", + "name": "avi", + "type": "Microsoft.VideoIndexer/accounts/privateLinkResources", + "properties": { + "groupId": "avi", + "requiredMembers": [ + "avi" + ], + "requiredZoneNames": [ + "privatelink.avi.microsoft.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountCheckNameAvailabilityFree.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountCheckNameAvailabilityFree.json new file mode 100644 index 000000000000..70d7e4e9dfd6 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountCheckNameAvailabilityFree.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e", + "checkNameAvailabilityParameters": { + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountCheckNameAvailabilityTaken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountCheckNameAvailabilityTaken.json new file mode 100644 index 000000000000..c5d72dc98621 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountCheckNameAvailabilityTaken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e", + "checkNameAvailabilityParameters": { + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Resource name already exists" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountDelete.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountDelete.json new file mode 100644 index 000000000000..27348a72fe75 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contoso-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountGet.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountGet.json new file mode 100644 index 000000000000..9020e04e3296 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contoso-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json new file mode 100644 index 000000000000..cd5e08caa15d --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contoso-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "storageServices": {}, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer", + "name": "contosto-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json new file mode 100644 index 000000000000..a0d53bab3280 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "storageServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": {}, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer", + "name": "contosto-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json new file mode 100644 index 000000000000..8547c51229a4 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoindexer", + "name": "contosto-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoindexer", + "name": "contosto-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json new file mode 100644 index 000000000000..326ae49384c7 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoindexer", + "name": "contosto-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoindexer", + "name": "contosto-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json new file mode 100644 index 000000000000..c0aa265d875b --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoindexer", + "name": "contosto-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoindexer", + "name": "contosto-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json new file mode 100644 index 000000000000..005b4e8c2410 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": {}, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoindexer", + "name": "contosto-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer", + "name": "contoso-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contoso-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + }, + "totalSecondsIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountsList.json new file mode 100644 index 000000000000..991b757541a8 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + }, + "provisioningState": "Provisioning" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountsListByResourceGroup.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountsListByResourceGroup.json new file mode 100644 index 000000000000..66be6d2e8fee --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViAccountsListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceGroupName": "contoso-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer-rg", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json new file mode 100644 index 000000000000..e5fec9256fd8 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json new file mode 100644 index 000000000000..136f3c048efb --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json new file mode 100644 index 000000000000..0c755f7978aa --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json new file mode 100644 index 000000000000..97a4a2f809f0 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json new file mode 100644 index 000000000000..6f13814eeb34 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json new file mode 100644 index 000000000000..d500d14a0853 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoindexer", + "resourceGroupName": "contosto-videoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..6b59f3e624ec --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..94c3e27a9038 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..fc57e3d5f99c --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-06-01-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViOperationsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViOperationsList.json new file mode 100644 index 000000000000..f48d7f05fde8 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/examples/ViOperationsList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VideoIndexer/accounts/read", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Read accounts", + "description": "Read accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/write", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Update accounts", + "description": "Update accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/delete", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Delete accounts", + "description": "Delete accounts" + } + } + ] + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/vi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/vi.json new file mode 100644 index 000000000000..f46b8c1edb56 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-06-01-preview/vi.json @@ -0,0 +1,1328 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-06-01-preview", + "title": "vi", + "description": "Microsoft Azure Video Indexer" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.VideoIndexer/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Azure Video Indexer provider operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/ViOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/checkNameAvailability": { + "post": { + "tags": [ + "NameAvailability" + ], + "operationId": "Accounts_CheckNameAvailability", + "description": "Checks that the Video Indexer account name is valid and is not already in use.", + "x-ms-examples": { + "Check free account name availability": { + "$ref": "./examples/ViAccountCheckNameAvailabilityFree.json" + }, + "Check taken account name availability": { + "$ref": "./examples/ViAccountCheckNameAvailabilityTaken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountCheckNameAvailabilityParameters" + }, + "description": "The name of the Video Indexer account. Name must be unique globally" + } + ], + "responses": { + "200": { + "description": "OK - Operation to check the Video Indexer account name availability was successful. Ok does not indicate the name is available, the body of the response does.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_List", + "description": "List all Azure Video Indexer accounts available under the subscription", + "x-ms-examples": { + "List accounts": { + "$ref": "./examples/ViAccountsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_ListByResourceGroup", + "description": "List all Azure Video Indexer accounts available under the resource group", + "x-ms-examples": { + "List accounts by resource group": { + "$ref": "./examples/ViAccountsListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Get", + "description": "Gets the properties of an Azure Video Indexer account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get account": { + "$ref": "./examples/ViAccountGet.json" + } + } + }, + "patch": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Update", + "x-ms-long-running-operation": false, + "description": "Updates the properties of an existing Azure Video Indexer account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the current Azure Video Indexer account.", + "schema": { + "$ref": "#/definitions/AccountPatch" + } + } + ], + "responses": { + "200": { + "description": "The resource was updated successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch account with system assigned Mi": { + "$ref": "./examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json" + }, + "Patch account with user assigned Mi": { + "$ref": "./examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json" + } + } + }, + "put": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "description": "Creates or updates an Azure Video Indexer account.", + "x-ms-long-running-operation": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the Azure Video Indexer account.", + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "The resource was successfully updated.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "The resource was successfully created.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update account with system assigned Mi": { + "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json" + }, + "Create or update account with user assigned Mi": { + "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json" + }, + "Connect classic account to arm account using system assigned Mi": { + "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json" + }, + "Connect classic account to arm account using user assigned Mi": { + "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json" + } + } + }, + "delete": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Delete", + "description": "Delete an Azure Video Indexer account.", + "x-ms-long-running-operation": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account was successfully deleted." + }, + "202": { + "description": "The Azure Video Indexer account will be deleted asynchronously." + }, + "204": { + "description": "The Azure Video Indexer account does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete account": { + "$ref": "./examples/ViAccountDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateAccessToken": { + "post": { + "tags": [ + "AccessToken" + ], + "operationId": "Generate_AccessToken", + "description": "Generate an Azure Video Indexer access token.", + "x-ms-examples": { + "Generate accessToken for video contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json" + }, + "Generate accessToken for video reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json" + }, + "Generate accessToken for project contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json" + }, + "Generate accessToken for project reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json" + }, + "Generate accessToken for account contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json" + }, + "Generate accessToken for account reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "x-ms-client-flatten": true, + "description": "The parameters for generating access token", + "schema": { + "$ref": "#/definitions/GenerateAccessTokenParameters" + } + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateRestrictedViewerAccessToken": { + "post": { + "tags": [ + "AccessToken" + ], + "operationId": "Generate_RestrictedViewerAccessToken", + "description": "Generate an Azure Video Indexer restricted viewer access token.", + "x-ms-examples": { + "Generate restricted viewer accessToken for video": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json" + }, + "Generate restricted viewer accessToken for project": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json" + }, + "Generate restricted viewer accessToken for account": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "x-ms-client-flatten": true, + "description": "The parameters for generating restricted viewer access token", + "schema": { + "$ref": "#/definitions/GenerateRestrictedViewerAccessTokenParameters" + } + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List all private endpoint connections in a Video Indexer account.", + "operationId": "PrivateEndpointConnections_ListByAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionList": { + "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Get the specified private endpoint connection associated with the Video Indexer account.", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionGet": { + "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Update the state of specified private endpoint connection associated with the Video Indexer account.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionCreateOrUpdate": { + "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes the specified private endpoint connection associated with the Video Indexer account.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "The request was successful; the operation will complete asynchronously.", + "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": "The private endpoint connection does not exist in the subscription." + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionDelete": { + "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "List all private link resources in a Video Indexer account.", + "operationId": "PrivateLinkResources_ListByAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResourcesList": { + "$ref": "./examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Get the specified private link resource associated with the Video Indexer account.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResourcesGet": { + "$ref": "./examples/PrivateLinkResources/PrivateLinkResources_Get.json" + } + } + } + } + }, + "definitions": { + "Tags": { + "type": "object", + "description": "Resource tags", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + } + } + }, + "Account": { + "description": "An Azure Video Indexer account.", + "type": "object", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountPropertiesForPutRequest" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AccountPatch": { + "type": "object", + "description": "Azure Video Indexer account", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountPropertiesForPatchRequest" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Tags" + } + ] + }, + "AccountPropertiesForPutRequest": { + "description": "Azure Video Indexer account properties", + "type": "object", + "properties": { + "tenantId": { + "description": "The account's tenant id", + "type": "string", + "readOnly": true, + "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" + }, + "accountId": { + "description": "The account's data-plane ID. This can be set only when connecting an existing classic account", + "type": "string", + "default": "00000000-0000-0000-0000-000000000000", + "example": "3575690b-a569-449c-ab7b-11020f948f76" + }, + "accountName": { + "description": "The account's name", + "type": "string", + "readOnly": true, + "example": "contoso-videoindexer" + }, + "storageServices": { + "description": "The storage services details", + "type": "object", + "$ref": "#/definitions/StorageServicesForPutRequest" + }, + "openAiServices": { + "description": "The openAi services details", + "type": "object", + "$ref": "#/definitions/OpenAiServicesForPutRequest" + }, + "totalSecondsIndexed": { + "description": "An integer representing the total seconds that have been indexed on the account", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "publicNetworkAccess": { + "description": "Whether or not public network access is allowed for the account.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections associated with the account.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the account at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "AccountPropertiesForPatchRequest": { + "description": "Azure Video Indexer account properties", + "type": "object", + "properties": { + "tenantId": { + "description": "The account's tenant id", + "type": "string", + "readOnly": true, + "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" + }, + "accountId": { + "description": "The account's data-plane ID", + "readOnly": true, + "type": "string", + "example": "3575690b-a569-449c-ab7b-11020f948f76" + }, + "storageServices": { + "description": "The storage services details", + "type": "object", + "$ref": "#/definitions/StorageServicesForPatchRequest" + }, + "openAiServices": { + "description": "The openAi services details", + "type": "object", + "$ref": "#/definitions/OpenAiServicesForPatchRequest" + }, + "publicNetworkAccess": { + "description": "Whether or not public network access is allowed for the account.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections associated with the account.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the account at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "AccountList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "description": "List of accounts and their properties." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "example": "https://management.azure.com/{accountsOperation}?api-version={version}&%24skiptoken={token}" + } + }, + "description": "The list operation response, that contains the data pools and their properties.", + "type": "object" + }, + "GenerateAccessTokenParameters": { + "description": "Access token generation request's parameters", + "type": "object", + "required": [ + "permissionType", + "scope" + ], + "properties": { + "permissionType": { + "type": "string", + "description": "The requested permission", + "enum": [ + "Contributor", + "Reader" + ], + "x-ms-enum": { + "name": "permissionType", + "modelAsString": true + } + }, + "scope": { + "type": "string", + "description": "The requested media type", + "enum": [ + "Video", + "Account", + "Project" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true + } + }, + "videoId": { + "description": "The video ID", + "type": "string", + "example": "07ec9e38d4" + }, + "projectId": { + "description": "The project ID", + "type": "string" + } + } + }, + "GenerateRestrictedViewerAccessTokenParameters": { + "description": "Restricted viewer access token generation request's parameters", + "type": "object", + "required": [ + "scope" + ], + "properties": { + "scope": { + "type": "string", + "description": "The requested media type", + "enum": [ + "Video", + "Account", + "Project" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true + } + }, + "videoId": { + "description": "The video ID", + "type": "string", + "example": "07ec9e38d4" + }, + "projectId": { + "description": "The project ID", + "type": "string" + } + } + }, + "StorageServicesForPutRequest": { + "description": "The storage services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + }, + "description": "The storage services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms" + }, + "userAssignedIdentity": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + } + } + }, + "OpenAiServicesForPutRequest": { + "description": "The openAi services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "The openAi services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "userAssignedIdentity": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + } + } + }, + "StorageServicesForPatchRequest": { + "description": "The storage services details", + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + } + } + }, + "OpenAiServicesForPatchRequest": { + "description": "The openAi services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "The openAi services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "userAssignedIdentity": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + } + } + }, + "AccessToken": { + "description": "Azure Video Indexer access token.", + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "readOnly": true, + "description": "The access token.", + "x-ms-secret": true, + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2MjI0NDc3MzMsImV4cCI6MTY1Mzk4MzczMywiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSIsIkdpdmVuTmFtZSI6IkpvaG5ueSIsIlN1cm5hbWUiOiJSb2NrZXQiLCJFbWFpbCI6Impyb2NrZXRAZXhhbXBsZS5jb20iLCJSb2xlIjpbIk1hbmFnZXIiLCJQcm9qZWN0IEFkbWluaXN0cmF0b3IiXX0" + } + } + }, + "AccountCheckNameAvailabilityParameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The VideoIndexer account name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.VideoIndexer/accounts" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + }, + "description": "The type of resource, Microsoft.VideoIndexer/accounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "The parameters used to check the availability of the Video Indexer account name." + }, + "CheckNameAvailabilityResult": { + "type": "object", + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "Gets the reason that a Video Indexer account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": true + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + } + }, + "parameters": { + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Video Indexer account.", + "pattern": "^[A-Za-z0-9-]+$", + "maxLength": 50, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "GroupIdParameter": { + "name": "groupId", + "in": "path", + "required": true, + "type": "string", + "description": "The group ID of the private link resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/vi/resource-manager/readme.md b/specification/vi/resource-manager/readme.md index 69ccfb35bb91..ecf5ef8d23a9 100644 --- a/specification/vi/resource-manager/readme.md +++ b/specification/vi/resource-manager/readme.md @@ -30,6 +30,7 @@ directive: - Microsoft.VideoIndexer/preview/2022-04-13-preview/vi.json - Microsoft.VideoIndexer/preview/2022-07-20-preview/vi.json - Microsoft.VideoIndexer/preview/2024-04-01-preview/vi.json + - Microsoft.VideoIndexer/preview/2024-06-01-preview/vi.json - Microsoft.VideoIndexer/stable/2022-08-01/vi.json where: @@ -52,6 +53,16 @@ openapi-subtype: rpaas tag: package-2024-01 ``` +### Tag: package-2024-06-01-preview + +These settings apply only when `--tag=2024-06-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-06-01-preview' +version-with-underscores: 2024_06_01_preview +input-file: + - Microsoft.VideoIndexer/preview/2024-06-01-preview/vi.json +``` + ### Tag: package-2024-04-01-preview These settings apply only when `--tag=2024-04-01-preview` is specified on the command line. From e471d1facf1df82dc99bd6b2a1442d10dc7de27e Mon Sep 17 00:00:00 2001 From: Brent Rusinow <44413020+brrusino@users.noreply.github.com> Date: Wed, 12 Jun 2024 01:06:57 -0700 Subject: [PATCH 161/343] added format for date-time (#29306) --- .../preview/2023-09-01-preview/operationStatuses.json | 8 ++++++-- .../preview/2023-10-27-preview/operationStatuses.json | 8 ++++++-- .../preview/2024-03-22-preview/operationStatuses.json | 8 ++++++-- .../stable/2023-11-01/operationStatuses.json | 8 ++++++-- .../stable/2024-01-01/operationStatuses.json | 8 ++++++-- 5 files changed, 30 insertions(+), 10 deletions(-) diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-09-01-preview/operationStatuses.json b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-09-01-preview/operationStatuses.json index 80e2420ea956..430239e53037 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-09-01-preview/operationStatuses.json +++ b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-09-01-preview/operationStatuses.json @@ -105,11 +105,15 @@ }, "startTime": { "type": "string", - "description": "The start time of the operation." + "description": "The start time of the operation.", + "format": "date-time", + "readOnly": true }, "endTime": { "type": "string", - "description": "The end time of the operation." + "description": "The end time of the operation.", + "format": "date-time", + "readOnly": true }, "status": { "type": "string", diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-10-27-preview/operationStatuses.json b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-10-27-preview/operationStatuses.json index d82fefad4301..b3e50dbd461b 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-10-27-preview/operationStatuses.json +++ b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-10-27-preview/operationStatuses.json @@ -105,11 +105,15 @@ }, "startTime": { "type": "string", - "description": "The start time of the operation." + "description": "The start time of the operation.", + "format": "date-time", + "readOnly": true }, "endTime": { "type": "string", - "description": "The end time of the operation." + "description": "The end time of the operation.", + "format": "date-time", + "readOnly": true }, "status": { "type": "string", diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2024-03-22-preview/operationStatuses.json b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2024-03-22-preview/operationStatuses.json index 4c24791fa440..d403ffba3906 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2024-03-22-preview/operationStatuses.json +++ b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2024-03-22-preview/operationStatuses.json @@ -101,11 +101,15 @@ }, "startTime": { "type": "string", - "description": "The start time of the operation." + "description": "The start time of the operation.", + "format": "date-time", + "readOnly": true }, "endTime": { "type": "string", - "description": "The end time of the operation." + "description": "The end time of the operation.", + "format": "date-time", + "readOnly": true }, "status": { "type": "string", diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operationStatuses.json b/specification/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operationStatuses.json index 4aa5918a3f47..6daf68c7ffa3 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operationStatuses.json +++ b/specification/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operationStatuses.json @@ -101,11 +101,15 @@ }, "startTime": { "type": "string", - "description": "The start time of the operation." + "description": "The start time of the operation.", + "format": "date-time", + "readOnly": true }, "endTime": { "type": "string", - "description": "The end time of the operation." + "description": "The end time of the operation.", + "format": "date-time", + "readOnly": true }, "status": { "type": "string", diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operationStatuses.json b/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operationStatuses.json index ec92a2d3ea50..9660b7c68d07 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operationStatuses.json +++ b/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operationStatuses.json @@ -101,11 +101,15 @@ }, "startTime": { "type": "string", - "description": "The start time of the operation." + "description": "The start time of the operation.", + "format": "date-time", + "readOnly": true }, "endTime": { "type": "string", - "description": "The end time of the operation." + "description": "The end time of the operation.", + "format": "date-time", + "readOnly": true }, "status": { "type": "string", From 259fe9abaed3b55b600dc82d79323f046501e87f Mon Sep 17 00:00:00 2001 From: Johnathon Mohr Date: Wed, 12 Jun 2024 01:09:26 -0700 Subject: [PATCH 162/343] Remove Microsoft.SecurityDevOps RP (#29326) --- .../AzureDevOpsConnectorCreateOrUpdate.json | 59 - .../examples/AzureDevOpsConnectorDelete.json | 17 - .../examples/AzureDevOpsConnectorGet.json | 23 - ...ureDevOpsConnectorListByResourceGroup.json | 36 - ...zureDevOpsConnectorListBySubscription.json | 35 - .../AzureDevOpsConnectorStatsGet.json | 28 - .../examples/AzureDevOpsConnectorUpdate.json | 46 - .../AzureDevOpsOrgCreateOrUpdate.json | 40 - .../examples/AzureDevOpsOrgGet.json | 22 - .../examples/AzureDevOpsOrgList.json | 31 - .../examples/AzureDevOpsOrgUpdate.json | 39 - .../AzureDevOpsProjectCreateOrUpdate.json | 41 - .../examples/AzureDevOpsProjectGet.json | 23 - .../examples/AzureDevOpsProjectList.json | 32 - .../examples/AzureDevOpsProjectUpdate.json | 40 - .../AzureDevOpsRepoCreateOrUpdate.json | 97 - .../examples/AzureDevOpsRepoGet.json | 23 - .../examples/AzureDevOpsRepoList.json | 33 - .../AzureDevOpsRepoListByConnector.json | 31 - .../examples/AzureDevOpsRepoUpdate.json | 53 - .../GitHubConnectorCreateOrUpdate.json | 44 - .../examples/GitHubConnectorDelete.json | 17 - .../examples/GitHubConnectorGet.json | 23 - .../GitHubConnectorListByResourceGroup.json | 36 - .../GitHubConnectorListBySubscription.json | 35 - .../examples/GitHubConnectorStatsGet.json | 26 - .../examples/GitHubConnectorUpdate.json | 46 - .../examples/GitHubOwnerCreateOrUpdate.json | 38 - .../examples/GitHubOwnerGet.json | 23 - .../examples/GitHubOwnerList.json | 33 - .../examples/GitHubOwnerUpdate.json | 37 - .../examples/GitHubRepoCreateOrUpdate.json | 43 - .../examples/GitHubRepoGet.json | 25 - .../examples/GitHubRepoList.json | 36 - .../examples/GitHubRepoListByConnector.json | 33 - .../examples/GitHubRepoUpdate.json | 42 - .../examples/OperationsList.json | 44 - .../2022-09-01-preview/securitydevops.json | 2735 ----------------- .../resource-manager/readme.az.md | 28 - .../resource-manager/readme.cli.md | 1 - .../resource-manager/readme.csharp.md | 15 - .../resource-manager/readme.go.md | 11 - .../resource-manager/readme.java.md | 7 - .../securitydevops/resource-manager/readme.md | 95 - .../resource-manager/readme.python.md | 18 - .../resource-manager/readme.typescript.md | 14 - 46 files changed, 4254 deletions(-) delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorCreateOrUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorDelete.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorGet.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListByResourceGroup.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListBySubscription.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorStatsGet.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgCreateOrUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgGet.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgList.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectCreateOrUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectGet.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectList.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoCreateOrUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoGet.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoList.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoListByConnector.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorCreateOrUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorDelete.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorGet.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListByResourceGroup.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListBySubscription.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorStatsGet.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerCreateOrUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerGet.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerList.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoCreateOrUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoGet.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoList.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoListByConnector.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoUpdate.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/OperationsList.json delete mode 100644 specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/securitydevops.json delete mode 100644 specification/securitydevops/resource-manager/readme.az.md delete mode 100644 specification/securitydevops/resource-manager/readme.cli.md delete mode 100644 specification/securitydevops/resource-manager/readme.csharp.md delete mode 100644 specification/securitydevops/resource-manager/readme.go.md delete mode 100644 specification/securitydevops/resource-manager/readme.java.md delete mode 100644 specification/securitydevops/resource-manager/readme.md delete mode 100644 specification/securitydevops/resource-manager/readme.python.md delete mode 100644 specification/securitydevops/resource-manager/readme.typescript.md diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorCreateOrUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorCreateOrUpdate.json deleted file mode 100644 index 4cee5b4394cc..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorCreateOrUpdate.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "api-version": "2022-09-01-preview", - "azureDevOpsConnector": { - "location": "West US", - "properties": { - "authorization": { - "code": "00000000000000000000" - }, - "orgs": [ - { - "name": "testOrg", - "projects": [ - { - "name": "testProject", - "repos": [ - "testRepo" - ] - } - ] - } - ] - } - } - }, - "responses": { - "201": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector", - "name": "testconnector", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Created" - } - } - }, - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector", - "name": "testconnector", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorDelete.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorDelete.json deleted file mode 100644 index a9d42c0a844d..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorDelete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - } - }, - "204": {}, - "200": {} - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorGet.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorGet.json deleted file mode 100644 index 32936d059612..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorGet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector", - "name": "testconnector", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListByResourceGroup.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListByResourceGroup.json deleted file mode 100644 index 12a1e7bf0d47..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListByResourceGroup.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector", - "name": "testconnector1", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector", - "name": "testconnector2", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListBySubscription.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListBySubscription.json deleted file mode 100644 index 3a51f4dd24eb..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorListBySubscription.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors", - "name": "testconnector1", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors", - "name": "testconnector2", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorStatsGet.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorStatsGet.json deleted file mode 100644 index ebba8981d183..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorStatsGet.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors", - "name": "testconnector", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "properties": { - "orgsCount": 5, - "projectsCount": 10, - "reposCount": 100, - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorUpdate.json deleted file mode 100644 index 5fc88106ff1b..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsConnectorUpdate.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "api-version": "2022-09-01-preview", - "azureDevOpsConnector": { - "location": "West US", - "tags": { - "env": "dev", - "client": "dev-client" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors", - "name": "testconnector1", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "location": "West US", - "properties": { - "provisioningState": "Succeeded" - }, - "tags": { - "Environment": "Dev" - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector", - "name": "testconnector", - "type": "microsoft.securitydevops/azureDevOpsConnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Accepted" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgCreateOrUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgCreateOrUpdate.json deleted file mode 100644 index 6dfce3c65da6..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgCreateOrUpdate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "api-version": "2022-09-01-preview", - "azureDevOpsOrg": { - "properties": { - "autoDiscovery": "Disabled" - } - } - }, - "responses": { - "201": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg", - "name": "myOrg", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs", - "properties": { - "provisioningState": "Created" - } - } - }, - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg", - "name": "myOrg", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs", - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgGet.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgGet.json deleted file mode 100644 index ef00460b452e..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs", - "properties": { - "autoDiscovery": "Disabled", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgList.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgList.json deleted file mode 100644 index 2d0be99d3780..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgList.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg1", - "type": "microsoft.securitydevops/azureDevOpsConnectors/orgs", - "properties": { - "autoDiscovery": "Disabled" - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg2", - "type": "microsoft.securitydevops/azureDevOpsConnectors/orgs", - "properties": { - "autoDiscovery": "Disabled" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgUpdate.json deleted file mode 100644 index 22247a7fcfc0..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsOrgUpdate.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "api-version": "2022-09-01-preview", - "azureDevOpsOrg": { - "properties": { - "autoDiscovery": "Disabled" - } - } - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg", - "name": "myOrg", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs", - "properties": { - "provisioningState": "Accepted" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg", - "name": "myOrg", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs", - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectCreateOrUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectCreateOrUpdate.json deleted file mode 100644 index c6282e786328..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectCreateOrUpdate.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "azureDevOpsProjectName": "myProject", - "api-version": "2022-09-01-preview", - "azureDevOpsProject": { - "properties": { - "autoDiscovery": "Disabled" - } - } - }, - "responses": { - "201": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject", - "name": "myProject", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects", - "properties": { - "provisioningState": "Created" - } - } - }, - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject", - "name": "myProject", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects", - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectGet.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectGet.json deleted file mode 100644 index ee3812fb5f14..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectGet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "azureDevOpsProjectName": "myProject", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects", - "properties": { - "autoDiscovery": "Disabled", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectList.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectList.json deleted file mode 100644 index d00cc58fed77..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectList.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject", - "type": "microsoft.securitydevops/azureDevOpsConnectors/orgs/projects", - "properties": { - "autoDiscovery": "Disabled" - } - }, - { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProjectNew", - "type": "microsoft.securitydevops/azureDevOpsConnectors/orgs/projects", - "properties": { - "autoDiscovery": "Disabled" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectUpdate.json deleted file mode 100644 index 06c8fedead70..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsProjectUpdate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "azureDevOpsProjectName": "myProject", - "api-version": "2022-09-01-preview", - "azureDevOpsProject": { - "properties": { - "autoDiscovery": "Disabled" - } - } - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject", - "name": "myProject", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects", - "properties": { - "provisioningState": "Accepted" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject", - "name": "myProject", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects", - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoCreateOrUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoCreateOrUpdate.json deleted file mode 100644 index de5d5dd4d543..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoCreateOrUpdate.json +++ /dev/null @@ -1,97 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "azureDevOpsProjectName": "myProject", - "azureDevOpsRepoName": "myRepo", - "api-version": "2022-09-01-preview", - "azureDevOpsRepo": { - "properties": { - "actionableRemediation": { - "state": "Enabled", - "categories": [ - "Secrets" - ], - "severityLevels": [ - "High" - ], - "branchConfiguration": { - "names": [ - "main" - ] - } - } - } - } - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject/repos/myRepo", - "name": "myRepo", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects/repos", - "properties": { - "provisioningState": "Accepted" - } - } - }, - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject/repos/myRepo", - "name": "myRepo", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects/repos", - "properties": { - "actionableRemediation": { - "state": "Enabled", - "categories": [ - "Secrets" - ], - "severityLevels": [ - "High" - ], - "branchConfiguration": { - "names": [ - "main" - ] - } - }, - "repoId": "00000000-0000-0000-0000-000000000000", - "repoUrl": "https://dev.azure.com/myOrg/myProject/_git/myRepo", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject/repos/myRepo", - "name": "myRepo", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects/repos", - "properties": { - "actionableRemediation": { - "state": "Enabled", - "categories": [ - "Secrets" - ], - "severityLevels": [ - "High" - ], - "branchConfiguration": { - "names": [ - "main" - ] - } - }, - "repoId": "00000000-0000-0000-0000-000000000000", - "repoUrl": "https://dev.azure.com/myOrg/myProject/_git/myRepo", - "provisioningState": "Created" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoGet.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoGet.json deleted file mode 100644 index a2f507854510..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoGet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "azureDevOpsProjectName": "myProject", - "azureDevOpsRepoName": "myRepo", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject/repos/myRepo", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects/repos", - "properties": { - "repoUrl": "https://dev.azure.com/myOrg/myProject/myRepo" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoList.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoList.json deleted file mode 100644 index a12b78a63502..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoList.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "azureDevOpsProjectName": "myProject", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg1/projects/myProject/repos/myRepo", - "type": "microsoft.securitydevops/azureDevOpsConnectors/githubrepo", - "properties": { - "repoUrl": "https://dev.azure.com/myOrg/myProject/myRepo" - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg2/projects/myProject/repos/myRepo", - "type": "microsoft.securitydevops/azureDevOpsConnectors/githubrepo", - "properties": { - "repoUrl": "https://dev.azure.com/myOrg2/myProject/myRepo" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoListByConnector.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoListByConnector.json deleted file mode 100644 index dfcf99ebd6be..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoListByConnector.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg1/projects/myProject/repos/myRepo", - "type": "microsoft.securitydevops/azureDevOpsConnectors/githubrepo", - "properties": { - "repoUrl": "https://dev.azure.com/myOrg/myProject/myRepo" - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg2/projects/myProject/repos/myRepo", - "type": "microsoft.securitydevops/azureDevOpsConnectors/githubrepo", - "properties": { - "repoUrl": "https://dev.azure.com/myOrg2/myProject/myRepo" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoUpdate.json deleted file mode 100644 index 05c8d4433f28..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/AzureDevOpsRepoUpdate.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "azureDevOpsConnectorName": "testconnector", - "azureDevOpsOrgName": "myOrg", - "azureDevOpsProjectName": "myProject", - "azureDevOpsRepoName": "myRepo", - "api-version": "2022-09-01-preview", - "azureDevOpsRepo": {} - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject/repos/myRepo", - "name": "myRepo", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects/repos", - "properties": { - "provisioningState": "Accepted" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/testconnector/orgs/myOrg/projects/myProject/repos/myRepo", - "name": "myRepo", - "type": "Microsoft.SecurityDevOps/azureDevOpsConnectos/orgs/projects/repos", - "properties": { - "actionableRemediation": { - "state": "Enabled", - "categories": [ - "Secrets" - ], - "severityLevels": [ - "High" - ], - "branchConfiguration": { - "names": [ - "main" - ] - } - }, - "repoId": "00000000-0000-0000-0000-000000000000", - "repoUrl": "https://dev.azure.com/myOrg/myProject/_git/myRepo", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorCreateOrUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorCreateOrUpdate.json deleted file mode 100644 index b56fba61636b..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorCreateOrUpdate.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "api-version": "2022-09-01-preview", - "gitHubConnector": { - "location": "West US", - "properties": { - "code": "00000000000000000000" - } - } - }, - "responses": { - "201": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector", - "name": "testconnector", - "type": "microsoft.securitydevops/githubconnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Accepted" - } - } - }, - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector", - "name": "testconnector", - "type": "microsoft.securitydevops/githubconnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorDelete.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorDelete.json deleted file mode 100644 index f8cb6461b949..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorDelete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - } - }, - "204": {}, - "200": {} - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorGet.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorGet.json deleted file mode 100644 index 9c4cbcf802b6..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorGet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector", - "name": "testconnector", - "type": "microsoft.securitydevops/githubconnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListByResourceGroup.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListByResourceGroup.json deleted file mode 100644 index 721240fcc893..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListByResourceGroup.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector", - "name": "testconnector1", - "type": "microsoft.securitydevops/githubconnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector", - "name": "testconnector2", - "type": "microsoft.securitydevops/githubconnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListBySubscription.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListBySubscription.json deleted file mode 100644 index 38bca2e49104..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorListBySubscription.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/gitHubConnectors", - "name": "testconnector1", - "type": "microsoft.securitydevops/githubconnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/gitHubConnectors", - "name": "testconnector2", - "type": "microsoft.securitydevops/githubconnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorStatsGet.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorStatsGet.json deleted file mode 100644 index eb8cd1fa99f8..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorStatsGet.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/gitHubConnectors", - "name": "testconnector1", - "type": "microsoft.securitydevops/githubconnectors", - "properties": { - "reposCount": 100, - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorUpdate.json deleted file mode 100644 index 5c39b325abf3..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubConnectorUpdate.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "api-version": "2022-09-01-preview", - "gitHubConnector": { - "location": "West US", - "tags": { - "env": "dev", - "client": "dev-client" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/gitHubConnectors", - "name": "testconnector1", - "type": "microsoft.securitydevops/githubconnectors", - "location": "West US", - "properties": { - "provisioningState": "Succeeded" - }, - "tags": { - "Environment": "Dev" - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector", - "name": "testconnector", - "type": "microsoft.securitydevops/githubconnectors", - "location": "West US", - "tags": {}, - "properties": { - "provisioningState": "Accepted" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerCreateOrUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerCreateOrUpdate.json deleted file mode 100644 index 510666216a21..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerCreateOrUpdate.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "gitHubOwnerName": "Azure", - "api-version": "2022-09-01-preview", - "gitHubOwner": {} - }, - "responses": { - "201": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure", - "name": "Azure", - "type": "Microsoft.SecurityDevOps/owners", - "properties": { - "ownerUrl": "https://github.com/Azure", - "provisioningState": "Created" - } - } - }, - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure", - "name": "Azure", - "type": "Microsoft.SecurityDevOps/owners", - "properties": { - "ownerUrl": "https://github.com/Azure", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerGet.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerGet.json deleted file mode 100644 index 9b5cf0e85ba7..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerGet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "gitHubOwnerName": "Azure", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure", - "name": "Azure", - "type": "Microsoft.SecurityDevOps/owners/repos", - "properties": { - "ownerUrl": "https://github.com/Azure", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerList.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerList.json deleted file mode 100644 index 64430cc91c2a..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerList.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure", - "name": "Azure", - "type": "microsoft.securitydevops/githubconnectors/owners", - "properties": { - "ownerUrl": "https://github.com/Azure" - } - }, - { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure-Samples", - "name": "Azure-Samples", - "type": "microsoft.securitydevops/githubconnectors/owners", - "properties": { - "ownerUrl": "https://github.com/Azure-Samples" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerUpdate.json deleted file mode 100644 index c11c7a2a9209..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubOwnerUpdate.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "gitHubOwnerName": "Azure", - "api-version": "2022-09-01-preview", - "gitHubOwner": {} - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure", - "name": "Azure", - "type": "Microsoft.SecurityDevOps/owners", - "properties": { - "ownerUrl": "https://github.com/Azure", - "provisioningState": "Succeeded" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure", - "name": "Azure", - "type": "Microsoft.SecurityDevOps/owners", - "properties": { - "ownerUrl": "https://github.com/Azure", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoCreateOrUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoCreateOrUpdate.json deleted file mode 100644 index 18680c0c168b..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoCreateOrUpdate.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "gitHubOwnerName": "Azure", - "gitHubRepoName": "azure-rest-api-specs", - "api-version": "2022-09-01-preview", - "gitHubRepo": {} - }, - "responses": { - "201": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/myOrg/repos/azure-rest-api-specs", - "name": "azure-rest-api-specs", - "type": "Microsoft.SecurityDevOps/owners/repos", - "properties": { - "accountId": 6844498, - "repoUrl": "https://github.com/Azure/azure-rest-api-specs", - "ownerName": "Azure", - "provisioningState": "Created" - } - } - }, - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/myOrg/repos/azure-rest-api-specs", - "name": "azure-rest-api-specs", - "type": "Microsoft.SecurityDevOps/owners/repos", - "properties": { - "accountId": 6844498, - "repoUrl": "https://github.com/Azure/azure-rest-api-specs", - "ownerName": "Azure", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoGet.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoGet.json deleted file mode 100644 index fe0e6a24f674..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoGet.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "gitHubOwnerName": "Azure", - "gitHubRepoName": "39093389", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure/repos/azure-rest-api-specs", - "name": "azure-rest-api-specs", - "type": "Microsoft.SecurityDevOps/owners/repos", - "properties": { - "accountId": 6844498, - "repoUrl": "https://github.com/Azure/azure-rest-api-specs", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoList.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoList.json deleted file mode 100644 index ca6cb29404b3..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoList.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "gitHubOwnerName": "Azure", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure/repos/azure-rest-api-specs", - "name": "azure-rest-api-specs", - "type": "microsoft.securitydevops/githubconnectors/owners/repos", - "properties": { - "accountId": 6844498, - "repoUrl": "https://github.com/Azure/azure-rest-api-specs" - } - }, - { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure/repos/another-repo", - "name": "azure-rest-api-specs", - "type": "microsoft.securitydevops/githubconnectors/owners/repos", - "properties": { - "accountId": 6844499, - "repoUrl": "https://github.com/Azure/another-repo" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoListByConnector.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoListByConnector.json deleted file mode 100644 index 76adf0589d14..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoListByConnector.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure/repos/azure-rest-api-specs", - "type": "microsoft.securitydevops/githubconnectors/owners/repos", - "properties": { - "accountId": 6844498, - "repoUrl": "https://github.com/Azure/azure-rest-api-specs" - } - }, - { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure-Samples/repos/another-repo", - "type": "microsoft.securitydevops/githubconnectors/owners/repos", - "properties": { - "accountId": 6844499, - "repoUrl": "https://github.com/Azure-Samples/another-repo" - } - } - ] - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoUpdate.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoUpdate.json deleted file mode 100644 index 2affe435e5cd..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/GitHubRepoUpdate.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "westusrg", - "gitHubConnectorName": "testconnector", - "gitHubOwnerName": "Azure", - "gitHubRepoName": "azure-rest-api-specs", - "api-version": "2022-09-01-preview", - "gitHubRepo": {} - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://api-prod.resources.windows-int.net/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SecurityDevOps/locations/WESTUS/operationStatuses/7e430d08-0ed2-4566-bcdc-3508e79f51cd*0000000000000000000000000000000000000000000000000000000000000000?api-version=2022-09-01-preview" - }, - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure/repos/azure-rest-api-specs", - "name": "azure-rest-api-specs", - "type": "Microsoft.SecurityDevOps/owners/repos", - "properties": { - "accountId": 6844498, - "ownerName": "Azure", - "repoUrl": "https://github.com/Azure/azure-rest-api-specs", - "provisioningState": "Succeeded" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/e7032cc6-7422-4ddd-9022-bfbf23b05332/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector/owners/Azure/repos/azure-rest-api-specs", - "name": "azure-rest-api-specs", - "type": "Microsoft.SecurityDevOps/owners/repos", - "properties": { - "accountId": 6844498, - "ownerName": "Azure", - "repoUrl": "https://github.com/Azure/azure-rest-api-specs", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/OperationsList.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/OperationsList.json deleted file mode 100644 index 36f0fef0ce79..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/examples/OperationsList.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2022-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.SecurityDevOps/gitHubConnectors/Read", - "isDataAction": false, - "display": { - "provider": "Microsoft.SecurityDevOps", - "resource": "gitHubConnectors", - "operation": "Get/List gitHubConnector resources", - "description": "Read gitHubConnector" - } - }, - { - "name": "Microsoft.SecurityDevOps/gitHubConnectors/Write", - "isDataAction": false, - "display": { - "provider": "Microsoft.SecurityDevOps", - "resource": "gitHubConnectors", - "operation": "Create/Update gitHubConnector resources", - "description": "Write gitHubConnector" - } - }, - { - "name": "Microsoft.SecurityDevOps/gitHubConnectors/Delete", - "isDataAction": false, - "display": { - "provider": "Microsoft.SecurityDevOps", - "resource": "gitHubConnectors", - "operation": "Delete gitHubConnector resources", - "description": "Delete gitHubConnector" - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/securitydevops.json b/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/securitydevops.json deleted file mode 100644 index 12bb85381534..000000000000 --- a/specification/securitydevops/resource-manager/Microsoft.SecurityDevOps/preview/2022-09-01-preview/securitydevops.json +++ /dev/null @@ -1,2735 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft.SecurityDevOps", - "description": "REST APIs for Defender for DevOps", - "version": "2022-09-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors": { - "get": { - "tags": [ - "default" - ], - "operationId": "AzureDevOpsConnector_ListByResourceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsConnectorListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AzureDevOpsConnector_ListByResourceGroup": { - "$ref": "./examples/AzureDevOpsConnectorListByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a monitored AzureDevOps Connector resource for a given ID.", - "operationId": "AzureDevOpsConnector_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsConnector" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AzureDevOpsConnector_Get": { - "$ref": "./examples/AzureDevOpsConnectorGet.json" - } - } - }, - "put": { - "tags": [ - "default" - ], - "summary": "Creates or updates an Azure DevOps Connector.", - "operationId": "AzureDevOpsConnector_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureDevOpsConnector", - "description": "Connector resource payload.", - "required": true, - "schema": { - "$ref": "#/definitions/AzureDevOpsConnector" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/AzureDevOpsConnector" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsConnector" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "AzureDevOpsConnector_CreateOrUpdate": { - "$ref": "./examples/AzureDevOpsConnectorCreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "default" - ], - "summary": "Update monitored AzureDevOps Connector details.", - "operationId": "AzureDevOpsConnector_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureDevOpsConnector", - "description": "Connector resource payload.", - "schema": { - "$ref": "#/definitions/AzureDevOpsConnector" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsConnector" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/AzureDevOpsConnector" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AzureDevOpsConnector_Update": { - "$ref": "./examples/AzureDevOpsConnectorUpdate.json" - } - } - }, - "delete": { - "tags": [ - "default" - ], - "summary": "Delete monitored AzureDevOps Connector details.", - "operationId": "AzureDevOpsConnector_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - }, - "200": { - "description": "Success" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AzureDevOpsConnector_Delete": { - "$ref": "./examples/AzureDevOpsConnectorDelete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/repos": { - "get": { - "tags": [ - "default" - ], - "operationId": "AzureDevOpsRepo_ListByConnector", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsRepoListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AzureDevOpsRepo_ListByConnector": { - "$ref": "./examples/AzureDevOpsRepoListByConnector.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/stats": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns the summary of the AzureDevOps Connector Stats.", - "operationId": "AzureDevOpsConnectorStats_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsConnectorStatsListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AzureDevOpsConnectorStats_Get": { - "$ref": "./examples/AzureDevOpsConnectorStatsGet.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs": { - "get": { - "tags": [ - "default" - ], - "operationId": "AzureDevOpsOrg_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsOrgListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AzureDevOpsOrg_List": { - "$ref": "./examples/AzureDevOpsOrgList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName}": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a monitored AzureDevOps Org resource for a given ID.", - "operationId": "AzureDevOpsOrg_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsOrg" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AzureDevOpsOrg_Get": { - "$ref": "./examples/AzureDevOpsOrgGet.json" - } - } - }, - "put": { - "tags": [ - "default" - ], - "summary": "Creates or updates an Azure DevOps Org.", - "operationId": "AzureDevOpsOrg_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureDevOpsOrg", - "description": "Azure DevOps Org resource payload.", - "required": true, - "schema": { - "$ref": "#/definitions/AzureDevOpsOrg" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/AzureDevOpsOrg" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsOrg" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "AzureDevOpsOrg_CreateOrUpdate": { - "$ref": "./examples/AzureDevOpsOrgCreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "default" - ], - "summary": "Update monitored AzureDevOps Org details.", - "operationId": "AzureDevOpsOrg_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureDevOpsOrg", - "description": "Azure DevOps Org resource payload.", - "schema": { - "$ref": "#/definitions/AzureDevOpsOrg" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/AzureDevOpsOrg" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsOrg" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AzureDevOpsOrg_Update": { - "$ref": "./examples/AzureDevOpsOrgUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName}/projects": { - "get": { - "tags": [ - "default" - ], - "operationId": "AzureDevOpsProject_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsProjectListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AzureDevOpsProject_List": { - "$ref": "./examples/AzureDevOpsProjectList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName}/projects/{azureDevOpsProjectName}": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a monitored AzureDevOps Project resource for a given ID.", - "operationId": "AzureDevOpsProject_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "#/parameters/AzureDevOpsProjectName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsProject" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AzureDevOpsProject_Get": { - "$ref": "./examples/AzureDevOpsProjectGet.json" - } - } - }, - "put": { - "tags": [ - "default" - ], - "summary": "Creates or updates an Azure DevOps Project.", - "operationId": "AzureDevOpsProject_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "#/parameters/AzureDevOpsProjectName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureDevOpsProject", - "description": "Azure DevOps Org resource payload.", - "required": true, - "schema": { - "$ref": "#/definitions/AzureDevOpsProject" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/AzureDevOpsProject" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsProject" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "AzureDevOpsProject_CreateOrUpdate": { - "$ref": "./examples/AzureDevOpsProjectCreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "default" - ], - "summary": "Update monitored AzureDevOps Project details.", - "operationId": "AzureDevOpsProject_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "#/parameters/AzureDevOpsProjectName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureDevOpsProject", - "description": "Azure DevOps Project resource payload.", - "schema": { - "$ref": "#/definitions/AzureDevOpsProject" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/AzureDevOpsProject" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsProject" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AzureDevOpsProject_Update": { - "$ref": "./examples/AzureDevOpsProjectUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName}/projects/{azureDevOpsProjectName}/repos": { - "get": { - "tags": [ - "default" - ], - "operationId": "AzureDevOpsRepo_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "#/parameters/AzureDevOpsProjectName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsRepoListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AzureDevOpsRepo_List": { - "$ref": "./examples/AzureDevOpsRepoList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName}/projects/{azureDevOpsProjectName}/repos/{azureDevOpsRepoName}": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a monitored AzureDevOps Project resource for a given ID.", - "operationId": "AzureDevOpsRepo_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "#/parameters/AzureDevOpsProjectName" - }, - { - "$ref": "#/parameters/AzureDevOpsRepoName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsRepo" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AzureDevOpsRepo_Get": { - "$ref": "./examples/AzureDevOpsRepoGet.json" - } - } - }, - "put": { - "tags": [ - "default" - ], - "summary": "Updates an Azure DevOps Repo.", - "operationId": "AzureDevOpsRepo_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "#/parameters/AzureDevOpsProjectName" - }, - { - "$ref": "#/parameters/AzureDevOpsRepoName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureDevOpsRepo", - "description": "Azure DevOps Repo resource payload.", - "required": true, - "schema": { - "$ref": "#/definitions/AzureDevOpsRepo" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/AzureDevOpsRepo" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsRepo" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/AzureDevOpsRepo" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "AzureDevOpsRepo_CreateOrUpdate": { - "$ref": "./examples/AzureDevOpsRepoCreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "default" - ], - "summary": "Update monitored AzureDevOps Repo details.", - "operationId": "AzureDevOpsRepo_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureDevOpsConnectorName" - }, - { - "$ref": "#/parameters/AzureDevOpsOrgName" - }, - { - "$ref": "#/parameters/AzureDevOpsProjectName" - }, - { - "$ref": "#/parameters/AzureDevOpsRepoName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureDevOpsRepo", - "description": "Azure DevOps Repo resource payload.", - "schema": { - "$ref": "#/definitions/AzureDevOpsRepo" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/AzureDevOpsRepo" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsRepo" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AzureDevOpsRepo_Update": { - "$ref": "./examples/AzureDevOpsRepoUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors": { - "get": { - "tags": [ - "default" - ], - "operationId": "GitHubConnector_ListByResourceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubConnectorListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GitHubConnector_ListByResourceGroup": { - "$ref": "./examples/GitHubConnectorListByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a monitored GitHub Connector resource for a given ID.", - "operationId": "GitHubConnector_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubConnector" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GitHubConnector_Get": { - "$ref": "./examples/GitHubConnectorGet.json" - } - } - }, - "put": { - "tags": [ - "default" - ], - "summary": "Create or update a monitored GitHub Connector resource.", - "operationId": "GitHubConnector_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "gitHubConnector", - "description": "Connector resource payload.", - "required": true, - "schema": { - "$ref": "#/definitions/GitHubConnector" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/GitHubConnector" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubConnector" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "GitHubConnector_CreateOrUpdate": { - "$ref": "./examples/GitHubConnectorCreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "default" - ], - "summary": "Update monitored GitHub Connector details.", - "operationId": "GitHubConnector_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "gitHubConnector", - "description": "Connector resource payload.", - "schema": { - "$ref": "#/definitions/GitHubConnector" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubConnector" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/GitHubConnector" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "GitHubConnector_Update": { - "$ref": "./examples/GitHubConnectorUpdate.json" - } - } - }, - "delete": { - "tags": [ - "default" - ], - "summary": "Delete monitored GitHub Connector details.", - "operationId": "GitHubConnector_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - }, - "200": { - "description": "Success" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "GitHubConnector_Delete": { - "$ref": "./examples/GitHubConnectorDelete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/repos": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a list of monitored GitHub repositories.", - "operationId": "GitHubRepo_ListByConnector", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubRepoListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GitHubRepo_ListByConnector": { - "$ref": "./examples/GitHubRepoListByConnector.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/stats": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns the summary of the GitHub Connector Stats.", - "operationId": "GitHubConnectorStats_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubConnectorStatsListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GitHubConnectorStats_Get": { - "$ref": "./examples/GitHubConnectorStatsGet.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/owners": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a list of monitored GitHub owners.", - "operationId": "GitHubOwner_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubOwnerListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GitHubOwner_List": { - "$ref": "./examples/GitHubOwnerList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/owners/{gitHubOwnerName}": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a monitored GitHub repository.", - "operationId": "GitHubOwner_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "#/parameters/GitHubOwnerName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubOwner" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GitHubOwner_Get": { - "$ref": "./examples/GitHubOwnerGet.json" - } - } - }, - "put": { - "tags": [ - "default" - ], - "summary": "Create or update a monitored GitHub owner.", - "operationId": "GitHubOwner_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "#/parameters/GitHubOwnerName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "gitHubOwner", - "description": "Github owner.", - "required": true, - "schema": { - "$ref": "#/definitions/GitHubOwner" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/GitHubOwner" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubOwner" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "GitHubOwner_CreateOrUpdate": { - "$ref": "./examples/GitHubOwnerCreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "default" - ], - "summary": "Update a monitored GitHub repository.", - "operationId": "GitHubOwner_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "#/parameters/GitHubOwnerName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "gitHubOwner", - "description": "Github owner.", - "schema": { - "$ref": "#/definitions/GitHubOwner" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/GitHubOwner" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubOwner" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "GitHubOwner_Update": { - "$ref": "./examples/GitHubOwnerUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/owners/{gitHubOwnerName}/repos": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a list of monitored GitHub repositories.", - "operationId": "GitHubRepo_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "#/parameters/GitHubOwnerName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubRepoListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GitHubRepo_List": { - "$ref": "./examples/GitHubRepoList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/owners/{gitHubOwnerName}/repos/{gitHubRepoName}": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a monitored GitHub repository.", - "operationId": "GitHubRepo_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "#/parameters/GitHubOwnerName" - }, - { - "$ref": "#/parameters/GitHubRepoName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubRepo" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GitHubRepo_Get": { - "$ref": "./examples/GitHubRepoGet.json" - } - } - }, - "put": { - "tags": [ - "default" - ], - "summary": "Create or update a monitored GitHub repository.", - "operationId": "GitHubRepo_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "#/parameters/GitHubOwnerName" - }, - { - "$ref": "#/parameters/GitHubRepoName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "gitHubRepo", - "description": "Github repo.", - "required": true, - "schema": { - "$ref": "#/definitions/GitHubRepo" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/GitHubRepo" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubRepo" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "GitHubRepo_CreateOrUpdate": { - "$ref": "./examples/GitHubRepoCreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "default" - ], - "summary": "Update a monitored GitHub repository.", - "operationId": "GitHubRepo_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/GitHubConnectorName" - }, - { - "$ref": "#/parameters/GitHubOwnerName" - }, - { - "$ref": "#/parameters/GitHubRepoName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "gitHubRepo", - "description": "Github repo.", - "schema": { - "$ref": "#/definitions/GitHubRepo" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/GitHubRepo" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubRepo" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "GitHubRepo_Update": { - "$ref": "./examples/GitHubRepoUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SecurityDevOps/gitHubConnectors": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a list of monitored GitHub Connectors.", - "operationId": "GitHubConnector_ListBySubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GitHubConnectorListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GitHubConnector_ListBySubscription": { - "$ref": "./examples/GitHubConnectorListBySubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors": { - "get": { - "tags": [ - "default" - ], - "summary": "Returns a list of monitored AzureDevOps Connectors.", - "operationId": "AzureDevOpsConnector_ListBySubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AzureDevOpsConnectorListResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AzureDevOpsConnector_ListBySubscription": { - "$ref": "./examples/AzureDevOpsConnectorListBySubscription.json" - } - } - } - }, - "/providers/Microsoft.SecurityDevOps/operations": { - "get": { - "description": "Returns list of operations supported by the Microsoft.SecurityDevOps provider.", - "operationId": "Operations_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation details.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/OperationsList.json" - } - } - } - } - }, - "definitions": { - "ActionableRemediation": { - "type": "object", - "properties": { - "state": { - "$ref": "#/definitions/ActionableRemediationState" - }, - "severityLevels": { - "type": "array", - "items": { - "type": "string" - }, - "x-ms-identifiers": [] - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/definitions/RuleCategory" - }, - "x-ms-identifiers": [] - }, - "branchConfiguration": { - "$ref": "#/definitions/TargetBranchConfiguration" - } - } - }, - "ActionableRemediationState": { - "description": "ActionableRemediation Setting.\r\nNone - the setting was never set.\r\nEnabled - ActionableRemediation is enabled.\r\nDisabled - ActionableRemediation is disabled.", - "enum": [ - "None", - "Disabled", - "Enabled" - ], - "type": "string", - "x-ms-enum": { - "name": "ActionableRemediationState", - "modelAsString": true, - "modelAsExtensible": true - } - }, - "AuthorizationInfo": { - "type": "object", - "properties": { - "code": { - "description": "Gets or sets one-time OAuth code to exchange for refresh and access tokens.\r\n\r\nOnly used during PUT operations. The secret is cleared during GET.\r\nIn general, RPaaS does not return any property marked as a secret.", - "type": "string", - "example": "00000000000000000000.", - "x-ms-secret": true - } - } - }, - "AutoDiscovery": { - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string", - "x-ms-enum": { - "name": "AutoDiscovery", - "modelAsString": true, - "modelAsExtensible": true - } - }, - "AzureDevOpsConnector": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AzureDevOpsConnectorProperties" - } - } - }, - "AzureDevOpsConnectorListResponse": { - "type": "object", - "properties": { - "value": { - "description": "Gets or sets list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/AzureDevOpsConnector" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Gets or sets next link to scroll over the results.", - "type": "string" - } - } - }, - "AzureDevOpsConnectorProperties": { - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "authorization": { - "$ref": "#/definitions/AuthorizationInfo" - }, - "orgs": { - "description": "Gets or sets org onboarding information.", - "type": "array", - "items": { - "$ref": "#/definitions/AzureDevOpsOrgMetadata" - }, - "x-ms-identifiers": [] - } - } - }, - "AzureDevOpsConnectorStats": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AzureDevOpsConnectorStatsProperties" - } - } - }, - "AzureDevOpsConnectorStatsListResponse": { - "type": "object", - "properties": { - "value": { - "description": "Gets or sets list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/AzureDevOpsConnectorStats" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Gets or sets next link to scroll over the results.", - "type": "string" - } - } - }, - "AzureDevOpsConnectorStatsProperties": { - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "orgsCount": { - "format": "int64", - "description": "Gets or sets orgs count.", - "type": "integer" - }, - "projectsCount": { - "format": "int64", - "description": "Gets or sets projects count.", - "type": "integer" - }, - "reposCount": { - "format": "int64", - "description": "Gets or sets repos count.", - "type": "integer" - } - } - }, - "AzureDevOpsOrg": { - "description": "Azure DevOps Org Proxy Resource.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AzureDevOpsOrgProperties" - } - } - }, - "AzureDevOpsOrgListResponse": { - "type": "object", - "properties": { - "value": { - "description": "Gets or sets list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/AzureDevOpsOrg" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Gets or sets next link to scroll over the results.", - "type": "string" - } - } - }, - "AzureDevOpsOrgMetadata": { - "description": "Org onboarding info.", - "type": "object", - "properties": { - "name": { - "description": "Gets or sets name of the AzureDevOps Org.", - "type": "string" - }, - "autoDiscovery": { - "$ref": "#/definitions/AutoDiscovery" - }, - "projects": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureDevOpsProjectMetadata" - }, - "x-ms-identifiers": [] - } - } - }, - "AzureDevOpsOrgProperties": { - "description": "AzureDevOps Org properties.", - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "autoDiscovery": { - "$ref": "#/definitions/AutoDiscovery" - } - } - }, - "AzureDevOpsProject": { - "description": "Azure DevOps Project Proxy Resource.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AzureDevOpsProjectProperties" - } - } - }, - "AzureDevOpsProjectListResponse": { - "type": "object", - "properties": { - "value": { - "description": "Gets or sets list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/AzureDevOpsProject" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Gets or sets next link to scroll over the results.", - "type": "string" - } - } - }, - "AzureDevOpsProjectMetadata": { - "description": "Project onboarding info.", - "type": "object", - "properties": { - "name": { - "description": "Gets or sets name of the AzureDevOps Project.", - "type": "string" - }, - "autoDiscovery": { - "$ref": "#/definitions/AutoDiscovery" - }, - "repos": { - "description": "Gets or sets repositories.", - "type": "array", - "items": { - "type": "string" - }, - "x-ms-identifiers": [] - } - } - }, - "AzureDevOpsProjectProperties": { - "description": "AzureDevOps Project properties.", - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "orgName": { - "description": "Gets or sets AzureDevOps org Name.", - "type": "string" - }, - "projectId": { - "description": "Gets or sets AzureDevOps Project Id.", - "type": "string" - }, - "autoDiscovery": { - "$ref": "#/definitions/AutoDiscovery" - } - } - }, - "AzureDevOpsRepo": { - "description": "Azure DevOps Repo Proxy Resource.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AzureDevOpsRepoProperties" - } - } - }, - "AzureDevOpsRepoListResponse": { - "type": "object", - "properties": { - "value": { - "description": "Gets or sets list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/AzureDevOpsRepo" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Gets or sets next link to scroll over the results.", - "type": "string" - } - } - }, - "AzureDevOpsRepoProperties": { - "description": "AzureDevOps Repo properties.", - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "orgName": { - "description": "Gets or sets AzureDevOps org Name.", - "type": "string", - "readOnly": true - }, - "projectName": { - "description": "Gets or sets AzureDevOps project Name.", - "type": "string", - "readOnly": true - }, - "repoId": { - "description": "Gets or sets Azure DevOps repo id.", - "type": "string", - "readOnly": true - }, - "repoUrl": { - "description": "Gets or sets AzureDevOps repo url.", - "type": "string", - "readOnly": true - }, - "visibility": { - "description": "Gets or sets AzureDevOps repo visibility, whether it is public or private etc.", - "type": "string", - "readOnly": true - }, - "actionableRemediation": { - "$ref": "#/definitions/ActionableRemediation" - } - } - }, - "GitHubConnector": { - "description": "Represents an ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/GitHubConnectorProperties" - } - } - }, - "GitHubConnectorListResponse": { - "type": "object", - "properties": { - "value": { - "description": "Gets or sets list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/GitHubConnector" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Gets or sets next link to scroll over the results.", - "type": "string" - } - } - }, - "GitHubConnectorProperties": { - "description": "Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.", - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "code": { - "description": "Gets or sets one-time OAuth code to exchange for refresh and access tokens.\r\n\r\nOnly used during PUT operations. The secret is cleared during GET.\r\nIn general, RPaaS does not return any property marked as a secret.", - "type": "string", - "example": "00000000000000000000.", - "x-ms-secret": true - } - } - }, - "GitHubConnectorStats": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/GitHubConnectorStatsProperties" - } - } - }, - "GitHubConnectorStatsListResponse": { - "type": "object", - "properties": { - "value": { - "description": "Gets or sets list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/GitHubConnectorStats" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Gets or sets next link to scroll over the results.", - "type": "string" - } - } - }, - "GitHubConnectorStatsProperties": { - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "ownersCount": { - "format": "int64", - "description": "Gets or sets owners count.", - "type": "integer" - }, - "reposCount": { - "format": "int64", - "description": "Gets or sets repos count.", - "type": "integer" - } - } - }, - "GitHubOwner": { - "description": "GitHub repo owner Proxy Resource.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/GitHubOwnerProperties" - } - } - }, - "GitHubOwnerListResponse": { - "type": "object", - "properties": { - "value": { - "description": "Gets or sets list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/GitHubOwner" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Gets or sets next link to scroll over the results.", - "type": "string" - } - } - }, - "GitHubOwnerProperties": { - "description": "GitHub Repo Owner properties.", - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "ownerUrl": { - "description": "Gets or sets gitHub owner url.", - "type": "string" - } - } - }, - "GitHubRepo": { - "description": "GitHub repo Proxy Resource.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/GitHubRepoProperties" - } - } - }, - "GitHubRepoListResponse": { - "type": "object", - "properties": { - "value": { - "description": "Gets or sets list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/GitHubRepo" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Gets or sets next link to scroll over the results.", - "type": "string" - } - } - }, - "GitHubRepoProperties": { - "description": "GitHub Repo properties.", - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "accountId": { - "format": "int64", - "description": "Gets or sets gitHub repo account id.", - "type": "integer" - }, - "repoUrl": { - "description": "Gets or sets gitHub repo url.", - "type": "string" - }, - "ownerName": { - "description": "Gets or sets GitHub Owner Name.", - "type": "string" - } - } - }, - "GitHubReposProperties": { - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" - }, - "accountId": { - "format": "int64", - "description": "Gets or sets gitHub repo account id.", - "type": "integer" - }, - "repoName": { - "description": "Gets or sets gitHub repo name.", - "type": "string" - }, - "repoUrl": { - "description": "Gets or sets gitHub repo url.", - "type": "string" - } - } - }, - "ProvisioningState": { - "enum": [ - "Succeeded", - "Failed", - "Canceled" - ], - "type": "string", - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true, - "modelAsExtensible": true - }, - "readOnly": true - }, - "RuleCategory": { - "enum": [ - "Code", - "Artifacts", - "Dependencies", - "Secrets", - "IaC", - "Containers" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleCategory", - "modelAsString": true, - "modelAsExtensible": true - } - }, - "TargetBranchConfiguration": { - "description": "Branch onboarding info.", - "type": "object", - "properties": { - "names": { - "description": "Gets or sets branches that should have annotations.\r\n\r\nFor Ignite, we will be supporting a single default branch configuration in the UX.", - "type": "array", - "items": { - "type": "string" - }, - "x-ms-identifiers": [] - } - } - } - }, - "parameters": { - "AzureDevOpsConnectorName": { - "in": "path", - "name": "azureDevOpsConnectorName", - "description": "Name of the AzureDevOps Connector.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AzureDevOpsOrgName": { - "in": "path", - "name": "azureDevOpsOrgName", - "description": "Name of the AzureDevOps Org.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AzureDevOpsProjectName": { - "in": "path", - "name": "azureDevOpsProjectName", - "description": "Name of the AzureDevOps Project.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AzureDevOpsRepoName": { - "in": "path", - "name": "azureDevOpsRepoName", - "description": "Name of the AzureDevOps Repo.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "GitHubConnectorName": { - "in": "path", - "name": "gitHubConnectorName", - "description": "Name of the GitHub Connector.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "GitHubOwnerName": { - "in": "path", - "name": "gitHubOwnerName", - "description": "Name of the GitHub Owner.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "GitHubRepoName": { - "in": "path", - "name": "gitHubRepoName", - "description": "Name of the GitHub Repo.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "Impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/securitydevops/resource-manager/readme.az.md b/specification/securitydevops/resource-manager/readme.az.md deleted file mode 100644 index e8ddb9da292c..000000000000 --- a/specification/securitydevops/resource-manager/readme.az.md +++ /dev/null @@ -1,28 +0,0 @@ -## AZ - -These settings apply only when `--az` is specified on the command line. - -For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. - -``` yaml $(az) && $(target-mode) != 'core' -az: - extensions: securitydevops - namespace: azure.mgmt.securitydevops - package-name: azure-mgmt-securitydevops -az-output-folder: $(azure-cli-extension-folder)/src/securitydevops -python-sdk-output-folder: "$(az-output-folder)/azext_securitydevops/vendored_sdks/securitydevops" -# add additional configuration here specific for Azure CLI -# refer to the faq.md for more details -``` - - - -This is for command modules that already in azure cli main repo. -``` yaml $(az) && $(target-mode) == 'core' -az: - extensions: securitydevops - namespace: azure.mgmt.securitydevops - package-name: azure-mgmt-securitydevops -az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/securitydevops -python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/securitydevops" -``` \ No newline at end of file diff --git a/specification/securitydevops/resource-manager/readme.cli.md b/specification/securitydevops/resource-manager/readme.cli.md deleted file mode 100644 index c6cf6ad37ea4..000000000000 --- a/specification/securitydevops/resource-manager/readme.cli.md +++ /dev/null @@ -1 +0,0 @@ -## CLI Common Settings for all the command line tools \ No newline at end of file diff --git a/specification/securitydevops/resource-manager/readme.csharp.md b/specification/securitydevops/resource-manager/readme.csharp.md deleted file mode 100644 index eefc08006882..000000000000 --- a/specification/securitydevops/resource-manager/readme.csharp.md +++ /dev/null @@ -1,15 +0,0 @@ -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -```yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 1 - clear-output-folder: true - client-side-validation: false - namespace: Microsoft.SecurityDevOps - output-folder: $(csharp-sdks-folder)/securitydevops/management/Microsoft.SecurityDevOps/GeneratedProtocol -``` diff --git a/specification/securitydevops/resource-manager/readme.go.md b/specification/securitydevops/resource-manager/readme.go.md deleted file mode 100644 index c4f2243e2c9d..000000000000 --- a/specification/securitydevops/resource-manager/readme.go.md +++ /dev/null @@ -1,11 +0,0 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -```yaml $(go) && $(track2) -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -module-name: sdk/resourcemanager/securitydevops/armsecuritydevops -module: github.com/Azure/azure-sdk-for-go/$(module-name) -output-folder: $(go-sdk-folder)/$(module-name) -``` diff --git a/specification/securitydevops/resource-manager/readme.java.md b/specification/securitydevops/resource-manager/readme.java.md deleted file mode 100644 index 648f3e06ed2e..000000000000 --- a/specification/securitydevops/resource-manager/readme.java.md +++ /dev/null @@ -1,7 +0,0 @@ -## Java - -These settings apply only when `--java` is specified on the command line. - -``` yaml $(java) -service-name: Security Dev Ops -``` \ No newline at end of file diff --git a/specification/securitydevops/resource-manager/readme.md b/specification/securitydevops/resource-manager/readme.md deleted file mode 100644 index c9f3c746da39..000000000000 --- a/specification/securitydevops/resource-manager/readme.md +++ /dev/null @@ -1,95 +0,0 @@ -# securitydevops - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for securitydevops. - -## Getting Started - -To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: - -> `autorest readme.md` - -To see additional help and options, run: - -> `autorest --help` - -For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. - ---- - -## Configuration - -### Basic Information - -These are the global settings for the securitydevops. - -``` yaml -openapi-type: arm -openapi-subtype: rpaas -tag: package-2022-09-01-preview -``` - -### Tag: package-2022-09-01-preview - -These settings apply only when `--tag=package-2022-09-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2022-09-01-preview' -input-file: - - Microsoft.SecurityDevOps/preview/2022-09-01-preview/securitydevops.json -``` - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-resource-manager-schemas - - repo: azure-cli-extensions -``` - -## Az - -See configuration in [readme.az.md](./readme.az.md) - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## TypeScript - -See configuration in [readme.typescript.md](./readme.typescript.md) - -## CSharp - -See configuration in [readme.csharp.md](./readme.csharp.md) - -## Suppression - -``` yaml -directive: - - suppress: TrackedResourceListByImmediateParent - where: $.definitions - from: securitydevops.json - reason: We do not have tracked resource - - suppress: EnumInsteadOfBoolean - where: $.definitions.Operation.properties.isDataAction - from: types.json - reason: This is not related to my code and is part of common code - - suppress: EnumInsteadOfBoolean - where: $.definitions.Operation.properties.isDataAction - from: types.json - reason: 'Not my code, it is a part of common code' -``` diff --git a/specification/securitydevops/resource-manager/readme.python.md b/specification/securitydevops/resource-manager/readme.python.md deleted file mode 100644 index c0dbbb97a487..000000000000 --- a/specification/securitydevops/resource-manager/readme.python.md +++ /dev/null @@ -1,18 +0,0 @@ -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(python) -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -package-name: azure-mgmt-securitydevops -namespace: azure.mgmt.securitydevops -package-version: 1.0.0b1 -clear-output-folder: true -``` - -``` yaml $(python) -no-namespace-folders: true -output-folder: $(python-sdks-folder)/securitydevops/azure-mgmt-securitydevops/azure/mgmt/securitydevops -``` diff --git a/specification/securitydevops/resource-manager/readme.typescript.md b/specification/securitydevops/resource-manager/readme.typescript.md deleted file mode 100644 index d9a64b4327f7..000000000000 --- a/specification/securitydevops/resource-manager/readme.typescript.md +++ /dev/null @@ -1,14 +0,0 @@ -## TypeScript - -These settings apply only when `--typescript` is specified on the command line. -Please also specify `--typescript-sdks-folder=`. - -``` yaml $(typescript) -typescript: - azure-arm: true - package-name: "@azure/arm-securitydevops" - output-folder: "$(typescript-sdks-folder)/sdk/securitydevops/arm-securitydevops" - payload-flattening-threshold: 1 - clear-output-folder: true - generate-metadata: true -``` From c0409c494529a274a502b36d94ed6adbfc138356 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 12 Jun 2024 11:42:17 -0700 Subject: [PATCH 163/343] [package.json] Add devDependency "oav" (#29296) --- package-lock.json | 2210 ++++++++++++++++++++++++++++++++++++++++++++- package.json | 1 + 2 files changed, 2181 insertions(+), 30 deletions(-) diff --git a/package-lock.json b/package-lock.json index 1637d0e1fb9d..81e199d8467f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -21,6 +21,7 @@ "@typespec/rest": "0.56.0", "@typespec/versioning": "0.56.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", + "oav": "^3.3.7", "prettier": "~3.2.5", "typescript": "~5.4.5" } @@ -272,6 +273,134 @@ "node": ">=6.0.0" } }, + "node_modules/@apidevtools/json-schema-ref-parser": { + "version": "9.1.2", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz", + "integrity": "sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg==", + "dev": true, + "dependencies": { + "@jsdevtools/ono": "^7.1.3", + "@types/json-schema": "^7.0.6", + "call-me-maybe": "^1.0.1", + "js-yaml": "^4.1.0" + } + }, + "node_modules/@apidevtools/json-schema-ref-parser/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/@apidevtools/json-schema-ref-parser/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@apidevtools/openapi-schemas": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz", + "integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@apidevtools/swagger-methods": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz", + "integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg==", + "dev": true + }, + "node_modules/@apidevtools/swagger-parser": { + "version": "10.0.3", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.0.3.tgz", + "integrity": "sha512-sNiLY51vZOmSPFZA5TF35KZ2HbgYklQnTSDnkghamzLb3EkNtcQnrBQEj5AOCxHpTtXpqMCRM1CrmV2rG6nw4g==", + "dev": true, + "dependencies": { + "@apidevtools/json-schema-ref-parser": "^9.0.6", + "@apidevtools/openapi-schemas": "^2.0.4", + "@apidevtools/swagger-methods": "^3.0.2", + "@jsdevtools/ono": "^7.1.3", + "call-me-maybe": "^1.0.1", + "z-schema": "^5.0.1" + }, + "peerDependencies": { + "openapi-types": ">=7" + } + }, + "node_modules/@autorest/schemas": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@autorest/schemas/-/schemas-1.3.5.tgz", + "integrity": "sha512-HUP89Ns/4vDGcMtmFt/fxu+QqKvit/IQ8oBTQjzC6RnJojF+880KoEgTuweTuea2stzRmNyuMiBu4F8AnxdyUA==", + "dev": true + }, + "node_modules/@azure-tools/openapi-tools-common": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/@azure-tools/openapi-tools-common/-/openapi-tools-common-1.2.2.tgz", + "integrity": "sha512-r6oBkNsND1sA+ZjHlE1vTf2hUj4RUnbD9KG9uksEKnLVC6oOD5WuJYCO5y4xDzWWuR0x+9gImovQqXAE7ZXYfg==", + "dev": true, + "dependencies": { + "@types/async-retry": "^1.4.1", + "@types/commonmark": "^0.27.3", + "@types/node-fetch": "^2.5.7", + "async-retry": "^1.2.3", + "commonmark": "^0.28.1", + "front-matter": "^4.0.2", + "node-fetch": "^2.6.0", + "tslib": "^2.0.0" + } + }, + "node_modules/@azure-tools/openapi-tools-common/node_modules/commonmark": { + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.28.1.tgz", + "integrity": "sha512-PklsZ9pgrfFQ5hQH9BRzoWnqI9db2LeR9MhvkNk8iz97kfaTNmhTU+IE8jKDHTEfivZZXoFqzGqzddXdk14EJw==", + "dev": true, + "dependencies": { + "entities": "~ 1.1.1", + "mdurl": "~ 1.0.1", + "minimist": "~ 1.2.0", + "string.prototype.repeat": "^0.2.0" + }, + "bin": { + "commonmark": "bin/commonmark" + }, + "engines": { + "node": "*" + } + }, + "node_modules/@azure-tools/openapi-tools-common/node_modules/entities": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", + "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", + "dev": true + }, + "node_modules/@azure-tools/openapi-tools-common/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, "node_modules/@azure-tools/suppressions": { "resolved": "eng/tools/suppressions", "link": true @@ -394,6 +523,18 @@ "resolved": "eng/tools/typespec-validation", "link": true }, + "node_modules/@azure/abort-controller": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-1.1.0.tgz", + "integrity": "sha512-TrRLIoSQVzfAJX9H1JeFjzAoDGcoK1IYX1UImfceTZpsyYfWr09Ss1aHW1y5TrrR3iq6RZLBwJ3E24uwPhwahw==", + "dev": true, + "dependencies": { + "tslib": "^2.2.0" + }, + "engines": { + "node": ">=12.0.0" + } + }, "node_modules/@azure/avocado": { "version": "0.8.14", "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.8.14.tgz", @@ -422,6 +563,183 @@ "avocado": "bin/cli.js" } }, + "node_modules/@azure/core-auth": { + "version": "1.7.2", + "resolved": "https://registry.npmjs.org/@azure/core-auth/-/core-auth-1.7.2.tgz", + "integrity": "sha512-Igm/S3fDYmnMq1uKS38Ae1/m37B3zigdlZw+kocwEhh5GjyKjPrXKO2J6rzpC1wAxrNil/jX9BJRqBshyjnF3g==", + "dev": true, + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "@azure/core-util": "^1.1.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@azure/core-auth/node_modules/@azure/abort-controller": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", + "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", + "dev": true, + "dependencies": { + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@azure/core-http": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@azure/core-http/-/core-http-3.0.4.tgz", + "integrity": "sha512-Fok9VVhMdxAFOtqiiAtg74fL0UJkt0z3D+ouUUxcRLzZNBioPRAMJFVxiWoJljYpXsRi4GDQHzQHDc9AiYaIUQ==", + "dev": true, + "dependencies": { + "@azure/abort-controller": "^1.0.0", + "@azure/core-auth": "^1.3.0", + "@azure/core-tracing": "1.0.0-preview.13", + "@azure/core-util": "^1.1.1", + "@azure/logger": "^1.0.0", + "@types/node-fetch": "^2.5.0", + "@types/tunnel": "^0.0.3", + "form-data": "^4.0.0", + "node-fetch": "^2.6.7", + "process": "^0.11.10", + "tslib": "^2.2.0", + "tunnel": "^0.0.6", + "uuid": "^8.3.0", + "xml2js": "^0.5.0" + }, + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/@azure/core-http/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/@azure/core-tracing": { + "version": "1.0.0-preview.13", + "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.0.0-preview.13.tgz", + "integrity": "sha512-KxDlhXyMlh2Jhj2ykX6vNEU0Vou4nHr025KoSEiz7cS3BNiHNaZcdECk/DmLkEB0as5T7b/TpRcehJ5yV6NeXQ==", + "dev": true, + "dependencies": { + "@opentelemetry/api": "^1.0.1", + "tslib": "^2.2.0" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/@azure/core-util": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.9.0.tgz", + "integrity": "sha512-AfalUQ1ZppaKuxPPMsFEUdX6GZPB3d9paR9d/TTL7Ow2De8cJaC7ibi7kWVlFAVPCYo31OcnGymc0R89DX8Oaw==", + "dev": true, + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@azure/core-util/node_modules/@azure/abort-controller": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", + "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", + "dev": true, + "dependencies": { + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@azure/logger": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.1.2.tgz", + "integrity": "sha512-l170uE7bsKpIU6B/giRc9i4NI0Mj+tANMMMxf7Zi/5cKzEqPayP7+X1WPrG7e+91JgY8N+7K7nF2WOi7iVhXvg==", + "dev": true, + "dependencies": { + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@azure/ms-rest-js": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/@azure/ms-rest-js/-/ms-rest-js-2.7.0.tgz", + "integrity": "sha512-ngbzWbqF+NmztDOpLBVDxYM+XLcUj7nKhxGbSU9WtIsXfRB//cf2ZbAG5HkOrhU9/wd/ORRB6lM/d69RKVjiyA==", + "dev": true, + "dependencies": { + "@azure/core-auth": "^1.1.4", + "abort-controller": "^3.0.0", + "form-data": "^2.5.0", + "node-fetch": "^2.6.7", + "tslib": "^1.10.0", + "tunnel": "0.0.6", + "uuid": "^8.3.2", + "xml2js": "^0.5.0" + } + }, + "node_modules/@azure/ms-rest-js/node_modules/form-data": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.1.tgz", + "integrity": "sha512-m21N3WOmEEURgk6B9GLOE4RuWOFf28Lhh9qGYeNlGq4VDXUlJy2th2slBNU8Gp8EzloYZOibZJ7t5ecIrFSjVA==", + "dev": true, + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.6", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 0.12" + } + }, + "node_modules/@azure/ms-rest-js/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/@azure/ms-rest-js/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, "node_modules/@azure/openapi-markdown": { "version": "0.9.4", "resolved": "https://registry.npmjs.org/@azure/openapi-markdown/-/openapi-markdown-0.9.4.tgz", @@ -557,6 +875,26 @@ "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", "dev": true }, + "node_modules/@colors/colors": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz", + "integrity": "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@dabh/diagnostics": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@dabh/diagnostics/-/diagnostics-2.0.3.tgz", + "integrity": "sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==", + "dev": true, + "dependencies": { + "colorspace": "1.1.x", + "enabled": "2.0.x", + "kuler": "^2.0.0" + } + }, "node_modules/@esbuild/aix-ppc64": { "version": "0.20.2", "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.20.2.tgz", @@ -925,6 +1263,12 @@ "node": ">=12" } }, + "node_modules/@faker-js/faker": { + "version": "5.5.3", + "resolved": "https://registry.npmjs.org/@faker-js/faker/-/faker-5.5.3.tgz", + "integrity": "sha512-R11tGE6yIFwqpaIqcfkcg7AICXzFg14+5h5v0TfF/9+RMDL6jhzCy/pxHVOfbALGdtVYdt6JdR21tuxEgl34dw==", + "dev": true + }, "node_modules/@istanbuljs/schema": { "version": "0.1.3", "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", @@ -994,6 +1338,12 @@ "@jridgewell/sourcemap-codec": "^1.4.14" } }, + "node_modules/@jsdevtools/ono": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", + "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", + "dev": true + }, "node_modules/@kwsites/file-exists": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/@kwsites/file-exists/-/file-exists-1.1.1.tgz", @@ -1044,6 +1394,65 @@ "node": ">= 8" } }, + "node_modules/@opentelemetry/api": { + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.8.0.tgz", + "integrity": "sha512-I/s6F7yKUDdtMsoBWXJe8Qz40Tui5vsuKCWJEWVL+5q9sSWRzzx6v2KeNsOBEwd94j0eWkpWCH4yB6rZg9Mf0w==", + "dev": true, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/@postman/form-data": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@postman/form-data/-/form-data-3.1.1.tgz", + "integrity": "sha512-vjh8Q2a8S6UCm/KKs31XFJqEEgmbjBmpPNVV2eVav6905wyFAwaUOBGA1NPBI4ERH9MMZc6w0umFgM6WbEPMdg==", + "dev": true, + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/@postman/tough-cookie": { + "version": "4.1.3-postman.1", + "resolved": "https://registry.npmjs.org/@postman/tough-cookie/-/tough-cookie-4.1.3-postman.1.tgz", + "integrity": "sha512-txpgUqZOnWYnUHZpHjkfb0IwVH4qJmyq77pPnJLlfhMtdCLMFTEeQHlzQiK906aaNCe4NEB5fGJHo9uzGbFMeA==", + "dev": true, + "dependencies": { + "psl": "^1.1.33", + "punycode": "^2.1.1", + "universalify": "^0.2.0", + "url-parse": "^1.5.3" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/@postman/tough-cookie/node_modules/universalify": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.2.0.tgz", + "integrity": "sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg==", + "dev": true, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/@postman/tunnel-agent": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/@postman/tunnel-agent/-/tunnel-agent-0.6.3.tgz", + "integrity": "sha512-k57fzmAZ2PJGxfOA4SGR05ejorHbVAa/84Hxh/2nAztjNXc4ZjOm9NUIk6/Z6LCrBvJZqjRZbN8e/nROVUPVdg==", + "dev": true, + "dependencies": { + "safe-buffer": "^5.0.1" + }, + "engines": { + "node": "*" + } + }, "node_modules/@rollup/rollup-android-arm-eabi": { "version": "4.17.2", "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.17.2.tgz", @@ -1511,6 +1920,12 @@ "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", "dev": true }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "dev": true + }, "node_modules/@types/node": { "version": "10.17.60", "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz", @@ -1533,6 +1948,21 @@ "integrity": "sha512-3xSjTp3v03X/lSQLkczaN9UIEwJMoMCA1+Nb5HfbJEQWogdeQIyVtTvxPXDQjZ5zws8rFQfVfRdz03ARihPJgw==", "dev": true }, + "node_modules/@types/triple-beam": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@types/triple-beam/-/triple-beam-1.3.5.tgz", + "integrity": "sha512-6WaYesThRMCl19iryMYP7/x2OVgCtbIVflDGFpWnb9irXI3UjYE4AzmYuiUKY1AJstGijoY+MgUszMgRxIYTYw==", + "dev": true + }, + "node_modules/@types/tunnel": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/@types/tunnel/-/tunnel-0.0.3.tgz", + "integrity": "sha512-sOUTGn6h1SfQ+gbgqC364jLFBw2lnFqkgF3q0WovEHRLMrVD1sd5aufqi/aJObLekJO+Aq5z646U4Oxy6shXMA==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, "node_modules/@typespec/compiler": { "version": "0.56.0", "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.56.0.tgz", @@ -1813,10 +2243,22 @@ "url": "https://opencollective.com/vitest" } }, - "node_modules/acorn": { - "version": "8.11.3", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", - "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==", + "node_modules/abort-controller": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz", + "integrity": "sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg==", + "dev": true, + "dependencies": { + "event-target-shim": "^5.0.0" + }, + "engines": { + "node": ">=6.5" + } + }, + "node_modules/acorn": { + "version": "8.11.3", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", + "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==", "dev": true, "bin": { "acorn": "bin/acorn" @@ -1880,6 +2322,24 @@ "sprintf-js": "~1.0.2" } }, + "node_modules/asn1": { + "version": "0.2.6", + "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.6.tgz", + "integrity": "sha512-ix/FxPn0MDjeyJ7i/yoHGFt/EX6LyNbxSEhPPXODPL+KB0VPk86UYfL0lMdy+KCnv+fmvIzySwaK5COwqVbWTQ==", + "dev": true, + "dependencies": { + "safer-buffer": "~2.1.0" + } + }, + "node_modules/assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha512-NfJ4UzBCcQGLDlQq7nHxH+tv3kyZ0hHQqF5BO6J7tNJeP5do1llPr8dZ8zHonfhAu0PHAdMkSo+8o0wxg9lZWw==", + "dev": true, + "engines": { + "node": ">=0.8" + } + }, "node_modules/assertion-error": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", @@ -1889,6 +2349,12 @@ "node": "*" } }, + "node_modules/async": { + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/async/-/async-3.2.5.tgz", + "integrity": "sha512-baNZyqaaLhyLVKm/DlvdW051MSgO6b8eVfIezl9E5PqWxFgzLm/wQntEW4zOytVburDEr0JlALEpdOFwvErLsg==", + "dev": true + }, "node_modules/async-retry": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/async-retry/-/async-retry-1.3.3.tgz", @@ -1904,6 +2370,21 @@ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", "dev": true }, + "node_modules/aws-sign2": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", + "integrity": "sha512-08kcGqnYf/YmjoRhfxyu+CLxBjUtHLXLXX/vUfx9l2LYzG3c1m61nrpyFUZI6zeS+Li/wWMMidD9KgrqtGq3mA==", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/aws4": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.13.0.tgz", + "integrity": "sha512-3AungXC4I8kKsS9PuS4JH2nc+0bVY/mjgrephHTIi8fpEeGsTHBUJeosp0Wc1myYMElmD0B3Oc4XL/HVJ4PV2g==", + "dev": true + }, "node_modules/azure-rest-api-specs-eng-tools": { "resolved": "eng/tools", "link": true @@ -1914,6 +2395,41 @@ "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", "dev": true }, + "node_modules/base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/bcrypt-pbkdf": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", + "integrity": "sha512-qeFIXtP4MSoi6NLqO12WfqARWWuCKi2Rn/9hJLEmtB5yTNr9DqFWkJRCf2qShWzPeAMRnOgCrq0sg/KLv5ES9w==", + "dev": true, + "dependencies": { + "tweetnacl": "^0.14.3" + } + }, + "node_modules/bluebird": { + "version": "2.11.0", + "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-2.11.0.tgz", + "integrity": "sha512-UfFSr22dmHPQqPP9XWHRhq+gWnHCYguQGkXQlbyPtW5qTnhFWA8/iXg765tH0cAjy7l/zPJ1aBTO0g5XgA7kvQ==", + "dev": true + }, "node_modules/brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -1936,6 +2452,15 @@ "node": ">=8" } }, + "node_modules/brotli": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/brotli/-/brotli-1.3.3.tgz", + "integrity": "sha512-oTKjJdShmDuGW94SyyaoQvAjf30dZaHnjJ8uAF+u2/vGJkJbJPJAT1gDiOJP5v1Zb6f9KEyW/1HpuaWIXtGHPg==", + "dev": true, + "dependencies": { + "base64-js": "^1.1.2" + } + }, "node_modules/cac": { "version": "6.7.14", "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", @@ -1945,6 +2470,12 @@ "node": ">=8" } }, + "node_modules/call-me-maybe": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", + "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==", + "dev": true + }, "node_modules/camelcase": { "version": "5.3.1", "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", @@ -1954,6 +2485,12 @@ "node": ">=6" } }, + "node_modules/caseless": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", + "integrity": "sha512-4tYFyifaFfGacoiObjJegolkwSU4xQNGbVgUiNYVUxbQ2x2lUsFvY4hVgVzGiIe6WLOPqycWXA40l+PWsxthUw==", + "dev": true + }, "node_modules/chai": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/chai/-/chai-4.4.1.tgz", @@ -1992,6 +2529,21 @@ "integrity": "sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==", "dev": true }, + "node_modules/chardet": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/chardet/-/chardet-2.0.0.tgz", + "integrity": "sha512-xVgPpulCooDjY6zH4m9YW3jbkaBe3FKIAvF5sj5t7aBNsVl2ljIE+xwJ4iNgiDZHFQvNIpjdKdVOQvvk5ZfxbQ==", + "dev": true + }, + "node_modules/charset": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/charset/-/charset-1.0.1.tgz", + "integrity": "sha512-6dVyOOYjpfFcL1Y4qChrAoQLRHvj2ziyhcm0QJlhOcAhykL/k1kTUPbeo+87MNRTRdk2OIIsIXbuF3x2wi5EXg==", + "dev": true, + "engines": { + "node": ">=4.0.0" + } + }, "node_modules/check-error": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.3.tgz", @@ -2004,6 +2556,43 @@ "node": "*" } }, + "node_modules/cli-progress": { + "version": "3.12.0", + "resolved": "https://registry.npmjs.org/cli-progress/-/cli-progress-3.12.0.tgz", + "integrity": "sha512-tRkV3HJ1ASwm19THiiLIXLO7Im7wlTuKnvkYaTkyoAPefqjNg7W7DHKUlGRxy9vxDvbyCYQkQozvptuMkGCg8A==", + "dev": true, + "dependencies": { + "string-width": "^4.2.3" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/cli-table3": { + "version": "0.6.5", + "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.5.tgz", + "integrity": "sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ==", + "dev": true, + "dependencies": { + "string-width": "^4.2.0" + }, + "engines": { + "node": "10.* || >= 12.*" + }, + "optionalDependencies": { + "@colors/colors": "1.5.0" + } + }, + "node_modules/cli-table3/node_modules/@colors/colors": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", + "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", + "dev": true, + "optional": true, + "engines": { + "node": ">=0.1.90" + } + }, "node_modules/cliui": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz", @@ -2015,6 +2604,16 @@ "wrap-ansi": "^6.2.0" } }, + "node_modules/color": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/color/-/color-3.2.1.tgz", + "integrity": "sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==", + "dev": true, + "dependencies": { + "color-convert": "^1.9.3", + "color-string": "^1.6.0" + } + }, "node_modules/color-convert": { "version": "1.9.3", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", @@ -2030,6 +2629,35 @@ "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", "dev": true }, + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "dev": true, + "dependencies": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } + }, + "node_modules/colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/colorspace": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/colorspace/-/colorspace-1.1.4.tgz", + "integrity": "sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w==", + "dev": true, + "dependencies": { + "color": "^3.1.3", + "text-hex": "1.0.x" + } + }, "node_modules/combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -2042,6 +2670,15 @@ "node": ">= 0.8" } }, + "node_modules/commander": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz", + "integrity": "sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==", + "dev": true, + "engines": { + "node": ">=16" + } + }, "node_modules/commonmark": { "version": "0.29.3", "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.29.3.tgz", @@ -2072,6 +2709,12 @@ "integrity": "sha512-uJcB/FKZtBMCJpK8MQji6bJHgu1tixKPxRLeGkNzBoOZzpnZUJm0jm2/sBDWcuBx1dYgxV4JU+g5hmNxCyAmdA==", "dev": true }, + "node_modules/core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha512-3lqz5YjWTYnW6dlDa5TLaTCcShfar1e40rmcJVwCBJC6mWlFuj0eCHIElmG1g5kyuJ/GD+8Wn4FFCcz4gJPfaQ==", + "dev": true + }, "node_modules/cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", @@ -2086,6 +2729,24 @@ "node": ">= 8" } }, + "node_modules/csv-parse": { + "version": "4.16.3", + "resolved": "https://registry.npmjs.org/csv-parse/-/csv-parse-4.16.3.tgz", + "integrity": "sha512-cO1I/zmz4w2dcKHVvpCr7JVRu8/FymG5OEpmvsZYlccYolPBLoVGKUHgNoc4ZGkFeFlWGEDmMyBM+TTqRdW/wg==", + "dev": true + }, + "node_modules/dashdash": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", + "integrity": "sha512-jRFi8UDGo6j+odZiEpjazZaWqEal3w/basFjQHQEwVtZJGDpxbH1MeYluwCS8Xq5wmLJooDlMgvVarmWfGM44g==", + "dev": true, + "dependencies": { + "assert-plus": "^1.0.0" + }, + "engines": { + "node": ">=0.10" + } + }, "node_modules/data-uri-to-buffer": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz", @@ -2095,6 +2756,15 @@ "node": ">= 12" } }, + "node_modules/date-format": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/date-format/-/date-format-4.0.3.tgz", + "integrity": "sha512-7P3FyqDcfeznLZp2b+OMitV9Sz2lUnsT87WaTat9nVwqsBkTzPG3lPLNwW3en6F4pHUiWzr6vb8CLhjdK9bcxQ==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, "node_modules/debug": { "version": "4.3.4", "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", @@ -2133,6 +2803,16 @@ "node": ">=6" } }, + "node_modules/deepdash": { + "version": "5.3.9", + "resolved": "https://registry.npmjs.org/deepdash/-/deepdash-5.3.9.tgz", + "integrity": "sha512-GRzJ0q9PDj2T+J2fX+b+TlUa2NlZ11l6vJ8LHNKVGeZ8CfxCuJaCychTq07iDRTvlfO8435jlvVS1QXBrW9kMg==", + "dev": true, + "dependencies": { + "lodash": "^4.17.21", + "lodash-es": "^4.17.21" + } + }, "node_modules/delayed-stream": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", @@ -2142,6 +2822,16 @@ "node": ">=0.4.0" } }, + "node_modules/des.js": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/des.js/-/des.js-1.1.0.tgz", + "integrity": "sha512-r17GxjhUCjSRy8aiJpr8/UadFIzMzJGexI3Nmz4ADi9LYSFx4gTBp80+NaX/YsXWWLhpZ7v/v/ubEc/bCNfKwg==", + "dev": true, + "dependencies": { + "inherits": "^2.0.1", + "minimalistic-assert": "^1.0.0" + } + }, "node_modules/diff-sequences": { "version": "29.6.3", "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.6.3.tgz", @@ -2151,12 +2841,40 @@ "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, + "node_modules/difflib": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/difflib/-/difflib-0.2.4.tgz", + "integrity": "sha512-9YVwmMb0wQHQNr5J9m6BSj6fk4pfGITGQOOs+D9Fl+INODWFOfvhIU1hNv6GgR1RBoC/9NJcwu77zShxV0kT7w==", + "dev": true, + "dependencies": { + "heap": ">= 0.2.0" + }, + "engines": { + "node": "*" + } + }, + "node_modules/ecc-jsbn": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", + "integrity": "sha512-eh9O+hwRHNbG4BLTjEl3nw044CkGm5X6LoaCf7LPp7UU8Qrt47JYNi6nPX8xjW97TKGKm1ouctg0QSpZe9qrnw==", + "dev": true, + "dependencies": { + "jsbn": "~0.1.0", + "safer-buffer": "^2.1.0" + } + }, "node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", "dev": true }, + "node_modules/enabled": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz", + "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ==", + "dev": true + }, "node_modules/entities": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", @@ -2241,6 +2959,15 @@ "@types/estree": "^1.0.0" } }, + "node_modules/event-target-shim": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/event-target-shim/-/event-target-shim-5.0.1.tgz", + "integrity": "sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/execa": { "version": "8.0.1", "resolved": "https://registry.npmjs.org/execa/-/execa-8.0.1.tgz", @@ -2264,6 +2991,21 @@ "url": "https://github.com/sindresorhus/execa?sponsor=1" } }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "dev": true + }, + "node_modules/extsprintf": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", + "integrity": "sha512-11Ndz7Nv+mvAC1j0ktTa7fAb0vLyGGX+rMHNBYQviQDGU0Hw7lhctJANqbPhu9nV9/izT/IntTgZ7Im/9LJs9g==", + "dev": true, + "engines": [ + "node >=0.6.0" + ] + }, "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", @@ -2286,6 +3028,12 @@ "node": ">=8.6.0" } }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true + }, "node_modules/fastq": { "version": "1.17.1", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", @@ -2295,6 +3043,12 @@ "reusify": "^1.0.4" } }, + "node_modules/fecha": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/fecha/-/fecha-4.2.3.tgz", + "integrity": "sha512-OP2IUU6HeYKJi3i0z4A19kHMQoLVs4Hc+DPqqxI2h/DPZHTm/vjsfC6P0b4jCMy14XizLBqvndQ+UilD7707Jw==", + "dev": true + }, "node_modules/fetch-blob": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz", @@ -2318,6 +3072,24 @@ "node": "^12.20 || >= 14.13" } }, + "node_modules/file-type": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/file-type/-/file-type-3.9.0.tgz", + "integrity": "sha512-RLoqTXE8/vPmMuTI88DAzhMYC99I8BWv7zYP4A1puo5HIjEJ5EX48ighy4ZyKMG9EDXxBgW6e++cn7d1xuFghA==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/filesize": { + "version": "10.1.2", + "resolved": "https://registry.npmjs.org/filesize/-/filesize-10.1.2.tgz", + "integrity": "sha512-Dx770ai81ohflojxhU+oG+Z2QGvKdYxgEr9OSA8UVrqhwNHjfH9A8f5NKfg83fEH8ZFA5N5llJo5T3PIoZ4CRA==", + "dev": true, + "engines": { + "node": ">= 10.4.0" + } + }, "node_modules/fill-range": { "version": "7.1.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", @@ -2343,6 +3115,33 @@ "node": ">=8" } }, + "node_modules/flatted": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.6.tgz", + "integrity": "sha512-0sQoMh9s0BYsm+12Huy/rkKxVu4R1+r96YX5cG44rHV0pQ6iC3Q+mkoMFaGWObMFYQxCVT+ssG1ksneA2MI9KQ==", + "dev": true + }, + "node_modules/fn.name": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/fn.name/-/fn.name-1.1.0.tgz", + "integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw==", + "dev": true + }, + "node_modules/foreach": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.6.tgz", + "integrity": "sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg==", + "dev": true + }, + "node_modules/forever-agent": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", + "integrity": "sha512-j0KLYPhm6zeac4lz3oJ3o65qvgQCcPubiyotZrXqEaG4hNagNYO8qdlUrX5vwqv9ohqeT/Z3j6+yW067yWWdUw==", + "dev": true, + "engines": { + "node": "*" + } + }, "node_modules/form-data": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz", @@ -2378,6 +3177,20 @@ "js-yaml": "^3.13.1" } }, + "node_modules/fs-extra": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz", + "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=12" + } + }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -2428,6 +3241,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/getpass": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", + "integrity": "sha512-0fzj9JxOLfJ+XGLhR8ze3unN0KZCgZwiSSDz168VERjK8Wl8kVSdcu2kspd4s4wtAa1y/qrVRiAA0WclVsu0ng==", + "dev": true, + "dependencies": { + "assert-plus": "^1.0.0" + } + }, "node_modules/glob": { "version": "7.2.3", "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", @@ -2480,12 +3302,84 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true + }, "node_modules/growly": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/growly/-/growly-1.3.0.tgz", "integrity": "sha512-+xGQY0YyAWCnqy7Cd++hc2JqMYzlm0dG30Jd0beaA64sROr8C4nt8Yc9V5Ro3avlSUDTN0ulqP/VBKi1/lLygw==", "dev": true }, + "node_modules/handlebars": { + "version": "4.7.8", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz", + "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==", + "dev": true, + "dependencies": { + "minimist": "^1.2.5", + "neo-async": "^2.6.2", + "source-map": "^0.6.1", + "wordwrap": "^1.0.0" + }, + "bin": { + "handlebars": "bin/handlebars" + }, + "engines": { + "node": ">=0.4.7" + }, + "optionalDependencies": { + "uglify-js": "^3.1.4" + } + }, + "node_modules/har-schema": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", + "integrity": "sha512-Oqluz6zhGX8cyRaTQlFMPw80bSJVG2x/cFb8ZPhUILGgHka9SsokCCOQgpveePerqidZOrT14ipqfJb7ILcW5Q==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/har-validator": { + "version": "5.1.5", + "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.1.5.tgz", + "integrity": "sha512-nmT2T0lljbxdQZfspsno9hgrG3Uir6Ks5afism62poxqBM6sDnMEuPmzTq8XN0OEwqKLLdh1jQI3qyE66Nzb3w==", + "deprecated": "this library is no longer supported", + "dev": true, + "dependencies": { + "ajv": "^6.12.3", + "har-schema": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/har-validator/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/har-validator/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, "node_modules/has-flag": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", @@ -2495,23 +3389,101 @@ "node": ">=4" } }, + "node_modules/heap": { + "version": "0.2.7", + "resolved": "https://registry.npmjs.org/heap/-/heap-0.2.7.tgz", + "integrity": "sha512-2bsegYkkHO+h/9MGbn6KWcE45cHZgPANo5LXF7EvWdT0yT2EguSVO1nDgU5c8+ZOPwp2vMNa7YFsJhVcDR9Sdg==", + "dev": true + }, "node_modules/html-escaper": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", "dev": true }, - "node_modules/human-signals": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz", - "integrity": "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==", + "node_modules/http-reasons": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/http-reasons/-/http-reasons-0.1.0.tgz", + "integrity": "sha512-P6kYh0lKZ+y29T2Gqz+RlC9WBLhKe8kDmcJ+A+611jFfxdPsbMRQ5aNmFRM3lENqFkK+HTTL+tlQviAiv0AbLQ==", + "dev": true + }, + "node_modules/http-signature": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.3.6.tgz", + "integrity": "sha512-3adrsD6zqo4GsTqtO7FyrejHNv+NgiIfAfv68+jVlFmSr9OGy7zrxONceFRLKvnnZA5jbxQBX1u9PpB6Wi32Gw==", "dev": true, + "dependencies": { + "assert-plus": "^1.0.0", + "jsprim": "^2.0.2", + "sshpk": "^1.14.1" + }, "engines": { - "node": ">=16.17.0" + "node": ">=0.10" } }, - "node_modules/ignore": { - "version": "5.3.1", + "node_modules/httpntlm": { + "version": "1.8.13", + "resolved": "https://registry.npmjs.org/httpntlm/-/httpntlm-1.8.13.tgz", + "integrity": "sha512-2F2FDPiWT4rewPzNMg3uPhNkP3NExENlUGADRUDPQvuftuUTGW98nLZtGemCIW3G40VhWZYgkIDcQFAwZ3mf2Q==", + "dev": true, + "funding": [ + { + "type": "paypal", + "url": "https://www.paypal.com/donate/?hosted_button_id=2CKNJLZJBW8ZC" + }, + { + "type": "buymeacoffee", + "url": "https://www.buymeacoffee.com/samdecrock" + } + ], + "dependencies": { + "des.js": "^1.0.1", + "httpreq": ">=0.4.22", + "js-md4": "^0.3.2", + "underscore": "~1.12.1" + }, + "engines": { + "node": ">=10.4.0" + } + }, + "node_modules/httpreq": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/httpreq/-/httpreq-1.1.1.tgz", + "integrity": "sha512-uhSZLPPD2VXXOSN8Cni3kIsoFHaU2pT/nySEU/fHr/ePbqHYr0jeiQRmUKLEirC09SFPsdMoA7LU7UXMd/w0Kw==", + "dev": true, + "engines": { + "node": ">= 6.15.1" + } + }, + "node_modules/human-signals": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz", + "integrity": "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==", + "dev": true, + "engines": { + "node": ">=16.17.0" + } + }, + "node_modules/humanize-duration": { + "version": "3.32.1", + "resolved": "https://registry.npmjs.org/humanize-duration/-/humanize-duration-3.32.1.tgz", + "integrity": "sha512-inh5wue5XdfObhu/IGEMiA1nUXigSGcaKNemcbLRKa7jXYGDZXr3LoT9pTIzq2hPEbld7w/qv9h+ikWGz8fL1g==", + "dev": true + }, + "node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "dev": true, + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/ignore": { + "version": "5.3.1", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", "dev": true, @@ -2535,6 +3507,18 @@ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", "dev": true }, + "node_modules/inversify": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/inversify/-/inversify-5.1.1.tgz", + "integrity": "sha512-j8grHGDzv1v+8T1sAQ+3boTCntFPfvxLCkNcxB1J8qA0lUN+fAlSyYd+RXKvaPRL4AGyPxViutBEJHNXOyUdFQ==", + "dev": true + }, + "node_modules/is-arrayish": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz", + "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==", + "dev": true + }, "node_modules/is-docker": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", @@ -2601,6 +3585,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", + "dev": true + }, "node_modules/is-wsl": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz", @@ -2619,6 +3609,12 @@ "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", "dev": true }, + "node_modules/isstream": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", + "integrity": "sha512-Yljz7ffyPbrLpLngrMtZ7NduUgVvi6wG9RJ9IUcyCd59YQ911PBJphODUcbOVbqYfxe1wuYf/LJ8PauMRwsM/g==", + "dev": true + }, "node_modules/istanbul-lib-coverage": { "version": "3.2.2", "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz", @@ -2690,6 +3686,27 @@ "node": ">=8" } }, + "node_modules/jose": { + "version": "4.14.4", + "resolved": "https://registry.npmjs.org/jose/-/jose-4.14.4.tgz", + "integrity": "sha512-j8GhLiKmUAh+dsFXlX1aJCbt5KMibuKb+d7j1JaOJG6s2UjX1PQlW+OKB/sD4a/5ZYF4RcmYmLSndOoU3Lt/3g==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/panva" + } + }, + "node_modules/js-md4": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/js-md4/-/js-md4-0.3.2.tgz", + "integrity": "sha512-/GDnfQYsltsjRswQhN9fhv3EMw2sCpUdrdxyWDOUK7eyD++r3gRhzgiQgc/x4MAv2i1iuQ4lxO5mvqM3vj4bwA==", + "dev": true + }, + "node_modules/js-sha512": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/js-sha512/-/js-sha512-0.9.0.tgz", + "integrity": "sha512-mirki9WS/SUahm+1TbAPkqvbCiCfOAAsyXeHxK1UkullnJVVqoJG2pL9ObvT05CN+tM7fxhfYm0NbXn+1hWoZg==", + "dev": true + }, "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -2709,12 +3726,60 @@ "js-yaml": "bin/js-yaml.js" } }, + "node_modules/jsbn": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", + "integrity": "sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg==", + "dev": true + }, + "node_modules/json-merge-patch": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json-merge-patch/-/json-merge-patch-1.0.2.tgz", + "integrity": "sha512-M6Vp2GN9L7cfuMXiWOmHj9bEFbeC250iVtcKQbqVgEsDVYnIsrNsbU+h/Y/PkbBQCtEa4Bez+Ebv0zfbC8ObLg==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.3" + } + }, + "node_modules/json-pointer": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.2.tgz", + "integrity": "sha512-vLWcKbOaXlO+jvRy4qNd+TI1QUPZzfJj1tpJ3vAXDych5XJf93ftpUKe5pKCrzyIIwgBJcOcCVRUfqQP25afBw==", + "dev": true, + "dependencies": { + "foreach": "^2.0.4" + } + }, + "node_modules/json-schema": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.4.0.tgz", + "integrity": "sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA==", + "dev": true + }, "node_modules/json-schema-traverse": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", "dev": true }, + "node_modules/json-stringify-safe": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", + "integrity": "sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA==", + "dev": true + }, + "node_modules/jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dev": true, + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, "node_modules/jsonpath-plus": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-6.0.1.tgz", @@ -2724,6 +3789,60 @@ "node": ">=10.0.0" } }, + "node_modules/jsprim": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-2.0.2.tgz", + "integrity": "sha512-gqXddjPqQ6G40VdnI6T6yObEC+pDNvyP95wdQhkWkg7crHH3km5qP1FsOXEkzEQwnz6gz5qGTn1c2Y52wP3OyQ==", + "dev": true, + "engines": [ + "node >=0.6.0" + ], + "dependencies": { + "assert-plus": "1.0.0", + "extsprintf": "1.3.0", + "json-schema": "0.4.0", + "verror": "1.10.0" + } + }, + "node_modules/junit-report-builder": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/junit-report-builder/-/junit-report-builder-3.2.1.tgz", + "integrity": "sha512-IMCp5XyDQ4YESDE4Za7im3buM0/7cMnRfe17k2X8B05FnUl9vqnaliX6cgOEmPIeWKfJrEe/gANRq/XgqttCqQ==", + "dev": true, + "dependencies": { + "date-format": "4.0.3", + "lodash": "^4.17.21", + "make-dir": "^3.1.0", + "xmlbuilder": "^15.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/junit-report-builder/node_modules/make-dir": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", + "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", + "dev": true, + "dependencies": { + "semver": "^6.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/junit-report-builder/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, "node_modules/kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -2733,6 +3852,21 @@ "node": ">=6" } }, + "node_modules/kuler": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/kuler/-/kuler-2.0.0.tgz", + "integrity": "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A==", + "dev": true + }, + "node_modules/liquid-json": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/liquid-json/-/liquid-json-0.3.1.tgz", + "integrity": "sha512-wUayTU8MS827Dam6MxgD72Ui+KOSF+u/eIqpatOtjnvgJ0+mnDq33uC2M7J0tPK+upe/DpUAuK4JUU89iBoNKQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, "node_modules/local-pkg": { "version": "0.5.0", "resolved": "https://registry.npmjs.org/local-pkg/-/local-pkg-0.5.0.tgz", @@ -2761,6 +3895,47 @@ "node": ">=8" } }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, + "node_modules/lodash-es": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.21.tgz", + "integrity": "sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw==", + "dev": true + }, + "node_modules/lodash.get": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", + "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==", + "dev": true + }, + "node_modules/lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==", + "dev": true + }, + "node_modules/logform": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/logform/-/logform-2.6.0.tgz", + "integrity": "sha512-1ulHeNPp6k/LD8H91o7VYFBng5i1BDE7HoKxVbZiGFidS1Rj65qcywLxX+pVfAPoQJEjRdvKcusKwOupHCVOVQ==", + "dev": true, + "dependencies": { + "@colors/colors": "1.6.0", + "@types/triple-beam": "^1.3.2", + "fecha": "^4.2.0", + "ms": "^2.1.1", + "safe-stable-stringify": "^2.3.1", + "triple-beam": "^1.3.0" + }, + "engines": { + "node": ">= 12.0.0" + } + }, "node_modules/loupe": { "version": "2.3.7", "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.7.tgz", @@ -2770,6 +3945,18 @@ "get-func-name": "^2.0.1" } }, + "node_modules/lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/magic-string": { "version": "0.30.10", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.10.tgz", @@ -2805,6 +3992,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/md5-file": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/md5-file/-/md5-file-5.0.0.tgz", + "integrity": "sha512-xbEFXCYVWrSx/gEKS1VPlg84h/4L20znVIulKw6kMfmBUAZNAnF00eczz9ICMl+/hjQGo5KSXRxbL/47X3rmMw==", + "dev": true, + "bin": { + "md5-file": "cli.js" + }, + "engines": { + "node": ">=10.13.0" + } + }, "node_modules/mdurl": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", @@ -2848,6 +4047,15 @@ "node": ">= 0.6" } }, + "node_modules/mime-format": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mime-format/-/mime-format-2.0.1.tgz", + "integrity": "sha512-XxU3ngPbEnrYnNbIX+lYSaYg0M01v6p2ntd2YaFksTu0vayaw5OJvbdRyWs07EYRlLED5qadUZ+xo+XhOvFhwg==", + "dev": true, + "dependencies": { + "charset": "^1.0.0" + } + }, "node_modules/mime-types": { "version": "2.1.35", "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", @@ -2872,6 +4080,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/minimalistic-assert": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz", + "integrity": "sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==", + "dev": true + }, "node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", @@ -2893,6 +4107,18 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "dev": true, + "bin": { + "mkdirp": "bin/cmd.js" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/mlly": { "version": "1.7.0", "resolved": "https://registry.npmjs.org/mlly/-/mlly-1.7.0.tgz", @@ -2905,6 +4131,15 @@ "ufo": "^1.5.3" } }, + "node_modules/moment": { + "version": "2.30.1", + "resolved": "https://registry.npmjs.org/moment/-/moment-2.30.1.tgz", + "integrity": "sha512-uEmtNhbDOrWPFS+hdjFCBfy9f2YoyzRpwcl+DqpC6taX21FzsTLQVbMV/W7PzNSX6x/bhC1zA3c2UQ5NzH6how==", + "dev": true, + "engines": { + "node": "*" + } + }, "node_modules/ms": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", @@ -2938,6 +4173,62 @@ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" } }, + "node_modules/neo-async": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", + "dev": true + }, + "node_modules/newman": { + "version": "6.1.3", + "resolved": "https://registry.npmjs.org/newman/-/newman-6.1.3.tgz", + "integrity": "sha512-Zv+BjkJsYwSwc4oE3o40W6enBZRS7a7OL3aB8c4e46tDvg4HCOh6EhsmQmYhSMmlYF2JBieYiqS7XUwWkY6PiQ==", + "dev": true, + "dependencies": { + "@postman/tough-cookie": "4.1.3-postman.1", + "async": "3.2.5", + "chardet": "2.0.0", + "cli-progress": "3.12.0", + "cli-table3": "0.6.5", + "colors": "1.4.0", + "commander": "11.1.0", + "csv-parse": "4.16.3", + "filesize": "10.1.2", + "liquid-json": "0.3.1", + "lodash": "4.17.21", + "mkdirp": "3.0.1", + "postman-collection": "4.4.0", + "postman-collection-transformer": "4.1.8", + "postman-request": "2.88.1-postman.33", + "postman-runtime": "7.39.0", + "pretty-ms": "7.0.1", + "semver": "7.6.2", + "serialised-error": "1.1.3", + "word-wrap": "1.2.5", + "xmlbuilder": "15.1.1" + }, + "bin": { + "newman": "bin/newman.js" + }, + "engines": { + "node": ">=16" + } + }, + "node_modules/newman/node_modules/mkdirp": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-3.0.1.tgz", + "integrity": "sha512-+NsyUUAZDmo6YVHzL/stxSu3t9YS1iljliy3BSDrXJ/dkn1KYdmtZODGGjLcc9XLgVVpH4KshHB8XmZgMhaBXg==", + "dev": true, + "bin": { + "mkdirp": "dist/cjs/src/bin.js" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/node-domexception": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz", @@ -2975,6 +4266,15 @@ "url": "https://opencollective.com/node-fetch" } }, + "node_modules/node-forge": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/node-forge/-/node-forge-1.3.1.tgz", + "integrity": "sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA==", + "dev": true, + "engines": { + "node": ">= 6.13.0" + } + }, "node_modules/node-notifier": { "version": "10.0.1", "resolved": "https://registry.npmjs.org/node-notifier/-/node-notifier-10.0.1.tgz", @@ -2989,6 +4289,12 @@ "which": "^2.0.2" } }, + "node_modules/node-oauth1": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/node-oauth1/-/node-oauth1-1.3.0.tgz", + "integrity": "sha512-0yggixNfrA1KcBwvh/Hy2xAS1Wfs9dcg6TdFf2zN7gilcAigMdrtZ4ybrBSXBgLvGDw9V1p2MRnGBMq7XjTWLg==", + "dev": true + }, "node_modules/node-object-hash": { "version": "1.4.2", "resolved": "https://registry.npmjs.org/node-object-hash/-/node-object-hash-1.4.2.tgz", @@ -3025,6 +4331,172 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/oauth-sign": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", + "integrity": "sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/oav": { + "version": "3.3.7", + "resolved": "https://registry.npmjs.org/oav/-/oav-3.3.7.tgz", + "integrity": "sha512-zwtLSCTCADo8AcjUc8YFLvCHiamAs1E2n/8QVSmX+FzdqI7TeNm98k8xyQX393cD4OW7VFY9BQ9vDpi1Ap/SKg==", + "dev": true, + "dependencies": { + "@apidevtools/swagger-parser": "10.0.3", + "@autorest/schemas": "^1.3.4", + "@azure-tools/openapi-tools-common": "^1.2.2", + "@azure/core-http": "^3.0.1", + "@azure/core-util": "~1.7.0", + "@azure/logger": "~1.0.4", + "@azure/ms-rest-js": "^2.7.0", + "@azure/openapi-markdown": "^0.9.4", + "@ts-common/commonmark-to-markdown": "^2.0.2", + "ajv": "^6.12.6", + "commonmark": "^0.29.3", + "deepdash": "^5.3.2", + "difflib": "^0.2.4", + "fast-json-stable-stringify": "^2.1.0", + "fs-extra": "^10.1.0", + "glob": "^7.2.3", + "humanize-duration": "^3.27.2", + "inversify": "^5.1.1", + "js-yaml": "^4.1.0", + "json-merge-patch": "^1.0.2", + "json-pointer": "^0.6.2", + "json-schema-traverse": "^0.4.1", + "jsonpath-plus": "^4.0.0", + "junit-report-builder": "^3.0.0", + "lodash": "^4.17.21", + "md5-file": "^5.0.0", + "mkdirp": "^1.0.4", + "moment": "^2.29.3", + "mustache": "^4.2.0", + "newman": "^6.0.0", + "path-to-regexp": "^6.2.1", + "postman-collection": "^4.1.7", + "reflect-metadata": "^0.1.13", + "toposort": "^2.0.2", + "uuid": "^3.4.0", + "winston": "^3.3.4", + "yargs": "^15.4.1", + "z-schema": "^5.0.3" + }, + "bin": { + "oav": "dist/cli.js" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/oav/node_modules/@azure/abort-controller": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", + "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", + "dev": true, + "dependencies": { + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/oav/node_modules/@azure/core-util": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.7.0.tgz", + "integrity": "sha512-Zq2i3QO6k9DA8vnm29mYM4G8IE9u1mhF1GUabVEqPNX8Lj833gdxQ2NAFxt2BZsfAL+e9cT8SyVN7dFVJ/Hf0g==", + "dev": true, + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "tslib": "^2.2.0" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/oav/node_modules/@azure/logger": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.0.4.tgz", + "integrity": "sha512-ustrPY8MryhloQj7OWGe+HrYx+aoiOxzbXTtgblbV3xwCqpzUK36phH3XNHQKj3EPonyFUuDTfR3qFhTEAuZEg==", + "dev": true, + "dependencies": { + "tslib": "^2.2.0" + }, + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/oav/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/oav/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/oav/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/oav/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/oav/node_modules/jsonpath-plus": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-4.0.0.tgz", + "integrity": "sha512-e0Jtg4KAzDJKKwzbLaUtinCn0RZseWBVRTRGihSpvFlM3wTR7ExSp+PTdeTsDrLNJUe7L7JYJe8mblHX5SCT6A==", + "dev": true, + "engines": { + "node": ">=10.0" + } + }, + "node_modules/oav/node_modules/uuid": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", + "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==", + "deprecated": "Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.", + "dev": true, + "bin": { + "uuid": "bin/uuid" + } + }, + "node_modules/object-hash": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-1.3.1.tgz", + "integrity": "sha512-OSuu/pU4ENM9kmREg0BdNrUDIl1heYa4mBZacJc+vVWz4GtAwu7jO8s4AIt2aGRUTqxykpWzI3Oqnsm13tTMDA==", + "dev": true, + "engines": { + "node": ">= 0.10.0" + } + }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -3034,6 +4506,15 @@ "wrappy": "1" } }, + "node_modules/one-time": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/one-time/-/one-time-1.0.0.tgz", + "integrity": "sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g==", + "dev": true, + "dependencies": { + "fn.name": "1.x.x" + } + }, "node_modules/onetime": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz", @@ -3049,6 +4530,13 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/openapi-types": { + "version": "12.1.3", + "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz", + "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==", + "dev": true, + "peer": true + }, "node_modules/p-limit": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", @@ -3085,6 +4573,15 @@ "node": ">=6" } }, + "node_modules/parse-ms": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/parse-ms/-/parse-ms-2.1.0.tgz", + "integrity": "sha512-kHt7kzLoS9VBZfUsiKjv43mr91ea+U05EyKkEtqp7vNbHxmaVuEqN7XxeEVnGrMtYOAxGrDElSi96K7EgO1zCA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/path-exists": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", @@ -3112,6 +4609,12 @@ "node": ">=8" } }, + "node_modules/path-to-regexp": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.2.2.tgz", + "integrity": "sha512-GQX3SSMokngb36+whdpRXE+3f9V8UzyAorlYvOGx87ufGHehNTn5lCxrKtLyZ4Yl/wEKnNnr98ZzOwwDZV5ogw==", + "dev": true + }, "node_modules/path-type": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/path-type/-/path-type-5.0.0.tgz", @@ -3139,6 +4642,12 @@ "node": "*" } }, + "node_modules/performance-now": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", + "integrity": "sha512-7EAHlyLHI56VEIdK57uwHdHKIaAGbnXPiw0yWbarQZOKaKpvUIgW0jWRVLiatnM+XXlSwsanIBH/hzGMJulMow==", + "dev": true + }, "node_modules/picocolors": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.1.tgz", @@ -3182,27 +4691,203 @@ "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz", "integrity": "sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==", "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/postcss" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "nanoid": "^3.3.7", + "picocolors": "^1.0.0", + "source-map-js": "^1.2.0" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/postman-collection": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/postman-collection/-/postman-collection-4.4.0.tgz", + "integrity": "sha512-2BGDFcUwlK08CqZFUlIC8kwRJueVzPjZnnokWPtJCd9f2J06HBQpGL7t2P1Ud1NEsK9NHq9wdipUhWLOPj5s/Q==", + "dev": true, + "dependencies": { + "@faker-js/faker": "5.5.3", + "file-type": "3.9.0", + "http-reasons": "0.1.0", + "iconv-lite": "0.6.3", + "liquid-json": "0.3.1", + "lodash": "4.17.21", + "mime-format": "2.0.1", + "mime-types": "2.1.35", + "postman-url-encoder": "3.0.5", + "semver": "7.5.4", + "uuid": "8.3.2" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/postman-collection-transformer": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/postman-collection-transformer/-/postman-collection-transformer-4.1.8.tgz", + "integrity": "sha512-smJ6X7Z7kbg6hp7JZPFixrSN3J3WkQed7DrWCC5tF7IxOMpFLqhtTtGssY8nD1inP8+mJf+N72Pf2ttUAHgBKw==", + "dev": true, + "dependencies": { + "commander": "8.3.0", + "inherits": "2.0.4", + "lodash": "4.17.21", + "semver": "7.5.4", + "strip-json-comments": "3.1.1" + }, + "bin": { + "postman-collection-transformer": "bin/transform-collection.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/postman-collection-transformer/node_modules/commander": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", + "integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==", + "dev": true, + "engines": { + "node": ">= 12" + } + }, + "node_modules/postman-collection-transformer/node_modules/semver": { + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/postman-collection/node_modules/semver": { + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/postman-request": { + "version": "2.88.1-postman.33", + "resolved": "https://registry.npmjs.org/postman-request/-/postman-request-2.88.1-postman.33.tgz", + "integrity": "sha512-uL9sCML4gPH6Z4hreDWbeinKU0p0Ke261nU7OvII95NU22HN6Dk7T/SaVPaj6T4TsQqGKIFw6/woLZnH7ugFNA==", + "dev": true, + "dependencies": { + "@postman/form-data": "~3.1.1", + "@postman/tough-cookie": "~4.1.3-postman.1", + "@postman/tunnel-agent": "^0.6.3", + "aws-sign2": "~0.7.0", + "aws4": "^1.12.0", + "brotli": "^1.3.3", + "caseless": "~0.12.0", + "combined-stream": "~1.0.6", + "extend": "~3.0.2", + "forever-agent": "~0.6.1", + "har-validator": "~5.1.3", + "http-signature": "~1.3.1", + "is-typedarray": "~1.0.0", + "isstream": "~0.1.2", + "json-stringify-safe": "~5.0.1", + "mime-types": "^2.1.35", + "oauth-sign": "~0.9.0", + "performance-now": "^2.1.0", + "qs": "~6.5.3", + "safe-buffer": "^5.1.2", + "stream-length": "^1.0.2", + "uuid": "^8.3.2" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/postman-runtime": { + "version": "7.39.0", + "resolved": "https://registry.npmjs.org/postman-runtime/-/postman-runtime-7.39.0.tgz", + "integrity": "sha512-FMfHHdbBlCB7hno8AHWEfVItVHk+/NaV3NeedVMNEtLnTeNTjKtDZ29LMmIikW4O+mmToh2l46qYH2iw72TtEQ==", + "dev": true, + "dependencies": { + "@postman/tough-cookie": "4.1.3-postman.1", + "async": "3.2.5", + "aws4": "1.12.0", + "handlebars": "4.7.8", + "httpntlm": "1.8.13", + "jose": "4.14.4", + "js-sha512": "0.9.0", + "lodash": "4.17.21", + "mime-types": "2.1.35", + "node-forge": "1.3.1", + "node-oauth1": "1.3.0", + "performance-now": "2.1.0", + "postman-collection": "4.4.0", + "postman-request": "2.88.1-postman.33", + "postman-sandbox": "4.7.1", + "postman-url-encoder": "3.0.5", + "serialised-error": "1.1.3", + "strip-json-comments": "3.1.1", + "uuid": "8.3.2" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/postman-runtime/node_modules/aws4": { + "version": "1.12.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.12.0.tgz", + "integrity": "sha512-NmWvPnx0F1SfrQbYwOi7OeaNGokp9XhzNioJ/CSBs8Qa4vxug81mhJEAVZwxXuBmYB5KDRfMq/F3RR0BIU7sWg==", + "dev": true + }, + "node_modules/postman-sandbox": { + "version": "4.7.1", + "resolved": "https://registry.npmjs.org/postman-sandbox/-/postman-sandbox-4.7.1.tgz", + "integrity": "sha512-H2wYSLK0mB588IaxoLrLoPbpmxsIcwFtgaK2c8gAsAQ+TgYFePwb4qdeVcYDMqmwrLd77/ViXkjasP/sBMz1sQ==", + "dev": true, + "dependencies": { + "lodash": "4.17.21", + "postman-collection": "4.4.0", + "teleport-javascript": "1.0.0", + "uvm": "2.1.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/postman-url-encoder": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/postman-url-encoder/-/postman-url-encoder-3.0.5.tgz", + "integrity": "sha512-jOrdVvzUXBC7C+9gkIkpDJ3HIxOHTIqjpQ4C1EMt1ZGeMvSEpbFCKq23DEfgsj46vMnDgyQf+1ZLp2Wm+bKSsA==", + "dev": true, "dependencies": { - "nanoid": "^3.3.7", - "picocolors": "^1.0.0", - "source-map-js": "^1.2.0" + "punycode": "^2.1.1" }, "engines": { - "node": "^10 || ^12 || >=14" + "node": ">=10" } }, "node_modules/prettier": { @@ -3246,6 +4931,30 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, + "node_modules/pretty-ms": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/pretty-ms/-/pretty-ms-7.0.1.tgz", + "integrity": "sha512-973driJZvxiGOQ5ONsFhOF/DtzPMOMtgC11kCpUrPGMTgqp2q/1gwzCquocrN33is0VZ5GFHXZYMM9l6h67v2Q==", + "dev": true, + "dependencies": { + "parse-ms": "^2.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/process": { + "version": "0.11.10", + "resolved": "https://registry.npmjs.org/process/-/process-0.11.10.tgz", + "integrity": "sha512-cdGef/drWFoydD1JsMzuFf8100nZl+GT+yacc2bEced5f9Rjk4z+WtFUTBu9PhOi9j/jfmBPu0mMEY4wIdAF8A==", + "dev": true, + "engines": { + "node": ">= 0.6.0" + } + }, "node_modules/prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", @@ -3259,6 +4968,12 @@ "node": ">= 6" } }, + "node_modules/psl": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.9.0.tgz", + "integrity": "sha512-E/ZsdU4HLs/68gYzgGTkMicWTLPdAftJLfJFlLUAAKZGkStNU72sZjT66SnMDVOfOWY/YAoiD7Jxa9iHvngcag==", + "dev": true + }, "node_modules/punycode": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", @@ -3268,6 +4983,21 @@ "node": ">=6" } }, + "node_modules/qs": { + "version": "6.5.3", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.3.tgz", + "integrity": "sha512-qxXIEh4pCGfHICj1mAJQ2/2XVZkjCDTcEgfoSQxc/fYivUZxTkk7L3bDBJSoNrEzXI17oUO5Dp07ktqE5KzczA==", + "dev": true, + "engines": { + "node": ">=0.6" + } + }, + "node_modules/querystringify": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/querystringify/-/querystringify-2.2.0.tgz", + "integrity": "sha512-FIqgj2EUvTa7R50u0rGsyTftzjYmv/a3hO345bZNrqabNqjtgiDMgmo4mkUjd+nzU5oF3dClKqFIPUKybUyqoQ==", + "dev": true + }, "node_modules/queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", @@ -3294,6 +5024,26 @@ "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==", "dev": true }, + "node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "dev": true, + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/reflect-metadata": { + "version": "0.1.14", + "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.1.14.tgz", + "integrity": "sha512-ZhYeb6nRaXCfhnndflDK8qI6ZQ/YcWZCISRAWICW9XYqMUwjZM9Z0DveWX/ABN01oxSHwVxKQmxeYZSsm0jh5A==", + "dev": true + }, "node_modules/require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -3318,6 +5068,12 @@ "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", "dev": true }, + "node_modules/requires-port": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", + "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", + "dev": true + }, "node_modules/retry": { "version": "0.13.1", "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz", @@ -3395,6 +5151,47 @@ "queue-microtask": "^1.2.2" } }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/safe-stable-stringify": { + "version": "2.4.3", + "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.4.3.tgz", + "integrity": "sha512-e2bDA2WJT0wxseVd4lsDP4+3ONX6HpMXQa1ZhFQ7SU+GjvORCmShbCMltrtIDfkYhVHrOcPtj+KhmDBdPdZD1g==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "dev": true + }, + "node_modules/sax": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.4.1.tgz", + "integrity": "sha512-+aWOz7yVScEGoKNd4PA10LZ8sk0A/z5+nXQG5giUO5rprX9jgYsTdov9qCchZiPIZezbZH+jRut8nPodFAX4Jg==", + "dev": true + }, "node_modules/semver": { "version": "7.6.2", "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", @@ -3407,6 +5204,27 @@ "node": ">=10" } }, + "node_modules/serialised-error": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/serialised-error/-/serialised-error-1.1.3.tgz", + "integrity": "sha512-vybp3GItaR1ZtO2nxZZo8eOo7fnVaNtP3XE2vJKgzkKR2bagCkdJ1EpYYhEMd3qu/80DwQk9KjsNSxE3fXWq0g==", + "dev": true, + "dependencies": { + "object-hash": "^1.1.2", + "stack-trace": "0.0.9", + "uuid": "^3.0.0" + } + }, + "node_modules/serialised-error/node_modules/uuid": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", + "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==", + "deprecated": "Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.", + "dev": true, + "bin": { + "uuid": "bin/uuid" + } + }, "node_modules/set-blocking": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", @@ -3473,6 +5291,15 @@ "url": "https://github.com/steveukx/git-js?sponsor=1" } }, + "node_modules/simple-swizzle": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz", + "integrity": "sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg==", + "dev": true, + "dependencies": { + "is-arrayish": "^0.3.1" + } + }, "node_modules/sisteransi": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", @@ -3491,6 +5318,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/source-map-js": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.0.tgz", @@ -3506,6 +5342,40 @@ "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", "dev": true }, + "node_modules/sshpk": { + "version": "1.18.0", + "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.18.0.tgz", + "integrity": "sha512-2p2KJZTSqQ/I3+HX42EpYOa2l3f8Erv8MWKsy2I9uf4wA7yFIkXRffYdsx86y6z4vHtV8u7g+pPlr8/4ouAxsQ==", + "dev": true, + "dependencies": { + "asn1": "~0.2.3", + "assert-plus": "^1.0.0", + "bcrypt-pbkdf": "^1.0.0", + "dashdash": "^1.12.0", + "ecc-jsbn": "~0.1.1", + "getpass": "^0.1.1", + "jsbn": "~0.1.0", + "safer-buffer": "^2.0.2", + "tweetnacl": "~0.14.0" + }, + "bin": { + "sshpk-conv": "bin/sshpk-conv", + "sshpk-sign": "bin/sshpk-sign", + "sshpk-verify": "bin/sshpk-verify" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stack-trace": { + "version": "0.0.9", + "resolved": "https://registry.npmjs.org/stack-trace/-/stack-trace-0.0.9.tgz", + "integrity": "sha512-vjUc6sfgtgY0dxCdnc40mK6Oftjo9+2K8H/NG81TMhgL392FtiPA9tn9RLyTxXmTLPJPjF3VyzFp6bsWFLisMQ==", + "dev": true, + "engines": { + "node": "*" + } + }, "node_modules/stackback": { "version": "0.0.2", "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", @@ -3518,6 +5388,24 @@ "integrity": "sha512-JPbdCEQLj1w5GilpiHAx3qJvFndqybBysA3qUOnznweH4QbNYUsW/ea8QzSrnh0vNsezMMw5bcVool8lM0gwzg==", "dev": true }, + "node_modules/stream-length": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/stream-length/-/stream-length-1.0.2.tgz", + "integrity": "sha512-aI+qKFiwoDV4rsXiS7WRoCt+v2RX1nUj17+KJC5r2gfh5xoSJIfP6Y3Do/HtvesFcTSWthIuJ3l1cvKQY/+nZg==", + "dev": true, + "dependencies": { + "bluebird": "^2.6.2" + } + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "dev": true, + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, "node_modules/string-width": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", @@ -3562,6 +5450,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/strip-literal": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-2.1.0.tgz", @@ -3596,6 +5496,12 @@ "resolved": "eng/tools/suppressions", "link": true }, + "node_modules/teleport-javascript": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/teleport-javascript/-/teleport-javascript-1.0.0.tgz", + "integrity": "sha512-j1llvWVFyEn/6XIFDfX5LAU43DXe0GCt3NfXDwJ8XpRRMkS+i50SAkonAONBy+vxwPFBd50MFU8a2uj8R/ccLg==", + "dev": true + }, "node_modules/test-exclude": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", @@ -3610,6 +5516,12 @@ "node": ">=8" } }, + "node_modules/text-hex": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/text-hex/-/text-hex-1.0.0.tgz", + "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==", + "dev": true + }, "node_modules/tinybench": { "version": "2.8.0", "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.8.0.tgz", @@ -3655,18 +5567,47 @@ "node": ">=8.0" } }, + "node_modules/toposort": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/toposort/-/toposort-2.0.2.tgz", + "integrity": "sha512-0a5EOkAUp8D4moMi2W8ZF8jcga7BgZd91O/yabJCFY8az+XSzeGyTKs0Aoo897iV1Nj6guFq8orWDS96z91oGg==", + "dev": true + }, "node_modules/tr46": { "version": "0.0.3", "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", "dev": true }, + "node_modules/triple-beam": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/triple-beam/-/triple-beam-1.4.1.tgz", + "integrity": "sha512-aZbgViZrg1QNcG+LULa7nhZpJTZSLm/mXnHXnbAbjmN5aSa0y7V+wvv6+4WaBtpISJzThKy+PIPxc1Nq1EJ9mg==", + "dev": true, + "engines": { + "node": ">= 14.0.0" + } + }, "node_modules/tslib": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz", "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==", + "dev": true + }, + "node_modules/tunnel": { + "version": "0.0.6", + "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz", + "integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==", "dev": true, - "peer": true + "engines": { + "node": ">=0.6.11 <=0.7.0 || >=0.7.3" + } + }, + "node_modules/tweetnacl": { + "version": "0.14.5", + "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", + "integrity": "sha512-KXXFFdAbFXY4geFIwoyNK+f5Z1b7swfXABfL7HXCmoIWMKU3dmS26672A4EeQtDzLKy7SXmfBu51JolvEKwtGA==", + "dev": true }, "node_modules/type-detect": { "version": "4.0.8", @@ -3696,6 +5637,25 @@ "integrity": "sha512-Y7HYmWaFwPUmkoQCUIAYpKqkOf+SbVj/2fJJZ4RJMCfZp0rTGwRbzQD+HghfnhKOjL9E01okqz+ncJskGYfBNw==", "dev": true }, + "node_modules/uglify-js": { + "version": "3.18.0", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.18.0.tgz", + "integrity": "sha512-SyVVbcNBCk0dzr9XL/R/ySrmYf0s372K6/hFklzgcp2lBFyXtw4I7BOdDjlLhE1aVqaI/SHWXWmYdlZxuyF38A==", + "dev": true, + "optional": true, + "bin": { + "uglifyjs": "bin/uglifyjs" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/underscore": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.1.tgz", + "integrity": "sha512-hEQt0+ZLDVUMhebKxL4x1BTtDY7bavVofhZ9KZ4aI26X9SRaE+Y3m83XUL1UP2jn8ynjndwCCpEHdUG+9pP1Tw==", + "dev": true + }, "node_modules/undici-types": { "version": "5.26.5", "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", @@ -3714,6 +5674,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "dev": true, + "engines": { + "node": ">= 10.0.0" + } + }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -3723,6 +5692,22 @@ "punycode": "^2.1.0" } }, + "node_modules/url-parse": { + "version": "1.5.10", + "resolved": "https://registry.npmjs.org/url-parse/-/url-parse-1.5.10.tgz", + "integrity": "sha512-WypcfiRhfeUP9vvF0j6rw0J3hrWrw6iZv3+22h6iRMJ/8z1Tj6XfLP4DsUix5MhMPnXpiHDoKyoZ/bdCkwBCiQ==", + "dev": true, + "dependencies": { + "querystringify": "^2.1.1", + "requires-port": "^1.0.0" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "dev": true + }, "node_modules/uuid": { "version": "8.3.2", "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", @@ -3732,6 +5717,41 @@ "uuid": "dist/bin/uuid" } }, + "node_modules/uvm": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/uvm/-/uvm-2.1.1.tgz", + "integrity": "sha512-BZ5w8adTpNNr+zczOBRpaX/hH8UPKAf7fmCnidrcsqt3bn8KT9bDIfuS7hgRU9RXgiN01su2pwysBONY6w8W5w==", + "dev": true, + "dependencies": { + "flatted": "3.2.6" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/validator": { + "version": "13.12.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.12.0.tgz", + "integrity": "sha512-c1Q0mCiPlgdTVVVIJIrBuxNicYE+t/7oKeI9MWLj3fh/uq2Pxh/3eeWbVZ4OcGW1TUf53At0njHw5SMdA3tmMg==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/verror": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", + "integrity": "sha512-ZZKSmDAEFOijERBLkmYfJ+vmk3w+7hOLYDNkRCuRuMJGEmqYNCNLyBBFwWKVMhfwaEF3WOd0Zlw86U/WC/+nYw==", + "dev": true, + "engines": [ + "node >=0.6.0" + ], + "dependencies": { + "assert-plus": "^1.0.0", + "core-util-is": "1.0.2", + "extsprintf": "^1.2.0" + } + }, "node_modules/vite-node": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-1.6.0.tgz", @@ -3925,6 +5945,69 @@ "node": ">=8" } }, + "node_modules/winston": { + "version": "3.13.0", + "resolved": "https://registry.npmjs.org/winston/-/winston-3.13.0.tgz", + "integrity": "sha512-rwidmA1w3SE4j0E5MuIufFhyJPBDG7Nu71RkZor1p2+qHvJSZ9GYDA81AyleQcZbh/+V6HjeBdfnTZJm9rSeQQ==", + "dev": true, + "dependencies": { + "@colors/colors": "^1.6.0", + "@dabh/diagnostics": "^2.0.2", + "async": "^3.2.3", + "is-stream": "^2.0.0", + "logform": "^2.4.0", + "one-time": "^1.0.0", + "readable-stream": "^3.4.0", + "safe-stable-stringify": "^2.3.1", + "stack-trace": "0.0.x", + "triple-beam": "^1.3.0", + "winston-transport": "^4.7.0" + }, + "engines": { + "node": ">= 12.0.0" + } + }, + "node_modules/winston-transport": { + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.7.0.tgz", + "integrity": "sha512-ajBj65K5I7denzer2IYW6+2bNIVqLGDHqDw3Ow8Ohh+vdW+rv4MZ6eiDvHoKhfJFZ2auyN8byXieDDJ96ViONg==", + "dev": true, + "dependencies": { + "logform": "^2.3.2", + "readable-stream": "^3.6.0", + "triple-beam": "^1.3.0" + }, + "engines": { + "node": ">= 12.0.0" + } + }, + "node_modules/winston/node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/word-wrap": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", + "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", + "dev": true + }, "node_modules/wrap-ansi": { "version": "6.2.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", @@ -3978,12 +6061,49 @@ "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", "dev": true }, + "node_modules/xml2js": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.5.0.tgz", + "integrity": "sha512-drPFnkQJik/O+uPKpqSgr22mpuFHqKdbS835iAQrUC73L2F5WkboIRd63ai/2Yg6I1jzifPFKH2NTK+cfglkIA==", + "dev": true, + "dependencies": { + "sax": ">=0.6.0", + "xmlbuilder": "~11.0.0" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/xml2js/node_modules/xmlbuilder": { + "version": "11.0.1", + "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-11.0.1.tgz", + "integrity": "sha512-fDlsI/kFEx7gLvbecc0/ohLG50fugQp8ryHzMTuW9vSa1GJ0XYWKnhsUx7oie3G98+r56aTQIUB4kht42R3JvA==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/xmlbuilder": { + "version": "15.1.1", + "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-15.1.1.tgz", + "integrity": "sha512-yMqGBqtXyeN1e3TGYvgNgDVZ3j84W4cwkOXQswghol6APgZWaff9lnbvN7MHYJOiXsvGPXtjTYJEiC9J2wv9Eg==", + "dev": true, + "engines": { + "node": ">=8.0" + } + }, "node_modules/y18n": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", "dev": true }, + "node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, "node_modules/yaml": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.2.tgz", @@ -4043,6 +6163,36 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/z-schema": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz", + "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==", + "dev": true, + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^9.4.1" + } + }, + "node_modules/z-schema/node_modules/commander": { + "version": "9.5.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz", + "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==", + "dev": true, + "optional": true, + "engines": { + "node": "^12.20.0 || >=14" + } + }, "node_modules/zod": { "version": "3.23.8", "resolved": "https://registry.npmjs.org/zod/-/zod-3.23.8.tgz", diff --git a/package.json b/package.json index 117036efce61..9ccc0baed0a3 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "@typespec/rest": "0.56.0", "@typespec/versioning": "0.56.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", + "oav": "^3.3.7", "prettier": "~3.2.5", "typescript": "~5.4.5" }, From a8c212bc18177ac4891ec93aa7b4c5c834c156e4 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 12 Jun 2024 14:07:56 -0700 Subject: [PATCH 164/343] [ci-fix] Add docs for two common LintDiff errors in TypeSpec specs (#29416) --- documentation/ci-fix.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 19069d1d9c5a..dc37b413d2bb 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -35,6 +35,8 @@ If you need help with your specs PR, please first thoroughly read the [aka.ms/az - [`AvoidAnonymousParameter`, `AvoidAnonymousTypes`, `IntegerTypeMustHaveFormat`](#avoidanonymousparameter-avoidanonymoustypes-integertypemusthaveformat) - [`AvoidAnonymousTypes` inside a 202 response](#avoidanonymoustypes-inside-a-202-response) - [`OAuth2Auth` causes `XmsEnumValidation`](#oauth2auth-causes-xmsenumvalidation) + - [`ProvisioningStateMustBeReadOnly`](#provisioningstatemustbereadonly) + - [`PatchBodyParameterSchema`](#patchbodyparameterschema) - [`Swagger ModelValidation`](#swagger-modelvalidation) - [`Swagger PrettierCheck`](#swagger-prettiercheck) - [Prettier reference](#prettier-reference) @@ -236,6 +238,23 @@ TypeSpec using `OAuth2Auth` may generate the following OpenAPI: Which causes error `XmsEnumValidation`. The recommended workaround is to add `omit-unreachable-types: true` to your `tspconfig.yaml`. +### `ProvisioningStateMustBeReadOnly` + +The root cause is bugs in `azure-openapi-validator` and `oav`: + +https://github.com/Azure/azure-openapi-validator/issues/637 +https://github.com/Azure/oav/issues/848 + +The recommended workaround is to add `use-read-only-status-schema: true` to your `tspconfig.yaml`. + +### `PatchBodyParameterSchema` + +The root cause is a bug in typespec-azure: + +https://github.com/Azure/typespec-azure/issues/383. + +Please see the issue above for the suggested workaround and apply it directly to the spec TypeSpec sources. The LintDiff error should **not** be ignored or suppressed. + ## `Swagger ModelValidation` To repro issues with `Swagger ModelValidation` locally: From 3dbffd014194b1985f6498b259fe8d91461c898c Mon Sep 17 00:00:00 2001 From: Driele Neves Ribeiro Date: Wed, 12 Jun 2024 18:07:40 -0700 Subject: [PATCH 165/343] [DevCenter]Add JS api-version (#29423) --- specification/devcenter/DevCenter/tspconfig.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/devcenter/DevCenter/tspconfig.yaml b/specification/devcenter/DevCenter/tspconfig.yaml index c30cb2134bc5..4036f7c677b4 100644 --- a/specification/devcenter/DevCenter/tspconfig.yaml +++ b/specification/devcenter/DevCenter/tspconfig.yaml @@ -33,6 +33,7 @@ options: description: "Azure Developer DevCenter Client" version: "1.0.0" flavor: azure + api-version: "2023-04-01" "@azure-tools/typespec-java": package-dir: "azure-developer-devcenter" namespace: com.azure.developer.devcenter From ed23c08d96df19aa31784e8a33253f3e35e09410 Mon Sep 17 00:00:00 2001 From: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Date: Thu, 13 Jun 2024 10:02:46 +0800 Subject: [PATCH 166/343] Security enhancement feature snowflake support storage integration (#29240) * new feature for snowflake support storage integration * fix prettier: --- .../stable/2018-06-01/entityTypes/Pipeline.json | 10 ++++++++++ .../2019-06-01-preview/entityTypes/Pipeline.json | 8 ++++++++ 2 files changed, 18 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 3914b9560d42..3a38134eb663 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -4389,6 +4389,11 @@ "additionalProperties": { "type": "object" } + }, + "storageIntegration": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string)." } } }, @@ -5349,6 +5354,11 @@ "additionalProperties": { "type": "object" } + }, + "storageIntegration": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string)." } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json index f0e44055c63d..aca3e64bcba8 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json @@ -3643,6 +3643,10 @@ "additionalProperties": { "type": "object" } + }, + "storageIntegration": { + "type": "object", + "description": "The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string)." } } }, @@ -4312,6 +4316,10 @@ "additionalProperties": { "type": "object" } + }, + "storageIntegration": { + "type": "object", + "description": "The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string)." } } }, From 412364b282e52b50eadc3cd88d56d283b6c8712a Mon Sep 17 00:00:00 2001 From: Cale Carter <44513609+calecarter@users.noreply.github.com> Date: Wed, 12 Jun 2024 20:54:26 -0700 Subject: [PATCH 167/343] Fix missing property in existing APIs (#29383) * Fix missing property in existing APIs * Fixing missing property caught by the linter --------- Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> --- .../examples/createOrUpdatePolicySetDefinition.json | 2 ++ ...OrUpdatePolicySetDefinitionAtManagementGroup.json | 4 ++++ .../createOrUpdatePolicySetDefinitionVersion.json | 4 ++++ ...ePolicySetDefinitionVersionAtManagementGroup.json | 4 ++++ .../createOrUpdatePolicySetDefinitionWithGroups.json | 6 ++++++ ...licySetDefinitionWithGroupsAtManagementGroup.json | 4 ++++ .../2023-04-01/examples/createPolicyAssignment.json | 1 + .../examples/createPolicyAssignmentById.json | 2 ++ .../createPolicyAssignmentNonComplianceMessages.json | 1 + .../examples/createPolicyAssignmentWithIdentity.json | 1 + .../createPolicyAssignmentWithIdentityById.json | 2 ++ .../createPolicyAssignmentWithOverrides.json | 1 + .../createPolicyAssignmentWithResourceSelectors.json | 1 + ...eatePolicyAssignmentWithUserAssignedIdentity.json | 1 + .../createPolicyAssignmentWithoutEnforcement.json | 1 + .../2023-04-01/examples/deletePolicyAssignment.json | 1 + .../examples/deletePolicyAssignmentById.json | 1 + .../examples/getBuiltInPolicySetDefinition.json | 10 ++++++++++ .../getBuiltInPolicySetDefinitionVersion.json | 10 ++++++++++ .../2023-04-01/examples/getPolicyAssignment.json | 1 + .../2023-04-01/examples/getPolicyAssignmentById.json | 1 + .../examples/getPolicyAssignmentWithIdentity.json | 1 + .../getPolicyAssignmentWithIdentityById.json | 1 + .../examples/getPolicyAssignmentWithOverrides.json | 1 + .../getPolicyAssignmentWithResourceSelectors.json | 1 + .../getPolicyAssignmentWithUserAssignedIdentity.json | 1 + .../2023-04-01/examples/getPolicySetDefinition.json | 2 ++ .../getPolicySetDefinitionAtManagementGroup.json | 2 ++ .../examples/getPolicySetDefinitionVersion.json | 2 ++ ...tPolicySetDefinitionVersionAtManagementGroup.json | 2 ++ .../listAllBuiltInPolicySetDefinitionVersions.json | 10 ++++++++++ .../examples/listAllPolicySetDefinitionVersions.json | 2 ++ ...PolicySetDefinitionVersionsByManagementGroup.json | 12 ++++++++++++ .../listBuiltInPolicySetDefinitionVersions.json | 10 ++++++++++ .../examples/listBuiltInPolicySetDefinitions.json | 10 ++++++++++ .../2023-04-01/examples/listPolicyAssignments.json | 2 ++ .../listPolicyAssignmentsForManagementGroup.json | 2 ++ .../examples/listPolicyAssignmentsForResource.json | 2 ++ .../listPolicyAssignmentsForResourceGroup.json | 2 ++ .../examples/listPolicySetDefinitionVersions.json | 2 ++ ...PolicySetDefinitionVersionsByManagementGroup.json | 2 ++ .../examples/listPolicySetDefinitions.json | 12 ++++++++++++ .../listPolicySetDefinitionsByManagementGroup.json | 10 ++++++++++ .../examples/updatePolicyAssignmentWithIdentity.json | 1 + .../updatePolicyAssignmentWithIdentityById.json | 1 + .../updatePolicyAssignmentWithOverrides.json | 1 + .../updatePolicyAssignmentWithResourceSelectors.json | 1 + ...datePolicyAssignmentWithUserAssignedIdentity.json | 1 + .../stable/2023-04-01/policyAssignments.json | 4 ++++ .../2023-04-01/policySetDefinitionVersions.json | 4 ++++ .../stable/2023-04-01/policySetDefinitions.json | 4 ++++ .../2024-04-01/examples/createPolicyAssignment.json | 1 + .../examples/createPolicyAssignmentById.json | 2 ++ .../createPolicyAssignmentNonComplianceMessages.json | 1 + .../examples/createPolicyAssignmentWithIdentity.json | 1 + .../createPolicyAssignmentWithIdentityById.json | 2 ++ .../createPolicyAssignmentWithOverrides.json | 1 + .../createPolicyAssignmentWithResourceSelectors.json | 1 + ...eatePolicyAssignmentWithUserAssignedIdentity.json | 1 + .../createPolicyAssignmentWithoutEnforcement.json | 1 + .../2024-04-01/examples/deletePolicyAssignment.json | 1 + .../examples/deletePolicyAssignmentById.json | 1 + .../2024-04-01/examples/getPolicyAssignment.json | 1 + .../2024-04-01/examples/getPolicyAssignmentById.json | 1 + .../examples/getPolicyAssignmentWithIdentity.json | 1 + .../getPolicyAssignmentWithIdentityById.json | 1 + .../examples/getPolicyAssignmentWithOverrides.json | 1 + .../getPolicyAssignmentWithResourceSelectors.json | 1 + .../getPolicyAssignmentWithUserAssignedIdentity.json | 1 + .../2024-04-01/examples/listPolicyAssignments.json | 2 ++ .../listPolicyAssignmentsForManagementGroup.json | 2 ++ .../examples/listPolicyAssignmentsForResource.json | 2 ++ .../listPolicyAssignmentsForResourceGroup.json | 2 ++ .../examples/updatePolicyAssignmentWithIdentity.json | 1 + .../updatePolicyAssignmentWithIdentityById.json | 1 + .../updatePolicyAssignmentWithOverrides.json | 1 + .../updatePolicyAssignmentWithResourceSelectors.json | 1 + ...datePolicyAssignmentWithUserAssignedIdentity.json | 1 + .../stable/2024-04-01/policyAssignments.json | 4 ++++ 79 files changed, 204 insertions(+) diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinition.json index 5ed89cf1a9cc..c8c35dde59bf 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinition.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinition.json @@ -78,6 +78,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -90,6 +91,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionAtManagementGroup.json index 2e59efd9898e..95f1e2d750d3 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionAtManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionAtManagementGroup.json @@ -60,6 +60,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -72,6 +73,7 @@ }, { "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { @@ -101,6 +103,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -113,6 +116,7 @@ }, { "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionVersion.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionVersion.json index a54b244c2b5c..e85c3246352d 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionVersion.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionVersion.json @@ -76,6 +76,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -88,6 +89,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { @@ -127,6 +129,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -139,6 +142,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionVersionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionVersionAtManagementGroup.json index a5c60be1ae02..4b7978acd533 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionVersionAtManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionVersionAtManagementGroup.json @@ -58,6 +58,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -70,6 +71,7 @@ }, { "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { @@ -99,6 +101,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -111,6 +114,7 @@ }, { "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionWithGroups.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionWithGroups.json index 8483ae575b01..7ef27d50753e 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionWithGroups.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionWithGroups.json @@ -25,6 +25,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "groupNames": [ "CostSaving" @@ -40,6 +41,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "groupNames": [ "Organizational" @@ -90,6 +92,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "groupNames": [ "CostSaving" @@ -105,6 +108,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "groupNames": [ "Organizational" @@ -154,6 +158,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "groupNames": [ "CostSaving" @@ -169,6 +174,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "groupNames": [ "Organizational" diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionWithGroupsAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionWithGroupsAtManagementGroup.json index 8088c7993a43..26a9ef16e40c 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionWithGroupsAtManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createOrUpdatePolicySetDefinitionWithGroupsAtManagementGroup.json @@ -90,6 +90,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "groupNames": [ "CostSaving" @@ -105,6 +106,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "groupNames": [ "Organizational" @@ -154,6 +156,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "groupNames": [ "CostSaving" @@ -169,6 +172,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "groupNames": [ "Organizational" diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignment.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignment.json index 507e0d3ade80..e734839d4773 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignment.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignment.json @@ -38,6 +38,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentById.json index 9c65dd44d837..afdad19b89eb 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentById.json @@ -10,6 +10,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "parameters": { "listOfAllowedSKUs": { "value": [ @@ -33,6 +34,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentNonComplianceMessages.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentNonComplianceMessages.json index aae5a745da0b..2d29465704d3 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentNonComplianceMessages.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentNonComplianceMessages.json @@ -33,6 +33,7 @@ "assignedBy": "User 1" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/securityInitiative", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithIdentity.json index 92699f063348..27807aa215e7 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithIdentity.json @@ -38,6 +38,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithIdentityById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithIdentityById.json index a38d483c5ae2..ade3496576fd 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithIdentityById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithIdentityById.json @@ -14,6 +14,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "parameters": { "listOfAllowedSKUs": { "value": [ @@ -37,6 +38,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithOverrides.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithOverrides.json index 936e4dfa6362..f6bd0b46bb7d 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithOverrides.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithOverrides.json @@ -40,6 +40,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithResourceSelectors.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithResourceSelectors.json index 7106dc80f78b..42afac2a8b0f 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithResourceSelectors.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithResourceSelectors.json @@ -39,6 +39,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithUserAssignedIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithUserAssignedIdentity.json index 790ddf6e758f..5fdd4d498977 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithUserAssignedIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithUserAssignedIdentity.json @@ -41,6 +41,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithoutEnforcement.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithoutEnforcement.json index 8f68a65a8aa1..964fa0450935 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithoutEnforcement.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/createPolicyAssignmentWithoutEnforcement.json @@ -34,6 +34,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/deletePolicyAssignment.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/deletePolicyAssignment.json index fe9b87fcf0c1..b83ea50d8b91 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/deletePolicyAssignment.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/deletePolicyAssignment.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/deletePolicyAssignmentById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/deletePolicyAssignmentById.json index 3f489e6f385b..d417e140a43d 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/deletePolicyAssignmentById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/deletePolicyAssignmentById.json @@ -14,6 +14,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getBuiltInPolicySetDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getBuiltInPolicySetDefinition.json index 628d5a1449d3..1c785d31d6cb 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getBuiltInPolicySetDefinition.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getBuiltInPolicySetDefinition.json @@ -23,42 +23,52 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId1" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId2" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId3" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId4" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId5" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId6" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId7" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId8" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId9" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId10" } ] diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getBuiltInPolicySetDefinitionVersion.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getBuiltInPolicySetDefinitionVersion.json index bd78c6bcb8df..bc6cecc7b0f9 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getBuiltInPolicySetDefinitionVersion.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getBuiltInPolicySetDefinitionVersion.json @@ -20,42 +20,52 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId1" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId2" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId3" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId4" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId5" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId6" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId7" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId8" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId9" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId10" } ] diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignment.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignment.json index f3dd1bd16638..549a09ca6a79 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignment.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignment.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentById.json index 167547511c36..d5d1c177f677 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentById.json @@ -14,6 +14,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithIdentity.json index 9aa734ce3fb4..b5fe18a24c70 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithIdentity.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithIdentityById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithIdentityById.json index 426cf0ad6691..e478978ff0e3 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithIdentityById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithIdentityById.json @@ -14,6 +14,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithOverrides.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithOverrides.json index 24ae6a248f62..9cdc97c58caa 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithOverrides.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithOverrides.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithResourceSelectors.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithResourceSelectors.json index ccffcbae7aa2..222ad2819709 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithResourceSelectors.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithResourceSelectors.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithUserAssignedIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithUserAssignedIdentity.json index 117b71fe5083..84c4c8dfef53 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithUserAssignedIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicyAssignmentWithUserAssignedIdentity.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinition.json index 06b97ca99930..cf62d3140508 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinition.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinition.json @@ -37,6 +37,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "groupNames": [ "CostSaving" @@ -52,6 +53,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "groupNames": [ "Organizational" diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionAtManagementGroup.json index 21a6b10bdb59..04402f737538 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionAtManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionAtManagementGroup.json @@ -25,6 +25,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -37,6 +38,7 @@ }, { "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersion.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersion.json index 296242856d25..862158f82445 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersion.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersion.json @@ -34,6 +34,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "groupNames": [ "CostSaving" @@ -49,6 +50,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "groupNames": [ "Organizational" diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersionAtManagementGroup.json index 48b464589b9f..093143ae40bb 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersionAtManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersionAtManagementGroup.json @@ -22,6 +22,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -34,6 +35,7 @@ }, { "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllBuiltInPolicySetDefinitionVersions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllBuiltInPolicySetDefinitionVersions.json index 173fd8c30fb6..1c40f86d8ffb 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllBuiltInPolicySetDefinitionVersions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllBuiltInPolicySetDefinitionVersions.json @@ -20,42 +20,52 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId1" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId2" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId3" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId4" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId5" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId6" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId7" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId8" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId9" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId10" } ] diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllPolicySetDefinitionVersions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllPolicySetDefinitionVersions.json index f3c08eac8283..fb9ef19b777c 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllPolicySetDefinitionVersions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllPolicySetDefinitionVersions.json @@ -22,6 +22,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -34,6 +35,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllPolicySetDefinitionVersionsByManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllPolicySetDefinitionVersionsByManagementGroup.json index 6bdbe39794b9..21a4320bb0ea 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllPolicySetDefinitionVersionsByManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listAllPolicySetDefinitionVersionsByManagementGroup.json @@ -21,42 +21,52 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId1" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId2" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId3" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId4" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId5" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId6" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId7" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId8" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId9" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId10" } ] @@ -79,6 +89,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -91,6 +102,7 @@ }, { "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitionVersions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitionVersions.json index 16ed760edba9..1ed8541f88eb 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitionVersions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitionVersions.json @@ -21,42 +21,52 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId1" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId2" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId3" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId4" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId5" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId6" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId7" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId8" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId9" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId10" } ] diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitions.json index db8b36f80545..02d7edc6fbe6 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitions.json @@ -24,42 +24,52 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId1" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId2" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId3" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId4" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId5" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId6" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId7" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId8" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId9" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId10" } ] diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignments.json index d0753ec91f61..514b8413dcd1 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignments.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignments.json @@ -26,6 +26,7 @@ "category": "Cost Management" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus", + "definitionVersion": "1.*.*", "parameters": { "allowedSkus": { "value": "Standard_A1" @@ -43,6 +44,7 @@ "displayName": "Enforces a tag key and value", "description": "Ensure a given tag key and value are present on all resources", "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "definitionVersion": "1.*.*", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", "notScopes": [] } diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForManagementGroup.json index 716b6f5b6173..72ba0190c78b 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForManagementGroup.json @@ -26,6 +26,7 @@ "category": "Cost Management" }, "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyDefinitions/storageSkus", + "definitionVersion": "1.*.*", "parameters": { "allowedSkus": { "value": "Standard_A1" @@ -43,6 +44,7 @@ "displayName": "Enforces a tag key and value", "description": "Ensure a given tag key and value are present on all resources", "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "definitionVersion": "1.*.*", "scope": "/providers/Microsoft.Management/managementGroups/TestManagementGroup", "notScopes": [] } diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForResource.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForResource.json index 5cb7b5b1f230..907fc812d656 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForResource.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForResource.json @@ -30,6 +30,7 @@ "category": "Cost Management" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/vmSkus", + "definitionVersion": "1.*.*", "parameters": { "allowedSkus": { "value": "Standard_A1" @@ -47,6 +48,7 @@ "displayName": "Enforces a tag key and value", "description": "Ensure a given tag key and value are present on all resources", "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "definitionVersion": "1.*.*", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup", "notScopes": [] } diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForResourceGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForResourceGroup.json index 57967e2d97d7..8df2b2177033 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForResourceGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyAssignmentsForResourceGroup.json @@ -27,6 +27,7 @@ "category": "Cost Management" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus", + "definitionVersion": "1.*.*", "parameters": { "allowedSkus": { "value": "Standard_A1" @@ -44,6 +45,7 @@ "displayName": "Enforces a tag key and value", "description": "Ensure a given tag key and value are present on all resources", "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "definitionVersion": "1.*.*", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup", "notScopes": [] } diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersions.json index b0191b4b1b54..cfa70a124f88 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersions.json @@ -23,6 +23,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -35,6 +36,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersionsByManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersionsByManagementGroup.json index fa7e45ed2d50..6067833bb870 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersionsByManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersionsByManagementGroup.json @@ -23,6 +23,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -35,6 +36,7 @@ }, { "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitions.json index e39556f2f482..6153d13e96da 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitions.json @@ -25,42 +25,52 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId1" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId2" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId3" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId4" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId5" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId6" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId7" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId8" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId9" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId10" } ] @@ -87,6 +97,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -99,6 +110,7 @@ }, { "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionsByManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionsByManagementGroup.json index d3155e5e7966..10d926f44e88 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionsByManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionsByManagementGroup.json @@ -25,18 +25,22 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId1" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId2" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId3" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId4" }, { @@ -45,10 +49,12 @@ }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId6" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId7" }, { @@ -57,10 +63,12 @@ }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId9" }, { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "RefId10" } ] @@ -87,6 +95,7 @@ "policyDefinitions": [ { "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Limit_Skus", "parameters": { "listOfAllowedSKUs": { @@ -99,6 +108,7 @@ }, { "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "policyDefinitionReferenceId": "Resource_Naming", "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithIdentity.json index af0861f2c6c0..e2b68eeb0841 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithIdentity.json @@ -21,6 +21,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithIdentityById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithIdentityById.json index 5348c752720c..2073cf18fc0f 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithIdentityById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithIdentityById.json @@ -20,6 +20,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithOverrides.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithOverrides.json index d3a2e76989ab..b221db74ad3f 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithOverrides.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithOverrides.json @@ -34,6 +34,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithResourceSelectors.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithResourceSelectors.json index 9d1e732d9b9b..8f809988f2b7 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithResourceSelectors.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithResourceSelectors.json @@ -33,6 +33,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json index 76077a9496e2..f89c222b562c 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json @@ -24,6 +24,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policyAssignments.json index e584799fe24f..92e22341c101 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policyAssignments.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policyAssignments.json @@ -738,6 +738,10 @@ "type": "string", "description": "The ID of the policy definition or policy set definition being assigned." }, + "definitionVersion": { + "type": "string", + "description": "The version of the policy definition to use." + }, "scope": { "type": "string", "description": "The scope for the policy assignment.", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json index a814c951f329..c0a382296763 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json @@ -679,6 +679,10 @@ "type": "string", "description": "The ID of the policy definition or policy set definition." }, + "definitionVersion": { + "type": "string", + "description": "The version of the policy definition to use." + }, "parameters": { "description": "The parameter values for the referenced policy rule. The keys are the parameter names.", "$ref": "./policyAssignments.json#/definitions/ParameterValues" diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitions.json index a9b8cd89659b..9f027f86f4f6 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/policySetDefinitions.json @@ -598,6 +598,10 @@ "type": "string", "description": "The ID of the policy definition or policy set definition." }, + "definitionVersion": { + "type": "string", + "description": "The version of the policy definition to use." + }, "parameters": { "description": "The parameter values for the referenced policy rule. The keys are the parameter names.", "$ref": "./policyAssignments.json#/definitions/ParameterValues" diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignment.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignment.json index 85cf01e4b970..02dbba61bbef 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignment.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignment.json @@ -38,6 +38,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentById.json index af6799c6950f..bf107b4d4c7c 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentById.json @@ -10,6 +10,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "parameters": { "listOfAllowedSKUs": { "value": [ @@ -33,6 +34,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentNonComplianceMessages.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentNonComplianceMessages.json index 23116f553880..8d605ddcecc3 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentNonComplianceMessages.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentNonComplianceMessages.json @@ -33,6 +33,7 @@ "assignedBy": "User 1" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/securityInitiative", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithIdentity.json index bba5bf1c8f98..a02023950bfe 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithIdentity.json @@ -38,6 +38,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithIdentityById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithIdentityById.json index 291ade5de921..d8da8a7ea4b1 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithIdentityById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithIdentityById.json @@ -14,6 +14,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "parameters": { "listOfAllowedSKUs": { "value": [ @@ -37,6 +38,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithOverrides.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithOverrides.json index 0ff331f5690a..1d965467450a 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithOverrides.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithOverrides.json @@ -40,6 +40,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithResourceSelectors.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithResourceSelectors.json index a6a50f960b6a..a7c41a835a87 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithResourceSelectors.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithResourceSelectors.json @@ -39,6 +39,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithUserAssignedIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithUserAssignedIdentity.json index cffaf2f79364..4a2038094fef 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithUserAssignedIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithUserAssignedIdentity.json @@ -41,6 +41,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithoutEnforcement.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithoutEnforcement.json index 8f0050637a42..cd258447ceec 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithoutEnforcement.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/createPolicyAssignmentWithoutEnforcement.json @@ -34,6 +34,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/deletePolicyAssignment.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/deletePolicyAssignment.json index 4a49760afdc4..8129777e1d02 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/deletePolicyAssignment.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/deletePolicyAssignment.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/deletePolicyAssignmentById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/deletePolicyAssignmentById.json index d38f5a690267..7578c60c795b 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/deletePolicyAssignmentById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/deletePolicyAssignmentById.json @@ -14,6 +14,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignment.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignment.json index da77ffaff5fb..44c51d732b3a 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignment.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignment.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentById.json index 865bbc44cbaf..e2e064d167dc 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentById.json @@ -14,6 +14,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithIdentity.json index bfbb3a57e35c..d9466bee0947 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithIdentity.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithIdentityById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithIdentityById.json index dd5447ac93be..d8fa9c168440 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithIdentityById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithIdentityById.json @@ -14,6 +14,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithOverrides.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithOverrides.json index 3fa10f7368e3..e68a8e6db887 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithOverrides.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithOverrides.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithResourceSelectors.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithResourceSelectors.json index dafab2356629..6f049c483cba 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithResourceSelectors.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithResourceSelectors.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithUserAssignedIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithUserAssignedIdentity.json index eb05de90a9bd..b7f41ee1ba85 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithUserAssignedIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/getPolicyAssignmentWithUserAssignedIdentity.json @@ -15,6 +15,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignments.json index b85ab0c72973..b257e1a0800f 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignments.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignments.json @@ -26,6 +26,7 @@ "category": "Cost Management" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus", + "definitionVersion": "1.*.*", "parameters": { "allowedSkus": { "value": "Standard_A1" @@ -43,6 +44,7 @@ "displayName": "Enforces a tag key and value", "description": "Ensure a given tag key and value are present on all resources", "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "definitionVersion": "1.*.*", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", "notScopes": [] } diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForManagementGroup.json index 8f54b3d3f6e6..343e58cd3e41 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForManagementGroup.json @@ -26,6 +26,7 @@ "category": "Cost Management" }, "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyDefinitions/storageSkus", + "definitionVersion": "1.*.*", "parameters": { "allowedSkus": { "value": "Standard_A1" @@ -43,6 +44,7 @@ "displayName": "Enforces a tag key and value", "description": "Ensure a given tag key and value are present on all resources", "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/TestManagementGroup/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "definitionVersion": "1.*.*", "scope": "/providers/Microsoft.Management/managementGroups/TestManagementGroup", "notScopes": [] } diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForResource.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForResource.json index f2883c5064aa..b3d3190d233a 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForResource.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForResource.json @@ -30,6 +30,7 @@ "category": "Cost Management" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/vmSkus", + "definitionVersion": "1.*.*", "parameters": { "allowedSkus": { "value": "Standard_A1" @@ -47,6 +48,7 @@ "displayName": "Enforces a tag key and value", "description": "Ensure a given tag key and value are present on all resources", "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "definitionVersion": "1.*.*", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup", "notScopes": [] } diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForResourceGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForResourceGroup.json index b618b59fe37b..81dfb68247a9 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForResourceGroup.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/listPolicyAssignmentsForResourceGroup.json @@ -27,6 +27,7 @@ "category": "Cost Management" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus", + "definitionVersion": "1.*.*", "parameters": { "allowedSkus": { "value": "Standard_A1" @@ -44,6 +45,7 @@ "displayName": "Enforces a tag key and value", "description": "Ensure a given tag key and value are present on all resources", "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "definitionVersion": "1.*.*", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup", "notScopes": [] } diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithIdentity.json index 2632a663244e..1ec8cb070c0b 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithIdentity.json @@ -21,6 +21,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithIdentityById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithIdentityById.json index eb459749a08f..508061dcbe37 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithIdentityById.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithIdentityById.json @@ -20,6 +20,7 @@ "assignedBy": "Cheapskate Boss" }, "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "listOfAllowedSKUs": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithOverrides.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithOverrides.json index 5ed98ca5862a..f53a09658ab4 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithOverrides.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithOverrides.json @@ -34,6 +34,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithResourceSelectors.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithResourceSelectors.json index 89deef919e58..9e7aba5cd45b 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithResourceSelectors.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithResourceSelectors.json @@ -33,6 +33,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "definitionVersion": "1.*.*", "notScopes": [], "enforcementMode": "Default", "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json index 8623bdac57dc..d4f222a4ee04 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/examples/updatePolicyAssignmentWithUserAssignedIdentity.json @@ -24,6 +24,7 @@ "assignedBy": "Special Someone" }, "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "definitionVersion": "1.*.*", "notScopes": [], "parameters": { "prefix": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/policyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/policyAssignments.json index 3e7730f09970..b9b68f8043e3 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/policyAssignments.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2024-04-01/policyAssignments.json @@ -738,6 +738,10 @@ "type": "string", "description": "The ID of the policy definition or policy set definition being assigned." }, + "definitionVersion": { + "type": "string", + "description": "The version of the policy definition to use." + }, "scope": { "type": "string", "description": "The scope for the policy assignment.", From eeb6a465860b7413763b51c31971f2ca9cc7008b Mon Sep 17 00:00:00 2001 From: jecmenicanikola <122357154+jecmenicanikola@users.noreply.github.com> Date: Wed, 12 Jun 2024 23:38:45 -0700 Subject: [PATCH 168/343] Change two property types for route spec (#28576) * Change two property types for route spec * Add format to integer type * Change description * Fix typo --- .../data-plane/Route/preview/1.0/route.json | 169 +++++++++--------- 1 file changed, 87 insertions(+), 82 deletions(-) diff --git a/specification/maps/data-plane/Route/preview/1.0/route.json b/specification/maps/data-plane/Route/preview/1.0/route.json index d3ba2bceb1ca..8b210b82e594 100644 --- a/specification/maps/data-plane/Route/preview/1.0/route.json +++ b/specification/maps/data-plane/Route/preview/1.0/route.json @@ -610,87 +610,91 @@ "name": "sectionType", "x-ms-client-name": "FilterSectionType", "in": "query", - "description": "Specifies which of the section types is reported in the route response.

For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Multiple types can be used. The default sectionType refers to the travelMode input. By default travelMode is set to car", - "type": "string", - "enum": [ - "carTrain", - "country", - "ferry", - "motorway", - "pedestrian", - "tollRoad", - "tollVignette", - "traffic", - "travelMode", - "tunnel", - "carpool", - "urban" - ], - "x-ms-enum": { - "name": "SectionType", - "modelAsString": true, - "values": [ - { - "value": "carTrain", - "name": "CarOrTrain", - "description": "Sections of the route that are cars or trains." - }, - { - "value": "country", - "name": "Country", - "description": "Sections indicating which countries/regions the route is in." - }, - { - "value": "ferry", - "name": "Ferry", - "description": "Sections of the route that are ferries." - }, - { - "value": "motorway", - "name": "Motorway", - "description": "Sections of the route that are motorways." - }, - { - "value": "pedestrian", - "name": "Pedestrian", - "description": "Sections of the route that are only suited for pedestrians." - }, - { - "value": "tollRoad", - "name": "TollRoad", - "description": "Sections of the route that require a toll to be payed." - }, - { - "value": "tollVignette", - "name": "TollVignette", - "description": "Sections of the route that require a toll vignette to be present." - }, - { - "value": "traffic", - "name": "Traffic", - "description": "Sections of the route that contain traffic information." - }, - { - "value": "travelMode", - "name": "TravelMode", - "description": "Sections in relation to the request parameter `travelMode`." - }, - { - "value": "tunnel", - "name": "Tunnel", - "description": "Sections of the route that are tunnels." - }, - { - "value": "carpool", - "name": "Carpool", - "description": "Sections of the route that require use of carpool (HOV/High Occupancy Vehicle) lanes." - }, - { - "value": "urban", - "name": "Urban", - "description": "Sections of the route that are located within urban areas." - } - ] + "description": "Specifies which of the section types is reported in the route response.

For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "carTrain", + "country", + "ferry", + "motorway", + "pedestrian", + "tollRoad", + "tollVignette", + "traffic", + "travelMode", + "tunnel", + "carpool", + "urban" + ], + "x-ms-enum": { + "name": "SectionType", + "modelAsString": true, + "values": [ + { + "value": "carTrain", + "name": "CarOrTrain", + "description": "Sections of the route that are cars or trains." + }, + { + "value": "country", + "name": "Country", + "description": "Sections indicating which countries/regions the route is in." + }, + { + "value": "ferry", + "name": "Ferry", + "description": "Sections of the route that are ferries." + }, + { + "value": "motorway", + "name": "Motorway", + "description": "Sections of the route that are motorways." + }, + { + "value": "pedestrian", + "name": "Pedestrian", + "description": "Sections of the route that are only suited for pedestrians." + }, + { + "value": "tollRoad", + "name": "TollRoad", + "description": "Sections of the route that require a toll to be paid." + }, + { + "value": "tollVignette", + "name": "TollVignette", + "description": "Sections of the route that require a toll vignette to be present." + }, + { + "value": "traffic", + "name": "Traffic", + "description": "Sections of the route that contain traffic information." + }, + { + "value": "travelMode", + "name": "TravelMode", + "description": "Sections in relation to the request parameter `travelMode`." + }, + { + "value": "tunnel", + "name": "Tunnel", + "description": "Sections of the route that are tunnels." + }, + { + "value": "carpool", + "name": "Carpool", + "description": "Sections of the route that require use of carpool (HOV/High Occupancy Vehicle) lanes." + }, + { + "value": "urban", + "name": "Urban", + "description": "Sections of the route that are located within urban areas." + } + ] + } }, "x-ms-parameter-location": "method" }, @@ -2213,7 +2217,8 @@ }, "roundaboutExitNumber": { "description": "This indicates which exit to take at a roundabout.", - "type": "string", + "type": "integer", + "format": "int64", "readOnly": true }, "possibleCombineWithNext": { From a89c175684a2861e0ed76905161a033865c8e336 Mon Sep 17 00:00:00 2001 From: Sahil Arora Date: Thu, 13 Jun 2024 00:10:23 -0700 Subject: [PATCH 169/343] Examples Changes and move VMSS list operation inside fleets resource (#29243) * Examples Changes and move VMSS list operation inside fleets resource * Add uri format * revert vmss name in example --------- Co-authored-by: Sahil Arora --- .../Fleets_CreateOrUpdate_MaximumSet.json | 23 ++--------------- .../Fleets_Get_MaximumSet.json | 9 +------ ...Fleets_ListByResourceGroup_MaximumSet.json | 9 +------ .../Fleets_ListBySubscription_MaximumSet.json | 9 +------ ...stVirtualMachineScaleSets_MaximumSet.json} | 11 ++++---- .../Fleets_Update_MaximumSet.json | 14 +---------- ...chineScaleSets_ListByFleet_MinimumSet.json | 23 ----------------- .../Fleets_CreateOrUpdate.json | 23 ++--------------- .../Fleets_ListByResourceGroup.json | 5 ---- .../Fleets_ListBySubscription.json | 5 ---- .../Fleets_ListVirtualMachineScaleSets.json} | 21 ++++++++-------- .../2024-05-01-preview/Fleets_Update.json | 14 +---------- .../AzureFleet.Management/fleet.tsp | 21 ++++++++++++++++ .../virtualMachineScaleSet.tsp | 25 ------------------- .../2023-11-01-preview/azurefleet.json | 14 +++-------- .../Fleets_CreateOrUpdate_MaximumSet.json | 23 ++--------------- .../examples/Fleets_Get_MaximumSet.json | 9 +------ ...Fleets_ListByResourceGroup_MaximumSet.json | 9 +------ .../Fleets_ListBySubscription_MaximumSet.json | 9 +------ ...stVirtualMachineScaleSets_MaximumSet.json} | 11 ++++---- .../examples/Fleets_Update_MaximumSet.json | 14 +---------- ...chineScaleSets_ListByFleet_MinimumSet.json | 23 ----------------- .../2024-05-01-preview/azurefleet.json | 11 +++----- .../examples/Fleets_CreateOrUpdate.json | 23 ++--------------- .../examples/Fleets_ListByResourceGroup.json | 5 ---- .../examples/Fleets_ListBySubscription.json | 5 ---- .../Fleets_ListVirtualMachineScaleSets.json} | 21 ++++++++-------- .../examples/Fleets_Update.json | 14 +---------- 28 files changed, 77 insertions(+), 326 deletions(-) rename specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/{VirtualMachineScaleSets_ListByFleet_MaximumSet.json => Fleets_ListVirtualMachineScaleSets_MaximumSet.json} (74%) delete mode 100644 specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/VirtualMachineScaleSets_ListByFleet_MinimumSet.json rename specification/azurefleet/{resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/VirtualMachineScaleSets_ListByFleet.json => AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListVirtualMachineScaleSets.json} (66%) rename specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/{VirtualMachineScaleSets_ListByFleet_MaximumSet.json => Fleets_ListVirtualMachineScaleSets_MaximumSet.json} (74%) delete mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/VirtualMachineScaleSets_ListByFleet_MinimumSet.json rename specification/azurefleet/{AzureFleet.Management/examples/2024-05-01-preview/VirtualMachineScaleSets_ListByFleet.json => resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListVirtualMachineScaleSets.json} (66%) diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json index f3b06a940568..58e8fcb80aed 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json @@ -305,11 +305,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ncc", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", @@ -445,7 +440,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -454,8 +448,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -723,11 +716,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ncc", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", @@ -887,7 +875,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -896,8 +883,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -1165,11 +1151,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ncc", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Get_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Get_MaximumSet.json index 4ecfdd206504..b080f05cdc68 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Get_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Get_MaximumSet.json @@ -33,7 +33,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -42,8 +41,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -311,11 +309,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ncc", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListByResourceGroup_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListByResourceGroup_MaximumSet.json index 382d4f6c1589..1ddb67117d37 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListByResourceGroup_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListByResourceGroup_MaximumSet.json @@ -35,7 +35,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -44,8 +43,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -313,11 +311,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ejag", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListBySubscription_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListBySubscription_MaximumSet.json index 7c5cf143d75c..55fea7dae063 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListBySubscription_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListBySubscription_MaximumSet.json @@ -34,7 +34,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -43,8 +42,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -312,11 +310,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ejag", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/VirtualMachineScaleSets_ListByFleet_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListVirtualMachineScaleSets_MaximumSet.json similarity index 74% rename from specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/VirtualMachineScaleSets_ListByFleet_MaximumSet.json rename to specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListVirtualMachineScaleSets_MaximumSet.json index 74ac0007694d..35b9dc9c20da 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/VirtualMachineScaleSets_ListByFleet_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListVirtualMachineScaleSets_MaximumSet.json @@ -1,6 +1,6 @@ { - "title": "VirtualMachineScaleSets_ListByFleet_MaximumSet", - "operationId": "VirtualMachineScaleSets_ListByFleet", + "title": "Fleets_ListVirtualMachineScaleSets_MaximumSet", + "operationId": "Fleets_ListVirtualMachineScaleSets", "parameters": { "api-version": "2023-11-01-preview", "subscriptionId": "7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C", @@ -12,13 +12,12 @@ "body": { "value": [ { - "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", "name": "myVmss", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", "type": "Microsoft.AzureFleet/fleets/virtualMachineScaleSets", - "provisioningState": "Creating" + "provisioningState": "Succeeded" } - ], - "nextLink": null + ] } } } diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json index c09aea4a8b80..43cbb9db43e1 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json @@ -306,11 +306,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "pbnasge", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", @@ -443,7 +438,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -452,8 +446,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -721,11 +714,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "pbnasge", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/VirtualMachineScaleSets_ListByFleet_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/VirtualMachineScaleSets_ListByFleet_MinimumSet.json deleted file mode 100644 index e443ae914371..000000000000 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/VirtualMachineScaleSets_ListByFleet_MinimumSet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "title": "VirtualMachineScaleSets_ListByFleet_MinimumSet", - "operationId": "VirtualMachineScaleSets_ListByFleet", - "parameters": { - "api-version": "2023-11-01-preview", - "subscriptionId": "7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C", - "resourceGroupName": "rgazurefleet", - "name": "testFleet" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", - "name": "myVmss", - "provisioningState": "Creating" - } - ] - } - } - } -} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json index 098e590357f5..f90d8d57e529 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json @@ -307,11 +307,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", @@ -453,7 +448,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -462,8 +456,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -731,11 +724,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", @@ -900,7 +888,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -909,8 +896,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -1178,11 +1164,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListByResourceGroup.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListByResourceGroup.json index 894f01849bf2..ad7bc37f6910 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListByResourceGroup.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListByResourceGroup.json @@ -315,11 +315,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListBySubscription.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListBySubscription.json index f23c58309970..0c9de85a88ba 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListBySubscription.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListBySubscription.json @@ -314,11 +314,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/VirtualMachineScaleSets_ListByFleet.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListVirtualMachineScaleSets.json similarity index 66% rename from specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/VirtualMachineScaleSets_ListByFleet.json rename to specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListVirtualMachineScaleSets.json index f8ad3c043c5f..628c68be9aed 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/VirtualMachineScaleSets_ListByFleet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListVirtualMachineScaleSets.json @@ -1,9 +1,9 @@ { - "title": "VirtualMachineScaleSets_ListByFleet", - "operationId": "VirtualMachineScaleSets_ListByFleet", + "title": "Fleets_ListVirtualMachineScaleSets", + "operationId": "Fleets_ListVirtualMachineScaleSets", "parameters": { "api-version": "2024-05-01-preview", - "subscriptionId": "7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", "resourceGroupName": "rgazurefleet", "name": "myFleet" }, @@ -12,29 +12,28 @@ "body": { "value": [ { - "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", "name": "myVmss", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", "type": "Microsoft.AzureFleet/fleets/virtualMachineScaleSets", "operationStatus": "Creating", "error": { "details": [ { - "code": "OverconstrainedAllocationRequest", - "target": "ctewy", + "code": "gzhtOverconstrainedAllocationRequestyosk", + "target": "qfthabhrmndhfizfnrwpgxvnokpy", "message": "Allocation Failed" } ], "innererror": { - "exceptiontype": "izreesvoxoftelpzpbo", - "errordetail": "hnwzlnmyqyclprdnzfumar" + "exceptiontype": "sfaomfpoaptnbxchrfskm", + "errordetail": "ihjwbwykq" }, "code": "OverconstrainedAllocationRequest", - "target": "ctewy", + "target": "nhaj", "message": "Allocation Failed" } } - ], - "nextLink": null + ] } } } diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json index bbfa1f3f6ff5..621ccf96f741 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json @@ -312,11 +312,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", @@ -448,7 +443,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -457,8 +451,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -726,11 +719,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", diff --git a/specification/azurefleet/AzureFleet.Management/fleet.tsp b/specification/azurefleet/AzureFleet.Management/fleet.tsp index b0ecd27d3b21..119a9f9a93e2 100644 --- a/specification/azurefleet/AzureFleet.Management/fleet.tsp +++ b/specification/azurefleet/AzureFleet.Management/fleet.tsp @@ -217,4 +217,25 @@ interface Fleets { delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; + @autoRoute + @listsResource(VirtualMachineScaleSet) + @armResourceList(VirtualMachineScaleSet) + @get + @doc("List VirtualMachineScaleSet resources by Fleet") + @extension( + "x-ms-pageable", + { + nextLinkName: "nextLink", + } + ) + listVirtualMachineScaleSets( + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...ProviderNamespace, + ...ResourceNameParameter< + Fleet, + NamePattern = "^[^_\\W][\\w-._]{0,79}(?, + ): ArmResponse | ErrorResponse; } diff --git a/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp b/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp index bf38fbe41a8c..1864d1a78f91 100644 --- a/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp +++ b/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp @@ -58,28 +58,3 @@ model VirtualMachineScaleSetListResult { @format("uri") nextLink?: string; } - -@armResourceOperations -interface VirtualMachineScaleSets { - @autoRoute - @listsResource(VirtualMachineScaleSet) - @armResourceList(VirtualMachineScaleSet) - @get - @doc("List VirtualMachineScaleSet resources by Fleet") - @extension( - "x-ms-pageable", - { - nextLinkName: "nextLink", - } - ) - listByFleet( - ...ApiVersionParameter, - ...SubscriptionIdParameter, - ...ResourceGroupParameter, - ...ProviderNamespace, - ...ResourceNameParameter< - Fleet, - NamePattern = "^[^_\\W][\\w-._]{0,79}(?, - ): ArmResponse | ErrorResponse; -} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json index a374ea7ef3b9..0bbd2f4db9d6 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json @@ -43,9 +43,6 @@ }, { "name": "Fleets" - }, - { - "name": "VirtualMachineScaleSets" } ], "paths": { @@ -439,9 +436,9 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{name}/virtualMachineScaleSets": { "get": { - "operationId": "VirtualMachineScaleSets_ListByFleet", + "operationId": "Fleets_ListVirtualMachineScaleSets", "tags": [ - "VirtualMachineScaleSets" + "Fleets" ], "description": "List VirtualMachineScaleSet resources by Fleet", "parameters": [ @@ -478,11 +475,8 @@ } }, "x-ms-examples": { - "VirtualMachineScaleSets_ListByFleet_MaximumSet": { - "$ref": "./examples/VirtualMachineScaleSets_ListByFleet_MaximumSet.json" - }, - "VirtualMachineScaleSets_ListByFleet_MinimumSet": { - "$ref": "./examples/VirtualMachineScaleSets_ListByFleet_MinimumSet.json" + "Fleets_ListVirtualMachineScaleSets_MaximumSet": { + "$ref": "./examples/Fleets_ListVirtualMachineScaleSets_MaximumSet.json" } }, "x-ms-pageable": { diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json index f3b06a940568..58e8fcb80aed 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json @@ -305,11 +305,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ncc", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", @@ -445,7 +440,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -454,8 +448,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -723,11 +716,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ncc", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", @@ -887,7 +875,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -896,8 +883,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -1165,11 +1151,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ncc", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Get_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Get_MaximumSet.json index 4ecfdd206504..b080f05cdc68 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Get_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Get_MaximumSet.json @@ -33,7 +33,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -42,8 +41,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -311,11 +309,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ncc", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListByResourceGroup_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListByResourceGroup_MaximumSet.json index 382d4f6c1589..1ddb67117d37 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListByResourceGroup_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListByResourceGroup_MaximumSet.json @@ -35,7 +35,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -44,8 +43,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -313,11 +311,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ejag", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListBySubscription_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListBySubscription_MaximumSet.json index 7c5cf143d75c..55fea7dae063 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListBySubscription_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListBySubscription_MaximumSet.json @@ -34,7 +34,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -43,8 +42,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -312,11 +310,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "ejag", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/VirtualMachineScaleSets_ListByFleet_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListVirtualMachineScaleSets_MaximumSet.json similarity index 74% rename from specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/VirtualMachineScaleSets_ListByFleet_MaximumSet.json rename to specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListVirtualMachineScaleSets_MaximumSet.json index 74ac0007694d..35b9dc9c20da 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/VirtualMachineScaleSets_ListByFleet_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListVirtualMachineScaleSets_MaximumSet.json @@ -1,6 +1,6 @@ { - "title": "VirtualMachineScaleSets_ListByFleet_MaximumSet", - "operationId": "VirtualMachineScaleSets_ListByFleet", + "title": "Fleets_ListVirtualMachineScaleSets_MaximumSet", + "operationId": "Fleets_ListVirtualMachineScaleSets", "parameters": { "api-version": "2023-11-01-preview", "subscriptionId": "7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C", @@ -12,13 +12,12 @@ "body": { "value": [ { - "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", "name": "myVmss", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", "type": "Microsoft.AzureFleet/fleets/virtualMachineScaleSets", - "provisioningState": "Creating" + "provisioningState": "Succeeded" } - ], - "nextLink": null + ] } } } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json index c09aea4a8b80..43cbb9db43e1 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json @@ -306,11 +306,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "pbnasge", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", @@ -443,7 +438,6 @@ "osProfile": { "computerNamePrefix": "svdrokuuojba", "adminUsername": "offgcmltnjkbiakzjhosetqeslifah", - "customData": "konjpsuyijb", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -452,8 +446,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "kstwdekvloggaypeiqgzlcfsm" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -721,11 +714,6 @@ "extensionsTimeBudget": "srvemetinivyy" }, "licenseType": "pbnasge", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 8 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "yczcvhbnxumqmilfufwatqupjrniie", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/VirtualMachineScaleSets_ListByFleet_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/VirtualMachineScaleSets_ListByFleet_MinimumSet.json deleted file mode 100644 index e443ae914371..000000000000 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/VirtualMachineScaleSets_ListByFleet_MinimumSet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "title": "VirtualMachineScaleSets_ListByFleet_MinimumSet", - "operationId": "VirtualMachineScaleSets_ListByFleet", - "parameters": { - "api-version": "2023-11-01-preview", - "subscriptionId": "7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C", - "resourceGroupName": "rgazurefleet", - "name": "testFleet" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", - "name": "myVmss", - "provisioningState": "Creating" - } - ] - } - } - } -} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json index 3e9036a323dc..7a6c8aabf7ca 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json @@ -43,9 +43,6 @@ }, { "name": "Fleets" - }, - { - "name": "VirtualMachineScaleSets" } ], "paths": { @@ -418,9 +415,9 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{name}/virtualMachineScaleSets": { "get": { - "operationId": "VirtualMachineScaleSets_ListByFleet", + "operationId": "Fleets_ListVirtualMachineScaleSets", "tags": [ - "VirtualMachineScaleSets" + "Fleets" ], "description": "List VirtualMachineScaleSet resources by Fleet", "parameters": [ @@ -457,8 +454,8 @@ } }, "x-ms-examples": { - "VirtualMachineScaleSets_ListByFleet": { - "$ref": "./examples/VirtualMachineScaleSets_ListByFleet.json" + "Fleets_ListVirtualMachineScaleSets": { + "$ref": "./examples/Fleets_ListVirtualMachineScaleSets.json" } }, "x-ms-pageable": { diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json index 098e590357f5..f90d8d57e529 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json @@ -307,11 +307,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", @@ -453,7 +448,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -462,8 +456,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -731,11 +724,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", @@ -900,7 +888,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -909,8 +896,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -1178,11 +1164,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListByResourceGroup.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListByResourceGroup.json index 894f01849bf2..ad7bc37f6910 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListByResourceGroup.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListByResourceGroup.json @@ -315,11 +315,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListBySubscription.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListBySubscription.json index f23c58309970..0c9de85a88ba 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListBySubscription.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListBySubscription.json @@ -314,11 +314,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/VirtualMachineScaleSets_ListByFleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListVirtualMachineScaleSets.json similarity index 66% rename from specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/VirtualMachineScaleSets_ListByFleet.json rename to specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListVirtualMachineScaleSets.json index f8ad3c043c5f..628c68be9aed 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/VirtualMachineScaleSets_ListByFleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListVirtualMachineScaleSets.json @@ -1,9 +1,9 @@ { - "title": "VirtualMachineScaleSets_ListByFleet", - "operationId": "VirtualMachineScaleSets_ListByFleet", + "title": "Fleets_ListVirtualMachineScaleSets", + "operationId": "Fleets_ListVirtualMachineScaleSets", "parameters": { "api-version": "2024-05-01-preview", - "subscriptionId": "7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", "resourceGroupName": "rgazurefleet", "name": "myFleet" }, @@ -12,29 +12,28 @@ "body": { "value": [ { - "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", "name": "myVmss", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", "type": "Microsoft.AzureFleet/fleets/virtualMachineScaleSets", "operationStatus": "Creating", "error": { "details": [ { - "code": "OverconstrainedAllocationRequest", - "target": "ctewy", + "code": "gzhtOverconstrainedAllocationRequestyosk", + "target": "qfthabhrmndhfizfnrwpgxvnokpy", "message": "Allocation Failed" } ], "innererror": { - "exceptiontype": "izreesvoxoftelpzpbo", - "errordetail": "hnwzlnmyqyclprdnzfumar" + "exceptiontype": "sfaomfpoaptnbxchrfskm", + "errordetail": "ihjwbwykq" }, "code": "OverconstrainedAllocationRequest", - "target": "ctewy", + "target": "nhaj", "message": "Allocation Failed" } } - ], - "nextLink": null + ] } } } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json index bbfa1f3f6ff5..621ccf96f741 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json @@ -312,11 +312,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", @@ -448,7 +443,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -457,8 +451,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -726,11 +719,6 @@ "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", From a399f3042298ff80314b79024519b1372af0eb36 Mon Sep 17 00:00:00 2001 From: abhayohri <111389143+abhayohri@users.noreply.github.com> Date: Thu, 13 Jun 2024 00:11:09 -0700 Subject: [PATCH 170/343] add preview api version missing from documentation (#29378) --- specification/resourcehealth/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resourcehealth/resource-manager/readme.md b/specification/resourcehealth/resource-manager/readme.md index 4c9643bbade8..b9d4e70c82f6 100644 --- a/specification/resourcehealth/resource-manager/readme.md +++ b/specification/resourcehealth/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the ResourceHealth API. ``` yaml openapi-type: arm -tag: package-2024-02 +tag: package-preview-2023-10 azure-validator: true ``` From 8849a525aec91f96551d4bb4685a7bfdb9607d67 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 13 Jun 2024 11:14:37 -0700 Subject: [PATCH 171/343] Set Python package dir to azure-ai-inference --- specification/ai/ModelClient/tspconfig.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index 4524b2bcd7f4..136e4c500f15 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -19,6 +19,6 @@ options: output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" "@azure-tools/typespec-python": package-mode: dataplane - package-dir: "azure-ai-inference" + package-dir: "azure-ai-runtime-inference" package-name: "{package-dir}" flavor: azure From 30c95a2a424a347f27ac78b6bdefd37f71314b7e Mon Sep 17 00:00:00 2001 From: James Suplizio Date: Thu, 13 Jun 2024 11:28:08 -0700 Subject: [PATCH 172/343] Enable linter for azure-rest-api-specs (#29434) * Enable linter for azure-rest-api-specs * set the working directory to something that exists, there is no eng/common in rest-api-specs --- .github/CODEOWNERS_baseline_errors.txt | 143 +++++++++++++++++++++++++ eng/pipelines/codeowners-linter.yml | 76 +++++++++++++ 2 files changed, 219 insertions(+) create mode 100644 .github/CODEOWNERS_baseline_errors.txt create mode 100644 eng/pipelines/codeowners-linter.yml diff --git a/.github/CODEOWNERS_baseline_errors.txt b/.github/CODEOWNERS_baseline_errors.txt new file mode 100644 index 000000000000..4132d1b57296 --- /dev/null +++ b/.github/CODEOWNERS_baseline_errors.txt @@ -0,0 +1,143 @@ +Azure/api-stewardship-board is an invalid team. Ensure the team exists and has write permissions. +nickghardwick is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +minhanh-phan is not a public member of Azure. +assafi is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +rokulka is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +ChongTang is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +Azure/adp is an invalid team. Ensure the team exists and has write permissions. +taiwu is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +ofirmanor is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +olalavi is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +erangon is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +orieldar is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +ilaizi is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +shakednai1 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +orenhor is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +promoisha is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +alexeldeib is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +ramthi is not a public member of Azure. +'Container Apps' is not a valid label for this repository. +jijohn14 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +Juliehzl is not a public member of Azure. +/specification/codesigning/data-plane path or file does not exist in repository. +/specification/asazure/ path or file does not exist in repository. +athipp is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +darshanhs90 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +vrdmr is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +deathly809 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +dpwatrous is not a public member of Azure. +/specification/batchai/ path or file does not exist in repository. +alexanderyukhanov is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +asarkar84 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +jorinmejia is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +yunhemsft is not a public member of Azure. +jessicl-ms is not a public member of Azure. +rrahulms is not a public member of Azure. +t-bzhan is not a public member of Azure. +felixwa is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +'Cognitive Services - Form Recognizer' is not a valid label for this repository. +bojunehsu is not a public member of Azure. +nizi1127 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +bilaakpan-ms is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +dkulkarni-ms is not a public member of Azure. +MS-syh2qs is not a public member of Azure. +grizzlytheodore is not a public member of Azure. +mabhard is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +danielli90 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +smotwani is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +ppatwa is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +vikramd-ms is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +yunusm is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +ZhidongPeng is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +nkuchta is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +maheshnemichand is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +najams is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +changov is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +kjeur is not a public member of Azure. +panda-wang is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +novinc is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +djyou is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +weinong is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +seguler is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +alvinli222 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +justindavies is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +robbiezhang is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +paulgmiller is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +yizhang4321 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +circy9 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +qike-ms is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +MehaKaushik is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +tjlvtao is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +zhangyd2015 is not a public member of Azure. +davidzhaoyue is not a public member of Azure. +ro-joowan is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +hitenjava is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +/specification/deploymentmanager/ path or file does not exist in repository. +netrock is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +/specification/documentdb/ path or file does not exist in repository. +dmakwana is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +jihochang is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +Kishp01 is not a public member of Azure. +ahamad-MS is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +damodaravadhani is not a public member of Azure. +/specification/features/ path or file does not exist in repository. +yugangw-msft is not a public member of Azure. +amarzavery is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +pulkittomar is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +wawon-msft is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +/specification/insights/ path or file does not exist in repository. +gucalder is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +vrmurthy01 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +randallilama is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +jlichwa is not a public member of Azure. +pankajsn is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +tonytang-microsoft-com is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +nonstatic2014 is not a public member of Azure. +/specification/machinelearningcompute/ path or file does not exist in repository. +shutchings is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +jeffrey-ace is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +giakas is not a public member of Azure. +amolr is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +smithab is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +sw47 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +dashimi16 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +rileymckenna is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +pilor is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +tarostok is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +/specification/postgresql/** ends with an unsupported sequence '/**' and will not match. Replace it with '/' +/specification/provisioningservices/ path or file does not exist in repository. +kvish is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +dragonfly91 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +sonathan is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +dheerendrarathor is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +avneeshrai is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +siddharthchatrolams is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +timlovellsmith is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +Azure/arm-template-deployments is an invalid team. Ensure the team exists and has write permissions. +rajshah11 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +vivsriaus is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +pinwang81 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +bleroy is not a public member of Azure. +tjacobhi is not a public member of Azure. +amitchat is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +craigw is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +asinn826 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +daveirwin1 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +juhacket is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +samedder is not a public member of Azure. +jamestao is not a public member of Azure. +ericshape is not a public member of Azure. +leoz-ms is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +manaas-microsoft is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +atpham256 is not a public member of Azure. +/specification/subscriptions/ path or file does not exist in repository. +navysingla is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +yanjungao718 is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +sandshadow is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +allencal is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +hrkulkarmsft is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. +naveedaz is not a public member of Azure. +Azure/azure-app-service-control-plane is an invalid team. Ensure the team exists and has write permissions. +'AzureML - Compute Instance' is not a valid label for this repository. +Azure/aml-compute-instance is an invalid team. Ensure the team exists and has write permissions. +shahabhijeet is an invalid user. Ensure the user exists, is public member of Azure and has write permissions. diff --git a/eng/pipelines/codeowners-linter.yml b/eng/pipelines/codeowners-linter.yml new file mode 100644 index 000000000000..3194eb1de851 --- /dev/null +++ b/eng/pipelines/codeowners-linter.yml @@ -0,0 +1,76 @@ +# Lint the CODEOWNERS file for a given repository and filter out baseline errors +# Note: Due to the nature of the verifications, which includes source paths/globs +# for the repository, this pipeline cannot use sparse-checkout. +trigger: none + +pr: + branches: + include: + - main + - feature/* + - hotfix/* + - release/* + paths: + include: + - .github/CODEOWNERS + - .github/CODEOWNERS_baseline_errors.txt + - eng/common/pipelines/codeowners-linter.yml + +stages: +- stage: Run + variables: + skipComponentGovernanceDetection: true + nugetMultiFeedWarnLevel: 'none' + baseBranchBaseline: '' + + jobs: + - job: Run + timeoutInMinutes: 120 + pool: + name: azsdk-pool-mms-ubuntu-2204-general + vmImage: ubuntu-22.04 + + variables: + CodeownersLinterVersion: '1.0.0-dev.20240514.2' + DotNetDevOpsFeed: "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json" + RepoLabelUri: "https://azuresdkartifacts.blob.core.windows.net/azure-sdk-write-teams/repository-labels-blob" + TeamUserUri: "https://azuresdkartifacts.blob.core.windows.net/azure-sdk-write-teams/azure-sdk-write-teams-blob" + UserOrgUri: "https://azuresdkartifacts.blob.core.windows.net/azure-sdk-write-teams/user-org-visibility-blob" + + steps: + - task: DotNetCoreCLI@2 + displayName: 'Install CodeownersLinter' + inputs: + command: custom + custom: 'tool' + arguments: 'install --global --add-source "$(DotNetDevOpsFeed)" --version "$(CodeownersLinterVersion)" "Azure.Sdk.Tools.CodeownersLinter"' + workingDirectory: '$(Build.SourcesDirectory)/eng/pipelines' + + - ${{ if eq(variables['Build.Reason'], 'PullRequest') }}: + - pwsh: | + Write-Host "git checkout $ENV:SYSTEM_PULLREQUEST_TARGETBRANCH" + git checkout $ENV:SYSTEM_PULLREQUEST_TARGETBRANCH + displayName: Checkout the base branch + + - pwsh: | + # Generate the base branch baseline file to the Build.BinariesDirectory. This will create + # a baseline error file against the CODEOWNERS in the base branch + $baseBranchBaselineFile = "$(Build.BinariesDirectory)/CODEOWNERS_BaseBranch_Baseline_errors.txt" + Write-Host "codeowners-linter --repoRoot $(Build.SourcesDirectory) --repoName $(Build.Repository.Name) -gbl -rUri ""$(RepoLabelUri)"" -tUri ""$(TeamUserUri)"" -uUri ""$(UserOrgUri)"" -bbf ""$baseBranchBaselineFile""" + codeowners-linter --repoRoot $(Build.SourcesDirectory) --repoName $(Build.Repository.Name) -gbl -rUri "$(RepoLabelUri)" -tUri "$(TeamUserUri)" -uUri "$(UserOrgUri)" -bbf "$baseBranchBaselineFile" + echo "##vso[task.setvariable variable=baseBranchBaseline]$baseBranchBaselineFile" + displayName: 'Generate baseline file for base branch' + workingDirectory: '$(Build.SourcesDirectory)/eng/pipelines' + + - pwsh: | + Write-Host "git checkout refs/remotes/pull/$ENV:SYSTEM_PULLREQUEST_PULLREQUESTNUMBER/merge" + git checkout refs/remotes/pull/$ENV:SYSTEM_PULLREQUEST_PULLREQUESTNUMBER/merge + displayName: Checkout the PR branch + + - pwsh: | + # In the case of a PR, the baseBranchBaseline will be set which will be used to further filter results. + # For scheduled runs, the baseBranchBaseline won't be set and only the existing baseline file will be used to filter + Write-Host "codeowners-linter --repoRoot $(Build.SourcesDirectory) --repoName $(Build.Repository.Name) -fbl -rUri ""$(RepoLabelUri)"" -tUri ""$(TeamUserUri)"" -uUri ""$(UserOrgUri)"" -bbf ""$(baseBranchBaseline)""" + codeowners-linter --repoRoot $(Build.SourcesDirectory) --repoName $(Build.Repository.Name) -fbl -rUri "$(RepoLabelUri)" -tUri "$(TeamUserUri)" -uUri "$(UserOrgUri)" -bbf "$(baseBranchBaseline)" + displayName: 'Lint CODEOWNERS and filter using baseline' + workingDirectory: '$(Build.SourcesDirectory)/eng/pipelines' From 1b0a8f9a31a0c232e4e0de2518eb97c5d5064c68 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 13 Jun 2024 12:56:46 -0700 Subject: [PATCH 173/343] Make sure text and image embeddings models don't show up in C# and JS emitters --- specification/ai/ModelClient/client.tsp | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 3af2820c1f07..1d6630fd99be 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -36,12 +36,12 @@ namespace Customizations; // The actual name here doesn't matter and is here for @@access(ModelClient.ChatRole, Access.public); @@access(ModelClient.CompletionsFinishReason, Access.public); @@access(ModelClient.CompletionsUsage, Access.public); -@@access(ModelClient.EmbeddingEncodingFormat, Access.public); -@@access(ModelClient.EmbeddingInput, Access.public); -@@access(ModelClient.EmbeddingInputType, Access.public); -@@access(ModelClient.EmbeddingItem, Access.public); -@@access(ModelClient.EmbeddingsResult, Access.public); -@@access(ModelClient.EmbeddingsUsage, Access.public); +@@access(ModelClient.EmbeddingEncodingFormat, Access.public, "python"); +@@access(ModelClient.EmbeddingInput, Access.public, "python"); +@@access(ModelClient.EmbeddingInputType, Access.public, "python"); +@@access(ModelClient.EmbeddingItem, Access.public, "python"); +@@access(ModelClient.EmbeddingsResult, Access.public, "python"); +@@access(ModelClient.EmbeddingsUsage, Access.public, "python"); @@access(ModelClient.FunctionCall, Access.public); @@access(ModelClient.FunctionDefinition, Access.public); @@access(ModelClient.ModelInfo, Access.public); @@ -59,8 +59,8 @@ namespace Customizations; // The actual name here doesn't matter and is here for // 2. Add hyper-params (to getChatCompletions/Embeddings/ImageEmbeddings, all clients) // 3. Cache model info (to getModelInfo, all clients, Python only) @@access(ModelClient.getChatCompletions, Access.internal, "python"); -@@access(ModelClient.getEmbeddings, Access.internal, "python"); -@@access(ModelClient.getImageEmbeddings, Access.internal, "python"); +@@access(ModelClient.getEmbeddings, Access.internal); +@@access(ModelClient.getImageEmbeddings, Access.internal); @@access(ModelClient.getModelInfo, Access.internal, "python"); // We use shorter names in the Python client library From 2209f9b8e99b43748ba6a810196b81127c48e07e Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Fri, 14 Jun 2024 13:41:42 +0800 Subject: [PATCH 174/343] tsp, avs, rename List API response schema back to ##List (#29408) --- specification/vmware/Microsoft.AVS/models.tsp | 7 + specification/vmware/Microsoft.AVS/routes.tsp | 129 ++++- .../stable/2023-09-01/vmware.json | 534 +++++++++--------- 3 files changed, 379 insertions(+), 291 deletions(-) diff --git a/specification/vmware/Microsoft.AVS/models.tsp b/specification/vmware/Microsoft.AVS/models.tsp index a9c4f74bce4a..c1989f67724b 100644 --- a/specification/vmware/Microsoft.AVS/models.tsp +++ b/specification/vmware/Microsoft.AVS/models.tsp @@ -2224,3 +2224,10 @@ model ResourceSkuRequired { @doc("The SKU (Stock Keeping Unit) assigned to this resource.") sku: Foundations.Sku; } + +@doc("The response of a {name} list operation.", Resource) +@friendlyName(FriendlyNameFormat, Resource) +model ResourceList< + Resource extends Foundations.Resource, + FriendlyNameFormat extends valueof string = "{name}List" +> is Azure.Core.Page; diff --git a/specification/vmware/Microsoft.AVS/routes.tsp b/specification/vmware/Microsoft.AVS/routes.tsp index 8a490e1c769f..6cb36ffd5f2c 100644 --- a/specification/vmware/Microsoft.AVS/routes.tsp +++ b/specification/vmware/Microsoft.AVS/routes.tsp @@ -38,9 +38,15 @@ interface Locations { interface PrivateClouds { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("PrivateClouds_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + PrivateCloud, + Response = ArmResponse> + >; - listInSubscription is ArmListBySubscription; + listInSubscription is ArmListBySubscription< + PrivateCloud, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -109,7 +115,10 @@ interface PrivateClouds { interface Clusters { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("Clusters_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + Cluster, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -167,7 +176,10 @@ interface Clusters { interface Datastores { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("Datastores_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + Datastore, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -192,7 +204,10 @@ interface Datastores { interface HcxEnterpriseSites { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("HcxEnterpriseSites_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + HcxEnterpriseSite, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -217,7 +232,10 @@ interface HcxEnterpriseSites { interface Authorizations { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("Authorizations_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + ExpressRouteAuthorization, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -247,7 +265,10 @@ interface Authorizations { interface GlobalReachConnections { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("GlobalReachConnections_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + GlobalReachConnection, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -278,14 +299,20 @@ interface WorkloadNetworks { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetwork, + Response = ArmResponse> + >; } @armResourceOperations interface WorkloadNetworkSegments { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_ListSegments") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetworkSegment, + Response = ArmResponse> + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_GetSegment") @@ -340,7 +367,10 @@ interface WorkloadNetworkSegments { interface WorkloadNetworkDhcpConfigurations { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_ListDhcp") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetworkDhcp, + Response = ArmResponse> + >; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "DhcpIdParameter should be last, but it is breaking to correct it." #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @@ -410,7 +440,10 @@ interface WorkloadNetworkDhcpConfigurations { interface WorkloadNetworkGateways { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_ListGateways") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetworkGateway, + Response = ArmResponse> + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_GetGateway") @@ -424,7 +457,10 @@ interface WorkloadNetworkGateways { interface WorkloadNetworkPortMirroringProfiles { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_ListPortMirroring") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetworkPortMirroring, + Response = ArmResponse> + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_GetPortMirroring") @@ -498,7 +534,10 @@ interface WorkloadNetworkPortMirroringProfiles { interface WorkloadNetworkVmGroups { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_ListVMGroups") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetworkVMGroup, + Response = ArmResponse> + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_GetVMGroup") @@ -570,7 +609,13 @@ interface WorkloadNetworkVmGroups { interface WorkloadNetworkVirtualMachines { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_ListVirtualMachines") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetworkVirtualMachine, + Response = ArmResponse> + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_GetVirtualMachine") @@ -584,7 +629,13 @@ interface WorkloadNetworkVirtualMachines { interface WorkloadNetworkDnsServices { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_ListDnsServices") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetworkDnsService, + Response = ArmResponse> + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_GetDnsService") @@ -658,7 +709,10 @@ interface WorkloadNetworkDnsServices { interface WorkloadNetworkDnsZones { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_ListDnsZones") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetworkDnsZone, + Response = ArmResponse> + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_GetDnsZone") @@ -731,7 +785,10 @@ interface WorkloadNetworkDnsZones { interface WorkloadNetworkPublicIps { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_ListPublicIPs") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + WorkloadNetworkPublicIP, + Response = ArmResponse> + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_GetPublicIP") @@ -782,7 +839,10 @@ interface WorkloadNetworkPublicIps { interface CloudLinks { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("CloudLinks_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + CloudLink, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -807,7 +867,10 @@ interface CloudLinks { interface Addons { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("Addons_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + Addon, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -832,7 +895,10 @@ interface Addons { interface VirtualMachines { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("VirtualMachines_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + VirtualMachine, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -854,7 +920,13 @@ interface VirtualMachines { interface PlacementPolicies { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("PlacementPolicies_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + PlacementPolicy, + Response = ArmResponse> + >; get is ArmResourceRead; @@ -910,7 +982,10 @@ interface PlacementPolicies { interface ScriptPackages { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("ScriptPackages_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + ScriptPackage, + Response = ArmResponse> + >; get is ArmResourceRead; } @@ -919,7 +994,10 @@ interface ScriptPackages { interface ScriptCmdlets { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("ScriptCmdlets_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + ScriptCmdlet, + Response = ArmResponse> + >; get is ArmResourceRead; } @@ -928,7 +1006,10 @@ interface ScriptCmdlets { interface ScriptExecutions { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("ScriptExecutions_List") - list is ArmResourceListByParent; + list is ArmResourceListByParent< + ScriptExecution, + Response = ArmResponse> + >; get is ArmResourceRead; diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json index e50c56d874fe..81a5cb077afb 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json @@ -246,7 +246,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/PrivateCloudListResult" + "$ref": "#/definitions/PrivateCloudList" } }, "default": { @@ -291,7 +291,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/PrivateCloudListResult" + "$ref": "#/definitions/PrivateCloudList" } }, "default": { @@ -610,7 +610,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/AddonListResult" + "$ref": "#/definitions/AddonList" } }, "default": { @@ -884,7 +884,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ExpressRouteAuthorizationListResult" + "$ref": "#/definitions/ExpressRouteAuthorizationList" } }, "default": { @@ -1140,7 +1140,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/CloudLinkListResult" + "$ref": "#/definitions/CloudLinkList" } }, "default": { @@ -1396,7 +1396,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ClusterListResult" + "$ref": "#/definitions/ClusterList" } }, "default": { @@ -1743,7 +1743,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/DatastoreListResult" + "$ref": "#/definitions/DatastoreList" } }, "default": { @@ -2089,7 +2089,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/PlacementPolicyListResult" + "$ref": "#/definitions/PlacementPoliciesList" } }, "default": { @@ -2468,7 +2468,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualMachineListResult" + "$ref": "#/definitions/VirtualMachinesList" } }, "default": { @@ -2662,7 +2662,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/GlobalReachConnectionListResult" + "$ref": "#/definitions/GlobalReachConnectionList" } }, "default": { @@ -2918,7 +2918,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/HcxEnterpriseSiteListResult" + "$ref": "#/definitions/HcxEnterpriseSiteList" } }, "default": { @@ -3547,7 +3547,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ScriptExecutionListResult" + "$ref": "#/definitions/ScriptExecutionsList" } }, "default": { @@ -3870,7 +3870,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ScriptPackageListResult" + "$ref": "#/definitions/ScriptPackagesList" } }, "default": { @@ -3983,7 +3983,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ScriptCmdletListResult" + "$ref": "#/definitions/ScriptCmdletsList" } }, "default": { @@ -4096,7 +4096,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkListResult" + "$ref": "#/definitions/WorkloadNetworkList" } }, "default": { @@ -4190,7 +4190,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkDhcpListResult" + "$ref": "#/definitions/WorkloadNetworkDhcpList" } }, "default": { @@ -4502,7 +4502,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsServiceListResult" + "$ref": "#/definitions/WorkloadNetworkDnsServicesList" } }, "default": { @@ -4814,7 +4814,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsZoneListResult" + "$ref": "#/definitions/WorkloadNetworkDnsZonesList" } }, "default": { @@ -5129,7 +5129,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkGatewayListResult" + "$ref": "#/definitions/WorkloadNetworkGatewayList" } }, "default": { @@ -5231,7 +5231,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkPortMirroringListResult" + "$ref": "#/definitions/WorkloadNetworkPortMirroringList" } }, "default": { @@ -5543,7 +5543,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkPublicIPListResult" + "$ref": "#/definitions/WorkloadNetworkPublicIPsList" } }, "default": { @@ -5780,7 +5780,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkSegmentListResult" + "$ref": "#/definitions/WorkloadNetworkSegmentsList" } }, "default": { @@ -6117,7 +6117,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkVirtualMachineListResult" + "$ref": "#/definitions/WorkloadNetworkVirtualMachinesList" } }, "default": { @@ -6219,7 +6219,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkloadNetworkVMGroupListResult" + "$ref": "#/definitions/WorkloadNetworkVMGroupsList" } }, "default": { @@ -6561,7 +6561,7 @@ ], "x-ms-discriminator-value": "HCX" }, - "AddonListResult": { + "AddonList": { "type": "object", "description": "The response of a Addon list operation.", "properties": { @@ -6916,7 +6916,7 @@ } ] }, - "CloudLinkListResult": { + "CloudLinkList": { "type": "object", "description": "The response of a CloudLink list operation.", "properties": { @@ -7057,7 +7057,7 @@ } ] }, - "ClusterListResult": { + "ClusterList": { "type": "object", "description": "The response of a Cluster list operation.", "properties": { @@ -7246,7 +7246,7 @@ } ] }, - "DatastoreListResult": { + "DatastoreList": { "type": "object", "description": "The response of a Datastore list operation.", "properties": { @@ -7766,7 +7766,7 @@ } ] }, - "ExpressRouteAuthorizationListResult": { + "ExpressRouteAuthorizationList": { "type": "object", "description": "The response of a ExpressRouteAuthorization list operation.", "properties": { @@ -7869,7 +7869,7 @@ } ] }, - "GlobalReachConnectionListResult": { + "GlobalReachConnectionList": { "type": "object", "description": "The response of a GlobalReachConnection list operation.", "properties": { @@ -8010,7 +8010,7 @@ } ] }, - "HcxEnterpriseSiteListResult": { + "HcxEnterpriseSiteList": { "type": "object", "description": "The response of a HcxEnterpriseSite list operation.", "properties": { @@ -8425,27 +8425,7 @@ ], "x-ms-discriminator-value": "Credential" }, - "PlacementPolicy": { - "type": "object", - "description": "A vSphere Distributed Resource Scheduler (DRS) placement policy", - "properties": { - "properties": { - "$ref": "#/definitions/PlacementPolicyProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "PlacementPolicyListResult": { + "PlacementPoliciesList": { "type": "object", "description": "The response of a PlacementPolicy list operation.", "properties": { @@ -8466,6 +8446,26 @@ "value" ] }, + "PlacementPolicy": { + "type": "object", + "description": "A vSphere Distributed Resource Scheduler (DRS) placement policy", + "properties": { + "properties": { + "$ref": "#/definitions/PlacementPolicyProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, "PlacementPolicyProperties": { "type": "object", "description": "Abstract placement policy properties", @@ -8716,7 +8716,7 @@ } ] }, - "PrivateCloudListResult": { + "PrivateCloudList": { "type": "object", "description": "The response of a PrivateCloud list operation.", "properties": { @@ -9115,27 +9115,6 @@ ] } }, - "ScriptCmdletListResult": { - "type": "object", - "description": "The response of a ScriptCmdlet list operation.", - "properties": { - "value": { - "type": "array", - "description": "The ScriptCmdlet items on this page", - "items": { - "$ref": "#/definitions/ScriptCmdlet" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "ScriptCmdletProperties": { "type": "object", "description": "Properties of a pre-canned script", @@ -9202,6 +9181,27 @@ }, "readOnly": true }, + "ScriptCmdletsList": { + "type": "object", + "description": "The response of a ScriptCmdlet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ScriptCmdlet items on this page", + "items": { + "$ref": "#/definitions/ScriptCmdlet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "ScriptExecution": { "type": "object", "description": "An instance of a script executed by a user - custom or AVS", @@ -9222,27 +9222,6 @@ } ] }, - "ScriptExecutionListResult": { - "type": "object", - "description": "The response of a ScriptExecution list operation.", - "properties": { - "value": { - "type": "array", - "description": "The ScriptExecution items on this page", - "items": { - "$ref": "#/definitions/ScriptExecution" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "ScriptExecutionParameter": { "type": "object", "description": "The arguments passed in to the execution", @@ -9452,6 +9431,27 @@ }, "readOnly": true }, + "ScriptExecutionsList": { + "type": "object", + "description": "The response of a ScriptExecution list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ScriptExecution items on this page", + "items": { + "$ref": "#/definitions/ScriptExecution" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "ScriptOutputStreamType": { "type": "string", "description": "Script Output Stream type", @@ -9508,27 +9508,6 @@ } ] }, - "ScriptPackageListResult": { - "type": "object", - "description": "The response of a ScriptPackage list operation.", - "properties": { - "value": { - "type": "array", - "description": "The ScriptPackage items on this page", - "items": { - "$ref": "#/definitions/ScriptPackage" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "ScriptPackageProperties": { "type": "object", "description": "Properties of a Script Package subresource", @@ -9591,6 +9570,27 @@ }, "readOnly": true }, + "ScriptPackagesList": { + "type": "object", + "description": "The response of a ScriptPackage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ScriptPackage items on this page", + "items": { + "$ref": "#/definitions/ScriptPackage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "ScriptParameter": { "type": "object", "description": "An parameter that the script will accept", @@ -9872,27 +9872,6 @@ } ] }, - "VirtualMachineListResult": { - "type": "object", - "description": "The response of a VirtualMachine list operation.", - "properties": { - "value": { - "type": "array", - "description": "The VirtualMachine items on this page", - "items": { - "$ref": "#/definitions/VirtualMachine" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "VirtualMachineProperties": { "type": "object", "description": "Virtual Machine Properties", @@ -9989,6 +9968,27 @@ ] } }, + "VirtualMachinesList": { + "type": "object", + "description": "The response of a VirtualMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachine items on this page", + "items": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "VisibilityParameterEnum": { "type": "string", "description": "Visibility Parameter", @@ -10182,7 +10182,7 @@ "dhcpType" ] }, - "WorkloadNetworkDhcpListResult": { + "WorkloadNetworkDhcpList": { "type": "object", "description": "The response of a WorkloadNetworkDhcp list operation.", "properties": { @@ -10367,27 +10367,6 @@ } ] }, - "WorkloadNetworkDnsServiceListResult": { - "type": "object", - "description": "The response of a WorkloadNetworkDnsService list operation.", - "properties": { - "value": { - "type": "array", - "description": "The WorkloadNetworkDnsService items on this page", - "items": { - "$ref": "#/definitions/WorkloadNetworkDnsService" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "WorkloadNetworkDnsServiceProperties": { "type": "object", "description": "NSX DNS Service Properties", @@ -10492,6 +10471,27 @@ } } }, + "WorkloadNetworkDnsServicesList": { + "type": "object", + "description": "The response of a WorkloadNetworkDnsService list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkDnsService items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkDnsService" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "WorkloadNetworkDnsZone": { "type": "object", "description": "NSX DNS Zone", @@ -10512,27 +10512,6 @@ } ] }, - "WorkloadNetworkDnsZoneListResult": { - "type": "object", - "description": "The response of a WorkloadNetworkDnsZone list operation.", - "properties": { - "value": { - "type": "array", - "description": "The WorkloadNetworkDnsZone items on this page", - "items": { - "$ref": "#/definitions/WorkloadNetworkDnsZone" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "WorkloadNetworkDnsZoneProperties": { "type": "object", "description": "NSX DNS Zone Properties", @@ -10636,6 +10615,27 @@ } } }, + "WorkloadNetworkDnsZonesList": { + "type": "object", + "description": "The response of a WorkloadNetworkDnsZone list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkDnsZone items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkDnsZone" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "WorkloadNetworkGateway": { "type": "object", "description": "NSX Gateway.", @@ -10656,7 +10656,7 @@ } ] }, - "WorkloadNetworkGatewayListResult": { + "WorkloadNetworkGatewayList": { "type": "object", "description": "The response of a WorkloadNetworkGateway list operation.", "properties": { @@ -10697,7 +10697,7 @@ } } }, - "WorkloadNetworkListResult": { + "WorkloadNetworkList": { "type": "object", "description": "The response of a WorkloadNetwork list operation.", "properties": { @@ -10738,7 +10738,7 @@ } ] }, - "WorkloadNetworkPortMirroringListResult": { + "WorkloadNetworkPortMirroringList": { "type": "object", "description": "The response of a WorkloadNetworkPortMirroring list operation.", "properties": { @@ -10936,27 +10936,6 @@ } ] }, - "WorkloadNetworkPublicIPListResult": { - "type": "object", - "description": "The response of a WorkloadNetworkPublicIP list operation.", - "properties": { - "value": { - "type": "array", - "description": "The WorkloadNetworkPublicIP items on this page", - "items": { - "$ref": "#/definitions/WorkloadNetworkPublicIP" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "WorkloadNetworkPublicIPProperties": { "type": "object", "description": "NSX Public IP Block Properties", @@ -11031,6 +11010,27 @@ }, "readOnly": true }, + "WorkloadNetworkPublicIPsList": { + "type": "object", + "description": "The response of a WorkloadNetworkPublicIP list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkPublicIP items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkPublicIP" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "WorkloadNetworkSegment": { "type": "object", "description": "NSX Segment", @@ -11051,27 +11051,6 @@ } ] }, - "WorkloadNetworkSegmentListResult": { - "type": "object", - "description": "The response of a WorkloadNetworkSegment list operation.", - "properties": { - "value": { - "type": "array", - "description": "The WorkloadNetworkSegment items on this page", - "items": { - "$ref": "#/definitions/WorkloadNetworkSegment" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "WorkloadNetworkSegmentPortVif": { "type": "object", "description": "Ports and any VIF attached to segment.", @@ -11201,6 +11180,27 @@ } } }, + "WorkloadNetworkSegmentsList": { + "type": "object", + "description": "The response of a WorkloadNetworkSegment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkSegment items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkSegment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "WorkloadNetworkVMGroup": { "type": "object", "description": "NSX VM Group", @@ -11221,27 +11221,6 @@ } ] }, - "WorkloadNetworkVMGroupListResult": { - "type": "object", - "description": "The response of a WorkloadNetworkVMGroup list operation.", - "properties": { - "value": { - "type": "array", - "description": "The WorkloadNetworkVMGroup items on this page", - "items": { - "$ref": "#/definitions/WorkloadNetworkVMGroup" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "WorkloadNetworkVMGroupProperties": { "type": "object", "description": "NSX VM Group Properties", @@ -11334,6 +11313,27 @@ } } }, + "WorkloadNetworkVMGroupsList": { + "type": "object", + "description": "The response of a WorkloadNetworkVMGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkVMGroup items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkVMGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "WorkloadNetworkVirtualMachine": { "type": "object", "description": "NSX Virtual Machine", @@ -11354,27 +11354,6 @@ } ] }, - "WorkloadNetworkVirtualMachineListResult": { - "type": "object", - "description": "The response of a WorkloadNetworkVirtualMachine list operation.", - "properties": { - "value": { - "type": "array", - "description": "The WorkloadNetworkVirtualMachine items on this page", - "items": { - "$ref": "#/definitions/WorkloadNetworkVirtualMachine" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, "WorkloadNetworkVirtualMachineProperties": { "type": "object", "description": "NSX Virtual Machine Properties", @@ -11394,6 +11373,27 @@ "readOnly": true } } + }, + "WorkloadNetworkVirtualMachinesList": { + "type": "object", + "description": "The response of a WorkloadNetworkVirtualMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkVirtualMachine items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkVirtualMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] } }, "parameters": { From 7bf13ef1c776f6d973b9645906281d0ec4660fc8 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Fri, 14 Jun 2024 14:12:35 +0800 Subject: [PATCH 175/343] avs, mgmt, rename schema via directive, for SDK backward-compatibility (#29413) * avs, mgmt, rename schema via directive, for SDK backward-compatibility * readme.go.md add directive * Update readme.python.md * fix x-ms-mutability * Update readme.typescript.md --------- Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: Yuchao Yan --- .../vmware/resource-manager/readme.go.md | 7 ++ .../vmware/resource-manager/readme.java.md | 93 +++---------------- .../vmware/resource-manager/readme.python.md | 10 ++ .../resource-manager/readme.typescript.md | 10 ++ 4 files changed, 39 insertions(+), 81 deletions(-) diff --git a/specification/vmware/resource-manager/readme.go.md b/specification/vmware/resource-manager/readme.go.md index e9640cb2376b..e87cab9ed449 100644 --- a/specification/vmware/resource-manager/readme.go.md +++ b/specification/vmware/resource-manager/readme.go.md @@ -15,6 +15,13 @@ module-name: sdk/resourcemanager/avs/armavs module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true +directive: +- from: managedidentity.json + where: definitions.SystemAssignedServiceIdentity + transform: $["x-ms-client-name"] = "PrivateCloudIdentity" +- from: managedidentity.json + where: definitions.SystemAssignedServiceIdentityType + transform: $["x-ms-enum"].name = "ResourceIdentityType" ``` ### Go multi-api diff --git a/specification/vmware/resource-manager/readme.java.md b/specification/vmware/resource-manager/readme.java.md index e49a64596c7c..a77677691c5e 100644 --- a/specification/vmware/resource-manager/readme.java.md +++ b/specification/vmware/resource-manager/readme.java.md @@ -4,86 +4,17 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.avs override-client-name: AvsClient -license-header: MICROSOFT_MIT_NO_CODEGEN -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-avs -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2021-12-01 - - tag: package-2021-06-01 - - tag: package-2021-01-01-preview - - tag: package-2020-07-17-preview - - tag: package-2020-03-20 -``` - -### Tag: package-2021-12-01 and java - -These settings apply only when `--tag=package-2021-12-01 --java` is specified on the command line. -Please also specify the `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2021-12-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.avs.v2021_12_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/avs/mgmt-v2021_12_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2021-06-01 and java - -These settings apply only when `--tag=package-2021-06-01 --java` is specified on the command line. -Please also specify the `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2021-06-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.avs.v2021_06_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/avs/mgmt-v2021_06_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2021-01-01-preview and java - -These settings apply only when `--tag=package-2021-01-01-preview -java` is specified on the command line. -Please also specify the `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2021-01-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.avs.v2021_01_01_preview - output-folder: $(azure-libraries-for-java-folder)/sdk/avs/mgmt-v2021_01_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2020-07-17-preview and java - -These settings apply only when `--tag=package-2020-07-17-preview -java` is specified on the command line. -Please also specify the `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2020-07-17-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.avs.v2020_07_17_preview - output-folder: $(azure-libraries-for-java-folder)/sdk/avs/mgmt-v2020_07_17_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2020-03-20 and java - -These settings apply only when `--tag=package-2020-03-20 --java` is specified on the command line. -Please also specify the `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2020-03-20' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.avs.v2020_03_20 - output-folder: $(azure-libraries-for-java-folder)/sdk/avs/mgmt-v2020_03_20 -regenerate-manager: true -generate-interface: true +uuid-as-string: true + +directive: +- from: managedidentity.json + where: definitions.SystemAssignedServiceIdentity + transform: $["x-ms-client-name"] = "PrivateCloudIdentity" +- from: managedidentity.json + where: definitions.SystemAssignedServiceIdentityType + transform: $["x-ms-enum"].name = "ResourceIdentityType" +- from: vmware.json + where: definitions.Addon.properties.properties + transform: $["x-ms-mutability"] = undefined ``` diff --git a/specification/vmware/resource-manager/readme.python.md b/specification/vmware/resource-manager/readme.python.md index f672623bec1a..66079d0519e8 100644 --- a/specification/vmware/resource-manager/readme.python.md +++ b/specification/vmware/resource-manager/readme.python.md @@ -18,3 +18,13 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/compute/azure-mgmt-avs/azure/mgmt/avs ``` + +``` yaml $(python) +directive: +- from: managedidentity.json + where: definitions.SystemAssignedServiceIdentity + transform: $["x-ms-client-name"] = "PrivateCloudIdentity" +- from: managedidentity.json + where: definitions.SystemAssignedServiceIdentityType + transform: $["x-ms-enum"].name = "ResourceIdentityType" +``` diff --git a/specification/vmware/resource-manager/readme.typescript.md b/specification/vmware/resource-manager/readme.typescript.md index c6984e869dc1..960eed8a1d0f 100644 --- a/specification/vmware/resource-manager/readme.typescript.md +++ b/specification/vmware/resource-manager/readme.typescript.md @@ -13,3 +13,13 @@ typescript: payload-flattening-threshold: 1 generate-metadata: true ``` + +```yaml $(typescript) +directive: +- from: managedidentity.json + where: definitions.SystemAssignedServiceIdentity + transform: $["x-ms-client-name"] = "PrivateCloudIdentity" +- from: managedidentity.json + where: definitions.SystemAssignedServiceIdentityType + transform: $["x-ms-enum"].name = "ResourceIdentityType" +``` From db63bea839f5648462c94e685d5cc96f8e8b38ba Mon Sep 17 00:00:00 2001 From: Allen Zhang Date: Fri, 14 Jun 2024 00:56:33 -0700 Subject: [PATCH 176/343] Update TypeSpec to latest 2024-06 release - 0.57 & 0.43 (#29440) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update package.json and scripts * Add typespec-azure-portal-core * Fix some deprecations from valueof PR (#29126) * [apicenter] Regen swagger to add "title" properties * [cognitiveservices] Use TypeSpec array (#[]) instead of tuple ([]) (#29213) * fix * Suppress failing rules * Fix shouldn't have `Content-Type` header * Pin typespec versioning to 0.57.0-dev.6 * Switch back to next tag for versioning library * Add new networking code owner (#29281) * Sherylueen appcomplianceautomation microsoft.app compliance automation 2024 06 27 (#28981) * Adds base for updating Microsoft.AppComplianceAutomation from version preview/2022-11-16-preview to version 2024-06-27 * Updates readme * Updates API version in new specs and examples * add new stable version for Microsoft.AppComplianceAutomation * remove the useless example file * fix spell check * remove query in get evidence api * remove the singleton annotation * fix compile error * fix compile error of v56 * fix compile error * fix all compile error and make the swagger align with before * tsp prettier * change scoping name * upgrade the commontypes from v3 to v5 * change commonTypes version to v3 * add service-dir * format tspconfig.yaml * modify tspconfig.yaml * remove custom operations * modify re pattern of snapshot name * make the resource x-ms-client-name properties * format typespec * remove suffix of snapshot * use requestBody replace parameters * Revert "use requestBody replace parameters" This reverts commit e4dd975ea2b956032e71424b71cc486b7fc15fde. * tsp format * remove dotnet from tspconfig.yaml and add azure-sdk-for-net-track2 in readme * add sdk-suppressions.yaml * Update tspconfig.yaml * Update tspconfig.yaml * rename operationid * rename getScopingQuestions and move model reportBaseProperties to alias --------- Co-authored-by: Yanwen Liu Co-authored-by: Mark Cowlishaw Co-authored-by: Yuchao Yan Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: Weidong Xu * Microsoft.ScVmm TypeSpec onboarding (#26644) * Init tsp for Microsoft.ScVmm * Some changes towards passing tsv * Updates to fix lint errors, remove unused types, regenerate examples, etc. * Created shareable 'force' param * Figured out the incantation to rename a file case-sensitively * Restored string bool enums. * Removed all examples * Regenerate examples * Updated ARM ID properties. Added script to sort output to compare with sorted old swagger * Additional changes. * Removed unused XXUpdate models, Added @secret for password, * Fixed #8, #6, #5 * Fixed #2 * Update swagger to be in sync with previous fixes. * Workaround for CloudCapacity readonly * Additional fixes. * fix ModelValidation * update void * VM Instance Update Properties changes * spell check and prettier validation fix * fix for identifier bug * workaround for https://github.com/Azure/typespec-azure/issues/449 * format * spell and prettier check improvements * use encodedName replace projectdName * Add summary annotations * summary * update kind and void * lro azure-async-operation * fix * tsp compilation warning * TypeSpec Validation fix * Update tspconfig.yaml * config change * Removed Read Only Property from Examples to fix Swagger ModelValidation * Revert Boolean to Enum with type Union in TypeSpec * specs-pr repo PR review changes to specs repo * Remove sorted json file used for comparison * Fix TypeSpec PR pipeline failure * make extendedLocation for VM Instance read and create * typespec validation fix --------- Co-authored-by: Will Temple Co-authored-by: Allen Zhang Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: Harshit Surana * Imagebuilder API Release 2024-02-01 (#28896) * Copy files from stable/2023-07-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-02-01 Updated the API version from stable/2023-07-01 to stable/2024-02-01. * Added tag for 2024-02-01 in readme file * copying over 2024-02-01 changes from ADO * Revert "copying over 2024-02-01 changes from ADO" This reverts commit aa54d741c45d0ad1636e2d28b3eb7f23be7e7884. * adding changes from ado * adding autorun as custom word * adding autorun to custom-words.txt * fixing UpdateImageTemplateVmProfile.json reference and additionalProperties error * fixing UpdateImageTemplateVmProfile.json reference and additionalProperties error * changing type from string back to object * changing type from string back to object * Revert "changing type from string back to object" This reverts commit b0b51226863d56d08b20e37b0a45829923e5883e. revert commit * Revert "fixing UpdateImageTemplateVmProfile.json reference and additionalProperties error" This reverts commit 0e52ddf7739adc6032ef6ed644baa2b4e90fd6bb. * referencing examples file * writing suppression for lintdiff * removing userassignedidentity * fixing bad version mismatch * fixing suppression * prettier changes * fixing where syntax * fixing where suppress 2 * where suppress 3 * where supress 4 * where suppress 5 * suppressing entire file * Update readme.md to show up documentation for preview version (#29165) * Update readme.python.md (#29309) * Update readme.python.md * Update readme.md --------- Co-authored-by: Yuchao Yan * Update readme.md (#29313) * Add info about `SDK azure-sdk-for-*` checks and `SDK azure-powershell` to `ci-fix` doc; Clean up markdownlint rules and `ci-fix` doc. (#29311) * Update ci-fix.md: clarify that `SDK azure-powershell` is owned by `Azure.Core`. (#29318) * Update ci-fix.md * Update ci-fix.md * Update ci-fix.md * RouteMatrix 2024-06-01-preview (#29153) * first commit * fix * Add operationType * rename to pointType * fix * update * Update example * update * update description for default value * update description * Remove axleCount for RouteMatrix * Update vehicleSpec * update description * Update description * remove async result * Revert "remove async result" This reverts commit b7b272883564048269cb93ac2f068e1d9e5ef7c2. * Remove Summary * follow azure's convention * Remove Accept-Language for RouteMatrix * Update retention period to 24 hours * Add createdDateTime * Add suppressions * Update description --------- Co-authored-by: Will Huang Co-authored-by: Joel Hendrix * [OAI-Assistant] Added Missing annotation and delete unnecessary annotation (#29297) * fixed the error * npx tsp compile updates --------- Co-authored-by: Travis Wilson Co-authored-by: Jose Alvarez * [OpenAI] [Inference] TSP definition updates for `v2024_05_01_preview` service release (#29182) * Azure OpenAI: 2024-04-01-preview updates * add audio formats * post-merge fix incl. tool update for enum conversion to union * minor: spellcheck fix * refine duration encoding for word start/end * enable serialization into azure json and rename customization class name * Added new customBlockList filter and fields to OYD * Adding changes to authentication for Vector Search * Adjusted docs for OYD vector search auth models * Added missing field and retrieved documents * Examples added * corrected examples api-versions in json * Reformat * Recompile after reformat * PR comments: wrong plural and type precision * Revert added tab to service spec Co-authored-by: Shawn Fang <45607042+mssfang@users.noreply.github.com> * Added readme entry for generated openAPI doc * Trying to improve folder structure * Removed moved and renamed generated.json files * Reverted last 3 commits * Added entry for generated.json swagger in the readme * Changed enum to nonExpandable * Ran formatter --------- Co-authored-by: Travis Wilson Co-authored-by: Travis Wilson <35748617+trrwilson@users.noreply.github.com> Co-authored-by: Shawn Fang Co-authored-by: Shawn Fang <45607042+mssfang@users.noreply.github.com> * Add v3.2 for Speech to text (3.2p2 as base) (#28664) * Add v3.2 for Speech to text (3.2p2 as base) * Update swagger with new changes and updated version number * Update readme.md with new version * Added evaluation token errors * Revert ttl changes for transcriptions * Finalized api changes for GA * Try fix avocado error * Add new api-version 2024-02-01-preview to main (#29105) * Add 2024-02-01-preview to main * fix typespec errors * remove operations.json * fix linters * delete unusued file * edit readme * remove suppressions * Update specification/azurestackhci/Operations.Management/tspconfig.yaml Co-authored-by: Mike Harder * Update specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml Co-authored-by: Mike Harder * ID to id * remove unnecessary suppress * fix examples * copy private folder changes --------- Co-authored-by: Mike Harder * Storage STG 94 (#28327) * added swagger (#28199) * [STG94] Updated STG94 Files Readme (#28201) * added swagger * updated readme * small fix * added new blob swagger (#28245) * added blob readme (#28246) * Ran prettier on the 2024-08-04 files swagger file (#28358) * Added AuthenticationErrorDetail to StorageError (#28360) * NFS Share Snapshot (#28362) * Added GetAccountInfo() API to Container and Blob level (#28297) * Storage Error Codes for Copies (#28359) * Revert "Storage Error Codes for Copies (#28359)" This reverts commit 8b14ba4a3232adb8538d96832a47dfd695904341. --------- Co-authored-by: Tamer Sherif <69483382+tasherif-msft@users.noreply.github.com> * Storage Task Assignment Swagger Updates (#29050) * SDK team improvements * Report APIs contain filtering * PR comment add more examples * Fix example path * Fix duplicate schema issue --------- Co-authored-by: Tricia Rosario * Update virtualMachine.json (#29112) remove "feature in preview" Co-authored-by: Theodore Chang * Merge release api management 2023 09 01 preview - Active (#29184) * Adds base for updating Microsoft.ApiManagement from version preview/2023-05-01-preview to version 2023-09-01-preview * Updates readme * Updates API version in new specs and examples * feat(apim): Introduce gateway resource (#27757) * WIP * Update sample * WIP * Add GatewayNameParameter * Clean up * Update sample * Add another sample * Add sample for delete gateway * Remove endpoints * Fix typo * Add list sample * Clean up Signed-off-by: Tom Kerkhove * Add disclaimer Signed-off-by: Tom Kerkhove * Make it pretty 💄 Signed-off-by: Tom Kerkhove * Refer to new file Signed-off-by: Tom Kerkhove * Add missing ApiManagementGatewayListResult Signed-off-by: Tom Kerkhove * Update sample reference Signed-off-by: Tom Kerkhove * Remove ApiManagementGatewayIdentity + List by operation Signed-off-by: Tom Kerkhove * Add more sample Signed-off-by: Tom Kerkhove * Latest version of common types Signed-off-by: Tom Kerkhove * Remove 200 for delete Signed-off-by: Tom Kerkhove * Formatting and re-order Signed-off-by: Tom Kerkhove * Align with spec Signed-off-by: Tom Kerkhove * Align sample with spec Signed-off-by: Tom Kerkhove * Error response from common types Signed-off-by: Tom Kerkhove * Rename SKU name * Have seperate SKU for patch to not make it mandatory * Remove empty required * Improve note * Rename schema * Remove unused type * sku.capacity should not be required --------- Signed-off-by: Tom Kerkhove * Add loggers, diagnostics, certificates and backends to workspace (#27262) * Add loggers to workspaces * Add diagnostics to workspace * Add certificates to workspace * Add backends to workspaces * Change DiagnosticContract to DiagnosticContractProperties in patch * Revert back DiagnosticContractProperties to DiagnosticContract * Fix CI and add files to readme * Fix example * remove reconnect endpoint * Add suppressions * Try different suppression where * Try different suppression * Try other suppression * another test * finally working suppression * remove unwanted line * remove secret examples (#28409) * Modify CircuitBreaker and BackendPool Contract (#28397) * md cb contract * modify pool contract * correct the limits --------- Co-authored-by: Samir Solanki * Common Error Response (#28408) * add operation statuses resource (#28591) * add operation statuses resource * fix api-version * Add locations/operationsResults endpoint for DELETE workflow (#28808) * add operation results * fix spec * operationresults * fix file name * feat(Workspace): Add new SkuType for Workspace (#28903) * new skutype * virtualNetworkType * remove default from patch * List skus API * add model for sku * caps enums * feat)Gateway): Adding gateway config resource (#28478) * added gateway config resource * removing Head gateway Config call * updates * resolving errors * trying to resolve more model validations * resolving some model validations * resolving model validations * resoloving delete example errors * Swagger Prettier * prettier * updating so patch has same response as get and put * removing path for gateway config * addressing comment * addressing comments * nit * path updatess * updating as per comments * Adding workspaceLinks * resolving some of the errors * resolved some errors * resolving some of the errors * resolving some more errors * npx prettier * addressing comments * updated based on comments * lint updates * nit updates --------- Co-authored-by: Samir Solanki * Fix generation errors (#29207) * fix(apim): Remove duplicate ErrorResponse schema due to move to common schema * Gateway -> ApiGateway to prevent SDK collision with self-hosted gateway * Revert "Gateway -> ApiGateway to prevent SDK collision with self-hosted gateway" This reverts commit 8d4753d36664ef91e2c4f605e422a99a5dd4854d. * Remove ApiManagement Prefix for GatewayConfigConnections * Revert "Remove ApiManagement Prefix for GatewayConfigConnections" This reverts commit 3e8197fb1845795ad97b1e6975f0495a0dca1295. * Gateway -> ApiGateway to prevent SDK collision with self-hosted gateway * Create sdk-suppressions.yaml --------- Signed-off-by: Tom Kerkhove Co-authored-by: Tom Kerkhove Co-authored-by: Rafał Mielowski Co-authored-by: Mahsa Sadi Co-authored-by: Vidisha Shah <102258037+vidishamsft@users.noreply.github.com> Co-authored-by: Yuchao Yan * Fixed typo in documentation (#29341) * Update 2023-12-01 Microsoft.Web functionAppConfig definition (#29226) * Rename enum to functionsDeploymentStorageType * Update enum name to camel case * Update enum names to camel case * Update `securityPostureReference` in VMScaleSet API (#28891) * update securityPostureRef properties in VMScaleSet spec * add securityPostureReference to UpdateVMProfile definition and fix min version * add prettier changes * remove unsupported 'major.*' from spec * add optional fields in security posture example * add required fields * correct minimum api version * add prettier fixes * remove extensionsSettings property * create new Update model for security posture reference & update * fix validation issue * Create sdk-suppressions.yaml * add azure-sdk-for-go suppression * Update sdk-suppressions.yaml --------- Co-authored-by: Dylan Martinez Co-authored-by: Yuchao Yan Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> * [Microsoft.AzureStackHCI] Add 2024-04-01 for StackHCI (#29110) * Add 2024-04-01 for StackHCI * add missing properties * add log collection job type * changes in sdk suppressions * sdk suppression changes * Enable stream-stype serialization for Java Communication Job Router (#29328) * Azure Map Rendering 20240401 (#27950) * Adds base for updating Render from version stable/2022-08-01 to version 2024-04-01 * Updates readme * Updates API version in new specs and examples * update static map API doc * small change on static map doc * update tilesetId section * add static map supported tilesetid and trafficLayer * update range table and static image example * fix typo * add additional static image example * error fix * run prettier on static image example json * set tilesetId as optional * update max/min latitude/longitude table * update Accept header for static image API * error fix * add explanation for Accept header * typo * add parameter limitation * improve wording * add path and pin parameter type * fix tables * improve on example * typo fix * run prettier * wording fix * map attribution description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * state tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map tileset description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright caption description change Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright bounding description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * weather radar tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * weather infrared tiles description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright world description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * remove pricing tiers applies * Adds base for updating Render from version stable/2022-08-01 to version 2024-04-01 * Updates readme * Updates API version in new specs and examples * update static map API doc * small change on static map doc * update tilesetId section * add static map supported tilesetid and trafficLayer * update range table and static image example * fix typo * add additional static image example * error fix * run prettier on static image example json * set tilesetId as optional * update max/min latitude/longitude table * update Accept header for static image API * error fix * add explanation for Accept header * typo * add parameter limitation * improve wording * add path and pin parameter type * fix tables * improve on example * typo fix * run prettier * wording fix * map attribution description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * state tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map tileset description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright caption description change Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright bounding description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * weather radar tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * weather infrared tiles description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright world description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * remove pricing tiers applies * reduce get copyright example length * add summary for render 20240401 * remove summary from static image * remove please from language and view * add package-2024-04-01 to readme * revert back common change * revert changes in maps readme * \n fix Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * typo fix Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * typo fix for map copyright caption Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * typo fix for statetile Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * typo fix for map copyright world Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> --------- Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> Co-authored-by: Joel Hendrix * Update directory-structure.md: clarify service, service group, uniform versioning. (#28929) * [ACS][Communication][Chat] 2024-06-05-preview public preview API spec (#28875) * Update for autorest lro support * Format * Fix issues with oracle spec from main * Update format * Update for latest dev version * Fixing typespec-next for June 2024 release (#29427) * green typespec-next * Fix DeviceRegistry * upgrade monitor to v4. Taking arm-id and subId uuid SDK breaking change. This should get rid of ModelValidation error * Update package.json --------- Signed-off-by: Tom Kerkhove Co-authored-by: Mike Harder Co-authored-by: Timothee Guerin Co-authored-by: Timothee Guerin Co-authored-by: Joanna-Yang-Art <137839107+Joanna-Yang-Art@users.noreply.github.com> Co-authored-by: Sherylueen Co-authored-by: Yanwen Liu Co-authored-by: Mark Cowlishaw Co-authored-by: Yuchao Yan Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: Weidong Xu Co-authored-by: Chenjie Shi Co-authored-by: Will Temple Co-authored-by: Harshit Surana Co-authored-by: zdelacerda-microsoft <90284189+zdelacerda-microsoft@users.noreply.github.com> Co-authored-by: raghumunukutla <55466801+raghumunukutla@users.noreply.github.com> Co-authored-by: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Co-authored-by: Konrad Jamrozik Co-authored-by: will Co-authored-by: Will Huang Co-authored-by: Joel Hendrix Co-authored-by: Shawn Fang <45607042+mssfang@users.noreply.github.com> Co-authored-by: Travis Wilson Co-authored-by: Jose Alvarez Co-authored-by: Travis Wilson <35748617+trrwilson@users.noreply.github.com> Co-authored-by: Shawn Fang Co-authored-by: Ralf Beckers Co-authored-by: shraddhasun <128851887+shraddhasun@users.noreply.github.com> Co-authored-by: Sean McCullough <44180881+seanmcc-msft@users.noreply.github.com> Co-authored-by: Tamer Sherif <69483382+tasherif-msft@users.noreply.github.com> Co-authored-by: Tricia Rosario Co-authored-by: Tricia Rosario Co-authored-by: jaclin1111 Co-authored-by: Theodore Chang Co-authored-by: Samir Solanki Co-authored-by: Tom Kerkhove Co-authored-by: Rafał Mielowski Co-authored-by: Mahsa Sadi Co-authored-by: Vidisha Shah <102258037+vidishamsft@users.noreply.github.com> Co-authored-by: Francisco Gamino Co-authored-by: Dylan Martinez Co-authored-by: Dylan Martinez Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: Priyanshi Jain <87351063+priyjain358@users.noreply.github.com> Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> Co-authored-by: miaxzhitong <146033271+miaxzhitong@users.noreply.github.com> Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> Co-authored-by: Jim Chou <77021369+jimchou-dev@users.noreply.github.com> --- package-lock.json | 194 +++--- package.json | 24 +- .../ai/DocumentIntelligence/models.tsp | 246 +++---- .../ai/DocumentIntelligence/routes.tsp | 12 +- .../ai/DocumentIntelligence/tspconfig.yaml | 1 + specification/ai/Face/main.tsp | 6 +- specification/ai/Face/models.common.tsp | 44 +- specification/ai/Face/routes.detection.tsp | 30 +- specification/ai/Face/routes.facelist.tsp | 42 +- .../ai/Face/routes.persondirectory.tsp | 48 +- specification/ai/Face/routes.persongroup.tsp | 44 +- specification/ai/Face/routes.recognition.tsp | 104 ++- specification/ai/Face/routes.session.tsp | 72 +- specification/ai/Face/tspconfig.yaml | 1 + .../model.common.fhir.elements.tsp | 106 +-- .../model.common.fhir.resources.tsp | 59 +- .../model.common.request.tsp | 58 +- .../model.common.response.tsp | 6 +- .../model.common.shared.tsp | 52 +- .../model.oncophenotype.tsp | 16 +- .../HealthInsights.OpenAPI/tspconfig.yaml | 1 + .../model.patienttimeline.tsp | 8 +- .../model.radiologyinsights.tsp | 26 +- .../model.radiologyinsights.valuesets.tsp | 6 +- .../model.trialmatcher.tsp | 134 ++-- specification/ai/ImageAnalysis/main.tsp | 6 +- specification/ai/ImageAnalysis/models.tsp | 76 +-- specification/ai/ImageAnalysis/routes.tsp | 46 +- specification/ai/ImageAnalysis/tspconfig.yaml | 1 + .../OpenAI.Assistants/assistants/models.tsp | 6 +- .../ai/OpenAI.Assistants/messages/models.tsp | 10 +- .../ai/OpenAI.Assistants/run_steps/models.tsp | 3 + .../ai/OpenAI.Assistants/runs/models.tsp | 9 +- .../ai/OpenAI.Assistants/streaming/events.tsp | 34 +- .../ai/OpenAI.Assistants/tools/models.tsp | 26 +- .../tools/tool_resources.tsp | 4 +- .../ai/OpenAI.Assistants/tspconfig.yaml | 1 + .../ApiCenter.DataApi/tspconfig.yaml | 1 + .../apicenter/ApiCenter.Management/models.tsp | 18 +- .../preview/2024-03-15-preview/apicenter.json | 55 +- .../stable/2024-03-01/apicenter.json | 49 +- .../resources/ReportResource.tsp | 5 +- .../AppConfiguration/models.tsp | 32 +- .../AppConfiguration/routes.tsp | 324 ++++----- .../AppConfiguration/tspconfig.yaml | 1 + .../stable/2023-11-01/appconfiguration.json | 143 ---- .../tspconfig.yaml | 1 + .../AzureFleet.Management/fleet.tsp | 47 +- .../azurefleet/AzureFleet.Management/main.tsp | 3 +- .../virtualMachineScaleSet.tsp | 6 +- .../2023-11-01-preview/azurefleet.json | 14 +- .../2024-05-01-preview/azurefleet.json | 14 +- .../AzureLargeInstance.tsp | 30 +- .../AzureLargeStorageInstance.tsp | 32 +- .../AzureLargeInstance.Management/models.tsp | 26 +- .../azurelargeinstance.json | 12 +- .../stable/2024-04-10/azurelargeinstance.json | 12 +- .../GalleryImages.tsp | 7 +- .../GuestAgent.tsp | 7 +- .../LogicalNetworks.tsp | 7 +- .../MarketplaceGalleryImages.tsp | 7 +- .../NetworkInterfaces.tsp | 7 +- .../NetworkSecurityGroups.tsp | 7 +- .../SecurityRules.tsp | 7 +- .../StorageContainers.tsp | 7 +- .../VirtualHardDisks.tsp | 7 +- .../VirtualMachineInstance.tsp | 7 +- .../2024-02-01-preview/stackhcivm.json | 72 +- specification/batch/Azure.Batch/common.tsp | 56 +- specification/batch/Azure.Batch/models.tsp | 430 ++++++------ specification/batch/Azure.Batch/routes.tsp | 630 +++++++++--------- .../CertificateProfile.tsp | 7 +- .../CodeSigningAccount.tsp | 7 +- .../codeSigningAccount.json | 12 +- .../AnomalyDetector/main.tsp | 40 +- .../AnomalyDetector/multivariate/models.tsp | 150 ++--- .../AnomalyDetector/multivariate/routes.tsp | 58 +- .../AnomalyDetector/tspconfig.yaml | 1 + .../AnomalyDetector/univariate/models.tsp | 224 +++---- .../AnomalyDetector/univariate/routes.tsp | 16 +- .../cognitiveservices/ContentSafety/main.tsp | 6 +- .../ContentSafety/models.tsp | 50 +- .../ContentSafety/tspconfig.yaml | 1 + .../Language.AnalyzeText/tspconfig.yaml | 1 + .../Language.Conversations/tspconfig.yaml | 1 + .../OpenAI.Inference/main.tsp | 6 +- .../models/audio/audio_speech.tsp | 4 +- .../models/audio/audio_transcription.tsp | 102 +-- .../models/audio/audio_translation.tsp | 66 +- .../completions/azure_chat_extensions.tsp | 60 +- .../completions/azure_content_filtering.tsp | 78 +-- .../models/completions/chat_completions.tsp | 120 ++-- .../models/completions/chat_messages.tsp | 55 +- .../models/completions/common.tsp | 12 +- .../models/completions/completions_create.tsp | 42 +- .../extensions/oyd/authentication.tsp | 32 +- .../extensions/oyd/azure_cosmosdb_options.tsp | 18 +- .../azure_machinelearning_index_options.tsp | 12 +- .../extensions/oyd/azure_search_options.tsp | 16 +- .../extensions/oyd/common_options.tsp | 12 +- .../extensions/oyd/elasticsearch_options.tsp | 16 +- .../extensions/oyd/pinecone_options.tsp | 12 +- .../extensions/oyd/vector_search.tsp | 42 +- .../models/completions/functions.tsp | 44 +- .../models/completions/tools.tsp | 31 +- .../models/embeddings_create.tsp | 18 +- .../OpenAI.Inference/models/images/images.tsp | 160 ++--- .../routes/audio_transcription.tsp | 12 +- .../routes/audio_translation.tsp | 8 +- .../OpenAI.Inference/routes/completions.tsp | 16 +- .../OpenAI.Inference/tspconfig.yaml | 1 + .../Communication.JobRouter/models.tsp | 26 +- .../Communication.JobRouter/tspconfig.yaml | 1 + .../Communication.Messages/tspconfig.yaml | 1 + .../Community.Management/main.tsp | 7 +- .../stable/2023-11-01/CommunityTrainings.json | 6 +- .../Microsoft.ManagedCcf/service_state.tsp | 1 + .../Fleet.Management/fleet.tsp | 9 +- .../Fleet.Management/fleetmember.tsp | 5 +- .../Fleet.Management/update/common.tsp | 16 +- .../Fleet.Management/update/run.tsp | 27 +- .../Fleet.Management/update/strategy.tsp | 5 +- .../preview/2022-09-02-preview/fleets.json | 12 +- .../preview/2023-03-15-preview/fleets.json | 18 +- .../preview/2023-06-15-preview/fleets.json | 18 +- .../preview/2023-08-15-preview/fleets.json | 24 +- .../preview/2024-02-02-preview/fleets.json | 24 +- .../fleet/stable/2023-10-15/fleets.json | 24 +- .../fleet/stable/2024-04-01/fleets.json | 24 +- .../ContainerStorage.Management/pool.tsp | 9 +- .../ContainerStorage.Management/snapshot.tsp | 7 +- .../ContainerStorage.Management/volume.tsp | 7 +- .../2023-07-01-preview/containerstorage.json | 18 +- .../Contoso.WidgetManager/tspconfig.yaml | 1 + .../DatabaseWatcher.Management/baseTarget.tsp | 1 + .../sharedPrivateLinkResource.tsp | 7 +- .../DatabaseWatcher.Management/watcher.tsp | 9 +- .../preview/2023-09-01-preview/Watcher.json | 18 +- .../devcenter/DevCenter/DevBox/models.tsp | 50 +- .../devcenter/DevCenter/DevBox/routes.tsp | 22 +- .../devcenter/DevCenter/DevCenter/routes.tsp | 6 +- .../DevCenter/Environments/models.tsp | 26 +- .../DevCenter/Environments/routes.tsp | 6 +- .../devcenter/DevCenter/shared/models.tsp | 6 +- .../devcenter/DevCenter/tspconfig.yaml | 1 + .../DeveloperSigning/main.tsp | 6 +- .../DeveloperSigning/tspconfig.yaml | 1 + .../assetEndpointProfiles.tsp | 7 +- .../DeviceRegistry.Management/assets.tsp | 7 +- .../DeviceRegistry.Management/main.tsp | 21 +- .../2023-11-01-preview/deviceregistry.json | 12 +- .../Microsoft.DevOpsInfrastructure/main.tsp | 10 +- .../devopsinfrastructure.json | 30 +- .../preview/2024-04-01-preview/edgezones.json | 6 +- .../Microsoft.Media/MediaServices.tsp | 1 + .../tspconfig.yaml | 1 + .../Azure.Messaging.EventGrid/tspconfig.yaml | 1 + .../Informatica.DataManagement/main.tsp | 18 +- .../stable/2024-05-08/openapi.json | 12 +- .../dataset.tsp | 7 +- .../instance.tsp | 7 +- .../pipeline.tsp | 7 +- .../preview/2023-10-04-preview/openapi.json | 18 +- .../IoTOperationsMQ.Management/main.tsp | 84 ++- .../models/base.tsp | 4 +- .../models/mqttbroker.tsp | 2 +- .../2023-10-04-preview/iotoperationsmq.json | 72 +- .../instance.tsp | 7 +- .../solution.tsp | 7 +- .../target.tsp | 7 +- .../preview/2023-10-04-preview/openapi.json | 18 +- .../KubernetesRuntime.Management/bgppeer.tsp | 7 +- .../loadbalancer.tsp | 7 +- .../storageclass.tsp | 7 +- .../2023-10-01-preview/kubernetesruntime.json | 24 +- .../stable/2024-03-01/kubernetesruntime.json | 24 +- .../Astronomer.Astro.Management/main.tsp | 9 +- .../2023-08-01-preview/astronomer.json | 6 +- .../LoadTestService.Management/routes.tsp | 1 + .../loadtestservice/LoadTestService/main.tsp | 4 +- .../LoadTestService/models.tsp | 208 +++--- .../LoadTestService/routes.tsp | 118 ++-- .../LoadTestService/tspconfig.yaml | 1 + .../stable/2022-12-01/loadtestservice.json | 16 +- .../Azure.AI.ChatProtocol/models/common.tsp | 16 +- .../Azure.AI.ChatProtocol/tspconfig.yaml | 1 + .../AzureAI.Assets/main.tsp | 4 +- .../AzureAI.Assets/tspconfig.yaml | 1 + .../2023-10-15-preview/mobilepacketcore.json | 42 +- .../FirewallRule.tsp | 2 + .../MongoCluster.tsp | 7 +- .../PrivateEndpointConnection.tsp | 2 + .../2024-03-01-preview/mongoCluster.json | 41 +- .../typespec/azureMonitorWorkspace.tsp | 8 +- .../typespec/pipelineGroup.tsp | 8 +- .../Microsoft.Monitor/typespec/service.tsp | 1 + .../2023-10-01-preview/azuremonitor.json | 131 ++-- .../networkfunction.tsp | 7 +- .../2023-05-15-preview/networkfunction.json | 6 +- .../NetworkAnalytics.Management/main.tsp | 22 +- .../stable/2023-11-15/networkanalytics.json | 18 +- specification/oracle/Oracle.Database/main.tsp | 1 + .../Oracle.Database/operations/commons.tsp | 22 +- .../preview/2023-09-01-preview/openapi.json | 96 +-- .../PlaywrightTesting.Management/main.tsp | 6 + .../PlaywrightTesting/tspconfig.yaml | 1 + .../2024-02-01-preview/playwrighttesting.json | 18 +- .../Extension.Management/models.tsp | 1 + .../2024-04-01-preview/copilotSettings.json | 6 +- .../apis/number.tsp | 20 +- .../tspconfig.yaml | 1 + .../Azure.Analytics.Purview.DataMap/main.tsp | 10 +- .../models.tsp | 480 ++++++------- .../routes.tsp | 586 ++++++++-------- .../tspconfig.yaml | 1 + .../PurviewPolicy.Management/backcompat.tsp | 2 +- .../common/base-operations.tsp | 8 +- .../quantum/Quantum.Workspace/main.tsp | 20 +- .../Quantum.Workspace/operations/jobs.tsp | 14 +- .../Quantum.Workspace/operations/sessions.tsp | 6 +- .../quantum/Quantum.Workspace/tspconfig.yaml | 1 + specification/riskiq/Easm/models.tsp | 3 + specification/riskiq/Easm/tspconfig.yaml | 1 + .../SchemaRegistry/tspconfig.yaml | 1 + .../stable/2021-10/schemaregistry.json | 22 - .../stable/2022-10/schemaregistry.json | 60 -- .../stable/2023-07-01/schemaregistry.json | 72 -- .../scvmm/ScVmm.Management/Cloud.tsp | 7 +- .../scvmm/ScVmm.Management/GuestAgent.tsp | 7 +- .../VirtualMachineInstance.tsp | 7 +- .../VirtualMachineTemplate.tsp | 7 +- .../scvmm/ScVmm.Management/VirtualNetwork.tsp | 7 +- .../scvmm/ScVmm.Management/VmmServer.tsp | 7 +- .../stable/2023-10-07/scvmm.json | 54 +- .../ServiceNetworking.Management/main.tsp | 28 +- .../2024-05-01-preview/TrafficController.json | 24 +- .../stable/2023-11-01/TrafficController.json | 18 +- .../sphere/Sphere.Management/catalog.tsp | 7 +- .../sphere/Sphere.Management/deployment.tsp | 7 +- .../sphere/Sphere.Management/device.tsp | 10 +- .../sphere/Sphere.Management/deviceGroup.tsp | 7 +- .../sphere/Sphere.Management/image.tsp | 7 +- .../sphere/Sphere.Management/product.tsp | 7 +- .../stable/2024-04-01/azuresphere.json | 46 +- .../main.tsp | 7 +- .../preview/2024-03-01-preview/splitio.json | 6 +- .../standbyContainerGroupPool.tsp | 7 +- .../StandbyPool.Management/standbyVMPool.tsp | 7 +- .../2023-12-01-preview/standbypool.json | 18 +- .../Azure.AI.DocumentTranslation/models.tsp | 164 ++--- .../Azure.AI.DocumentTranslation/routes.tsp | 428 ++++++------ .../tspconfig.yaml | 1 + .../Azure.AI.TextTranslation/main.tsp | 42 +- .../models-languages.tsp | 14 +- .../models-translate.tsp | 6 +- .../Azure.AI.TextTranslation/tspconfig.yaml | 1 + .../verifiedid/Microsoft.VerifiedId/main.tsp | 7 +- .../2024-01-26-preview/verifiedid.json | 6 +- specification/vmware/Microsoft.AVS/models.tsp | 114 ++-- specification/vmware/Microsoft.AVS/routes.tsp | 122 +++- .../stable/2023-09-01/vmware.json | 147 +--- .../VoiceServices.Provisioning/tspconfig.yaml | 1 + .../SAPDiscoverySite.tsp | 7 +- .../SAPInstance.tsp | 7 +- .../ServerInstance.tsp | 7 +- .../Monitor.tsp | 7 +- .../ProviderInstance.tsp | 7 +- .../models.tsp | 1 + .../2023-10-01-preview/SAPDiscoverySites.json | 18 +- .../preview/2023-12-01-preview/monitors.json | 18 +- 270 files changed, 4523 insertions(+), 5141 deletions(-) diff --git a/package-lock.json b/package-lock.json index 81e199d8467f..cf58c9a3a61b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,19 +7,19 @@ "name": "azure-rest-api-specs", "devDependencies": { "@azure-tools/typespec-apiview": "0.4.8", - "@azure-tools/typespec-autorest": "0.42.1", - "@azure-tools/typespec-azure-core": "0.42.0", - "@azure-tools/typespec-azure-portal-core": "0.42.0", - "@azure-tools/typespec-azure-resource-manager": "0.42.1", - "@azure-tools/typespec-azure-rulesets": "0.42.1", - "@azure-tools/typespec-client-generator-core": "0.42.3", + "@azure-tools/typespec-autorest": "0.43.0", + "@azure-tools/typespec-azure-core": "0.43.0", + "@azure-tools/typespec-azure-portal-core": "0.43.0", + "@azure-tools/typespec-azure-resource-manager": "0.43.0", + "@azure-tools/typespec-azure-rulesets": "0.43.0", + "@azure-tools/typespec-client-generator-core": "0.43.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.56.0", - "@typespec/http": "0.56.0", - "@typespec/openapi": "0.56.0", - "@typespec/openapi3": "0.56.0", - "@typespec/rest": "0.56.0", - "@typespec/versioning": "0.56.0", + "@typespec/compiler": "0.57.0", + "@typespec/http": "0.57.0", + "@typespec/openapi": "0.57.0", + "@typespec/openapi3": "0.57.0", + "@typespec/rest": "0.57.0", + "@typespec/versioning": "0.57.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.2.5", @@ -419,51 +419,52 @@ } }, "node_modules/@azure-tools/typespec-autorest": { - "version": "0.42.1", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.42.1.tgz", - "integrity": "sha512-egWR2Ljxde5PvyDwuVu/8Rq8cSW6FW+qMbvwHfzrtm/sULdSnA6k+VnGD/PQ+dk+1SmFeKG1b+0MlaFuBVz1Hw==", + "version": "0.43.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.43.0.tgz", + "integrity": "sha512-tZ9uXXOdxu2y01W9n3mzXf+IEY2MQkP/JaQaKlcOx2+dbklHNQWSDU0Vm6Gmm6l//XiF9QiI8653BiuO97czyw==", "dev": true, "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.42.0", - "@azure-tools/typespec-client-generator-core": "~0.42.0", - "@typespec/compiler": "~0.56.0", - "@typespec/http": "~0.56.0", - "@typespec/openapi": "~0.56.0", - "@typespec/rest": "~0.56.0", - "@typespec/versioning": "~0.56.0" + "@azure-tools/typespec-azure-core": "~0.43.0", + "@azure-tools/typespec-azure-resource-manager": "~0.43.0", + "@azure-tools/typespec-client-generator-core": "~0.43.0", + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0", + "@typespec/openapi": "~0.57.0", + "@typespec/rest": "~0.57.0", + "@typespec/versioning": "~0.57.0" } }, "node_modules/@azure-tools/typespec-azure-core": { - "version": "0.42.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.42.0.tgz", - "integrity": "sha512-8C96RkgSWtgqsaHRMWCd2iDltFJZTGmFQiTZazZj/uRy0Wn1ikjSriSN8t1puL5SiUPd0BVJP/YXiwAfjfZYDA==", + "version": "0.43.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.43.0.tgz", + "integrity": "sha512-B1r0i3segJ7RuNXxcAMBy8H2t+jTkaf74dkyUWD0HIFPkhETN0uR59nuor+s+LoLU8yI4JypOFSNZt6e1rod8w==", "dev": true, "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.56.0", - "@typespec/http": "~0.56.0", - "@typespec/rest": "~0.56.0" + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0", + "@typespec/rest": "~0.57.0" } }, "node_modules/@azure-tools/typespec-azure-portal-core": { - "version": "0.42.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-portal-core/-/typespec-azure-portal-core-0.42.0.tgz", - "integrity": "sha512-3RSAC/tUoZ74wXrPHupJB1qLhQNnm00OUDZU9YJ8Wv5NNEr1aar1z2luyhR9SWDk42B+snhnzm9hH5CHxtk1lA==", + "version": "0.43.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-portal-core/-/typespec-azure-portal-core-0.43.0.tgz", + "integrity": "sha512-I/EHlE27zB7arteyg1kNSKua0Uip8qbcLCYYEhdP0NzpEVqcA2mdEnwmc6xjP7/Tg3X0FeGf8Bc+UTSHK5zr/g==", "dev": true, "peerDependencies": { - "@azure-tools/typespec-azure-resource-manager": "~0.42.0", - "@typespec/compiler": "~0.56.0" + "@azure-tools/typespec-azure-resource-manager": "~0.43.0", + "@typespec/compiler": "~0.57.0" } }, "node_modules/@azure-tools/typespec-azure-resource-manager": { - "version": "0.42.1", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.42.1.tgz", - "integrity": "sha512-vUqmHWS9OrN+16jXfpgUdUXXa1RLrr8Pkrzb1HFQGmdXuRxMZZtLCRcyyEHZJIMYE4RmmpPoB3JJeqiGWxlegQ==", + "version": "0.43.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.43.0.tgz", + "integrity": "sha512-0GQL+/o1u+PAB63FpYz3sy3ZgZvCtk5T4sDAnICnV23v2YWIONDMUfxxd0x40xJbY6PkcwwHDpBLNMqajf2H6A==", "dev": true, "dependencies": { "change-case": "~5.4.4", @@ -473,37 +474,34 @@ "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-autorest": "~0.42.1", - "@azure-tools/typespec-azure-core": "~0.42.0", - "@typespec/compiler": "~0.56.0", - "@typespec/http": "~0.56.0", - "@typespec/openapi": "~0.56.0", - "@typespec/rest": "~0.56.0", - "@typespec/versioning": "~0.56.0" + "@azure-tools/typespec-azure-core": "~0.43.0", + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0", + "@typespec/openapi": "~0.57.0", + "@typespec/rest": "~0.57.0", + "@typespec/versioning": "~0.57.0" } }, "node_modules/@azure-tools/typespec-azure-rulesets": { - "version": "0.42.1", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-rulesets/-/typespec-azure-rulesets-0.42.1.tgz", - "integrity": "sha512-GRiMErWJ96DvDBQMVgGI1sgMTOegXxpx7w6enZyEF0BaodxGfObJyl1TrMb9Pj6NAZfV5Q6uJAfXFbpF1MVDCw==", + "version": "0.43.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-rulesets/-/typespec-azure-rulesets-0.43.0.tgz", + "integrity": "sha512-yh0dNQIM4hRDWATh/tkONP991uMxFDHY8BkC0eWtIpfTjQTuR2PlGhrLgMxHT2Q5cCusfkNWeFvKDYlxKeoFLA==", "dev": true, - "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.42.0", - "@azure-tools/typespec-azure-resource-manager": "~0.42.1", - "@azure-tools/typespec-client-generator-core": "~0.42.3", - "@typespec/compiler": "~0.56.0" + "@azure-tools/typespec-azure-core": "~0.43.0", + "@azure-tools/typespec-azure-resource-manager": "~0.43.0", + "@azure-tools/typespec-client-generator-core": "~0.43.0", + "@typespec/compiler": "~0.57.0" } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.42.3", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.42.3.tgz", - "integrity": "sha512-ZDVVIY1uJ8EaI4QhCdQmTdKVACm4xYn/I7ySpwv4oxk9X8kZFhxx+PKNHAlx34mhOf4oF0PW3wCN5DMeU6asYg==", + "version": "0.43.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.43.0.tgz", + "integrity": "sha512-rssB/zsg89wstzJC1MWzbd8oPpqbgoftkp9G/NP3BoMb/gCP5uRLggwlSUAgnoU2Lt0jBUKcMlqEiVLTAkY9LA==", "dev": true, - "license": "MIT", "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0" @@ -512,11 +510,11 @@ "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.42.0", - "@typespec/compiler": "~0.56.0", - "@typespec/http": "~0.56.0", - "@typespec/rest": "~0.56.0", - "@typespec/versioning": "~0.56.0" + "@azure-tools/typespec-azure-core": "~0.43.0", + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0", + "@typespec/rest": "~0.57.0", + "@typespec/versioning": "~0.57.0" } }, "node_modules/@azure-tools/typespec-validation": { @@ -1964,23 +1962,23 @@ } }, "node_modules/@typespec/compiler": { - "version": "0.56.0", - "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.56.0.tgz", - "integrity": "sha512-K+VhXycoeqcoSGtB0/l1XYco4V2qRsCOOwqklVM4Yew7kTcKVfz7CT7a6a2OKWDMNg5iijZtRBoM5YF50XtQug==", + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.57.0.tgz", + "integrity": "sha512-Z5L7J90Ol21IbzU+rBD2wzKy2vJ2Yg2FIzi+yB5rtb7/c4oBea/CgEByMVHBtT7uw45ZXJpHOiepuGSPVXw2EA==", "dev": true, "dependencies": { "@babel/code-frame": "~7.24.2", - "ajv": "~8.12.0", + "ajv": "~8.13.0", "change-case": "~5.4.4", "globby": "~14.0.1", "mustache": "~4.2.0", - "picocolors": "~1.0.0", + "picocolors": "~1.0.1", "prettier": "~3.2.5", "prompts": "~2.4.2", - "semver": "^7.6.0", + "semver": "^7.6.2", "vscode-languageserver": "~9.0.1", "vscode-languageserver-textdocument": "~1.0.11", - "yaml": "~2.4.1", + "yaml": "~2.4.2", "yargs": "~17.7.2" }, "bin": { @@ -2092,71 +2090,71 @@ } }, "node_modules/@typespec/http": { - "version": "0.56.0", - "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.56.0.tgz", - "integrity": "sha512-f/tpHRWev9bnAtNPFkfCU/5SFou9glA/rPDY0m2W5bK6EG1/6/TKKKz5FoKPA4xvc2dQ5vu/ouGLb4i5UzXvWQ==", + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.57.0.tgz", + "integrity": "sha512-k3bWOTPNqlRB3/TmrXVBtObmxj2J20l2FnhGXvs+tjdtbXLxCQWmvQz6xlne9nkLAtWVB/pQRUn+oMJfhWta3w==", "dev": true, "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.56.0" + "@typespec/compiler": "~0.57.0" } }, "node_modules/@typespec/openapi": { - "version": "0.56.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.56.0.tgz", - "integrity": "sha512-q8+IHRglXBm3slvonRLSNYN2fX7plbWA+ugIiMJZTeyc3enqfxPqMGA8BCiAFV3kwP0uPPpIXbCSIVhHgkONbA==", + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.57.0.tgz", + "integrity": "sha512-35wK/BqjOXSlhWuGMwoYN3FSgIYFOKtw8ot4ErcgmxAGuKaS2GkUhZvtQJXUn2ByU0Fl4jqslPmTz8SEcz7rbw==", "dev": true, "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.56.0", - "@typespec/http": "~0.56.0" + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0" } }, "node_modules/@typespec/openapi3": { - "version": "0.56.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.56.0.tgz", - "integrity": "sha512-55JPUP7dFk4iXn4fNKZEs76j7hAdlWfoMWNPsQPRJCP//KWCtNXfTP+/TTVPVv1L/6HztbXyPV0agKZwyS7gDw==", + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.57.0.tgz", + "integrity": "sha512-spNLzwCTduPISJBTWhqsMLTjuGC3Tdh/FVI1rTGnRunB7ZXjhRyz031o1bCe2BZeW1w1sacZGfe+ba8sXqgMxA==", "dev": true, "dependencies": { - "yaml": "~2.4.1" + "yaml": "~2.4.2" }, "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.56.0", - "@typespec/http": "~0.56.0", - "@typespec/openapi": "~0.56.0", - "@typespec/versioning": "~0.56.0" + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0", + "@typespec/openapi": "~0.57.0", + "@typespec/versioning": "~0.57.0" } }, "node_modules/@typespec/rest": { - "version": "0.56.0", - "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.56.0.tgz", - "integrity": "sha512-8w4WhWDcpEQNW8bB1BHhiBxIQUChDJtyq/n9p2OI/Bm1wncd61y/ZNOtcxmlKq8uB9d+dzHiZdEfqFCR8HF8/Q==", + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.57.0.tgz", + "integrity": "sha512-mZj76Kf+cmH38pYA6LT8Zz7QjuR3fdQo5bc8pXhKMwLq9vRqNLz6Z9InbOeo8zY+xP0GfUwEU9kXczmCc8gyRA==", "dev": true, "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.56.0", - "@typespec/http": "~0.56.0" + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0" } }, "node_modules/@typespec/versioning": { - "version": "0.56.0", - "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.56.0.tgz", - "integrity": "sha512-j7IN9XFyGn3LH6IOJkinEvk9sDncsxiWPULOAe0VQ+D/dtCfLawDMUALnvklMDRKeD1OOUPSCjjUAp9OB0f7YA==", + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.57.0.tgz", + "integrity": "sha512-kk6zCNSwcqqYB9isNNagTy+Zv6wEIRA4NkcZ/X1riTj2zhJwKsIFNXQWm1yxpZn+BY4+1QtuaQHuBLo8HbgR/w==", "dev": true, "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.56.0" + "@typespec/compiler": "~0.57.0" } }, "node_modules/@vitest/expect": { @@ -2277,15 +2275,15 @@ } }, "node_modules/ajv": { - "version": "8.12.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz", - "integrity": "sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==", + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.13.0.tgz", + "integrity": "sha512-PRA911Blj99jR5RMeTunVbNXMF6Lp4vZXnk5GQjcnUWUTsrXtekg/pnmFFI2u/I36Y/2bITGS30GZCXei6uNkA==", "dev": true, "dependencies": { - "fast-deep-equal": "^3.1.1", + "fast-deep-equal": "^3.1.3", "json-schema-traverse": "^1.0.0", "require-from-string": "^2.0.2", - "uri-js": "^4.2.2" + "uri-js": "^4.4.1" }, "funding": { "type": "github", diff --git a/package.json b/package.json index 9ccc0baed0a3..9b953df05fc1 100644 --- a/package.json +++ b/package.json @@ -2,19 +2,19 @@ "name": "azure-rest-api-specs", "devDependencies": { "@azure-tools/typespec-apiview": "0.4.8", - "@azure-tools/typespec-autorest": "0.42.1", - "@azure-tools/typespec-azure-core": "0.42.0", - "@azure-tools/typespec-azure-portal-core": "0.42.0", - "@azure-tools/typespec-azure-resource-manager": "0.42.1", - "@azure-tools/typespec-client-generator-core": "0.42.3", - "@azure-tools/typespec-azure-rulesets": "0.42.1", + "@azure-tools/typespec-autorest": "0.43.0", + "@azure-tools/typespec-azure-core": "0.43.0", + "@azure-tools/typespec-azure-portal-core": "0.43.0", + "@azure-tools/typespec-azure-resource-manager": "0.43.0", + "@azure-tools/typespec-client-generator-core": "0.43.0", + "@azure-tools/typespec-azure-rulesets": "0.43.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.56.0", - "@typespec/http": "0.56.0", - "@typespec/openapi": "0.56.0", - "@typespec/openapi3": "0.56.0", - "@typespec/rest": "0.56.0", - "@typespec/versioning": "0.56.0", + "@typespec/compiler": "0.57.0", + "@typespec/http": "0.57.0", + "@typespec/openapi": "0.57.0", + "@typespec/openapi3": "0.57.0", + "@typespec/rest": "0.57.0", + "@typespec/versioning": "0.57.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.2.5", diff --git a/specification/ai/DocumentIntelligence/models.tsp b/specification/ai/DocumentIntelligence/models.tsp index 6a5ceeaff2ad..601541e2a649 100644 --- a/specification/ai/DocumentIntelligence/models.tsp +++ b/specification/ai/DocumentIntelligence/models.tsp @@ -18,18 +18,18 @@ union StringIndexType { string, @doc(""" - User-perceived display character, or grapheme cluster, as defined by Unicode - 8.0.0. - """) + User-perceived display character, or grapheme cluster, as defined by Unicode + 8.0.0. + """) textElements: "textElements", @doc("Character unit represented by a single unicode code point. Used by Python 3.") unicodeCodePoint: "unicodeCodePoint", @doc(""" - Character unit represented by a 16-bit Unicode code unit. Used by JavaScript, - Java, and .NET. - """) + Character unit represented by a 16-bit Unicode code unit. Used by JavaScript, + Java, and .NET. + """) utf16CodeUnit: "utf16CodeUnit", } @@ -41,9 +41,9 @@ union ContentFormat { text: "text", @doc(""" - Markdown representation of the document content with section headings, tables, - etc. - """) + Markdown representation of the document content with section headings, tables, + etc. + """) markdown: "markdown", } @@ -85,9 +85,9 @@ union DocumentSelectionMarkState { string, @doc(""" - The selection mark is selected, often indicated by a check ✓ or cross X inside - the selection mark. - """) + The selection mark is selected, often indicated by a check ✓ or cross X inside + the selection mark. + """) "selected", @doc("The selection mark is not selected.") @@ -279,9 +279,9 @@ union OperationKind { documentModelCompose: "documentModelCompose", @doc(""" - Copy an existing document model to potentially a different resource, region, or - subscription. - """) + Copy an existing document model to potentially a different resource, region, or + subscription. + """) documentModelCopyTo: "documentModelCopyTo", @doc("Build a new custom classifier model.") @@ -354,9 +354,9 @@ model AnalyzeDocumentRequest { urlSource?: url; @doc(""" - Base64 encoding of the document to analyze. Either urlSource or base64Source - must be specified. - """) + Base64 encoding of the document to analyze. Either urlSource or base64Source + must be specified. + """) base64Source?: bytes; } @@ -448,9 +448,9 @@ model AnalyzeResult { contentFormat?: ContentFormat; @doc(""" - Concatenate string representation of all textual and visual elements in reading - order. - """) + Concatenate string representation of all textual and visual elements in reading + order. + """) content: string; @doc("Analyzed pages.") @@ -491,9 +491,9 @@ model DocumentPage { pageNumber: int32; @doc(""" - The general orientation of the content in clockwise direction, measured in - degrees between (-180, 180]. - """) + The general orientation of the content in clockwise direction, measured in + degrees between (-180, 180]. + """) @minValueExclusive(-180) @maxValue(180) angle?: float32; @@ -507,9 +507,9 @@ model DocumentPage { height?: float32; @doc(""" - The unit used by the width, height, and polygon properties. For images, the - unit is \"pixel\". For PDF, the unit is \"inch\". - """) + The unit used by the width, height, and polygon properties. For images, the + unit is \"pixel\". For PDF, the unit is \"inch\". + """) unit?: LengthUnit; @doc("Location of the page in the reading order concatenated content.") @@ -522,9 +522,9 @@ model DocumentPage { selectionMarks?: DocumentSelectionMark[]; @doc(""" - Extracted lines from the page, potentially containing both textual and visual - elements. - """) + Extracted lines from the page, potentially containing both textual and visual + elements. + """) lines?: DocumentLine[]; @doc("Extracted barcodes from the page.") @@ -535,9 +535,9 @@ model DocumentPage { } @doc(""" -Contiguous region of the concatenated content property, specified as an offset -and length. -""") + Contiguous region of the concatenated content property, specified as an offset + and length. + """) model DocumentSpan { @doc("Zero-based index of the content represented by the span.") @minValue(0) @@ -549,21 +549,21 @@ model DocumentSpan { } @doc(""" -A word object consisting of a contiguous sequence of characters. For non-space -delimited languages, such as Chinese, Japanese, and Korean, each character is -represented as its own word. -""") + A word object consisting of a contiguous sequence of characters. For non-space + delimited languages, such as Chinese, Japanese, and Korean, each character is + represented as its own word. + """) model DocumentWord { @doc("Text content of the word.") content: string; // FIXME: No way to specify constraints on array elements without creating new scalar types. @doc(""" - Bounding polygon of the word, with coordinates specified relative to the - top-left of the page. The numbers represent the x, y values of the polygon - vertices, clockwise from the left (-180 degrees inclusive) relative to the - element orientation. - """) + Bounding polygon of the word, with coordinates specified relative to the + top-left of the page. The numbers represent the x, y values of the polygon + vertices, clockwise from the left (-180 degrees inclusive) relative to the + element orientation. + """) polygon?: float32[]; @doc("Location of the word in the reading order concatenated content.") @@ -576,19 +576,19 @@ model DocumentWord { } @doc(""" -A selection mark object representing check boxes, radio buttons, and other -elements indicating a selection. -""") + A selection mark object representing check boxes, radio buttons, and other + elements indicating a selection. + """) model DocumentSelectionMark { @doc("State of the selection mark.") state: DocumentSelectionMarkState; @doc(""" - Bounding polygon of the selection mark, with coordinates specified relative - to the top-left of the page. The numbers represent the x, y values of the - polygon vertices, clockwise from the left (-180 degrees inclusive) relative - to the element orientation. - """) + Bounding polygon of the selection mark, with coordinates specified relative + to the top-left of the page. The numbers represent the x, y values of the + polygon vertices, clockwise from the left (-180 degrees inclusive) relative + to the element orientation. + """) polygon?: float32[]; @doc("Location of the selection mark in the reading order concatenated content.") @@ -601,19 +601,19 @@ model DocumentSelectionMark { } @doc(""" -A content line object consisting of an adjacent sequence of content elements, -such as words and selection marks. -""") + A content line object consisting of an adjacent sequence of content elements, + such as words and selection marks. + """) model DocumentLine { @doc("Concatenated content of the contained elements in reading order.") content: string; @doc(""" - Bounding polygon of the line, with coordinates specified relative to the - top-left of the page. The numbers represent the x, y values of the polygon - vertices, clockwise from the left (-180 degrees inclusive) relative to the - element orientation. - """) + Bounding polygon of the line, with coordinates specified relative to the + top-left of the page. The numbers represent the x, y values of the polygon + vertices, clockwise from the left (-180 degrees inclusive) relative to the + element orientation. + """) polygon?: float32[]; @doc("Location of the line in the reading order concatenated content.") @@ -629,11 +629,11 @@ model DocumentBarcode { value: string; @doc(""" - Bounding polygon of the barcode, with coordinates specified relative to the - top-left of the page. The numbers represent the x, y values of the polygon - vertices, clockwise from the left (-180 degrees inclusive) relative to the - element orientation. - """) + Bounding polygon of the barcode, with coordinates specified relative to the + top-left of the page. The numbers represent the x, y values of the polygon + vertices, clockwise from the left (-180 degrees inclusive) relative to the + element orientation. + """) polygon?: float32[]; @doc("Location of the barcode in the reading order concatenated content.") @@ -654,11 +654,11 @@ model DocumentFormula { value: string; @doc(""" - Bounding polygon of the formula, with coordinates specified relative to the - top-left of the page. The numbers represent the x, y values of the polygon - vertices, clockwise from the left (-180 degrees inclusive) relative to the - element orientation. - """) + Bounding polygon of the formula, with coordinates specified relative to the + top-left of the page. The numbers represent the x, y values of the polygon + vertices, clockwise from the left (-180 degrees inclusive) relative to the + element orientation. + """) polygon?: float32[]; @doc("Location of the formula in the reading order concatenated content.") @@ -671,9 +671,9 @@ model DocumentFormula { } @doc(""" -A paragraph object consisting with contiguous lines generally with common -alignment and spacing. -""") + A paragraph object consisting with contiguous lines generally with common + alignment and spacing. + """) model DocumentParagraph { @doc("Semantic role of the paragraph.") role?: ParagraphRole; @@ -695,11 +695,11 @@ model BoundingRegion { pageNumber: int32; @doc(""" - Bounding polygon on the page, or the entire page if not specified. - Coordinates specified relative to the top-left of the page. The numbers - represent the x, y values of the polygon vertices, clockwise from the left - (-180 degrees inclusive) relative to the element orientation. - """) + Bounding polygon on the page, or the entire page if not specified. + Coordinates specified relative to the top-left of the page. The numbers + represent the x, y values of the polygon vertices, clockwise from the left + (-180 degrees inclusive) relative to the element orientation. + """) polygon: float32[]; } @@ -848,15 +848,15 @@ model DocumentFootnote { } @doc(""" -An JSON pointer referencing an element of the document, such as paragraph, -table, section, etc. -""") + An JSON pointer referencing an element of the document, such as paragraph, + table, section, etc. + """) scalar DocumentElement extends string; @doc(""" -An object representing a form field with distinct field label (key) and field -value (may be empty). -""") + An object representing a form field with distinct field label (key) and field + value (may be empty). + """) model DocumentKeyValuePair { @doc("Field label of the key-value pair.") key: DocumentKeyValueElement; @@ -888,9 +888,9 @@ model DocumentStyle { isHandwritten?: boolean; @doc(""" - Visually most similar font from among the set of supported font families, with - fallback fonts following CSS convention (ex. 'Arial, sans-serif'). - """) + Visually most similar font from among the set of supported font families, with + fallback fonts following CSS convention (ex. 'Arial, sans-serif'). + """) similarFontFamily?: string; @doc("Font style.") @@ -919,15 +919,15 @@ model DocumentStyle { @doc("An object representing the detected language for a given text span.") model DocumentLanguage { @doc(""" - Detected language. Value may an ISO 639-1 language code (ex. \"en\", \"fr\") - or BCP 47 language tag (ex. \"zh-Hans\"). - """) + Detected language. Value may an ISO 639-1 language code (ex. \"en\", \"fr\") + or BCP 47 language tag (ex. \"zh-Hans\"). + """) locale: string; @doc(""" - Location of the text elements in the concatenated content the language applies - to. - """) + Location of the text elements in the concatenated content the language applies + to. + """) spans: DocumentSpan[]; @doc("Confidence of correctly identifying the language.") @@ -1067,9 +1067,9 @@ model AddressValue { unit?: string; @doc(""" - Districts or boroughs within a city, such as Brooklyn in New York City or City - of Westminster in London. - """) + Districts or boroughs within a city, such as Brooklyn in New York City or City + of Westminster in London. + """) cityDistrict?: string; @doc("Second-level administrative division used in certain locales.") @@ -1099,15 +1099,15 @@ model BuildDocumentModelRequest { buildMode: DocumentBuildMode; @doc(""" - Azure Blob Storage location containing the training data. Either - azureBlobSource or azureBlobFileListSource must be specified. - """) + Azure Blob Storage location containing the training data. Either + azureBlobSource or azureBlobFileListSource must be specified. + """) azureBlobSource?: AzureBlobContentSource; @doc(""" - Azure Blob Storage file list specifying the training data. Either - azureBlobSource or azureBlobFileListSource must be specified. - """) + Azure Blob Storage file list specifying the training data. Either + azureBlobSource or azureBlobFileListSource must be specified. + """) azureBlobFileListSource?: AzureBlobFileListContentSource; @doc("List of key-value tag attributes associated with the document model.") @@ -1172,18 +1172,18 @@ model AuthorizeCopyRequest { } @doc(""" -Authorization to copy a document model to the specified target resource and -modelId. -""") + Authorization to copy a document model to the specified target resource and + modelId. + """) model CopyAuthorization { @doc("ID of the target Azure resource where the document model should be copied to.") @extension("x-ms-azure-resource", true) targetResourceId: string; @doc(""" - Location of the target Azure resource where the document model should be copied - to. - """) + Location of the target Azure resource where the document model should be copied + to. + """) targetResourceRegion: string; @doc("Identifier of the target document model.") @@ -1268,15 +1268,15 @@ model DocumentModelDetails { buildMode?: DocumentBuildMode; @doc(""" - Azure Blob Storage location containing the training data. Either - azureBlobSource or azureBlobFileListSource must be specified. - """) + Azure Blob Storage location containing the training data. Either + azureBlobSource or azureBlobFileListSource must be specified. + """) azureBlobSource?: AzureBlobContentSource; @doc(""" - Azure Blob Storage file list specifying the training data. Either - azureBlobSource or azureBlobFileListSource must be specified. - """) + Azure Blob Storage file list specifying the training data. Either + azureBlobSource or azureBlobFileListSource must be specified. + """) azureBlobFileListSource?: AzureBlobFileListContentSource; @doc("Supported document types.") @@ -1348,17 +1348,17 @@ model ClassifierDocumentTypeDetails { sourceKind?: ContentSourceKind; @doc(""" - Azure Blob Storage location containing the training data for a classifier - document type. Either azureBlobSource or azureBlobFileListSource must be - specified. - """) + Azure Blob Storage location containing the training data for a classifier + document type. Either azureBlobSource or azureBlobFileListSource must be + specified. + """) azureBlobSource?: AzureBlobContentSource; @doc(""" - Azure Blob Storage file list specifying the training data for a classifier - document type. Either azureBlobSource or azureBlobFileListSource must be - specified. - """) + Azure Blob Storage file list specifying the training data for a classifier + document type. Either azureBlobSource or azureBlobFileListSource must be + specified. + """) azureBlobFileListSource?: AzureBlobFileListContentSource; } @@ -1404,9 +1404,9 @@ model ClassifyDocumentRequest { urlSource?: url; @doc(""" - Base64 encoding of the document to classify. Either urlSource or base64Source - must be specified. - """) + Base64 encoding of the document to classify. Either urlSource or base64Source + must be specified. + """) base64Source?: bytes; } diff --git a/specification/ai/DocumentIntelligence/routes.tsp b/specification/ai/DocumentIntelligence/routes.tsp index 4b2e61453ada..f97b79eb289c 100644 --- a/specification/ai/DocumentIntelligence/routes.tsp +++ b/specification/ai/DocumentIntelligence/routes.tsp @@ -52,9 +52,9 @@ model DocumentModelAnalyzeRequestParams { pages?: string; @doc(""" - Locale hint for text recognition and document analysis. Value may contain only - the language code (ex. \"en\", \"fr\") or BCP 47 language tag (ex. \"en-US\"). - """) + Locale hint for text recognition and document analysis. Value may contain only + the language code (ex. \"en\", \"fr\") or BCP 47 language tag (ex. \"en-US\"). + """) @query locale?: string; @@ -208,9 +208,9 @@ interface DocumentModels { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Doesn't fit standard ops" @doc(""" - Generates authorization to copy a document model to this location with - specified modelId and optional description. - """) + Generates authorization to copy a document model to this location with + specified modelId and optional description. + """) @route("/documentModels:authorizeCopy") @post authorizeModelCopy is DocumentIntelligenceOperation< diff --git a/specification/ai/DocumentIntelligence/tspconfig.yaml b/specification/ai/DocumentIntelligence/tspconfig.yaml index b277824c6845..a86f2a3c185e 100644 --- a/specification/ai/DocumentIntelligence/tspconfig.yaml +++ b/specification/ai/DocumentIntelligence/tspconfig.yaml @@ -13,6 +13,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "examples" omit-unreachable-types: true diff --git a/specification/ai/Face/main.tsp b/specification/ai/Face/main.tsp index 069b23ed0899..c0a19f5c2b1a 100644 --- a/specification/ai/Face/main.tsp +++ b/specification/ai/Face/main.tsp @@ -23,9 +23,9 @@ using TypeSpec.Versioning; "Azure AI Face API", { @doc(""" -Supported Cognitive Services endpoints (protocol and hostname, for example: -https://{resource-name}.cognitiveservices.azure.com). -""") + Supported Cognitive Services endpoints (protocol and hostname, for example: + https://{resource-name}.cognitiveservices.azure.com). + """) endpoint: url, @doc("API Version") diff --git a/specification/ai/Face/models.common.tsp b/specification/ai/Face/models.common.tsp index 26168c088e12..4eb0c1e70ae0 100644 --- a/specification/ai/Face/models.common.tsp +++ b/specification/ai/Face/models.common.tsp @@ -259,30 +259,30 @@ model GroupingResult { } alias AddFaceDescriptionInList = """ -> -* - * Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. - * Each person entry can hold up to 248 faces. - * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. - * "targetFace" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided "targetFace" rectangle is not returned from \"Detect\", there's no guarantee to detect and add the face successfully. - * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures. - * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. - * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model -"""; + > + * + * Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. + * Each person entry can hold up to 248 faces. + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. + * "targetFace" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided "targetFace" rectangle is not returned from \"Detect\", there's no guarantee to detect and add the face successfully. + * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures. + * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. + * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model + """; alias ListRequestOptionsDescriptionInList = """ -> -* - * "start" parameter (string, optional) specifies an ID value from which returned entries will have larger IDs based on string comparison. Setting "start" to an empty value indicates that entries should be returned starting from the first item. - * "top" parameter (int, optional) determines the maximum number of entries to be returned, with a limit of up to 1000 entries per call. To retrieve additional entries beyond this limit, specify "start" with the personId of the last entry returned in the current call. - -> [!TIP] -> -> * For example, there are total 5 items with their IDs: "itemId1", ..., "itemId5". -> * "start=&top=" will return all 5 items. -> * "start=&top=2" will return "itemId1", "itemId2". -> * "start=itemId2&top=3" will return "itemId3", "itemId4", "itemId5". -"""; + > + * + * "start" parameter (string, optional) specifies an ID value from which returned entries will have larger IDs based on string comparison. Setting "start" to an empty value indicates that entries should be returned starting from the first item. + * "top" parameter (int, optional) determines the maximum number of entries to be returned, with a limit of up to 1000 entries per call. To retrieve additional entries beyond this limit, specify "start" with the personId of the last entry returned in the current call. + + > [!TIP] + > + > * For example, there are total 5 items with their IDs: "itemId1", ..., "itemId5". + > * "start=&top=" will return all 5 items. + > * "start=&top=2" will return "itemId1", "itemId2". + > * "start=itemId2&top=3" will return "itemId3", "itemId4", "itemId5". + """; @doc("The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.") model FaceError { diff --git a/specification/ai/Face/routes.detection.tsp b/specification/ai/Face/routes.detection.tsp index 503df02d894a..c338620c3972 100644 --- a/specification/ai/Face/routes.detection.tsp +++ b/specification/ai/Face/routes.detection.tsp @@ -15,21 +15,21 @@ namespace Face; @summary("Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.") @doc(""" -> [!IMPORTANT] -> To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. - -* - * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. - * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. - * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. - * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. - * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. - * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). - * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model - * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model. - * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model. - * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model. -""") + > [!IMPORTANT] + > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. + + * + * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. + * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. + * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. + * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. + * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). + * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model + * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model. + * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model. + * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model. + """) @returnsDoc("A successful call returns an array of face entries ranked by face rectangle size in descending order. An empty response indicates no faces detected.") @post @sharedRoute diff --git a/specification/ai/Face/routes.facelist.tsp b/specification/ai/Face/routes.facelist.tsp index 08ed2d4303e3..04c3d3994864 100644 --- a/specification/ai/Face/routes.facelist.tsp +++ b/specification/ai/Face/routes.facelist.tsp @@ -14,17 +14,17 @@ namespace Face; alias AddFaceListFaceSummary = "Add a face to a specified Face List, up to 1,000 faces."; alias AddFaceListFaceDescription = """ To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until \"Delete Face List Face\" or \"Delete Face List\" is called. - + Note that persistedFaceId is different from faceId generated by \"Detect\". ${AddFaceDescriptionInList} """; alias AddLargeFaceListFaceSummary = "Add a face to a specified Large Face List, up to 1,000,000 faces."; alias AddLargeFaceListFaceDescription = """ To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until \"Delete Large Face List Face\" or \"Delete Large Face List\" is called. - + Note that persistedFaceId is different from faceId generated by \"Detect\". ${AddFaceDescriptionInList} - + > [!NOTE] > > * @@ -36,13 +36,13 @@ interface FaceListOperations { @summary("Create an empty Face List with user-specified faceListId, name, an optional userData and recognitionModel.") @doc(""" Up to 64 Face Lists are allowed in one subscription. - + Face List is a list of faces, up to 1,000 faces, and used by \"Find Similar From Face List\". - + After creation, user should use \"Add Face List Face\" to import the faces. No image will be stored. Only the extracted face feature(s) will be stored on server until \"Delete Face List\" is called. - + \"Find Similar\" is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use Person Group / Large Person Group and \"Identify\". - + Please consider Large Face List when the face number is large. It can support up to 1,000,000 faces. """) @returnsDoc(SuccessfulCallWithEmptyBody) @@ -62,7 +62,7 @@ interface FaceListOperations { @doc(""" List Face Lists' faceListId, name, userData and recognitionModel. - + To get face information inside Face List use \"Get Face List\". """) @returnsDoc("A successful call returns an array of Face Lists.") @@ -93,11 +93,11 @@ interface FaceListOperations { @summary("Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel.") @doc(""" Large Face List is a list of faces, up to 1,000,000 faces, and used by \"Find Similar From Large Face List\". - + After creation, user should use Add Large Face List Face to import the faces and Train Large Face List to make it ready for \"Find Similar\". No image will be stored. Only the extracted face feature(s) will be stored on server until Delete Large Face List is called. - + \"Find Similar\" is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use Person Group / Large Person Group and \"Identify\". - + > [!NOTE] > > * @@ -121,14 +121,12 @@ interface FaceListOperations { updateLargeFaceList is FaceResourceUpdateOperation; @summary("List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.") - @doc( - """ + @doc(""" To get face information inside largeFaceList use \"Get Large Face List Face\". - + Large Face Lists are stored in alphabetical order of largeFaceListId. ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of Large Face Lists and their information (largeFaceListId, name and userData).") getLargeFaceLists is FaceResourceListOperation< LargeFaceList, @@ -138,7 +136,7 @@ interface FaceListOperations { @doc(""" To check the Large Face List training status completed or still ongoing. Large Face List training is an asynchronous operation triggered by \"Train Large Face List\". - + Training time depends on the number of face entries in a Large Face List. It could be in seconds, or up to half an hour for 1,000,000 faces. """) @returnsDoc("A successful call returns the Large Face List's training status.") @@ -146,9 +144,9 @@ interface FaceListOperations { @summary("Submit a Large Face List training task.") @doc(""" - + Training is a crucial step that only a trained Large Face List can be used by \"Find Similar From Large Face List\". - + The training task is an asynchronous task. Training time depends on the number of face entries in a Large Face List. It could be in seconds, or up to half an hour for 1,000,000 faces. To check training completion, please use \"Get Large Face List Training Status\". """) @returnsDoc(SuccessfulCallWithEmptyBody) @@ -182,12 +180,10 @@ interface FaceListOperations { >; @summary("List faces' persistedFaceId and userData in a specified Large Face List.") - @doc( - """ + @doc(""" Faces are stored in alphabetical order of persistedFaceId created in \"Add Large Face List Face\". ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of persisted faces and their information (persistedFaceId and userData).") getLargeFaceListFaces is FaceResourceListOperation; } diff --git a/specification/ai/Face/routes.persondirectory.tsp b/specification/ai/Face/routes.persondirectory.tsp index 5b54231cac35..7e8a1db5d5a8 100644 --- a/specification/ai/Face/routes.persondirectory.tsp +++ b/specification/ai/Face/routes.persondirectory.tsp @@ -14,17 +14,15 @@ namespace Face; #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "This is a template, polling operation should be defined in the operation instance." @summary("Add a face to a person (see Person Directory \"Create Person\") for face identification or verification.") -@doc( - """ +@doc(""" To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until Person Directory \"Delete Person Face\" or \"Delete Person\" is called. - + Note that persistedFaceId is different from faceId generated by \"Detect\". ${AddFaceDescriptionInList} * * Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel. * This is a long running operation. Use Response Header "Operation-Location" to determine when the AddFace operation has successfully propagated for future requests to \"Identify\". For further information about Operation-Locations see \"Get Face Operation Status\". - """ -) + """) @returnsDoc(PersonModificationAccepted) @pollingOperation(getOperationResult) @sharedRoute @@ -92,14 +90,14 @@ alias DynamicPersonGroupModificationAccepted = "A successful call returns an emp alias CreateDynamicPersonGroupSummary = "Creates a new Dynamic Person Group with specified dynamicPersonGroupId, name, and user-provided userData."; alias CreateDynamicPersonGroupDescription = """ -A Dynamic Person Group is a container that references Person Directory "Create Person". After creation, use Person Directory "Update Dynamic Person Group" to add/remove persons to/from the Dynamic Person Group. - -Dynamic Person Group and user data will be stored on server until Person Directory "Delete Dynamic Person Group" is called. Use "Identify From Dynamic Person Group" with the dynamicPersonGroupId parameter to identify against persons. - -No image will be stored. Only the person's extracted face feature(s) and userData will be stored on server until Person Directory "Delete Person" or "Delete Person Face" is called. - -'recognitionModel' does not need to be specified with Dynamic Person Groups. Dynamic Person Groups are references to Person Directory "Create Person" and therefore work with most all 'recognitionModels'. The faceId's provided during "Identify" determine the 'recognitionModel' used. -"""; + A Dynamic Person Group is a container that references Person Directory "Create Person". After creation, use Person Directory "Update Dynamic Person Group" to add/remove persons to/from the Dynamic Person Group. + + Dynamic Person Group and user data will be stored on server until Person Directory "Delete Dynamic Person Group" is called. Use "Identify From Dynamic Person Group" with the dynamicPersonGroupId parameter to identify against persons. + + No image will be stored. Only the person's extracted face feature(s) and userData will be stored on server until Person Directory "Delete Person" or "Delete Person Face" is called. + + 'recognitionModel' does not need to be specified with Dynamic Person Groups. Dynamic Person Groups are references to Person Directory "Create Person" and therefore work with most all 'recognitionModels'. The faceId's provided during "Identify" determine the 'recognitionModel' used. + """; alias UpdateDynamicPersonGroupSummary = "Update the name or userData of an existing Dynamic Person Group, and manage its members by adding or removing persons."; alias UpdateDynamicPersonGroupDescription = "The properties keep unchanged if they are not in request body."; @@ -139,23 +137,19 @@ interface PersonDirectoryOperations { @returnsDoc(SuccessfulCallWithEmptyBody) updatePerson is FaceResourceUpdateOperation; - @doc( - """ + @doc(""" Persons are stored in alphabetical order of personId created in Person Directory \"Create Person\". ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of Person Directory Persons contained in the Dynamic Person Group.") @summary("List all persons' information in Person Directory, including personId, name, and userData.") getPersons is FaceResourceListOperation; @summary("List all Dynamic Person Groups a person has been referenced by in Person Directory.") - @doc( - """ + @doc(""" Dynamic Person Groups are stored in alphabetical order of Dynamic Person Group ID created in Person Directory \"Create Dynamic Person Group\". ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of dynamicPersonGroups information that reference the provided personId.") @get @action("dynamicPersonGroupReferences") @@ -257,22 +251,18 @@ interface PersonDirectoryOperations { updateDynamicPersonGroup is DynamicPersonGroupOperation; @summary("List all existing Dynamic Person Groups by dynamicPersonGroupId along with name and userData.") - @doc( - """ + @doc(""" Dynamic Person Groups are stored in alphabetical order of dynamicPersonGroupId. ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of Dynamic Person Groups and their information (dynamicPersonGroupId, name and userData).") getDynamicPersonGroups is FaceResourceListOperation; @summary("List all persons in the specified Dynamic Person Group.") - @doc( - """ + @doc(""" Persons are stored in alphabetical order of personId created in Person Directory \"Create Person\". ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of person information in the Person Directory.") @get @action("persons") diff --git a/specification/ai/Face/routes.persongroup.tsp b/specification/ai/Face/routes.persongroup.tsp index b6614083944a..7ef3b13b52e9 100644 --- a/specification/ai/Face/routes.persongroup.tsp +++ b/specification/ai/Face/routes.persongroup.tsp @@ -14,14 +14,14 @@ namespace Face; alias AddPersonGroupPersonFaceSummary = "Add a face to a person into a Person Group for face identification or verification."; alias AddPersonGroupPersonFaceDescription = """ To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until \"Delete Person Group Person Face\", \"Delete Person Group Person\" or \"Delete Person Group\" is called. - + Note that persistedFaceId is different from faceId generated by \"Detect\". ${AddFaceDescriptionInList} """; alias AddLargePersonGroupPersonFaceSummary = "Add a face to a person into a Large Person Group for face identification or verification."; alias AddLargePersonGroupPersonFaceDescription = """ To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until \"Delete Large Person Group Person Face\", \"Delete Large Person Group Person\" or \"Delete Large Person Group\" is called. - + Note that persistedFaceId is different from faceId generated by \"Detect\". ${AddFaceDescriptionInList} """; @@ -33,13 +33,13 @@ interface PersonGroupOperations { @summary("Create a new Person Group with specified personGroupId, name, user-provided userData and recognitionModel.") @doc(""" A Person Group is a container holding the uploaded person data, including face recognition features. - + After creation, use \"Create Person Group Person\" to add persons into the group, and then call \"Train Person Group\" to get this group ready for \"Identify From Person Group\". - + No image will be stored. Only the person's extracted face feature(s) and userData will be stored on server until \"Delete Person Group Person\" or \"Delete Person Group\" is called. - + 'recognitionModel' should be specified to associate with this Person Group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing Person Group will use the recognition model that's already associated with the collection. Existing face feature(s) in a Person Group can't be updated to features extracted by another version of recognition model. - + > [!NOTE] > > * @@ -63,12 +63,10 @@ interface PersonGroupOperations { updatePersonGroup is FaceResourceUpdateOperation; @summary("List Person Groups' personGroupId, name, userData and recognitionModel.") - @doc( - """ + @doc(""" Person Groups are stored in alphabetical order of personGroupId. ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of Person Groups and their information (personGroupId, name and userData).") getPersonGroups is FaceResourceListOperation< PersonGroup, @@ -120,12 +118,10 @@ interface PersonGroupOperations { updatePersonGroupPerson is FaceResourceUpdateOperation; @summary("List all persons' information in the specified Person Group, including personId, name, userData and persistedFaceIds of registered person faces.") - @doc( - """ + @doc(""" Persons are stored in alphabetical order of personId created in \"Create Person Group Person\". ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of person information that belong to the Person Group.") getPersonGroupPersons is FaceResourceListOperation; @@ -161,13 +157,13 @@ interface PersonGroupOperations { @summary("Create a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.") @doc(""" A Large Person Group is a container holding the uploaded person data, including the face recognition features. It can hold up to 1,000,000 entities. - + After creation, use \"Create Large Person Group Person\" to add person into the group, and call \"Train Large Person Group\" to get this group ready for \"Identify From Large Person Group\". - + No image will be stored. Only the person's extracted face feature(s) and userData will be stored on server until \"Delete Large Person Group Person\" or \"Delete Large Person Group\" is called. - + 'recognitionModel' should be specified to associate with this Large Person Group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing Large Person Group will use the recognition model that's already associated with the collection. Existing face feature(s) in a Large Person Group can't be updated to features extracted by another version of recognition model. - + > [!NOTE] > > * @@ -190,12 +186,10 @@ interface PersonGroupOperations { updateLargePersonGroup is FaceResourceUpdateOperation; @summary("List all existing Large Person Groups' largePersonGroupId, name, userData and recognitionModel.") - @doc( - """ + @doc(""" Large Person Groups are stored in alphabetical order of largePersonGroupId. ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of Large Person Groups and their information (largePersonGroupId, name and userData).") getLargePersonGroups is FaceResourceListOperation< LargePersonGroup, @@ -250,12 +244,10 @@ interface PersonGroupOperations { updateLargePersonGroupPerson is FaceResourceUpdateOperation; @summary("List all persons' information in the specified Large Person Group, including personId, name, userData and persistedFaceIds of registered person faces.") - @doc( - """ + @doc(""" Persons are stored in alphabetical order of personId created in \"Create Large Person Group Person\". ${ListRequestOptionsDescriptionInList} - """ - ) + """) @returnsDoc("A successful call returns an array of person information that belong to the Large Person Group.") getLargePersonGroupPersons is FaceResourceListOperation; diff --git a/specification/ai/Face/routes.recognition.tsp b/specification/ai/Face/routes.recognition.tsp index 04c9b296b6c1..70148cee57ae 100644 --- a/specification/ai/Face/routes.recognition.tsp +++ b/specification/ai/Face/routes.recognition.tsp @@ -13,29 +13,29 @@ using Foundations; namespace Face; alias IdentifyDocumentNote = """ -> [!NOTE] -> -> * -> * The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces. -> * Each person could have more than one face, but no more than 248 faces. -> * Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. -> * Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array. -"""; + > [!NOTE] + > + > * + > * The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces. + > * Each person could have more than one face, but no more than 248 faces. + > * Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. + > * Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array. + """; alias VerifyDocumentNote = """ -> [!NOTE] -> -> * -> * Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. -> * For the scenarios that are sensitive to accuracy please make your own judgment. -"""; + > [!NOTE] + > + > * + > * Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. + > * For the scenarios that are sensitive to accuracy please make your own judgment. + """; alias FindSimilarDocument = """ -Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. - -Find similar has two working modes, "matchPerson" and "matchFace". "matchPerson" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. "matchFace" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. - -"""; + Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. + + Find similar has two working modes, "matchPerson" and "matchFace". "matchPerson" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. "matchFace" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. + + """; @returnsDoc("A successful call returns the identified candidate person(s) for each query face.") @sharedRoute @@ -102,78 +102,66 @@ op FindSimilarOperation is Azure.Core.RpcOp interface FaceRecognitionOperations { @summary("Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect.") - @doc( - """ + @doc(""" ${FindSimilarDocument} The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target faceId array. - """ - ) + """) findSimilar is FindSimilarOperation<{ @doc("An array of candidate faceIds. All of them are created by \"Detect\" and the faceIds will expire 24 hours after the detection call. The number of faceIds is limited to 1000.") faceIds: uuid[]; }>; @summary("Given query face's faceId, to search the similar-looking faces from a Face List. A 'faceListId' is created by Create Face List.") - @doc( - """ + @doc(""" ${FindSimilarDocument} The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target Face List. - """ - ) + """) findSimilarFromFaceList is FindSimilarOperation<{ @doc("An existing user-specified unique candidate Face List, created in \"Create Face List\". Face List contains a set of persistedFaceIds which are persisted and will never expire.") faceListId: string; }>; @summary("Given query face's faceId, to search the similar-looking faces from a Large Face List. A 'largeFaceListId' is created by Create Large Face List.") - @doc( - """ + @doc(""" ${FindSimilarDocument} The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target Large Face List. - """ - ) + """) findSimilarFromLargeFaceList is FindSimilarOperation<{ @doc("An existing user-specified unique candidate Large Face List, created in \"Create Large Face List\". Large Face List contains a set of persistedFaceIds which are persisted and will never expire.") largeFaceListId: string; }>; @summary("1-to-many identification to find the closest matches of the specific query person face from a Person Group.") - @doc( - """ + @doc(""" For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Person Group (given by personGroupId), and return candidate person(s) for that face ranked by similarity confidence. The Person Group should be trained to make it ready for identification. See more in \"Train Person Group\". ${IdentifyDocumentNote} > * Try \"Find Similar\" when you need to find similar faces from a Face List/Large Face List instead of a Person Group. > * The 'recognitionModel' associated with the query faces' faceIds should be the same as the 'recognitionModel' used by the target Person Group. - """ - ) + """) identifyFromPersonGroup is IdentifyOperation<{ @doc("personGroupId of the target Person Group, created by \"Create Person Group\". Parameter personGroupId and largePersonGroupId should not be provided at the same time.") personGroupId: string; }>; @summary("1-to-many identification to find the closest matches of the specific query person face from a Large Person Group.") - @doc( - """ + @doc(""" For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Large Person Group (given by largePersonGroupId), and return candidate person(s) for that face ranked by similarity confidence. The Large Person Group should be trained to make it ready for identification. See more in \"Train Large Person Group\". ${IdentifyDocumentNote} > * Try \"Find Similar\" when you need to find similar faces from a Face List/Large Face List instead of a Person Group/Large Person Group. > * The 'recognitionModel' associated with the query faces' faceIds should be the same as the 'recognitionModel' used by the target Person Group or Large Person Group. - """ - ) + """) identifyFromLargePersonGroup is IdentifyOperation<{ @doc("largePersonGroupId of the target Large Person Group, created by \"Create Large Person Group\". Parameter personGroupId and largePersonGroupId should not be provided at the same time.") largePersonGroupId: string; }>; @summary("1-to-many identification to find the closest matches of the specific query person face from a person directory personIds array.") - @doc( - """ + @doc(""" For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Person Directory Persons (given by personIds), and return candidate person(s) for that face ranked by similarity confidence. Passing personIds with an array with one element "*" can perform the operation over entire person directory. ${IdentifyDocumentNote} > * The Identify operation can only match faces obtained with the same recognition model, that is associated with the query faces. - """ - ) + """) identifyFromPersonDirectory is IdentifyOperation<{ @doc("Array of personIds created in Person Directory \"Create Person\". The valid number of personIds is between [1,30].") @minItems(1) @@ -182,25 +170,21 @@ interface FaceRecognitionOperations { }>; @summary("1-to-many identification to find the closest matches of the specific query person face from a Dynamic Person Group.") - @doc( - """ + @doc(""" For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Dynamic Person Group (given by dynamicPersonGroupId), and return candidate person(s) for that face ranked by similarity confidence. ${IdentifyDocumentNote} > * The Identify operation can only match faces obtained with the same recognition model, that is associated with the query faces. - """ - ) + """) identifyFromDynamicPersonGroup is IdentifyOperation<{ @doc("DynamicPersonGroupId of the target PersonDirectory DynamicPersonGroup to match against.") dynamicPersonGroupId: string; }>; @summary("Verify whether two faces belong to a same person.") - @doc( - """ + @doc(""" ${VerifyDocumentNote} > * The 'recognitionModel' associated with the both faces should be the same. - """ - ) + """) verifyFaceToFace is VerifyOperation<{ @doc("The faceId of one face, come from \"Detect\".") faceId1: uuid; @@ -210,12 +194,10 @@ interface FaceRecognitionOperations { }>; @summary("Verify whether a face belongs to a person in a Person Group.") - @doc( - """ + @doc(""" ${VerifyDocumentNote} > * The 'recognitionModel' associated with the query face should be the same as the 'recognitionModel' used by the Person Group. - """ - ) + """) verifyFromPersonGroup is VerifyOperation<{ @doc("The faceId of the face, come from \"Detect\".") faceId: uuid; @@ -228,12 +210,10 @@ interface FaceRecognitionOperations { }>; @summary("Verify whether a face belongs to a person in a Large Person Group.") - @doc( - """ + @doc(""" ${VerifyDocumentNote} > * The 'recognitionModel' associated with the query face should be the same as the 'recognitionModel' used by the Large Person Group. - """ - ) + """) verifyFromLargePersonGroup is VerifyOperation<{ @doc("The faceId of the face, come from \"Detect\".") faceId: uuid; @@ -245,12 +225,10 @@ interface FaceRecognitionOperations { personId: uuid; }>; - @doc( - """ + @doc(""" ${VerifyDocumentNote} > * The Verify operation can only match faces obtained with the same recognition model, that is associated with the query face. - """ - ) + """) @summary("Verify whether a face belongs to a person in Person Directory.") verifyFromPersonDirectory is VerifyOperation<{ @doc("The faceId of the face, come from \"Detect\".") diff --git a/specification/ai/Face/routes.session.tsp b/specification/ai/Face/routes.session.tsp index eff89082a2e6..70b492cdb31b 100644 --- a/specification/ai/Face/routes.session.tsp +++ b/specification/ai/Face/routes.session.tsp @@ -13,32 +13,32 @@ namespace Face; alias SessionCommonDescription = "A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired."; alias LivenessSessionWithVerifyDescription = """ -${SessionCommonDescription} - -Permissions includes... -> -* - * Ability to call /detectLivenessWithVerify/singleModal for up to 3 retries. - * A token lifetime of 10 minutes. - -> [!NOTE] -> -> * -> * Client access can be revoked by deleting the session using the Delete Liveness With Verify Session operation. -> * To retrieve a result, use the Get Liveness With Verify Session. -> * To audit the individual requests that a client has made to your resource, use the List Liveness With Verify Session Audit Entries. -"""; + ${SessionCommonDescription} + + Permissions includes... + > + * + * Ability to call /detectLivenessWithVerify/singleModal for up to 3 retries. + * A token lifetime of 10 minutes. + + > [!NOTE] + > + > * + > * Client access can be revoked by deleting the session using the Delete Liveness With Verify Session operation. + > * To retrieve a result, use the Get Liveness With Verify Session. + > * To audit the individual requests that a client has made to your resource, use the List Liveness With Verify Session Audit Entries. + """; alias SessionCreationSuccess = "A successful call create a session for a client device and provide an authorization token for use by the client application for a limited purpose and time."; alias DeleteSessionSummary = "Delete all session related information for matching the specified session id."; alias DeleteSessionDescription = """ -> [!NOTE] -> Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused. -"""; + > [!NOTE] + > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused. + """; alias ListSessionDescription = """ -List sessions from the last sessionId greater than the 'start'. - -The result should be ordered by sessionId in ascending order. -"""; + List sessions from the last sessionId greater than the 'start'. + + The result should be ordered by sessionId in ascending order. + """; alias ListSessionAuditEntriesDescription = "Gets session requests and response body for the session."; @get @@ -53,20 +53,18 @@ op FaceLivenessSessionListAuditEntries; interface LivenessSessionOperations { - @doc( - """ + @doc(""" ${SessionCommonDescription} - + Permissions includes... > * * Ability to call /detectLiveness/singleModal for up to 3 retries. * A token lifetime of 10 minutes. - + > [!NOTE] > Client access can be revoked by deleting the session using the Delete Liveness Session operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries. - """ - ) + """) @summary("Create a new detect liveness session.") @returnsDoc(SessionCreationSuccess) createLivenessSession is FaceResourceCreateWithServiceProvidedName< @@ -94,13 +92,11 @@ interface LivenessSessionOperations { getLivenessSessionAuditEntries is FaceLivenessSessionListAuditEntries; #suppress "@azure-tools/typespec-azure-core/byos" "Representation of existing multipart/form-data operation" - @doc( - """ + @doc(""" ${LivenessSessionWithVerifyDescription} - + Recommended Option: VerifyImage is provided during session creation. - """ - ) + """) @summary("Create a new liveness session with verify. Provide the verify image during session creation.") @returnsDoc(SessionCreationSuccess) @sharedRoute @@ -110,15 +106,13 @@ interface LivenessSessionOperations { CreateLivenessWithVerifySessionResult >; - @doc( - """ + @doc(""" ${LivenessSessionWithVerifyDescription} - + Alternative Option: Client device submits VerifyImage during the /detectLivenessWithVerify/singleModal call. > [!NOTE] > Extra measures should be taken to validate that the client is sending the expected VerifyImage. - """ - ) + """) @summary("Create a new liveness session with verify. Client device submits VerifyImage during the /detectLivenessWithVerify/singleModal call.") @returnsDoc(SessionCreationSuccess) @sharedRoute @@ -139,7 +133,7 @@ interface LivenessSessionOperations { @summary("Lists sessions for /detectLivenessWithVerify/SingleModal.") @doc(""" List sessions from the last sessionId greater than the \"start\". - + The result should be ordered by sessionId in ascending order. """) getLivenessWithVerifySessions is FaceResourceListOperation< diff --git a/specification/ai/Face/tspconfig.yaml b/specification/ai/Face/tspconfig.yaml index f0b397a84bed..b96f9c05c0aa 100644 --- a/specification/ai/Face/tspconfig.yaml +++ b/specification/ai/Face/tspconfig.yaml @@ -9,6 +9,7 @@ emit: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "examples" omit-unreachable-types: true diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp index 0f07ddb14e67..533733cf14cb 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp @@ -54,9 +54,9 @@ alias value_x = { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -Base for all elements -Based on [FHIR Element](https://www.hl7.org/fhir/datatypes.html#Element) -""") + Base for all elements + Based on [FHIR Element](https://www.hl7.org/fhir/datatypes.html#Element) + """) model Extension extends Element { @doc("Source of the definition for the extension code - a logical name or a URL.") url: fhirUri; @@ -71,9 +71,9 @@ model Extendible { } @doc(""" -The base definition for all elements contained inside a resource. -Based on [FHIR Element](https://www.hl7.org/fhir/R4/element.html) -""") + The base definition for all elements contained inside a resource. + Based on [FHIR Element](https://www.hl7.org/fhir/R4/element.html) + """) model Element { @doc("Unique id for inter-element referencing") id?: string; @@ -85,9 +85,9 @@ model Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -A Coding is a representation of a defined concept using a symbol from a defined "code system". -Based on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.html#Coding) -""") + A Coding is a representation of a defined concept using a symbol from a defined "code system". + Based on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.html#Coding) + """) model Coding extends Element { @doc("Identity of the terminology system") system?: fhirUri; @@ -104,9 +104,9 @@ model Coding extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -Concept - reference to a terminology or just text -Based on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.html#CodeableConcept) -""") + Concept - reference to a terminology or just text + Based on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.html#CodeableConcept) + """) model CodeableConcept extends Element { @doc("Code defined by a terminology system") coding?: Array; @@ -118,9 +118,9 @@ model CodeableConcept extends Element { alias canonical = fhirUri; @doc(""" -Metadata about a resource -Based on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.html#Meta) -""") + Metadata about a resource + Based on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.html#Meta) + """) model Meta { @doc("The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.") versionId?: string; @@ -144,9 +144,9 @@ model Meta { alias xhtml = string; #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -Any resource that is a [DomainResource](https://www.hl7.org/fhir/domainresource.html) may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human. -Based on [FHIR Narrative](https://www.hl7.org/fhir/R4/narrative.html#Narrative) -""") + Any resource that is a [DomainResource](https://www.hl7.org/fhir/domainresource.html) may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human. + Based on [FHIR Narrative](https://www.hl7.org/fhir/R4/narrative.html#Narrative) + """) model Narrative extends Element { @doc("generated, extensions, additional, empty") status: string; @@ -157,9 +157,9 @@ model Narrative extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -A reference from one resource to another -Based on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html) -""") + A reference from one resource to another + Based on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html) + """) model Reference extends Element { #suppress "@azure-tools/typespec-azure-core/property-name-conflict" "must keep the name 'reference' for compatibility with FHIR" @doc("Literal reference, Relative, internal or absolute URL") @@ -177,9 +177,9 @@ model Reference extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -An identifier intended for computation -Based on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html) -""") + An identifier intended for computation + Based on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html) + """) model Identifier extends Element { @doc("usual | official | temp | secondary | old (If known)") use?: string; @@ -202,9 +202,9 @@ model Identifier extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -A time period defined by a start and end date and optionally time -Based on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.html#Period) -""") + A time period defined by a start and end date and optionally time + Based on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.html#Period) + """) model Period extends Element { @doc("Starting time with inclusive boundary") start?: fhirDateTime; @@ -215,9 +215,9 @@ model Period extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -A measured or measurable amount -Based on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.html#Quantity) -""") + A measured or measurable amount + Based on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.html#Quantity) + """) model Quantity extends Element { @doc("Numerical value (with implicit precision)") value?: float64; @@ -237,9 +237,9 @@ model Quantity extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -A set of ordered Quantities defined by a low and high limit -Based on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.html#Range) -""") + A set of ordered Quantities defined by a low and high limit + Based on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.html#Range) + """) model Range extends Element { @doc("Low limit") low?: Quantity; @@ -250,9 +250,9 @@ model Range extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -A ratio of two Quantity values - a numerator and a denominator -Based on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.html#Ratio) -""") + A ratio of two Quantity values - a numerator and a denominator + Based on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.html#Ratio) + """) model Ratio extends Element { @doc("Numerator value") numerator?: Quantity; @@ -263,9 +263,9 @@ model Ratio extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -A text note which also contains information about who made the statement and when -Based on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.html#Annotation) -""") + A text note which also contains information about who made the statement and when + Based on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.html#Annotation) + """) model Annotation extends Element { @doc("Individual responsible for the annotation") authorString?: string; @@ -279,9 +279,9 @@ model Annotation extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -A series of measurements taken by a device -Based on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.html#SampledData) -""") + A series of measurements taken by a device + Based on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.html#SampledData) + """) model SampledData extends Element { @doc("Zero value and units") origin: Quantity; @@ -308,8 +308,8 @@ model SampledData extends Element { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail) -""") + Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail) + """) model ContactDetail extends Element { @doc("Name of an individual to contact") name?: string; @@ -319,9 +319,9 @@ model ContactDetail extends Element { } @doc(""" -Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. -See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint -""") + Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. + See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint + """) model ContactPoint { @doc("phone | fax | email | pager | url | sms | other") system?: ContactPointSystem; @@ -340,9 +340,9 @@ model ContactPoint { } @doc(""" -Contact Point System -see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html -""") + Contact Point System + see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html + """) union ContactPointSystem { string, @@ -369,9 +369,9 @@ union ContactPointSystem { } @doc(""" -Contact Point Use -See: http://hl7.org/fhir/ValueSet/contact-point-use -""") + Contact Point Use + See: http://hl7.org/fhir/ValueSet/contact-point-use + """) union ContactPointUse { string, diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.resources.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.resources.tsp index 7608f74be812..a113644a1a8c 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.resources.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.resources.tsp @@ -6,9 +6,9 @@ namespace Fhir.R4; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" @doc(""" -Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly. -Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html -""") + Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly. + Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html + """) model Resource is Record { @doc("The type of resource") resourceType: string; @@ -28,10 +28,11 @@ model Resource is Record { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "must extends Resource to be able use clientName in both Resource and DomainResource" +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc(""" -A resource with narrative, extensions, and contained resources -Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html) -""") + A resource with narrative, extensions, and contained resources + Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html) + """) @discriminator("resourceType") model DomainResource extends Resource { @doc("Text summary of the resource, for human interpretation") @@ -49,9 +50,9 @@ model DomainResource extends Resource { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" @doc(""" -Detailed information about conditions, problems or diagnoses -Based on [FHIR Condition](https://www.hl7.org/fhir/R4/condition.html) -""") + Detailed information about conditions, problems or diagnoses + Based on [FHIR Condition](https://www.hl7.org/fhir/R4/condition.html) + """) model Condition extends DomainResource { @doc("resourceType") resourceType: "Condition"; @@ -121,9 +122,9 @@ model Condition extends DomainResource { } @doc(""" -Stage/grade, usually assessed formally -Based on [FHIR Condition.Stage](https://www.hl7.org/fhir/R4/condition.html) -""") + Stage/grade, usually assessed formally + Based on [FHIR Condition.Stage](https://www.hl7.org/fhir/R4/condition.html) + """) model ConditionStage { @doc("Simple summary (disease specific)") summary?: CodeableConcept; @@ -134,9 +135,9 @@ model ConditionStage { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" @doc(""" -Detailed information about observations -Based on [FHIR Observation](https://www.hl7.org/fhir/R4/observation.html) -""") + Detailed information about observations + Based on [FHIR Observation](https://www.hl7.org/fhir/R4/observation.html) + """) model Observation extends DomainResource { @doc("resourceType") resourceType: "Observation"; @@ -233,9 +234,9 @@ model Observation extends DomainResource { } @doc(""" -Provides guide for interpretation of component result -Based on [FHIR Observation.referenceRange](https://www.hl7.org/fhir/R4/observation.html) -""") + Provides guide for interpretation of component result + Based on [FHIR Observation.referenceRange](https://www.hl7.org/fhir/R4/observation.html) + """) model ObservationReferenceRange { @doc("Low Range, if relevant") low?: Quantity; @@ -258,9 +259,9 @@ model ObservationReferenceRange { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" -Component results -Based on [FHIR Observation.component](https://www.hl7.org/fhir/R4/observation.html) -""") + Component results + Based on [FHIR Observation.component](https://www.hl7.org/fhir/R4/observation.html) + """) model ObservationComponent extends Element { @doc("Type of component observation (code / type)") code: CodeableConcept; @@ -278,9 +279,9 @@ model ObservationComponent extends Element { } @doc(""" -Observation Status -Based on [FHIR ObservationStatus](https://www.hl7.org/fhir/R4/valueset-observation-status.html) -""") + Observation Status + Based on [FHIR ObservationStatus](https://www.hl7.org/fhir/R4/valueset-observation-status.html) + """) union ObservationStatusCodeType { string, @@ -311,9 +312,9 @@ union ObservationStatusCodeType { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" @doc(""" -Detailed information about Research Study -Based on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html) -""") + Detailed information about Research Study + Based on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html) + """) model ResearchStudy extends DomainResource { @doc("resourceType") resourceType: "ResearchStudy"; @@ -408,8 +409,8 @@ alias ResearchStudyObjective = { }; @doc(""" -https://www.hl7.org/fhir/R4/codesystem-research-study-status.html -""") + https://www.hl7.org/fhir/R4/codesystem-research-study-status.html + """) union ResearchStudyStatusCodeType { string, diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp index 0905aa8ac2da..a03306566784 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp @@ -22,14 +22,14 @@ alias ModelConfiguration = { @doc("A patient record, including their clinical information and data.") model PatientRecord { @doc(""" -A given identifier for the patient. Has to be unique across all patients in a single request. -""") + A given identifier for the patient. Has to be unique across all patients in a single request. + """) @minLength(1) id: string; @doc(""" -Patient structured information, including demographics and known structured clinical information. -""") + Patient structured information, including demographics and known structured clinical information. + """) details?: PatientDetails; @doc("Patient encounters/visits.") @@ -86,10 +86,10 @@ union ClinicalDocumentType { #suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" @doc(""" -The type of the content's source. -In case the source type is 'inline', the content is given as a string (for instance, text). -In case the source type is 'reference', the content is given as a URI. -""") + The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. + """) union DocumentContentSourceType { string, @@ -149,9 +149,9 @@ model PatientEncounter { id: string; @doc(""" - Time period of the visit. - In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time. - """) + Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time. + """) period?: TimePeriod; @doc("The class of the encounter.") @@ -163,33 +163,33 @@ union EncounterClass { string, @doc(""" - A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned to a location where patients generally stay at least overnight and provided with room, board, and continuous nursing service. - """) + A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned to a location where patients generally stay at least overnight and provided with room, board, and continuous nursing service. + """) InPatient: "inpatient", @doc(""" - The term ambulatory usually implies that the patient has come to the location and is not assigned to a bed. Sometimes referred to as an outpatient encounter. - """) + The term ambulatory usually implies that the patient has come to the location and is not assigned to a bed. Sometimes referred to as an outpatient encounter. + """) Ambulatory: "ambulatory", @doc(""" - An encounter where the patient usually will start in different encounter, such as one in the emergency department but then transition to this type of encounter because they require a significant period of treatment and monitoring to determine whether or not their condition warrants an inpatient admission or discharge. - """) + An encounter where the patient usually will start in different encounter, such as one in the emergency department but then transition to this type of encounter because they require a significant period of treatment and monitoring to determine whether or not their condition warrants an inpatient admission or discharge. + """) Observation: "observation", @doc(""" - A patient encounter that takes place at a dedicated healthcare service delivery location where the patient receives immediate evaluation and treatment, provided until the patient can be discharged or responsibility for the patient's care is transferred elsewhere (for example, the patient could be admitted as an inpatient or transferred to another facility. - """) + A patient encounter that takes place at a dedicated healthcare service delivery location where the patient receives immediate evaluation and treatment, provided until the patient can be discharged or responsibility for the patient's care is transferred elsewhere (for example, the patient could be admitted as an inpatient or transferred to another facility. + """) Emergency: "emergency", @doc(""" - A patient encounter where the patient is not physically present for the encounter, such as in a telehealth encounter, phone call, or electronic communication. - """) + A patient encounter where the patient is not physically present for the encounter, such as in a telehealth encounter, phone call, or electronic communication. + """) Virtual: "virtual", @doc(""" - Healthcare encounter that takes place in the residence of the patient or a designee - """) + Healthcare encounter that takes place in the residence of the patient or a designee + """) HealthHome: "healthHome", } @@ -216,14 +216,14 @@ model DocumentAuthor { @doc("The content of the patient document.") model DocumentContent { @doc(""" -The type of the content's source. -In case the source type is 'inline', the content is given as a string (for instance, text). -In case the source type is 'reference', the content is given as a URI. -""") + The type of the content's source. + In case the source type is 'inline', the content is given as a string (for instance, text). + In case the source type is 'reference', the content is given as a URI. + """) sourceType: DocumentContentSourceType; @doc(""" -The content of the document, given either inline (as a string) or as a reference (URI). -""") + The content of the document, given either inline (as a string) or as a reference (URI). + """) value: string; } diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp index 46692658bb8f..433c1532519f 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp @@ -63,9 +63,9 @@ model InferenceEvidence { patientDataEvidence?: ClinicalNoteEvidence; @doc(""" -A piece of clinical information, expressed as a code in a clinical coding -system. -""") + A piece of clinical information, expressed as a code in a clinical coding + system. + """) patientInfoEvidence?: ClinicalCodedElement; @doc("A value indicating how important this piece of evidence is for the inference.") diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp index 3c8a9fa7aca1..a316c356a25f 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp @@ -39,15 +39,15 @@ model HealthInsightsJobBase { @doc("ConditionStage") model ConditionStage { @doc(""" - Simple summary (disease specific) - see: https://www.hl7.org/fhir/valueset-condition-stage.html -""") + Simple summary (disease specific) + see: https://www.hl7.org/fhir/valueset-condition-stage.html + """) summary: Fhir.R4.CodeableConcept; @doc(""" - Kind of staging - see: https://www.hl7.org/fhir/valueset-condition-stage-kind.html - """) + Kind of staging + see: https://www.hl7.org/fhir/valueset-condition-stage-kind.html + """) type?: Fhir.R4.CodeableConcept; } @@ -87,9 +87,9 @@ union InterpretationType { } @doc(""" -ObservationStatusType based on FHIR valueset observation-status -see: https://www.hl7.org/fhir/codesystem-observation-status.html -""") + ObservationStatusType based on FHIR valueset observation-status + see: https://www.hl7.org/fhir/codesystem-observation-status.html + """) union ObservationStatusType { string, @@ -100,9 +100,9 @@ union ObservationStatusType { Preliminary: "preliminary", @doc(""" - The observation is complete and there are no further actions needed. Additional information such as 'released', 'signed', etc would be represented using [Provenance](provenance.html) which provides not only the act but also the actors and dates and other related data. - These act states would be associated with an observation status of `preliminary` until they are all completed and then a status of `final` would be applied. - """) + The observation is complete and there are no further actions needed. Additional information such as 'released', 'signed', etc would be represented using [Provenance](provenance.html) which provides not only the act but also the actors and dates and other related data. + These act states would be associated with an observation status of `preliminary` until they are all completed and then a status of `final` would be applied. + """) Final: "final", @doc("Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and corrections.") @@ -122,9 +122,9 @@ union ObservationStatusType { } @doc(""" -ConditionDiagnosisSeverityType based on SNOMED CT International edition 31-July 2022 -see: http://snomed.info/sct -""") + ConditionDiagnosisSeverityType based on SNOMED CT International edition 31-July 2022 + see: http://snomed.info/sct + """) union ConditionDiagnosisSeverityType { string, @@ -139,8 +139,8 @@ union ConditionDiagnosisSeverityType { } @doc(""" -ConditionCategoryType based on FHIR valueset condition-category -""") + ConditionCategoryType based on FHIR valueset condition-category + """) union ConditionCategoryType { string, @@ -152,9 +152,9 @@ union ConditionCategoryType { } @doc(""" -VerificationStatusType based of FHIR valueset condition-ver-status. -see: https://terminology.hl7.org/5.1.0/CodeSystem-condition-ver-status.html -""") + VerificationStatusType based of FHIR valueset condition-ver-status. + see: https://terminology.hl7.org/5.1.0/CodeSystem-condition-ver-status.html + """) union VerificationStatusType { string, @@ -178,10 +178,10 @@ union VerificationStatusType { } @doc(""" -A location given as a combination of city, state and country/region. It could specify a city, a state or a country/region. -In case a city is specified, either state +country/region or country/region (for countries/regions where there are no states) should be added. -In case a state is specified (without a city), country/region should be added. -""") + A location given as a combination of city, state and country/region. It could specify a city, a state or a country/region. + In case a city is specified, either state +country/region or country/region (for countries/regions where there are no states) should be added. + In case a state is specified (without a city), country/region should be added. + """) model GeographicLocation { @doc("City name.") city?: string; @@ -214,8 +214,8 @@ model OrderedProcedure { } @doc(""" -A piece of clinical information, expressed as a code in a clinical coding system. -""") + A piece of clinical information, expressed as a code in a clinical coding system. + """) model ClinicalCodedElement { @doc("The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS.") system: string; diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp index b9d4ad3e8be5..4523bb0b3283 100644 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp @@ -49,8 +49,8 @@ model OncoPhenotypeInference { evidence?: InferenceEvidence[]; @doc(""" -An identifier for a clinical case, if there are multiple clinical cases regarding the same patient. -""") + An identifier for a clinical case, if there are multiple clinical cases regarding the same patient. + """) caseId?: string; } @@ -59,15 +59,15 @@ model OncoPhenotypeModelConfiguration { ...ModelConfiguration; @doc(""" -A list of inference types to be inferred for the current request. -This could be used if only part of the Onco Phenotype inferences are required. -If this list is omitted or empty, the model will return all the inference types. -""") + A list of inference types to be inferred for the current request. + This could be used if only part of the Onco Phenotype inferences are required. + If this list is omitted or empty, the model will return all the inference types. + """) inferenceTypes?: OncoPhenotypeInferenceType[]; @doc(""" -An indication whether to perform a preliminary step on the patient's documents to determine whether they relate to a Cancer case. -""") + An indication whether to perform a preliminary step on the patient's documents to determine whether they relate to a Cancer case. + """) checkForCancerCase?: boolean = false; } diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml index 9b6557360eef..4594c77237d3 100644 --- a/specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml @@ -11,6 +11,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/../.." examples-directory: examples omit-unreachable-types: true diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp index ef954eb7f203..6e7f0bdfe3d2 100644 --- a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp +++ b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp @@ -51,10 +51,10 @@ model PatientTimelineInference is Fhir.R4.Extendible { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" @doc(""" - FHIR 4.0 representation of the piece of clinical info. - additional dependent resources maybe contained (e.g. MedicationStatement may contain Medication) - -- In the SDK we will have custom mapping to map this type to JsonObject - """) + FHIR 4.0 representation of the piece of clinical info. + additional dependent resources maybe contained (e.g. MedicationStatement may contain Medication) + -- In the SDK we will have custom mapping to map this type to JsonObject + """) resource?: Fhir.R4.DomainResource; @doc("Time range relevant to this Timeline inference.") diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.tsp b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.tsp index d1565e982c84..fe7f8d8b4d27 100644 --- a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.tsp +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.tsp @@ -93,19 +93,20 @@ model RadiologyInsightsPatientResult { inferences: RadiologyInsightsInference[]; } +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc(""" -An inference made by the Radiology Insights model regarding a patient. - - AgeMismatch - - SexMismatch - - LateralityDiscrepancy - - CompleteOrderDiscrepancy - - LimitedOrderDiscrepancy - - Finding - - CriticalResult - - FollowupRecommendation - - RadiologyProcedure - - FollowupCommunication -""") + An inference made by the Radiology Insights model regarding a patient. + - AgeMismatch + - SexMismatch + - LateralityDiscrepancy + - CompleteOrderDiscrepancy + - LimitedOrderDiscrepancy + - Finding + - CriticalResult + - FollowupRecommendation + - RadiologyProcedure + - FollowupCommunication + """) @discriminator("kind") model RadiologyInsightsInference { ...Fhir.R4.Extendible; @@ -246,6 +247,7 @@ model FollowupRecommendationInference extends RadiologyInsightsInference { recommendedProcedure: ProcedureRecommendation; } +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The procedure recommendation can be a generic procedure or an imaging procedure.") @discriminator("kind") model ProcedureRecommendation { diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.valuesets.tsp b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.valuesets.tsp index 1ead3a3230b1..17184393b37d 100644 --- a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.valuesets.tsp +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.valuesets.tsp @@ -159,9 +159,9 @@ union RecommendationFindingStatusType { } @doc(""" -DiseaseCourseType value set system url = http://github.com/Azure/HealthInsights/RadiologyInsights/ValueSet/condition-course -The below values can be used for binding in DiseaseCourseExtension.valueCodeableConcept -""") + DiseaseCourseType value set system url = http://github.com/Azure/HealthInsights/RadiologyInsights/ValueSet/condition-course + The below values can be used for binding in DiseaseCourseExtension.valueCodeableConcept + """) union DiseaseCourseType { string, diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp index 36d86b442f3c..ed61f08ef0c7 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp @@ -20,11 +20,11 @@ model TrialMatcherModelConfiguration { ...ModelConfiguration; @doc(""" -The clinical trials that the patient(s) should be matched to.
The trial -selection can be given as a list of custom clinical trials and/or a list of -filters to known clinical trial registries. In case both are given, the -resulting trial set is a union of the two sets. -""") + The clinical trials that the patient(s) should be matched to.
The trial + selection can be given as a list of custom clinical trials and/or a list of + filters to known clinical trial registries. In case both are given, the + resulting trial set is a union of the two sets. + """) clinicalTrials: ClinicalTrials; } @@ -49,19 +49,19 @@ model TrialMatcherInferenceResult { model NeededClinicalInfo is ExtendedClinicalCodedElement[]; @doc(""" -A piece of clinical information, expressed as a code in a clinical coding system, extended by semantic information. -""") + A piece of clinical information, expressed as a code in a clinical coding system, extended by semantic information. + """) model ExtendedClinicalCodedElement { ...ClinicalCodedElement; @doc(""" -The [UMLS semantic type](https://www.nlm.nih.gov/research/umls/META3_current_semantic_types.html) associated with the coded concept. -""") + The [UMLS semantic type](https://www.nlm.nih.gov/research/umls/META3_current_semantic_types.html) associated with the coded concept. + """) semanticType?: string; @doc(""" -The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination. -""") + The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination. + """) category?: string; } @@ -74,8 +74,8 @@ model TrialMatcherPatientResult { inferences: Array; @doc(""" - Clinical information which is needed to provide better trial matching results for the patient. - """) + Clinical information which is needed to provide better trial matching results for the patient. + """) neededClinicalInfo?: NeededClinicalInfo; } @@ -109,97 +109,97 @@ model TrialMatcherInference { } @doc(""" -The clinical trials that the patient(s) should be matched to. -The trial selection can be given as a list of custom clinical trials and/or a list of filters to known clinical trial registries. -In case both are given, the resulting trial set is a union of the two sets. -""") + The clinical trials that the patient(s) should be matched to. + The trial selection can be given as a list of custom clinical trials and/or a list of filters to known clinical trial registries. + In case both are given, the resulting trial set is a union of the two sets. + """) model ClinicalTrials { @doc("A list of clinical trials.") @minItems(1) customTrials?: Array; @doc(""" - A list of filters, each one creating a selection of trials from a given - clinical trial registry. - """) + A list of filters, each one creating a selection of trials from a given + clinical trial registry. + """) @minItems(1) registryFilters?: ClinicalTrialRegistryFilter[]; } @doc(""" -A filter defining a subset of clinical trials from a given clinical trial registry (e.g. clinicaltrials.gov). -""") + A filter defining a subset of clinical trials from a given clinical trial registry (e.g. clinicaltrials.gov). + """) model ClinicalTrialRegistryFilter { @doc(""" -Trials with any of the given medical conditions will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the medical conditions. -""") + Trials with any of the given medical conditions will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the medical conditions. + """) conditions?: string[]; @doc(""" -Trials with any of the given study types will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the study types. -""") + Trials with any of the given study types will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the study types. + """) studyTypes?: ClinicalTrialStudyType[]; @doc(""" -Trials with any of the given recruitment statuses will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the recruitment statuses. -""") + Trials with any of the given recruitment statuses will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the recruitment statuses. + """) recruitmentStatuses?: ClinicalTrialRecruitmentStatus[]; @doc(""" -Trials with any of the given sponsors will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the sponsors. -""") + Trials with any of the given sponsors will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the sponsors. + """) sponsors?: string[]; @doc(""" -Trials with any of the given phases will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the phases. -""") + Trials with any of the given phases will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the phases. + """) phases?: ClinicalTrialPhase[]; @doc(""" -Trials with any of the given purposes will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the purposes. -""") + Trials with any of the given purposes will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the purposes. + """) purposes?: ClinicalTrialPurpose[]; @doc(""" -Trials with any of the given identifiers will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the trial identifiers. -""") + Trials with any of the given identifiers will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the trial identifiers. + """) ids?: string[]; @doc(""" -Trials with any of the given sources will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the sources. -""") + Trials with any of the given sources will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the sources. + """) sources?: ClinicalTrialSource[]; @doc(""" -Trials with any of the given facility names will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the trial facility names. -""") + Trials with any of the given facility names will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the trial facility names. + """) facilityNames?: string[]; @doc(""" -Trials with any of the given facility locations will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the trial facility locations. -""") + Trials with any of the given facility locations will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the trial facility locations. + """) facilityLocations?: GeographicLocation[]; @doc(""" -Trials with any of the given facility area boundaries will be included in the selection (provided that other limitations are satisfied). -Leaving this list empty will not limit the trial facility area boundaries. -""") + Trials with any of the given facility area boundaries will be included in the selection (provided that other limitations are satisfied). + Leaving this list empty will not limit the trial facility area boundaries. + """) facilityAreas?: GeographicArea[]; } @doc(""" -A geographic area, expressed as a `Circle` geometry represented using a `GeoJSON Feature` (see [GeoJSON spec](https://tools.ietf.org/html/rfc7946)). -""") + A geographic area, expressed as a `Circle` geometry represented using a `GeoJSON Feature` (see [GeoJSON spec](https://tools.ietf.org/html/rfc7946)). + """) model GeographicArea { @doc("`GeoJSON` type.") type: GeoJsonType; @@ -217,9 +217,9 @@ model AreaGeometry { type: GeoJsonGeometryType; @doc(""" -Coordinates of the area circle's center, represented according to the `GeoJSON` standard. -This is an array of 2 decimal numbers, longitude and latitude (precisely in this order). -""") + Coordinates of the area circle's center, represented according to the `GeoJSON` standard. + This is an array of 2 decimal numbers, longitude and latitude (precisely in this order). + """) @minItems(2) @maxItems(2) coordinates: float32[]; @@ -238,9 +238,9 @@ model AreaProperties { @doc("Trial data which is of interest to the potential participant.") model ClinicalTrialMetadata { @doc(""" -Phases which are relevant for the clinical trial. -Each clinical trial can be in a certain phase or in multiple phases. -""") + Phases which are relevant for the clinical trial. + Each clinical trial can be in a certain phase or in multiple phases. + """) phases?: ClinicalTrialPhase[]; @doc("Possible study types of a clinical trial.") @@ -250,8 +250,8 @@ Each clinical trial can be in a certain phase or in multiple phases. recruitmentStatus?: ClinicalTrialRecruitmentStatus; @doc(""" -Medical conditions and their synonyms which are relevant for the clinical trial, given as strings. -""") + Medical conditions and their synonyms which are relevant for the clinical trial, given as strings. + """) @minItems(1) conditions: string[]; @@ -259,8 +259,8 @@ Medical conditions and their synonyms which are relevant for the clinical trial, sponsors?: string[]; @doc(""" -Contact details of the trial administrators, for patients that want to participate in the trial. -""") + Contact details of the trial administrators, for patients that want to participate in the trial. + """) contacts?: ContactDetails[]; @doc("Research facilities where the clinical trial is conducted.") diff --git a/specification/ai/ImageAnalysis/main.tsp b/specification/ai/ImageAnalysis/main.tsp index d21501ee098e..55a5bf9547a9 100644 --- a/specification/ai/ImageAnalysis/main.tsp +++ b/specification/ai/ImageAnalysis/main.tsp @@ -25,9 +25,9 @@ using Azure.Core; "Analyze an image to generate a description of its content, detect text, objects and more.", { @doc(""" -Azure AI Computer Vision endpoint (protocol and hostname, for example: -https://.cognitiveservices.azure.com). -""") + Azure AI Computer Vision endpoint (protocol and hostname, for example: + https://.cognitiveservices.azure.com). + """) endpoint: url, } ) diff --git a/specification/ai/ImageAnalysis/models.tsp b/specification/ai/ImageAnalysis/models.tsp index b637a1070578..61b804dff603 100644 --- a/specification/ai/ImageAnalysis/models.tsp +++ b/specification/ai/ImageAnalysis/models.tsp @@ -29,9 +29,9 @@ model ImageBoundingBox { @doc("Represents a generated phrase that describes the content of the whole image.") model CaptionResult { @doc(""" - A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate. - Higher values indicating higher confidence. - """) + A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate. + Higher values indicating higher confidence. + """) @minValue(0.0) @maxValue(1.0) confidence: float32; @@ -42,16 +42,16 @@ model CaptionResult { } @doc(""" -A region at the desired aspect ratio that can be used as image thumbnail. -The region preserves as much content as possible from the analyzed image, with priority given to detected faces. -""") + A region at the desired aspect ratio that can be used as image thumbnail. + The region preserves as much content as possible from the analyzed image, with priority given to detected faces. + """) model CropRegion { @doc(""" - The aspect ratio of the crop region. - Aspect ratio is calculated by dividing the width of the region in pixels by its height in pixels. - The aspect ratio will be in the range 0.75 to 1.8 (inclusive) if provided by the developer during the analyze call. - Otherwise, it will be in the range 0.5 to 2.0 (inclusive). - """) + The aspect ratio of the crop region. + Aspect ratio is calculated by dividing the width of the region in pixels by its height in pixels. + The aspect ratio will be in the range 0.75 to 1.8 (inclusive) if provided by the developer during the analyze call. + Otherwise, it will be in the range 0.5 to 2.0 (inclusive). + """) @minValue(0.0) aspectRatio: float32; @@ -62,9 +62,9 @@ model CropRegion { @doc("Represents a generated phrase that describes the content of the whole image or a region in the image") model DenseCaption { @doc(""" - A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate. - Higher values indicating higher confidence. - """) + A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate. + Higher values indicating higher confidence. + """) @minValue(0.0) @maxValue(1.0) confidence: float32; @@ -78,9 +78,9 @@ model DenseCaption { } @doc(""" -Represents a list of up to 10 image captions for different regions of the image. -The first caption always applies to the whole image. -""") + Represents a list of up to 10 image captions for different regions of the image. + The first caption always applies to the whole image. + """) model DenseCaptionsResult { @doc("The list of image captions.") @minItems(1) @@ -105,9 +105,9 @@ model DetectedPerson { boundingBox: ImageBoundingBox; @doc(""" - A score, in the range of 0 to 1 (inclusive), representing the confidence that this detection was accurate. - Higher values indicating higher confidence. - """) + A score, in the range of 0 to 1 (inclusive), representing the confidence that this detection was accurate. + Higher values indicating higher confidence. + """) @visibility("read") @minValue(0.0) @maxValue(1.0) @@ -172,9 +172,9 @@ model ImageAnalysisResult { caption?: CaptionResult; @doc(""" - The up to 10 generated phrases, the first describing the content of the whole image, - and the others describing the content of different regions of the image. - """) + The up to 10 generated phrases, the first describing the content of the whole image, + and the others describing the content of different regions of the image. + """) @encodedName("application/json", "denseCaptionsResult") denseCaptions?: DenseCaptionsResult; @@ -197,9 +197,9 @@ model ImageAnalysisResult { read?: ReadResult; @doc(""" - A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails. - These regions preserve as much content as possible from the analyzed image, with priority given to detected faces. - """) + A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails. + These regions preserve as much content as possible from the analyzed image, with priority given to detected faces. + """) @encodedName("application/json", "smartCropsResult") smartCrops?: SmartCropsResult; @@ -244,9 +244,9 @@ model ReadResult { } @doc(""" -Smart cropping result. A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails. -These regions preserve as much content as possible from the analyzed image, with priority given to detected faces. -""") + Smart cropping result. A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails. + These regions preserve as much content as possible from the analyzed image, with priority given to detected faces. + """) model SmartCropsResult { @doc("A list of crop regions.") @minItems(1) @@ -255,14 +255,14 @@ model SmartCropsResult { } @doc(""" -A content entity observation in the image. A tag can be a physical object, living being, scenery, or action -that appear in the image. -""") + A content entity observation in the image. A tag can be a physical object, living being, scenery, or action + that appear in the image. + """) model DetectedTag { @doc(""" - A score, in the range of 0 to 1 (inclusive), representing the confidence that this entity was observed. - Higher values indicating higher confidence. - """) + A score, in the range of 0 to 1 (inclusive), representing the confidence that this entity was observed. + Higher values indicating higher confidence. + """) @minValue(0.0) @maxValue(1.0) confidence: float32; @@ -273,9 +273,9 @@ model DetectedTag { } @doc(""" -A list of entities observed in the image. Tags can be physical objects, living being, scenery, or actions -that appear in the image. -""") + A list of entities observed in the image. Tags can be physical objects, living being, scenery, or actions + that appear in the image. + """) model TagsResult { @doc("A list of tags.") @minItems(0) diff --git a/specification/ai/ImageAnalysis/routes.tsp b/specification/ai/ImageAnalysis/routes.tsp index 7038a5d38bb7..5500500c4c34 100644 --- a/specification/ai/ImageAnalysis/routes.tsp +++ b/specification/ai/ImageAnalysis/routes.tsp @@ -20,28 +20,28 @@ alias SharedAnalyzeQuery = { format: "csv", }) @doc(""" - A list of visual features to analyze. - Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People. - At least one visual feature must be specified. - """) + A list of visual features to analyze. + Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People. + At least one visual feature must be specified. + """) @minItems(1) visualFeatures: Array; @query("language") @doc(""" - The desired language for result generation (a two-letter language code). - If this option is not specified, the default value 'en' is used (English). - See https://aka.ms/cv-languages for a list of supported languages. - """) + The desired language for result generation (a two-letter language code). + If this option is not specified, the default value 'en' is used (English). + See https://aka.ms/cv-languages for a list of supported languages. + """) @minLength(2) language?: string = "en"; @query("gender-neutral-caption") @doc(""" - Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features. - By default captions may contain gender terms (for example: 'man', 'woman', or 'boy', 'girl'). - If you set this to \"true\", those will be replaced with gender-neutral terms (for example: 'person' or 'child'). - """) + Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features. + By default captions may contain gender terms (for example: 'man', 'woman', or 'boy', 'girl'). + If you set this to \"true\", those will be replaced with gender-neutral terms (for example: 'person' or 'child'). + """) genderNeutralCaption?: boolean = false; @query({ @@ -49,21 +49,21 @@ alias SharedAnalyzeQuery = { format: "csv", }) @doc(""" - A list of aspect ratios to use for smart cropping. - Aspect ratios are calculated by dividing the target crop width in pixels by the height in pixels. - Supported values are between 0.75 and 1.8 (inclusive). - If this parameter is not specified, the service will return one crop region with an aspect - ratio it sees fit between 0.5 and 2.0 (inclusive). - """) + A list of aspect ratios to use for smart cropping. + Aspect ratios are calculated by dividing the target crop width in pixels by the height in pixels. + Supported values are between 0.75 and 1.8 (inclusive). + If this parameter is not specified, the service will return one crop region with an aspect + ratio it sees fit between 0.5 and 2.0 (inclusive). + """) smartCropsAspectRatios?: Array; @query("model-version") @doc(""" - The version of cloud AI-model used for analysis. - The format is the following: 'latest' (default value) or 'YYYY-MM-DD' or 'YYYY-MM-DD-preview', where 'YYYY', 'MM', 'DD' are the year, month and day associated with the model. - This is not commonly set, as the default always gives the latest AI model with recent improvements. - If however you would like to make sure analysis results do not change over time, set this value to a specific model version. - """) + The version of cloud AI-model used for analysis. + The format is the following: 'latest' (default value) or 'YYYY-MM-DD' or 'YYYY-MM-DD-preview', where 'YYYY', 'MM', 'DD' are the year, month and day associated with the model. + This is not commonly set, as the default always gives the latest AI model with recent improvements. + If however you would like to make sure analysis results do not change over time, set this value to a specific model version. + """) @pattern("^(latest|\\d{4}-\\d{2}-\\d{2})(-preview)?$") @minLength(6) @maxLength(18) diff --git a/specification/ai/ImageAnalysis/tspconfig.yaml b/specification/ai/ImageAnalysis/tspconfig.yaml index 38492b8b6381..f2ff99a42d93 100644 --- a/specification/ai/ImageAnalysis/tspconfig.yaml +++ b/specification/ai/ImageAnalysis/tspconfig.yaml @@ -11,6 +11,7 @@ options: emitter-output-dir: "{project-root}/../" output-file: "{azure-resource-provider-folder}/ImageAnalysis/{version-status}/{version}/generated.json" azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" examples-directory: examples omit-unreachable-types: true "@azure-tools/typespec-python": diff --git a/specification/ai/OpenAI.Assistants/assistants/models.tsp b/specification/ai/OpenAI.Assistants/assistants/models.tsp index 1ecff00e2e15..3c892cd75990 100644 --- a/specification/ai/OpenAI.Assistants/assistants/models.tsp +++ b/specification/ai/OpenAI.Assistants/assistants/models.tsp @@ -40,7 +40,7 @@ model Assistant { instructions: string | null; @doc("The collection of tools enabled for the assistant.") - tools: ToolDefinition[] = []; + tools: ToolDefinition[] = #[]; /** * A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` @@ -103,7 +103,7 @@ model AssistantCreationOptions { #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" @doc("The collection of tools to enable for the new assistant.") - tools?: ToolDefinition[] = []; + tools?: ToolDefinition[] = #[]; /** * A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` @@ -169,7 +169,7 @@ model UpdateAssistantOptions { instructions?: string | null; @doc("The modified collection of tools to enable for the assistant.") - tools?: ToolDefinition[] = []; + tools?: ToolDefinition[] = #[]; /** * A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, diff --git a/specification/ai/OpenAI.Assistants/messages/models.tsp b/specification/ai/OpenAI.Assistants/messages/models.tsp index ebce66ef29c4..118cdf5a0d73 100644 --- a/specification/ai/OpenAI.Assistants/messages/models.tsp +++ b/specification/ai/OpenAI.Assistants/messages/models.tsp @@ -120,6 +120,7 @@ union MessageAttachmentToolDefinition { @doc("An abstract representation of a single item of thread message content.") @added(ServiceApiVersions.v2024_02_15_preview) model MessageContent { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; } @@ -163,6 +164,7 @@ model MessageTextDetails { @doc("An abstract representation of an annotation to text thread message content.") @added(ServiceApiVersions.v2024_02_15_preview) model MessageTextAnnotation { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; @@ -180,9 +182,9 @@ model MessageTextFileCitationAnnotation extends MessageTextAnnotation { @encodedName("application/json", "file_citation") @doc(""" - A citation within the message that points to a specific quote from a specific file. - Generated when the assistant uses the "file_search" tool to search files. - """) + A citation within the message that points to a specific quote from a specific file. + Generated when the assistant uses the "file_search" tool to search files. + """) fileCitation: MessageTextFileCitationDetails; @encodedName("application/json", "start_index") @@ -322,6 +324,7 @@ model MessageDeltaContent { index: int32; /** The type of content for this content part. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" type: string; } @@ -372,6 +375,7 @@ model MessageDeltaTextAnnotation { index: int32; /** The type of the text content annotation. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" type: string; } diff --git a/specification/ai/OpenAI.Assistants/run_steps/models.tsp b/specification/ai/OpenAI.Assistants/run_steps/models.tsp index 89d15c2ea2bf..5ed19fc6a082 100644 --- a/specification/ai/OpenAI.Assistants/run_steps/models.tsp +++ b/specification/ai/OpenAI.Assistants/run_steps/models.tsp @@ -219,6 +219,7 @@ model RunStepDelta { @added(ServiceApiVersions.v2024_02_15_preview) model RunStepDeltaDetail { /** The object type for the run step detail object. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" type: string; } @@ -263,6 +264,7 @@ model RunStepDeltaToolCall { id: string; /** The type of the tool call detail item in a streaming run step's details. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" type: string; } @@ -334,6 +336,7 @@ model RunStepDeltaCodeInterpreterOutput { index: int32; /** The type of the streaming run step tool call's Code Interpreter output. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" type: string; } diff --git a/specification/ai/OpenAI.Assistants/runs/models.tsp b/specification/ai/OpenAI.Assistants/runs/models.tsp index 08cd8e08355b..4ae34b106f92 100644 --- a/specification/ai/OpenAI.Assistants/runs/models.tsp +++ b/specification/ai/OpenAI.Assistants/runs/models.tsp @@ -51,7 +51,7 @@ model ThreadRun { instructions: string; @doc("The overridden enabled tools used for this assistant thread run.") - tools: ToolDefinition[] = []; + tools: ToolDefinition[] = #[]; @encodedName("application/json", "created_at") @encode(DateTimeKnownEncoding.unixTimestamp, int32) @@ -195,9 +195,9 @@ model CreateRunOptions { #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" @encodedName("application/json", "additional_instructions") @doc(""" - Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior - on a per-run basis without overriding other instructions. - """) + Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior + on a per-run basis without overriding other instructions. + """) additionalInstructions?: string | null; /** Adds additional messages to the thread before creating the run. */ @@ -328,6 +328,7 @@ union RunStatus { @doc("An abstract representation of a required action for an assistant thread run to continue.") @added(ServiceApiVersions.v2024_02_15_preview) model RequiredAction { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; } diff --git a/specification/ai/OpenAI.Assistants/streaming/events.tsp b/specification/ai/OpenAI.Assistants/streaming/events.tsp index 22d34453e587..0adca1d5ef08 100644 --- a/specification/ai/OpenAI.Assistants/streaming/events.tsp +++ b/specification/ai/OpenAI.Assistants/streaming/events.tsp @@ -5,23 +5,23 @@ using TypeSpec.Versioning; namespace Azure.AI.OpenAI.Assistants; @doc(""" -Each event in a server-sent events stream has an `event` and `data` property: - -``` -event: thread.created -data: {"id": "thread_123", "object": "thread", ...} -``` - -We emit events whenever a new object is created, transitions to a new state, or is being -streamed in parts (deltas). For example, we emit `thread.run.created` when a new run -is created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses -to create a message during a run, we emit a `thread.message.created event`, a -`thread.message.in_progress` event, many `thread.message.delta` events, and finally a -`thread.message.completed` event. - -We may add additional events over time, so we recommend handling unknown events gracefully -in your code. -""") + Each event in a server-sent events stream has an `event` and `data` property: + + ``` + event: thread.created + data: {"id": "thread_123", "object": "thread", ...} + ``` + + We emit events whenever a new object is created, transitions to a new state, or is being + streamed in parts (deltas). For example, we emit `thread.run.created` when a new run + is created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses + to create a message during a run, we emit a `thread.message.created event`, a + `thread.message.in_progress` event, many `thread.message.delta` events, and finally a + `thread.message.completed` event. + + We may add additional events over time, so we recommend handling unknown events gracefully + in your code. + """) union AssistantStreamEvent { string, diff --git a/specification/ai/OpenAI.Assistants/tools/models.tsp b/specification/ai/OpenAI.Assistants/tools/models.tsp index 72e17b73dae6..038c6271a1c3 100644 --- a/specification/ai/OpenAI.Assistants/tools/models.tsp +++ b/specification/ai/OpenAI.Assistants/tools/models.tsp @@ -14,6 +14,7 @@ namespace Azure.AI.OpenAI.Assistants; @discriminator("type") @added(ServiceApiVersions.v2024_02_15_preview) model ToolDefinition { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; } @@ -64,10 +65,11 @@ model FunctionDefinition { @discriminator("type") @doc(""" -An abstract representation a a tool invocation needed by the model to continue a run. -""") + An abstract representation a a tool invocation needed by the model to continue a run. + """) @added(ServiceApiVersions.v2024_02_15_preview) model RequiredToolCall { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type for the required tool call.") type: string; @@ -103,6 +105,7 @@ model RequiredFunctionToolCallDetails { @doc("An abstract representation of a detailed tool call as recorded within a run step for an existing run.") @added(ServiceApiVersions.v2024_02_15_preview) model RunStepToolCall { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; @@ -111,9 +114,9 @@ model RunStepToolCall { } @doc(""" -A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that -represents inputs and outputs consumed and emitted by the code interpreter. -""") + A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that + represents inputs and outputs consumed and emitted by the code interpreter. + """) @added(ServiceApiVersions.v2024_02_15_preview) model RunStepCodeInterpreterToolCall extends RunStepToolCall { @doc("The object type, which is always 'code_interpreter'.") @@ -125,9 +128,9 @@ model RunStepCodeInterpreterToolCall extends RunStepToolCall { } @doc(""" -A record of a call to a file search tool, issued by the model in evaluation of a defined tool, that represents -executed file search. -""") + A record of a call to a file search tool, issued by the model in evaluation of a defined tool, that represents + executed file search. + """) @added(ServiceApiVersions.v2024_05_01_preview) model RunStepFileSearchToolCall extends RunStepToolCall { @doc("The object type, which is always 'file_search'.") @@ -139,9 +142,9 @@ model RunStepFileSearchToolCall extends RunStepToolCall { } @doc(""" -A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs -and output consumed and emitted by the specified function. -""") + A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs + and output consumed and emitted by the specified function. + """) @added(ServiceApiVersions.v2024_02_15_preview) model RunStepFunctionToolCall extends RunStepToolCall { @doc("The object type, which is always 'function'.") @@ -167,6 +170,7 @@ model RunStepCodeInterpreterToolCallDetails { @doc("An abstract representation of an emitted output from a code interpreter tool.") @added(ServiceApiVersions.v2024_02_15_preview) model RunStepCodeInterpreterToolCallOutput { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; } diff --git a/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp b/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp index 55f43651c27f..22d4f532aced 100644 --- a/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp +++ b/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp @@ -39,7 +39,7 @@ model CodeInterpreterToolResource { */ @encodedName("application/json", "file_ids") @maxItems(20) - fileIds: string[] = []; + fileIds: string[] = #[]; } /** @@ -87,7 +87,7 @@ model CreateCodeInterpreterToolResourceOptions { /** A list of file IDs made available to the `code_interpreter` tool. */ @maxItems(20) @encodedName("application/json", "file_ids") - fileIds?: string[] = []; + fileIds?: string[] = #[]; } /** diff --git a/specification/ai/OpenAI.Assistants/tspconfig.yaml b/specification/ai/OpenAI.Assistants/tspconfig.yaml index 0fb0ba8bdd39..564b8e16d05f 100644 --- a/specification/ai/OpenAI.Assistants/tspconfig.yaml +++ b/specification/ai/OpenAI.Assistants/tspconfig.yaml @@ -14,6 +14,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/../" output-file: "data-plane/OpenAI.Assistants/OpenApiV2/{version-status}/{version}/assistants_generated.json" examples-directory: "{project-root}/examples" diff --git a/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml b/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml index 61f42734e25f..dc8e58bf03a4 100644 --- a/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml +++ b/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml @@ -9,6 +9,7 @@ emit: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azure.apicenter.dataapi.json" diff --git a/specification/apicenter/ApiCenter.Management/models.tsp b/specification/apicenter/ApiCenter.Management/models.tsp index 23a5c2f92ca0..2f37764ae65d 100644 --- a/specification/apicenter/ApiCenter.Management/models.tsp +++ b/specification/apicenter/ApiCenter.Management/models.tsp @@ -160,9 +160,9 @@ union ApiSpecImportSourceFormat { @doc("The inlined content of a specification document.") "inline", @doc(""" -The link to a specification document hosted on a publicly accessible internet -address. -""") + The link to a specification document hosted on a publicly accessible internet + address. + """) "link", } @@ -377,16 +377,16 @@ model License { name?: string; @doc(""" -URL pointing to the license details. The URL field is mutually exclusive of the -identifier field. -""") + URL pointing to the license details. The URL field is mutually exclusive of the + identifier field. + """) @maxLength(200) url?: url; @doc(""" -SPDX license information for the API. The identifier field is mutually -exclusive of the URL field. -""") + SPDX license information for the API. The identifier field is mutually + exclusive of the URL field. + """) @maxLength(50) identifier?: url; } diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-03-15-preview/apicenter.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-03-15-preview/apicenter.json index b6905c6f97f3..99c8fd351591 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-03-15-preview/apicenter.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-03-15-preview/apicenter.json @@ -3576,11 +3576,7 @@ "properties": { "$ref": "#/definitions/ApiProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3596,11 +3592,7 @@ "properties": { "$ref": "#/definitions/ApiDefinitionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3910,11 +3902,7 @@ "properties": { "$ref": "#/definitions/ApiVersionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4026,6 +4014,7 @@ }, "CustomProperties": { "type": "object", + "title": "Custom Properties", "description": "The custom metadata defined for API catalog entities." }, "DeletedService": { @@ -4035,11 +4024,7 @@ "properties": { "$ref": "#/definitions/DeletedServiceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4094,11 +4079,7 @@ "properties": { "$ref": "#/definitions/DeploymentProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4211,11 +4192,7 @@ "properties": { "$ref": "#/definitions/EnvironmentProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4584,11 +4561,7 @@ "properties": { "$ref": "#/definitions/MetadataSchemaProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4775,11 +4748,7 @@ "properties": { "$ref": "#/definitions/ServiceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", @@ -4891,11 +4860,7 @@ "properties": { "$ref": "#/definitions/WorkspaceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/apicenter.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/apicenter.json index 3362ab052d6f..c33916a2bc68 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/apicenter.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/apicenter.json @@ -3387,11 +3387,7 @@ "properties": { "$ref": "#/definitions/ApiProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3407,11 +3403,7 @@ "properties": { "$ref": "#/definitions/ApiDefinitionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3721,11 +3713,7 @@ "properties": { "$ref": "#/definitions/ApiVersionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3837,6 +3825,7 @@ }, "CustomProperties": { "type": "object", + "title": "Custom Properties", "description": "The custom metadata defined for API catalog entities." }, "Deployment": { @@ -3846,11 +3835,7 @@ "properties": { "$ref": "#/definitions/DeploymentProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3963,11 +3948,7 @@ "properties": { "$ref": "#/definitions/EnvironmentProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4336,11 +4317,7 @@ "properties": { "$ref": "#/definitions/MetadataSchemaProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4527,11 +4504,7 @@ "properties": { "$ref": "#/definitions/ServiceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", @@ -4623,11 +4596,7 @@ "properties": { "$ref": "#/definitions/WorkspaceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ReportResource.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ReportResource.tsp index 19be57009d87..ac782c51b4c6 100644 --- a/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ReportResource.tsp +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ReportResource.tsp @@ -54,10 +54,13 @@ interface Report { * Create a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report. */ #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @operationId("Report_CreateOrUpdate") + @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrReplaceAsync< ReportResource, - Azure.ResourceManager.Foundations.BaseParameters + Azure.ResourceManager.Foundations.BaseParameters, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; /** diff --git a/specification/appconfiguration/AppConfiguration/models.tsp b/specification/appconfiguration/AppConfiguration/models.tsp index 878d6b028542..eefb14ce0daf 100644 --- a/specification/appconfiguration/AppConfiguration/models.tsp +++ b/specification/appconfiguration/AppConfiguration/models.tsp @@ -229,11 +229,11 @@ model Snapshot { filters: KeyValueFilter[]; @doc(""" -The composition type describes how the key-values within the snapshot are -composed. The 'key' composition type ensures there are no two key-values -containing the same key. The 'key_label' composition type ensures there are no -two key-values containing the same key and label. -""") + The composition type describes how the key-values within the snapshot are + composed. The 'key' composition type ensures there are no two key-values + containing the same key. The 'key_label' composition type ensures there are no + two key-values containing the same key and label. + """) @encodedName("application/json", "composition_type") compositionType?: CompositionType; @@ -248,11 +248,11 @@ two key-values containing the same key and label. expires?: offsetDateTime; @doc(""" -The amount of time, in seconds, that a snapshot will remain in the archived -state before expiring. This property is only writable during the creation of a -snapshot. If not specified, the default lifetime of key-value revisions will be -used. -""") + The amount of time, in seconds, that a snapshot will remain in the archived + state before expiring. This property is only writable during the creation of a + snapshot. If not specified, the default lifetime of key-value revisions will be + used. + """) @maxValue(7776000) @minValue(3600) @encodedName("application/json", "retention_period") @@ -276,9 +276,9 @@ used. } @doc(""" -Enables filtering of key-values. Syntax reference: -https://aka.ms/azconfig/docs/restapisnapshots -""") + Enables filtering of key-values. Syntax reference: + https://aka.ms/azconfig/docs/restapisnapshots + """) model KeyValueFilter { @doc("Filters key-values by their key field.") key: string; @@ -323,8 +323,8 @@ model OperationDetails { status: Foundations.OperationState; @doc(""" -An error, available when the status is `Failed`, describing why the operation -failed. -""") + An error, available when the status is `Failed`, describing why the operation + failed. + """) error?: Foundations.Error; } diff --git a/specification/appconfiguration/AppConfiguration/routes.tsp b/specification/appconfiguration/AppConfiguration/routes.tsp index 572c81823e7e..6c6e3239364c 100644 --- a/specification/appconfiguration/AppConfiguration/routes.tsp +++ b/specification/appconfiguration/AppConfiguration/routes.tsp @@ -58,18 +58,18 @@ op getKeys is Foundations.ResourceList< name?: string; @doc(""" - Instructs the server to return elements that appear after the element referred - to by the specified token. - """) + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; ...syncTokenHeader; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; }, @@ -95,16 +95,16 @@ op checkKeys is appConfigOperation< ...syncTokenHeader; @doc(""" -Instructs the server to return elements that appear after the element referred -to by the specified token. -""") + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; }, @@ -120,32 +120,32 @@ op getKeyValues is Foundations.ResourceList< KeyValue, { @doc(""" -A filter used to match keys. Syntax reference: -https://aka.ms/azconfig/docs/keyvaluefiltering -""") + A filter used to match keys. Syntax reference: + https://aka.ms/azconfig/docs/keyvaluefiltering + """) @query("key") key?: string; @doc(""" -A filter used to match labels. Syntax reference: -https://aka.ms/azconfig/docs/keyvaluefiltering -""") + A filter used to match labels. Syntax reference: + https://aka.ms/azconfig/docs/keyvaluefiltering + """) @query("label") label?: string; ...syncTokenHeader; @doc(""" -Instructs the server to return elements that appear after the element referred -to by the specified token. -""") + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; @@ -157,31 +157,31 @@ time. select?: KeyValueFields[]; @doc(""" -A filter used get key-values for a snapshot. The value should be the name of -the snapshot. Not valid when used with 'key' and 'label' filters. -""") + A filter used get key-values for a snapshot. The value should be the name of + the snapshot. Not valid when used with 'key' and 'label' filters. + """) @query("snapshot") snapshot?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "Pre-existing API contract" @doc(""" -A filter used to query by tags. Syntax reference: -https://aka.ms/azconfig/docs/keyvaluefiltering -""") + A filter used to query by tags. Syntax reference: + https://aka.ms/azconfig/docs/keyvaluefiltering + """) @query({ name: "tags", format: "multi", @@ -203,32 +203,32 @@ https://aka.ms/azconfig/docs/keyvaluefiltering op checkKeyValues is appConfigOperation< { @doc(""" -A filter used to match keys. Syntax reference: -https://aka.ms/azconfig/docs/keyvaluefiltering -""") + A filter used to match keys. Syntax reference: + https://aka.ms/azconfig/docs/keyvaluefiltering + """) @query("key") key?: string; @doc(""" -A filter used to match labels. Syntax reference: -https://aka.ms/azconfig/docs/keyvaluefiltering -""") + A filter used to match labels. Syntax reference: + https://aka.ms/azconfig/docs/keyvaluefiltering + """) @query("label") label?: string; ...syncTokenHeader; @doc(""" -Instructs the server to return elements that appear after the element referred -to by the specified token. -""") + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; @@ -244,24 +244,24 @@ time. snapshot?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "Pre-existing API contract" @doc(""" -A filter used to query by tags. Syntax reference: -https://aka.ms/azconfig/docs/keyvaluefiltering -""") + A filter used to query by tags. Syntax reference: + https://aka.ms/azconfig/docs/keyvaluefiltering + """) @query({ name: "tags", format: "multi", @@ -291,23 +291,23 @@ op getKeyValue is standardOps.ResourceRead< ...syncTokenHeader; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; }> & @@ -344,16 +344,16 @@ op putKeyValue is appConfigOperation< ...syncTokenHeader; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; @@ -384,9 +384,9 @@ op deleteKeyValue is appConfigOperation< ...syncTokenHeader; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; }, @@ -418,23 +418,23 @@ op checkKeyValue is appConfigOperation< ...syncTokenHeader; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; @@ -459,9 +459,9 @@ op getSnapshots is Foundations.ResourceList< name?: string; @doc(""" -Instructs the server to return elements that appear after the element referred -to by the specified token. -""") + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; @@ -499,9 +499,9 @@ op checkSnapshots is appConfigOperation< ...syncTokenHeader; @doc(""" -Instructs the server to return elements that appear after the element referred -to by the specified token. -""") + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; }, @@ -526,16 +526,16 @@ op getSnapshot is standardOps.ResourceRead< ...syncTokenHeader; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; }> & @@ -605,16 +605,16 @@ op updateSnapshot is appConfigOperation< ...syncTokenHeader; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; @@ -647,16 +647,16 @@ op checkSnapshot is appConfigOperation< ...syncTokenHeader; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; }, @@ -682,16 +682,16 @@ op getLabels is appConfigOperation< ...syncTokenHeader; @doc(""" -Instructs the server to return elements that appear after the element referred -to by the specified token. -""") + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; @@ -722,16 +722,16 @@ op checkLabels is appConfigOperation< ...syncTokenHeader; @doc(""" -Instructs the server to return elements that appear after the element referred -to by the specified token. -""") + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; @@ -765,16 +765,16 @@ op putLock is appConfigOperation< ...syncTokenHeader; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; }, @@ -801,16 +801,16 @@ op deleteLock is appConfigOperation< ...syncTokenHeader; @doc(""" -Used to perform an operation only if the targeted resource's etag matches the -value provided. -""") + Used to perform an operation only if the targeted resource's etag matches the + value provided. + """) @header("If-Match") ifMatch?: string; @doc(""" -Used to perform an operation only if the targeted resource's etag does not -match the value provided. -""") + Used to perform an operation only if the targeted resource's etag does not + match the value provided. + """) @header("If-None-Match") ifNoneMatch?: string; }, @@ -827,32 +827,32 @@ match the value provided. op getRevisions is appConfigOperation< { @doc(""" -A filter used to match keys. Syntax reference: -https://aka.ms/azconfig/docs/restapirevisions -""") + A filter used to match keys. Syntax reference: + https://aka.ms/azconfig/docs/restapirevisions + """) @query("key") key?: string; @doc(""" -A filter used to match labels. Syntax reference: -https://aka.ms/azconfig/docs/restapirevisions -""") + A filter used to match labels. Syntax reference: + https://aka.ms/azconfig/docs/restapirevisions + """) @query("label") label?: string; ...syncTokenHeader; @doc(""" -Instructs the server to return elements that appear after the element referred -to by the specified token. -""") + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; @@ -865,9 +865,9 @@ time. #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "Pre-existing API contract" @doc(""" -A filter used to query by tags. Syntax reference: -https://aka.ms/azconfig/docs/restapirevisions -""") + A filter used to query by tags. Syntax reference: + https://aka.ms/azconfig/docs/restapirevisions + """) @query({ name: "tags", format: "multi", @@ -887,32 +887,32 @@ https://aka.ms/azconfig/docs/restapirevisions op checkRevisions is appConfigOperation< { @doc(""" -A filter used to match keys. Syntax reference: -https://aka.ms/azconfig/docs/restapirevisions -""") + A filter used to match keys. Syntax reference: + https://aka.ms/azconfig/docs/restapirevisions + """) @query("key") key?: string; @doc(""" -A filter used to match labels. Syntax reference: -https://aka.ms/azconfig/docs/restapirevisions -""") + A filter used to match labels. Syntax reference: + https://aka.ms/azconfig/docs/restapirevisions + """) @query("label") label?: string; ...syncTokenHeader; @doc(""" -Instructs the server to return elements that appear after the element referred -to by the specified token. -""") + Instructs the server to return elements that appear after the element referred + to by the specified token. + """) @query("After") after?: string; @doc(""" -Requests the server to respond with the state of the resource at the specified -time. -""") + Requests the server to respond with the state of the resource at the specified + time. + """) @header("Accept-Datetime") acceptDatetime?: string; @@ -925,9 +925,9 @@ time. #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "Pre-existing API contract" @doc(""" -A filter used to query by tags. Syntax reference: -https://aka.ms/azconfig/docs/restapirevisions -""") + A filter used to query by tags. Syntax reference: + https://aka.ms/azconfig/docs/restapirevisions + """) @query({ name: "tags", format: "multi", diff --git a/specification/appconfiguration/AppConfiguration/tspconfig.yaml b/specification/appconfiguration/AppConfiguration/tspconfig.yaml index 7ccf487e05d0..4e07a120c182 100644 --- a/specification/appconfiguration/AppConfiguration/tspconfig.yaml +++ b/specification/appconfiguration/AppConfiguration/tspconfig.yaml @@ -9,6 +9,7 @@ emit: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/Microsoft.AppConfiguration/{version-status}/{version}/appconfiguration.json" diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json index 8d4cad68f08b..5dfd848776f1 100644 --- a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json @@ -111,17 +111,6 @@ "$ref": "#/definitions/KeyListResult" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.keyset+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "Sync-Token": { "type": "string", "description": "Used to guarantee real-time consistency between requests." @@ -373,17 +362,6 @@ "$ref": "#/definitions/KeyValueListResult" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.kvset+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." @@ -741,17 +719,6 @@ "$ref": "#/definitions/KeyValue" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." @@ -865,17 +832,6 @@ "$ref": "#/definitions/KeyValue" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." @@ -956,17 +912,6 @@ "$ref": "#/definitions/KeyValue" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." @@ -1244,17 +1189,6 @@ "$ref": "#/definitions/LabelListResult" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.labelset+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "Sync-Token": { "type": "string", "description": "Used to guarantee real-time consistency between requests." @@ -1433,17 +1367,6 @@ "$ref": "#/definitions/KeyValue" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." @@ -1532,17 +1455,6 @@ "$ref": "#/definitions/KeyValue" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." @@ -1753,17 +1665,6 @@ "$ref": "#/definitions/KeyValueListResult" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.kvset+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." @@ -2121,17 +2022,6 @@ "$ref": "#/definitions/SnapshotListResult" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.snapshotset+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "Sync-Token": { "type": "string", "description": "Used to guarantee real-time consistency between requests." @@ -2348,17 +2238,6 @@ "$ref": "#/definitions/Snapshot" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.snapshot+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." @@ -2450,17 +2329,6 @@ "$ref": "#/definitions/Snapshot" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.snapshot+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." @@ -2562,17 +2430,6 @@ "$ref": "#/definitions/Snapshot" }, "headers": { - "Content-Type": { - "type": "string", - "description": "Content-Type header", - "enum": [ - "application/vnd.microsoft.appconfig.snapshot+json", - "application/problem+json" - ], - "x-ms-enum": { - "modelAsString": false - } - }, "ETag": { "type": "string", "description": "A value representing the current state of the resource." diff --git a/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml b/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml index cbcaaa83003d..baeb8a1afba4 100644 --- a/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml +++ b/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml @@ -9,6 +9,7 @@ emit: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" # omit the enum type Versions from being added to versioned swagger diff --git a/specification/azurefleet/AzureFleet.Management/fleet.tsp b/specification/azurefleet/AzureFleet.Management/fleet.tsp index 119a9f9a93e2..d3760b3cde01 100644 --- a/specification/azurefleet/AzureFleet.Management/fleet.tsp +++ b/specification/azurefleet/AzureFleet.Management/fleet.tsp @@ -46,7 +46,7 @@ model FleetUpdate { } model ManagedServiceIdentityUpdate - is OptionalProperties>; + is OptionalProperties>; model ResourcePlanUpdate is OptionalProperties>; @@ -93,24 +93,24 @@ model FleetProperties { @doc("Compute Profile to use for running user's workloads.") model ComputeProfile { @doc(""" - Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" - """) + Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" + """) baseVirtualMachineProfile: BaseVirtualMachineProfile; @doc(""" - Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. - The default value will be the latest supported computeApiVersion by Compute Fleet. - """) + Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. + The default value will be the latest supported computeApiVersion by Compute Fleet. + """) computeApiVersion?: string; @added(Versions.v2024_05_01_preview) @doc(""" - Specifies the number of fault domains to use when creating the underlying VMSS. - A fault domain is a logical group of hardware within an Azure datacenter. - VMs in the same fault domain share a common power source and network switch. - If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). - This property cannot be updated. - """) + Specifies the number of fault domains to use when creating the underlying VMSS. + A fault domain is a logical group of hardware within an Azure datacenter. + VMs in the same fault domain share a common power source and network switch. + If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). + This property cannot be updated. + """) platformFaultDomainCount?: int32; } @@ -125,9 +125,9 @@ model VmSizeProfile { @added(Versions.v2024_05_01_preview) @doc(""" - The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' - The lower the number, the higher the priority. Starting with 0. - """) + The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' + The lower the number, the higher the priority. Starting with 0. + """) @minValue(0) @maxValue(65535) rank?: int32; @@ -158,11 +158,11 @@ model SpotPriorityProfile is BasePriorityProfile { @added(Versions.v2024_05_01_preview) @doc(""" - Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. - If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) - or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. - Maintain is enabled by default. - """) + Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. + If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) + or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. + Maintain is enabled by default. + """) maintain?: boolean; } @@ -212,7 +212,12 @@ union EvictionPolicy { @armResourceOperations interface Fleets { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Fleet, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmCustomPatchAsync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/azurefleet/AzureFleet.Management/main.tsp b/specification/azurefleet/AzureFleet.Management/main.tsp index 126e15a3e1b2..17ef95fcf8e7 100644 --- a/specification/azurefleet/AzureFleet.Management/main.tsp +++ b/specification/azurefleet/AzureFleet.Management/main.tsp @@ -16,17 +16,18 @@ using Azure.ResourceManager; @service({ title: "Microsoft.AzureFleet", }) -@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @versioned(Versions) namespace Microsoft.AzureFleet; /** Api versions */ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @doc("Private Preview Api version") v2023_11_01_preview: "2023-11-01-preview", @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @doc("Public Preview Api version") v2024_05_01_preview: "2024-05-01-preview", } diff --git a/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp b/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp index 1864d1a78f91..63d3fd5f8011 100644 --- a/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp +++ b/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp @@ -22,9 +22,9 @@ model VirtualMachineScaleSet { name: string; @doc(""" - The compute RP resource id of the virtualMachineScaleSet - "subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}" - """) + The compute RP resource id of the virtualMachineScaleSet + "subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}" + """) @visibility("read") id: string; diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json index 0bbd2f4db9d6..7ea6f4dabd42 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json @@ -486,9 +486,9 @@ } }, "definitions": { - "Azure.ResourceManager.Foundations.ManagedServiceIdentityType": { + "Azure.ResourceManager.Legacy.ManagedServiceIdentityType": { "type": "string", - "description": "The kind of managed identity assigned to this resource.", + "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "enum": [ "None", "SystemAssigned", @@ -602,11 +602,7 @@ "properties": { "$ref": "#/definitions/FleetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "zones": { "type": "array", @@ -742,7 +738,7 @@ "description": "The template for adding optional properties.", "properties": { "type": { - "$ref": "#/definitions/Azure.ResourceManager.Foundations.ManagedServiceIdentityType", + "$ref": "#/definitions/Azure.ResourceManager.Legacy.ManagedServiceIdentityType", "description": "The type of managed identity assigned to this resource." }, "userAssignedIdentities": { @@ -863,7 +859,7 @@ }, "product": { "type": "string", - "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding." }, "promotionCode": { "type": "string", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json index 7a6c8aabf7ca..d23085838d30 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json @@ -465,9 +465,9 @@ } }, "definitions": { - "Azure.ResourceManager.Foundations.ManagedServiceIdentityType": { + "Azure.ResourceManager.Legacy.ManagedServiceIdentityType": { "type": "string", - "description": "The kind of managed identity assigned to this resource.", + "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "enum": [ "None", "SystemAssigned", @@ -591,11 +591,7 @@ "properties": { "$ref": "#/definitions/FleetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "zones": { "type": "array", @@ -731,7 +727,7 @@ "description": "The template for adding optional properties.", "properties": { "type": { - "$ref": "#/definitions/Azure.ResourceManager.Foundations.ManagedServiceIdentityType", + "$ref": "#/definitions/Azure.ResourceManager.Legacy.ManagedServiceIdentityType", "description": "The type of managed identity assigned to this resource." }, "userAssignedIdentities": { @@ -858,7 +854,7 @@ }, "product": { "type": "string", - "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding." }, "promotionCode": { "type": "string", diff --git a/specification/azurelargeinstance/AzureLargeInstance.Management/AzureLargeInstance.tsp b/specification/azurelargeinstance/AzureLargeInstance.Management/AzureLargeInstance.tsp index 82104985f79a..3ae57ffbad46 100644 --- a/specification/azurelargeinstance/AzureLargeInstance.Management/AzureLargeInstance.tsp +++ b/specification/azurelargeinstance/AzureLargeInstance.Management/AzureLargeInstance.tsp @@ -11,9 +11,9 @@ using Azure.ClientGenerator.Core; namespace Microsoft.AzureLargeInstance; @doc(""" -Azure Large Instance info on Azure (ARM properties and AzureLargeInstance -properties) -""") + Azure Large Instance info on Azure (ARM properties and AzureLargeInstance + properties) + """) model AzureLargeInstance is TrackedResource { @doc("Name of the AzureLargeInstance.") @pattern(".*") @@ -28,27 +28,27 @@ model AzureLargeInstance is TrackedResource { @clientName("AzureLargeInstance") interface AzureLargeInstances { @doc(""" -Gets an Azure Large Instance for the specified subscription, resource group, -and instance name. -""") + Gets an Azure Large Instance for the specified subscription, resource group, + and instance name. + """) get is ArmResourceRead; @doc(""" -Patches the Tags field of an Azure Large Instance for the specified -subscription, resource group, and instance name. -""") + Patches the Tags field of an Azure Large Instance for the specified + subscription, resource group, and instance name. + """) update is ArmCustomPatchSync; @doc(""" -Gets a list of Azure Large Instances in the specified subscription and resource -group. The operations returns various properties of each Azure Large Instance. -""") + Gets a list of Azure Large Instances in the specified subscription and resource + group. The operations returns various properties of each Azure Large Instance. + """) listByResourceGroup is ArmResourceListByParent; @doc(""" -Gets a list of Azure Large Instances in the specified subscription. The -operations returns various properties of each Azure Large Instance. -""") + Gets a list of Azure Large Instances in the specified subscription. The + operations returns various properties of each Azure Large Instance. + """) listBySubscription is ArmListBySubscription; @doc("The operation to start an Azure Large Instance (only for compute instances)") diff --git a/specification/azurelargeinstance/AzureLargeInstance.Management/AzureLargeStorageInstance.tsp b/specification/azurelargeinstance/AzureLargeInstance.Management/AzureLargeStorageInstance.tsp index 118b3c4785a2..ec44a0a2fecf 100644 --- a/specification/azurelargeinstance/AzureLargeInstance.Management/AzureLargeStorageInstance.tsp +++ b/specification/azurelargeinstance/AzureLargeInstance.Management/AzureLargeStorageInstance.tsp @@ -11,9 +11,9 @@ using Azure.ClientGenerator.Core; namespace Microsoft.AzureLargeInstance; @doc(""" -AzureLargeStorageInstance info on Azure (ARM properties and -AzureLargeStorageInstance properties) -""") + AzureLargeStorageInstance info on Azure (ARM properties and + AzureLargeStorageInstance properties) + """) model AzureLargeStorageInstance is TrackedResource { @doc("Name of the AzureLargeStorageInstance.") @@ -29,25 +29,25 @@ model AzureLargeStorageInstance @clientName("AzureLargeStorageInstance") interface AzureLargeStorageInstances { @doc(""" -Gets an Azure Large Storage instance for the specified subscription, resource -group, and instance name. -""") + Gets an Azure Large Storage instance for the specified subscription, resource + group, and instance name. + """) get is ArmResourceRead; @doc(""" -Patches the Tags field of a Azure Large Storage Instance for the specified -subscription, resource group, and instance name. -""") + Patches the Tags field of a Azure Large Storage Instance for the specified + subscription, resource group, and instance name. + """) update is ArmCustomPatchSync; @doc(""" -Gets a list of AzureLargeStorageInstances in the specified subscription and -resource group. The operations returns various properties of each Azure -LargeStorage instance. -""") + Gets a list of AzureLargeStorageInstances in the specified subscription and + resource group. The operations returns various properties of each Azure + LargeStorage instance. + """) listByResourceGroup is ArmResourceListByParent; @doc(""" -Gets a list of AzureLargeStorageInstances in the specified subscription. The -operations returns various properties of each Azure LargeStorage instance. -""") + Gets a list of AzureLargeStorageInstances in the specified subscription. The + operations returns various properties of each Azure LargeStorage instance. + """) listBySubscription is ArmListBySubscription; } diff --git a/specification/azurelargeinstance/AzureLargeInstance.Management/models.tsp b/specification/azurelargeinstance/AzureLargeInstance.Management/models.tsp index 147410a10b3b..779f196340ad 100644 --- a/specification/azurelargeinstance/AzureLargeInstance.Management/models.tsp +++ b/specification/azurelargeinstance/AzureLargeInstance.Management/models.tsp @@ -309,9 +309,9 @@ model AzureLargeInstanceProperties { hwRevision?: string; @doc(""" -ARM ID of another AzureLargeInstance that will share a network with this -AzureLargeInstance -""") + ARM ID of another AzureLargeInstance that will share a network with this + AzureLargeInstance + """) @removed(Versions.v2024_04_10) partnerNodeId?: string; @@ -338,9 +338,9 @@ model StorageProfile { nfsIpAddress?: string; @doc(""" -Specifies information about the operating system disk used by Azure Large -Instance. -""") + Specifies information about the operating system disk used by Azure Large + Instance. + """) @extension("x-ms-identifiers", []) osDisks?: Disk[]; } @@ -355,10 +355,10 @@ model Disk { diskSizeGB?: int32; @doc(""" -Specifies the logical unit number of the data disk. This value is used to -identify data disks within the VM and therefore must be unique for each data -disk attached to a VM. -""") + Specifies the logical unit number of the data disk. This value is used to + identify data disks within the VM and therefore must be unique for each data + disk attached to a VM. + """) @visibility("read") lun?: int32; } @@ -400,9 +400,9 @@ model IpAddress { } @doc(""" -The active state empowers the server with the ability to forcefully terminate -and halt any existing processes that may be running on the server -""") + The active state empowers the server with the ability to forcefully terminate + and halt any existing processes that may be running on the server + """) model ForceState { #suppress "@azure-tools/typespec-azure-core/property-name-conflict" "https://github.com/Azure/typespec-azure/issues/417" @doc("Whether to force restart by shutting all processes.") diff --git a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/azurelargeinstance.json b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/azurelargeinstance.json index 185bd5eca35e..93519783821a 100644 --- a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/azurelargeinstance.json +++ b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/azurelargeinstance.json @@ -671,11 +671,7 @@ "properties": { "$ref": "#/definitions/AzureLargeInstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1221,11 +1217,7 @@ "properties": { "$ref": "#/definitions/AzureLargeStorageInstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/stable/2024-04-10/azurelargeinstance.json b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/stable/2024-04-10/azurelargeinstance.json index d5bbfe3bcc94..c20d5c66b605 100644 --- a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/stable/2024-04-10/azurelargeinstance.json +++ b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/stable/2024-04-10/azurelargeinstance.json @@ -671,11 +671,7 @@ "properties": { "$ref": "#/definitions/AzureLargeInstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1217,11 +1213,7 @@ "properties": { "$ref": "#/definitions/AzureLargeStorageInstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp index e46cd9ce02da..4948e6367a32 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp @@ -33,8 +33,13 @@ interface GalleryImages { @doc("Gets a gallery image") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + GalleryImage, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("The operation to update a gallery image.") @parameterVisibility diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp index e8cb4b5f819f..e7c453668417 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp @@ -30,8 +30,13 @@ interface GuestAgents { @doc("Implements GuestAgent GET method.") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("Create Or Update GuestAgent.") - create is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrReplaceAsync< + GuestAgent, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("Implements GuestAgent DELETE method.") delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp index 9b01a62dd7cc..d0d28d24df54 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp @@ -33,8 +33,13 @@ interface LogicalNetworks { @doc("The operation to get a logical network.") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("The operation to create or update a logical network. Please note some properties can be set only during logical network creation.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + LogicalNetwork, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("The operation to update a logical network.") @parameterVisibility diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp index 470b9fab0733..e763cfe68247 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp @@ -34,8 +34,13 @@ interface MarketplaceGalleryImages { @doc("Gets a marketplace gallery image") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("The operation to create or update a marketplace gallery image. Please note some properties can be set only during marketplace gallery image creation.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + MarketplaceGalleryImage, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("The operation to update a marketplace gallery image.") @parameterVisibility diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp index b181201c789c..30c6d7f11fe7 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp @@ -33,8 +33,13 @@ interface NetworkInterfaces { @doc("Gets a network interface") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("The operation to create or update a network interface. Please note some properties can be set only during network interface creation.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + NetworkInterface, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("The operation to update a network interface.") @parameterVisibility diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp index 8de6fc091382..4f712714116e 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp @@ -31,8 +31,13 @@ interface NetworkSecurityGroups { @doc("Gets the specified network security group.") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("Creates or updates a network security group in the specified resource group.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + NetworkSecurityGroup, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("Updates a network security group tags.") updateTags is ArmTagsPatchAsync; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp index 4563d65e5c59..a2e58268e493 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp @@ -30,8 +30,13 @@ interface SecurityRules { @doc("Gets the specified security rule.") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("Creates or updates a security rule in the specified resource group.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + SecurityRule, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("Deletes the specified security rule.") delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp index f81302304026..22546b6b08e5 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp @@ -32,8 +32,13 @@ interface StorageContainers { @doc("Gets a storage container") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("The operation to create or update a storage container. Please note some properties can be set only during storage container creation.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + StorageContainer, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("The operation to update a storage container.") update is ArmTagsPatchAsync; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp index 4123b2ea6ca7..c40e222784d1 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp @@ -33,8 +33,13 @@ interface VirtualHardDisks { @doc("Gets a virtual hard disk") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + VirtualHardDisk, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("The operation to update a virtual hard disk.") update is ArmTagsPatchAsync; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualMachineInstance.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualMachineInstance.tsp index 177c79c2491f..c502b2eacac6 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualMachineInstance.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualMachineInstance.tsp @@ -36,8 +36,13 @@ interface VirtualMachineInstances { @doc("Gets a virtual machine instance") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + VirtualMachineInstance, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("The operation to update a virtual machine instance.") @parameterVisibility diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json index db8910818cc0..b86d0039c729 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json @@ -3609,11 +3609,7 @@ "properties": { "$ref": "#/definitions/AttestationStatusProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3881,11 +3877,7 @@ "properties": { "$ref": "#/definitions/GalleryImageProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -4137,11 +4129,7 @@ "properties": { "$ref": "#/definitions/GuestAgentProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4307,11 +4295,7 @@ "properties": { "$ref": "#/definitions/HybridIdentityMetadataProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4622,11 +4606,7 @@ "properties": { "$ref": "#/definitions/LogicalNetworkProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -4778,11 +4758,7 @@ "properties": { "$ref": "#/definitions/MarketplaceGalleryImageProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -4955,11 +4931,7 @@ "properties": { "$ref": "#/definitions/NetworkInterfaceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -5129,11 +5101,7 @@ "properties": { "$ref": "#/definitions/NetworkSecurityGroupProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -5523,11 +5491,7 @@ "properties": { "$ref": "#/definitions/SecurityRuleProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -5864,11 +5828,7 @@ "properties": { "$ref": "#/definitions/StorageContainerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -6131,11 +6091,7 @@ "properties": { "$ref": "#/definitions/VirtualHardDiskProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -6351,11 +6307,7 @@ "properties": { "$ref": "#/definitions/VirtualMachineInstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", diff --git a/specification/batch/Azure.Batch/common.tsp b/specification/batch/Azure.Batch/common.tsp index a0d24afac769..e92f0df0a4a3 100644 --- a/specification/batch/Azure.Batch/common.tsp +++ b/specification/batch/Azure.Batch/common.tsp @@ -225,19 +225,19 @@ alias BatchMatchHeaders = { ...BatchModifiedSinceHeaders; @doc(""" - An ETag value associated with the version of the resource known to the client. - The operation will be performed only if the resource's current ETag on the - service exactly matches the value specified by the client. - """) + An ETag value associated with the version of the resource known to the client. + The operation will be performed only if the resource's current ETag on the + service exactly matches the value specified by the client. + """) @header("If-Match") @clientName("if__match", "python") ifMatch?: string; @doc(""" - An ETag value associated with the version of the resource known to the client. - The operation will be performed only if the resource's current ETag on the - service does not match the value specified by the client. - """) + An ETag value associated with the version of the resource known to the client. + The operation will be performed only if the resource's current ETag on the + service does not match the value specified by the client. + """) @header("If-None-Match") @clientName("if_none_match", "python") ifNoneMatch?: string; @@ -245,20 +245,20 @@ alias BatchMatchHeaders = { alias BatchModifiedSinceHeaders = { @doc(""" - A timestamp indicating the last modified time of the resource known to the - client. The operation will be performed only if the resource on the service has - been modified since the specified time. - """) + A timestamp indicating the last modified time of the resource known to the + client. The operation will be performed only if the resource on the service has + been modified since the specified time. + """) @header("If-Modified-Since") @encode(DateTimeKnownEncoding.rfc7231) @clientName("if_modified_since", "python") ifModifiedSince?: utcDateTime; @doc(""" - A timestamp indicating the last modified time of the resource known to the - client. The operation will be performed only if the resource on the service has - not been modified since the specified time. - """) + A timestamp indicating the last modified time of the resource known to the + client. The operation will be performed only if the resource on the service has + not been modified since the specified time. + """) @header("If-Unmodified-Since") @encode(DateTimeKnownEncoding.rfc7231) @clientName("if_unmodified_since", "python") @@ -337,9 +337,9 @@ alias BatchCommonListHeaders = { ...BatchClientRequestHeaders; @doc(""" - The maximum number of items to return in the response. A maximum of 1000 - applications can be returned. - """) + The maximum number of items to return in the response. A maximum of 1000 + applications can be returned. + """) @query @minValue(1) @maxValue(1000) @@ -377,16 +377,16 @@ alias BatchTaskFileClientPathContent = { alias BatchClientRequestHeaders = { @doc(""" - The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". - """) + The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". + """) @query @clientName("timeOutInSeconds") timeOut?: int32 = 30; @doc(""" - The caller-generated request identity, in the form of a GUID with no decoration - such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - """) + The caller-generated request identity, in the form of a GUID with no decoration + such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + """) @header("client-request-id") clientRequestId?: string; @@ -395,10 +395,10 @@ alias BatchClientRequestHeaders = { returnClientRequestId?: boolean = false; @doc(""" - The time the request was issued. Client libraries typically set this to the - current system clock time; set it explicitly if you are calling the REST API - directly. - """) + The time the request was issued. Client libraries typically set this to the + current system clock time; set it explicitly if you are calling the REST API + directly. + """) @header("ocp-date") @encode(DateTimeKnownEncoding.rfc7231) ocpdate?: utcDateTime; diff --git a/specification/batch/Azure.Batch/models.tsp b/specification/batch/Azure.Batch/models.tsp index 3d1ec61ad43a..fd927c8f2632 100644 --- a/specification/batch/Azure.Batch/models.tsp +++ b/specification/batch/Azure.Batch/models.tsp @@ -754,9 +754,9 @@ model BatchAccountListSupportedImagesResult { } @doc(""" -A reference to the Azure Virtual Machines Marketplace Image and additional -information about the Image. -""") + A reference to the Azure Virtual Machines Marketplace Image and additional + information about the Image. + """) model BatchSupportedImage { #suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Property types must use camelCase" @doc("The ID of the Compute Node agent SKU which the Image supports.") @@ -780,10 +780,10 @@ model BatchSupportedImage { } @doc(""" -A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. -To get the list of all Azure Marketplace Image references verified by Azure Batch, see the -' List Supported Images ' operation. -""") + A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. + To get the list of all Azure Marketplace Image references verified by Azure Batch, see the + ' List Supported Images ' operation. + """) model ImageReference { @doc("The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer.") publisher?: string; @@ -1012,9 +1012,9 @@ model NameValuePair { } @doc(""" -The result of listing the files on a Compute Node, or the files associated with -a Task on a Compute Node. -""") + The result of listing the files on a Compute Node, or the files associated with + a Task on a Compute Node. + """) @pagedResult model BatchNodeFileListResult { @doc("The list of files.") @@ -1061,9 +1061,9 @@ model FileProperties { } @doc(""" -A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a -specification used to create each Job. -""") + A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a + specification used to create each Job. + """) model BatchJobSchedule { @doc("A string that uniquely identifies the schedule within the Account.") @visibility("read") @@ -1124,8 +1124,8 @@ model BatchJobSchedule { } @doc(""" -Parameters for updating an Azure Batch Job Schedule. -""") + Parameters for updating an Azure Batch Job Schedule. + """) model BatchJobScheduleUpdateContent { @doc("The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. If you do not specify this element, the existing schedule is left unchanged.") schedule?: BatchJobScheduleConfiguration; @@ -1138,8 +1138,8 @@ model BatchJobScheduleUpdateContent { } @doc(""" -Parameters for creating an Azure Batch Job Schedule -""") + Parameters for creating an Azure Batch Job Schedule + """) model BatchJobScheduleCreateContent { @doc("A string that uniquely identifies the schedule within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).") id: string; @@ -1158,9 +1158,9 @@ model BatchJobScheduleCreateContent { } @doc(""" -The schedule according to which Jobs will be created. All times are fixed -respective to UTC and are not impacted by daylight saving time. -""") + The schedule according to which Jobs will be created. All times are fixed + respective to UTC and are not impacted by daylight saving time. + """) model BatchJobScheduleConfiguration { @doc("The earliest time at which any Job may be created under this Job Schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately.") doNotRunUntil?: utcDateTime; @@ -1188,9 +1188,9 @@ model SecurityProfile { } @doc(""" -Specifies the service artifact reference id used to set same image version -for all virtual machines in the scale set when using 'latest' image version. -""") + Specifies the service artifact reference id used to set same image version + for all virtual machines in the scale set when using 'latest' image version. + """) model ServiceArtifactReference { @doc("The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}") id: string; @@ -1260,30 +1260,30 @@ model BatchJobConstraints { } @doc(""" -Specifies details of a Job Manager Task. -The Job Manager Task is automatically started when the Job is created. The -Batch service tries to schedule the Job Manager Task before any other Tasks in -the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where -Job Manager Tasks are running for as long as possible (that is, Compute Nodes -running 'normal' Tasks are removed before Compute Nodes running Job Manager -Tasks). When a Job Manager Task fails and needs to be restarted, the system -tries to schedule it at the highest priority. If there are no idle Compute -Nodes available, the system may terminate one of the running Tasks in the Pool -and return it to the queue in order to make room for the Job Manager Task to -restart. Note that a Job Manager Task in one Job does not have priority over -Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For -example, if a Job Manager in a priority 0 Job needs to be restarted, it will -not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery -operation is triggered on a Node. Examples of recovery operations include (but -are not limited to) when an unhealthy Node is rebooted or a Compute Node -disappeared due to host failure. Retries due to recovery operations are -independent of and are not counted against the maxTaskRetryCount. Even if the -maxTaskRetryCount is 0, an internal retry due to a recovery operation may -occur. Because of this, all Tasks should be idempotent. This means Tasks need -to tolerate being interrupted and restarted without causing any corruption or -duplicate data. The best practice for long running Tasks is to use some form of -checkpointing. -""") + Specifies details of a Job Manager Task. + The Job Manager Task is automatically started when the Job is created. The + Batch service tries to schedule the Job Manager Task before any other Tasks in + the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where + Job Manager Tasks are running for as long as possible (that is, Compute Nodes + running 'normal' Tasks are removed before Compute Nodes running Job Manager + Tasks). When a Job Manager Task fails and needs to be restarted, the system + tries to schedule it at the highest priority. If there are no idle Compute + Nodes available, the system may terminate one of the running Tasks in the Pool + and return it to the queue in order to make room for the Job Manager Task to + restart. Note that a Job Manager Task in one Job does not have priority over + Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For + example, if a Job Manager in a priority 0 Job needs to be restarted, it will + not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery + operation is triggered on a Node. Examples of recovery operations include (but + are not limited to) when an unhealthy Node is rebooted or a Compute Node + disappeared due to host failure. Retries due to recovery operations are + independent of and are not counted against the maxTaskRetryCount. Even if the + maxTaskRetryCount is 0, an internal retry due to a recovery operation may + occur. Because of this, all Tasks should be idempotent. This means Tasks need + to tolerate being interrupted and restarted without causing any corruption or + duplicate data. The best practice for long running Tasks is to use some form of + checkpointing. + """) model BatchJobManagerTask { @doc("A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters.") id: string; @@ -1322,15 +1322,15 @@ model BatchJobManagerTask { runExclusive?: boolean; @doc(""" -A list of Application Packages that the Batch service will deploy to the -Compute Node before running the command line.Application Packages are -downloaded and deployed to a shared directory, not the Task working -directory. Therefore, if a referenced Application Package is already -on the Compute Node, and is up to date, then it is not re-downloaded; -the existing copy on the Compute Node is used. If a referenced Application -Package cannot be installed, for example because the package has been deleted -or because download failed, the Task fails. -""") + A list of Application Packages that the Batch service will deploy to the + Compute Node before running the command line.Application Packages are + downloaded and deployed to a shared directory, not the Task working + directory. Therefore, if a referenced Application Package is already + on the Compute Node, and is up to date, then it is not re-downloaded; + the existing copy on the Compute Node is used. If a referenced Application + Package cannot be installed, for example because the package has been deleted + or because download failed, the Task fails. + """) applicationPackageReferences?: BatchApplicationPackageReference[]; @doc("The settings for an authentication token that the Task can use to perform Batch service operations. If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.") @@ -1372,9 +1372,9 @@ model ContainerRegistryReference { } @doc(""" -The reference to a user assigned identity associated with the Batch pool which -a compute node will use. -""") + The reference to a user assigned identity associated with the Batch pool which + a compute node will use. + """) model BatchNodeIdentityReference { @doc("The ARM resource id of the user assigned identity.") resourceId?: string; @@ -1405,8 +1405,8 @@ model ResourceFile { } @doc(""" -On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure. -""") + On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure. + """) model OutputFile { @doc("A pattern indicating which file(s) to upload. Both relative and absolute paths are supported. Relative paths are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with \".\" it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\\*.txt matches any file that does not start in '.' and ends with .txt in the Task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \\ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied.") filePattern: string; @@ -1449,9 +1449,9 @@ model HttpHeader { } @doc(""" -Options for an output file upload operation, including under what conditions -to perform the upload. -""") + Options for an output file upload operation, including under what conditions + to perform the upload. + """) model OutputFileUploadConfig { @doc("The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion.") uploadCondition: OutputFileUploadCondition; @@ -1497,8 +1497,8 @@ model UefiSettings { } @doc(""" -Specifies the options for the auto user that runs an Azure Batch Task. -""") + Specifies the options for the auto user that runs an Azure Batch Task. + """) model AutoUserSpecification { @doc("The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks.") scope?: AutoUserScope; @@ -1517,42 +1517,42 @@ model BatchApplicationPackageReference { } @doc(""" -The settings for an authentication token that the Task can use to perform Batch -service operations. -""") + The settings for an authentication token that the Task can use to perform Batch + service operations. + """) model AuthenticationTokenSettings { @doc("The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task.") access?: AccessScope[]; } @doc(""" -A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. -You can use Job Preparation to prepare a Node to run Tasks for the Job. -Activities commonly performed in Job Preparation include: Downloading common -resource files used by all the Tasks in the Job. The Job Preparation Task can -download these common resource files to the shared location on the Node. -(AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the Node so -that all Tasks of that Job can communicate with it. If the Job Preparation Task -fails (that is, exhausts its retry count before exiting with exit code 0), -Batch will not run Tasks of this Job on the Node. The Compute Node remains -ineligible to run Tasks of this Job until it is reimaged. The Compute Node -remains active and can be used for other Jobs. The Job Preparation Task can run -multiple times on the same Node. Therefore, you should write the Job -Preparation Task to handle re-execution. If the Node is rebooted, the Job -Preparation Task is run again on the Compute Node before scheduling any other -Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job -Preparation Task did not previously complete. If the Node is reimaged, the Job -Preparation Task is run again before scheduling any Task of the Job. Batch will -retry Tasks when a recovery operation is triggered on a Node. Examples of -recovery operations include (but are not limited to) when an unhealthy Node is -rebooted or a Compute Node disappeared due to host failure. Retries due to -recovery operations are independent of and are not counted against the -maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to -a recovery operation may occur. Because of this, all Tasks should be -idempotent. This means Tasks need to tolerate being interrupted and restarted -without causing any corruption or duplicate data. The best practice for long -running Tasks is to use some form of checkpointing. -""") + A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. + You can use Job Preparation to prepare a Node to run Tasks for the Job. + Activities commonly performed in Job Preparation include: Downloading common + resource files used by all the Tasks in the Job. The Job Preparation Task can + download these common resource files to the shared location on the Node. + (AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the Node so + that all Tasks of that Job can communicate with it. If the Job Preparation Task + fails (that is, exhausts its retry count before exiting with exit code 0), + Batch will not run Tasks of this Job on the Node. The Compute Node remains + ineligible to run Tasks of this Job until it is reimaged. The Compute Node + remains active and can be used for other Jobs. The Job Preparation Task can run + multiple times on the same Node. Therefore, you should write the Job + Preparation Task to handle re-execution. If the Node is rebooted, the Job + Preparation Task is run again on the Compute Node before scheduling any other + Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job + Preparation Task did not previously complete. If the Node is reimaged, the Job + Preparation Task is run again before scheduling any Task of the Job. Batch will + retry Tasks when a recovery operation is triggered on a Node. Examples of + recovery operations include (but are not limited to) when an unhealthy Node is + rebooted or a Compute Node disappeared due to host failure. Retries due to + recovery operations are independent of and are not counted against the + maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to + a recovery operation may occur. Because of this, all Tasks should be + idempotent. This means Tasks need to tolerate being interrupted and restarted + without causing any corruption or duplicate data. The best practice for long + running Tasks is to use some form of checkpointing. + """) model BatchJobPreparationTask { @doc("A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).") id?: string; @@ -1583,23 +1583,23 @@ model BatchJobPreparationTask { } @doc(""" -A Job Release Task to run on Job completion on any Compute Node where the Job has run. -The Job Release Task runs when the Job ends, because of one of the following: -The user calls the Terminate Job API, or the Delete Job API while the Job is -still active, the Job's maximum wall clock time constraint is reached, and the -Job is still active, or the Job's Job Manager Task completed, and the Job is -configured to terminate when the Job Manager completes. The Job Release Task -runs on each Node where Tasks of the Job have run and the Job Preparation Task -ran and completed. If you reimage a Node after it has run the Job Preparation -Task, and the Job ends without any further Tasks of the Job running on that -Node (and hence the Job Preparation Task does not re-run), then the Job Release -Task does not run on that Compute Node. If a Node reboots while the Job Release -Task is still running, the Job Release Task runs again when the Compute Node -starts up. The Job is not marked as complete until all Job Release Tasks have -completed. The Job Release Task runs in the background. It does not occupy a -scheduling slot; that is, it does not count towards the taskSlotsPerNode limit -specified on the Pool. -""") + A Job Release Task to run on Job completion on any Compute Node where the Job has run. + The Job Release Task runs when the Job ends, because of one of the following: + The user calls the Terminate Job API, or the Delete Job API while the Job is + still active, the Job's maximum wall clock time constraint is reached, and the + Job is still active, or the Job's Job Manager Task completed, and the Job is + configured to terminate when the Job Manager completes. The Job Release Task + runs on each Node where Tasks of the Job have run and the Job Preparation Task + ran and completed. If you reimage a Node after it has run the Job Preparation + Task, and the Job ends without any further Tasks of the Job running on that + Node (and hence the Job Preparation Task does not re-run), then the Job Release + Task does not run on that Compute Node. If a Node reboots while the Job Release + Task is still running, the Job Release Task runs again when the Compute Node + starts up. The Job is not marked as complete until all Job Release Tasks have + completed. The Job Release Task runs in the background. It does not occupy a + scheduling slot; that is, it does not count towards the taskSlotsPerNode limit + specified on the Pool. + """) model BatchJobReleaseTask { @doc("A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).") id?: string; @@ -1636,9 +1636,9 @@ model BatchPoolInfo { } @doc(""" -Specifies characteristics for a temporary 'auto pool'. The Batch service will -create this auto Pool when the Job is submitted. -""") + Specifies characteristics for a temporary 'auto pool'. The Batch service will + create this auto Pool when the Job is submitted. + """) model BatchAutoPoolSpecification { @doc("A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long.") autoPoolIdPrefix?: string; @@ -1721,9 +1721,9 @@ model BatchPoolSpecification { #suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Property types must use camelCase" @doc(""" -The configuration for Compute Nodes in a Pool based on the Azure Virtual -Machines infrastructure. -""") + The configuration for Compute Nodes in a Pool based on the Azure Virtual + Machines infrastructure. + """) model VirtualMachineConfiguration { @doc("A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use.") imageReference: ImageReference; @@ -1739,16 +1739,16 @@ model VirtualMachineConfiguration { dataDisks?: DataDisk[]; @doc(""" -This only applies to Images that contain the Windows operating system, and -should only be used when you hold valid on-premises licenses for the Compute -Nodes which will be deployed. If omitted, no on-premises licensing discount is -applied. Values are: - - Windows_Server - The on-premises license is for Windows -Server. - Windows_Client - The on-premises license is for Windows Client. - -""") + This only applies to Images that contain the Windows operating system, and + should only be used when you hold valid on-premises licenses for the Compute + Nodes which will be deployed. If omitted, no on-premises licensing discount is + applied. Values are: + + Windows_Server - The on-premises license is for Windows + Server. + Windows_Client - The on-premises license is for Windows Client. + + """) licenseType?: string; @doc("The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it.") @@ -1781,10 +1781,10 @@ model WindowsConfiguration { #suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Property types must use camelCase" @doc(""" -Settings which will be used by the data disks associated to Compute Nodes in -the Pool. When using attached data disks, you need to mount and format the -disks from within a VM to use them. -""") + Settings which will be used by the data disks associated to Compute Nodes in + the Pool. When using attached data disks, you need to mount and format the + disks from within a VM to use them. + """) model DataDisk { @doc("The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive.") @clientName("logicalUnitNumber") @@ -1814,20 +1814,20 @@ model ContainerConfiguration { } @doc(""" -The disk encryption configuration applied on compute nodes in the pool. -Disk encryption configuration is not supported on Linux pool created with -Azure Compute Gallery Image. -""") + The disk encryption configuration applied on compute nodes in the pool. + Disk encryption configuration is not supported on Linux pool created with + Azure Compute Gallery Image. + """) model DiskEncryptionConfiguration { @doc("The list of disk targets Batch Service will encrypt on the compute node. If omitted, no disks on the compute nodes in the pool will be encrypted. On Linux pool, only \"TemporaryDisk\" is supported; on Windows pool, \"OsDisk\" and \"TemporaryDisk\" must be specified.") targets?: DiskEncryptionTarget[]; } @doc(""" -For regional placement, nodes in the pool will be allocated in the same region. -For zonal placement, nodes in the pool will be spread across different zones -with best effort balancing. -""") + For regional placement, nodes in the pool will be allocated in the same region. + For zonal placement, nodes in the pool will be spread across different zones + with best effort balancing. + """) model BatchNodePlacementConfiguration { @doc("Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.") policy?: BatchNodePlacementPolicyType; @@ -1884,9 +1884,9 @@ model OSDisk { } @doc(""" -Specifies the ephemeral Disk Settings for the operating system disk used by the -compute node (VM). -""") + Specifies the ephemeral Disk Settings for the operating system disk used by the + compute node (VM). + """) model DiffDiskSettings { @doc("Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.") placement?: DiffDiskPlacement; @@ -1928,9 +1928,9 @@ model BatchPoolEndpointConfiguration { #suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Property types must use camelCase" @doc(""" -A inbound NAT Pool that can be used to address specific ports on Compute Nodes -in a Batch Pool externally. -""") + A inbound NAT Pool that can be used to address specific ports on Compute Nodes + in a Batch Pool externally. + """) model InboundNatPool { @doc("The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.") name: string; @@ -1978,20 +1978,20 @@ model PublicIpAddressConfiguration { } @doc(""" -Batch will retry Tasks when a recovery operation is triggered on a Node. -Examples of recovery operations include (but are not limited to) when an -unhealthy Node is rebooted or a Compute Node disappeared due to host failure. -Retries due to recovery operations are independent of and are not counted -against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal -retry due to a recovery operation may occur. Because of this, all Tasks should -be idempotent. This means Tasks need to tolerate being interrupted and -restarted without causing any corruption or duplicate data. The best practice -for long running Tasks is to use some form of checkpointing. In some cases the -StartTask may be re-run even though the Compute Node was not rebooted. Special -care should be taken to avoid StartTasks which create breakaway process or -install/launch services from the StartTask working directory, as this will -block Batch from being able to re-run the StartTask. -""") + Batch will retry Tasks when a recovery operation is triggered on a Node. + Examples of recovery operations include (but are not limited to) when an + unhealthy Node is rebooted or a Compute Node disappeared due to host failure. + Retries due to recovery operations are independent of and are not counted + against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal + retry due to a recovery operation may occur. Because of this, all Tasks should + be idempotent. This means Tasks need to tolerate being interrupted and + restarted without causing any corruption or duplicate data. The best practice + for long running Tasks is to use some form of checkpointing. In some cases the + StartTask may be re-run even though the Compute Node was not rebooted. Special + care should be taken to avoid StartTasks which create breakaway process or + install/launch services from the StartTask working directory, as this will + block Batch from being able to re-run the StartTask. + """) model BatchStartTask { @doc("The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).") commandLine: string; @@ -2016,9 +2016,9 @@ model BatchStartTask { } @doc(""" -Properties used to create a user used to execute Tasks on an Azure Batch -Compute Node. -""") + Properties used to create a user used to execute Tasks on an Azure Batch + Compute Node. + """) model UserAccount { @doc("The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20.") name: string; @@ -2063,9 +2063,9 @@ model ManagedDisk { } @doc(""" -The Batch service does not assign any meaning to this metadata; it is solely -for the use of user code. -""") + The Batch service does not assign any meaning to this metadata; it is solely + for the use of user code. + """) model MetadataItem { @doc("The name of the metadata item.") name: string; @@ -2167,9 +2167,9 @@ model AzureFileShareConfiguration { } @doc(""" -Contains information about Jobs that have been and will be run under a Job -Schedule. -""") + Contains information about Jobs that have been and will be run under a Job + Schedule. + """) model BatchJobScheduleExecutionInfo { @doc("The next time at which a Job will be created under this schedule. This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no Job will be created at nextRunTime unless the Job is enabled before then.") nextRunTime?: utcDateTime; @@ -2487,9 +2487,9 @@ model BatchJobListResult { } @doc(""" -The result of listing the status of the Job Preparation and Job Release Tasks -for a Job. -""") + The result of listing the status of the Job Preparation and Job Release Tasks + for a Job. + """) @pagedResult model BatchJobPreparationAndReleaseTaskStatusListResult { @doc("A list of Job Preparation and Job Release Task execution information.") @@ -2521,9 +2521,9 @@ model BatchJobPreparationAndReleaseTaskStatus { } @doc(""" -Contains information about the execution of a Job Preparation Task on a Compute -Node. -""") + Contains information about the execution of a Job Preparation Task on a Compute + Node. + """) model BatchJobPreparationTaskExecutionInfo { @doc("The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running.") startTime: utcDateTime; @@ -2587,9 +2587,9 @@ model BatchTaskFailureInfo { } @doc(""" -Contains information about the execution of a Job Release Task on a Compute -Node. -""") + Contains information about the execution of a Job Release Task on a Compute + Node. + """) model BatchJobReleaseTaskExecutionInfo { @doc("The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running.") startTime: utcDateTime; @@ -3026,16 +3026,16 @@ model BatchNodeRemoveContent { } @doc(""" -Batch will retry Tasks when a recovery operation is triggered on a Node. -Examples of recovery operations include (but are not limited to) when an -unhealthy Node is rebooted or a Compute Node disappeared due to host failure. -Retries due to recovery operations are independent of and are not counted -against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal -retry due to a recovery operation may occur. Because of this, all Tasks should -be idempotent. This means Tasks need to tolerate being interrupted and -restarted without causing any corruption or duplicate data. The best practice -for long running Tasks is to use some form of checkpointing. -""") + Batch will retry Tasks when a recovery operation is triggered on a Node. + Examples of recovery operations include (but are not limited to) when an + unhealthy Node is rebooted or a Compute Node disappeared due to host failure. + Retries due to recovery operations are independent of and are not counted + against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal + retry due to a recovery operation may occur. Because of this, all Tasks should + be idempotent. This means Tasks need to tolerate being interrupted and + restarted without causing any corruption or duplicate data. The best practice + for long running Tasks is to use some form of checkpointing. + """) model BatchTask { @doc("A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.") @visibility("read") @@ -3146,8 +3146,8 @@ model BatchTask { } @doc(""" -Parameters for creating an Azure Batch Task. -""") + Parameters for creating an Azure Batch Task. + """) model BatchTaskCreateContent { @doc("A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a Job that differ only by case).") id: string; @@ -3217,9 +3217,9 @@ model ExitConditions { } @doc(""" -How the Batch service should respond if a Task exits with a particular exit -code. -""") + How the Batch service should respond if a Task exits with a particular exit + code. + """) model ExitCodeMapping { @doc("A process exit code.") code: int32; @@ -3238,9 +3238,9 @@ model ExitOptions { } @doc(""" -A range of exit codes and how the Batch service should respond to exit codes -within that range. -""") + A range of exit codes and how the Batch service should respond to exit codes + within that range. + """) model ExitCodeRangeMapping { @doc("The first exit code in the range.") start: int32; @@ -3253,9 +3253,9 @@ model ExitCodeRangeMapping { } @doc(""" -A locality hint that can be used by the Batch service to select a Compute Node -on which to start a Task. -""") + A locality hint that can be used by the Batch service to select a Compute Node + on which to start a Task. + """) model AffinityInfo { @doc("An opaque string representing the location of a Compute Node or a Task that has run previously. You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere.") affinityId: string; @@ -3316,11 +3316,11 @@ model BatchNodeInfo { } @doc(""" -Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, -if any of the subtasks fail (for example due to exiting with a non-zero exit -code) the entire multi-instance Task fails. The multi-instance Task is then -terminated and retried, up to its retry limit. -""") + Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, + if any of the subtasks fail (for example due to exiting with a non-zero exit + code) the entire multi-instance Task fails. The multi-instance Task is then + terminated and retried, up to its retry limit. + """) model MultiInstanceSettings { @doc("The number of Compute Nodes required by the Task. If omitted, the default is 1.") numberOfInstances?: int32; @@ -3372,10 +3372,10 @@ model BatchTaskStatistics { } @doc(""" -Specifies any dependencies of a Task. Any Task that is explicitly specified or -within a dependency range must complete before the dependant Task will be -scheduled. -""") + Specifies any dependencies of a Task. Any Task that is explicitly specified or + within a dependency range must complete before the dependant Task will be + scheduled. + """) model BatchTaskDependencies { @doc("The list of Task IDs that this Task depends on. All Tasks in this list must complete successfully before the dependent Task can be scheduled. The taskIds collection is limited to 64000 characters total (i.e. the combined length of all Task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using Task ID ranges instead.") taskIds?: string[]; @@ -3385,9 +3385,9 @@ model BatchTaskDependencies { } @doc(""" -The start and end of the range are inclusive. For example, if a range has start -9 and end 12, then it represents Tasks '9', '10', '11' and '12'. -""") + The start and end of the range are inclusive. For example, if a range has start + 9 and end 12, then it represents Tasks '9', '10', '11' and '12'. + """) model BatchTaskIdRange { @doc("The first Task ID in the range.") start: int32; @@ -3743,9 +3743,9 @@ model InboundEndpoint { } @doc(""" -The Batch Compute Node agent is a program that runs on each Compute Node in the -Pool and provides Batch capability on the Compute Node. -""") + The Batch Compute Node agent is a program that runs on each Compute Node in the + Pool and provides Batch capability on the Compute Node. + """) model BatchNodeAgentInfo { @doc("The version of the Batch Compute Node agent running on the Compute Node. This version number can be checked against the Compute Node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.") version: string; diff --git a/specification/batch/Azure.Batch/routes.tsp b/specification/batch/Azure.Batch/routes.tsp index 3cb0f122b964..43036ef3a0c6 100644 --- a/specification/batch/Azure.Batch/routes.tsp +++ b/specification/batch/Azure.Batch/routes.tsp @@ -30,24 +30,24 @@ namespace Azure.Batch; interface Batch { @summary("Lists all of the applications available in the specified Account.") @doc(""" -This operation returns only Applications and versions that are available for -use on Compute Nodes; that is, that can be used in an Package reference. For -administrator information about applications and versions that are not yet -available to Compute Nodes, use the Azure portal or the Azure Resource Manager -API. -""") + This operation returns only Applications and versions that are available for + use on Compute Nodes; that is, that can be used in an Package reference. For + administrator information about applications and versions that are not yet + available to Compute Nodes, use the Azure portal or the Azure Resource Manager + API. + """) @route("/applications") @clientName("listApplicationsInternal", "java") listApplications is ListOperation<{}, BatchApplicationListResult>; @summary("Gets information about the specified Application.") @doc(""" -This operation returns only Applications and versions that are available for -use on Compute Nodes; that is, that can be used in an Package reference. For -administrator information about Applications and versions that are not yet -available to Compute Nodes, use the Azure portal or the Azure Resource Manager -API. -""") + This operation returns only Applications and versions that are available for + use on Compute Nodes; that is, that can be used in an Package reference. For + administrator information about Applications and versions that are not yet + available to Compute Nodes, use the Azure portal or the Azure Resource Manager + API. + """) @route("/applications/{applicationId}") @clientName("getApplicationInternal", "java") getApplication is ReadOperation< @@ -60,42 +60,42 @@ API. >; @summary(""" -Lists the usage metrics, aggregated by Pool across individual time intervals, -for the specified Account. -""") + Lists the usage metrics, aggregated by Pool across individual time intervals, + for the specified Account. + """) @doc(""" -If you do not specify a $filter clause including a poolId, the response -includes all Pools that existed in the Account in the time range of the -returned aggregation intervals. If you do not specify a $filter clause -including a startTime or endTime these filters default to the start and end -times of the last aggregation interval currently available; that is, only the -last aggregation interval is returned. -""") + If you do not specify a $filter clause including a poolId, the response + includes all Pools that existed in the Account in the time range of the + returned aggregation intervals. If you do not specify a $filter clause + including a startTime or endTime these filters default to the start and end + times of the last aggregation interval currently available; that is, only the + last aggregation interval is returned. + """) @route("/poolusagemetrics") @clientName("listPoolUsageMetricsInternal", "java") listPoolUsageMetrics is ListOperation< { @doc(""" - The earliest time from which to include metrics. This must be at least two and - a half hours before the current time. If not specified this defaults to the - start time of the last aggregation interval currently available. - """) + The earliest time from which to include metrics. This must be at least two and + a half hours before the current time. If not specified this defaults to the + start time of the last aggregation interval currently available. + """) @query @clientName("starttime") startTime?: utcDateTime; @doc(""" - The latest time from which to include metrics. This must be at least two hours - before the current time. If not specified this defaults to the end time of the - last aggregation interval currently available. - """) + The latest time from which to include metrics. This must be at least two hours + before the current time. If not specified this defaults to the end time of the + last aggregation interval currently available. + """) @query endtime?: utcDateTime; @doc(""" - An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. - """) + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. + """) @query @clientName("filter") $filter?: string; @@ -105,10 +105,10 @@ last aggregation interval is returned. @summary("Creates a Pool to the specified Account.") @doc(""" -When naming Pools, avoid including sensitive information such as user names or -secret project names. This information may appear in telemetry logs accessible -to Microsoft Support engineers. -""") + When naming Pools, avoid including sensitive information such as user names or + secret project names. This information may appear in telemetry logs accessible + to Microsoft Support engineers. + """) @route("/pools") @clientName("createPoolInternal", "java") createPool is CreateOperation< @@ -127,9 +127,9 @@ to Microsoft Support engineers. listPools is ListOperation< { @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools. + """) @query @clientName("filter") $filter?: string; @@ -153,19 +153,19 @@ https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#li @summary("Deletes a Pool from the specified Account.") @doc(""" -When you request that a Pool be deleted, the following actions occur: the Pool -state is set to deleting; any ongoing resize operation on the Pool are stopped; -the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks -running on existing Compute Nodes are terminated and requeued (as if a resize -Pool operation had been requested with the default requeue option); finally, -the Pool is removed from the system. Because running Tasks are requeued, the -user can rerun these Tasks by updating their Job to target a different Pool. -The Tasks can then run on the new Pool. If you want to override the requeue -behavior, then you should call resize Pool explicitly to shrink the Pool to -zero size before deleting the Pool. If you call an Update, Patch or Delete API -on a Pool in the deleting state, it will fail with HTTP status code 409 with -error code PoolBeingDeleted. -""") + When you request that a Pool be deleted, the following actions occur: the Pool + state is set to deleting; any ongoing resize operation on the Pool are stopped; + the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks + running on existing Compute Nodes are terminated and requeued (as if a resize + Pool operation had been requested with the default requeue option); finally, + the Pool is removed from the system. Because running Tasks are requeued, the + user can rerun these Tasks by updating their Job to target a different Pool. + The Tasks can then run on the new Pool. If you want to override the requeue + behavior, then you should call resize Pool explicitly to shrink the Pool to + zero size before deleting the Pool. If you call an Update, Patch or Delete API + on a Pool in the deleting state, it will fail with HTTP status code 409 with + error code PoolBeingDeleted. + """) @route("/pools/{poolId}") @clientName("deletePoolInternal", "java") deletePool is DeleteOperation; @@ -203,10 +203,10 @@ error code PoolBeingDeleted. @summary("Updates the properties of the specified Pool.") @doc(""" -This only replaces the Pool properties specified in the request. For example, -if the Pool has a StartTask associated with it, and a request does not specify -a StartTask element, then the Pool keeps the existing StartTask. -""") + This only replaces the Pool properties specified in the request. For example, + if the Pool has a StartTask associated with it, and a request does not specify + a StartTask element, then the Pool keeps the existing StartTask. + """) @route("/pools/{poolId}") @clientName("updatePoolInternal", "java") updatePool is UpdateOperation< @@ -233,13 +233,13 @@ a StartTask element, then the Pool keeps the existing StartTask. @summary("Enables automatic scaling for a Pool.") @doc(""" -You cannot enable automatic scaling on a Pool if a resize operation is in -progress on the Pool. If automatic scaling of the Pool is currently disabled, -you must specify a valid autoscale formula as part of the request. If automatic -scaling of the Pool is already enabled, you may specify a new autoscale formula -and/or a new evaluation interval. You cannot call this API for the same Pool -more than once every 30 seconds. -""") + You cannot enable automatic scaling on a Pool if a resize operation is in + progress on the Pool. If automatic scaling of the Pool is currently disabled, + you must specify a valid autoscale formula as part of the request. If automatic + scaling of the Pool is already enabled, you may specify a new autoscale formula + and/or a new evaluation interval. You cannot call this API for the same Pool + more than once every 30 seconds. + """) @route("/pools/{poolId}/enableautoscale") @clientName("enablePoolAutoScaleInternal", "java") enablePoolAutoScale is PostOperation< @@ -254,10 +254,10 @@ more than once every 30 seconds. @summary("Gets the result of evaluating an automatic scaling formula on the Pool.") @doc(""" -This API is primarily for validating an autoscale formula, as it simply returns -the result without applying the formula to the Pool. The Pool must have auto -scaling enabled in order to evaluate a formula. -""") + This API is primarily for validating an autoscale formula, as it simply returns + the result without applying the formula to the Pool. The Pool must have auto + scaling enabled in order to evaluate a formula. + """) @route("/pools/{poolId}/evaluateautoscale") @clientName("evaluatePoolAutoScaleInternal", "java") evaluatePoolAutoScale is PostOperation< @@ -275,14 +275,14 @@ scaling enabled in order to evaluate a formula. @summary("Changes the number of Compute Nodes that are assigned to a Pool.") @doc(""" -You can only resize a Pool when its allocation state is steady. If the Pool is -already resizing, the request fails with status code 409. When you resize a -Pool, the Pool's allocation state changes from steady to resizing. You cannot -resize Pools which are configured for automatic scaling. If you try to do this, -the Batch service returns an error 409. If you resize a Pool downwards, the -Batch service chooses which Compute Nodes to remove. To remove specific Compute -Nodes, use the Pool remove Compute Nodes API instead. -""") + You can only resize a Pool when its allocation state is steady. If the Pool is + already resizing, the request fails with status code 409. When you resize a + Pool, the Pool's allocation state changes from steady to resizing. You cannot + resize Pools which are configured for automatic scaling. If you try to do this, + the Batch service returns an error 409. If you resize a Pool downwards, the + Batch service chooses which Compute Nodes to remove. To remove specific Compute + Nodes, use the Pool remove Compute Nodes API instead. + """) @route("/pools/{poolId}/resize") @clientName("resizePoolInternal", "java") resizePool is PostOperation< @@ -297,14 +297,14 @@ Nodes, use the Pool remove Compute Nodes API instead. @summary("Stops an ongoing resize operation on the Pool.") @doc(""" -This does not restore the Pool to its previous state before the resize -operation: it only stops any further changes being made, and the Pool maintains -its current state. After stopping, the Pool stabilizes at the number of Compute -Nodes it was at when the stop operation was done. During the stop operation, -the Pool allocation state changes first to stopping and then to steady. A -resize operation need not be an explicit resize Pool request; this API can also -be used to halt the initial sizing of the Pool when it is created. -""") + This does not restore the Pool to its previous state before the resize + operation: it only stops any further changes being made, and the Pool maintains + its current state. After stopping, the Pool stabilizes at the number of Compute + Nodes it was at when the stop operation was done. During the stop operation, + the Pool allocation state changes first to stopping and then to steady. A + resize operation need not be an explicit resize Pool request; this API can also + be used to halt the initial sizing of the Pool when it is created. + """) @route("/pools/{poolId}/stopresize") @clientName("stopPoolResizeInternal", "java") stopPoolResize is PostOperation< @@ -314,10 +314,10 @@ be used to halt the initial sizing of the Pool when it is created. @summary("Updates the properties of the specified Pool.") @doc(""" -This fully replaces all the updatable properties of the Pool. For example, if -the Pool has a StartTask associated with it and if StartTask is not specified -with this request, then the Batch service will remove the existing StartTask. -""") + This fully replaces all the updatable properties of the Pool. For example, if + the Pool has a StartTask associated with it and if StartTask is not specified + with this request, then the Batch service will remove the existing StartTask. + """) @route("/pools/{poolId}/updateproperties") @clientName("replacePoolPropertiesInternal", "java") replacePoolProperties is PostOperation< @@ -335,10 +335,10 @@ with this request, then the Batch service will remove the existing StartTask. @summary("Removes Compute Nodes from the specified Pool.") @doc(""" -This operation can only run when the allocation state of the Pool is steady. -When this operation runs, the allocation state changes from steady to resizing. -Each request may remove up to 100 nodes. -""") + This operation can only run when the allocation state of the Pool is steady. + When this operation runs, the allocation state changes from steady to resizing. + Each request may remove up to 100 nodes. + """) @route("/pools/{poolId}/removenodes") @clientName("removeNodesInternal", "java") removeNodes is PostOperation< @@ -358,9 +358,9 @@ Each request may remove up to 100 nodes. listSupportedImages is ListOperation< { @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images. + """) @query @clientName("filter") $filter?: string; @@ -369,18 +369,18 @@ https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#li >; @doc(""" -Gets the number of Compute Nodes in each state, grouped by Pool. Note that the -numbers returned may not always be up to date. If you need exact node counts, -use a list query. -""") + Gets the number of Compute Nodes in each state, grouped by Pool. Note that the + numbers returned may not always be up to date. If you need exact node counts, + use a list query. + """) @route("/nodecounts") @clientName("listPoolNodeCountsInternal", "java") listPoolNodeCounts is ListOperation< { @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images. + """) @query @clientName("filter") $filter?: string; @@ -390,15 +390,15 @@ https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#li @summary("Deletes a Job.") @doc(""" -Deleting a Job also deletes all Tasks that are part of that Job, and all Job -statistics. This also overrides the retention period for Task data; that is, if -the Job contains Tasks which are still retained on Compute Nodes, the Batch -services deletes those Tasks' working directories and all their contents. When -a Delete Job request is received, the Batch service sets the Job to the -deleting state. All update operations on a Job that is in deleting state will -fail with status code 409 (Conflict), with additional information indicating -that the Job is being deleted. -""") + Deleting a Job also deletes all Tasks that are part of that Job, and all Job + statistics. This also overrides the retention period for Task data; that is, if + the Job contains Tasks which are still retained on Compute Nodes, the Batch + services deletes those Tasks' working directories and all their contents. When + a Delete Job request is received, the Batch service sets the Job to the + deleting state. All update operations on a Job that is in deleting state will + fail with status code 409 (Conflict), with additional information indicating + that the Job is being deleted. + """) @route("/jobs/{jobId}") @clientName("deleteJobInternal", "java") deleteJob is DeleteOperation< @@ -439,10 +439,10 @@ that the Job is being deleted. @summary("Updates the properties of the specified Job.") @doc(""" -This replaces only the Job properties specified in the request. For example, if -the Job has constraints, and a request does not specify the constraints -element, then the Job keeps the existing constraints. -""") + This replaces only the Job properties specified in the request. For example, if + the Job has constraints, and a request does not specify the constraints + element, then the Job keeps the existing constraints. + """) @route("/jobs/{jobId}") @clientName("updateJobInternal", "java") updateJob is UpdateOperation< @@ -460,10 +460,10 @@ element, then the Job keeps the existing constraints. @summary("Updates the properties of the specified Job.") @doc(""" -This fully replaces all the updatable properties of the Job. For example, if -the Job has constraints associated with it and if constraints is not specified -with this request, then the Batch service will remove the existing constraints. -""") + This fully replaces all the updatable properties of the Job. For example, if + the Job has constraints associated with it and if constraints is not specified + with this request, then the Batch service will remove the existing constraints. + """) @route("/jobs/{jobId}") @clientName("replaceJobInternal", "java") replaceJob is ReplaceOperation< @@ -481,15 +481,15 @@ with this request, then the Batch service will remove the existing constraints. @summary("Disables the specified Job, preventing new Tasks from running.") @doc(""" -The Batch Service immediately moves the Job to the disabling state. Batch then -uses the disableTasks parameter to determine what to do with the currently -running Tasks of the Job. The Job remains in the disabling state until the -disable operation is completed and all Tasks have been dealt with according to -the disableTasks option; the Job then moves to the disabled state. No new Tasks -are started under the Job until it moves back to active state. If you try to -disable a Job that is in any state other than active, disabling, or disabled, -the request fails with status code 409. -""") + The Batch Service immediately moves the Job to the disabling state. Batch then + uses the disableTasks parameter to determine what to do with the currently + running Tasks of the Job. The Job remains in the disabling state until the + disable operation is completed and all Tasks have been dealt with according to + the disableTasks option; the Job then moves to the disabled state. No new Tasks + are started under the Job until it moves back to active state. If you try to + disable a Job that is in any state other than active, disabling, or disabled, + the request fails with status code 409. + """) @route("/jobs/{jobId}/disable") @clientName("disableJobInternal", "java") disableJob is PostOperation< @@ -508,13 +508,13 @@ the request fails with status code 409. @summary("Enables the specified Job, allowing new Tasks to run.") @doc(""" -When you call this API, the Batch service sets a disabled Job to the enabling -state. After the this operation is completed, the Job moves to the active -state, and scheduling of new Tasks under the Job resumes. The Batch service -does not allow a Task to remain in the active state for more than 180 days. -Therefore, if you enable a Job containing active Tasks which were added more -than 180 days ago, those Tasks will not run. -""") + When you call this API, the Batch service sets a disabled Job to the enabling + state. After the this operation is completed, the Job moves to the active + state, and scheduling of new Tasks under the Job resumes. The Batch service + does not allow a Task to remain in the active state for more than 180 days. + Therefore, if you enable a Job containing active Tasks which were added more + than 180 days ago, those Tasks will not run. + """) @route("/jobs/{jobId}/enable") @clientName("enableJobInternal", "java") enableJob is PostOperation< @@ -528,13 +528,13 @@ than 180 days ago, those Tasks will not run. @summary("Terminates the specified Job, marking it as completed.") @doc(""" -When a Terminate Job request is received, the Batch service sets the Job to the -terminating state. The Batch service then terminates any running Tasks -associated with the Job and runs any required Job release Tasks. Then the Job -moves into the completed state. If there are any Tasks in the Job in the active -state, they will remain in the active state. Once a Job is terminated, new -Tasks cannot be added and any remaining active Tasks will not be scheduled. -""") + When a Terminate Job request is received, the Batch service sets the Job to the + terminating state. The Batch service then terminates any running Tasks + associated with the Job and runs any required Job release Tasks. Then the Job + moves into the completed state. If there are any Tasks in the Job in the active + state, they will remain in the active state. Once a Job is terminated, new + Tasks cannot be added and any remaining active Tasks will not be scheduled. + """) @route("/jobs/{jobId}/terminate") @clientName("terminateJobInternal", "java") terminateJob is PostOperation< @@ -553,16 +553,16 @@ Tasks cannot be added and any remaining active Tasks will not be scheduled. @summary("Creates a Job to the specified Account.") @doc(""" -The Batch service supports two ways to control the work done as part of a Job. -In the first approach, the user specifies a Job Manager Task. The Batch service -launches this Task when it is ready to start the Job. The Job Manager Task -controls all other Tasks that run under this Job, by using the Task APIs. In -the second approach, the user directly controls the execution of Tasks under an -active Job, by using the Task APIs. Also note: when naming Jobs, avoid -including sensitive information such as user names or secret project names. -This information may appear in telemetry logs accessible to Microsoft Support -engineers. -""") + The Batch service supports two ways to control the work done as part of a Job. + In the first approach, the user specifies a Job Manager Task. The Batch service + launches this Task when it is ready to start the Job. The Job Manager Task + controls all other Tasks that run under this Job, by using the Task APIs. In + the second approach, the user directly controls the execution of Tasks under an + active Job, by using the Task APIs. Also note: when naming Jobs, avoid + including sensitive information such as user names or secret project names. + This information may appear in telemetry logs accessible to Microsoft Support + engineers. + """) @route("/jobs") @clientName("createJobInternal", "java") createJob is CreateOperation< @@ -581,9 +581,9 @@ engineers. listJobs is ListOperation< { @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. + """) @query @clientName("filter") $filter?: string; @@ -616,9 +616,9 @@ https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#li jobScheduleId: string; @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. + """) @query @clientName("filter") $filter?: string; @@ -641,17 +641,17 @@ https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#li >; @summary(""" -Lists the execution status of the Job Preparation and Job Release Task for the -specified Job across the Compute Nodes where the Job has run. -""") + Lists the execution status of the Job Preparation and Job Release Task for the + specified Job across the Compute Nodes where the Job has run. + """) @doc(""" -This API returns the Job Preparation and Job Release Task status on all Compute -Nodes that have run the Job Preparation or Job Release Task. This includes -Compute Nodes which have since been removed from the Pool. If this API is -invoked on a Job which has no Job Preparation or Job Release Task, the Batch -service returns HTTP status code 409 (Conflict) with an error code of -JobPreparationTaskNotSpecified. -""") + This API returns the Job Preparation and Job Release Task status on all Compute + Nodes that have run the Job Preparation or Job Release Task. This includes + Compute Nodes which have since been removed from the Pool. If this API is + invoked on a Job which has no Job Preparation or Job Release Task, the Batch + service returns HTTP status code 409 (Conflict) with an error code of + JobPreparationTaskNotSpecified. + """) @route("/jobs/{jobId}/jobpreparationandreleasetaskstatus") @clientName("listJobPreparationAndReleaseTaskStatusInternal", "java") listJobPreparationAndReleaseTaskStatus is ListOperation< @@ -661,9 +661,9 @@ JobPreparationTaskNotSpecified. jobId: string; @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. + """) @query @clientName("filter") $filter?: string; @@ -680,11 +680,11 @@ https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#li @summary("Gets the Task counts for the specified Job.") @doc(""" -Task counts provide a count of the Tasks by active, running or completed Task -state, and a count of Tasks which succeeded or failed. Tasks in the preparing -state are counted as running. Note that the numbers returned may not always be -up to date. If you need exact task counts, use a list query. -""") + Task counts provide a count of the Tasks by active, running or completed Task + state, and a count of Tasks which succeeded or failed. Tasks in the preparing + state are counted as running. Note that the numbers returned may not always be + up to date. If you need exact task counts, use a list query. + """) @route("/jobs/{jobId}/taskcounts") @clientName("getJobTaskCountsInternal", "java") getJobTaskCounts is ReadOperation< @@ -713,12 +713,12 @@ up to date. If you need exact task counts, use a list query. @summary("Deletes a Job Schedule from the specified Account.") @doc(""" -When you delete a Job Schedule, this also deletes all Jobs and Tasks under that -schedule. When Tasks are deleted, all the files in their working directories on -the Compute Nodes are also deleted (the retention period is ignored). The Job -Schedule statistics are no longer accessible once the Job Schedule is deleted, -though they are still counted towards Account lifetime statistics. -""") + When you delete a Job Schedule, this also deletes all Jobs and Tasks under that + schedule. When Tasks are deleted, all the files in their working directories on + the Compute Nodes are also deleted (the retention period is ignored). The Job + Schedule statistics are no longer accessible once the Job Schedule is deleted, + though they are still counted towards Account lifetime statistics. + """) @route("/jobschedules/{jobScheduleId}") @clientName("deleteJobScheduleInternal", "java") deleteJobSchedule is DeleteOperation< @@ -758,12 +758,12 @@ though they are still counted towards Account lifetime statistics. @summary("Updates the properties of the specified Job Schedule.") @doc(""" -This replaces only the Job Schedule properties specified in the request. For -example, if the schedule property is not specified with this request, then the -Batch service will keep the existing schedule. Changes to a Job Schedule only -impact Jobs created by the schedule after the update has taken place; currently -running Jobs are unaffected. -""") + This replaces only the Job Schedule properties specified in the request. For + example, if the schedule property is not specified with this request, then the + Batch service will keep the existing schedule. Changes to a Job Schedule only + impact Jobs created by the schedule after the update has taken place; currently + running Jobs are unaffected. + """) @route("/jobschedules/{jobScheduleId}") @clientName("updateJobScheduleInternal", "java") updateJobSchedule is UpdateOperation< @@ -781,12 +781,12 @@ running Jobs are unaffected. @summary("Updates the properties of the specified Job Schedule.") @doc(""" -This fully replaces all the updatable properties of the Job Schedule. For -example, if the schedule property is not specified with this request, then the -Batch service will remove the existing schedule. Changes to a Job Schedule only -impact Jobs created by the schedule after the update has taken place; currently -running Jobs are unaffected. -""") + This fully replaces all the updatable properties of the Job Schedule. For + example, if the schedule property is not specified with this request, then the + Batch service will remove the existing schedule. Changes to a Job Schedule only + impact Jobs created by the schedule after the update has taken place; currently + running Jobs are unaffected. + """) @route("/jobschedules/{jobScheduleId}") @clientName("replaceJobScheduleInternal", "java") replaceJobSchedule is ReplaceOperation< @@ -861,9 +861,9 @@ running Jobs are unaffected. listJobSchedules is ListOperation< { @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. + """) @query @clientName("filter") $filter?: string; @@ -887,10 +887,10 @@ https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#li @summary("Creates a Task to the specified Job.") @doc(""" -The maximum lifetime of a Task from addition to completion is 180 days. If a -Task has not completed within 180 days of being added it will be terminated by -the Batch service and left in whatever state it was in at that time. -""") + The maximum lifetime of a Task from addition to completion is 180 days. If a + Task has not completed within 180 days of being added it will be terminated by + the Batch service and left in whatever state it was in at that time. + """) @route("/jobs/{jobId}/tasks") @clientName("createTaskInternal", "java") createTask is CreateOperation< @@ -908,10 +908,10 @@ the Batch service and left in whatever state it was in at that time. @summary("Lists all of the Tasks that are associated with the specified Job.") @doc(""" -For multi-instance Tasks, information such as affinityId, executionInfo and -nodeInfo refer to the primary Task. Use the list subtasks API to retrieve -information about subtasks. -""") + For multi-instance Tasks, information such as affinityId, executionInfo and + nodeInfo refer to the primary Task. Use the list subtasks API to retrieve + information about subtasks. + """) @route("/jobs/{jobId}/tasks") @clientName("listTasksInternal", "java") listTasks is ListOperation< @@ -921,9 +921,9 @@ information about subtasks. jobId: string; @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks. + """) @query @clientName("filter") $filter?: string; @@ -947,21 +947,21 @@ https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#li @summary("Adds a collection of Tasks to the specified Job.") @doc(""" -Note that each Task must have a unique ID. The Batch service may not return the -results for each Task in the same order the Tasks were submitted in this -request. If the server times out or the connection is closed during the -request, the request may have been partially or fully processed, or not at all. -In such cases, the user should re-issue the request. Note that it is up to the -user to correctly handle failures when re-issuing a request. For example, you -should use the same Task IDs during a retry so that if the prior operation -succeeded, the retry will not create extra Tasks unexpectedly. If the response -contains any Tasks which failed to add, a client can retry the request. In a -retry, it is most efficient to resubmit only Tasks that failed to add, and to -omit Tasks that were successfully added on the first attempt. The maximum -lifetime of a Task from addition to completion is 180 days. If a Task has not -completed within 180 days of being added it will be terminated by the Batch -service and left in whatever state it was in at that time. -""") + Note that each Task must have a unique ID. The Batch service may not return the + results for each Task in the same order the Tasks were submitted in this + request. If the server times out or the connection is closed during the + request, the request may have been partially or fully processed, or not at all. + In such cases, the user should re-issue the request. Note that it is up to the + user to correctly handle failures when re-issuing a request. For example, you + should use the same Task IDs during a retry so that if the prior operation + succeeded, the retry will not create extra Tasks unexpectedly. If the response + contains any Tasks which failed to add, a client can retry the request. In a + retry, it is most efficient to resubmit only Tasks that failed to add, and to + omit Tasks that were successfully added on the first attempt. The maximum + lifetime of a Task from addition to completion is 180 days. If a Task has not + completed within 180 days of being added it will be terminated by the Batch + service and left in whatever state it was in at that time. + """) @route("/jobs/{jobId}/addtaskcollection") @clientName("createTaskCollectionInternal", "java") createTaskCollection is PostOperation< @@ -979,12 +979,12 @@ service and left in whatever state it was in at that time. @summary("Deletes a Task from the specified Job.") @doc(""" -When a Task is deleted, all of the files in its directory on the Compute Node -where it ran are also deleted (regardless of the retention time). For -multi-instance Tasks, the delete Task operation applies synchronously to the -primary task; subtasks and their files are then deleted asynchronously in the -background. -""") + When a Task is deleted, all of the files in its directory on the Compute Node + where it ran are also deleted (regardless of the retention time). For + multi-instance Tasks, the delete Task operation applies synchronously to the + primary task; subtasks and their files are then deleted asynchronously in the + background. + """) @route("/jobs/{jobId}/tasks/{taskId}") @clientName("deleteTaskInternal", "java") deleteTask is DeleteOperation< @@ -1006,10 +1006,10 @@ background. @summary("Gets information about the specified Task.") @doc(""" -For multi-instance Tasks, information such as affinityId, executionInfo and -nodeInfo refer to the primary Task. Use the list subtasks API to retrieve -information about subtasks. -""") + For multi-instance Tasks, information such as affinityId, executionInfo and + nodeInfo refer to the primary Task. Use the list subtasks API to retrieve + information about subtasks. + """) @route("/jobs/{jobId}/tasks/{taskId}") @clientName("getTaskInternal", "java") getTask is ReadOperation< @@ -1061,9 +1061,9 @@ information about subtasks. #suppress "@azure-tools/typespec-azure-core/use-standard-names" "GET operations that return single objects should start with 'get'" @summary(""" -Lists all of the subtasks that are associated with the specified multi-instance -Task. -""") + Lists all of the subtasks that are associated with the specified multi-instance + Task. + """) @doc("If the Task is not a multi-instance Task then this returns an empty collection.") @route("/jobs/{jobId}/tasks/{taskId}/subtasksinfo") @clientName("listSubTasksInternal", "java") @@ -1089,10 +1089,10 @@ Task. @summary("Terminates the specified Task.") @doc(""" -When the Task has been terminated, it moves to the completed state. For -multi-instance Tasks, the terminate Task operation applies synchronously to the -primary task; subtasks are then terminated asynchronously in the background. -""") + When the Task has been terminated, it moves to the completed state. For + multi-instance Tasks, the terminate Task operation applies synchronously to the + primary task; subtasks are then terminated asynchronously in the background. + """) @route("/jobs/{jobId}/tasks/{taskId}/terminate") @clientName("terminateTaskInternal", "java") terminateTask is PostOperation< @@ -1109,18 +1109,18 @@ primary task; subtasks are then terminated asynchronously in the background. >; @summary(""" -Reactivates a Task, allowing it to run again even if its retry count has been -exhausted. -""") + Reactivates a Task, allowing it to run again even if its retry count has been + exhausted. + """) @doc(""" -Reactivation makes a Task eligible to be retried again up to its maximum retry -count. The Task's state is changed to active. As the Task is no longer in the -completed state, any previous exit code or failure information is no longer -available after reactivation. Each time a Task is reactivated, its retry count -is reset to 0. Reactivation will fail for Tasks that are not completed or that -previously completed successfully (with an exit code of 0). Additionally, it -will fail if the Job has completed (or is terminating or deleting). -""") + Reactivation makes a Task eligible to be retried again up to its maximum retry + count. The Task's state is changed to active. As the Task is no longer in the + completed state, any previous exit code or failure information is no longer + available after reactivation. Each time a Task is reactivated, its retry count + is reset to 0. Reactivation will fail for Tasks that are not completed or that + previously completed successfully (with an exit code of 0). Additionally, it + will fail if the Job has completed (or is terminating or deleting). + """) @route("/jobs/{jobId}/tasks/{taskId}/reactivate") @clientName("reactivateTaskInternal", "java") reactivateTask is PostOperation< @@ -1143,11 +1143,11 @@ will fail if the Job has completed (or is terminating or deleting). deleteTaskFile is DeleteOperation< BatchTaskFileClientPathContent & { @doc(""" -Whether to delete children of a directory. If the filePath parameter represents -a directory instead of a file, you can set recursive to true to delete the -directory and all of the files and subdirectories in it. If recursive is false -then the directory must be empty or deletion will fail. -""") + Whether to delete children of a directory. If the filePath parameter represents + a directory instead of a file, you can set recursive to true to delete the + directory and all of the files and subdirectories in it. If recursive is false + then the directory must be empty or deletion will fail. + """) @query recursive?: boolean; }, @@ -1165,9 +1165,9 @@ then the directory must be empty or deletion will fail. BatchTaskFileClientPathContent & BatchModifiedSinceHeaders & { @doc(""" -The byte range to be retrieved. The default is to retrieve the entire file. The -format is bytes=startRange-endRange. -""") + The byte range to be retrieved. The default is to retrieve the entire file. The + format is bytes=startRange-endRange. + """) @header `ocp-range`?: string; }, @@ -1206,17 +1206,17 @@ format is bytes=startRange-endRange. taskId: string; @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. + """) @query @clientName("filter") $filter?: string; @doc(""" -Whether to list children of the Task directory. This parameter can be used in -combination with the filter parameter to list specific type of files. -""") + Whether to list children of the Task directory. This parameter can be used in + combination with the filter parameter to list specific type of files. + """) @query recursive?: boolean; }, @@ -1225,9 +1225,9 @@ combination with the filter parameter to list specific type of files. @summary("Adds a user Account to the specified Compute Node.") @doc(""" -You can add a user Account to a Compute Node only when it is in the idle or -running state. -""") + You can add a user Account to a Compute Node only when it is in the idle or + running state. + """) @route("/pools/{poolId}/nodes/{nodeId}/users") @clientName("createNodeUserInternal", "java") createNodeUser is CreateOperation< @@ -1249,9 +1249,9 @@ running state. @summary("Deletes a user Account from the specified Compute Node.") @doc(""" -You can delete a user Account to a Compute Node only when it is in the idle or -running state. -""") + You can delete a user Account to a Compute Node only when it is in the idle or + running state. + """) @route("/pools/{poolId}/nodes/{nodeId}/users/{userName}") @clientName("deleteNodeUserInternal", "java") deleteNodeUser is DeleteOperation< @@ -1276,14 +1276,14 @@ running state. >; @summary(""" -Updates the password and expiration time of a user Account on the specified Compute Node. -""") + Updates the password and expiration time of a user Account on the specified Compute Node. + """) @doc(""" -This operation replaces of all the updatable properties of the Account. For -example, if the expiryTime element is not specified, the current value is -replaced with the default value, not left unmodified. You can update a user -Account on a Compute Node only when it is in the idle or running state. -""") + This operation replaces of all the updatable properties of the Account. For + example, if the expiryTime element is not specified, the current value is + replaced with the default value, not left unmodified. You can update a user + Account on a Compute Node only when it is in the idle or running state. + """) @route("/pools/{poolId}/nodes/{nodeId}/users/{userName}") @clientName("replaceNodeUserInternal", "java") replaceNodeUser is ReplaceOperation< @@ -1354,9 +1354,9 @@ Account on a Compute Node only when it is in the idle or running state. @summary("Disables Task scheduling on the specified Compute Node.") @doc(""" -You can disable Task scheduling on a Compute Node only if its current -scheduling state is enabled. -""") + You can disable Task scheduling on a Compute Node only if its current + scheduling state is enabled. + """) @route("/pools/{poolId}/nodes/{nodeId}/disablescheduling") @clientName("disableNodeSchedulingInternal", "java") disableNodeScheduling is PostOperation< @@ -1378,9 +1378,9 @@ scheduling state is enabled. @summary("Enables Task scheduling on the specified Compute Node.") @doc(""" -You can enable Task scheduling on a Compute Node only if its current scheduling -state is disabled -""") + You can enable Task scheduling on a Compute Node only if its current scheduling + state is disabled + """) @route("/pools/{poolId}/nodes/{nodeId}/enablescheduling") @clientName("enableNodeSchedulingInternal", "java") enableNodeScheduling is PostOperation< @@ -1398,10 +1398,10 @@ state is disabled @summary("Gets the settings required for remote login to a Compute Node.") @doc(""" -Before you can remotely login to a Compute Node using the remote login -settings, you must create a user Account on the Compute Node. This API can be -invoked only on Pools created with the virtual machine configuration property. -""") + Before you can remotely login to a Compute Node using the remote login + settings, you must create a user Account on the Compute Node. This API can be + invoked only on Pools created with the virtual machine configuration property. + """) @route("/pools/{poolId}/nodes/{nodeId}/remoteloginsettings") @clientName("getNodeRemoteLoginSettingsInternal", "java") getNodeRemoteLoginSettings is ReadOperation< @@ -1418,15 +1418,15 @@ invoked only on Pools created with the virtual machine configuration property. >; @summary(""" -Upload Azure Batch service log files from the specified Compute Node to Azure -Blob Storage. -""") + Upload Azure Batch service log files from the specified Compute Node to Azure + Blob Storage. + """) @doc(""" -This is for gathering Azure Batch service log files in an automated fashion -from Compute Nodes if you are experiencing an error and wish to escalate to -Azure support. The Azure Batch service log files should be shared with Azure -support to aid in debugging issues with the Batch service. -""") + This is for gathering Azure Batch service log files in an automated fashion + from Compute Nodes if you are experiencing an error and wish to escalate to + Azure support. The Azure Batch service log files should be shared with Azure + support to aid in debugging issues with the Batch service. + """) @route("/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs") @clientName("uploadNodeLogsInternal", "java") uploadNodeLogs is PostOperation< @@ -1436,9 +1436,9 @@ support to aid in debugging issues with the Batch service. poolId: string; @doc(""" -The ID of the Compute Node for which you want to get the Remote Desktop -Protocol file. -""") + The ID of the Compute Node for which you want to get the Remote Desktop + Protocol file. + """) @path nodeId: string; @@ -1460,9 +1460,9 @@ Protocol file. poolId: string; @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. + """) @query @clientName("filter") $filter?: string; @@ -1492,8 +1492,8 @@ https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#li nodeId: string; @doc(""" -The name of the Compute Node Extension that you want to get information about. -""") + The name of the Compute Node Extension that you want to get information about. + """) @path extensionName: string; @@ -1538,11 +1538,11 @@ The name of the Compute Node Extension that you want to get information about. deleteNodeFile is DeleteOperation< BatchNodeFileClientPathContent & { @doc(""" -Whether to delete children of a directory. If the filePath parameter represents -a directory instead of a file, you can set recursive to true to delete the -directory and all of the files and subdirectories in it. If recursive is false -then the directory must be empty or deletion will fail. -""") + Whether to delete children of a directory. If the filePath parameter represents + a directory instead of a file, you can set recursive to true to delete the + directory and all of the files and subdirectories in it. If recursive is false + then the directory must be empty or deletion will fail. + """) @query recursive?: boolean; }, @@ -1560,9 +1560,9 @@ then the directory must be empty or deletion will fail. BatchNodeFileClientPathContent & BatchModifiedSinceHeaders & { @doc(""" -The byte range to be retrieved. The default is to retrieve the entire file. The -format is bytes=startRange-endRange. -""") + The byte range to be retrieved. The default is to retrieve the entire file. The + format is bytes=startRange-endRange. + """) @header `ocp-range`?: string; }, @@ -1601,9 +1601,9 @@ format is bytes=startRange-endRange. nodeId: string; @doc(""" -An OData $filter clause. For more information on constructing this filter, see -https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. -""") + An OData $filter clause. For more information on constructing this filter, see + https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. + """) @query @clientName("filter") $filter?: string; diff --git a/specification/codesigning/CodeSigning.Management/CertificateProfile.tsp b/specification/codesigning/CodeSigning.Management/CertificateProfile.tsp index 55ebaa3d6001..fdcb066344e6 100644 --- a/specification/codesigning/CodeSigning.Management/CertificateProfile.tsp +++ b/specification/codesigning/CodeSigning.Management/CertificateProfile.tsp @@ -27,8 +27,13 @@ interface CertificateProfiles { @doc("Get details of a certificate profile.") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("Create a certificate profile.") - create is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrReplaceAsync< + CertificateProfile, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("Delete a certificate profile.") delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/codesigning/CodeSigning.Management/CodeSigningAccount.tsp b/specification/codesigning/CodeSigning.Management/CodeSigningAccount.tsp index 4355346b7284..2ba44542c4ba 100644 --- a/specification/codesigning/CodeSigning.Management/CodeSigningAccount.tsp +++ b/specification/codesigning/CodeSigning.Management/CodeSigningAccount.tsp @@ -25,8 +25,13 @@ interface CodeSigningAccounts { @doc("Get a trusted Signing Account.") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("Create a trusted Signing Account.") - create is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrReplaceAsync< + CodeSigningAccount, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("Update a trusted signing account.") @parameterVisibility diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-02-05-preview/codeSigningAccount.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-02-05-preview/codeSigningAccount.json index c39c884ded31..123faa923f38 100644 --- a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-02-05-preview/codeSigningAccount.json +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-02-05-preview/codeSigningAccount.json @@ -832,11 +832,7 @@ "properties": { "$ref": "#/definitions/CertificateProfileProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1074,11 +1070,7 @@ "properties": { "$ref": "#/definitions/CodeSigningAccountProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/cognitiveservices/AnomalyDetector/main.tsp b/specification/cognitiveservices/AnomalyDetector/main.tsp index 5172ffb61695..896abafe657d 100644 --- a/specification/cognitiveservices/AnomalyDetector/main.tsp +++ b/specification/cognitiveservices/AnomalyDetector/main.tsp @@ -18,9 +18,9 @@ using TypeSpec.Versioning; "The Anomaly Detector API detects anomalies automatically in time series data. It supports two kinds of mode, one is for stateless using, another is for stateful using. In stateless mode, there are three functionalities. Entire Detect is for detecting the whole series with model trained by the time series, Last Detect is detecting last point with model trained by points before. ChangePoint Detect is for detecting trend changes in time series. In stateful mode, user can store time series, the stored time series will be used for detection anomalies. Under this mode, user can still use the above three functionalities by only giving a time range without preparing time series in client side. Besides the above three functionalities, stateful model also provide group based detection and labeling service. By leveraging labeling service user can provide labels for each detection result, these labels will be used for retuning or regenerating detection models. Inconsistency detection is a kind of group based detection, this detection will find inconsistency ones in a set of time series. By using anomaly detector service, business customers can discover incidents and establish a logic flow for root cause analysis.", { @doc(""" -Supported Azure Cognitive Services endpoints (protocol and host name, such as -https://westus2.api.cognitive.microsoft.com). -""") + Supported Azure Cognitive Services endpoints (protocol and host name, such as + https://westus2.api.cognitive.microsoft.com). + """) Endpoint: string, @doc("Api Version") @@ -29,23 +29,23 @@ https://westus2.api.cognitive.microsoft.com). } ) @doc(""" -The Anomaly Detector API detects anomalies automatically in time series data. -It supports both a stateless detection mode and a -stateful detection mode. In stateless mode, there are three functionalities. Entire -Detect is for detecting the whole series, with the model trained by the time series. -Last Detect is for detecting the last point, with the model trained by points before. -ChangePoint Detect is for detecting trend changes in the time series. In stateful -mode, the user can store time series. The stored time series will be used for -detection anomalies. In this mode, the user can still use the preceding three -functionalities by only giving a time range without preparing time series on the -client side. Besides the preceding three functionalities, the stateful model -provides group-based detection and labeling services. By using the labeling -service, the user can provide labels for each detection result. These labels will be -used for retuning or regenerating detection models. Inconsistency detection is -a kind of group-based detection that finds inconsistencies in -a set of time series. By using the anomaly detector service, business customers can -discover incidents and establish a logic flow for root cause analysis. -""") + The Anomaly Detector API detects anomalies automatically in time series data. + It supports both a stateless detection mode and a + stateful detection mode. In stateless mode, there are three functionalities. Entire + Detect is for detecting the whole series, with the model trained by the time series. + Last Detect is for detecting the last point, with the model trained by points before. + ChangePoint Detect is for detecting trend changes in the time series. In stateful + mode, the user can store time series. The stored time series will be used for + detection anomalies. In this mode, the user can still use the preceding three + functionalities by only giving a time range without preparing time series on the + client side. Besides the preceding three functionalities, the stateful model + provides group-based detection and labeling services. By using the labeling + service, the user can provide labels for each detection result. These labels will be + used for retuning or regenerating detection models. Inconsistency detection is + a kind of group-based detection that finds inconsistencies in + a set of time series. By using the anomaly detector service, business customers can + discover incidents and establish a logic flow for root cause analysis. + """) namespace AnomalyDetector; @doc("The secret key for your Azure Cognitive Services subscription.") diff --git a/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp b/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp index 2c07097dba56..e7e03d667745 100644 --- a/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp +++ b/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp @@ -90,9 +90,9 @@ model MultivariateBatchDetectionResultSummary { variableStates?: VariableState[]; @doc(""" -Detection request for batch inference. This is an asynchronous inference that -will need another API to get detection results. -""") + Detection request for batch inference. This is an asynchronous inference that + will need another API to get detection results. + """) setupInfo: MultivariateBatchDetectionOptions; } @@ -128,35 +128,35 @@ model VariableState { } @doc(""" -Detection request for batch inference. This is an asynchronous inference that -will need another API to get detection results. -""") + Detection request for batch inference. This is an asynchronous inference that + will need another API to get detection results. + """) model MultivariateBatchDetectionOptions { @doc(""" -Source link to the input data to indicate an accessible Azure Storage URI. -It either points to an Azure Blob Storage folder or points to a CSV file in -Azure Blob Storage, based on your data schema selection. The data schema should -be exactly the same as those used in the training phase. The input data must -contain at least slidingWindow entries preceding the start time of the data -to be detected. -""") + Source link to the input data to indicate an accessible Azure Storage URI. + It either points to an Azure Blob Storage folder or points to a CSV file in + Azure Blob Storage, based on your data schema selection. The data schema should + be exactly the same as those used in the training phase. The input data must + contain at least slidingWindow entries preceding the start time of the data + to be detected. + """) dataSource: url; @doc(""" -Number of top contributed variables for one anomalous time stamp in the response. -""") + Number of top contributed variables for one anomalous time stamp in the response. + """) topContributorCount?: int32 = 10; @doc(""" -Start date/time of data for detection, which should -be in ISO 8601 format. -""") + Start date/time of data for detection, which should + be in ISO 8601 format. + """) startTime: utcDateTime; @doc(""" -End date/time of data for detection, which should -be in ISO 8601 format. -""") + End date/time of data for detection, which should + be in ISO 8601 format. + """) endTime: utcDateTime; } @@ -178,16 +178,16 @@ model AnomalyValue { isAnomaly: boolean; @doc(""" -Indicates the significance of the anomaly. The higher the severity, the more -significant the anomaly is. -""") + Indicates the significance of the anomaly. The higher the severity, the more + significant the anomaly is. + """) @minValue(0.0) @maxValue(1.0) severity: float32; @doc(""" -Raw anomaly score of severity, to help indicate the degree of abnormality. -""") + Raw anomaly score of severity, to help indicate the degree of abnormality. + """) @minValue(0.0) @maxValue(2.0) score: float32; @@ -202,9 +202,9 @@ model AnomalyInterpretation { variable?: string; @doc(""" -This score shows the percentage that contributes to the anomalous time stamp. It's a -number between 0 and 1. -""") + This score shows the percentage that contributes to the anomalous time stamp. It's a + number between 0 and 1. + """) contributionScore?: float32; @doc("Correlation changes among the anomalous variables.") @@ -218,46 +218,46 @@ model CorrelationChanges { } @doc(""" -Training result of a model, including its status, errors, and diagnostics -information. -""") + Training result of a model, including its status, errors, and diagnostics + information. + """) model ModelInfo { @doc(""" -Source link to the input data to indicate an accessible Azure Storage URI. -It either points to an Azure Blob Storage folder or points to a CSV file in -Azure Blob Storage, based on your data schema selection. -""") + Source link to the input data to indicate an accessible Azure Storage URI. + It either points to an Azure Blob Storage folder or points to a CSV file in + Azure Blob Storage, based on your data schema selection. + """) dataSource: url; @doc(""" -Data schema of the input data source. The default -is OneTable. -""") + Data schema of the input data source. The default + is OneTable. + """) dataSchema?: DataSchema; @doc(""" -Start date/time of training data, which should be -in ISO 8601 format. -""") + Start date/time of training data, which should be + in ISO 8601 format. + """) startTime: utcDateTime; @doc(""" -End date/time of training data, which should be -in ISO 8601 format. -""") + End date/time of training data, which should be + in ISO 8601 format. + """) endTime: utcDateTime; @doc(""" -Display name of the model. Maximum length is 24 -characters. -""") + Display name of the model. Maximum length is 24 + characters. + """) @maxLength(24) displayName?: string; @doc(""" -Number of previous time stamps that will be used to -detect whether the time stamp is an anomaly or not. -""") + Number of previous time stamps that will be used to + detect whether the time stamp is an anomaly or not. + """) slidingWindow?: int32; @doc("Manner of aligning multiple variables.") @@ -279,15 +279,15 @@ detect whether the time stamp is an anomaly or not. @doc("Manner of aligning multiple variables.") model AlignPolicy { @doc(""" -Field that indicates how to align different variables to the same -time range. -""") + Field that indicates how to align different variables to the same + time range. + """) alignMode?: AlignMode; #suppress "@azure-tools/typespec-azure-core/casing-style" "Service uppercases common acronyms like NA." @doc(""" -Field that indicates how missing values will be filled. -""") + Field that indicates how missing values will be filled. + """) fillNAMethod?: FillNAMethod; @doc("Field that's required when fillNAMethod is Fixed.") @@ -306,21 +306,21 @@ model DiagnosticsInfo { @doc("Model status.") model ModelState { @doc(""" -Number of passes of the entire training dataset that the -algorithm has completed. -""") + Number of passes of the entire training dataset that the + algorithm has completed. + """) epochIds?: int32[]; @doc(""" -List of metrics used to assess how the model fits the training data for each -epoch. -""") + List of metrics used to assess how the model fits the training data for each + epoch. + """) trainLosses?: float32[]; @doc(""" -List of metrics used to assess how the model fits the validation set for each -epoch. -""") + List of metrics used to assess how the model fits the validation set for each + epoch. + """) validationLosses?: float32[]; @doc("Latency for each epoch.") @@ -342,9 +342,9 @@ model AnomalyDetectionModel { lastUpdatedTime: utcDateTime; @doc(""" -Training result of a model, including its status, errors, and diagnostics -information. -""") + Training result of a model, including its status, errors, and diagnostics + information. + """) modelInfo?: ModelInfo; } @@ -369,16 +369,16 @@ model ModelList { @doc("Request of the last detection.") model MultivariateLastDetectionOptions { @doc(""" -Contains the inference data, including the name, time stamps (ISO 8601), and -values of variables. -""") + Contains the inference data, including the name, time stamps (ISO 8601), and + values of variables. + """) variables: VariableValues[]; @doc(""" -Number of top contributed -variables for one anomalous time stamp in the response. The default is -10. -""") + Number of top contributed + variables for one anomalous time stamp in the response. The default is + 10. + """) topContributorCount?: int32 = 10; } diff --git a/specification/cognitiveservices/AnomalyDetector/multivariate/routes.tsp b/specification/cognitiveservices/AnomalyDetector/multivariate/routes.tsp index 9ef969f400c8..2540235fb63e 100644 --- a/specification/cognitiveservices/AnomalyDetector/multivariate/routes.tsp +++ b/specification/cognitiveservices/AnomalyDetector/multivariate/routes.tsp @@ -28,9 +28,9 @@ op MultivariateServiceAction( @route("/multivariate/detect-batch/{resultId}") @summary("Get Multivariate Anomaly Detection Result") @doc(""" -For asynchronous inference, get a multivariate anomaly detection result based on the -resultId value that the BatchDetectAnomaly API returns. -""") + For asynchronous inference, get a multivariate anomaly detection result based on the + resultId value that the BatchDetectAnomaly API returns. + """) op getMultivariateBatchDetectionResult( @doc("ID of a batch detection result.") @path @@ -42,17 +42,17 @@ op getMultivariateBatchDetectionResult( @route("/multivariate/models") @summary("Train a Multivariate Anomaly Detection Model") @doc(""" -Create and train a multivariate anomaly detection model. The request must -include a source parameter to indicate an Azure Blob -Storage URI that's accessible to the service. There are two types of data input. The Blob Storage URI can point to an Azure Blob -Storage folder that contains multiple CSV files, where each CSV file has -two columns, time stamp and variable. Or the Blob Storage URI can point to a single blob that contains a CSV file that has all the variables and a -time stamp column. -The model object will be created and returned in the response, but the -training process happens asynchronously. To check the training status, call -GetMultivariateModel with the modelId value and check the status field in the -modelInfo object. -""") + Create and train a multivariate anomaly detection model. The request must + include a source parameter to indicate an Azure Blob + Storage URI that's accessible to the service. There are two types of data input. The Blob Storage URI can point to an Azure Blob + Storage folder that contains multiple CSV files, where each CSV file has + two columns, time stamp and variable. Or the Blob Storage URI can point to a single blob that contains a CSV file that has all the variables and a + time stamp column. + The model object will be created and returned in the response, but the + training process happens asynchronously. To check the training status, call + GetMultivariateModel with the modelId value and check the status field in the + modelInfo object. + """) op trainMultivariateModel is MultivariateServiceAction< // TParams { @@ -111,9 +111,9 @@ op deleteMultivariateModel( // it does not support an api-version in the path defined in the @server decorator. @summary("Get Multivariate Model") @doc(""" -Get detailed information about the multivariate model, including the training status -and variables used in the model. -""") + Get detailed information about the multivariate model, including the training status + and variables used in the model. + """) @get @route("/multivariate/models/{modelId}") op getMultivariateModel( @@ -130,13 +130,13 @@ op getMultivariateModel( @route("/multivariate/models/{modelId}:detect-batch") @summary("Detect Multivariate Anomaly") @doc(""" -Submit a multivariate anomaly detection task with the modelId value of a trained model -and inference data. The input schema should be the same with the training -request. The request will finish asynchronously and return a resultId value to -query the detection result. The request should be a source link to indicate an -externally accessible Azure Storage URI that either points to an Azure Blob -Storage folder or points to a CSV file in Azure Blob Storage. -""") + Submit a multivariate anomaly detection task with the modelId value of a trained model + and inference data. The input schema should be the same with the training + request. The request will finish asynchronously and return a resultId value to + query the detection result. The request should be a source link to indicate an + externally accessible Azure Storage URI that either points to an Azure Blob + Storage folder or points to a CSV file in Azure Blob Storage. + """) op detectMultivariateBatchAnomaly( @doc("Model identifier.") @path @@ -166,11 +166,11 @@ op detectMultivariateBatchAnomaly( @route("/multivariate/models/{modelId}:detect-last") @summary("Detect anomalies in the last point of the request body") @doc(""" -Submit a multivariate anomaly detection task with the modelId value of a trained model -and inference data. The inference data should be put into the request body in -JSON format. The request will finish synchronously and return the detection -immediately in the response body. -""") + Submit a multivariate anomaly detection task with the modelId value of a trained model + and inference data. The inference data should be put into the request body in + JSON format. The request will finish synchronously and return the detection + immediately in the response body. + """) op detectMultivariateLastAnomaly( @doc("Model identifier.") @path diff --git a/specification/cognitiveservices/AnomalyDetector/tspconfig.yaml b/specification/cognitiveservices/AnomalyDetector/tspconfig.yaml index 7350f3561ad4..eee7c0c25c1d 100644 --- a/specification/cognitiveservices/AnomalyDetector/tspconfig.yaml +++ b/specification/cognitiveservices/AnomalyDetector/tspconfig.yaml @@ -17,6 +17,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" examples-directory: examples omit-unreachable-types: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" diff --git a/specification/cognitiveservices/AnomalyDetector/univariate/models.tsp b/specification/cognitiveservices/AnomalyDetector/univariate/models.tsp index 002e80226f66..0415bf4a4538 100644 --- a/specification/cognitiveservices/AnomalyDetector/univariate/models.tsp +++ b/specification/cognitiveservices/AnomalyDetector/univariate/models.tsp @@ -52,53 +52,53 @@ union TimeGranularity { @doc("Request of the entire or last anomaly detection.") model UnivariateDetectionOptions { @doc(""" -Time series data points. Points should be sorted by time stamp in ascending -order to match the anomaly detection result. If the data is not sorted -correctly or there's a duplicated time stamp, the API won't work. In such -a case, an error message is returned. -""") + Time series data points. Points should be sorted by time stamp in ascending + order to match the anomaly detection result. If the data is not sorted + correctly or there's a duplicated time stamp, the API won't work. In such + a case, an error message is returned. + """) series: TimeSeriesPoint[]; @doc(""" -Argument that indicates time granularity. If granularity is not present, the value -is none by default. If granularity is none, the time stamp property in the time -series point can be absent. -""") + Argument that indicates time granularity. If granularity is not present, the value + is none by default. If granularity is none, the time stamp property in the time + series point can be absent. + """) granularity?: TimeGranularity; @doc(""" -A custom interval is used to set a nonstandard time interval. For example, if the -series is 5 minutes, the request can be set as {"granularity":"minutely", -"customInterval":5}. -""") + A custom interval is used to set a nonstandard time interval. For example, if the + series is 5 minutes, the request can be set as {"granularity":"minutely", + "customInterval":5}. + """) customInterval?: int32; @doc(""" -Argument that indicates the periodic value of a time series. If the value is null or -is not present, the API determines the period automatically. -""") + Argument that indicates the periodic value of a time series. If the value is null or + is not present, the API determines the period automatically. + """) period?: int32; @doc("Argument that indicates an advanced model parameter. It's the maximum anomaly ratio in a time series.") maxAnomalyRatio?: float32; @doc(""" -Argument that indicates an advanced model parameter between 0 and 99. The lower the value -is, the larger the margin value is, which means fewer anomalies will be -accepted. -""") + Argument that indicates an advanced model parameter between 0 and 99. The lower the value + is, the larger the margin value is, which means fewer anomalies will be + accepted. + """) sensitivity?: int32; @doc(""" -Specifies how to deal with missing values in the input series. It's used -when granularity is not \"none\". -""") + Specifies how to deal with missing values in the input series. It's used + when granularity is not \"none\". + """) imputeMode?: ImputeMode; @doc(""" -Specifies the value to fill. It's used when granularity is not \"none\" -and imputeMode is \"fixed\". -""") + Specifies the value to fill. It's used when granularity is not \"none\" + and imputeMode is \"fixed\". + """) imputeFixedValue?: float32; } @@ -114,63 +114,63 @@ model TimeSeriesPoint { @doc("Response of the entire anomaly detection.") model UnivariateEntireDetectionResult { @doc(""" -Frequency extracted from the series. Zero means no recurrent pattern has been -found. -""") + Frequency extracted from the series. Zero means no recurrent pattern has been + found. + """) period: int32; @doc(""" -Expected value for each input point. The index of the -array is consistent with the input series. -""") + Expected value for each input point. The index of the + array is consistent with the input series. + """) expectedValues: float32[]; @doc(""" -Upper margin of each input point. UpperMargin is used to -calculate upperBoundary, which is equal to expectedValue + (100 - -marginScale)*upperMargin. Anomalies in the response can be filtered by -upperBoundary and lowerBoundary. Adjusting the marginScale value can help filter less -significant anomalies on the client side. The index of the array is -consistent with the input series. -""") + Upper margin of each input point. UpperMargin is used to + calculate upperBoundary, which is equal to expectedValue + (100 - + marginScale)*upperMargin. Anomalies in the response can be filtered by + upperBoundary and lowerBoundary. Adjusting the marginScale value can help filter less + significant anomalies on the client side. The index of the array is + consistent with the input series. + """) upperMargins: float32[]; @doc(""" -Lower margin of each input point. LowerMargin is used to -calculate lowerBoundary, which is equal to expectedValue - (100 - -marginScale)*lowerMargin. Points between the boundary can be marked as normal -ones on the client side. The index of the array is consistent with the input -series. -""") + Lower margin of each input point. LowerMargin is used to + calculate lowerBoundary, which is equal to expectedValue - (100 - + marginScale)*lowerMargin. Points between the boundary can be marked as normal + ones on the client side. The index of the array is consistent with the input + series. + """) lowerMargins: float32[]; @doc(""" -Anomaly properties for each input point. True means an -anomaly (either negative or positive) has been detected. The index of the array -is consistent with the input series. -""") + Anomaly properties for each input point. True means an + anomaly (either negative or positive) has been detected. The index of the array + is consistent with the input series. + """) isAnomaly: boolean[]; @doc(""" -Anomaly status in a negative direction for each input -point. True means a negative anomaly has been detected. A negative anomaly -means the point is detected as an anomaly and its real value is smaller than -the expected one. The index of the array is consistent with the input series. -""") + Anomaly status in a negative direction for each input + point. True means a negative anomaly has been detected. A negative anomaly + means the point is detected as an anomaly and its real value is smaller than + the expected one. The index of the array is consistent with the input series. + """) isNegativeAnomaly: boolean[]; @doc(""" -Anomaly status in a positive direction for each input -point. True means a positive anomaly has been detected. A positive anomaly -means the point is detected as an anomaly and its real value is larger than the -expected one. The index of the array is consistent with the input series. -""") + Anomaly status in a positive direction for each input + point. True means a positive anomaly has been detected. A positive anomaly + means the point is detected as an anomaly and its real value is larger than the + expected one. The index of the array is consistent with the input series. + """) isPositiveAnomaly: boolean[]; @doc(""" -Severity score for each input point. The larger the value is, the more -severe the anomaly is. For normal points, the severity is always 0. -""") + Severity score for each input point. The larger the value is, the more + severe the anomaly is. For normal points, the severity is always 0. + """) severity?: float32[]; } @@ -191,9 +191,9 @@ model AnomalyDetectorError { @doc("Response of the last anomaly detection.") model UnivariateLastDetectionResult { @doc(""" -Frequency extracted from the series. Zero means no recurrent pattern has been -found. -""") + Frequency extracted from the series. Zero means no recurrent pattern has been + found. + """) period: int32; @doc("Suggested input series points needed for detecting the latest point.") @@ -203,99 +203,99 @@ found. expectedValue: float32; @doc(""" -Upper margin of the latest point. UpperMargin is used to calculate -upperBoundary, which is equal to expectedValue + (100 - marginScale)*upperMargin. -If the value of latest point is between upperBoundary and lowerBoundary, it -should be treated as a normal value. Adjusting the marginScale value enables the anomaly -status of the latest point to be changed. -""") + Upper margin of the latest point. UpperMargin is used to calculate + upperBoundary, which is equal to expectedValue + (100 - marginScale)*upperMargin. + If the value of latest point is between upperBoundary and lowerBoundary, it + should be treated as a normal value. Adjusting the marginScale value enables the anomaly + status of the latest point to be changed. + """) upperMargin: float32; @doc(""" -Lower margin of the latest point. LowerMargin is used to calculate -lowerBoundary, which is equal to expectedValue - (100 - marginScale)*lowerMargin. -""") + Lower margin of the latest point. LowerMargin is used to calculate + lowerBoundary, which is equal to expectedValue - (100 - marginScale)*lowerMargin. + """) lowerMargin: float32; @doc(""" -Anomaly status of the latest point. True means the latest point is an anomaly, -either in the negative direction or in the positive direction. -""") + Anomaly status of the latest point. True means the latest point is an anomaly, + either in the negative direction or in the positive direction. + """) isAnomaly: boolean; @doc(""" -Anomaly status of the latest point in a negative direction. True means the latest -point is an anomaly and its real value is smaller than the expected one. -""") + Anomaly status of the latest point in a negative direction. True means the latest + point is an anomaly and its real value is smaller than the expected one. + """) isNegativeAnomaly: boolean; @doc(""" -Anomaly status of the latest point in a positive direction. True means the latest -point is an anomaly and its real value is larger than the expected one. -""") + Anomaly status of the latest point in a positive direction. True means the latest + point is an anomaly and its real value is larger than the expected one. + """) isPositiveAnomaly: boolean; @doc(""" -Severity score for the last input point. The larger the value is, the more -severe the anomaly is. For normal points, the severity is always 0. -""") + Severity score for the last input point. The larger the value is, the more + severe the anomaly is. For normal points, the severity is always 0. + """) severity?: float32; } @doc("Request of change point detection.") model UnivariateChangePointDetectionOptions { @doc(""" -Time series data points. Points should be sorted by time stamp in ascending -order to match the change point detection result. -""") + Time series data points. Points should be sorted by time stamp in ascending + order to match the change point detection result. + """) series: TimeSeriesPoint[]; @doc(""" -Granularity is used to verify whether the input series is valid. -""") + Granularity is used to verify whether the input series is valid. + """) granularity: TimeGranularity; @doc(""" -A custom interval is used to set a nonstandard time interval. For example, if the -series is 5 minutes, the request can be set as {"granularity":"minutely", -"customInterval":5}. -""") + A custom interval is used to set a nonstandard time interval. For example, if the + series is 5 minutes, the request can be set as {"granularity":"minutely", + "customInterval":5}. + """) customInterval?: int32; @doc(""" -Argument that indicates the periodic value of a time series. If the value is null or -not present, the API will determine the period automatically. -""") + Argument that indicates the periodic value of a time series. If the value is null or + not present, the API will determine the period automatically. + """) period?: int32; @doc(""" -Argument that indicates an advanced model parameter. A default stableTrendWindow value will -be used in detection. -""") + Argument that indicates an advanced model parameter. A default stableTrendWindow value will + be used in detection. + """) stableTrendWindow?: int32; @doc(""" -Argument that indicates an advanced model parameter between 0.0 and 1.0. The lower the -value is, the larger the trend error is, which means less change point will -be accepted. -""") + Argument that indicates an advanced model parameter between 0.0 and 1.0. The lower the + value is, the larger the trend error is, which means less change point will + be accepted. + """) threshold?: float32; } @doc("Response of change point detection.") model UnivariateChangePointDetectionResult { @doc(""" -Frequency extracted from the series. Zero means no recurrent pattern has been -found. -""") + Frequency extracted from the series. Zero means no recurrent pattern has been + found. + """) @visibility("read") period?: int32; @doc(""" -Change point properties for each input point. True means -an anomaly (either negative or positive) has been detected. The index of the -array is consistent with the input series. -""") + Change point properties for each input point. True means + an anomaly (either negative or positive) has been detected. The index of the + array is consistent with the input series. + """) isChangePoint?: boolean[]; @doc("Change point confidence of each point.") diff --git a/specification/cognitiveservices/AnomalyDetector/univariate/routes.tsp b/specification/cognitiveservices/AnomalyDetector/univariate/routes.tsp index 8dd789808bd0..a27284739ded 100644 --- a/specification/cognitiveservices/AnomalyDetector/univariate/routes.tsp +++ b/specification/cognitiveservices/AnomalyDetector/univariate/routes.tsp @@ -20,11 +20,11 @@ op UnivariateServiceAction( @route("timeseries/entire/detect") @summary("Detect anomalies for the entire series in batch.") @doc(""" -This operation generates a model with an entire series. Each point is detected -with the same model. With this method, points before and after a certain point -are used to determine whether it's an anomaly. The entire detection can give the -user an overall status of the time series. -""") + This operation generates a model with an entire series. Each point is detected + with the same model. With this method, points before and after a certain point + are used to determine whether it's an anomaly. The entire detection can give the + user an overall status of the time series. + """) op detectUnivariateEntireSeries is UnivariateServiceAction< // TParams { @@ -41,9 +41,9 @@ op detectUnivariateEntireSeries is UnivariateServiceAction< @route("timeseries/last/detect") @summary("Detect anomaly status of the latest point in time series.") @doc(""" -This operation generates a model by using the points that you sent in to the API -and based on all data to determine whether the last point is anomalous. -""") + This operation generates a model by using the points that you sent in to the API + and based on all data to determine whether the last point is anomalous. + """) op detectUnivariateLastPoint is UnivariateServiceAction< // TParams { diff --git a/specification/cognitiveservices/ContentSafety/main.tsp b/specification/cognitiveservices/ContentSafety/main.tsp index 0624fff0c638..935309543c5c 100644 --- a/specification/cognitiveservices/ContentSafety/main.tsp +++ b/specification/cognitiveservices/ContentSafety/main.tsp @@ -28,9 +28,9 @@ using Azure.Core; "Analyze harmful content", { @doc(""" -Supported Cognitive Services endpoints (protocol and hostname, for example: -https://.cognitiveservices.azure.com). -""") + Supported Cognitive Services endpoints (protocol and hostname, for example: + https://.cognitiveservices.azure.com). + """) endpoint: string, } ) diff --git a/specification/cognitiveservices/ContentSafety/models.tsp b/specification/cognitiveservices/ContentSafety/models.tsp index 00ec88b0f0e9..29746094d9c9 100644 --- a/specification/cognitiveservices/ContentSafety/models.tsp +++ b/specification/cognitiveservices/ContentSafety/models.tsp @@ -293,21 +293,21 @@ model LLMResource { @doc("The request of groundedness detection.") model AnalyzeTextGroundednessOptions { @doc(""" - The domain of the text for analysis. Allowed values: Medical, Generic. - This field is optional, with a default value of Generic. - """) + The domain of the text for analysis. Allowed values: Medical, Generic. + This field is optional, with a default value of Generic. + """) domain?: GroundednessDomain = GroundednessDomain.Generic; @doc(""" - The task type for the text analysis. Type of task: QnA, Summarization. - This field is optional, with a default value of Summarization. - """) + The task type for the text analysis. Type of task: QnA, Summarization. + This field is optional, with a default value of Summarization. + """) task?: GroundednessTask = GroundednessTask.Summarization; @doc(""" - The user's question input in a QnA scenario. - This field is optional, but if the task type is set to QnA, it becomes required. - """) + The user's question input in a QnA scenario. + This field is optional, but if the task type is set to QnA, it becomes required. + """) qna?: QnAOptions; @doc("The specific text that needs to be checked.") @@ -315,21 +315,21 @@ model AnalyzeTextGroundednessOptions { text: string; @doc(""" - Leverages a vast array of grounding sources to validate AI-generated text. - Limit: Restrictions on the total amount of grounding sources that can be analyzed in a single request are 55K characters. - """) + Leverages a vast array of grounding sources to validate AI-generated text. + Limit: Restrictions on the total amount of grounding sources that can be analyzed in a single request are 55K characters. + """) groundingSources: string[]; @doc(""" - A value indicating if the output includes an explanation for the identified groundedness. - This field is optional, with a default value of false. - """) + A value indicating if the output includes an explanation for the identified groundedness. + This field is optional, with a default value of false. + """) reasoning?: boolean; @doc(""" - Connection details for the LLM resource. - This field will be used only when the 'reasoning' field is set to true; otherwise, it will be ignored. - """) + Connection details for the LLM resource. + This field will be used only when the 'reasoning' field is set to true; otherwise, it will be ignored. + """) llmResource?: LLMResource; } @@ -359,9 +359,9 @@ model UngroundednessDetails { length: IndexDetails; @doc(""" - The explanation for detected ungroundedness, enhancing understanding. - Only when the 'reasoning' field in the input is set to true 'reason' field will be returned. - """) + The explanation for detected ungroundedness, enhancing understanding. + Only when the 'reasoning' field in the input is set to true 'reason' field will be returned. + """) reason?: string; } @@ -372,10 +372,10 @@ model AnalyzeTextGroundednessResult { ungroundedDetected: boolean; @doc(""" - Specifies the proportion of the text identified as ungrounded, - expressed as a decimal between 0 and 1, - where 0 indicates no grounded content and 1 indicates entirely grounded content.. - """) + Specifies the proportion of the text identified as ungrounded, + expressed as a decimal between 0 and 1, + where 0 indicates no grounded content and 1 indicates entirely grounded content.. + """) ungroundedPercentage: float32; @doc("Provides insights into ungrounded content with specific examples and percentages.") diff --git a/specification/cognitiveservices/ContentSafety/tspconfig.yaml b/specification/cognitiveservices/ContentSafety/tspconfig.yaml index f3c9fb98dec7..53e30575b6ce 100644 --- a/specification/cognitiveservices/ContentSafety/tspconfig.yaml +++ b/specification/cognitiveservices/ContentSafety/tspconfig.yaml @@ -11,6 +11,7 @@ options: emitter-output-dir: "{project-root}/../" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/contentsafety.json" azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" examples-directory: ./examples omit-unreachable-types: true "@azure-tools/typespec-python": diff --git a/specification/cognitiveservices/Language.AnalyzeText/tspconfig.yaml b/specification/cognitiveservices/Language.AnalyzeText/tspconfig.yaml index ac7c86eb9562..1dd04139383f 100644 --- a/specification/cognitiveservices/Language.AnalyzeText/tspconfig.yaml +++ b/specification/cognitiveservices/Language.AnalyzeText/tspconfig.yaml @@ -10,6 +10,7 @@ options: "@azure-tools/typespec-autorest": omit-unreachable-types: true azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/Language/{version-status}/{version}/analyzetext.json" diff --git a/specification/cognitiveservices/Language.Conversations/tspconfig.yaml b/specification/cognitiveservices/Language.Conversations/tspconfig.yaml index 4d16c73d3258..f6fec2779b39 100644 --- a/specification/cognitiveservices/Language.Conversations/tspconfig.yaml +++ b/specification/cognitiveservices/Language.Conversations/tspconfig.yaml @@ -10,6 +10,7 @@ options: "@azure-tools/typespec-autorest": omit-unreachable-types: true azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/Language/{version-status}/{version}/analyzeconversations.json" diff --git a/specification/cognitiveservices/OpenAI.Inference/main.tsp b/specification/cognitiveservices/OpenAI.Inference/main.tsp index a8421a3f7fbf..8ab85d3186ad 100644 --- a/specification/cognitiveservices/OpenAI.Inference/main.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/main.tsp @@ -30,9 +30,9 @@ using TypeSpec.Versioning; "Azure OpenAI APIs for completions and search", { @doc(""" -Supported Cognitive Services endpoints (protocol and hostname, for example: -https://westus.api.cognitive.microsoft.com). -""") + Supported Cognitive Services endpoints (protocol and hostname, for example: + https://westus.api.cognitive.microsoft.com). + """) endpoint: string, } ) diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_speech.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_speech.tsp index c6c28276b3ba..ffd791b045f6 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_speech.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_speech.tsp @@ -78,8 +78,8 @@ model SpeechGenerationOptions { speed?: float32 = 1.0; @doc(""" - The model to use for this text-to-speech request. - """) + The model to use for this text-to-speech request. + """) // Implementation note: developer-facing specification of deployment or model by clients should be controlled either // via an operation parameter or by this request body field -- but only one of those. This field should be hidden by // clients if operation parameters are used and populated into the request body on an as-needed basis. diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp index bed16d4c7338..97b7963aa9ff 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp @@ -39,78 +39,78 @@ union AudioTranscriptionTimestampGranularity { string, @doc(""" - Indicates that responses should include timing information about each transcribed word. Note that generating word - timestamp information will incur additional response latency. - """) + Indicates that responses should include timing information about each transcribed word. Note that generating word + timestamp information will incur additional response latency. + """) word: "word", @doc(""" - Indicates that responses should include timing and other information about each transcribed audio segment. Audio - segment timestamp information does not incur any additional latency. - """) + Indicates that responses should include timing and other information about each transcribed audio segment. Audio + segment timestamp information does not incur any additional latency. + """) segment: "segment", } @doc(""" -The configuration information for an audio transcription request. -""") + The configuration information for an audio transcription request. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model AudioTranscriptionOptions { @doc(""" - The audio data to transcribe. This must be the binary content of a file in one of the supported media formats: - flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm. - """) + The audio data to transcribe. This must be the binary content of a file in one of the supported media formats: + flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm. + """) @clientName("AudioData", "csharp") file: bytes; @doc(""" - The optional filename or descriptive identifier to associate with with the audio data. - """) + The optional filename or descriptive identifier to associate with with the audio data. + """) // Note: although this isn't explicitly part of the request schema per documentation, it is present via the encoded // content-disposition header for the binary section of the multipart/form-data content. filename?: string; @doc(""" - The requested format of the transcription response data, which will influence the content and detail of the result. - """) + The requested format of the transcription response data, which will influence the content and detail of the result. + """) @encodedName("application/json", "response_format") responseFormat?: AudioTranscriptionFormat; @doc(""" - The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code - such as 'en' or 'fr'. - Providing this known input language is optional but may improve the accuracy and/or latency of transcription. - """) + The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code + such as 'en' or 'fr'. + Providing this known input language is optional but may improve the accuracy and/or latency of transcription. + """) language?: string; @doc(""" - An optional hint to guide the model's style or continue from a prior audio segment. The written language of the - prompt should match the primary spoken language of the audio data. - """) + An optional hint to guide the model's style or continue from a prior audio segment. The written language of the + prompt should match the primary spoken language of the audio data. + """) prompt?: string; @doc(""" - The sampling temperature, between 0 and 1. - Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. - """) + The sampling temperature, between 0 and 1. + Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + """) temperature?: float32; @doc(""" - The timestamp granularities to populate for this transcription. - `response_format` must be set `verbose_json` to use timestamp granularities. - Either or both of these options are supported: `word`, or `segment`. - Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. - """) + The timestamp granularities to populate for this transcription. + `response_format` must be set `verbose_json` to use timestamp granularities. + Either or both of these options are supported: `word`, or `segment`. + Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. + """) @added(ServiceApiVersions.v2024_04_01_Preview) @encodedName("application/json", "timestamp_granularities") - timestampGranularities?: AudioTranscriptionTimestampGranularity[] = [ + timestampGranularities?: AudioTranscriptionTimestampGranularity[] = #[ AudioTranscriptionTimestampGranularity.segment ]; @doc(""" - The model to use for this transcription request. - """) + The model to use for this transcription request. + """) // Implementation note: developer-facing specification of deployment or model by clients should be controlled either // via an operation parameter or by this request body field -- but only one of those. This field should be hidden by // clients if operation parameters are used and populated into the request body on an as-needed basis. @@ -119,10 +119,10 @@ model AudioTranscriptionOptions { } @doc(""" -Extended information about a single segment of transcribed audio data. -Segments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not -necessarily sentences. -""") + Extended information about a single segment of transcribed audio data. + Segments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not + necessarily sentences. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model AudioTranscriptionSegment { @doc("The 0-based index of this segment within a transcription.") @@ -160,12 +160,12 @@ model AudioTranscriptionSegment { tokens: int32[]; @doc(""" - The seek position associated with the processing of this audio segment. - Seek positions are expressed as hundredths of seconds. - The model may process several segments from a single seek position, so while the seek position will never represent - a later time than the segment's start, the segment's start may represent a significantly later time than the - segment's associated seek position. - """) + The seek position associated with the processing of this audio segment. + Seek positions are expressed as hundredths of seconds. + The model may process several segments from a single seek position, so while the seek position will never represent + a later time than the segment's start, the segment's start may represent a significantly later time than the + segment's associated seek position. + """) seek: int32; } @@ -195,9 +195,9 @@ model AudioTranscription { task?: AudioTaskLabel; @doc(""" - The spoken language that was detected in the transcribed audio data. - This is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'. - """) + The spoken language that was detected in the transcribed audio data. + This is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'. + """) language?: string; @doc("The total duration of the audio processed to produce accompanying transcription information.") @@ -205,13 +205,13 @@ model AudioTranscription { duration?: duration; @doc(""" - A collection of information about the timing, probabilities, and other detail of each processed audio segment. - """) + A collection of information about the timing, probabilities, and other detail of each processed audio segment. + """) segments?: AudioTranscriptionSegment[]; @doc(""" - A collection of information about the timing of each processed word. - """) + A collection of information about the timing of each processed word. + """) @added(ServiceApiVersions.v2024_04_01_Preview) words?: AudioTranscriptionWord[]; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp index 35bc3ee58384..9c9733e9135d 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp @@ -34,46 +34,46 @@ union AudioTranslationFormat { } @doc(""" -The configuration information for an audio translation request. -""") + The configuration information for an audio translation request. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model AudioTranslationOptions { @doc(""" - The audio data to translate. This must be the binary content of a file in one of the supported media formats: - flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm. - """) + The audio data to translate. This must be the binary content of a file in one of the supported media formats: + flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm. + """) @clientName("AudioData", "csharp") file: bytes; @doc(""" - The optional filename or descriptive identifier to associate with with the audio data. - """) + The optional filename or descriptive identifier to associate with with the audio data. + """) // Note: although this isn't explicitly part of the request schema per documentation, it is present via the encoded // content-disposition header for the binary section of the multipart/form-data content. filename?: string; @doc(""" - The requested format of the translation response data, which will influence the content and detail of the result. - """) + The requested format of the translation response data, which will influence the content and detail of the result. + """) @encodedName("application/json", "response_format") responseFormat?: AudioTranslationFormat; @doc(""" - An optional hint to guide the model's style or continue from a prior audio segment. The written language of the - prompt should match the primary spoken language of the audio data. - """) + An optional hint to guide the model's style or continue from a prior audio segment. The written language of the + prompt should match the primary spoken language of the audio data. + """) prompt?: string; @doc(""" - The sampling temperature, between 0 and 1. - Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. - """) + The sampling temperature, between 0 and 1. + Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + """) temperature?: float32; @doc(""" - The model to use for this translation request. - """) + The model to use for this translation request. + """) // Implementation note: developer-facing specification of deployment or model by clients should be controlled either // via an operation parameter or by this request body field -- but only one of those. This field should be hidden by // clients if operation parameters are used and populated into the request body on an as-needed basis. @@ -82,10 +82,10 @@ model AudioTranslationOptions { } @doc(""" -Extended information about a single segment of translated audio data. -Segments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not -necessarily sentences. -""") + Extended information about a single segment of translated audio data. + Segments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not + necessarily sentences. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model AudioTranslationSegment { @doc("The 0-based index of this segment within a translation.") @@ -123,12 +123,12 @@ model AudioTranslationSegment { tokens: int32[]; @doc(""" - The seek position associated with the processing of this audio segment. - Seek positions are expressed as hundredths of seconds. - The model may process several segments from a single seek position, so while the seek position will never represent - a later time than the segment's start, the segment's start may represent a significantly later time than the - segment's associated seek position. - """) + The seek position associated with the processing of this audio segment. + Seek positions are expressed as hundredths of seconds. + The model may process several segments from a single seek position, so while the seek position will never represent + a later time than the segment's start, the segment's start may represent a significantly later time than the + segment's associated seek position. + """) seek: int32; } @@ -143,9 +143,9 @@ model AudioTranslation { task?: AudioTaskLabel; @doc(""" - The spoken language that was detected in the translated audio data. - This is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'. - """) + The spoken language that was detected in the translated audio data. + This is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'. + """) language?: string; @doc("The total duration of the audio processed to produce accompanying translation information.") @@ -153,7 +153,7 @@ model AudioTranslation { duration?: duration; @doc(""" - A collection of information about the timing, probabilities, and other detail of each processed audio segment. - """) + A collection of information about the timing, probabilities, and other detail of each processed audio segment. + """) segments?: AudioTranslationSegment[]; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp index 3f30a4ccced3..cd837e3976a5 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp @@ -13,10 +13,10 @@ using TypeSpec.Versioning; @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat - completions request that should use Azure OpenAI chat extensions to augment the response behavior. - The use of this configuration is compatible only with Azure OpenAI. -""") + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + """) union AzureChatExtensionType { string, @@ -39,31 +39,31 @@ union AzureChatExtensionType { @discriminator("type") @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat - completions request that should use Azure OpenAI chat extensions to augment the response behavior. - The use of this configuration is compatible only with Azure OpenAI. -""") + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + """) model AzureChatExtensionConfiguration { @doc(""" - The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource. - Azure chat extensions are only compatible with Azure OpenAI. - """) + The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource. + Azure chat extensions are only compatible with Azure OpenAI. + """) type: AzureChatExtensionType; } @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - A representation of the additional context information available when Azure OpenAI chat extensions are involved - in the generation of a corresponding chat completions response. This context information is only populated when - using an Azure OpenAI request configured to use a matching extension. -""") + A representation of the additional context information available when Azure OpenAI chat extensions are involved + in the generation of a corresponding chat completions response. This context information is only populated when + using an Azure OpenAI request configured to use a matching extension. + """) model AzureChatExtensionsMessageContext { @doc(""" - The contextual information associated with the Azure chat extensions used for a chat completions request. - These messages describe the data source retrievals, plugin invocations, and other intermediate steps taken in the - course of generating a chat completions response that was augmented by capabilities from Azure OpenAI chat - extensions. - """) + The contextual information associated with the Azure chat extensions used for a chat completions request. + These messages describe the data source retrievals, plugin invocations, and other intermediate steps taken in the + course of generating a chat completions response that was augmented by capabilities from Azure OpenAI chat + extensions. + """) citations?: AzureChatExtensionDataSourceResponseCitation[]; @doc("The detected intent from the chat history, used to pass to the next turn to carry over the context.") @@ -77,10 +77,10 @@ model AzureChatExtensionsMessageContext { @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -A single instance of additional context information available when Azure OpenAI chat extensions are involved -in the generation of a corresponding chat completions response. This context information is only populated when -using an Azure OpenAI request configured to use a matching extension. -""") + A single instance of additional context information available when Azure OpenAI chat extensions are involved + in the generation of a corresponding chat completions response. This context information is only populated when + using an Azure OpenAI request configured to use a matching extension. + """) model AzureChatExtensionDataSourceResponseCitation { @doc("The content of the citation.") content: string; @@ -170,9 +170,9 @@ model AzureChatEnhancementConfiguration { @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided -in the request. -""") + Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided + in the request. + """) model AzureChatEnhancements { @doc("The grounding enhancement that returns the bounding box of the objects detected in the image.") grounding?: AzureGroundingEnhancement; @@ -202,9 +202,9 @@ model AzureGroundingEnhancementLineSpan { text: string; @doc(""" - The character offset within the text where the span begins. This offset is defined as the position of the first - character of the span, counting from the start of the text as Unicode codepoints. - """) + The character offset within the text where the span begins. This offset is defined as the position of the first + character of the span, counting from the start of the text as Unicode codepoints. + """) offset: int32; @doc("The length of the span in characters, measured in Unicode codepoints.") diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp index 75bfaad1ed13..1b5be626f6cc 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp @@ -15,32 +15,32 @@ union ContentFilterSeverity { string, @doc(""" - Content may be related to violence, self-harm, sexual, or hate categories but the terms - are used in general, journalistic, scientific, medical, and similar professional contexts, - which are appropriate for most audiences. - """) + Content may be related to violence, self-harm, sexual, or hate categories but the terms + are used in general, journalistic, scientific, medical, and similar professional contexts, + which are appropriate for most audiences. + """) safe: "safe", @doc(""" - Content that expresses prejudiced, judgmental, or opinionated views, includes offensive - use of language, stereotyping, use cases exploring a fictional world (for example, gaming, - literature) and depictions at low intensity. - """) + Content that expresses prejudiced, judgmental, or opinionated views, includes offensive + use of language, stereotyping, use cases exploring a fictional world (for example, gaming, + literature) and depictions at low intensity. + """) low: "low", @doc(""" - Content that uses offensive, insulting, mocking, intimidating, or demeaning language - towards specific identity groups, includes depictions of seeking and executing harmful - instructions, fantasies, glorification, promotion of harm at medium intensity. - """) + Content that uses offensive, insulting, mocking, intimidating, or demeaning language + towards specific identity groups, includes depictions of seeking and executing harmful + instructions, fantasies, glorification, promotion of harm at medium intensity. + """) medium: "medium", @doc(""" - Content that displays explicit and severe harmful instructions, actions, - damage, or abuse; includes endorsement, glorification, or promotion of severe - harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual - power exchange or abuse. - """) + Content that displays explicit and severe harmful instructions, actions, + damage, or abuse; includes endorsement, glorification, or promotion of severe + harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual + power exchange or abuse. + """) high: "high", } @@ -60,32 +60,32 @@ alias FilteredResultBase = { alias ContentFilterResultsBase = { @doc(""" - Describes language related to anatomical organs and genitals, romantic relationships, - acts portrayed in erotic or affectionate terms, physical sexual acts, including - those portrayed as an assault or a forced sexual violent act against one’s will, - prostitution, pornography, and abuse. - """) + Describes language related to anatomical organs and genitals, romantic relationships, + acts portrayed in erotic or affectionate terms, physical sexual acts, including + those portrayed as an assault or a forced sexual violent act against one’s will, + prostitution, pornography, and abuse. + """) sexual?: ContentFilterResult; @doc(""" - Describes language related to physical actions intended to hurt, injure, damage, or - kill someone or something; describes weapons, etc. - """) + Describes language related to physical actions intended to hurt, injure, damage, or + kill someone or something; describes weapons, etc. + """) violence?: ContentFilterResult; @doc(""" - Describes language attacks or uses that include pejorative or discriminatory language - with reference to a person or identity group on the basis of certain differentiating - attributes of these groups including but not limited to race, ethnicity, nationality, - gender identity and expression, sexual orientation, religion, immigration status, ability - status, personal appearance, and body size. - """) + Describes language attacks or uses that include pejorative or discriminatory language + with reference to a person or identity group on the basis of certain differentiating + attributes of these groups including but not limited to race, ethnicity, nationality, + gender identity and expression, sexual orientation, religion, immigration status, ability + status, personal appearance, and body size. + """) hate?: ContentFilterResult; @doc(""" - Describes language related to physical actions intended to purposely hurt, injure, - or damage one’s body, or kill oneself. - """) + Describes language related to physical actions intended to purposely hurt, injure, + or damage one’s body, or kill oneself. + """) @encodedName("application/json", "self_harm") selfHarm?: ContentFilterResult; @@ -103,9 +103,9 @@ alias ContentFilterResultsBase = { customBlocklists?: ContentFilterDetailedResults; @doc(""" - Describes an error returned if the content filtering system is - down or otherwise unable to complete the operation in time. - """) + Describes an error returned if the content filtering system is + down or otherwise unable to complete the operation in time. + """) error?: Azure.Core.Foundations.Error; }; @@ -142,8 +142,8 @@ model ContentFilterResultsForChoice { @added(ServiceApiVersions.v2023_06_01_Preview) @doc(""" -Content filtering results for a single prompt in the request. -""") + Content filtering results for a single prompt in the request. + """) model ContentFilterResultsForPrompt { @doc("The index of this prompt in the set of prompt results") @encodedName("application/json", "prompt_index") diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp index 913808db5f30..e13ed63929d4 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp @@ -19,19 +19,20 @@ namespace Azure.OpenAI; @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON -mode. -""") + An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON + mode. + """) @discriminator("type") model ChatCompletionsResponseFormat { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The discriminated type for the response format.") type: string; } @doc(""" -The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response -content that adheres to a specific schema. -""") + The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response + content that adheres to a specific schema. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model ChatCompletionsTextResponseFormat extends ChatCompletionsResponseFormat { @doc("The discriminated object type, which is always 'text' for this format.") @@ -39,8 +40,8 @@ model ChatCompletionsTextResponseFormat extends ChatCompletionsResponseFormat { } @doc(""" -A response format for Chat Completions that restricts responses to emitting valid JSON objects. -""") + A response format for Chat Completions that restricts responses to emitting valid JSON objects. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model ChatCompletionsJsonResponseFormat extends ChatCompletionsResponseFormat { @doc("The discriminated object type, which is always 'json_object' for this format.") @@ -48,10 +49,10 @@ model ChatCompletionsJsonResponseFormat extends ChatCompletionsResponseFormat { } @doc(""" -The configuration information for a chat completions request. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") + The configuration information for a chat completions request. + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. + """) @added(ServiceApiVersions.v2023_05_15) model ChatCompletionsOptions { @doc(""" @@ -166,9 +167,9 @@ model ChatCompletionsOptions { `model`?: string; @doc(""" - The configuration entries for Azure OpenAI chat extensions that use them. - This additional specification is only compatible with Azure OpenAI. - """) + The configuration entries for Azure OpenAI chat extensions that use them. + This additional specification is only compatible with Azure OpenAI. + """) // Note: client libraries should represent the `dataSources` information for Azure OpenAI chat extensions in a way // that differs from the wire format. To wit: the array should appear on a custom sub-options type (as if // the array were in an appropriate parent JSON object on the wire) and type/field names should converge on @@ -185,25 +186,25 @@ model ChatCompletionsOptions { @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - If specified, the system will make a best effort to sample deterministically such that repeated requests with the - same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the - system_fingerprint response parameter to monitor changes in the backend." - """) + If specified, the system will make a best effort to sample deterministically such that repeated requests with the + same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the + system_fingerprint response parameter to monitor changes in the backend." + """) seed?: int64; #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicitly nullable types" @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model. - """) + Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model. + """) logprobs?: boolean | null = false; #suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI uses wire-format snake_casing" #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicitly required, nullable types" @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. - """) + An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. + """) top_logprobs?: int32 | null; @encodedName("application/json", "response_format") @@ -218,16 +219,16 @@ model ChatCompletionsOptions { @encodedName("application/json", "tool_choice") @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - If specified, the model will configure which of the provided tools it can use for the chat completions response. - """) + If specified, the model will configure which of the provided tools it can use for the chat completions response. + """) toolChoice?: ChatCompletionsToolSelection; } @doc(""" -The representation of a single prompt completion as part of an overall chat completions request. -Generally, `n` choices are generated per provided prompt with a default value of 1. -Token limits and other settings may limit the number of choices generated. -""") + The representation of a single prompt completion as part of an overall chat completions request. + Generally, `n` choices are generated per provided prompt with a default value of 1. + Token limits and other settings may limit the number of choices generated. + """) @added(ServiceApiVersions.v2023_05_15) model ChatChoice { @doc("The chat message for a given chat completions prompt.") @@ -250,9 +251,9 @@ model ChatChoice { // Note: this property is currently speculative via observation and not yet documented anywhere. @doc(""" - The reason the model stopped generating tokens, together with any applicable details. - This structured representation replaces 'finish_reason' for some models. - """) + The reason the model stopped generating tokens, together with any applicable details. + This structured representation replaces 'finish_reason' for some models. + """) @added(ServiceApiVersions.v2024_02_15_Preview) @encodedName("application/json", "finish_details") finishDetails?: ChatFinishDetails; @@ -272,18 +273,18 @@ model ChatChoice { @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - Represents the output results of Azure OpenAI enhancements to chat completions, as configured via the matching input - provided in the request. This supplementary information is only available when using Azure OpenAI and only when the - request is configured to use enhancements. - """) + Represents the output results of Azure OpenAI enhancements to chat completions, as configured via the matching input + provided in the request. This supplementary information is only available when using Azure OpenAI and only when the + request is configured to use enhancements. + """) enhancements?: AzureChatEnhancements; } @doc(""" -Representation of the response data from a chat completions request. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") + Representation of the response data from a chat completions request. + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. + """) @added(ServiceApiVersions.v2023_05_15) model ChatCompletions { @doc("A unique identifier associated with this chat completions response.") @@ -308,9 +309,9 @@ model ChatCompletions { `model`?: string; @doc(""" - Content filtering results for zero or more prompts in the request. In a streaming request, - results for different prompts may arrive at different times or in different orders. - """) + Content filtering results for zero or more prompts in the request. In a streaming request, + results for different prompts may arrive at different times or in different orders. + """) @added(ServiceApiVersions.v2023_06_01_Preview) @encodedName("application/json", "prompt_filter_results") promptFilterResults?: ContentFilterResultsForPrompt[]; @@ -318,9 +319,9 @@ model ChatCompletions { @added(ServiceApiVersions.v2024_02_15_Preview) @encodedName("application/json", "system_fingerprint") @doc(""" - Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that - might impact determinism. - """) + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that + might impact determinism. + """) systemFingerprint?: string; @doc(""" @@ -333,6 +334,7 @@ model ChatCompletions { @discriminator("type") @doc("An abstract representation of structured information about why a chat completions response terminated.") model ChatFinishDetails { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; } @@ -348,9 +350,9 @@ model StopFinishDetails extends ChatFinishDetails { } @doc(""" -A structured representation of a stop reason that signifies a token limit was reached before the model could naturally -complete. -""") + A structured representation of a stop reason that signifies a token limit was reached before the model could naturally + complete. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model MaxTokensFinishDetails extends ChatFinishDetails { @doc("The object type, which is always 'max_tokens' for this object.") @@ -359,20 +361,20 @@ model MaxTokensFinishDetails extends ChatFinishDetails { @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -Log probability information for a choice, as requested via 'logprobs' and 'top_logprobs'. -""") + Log probability information for a choice, as requested via 'logprobs' and 'top_logprobs'. + """) model ChatChoiceLogProbabilityInfo { #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicitly required, nullable types" @doc(""" - The list of log probability information entries for the choice's message content tokens, as requested via the 'logprobs' option. - """) + The list of log probability information entries for the choice's message content tokens, as requested via the 'logprobs' option. + """) content: ChatTokenLogProbabilityResult[] | null; } @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -A representation of the log probability information for a single content token, including a list of most likely tokens if 'top_logprobs' were requested. -""") + A representation of the log probability information for a single content token, including a list of most likely tokens if 'top_logprobs' were requested. + """) model ChatTokenLogProbabilityResult { ...ChatTokenLogProbabilityInfo; @@ -384,8 +386,8 @@ model ChatTokenLogProbabilityResult { @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -A representation of the log probability information for a single message content token. -""") + A representation of the log probability information for a single message content token. + """) model ChatTokenLogProbabilityInfo { @doc("The message content token.") token: string; @@ -395,7 +397,7 @@ model ChatTokenLogProbabilityInfo { #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicitly required, nullable types" @doc(""" - A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token. - """) + A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token. + """) bytes: int32[] | null; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp index 1aed3aee3896..702a4c0c9056 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp @@ -20,6 +20,7 @@ alias ChatMessageContent = string | ChatMessageContentItem[]; @doc("An abstract representation of a structured content item within a chat message.") @discriminator("type") model ChatMessageContentItem { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The discriminated object type.") type: string; } @@ -43,15 +44,15 @@ union ChatMessageImageDetailLevel { auto: "auto", @doc(""" - Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer - tokens but may also be less accurate for highly detailed images. - """) + Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer + tokens but may also be less accurate for highly detailed images. + """) low: "low", @doc(""" - Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed - images but may also be slower and consume more tokens. - """) + Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed + images but may also be slower and consume more tokens. + """) high: "high", } @@ -73,9 +74,9 @@ model ChatMessageImageUrl { url: url; @doc(""" - The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and - accuracy. - """) + The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and + accuracy. + """) detail?: ChatMessageImageDetailLevel; } @@ -89,9 +90,9 @@ model ChatRequestMessage { @added(ServiceApiVersions.v2023_05_15) @doc(""" -A request chat message containing system instructions that influence how the model will generate a chat completions -response. -""") + A request chat message containing system instructions that influence how the model will generate a chat completions + response. + """) model ChatRequestSystemMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'system' for system messages.") role: ChatRole.system; @@ -132,17 +133,17 @@ model ChatRequestAssistantMessage extends ChatRequestMessage { @encodedName("application/json", "tool_calls") @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat - completions request to resolve as configured. - """) + The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat + completions request to resolve as configured. + """) toolCalls?: ChatCompletionsToolCall[]; @added(ServiceApiVersions.v2023_07_01_Preview) @encodedName("application/json", "function_call") @doc(""" - The function call that must be resolved and have its output appended to subsequent input messages for the chat - completions request to resolve as configured. - """) + The function call that must be resolved and have its output appended to subsequent input messages for the chat + completions request to resolve as configured. + """) functionCall?: FunctionCall; } @@ -188,23 +189,23 @@ model ChatResponseMessage { @added(ServiceApiVersions.v2024_02_15_Preview) @encodedName("application/json", "tool_calls") @doc(""" - The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat - completions request to resolve as configured. - """) + The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat + completions request to resolve as configured. + """) toolCalls?: ChatCompletionsToolCall[]; @added(ServiceApiVersions.v2023_07_01_Preview) @encodedName("application/json", "function_call") @doc(""" - The function call that must be resolved and have its output appended to subsequent input messages for the chat - completions request to resolve as configured. - """) + The function call that must be resolved and have its output appended to subsequent input messages for the chat + completions request to resolve as configured. + """) functionCall?: FunctionCall; @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" - If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those - extensions while processing the chat completions request. - """) + If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those + extensions while processing the chat completions request. + """) context?: AzureChatExtensionsMessageContext; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp index 4bf328ea298c..3afebd183971 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp @@ -6,10 +6,10 @@ using TypeSpec.Versioning; namespace Azure.OpenAI; @doc(""" -Representation of the token counts processed for a completions request. -Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and -other consumers. -""") + Representation of the token counts processed for a completions request. + Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and + other consumers. + """) model CompletionsUsage { @doc("The number of tokens generated across all completions emissions.") @encodedName("application/json", "completion_tokens") @@ -25,8 +25,8 @@ model CompletionsUsage { } @doc(""" -Representation of the manner in which a completions response concluded. -""") + Representation of the manner in which a completions response concluded. + """) union CompletionsFinishReason { string, diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp index c48dc3bb5782..0fba24798f4a 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp @@ -14,10 +14,10 @@ using Azure.ClientGenerator.Core; namespace Azure.OpenAI; @doc(""" -The configuration information for a completions request. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") + The configuration information for a completions request. + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. + """) model CompletionsOptions { @doc("The prompts to generate completions from.") @clientName("Prompts", "csharp") @@ -142,10 +142,10 @@ model CompletionsOptions { } @doc(""" -Representation of the response data from a completions request. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") + Representation of the response data from a completions request. + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. + """) model Completions { @doc("A unique identifier associated with this completions response.") id: string; @@ -159,9 +159,9 @@ model Completions { created: utcDateTime; @doc(""" - Content filtering results for zero or more prompts in the request. In a streaming request, - results for different prompts may arrive at different times or in different orders. - """) + Content filtering results for zero or more prompts in the request. In a streaming request, + results for different prompts may arrive at different times or in different orders. + """) @added(ServiceApiVersions.v2023_06_01_Preview) @encodedName("application/json", "prompt_filter_results") promptFilterResults?: ContentFilterResultsForPrompt[]; @@ -180,10 +180,10 @@ model Completions { } @doc(""" -The representation of a single prompt completion as part of an overall completions request. -Generally, `n` choices are generated per provided prompt with a default value of 1. -Token limits and other settings may limit the number of choices generated. -""") + The representation of a single prompt completion as part of an overall completions request. + Generally, `n` choices are generated per provided prompt with a default value of 1. + Token limits and other settings may limit the number of choices generated. + """) model Choice { @doc("The generated text for a given completions prompt.") text: string; @@ -192,10 +192,10 @@ model Choice { index: int32; @doc(""" - Information about the content filtering category (hate, sexual, violence, self_harm), if it - has been detected, as well as the severity level (very_low, low, medium, high-scale that - determines the intensity and risk level of harmful content) and if it has been filtered or not. - """) + Information about the content filtering category (hate, sexual, violence, self_harm), if it + has been detected, as well as the severity level (very_low, low, medium, high-scale that + determines the intensity and risk level of harmful content) and if it has been filtered or not. + """) @added(ServiceApiVersions.v2023_06_01_Preview) @encodedName("application/json", "content_filter_results") contentFilterResults?: ContentFilterResultsForChoice; @@ -215,8 +215,8 @@ model Choice { alias NullableFloat = float32 | null; @doc(""" -Representation of a log probabilities model for a completions generation. -""") + Representation of a log probabilities model for a completions generation. + """) model CompletionsLogProbabilityModel { @doc("The textual forms of tokens evaluated in this probability model.") tokens: string[]; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp index 9b677da801a8..63c04068f05a 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp @@ -5,8 +5,8 @@ namespace Azure.OpenAI; using TypeSpec.Versioning; @doc(""" -The authentication types supported with Azure OpenAI On Your Data. -""") + The authentication types supported with Azure OpenAI On Your Data. + """) @added(ServiceApiVersions.v2024_02_15_Preview) union OnYourDataAuthenticationType { string, @@ -42,8 +42,8 @@ model OnYourDataAuthenticationOptions { } @doc(""" -The authentication options for Azure OpenAI On Your Data when using an API key. -""") + The authentication options for Azure OpenAI On Your Data when using an API key. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model OnYourDataApiKeyAuthenticationOptions extends OnYourDataAuthenticationOptions { @@ -55,8 +55,8 @@ model OnYourDataApiKeyAuthenticationOptions } @doc(""" -The authentication options for Azure OpenAI On Your Data when using a connection string. -""") + The authentication options for Azure OpenAI On Your Data when using a connection string. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model OnYourDataConnectionStringAuthenticationOptions extends OnYourDataAuthenticationOptions { @@ -69,8 +69,8 @@ model OnYourDataConnectionStringAuthenticationOptions } @doc(""" -The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair. -""") + The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model OnYourDataKeyAndKeyIdAuthenticationOptions extends OnYourDataAuthenticationOptions { @@ -86,8 +86,8 @@ model OnYourDataKeyAndKeyIdAuthenticationOptions } @doc(""" -The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key. -""") + The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model OnYourDataEncodedApiKeyAuthenticationOptions extends OnYourDataAuthenticationOptions { @@ -100,8 +100,8 @@ model OnYourDataEncodedApiKeyAuthenticationOptions } @doc(""" -The authentication options for Azure OpenAI On Your Data when using access token. -""") + The authentication options for Azure OpenAI On Your Data when using access token. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model OnYourDataAccessTokenAuthenticationOptions extends OnYourDataAuthenticationOptions { @@ -114,8 +114,8 @@ model OnYourDataAccessTokenAuthenticationOptions } @doc(""" -The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. -""") + The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model OnYourDataSystemAssignedManagedIdentityAuthenticationOptions extends OnYourDataAuthenticationOptions { @@ -124,8 +124,8 @@ model OnYourDataSystemAssignedManagedIdentityAuthenticationOptions } @doc(""" -The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity. -""") + The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model OnYourDataUserAssignedManagedIdentityAuthenticationOptions extends OnYourDataAuthenticationOptions { diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp index a8b7d4f73fab..067e7628bd96 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp @@ -12,15 +12,15 @@ using Azure.ClientGenerator.Core; #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat -extension. -""") + A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat + extension. + """) model AzureCosmosDBChatExtensionConfiguration extends AzureChatExtensionConfiguration { @doc(""" - The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its - default value for Azure Cosmos DB. - """) + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Azure Cosmos DB. + """) type: AzureChatExtensionType.azureCosmosDB; @doc("The parameters to use when configuring Azure OpenAI CosmosDB chat extensions.") @@ -30,9 +30,9 @@ model AzureCosmosDBChatExtensionConfiguration #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for -MongoDB vCore. The supported authentication type is ConnectionString. -""") + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for + MongoDB vCore. The supported authentication type is ConnectionString. + """) model AzureCosmosDBChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp index 7b567180c38f..a764b32c5f52 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp @@ -10,15 +10,15 @@ using Azure.ClientGenerator.Core; @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -A specific representation of configurable options for Azure Machine Learning vector index when using it as an Azure -OpenAI chat extension. -""") + A specific representation of configurable options for Azure Machine Learning vector index when using it as an Azure + OpenAI chat extension. + """) model AzureMachineLearningIndexChatExtensionConfiguration extends AzureChatExtensionConfiguration { @doc(""" - The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its - default value for Azure Machine Learning vector index. - """) + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Azure Machine Learning vector index. + """) type: AzureChatExtensionType.azureMachineLearningIndex; @doc("The parameters for the Azure Machine Learning vector index chat extension.") diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_search_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_search_options.tsp index e2a77ff5ba98..61f0e83a0dd1 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_search_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_search_options.tsp @@ -10,16 +10,16 @@ using TypeSpec.Versioning; using Azure.ClientGenerator.Core; @doc(""" -A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat -extension. -""") + A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat + extension. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model AzureSearchChatExtensionConfiguration extends AzureChatExtensionConfiguration { @doc(""" - The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its - default value for Azure Cognitive Search. - """) + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Azure Cognitive Search. + """) type: AzureChatExtensionType.azureSearch; @doc("The parameters to use when configuring Azure Search.") @@ -100,8 +100,8 @@ model AzureSearchIndexFieldMappingOptions { } @doc(""" -The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. -""") + The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. + """) @added(ServiceApiVersions.v2024_02_15_Preview) union AzureSearchQueryType { string, diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp index 22cc07d0778c..ec91c476f801 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp @@ -10,12 +10,12 @@ using Azure.ClientGenerator.Core; alias OnYourDataCommonChatExtensionConfiguration = { @doc(""" - The authentication method to use when accessing the defined data source. - Each data source type supports a specific set of available authentication methods; please see the documentation of - the data source for supported mechanisms. - If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) - authentication. - """) + The authentication method to use when accessing the defined data source. + Each data source type supports a specific set of available authentication methods; please see the documentation of + the data source for supported mechanisms. + If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) + authentication. + """) @clientName("Authentication", "csharp") authentication?: OnYourDataAuthenticationOptions; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp index a292e0f08dc7..60b694069447 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp @@ -10,15 +10,15 @@ using Azure.ClientGenerator.Core; @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat -extension. -""") + A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat + extension. + """) model ElasticsearchChatExtensionConfiguration extends AzureChatExtensionConfiguration { @doc(""" - The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its - default value for Elasticsearch®. - """) + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Elasticsearch®. + """) type: AzureChatExtensionType.elasticsearch; @doc("The parameters to use when configuring Elasticsearch®.") @@ -86,8 +86,8 @@ model ElasticsearchIndexFieldMappingOptions { } @doc(""" -The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension. -""") + The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension. + """) @added(ServiceApiVersions.v2024_02_15_Preview) union ElasticsearchQueryType { string, diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp index cf0acabe7017..ffd0a4f87c41 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp @@ -12,15 +12,15 @@ using Azure.ClientGenerator.Core; #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat -extension. -""") + A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat + extension. + """) model PineconeChatExtensionConfiguration extends AzureChatExtensionConfiguration { @doc(""" - The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its - default value for Pinecone. - """) + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Pinecone. + """) type: AzureChatExtensionType.pinecone; @doc("The parameters to use when configuring Azure OpenAI chat extensions.") diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp index 8fcd2f6603fe..3c16cd2371a8 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp @@ -7,28 +7,28 @@ using TypeSpec.Versioning; @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with -vector search. -""") + Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with + vector search. + """) union OnYourDataVectorizationSourceType { string, @doc(""" - Represents vectorization performed by public service calls to an Azure OpenAI embedding model. - """) + Represents vectorization performed by public service calls to an Azure OpenAI embedding model. + """) endpoint: "endpoint", @doc(""" - Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but - On Your Data will use this model deployment via an internal call rather than a public one, which enables vector - search even in private networks. - """) + Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but + On Your Data will use this model deployment via an internal call rather than a public one, which enables vector + search even in private networks. + """) deploymentName: "deployment_name", @doc(""" - Represents a specific embedding model ID as defined in the search service. - Currently only supported by Elasticsearch®. - """) + Represents a specific embedding model ID as defined in the search service. + Currently only supported by Elasticsearch®. + """) modelId: "model_id", } @@ -42,9 +42,9 @@ model OnYourDataVectorizationSource { @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based -on a public Azure OpenAI endpoint call for embeddings. -""") + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a public Azure OpenAI endpoint call for embeddings. + """) model OnYourDataEndpointVectorizationSource extends OnYourDataVectorizationSource { @doc("The type of vectorization source to use. Always 'Endpoint' for this type.") @@ -61,9 +61,9 @@ model OnYourDataEndpointVectorizationSource @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based -on an internal embeddings model deployment name in the same Azure OpenAI resource. -""") + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on an internal embeddings model deployment name in the same Azure OpenAI resource. + """) model OnYourDataDeploymentNameVectorizationSource extends OnYourDataVectorizationSource { @doc("The type of vectorization source to use. Always 'DeploymentName' for this type.") @@ -80,9 +80,9 @@ model OnYourDataDeploymentNameVectorizationSource @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based -on a search service model ID. Currently only supported by Elasticsearch®. -""") + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a search service model ID. Currently only supported by Elasticsearch®. + """) model OnYourDataModelIdVectorizationSource extends OnYourDataVectorizationSource { @doc("The type of vectorization source to use. Always 'ModelId' for this type.") diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/functions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/functions.tsp index cad83db52fdc..51201f0aa33f 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/functions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/functions.tsp @@ -5,9 +5,9 @@ namespace Azure.OpenAI; using TypeSpec.Versioning; @doc(""" -A structure that specifies the exact name of a specific, request-provided function to use when processing a chat -completions operation. -""") + A structure that specifies the exact name of a specific, request-provided function to use when processing a chat + completions operation. + """) @added(ServiceApiVersions.v2023_07_01_Preview) model FunctionName { @doc("The name of the function to call.") @@ -15,23 +15,23 @@ model FunctionName { } @doc(""" -The collection of predefined behaviors for handling request-provided function information in a chat completions -operation. -""") + The collection of predefined behaviors for handling request-provided function information in a chat completions + operation. + """) @added(ServiceApiVersions.v2023_07_01_Preview) union FunctionCallPreset { string, @doc(""" - Specifies that the model may either use any of the functions provided in this chat completions request or - instead return a standard chat completions response as if no functions were provided. - """) + Specifies that the model may either use any of the functions provided in this chat completions request or + instead return a standard chat completions response as if no functions were provided. + """) auto: "auto", @doc(""" - Specifies that the model should not respond with a function call and should instead provide a standard chat - completions response. Response content may still be influenced by the provided function information. - """) + Specifies that the model should not respond with a function call and should instead provide a standard chat + completions response. Response content may still be influenced by the provided function information. + """) none: "none", } @@ -39,17 +39,17 @@ union FunctionCallPreset { alias FunctionCallConfig = FunctionCallPreset | FunctionName; @doc(""" -The definition of a caller-specified function that chat completions may invoke in response to matching user input. -""") + The definition of a caller-specified function that chat completions may invoke in response to matching user input. + """) @added(ServiceApiVersions.v2023_07_01_Preview) model FunctionDefinition { @doc("The name of the function to be called.") name: string; @doc(""" - A description of what the function does. The model will use this description when selecting the function and - interpreting its parameters. - """) + A description of what the function does. The model will use this description when selecting the function and + interpreting its parameters. + """) description?: string; #suppress "@azure-tools/typespec-azure-core/no-unknown" "External API shape takes an arbitrary json" @@ -64,10 +64,10 @@ model FunctionCall { name: string; @doc(""" - The arguments to call the function with, as generated by the model in JSON format. - Note that the model does not always generate valid JSON, and may hallucinate parameters - not defined by your function schema. Validate the arguments in your code before calling - your function. - """) + The arguments to call the function with, as generated by the model in JSON format. + Note that the model does not always generate valid JSON, and may hallucinate parameters + not defined by your function schema. Validate the arguments in your code before calling + your function. + """) arguments: string; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp index 2a9e7b295faf..8d45bd50a058 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp @@ -16,21 +16,22 @@ union ChatCompletionsToolSelectionPreset { string, @doc(""" - Specifies that the model may either use any of the tools provided in this chat completions request or - instead return a standard chat completions response as if no tools were provided. - """) + Specifies that the model may either use any of the tools provided in this chat completions request or + instead return a standard chat completions response as if no tools were provided. + """) auto: "auto", @doc(""" - Specifies that the model should not respond with a tool call and should instead provide a standard chat - completions response. Response content may still be influenced by the provided tool definitions. - """) + Specifies that the model should not respond with a tool call and should instead provide a standard chat + completions response. Response content may still be influenced by the provided tool definitions. + """) none: "none", } @discriminator("type") @doc("An abstract representation of an explicit, named tool selection to use for a chat completions request.") model ChatCompletionsNamedToolSelection { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; } @@ -59,14 +60,15 @@ model ChatCompletionsFunctionToolSelection { @doc("An abstract representation of a tool that can be used by the model to improve a chat completions response.") @added(ServiceApiVersions.v2024_02_15_Preview) model ChatCompletionsToolDefinition { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; } @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -The definition information for a chat completions function tool that can call a function in response to a tool call. -""") + The definition information for a chat completions function tool that can call a function in response to a tool call. + """) model ChatCompletionsFunctionToolDefinition extends ChatCompletionsToolDefinition { @doc("The object name, which is always 'function'.") @@ -80,11 +82,12 @@ model ChatCompletionsFunctionToolDefinition @discriminator("type") @doc(""" -An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested -chat completion. -""") + An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested + chat completion. + """) @added(ServiceApiVersions.v2024_02_15_Preview) model ChatCompletionsToolCall { + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The object type.") type: string; @@ -94,9 +97,9 @@ model ChatCompletionsToolCall { @added(ServiceApiVersions.v2024_02_15_Preview) @doc(""" -A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents -a function invocation needed for a subsequent chat completions request to resolve. -""") + A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents + a function invocation needed for a subsequent chat completions request to resolve. + """) model ChatCompletionsFunctionToolCall extends ChatCompletionsToolCall { @doc("The type of tool call, in this case always 'function'.") type: "function"; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp index e9e7034311da..eddaa1cb4b5a 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp @@ -11,10 +11,10 @@ using Azure.ClientGenerator.Core; namespace Azure.OpenAI; @doc(""" -The configuration information for an embeddings request. -Embeddings measure the relatedness of text strings and are commonly used for search, clustering, -recommendations, and other similar scenarios. -""") + The configuration information for an embeddings request. + Embeddings measure the relatedness of text strings and are commonly used for search, clustering, + recommendations, and other similar scenarios. + """) model EmbeddingsOptions { @doc(""" An identifier for the caller or end user of the operation. This may be used for tracking @@ -33,7 +33,7 @@ model EmbeddingsOptions { @doc(""" Input texts to get embeddings for, encoded as a an array of strings. Each input must not exceed 2048 tokens in length. - + Unless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space, as we have observed inferior results when newlines are present. """) @@ -67,10 +67,10 @@ union EmbeddingEncodingFormat { } @doc(""" -Representation of the response data from an embeddings request. -Embeddings measure the relatedness of text strings and are commonly used for search, clustering, -recommendations, and other similar scenarios. -""") + Representation of the response data from an embeddings request. + Embeddings measure the relatedness of text strings and are commonly used for search, clustering, + recommendations, and other similar scenarios. + """) model Embeddings { @doc("Embedding values for the prompts submitted in the request.") data: EmbeddingItem[]; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp index e0b920275934..b0619f8b0f5e 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp @@ -19,75 +19,75 @@ union ImageSize { string, @doc(""" - Very small image size of 256x256 pixels. - Only supported with dall-e-2 models. - """) + Very small image size of 256x256 pixels. + Only supported with dall-e-2 models. + """) size256x256: "256x256", @doc(""" - A smaller image size of 512x512 pixels. - Only supported with dall-e-2 models. - """) + A smaller image size of 512x512 pixels. + Only supported with dall-e-2 models. + """) size512x512: "512x512", @doc(""" - A standard, square image size of 1024x1024 pixels. - Supported by both dall-e-2 and dall-e-3 models. - """) + A standard, square image size of 1024x1024 pixels. + Supported by both dall-e-2 and dall-e-3 models. + """) @added(ServiceApiVersions.v2024_02_15_Preview) size1024x1024: "1024x1024", @doc(""" - A wider image size of 1024x1792 pixels. - Only supported with dall-e-3 models. - """) + A wider image size of 1024x1792 pixels. + Only supported with dall-e-3 models. + """) @added(ServiceApiVersions.v2024_02_15_Preview) size1792x1024: "1792x1024", @doc(""" - A taller image size of 1792x1024 pixels. - Only supported with dall-e-3 models. - """) + A taller image size of 1792x1024 pixels. + Only supported with dall-e-3 models. + """) @added(ServiceApiVersions.v2024_02_15_Preview) size1024x1792: "1024x1792", } @doc(""" -An image generation configuration that specifies how the model should prioritize quality, cost, and speed. -Only configurable with dall-e-3 models. -""") + An image generation configuration that specifies how the model should prioritize quality, cost, and speed. + Only configurable with dall-e-3 models. + """) @added(ServiceApiVersions.v2024_02_15_Preview) union ImageGenerationQuality { string, @doc(""" - Requests image generation with standard, balanced characteristics of quality, cost, and speed. - """) + Requests image generation with standard, balanced characteristics of quality, cost, and speed. + """) standard: "standard", @doc(""" - Requests image generation with higher quality, higher cost and lower speed relative to standard. - """) + Requests image generation with higher quality, higher cost and lower speed relative to standard. + """) hd: "hd", } @doc(""" -An image generation configuration that specifies how the model should incorporate realism and other visual characteristics. -Only configurable with dall-e-3 models. -""") + An image generation configuration that specifies how the model should incorporate realism and other visual characteristics. + Only configurable with dall-e-3 models. + """) @added(ServiceApiVersions.v2024_02_15_Preview) union ImageGenerationStyle { string, @doc(""" - Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics. - """) + Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics. + """) natural: "natural", @doc(""" - Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic - characteristics. - """) + Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic + characteristics. + """) vivid: "vivid", } @@ -107,27 +107,27 @@ union ImageGenerationResponseFormat { @added(ServiceApiVersions.v2023_06_01_Preview) model ImageGenerationOptions { @doc(""" - The model name or Azure OpenAI model deployment name to use for image generation. If not specified, dall-e-2 will be - inferred as a default. - """) + The model name or Azure OpenAI model deployment name to use for image generation. If not specified, dall-e-2 will be + inferred as a default. + """) `model`?: string; @doc("A description of the desired images.") prompt: string; @doc(""" - The number of images to generate. - Dall-e-2 models support values between 1 and 10. - Dall-e-3 models only support a value of 1. - """) + The number of images to generate. + Dall-e-2 models support values between 1 and 10. + Dall-e-3 models only support a value of 1. + """) @clientName("ImageCount", "csharp") n?: int32 = 1; @doc(""" - The desired dimensions for generated images. - Dall-e-2 models support 256x256, 512x512, or 1024x1024. - Dall-e-3 models support 1024x1024, 1792x1024, or 1024x1792. - """) + The desired dimensions for generated images. + Dall-e-2 models support 256x256, 512x512, or 1024x1024. + Dall-e-3 models support 1024x1024, 1792x1024, or 1024x1792. + """) size?: ImageSize = ImageSize.size1024x1024; @doc("The format in which image generation response items should be presented.") @@ -135,16 +135,16 @@ model ImageGenerationOptions { responseFormat?: ImageGenerationResponseFormat = ImageGenerationResponseFormat.url; @doc(""" - The desired image generation quality level to use. - Only configurable with dall-e-3 models. - """) + The desired image generation quality level to use. + Only configurable with dall-e-3 models. + """) @added(ServiceApiVersions.v2024_02_15_Preview) quality?: ImageGenerationQuality = ImageGenerationQuality.standard; @doc(""" - The desired image generation style to use. - Only configurable with dall-e-3 models. - """) + The desired image generation style to use. + Only configurable with dall-e-3 models. + """) @added(ServiceApiVersions.v2024_02_15_Preview) style?: ImageGenerationStyle = ImageGenerationStyle.vivid; @@ -156,32 +156,32 @@ model ImageGenerationOptions { @added(ServiceApiVersions.v2024_02_15_Preview) model ImageGenerationContentFilterResults { @doc(""" - Describes language related to anatomical organs and genitals, romantic relationships, - acts portrayed in erotic or affectionate terms, physical sexual acts, including - those portrayed as an assault or a forced sexual violent act against one’s will, - prostitution, pornography, and abuse. - """) + Describes language related to anatomical organs and genitals, romantic relationships, + acts portrayed in erotic or affectionate terms, physical sexual acts, including + those portrayed as an assault or a forced sexual violent act against one’s will, + prostitution, pornography, and abuse. + """) sexual?: ContentFilterResult; @doc(""" - Describes language related to physical actions intended to hurt, injure, damage, or - kill someone or something; describes weapons, etc. - """) + Describes language related to physical actions intended to hurt, injure, damage, or + kill someone or something; describes weapons, etc. + """) violence?: ContentFilterResult; @doc(""" - Describes language attacks or uses that include pejorative or discriminatory language - with reference to a person or identity group on the basis of certain differentiating - attributes of these groups including but not limited to race, ethnicity, nationality, - gender identity and expression, sexual orientation, religion, immigration status, ability - status, personal appearance, and body size. - """) + Describes language attacks or uses that include pejorative or discriminatory language + with reference to a person or identity group on the basis of certain differentiating + attributes of these groups including but not limited to race, ethnicity, nationality, + gender identity and expression, sexual orientation, religion, immigration status, ability + status, personal appearance, and body size. + """) hate?: ContentFilterResult; @doc(""" - Describes language related to physical actions intended to purposely hurt, injure, - or damage one’s body, or kill oneself. - """) + Describes language related to physical actions intended to purposely hurt, injure, + or damage one’s body, or kill oneself. + """) @encodedName("application/json", "self_harm") selfHarm?: ContentFilterResult; } @@ -204,9 +204,9 @@ model ImageGenerationPromptFilterResults { } @doc(""" -A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image -may be retrieved. -""") + A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image + may be retrieved. + """) @added(ServiceApiVersions.v2023_06_01_Preview) model ImageGenerationData { @doc("The URL that provides temporary access to download the generated image.") @@ -222,21 +222,21 @@ model ImageGenerationData { contentFilterResults?: ImageGenerationContentFilterResults; @doc(""" - The final prompt used by the model to generate the image. - Only provided with dall-3-models and only when revisions were made to the prompt. - """) + The final prompt used by the model to generate the image. + Only provided with dall-3-models and only when revisions were made to the prompt. + """) @added(ServiceApiVersions.v2024_02_15_Preview) @encodedName("application/json", "revised_prompt") revisedPrompt?: string; @doc(""" - Information about the content filtering category (hate, sexual, violence, self_harm), if - it has been detected, as well as the severity level (very_low, low, medium, high-scale - that determines the intensity and risk level of harmful content) and if it has been - filtered or not. Information about jailbreak content and profanity, if it has been detected, - and if it has been filtered or not. And information about customer block list, if it has - been filtered and its id. - """) + Information about the content filtering category (hate, sexual, violence, self_harm), if + it has been detected, as well as the severity level (very_low, low, medium, high-scale + that determines the intensity and risk level of harmful content) and if it has been + filtered or not. Information about jailbreak content and profanity, if it has been detected, + and if it has been filtered or not. And information about customer block list, if it has + been filtered and its id. + """) @added(ServiceApiVersions.v2024_02_15_Preview) @encodedName("application/json", "prompt_filter_results") promptFilterResults?: ImageGenerationPromptFilterResults; @@ -246,9 +246,9 @@ model ImageGenerationData { @added(ServiceApiVersions.v2023_06_01_Preview) model ImageGenerations { @doc(""" - A timestamp representing when this operation was started. - Expressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000. - """) + A timestamp representing when this operation was started. + Expressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000. + """) @clientName("createdAt", "java") @encode(DateTimeKnownEncoding.unixTimestamp, int32) created: utcDateTime; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp index 217c05759658..6a3fab3d6e9c 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp @@ -19,9 +19,9 @@ namespace Azure.OpenAI; #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "non-model response value needed" @doc(""" -Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the -written language corresponding to the language it was spoken in. -""") + Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the + written language corresponding to the language it was spoken in. + """) @added(ServiceApiVersions.v2024_02_15_Preview) @actionSeparator("/") @action("audio/transcriptions") @@ -35,9 +35,9 @@ op getAudioTranscriptionAsPlainText is Azure.Core.ResourceAction< #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" @doc(""" -Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the -written language corresponding to the language it was spoken in. -""") + Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the + written language corresponding to the language it was spoken in. + """) @added(ServiceApiVersions.v2024_02_15_Preview) @actionSeparator("/") @action("audio/transcriptions") diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp index 8c2b8adb5562..0f36637e5964 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp @@ -19,8 +19,8 @@ namespace Azure.OpenAI; #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "non-model response value needed" @doc(""" -Gets English language transcribed text and associated metadata from provided spoken audio data. -""") + Gets English language transcribed text and associated metadata from provided spoken audio data. + """) @added(ServiceApiVersions.v2024_02_15_Preview) @actionSeparator("/") @action("audio/translations") @@ -34,8 +34,8 @@ op getAudioTranslationAsPlainText is Azure.Core.ResourceAction< #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" @doc(""" -Gets English language transcribed text and associated metadata from provided spoken audio data. -""") + Gets English language transcribed text and associated metadata from provided spoken audio data. + """) @added(ServiceApiVersions.v2024_02_15_Preview) @actionSeparator("/") @action("audio/translations") diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp index 823f980fcde7..284b0842ca5d 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp @@ -15,10 +15,10 @@ using Azure.Core; namespace Azure.OpenAI; @doc(""" -Gets completions for the provided input prompts. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") + Gets completions for the provided input prompts. + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. + """) @actionSeparator("/") @action("completions") //@convenientAPI(true) op getCompletions is Azure.Core.ResourceAction< @@ -28,10 +28,10 @@ op getCompletions is Azure.Core.ResourceAction< >; @doc(""" -Gets chat completions for the provided chat messages. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") + Gets chat completions for the provided chat messages. + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. + """) @added(ServiceApiVersions.v2023_05_15) @actionSeparator("/") @action("chat/completions") //@convenientAPI(true) diff --git a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml index 33a2c0b7b7c9..774d75419735 100644 --- a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml +++ b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml @@ -13,6 +13,7 @@ options: emitter-output-dir: "{project-root}/../" output-file: "{azure-resource-provider-folder}/AzureOpenAI/inference/{version-status}/{version}/generated.json" azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" examples-directory: "{project-root}/examples" omit-unreachable-types: true "@azure-tools/typespec-csharp": diff --git a/specification/communication/Communication.JobRouter/models.tsp b/specification/communication/Communication.JobRouter/models.tsp index 66014395d3fd..c09a1ec53fde 100644 --- a/specification/communication/Communication.JobRouter/models.tsp +++ b/specification/communication/Communication.JobRouter/models.tsp @@ -380,13 +380,13 @@ model ClassificationPolicy { } @doc(""" -A rule of one of the following types: -StaticRule: A rule providing static rules that always return the same result, regardless of input. -DirectMapRule: A rule that return the same labels as the input labels. -ExpressionRule: A rule providing inline expression rules. -FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function. -WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol. -""") + A rule of one of the following types: + StaticRule: A rule providing static rules that always return the same result, regardless of input. + DirectMapRule: A rule that return the same labels as the input labels. + ExpressionRule: A rule providing inline expression rules. + FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function. + WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol. + """) @discriminator("kind") model RouterRule { @doc("The type discriminator describing a sub-type of RouterRule") @@ -590,11 +590,11 @@ model RouterJobAssignment { } @doc(""" -A matching mode of one of the following types: -QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued. -ScheduleAndSuspendMode: Used for scheduling jobs to be queued at a future time. At specified time, matching of a worker to the job will not start automatically. -SuspendMode: Used when matching workers to a job needs to be suspended. -""") + A matching mode of one of the following types: + QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued. + ScheduleAndSuspendMode: Used for scheduling jobs to be queued at a future time. At specified time, matching of a worker to the job will not start automatically. + SuspendMode: Used when matching workers to a job needs to be suspended. + """) @discriminator("kind") model JobMatchingMode { @doc("The type discriminator describing a sub-type of JobMatchingMode.") @@ -865,7 +865,7 @@ model ScoringRuleOptions { batchSize?: int32 = 20; @doc("List of extra parameters from a job that will be sent as part of the payload to scoring rule. If not set, a job's labels (sent in the payload as `job`) and a job's worker selectors (sent in the payload as `selectors`) are added to the payload of the scoring rule by default. Note: Worker labels are always sent with scoring payload.") - scoringParameters?: ScoringRuleParameterSelector[] = [ + scoringParameters?: ScoringRuleParameterSelector[] = #[ ScoringRuleParameterSelector.jobLabels, ScoringRuleParameterSelector.workerSelectors ]; diff --git a/specification/communication/Communication.JobRouter/tspconfig.yaml b/specification/communication/Communication.JobRouter/tspconfig.yaml index 2b99d766d271..e6cf699eae6a 100644 --- a/specification/communication/Communication.JobRouter/tspconfig.yaml +++ b/specification/communication/Communication.JobRouter/tspconfig.yaml @@ -23,6 +23,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" output-file: "{azure-resource-provider-folder}/JobRouter/{version-status}/{version}/communicationservicejobrouter.json" emitter-output-dir: "{project-root}/.." omit-unreachable-types: true diff --git a/specification/communication/Communication.Messages/tspconfig.yaml b/specification/communication/Communication.Messages/tspconfig.yaml index ac47a74e4762..f9604a3a266c 100644 --- a/specification/communication/Communication.Messages/tspconfig.yaml +++ b/specification/communication/Communication.Messages/tspconfig.yaml @@ -23,6 +23,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" output-file: "{azure-resource-provider-folder}/Messages/{version-status}/{version}/communicationservicesmessages.json" emitter-output-dir: "{project-root}/.." omit-unreachable-types: true diff --git a/specification/communitytraining/Community.Management/main.tsp b/specification/communitytraining/Community.Management/main.tsp index bf3d917bd6ba..2c2a9c763bc4 100644 --- a/specification/communitytraining/Community.Management/main.tsp +++ b/specification/communitytraining/Community.Management/main.tsp @@ -138,7 +138,12 @@ model CommunityTrainingProperties { @armResourceOperations interface CommunityTrainings { get is ArmResourceRead; - create is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + CommunityTraining, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchAsync< CommunityTraining, CommunityTrainingProperties diff --git a/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json b/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json index 45f86ef2438f..267b74e8889a 100644 --- a/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json +++ b/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json @@ -425,11 +425,7 @@ "properties": { "$ref": "#/definitions/CommunityTrainingProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "sku": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", diff --git a/specification/confidentialledger/Microsoft.ManagedCcf/service_state.tsp b/specification/confidentialledger/Microsoft.ManagedCcf/service_state.tsp index c9ddd22b76b8..0d84f59a9b4a 100644 --- a/specification/confidentialledger/Microsoft.ManagedCcf/service_state.tsp +++ b/specification/confidentialledger/Microsoft.ManagedCcf/service_state.tsp @@ -58,6 +58,7 @@ union NodeStatus { "Retired", } +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("Common type for attestation information, describing the cryptographically-endorsed claim of what code is executing, and what platform it is executing on. Derived types contain platform-specific details.") @discriminator("format") model QuoteInfo {} diff --git a/specification/containerservice/Fleet.Management/fleet.tsp b/specification/containerservice/Fleet.Management/fleet.tsp index a333c7d5b36e..df75bf9acedc 100644 --- a/specification/containerservice/Fleet.Management/fleet.tsp +++ b/specification/containerservice/Fleet.Management/fleet.tsp @@ -33,7 +33,7 @@ model Fleet is TrackedResource { #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "https://github.com/Azure/typespec-azure/issues/2840" @added(Versions.v2023_06_15_preview) @doc("Managed identity.") - identity?: Azure.ResourceManager.Foundations.ManagedServiceIdentity; + identity?: Azure.ResourceManager.Legacy.ManagedServiceIdentityV4; } @doc("Fleet properties.") @@ -154,7 +154,7 @@ model FleetPatch { #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "https://github.com/Azure/typespec-azure/issues/2840" @added(Versions.v2023_06_15_preview) @doc("Managed identity.") - identity?: Azure.ResourceManager.Foundations.ManagedServiceIdentity; + identity?: Azure.ResourceManager.Legacy.ManagedServiceIdentityV4; } @doc("One credential result item.") @@ -181,14 +181,17 @@ interface Fleets { @doc("Gets a Fleet.") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "must change at next update" #suppress "@azure-tools/typespec-azure-core/no-operation-id" "changing the operation-id on an existing operation is an SDK breaking change" @doc("Creates or updates a Fleet.") @operationId("Fleets_CreateOrUpdate") + @Azure.Core.useFinalStateVia("azure-async-operation") create is ArmResourceCreateOrUpdateAsync< Fleet, Azure.ResourceManager.Foundations.BaseParameters & IfMatchParameters & - IfNoneMatchParameters + IfNoneMatchParameters, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "Actual breaking change" diff --git a/specification/containerservice/Fleet.Management/fleetmember.tsp b/specification/containerservice/Fleet.Management/fleetmember.tsp index 6a954722b77c..970f6dd7cd42 100644 --- a/specification/containerservice/Fleet.Management/fleetmember.tsp +++ b/specification/containerservice/Fleet.Management/fleetmember.tsp @@ -76,11 +76,14 @@ union FleetMemberProvisioningState { interface FleetMembers { get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "must change at next release" + @Azure.Core.useFinalStateVia("azure-async-operation") create is ArmResourceCreateOrUpdateAsync< FleetMember, Azure.ResourceManager.Foundations.BaseParameters & IfMatchParameters & - IfNoneMatchParameters + IfNoneMatchParameters, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "Actual breaking change" diff --git a/specification/containerservice/Fleet.Management/update/common.tsp b/specification/containerservice/Fleet.Management/update/common.tsp index 1c78837a6ed1..258ff298c61a 100644 --- a/specification/containerservice/Fleet.Management/update/common.tsp +++ b/specification/containerservice/Fleet.Management/update/common.tsp @@ -4,14 +4,14 @@ using TypeSpec.OpenAPI; namespace Microsoft.ContainerService; @doc(""" -Defines the update sequence of the clusters via stages and groups. - -Stages within a run are executed sequentially one after another. -Groups within a stage are executed in parallel. -Member clusters within a group are updated sequentially one after another. - -A valid strategy contains no duplicate groups within or across stages. -""") + Defines the update sequence of the clusters via stages and groups. + + Stages within a run are executed sequentially one after another. + Groups within a stage are executed in parallel. + Member clusters within a group are updated sequentially one after another. + + A valid strategy contains no duplicate groups within or across stages. + """) model UpdateRunStrategy { @extension("x-ms-identifiers", ["name"]) @doc("The list of stages that compose this update run. Min size: 1.") diff --git a/specification/containerservice/Fleet.Management/update/run.tsp b/specification/containerservice/Fleet.Management/update/run.tsp index 659fede185b6..004f32fcca0c 100644 --- a/specification/containerservice/Fleet.Management/update/run.tsp +++ b/specification/containerservice/Fleet.Management/update/run.tsp @@ -51,14 +51,14 @@ model UpdateRunProperties { @doc(""" The resource id of the FleetUpdateStrategy resource to reference. - + When creating a new run, there are three ways to define a strategy for the run: 1. Define a new strategy in place: Set the "strategy" field. 2. Use an existing strategy: Set the "updateStrategyId" field. (since 2023-08-15-preview) 3. Use the default strategy to update all the members one by one: Leave both "updateStrategyId" and "strategy" unset. (since 2023-08-15-preview) - + Setting both "updateStrategyId" and "strategy" is invalid. - + UpdateRuns created by "updateStrategyId" snapshot the referenced UpdateStrategy at the time of creation and store it in the "strategy" field. Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. UpdateRunStrategy changes can be made directly on the "strategy" field before launching the UpdateRun. @@ -67,10 +67,10 @@ model UpdateRunProperties { updateStrategyId?: FleetUpdateStrategyResourceId; @doc(""" -The strategy defines the order in which the clusters will be updated. -If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. -The strategy of the UpdateRun can be modified until the run is started. -""") + The strategy defines the order in which the clusters will be updated. + If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. + The strategy of the UpdateRun can be modified until the run is started. + """) strategy?: UpdateRunStrategy; @doc("The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started.") @@ -314,10 +314,10 @@ model SkipTarget { type: TargetType; @doc(""" - The skip target's name. - To skip a member/group/stage, use the member/group/stage's name; - Tp skip an after stage wait, use the parent stage's name. - """) + The skip target's name. + To skip a member/group/stage, use the member/group/stage's name; + Tp skip an after stage wait, use the parent stage's name. + """) name: string; } @@ -334,11 +334,14 @@ model SkipProperties { interface UpdateRuns { get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE AT NEXT VERSION" + @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrUpdateAsync< UpdateRun, Azure.ResourceManager.Foundations.BaseParameters & IfMatchParameters & - IfNoneMatchParameters + IfNoneMatchParameters, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; #suppress "deprecated" "Existing API" diff --git a/specification/containerservice/Fleet.Management/update/strategy.tsp b/specification/containerservice/Fleet.Management/update/strategy.tsp index 87fe0259b543..6e44e7ee30ff 100644 --- a/specification/containerservice/Fleet.Management/update/strategy.tsp +++ b/specification/containerservice/Fleet.Management/update/strategy.tsp @@ -55,11 +55,14 @@ model FleetUpdateStrategyProperties { interface FleetUpdateStrategies { get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE AT NEXT API VERSION UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrUpdateAsync< FleetUpdateStrategy, Azure.ResourceManager.Foundations.BaseParameters & IfMatchParameters & - IfNoneMatchParameters + IfNoneMatchParameters, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; #suppress "deprecated" "Existing API" diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json index ac851bd682c4..787b575865e6 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json @@ -805,11 +805,7 @@ "properties": { "$ref": "#/definitions/FleetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -912,11 +908,7 @@ "properties": { "$ref": "#/definitions/FleetMemberProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json index 32b7be221206..bf1161cc3a11 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json @@ -1345,11 +1345,7 @@ "properties": { "$ref": "#/definitions/FleetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -1452,11 +1448,7 @@ "properties": { "$ref": "#/definitions/FleetMemberProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -1802,11 +1794,7 @@ "properties": { "$ref": "#/definitions/UpdateRunProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json index ac52d0f232dd..ea0d25f30e1d 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json @@ -1425,11 +1425,7 @@ "properties": { "$ref": "#/definitions/FleetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -1552,11 +1548,7 @@ "properties": { "$ref": "#/definitions/FleetMemberProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -2000,11 +1992,7 @@ "properties": { "$ref": "#/definitions/UpdateRunProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json index f747f3811aa2..783d024a09ab 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json @@ -1729,11 +1729,7 @@ "properties": { "$ref": "#/definitions/FleetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -1861,11 +1857,7 @@ "properties": { "$ref": "#/definitions/FleetMemberProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -2089,11 +2081,7 @@ "properties": { "$ref": "#/definitions/FleetUpdateStrategyProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -2421,11 +2409,7 @@ "properties": { "$ref": "#/definitions/UpdateRunProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json index 22140dbc468d..a83cfbde5750 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json @@ -1823,11 +1823,7 @@ "properties": { "$ref": "#/definitions/FleetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -1955,11 +1951,7 @@ "properties": { "$ref": "#/definitions/FleetMemberProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -2183,11 +2175,7 @@ "properties": { "$ref": "#/definitions/FleetUpdateStrategyProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -2595,11 +2583,7 @@ "properties": { "$ref": "#/definitions/UpdateRunProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json index d6c7e2156661..c184493e1f2d 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json @@ -1677,11 +1677,7 @@ "properties": { "$ref": "#/definitions/FleetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -1761,11 +1757,7 @@ "properties": { "$ref": "#/definitions/FleetMemberProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -1985,11 +1977,7 @@ "properties": { "$ref": "#/definitions/FleetUpdateStrategyProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -2305,11 +2293,7 @@ "properties": { "$ref": "#/definitions/UpdateRunProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2024-04-01/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2024-04-01/fleets.json index 1c2444f69b89..01ed08549633 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2024-04-01/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2024-04-01/fleets.json @@ -1807,11 +1807,7 @@ "properties": { "$ref": "#/definitions/FleetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -1939,11 +1935,7 @@ "properties": { "$ref": "#/definitions/FleetMemberProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -2167,11 +2159,7 @@ "properties": { "$ref": "#/definitions/FleetUpdateStrategyProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", @@ -2579,11 +2567,7 @@ "properties": { "$ref": "#/definitions/UpdateRunProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "eTag": { "type": "string", diff --git a/specification/containerstorage/ContainerStorage.Management/pool.tsp b/specification/containerstorage/ContainerStorage.Management/pool.tsp index 7bcdb9fbf61c..662e943c31e3 100644 --- a/specification/containerstorage/ContainerStorage.Management/pool.tsp +++ b/specification/containerstorage/ContainerStorage.Management/pool.tsp @@ -12,13 +12,18 @@ namespace Microsoft.ContainerStorage; @armResourceOperations interface Pools { get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @extension( "x-ms-long-running-operation-options", { `final-state-via`: "location", } ) - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Pool, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; delete is ArmResourceDeleteWithoutOkAsync; update is ArmResourcePatchAsync; listByResourceGroup is ArmResourceListByParent; @@ -187,7 +192,7 @@ model Encryption { @doc("The URI of the key vault.") keyVaultUri: string; - ...ManagedServiceIdentityProperty; + ...Legacy.ManagedServiceIdentityV4Property; } @doc("Elastic San Pool Properties") diff --git a/specification/containerstorage/ContainerStorage.Management/snapshot.tsp b/specification/containerstorage/ContainerStorage.Management/snapshot.tsp index bd864fb92543..ed79f69d3d59 100644 --- a/specification/containerstorage/ContainerStorage.Management/snapshot.tsp +++ b/specification/containerstorage/ContainerStorage.Management/snapshot.tsp @@ -12,13 +12,18 @@ namespace Microsoft.ContainerStorage; @armResourceOperations interface Snapshots { get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @extension( "x-ms-long-running-operation-options", { `final-state-via`: "location", } ) - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Snapshot, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; delete is ArmResourceDeleteWithoutOkAsync; listByPool is ArmResourceListByParent; } diff --git a/specification/containerstorage/ContainerStorage.Management/volume.tsp b/specification/containerstorage/ContainerStorage.Management/volume.tsp index ebd7e7977645..4187903a5615 100644 --- a/specification/containerstorage/ContainerStorage.Management/volume.tsp +++ b/specification/containerstorage/ContainerStorage.Management/volume.tsp @@ -12,13 +12,18 @@ namespace Microsoft.ContainerStorage; @armResourceOperations interface Volumes { get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @extension( "x-ms-long-running-operation-options", { `final-state-via`: "location", } ) - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Volume, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; delete is ArmResourceDeleteWithoutOkAsync; update is ArmResourcePatchAsync; listByPool is ArmResourceListByParent; diff --git a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json index a0b571348b7f..94ead5e8046e 100644 --- a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json +++ b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json @@ -1424,11 +1424,7 @@ "properties": { "$ref": "#/definitions/PoolProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1742,11 +1738,7 @@ "properties": { "$ref": "#/definitions/SnapshotProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1813,11 +1805,7 @@ "properties": { "$ref": "#/definitions/VolumeProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml index 34fc37ff279f..ce5527f45e35 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml +++ b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml @@ -13,6 +13,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/widgets.json" diff --git a/specification/databasewatcher/DatabaseWatcher.Management/baseTarget.tsp b/specification/databasewatcher/DatabaseWatcher.Management/baseTarget.tsp index 86698fa6d172..41140fbc6587 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/baseTarget.tsp +++ b/specification/databasewatcher/DatabaseWatcher.Management/baseTarget.tsp @@ -28,6 +28,7 @@ model Target is ProxyResource { name: string; } +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The generic properties of a target.") @discriminator("targetType") model TargetProperties { diff --git a/specification/databasewatcher/DatabaseWatcher.Management/sharedPrivateLinkResource.tsp b/specification/databasewatcher/DatabaseWatcher.Management/sharedPrivateLinkResource.tsp index 2537460d16d0..c34f20441d50 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/sharedPrivateLinkResource.tsp +++ b/specification/databasewatcher/DatabaseWatcher.Management/sharedPrivateLinkResource.tsp @@ -12,7 +12,12 @@ using TypeSpec.Rest; @armResourceOperations interface SharedPrivateLinkResources { get is ArmResourceRead; - create is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + SharedPrivateLinkResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; delete is ArmResourceDeleteWithoutOkAsync; listByParent is ArmResourceListByParent; } diff --git a/specification/databasewatcher/DatabaseWatcher.Management/watcher.tsp b/specification/databasewatcher/DatabaseWatcher.Management/watcher.tsp index 2f261c2e6eb8..4d90639e4cf3 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/watcher.tsp +++ b/specification/databasewatcher/DatabaseWatcher.Management/watcher.tsp @@ -40,7 +40,7 @@ model Watcher is TrackedResource { @segment("watchers") name: string; - ...ManagedServiceIdentityProperty; + ...Legacy.ManagedServiceIdentityV4Property; } @doc("The RP specific properties of the resource.") @@ -106,7 +106,12 @@ union KustoOfferingType { @armResourceOperations interface Watchers { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Watcher, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchAsync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json index f14d0a7c82a0..b0562b8ed9cb 100644 --- a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json +++ b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json @@ -1219,11 +1219,7 @@ "properties": { "$ref": "#/definitions/SharedPrivateLinkResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1486,11 +1482,7 @@ "properties": { "$ref": "#/definitions/TargetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1613,11 +1605,7 @@ "properties": { "$ref": "#/definitions/WatcherProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", diff --git a/specification/devcenter/DevCenter/DevBox/models.tsp b/specification/devcenter/DevCenter/DevBox/models.tsp index 93179a31531c..63b0321adbda 100644 --- a/specification/devcenter/DevCenter/DevBox/models.tsp +++ b/specification/devcenter/DevCenter/DevBox/models.tsp @@ -408,18 +408,18 @@ model Pool { imageReference?: ImageReference; @doc(""" -Indicates whether owners of Dev Boxes in this pool are local administrators on -the Dev Boxes. -""") + Indicates whether owners of Dev Boxes in this pool are local administrators on + the Dev Boxes. + """) localAdministrator?: LocalAdminStatus; @doc("Stop on disconnect configuration settings for Dev Boxes created in this pool.") stopOnDisconnect?: StopOnDisconnectConfiguration; @doc(""" -Overall health status of the Pool. Indicates whether or not the Pool is -available to create Dev Boxes. -""") + Overall health status of the Pool. Indicates whether or not the Pool is + available to create Dev Boxes. + """) healthStatus: PoolHealthStatus; @doc("Display name of the pool.") @@ -484,15 +484,15 @@ model ImageReference { @doc("Stop on disconnect configuration settings for Dev Boxes created in this pool.") model StopOnDisconnectConfiguration { @doc(""" -Indicates whether the feature to stop the devbox on disconnect once the grace -period has lapsed is enabled. -""") + Indicates whether the feature to stop the devbox on disconnect once the grace + period has lapsed is enabled. + """) status: StopOnDisconnectEnableStatus; @doc(""" -The specified time in minutes to wait before stopping a Dev Box once disconnect -is detected. -""") + The specified time in minutes to wait before stopping a Dev Box once disconnect + is detected. + """) gracePeriodMinutes?: int32; } @@ -575,9 +575,9 @@ model DevBox { provisioningState?: DevBoxProvisioningState; @doc(""" -The current action state of the Dev Box. This is state is based on previous -action performed by user. -""") + The current action state of the Dev Box. This is state is based on previous + action performed by user. + """) @visibility("read") actionState?: string; @@ -586,9 +586,9 @@ action performed by user. powerState?: PowerState; @doc(""" -A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. -00000000-0000-0000-0000-000000000000). -""") + A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. + 00000000-0000-0000-0000-000000000000). + """) @visibility("read") uniqueId?: Azure.Core.uuid; @@ -597,9 +597,9 @@ A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. error?: Azure.Core.Foundations.Error; @doc(""" -Azure region where this Dev Box is located. This will be the same region as the -Virtual Network it is attached to. -""") + Azure region where this Dev Box is located. This will be the same region as the + Virtual Network it is attached to. + """) @visibility("read") location?: Azure.Core.azureLocation; @@ -923,10 +923,10 @@ model CustomizationTaskListValidationError { @added(APIVersions.v2024_05_01_preview) model CustomizationGroup { @doc(""" - Tasks to apply. Note by default tasks are excluded from the response when - listing customization groups. To include them, use the `include=tasks` query - parameter. - """) + Tasks to apply. Note by default tasks are excluded from the response when + listing customization groups. To include them, use the `include=tasks` query + parameter. + """) tasks?: CustomizationTask[]; @doc("The unique URI of the customization group.") diff --git a/specification/devcenter/DevCenter/DevBox/routes.tsp b/specification/devcenter/DevCenter/DevBox/routes.tsp index 1d84033630ad..7b1b78069f00 100644 --- a/specification/devcenter/DevCenter/DevBox/routes.tsp +++ b/specification/devcenter/DevCenter/DevBox/routes.tsp @@ -265,9 +265,9 @@ interface DevBoxes { >; @doc(""" - Lists customization groups on the Dev Box. Listed customization groups exclude - task information unless specified via the include parameter. - """) + Lists customization groups on the Dev Box. Listed customization groups exclude + task information unless specified via the include parameter. + """) @added(APIVersions.v2024_05_01_preview) listCustomizationGroups is StandardResourceOperations.ResourceList< CustomizationGroup, @@ -279,8 +279,8 @@ interface DevBoxes { >; @doc(""" - Gets a customization group. - """) + Gets a customization group. + """) @added(APIVersions.v2024_05_01_preview) getCustomizationGroup is StandardResourceOperations.ResourceRead; @@ -309,9 +309,9 @@ interface DevBoxes { projectName: string; @doc(""" - The AAD object id of the user. If value is 'me', the identity is taken from the - authentication context. - """) + The AAD object id of the user. If value is 'me', the identity is taken from the + authentication context. + """) @maxLength(36) @minLength(2) @pattern("^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$") @@ -354,9 +354,9 @@ interface DevBoxes { projectName: string; @doc(""" - The AAD object id of the user. If value is 'me', the identity is taken from the - authentication context. - """) + The AAD object id of the user. If value is 'me', the identity is taken from the + authentication context. + """) @maxLength(36) @minLength(2) @pattern("^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$") diff --git a/specification/devcenter/DevCenter/DevCenter/routes.tsp b/specification/devcenter/DevCenter/DevCenter/routes.tsp index 8bbdeab5cd1d..b1fc6f9bcf21 100644 --- a/specification/devcenter/DevCenter/DevCenter/routes.tsp +++ b/specification/devcenter/DevCenter/DevCenter/routes.tsp @@ -32,9 +32,9 @@ interface DevCenter { projectName: string; @doc(""" - The AAD object id of the user. If value is 'me', the identity is taken from the - authentication context. - """) + The AAD object id of the user. If value is 'me', the identity is taken from the + authentication context. + """) @maxLength(36) @minLength(2) @pattern("^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$") diff --git a/specification/devcenter/DevCenter/Environments/models.tsp b/specification/devcenter/DevCenter/Environments/models.tsp index 42d07d34e076..06b7c1b03cef 100644 --- a/specification/devcenter/DevCenter/Environments/models.tsp +++ b/specification/devcenter/DevCenter/Environments/models.tsp @@ -225,9 +225,9 @@ alias EnvironmentUpdateProperties = { alias EnvironmentPatchProperties = { @doc(""" - The time the expiration date will be triggered (UTC), after which the - environment and associated resources will be deleted. - """) + The time the expiration date will be triggered (UTC), after which the + environment and associated resources will be deleted. + """) @added(APIVersions.v2024_02_01) expirationDate?: utcDateTime; }; @@ -401,15 +401,15 @@ model EnvironmentDefinitionParameter { default?: string; @doc(""" -A string of one of the basic JSON types (number, integer, array, object, -boolean, string). -""") + A string of one of the basic JSON types (number, integer, array, object, + boolean, string). + """) type: ParameterType; @doc(""" -Whether or not this parameter is read-only. If true, default should have a -value. -""") + Whether or not this parameter is read-only. If true, default should have a + value. + """) readOnly?: boolean; @doc("Whether or not this parameter is required.") @@ -439,10 +439,10 @@ model EnvironmentType { name: string; @doc(""" -Id of a subscription or management group that the environment type will be -mapped to. The environment's resources will be deployed into this subscription -or management group. -""") + Id of a subscription or management group that the environment type will be + mapped to. The environment's resources will be deployed into this subscription + or management group. + """) deploymentTargetId: string; @doc("Indicates whether this environment type is enabled for use in this project.") diff --git a/specification/devcenter/DevCenter/Environments/routes.tsp b/specification/devcenter/DevCenter/Environments/routes.tsp index 47970641d893..f88a5386ca96 100644 --- a/specification/devcenter/DevCenter/Environments/routes.tsp +++ b/specification/devcenter/DevCenter/Environments/routes.tsp @@ -385,9 +385,9 @@ interface Environments { environmentTypeName: string; @doc(""" - The AAD object id of the user. If value is 'me', the identity is taken from the - authentication context. - """) + The AAD object id of the user. If value is 'me', the identity is taken from the + authentication context. + """) @maxLength(36) @minLength(2) @pattern("^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$") diff --git a/specification/devcenter/DevCenter/shared/models.tsp b/specification/devcenter/DevCenter/shared/models.tsp index 5c11d664a453..e15a428d5b3e 100644 --- a/specification/devcenter/DevCenter/shared/models.tsp +++ b/specification/devcenter/DevCenter/shared/models.tsp @@ -70,9 +70,9 @@ model Project { description?: string; @doc(""" -When specified, indicates the maximum number of Dev Boxes a single user can -create across all pools in the project. -""") + When specified, indicates the maximum number of Dev Boxes a single user can + create across all pools in the project. + """) @minValue(0) maxDevBoxesPerUser?: int32; diff --git a/specification/devcenter/DevCenter/tspconfig.yaml b/specification/devcenter/DevCenter/tspconfig.yaml index 4036f7c677b4..4aec9f6a6a96 100644 --- a/specification/devcenter/DevCenter/tspconfig.yaml +++ b/specification/devcenter/DevCenter/tspconfig.yaml @@ -8,6 +8,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." output-file: "{azure-resource-provider-folder}/Microsoft.DevCenter/{version-status}/{version}/devcenter.json" examples-directory: "{project-root}/examples" diff --git a/specification/developersigning/DeveloperSigning/main.tsp b/specification/developersigning/DeveloperSigning/main.tsp index ec078c941043..89c0df419a51 100644 --- a/specification/developersigning/DeveloperSigning/main.tsp +++ b/specification/developersigning/DeveloperSigning/main.tsp @@ -150,9 +150,9 @@ model SignResult { signature?: bytes; @doc(""" -Signing certificate corresponding to the private key used to sign the requested -digest. -""") + Signing certificate corresponding to the private key used to sign the requested + digest. + """) signingCertificate?: bytes; } diff --git a/specification/developersigning/DeveloperSigning/tspconfig.yaml b/specification/developersigning/DeveloperSigning/tspconfig.yaml index 38bf662c7e2c..f1458d64cb5c 100644 --- a/specification/developersigning/DeveloperSigning/tspconfig.yaml +++ b/specification/developersigning/DeveloperSigning/tspconfig.yaml @@ -9,6 +9,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "examples" omit-unreachable-types: true diff --git a/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp b/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp index d47412e98703..6dbe9f00e252 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp @@ -120,7 +120,12 @@ model OwnCertificate { interface AssetEndpointProfiles { get is ArmResourceRead; - createOrReplace is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrReplace is ArmResourceCreateOrReplaceAsync< + AssetEndpointProfile, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchAsync< AssetEndpointProfile, diff --git a/specification/deviceregistry/DeviceRegistry.Management/assets.tsp b/specification/deviceregistry/DeviceRegistry.Management/assets.tsp index 155d378ccea6..d31b2560f6e9 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/assets.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/assets.tsp @@ -205,7 +205,12 @@ model AssetStatusError { interface Assets { get is ArmResourceRead; - createOrReplace is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrReplace is ArmResourceCreateOrReplaceAsync< + Asset, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchAsync; diff --git a/specification/deviceregistry/DeviceRegistry.Management/main.tsp b/specification/deviceregistry/DeviceRegistry.Management/main.tsp index b20e7ad8756f..5fb0dd46c348 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/main.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/main.tsp @@ -46,23 +46,8 @@ interface OperationStatus { provider: "Microsoft.DeviceRegistry", ...LocationParameter, - - @path - @segment("operationStatuses") - @minLength(1) - @doc("The ID of an ongoing async operation.") - @armCommonParameter( - "OperationIdParameter", - Azure.ResourceManager.CommonTypes.Versions.v3 - ) - @armCommonParameter( - "OperationIdParameter", - Azure.ResourceManager.CommonTypes.Versions.v4 - ) - @armCommonParameter( - "OperationIdParameter", - Azure.ResourceManager.CommonTypes.Versions.v5 - ) - operationId: string, + ...Foundations.OperationIdParameter, ): ArmResponse | ErrorResponse; } + +@@segment(OperationStatus.get::parameters.operationId, "operationStatuses"); diff --git a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json index 91e1f1a92e08..7af2954f4243 100644 --- a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json +++ b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json @@ -827,11 +827,7 @@ "properties": { "$ref": "#/definitions/AssetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -858,11 +854,7 @@ "properties": { "$ref": "#/definitions/AssetEndpointProfileProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp index 96d717c0973e..7ad4b1ced9e7 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp @@ -61,6 +61,7 @@ model PoolProperties { devCenterProjectResourceId: string; } +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("Defines the organization in which the pool will be used.") @discriminator("kind") model OrganizationProfile {} @@ -131,6 +132,7 @@ union AzureDevOpsPermissionType { "SpecificAccounts", } +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("Defines the type of fabric the agent will run on.") @discriminator("kind") model FabricProfile {} @@ -286,6 +288,7 @@ model NetworkProfile { subnetId: string; } +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @doc("The agent profile of the machines in the pool.") @discriminator("kind") model AgentProfile { @@ -398,7 +401,12 @@ interface Operations extends Azure.ResourceManager.Operations {} @armResourceOperations interface Pools { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Pool, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchAsync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json index 227e8c4736df..89f071f7e6e0 100644 --- a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json @@ -911,11 +911,7 @@ "properties": { "$ref": "#/definitions/ImageVersionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1105,11 +1101,7 @@ "properties": { "$ref": "#/definitions/PoolProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", @@ -1366,11 +1358,7 @@ "properties": { "$ref": "#/definitions/QuotaProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1451,11 +1439,7 @@ "properties": { "$ref": "#/definitions/ResourceDetailsObjectProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1571,11 +1555,7 @@ "properties": { "$ref": "#/definitions/ResourceSkuProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/edgezones/resource-manager/Microsoft.EdgeZones/preview/2024-04-01-preview/edgezones.json b/specification/edgezones/resource-manager/Microsoft.EdgeZones/preview/2024-04-01-preview/edgezones.json index 24673c025ff4..a8bad6587d4a 100644 --- a/specification/edgezones/resource-manager/Microsoft.EdgeZones/preview/2024-04-01-preview/edgezones.json +++ b/specification/edgezones/resource-manager/Microsoft.EdgeZones/preview/2024-04-01-preview/edgezones.json @@ -262,11 +262,7 @@ "properties": { "$ref": "#/definitions/ExtendedZoneProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp index 83ab45e40a9f..b7662f5bb55c 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp @@ -141,6 +141,7 @@ namespace Microsoft.EventGrid.SystemEvents { @discriminator("@odata.type") model MediaJobOutput { /** The discriminator for derived types. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" #suppress "@azure-tools/typespec-azure-core/casing-style" "Maintain compatibility with existing models." `@odata.type`: string; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml index d12042016bb8..b70a5107b6fc 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml @@ -15,6 +15,7 @@ options: omit-unreachable-types: false output-file: "{azure-resource-provider-folder}/Microsoft.EventGrid/{version-status}/{version}/SystemEvents.json" azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" "@azure-tools/typespec-python": package-pprint-name: '"Azure Event Grid System Events"' package-version: 4.12.0b1 diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml index 714857f61985..8689784d3655 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml @@ -15,6 +15,7 @@ options: omit-unreachable-types: true output-file: "{azure-resource-provider-folder}/Microsoft.EventGrid/{version-status}/{version}/EventGrid.json" azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" "@azure-tools/typespec-python": package-pprint-name: '"Azure Event Grid"' package-version: 4.20.0 diff --git a/specification/informatica/Informatica.DataManagement/main.tsp b/specification/informatica/Informatica.DataManagement/main.tsp index 72e6980addfc..5d4910d75a44 100644 --- a/specification/informatica/Informatica.DataManagement/main.tsp +++ b/specification/informatica/Informatica.DataManagement/main.tsp @@ -57,7 +57,12 @@ interface Organizations OrganizationProperties > { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + InformaticaOrganizationResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; delete is ArmResourceDeleteWithoutOkAsync; update is ArmCustomPatchSync< InformaticaOrganizationResource, @@ -83,7 +88,12 @@ interface Organizations interface ServerlessRuntimes extends ProxyResourceOperations { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + InformaticaServerlessRuntimeResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; delete is ArmResourceDeleteWithoutOkAsync; update is ArmCustomPatchSync< InformaticaServerlessRuntimeResource, @@ -623,7 +633,7 @@ union RuntimeType { model InformaticaOrganizationResourceUpdate is OptionalProperties>> { /** Patchable PropertieInformaticaOrganizationPropertiesUpdates of the Organization observability resource */ properties?: OrganizationPropertiesCustomUpdate; @@ -672,7 +682,7 @@ model CompanyDetailsUpdate model InformaticaServerlessRuntimeResourceUpdate is OptionalProperties>> { /** Patchable PropertieInformaticaOrganizationPropertiesUpdates of the Organization observability resource */ properties?: ServerlessRuntimePropertiesCustomUpdate; diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json index e56192027250..8ef8c019e494 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json @@ -1368,11 +1368,7 @@ "properties": { "$ref": "#/definitions/OrganizationProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1518,11 +1514,7 @@ "properties": { "$ref": "#/definitions/InformaticaServerlessRuntimeProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/dataset.tsp b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/dataset.tsp index 6fa191db96bb..aaa1467a4af4 100644 --- a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/dataset.tsp +++ b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/dataset.tsp @@ -66,7 +66,12 @@ model DatasetPropertyKey { @armResourceOperations interface Datasets { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Dataset, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmCustomPatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByInstance is ArmResourceListByParent; diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/instance.tsp b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/instance.tsp index e5b1bd1d0e8e..7d1ea14a8b4f 100644 --- a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/instance.tsp +++ b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/instance.tsp @@ -42,7 +42,12 @@ model InstanceProperties { @armResourceOperations interface Instances { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Instance, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmCustomPatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/pipeline.tsp b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/pipeline.tsp index a9604ac90e91..7217eb1e207e 100644 --- a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/pipeline.tsp +++ b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/pipeline.tsp @@ -80,7 +80,12 @@ model PipelineStage is Record { @armResourceOperations interface Pipelines { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Pipeline, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmCustomPatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByInstance is ArmResourceListByParent; diff --git a/specification/iotoperationsdataprocessor/resource-manager/Microsoft.IoTOperationsDataProcessor/preview/2023-10-04-preview/openapi.json b/specification/iotoperationsdataprocessor/resource-manager/Microsoft.IoTOperationsDataProcessor/preview/2023-10-04-preview/openapi.json index 2db1e360a21b..71af4a17cb5a 100644 --- a/specification/iotoperationsdataprocessor/resource-manager/Microsoft.IoTOperationsDataProcessor/preview/2023-10-04-preview/openapi.json +++ b/specification/iotoperationsdataprocessor/resource-manager/Microsoft.IoTOperationsDataProcessor/preview/2023-10-04-preview/openapi.json @@ -1039,11 +1039,7 @@ "properties": { "$ref": "#/definitions/DatasetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -1173,11 +1169,7 @@ "properties": { "$ref": "#/definitions/InstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -1253,11 +1245,7 @@ "properties": { "$ref": "#/definitions/PipelineProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp index 2a2ec6653290..e75e801e8293 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp @@ -38,7 +38,12 @@ interface Operations extends Azure.ResourceManager.Operations {} @armResourceOperations interface Mq { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + MqResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; @@ -49,7 +54,12 @@ interface Mq { @armResourceOperations interface Broker { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + BrokerResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; @@ -59,7 +69,12 @@ interface Broker { @armResourceOperations interface BrokerListener { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + BrokerListenerResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< BrokerListenerResource, BrokerListenerProperties @@ -72,7 +87,12 @@ interface BrokerListener { @armResourceOperations interface BrokerAuthentication { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + BrokerAuthenticationResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< BrokerAuthenticationResource, BrokerAuthenticationProperties @@ -85,7 +105,12 @@ interface BrokerAuthentication { @armResourceOperations interface BrokerAuthorization { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + BrokerAuthorizationResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< BrokerAuthorizationResource, BrokerAuthorizationProperties @@ -98,7 +123,12 @@ interface BrokerAuthorization { @armResourceOperations interface MqttBridgeConnector { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + MqttBridgeConnectorResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< MqttBridgeConnectorResource, MqttBridgeConnectorProperties @@ -111,7 +141,12 @@ interface MqttBridgeConnector { @armResourceOperations interface MqttBridgeTopicMap { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + MqttBridgeTopicMapResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< MqttBridgeTopicMapResource, MqttBridgeTopicMapProperties @@ -124,7 +159,12 @@ interface MqttBridgeTopicMap { @armResourceOperations interface DiagnosticService { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + DiagnosticServiceResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< DiagnosticServiceResource, DiagnosticServiceProperties @@ -137,7 +177,12 @@ interface DiagnosticService { @armResourceOperations interface DataLakeConnector { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + DataLakeConnectorResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< DataLakeConnectorResource, DataLakeConnectorProperties @@ -150,7 +195,12 @@ interface DataLakeConnector { @armResourceOperations interface DataLakeConnectorTopicMap { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + DataLakeTopicMapResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< DataLakeTopicMapResource, DataLakeConnectorTopicMapProperties @@ -163,7 +213,12 @@ interface DataLakeConnectorTopicMap { @armResourceOperations interface KafkaConnector { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + KafkaConnectorResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< KafkaConnectorResource, KafkaConnectorProperties @@ -176,7 +231,12 @@ interface KafkaConnector { @armResourceOperations interface KafkaConnectorTopicMap { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + KafkaTopicMapResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< KafkaTopicMapResource, KafkaTopicMapProperties diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/base.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/base.tsp index 7e2df9921356..e08683a47957 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/base.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/base.tsp @@ -118,10 +118,10 @@ model CertManagerIssuerRef { @doc("SANs for certificate.") model SanForCert { @doc("DNS SANs.") - dns: string[] = []; + dns: string[] = #[]; @doc("IP address SANs.") - ip: string[] = []; + ip: string[] = #[]; } @doc("Mqtt Protocol types") diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbroker.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbroker.tsp index 29be327356b0..3b60a89c2511 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbroker.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbroker.tsp @@ -679,7 +679,7 @@ model PrincipalDefinition { #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "existing API" @doc("A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.") @OpenAPI.extension("x-ms-identifiers", []) - attributes?: Record[] = []; + attributes?: Record[] = #[]; @doc("A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.") clientids?: string[]; diff --git a/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json b/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json index c6b62c125dfc..0d99a964e857 100644 --- a/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json +++ b/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json @@ -4396,11 +4396,7 @@ "properties": { "$ref": "#/definitions/BrokerAuthenticationProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -4681,11 +4677,7 @@ "properties": { "$ref": "#/definitions/BrokerAuthorizationProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -4943,11 +4935,7 @@ "properties": { "$ref": "#/definitions/BrokerListenerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -5221,11 +5209,7 @@ "properties": { "$ref": "#/definitions/BrokerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -5747,11 +5731,7 @@ "properties": { "$ref": "#/definitions/DataLakeConnectorProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -6103,11 +6083,7 @@ "properties": { "$ref": "#/definitions/DataLakeConnectorTopicMapProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -6428,11 +6404,7 @@ "properties": { "$ref": "#/definitions/DiagnosticServiceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -6845,11 +6817,7 @@ "properties": { "$ref": "#/definitions/KafkaConnectorProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -7451,11 +7419,7 @@ "properties": { "$ref": "#/definitions/KafkaTopicMapProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -7970,11 +7934,7 @@ "properties": { "$ref": "#/definitions/MqProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -8086,11 +8046,7 @@ "properties": { "$ref": "#/definitions/MqttBridgeConnectorProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", @@ -8508,11 +8464,7 @@ "properties": { "$ref": "#/definitions/MqttBridgeTopicMapProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocationProperty", diff --git a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/instance.tsp b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/instance.tsp index 2024510d4758..b7150ac379e9 100644 --- a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/instance.tsp +++ b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/instance.tsp @@ -60,7 +60,12 @@ model TargetSelectorProperties { @armResourceOperations interface Instances { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Instance, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmCustomPatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/solution.tsp b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/solution.tsp index a66741a1d9d5..32d72ed4b026 100644 --- a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/solution.tsp +++ b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/solution.tsp @@ -46,7 +46,12 @@ model SolutionProperties { @armResourceOperations interface Solutions { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Solution, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmCustomPatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/target.tsp b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/target.tsp index 2baa2f60e69b..d736a18ed658 100644 --- a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/target.tsp +++ b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/target.tsp @@ -76,7 +76,12 @@ model BindingProperties { @armResourceOperations interface Targets { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Target, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmCustomPatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/iotoperationsorchestrator/resource-manager/Microsoft.IoTOperationsOrchestrator/preview/2023-10-04-preview/openapi.json b/specification/iotoperationsorchestrator/resource-manager/Microsoft.IoTOperationsOrchestrator/preview/2023-10-04-preview/openapi.json index 0d7af904ca10..9ff3def3e27c 100644 --- a/specification/iotoperationsorchestrator/resource-manager/Microsoft.IoTOperationsOrchestrator/preview/2023-10-04-preview/openapi.json +++ b/specification/iotoperationsorchestrator/resource-manager/Microsoft.IoTOperationsOrchestrator/preview/2023-10-04-preview/openapi.json @@ -1139,11 +1139,7 @@ "properties": { "$ref": "#/definitions/InstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -1319,11 +1315,7 @@ "properties": { "$ref": "#/definitions/SolutionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -1407,11 +1399,7 @@ "properties": { "$ref": "#/definitions/TargetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/bgppeer.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/bgppeer.tsp index aff77c287bb5..8fbdcec221ff 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/bgppeer.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/bgppeer.tsp @@ -36,7 +36,12 @@ model BgpPeerProperties { @armResourceOperations(BgpPeer) interface BgpPeers { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + BgpPeer, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @sharedRoute @added(Versions.v2024_03_01) delete is ArmResourceDeleteSync; diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/loadbalancer.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/loadbalancer.tsp index e3dcd5ac2d5f..2e13742d83cc 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/loadbalancer.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/loadbalancer.tsp @@ -55,7 +55,12 @@ model LoadBalancerProperties { @armResourceOperations(LoadBalancer) interface LoadBalancers { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + LoadBalancer, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @sharedRoute @added(Versions.v2024_03_01) delete is ArmResourceDeleteSync; diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/storageclass.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/storageclass.tsp index e3842cf67377..c5569c2a21ba 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/storageclass.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/storageclass.tsp @@ -282,7 +282,12 @@ model StorageClassResource is ExtensionResource { @armResourceOperations(StorageClassResource) interface StorageClass { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + StorageClassResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmCustomPatchAsync< StorageClassResource, StorageClassResourceUpdate diff --git a/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/preview/2023-10-01-preview/kubernetesruntime.json b/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/preview/2023-10-01-preview/kubernetesruntime.json index 9c3b696670c1..49d50221a434 100644 --- a/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/preview/2023-10-01-preview/kubernetesruntime.json +++ b/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/preview/2023-10-01-preview/kubernetesruntime.json @@ -1029,11 +1029,7 @@ "properties": { "$ref": "#/definitions/BgpPeerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1186,11 +1182,7 @@ "properties": { "$ref": "#/definitions/LoadBalancerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1504,11 +1496,7 @@ "properties": { "$ref": "#/definitions/ServiceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1714,11 +1702,7 @@ "properties": { "$ref": "#/definitions/StorageClassProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/stable/2024-03-01/kubernetesruntime.json b/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/stable/2024-03-01/kubernetesruntime.json index 65aa9e986ce0..a890d90a7748 100644 --- a/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/stable/2024-03-01/kubernetesruntime.json +++ b/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/stable/2024-03-01/kubernetesruntime.json @@ -999,11 +999,7 @@ "properties": { "$ref": "#/definitions/BgpPeerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1156,11 +1152,7 @@ "properties": { "$ref": "#/definitions/LoadBalancerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1481,11 +1473,7 @@ "properties": { "$ref": "#/definitions/ServiceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1691,11 +1679,7 @@ "properties": { "$ref": "#/definitions/StorageClassProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp b/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp index d15a786a17fb..e02856267934 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp +++ b/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp @@ -41,13 +41,18 @@ model OrganizationResource is TrackedResource { @path name: string; - ...ManagedServiceIdentityProperty; + ...Legacy.ManagedServiceIdentityV4Property; } @armResourceOperations interface Organizations { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + OrganizationResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchAsync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json index 53e3bf9d2552..3bff98bd57a9 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json @@ -777,11 +777,7 @@ "properties": { "$ref": "#/definitions/LiftrBase.Data.OrganizationProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", diff --git a/specification/loadtestservice/LoadTestService.Management/routes.tsp b/specification/loadtestservice/LoadTestService.Management/routes.tsp index 1f340ab881b9..22f4caa9240c 100644 --- a/specification/loadtestservice/LoadTestService.Management/routes.tsp +++ b/specification/loadtestservice/LoadTestService.Management/routes.tsp @@ -43,6 +43,7 @@ interface LoadTests { LoadTestResource, LoadTestProperties, LroHeaders = ArmAsyncOperationHeader & + ArmLroLocationHeader & Azure.Core.Foundations.RetryAfterHeader >; diff --git a/specification/loadtestservice/LoadTestService/main.tsp b/specification/loadtestservice/LoadTestService/main.tsp index d5e4c74e2ed9..d10fd6ad079a 100644 --- a/specification/loadtestservice/LoadTestService/main.tsp +++ b/specification/loadtestservice/LoadTestService/main.tsp @@ -21,8 +21,8 @@ using Azure.Core; } ) @doc(""" -These APIs allow end users to create, view and run load tests using Azure Load Test Service. -""") + These APIs allow end users to create, view and run load tests using Azure Load Test Service. + """) namespace Microsoft.LoadTestService; @doc("Azure Load Testing API versions.") diff --git a/specification/loadtestservice/LoadTestService/models.tsp b/specification/loadtestservice/LoadTestService/models.tsp index 40177d088502..d9e53c981582 100644 --- a/specification/loadtestservice/LoadTestService/models.tsp +++ b/specification/loadtestservice/LoadTestService/models.tsp @@ -216,12 +216,12 @@ model Test { autoStopCriteria?: AutoStopCriteria; @doc(""" -Secrets can be stored in an Azure Key Vault or any other secret store. If the -secret is stored in an Azure Key Vault, the value should be the secret -identifier and the type should be AKV_SECRET_URI. If the secret is stored -elsewhere, the secret value should be provided directly and the type should be -SECRET_VALUE. -""") + Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE. + """) secrets?: Record; @doc("Certificates metadata.") @@ -285,11 +285,11 @@ model PassFailMetric { clientMetric?: PFMetrics; @doc(""" -The aggregation function to be applied on the client metric. Allowed functions -- ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, -‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, -‘count’ - for requests -""") + The aggregation function to be applied on the client metric. Allowed functions + - ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, + ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, + ‘count’ - for requests + """) aggregate?: PFAgFunc; @doc("The comparison operator. Supported types ‘>’, ‘<’ ") @@ -299,9 +299,9 @@ The aggregation function to be applied on the client metric. Allowed functions requestName?: string; @doc(""" -The value to compare with the client metric. Allowed values - ‘error : [0.0 , -100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms. -""") + The value to compare with the client metric. Allowed values - ‘error : [0.0 , + 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms. + """) value?: float64; @doc("Action taken after the threshold is met. Default is ‘continue’.") @@ -353,23 +353,23 @@ model AutoStopCriteria { @doc("Configurations for the load test.") model LoadTestConfiguration { @doc(""" -The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. -""") + The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. + """) engineInstances?: int32; #suppress "@azure-tools/typespec-azure-core/casing-style" "CSV is an abbervation and should be all caps" @doc(""" -If false, Azure Load Testing copies and processes your input files unmodified -across all test engine instances. If true, Azure Load Testing splits the CSV -input data evenly across all engine instances. If you provide multiple CSV -files, each file will be split evenly. -""") + If false, Azure Load Testing copies and processes your input files unmodified + across all test engine instances. If true, Azure Load Testing splits the CSV + input data evenly across all engine instances. If you provide multiple CSV + files, each file will be split evenly. + """) splitAllCSVs?: boolean = false; @doc(""" -If true, optionalLoadTestConfig is required and JMX script for the load test is -not required to upload. -""") + If true, optionalLoadTestConfig is required and JMX script for the load test is + not required to upload. + """) quickStartTest?: boolean = false; @doc("Configuration for quick load test") @@ -383,15 +383,15 @@ not required to upload. @doc("Region distribution configuration for the load test.") model RegionalConfiguration { @doc(""" - The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. -""") + The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. + """) engineInstances: int32; @doc(""" -Azure region name. -The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". -The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. -""") + Azure region name. + The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". + The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. + """) region: string; } @@ -473,10 +473,10 @@ model FileInfo { @doc("Test app components") model TestAppComponents { @doc(""" -Azure resource collection { resource id (fully qualified resource Id e.g -subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) -: resource object } -""") + Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object } + """) components: Record; @doc("Test identifier") @@ -487,12 +487,12 @@ subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/lo } @doc(""" -An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource) -""") + An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource) + """) model AppComponent { @doc(""" -fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} -""") + fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} + """) @visibility("read") resourceId: string; @@ -524,20 +524,20 @@ model TestServerMetricConfig { testId?: string; @doc(""" -Azure resource metrics collection {metric id : metrics object} (Refer : -https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition -for metric id). -""") + Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id). + """) metrics: Record; ...SystemMetaData; } @doc(""" -Associated metric definition for particular metrics of the azure resource ( -Refer : -https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). -""") + Associated metric definition for particular metrics of the azure resource ( + Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + """) model ResourceMetric { @doc("Unique name for metric.") @visibility("read") @@ -578,12 +578,12 @@ model TestRun { autoStopCriteria?: AutoStopCriteria; @doc(""" -Secrets can be stored in an Azure Key Vault or any other secret store. If the -secret is stored in an Azure Key Vault, the value should be the secret -identifier and the type should be AKV_SECRET_URI. If the secret is stored -elsewhere, the secret value should be provided directly and the type should be -SECRET_VALUE. -""") + Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE. + """) secrets?: Record; @doc("Certificates metadata") @@ -597,18 +597,18 @@ SECRET_VALUE. errorDetails?: ErrorDetails[]; @doc(""" -Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run. -The sampler name is the same as the name mentioned in the test script. -Sampler name "Total" represents the aggregated statistics of all the samplers. -""") + Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run. + The sampler name is the same as the name mentioned in the test script. + Sampler name "Total" represents the aggregated statistics of all the samplers. + """) @visibility("read") testRunStatistics?: Record; @doc(""" -Regional statistics. Key is the Azure region name and value is the test run statistics. -The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". -The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. -""") + Regional statistics. Key is the Azure region name and value is the test run statistics. + The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". + The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. + """) @visibility("read") @added(APIVersions.v2024_03_01_preview) regionalStatistics?: Record; @@ -853,9 +853,9 @@ model MetricDefinition { unit?: MetricUnit; @doc(""" -Metric availability specifies the time grain (aggregation interval or -frequency). -""") + Metric availability specifies the time grain (aggregation interval or + frequency). + """) metricAvailabilities?: MetricAvailability[]; } @@ -871,20 +871,20 @@ model NameAndDesc { @doc("Metric availability specifies the time grain (aggregation interval or frequency)") model MetricAvailability { @doc(""" -The time grain specifies the aggregation interval for the metric. Expressed as -a duration 'PT1M', 'PT1H', etc. -""") + The time grain specifies the aggregation interval for the metric. Expressed as + a duration 'PT1M', 'PT1H', etc. + """) timeGrain?: TimeGrain; } @doc("Filters to fetch the set of metric.") model MetricRequestPayload { @doc(""" -Get metrics for specific dimension values. Example: Metric contains dimension -like SamplerName, Error. To retrieve all the time series data where SamplerName -is equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be -{\"SamplerName\", [\"HTTPRequest1\", \"HTTPRequest2\"} -""") + Get metrics for specific dimension values. Example: Metric contains dimension + like SamplerName, Error. To retrieve all the time series data where SamplerName + is equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be + {\"SamplerName\", [\"HTTPRequest1\", \"HTTPRequest2\"} + """) filters?: DimensionFilter[]; } @@ -958,8 +958,8 @@ model MetricDimensionsRequest { metricNamespace: string; @doc(""" - The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. - """) + The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. + """) @query @clientName("time_interval", "python") timespan: string; @@ -968,10 +968,10 @@ model MetricDimensionsRequest { @doc("Test run app component") model TestRunAppComponents { @doc(""" -Azure resource collection { resource id (fully qualified resource Id e.g -subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) -: resource object } -""") + Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object } + """) components: Record; @doc("Test run identifier") @@ -988,10 +988,10 @@ model TestRunServerMetricConfig { testRunId?: string; @doc(""" -Azure resource metrics collection {metric id : metrics object} (Refer : -https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition -for metric id). -""") + Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id). + """) metrics?: Record; ...SystemMetaData; @@ -1000,11 +1000,11 @@ for metric id). @doc("Query parameters for list test run operation") model OldTestRunIdQueryParam { @doc(""" -Existing test run identifier that should be rerun, if this is provided, the -test will run with the JMX file, configuration and app components from the -existing test run. You can override the configuration values for new test run -in the request body. -""") + Existing test run identifier that should be rerun, if this is provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. + """) @query oldTestRunId?: string; } @@ -1012,17 +1012,17 @@ in the request body. @doc("Parameters for list test run operation") model ListTestRunQueryParams { @doc(""" -Sort on the supported fields in (field asc/desc) format. eg: executedDateTime -asc. Supported fields - executedDateTime -""") + Sort on the supported fields in (field asc/desc) format. eg: executedDateTime + asc. Supported fields - executedDateTime + """) @query orderby?: string; @doc(""" -Prefix based, case sensitive search on searchable fields - description, -executedUser. For example, to search for a test run, with description 500 VUs, -the search parameter can be 500. -""") + Prefix based, case sensitive search on searchable fields - description, + executedUser. For example, to search for a test run, with description 500 VUs, + the search parameter can be 500. + """) @query search?: string; @@ -1050,29 +1050,29 @@ the search parameter can be 500. @doc("Parameters for list test operation") model ListTestQueryParams { @doc(""" -Sort on the supported fields in (field asc/desc) format. eg: -lastModifiedDateTime asc. Supported fields - lastModifiedDateTime -""") + Sort on the supported fields in (field asc/desc) format. eg: + lastModifiedDateTime asc. Supported fields - lastModifiedDateTime + """) @query orderby?: string; @doc(""" -Prefix based, case sensitive search on searchable fields - displayName, -createdBy. For example, to search for a test, with display name is Login Test, -the search parameter can be Login. -""") + Prefix based, case sensitive search on searchable fields - displayName, + createdBy. For example, to search for a test, with display name is Login Test, + the search parameter can be Login. + """) @query search?: string; @doc(""" -Start DateTime(RFC 3339 literal format) of the last updated time range to filter tests. -""") + Start DateTime(RFC 3339 literal format) of the last updated time range to filter tests. + """) @query lastModifiedStartTime?: utcDateTime; @doc(""" -End DateTime(RFC 3339 literal format) of the last updated time range to filter tests. -""") + End DateTime(RFC 3339 literal format) of the last updated time range to filter tests. + """) @query lastModifiedEndTime?: utcDateTime; diff --git a/specification/loadtestservice/LoadTestService/routes.tsp b/specification/loadtestservice/LoadTestService/routes.tsp index 0992853d9739..9b6118b7dfc9 100644 --- a/specification/loadtestservice/LoadTestService/routes.tsp +++ b/specification/loadtestservice/LoadTestService/routes.tsp @@ -36,13 +36,13 @@ interface LoadTestAdministration { getTest is StandardResourceOperations.ResourceRead; @summary(""" -Get all load tests by the fully qualified resource Id e.g -subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. -""") + Get all load tests by the fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + """) @doc(""" -Get all load tests by the fully qualified resource Id e.g -subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. -""") + Get all load tests by the fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + """) listTests is StandardResourceOperations.ResourceList< Test, ListQueryParametersTrait @@ -51,15 +51,15 @@ subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/lo #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Our operation is not following the standard put behavior https://github.com/Azure/typespec-azure/issues/3743" #suppress "@azure-tools/typespec-azure-core/byos" "It is limiting for users to have storage first before creating a load test also it will be breaking change for us." @summary(""" -Upload input file for a given test Id. File size can't be more than 50 MB. -Existing file with same name for the given test will be overwritten. File -should be provided in the request body as application/octet-stream. -""") + Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + """) @doc(""" -Upload input file for a given test Id. File size can't be more than 50 MB. -Existing file with same name for the given test will be overwritten. File -should be provided in the request body as application/octet-stream. -""") + Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + """) @route("/tests/{testId}/files/{fileName}") @put uploadTestFile is Azure.Core.Foundations.Operation< @@ -69,9 +69,9 @@ should be provided in the request body as application/octet-stream. contentType: "application/octet-stream"; @doc(""" -Unique name for the load test, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -117,9 +117,9 @@ numeric, underscore or hyphen characters. contentType: "application/merge-patch+json"; @doc(""" -Unique name for the load test, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -141,9 +141,9 @@ numeric, underscore or hyphen characters. getAppComponents is Azure.Core.Foundations.Operation< { @doc(""" -Unique name for the load test, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -165,9 +165,9 @@ numeric, underscore or hyphen characters. contentType: "application/merge-patch+json"; @doc(""" -Unique name for the load test, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -189,9 +189,9 @@ numeric, underscore or hyphen characters. getServerMetricsConfig is Azure.Core.Foundations.Operation< { @doc(""" -Unique name for the load test, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -245,9 +245,9 @@ interface LoadTestRun { listMetricNamespaces is Azure.Core.Foundations.Operation< { @doc(""" -Unique name for the load test run, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -265,9 +265,9 @@ numeric, underscore or hyphen characters. listMetricDefinitions is Azure.Core.Foundations.Operation< { @doc(""" -Unique name for the load test run, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -289,9 +289,9 @@ numeric, underscore or hyphen characters. listMetrics is Azure.Core.Foundations.Operation< { @doc(""" -Unique name for the load test run, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -318,9 +318,9 @@ numeric, underscore or hyphen characters. listMetricDimensionValues is Azure.Core.Foundations.Operation< { @doc(""" -Unique name for the load test run, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -348,9 +348,9 @@ numeric, underscore or hyphen characters. contentType: "application/merge-patch+json"; @doc(""" -Unique Id for the load test run, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -366,21 +366,21 @@ numeric, underscore or hyphen characters. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @summary(""" -Get associated app component (collection of azure resources) for the given test -run. -""") + Get associated app component (collection of azure resources) for the given test + run. + """) @doc(""" -Get associated app component (collection of azure resources) for the given test -run. -""") + Get associated app component (collection of azure resources) for the given test + run. + """) @route("/test-runs/{testRunId}/app-components") @get getAppComponents is Azure.Core.Foundations.Operation< { @doc(""" -Unique name for the load test run, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -402,9 +402,9 @@ numeric, underscore or hyphen characters. contentType: "application/merge-patch+json"; @doc(""" -Unique Id for the load test run, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) @@ -426,9 +426,9 @@ numeric, underscore or hyphen characters. getServerMetricsConfig is Azure.Core.Foundations.Operation< { @doc(""" -Unique name for the load test run, must contain only lower-case alphabetic, -numeric, underscore or hyphen characters. -""") + Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. + """) @path @maxLength(50) @minLength(2) diff --git a/specification/loadtestservice/LoadTestService/tspconfig.yaml b/specification/loadtestservice/LoadTestService/tspconfig.yaml index 672a679be2ab..520158683e57 100644 --- a/specification/loadtestservice/LoadTestService/tspconfig.yaml +++ b/specification/loadtestservice/LoadTestService/tspconfig.yaml @@ -21,6 +21,7 @@ options: emitter-output-dir: "{project-root}/../" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/loadtestservice.json" azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" examples-directory: ./examples omit-unreachable-types: true "@azure-tools/typespec-python": diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json index 6a4534491abc..deefcea56e76 100644 --- a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json @@ -481,6 +481,10 @@ "type": "string", "description": "A link to the status monitor" }, + "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", @@ -769,11 +773,7 @@ "properties": { "$ref": "#/definitions/LoadTestProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", @@ -949,11 +949,7 @@ "properties": { "$ref": "#/definitions/QuotaResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/machinelearning/Azure.AI.ChatProtocol/models/common.tsp b/specification/machinelearning/Azure.AI.ChatProtocol/models/common.tsp index 681e4c5401e9..e1d096d3fa7d 100644 --- a/specification/machinelearning/Azure.AI.ChatProtocol/models/common.tsp +++ b/specification/machinelearning/Azure.AI.ChatProtocol/models/common.tsp @@ -33,9 +33,9 @@ union ChatRole { model ContextProperty { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Protocol defines the type as Record" @doc(""" - Context allows the chat app to receive extra parameters from the client, such as temperature, functions, or - customer_info. These parameters are specific to the chat app and not understood by the generic clients. - """) + Context allows the chat app to receive extra parameters from the client, such as temperature, functions, or + customer_info. These parameters are specific to the chat app and not understood by the generic clients. + """) context?: Record; } @@ -43,11 +43,11 @@ model ContextProperty { model StateProperty { #suppress "@azure-tools/typespec-azure-core/no-unknown" "The protocol defines these as any (object/scalar) for now" @doc(""" - Field that allows the chat app to store and retrieve data, the structure of such data is dependant on the backend - being used. The client must send back the data in this field unchanged in subsequent requests, until the chat app - sends a new one. The data in this field can be used to implement stateful services, such as remembering previous - conversations or user preferences. - """) + Field that allows the chat app to store and retrieve data, the structure of such data is dependant on the backend + being used. The client must send back the data in this field unchanged in subsequent requests, until the chat app + sends a new one. The data in this field can be used to implement stateful services, such as remembering previous + conversations or user preferences. + """) sessionState?: unknown; } diff --git a/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml b/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml index 582f1e520dc4..ae4caf53f776 100644 --- a/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml +++ b/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml @@ -12,6 +12,7 @@ options: emitter-output-dir: "{project-root}/../" output-file: "{azure-resource-provider-folder}/Azure.AI.ChatProtocol/{version-status}/{version}/generated.json" azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" examples-directory: examples omit-unreachable-types: true "@azure-tools/typespec-csharp": diff --git a/specification/machinelearningservices/AzureAI.Assets/main.tsp b/specification/machinelearningservices/AzureAI.Assets/main.tsp index afdfc49a3a5b..561830ad433b 100644 --- a/specification/machinelearningservices/AzureAI.Assets/main.tsp +++ b/specification/machinelearningservices/AzureAI.Assets/main.tsp @@ -27,8 +27,8 @@ using Azure.Core.Traits; "Machinelearning Services Asset APIs", { @doc(""" -Supported Azure-AI asset endpoints. -""") + Supported Azure-AI asset endpoints. + """) endpoint: url, @doc("The ID of the target subscription.") diff --git a/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml b/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml index 3a8f06dc8c95..8b6fccf845f6 100644 --- a/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml +++ b/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml @@ -7,6 +7,7 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azure-ai-assets.json" examples-directory: "{project-root}/examples" "@azure-tools/typespec-python": diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/mobilepacketcore.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/mobilepacketcore.json index 090f7ccd286c..d435d26ad281 100644 --- a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/mobilepacketcore.json +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/mobilepacketcore.json @@ -2357,11 +2357,7 @@ "properties": { "$ref": "#/definitions/AmfDeploymentResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -2504,11 +2500,7 @@ "properties": { "$ref": "#/definitions/ClusterServiceResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -2705,11 +2697,7 @@ "properties": { "$ref": "#/definitions/NrfDeploymentResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -2801,11 +2789,7 @@ "properties": { "$ref": "#/definitions/NssfDeploymentResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -2897,11 +2881,7 @@ "properties": { "$ref": "#/definitions/ObservabilityServiceResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3116,11 +3096,7 @@ "properties": { "$ref": "#/definitions/SmfDeploymentResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3212,11 +3188,7 @@ "properties": { "$ref": "#/definitions/UpfDeploymentResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp index 20ef9365bcd5..3ccc13b563ad 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp @@ -37,7 +37,9 @@ interface FirewallRules { /** Gets information about a mongo cluster firewall rule. */ get is ArmResourceRead; /** Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. */ + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST REMOVE AT NEXT API VERSION UPDATE" #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "Need to support existing 202 response for PUT operations" + @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrReplaceAsync< FirewallRule, Response = ArmAcceptedLroResponse<"Resource operation accepted."> | ArmResourceUpdatedResponse | ArmResourceCreatedResponse< diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/MongoCluster.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/MongoCluster.tsp index 2949ec5c2c85..e024ef88aa50 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/MongoCluster.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/MongoCluster.tsp @@ -26,7 +26,12 @@ interface MongoClusters { /** Gets information about a mongo cluster. */ get is ArmResourceRead; /** Create or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH. */ - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + MongoCluster, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition. */ update is ArmResourcePatchAsync; /** Deletes a mongo cluster. */ diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp index 42bdf34f97de..e7656b6c355c 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp @@ -17,7 +17,9 @@ interface PrivateEndpointConnections { /** Get a specific private connection */ get is ArmResourceRead; /** Create a Private endpoint connection */ + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST REMOVE AT NEXT API VERSION UPDATE" #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "Need to support existing 202 response for PUT operations" + @Azure.Core.useFinalStateVia("azure-async-operation") create is ArmResourceCreateOrReplaceAsync< PrivateEndpointConnectionResource, Response = ArmAcceptedLroResponse<"Resource operation accepted."> | ArmResourceUpdatedResponse | ArmResourceCreatedResponse< diff --git a/specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json b/specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json index 8926b7ebe439..ea08773fcbe3 100644 --- a/specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json +++ b/specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json @@ -1119,21 +1119,6 @@ } }, "definitions": { - "Azure.ResourceManager.PrivateEndpointConnection": { - "type": "object", - "description": "The private endpoint connection resource", - "properties": { - "properties": { - "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", - "description": "The private endpoint connection properties" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, "ConnectionString": { "type": "object", "description": "Connection string for the mongo cluster", @@ -1181,11 +1166,7 @@ "properties": { "$ref": "#/definitions/FirewallRuleProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1262,11 +1243,7 @@ "properties": { "$ref": "#/definitions/MongoClusterProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1373,7 +1350,7 @@ "type": "array", "description": "List of private endpoint connections.", "items": { - "$ref": "#/definitions/Azure.ResourceManager.PrivateEndpointConnection" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" }, "readOnly": true } @@ -1578,11 +1555,7 @@ "properties": { "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1619,11 +1592,7 @@ "properties": { "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/monitor/Microsoft.Monitor/typespec/azureMonitorWorkspace.tsp b/specification/monitor/Microsoft.Monitor/typespec/azureMonitorWorkspace.tsp index f394158e6235..d02420de7cfc 100644 --- a/specification/monitor/Microsoft.Monitor/typespec/azureMonitorWorkspace.tsp +++ b/specification/monitor/Microsoft.Monitor/typespec/azureMonitorWorkspace.tsp @@ -9,7 +9,6 @@ using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.Core; using Azure.ResourceManager; -using Azure.ResourceManager.Private; using OpenAPI; namespace Microsoft.Monitor; @@ -88,8 +87,13 @@ union PublicNetworkAccess { interface AzureMonitorWorkspaces { @doc("Returns the specific Azure Monitor workspace") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("Create or update a workspace") - createOrUpdate is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + AzureMonitorWorkspace, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("Updates part of a workspace") update is ArmResourcePatchSync< AzureMonitorWorkspace, diff --git a/specification/monitor/Microsoft.Monitor/typespec/pipelineGroup.tsp b/specification/monitor/Microsoft.Monitor/typespec/pipelineGroup.tsp index ff9e1df1fac4..0ceb17c19270 100644 --- a/specification/monitor/Microsoft.Monitor/typespec/pipelineGroup.tsp +++ b/specification/monitor/Microsoft.Monitor/typespec/pipelineGroup.tsp @@ -16,7 +16,6 @@ using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.Core; using Azure.ResourceManager; -using Azure.ResourceManager.Private; using OpenAPI; namespace Microsoft.Monitor; @@ -246,8 +245,13 @@ interface PipelineGroups { @doc("Returns the specific pipeline group instance.") get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("Create or update a pipeline group instance.") - createOrUpdate is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + PipelineGroup, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("Delete a pipeline group instance.") delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/monitor/Microsoft.Monitor/typespec/service.tsp b/specification/monitor/Microsoft.Monitor/typespec/service.tsp index 0cffc4c28b64..3313dfeee219 100644 --- a/specification/monitor/Microsoft.Monitor/typespec/service.tsp +++ b/specification/monitor/Microsoft.Monitor/typespec/service.tsp @@ -24,6 +24,7 @@ namespace Microsoft.Monitor; @doc("Microsoft.Monitor Versions") enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v4) @doc("API Version 2023-10-01-preview") `2023-10-01-preview`, } diff --git a/specification/monitor/resource-manager/Microsoft.Monitor/preview/2023-10-01-preview/azuremonitor.json b/specification/monitor/resource-manager/Microsoft.Monitor/preview/2023-10-01-preview/azuremonitor.json index c15f4d78e7d5..9692991c5239 100644 --- a/specification/monitor/resource-manager/Microsoft.Monitor/preview/2023-10-01-preview/azuremonitor.json +++ b/specification/monitor/resource-manager/Microsoft.Monitor/preview/2023-10-01-preview/azuremonitor.json @@ -59,20 +59,20 @@ "description": "List the operations for the provider", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -95,10 +95,10 @@ "description": "Lists all workspaces in the specified subscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -111,7 +111,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -134,10 +134,10 @@ "description": "Lists all workspaces in the specified subscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -150,7 +150,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -173,13 +173,13 @@ "description": "Lists all workspaces in the specified resource group", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -192,7 +192,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -215,13 +215,13 @@ "description": "Returns the specific Azure Monitor workspace", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "azureMonitorWorkspaceName", @@ -242,7 +242,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -260,13 +260,13 @@ "description": "Create or update a workspace", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "azureMonitorWorkspaceName", @@ -309,7 +309,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -331,13 +331,13 @@ "description": "Updates part of a workspace", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "azureMonitorWorkspaceName", @@ -367,7 +367,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -385,13 +385,13 @@ "description": "Delete a workspace", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "azureMonitorWorkspaceName", @@ -423,7 +423,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -447,13 +447,13 @@ "description": "Lists all workspaces in the specified resource group", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -466,7 +466,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -489,13 +489,13 @@ "description": "Returns the specific pipeline group instance.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "pipelineGroupName", @@ -516,7 +516,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -534,13 +534,13 @@ "description": "Create or update a pipeline group instance.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "pipelineGroupName", @@ -583,7 +583,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -614,13 +614,13 @@ "description": "Updates a pipeline group instance", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "pipelineGroupName", @@ -664,7 +664,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -686,13 +686,13 @@ "description": "Delete a pipeline group instance.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "pipelineGroupName", @@ -724,7 +724,7 @@ "default": { "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse" } } }, @@ -741,21 +741,6 @@ } }, "definitions": { - "Azure.ResourceManager.PrivateEndpointConnection": { - "type": "object", - "description": "The private endpoint connection resource", - "properties": { - "properties": { - "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", - "description": "The private endpoint connection properties" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, "AzureMonitorWorkspace": { "type": "object", "description": "An Azure Monitor Workspace definition.", @@ -763,16 +748,12 @@ "properties": { "$ref": "#/definitions/AzureMonitorWorkspaceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/TrackedResource" } ] }, @@ -871,7 +852,7 @@ "type": "array", "description": "List of private endpoint connections.", "items": { - "$ref": "#/definitions/Azure.ResourceManager.PrivateEndpointConnection" + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection" }, "readOnly": true }, @@ -1254,11 +1235,7 @@ "properties": { "$ref": "#/definitions/PipelineGroupProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -1271,7 +1248,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/TrackedResource" } ] }, diff --git a/specification/mpcnetworkfunction/MpcNetworkFunction.Management/networkfunction.tsp b/specification/mpcnetworkfunction/MpcNetworkFunction.Management/networkfunction.tsp index ce9e0924f4f9..f320daa93bc3 100644 --- a/specification/mpcnetworkfunction/MpcNetworkFunction.Management/networkfunction.tsp +++ b/specification/mpcnetworkfunction/MpcNetworkFunction.Management/networkfunction.tsp @@ -57,7 +57,12 @@ model NetworkFunctionResourceProperties { @armResourceOperations(NetworkFunctionResource) interface NetworkFunctions { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + NetworkFunctionResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; updateTags is ArmTagsPatchSync; delete is ArmResourceDeleteSync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json index 152b307e1d96..2c32de60fddc 100644 --- a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json @@ -458,11 +458,7 @@ "properties": { "$ref": "#/definitions/NetworkFunctionResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/networkanalytics/NetworkAnalytics.Management/main.tsp b/specification/networkanalytics/NetworkAnalytics.Management/main.tsp index a7f74cb8338b..36853645c013 100644 --- a/specification/networkanalytics/NetworkAnalytics.Management/main.tsp +++ b/specification/networkanalytics/NetworkAnalytics.Management/main.tsp @@ -152,7 +152,7 @@ model DataProduct is TrackedResource { @maxLength(63) name: string; - ...ManagedServiceIdentityProperty; + ...Legacy.ManagedServiceIdentityV4Property; } @doc("The data product properties.") @@ -429,9 +429,9 @@ union DataProductUserRole { "Reader", @doc(""" -Field to specify user of type SensitiveReader. -This user has privileged access to read sensitive data of a data product. -""") + Field to specify user of type SensitiveReader. + This user has privileged access to read sensitive data of a data product. + """) "SensitiveReader", } @@ -531,8 +531,13 @@ interface DataProductsCatalogs { @added(Versions.v2023_11_15) @armResourceOperations interface DataTypes { + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("Create data type resource.") - create is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + DataType, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("Retrieve data type resource.") get is ArmResourceRead; @@ -562,8 +567,13 @@ interface DataTypes { @added(Versions.v2023_11_15) @armResourceOperations interface DataProducts { + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @doc("Create data product resource.") - create is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + DataProduct, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; @doc("Retrieve data product resource.") get is ArmResourceRead; diff --git a/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json b/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json index d778934dca55..d4505aa801b0 100644 --- a/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json +++ b/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json @@ -1607,11 +1607,7 @@ "properties": { "$ref": "#/definitions/DataProductProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", @@ -1990,11 +1986,7 @@ "properties": { "$ref": "#/definitions/DataProductsCatalogProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -2053,11 +2045,7 @@ "properties": { "$ref": "#/definitions/DataTypeProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/oracle/Oracle.Database/main.tsp b/specification/oracle/Oracle.Database/main.tsp index 616a085c1a96..3594c17ff745 100644 --- a/specification/oracle/Oracle.Database/main.tsp +++ b/specification/oracle/Oracle.Database/main.tsp @@ -1,3 +1,4 @@ +import "@azure-tools/typespec-autorest"; import "./operations/exadata/exadatainfrastructureOperations.tsp"; import "./operations/exadata/dbServersOperations.tsp"; import "./operations/exadata/vmclusterOperations.tsp"; diff --git a/specification/oracle/Oracle.Database/operations/commons.tsp b/specification/oracle/Oracle.Database/operations/commons.tsp index 822a0dcb58ca..029de8a53bb7 100644 --- a/specification/oracle/Oracle.Database/operations/commons.tsp +++ b/specification/oracle/Oracle.Database/operations/commons.tsp @@ -14,10 +14,16 @@ interface OracleSubscriptionLevelResource< TProperties extends TypeSpec.Reflection.Model > extends ResourceListBySubscription, - ResourceCreateAsync, ResourceRead, ResourceUpdateAsync, - ResourceDeleteWithoutOkAsync {} + ResourceDeleteWithoutOkAsync { + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "REMOVE THIS SUPPRESSION AT THE NEXT API VERSION UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + T, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; +} @armResourceOperations(T) interface OracleTrackedResource< @@ -44,10 +50,14 @@ interface OracleLocationBasedResource interface OracleChildResource< T extends Foundations.Resource, TProperties extends TypeSpec.Reflection.Model -> - extends ResourceCreateAsync, - ResourceRead, - ResourceDeleteWithoutOkAsync {} +> extends ResourceRead, ResourceDeleteWithoutOkAsync { + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "REMOVE THIS SUPPRESSION AT THE NEXT API VERSION UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + T, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; +} @armResourceOperations interface ListActions { diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json index 7240ac650bcc..99c09e6891a0 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json @@ -3897,11 +3897,7 @@ "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3917,11 +3913,7 @@ "properties": { "$ref": "#/definitions/AutonomousDatabaseBackupProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4724,11 +4716,7 @@ "properties": { "$ref": "#/definitions/AutonomousDatabaseCharacterSetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -5020,11 +5008,7 @@ "properties": { "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -5378,11 +5362,7 @@ "properties": { "$ref": "#/definitions/AutonomousDbVersionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -5622,11 +5602,7 @@ "properties": { "$ref": "#/definitions/CloudExadataInfrastructureProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "zones": { "type": "array", @@ -6031,11 +6007,7 @@ "properties": { "$ref": "#/definitions/CloudVmClusterProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -6951,11 +6923,7 @@ "properties": { "$ref": "#/definitions/DbNodeProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -7259,11 +7227,7 @@ "properties": { "$ref": "#/definitions/DbServerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -7544,11 +7508,7 @@ "properties": { "$ref": "#/definitions/DbSystemShapeProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -7763,11 +7723,7 @@ "properties": { "$ref": "#/definitions/DnsPrivateViewProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -7895,11 +7851,7 @@ "properties": { "$ref": "#/definitions/DnsPrivateZoneProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -8155,11 +8107,7 @@ "properties": { "$ref": "#/definitions/GiVersionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -8659,11 +8607,7 @@ "properties": { "$ref": "#/definitions/OracleSubscriptionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "plan": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan", @@ -9465,11 +9409,7 @@ "properties": { "$ref": "#/definitions/SystemVersionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -9663,11 +9603,7 @@ "properties": { "$ref": "#/definitions/VirtualNetworkAddressProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp b/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp index 69a49a3e37e8..f90575183eac 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp +++ b/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp @@ -92,6 +92,12 @@ interface Accounts extends TrackedResourceOperations { @doc("Adds check global name availability operation, normally used if a resource name must be globally unique.") checkNameAvailability is checkGlobalNameAvailability; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST REMOVE AT NEXT API VERSION UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Account, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; } @doc("The location of subscription quota resource.") diff --git a/specification/playwrighttesting/PlaywrightTesting/tspconfig.yaml b/specification/playwrighttesting/PlaywrightTesting/tspconfig.yaml index 8de6f39b8b80..7ec6149d4529 100644 --- a/specification/playwrighttesting/PlaywrightTesting/tspconfig.yaml +++ b/specification/playwrighttesting/PlaywrightTesting/tspconfig.yaml @@ -9,6 +9,7 @@ parameters: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/playwrighttesting.json" diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json index 94efedc41032..b6f9d850e114 100644 --- a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json @@ -699,11 +699,7 @@ "properties": { "$ref": "#/definitions/AccountProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -877,11 +873,7 @@ "properties": { "$ref": "#/definitions/AccountQuotaProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1135,11 +1127,7 @@ "properties": { "$ref": "#/definitions/QuotaProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/portalservices/Extension.Management/models.tsp b/specification/portalservices/Extension.Management/models.tsp index 0cb843dea6d9..d6cf7d03efae 100644 --- a/specification/portalservices/Extension.Management/models.tsp +++ b/specification/portalservices/Extension.Management/models.tsp @@ -428,6 +428,7 @@ model PortalExtensionListSourcesFolder { /** * The content metadata of a file */ +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @discriminator("kind") model PortalExtensionListSourcesFile { /** diff --git a/specification/portalservices/resource-manager/Microsoft.PortalServices/copilotSettings/preview/2024-04-01-preview/copilotSettings.json b/specification/portalservices/resource-manager/Microsoft.PortalServices/copilotSettings/preview/2024-04-01-preview/copilotSettings.json index c841b0db39a8..cf8c28b43cbd 100644 --- a/specification/portalservices/resource-manager/Microsoft.PortalServices/copilotSettings/preview/2024-04-01-preview/copilotSettings.json +++ b/specification/portalservices/resource-manager/Microsoft.PortalServices/copilotSettings/preview/2024-04-01-preview/copilotSettings.json @@ -291,11 +291,7 @@ "properties": { "$ref": "#/definitions/CopilotSettingsProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp index e28cc2a40819..550e6d3d4477 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp @@ -11,17 +11,17 @@ namespace Azure.ProgrammableConnectivity; /// Interfaces @doc(""" - Number operations include Frontend Authentication. - - Users first make a call to the endpoint /Number:verify, which returns a redirect to the device's - Network. This is followed by the device to authenticate directly with the Network. The Network - responds with a token and a redirect. This token can be exchanged with APC for a code. + Number operations include Frontend Authentication. - Users make a second call to the endpoint /Number:verify including the code. The code is used - to verify the device number. The second response is a 200 containing the result of the query. - - For more information on the steps required to use Number Verificaiton, see the APC documentation. -""") + Users first make a call to the endpoint /Number:verify, which returns a redirect to the device's + Network. This is followed by the device to authenticate directly with the Network. The Network + responds with a token and a redirect. This token can be exchanged with APC for a code. + + Users make a second call to the endpoint /Number:verify including the code. The code is used + to verify the device number. The second response is a 200 containing the result of the query. + + For more information on the steps required to use Number Verificaiton, see the APC documentation. + """) interface NumberVerification { #suppress "@azure-tools/typespec-azure-core/no-response-body" "302 redirect has no response body" @doc("Verifies the phone number (MSISDN) associated with a device. As part of the frontend authorization flow, the device is redirected to the operator network to authenticate directly.") diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml index 0c7cf5d47927..14d312af735b 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml @@ -9,6 +9,7 @@ emit: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index 67657574ea86..bec1c82a4957 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -17,11 +17,11 @@ using TypeSpec.Versioning; } ) @doc(""" -Purview Data Map Service is a fully managed cloud service whose users can -discover the data sources they need and understand the data sources they find. -At the same time, Data Map helps organizations get more value from their -existing investments. This spec defines REST API of Purview Data Map Service. -""") + Purview Data Map Service is a fully managed cloud service whose users can + discover the data sources they need and understand the data sources they find. + At the same time, Data Map helps organizations get more value from their + existing investments. This spec defines REST API of Purview Data Map Service. + """) @useAuth(AuthToken) @versioned(ApiVersions) namespace PurviewDataMap; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 2edf89e54833..dc511d8f89e4 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -275,9 +275,9 @@ union FilterOperator { } @doc(""" -An instance of an entity along with extended info - like hive_table, -hive_database. -""") + An instance of an entity along with extended info - like hive_table, + hive_database. + """) model AtlasEntityWithExtInfo { ...AtlasEntityExtInfo; @@ -335,9 +335,9 @@ model AtlasEntity { relationshipAttributes?: Record; @doc(""" -Status of the entity - can be active or deleted. Deleted entities are not -removed. -""") + Status of the entity - can be active or deleted. Deleted entities are not + removed. + """) status?: EntityStatus; @doc("The update time of the record.") @@ -354,9 +354,9 @@ removed. } @doc(""" -An instance of a classification; it doesn't have an identity, this object -exists only when associated with an entity. -""") + An instance of a classification; it doesn't have an identity, this object + exists only when associated with an entity. + """) model AtlasClassification { ...AtlasStruct; @@ -364,9 +364,9 @@ model AtlasClassification { entityGuid?: string; @doc(""" -Status of the entity - can be active or deleted. Deleted entities are not -removed. -""") + Status of the entity - can be active or deleted. Deleted entities are not + removed. + """) entityStatus?: EntityStatus; @doc("Determines if propagations will be removed on entity deletion.") @@ -389,9 +389,9 @@ model TimeBoundary { } @doc(""" -Captures details of struct contents. Not instantiated directly, used only via -AtlasEntity, AtlasClassification. -""") + Captures details of struct contents. Not instantiated directly, used only via + AtlasEntity, AtlasClassification. + """) model AtlasStruct { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Record to model Map" @doc("The attributes of the struct.") @@ -445,9 +445,9 @@ model ContactInfo { } @doc(""" -An instance of an entity along with extended info - like hive_table, -hive_database. -""") + An instance of an entity along with extended info - like hive_table, + hive_database. + """) model AtlasEntityExtInfo { @doc("The referred entities.") referredEntities?: Record; @@ -494,9 +494,9 @@ model AtlasEntityHeader { meanings?: AtlasTermAssignmentHeader[]; @doc(""" -Status of the entity - can be active or deleted. Deleted entities are not -removed. -""") + Status of the entity - can be active or deleted. Deleted entities are not + removed. + """) status?: EntityStatus; } @@ -514,9 +514,9 @@ model AtlasErrorResponse { } @doc(""" -An instance of an entity along with extended info - like hive_table, -hive_database. -""") + An instance of an entity along with extended info - like hive_table, + hive_database. + """) model AtlasEntitiesWithExtInfo { ...AtlasEntityExtInfo; @@ -527,9 +527,9 @@ model AtlasEntitiesWithExtInfo { @doc("The request payload for classification association.") model ClassificationAssociateOptions { @doc(""" -An instance of a classification; it doesn't have an identity, this object -exists only when associated with an entity. -""") + An instance of a classification; it doesn't have an identity, this object + exists only when associated with an entity. + """) classification?: AtlasClassification; @doc("The GUID of the entity.") @@ -770,10 +770,10 @@ model AtlasGlossaryTerm { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @doc(""" -The custom attributes of the term, which is map>. -The -key of the first layer map is term template name. -""") + The custom attributes of the term, which is map>. + The + key of the first layer map is term template name. + """) attributes?: Record>; @doc("An array of related object IDs.") @@ -869,9 +869,9 @@ model ResourceLink { } @doc(""" -Reference to an object-instance of AtlasEntity type used in relationship -attribute values -""") + Reference to an object-instance of AtlasEntity type used in relationship + attribute values + """) model AtlasRelatedObjectId { ...AtlasObjectId; @@ -879,18 +879,18 @@ model AtlasRelatedObjectId { displayText?: string; @doc(""" -Status of the entity - can be active or deleted. Deleted entities are not -removed. -""") + Status of the entity - can be active or deleted. Deleted entities are not + removed. + """) entityStatus?: EntityStatus; @doc("Relationship type") relationshipType?: string; @doc(""" -Captures details of struct contents. Not instantiated directly, used only via -AtlasEntity, AtlasClassification. -""") + Captures details of struct contents. Not instantiated directly, used only via + AtlasEntity, AtlasClassification. + """) relationshipAttributes?: AtlasStruct; @doc("The GUID of the relationship.") @@ -935,15 +935,15 @@ model QueryOptions { keywords?: string; @doc(""" -The limit of the number of the search result. default value is 50; maximum -value is 1000. -""") + The limit of the number of the search result. default value is 50; maximum + value is 1000. + """) limit?: int32; @doc(""" -The token used to get next batch of data. Default 'Null' to get the first -batch, and will return new token in each response unless there's no more data. -""") + The token used to get next batch of data. Default 'Null' to get the first + batch, and will return new token in each response unless there's no more data. + """) continuationToken?: string; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "This is a flexible property" @@ -1005,9 +1005,9 @@ model SearchTaxonomySetting { @doc("The result of the search result.") model QueryResult { @doc(""" -The total number of search results (not the number of documents in a single -page). -""") + The total number of search results (not the number of documents in a single + page). + """) @encodedName("application/json", "@search.count") searchCount?: int32; @@ -1019,10 +1019,10 @@ page). continuationToken?: string; @doc(""" -A facet list that consists of index fields assetType ,classification, -contactId, and label. When the facet is specified in the request, the value of -the facet is returned as an element of @search.facets. -""") + A facet list that consists of index fields assetType ,classification, + contactId, and label. When the facet is specified in the request, the value of + the facet is returned as an element of @search.facets. + """) @encodedName("application/json", "@search.facets") searchFacets?: SearchFacetResultValue; @@ -1031,10 +1031,10 @@ the facet is returned as an element of @search.facets. } @doc(""" -A facet list that consists of index fields assetType ,classification, -contactId, and label. When the facet is specified in the request, the value of -the facet is returned as an element of @search.facets. -""") + A facet list that consists of index fields assetType ,classification, + contactId, and label. When the facet is specified in the request, the value of + the facet is returned as an element of @search.facets. + """) model SearchFacetResultValue { @doc("Entity type") entityType?: SearchFacetItemValue[]; @@ -1079,25 +1079,25 @@ model SearchFacetItemValue { @doc("The value item of the search result.") model SearchResultValue { @doc(""" -The search score calculated by the search engine. The results are ordered by -search score by default. -""") + The search score calculated by the search engine. The results are ordered by + search score by default. + """) @encodedName("application/json", "@search.score") searchScore?: float32; @doc(""" -A highlight list that consists of index fields id ,qualifiedName, name, -description, entityType. When the keyword appears in those fields, the value of -the field, attached with emphasis mark, is returned as an element of -@search.highlights. -""") + A highlight list that consists of index fields id ,qualifiedName, name, + description, entityType. When the keyword appears in those fields, the value of + the field, attached with emphasis mark, is returned as an element of + @search.highlights. + """) @encodedName("application/json", "@search.highlights") searchHighlights?: SearchHighlights; @doc(""" -The object type of the record. Object type is the top-level property to -distinguish whether a record is an asset or a term. -""") + The object type of the record. Object type is the top-level property to + distinguish whether a record is an asset or a term. + """) objectType?: string; @doc("The create time of the record. The Unix epoch format.") @@ -1143,9 +1143,9 @@ distinguish whether a record is an asset or a term. assetType?: string[]; @doc(""" -The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or -AtlasGlossaryCategory. -""") + The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or + AtlasGlossaryCategory. + """) glossaryType?: string; @doc("The glossary name of the term.") @@ -1162,11 +1162,11 @@ AtlasGlossaryCategory. } @doc(""" -A highlight list that consists of index fields id ,qualifiedName, name, -description, entityType. When the keyword appears in those fields, the value of -the field, attached with emphasis mark, is returned as an element of -@search.highlights. -""") + A highlight list that consists of index fields id ,qualifiedName, name, + description, entityType. When the keyword appears in those fields, the value of + the field, attached with emphasis mark, is returned as an element of + @search.highlights. + """) model SearchHighlights { @doc("Id") id?: string[]; @@ -1205,26 +1205,26 @@ model ContactSearchResultValue { info?: string; @doc(""" -The type of the contact. It can be Expert or Owner for an entity. It can be -Expert or Steward for a glossary term. -""") + The type of the contact. It can be Expert or Owner for an entity. It can be + Expert or Steward for a glossary term. + """) contactType?: string; } @doc("The payload of suggest request.") model SuggestOptions { @doc(""" -The keywords applied to all fields that support suggest operation. It must be -at least 1 character, and no more than 100 characters. In the index schema we -defined a default suggester which lists all the supported fields and specifies -a search mode. -""") + The keywords applied to all fields that support suggest operation. It must be + at least 1 character, and no more than 100 characters. In the index schema we + defined a default suggester which lists all the supported fields and specifies + a search mode. + """) keywords?: string; @doc(""" -The number of suggestions we hope to return. The default value is 5. The value -must be a number between 1 and 100. -""") + The number of suggestions we hope to return. The default value is 5. The value + must be a number between 1 and 100. + """) limit?: int32; #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @@ -1241,23 +1241,23 @@ model SuggestResult { @doc("The value item of the search suggest.") model SuggestResultValue { @doc(""" -The search score calculated by the search engine. The results are ordered by -search score by default. -""") + The search score calculated by the search engine. The results are ordered by + search score by default. + """) @encodedName("application/json", "@search.score") searchScore?: float32; @doc(""" -The target text that contains the keyword as prefix. The keyword is wrapped -with emphasis mark. -""") + The target text that contains the keyword as prefix. The keyword is wrapped + with emphasis mark. + """) @encodedName("application/json", "@search.text") searchText?: string; @doc(""" -The object type of the record. Object type is the top-level property to -distinguish whether a record is an asset or a term. -""") + The object type of the record. Object type is the top-level property to + distinguish whether a record is an asset or a term. + """) objectType?: string; @doc("The create time of the record. The Unix epoch format.") @@ -1303,9 +1303,9 @@ distinguish whether a record is an asset or a term. assetType?: string[]; @doc(""" -The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or -AtlasGlossaryCategory. -""") + The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or + AtlasGlossaryCategory. + """) glossaryType?: string; @doc("The glossary name of the term.") @@ -1324,15 +1324,15 @@ AtlasGlossaryCategory. @doc("The payload of autocomplete request.") model AutoCompleteOptions { @doc(""" -The keywords applied to all fields that support autocomplete operation. It must -be at least 1 character, and no more than 100 characters. -""") + The keywords applied to all fields that support autocomplete operation. It must + be at least 1 character, and no more than 100 characters. + """) keywords?: string; @doc(""" -The number of autocomplete results we hope to return. The default value is 50. -The value must be a number between 1 and 100. -""") + The number of autocomplete results we hope to return. The default value is 50. + The value must be a number between 1 and 100. + """) limit?: int32; #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @@ -1671,29 +1671,29 @@ model AtlasClassificationDef { ...AtlasStructDef; @doc(""" -Specifying a list of entityType names in the classificationDef, ensures that -classifications can -only be applied to those entityTypes. - -Any subtypes of the entity types inherit the restriction. - -Any classificationDef subtypes inherit the parents entityTypes restrictions. - -Any classificationDef subtypes can further restrict the parents entityTypes -restrictions by specifying a subset of the entityTypes. - -An empty entityTypes list when there are no parent restrictions means there are no -restrictions. - -An empty entityTypes list when there are parent -restrictions means that the subtype picks up the parents -restrictions. - -If a list of entityTypes are supplied, where one inherits -from another, this will be rejected. This should encourage cleaner -classificationsDefs. - -""") + Specifying a list of entityType names in the classificationDef, ensures that + classifications can + only be applied to those entityTypes. + + Any subtypes of the entity types inherit the restriction. + + Any classificationDef subtypes inherit the parents entityTypes restrictions. + + Any classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. + + An empty entityTypes list when there are no parent restrictions means there are no + restrictions. + + An empty entityTypes list when there are parent + restrictions means that the subtype picks up the parents + restrictions. + + If a list of entityTypes are supplied, where one inherits + from another, this will be rejected. This should encourage cleaner + classificationsDefs. + + """) entityTypes?: string[]; @doc("An array of sub types.") @@ -1718,11 +1718,11 @@ model AtlasEntityDef { } @doc(""" -The relationshipEndDef represents an end of the relationship. The end of the -relationship is defined by a type, an -attribute name, cardinality and whether -it is the container end of the relationship. -""") + The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + """) model AtlasRelationshipAttributeDef { ...AtlasAttributeDef; @@ -1757,74 +1757,74 @@ model AtlasEnumElementDef { } @doc(""" -AtlasRelationshipDef is a TypeDef that defines a relationship. -As with other typeDefs the AtlasRelationshipDef has a name. Once created the -RelationshipDef has a guid. -The name and the guid are the 2 ways that the -RelationshipDef is identified. -RelationshipDefs have 2 ends, each of which -specify cardinality, an EntityDef type name and name and optionally -whether the -end is a container. -RelationshipDefs can have AttributeDefs - though only -primitive types are allowed. -RelationshipDefs have a relationshipCategory -specifying the UML type of relationship required -The way EntityDefs and -RelationshipDefs are intended to be used is that EntityDefs will define -AttributeDefs these AttributeDefs -will not specify an EntityDef type name as -their types. -RelationshipDefs introduce new attributes to the entity -instances. For example -EntityDef A might have attributes attr1,attr2,attr3 - -EntityDef B might have attributes attr4,attr5,attr6 -RelationshipDef -AtoB might define 2 ends - -end1: type A, name attr7 -end2: type B, name attr8 - -When an instance of EntityDef A is created, it -will have attributes attr1,attr2,attr3,attr7 -When an instance of EntityDef -B is created, it will have attributes attr4,attr5,attr6,attr8 - -In this way -relationshipDefs can be authored separately from entityDefs and can inject -relationship attributes into -the entity instances -""") + AtlasRelationshipDef is a TypeDef that defines a relationship. + As with other typeDefs the AtlasRelationshipDef has a name. Once created the + RelationshipDef has a guid. + The name and the guid are the 2 ways that the + RelationshipDef is identified. + RelationshipDefs have 2 ends, each of which + specify cardinality, an EntityDef type name and name and optionally + whether the + end is a container. + RelationshipDefs can have AttributeDefs - though only + primitive types are allowed. + RelationshipDefs have a relationshipCategory + specifying the UML type of relationship required + The way EntityDefs and + RelationshipDefs are intended to be used is that EntityDefs will define + AttributeDefs these AttributeDefs + will not specify an EntityDef type name as + their types. + RelationshipDefs introduce new attributes to the entity + instances. For example + EntityDef A might have attributes attr1,attr2,attr3 + + EntityDef B might have attributes attr4,attr5,attr6 + RelationshipDef + AtoB might define 2 ends + + end1: type A, name attr7 + end2: type B, name attr8 + + When an instance of EntityDef A is created, it + will have attributes attr1,attr2,attr3,attr7 + When an instance of EntityDef + B is created, it will have attributes attr4,attr5,attr6,attr8 + + In this way + relationshipDefs can be authored separately from entityDefs and can inject + relationship attributes into + the entity instances + """) model AtlasRelationshipDef { ...AtlasStructDef; @doc(""" -The relationshipEndDef represents an end of the relationship. The end of the -relationship is defined by a type, an -attribute name, cardinality and whether -it is the container end of the relationship. -""") + The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + """) endDef1?: AtlasRelationshipEndDef; @doc(""" -The relationshipEndDef represents an end of the relationship. The end of the -relationship is defined by a type, an -attribute name, cardinality and whether -it is the container end of the relationship. -""") + The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + """) endDef2?: AtlasRelationshipEndDef; @doc(""" -The Relationship category determines the style of relationship around -containment and lifecycle. -UML terminology is used for the values. -ASSOCIATION is a relationship with no containment. -COMPOSITION and AGGREGATION are containment relationships. -The difference being in the lifecycles of the container and its children. -In the COMPOSITION case, the children cannot exist without the container. -For AGGREGATION, the life cycles of the container and children are totally independent. -""") + The Relationship category determines the style of relationship around + containment and lifecycle. + UML terminology is used for the values. + ASSOCIATION is a relationship with no containment. + COMPOSITION and AGGREGATION are containment relationships. + The difference being in the lifecycles of the container and its children. + In the COMPOSITION case, the children cannot exist without the container. + For AGGREGATION, the life cycles of the container and children are totally independent. + """) relationshipCategory?: RelationshipCategory; @doc("The label of the relationship.") @@ -1832,11 +1832,11 @@ For AGGREGATION, the life cycles of the container and children are totally indep } @doc(""" -The relationshipEndDef represents an end of the relationship. The end of the -relationship is defined by a type, an -attribute name, cardinality and whether -it is the container end of the relationship. -""") + The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + """) model AtlasRelationshipEndDef { @doc("single-valued attribute or multi-valued attribute.") cardinality?: CardinalityValue; @@ -1866,29 +1866,29 @@ model AtlasTypeDef { @doc("Extra properties for a type.") model AtlasExtraTypeDef { @doc(""" -Specifying a list of entityType names in the classificationDef, ensures that -classifications can -only be applied to those entityTypes. - -Any subtypes of the entity types inherit the restriction. - -Any classificationDef subtypes inherit the parents entityTypes restrictions. - -Any classificationDef subtypes can further restrict the parents entityTypes -restrictions by specifying a subset of the entityTypes. - -An empty entityTypes list when there are no parent restrictions means there are no -restrictions. - -An empty entityTypes list when there are parent -restrictions means that the subtype picks up the parents -restrictions. - -If a list of entityTypes are supplied, where one inherits -from another, this will be rejected. This should encourage cleaner -classificationsDefs. - -""") + Specifying a list of entityType names in the classificationDef, ensures that + classifications can + only be applied to those entityTypes. + + Any subtypes of the entity types inherit the restriction. + + Any classificationDef subtypes inherit the parents entityTypes restrictions. + + Any classificationDef subtypes can further restrict the parents entityTypes + restrictions by specifying a subset of the entityTypes. + + An empty entityTypes list when there are no parent restrictions means there are no + restrictions. + + An empty entityTypes list when there are parent + restrictions means that the subtype picks up the parents + restrictions. + + If a list of entityTypes are supplied, where one inherits + from another, this will be rejected. This should encourage cleaner + classificationsDefs. + + """) entityTypes?: string[]; @doc("An array of sub types.") @@ -1907,33 +1907,33 @@ classificationsDefs. elementDefs?: AtlasEnumElementDef[]; @doc(""" -The relationshipEndDef represents an end of the relationship. The end of the -relationship is defined by a type, an -attribute name, cardinality and whether -it is the container end of the relationship. -""") + The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + """) endDef1?: AtlasRelationshipEndDef; @doc(""" -The relationshipEndDef represents an end of the relationship. The end of the -relationship is defined by a type, an -attribute name, cardinality and whether -it is the container end of the relationship. -""") + The relationshipEndDef represents an end of the relationship. The end of the + relationship is defined by a type, an + attribute name, cardinality and whether + it is the container end of the relationship. + """) endDef2?: AtlasRelationshipEndDef; @doc(""" -The Relationship category determines the style of relationship around -containment and lifecycle. -UML terminology is used for the values. - -ASSOCIATION is a relationship with no containment. -COMPOSITION and AGGREGATION are containment relationships. - -The difference being in the lifecycles of the container and its children. -In the COMPOSITION case, the children cannot exist without the container. -For AGGREGATION, the life cycles of the container and children are totally independent. -""") + The Relationship category determines the style of relationship around + containment and lifecycle. + UML terminology is used for the values. + + ASSOCIATION is a relationship with no containment. + COMPOSITION and AGGREGATION are containment relationships. + + The difference being in the lifecycles of the container and its children. + In the COMPOSITION case, the children cannot exist without the container. + For AGGREGATION, the life cycles of the container and children are totally independent. + """) relationshipCategory?: RelationshipCategory; @doc("The label of the relationship.") diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index c7a68f0284e1..d47f16bf8ce1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -91,29 +91,29 @@ alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTr interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" -Create or update an entity. -Existing entity is matched using its unique guid if -supplied or by its unique attributes eg: qualifiedName. -Map and array of -collections are not well supported. E.g., array>, array>. -For each contact type, the maximum number of contacts is 20. -""") + Create or update an entity. + Existing entity is matched using its unique guid if + supplied or by its unique attributes eg: qualifiedName. + Map and array of + collections are not well supported. E.g., array>, array>. + For each contact type, the maximum number of contacts is 20. + """) @route("/atlas/v2/entity") @post createOrUpdate is AtlasOperation< { @doc(""" -Used to define the update behavior for business attributes when updating -entities. -""") + Used to define the update behavior for business attributes when updating + entities. + """) @query businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; @doc(""" -The collection where entities will be moved to. Only specify a value if you -need to move an entity to another collection. -""") + The collection where entities will be moved to. Only specify a value if you + need to move an entity to another collection. + """) @query collectionId?: string; } & AtlasEntityWithExtInfo, @@ -148,30 +148,30 @@ need to move an entity to another collection. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" -Create or update entities in bulk. -Existing entity is matched using its unique -guid if supplied or by its unique attributes eg: qualifiedName. -Map and array -of collections are not well supported. E.g., array>, -array>. -For each contact type, the maximum number of contacts -is 20. -""") + Create or update entities in bulk. + Existing entity is matched using its unique + guid if supplied or by its unique attributes eg: qualifiedName. + Map and array + of collections are not well supported. E.g., array>, + array>. + For each contact type, the maximum number of contacts + is 20. + """) @route("/atlas/v2/entity/bulk") @post bulkCreateOrUpdate is AtlasOperation< { @doc(""" -The collection where entities will be moved to. Only specify a value if you -need to move an entity to another collection. -""") + The collection where entities will be moved to. Only specify a value if you + need to move an entity to another collection. + """) @query collectionId?: string; @doc(""" -Used to define the update behavior for business attributes when updating -entities. -""") + Used to define the update behavior for business attributes when updating + entities. + """) @query businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; } & AtlasEntitiesWithExtInfo, @@ -183,9 +183,9 @@ entities. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Delete a list of entities in bulk identified by their GUIDs or unique -attributes. -""") + Delete a list of entities in bulk identified by their GUIDs or unique + attributes. + """) @route("/atlas/v2/entity/bulk") @delete bulkDelete is AtlasOperation< @@ -233,12 +233,12 @@ attributes. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Update entity partially - create or update entity attribute identified by its -GUID. -Supports only primitive attribute type and entity references. -It does not support updating complex types like arrays, and maps. -Null updates are not possible. -""") + Update entity partially - create or update entity attribute identified by its + GUID. + Supports only primitive attribute type and entity references. + It does not support updating complex types like arrays, and maps. + Null updates are not possible. + """) @route("/atlas/v2/entity/guid/{guid}") @put partialUpdateAttributeByGuid is AtlasOperation< @@ -371,21 +371,21 @@ Null updates are not possible. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Get complete definition of an entity given its type and unique attribute. - -In -addition to the typeName path parameter, attribute key-value pair(s) can be -provided in the following format: -attr:\\=. - -NOTE: The -attrName and attrValue should be unique across entities, eg. -qualifiedName. - -The REST request would look something like this: -GET -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") + Get complete definition of an entity given its type and unique attribute. + + In + addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the following format: + attr:\\=. + + NOTE: The + attrName and attrValue should be unique across entities, eg. + qualifiedName. + + The REST request would look something like this: + GET + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @get getByUniqueAttributes is AtlasOperation< @@ -403,9 +403,9 @@ GET ignoreRelationships?: boolean; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; }, @@ -416,23 +416,23 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Update entity partially - Allow a subset of attributes to be updated on an -entity which is identified by its type and unique attribute eg: -Referenceable.qualifiedName. Null updates are not possible. - -In addition to the -typeName path parameter, attribute key-value pair(s) can be provided in the -following format: - -attr:=. -NOTE: The attrName and -attrValue should be unique across entities, eg. qualifiedName. - -The REST -request would look something like this: -PUT -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") + Update entity partially - Allow a subset of attributes to be updated on an + entity which is identified by its type and unique attribute eg: + Referenceable.qualifiedName. Null updates are not possible. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + + attr:=. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @put partialUpdateByUniqueAttributes is AtlasOperation< @@ -442,9 +442,9 @@ PUT typeName: string; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; } & AtlasEntityWithExtInfo, @@ -455,19 +455,19 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Delete an entity identified by its type and unique attributes. -In addition to -the typeName path parameter, attribute key-value pair(s) can be provided in the -following format: -attr:\\=\\. -NOTE: The attrName and -attrValue should be unique across entities, eg. qualifiedName. - -The REST -request would look something like this: -DELETE -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") + Delete an entity identified by its type and unique attributes. + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: + attr:\\=\\. + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: + DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @delete deleteByUniqueAttribute is AtlasOperation< @@ -477,9 +477,9 @@ DELETE typeName: string; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; }, @@ -490,9 +490,9 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Delete a given classification from an entity identified by its type and unique -attributes. -""") + Delete a given classification from an entity identified by its type and unique + attributes. + """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") @delete removeClassificationByUniqueAttribute is AtlasOperation< @@ -506,9 +506,9 @@ attributes. classificationName: string; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; }, @@ -529,9 +529,9 @@ be changed to other unique attributes) typeName: string; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; @@ -556,9 +556,9 @@ be changed to other unique attributes) typeName: string; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; @@ -585,25 +585,25 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/casing-style" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Bulk API to retrieve list of entities identified by its unique attributes. -In -addition to the typeName path parameter, attribute key-value pair(s) can be -provided in the following -format - -typeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\ - -NOTE: -The attrName should be an unique attribute for the given entity-type. -The REST -request would look something like this - -GET -/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 - -Note: -at least one unique attribute must be provided. -""") + Bulk API to retrieve list of entities identified by its unique attributes. + In + addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the following + format + + typeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\ + + NOTE: + The attrName should be an unique attribute for the given entity-type. + The REST + request would look something like this + + GET + /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 + + Note: + at least one unique attribute must be provided. + """) @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") @get listByUniqueAttributes is AtlasOperation< @@ -621,10 +621,10 @@ at least one unique attribute must be provided. ignoreRelationships?: boolean; @doc(""" -Qualified name of an entity. E.g. to find 2 entities you can set -attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an -example. qualifiedName can be changed to other unique attributes) -""") + Qualified name of an entity. E.g. to find 2 entities you can set + attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an + example. qualifiedName can be changed to other unique attributes) + """) @query `attr_N:qualifiedName`?: string; }, @@ -679,9 +679,9 @@ example. qualifiedName can be changed to other unique attributes) guid: string; @doc(""" -Whether to overwrite the existing business metadata on the entity or not, -default is false. -""") + Whether to overwrite the existing business metadata on the entity or not, + default is false. + """) @query("isOverwrite") overwrite?: boolean; @@ -834,20 +834,20 @@ default is false. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Delete given labels to a given entity identified by its type and unique -attribute. - -If labels is null/empty, no labels will be removed. - -If any labels -in labels set are non-existing labels, they will be ignored, only existing -labels will be removed. In addition to the typeName path parameter, attribute -key-value pair(s) can be provided in the following format: -attr:=. NOTE: The attrName and attrValue should be unique -across entities, eg. qualifiedName. The REST request would look something like -this: DELETE -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") + Delete given labels to a given entity identified by its type and unique + attribute. + + If labels is null/empty, no labels will be removed. + + If any labels + in labels set are non-existing labels, they will be ignored, only existing + labels will be removed. In addition to the typeName path parameter, attribute + key-value pair(s) can be provided in the following format: + attr:=. NOTE: The attrName and attrValue should be unique + across entities, eg. qualifiedName. The REST request would look something like + this: DELETE + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @delete removeLabelsByUniqueAttribute is AtlasOperation< @@ -857,9 +857,9 @@ this: DELETE typeName: string; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; @@ -875,22 +875,22 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Set labels to a given entity identified by its type and unique attributes. - -If -labels is null/empty, existing labels will all be removed. - -In addition to the -typeName path parameter, attribute key-value pair(s) can be provided in the -following format: attr:=. - -NOTE: The attrName and -attrValue should be unique across entities, eg. qualifiedName. - -The REST -request would look something like this: POST -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") + Set labels to a given entity identified by its type and unique attributes. + + If + labels is null/empty, existing labels will all be removed. + + In addition to the + typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr:=. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: POST + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @post setLabelsByUniqueAttribute is AtlasOperation< @@ -900,9 +900,9 @@ request would look something like this: POST typeName: string; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; @@ -918,22 +918,22 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Add given labels to a given entity identified by its type and unique -attributes. - -If labels is null/empty, no labels will be added. - -In addition to -the typeName path parameter, attribute key-value pair(s) can be provided in the -following format: attr:=. - -NOTE: The attrName and -attrValue should be unique across entities, eg. qualifiedName. - -The REST -request would look something like this: PUT -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") + Add given labels to a given entity identified by its type and unique + attributes. + + If labels is null/empty, no labels will be added. + + In addition to + the typeName path parameter, attribute key-value pair(s) can be provided in the + following format: attr:=. + + NOTE: The attrName and + attrValue should be unique across entities, eg. qualifiedName. + + The REST + request would look something like this: PUT + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @put addLabelsByUniqueAttribute is AtlasOperation< @@ -943,9 +943,9 @@ request would look something like this: PUT typeName: string; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; @@ -976,15 +976,15 @@ be changed to other unique attributes) interface Glossary { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" -Get all glossaries. Recommend using limit/offset to get pagination result. -Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories -separately using - - 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' -and - - 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. -""") + Get all glossaries. Recommend using limit/offset to get pagination result. + Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories + separately using + + 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' + and + + 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. + """) @route("/atlas/v2/glossary") @get list is AtlasOperation< @@ -1093,9 +1093,9 @@ and #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc(""" -Update the glossary category partially. So far we only supports partial -updating shortDescription and longDescription for category. -""") + Update the glossary category partially. So far we only supports partial + updating shortDescription and longDescription for category. + """) @route("/atlas/v2/glossary/category/{categoryId}/partial") @put partialUpdateCategory is AtlasOperation< @@ -1105,9 +1105,9 @@ updating shortDescription and longDescription for category. categoryId: string; @doc(""" -A map containing keys as attribute names and values as corresponding attribute -values for partial update. -""") + A map containing keys as attribute names and values as corresponding attribute + values for partial update. + """) @bodyRoot body: Record; }, @@ -1118,9 +1118,9 @@ values for partial update. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Get all related categories (parent and children). Limit, offset, and sort -parameters are currently not being enabled and won't work even they are passed. -""") + Get all related categories (parent and children). Limit, offset, and sort + parameters are currently not being enabled and won't work even they are passed. + """) @route("/atlas/v2/glossary/category/{categoryId}/related") @get listRelatedCategories is AtlasOperation< @@ -1237,9 +1237,9 @@ parameters are currently not being enabled and won't work even they are passed. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc(""" -Update the glossary term partially. So far we only supports partial updating -shortDescription, longDescription, abbreviation, usage and status for term. -""") + Update the glossary term partially. So far we only supports partial updating + shortDescription, longDescription, abbreviation, usage and status for term. + """) @route("/atlas/v2/glossary/term/{termId}/partial") @put partialUpdateTerm is AtlasOperation< @@ -1253,9 +1253,9 @@ shortDescription, longDescription, abbreviation, usage and status for term. includeTermHierarchy?: boolean; @doc(""" -A map containing keys as attribute names and values as corresponding attribute -values to be updated. -""") + A map containing keys as attribute names and values as corresponding attribute + values to be updated. + """) @bodyRoot body: Record; }, @@ -1285,9 +1285,9 @@ values to be updated. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -List all related objects assigned with the specified term. Recommend using -limit/offset to get pagination result. -""") + List all related objects assigned with the specified term. Recommend using + limit/offset to get pagination result. + """) @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") @get listEntitiesAssignedWithTerm is AtlasOperation< @@ -1316,13 +1316,13 @@ limit/offset to get pagination result. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Assign the given term to the provided list of related objects. Recommend using -small batches with multiple API calls. - -[Entities Create Or Update -operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) -is an alternative to assign a term to multiple entities. -""") + Assign the given term to the provided list of related objects. Recommend using + small batches with multiple API calls. + + [Entities Create Or Update + operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) + is an alternative to assign a term to multiple entities. + """) @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") @post assignTermToEntities is AtlasOperation< @@ -1361,9 +1361,9 @@ is an alternative to assign a term to multiple entities. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" -Get all related terms for a specific term by its GUID. Limit, offset, and sort -parameters are currently not being enabled and won't work even they are passed. -""") + Get all related terms for a specific term by its GUID. Limit, offset, and sort + parameters are currently not being enabled and won't work even they are passed. + """) @route("/atlas/v2/glossary/terms/{termId}/related") @get listRelatedTerms is AtlasOperation< @@ -1424,9 +1424,9 @@ parameters are currently not being enabled and won't work even they are passed. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Delete a glossary. Will delete underlying terms/categories together. Recommend -separate delete terms and categories. -""") + Delete a glossary. Will delete underlying terms/categories together. Recommend + separate delete terms and categories. + """) @route("/atlas/v2/glossary/{glossaryId}") @delete delete is AtlasOperation< @@ -1442,9 +1442,9 @@ separate delete terms and categories. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Get the categories belonging to a specific glossary. Recommend using -limit/offset to get pagination result. -""") + Get the categories belonging to a specific glossary. Recommend using + limit/offset to get pagination result. + """) @route("/atlas/v2/glossary/{glossaryId}/categories") @get listCategories is AtlasOperation< @@ -1472,9 +1472,9 @@ limit/offset to get pagination result. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Get the category headers belonging to a specific glossary. Recommend using -limit/offset to get pagination result. -""") + Get the category headers belonging to a specific glossary. Recommend using + limit/offset to get pagination result. + """) @route("/atlas/v2/glossary/{glossaryId}/categories/headers") @get listCategoriesHeaders is AtlasOperation< @@ -1501,15 +1501,15 @@ limit/offset to get pagination result. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" -Get a specific glossary with detailed information. This API is not -recommend. - -Recommend to fetch terms/categories details separately using - -GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and - -GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. -""") + Get a specific glossary with detailed information. This API is not + recommend. + + Recommend to fetch terms/categories details separately using + + GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and + + GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. + """) @route("/atlas/v2/glossary/{glossaryId}/detailed") @get getDetailed is AtlasOperation< @@ -1525,15 +1525,15 @@ GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc(""" -Update the glossary partially. Some properties such as qualifiedName are not -allowed to be updated. - -So far we only supports partial updating -shortDescription, longDescription, language and usage for glossary. - -Recommend -using 'ignoreTermsAndCategories=true' to reduce response body size. -""") + Update the glossary partially. Some properties such as qualifiedName are not + allowed to be updated. + + So far we only supports partial updating + shortDescription, longDescription, language and usage for glossary. + + Recommend + using 'ignoreTermsAndCategories=true' to reduce response body size. + """) @route("/atlas/v2/glossary/{glossaryId}/partial") @put partialUpdate is AtlasOperation< @@ -1547,9 +1547,9 @@ using 'ignoreTermsAndCategories=true' to reduce response body size. ignoreTermsAndCategories?: boolean; @doc(""" -A map containing keys as attribute names and values as corresponding attribute -values. -""") + A map containing keys as attribute names and values as corresponding attribute + values. + """) @bodyRoot body: Record; }, @@ -1559,9 +1559,9 @@ values. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" -Get terms belonging to a specific glossary. Recommend using limit/offset to get -pagination result. -""") + Get terms belonging to a specific glossary. Recommend using limit/offset to get + pagination result. + """) @route("/atlas/v2/glossary/{glossaryId}/terms") @get listTerms is AtlasOperation< @@ -1589,9 +1589,9 @@ pagination result. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Get term headers belonging to a specific glossary. Recommend using limit/offset -to get pagination result. -""") + Get term headers belonging to a specific glossary. Recommend using limit/offset + to get pagination result. + """) @route("/atlas/v2/glossary/{glossaryId}/terms/headers") @get listTermHeaders is AtlasOperation< @@ -1705,23 +1705,23 @@ interface Lineage { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Return lineage info about entity. - -In addition to the typeName path parameter, -attribute key-value pair(s) can be provided in the following -format - -attr:[attrName]=[attrValue] - -NOTE: The attrName and attrValue should be -unique across entities, eg. qualifiedName. - -The REST request would look -something like this: - -GET -/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") + Return lineage info about entity. + + In addition to the typeName path parameter, + attribute key-value pair(s) can be provided in the following + format + + attr:[attrName]=[attrValue] + + NOTE: The attrName and attrValue should be + unique across entities, eg. qualifiedName. + + The REST request would look + something like this: + + GET + /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. + """) @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") @get getByUniqueAttribute is AtlasOperation< @@ -1739,9 +1739,9 @@ GET direction: LineageDirection; @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") + The qualified name of the entity. (This is only an example. qualifiedName can + be changed to other unique attributes) + """) @query("attr:qualifiedName") attribute?: string; }, @@ -2033,10 +2033,10 @@ interface Type { list is AtlasOperation< { @doc(""" -Whether include termtemplatedef when return all typedefs. -This is always true -when search filter type=term_template -""") + Whether include termtemplatedef when return all typedefs. + This is always true + when search filter type=term_template + """) @query includeTermTemplate?: boolean; @@ -2051,10 +2051,10 @@ when search filter type=term_template #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Create all atlas type definitions in bulk, only new definitions will be -created. -Any changes to the existing definitions will be discarded. -""") + Create all atlas type definitions in bulk, only new definitions will be + created. + Any changes to the existing definitions will be discarded. + """) @route("/atlas/v2/types/typedefs") @post bulkCreate is AtlasOperation; @@ -2062,9 +2062,9 @@ Any changes to the existing definitions will be discarded. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" -Update all types in bulk, changes detected in the type definitions would be -persisted. -""") + Update all types in bulk, changes detected in the type definitions would be + persisted. + """) @route("/atlas/v2/types/typedefs") @put bulkUpdate is AtlasOperation; @@ -2083,10 +2083,10 @@ persisted. listHeaders is AtlasOperation< { @doc(""" -Whether include termtemplatedef when return all typedefs. -This is always true -when search filter type=term_template -""") + Whether include termtemplatedef when return all typedefs. + This is always true + when search filter type=term_template + """) @query includeTermTemplate?: boolean; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index 728bf1d6c2e4..2168a282a9a0 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -9,6 +9,7 @@ emit: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/purviewdatamap.json" diff --git a/specification/purviewpolicy/PurviewPolicy.Management/backcompat.tsp b/specification/purviewpolicy/PurviewPolicy.Management/backcompat.tsp index 84328570e6a6..e9c3ff64e9e5 100644 --- a/specification/purviewpolicy/PurviewPolicy.Management/backcompat.tsp +++ b/specification/purviewpolicy/PurviewPolicy.Management/backcompat.tsp @@ -5,7 +5,7 @@ using TypeSpec.Http; using Azure.ResourceManager; @@path(ResourceUriParameter.resourceUri, "scope"); -@@Azure.ResourceManager.Private.armCommonParameter(ResourceUriParameter.resourceUri, +@@Azure.ResourceManager.CommonTypes.Private.armCommonParameter(ResourceUriParameter.resourceUri, "ScopeParameter", Azure.ResourceManager.CommonTypes.Versions.v5 ); diff --git a/specification/quantum/Quantum.Workspace/common/base-operations.tsp b/specification/quantum/Quantum.Workspace/common/base-operations.tsp index 64d0e6e4af81..b1f9552cecdd 100644 --- a/specification/quantum/Quantum.Workspace/common/base-operations.tsp +++ b/specification/quantum/Quantum.Workspace/common/base-operations.tsp @@ -41,10 +41,10 @@ namespace Quantum.Workspace.BaseOperations { /** Operation to patch a resource. */ #suppress "@azure-tools/typespec-azure-core/use-standard-operations" """ - There is no support for JsonPatch in Azure.Core. - The Azure.Core.ResourceUpdate does not support NoContentResponse and the JsonPatchDocument request body. - See https://github.com/Azure/typespec-azure/issues/475 - """ + There is no support for JsonPatch in Azure.Core. + The Azure.Core.ResourceUpdate does not support NoContentResponse and the JsonPatchDocument request body. + See https://github.com/Azure/typespec-azure/issues/475 + """ @updatesResource(Resource) @patch @Azure.Core.Foundations.Private.ensureVerb("PatchOperation", "PATCH") diff --git a/specification/quantum/Quantum.Workspace/main.tsp b/specification/quantum/Quantum.Workspace/main.tsp index ca91b5c67586..66d2637d36e1 100644 --- a/specification/quantum/Quantum.Workspace/main.tsp +++ b/specification/quantum/Quantum.Workspace/main.tsp @@ -52,20 +52,20 @@ using OpenAPI; }) namespace Quantum.Workspace.Services { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" """ - There is no support for JsonPatch in Azure.Core. - The Azure.Core.ResourceUpdate does not support NoContentResponse and the JsonPatchDocument request body. - See https://github.com/Azure/typespec-azure/issues/475 - """ + There is no support for JsonPatch in Azure.Core. + The Azure.Core.ResourceUpdate does not support NoContentResponse and the JsonPatchDocument request body. + See https://github.com/Azure/typespec-azure/issues/475 + """ #suppress "@azure-tools/typespec-azure-core/use-standard-operations" """ - We had to use a custom ResourceList to avoid an autoroute bug for workspace/jobs and sesssions/{sessionId}/jobs. - See https://github.com/Azure/typespec-azure/issues/494 - """ + We had to use a custom ResourceList to avoid an autoroute bug for workspace/jobs and sesssions/{sessionId}/jobs. + See https://github.com/Azure/typespec-azure/issues/494 + """ interface Jobs extends Quantum.Workspace.Operations.JobOperations {} #suppress "@azure-tools/typespec-azure-core/use-standard-operations" """ - We had to use a custom ResourceList to avoid an autoroute bug for workspace/jobs and sesssions/{sessionId}/jobs. - See https://github.com/Azure/typespec-azure/issues/494 - """ + We had to use a custom ResourceList to avoid an autoroute bug for workspace/jobs and sesssions/{sessionId}/jobs. + See https://github.com/Azure/typespec-azure/issues/494 + """ interface Sessions extends Quantum.Workspace.Operations.SessionOperations {} interface Providers extends Quantum.Workspace.Operations.ProviderOperations {} diff --git a/specification/quantum/Quantum.Workspace/operations/jobs.tsp b/specification/quantum/Quantum.Workspace/operations/jobs.tsp index 3d9449312f4f..32035bbcc2d2 100644 --- a/specification/quantum/Quantum.Workspace/operations/jobs.tsp +++ b/specification/quantum/Quantum.Workspace/operations/jobs.tsp @@ -131,10 +131,10 @@ namespace Quantum.Workspace.Operations { /** Update job properties. */ #suppress "@azure-tools/typespec-azure-core/use-standard-operations" """ - There is no support for JsonPatch in Azure.Core. - The Azure.Core.ResourceUpdate does not support NoContentResponse and the JsonPatchDocument request body. - See https://github.com/Azure/typespec-azure/issues/475 - """ + There is no support for JsonPatch in Azure.Core. + The Azure.Core.ResourceUpdate does not support NoContentResponse and the JsonPatchDocument request body. + See https://github.com/Azure/typespec-azure/issues/475 + """ update is PatchOperation; /** Request the cancellation of an existing job. */ @@ -145,9 +145,9 @@ namespace Quantum.Workspace.Operations { /** List all jobs. */ #suppress "@azure-tools/typespec-azure-core/use-standard-operations" """ - We had to use a custom ResourceList to avoid an autoroute bug for workspace/jobs and sesssions/{sessionId}/jobs. - See https://github.com/Azure/typespec-azure/issues/494 - """ + We had to use a custom ResourceList to avoid an autoroute bug for workspace/jobs and sesssions/{sessionId}/jobs. + See https://github.com/Azure/typespec-azure/issues/494 + """ list is CustomListOperation< Resource = JobDetails, Response = PagedJobDetails diff --git a/specification/quantum/Quantum.Workspace/operations/sessions.tsp b/specification/quantum/Quantum.Workspace/operations/sessions.tsp index b76d055c6a12..3d2ab6dea487 100644 --- a/specification/quantum/Quantum.Workspace/operations/sessions.tsp +++ b/specification/quantum/Quantum.Workspace/operations/sessions.tsp @@ -86,9 +86,9 @@ namespace Quantum.Workspace.Operations { /** List jobs in a session. */ #suppress "@azure-tools/typespec-azure-core/no-operation-id" "The nesting of Jobs under a Session makes the auto-generated ID to be Sessions_JobsList, which is not in a Noun_Verb format." #suppress "@azure-tools/typespec-azure-core/use-standard-operations" """ - We had to use a custom ResourceList to avoid an autoroute bug for workspace/jobs and sesssions/{sessionId}/jobs. - See https://github.com/Azure/typespec-azure/issues/494 - """ + We had to use a custom ResourceList to avoid an autoroute bug for workspace/jobs and sesssions/{sessionId}/jobs. + See https://github.com/Azure/typespec-azure/issues/494 + """ @operationId("SessionsJobs_List") jobsList is CustomListOperation< Resource = JobDetails, diff --git a/specification/quantum/Quantum.Workspace/tspconfig.yaml b/specification/quantum/Quantum.Workspace/tspconfig.yaml index 603f3eb0f1c4..2e36cf34ec56 100644 --- a/specification/quantum/Quantum.Workspace/tspconfig.yaml +++ b/specification/quantum/Quantum.Workspace/tspconfig.yaml @@ -14,6 +14,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" examples-directory: examples omit-unreachable-types: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/quantum.json" diff --git a/specification/riskiq/Easm/models.tsp b/specification/riskiq/Easm/models.tsp index a131384ce3bc..74f37c48bd0b 100644 --- a/specification/riskiq/Easm/models.tsp +++ b/specification/riskiq/Easm/models.tsp @@ -220,6 +220,7 @@ model AssetPageResult { @resource("assets") model AssetResource { /** Discriminator property for AssetResource. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" kind: string; @doc("The system generated unique id for the resource.") @@ -483,6 +484,7 @@ model DataConnectionProperties {} @clientName("DataConnectionPayload", "csharp") model DataConnectionData { /** Discriminator property for DataConnectionData. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" kind: string; @doc("The name of data connection") @@ -503,6 +505,7 @@ model DataConnectionData { @resource("dataConnections") model DataConnection { /** Discriminator property for DataConnection. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" kind: string; @doc("The system generated unique id for the resource.") diff --git a/specification/riskiq/Easm/tspconfig.yaml b/specification/riskiq/Easm/tspconfig.yaml index 635dd75f996e..2f6eaacb276e 100644 --- a/specification/riskiq/Easm/tspconfig.yaml +++ b/specification/riskiq/Easm/tspconfig.yaml @@ -11,6 +11,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "examples" output-file: "{azure-resource-provider-folder}/Microsoft.Easm/{version-status}/{version}/easm.json" diff --git a/specification/schemaregistry/SchemaRegistry/tspconfig.yaml b/specification/schemaregistry/SchemaRegistry/tspconfig.yaml index 4672f92ac03c..71bf18d7f2bd 100644 --- a/specification/schemaregistry/SchemaRegistry/tspconfig.yaml +++ b/specification/schemaregistry/SchemaRegistry/tspconfig.yaml @@ -12,6 +12,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/../" output-file: "data-plane/Microsoft.SchemaRegistry/{version-status}/{version}/schemaregistry.json" examples-directory: examples diff --git a/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2021-10/schemaregistry.json b/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2021-10/schemaregistry.json index 67fe4fb35cad..87373cea78d2 100644 --- a/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2021-10/schemaregistry.json +++ b/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2021-10/schemaregistry.json @@ -374,17 +374,6 @@ "type": "file" }, "headers": { - "Content-Type": { - "type": "string", - "description": "The content type for given schema.", - "enum": [ - "application/json; serialization=Avro" - ], - "x-ms-enum": { - "modelAsString": false - }, - "x-nullable": false - }, "Location": { "type": "string", "description": "URL location of schema, identified by schema group, schema name, and version." @@ -460,17 +449,6 @@ "type": "file" }, "headers": { - "Content-Type": { - "type": "string", - "description": "The content type for given schema.", - "enum": [ - "application/json; serialization=Avro" - ], - "x-ms-enum": { - "modelAsString": false - }, - "x-nullable": false - }, "Location": { "type": "string", "description": "URL location of schema, identified by schema group, schema name, and version." diff --git a/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2022-10/schemaregistry.json b/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2022-10/schemaregistry.json index 54130caa7a12..153b174d8800 100644 --- a/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2022-10/schemaregistry.json +++ b/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2022-10/schemaregistry.json @@ -380,36 +380,6 @@ "type": "file" }, "headers": { - "Content-Type": { - "type": "string", - "description": "The content type for given schema.", - "enum": [ - "application/json; serialization=Avro", - "application/json; serialization=Json", - "text/plain; charset=utf-8" - ], - "x-ms-enum": { - "name": "SchemaContentTypeValues", - "modelAsString": false, - "values": [ - { - "name": "avro", - "value": "application/json; serialization=Avro", - "description": "Avro encoding." - }, - { - "name": "json", - "value": "application/json; serialization=Json", - "description": "JSON encoding" - }, - { - "name": "custom", - "value": "text/plain; charset=utf-8", - "description": "Plain text custom encoding." - } - ] - } - }, "Location": { "type": "string", "description": "URL location of schema, identified by schema group, schema name, and version." @@ -487,36 +457,6 @@ "type": "file" }, "headers": { - "Content-Type": { - "type": "string", - "description": "The content type for given schema.", - "enum": [ - "application/json; serialization=Avro", - "application/json; serialization=Json", - "text/plain; charset=utf-8" - ], - "x-ms-enum": { - "name": "SchemaContentTypeValues", - "modelAsString": false, - "values": [ - { - "name": "avro", - "value": "application/json; serialization=Avro", - "description": "Avro encoding." - }, - { - "name": "json", - "value": "application/json; serialization=Json", - "description": "JSON encoding" - }, - { - "name": "custom", - "value": "text/plain; charset=utf-8", - "description": "Plain text custom encoding." - } - ] - } - }, "Location": { "type": "string", "description": "URL location of schema, identified by schema group, schema name, and version." diff --git a/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2023-07-01/schemaregistry.json b/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2023-07-01/schemaregistry.json index cbd2f391aac3..f0d5d664e0d2 100644 --- a/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2023-07-01/schemaregistry.json +++ b/specification/schemaregistry/data-plane/Microsoft.SchemaRegistry/stable/2023-07-01/schemaregistry.json @@ -383,42 +383,6 @@ "type": "file" }, "headers": { - "Content-Type": { - "type": "string", - "description": "The content type for given schema.", - "enum": [ - "application/json; serialization=Avro", - "application/json; serialization=Json", - "text/plain; charset=utf-8", - "text/vnd.ms.protobuf" - ], - "x-ms-enum": { - "name": "SchemaContentTypeValues", - "modelAsString": false, - "values": [ - { - "name": "avro", - "value": "application/json; serialization=Avro", - "description": "Avro encoding." - }, - { - "name": "json", - "value": "application/json; serialization=Json", - "description": "JSON encoding" - }, - { - "name": "custom", - "value": "text/plain; charset=utf-8", - "description": "Plain text custom encoding." - }, - { - "name": "protobuf", - "value": "text/vnd.ms.protobuf", - "description": "Protobuf encoding." - } - ] - } - }, "Location": { "type": "string", "description": "URL location of schema, identified by schema group, schema name, and version." @@ -497,42 +461,6 @@ "type": "file" }, "headers": { - "Content-Type": { - "type": "string", - "description": "The content type for given schema.", - "enum": [ - "application/json; serialization=Avro", - "application/json; serialization=Json", - "text/plain; charset=utf-8", - "text/vnd.ms.protobuf" - ], - "x-ms-enum": { - "name": "SchemaContentTypeValues", - "modelAsString": false, - "values": [ - { - "name": "avro", - "value": "application/json; serialization=Avro", - "description": "Avro encoding." - }, - { - "name": "json", - "value": "application/json; serialization=Json", - "description": "JSON encoding" - }, - { - "name": "custom", - "value": "text/plain; charset=utf-8", - "description": "Plain text custom encoding." - }, - { - "name": "protobuf", - "value": "text/vnd.ms.protobuf", - "description": "Protobuf encoding." - } - ] - } - }, "Location": { "type": "string", "description": "URL location of schema, identified by schema group, schema name, and version." diff --git a/specification/scvmm/ScVmm.Management/Cloud.tsp b/specification/scvmm/ScVmm.Management/Cloud.tsp index 11df2b42e155..8c6534b30723 100644 --- a/specification/scvmm/ScVmm.Management/Cloud.tsp +++ b/specification/scvmm/ScVmm.Management/Cloud.tsp @@ -31,8 +31,13 @@ interface Clouds { @summary("Gets a Cloud.") get is ArmResourceRead; /** Onboards the ScVmm fabric cloud as an Azure cloud resource. */ + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @summary("Implements Clouds PUT method.") - createOrUpdate is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Cloud, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** Updates the Clouds resource. */ @summary("Implements the Clouds PATCH method.") @extension( diff --git a/specification/scvmm/ScVmm.Management/GuestAgent.tsp b/specification/scvmm/ScVmm.Management/GuestAgent.tsp index e2433aecf13a..d44f3bdae9cc 100644 --- a/specification/scvmm/ScVmm.Management/GuestAgent.tsp +++ b/specification/scvmm/ScVmm.Management/GuestAgent.tsp @@ -30,8 +30,13 @@ interface GuestAgents { @summary("Gets GuestAgent.") get is ArmResourceRead; /** Create Or Update GuestAgent. */ + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @summary("Implements GuestAgent PUT method.") - create is ArmResourceCreateOrReplaceAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrReplaceAsync< + GuestAgent, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** Implements GuestAgent DELETE method. */ @summary("Deletes a GuestAgent resource.") delete is ArmResourceDeleteSync; diff --git a/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp index 49377ff789d6..2fc0b9c11303 100644 --- a/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp +++ b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp @@ -57,8 +57,13 @@ interface VirtualMachineInstances { @summary("Gets a virtual machine.") get is ArmResourceRead; /** The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation. */ + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @summary("Implements virtual machine PUT method.") - createOrUpdate is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + VirtualMachineInstance, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** The operation to update a virtual machine instance. */ @summary("Updates a virtual machine.") @extension( diff --git a/specification/scvmm/ScVmm.Management/VirtualMachineTemplate.tsp b/specification/scvmm/ScVmm.Management/VirtualMachineTemplate.tsp index 4f047ef22e0e..0ed42912c736 100644 --- a/specification/scvmm/ScVmm.Management/VirtualMachineTemplate.tsp +++ b/specification/scvmm/ScVmm.Management/VirtualMachineTemplate.tsp @@ -32,8 +32,13 @@ interface VirtualMachineTemplates { @summary("Gets a VirtualMachineTemplate.") get is ArmResourceRead; /** Onboards the ScVmm VM Template as an Azure VM Template resource. */ + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @summary("Implements VirtualMachineTemplates PUT method.") - createOrUpdate is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + VirtualMachineTemplate, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** Updates the VirtualMachineTemplate resource. */ @summary("Implements the VirtualMachineTemplate PATCH method.") @extension( diff --git a/specification/scvmm/ScVmm.Management/VirtualNetwork.tsp b/specification/scvmm/ScVmm.Management/VirtualNetwork.tsp index 12a8e500b1f8..e879baffdb67 100644 --- a/specification/scvmm/ScVmm.Management/VirtualNetwork.tsp +++ b/specification/scvmm/ScVmm.Management/VirtualNetwork.tsp @@ -31,8 +31,13 @@ interface VirtualNetworks { @summary("Gets a VirtualNetwork.") get is ArmResourceRead; /** Onboards the ScVmm virtual network as an Azure virtual network resource. */ + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @summary("Implements VirtualNetworks PUT method.") - createOrUpdate is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + VirtualNetwork, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** Updates the VirtualNetworks resource. */ @summary("Implements the VirtualNetworks PATCH method.") @extension( diff --git a/specification/scvmm/ScVmm.Management/VmmServer.tsp b/specification/scvmm/ScVmm.Management/VmmServer.tsp index 3926037810b0..78273c31048b 100644 --- a/specification/scvmm/ScVmm.Management/VmmServer.tsp +++ b/specification/scvmm/ScVmm.Management/VmmServer.tsp @@ -31,8 +31,13 @@ interface VmmServers { @summary("Gets a VMMServer.") get is ArmResourceRead; /** Onboards the SCVmm fabric as an Azure VmmServer resource. */ + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @summary("Implements VmmServers PUT method.") - createOrUpdate is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + VmmServer, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** Updates the VmmServers resource. */ @summary("Implements VmmServers PATCH method.") @extension( diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json index bc3f2a2f3c66..b363355e44c4 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json @@ -3142,11 +3142,7 @@ "properties": { "$ref": "#/definitions/AvailabilitySetProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -3278,11 +3274,7 @@ "properties": { "$ref": "#/definitions/CloudProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -3495,11 +3487,7 @@ "properties": { "$ref": "#/definitions/GuestAgentProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3819,11 +3807,7 @@ "properties": { "$ref": "#/definitions/InventoryItemProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "kind": { "type": "string", @@ -4578,11 +4562,7 @@ "properties": { "$ref": "#/definitions/VirtualMachineInstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -4785,11 +4765,7 @@ "properties": { "$ref": "#/definitions/VirtualMachineTemplateProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -5002,11 +4978,7 @@ "properties": { "$ref": "#/definitions/VirtualNetworkProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -5111,11 +5083,7 @@ "properties": { "$ref": "#/definitions/VmInstanceHybridIdentityMetadataProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -5192,11 +5160,7 @@ "properties": { "$ref": "#/definitions/VmmServerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", diff --git a/specification/servicenetworking/ServiceNetworking.Management/main.tsp b/specification/servicenetworking/ServiceNetworking.Management/main.tsp index 170ee278e7cc..f42b4988387f 100644 --- a/specification/servicenetworking/ServiceNetworking.Management/main.tsp +++ b/specification/servicenetworking/ServiceNetworking.Management/main.tsp @@ -223,7 +223,12 @@ model ResourceId { @armResourceOperations interface AssociationsInterface { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Association, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; @@ -232,7 +237,12 @@ interface AssociationsInterface { @armResourceOperations interface FrontendsInterface { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Frontend, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; @@ -242,7 +252,12 @@ interface FrontendsInterface { @armResourceOperations interface SecurityPoliciesInterface { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + SecurityPolicy, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; @@ -251,7 +266,12 @@ interface SecurityPoliciesInterface { @armResourceOperations interface TrafficControllerInterface { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + TrafficController, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync< TrafficController, TrafficControllerProperties diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2024-05-01-preview/TrafficController.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2024-05-01-preview/TrafficController.json index 9d1d97a9baab..d406c4d8ddef 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2024-05-01-preview/TrafficController.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2024-05-01-preview/TrafficController.json @@ -1356,11 +1356,7 @@ "properties": { "$ref": "#/definitions/AssociationProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1491,11 +1487,7 @@ "properties": { "$ref": "#/definitions/FrontendProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1646,11 +1638,7 @@ "properties": { "$ref": "#/definitions/SecurityPolicyProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1757,11 +1745,7 @@ "properties": { "$ref": "#/definitions/TrafficControllerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json index 4d2dab80fd7c..69b74f74c5c0 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json @@ -1039,11 +1039,7 @@ "properties": { "$ref": "#/definitions/AssociationProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1174,11 +1170,7 @@ "properties": { "$ref": "#/definitions/FrontendProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1311,11 +1303,7 @@ "properties": { "$ref": "#/definitions/TrafficControllerProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/sphere/Sphere.Management/catalog.tsp b/specification/sphere/Sphere.Management/catalog.tsp index 5433c0aaffc2..4455d2403c5e 100644 --- a/specification/sphere/Sphere.Management/catalog.tsp +++ b/specification/sphere/Sphere.Management/catalog.tsp @@ -29,7 +29,12 @@ interface Catalogs { /** * Create a Catalog */ - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Catalog, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Update a Catalog diff --git a/specification/sphere/Sphere.Management/deployment.tsp b/specification/sphere/Sphere.Management/deployment.tsp index 93528a9375cb..9df999337d4b 100644 --- a/specification/sphere/Sphere.Management/deployment.tsp +++ b/specification/sphere/Sphere.Management/deployment.tsp @@ -29,7 +29,12 @@ interface Deployments { /** * Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. */ - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Deployment, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. diff --git a/specification/sphere/Sphere.Management/device.tsp b/specification/sphere/Sphere.Management/device.tsp index aacac197e1eb..d75447d78ada 100644 --- a/specification/sphere/Sphere.Management/device.tsp +++ b/specification/sphere/Sphere.Management/device.tsp @@ -30,7 +30,12 @@ interface Devices { /** * Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only. */ - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Device, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level. @@ -40,7 +45,8 @@ interface Devices { update is ArmCustomPatchAsync< Device, DeviceUpdate, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader >; /** diff --git a/specification/sphere/Sphere.Management/deviceGroup.tsp b/specification/sphere/Sphere.Management/deviceGroup.tsp index 45278f314465..0bfd227bee5b 100644 --- a/specification/sphere/Sphere.Management/deviceGroup.tsp +++ b/specification/sphere/Sphere.Management/deviceGroup.tsp @@ -30,7 +30,12 @@ interface DeviceGroups { /** * Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. */ - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + DeviceGroup, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. diff --git a/specification/sphere/Sphere.Management/image.tsp b/specification/sphere/Sphere.Management/image.tsp index 287eba68d7ba..49932e5b06e9 100644 --- a/specification/sphere/Sphere.Management/image.tsp +++ b/specification/sphere/Sphere.Management/image.tsp @@ -30,7 +30,12 @@ interface Images { /** * Create a Image */ - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Image, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Delete a Image diff --git a/specification/sphere/Sphere.Management/product.tsp b/specification/sphere/Sphere.Management/product.tsp index b470d59b440f..bc62bde56bc0 100644 --- a/specification/sphere/Sphere.Management/product.tsp +++ b/specification/sphere/Sphere.Management/product.tsp @@ -37,7 +37,12 @@ interface Products { /** * Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. */ - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Product, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json index 8dec71e19fd5..e3f5e4f8b6cc 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json @@ -2772,6 +2772,10 @@ "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", @@ -3167,11 +3171,7 @@ "properties": { "$ref": "#/definitions/CatalogProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3237,11 +3237,7 @@ "properties": { "$ref": "#/definitions/CertificateProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3416,11 +3412,7 @@ "properties": { "$ref": "#/definitions/DeploymentProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3493,11 +3485,7 @@ "properties": { "$ref": "#/definitions/DeviceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3513,11 +3501,7 @@ "properties": { "$ref": "#/definitions/DeviceGroupProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -3782,11 +3766,7 @@ "properties": { "$ref": "#/definitions/ImageProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -4095,11 +4075,7 @@ "properties": { "$ref": "#/definitions/ProductProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/splitio/SplitIO.Experimentation.Management/main.tsp b/specification/splitio/SplitIO.Experimentation.Management/main.tsp index f3c23e1cd34d..c65478dc7e8a 100644 --- a/specification/splitio/SplitIO.Experimentation.Management/main.tsp +++ b/specification/splitio/SplitIO.Experimentation.Management/main.tsp @@ -119,7 +119,12 @@ namespace SplitIO.Experimentation { @armResourceOperations interface ExperimentationWorkspaces { get is ArmResourceRead; - create is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + ExperimentationWorkspace, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchAsync< ExperimentationWorkspace, ExperimentationWorkspaceProperties diff --git a/specification/splitio/resource-manager/SplitIO.Experimentation/preview/2024-03-01-preview/splitio.json b/specification/splitio/resource-manager/SplitIO.Experimentation/preview/2024-03-01-preview/splitio.json index bda2742acea8..fdc038996b8b 100644 --- a/specification/splitio/resource-manager/SplitIO.Experimentation/preview/2024-03-01-preview/splitio.json +++ b/specification/splitio/resource-manager/SplitIO.Experimentation/preview/2024-03-01-preview/splitio.json @@ -576,11 +576,7 @@ "properties": { "$ref": "#/definitions/ExperimentationWorkspaceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "sku": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku", diff --git a/specification/standbypool/StandbyPool.Management/standbyContainerGroupPool.tsp b/specification/standbypool/StandbyPool.Management/standbyContainerGroupPool.tsp index 0a75e1a67e71..1ba16b8eb60d 100644 --- a/specification/standbypool/StandbyPool.Management/standbyContainerGroupPool.tsp +++ b/specification/standbypool/StandbyPool.Management/standbyContainerGroupPool.tsp @@ -106,7 +106,12 @@ model Subnet { @armResourceOperations interface StandbyContainerGroupPools { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + StandbyContainerGroupPoolResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; delete is ArmResourceDeleteWithoutOkAsync; update is ArmResourcePatchSync< StandbyContainerGroupPoolResource, diff --git a/specification/standbypool/StandbyPool.Management/standbyVMPool.tsp b/specification/standbypool/StandbyPool.Management/standbyVMPool.tsp index 4e880f4196aa..01a6d30ecd75 100644 --- a/specification/standbypool/StandbyPool.Management/standbyVMPool.tsp +++ b/specification/standbypool/StandbyPool.Management/standbyVMPool.tsp @@ -77,7 +77,12 @@ model StandbyVirtualMachinePoolElasticityProfile { @armResourceOperations interface StandbyVirtualMachinePools { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + StandbyVirtualMachinePoolResource, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; delete is ArmResourceDeleteWithoutOkAsync; update is ArmResourcePatchSync< StandbyVirtualMachinePoolResource, diff --git a/specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/standbypool.json b/specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/standbypool.json index dc398d937518..868c8cfac56d 100644 --- a/specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/standbypool.json +++ b/specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/standbypool.json @@ -1006,11 +1006,7 @@ "properties": { "$ref": "#/definitions/StandbyContainerGroupPoolResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1130,11 +1126,7 @@ "properties": { "$ref": "#/definitions/StandbyVirtualMachinePoolResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1254,11 +1246,7 @@ "properties": { "$ref": "#/definitions/StandbyVirtualMachineResourceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/translation/Azure.AI.DocumentTranslation/models.tsp b/specification/translation/Azure.AI.DocumentTranslation/models.tsp index 73ec6c09922c..98f36a54789c 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/models.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/models.tsp @@ -11,33 +11,33 @@ namespace DocumentTranslation; @doc("Document Translate Request Content") model DocumentTranslateContent { @doc(""" - Specifies source language of the input document. - If this parameter isn't specified, automatic language detection is applied to determine the source language. - For example if the source document is written in English, then use sourceLanguage=en - """) + Specifies source language of the input document. + If this parameter isn't specified, automatic language detection is applied to determine the source language. + For example if the source document is written in English, then use sourceLanguage=en + """) @query("sourceLanguage") sourceLanguage?: string; @doc(""" - Specifies the language of the output document. - The target language must be one of the supported languages included in the translation scope. - For example if you want to translate the document in German language, then use targetLanguage=de - """) + Specifies the language of the output document. + The target language must be one of the supported languages included in the translation scope. + For example if you want to translate the document in German language, then use targetLanguage=de + """) @query("targetLanguage") targetLanguage: string; @doc(""" - A string specifying the category (domain) of the translation. This parameter is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom Translator - project details to this parameter to use your deployed customized system. Default value is: general. - """) + A string specifying the category (domain) of the translation. This parameter is used to get translations + from a customized system built with Custom Translator. Add the Category ID from your Custom Translator + project details to this parameter to use your deployed customized system. Default value is: general. + """) @query("category") category?: string = "general"; @doc(""" - Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. - Possible values are: true (default) or false. - """) + Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. + Possible values are: true (default) or false. + """) @query("allowFallback") allowFallback?: boolean; @@ -183,9 +183,9 @@ model SourceInput { filter?: DocumentFilter; @doc(""" -Language code -If none is specified, we will perform auto detect on the document -""") + Language code + If none is specified, we will perform auto detect on the document + """) language?: string; @doc("Storage Source") @@ -195,18 +195,18 @@ If none is specified, we will perform auto detect on the document @doc("Document filter") model DocumentFilter { @doc(""" -A case-sensitive prefix string to filter documents in the source path for -translation. -For example, when using a Azure storage blob Uri, use the prefix -to restrict sub folders for translation. -""") + A case-sensitive prefix string to filter documents in the source path for + translation. + For example, when using a Azure storage blob Uri, use the prefix + to restrict sub folders for translation. + """) prefix?: string; @doc(""" -A case-sensitive suffix string to filter documents in the source path for -translation. -This is most often use for file extensions -""") + A case-sensitive suffix string to filter documents in the source path for + translation. + This is most often use for file extensions + """) suffix?: string; } @@ -231,13 +231,13 @@ model TargetInput { @doc("Glossary / translation memory for the request") model Glossary { @doc(""" -Location of the glossary. -We will use the file extension to extract the -formatting if the format parameter is not supplied. - -If the translation -language pair is not present in the glossary, it will not be applied -""") + Location of the glossary. + We will use the file extension to extract the + formatting if the format parameter is not supplied. + + If the translation + language pair is not present in the glossary, it will not be applied + """) glossaryUrl: string; @doc("Format") @@ -251,26 +251,26 @@ language pair is not present in the glossary, it will not be applied } @doc(""" -Contains unified error information used for HTTP responses across any Cognitive -Service. Instances -can be created either through -Microsoft.CloudAI.Containers.HttpStatusExceptionV2 or by returning it directly -from -a controller. -""") + Contains unified error information used for HTTP responses across any Cognitive + Service. Instances + can be created either through + Microsoft.CloudAI.Containers.HttpStatusExceptionV2 or by returning it directly + from + a controller. + """) @error model TranslationErrorResponse { @doc(""" -This contains an outer error with error code, message, details, target and an -inner error with more descriptive details. -""") + This contains an outer error with error code, message, details, target and an + inner error with more descriptive details. + """) error?: TranslationError; } @doc(""" -This contains an outer error with error code, message, details, target and an -inner error with more descriptive details. -""") + This contains an outer error with error code, message, details, target and an + inner error with more descriptive details. + """) model TranslationError { @doc("Enums containing high level error codes.") code: TranslationErrorCode; @@ -279,32 +279,32 @@ model TranslationError { message: string; @doc(""" -Gets the source of the error. -For example it would be \"documents\" or -\"document id\" in case of invalid document. -""") + Gets the source of the error. + For example it would be \"documents\" or + \"document id\" in case of invalid document. + """) @visibility("read") target?: string; @doc(""" -New Inner Error format which conforms to Cognitive Services API Guidelines -which is available at -https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. -This -contains required properties ErrorCode, message and optional properties target, -details(key value pair), inner error(this can be nested). -""") + New Inner Error format which conforms to Cognitive Services API Guidelines + which is available at + https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. + This + contains required properties ErrorCode, message and optional properties target, + details(key value pair), inner error(this can be nested). + """) innerError?: InnerTranslationError; } @doc(""" -New Inner Error format which conforms to Cognitive Services API Guidelines -which is available at -https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. -This -contains required properties ErrorCode, message and optional properties target, -details(key value pair), inner error(this can be nested). -""") + New Inner Error format which conforms to Cognitive Services API Guidelines + which is available at + https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. + This + contains required properties ErrorCode, message and optional properties target, + details(key value pair), inner error(this can be nested). + """) model InnerTranslationError { @doc("Gets code error string.") code: string; @@ -313,21 +313,21 @@ model InnerTranslationError { message: string; @doc(""" -Gets the source of the error. -For example it would be \"documents\" or -\"document id\" in case of invalid document. -""") + Gets the source of the error. + For example it would be \"documents\" or + \"document id\" in case of invalid document. + """) @visibility("read") target?: string; @doc(""" -New Inner Error format which conforms to Cognitive Services API Guidelines -which is available at -https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. -This -contains required properties ErrorCode, message and optional properties target, -details(key value pair), inner error(this can be nested). -""") + New Inner Error format which conforms to Cognitive Services API Guidelines + which is available at + https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. + This + contains required properties ErrorCode, message and optional properties target, + details(key value pair), inner error(this can be nested). + """) innerError?: InnerTranslationError; } @@ -360,9 +360,9 @@ model TranslationStatus { status: Status; @doc(""" -This contains an outer error with error code, message, details, target and an -inner error with more descriptive details. -""") + This contains an outer error with error code, message, details, target and an + inner error with more descriptive details. + """) error?: TranslationError; @doc("Status Summary") @@ -416,9 +416,9 @@ model DocumentStatus { to: string; @doc(""" -This contains an outer error with error code, message, details, target and an -inner error with more descriptive details. -""") + This contains an outer error with error code, message, details, target and an + inner error with more descriptive details. + """) error?: TranslationError; @doc("Progress of the translation if available") diff --git a/specification/translation/Azure.AI.DocumentTranslation/routes.tsp b/specification/translation/Azure.AI.DocumentTranslation/routes.tsp index 4216fe4f0747..63a640672fd5 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/routes.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/routes.tsp @@ -30,26 +30,26 @@ interface DocumentTranslationOperations { #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" @summary("Submit a document translation request to the Document Translation service") @doc(""" -Use this API to submit a bulk (batch) translation request to the Document -Translation service. -Each request can contain multiple documents and must -contain a source and destination container for each document. - -The -prefix and suffix filter (if supplied) are used to filter folders. The prefix -is applied to the subpath after the container name. - -Glossaries / -Translation memory can be included in the request and are applied by the -service when the document is translated. - -If the glossary is -invalid or unreachable during translation, an error is indicated in the -document status. -If a file with the same name already exists at the -destination, it will be overwritten. The targetUrl for each target language -must be unique. -""") + Use this API to submit a bulk (batch) translation request to the Document + Translation service. + Each request can contain multiple documents and must + contain a source and destination container for each document. + + The + prefix and suffix filter (if supplied) are used to filter folders. The prefix + is applied to the subpath after the container name. + + Glossaries / + Translation memory can be included in the request and are applied by the + service when the document is translated. + + If the glossary is + invalid or unreachable during translation, an error is indicated in the + document status. + If a file with the same name already exists at the + destination, it will be overwritten. The targetUrl for each target language + must be unique. + """) @pollingOperation(DocumentTranslationOperations.getTranslationStatus) @route("/document/batches") @post @@ -70,110 +70,110 @@ must be unique. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Doesn't fit standard ops" @summary("Returns a list of batch requests submitted and the status for each request") @doc(""" -Returns a list of batch requests submitted and the status for each -request. -This list only contains batch requests submitted by the user (based on -the resource). - -If the number of requests exceeds our paging limit, -server-side paging is used. Paginated responses indicate a partial result and -include a continuation token in the response. -The absence of a continuation -token means that no additional pages are available. - -top, skip -and maxpagesize query parameters can be used to specify a number of results to -return and an offset for the collection. - -top indicates the total -number of records the user wants to be returned across all pages. -skip -indicates the number of records to skip from the list of batches based on the -sorting method specified. By default, we sort by descending start -time. -maxpagesize is the maximum items returned in a page. If more items are -requested via top (or top is not specified and there are more items to be -returned), @nextLink will contain the link to the next page. - - -orderby query parameter can be used to sort the returned list (ex -\"orderby=createdDateTimeUtc asc\" or \"orderby=createdDateTimeUtc -desc\"). -The default sorting is descending by createdDateTimeUtc. -Some query -parameters can be used to filter the returned list (ex: -\"status=Succeeded,Cancelled\") will only return succeeded and cancelled -operations. -createdDateTimeUtcStart and createdDateTimeUtcEnd can be used -combined or separately to specify a range of datetime to filter the returned -list by. -The supported filtering query parameters are (status, ids, -createdDateTimeUtcStart, createdDateTimeUtcEnd). - -The server honors -the values specified by the client. However, clients must be prepared to handle -responses that contain a different page size or contain a continuation token. - - -When both top and skip are included, the server should first apply -skip and then top on the collection. -Note: If the server can't honor top -and/or skip, the server must return an error to the client informing about it -instead of just ignoring the query options. -This reduces the risk of the client -making assumptions about the data returned. -""") + Returns a list of batch requests submitted and the status for each + request. + This list only contains batch requests submitted by the user (based on + the resource). + + If the number of requests exceeds our paging limit, + server-side paging is used. Paginated responses indicate a partial result and + include a continuation token in the response. + The absence of a continuation + token means that no additional pages are available. + + top, skip + and maxpagesize query parameters can be used to specify a number of results to + return and an offset for the collection. + + top indicates the total + number of records the user wants to be returned across all pages. + skip + indicates the number of records to skip from the list of batches based on the + sorting method specified. By default, we sort by descending start + time. + maxpagesize is the maximum items returned in a page. If more items are + requested via top (or top is not specified and there are more items to be + returned), @nextLink will contain the link to the next page. + + + orderby query parameter can be used to sort the returned list (ex + \"orderby=createdDateTimeUtc asc\" or \"orderby=createdDateTimeUtc + desc\"). + The default sorting is descending by createdDateTimeUtc. + Some query + parameters can be used to filter the returned list (ex: + \"status=Succeeded,Cancelled\") will only return succeeded and cancelled + operations. + createdDateTimeUtcStart and createdDateTimeUtcEnd can be used + combined or separately to specify a range of datetime to filter the returned + list by. + The supported filtering query parameters are (status, ids, + createdDateTimeUtcStart, createdDateTimeUtcEnd). + + The server honors + the values specified by the client. However, clients must be prepared to handle + responses that contain a different page size or contain a continuation token. + + + When both top and skip are included, the server should first apply + skip and then top on the collection. + Note: If the server can't honor top + and/or skip, the server must return an error to the client informing about it + instead of just ignoring the query options. + This reduces the risk of the client + making assumptions about the data returned. + """) @route("/document/batches") @get getTranslationsStatus is Azure.Core.Foundations.Operation< { @doc(""" -top indicates the total number of records the user wants to be returned across -all pages. - -Clients MAY use top and skip query parameters to -specify a number of results to return and an offset into the collection. -When -both top and skip are given by a client, the server SHOULD first apply skip -and then top on the collection. - -Note: If the server can't honor -top and/or skip, the server MUST return an error to the client informing -about it instead of just ignoring the query options. -""") + top indicates the total number of records the user wants to be returned across + all pages. + + Clients MAY use top and skip query parameters to + specify a number of results to return and an offset into the collection. + When + both top and skip are given by a client, the server SHOULD first apply skip + and then top on the collection. + + Note: If the server can't honor + top and/or skip, the server MUST return an error to the client informing + about it instead of just ignoring the query options. + """) @maxValue(2147483647) @query("top") top?: int32; @doc(""" -skip indicates the number of records to skip from the list of records held by -the server based on the sorting method specified. By default, we sort by -descending start time. - -Clients MAY use top and skip query -parameters to specify a number of results to return and an offset into the -collection. -When both top and skip are given by a client, the server SHOULD -first apply skip and then top on the collection. - -Note: If the -server can't honor top and/or skip, the server MUST return an error to the -client informing about it instead of just ignoring the query options. -""") + skip indicates the number of records to skip from the list of records held by + the server based on the sorting method specified. By default, we sort by + descending start time. + + Clients MAY use top and skip query + parameters to specify a number of results to return and an offset into the + collection. + When both top and skip are given by a client, the server SHOULD + first apply skip and then top on the collection. + + Note: If the + server can't honor top and/or skip, the server MUST return an error to the + client informing about it instead of just ignoring the query options. + """) @maxValue(2147483647) @query("skip") skip?: int32; @doc(""" -maxpagesize is the maximum items returned in a page. If more items are -requested via top (or top is not specified and there are more items to be -returned), @nextLink will contain the link to the next page. - - -Clients MAY request server-driven paging with a specific page size by -specifying a maxpagesize preference. The server SHOULD honor this preference -if the specified page size is smaller than the server's default page size. -""") + maxpagesize is the maximum items returned in a page. If more items are + requested via top (or top is not specified and there are more items to be + returned), @nextLink will contain the link to the next page. + + + Clients MAY request server-driven paging with a specific page size by + specifying a maxpagesize preference. The server SHOULD honor this preference + if the specified page size is smaller than the server's default page size. + """) @maxValue(100) @minValue(1) @query("maxpagesize") @@ -214,9 +214,9 @@ if the specified page size is smaller than the server's default page size. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Doesn't fit standard ops" @summary("Returns the status for a specific document") @doc(""" -Returns the translation status for a specific document based on the request Id -and document Id. -""") + Returns the translation status for a specific document based on the request Id + and document Id. + """) @route("/document/batches/{id}/documents/{documentId}") @get getDocumentStatus is Azure.Core.Foundations.Operation< @@ -235,11 +235,11 @@ and document Id. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Doesn't fit standard ops" @summary("Returns the status for a document translation request") @doc(""" -Returns the status for a document translation request. -The status includes the -overall request status, as well as the status for documents that are being -translated as part of that request. -""") + Returns the status for a document translation request. + The status includes the + overall request status, as well as the status for documents that are being + translated as part of that request. + """) @route("/document/batches/{id}") @get getTranslationStatus is Azure.Core.Foundations.Operation< @@ -254,15 +254,15 @@ translated as part of that request. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Doesn't fit standard ops" @summary("Cancel a currently processing or queued translation") @doc(""" -Cancel a currently processing or queued translation. -A translation will not be -cancelled if it is already completed or failed or cancelling. A bad request -will be returned. -All documents that have completed translation will not be -cancelled and will be charged. -All pending documents will be cancelled if -possible. -""") + Cancel a currently processing or queued translation. + A translation will not be + cancelled if it is already completed or failed or cancelling. A bad request + will be returned. + All documents that have completed translation will not be + cancelled and will be charged. + All pending documents will be cancelled if + possible. + """) @route("/document/batches/{id}") @delete cancelTranslation is Azure.Core.Foundations.Operation< @@ -277,53 +277,53 @@ possible. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Doesn't fit standard ops" @summary("Returns the status for all documents in a batch document translation request") @doc(""" -Returns the status for all documents in a batch document translation request. - - -If the number of documents in the response exceeds our paging limit, -server-side paging is used. -Paginated responses indicate a partial result and -include a continuation token in the response. The absence of a continuation -token means that no additional pages are available. - -top, skip -and maxpagesize query parameters can be used to specify a number of results to -return and an offset for the collection. - -top indicates the total -number of records the user wants to be returned across all pages. -skip -indicates the number of records to skip from the list of document status held -by the server based on the sorting method specified. By default, we sort by -descending start time. -maxpagesize is the maximum items returned in a page. -If more items are requested via top (or top is not specified and there are -more items to be returned), @nextLink will contain the link to the next page. - - -orderby query parameter can be used to sort the returned list (ex -\"orderby=createdDateTimeUtc asc\" or \"orderby=createdDateTimeUtc -desc\"). -The default sorting is descending by createdDateTimeUtc. -Some query -parameters can be used to filter the returned list (ex: -\"status=Succeeded,Cancelled\") will only return succeeded and cancelled -documents. -createdDateTimeUtcStart and createdDateTimeUtcEnd can be used -combined or separately to specify a range of datetime to filter the returned -list by. -The supported filtering query parameters are (status, ids, -createdDateTimeUtcStart, createdDateTimeUtcEnd). - -When both top -and skip are included, the server should first apply skip and then top on -the collection. -Note: If the server can't honor top and/or skip, the server -must return an error to the client informing about it instead of just ignoring -the query options. -This reduces the risk of the client making assumptions about -the data returned. -""") + Returns the status for all documents in a batch document translation request. + + + If the number of documents in the response exceeds our paging limit, + server-side paging is used. + Paginated responses indicate a partial result and + include a continuation token in the response. The absence of a continuation + token means that no additional pages are available. + + top, skip + and maxpagesize query parameters can be used to specify a number of results to + return and an offset for the collection. + + top indicates the total + number of records the user wants to be returned across all pages. + skip + indicates the number of records to skip from the list of document status held + by the server based on the sorting method specified. By default, we sort by + descending start time. + maxpagesize is the maximum items returned in a page. + If more items are requested via top (or top is not specified and there are + more items to be returned), @nextLink will contain the link to the next page. + + + orderby query parameter can be used to sort the returned list (ex + \"orderby=createdDateTimeUtc asc\" or \"orderby=createdDateTimeUtc + desc\"). + The default sorting is descending by createdDateTimeUtc. + Some query + parameters can be used to filter the returned list (ex: + \"status=Succeeded,Cancelled\") will only return succeeded and cancelled + documents. + createdDateTimeUtcStart and createdDateTimeUtcEnd can be used + combined or separately to specify a range of datetime to filter the returned + list by. + The supported filtering query parameters are (status, ids, + createdDateTimeUtcStart, createdDateTimeUtcEnd). + + When both top + and skip are included, the server should first apply skip and then top on + the collection. + Note: If the server can't honor top and/or skip, the server + must return an error to the client informing about it instead of just ignoring + the query options. + This reduces the risk of the client making assumptions about + the data returned. + """) @route("/document/batches/{id}/documents") @get getDocumentsStatus is Azure.Core.Foundations.Operation< @@ -333,52 +333,52 @@ the data returned. id: uuid; @doc(""" -top indicates the total number of records the user wants to be returned across -all pages. - -Clients MAY use top and skip query parameters to -specify a number of results to return and an offset into the collection. -When -both top and skip are given by a client, the server SHOULD first apply skip -and then top on the collection. - -Note: If the server can't honor -top and/or skip, the server MUST return an error to the client informing -about it instead of just ignoring the query options. -""") + top indicates the total number of records the user wants to be returned across + all pages. + + Clients MAY use top and skip query parameters to + specify a number of results to return and an offset into the collection. + When + both top and skip are given by a client, the server SHOULD first apply skip + and then top on the collection. + + Note: If the server can't honor + top and/or skip, the server MUST return an error to the client informing + about it instead of just ignoring the query options. + """) @maxValue(2147483647) @query("top") top?: int32; @doc(""" -skip indicates the number of records to skip from the list of records held by -the server based on the sorting method specified. By default, we sort by -descending start time. - -Clients MAY use top and skip query -parameters to specify a number of results to return and an offset into the -collection. -When both top and skip are given by a client, the server SHOULD -first apply skip and then top on the collection. - -Note: If the -server can't honor top and/or skip, the server MUST return an error to the -client informing about it instead of just ignoring the query options. -""") + skip indicates the number of records to skip from the list of records held by + the server based on the sorting method specified. By default, we sort by + descending start time. + + Clients MAY use top and skip query + parameters to specify a number of results to return and an offset into the + collection. + When both top and skip are given by a client, the server SHOULD + first apply skip and then top on the collection. + + Note: If the + server can't honor top and/or skip, the server MUST return an error to the + client informing about it instead of just ignoring the query options. + """) @maxValue(2147483647) @query("skip") skip?: int32; @doc(""" -maxpagesize is the maximum items returned in a page. If more items are -requested via top (or top is not specified and there are more items to be -returned), @nextLink will contain the link to the next page. - - -Clients MAY request server-driven paging with a specific page size by -specifying a maxpagesize preference. The server SHOULD honor this preference -if the specified page size is smaller than the server's default page size. -""") + maxpagesize is the maximum items returned in a page. If more items are + requested via top (or top is not specified and there are more items to be + returned), @nextLink will contain the link to the next page. + + + Clients MAY request server-driven paging with a specific page size by + specifying a maxpagesize preference. The server SHOULD honor this preference + if the specified page size is smaller than the server's default page size. + """) @maxValue(100) @minValue(1) @query("maxpagesize") @@ -419,11 +419,11 @@ if the specified page size is smaller than the server's default page size. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Doesn't fit standard ops" @summary("Returns a list of supported document formats") @doc(""" -The list of supported formats supported by the Document Translation -service. -The list includes the common file extension, as well as the -content-type if using the upload API. -""") + The list of supported formats supported by the Document Translation + service. + The list includes the common file extension, as well as the + content-type if using the upload API. + """) @route("/document/formats") @get getSupportedFormats is Azure.Core.Foundations.Operation< diff --git a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml index 67f3ba7f125c..f673994872f2 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml @@ -12,6 +12,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/Azure.AI.DocumentTranslation/{version-status}/{version}/openapi.json" diff --git a/specification/translation/Azure.AI.TextTranslation/main.tsp b/specification/translation/Azure.AI.TextTranslation/main.tsp index 15d1567ee80a..80a0f963b586 100644 --- a/specification/translation/Azure.AI.TextTranslation/main.tsp +++ b/specification/translation/Azure.AI.TextTranslation/main.tsp @@ -16,31 +16,31 @@ using TypeSpec.Versioning; "Text translation is a cloud-based REST API feature of the Translator service that uses neural machine translation technology to enable quick and accurate source-to-target text translation in real time across all supported languages.", { @doc(""" -Supported Text Translation endpoints (protocol and hostname, for example: - https://api.cognitive.microsofttranslator.com). -""") + Supported Text Translation endpoints (protocol and hostname, for example: + https://api.cognitive.microsofttranslator.com). + """) Endpoint: url, } ) @doc(""" -Text translation is a cloud-based REST API feature of the Translator service that uses neural -machine translation technology to enable quick and accurate source-to-target text translation -in real time across all supported languages. - -The following methods are supported by the Text Translation feature: - -Languages. Returns a list of languages supported by Translate, Transliterate, and Dictionary Lookup operations. - -Translate. Renders single source-language text to multiple target-language texts with a single request. - -Transliterate. Converts characters or letters of a source language to the corresponding characters or letters of a target language. - -Detect. Returns the source code language code and a boolean variable denoting whether the detected language is supported for text translation and transliteration. - -Dictionary lookup. Returns equivalent words for the source term in the target language. - -Dictionary example Returns grammatical structure and context examples for the source term and target term pair. -""") + Text translation is a cloud-based REST API feature of the Translator service that uses neural + machine translation technology to enable quick and accurate source-to-target text translation + in real time across all supported languages. + + The following methods are supported by the Text Translation feature: + + Languages. Returns a list of languages supported by Translate, Transliterate, and Dictionary Lookup operations. + + Translate. Renders single source-language text to multiple target-language texts with a single request. + + Transliterate. Converts characters or letters of a source language to the corresponding characters or letters of a target language. + + Detect. Returns the source code language code and a boolean variable denoting whether the detected language is supported for text translation and transliteration. + + Dictionary lookup. Returns equivalent words for the source term in the target language. + + Dictionary example Returns grammatical structure and context examples for the source term and target term pair. + """) @versioned(APIVersion) namespace TextTranslation; diff --git a/specification/translation/Azure.AI.TextTranslation/models-languages.tsp b/specification/translation/Azure.AI.TextTranslation/models-languages.tsp index 340b68b4bd28..1e7e697ccf79 100644 --- a/specification/translation/Azure.AI.TextTranslation/models-languages.tsp +++ b/specification/translation/Azure.AI.TextTranslation/models-languages.tsp @@ -72,9 +72,9 @@ alias BaseLanguage = { }; @doc(""" -The value of the translation property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. -A key identifies a language for which text can be translated to or translated from. -""") + The value of the translation property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. + A key identifies a language for which text can be translated to or translated from. + """) model TranslationLanguage { ...BaseLanguage; @@ -83,10 +83,10 @@ model TranslationLanguage { } @doc(""" -The value of the transliteration property is a dictionary of (key, value) pairs. -Each key is a BCP 47 language tag. A key identifies a language for which text can be converted from one script -to another script. -""") + The value of the transliteration property is a dictionary of (key, value) pairs. + Each key is a BCP 47 language tag. A key identifies a language for which text can be converted from one script + to another script. + """) model TransliterationLanguage { ...BaseLanguage; diff --git a/specification/translation/Azure.AI.TextTranslation/models-translate.tsp b/specification/translation/Azure.AI.TextTranslation/models-translate.tsp index 0f938702d8c2..669300202e73 100644 --- a/specification/translation/Azure.AI.TextTranslation/models-translate.tsp +++ b/specification/translation/Azure.AI.TextTranslation/models-translate.tsp @@ -30,7 +30,7 @@ model TranslateParameters { Specifies the language of the input text. Find which languages are available to translate from by looking up supported languages using the translation scope. If the from parameter isn't specified, automatic language detection is applied to determine the source language. - + You must use the from parameter rather than autodetection when using the dynamic dictionary feature. Note: the dynamic dictionary feature is case-sensitive. """) @@ -103,7 +103,7 @@ model TranslateParameters { @doc(""" Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. Possible values are: true (default) or false. - + allowFallback=false specifies that the translation should only use systems trained for the category specified by the request. If a translation for language X to language Y requires chaining through a pivot language E, then all the systems in the chain (X → E and E → Y) will need to be custom and have the same category. @@ -125,7 +125,7 @@ model TranslationResult { @doc(""" Specifies the system type that was used for translation for each 'to' language requested for translation. The value is a comma-separated list of strings. Each string indicates a type: - + * Custom - Request includes a custom system and at least one custom system was used during translation. * Team - All other requests """) diff --git a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml index e8e1187c7105..754f49ac6449 100644 --- a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml @@ -14,6 +14,7 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "examples" output-file: "{azure-resource-provider-folder}/Azure.AI.TextTranslation/stable/v3.0/openapi.json" diff --git a/specification/verifiedid/Microsoft.VerifiedId/main.tsp b/specification/verifiedid/Microsoft.VerifiedId/main.tsp index 01f85aabab69..e33db6e1b6f7 100644 --- a/specification/verifiedid/Microsoft.VerifiedId/main.tsp +++ b/specification/verifiedid/Microsoft.VerifiedId/main.tsp @@ -71,7 +71,12 @@ model AuthorityProperties { @armResourceOperations(Authority) interface Authorities { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Authority, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; update is ArmResourcePatchSync; delete is ArmResourceDeleteSync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json index a97a1e596f5e..b87b4bc7ecab 100644 --- a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json @@ -390,11 +390,7 @@ "properties": { "$ref": "#/definitions/AuthorityProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/vmware/Microsoft.AVS/models.tsp b/specification/vmware/Microsoft.AVS/models.tsp index c1989f67724b..96139932f959 100644 --- a/specification/vmware/Microsoft.AVS/models.tsp +++ b/specification/vmware/Microsoft.AVS/models.tsp @@ -600,7 +600,7 @@ model Location is ProxyResource { @key("location") @path @segment("locations") - @Azure.ResourceManager.Private.armCommonParameter( + @Azure.ResourceManager.CommonTypes.Private.armCommonParameter( "LocationParameter", Azure.ResourceManager.CommonTypes.Versions.v5 ) @@ -672,11 +672,11 @@ model PrivateCloudUpdateProperties { encryption?: Encryption; @doc(""" -Array of additional networks noncontiguous with networkBlock. Networks must be -unique and non-overlapping across VNet in your subscription, on-premise, and -this privateCloud networkBlock attribute. Make sure the CIDR format conforms to -(A.B.C.D/X). -""") + Array of additional networks noncontiguous with networkBlock. Networks must be + unique and non-overlapping across VNet in your subscription, on-premise, and + this privateCloud networkBlock attribute. Make sure the CIDR format conforms to + (A.B.C.D/X). + """) extendedNetworkBlocks?: string[]; @doc("The type of DNS zone to use.") @@ -703,11 +703,11 @@ model PrivateCloudProperties { encryption?: Encryption; @doc(""" -Array of additional networks noncontiguous with networkBlock. Networks must be -unique and non-overlapping across VNet in your subscription, on-premise, and -this privateCloud networkBlock attribute. Make sure the CIDR format conforms to -(A.B.C.D/X). -""") + Array of additional networks noncontiguous with networkBlock. Networks must be + unique and non-overlapping across VNet in your subscription, on-premise, and + this privateCloud networkBlock attribute. Make sure the CIDR format conforms to + (A.B.C.D/X). + """) extendedNetworkBlocks?: string[]; @doc("The provisioning state") @@ -722,10 +722,10 @@ this privateCloud networkBlock attribute. Make sure the CIDR format conforms to endpoints?: Endpoints; @doc(""" -The block of addresses should be unique across VNet in your subscription as -well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where -A,B,C,D are between 0 and 255, and X is between 0 and 22 -""") + The block of addresses should be unique across VNet in your subscription as + well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where + A,B,C,D are between 0 and 255, and X is between 0 and 22 + """) networkBlock: string; @doc("Network used to access vCenter Server and NSX-T Manager") @@ -761,15 +761,15 @@ A,B,C,D are between 0 and 255, and X is between 0 and 22 externalCloudLinks?: string[]; @doc(""" -A secondary expressRoute circuit from a separate AZ. Only present in a -stretched private cloud -""") + A secondary expressRoute circuit from a separate AZ. Only present in a + stretched private cloud + """) secondaryCircuit?: Circuit; @doc(""" -Flag to indicate whether the private cloud has the quota for provisioned NSX -Public IP count raised from 64 to 1024 -""") + Flag to indicate whether the private cloud has the quota for provisioned NSX + Public IP count raised from 64 to 1024 + """) @visibility("read") nsxPublicIpQuotaRaised?: NsxPublicIpQuotaRaisedEnum; @@ -887,15 +887,15 @@ model IdentitySource { ssl?: SslEnum; @doc(""" -The ID of an Active Directory user with a minimum of read-only access to Base -DN for users and group -""") + The ID of an Active Directory user with a minimum of read-only access to Base + DN for users and group + """) username?: string; @doc(""" -The password of the Active Directory user with a minimum of read-only access to -Base DN for users and groups. -""") + The password of the Active Directory user with a minimum of read-only access to + Base DN for users and groups. + """) @secret password?: string; } @@ -1045,9 +1045,9 @@ model DiskPoolVolume { lunName: string; @doc(""" -Mode that describes whether the LUN has to be mounted as a datastore or -attached as a LUN -""") + Mode that describes whether the LUN has to be mounted as a datastore or + attached as a LUN + """) mountOption?: MountOptionEnum = MountOptionEnum.MOUNT; @doc("Device path") @@ -1173,16 +1173,16 @@ model GlobalReachConnectionProperties { provisioningState?: GlobalReachConnectionProvisioningState; @doc(""" -The network used for global reach carved out from the original network block -provided for the private cloud -""") + The network used for global reach carved out from the original network block + provided for the private cloud + """) @visibility("read") addressPrefix?: string; @doc(""" -Authorization key from the peer express route used for the global reach -connection -""") + Authorization key from the peer express route used for the global reach + connection + """) authorizationKey?: string; @doc("The connection status of the global reach connection") @@ -1190,15 +1190,15 @@ connection circuitConnectionStatus?: GlobalReachConnectionStatus; @doc(""" -Identifier of the ExpressRoute Circuit to peer with in the global reach -connection -""") + Identifier of the ExpressRoute Circuit to peer with in the global reach + connection + """) peerExpressRouteCircuit?: string; @doc(""" -The ID of the Private Cloud's ExpressRoute Circuit that is participating in the -global reach connection -""") + The ID of the Private Cloud's ExpressRoute Circuit that is participating in the + global reach connection + """) expressRouteId?: string; } @@ -1331,9 +1331,9 @@ union DhcpTypeEnum { string, } @doc(""" -Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to -inherit from -""") + Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to + inherit from + """) @discriminator("dhcpType") model WorkloadNetworkDhcpEntity { @doc("Type of DHCP: SERVER or RELAY.") @@ -1945,9 +1945,9 @@ union ScriptCmdletAudience { @doc("An parameter that the script will accept") model ScriptParameter { @doc(""" -The type of parameter the script is expecting. psCredential is a -PSCredentialObject -""") + The type of parameter the script is expecting. psCredential is a + PSCredentialObject + """) @visibility("read") type?: ScriptParameterTypes; @@ -1959,9 +1959,9 @@ PSCredentialObject description?: string; @doc(""" -Should this parameter be visible to arm and passed in the parameters argument -when executing -""") + Should this parameter be visible to arm and passed in the parameters argument + when executing + """) @visibility("read") visibility?: VisibilityParameterEnum; @@ -1992,15 +1992,15 @@ model ScriptExecutionProperties { #suppress "@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers" @doc(""" -Parameters that will be hidden/not visible to ARM, such as passwords and -credentials -""") + Parameters that will be hidden/not visible to ARM, such as passwords and + credentials + """) hiddenParameters?: ScriptExecutionParameter[]; @doc(""" -Error message if the script was able to run, but if the script itself had -errors or powershell threw an exception -""") + Error message if the script was able to run, but if the script itself had + errors or powershell threw an exception + """) failureReason?: string; @doc("Time limit for execution") diff --git a/specification/vmware/Microsoft.AVS/routes.tsp b/specification/vmware/Microsoft.AVS/routes.tsp index 6cb36ffd5f2c..b380e6871654 100644 --- a/specification/vmware/Microsoft.AVS/routes.tsp +++ b/specification/vmware/Microsoft.AVS/routes.tsp @@ -34,23 +34,29 @@ interface Locations { ): ArmResponse | ErrorResponse; } +alias PrivateCloudList = ResourceList; @armResourceOperations interface PrivateClouds { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("PrivateClouds_List") list is ArmResourceListByParent< PrivateCloud, - Response = ArmResponse> + Response = ArmResponse >; listInSubscription is ArmListBySubscription< PrivateCloud, - Response = ArmResponse> + Response = ArmResponse >; get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + PrivateCloud, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; // This could be modeled with ArmCustomPatchAsync if a 202 response with no body is used instead of a 201. // update is ArmCustomPatchAsync; @@ -122,7 +128,12 @@ interface Clusters { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Cluster, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; // This could be modeled with ArmCustomPatchAsync if a 202 response with no body is used instead of a 201. // update is ArmCustomPatchAsync; @@ -183,7 +194,12 @@ interface Datastores { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Datastore, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "deprecated" #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" @@ -239,9 +255,12 @@ interface Authorizations { get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST REMOVE AT NEXT API VERSION UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrUpdateAsync< ExpressRouteAuthorization, - BaseParameters + BaseParameters, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; #suppress "deprecated" @@ -272,7 +291,12 @@ interface GlobalReachConnections { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + GlobalReachConnection, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "deprecated" #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" @@ -319,8 +343,13 @@ interface WorkloadNetworkSegments { get is ArmResourceRead; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @operationId("WorkloadNetworks_CreateSegments") - create is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkSegment, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdateSegments") @@ -386,8 +415,13 @@ interface WorkloadNetworkDhcpConfigurations { ): ArmResponse | ErrorResponse; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @operationId("WorkloadNetworks_CreateDhcp") - create is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkDhcp, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdateDhcp") @@ -467,8 +501,13 @@ interface WorkloadNetworkPortMirroringProfiles { get is ArmResourceRead; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @operationId("WorkloadNetworks_CreatePortMirroring") - create is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkPortMirroring, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdatePortMirroring") @@ -544,8 +583,13 @@ interface WorkloadNetworkVmGroups { get is ArmResourceRead; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @operationId("WorkloadNetworks_CreateVMGroup") - create is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkVMGroup, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdateVMGroup") @@ -642,8 +686,13 @@ interface WorkloadNetworkDnsServices { get is ArmResourceRead; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @operationId("WorkloadNetworks_CreateDnsService") - create is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkDnsService, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdateDnsService") @@ -719,8 +768,13 @@ interface WorkloadNetworkDnsZones { get is ArmResourceRead; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @operationId("WorkloadNetworks_CreateDnsZone") - create is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkDnsZone, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdateDnsZone") @@ -795,8 +849,13 @@ interface WorkloadNetworkPublicIps { get is ArmResourceRead; #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" @operationId("WorkloadNetworks_CreatePublicIP") - create is ArmResourceCreateOrUpdateAsync; + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkPublicIP, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "PublicIPIdParameter should be last, but it is breaking to correct it." #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @@ -846,7 +905,12 @@ interface CloudLinks { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + CloudLink, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "deprecated" #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" @@ -874,7 +938,12 @@ interface Addons { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Addon, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "deprecated" #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" @@ -930,7 +999,12 @@ interface PlacementPolicies { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + PlacementPolicy, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; // 202 response has a body, but it should not to match ArmCustomPatchAsync. // update is ArmCustomPatchAsync; @@ -1013,7 +1087,12 @@ interface ScriptExecutions { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + ScriptExecution, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "deprecated" #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" @@ -1058,7 +1137,12 @@ interface IscsiPaths { get is ArmResourceRead; - createOrUpdate is ArmResourceCreateOrUpdateAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + IscsiPath, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; #suppress "deprecated" #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json index 81a5cb077afb..fb82d0d15cb2 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json @@ -2629,6 +2629,9 @@ "$ref": "./examples/VirtualMachines_RestrictMovement.json" } }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-long-running-operation": true } }, @@ -6513,11 +6516,7 @@ "properties": { "$ref": "#/definitions/AddonProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -6903,11 +6902,7 @@ "properties": { "$ref": "#/definitions/CloudLinkProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -7037,11 +7032,7 @@ "properties": { "$ref": "#/definitions/ClusterProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "sku": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku", @@ -7233,11 +7224,7 @@ "properties": { "$ref": "#/definitions/DatastoreProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -7753,11 +7740,7 @@ "properties": { "$ref": "#/definitions/ExpressRouteAuthorizationProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -7856,11 +7839,7 @@ "properties": { "$ref": "#/definitions/GlobalReachConnectionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -7997,11 +7976,7 @@ "properties": { "$ref": "#/definitions/HcxEnterpriseSiteProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -8198,11 +8173,7 @@ "properties": { "$ref": "#/definitions/IscsiPathProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -8453,11 +8424,7 @@ "properties": { "$ref": "#/definitions/PlacementPolicyProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -8692,11 +8659,7 @@ "properties": { "$ref": "#/definitions/PrivateCloudProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "sku": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku", @@ -9078,11 +9041,7 @@ "properties": { "$ref": "#/definitions/ScriptCmdletProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -9209,11 +9168,7 @@ "properties": { "$ref": "#/definitions/ScriptExecutionProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -9495,11 +9450,7 @@ "properties": { "$ref": "#/definitions/ScriptPackageProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -9859,11 +9810,7 @@ "properties": { "$ref": "#/definitions/VirtualMachineProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -10090,11 +10037,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -10110,11 +10053,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkDhcpEntity", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -10354,11 +10293,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkDnsServiceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -10499,11 +10434,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkDnsZoneProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -10643,11 +10574,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkGatewayProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -10725,11 +10652,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkPortMirroringProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -10923,11 +10846,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkPublicIPProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -11038,11 +10957,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkSegmentProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -11208,11 +11123,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkVMGroupProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -11341,11 +11252,7 @@ "properties": { "$ref": "#/definitions/WorkloadNetworkVirtualMachineProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/voiceservices/VoiceServices.Provisioning/tspconfig.yaml b/specification/voiceservices/VoiceServices.Provisioning/tspconfig.yaml index 0690263a97e1..203ad187961a 100644 --- a/specification/voiceservices/VoiceServices.Provisioning/tspconfig.yaml +++ b/specification/voiceservices/VoiceServices.Provisioning/tspconfig.yaml @@ -10,6 +10,7 @@ emit: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/swagger.json" diff --git a/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPDiscoverySite.tsp b/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPDiscoverySite.tsp index cf1c04eb5504..a3b3b3193aaf 100644 --- a/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPDiscoverySite.tsp +++ b/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPDiscoverySite.tsp @@ -36,7 +36,12 @@ interface SAPDiscoverySites { /** * Creates a discovery site resource for SAP Migration. This resource will be used to run system discovery and assessment with Azure Migrate. */ - create is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrReplaceAsync< + SAPDiscoverySite, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Updates a SAP Migration discovery site resource. diff --git a/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPInstance.tsp b/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPInstance.tsp index f70c9a2bce2e..4fc5f70be91c 100644 --- a/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPInstance.tsp +++ b/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPInstance.tsp @@ -32,7 +32,12 @@ interface SAPInstances { /** * Creates the SAP Instance resource.

This will be used by service only. PUT operation on this resource by end user will return a Bad Request error. */ - create is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrReplaceAsync< + SAPInstance, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Updates the SAP Instance resource. diff --git a/specification/workloads/Workloads.SAPDiscoverySite.Management/ServerInstance.tsp b/specification/workloads/Workloads.SAPDiscoverySite.Management/ServerInstance.tsp index 053290d8b0bf..b6d6be8903e9 100644 --- a/specification/workloads/Workloads.SAPDiscoverySite.Management/ServerInstance.tsp +++ b/specification/workloads/Workloads.SAPDiscoverySite.Management/ServerInstance.tsp @@ -29,7 +29,12 @@ interface ServerInstances { /** * Creates the Server Instance resource.

;This will be used by service only. PUT operation on this resource by end user will return a Bad Request error. */ - create is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrReplaceAsync< + ServerInstance, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Updates the Server Instance resource. This operation on a resource by end user will return a Bad Request error. diff --git a/specification/workloads/Workloads.SAPMonitor.Management/Monitor.tsp b/specification/workloads/Workloads.SAPMonitor.Management/Monitor.tsp index 52a5d27b84c8..542752e4af90 100644 --- a/specification/workloads/Workloads.SAPMonitor.Management/Monitor.tsp +++ b/specification/workloads/Workloads.SAPMonitor.Management/Monitor.tsp @@ -31,7 +31,12 @@ interface Monitors { /** * Creates a SAP monitor for the specified subscription, resource group, and resource name. */ - create is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrReplaceAsync< + Monitor, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Patches the Tags field of a SAP monitor for the specified subscription, resource group, and SAP monitor name. diff --git a/specification/workloads/Workloads.SAPMonitor.Management/ProviderInstance.tsp b/specification/workloads/Workloads.SAPMonitor.Management/ProviderInstance.tsp index 2e43d502005a..a5a36bfb2c24 100644 --- a/specification/workloads/Workloads.SAPMonitor.Management/ProviderInstance.tsp +++ b/specification/workloads/Workloads.SAPMonitor.Management/ProviderInstance.tsp @@ -29,7 +29,12 @@ interface ProviderInstances { /** * Creates a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. */ - create is ArmResourceCreateOrReplaceAsync; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrReplaceAsync< + ProviderInstance, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; /** * Deletes a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. diff --git a/specification/workloads/Workloads.SAPMonitor.Management/models.tsp b/specification/workloads/Workloads.SAPMonitor.Management/models.tsp index 1821020722b0..f2473c62f089 100644 --- a/specification/workloads/Workloads.SAPMonitor.Management/models.tsp +++ b/specification/workloads/Workloads.SAPMonitor.Management/models.tsp @@ -272,6 +272,7 @@ model ProviderSpecificProperties { /** * The provider type. For example, the value can be SapHana. */ + #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" @visibility("read", "create") providerType: string; } diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPDiscoverySites/preview/2023-10-01-preview/SAPDiscoverySites.json b/specification/workloads/resource-manager/Microsoft.Workloads/SAPDiscoverySites/preview/2023-10-01-preview/SAPDiscoverySites.json index 72f5ae3e013c..1774bbafa200 100644 --- a/specification/workloads/resource-manager/Microsoft.Workloads/SAPDiscoverySites/preview/2023-10-01-preview/SAPDiscoverySites.json +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPDiscoverySites/preview/2023-10-01-preview/SAPDiscoverySites.json @@ -1477,11 +1477,7 @@ "properties": { "$ref": "#/definitions/SAPDiscoverySiteProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -1559,11 +1555,7 @@ "properties": { "$ref": "#/definitions/SAPInstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1762,11 +1754,7 @@ "properties": { "$ref": "#/definitions/ServerInstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/monitors/preview/2023-12-01-preview/monitors.json b/specification/workloads/resource-manager/Microsoft.Workloads/monitors/preview/2023-12-01-preview/monitors.json index 6c6243b4b835..927ac4174174 100644 --- a/specification/workloads/resource-manager/Microsoft.Workloads/monitors/preview/2023-12-01-preview/monitors.json +++ b/specification/workloads/resource-manager/Microsoft.Workloads/monitors/preview/2023-12-01-preview/monitors.json @@ -1126,11 +1126,7 @@ "properties": { "$ref": "#/definitions/MonitorProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", @@ -1335,11 +1331,7 @@ "properties": { "$ref": "#/definitions/ProviderInstanceProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ @@ -1565,11 +1557,7 @@ "properties": { "$ref": "#/definitions/SapLandscapeMonitorProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true } }, "allOf": [ From bbd815a2b70f4ebcf463c26aa4dbc258e1d40ecc Mon Sep 17 00:00:00 2001 From: "Alex Matei (Microsoft)" <168020294+almat-msft@users.noreply.github.com> Date: Fri, 14 Jun 2024 01:09:20 -0700 Subject: [PATCH 177/343] Microsoft.DesktopVirtualization 2024-04-08-preview (#29101) * Copy files from stable/2024-04-03 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-04-08-preview Updated the API version from stable/2024-04-03 to preview/2024-04-08-preview. * Added tag for 2024-04-08-preview in readme file * Merge changes from 2024-03-06-preview * Merge changes in examples folder from 2024-03-06-preview [part 1] * Merge changes in examples folder from 2024-03-06-preview [part 2] * Switch back to v5 api versions * Add missing example * Add missing example (part 2) * Add missing example (part 3) * Adjust versioning in examples * Let's fix MSI image uri example * Let's bring back v5 types * Fix patchBody + suppress false positives * Let's fix prettier * Let's fix prettier (part 2) * Bootstrap identity support * Add the missing object type * Relax restrictions for PATCH indentity payload * Minimize breaking change footprint for ManagedIdentity payload * Minimize breaking change footprint for ManagedIdentity payload (2) * Minimize breaking change footprint for ManagedIdentity payload (3) * Minimize breaking change footprint for ManagedIdentity payload (4) * More background info on why the supression is needed * Try to help SDK creation * Influence SDK from main readme.md * Fix .NET SDK * (Back) Influence SDK from main readme.md * Fix imageType * Let's rename the Identity object schema * Let's rename also the suppressions with the new Identity object schema * Remove initial props for SDK creation * Revert "Identity renaming" This reverts commit b0e0d282a99d62a0b3c39468e395946cc7552332. Revert "Let's rename also the suppressions with the new Identity object schema" This reverts commit 9c7bb1415df71c95ed69d0dff21a51221bd66fc1. Revert "Let's rename the Identity object schema" This reverts commit e5bc0090bb9efd223482ac9b642264a3283dcce0. * Let's update common types v6 * Align commontypes/v6/Identity with the latest MSI contract * Move Desktop Virtualization/HostPool on top of commonTypes/v6/Identity * Prettier * Fix identity for PATCH * No need for GUID suppression anymore * Copy files from stable/2024-04-03 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-04-08-preview Updated the API version from stable/2024-04-03 to preview/2024-04-08-preview. * Added tag for 2024-04-08-preview in readme file * Merge changes from 2024-03-06-preview * Merge changes in examples folder from 2024-03-06-preview [part 1] * Merge changes in examples folder from 2024-03-06-preview [part 2] * Switch back to v5 api versions * Add missing example * Add missing example (part 2) * Add missing example (part 3) * Adjust versioning in examples * Let's fix MSI image uri example * Let's bring back v5 types * Fix patchBody + suppress false positives * Let's fix prettier * Let's fix prettier (part 2) * Bootstrap identity support * Add the missing object type * Relax restrictions for PATCH indentity payload * Minimize breaking change footprint for ManagedIdentity payload * Minimize breaking change footprint for ManagedIdentity payload (2) * Minimize breaking change footprint for ManagedIdentity payload (3) * Minimize breaking change footprint for ManagedIdentity payload (4) * More background info on why the supression is needed * Try to help SDK creation * Influence SDK from main readme.md * Fix .NET SDK * (Back) Influence SDK from main readme.md * Fix imageType * Let's rename the Identity object schema * Let's rename also the suppressions with the new Identity object schema * Remove initial props for SDK creation * Revert "Identity renaming" This reverts commit b0e0d282a99d62a0b3c39468e395946cc7552332. Revert "Let's rename also the suppressions with the new Identity object schema" This reverts commit 9c7bb1415df71c95ed69d0dff21a51221bd66fc1. Revert "Let's rename the Identity object schema" This reverts commit e5bc0090bb9efd223482ac9b642264a3283dcce0. * Let's update common types v6 * Align commontypes/v6/Identity with the latest MSI contract * Move Desktop Virtualization/HostPool on top of commonTypes/v6/Identity * Prettier * Fix identity for PATCH * No need for GUID suppression anymore * SessionHost update 2024-04-08-preview [OKW] Control update of session hosts in host pool We will use v6 managedIdentity changes from a separate PR [OKW] SHC op status [OKW] SHMgmts op status [OKW] SHMgmts op status (2) [OKW] SHMgmts control provisioning [OKW] SHMgmts op status (3) [OKW] SHMgmts control provisioning - not needed [OKW] SHMgmts update status - properties [OKW] SHMgmts update status - path + example * Remove v6 types * Comments from review * Port VmPath * Linter fixes * Linter fixes (2) * No modeler suppression :) * Add Hibernate for rampDownActionOnDisconnect * Add Hibernate for other states * HostPool Type changes * Be more specific with suppression AvoidAdditionalProperties * Be more specific with suppressions whenever possible * Changes based on feedback from Razvan * Remove redundant systemData * InitiateSessionHostUpdate * Fix typo * Prettier * Remove obsolete examples * Remove empty loopbackUrl from apptattach examples * Remove empty loopbackUrl from apptattach examples(2) * Remove empty loopbackUrl from apptattach examples(3) + x-nullable * Update examples to use the correct storageUri format * storageUri should be nullable * HostPool should use the correct Identity definition * Prettier * Upgrade v5->v6 --- .../desktopvirtualization.json | 9954 +++++++++++++++++ .../ActiveSessionHostConfigurations_Get.json | 88 + ...sionHostConfigurations_ListByHostPool.json | 92 + .../AppAttachPackageInfo_Import_Post.json | 126 + .../examples/AppAttachPackage_Create.json | 167 + .../examples/AppAttachPackage_Delete.json | 66 + .../examples/AppAttachPackage_Get.json | 67 + .../AppAttachPackage_ListByResourceGroup.json | 126 + .../AppAttachPackage_ListBySubscription.json | 125 + .../examples/AppAttachPackage_Update.json | 108 + .../examples/ApplicationGroup_Create.json | 84 + .../examples/ApplicationGroup_Delete.json | 39 + .../examples/ApplicationGroup_Get.json | 40 + .../ApplicationGroup_ListByResourceGroup.json | 75 + .../ApplicationGroup_ListBySubscription.json | 74 + .../examples/ApplicationGroup_Update.json | 51 + .../examples/Application_Create.json | 85 + .../examples/Application_Delete.json | 41 + .../examples/Application_Get.json | 42 + .../examples/Application_List.json | 77 + .../examples/Application_Update.json | 57 + .../examples/Desktop_Get.json | 33 + .../examples/Desktop_List.json | 39 + .../examples/Desktop_Update.json | 39 + .../examples/HostPool_Create.json | 187 + .../examples/HostPool_Delete.json | 70 + .../examples/HostPool_Get.json | 83 + .../examples/HostPool_List.json | 143 + .../HostPool_ListByResourceGroup.json | 144 + .../examples/HostPool_Update.json | 118 + ...tPools_RetrieveRegistrationToken_Post.json | 17 + .../examples/MsixImage_Expand_Post.json | 99 + .../examples/MsixPackage_Create.json | 130 + .../examples/MsixPackage_Delete.json | 54 + .../examples/MsixPackage_Get.json | 55 + .../examples/MsixPackage_List.json | 103 + .../examples/MsixPackage_Update.json | 62 + .../examples/OperationDescription_List.json | 51 + ...teEndpointConnection_DeleteByHostPool.json | 13 + ...eEndpointConnection_DeleteByWorkspace.json | 13 + ...ivateEndpointConnection_GetByHostPool.json | 37 + ...vateEndpointConnection_GetByWorkspace.json | 37 + ...vateEndpointConnection_ListByHostPool.json | 40 + ...ateEndpointConnection_ListByWorkspace.json | 40 + ...teEndpointConnection_UpdateByHostPool.json | 46 + ...eEndpointConnection_UpdateByWorkspace.json | 46 + .../PrivateLinkResources_ListByHostPool.json | 33 + .../PrivateLinkResources_ListByWorkspace.json | 33 + .../ScalingPlanPersonalSchedule_Create.json | 180 + .../ScalingPlanPersonalSchedule_Delete.json | 13 + .../ScalingPlanPersonalSchedule_Get.json | 72 + .../ScalingPlanPersonalSchedule_List.json | 134 + .../ScalingPlanPersonalSchedule_Update.json | 101 + .../ScalingPlanPooledSchedule_Create.json | 151 + .../ScalingPlanPooledSchedule_Delete.json | 13 + .../ScalingPlanPooledSchedule_Get.json | 62 + .../ScalingPlanPooledSchedule_List.json | 114 + .../ScalingPlanPooledSchedule_Update.json | 82 + .../examples/ScalingPlan_Create.json | 215 + .../examples/ScalingPlan_Delete.json | 82 + .../examples/ScalingPlan_Get.json | 83 + .../examples/ScalingPlan_ListByHostPool.json | 90 + .../ScalingPlan_ListByResourceGroup.json | 159 + .../ScalingPlan_ListBySubscription.json | 158 + .../examples/ScalingPlan_Update.json | 140 + .../SessionHostConfigurations_Create.json | 238 + .../SessionHostConfigurations_Get.json | 89 + ...sionHostConfigurations_ListByHostPool.json | 93 + .../SessionHostConfigurations_Update.json | 157 + ...gements_ControlSessionHostUpdate_Post.json | 20 + .../SessionHostManagements_Create.json | 69 + .../examples/SessionHostManagements_Get.json | 37 + ...SessionHostManagements_ListByHostPool.json | 38 + .../SessionHostManagements_Update.json | 45 + ...stManagements_UpdateSessionHosts_Post.json | 21 + ...ssionHostManagements_UpdateStatus_Get.json | 24 + .../examples/SessionHost_Delete.json | 57 + .../examples/SessionHost_Get.json | 57 + .../examples/SessionHost_List.json | 107 + .../SessionHost_RetryProvisioning_Post.json | 12 + .../examples/SessionHost_Update.json | 65 + .../examples/StartMenuItem_List.json | 40 + .../examples/UserSession_Delete.json | 35 + .../examples/UserSession_Disconnect_Post.json | 13 + .../examples/UserSession_Get.json | 35 + .../examples/UserSession_List.json | 62 + .../examples/UserSession_ListByHostPool.json | 62 + .../UserSession_SendMessage_Post.json | 17 + .../examples/Workspace_Create.json | 73 + .../examples/Workspace_Delete.json | 35 + .../examples/Workspace_Get.json | 36 + .../Workspace_ListByResourceGroup.json | 66 + .../Workspace_ListBySubscription.json | 65 + .../examples/Workspace_Update.json | 46 + .../resource-manager/readme.md | 29 +- 95 files changed, 16940 insertions(+), 1 deletion(-) create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ActiveSessionHostConfigurations_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackageInfo_Import_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_ListBySubscription.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_ListBySubscription.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPools_RetrieveRegistrationToken_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixImage_Expand_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/OperationDescription_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_GetByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_GetByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_ListByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateLinkResources_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateLinkResources_ListByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListBySubscription.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_UpdateStatus_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_RetryProvisioning_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/StartMenuItem_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Disconnect_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_SendMessage_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_ListBySubscription.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Update.json diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json new file mode 100644 index 000000000000..49d7de77974b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json @@ -0,0 +1,9954 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-08-preview", + "title": "Desktop Virtualization API Client" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "host": "management.azure.com", + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.DesktopVirtualization/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List all of the available operations the Desktop Virtualization resource provider supports.", + "x-ms-examples": { + "OperationDescription_List": { + "$ref": "./examples/OperationDescription_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Get", + "description": "Get a workspace.", + "x-ms-examples": { + "Workspace_Get": { + "$ref": "./examples/Workspace_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_CreateOrUpdate", + "description": "Create or update a workspace.", + "x-ms-examples": { + "Workspace_Create": { + "$ref": "./examples/Workspace_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Successfully created workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Delete", + "description": "Remove a workspace.", + "x-ms-examples": { + "Workspace_Delete": { + "$ref": "./examples/Workspace_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted workspace." + }, + "204": { + "description": "Workspace does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Update", + "description": "Update a workspace.", + "x-ms-examples": { + "Workspace_Update": { + "$ref": "./examples/Workspace_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/WorkspacePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_ListByWorkspace", + "description": "List private endpoint connections.", + "x-ms-examples": { + "PrivateEndpointConnection_ListByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_ListByWorkspace.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved connection list.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_GetByWorkspace", + "description": "Get a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_GetByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_GetByWorkspace.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_DeleteByWorkspace", + "description": "Remove a connection.", + "x-ms-examples": { + "PrivateEndpointConnection_DeleteByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_DeleteByWorkspace.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully removed." + }, + "204": { + "description": "Connection does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_UpdateByWorkspace", + "description": "Approve or reject a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_UpdateByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_UpdateByWorkspace.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "connection", + "description": "Object containing the updated connection.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateLinkResources_ListByWorkspace", + "description": "List the private link resources available for this workspace.", + "x-ms-examples": { + "PrivateLinkResources_ListByWorkspace": { + "$ref": "./examples/PrivateLinkResources_ListByWorkspace.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "List workspaces.", + "x-ms-examples": { + "Workspace_ListByResourceGroup": { + "$ref": "./examples/Workspace_ListByResourceGroup.json" + } + }, + "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": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in resource group.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "List workspaces in subscription.", + "x-ms-examples": { + "Workspace_ListBySubscription": { + "$ref": "./examples/Workspace_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in subscription.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Get", + "description": "Get a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Get": { + "$ref": "./examples/ScalingPlan_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Create", + "description": "Create or update a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Create": { + "$ref": "./examples/ScalingPlan_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "name": "scalingPlan", + "description": "Object containing scaling plan definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "201": { + "description": "Successfully created scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Delete", + "description": "Remove a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Delete": { + "$ref": "./examples/ScalingPlan_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted scaling plan." + }, + "204": { + "description": "Scaling plan does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Update", + "description": "Update a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Update": { + "$ref": "./examples/ScalingPlan_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "name": "scalingPlan", + "description": "Object containing scaling plan definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_ListByResourceGroup", + "description": "List scaling plans.", + "x-ms-examples": { + "ScalingPlans_ListByResourceGroup": { + "$ref": "./examples/ScalingPlan_ListByResourceGroup.json" + } + }, + "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": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plans in resource group.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}": { + "get": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Get", + "description": "Get a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Get": { + "$ref": "./examples/ScalingPlanPooledSchedule_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Create", + "description": "Create or update a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Create": { + "$ref": "./examples/ScalingPlanPooledSchedule_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPooledSchedule definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "201": { + "description": "Successfully created ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Delete", + "description": "Remove a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Delete": { + "$ref": "./examples/ScalingPlanPooledSchedule_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed ScalingPlanPooledSchedule." + }, + "204": { + "description": "ScalingPlanPooledSchedule does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Update", + "description": "Update a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Update": { + "$ref": "./examples/ScalingPlanPooledSchedule_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPooledSchedule definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules": { + "get": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_List", + "description": "List ScalingPlanPooledSchedules.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_List": { + "$ref": "./examples/ScalingPlanPooledSchedule_List.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPooledSchedules.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledScheduleList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}": { + "get": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Get", + "description": "Get a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Get": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Create", + "description": "Create or update a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Create": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPersonalSchedule definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "201": { + "description": "Successfully created ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Delete", + "description": "Remove a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Delete": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed ScalingPlanPersonalSchedule." + }, + "204": { + "description": "ScalingPlanPersonalSchedule does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Update", + "description": "Update a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Update": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPersonalSchedule definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules": { + "get": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_List", + "description": "List ScalingPlanPersonalSchedules.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_List": { + "$ref": "./examples/ScalingPlanPersonalSchedule_List.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPersonalSchedules.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalScheduleList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_ListBySubscription", + "description": "List scaling plans in subscription.", + "x-ms-examples": { + "ScalingPlans_ListBySubscription": { + "$ref": "./examples/ScalingPlan_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plans in subscription.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Get", + "description": "Get an application group.", + "x-ms-examples": { + "ApplicationGroup_Get": { + "$ref": "./examples/ApplicationGroup_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_CreateOrUpdate", + "description": "Create or update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Create": { + "$ref": "./examples/ApplicationGroup_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "201": { + "description": "Successfully created application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Delete", + "description": "Remove an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Delete": { + "$ref": "./examples/ApplicationGroup_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application group." + }, + "204": { + "description": "Application group does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Update", + "description": "Update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroups_Update": { + "$ref": "./examples/ApplicationGroup_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListByResourceGroup", + "description": "List applicationGroups.", + "x-ms-examples": { + "ApplicationGroup_ListByResourceGroup": { + "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" + } + }, + "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": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in resource group.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListBySubscription", + "description": "List applicationGroups in subscription.", + "x-ms-examples": { + "ApplicationGroup_List": { + "$ref": "./examples/ApplicationGroup_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in subscription.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { + "get": { + "tags": [ + "StartMenuItem" + ], + "operationId": "StartMenuItems_List", + "description": "List start menu items in the given application group.", + "x-ms-examples": { + "StartMenuItem_List": { + "$ref": "./examples/StartMenuItem_List.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved start menu items in application group.", + "schema": { + "$ref": "#/definitions/StartMenuItemList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "description": "Get an application.", + "x-ms-examples": { + "Application_Get": { + "$ref": "./examples/Application_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "description": "Create or update an application.", + "x-ms-examples": { + "Application_Create": { + "$ref": "./examples/Application_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Successfully created application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "description": "Remove an application.", + "x-ms-examples": { + "Application_Delete": { + "$ref": "./examples/Application_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application." + }, + "204": { + "description": "Application does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "description": "Update an application.", + "x-ms-examples": { + "Application_Update": { + "$ref": "./examples/Application_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "description": "List applications.", + "x-ms-examples": { + "Applications_List": { + "$ref": "./examples/Application_List.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved applications in application group.", + "schema": { + "$ref": "#/definitions/ApplicationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Get", + "description": "Get a desktop.", + "x-ms-examples": { + "Desktop_Get": { + "$ref": "./examples/Desktop_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Update", + "description": "Update a desktop.", + "x-ms-examples": { + "Desktop_Update": { + "$ref": "./examples/Desktop_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + }, + { + "name": "desktop", + "description": "Object containing Desktop definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DesktopPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_List", + "description": "List desktops.", + "x-ms-examples": { + "Desktop_List": { + "$ref": "./examples/Desktop_List.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktops in application group.", + "schema": { + "$ref": "#/definitions/DesktopList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Get", + "description": "Get a host pool.", + "x-ms-examples": { + "HostPool_Get": { + "$ref": "./examples/HostPool_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_CreateOrUpdate", + "description": "Create or update a host pool.", + "x-ms-examples": { + "HostPool_Create": { + "$ref": "./examples/HostPool_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPool" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "201": { + "description": "Successfully created host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Delete", + "description": "Remove a host pool.", + "x-ms-examples": { + "HostPool_Delete": { + "$ref": "./examples/HostPool_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to delete sessionHost." + } + ], + "responses": { + "200": { + "description": "Successfully removed host pool." + }, + "204": { + "description": "Host pool does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Update", + "description": "Update a host pool.", + "x-ms-examples": { + "HostPool_Update": { + "$ref": "./examples/HostPool_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/HostPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_ListByResourceGroup", + "description": "List hostPools.", + "x-ms-examples": { + "HostPool_ListByResourceGroup": { + "$ref": "./examples/HostPool_ListByResourceGroup.json" + } + }, + "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": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_List", + "description": "List hostPools in subscription.", + "x-ms-examples": { + "HostPool_List": { + "$ref": "./examples/HostPool_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in subscription.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagements_Get", + "description": "Get a SessionHostManagement.", + "x-ms-examples": { + "SessionHostManagements_Get": { + "$ref": "./examples/SessionHostManagements_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved sessionHostManagement.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "SessionHostManagements_CreateOrUpdate", + "description": "Create or update a SessionHostManagement.", + "x-ms-examples": { + "SessionHostManagements_Create": { + "$ref": "./examples/SessionHostManagements_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "sessionHostManagement", + "description": "Object containing SessionHostManagement definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated SessionHostManagement.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "201": { + "description": "Successfully created SessionHostManagement.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "SessionHostManagements_Update", + "description": "Update a SessionHostManagement.", + "x-ms-examples": { + "SessionHostManagements_Update": { + "$ref": "./examples/SessionHostManagements_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "sessionHostManagement", + "description": "Object containing SessionHostManagement definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostManagementPatch" + } + } + ], + "responses": { + "200": { + "description": "Update SessionHostManagement success.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagements_ListByHostPool", + "description": "List SessionHostManagements by hostPool.", + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/SessionHostManagements_ListByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved SessionHostManagements in HostPool.", + "schema": { + "$ref": "#/definitions/SessionHostManagementList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/initiateSessionHostUpdate": { + "post": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "InitiateSessionHostUpdate_Post", + "description": "Initiates a hostpool update or schedule an update for the future.", + "x-ms-examples": { + "HostPools_Update_Post": { + "$ref": "./examples/SessionHostManagements_UpdateSessionHosts_Post.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "updateSessionHostsRequestBody", + "description": "Object containing the definition for properties to be used in the sessionHostUpdate validation.", + "in": "body", + "schema": { + "$ref": "#/definitions/UpdateSessionHostsRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Successfully initiated hostpool update." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostUpdate": { + "post": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "ControlSessionHostUpdate_Post", + "description": "Control update of a hostpool.", + "x-ms-examples": { + "SessionHostManagements_ControlUpdate_Post": { + "$ref": "./examples/SessionHostManagements_ControlSessionHostUpdate_Post.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPoolUpdateControlParameter", + "description": "Object containing control action for hostpool update.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPoolUpdateControlParameter" + } + } + ], + "responses": { + "202": { + "description": "Successfully controlled hostpool update.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostUpdateStatuses/default": { + "get": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "SessionHostManagementsUpdateStatus_Get", + "description": "Get the session host update status for a given hostpool.", + "x-ms-examples": { + "SessionHostManagements_UpdateStatus_Get": { + "$ref": "./examples/SessionHostManagements_UpdateStatus_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the session host update status.", + "schema": { + "$ref": "#/definitions/SessionHostManagementUpdateStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default": { + "put": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_CreateOrUpdate", + "description": "Create or update a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Create": { + "$ref": "./examples/SessionHostConfigurations_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "sessionHostConfiguration", + "description": "Object containing SessionHostConfiguration definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully initiated SessionHostConfiguration Update validation.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "201": { + "description": "Successfully created Session Host Configuration.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_Update", + "description": "Update a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Update": { + "$ref": "./examples/SessionHostConfigurations_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "sessionHostConfiguration", + "description": "Object containing SessionHostConfiguration definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostConfigurationPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully created SessionHostConfiguration.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "202": { + "description": "Successfully created SessionHostConfiguration.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_Get", + "description": "Get a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Get": { + "$ref": "./examples/SessionHostConfigurations_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved sessionHostConfiguration.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations": { + "get": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_ListByHostPool", + "description": "List sessionHostConfigurations.", + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/SessionHostConfigurations_ListByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved sessionHostConfigurations in HostPool.", + "schema": { + "$ref": "#/definitions/SessionHostConfigurationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations/default": { + "get": { + "tags": [ + "ActiveSessionHostConfiguration" + ], + "operationId": "ActiveSessionHostConfigurations_Get", + "description": "Get the ActiveSessionHostConfiguration for the hostPool that is currently being used for update operations.", + "x-ms-examples": { + "SessionHostConfigurations_Get": { + "$ref": "./examples/ActiveSessionHostConfigurations_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved activeSessionHostConfiguration.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations": { + "get": { + "tags": [ + "ActiveSessionHostConfiguration" + ], + "operationId": "ActiveSessionHostConfigurations_ListByHostPool", + "description": "List activeSessionHostConfigurations.", + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/ActiveSessionHostConfigurations_ListByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved activeSessionHostConfigurations in HostPool.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfigurationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateLinkResources_ListByHostPool", + "description": "List the private link resources available for this hostpool.", + "x-ms-examples": { + "PrivateLinkResources_ListByHostPool": { + "$ref": "./examples/PrivateLinkResources_ListByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken": { + "post": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_RetrieveRegistrationToken", + "description": "Registration token of the host pool.", + "x-ms-examples": { + "HostPools_RetrieveRegistrationToken_Post": { + "$ref": "./examples/HostPools_RetrieveRegistrationToken_Post.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/RegistrationInfo" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_ListByHostPool", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_ListByHostPool": { + "$ref": "./examples/UserSession_ListByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in host pool.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Get", + "description": "Get a session host.", + "x-ms-examples": { + "SessionHost_Get": { + "$ref": "./examples/SessionHost_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Delete", + "description": "Remove a SessionHost.", + "x-ms-examples": { + "SessionHost_Delete": { + "$ref": "./examples/SessionHost_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to force sessionHost deletion even when userSession exists." + } + ], + "responses": { + "200": { + "description": "Successfully removed session host." + }, + "204": { + "description": "Session host does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Update", + "description": "Update a session host.", + "x-ms-examples": { + "SessionHost_Update": { + "$ref": "./examples/SessionHost_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "sessionHost", + "description": "Object containing SessionHost definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to update assign, unassign or reassign personal desktop." + } + ], + "responses": { + "200": { + "description": "Successfully updated session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_List", + "description": "List sessionHosts.", + "x-ms-examples": { + "SessionHost_List": { + "$ref": "./examples/SessionHost_List.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + }, + { + "$ref": "#/parameters/vmPathParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session hosts in host pool.", + "schema": { + "$ref": "#/definitions/SessionHostList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/retryProvisioning": { + "post": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHost_RetryProvisioning", + "description": "Retry provisioning on a SessionHost.", + "x-ms-examples": { + "SessionHost_RetryProvisioning_Post": { + "$ref": "./examples/SessionHost_RetryProvisioning_Post.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully started provisioning retry on the sessionHost." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}": { + "get": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_Get", + "description": "Get a msixpackage.", + "x-ms-examples": { + "MSIXPackage_Get": { + "$ref": "./examples/MsixPackage_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_CreateOrUpdate", + "description": "Create or update a MSIX package.", + "x-ms-examples": { + "MSIXPackage_Create": { + "$ref": "./examples/MsixPackage_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + }, + { + "name": "msixPackage", + "description": "Object containing MSIX Package definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "201": { + "description": "Successfully created MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_Delete", + "description": "Remove an MSIX Package.", + "x-ms-examples": { + "MSIXPackage_Delete": { + "$ref": "./examples/MsixPackage_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed MSIX Package." + }, + "204": { + "description": "MSIX Package does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_Update", + "description": "Update an MSIX Package.", + "x-ms-examples": { + "MSIXPackage_Update": { + "$ref": "./examples/MsixPackage_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + }, + { + "name": "msixPackage", + "description": "Object containing MSIX Package definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/MSIXPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages": { + "get": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_List", + "description": "List MSIX packages in hostpool.", + "x-ms-examples": { + "MSIXPackage_List": { + "$ref": "./examples/MsixPackage_List.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved MSIX Packages in hostpool.", + "schema": { + "$ref": "#/definitions/MSIXPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/importAppAttachPackageInfo": { + "post": { + "tags": [ + "AppAttachPackageInfo" + ], + "operationId": "AppAttachPackageInfo_Import", + "description": "Gets information from a package given the path to the package.", + "x-ms-examples": { + "AppAttachPackageInfo_Import": { + "$ref": "./examples/AppAttachPackageInfo_Import_Post.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "importPackageInfoRequest", + "description": "Object containing URI to package image and other optional properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportPackageInfoRequest" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved packages in specified Image Path.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage": { + "post": { + "tags": [ + "MsixImage" + ], + "operationId": "MsixImages_Expand", + "description": "Expands and Lists MSIX packages in an Image, given the Image Path.", + "x-ms-examples": { + "MsixImage_Expand": { + "$ref": "./examples/MsixImage_Expand_Post.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "msixImageURI", + "description": "Object containing URI to MSIX Image", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXImageURI" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved MSIX packages in specified Image Path.", + "schema": { + "$ref": "#/definitions/ExpandMsixImageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Get", + "description": "Get an app attach package.", + "x-ms-examples": { + "AppAttachPackage_Get": { + "$ref": "./examples/AppAttachPackage_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_CreateOrUpdate", + "description": "Create or update an App Attach package.", + "x-ms-examples": { + "AppAttachPackage_Create": { + "$ref": "./examples/AppAttachPackage_Create.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "appAttachPackage", + "description": "Object containing App Attach Package definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "201": { + "description": "Successfully created App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Delete", + "description": "Remove an App Attach Package.", + "x-ms-examples": { + "AppAttachPackage_Delete": { + "$ref": "./examples/AppAttachPackage_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to delete App Attach package." + } + ], + "responses": { + "200": { + "description": "Successfully deleted App Attach Package." + }, + "204": { + "description": "App Attach Package does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Update", + "description": "Update an App Attach Package", + "x-ms-examples": { + "AppAttachPackage_Update": { + "$ref": "./examples/AppAttachPackage_Update.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "appAttachPackagePatch", + "description": "Object containing App Attach Package definition.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AppAttachPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_ListByResourceGroup", + "description": "List App Attach packages in resource group.", + "x-ms-examples": { + "AppAttachPackage_ListByResourceGroup": { + "$ref": "./examples/AppAttachPackage_ListByResourceGroup.json" + } + }, + "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": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are package name, host pool, package owner name, and custom data." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Packages in resource group.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_ListBySubscription", + "description": "List App Attach packages in subscription.", + "x-ms-examples": { + "AppAttachPackage_ListBySubscription": { + "$ref": "./examples/AppAttachPackage_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are package name, resource group, host pool, package owner name, and custom data." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Packages in subscription.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Get", + "description": "Get a userSession.", + "x-ms-examples": { + "UserSession_Get": { + "$ref": "./examples/UserSession_Get.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user session.", + "schema": { + "$ref": "#/definitions/UserSession" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Delete", + "description": "Remove a userSession.", + "x-ms-examples": { + "UserSession_Delete": { + "$ref": "./examples/UserSession_Delete.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to login off userSession." + } + ], + "responses": { + "200": { + "description": "Successfully removed user session." + }, + "204": { + "description": "User session does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_List", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_List": { + "$ref": "./examples/UserSession_List.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in session host.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Disconnect", + "description": "Disconnect a userSession.", + "x-ms-examples": { + "UserSession_Disconnect_Post": { + "$ref": "./examples/UserSession_Disconnect_Post.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully disconnected user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_SendMessage", + "description": "Send a message to a user.", + "x-ms-examples": { + "UserSession_SendMessage_Post": { + "$ref": "./examples/UserSession_SendMessage_Post.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "sendMessage", + "description": "Object containing message includes title and message body", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SendMessage" + } + } + ], + "responses": { + "200": { + "description": "Successfully sent message to user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_ListByHostPool", + "description": "List scaling plan associated with hostpool.", + "x-ms-examples": { + "ScalingPlan_ListByHostPool": { + "$ref": "./examples/ScalingPlan_ListByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plan associated with hostpool.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_ListByHostPool", + "description": "List private endpoint connections associated with hostpool.", + "x-ms-examples": { + "PrivateEndpointConnection_ListByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_ListByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved connection list.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_GetByHostPool", + "description": "Get a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_GetByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_GetByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_DeleteByHostPool", + "description": "Remove a connection.", + "x-ms-examples": { + "PrivateEndpointConnection_DeleteByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_DeleteByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully removed." + }, + "204": { + "description": "Connection does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_UpdateByHostPool", + "description": "Approve or reject a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_UpdateByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_UpdateByHostPool.json" + } + }, + "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" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "connection", + "description": "Object containing the updated connection.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "description": "Cloud error object.", + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorProperties" + } + } + }, + "CloudErrorProperties": { + "description": "Cloud error object properties.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "ResourceProviderOperationList": { + "type": "object", + "description": "Result of the request to list operations.", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "description": "List of operations supported by this resource provider." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ResourceProviderOperation": { + "type": "object", + "description": "Supported operation of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "type": "object", + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Resource provider: Microsoft Desktop Virtualization.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of this operation.", + "type": "string" + } + } + }, + "isDataAction": { + "description": "Is a data action.", + "type": "boolean" + }, + "properties": { + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of the operation", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "ServiceSpecification": { + "description": "Service specification payload", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Specifications of the Log for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "LogSpecification": { + "description": "Specifications of the Log for Azure Monitoring", + "type": "object", + "properties": { + "name": { + "description": "Name of the log", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log", + "type": "string" + }, + "blobDuration": { + "description": "Blob duration of the log", + "type": "string" + } + } + }, + "Workspace": { + "type": "object", + "description": "Represents a Workspace definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties" + } + } + }, + "WorkspaceProperties": { + "description": "Schema for Workspace properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Workspace. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup resource Ids.", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true, + "x-nullable": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints", + "x-nullable": true + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified resource", + "x-nullable": true + } + } + }, + "WorkspaceList": { + "type": "object", + "title": "WorkspaceList", + "description": "List of Workspace definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Workspace definitions.", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "WorkspacePatch": { + "type": "object", + "description": "Workspace properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated", + "x-nullable": true + }, + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspacePatchProperties" + } + } + }, + "WorkspacePatchProperties": { + "description": "Workspace properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled to allow this resource to be access from the public network", + "x-nullable": true + } + } + }, + "ApplicationGroup": { + "type": "object", + "description": "Represents a ApplicationGroup definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for ApplicationGroup", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupProperties", + "x-nullable": false + } + } + }, + "ApplicationGroupProperties": { + "description": "Schema for ApplicationGroup properties.", + "type": "object", + "required": [ + "hostPoolArmPath", + "applicationGroupType" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of ApplicationGroup. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "hostPoolArmPath": { + "type": "string", + "description": "HostPool arm path of ApplicationGroup.", + "x-nullable": false + }, + "workspaceArmPath": { + "type": "string", + "description": "Workspace arm path of ApplicationGroup.", + "readOnly": true + }, + "applicationGroupType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationGroupType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of ApplicationGroup.", + "x-nullable": false + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true, + "x-nullable": true + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + } + } + }, + "ApplicationGroupPatch": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated", + "x-nullable": true + }, + "properties": { + "description": "ApplicationGroup properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupPatchProperties" + } + } + }, + "ApplicationGroupPatchProperties": { + "description": "ApplicationGroup properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + } + } + }, + "ApplicationGroupList": { + "type": "object", + "title": "ApplicationGroupList", + "description": "List of ApplicationGroup definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ApplicationGroup definitions.", + "items": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "HostPool": { + "type": "object", + "description": "Represents a HostPool definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for HostPool", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolProperties", + "x-nullable": false + } + } + }, + "HostPoolProperties": { + "description": "Properties of HostPool.", + "type": "object", + "required": [ + "hostPoolType", + "loadBalancerType", + "preferredAppGroupType" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of HostPool. (internal use)", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "hostPoolType": { + "enum": [ + "Personal", + "Pooled", + "BYODesktop" + ], + "x-ms-enum": { + "name": "HostPoolType", + "modelAsString": true, + "values": [ + { + "value": "Personal", + "description": "Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost." + }, + { + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + }, + { + "value": "BYODesktop", + "description": "Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct." + } + ] + }, + "type": "string", + "description": "HostPool type for desktop.", + "x-nullable": false + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool.", + "x-nullable": true + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool.", + "x-nullable": true + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent", + "MultiplePersistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer.", + "x-nullable": false + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool.", + "x-nullable": true + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment.", + "x-nullable": true + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfo", + "description": "The registration info of HostPool.", + "x-nullable": true + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "managementType": { + "enum": [ + "Automated", + "Standard" + ], + "x-ms-enum": { + "name": "ManagementType", + "modelAsString": true + }, + "type": "string", + "description": "The type of management for this hostpool, Automated or Standard. The default value is Automated.", + "x-nullable": false + }, + "applicationGroupReferences": { + "readOnly": true, + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "appAttachPackageReferences": { + "readOnly": true, + "type": "array", + "description": "List of App Attach Package links.", + "items": { + "type": "string" + } + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "enum": [ + "SharedKey", + "Certificate", + "SharedKeyInKeyVault", + "CertificateInKeyVault" + ], + "x-ms-enum": { + "name": "SSOSecretType", + "modelAsString": true + }, + "type": "string", + "description": "The type of single sign on Secret Type.", + "x-nullable": true + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "x-nullable": false + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature.", + "x-nullable": true + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true, + "x-nullable": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled", + "EnabledForSessionHostsOnly", + "EnabledForClientsOnly" + ], + "x-ms-enum": { + "name": "HostpoolPublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints", + "x-nullable": true + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdateProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "x-nullable": true + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified resource" + }, + "managedPrivateUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ManagedPrivateUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "directUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DirectUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "publicUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "relayUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "RelayUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + } + } + }, + "HostPoolPatch": { + "type": "object", + "description": "HostPool properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated", + "x-nullable": true + }, + "properties": { + "description": "HostPool properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolPatchProperties" + } + } + }, + "HostPoolPatchProperties": { + "description": "Properties of HostPool.", + "type": "object", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool.", + "x-nullable": true + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool.", + "x-nullable": true + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent", + "MultiplePersistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool.", + "x-nullable": true + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment.", + "x-nullable": true + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfoPatch", + "description": "The registration info of HostPool.", + "x-nullable": true + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "enum": [ + "SharedKey", + "Certificate", + "SharedKeyInKeyVault", + "CertificateInKeyVault" + ], + "x-ms-enum": { + "name": "SSOSecretType", + "modelAsString": true + }, + "type": "string", + "description": "The type of single sign on Secret Type.", + "x-nullable": true + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group" + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature.", + "x-nullable": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled", + "EnabledForSessionHostsOnly", + "EnabledForClientsOnly" + ], + "x-ms-enum": { + "name": "HostpoolPublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled to allow this resource to be access from the public network", + "x-nullable": true + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdatePatchProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + }, + "managedPrivateUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ManagedPrivateUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "directUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DirectUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "publicUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "relayUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "RelayUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + } + } + }, + "SessionHostManagementList": { + "type": "object", + "title": "SessionHostManagementList", + "description": "List of SessionHostManagement definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHostManagement definitions.", + "items": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHostManagement": { + "type": "object", + "description": "Represents a SessionHostManagement definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHostManagement", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostManagementProperties" + } + } + }, + "SessionHostManagementProperties": { + "description": "Session host Managements of HostPool.", + "type": "object", + "required": [ + "scheduledDateTimeZone", + "update" + ], + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationProperties", + "description": "Parameters for a hostpool update." + } + } + }, + "SessionHostManagementPatch": { + "type": "object", + "description": "Represents a SessionHostManagementPatch definition.", + "properties": { + "properties": { + "description": "Detailed properties for SessionHostManagementPatch", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostManagementPatchProperties" + } + } + }, + "SessionHostManagementPatchProperties": { + "description": "Session host Managements of HostPool.", + "type": "object", + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties", + "description": "Parameters for a hostpool update." + } + } + }, + "HostPoolUpdateConfigurationProperties": { + "description": "The configurations of a hostpool update.", + "type": "object", + "required": [ + "maxVmsRemoved", + "logOffDelayMinutes" + ], + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff. Default value is an empty string.", + "maxLength": 260, + "default": "" + } + } + }, + "HostPoolUpdateConfigurationPatchProperties": { + "description": "The configurations of a hostpool update.", + "type": "object", + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff.", + "maxLength": 260 + } + } + }, + "HostPoolUpdateControlParameter": { + "description": "Represents properties for a hostpool update control request.", + "type": "object", + "required": [ + "action" + ], + "properties": { + "action": { + "enum": [ + "Start", + "Pause", + "Cancel", + "Retry", + "Resume" + ], + "x-ms-enum": { + "name": "HostPoolUpdateAction", + "modelAsString": true, + "values": [ + { + "value": "Start", + "description": "Start the hostpool update." + }, + { + "value": "Pause", + "description": "Pause the hostpool update." + }, + { + "value": "Cancel", + "description": "Cancel the hostpool update." + }, + { + "value": "Retry", + "description": "Retry the hostpool update." + }, + { + "value": "Resume", + "description": "Resume the hostpool update." + } + ] + }, + "type": "string", + "description": "Action types for controlling hostpool update.", + "x-nullable": false + }, + "cancelMessage": { + "type": "string", + "description": "The cancel message sent to the user on the session host. This is can only be specified if the action is 'Cancel'.", + "maxLength": 260 + } + } + }, + "HostPoolUpdateFault": { + "description": "Hostpool update fault information.", + "type": "object", + "properties": { + "faultType": { + "type": "string", + "description": "Hostpool update fault type.", + "enum": [ + "ServiceError", + "UserError" + ], + "x-ms-enum": { + "name": "faultType", + "modelAsString": true, + "values": [ + { + "value": "ServiceError", + "description": "Fault caused by service error." + }, + { + "value": "UserError", + "description": "Fault caused by user error." + } + ] + } + }, + "faultCode": { + "type": "string", + "description": "Hostpool update fault code." + }, + "faultText": { + "type": "string", + "description": "Hostpool update fault text." + }, + "faultContext": { + "type": "string", + "description": "Hostpool update fault context." + } + } + }, + "SessionHostManagementUpdateStatus": { + "description": "The current status of the session host update async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string" + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status. Current defined values are < Error | Scheduled | UpdatingSessionHosts | ValidatingSessionHostUpdate | Paused | Pausing | Cancelling > | Succeeded | Failed | Canceled", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail" + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The custom properties of the SessionHost Update Status.", + "$ref": "#/definitions/SessionHostManagementUpdateStatusProperties" + } + } + }, + "SessionHostManagementUpdateStatusProperties": { + "description": "Properties bag to hold custom RP properties for sessionHostManagement Update Statuses.", + "type": "object", + "properties": { + "correlationId": { + "type": "string", + "description": "The Log Analytics." + }, + "progress": { + "description": "Progress information on the sessionHostManagement operation.", + "$ref": "#/definitions/SessionHostManagementOperationProgress" + }, + "scheduledDateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp that the update is scheduled for." + }, + "sessionHostManagement": { + "description": "SessionHostManagement properties used for the operation.", + "$ref": "#/definitions/SessionHostManagement" + } + } + }, + "SessionHostManagementOperationType": { + "enum": [ + "InitiateSessionHostUpdate", + "ValidateSessionHostUpdate" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationTypeSHM", + "modelAsString": true + } + }, + "SessionHostManagementOperationProgress": { + "type": "object", + "description": "SessionHostManagement Operation Progress information.", + "properties": { + "executionStartTime": { + "format": "date-time", + "type": "string", + "description": "Time that the sessionHostManagement operation was created." + }, + "totalSessionHosts": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts to be started in the sessionHostManagement operation." + }, + "sessionHostsInProgress": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts in progress in the sessionHostManagement operation." + }, + "sessionHostsCompleted": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts completed in the sessionHostManagement operation." + }, + "sessionHostsRollbackFailed": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts rollback failed in the sessionHostManagement operation." + } + } + }, + "UpdateSessionHostsRequestBody": { + "description": "Object containing the definition for properties to be used for a sessionHostUpdate operation.", + "type": "object", + "properties": { + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately" + }, + "scheduledDateTimeZone": { + "type": "string", + "description": "The timeZone as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid." + }, + "update": { + "description": "settings for management information for the hostpool update operation. If none is provided the update will use the settings saved in the sessionHostManagement object.", + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties" + } + } + }, + "SessionHostConfigurationOperationStatus": { + "description": "The current status of an async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string" + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status. Current defined values are ", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatus" + } + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail" + } + } + }, + "SessionHostConfigurationOperationStatusList": { + "type": "object", + "title": "OperationStatusList", + "description": "List of OperationStatus definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of OperationStatus definitions.", + "items": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatus" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ActiveSessionHostConfigurationList": { + "type": "object", + "title": "ActiveSessionHostConfigurationList", + "description": "List of ActiveSessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ActiveSessionHostConfiguration definitions.", + "items": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ActiveSessionHostConfiguration": { + "type": "object", + "description": "Represents a ActiveSessionHostConfiguration definition. This has all of the sessionHostConfiguration properties except provisioningState", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHostConfiguration", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ActiveSessionHostConfigurationProperties" + } + } + }, + "ActiveSessionHostConfigurationProperties": { + "description": "Session host configurations of HostPool.", + "type": "object", + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ], + "properties": { + "version": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Hashtable that lists key/value pair tags to apply to the VMs" + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided." + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]." + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6" + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "format": "uri", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics information." + } + } + }, + "SessionHostConfigurationList": { + "type": "object", + "title": "SessionHostConfigurationList", + "description": "List of SessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHostConfiguration definitions.", + "items": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHostConfiguration": { + "type": "object", + "description": "Represents a SessionHostConfiguration definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHostConfiguration", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostConfigurationProperties" + } + } + }, + "SessionHostConfigurationProperties": { + "description": "Session host configurations of HostPool.", + "type": "object", + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ], + "properties": { + "version": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "provisioningState": { + "description": "Provisioning state of the Session Host Configuration.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningStateSHC", + "modelAsString": true + } + }, + "vmTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Hashtable that lists key/value pair tags to apply to the VMs" + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided." + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]." + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6" + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "format": "uri", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics information." + } + } + }, + "SessionHostConfigurationPatch": { + "type": "object", + "description": "Represents a SessionHostConfigurationPatch definition.", + "properties": { + "properties": { + "description": "Detailed properties for SessionHostConfigurationPatch", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostConfigurationPatchProperties" + } + } + }, + "SessionHostConfigurationPatchProperties": { + "description": "Session host configurations of HostPool.", + "type": "object", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Hashtable that lists key/value pair tags to apply to the VMs" + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in" + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]." + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoPatchProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6" + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoPatchProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "format": "uri", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning.", + "maxLength": 260 + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoPatchProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoPatchProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoPatchProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoPatchProperties", + "description": "Boot Diagnostics information." + } + } + }, + "DiskInfoProperties": { + "description": "Disk information.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "VirtualMachineDiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + } + ] + }, + "description": "The disk type used by virtual machine in hostpool session host." + } + } + }, + "DiskInfoPatchProperties": { + "description": "Disk information.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "VirtualMachineDiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + } + ] + }, + "description": "The disk type used by virtual machine in hostpool session host." + } + } + }, + "ImageInfoProperties": { + "description": "Image configurations of session host in a HostPool.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "x-ms-client-name": "imageType", + "enum": [ + "Marketplace", + "Custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "Marketplace", + "description": "Using default marketplace images offered by Azure Marketplace." + }, + { + "value": "Custom", + "description": "Using a custom image." + } + ] + }, + "type": "string", + "description": "The type of image session hosts use in the hostpool.", + "x-nullable": false + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + } + }, + "ImageInfoPatchProperties": { + "description": "Image configurations of session host in a HostPool.", + "type": "object", + "properties": { + "type": { + "x-ms-client-name": "imageType", + "enum": [ + "Marketplace", + "Custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "Marketplace", + "description": "Using default marketplace images offered by Azure Marketplace." + }, + { + "value": "Custom", + "description": "Using a custom image." + } + ] + }, + "type": "string", + "description": "The type of image session hosts use in the hostpool.", + "x-nullable": false + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoPatchProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoPatchProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + } + }, + "MarketplaceInfoProperties": { + "description": "Marketplace image information.", + "type": "object", + "required": [ + "offer", + "publisher", + "sku", + "exactVersion" + ], + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The sku of the image." + }, + "exactVersion": { + "type": "string", + "description": "The exact version of the image." + } + } + }, + "MarketplaceInfoPatchProperties": { + "description": "Marketplace image information.", + "type": "object", + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The sku of the image." + }, + "exactVersion": { + "type": "string", + "description": "The exact version of the image." + } + } + }, + "CustomInfoProperties": { + "description": "Custom image information.", + "type": "object", + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the custom image." + } + } + }, + "CustomInfoPatchProperties": { + "description": "Custom image information.", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the custom image." + } + } + }, + "DomainInfoProperties": { + "description": "Domain configurations of session hosts.", + "type": "object", + "required": [ + "joinType" + ], + "properties": { + "joinType": { + "enum": [ + "ActiveDirectory", + "AzureActiveDirectory" + ], + "x-ms-enum": { + "name": "DomainJoinType", + "modelAsString": true, + "values": [ + { + "value": "ActiveDirectory", + "description": "Using microsoft active directory." + }, + { + "value": "AzureActiveDirectory", + "description": "Using microsoft azure active directory." + } + ] + }, + "type": "string", + "description": "The type of domain join done by the virtual machine.", + "x-nullable": false + }, + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoProperties", + "description": "Active directory info. Only one should be populated based on the join type." + }, + "azureActiveDirectoryInfo": { + "$ref": "#/definitions/AzureActiveDirectoryInfoProperties", + "description": "Azure active directory info. Only one should be populated based on the join type." + } + } + }, + "DomainInfoPatchProperties": { + "description": "Domain configurations of session hosts.", + "type": "object", + "properties": { + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoPatchProperties", + "description": "Active directory info. Only one should be populated based on the join type." + } + } + }, + "ActiveDirectoryInfoProperties": { + "description": "Active directory info. Only one should be populated based on the join type.", + "type": "object", + "required": [ + "domainCredentials", + "ouPath" + ], + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Credentials needed to create the virtual machine." + }, + "ouPath": { + "type": "string", + "description": "The organizational unit(OU) path." + }, + "domainName": { + "type": "string", + "description": "The domain a virtual machine connected to a hostpool will join." + } + } + }, + "ActiveDirectoryInfoPatchProperties": { + "description": "Active directory info. Only one should be populated based on the join type.", + "type": "object", + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Credentials needed to create the virtual machine." + } + } + }, + "AzureActiveDirectoryInfoProperties": { + "description": "Azure Active directory info. Only one should be populated based on the join type.", + "type": "object", + "required": [ + "mdmProviderGuid" + ], + "properties": { + "mdmProviderGuid": { + "type": "string", + "description": "The Mobile Device Management(MDM) guid." + } + } + }, + "KeyVaultCredentialsProperties": { + "description": "Credentials kept in the keyvault.", + "type": "object", + "required": [ + "usernameKeyVaultSecretUri", + "passwordKeyVaultSecretUri" + ], + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the password is stored in." + } + } + }, + "KeyVaultCredentialsPatchProperties": { + "description": "Credentials kept in the keyvault.", + "type": "object", + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the password is stored in." + } + } + }, + "NetworkInfoProperties": { + "description": "Network information.", + "type": "object", + "required": [ + "subnetId" + ], + "properties": { + "subnetId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG)." + } + } + }, + "NetworkInfoPatchProperties": { + "description": "Network information.", + "type": "object", + "properties": { + "subnetId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG)." + } + } + }, + "SecurityInfoProperties": { + "description": "Security information.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot adn vTPM" + }, + { + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + }, + "default": "Standard", + "description": "The security type used by virtual machine in hostpool session host. Default is Standard." + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTPM on the virtual machine." + } + } + }, + "SecurityInfoPatchProperties": { + "description": "Security information.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot adn vTPM" + }, + { + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + }, + "description": "The security type used by virtual machine in hostpool session host." + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTPM on the virtual machine." + } + } + }, + "BootDiagnosticsInfoProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "format": "uri", + "description": "Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used.", + "x-nullable": true + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "BootDiagnosticsInfoPatchProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "RegistrationInfo": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token.", + "x-nullable": true + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + }, + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token.", + "x-nullable": false + } + } + }, + "RegistrationInfoPatch": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token.", + "x-nullable": true + }, + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token." + } + } + }, + "AgentUpdateProperties": { + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of maintenance for session host components.", + "enum": [ + "Default", + "Scheduled" + ], + "x-ms-enum": { + "name": "SessionHostComponentUpdateType", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." + }, + { + "value": "Scheduled", + "description": "TenantAdmin have opted in for Scheduled Component Update feature." + } + ] + } + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowProperties" + }, + "x-ms-identifiers": [], + "x-nullable": true + } + } + }, + "MaintenanceWindowProperties": { + "description": "Maintenance window starting hour and day of week.", + "type": "object", + "properties": { + "hour": { + "format": "int32", + "type": "integer", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "type": "string", + "description": "Day of the week.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + } + }, + "AgentUpdatePatchProperties": { + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of maintenance for session host components.", + "enum": [ + "Default", + "Scheduled" + ], + "x-ms-enum": { + "name": "SessionHostComponentUpdateType", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." + }, + { + "value": "Scheduled", + "description": "TenantAdmin have opted in for Scheduled Component Update feature." + } + ] + } + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowPatchProperties" + }, + "x-ms-identifiers": [], + "x-nullable": true + } + } + }, + "MaintenanceWindowPatchProperties": { + "description": "Maintenance window starting hour and day of week.", + "type": "object", + "properties": { + "hour": { + "format": "int32", + "type": "integer", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "type": "string", + "description": "Day of the week.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + } + }, + "SendMessage": { + "description": "Represents message sent to a UserSession.", + "type": "object", + "properties": { + "messageTitle": { + "type": "string", + "description": "Title of message." + }, + "messageBody": { + "type": "string", + "description": "Body of message." + } + } + }, + "HostPoolList": { + "type": "object", + "title": "HostPoolList", + "description": "List of HostPool definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of HostPool definitions.", + "items": { + "$ref": "#/definitions/HostPool" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "MSIXPackage": { + "description": "Schema for MSIX Package properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for MSIX Package", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MSIXPackageProperties", + "x-nullable": false + } + } + }, + "MSIXPackageProperties": { + "description": "Schema for MSIX Package properties.", + "type": "object", + "properties": { + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + } + }, + "version": { + "type": "string", + "description": "Package Version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date Package was last updated, found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-nullable": false + } + } + }, + "MSIXPackagePatch": { + "type": "object", + "description": "MSIX Package properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for MSIX Package", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MSIXPackagePatchProperties" + } + } + }, + "MSIXPackagePatchProperties": { + "description": "MSIX Package properties that can be patched.", + "type": "object", + "properties": { + "isActive": { + "type": "boolean", + "description": "Set a version of the package to be active across hostpool. " + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Set Registration mode. Regular or Delayed." + }, + "displayName": { + "type": "string", + "description": "Display name for MSIX Package." + } + } + }, + "MsixPackageApplications": { + "description": "Schema for MSIX Package Application properties.", + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "Package Application Id, found in appxmanifest.xml.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Description of Package Application.", + "x-nullable": false + }, + "appUserModelID": { + "type": "string", + "description": "Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml.", + "x-nullable": false + }, + "friendlyName": { + "type": "string", + "description": "User friendly name.", + "x-nullable": false + }, + "iconImageName": { + "type": "string", + "description": "User friendly name.", + "x-nullable": false + }, + "rawIcon": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + }, + "rawPng": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "MsixPackageDependencies": { + "description": "Schema for MSIX Package Dependencies properties.", + "type": "object", + "properties": { + "dependencyName": { + "type": "string", + "description": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files", + "x-nullable": false + }, + "publisher": { + "type": "string", + "description": "Name of dependency publisher.", + "x-nullable": false + }, + "minVersion": { + "type": "string", + "description": "Dependency version required.", + "x-nullable": false + } + } + }, + "MSIXPackageList": { + "type": "object", + "title": "MsixPackageList", + "description": "List of MSIX Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of MSIX Package definitions.", + "items": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "AppAttachPackage": { + "description": "Schema for App Attach Package properties.", + "type": "object", + "x-ms-client-flatten": false, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageProperties", + "x-nullable": false + } + } + }, + "AppAttachPackagePatch": { + "description": "Schema for patchable App Attach Package properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackagePatchProperties", + "x-ms-client-flatten": false, + "x-nullable": false + } + } + }, + "AppAttachPackageList": { + "type": "object", + "title": "AppAttachPackageList", + "description": "List of App Attach Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of App Attach Package definitions.", + "items": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "AppAttachPackageProperties": { + "description": "Schema for App Attach Package properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the App Attach Package." + }, + "image": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageInfoProperties", + "x-nullable": false + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL of keyvault location to store certificate" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/FailHealthCheckOnStagingFailureEnum", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "packageOwnerName": { + "type": "string", + "description": "Specific name of package owner, is \"AppAttach\" for native app attach packages" + }, + "packageLookbackUrl": { + "type": "string", + "format": "uri", + "description": "Lookback url to third party control plane, is null for native app attach packages", + "x-nullable": true + }, + "customData": { + "type": "string", + "description": "Field that can be populated with custom data and filtered on in list GET calls" + } + } + }, + "AppAttachPackagePatchProperties": { + "description": "Schema for patchable fields on an App Attach Package.", + "type": "object", + "properties": { + "image": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageInfoProperties" + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string", + "format": "arm-id" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL of keyvault location to store certificate" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/FailHealthCheckOnStagingFailureEnum", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "packageLookbackUrl": { + "type": "string", + "format": "uri", + "description": "Lookback url to third party control plane, should be null for first party packages" + }, + "customData": { + "type": "string", + "description": "Field that can be populated with custom data and filtered on in list GET calls" + } + } + }, + "AppAttachPackageInfoProperties": { + "description": "Schema for Import Package Information properties.", + "type": "object", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of App Attach Package. Assigned at import time" + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM/APP-V image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ", + "x-nullable": false + }, + "packageFullName": { + "type": "string", + "description": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [], + "x-nullable": true + }, + "version": { + "type": "string", + "description": "Package Version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [], + "x-nullable": false + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml. ", + "x-nullable": true + }, + "certificateExpiry": { + "format": "date-time", + "type": "string", + "description": "Date certificate expires, found in the appxmanifest.xml. ", + "x-nullable": true + }, + "isPackageTimestamped": { + "enum": [ + "Timestamped", + "NotTimestamped" + ], + "x-ms-enum": { + "name": "packageTimestamped", + "modelAsString": true + }, + "type": "string", + "description": "Is package timestamped so it can ignore the certificate expiry date", + "x-nullable": true + } + } + }, + "ImportPackageInfoRequest": { + "description": "Information to import app attach package", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "URI to Image" + }, + "packageArchitecture": { + "enum": [ + "ARM", + "ARM64", + "x86", + "x64", + "Neutral", + "x86a64", + "ALL" + ], + "x-ms-enum": { + "name": "AppAttachPackageArchitectures", + "modelAsString": true + }, + "type": "string", + "description": "Possible device architectures that an app attach package can be configured for", + "x-nullable": true + } + } + }, + "FailHealthCheckOnStagingFailureEnum": { + "enum": [ + "Unhealthy", + "NeedsAssistance", + "DoNotFail" + ], + "x-ms-enum": { + "name": "failHealthCheckOnStagingFailure", + "modelAsString": true + }, + "type": "string", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "Application": { + "description": "Schema for Application properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "x-nullable": false + } + } + }, + "ApplicationProperties": { + "description": "Schema for Application properties.", + "type": "object", + "required": [ + "commandLineSetting" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Application. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications", + "x-nullable": true, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications", + "x-nullable": true, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "applicationType": { + "enum": [ + "InBuilt", + "MsixApplication" + ], + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of Application.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", + "x-nullable": false + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "ApplicationList": { + "type": "object", + "title": "ApplicationList", + "description": "List of Application definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Application definitions.", + "items": { + "$ref": "#/definitions/Application" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ApplicationPatch": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated", + "x-nullable": true + }, + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPatchProperties" + } + } + }, + "ApplicationPatchProperties": { + "description": "Application properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications", + "x-nullable": true + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications", + "x-nullable": true + }, + "applicationType": { + "enum": [ + "InBuilt", + "MsixApplication" + ], + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of Application." + } + } + }, + "Desktop": { + "description": "Schema for Desktop properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopProperties" + } + } + }, + "DesktopProperties": { + "description": "Schema for Desktop properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Desktop. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "The icon a 64 bit string as a byte array." + } + } + }, + "DesktopList": { + "type": "object", + "title": "DesktopList", + "description": "List of Desktop definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Desktop definitions.", + "items": { + "$ref": "#/definitions/Desktop" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "DesktopPatch": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated", + "x-nullable": true + }, + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopPatchProperties" + } + } + }, + "DesktopPatchProperties": { + "description": "Desktop properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + } + } + }, + "StartMenuItemProperties": { + "description": "Schema for StartMenuItem properties.", + "type": "object", + "properties": { + "appAlias": { + "type": "string", + "description": "Alias of StartMenuItem." + }, + "filePath": { + "type": "string", + "description": "Path to the file of StartMenuItem." + }, + "commandLineArguments": { + "type": "string", + "description": "Command line arguments for StartMenuItem." + }, + "iconPath": { + "type": "string", + "description": "Path to the icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + } + } + }, + "StartMenuItem": { + "type": "object", + "description": "Represents a StartMenuItem definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for StartMenuItem", + "x-ms-client-flatten": true, + "$ref": "#/definitions/StartMenuItemProperties" + } + } + }, + "StartMenuItemList": { + "type": "object", + "title": "StartMenuItemList", + "description": "List of StartMenuItem definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of StartMenuItem definitions.", + "items": { + "$ref": "#/definitions/StartMenuItem" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ExpandMsixImageProperties": { + "description": "Schema for Expand MSIX Image properties.", + "type": "object", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of MSIX Package." + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ", + "x-nullable": false + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-nullable": true + }, + "version": { + "type": "string", + "description": "Package Version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date Package was last updated, found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-nullable": false + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml. ", + "x-nullable": true + }, + "certificateExpiry": { + "format": "date-time", + "type": "string", + "description": "Date certificate expires, found in the appxmanifest.xml. ", + "x-nullable": true + } + } + }, + "ExpandMsixImage": { + "type": "object", + "description": "Represents the definition of contents retrieved after expanding the MSIX Image. ", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for ExpandMsixImage", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpandMsixImageProperties" + } + } + }, + "ExpandMsixImageList": { + "type": "object", + "title": "ExpandMsixImageList", + "description": "List of MSIX package properties retrieved from MSIX Image expansion.", + "properties": { + "value": { + "type": "array", + "description": "List of MSIX package properties from give MSIX Image.", + "items": { + "$ref": "#/definitions/ExpandMsixImage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "MSIXImageURI": { + "description": "Represents URI referring to MSIX Image", + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "URI to Image" + } + } + }, + "SessionHost": { + "type": "object", + "description": "Represents a SessionHost definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostProperties" + } + } + }, + "SessionHostProperties": { + "description": "Schema for SessionHost properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of SessionHost. (internal use)", + "readOnly": true + }, + "lastHeartBeat": { + "format": "date-time", + "type": "string", + "description": "Last heart beat from SessionHost." + }, + "sessions": { + "type": "integer", + "format": "int32", + "description": "Number of sessions on SessionHost." + }, + "agentVersion": { + "type": "string", + "description": "Version of agent on SessionHost." + }, + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + }, + "status": { + "enum": [ + "Available", + "Unavailable", + "Shutdown", + "Disconnected", + "Upgrading", + "UpgradeFailed", + "NoHeartbeat", + "NotJoinedToDomain", + "DomainTrustRelationshipLost", + "SxSStackListenerNotReady", + "FSLogixNotHealthy", + "NeedsAssistance" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "value": "Available", + "description": "Session Host has passed all the health checks and is available to handle connections." + }, + { + "value": "Unavailable", + "description": "Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status." + }, + { + "value": "Shutdown", + "description": "Session Host is shutdown - RD Agent reported session host to be stopped or deallocated." + }, + { + "value": "Disconnected", + "description": "The Session Host is unavailable because it is currently disconnected." + }, + { + "value": "Upgrading", + "description": "Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections." + }, + { + "value": "UpgradeFailed", + "description": "Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed." + }, + { + "value": "NoHeartbeat", + "description": "The Session Host is not heart beating." + }, + { + "value": "NotJoinedToDomain", + "description": "SessionHost is not joined to domain." + }, + { + "value": "DomainTrustRelationshipLost", + "description": "SessionHost's domain trust relationship lost" + }, + { + "value": "SxSStackListenerNotReady", + "description": "SxS stack installed on the SessionHost is not ready to receive connections." + }, + { + "value": "FSLogixNotHealthy", + "description": "FSLogix is in an unhealthy state on the session host." + }, + { + "value": "NeedsAssistance", + "description": "New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal." + } + ] + }, + "type": "string", + "description": "Status for a SessionHost." + }, + "statusTimestamp": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the status.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "The version of the OS on the session host." + }, + "sxSStackVersion": { + "type": "string", + "description": "The version of the side by side stack on the session host." + }, + "updateState": { + "enum": [ + "Initial", + "Pending", + "Started", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "UpdateState", + "modelAsString": true + }, + "type": "string", + "description": "Update state of a SessionHost." + }, + "lastUpdateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "updateErrorMessage": { + "type": "string", + "description": "The error message." + }, + "lastSessionHostUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The last time update was completed.", + "readOnly": true + }, + "sessionHostConfiguration": { + "type": "string", + "description": "SessionHostConfiguration version reference at the time the update is initiated, in the format of date time. Example: 2024-04-26T04:56:45Z", + "readOnly": true + }, + "sessionHostHealthCheckResults": { + "type": "array", + "readOnly": true, + "description": "List of SessionHostHealthCheckReports", + "items": { + "$ref": "#/definitions/SessionHostHealthCheckReport" + } + } + } + }, + "SessionHostHealthCheckReport": { + "type": "object", + "description": "The report for session host information.", + "properties": { + "healthCheckName": { + "enum": [ + "DomainJoinedCheck", + "DomainTrustCheck", + "FSLogixHealthCheck", + "SxSStackListenerCheck", + "UrlsAccessibleCheck", + "MonitoringAgentCheck", + "DomainReachable", + "WebRTCRedirectorCheck", + "SupportedEncryptionCheck", + "MetaDataServiceCheck", + "AppAttachHealthCheck" + ], + "x-ms-enum": { + "name": "HealthCheckName", + "modelAsString": true, + "values": [ + { + "value": "DomainJoinedCheck", + "description": "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)" + }, + { + "value": "DomainTrustCheck", + "description": "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)" + }, + { + "value": "FSLogixHealthCheck", + "description": "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)" + }, + { + "value": "SxSStackListenerCheck", + "description": "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)" + }, + { + "value": "UrlsAccessibleCheck", + "description": "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)" + }, + { + "value": "MonitoringAgentCheck", + "description": "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)" + }, + { + "value": "DomainReachable", + "description": "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)" + }, + { + "value": "WebRTCRedirectorCheck", + "description": "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)" + }, + { + "value": "SupportedEncryptionCheck", + "description": "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)" + }, + { + "value": "MetaDataServiceCheck", + "description": "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)" + }, + { + "value": "AppAttachHealthCheck", + "description": "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)" + } + ] + }, + "type": "string", + "description": "Represents the name of the health check operation performed.", + "readOnly": true + }, + "healthCheckResult": { + "enum": [ + "Unknown", + "HealthCheckSucceeded", + "HealthCheckFailed", + "SessionHostShutdown" + ], + "x-ms-enum": { + "name": "HealthCheckResult", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Health check result is not currently known." + }, + { + "value": "HealthCheckSucceeded", + "description": "Health check passed." + }, + { + "value": "HealthCheckFailed", + "description": "Health check failed." + }, + { + "value": "SessionHostShutdown", + "description": "We received a Shutdown notification." + } + ] + }, + "type": "string", + "description": "Represents the Health state of the health check we performed.", + "readOnly": true + }, + "additionalFailureDetails": { + "$ref": "#/definitions/SessionHostHealthCheckFailureDetails", + "description": "Additional detailed information on the failure.", + "readOnly": true + } + } + }, + "SessionHostHealthCheckFailureDetails": { + "type": "object", + "description": "Contains details on the failure.", + "properties": { + "message": { + "type": "string", + "description": "Failure message: hints on what is wrong and how to recover.", + "readOnly": true + }, + "errorCode": { + "type": "integer", + "format": "int32", + "description": "Error code corresponding for the failure.", + "readOnly": true + }, + "lastHealthCheckDateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + } + } + }, + "SessionHostPatch": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostPatchProperties" + } + } + }, + "SessionHostPatchProperties": { + "description": "SessionHost properties that can be patched.", + "type": "object", + "properties": { + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + } + } + }, + "SessionHostList": { + "type": "object", + "title": "SessionHostList", + "description": "List of SessionHost definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHost definitions.", + "items": { + "$ref": "#/definitions/SessionHost" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "UserSession": { + "type": "object", + "description": "Represents a UserSession definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for UserSession", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserSessionProperties" + } + } + }, + "UserSessionProperties": { + "description": "Schema for UserSession properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of user session. (internal use)", + "readOnly": true + }, + "userPrincipalName": { + "type": "string", + "description": "The user principal name." + }, + "applicationType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Application type of application." + }, + "sessionState": { + "enum": [ + "Unknown", + "Active", + "Disconnected", + "Pending", + "LogOff", + "UserProfileDiskMounted" + ], + "x-ms-enum": { + "name": "SessionState", + "modelAsString": true + }, + "type": "string", + "description": "State of user session." + }, + "activeDirectoryUserName": { + "type": "string", + "description": "The active directory user name." + }, + "createTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the user session create." + } + } + }, + "UserSessionList": { + "type": "object", + "title": "UserSessionList", + "description": "List of UserSession definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of UserSession definitions.", + "items": { + "$ref": "#/definitions/UserSession" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlan": { + "type": "object", + "title": "ScalingPlan", + "description": "Represents a scaling plan definition.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for scaling plan.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanProperties", + "x-nullable": false + } + } + }, + "ScalingPlanProperties": { + "type": "object", + "description": "Scaling plan properties.", + "required": [ + "timeZone" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of scaling plan. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "hostPoolType": { + "enum": [ + "Pooled", + "Personal" + ], + "x-ms-enum": { + "name": "ScalingHostPoolType", + "modelAsString": true, + "values": [ + { + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + }, + { + "value": "Personal", + "description": "Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost." + } + ] + }, + "default": "Pooled", + "type": "string", + "description": "HostPool type for desktop.", + "x-nullable": false + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingPlanPooledSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + } + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + } + } + } + }, + "ScalingSchedule": { + "description": "A ScalingPlanPooledSchedule.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the ScalingPlanPooledSchedule." + }, + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string" + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp up period." + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp up period." + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp down period." + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp down period." + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "enum": [ + "ZeroSessions", + "ZeroActiveSessions" + ], + "x-ms-enum": { + "name": "StopHostsWhen", + "modelAsString": true + }, + "type": "string", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "ScalingPlanPooledSchedulePatch": { + "type": "object", + "description": "ScalingPlanPooledSchedule properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for ScalingPlanPooledSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPooledScheduleProperties" + } + } + }, + "ScalingPlanPooledScheduleList": { + "type": "object", + "title": "ScalingPlanPooledScheduleList", + "description": "List of ScalingPlanPooledSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ScalingPlanPooledSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlanPooledSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPooledSchedule definition.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for ScalingPlanPooledSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPooledScheduleProperties", + "x-nullable": false + } + } + }, + "ScalingPlanPooledScheduleProperties": { + "description": "A ScalingPlanPooledSchedule.", + "type": "object", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp up period." + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp up period." + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp down period." + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp down period." + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "enum": [ + "ZeroSessions", + "ZeroActiveSessions" + ], + "x-ms-enum": { + "name": "StopHostsWhen", + "modelAsString": true + }, + "type": "string", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "Time": { + "description": "The time for a scaling action to occur.", + "required": [ + "hour", + "minute" + ], + "type": "object", + "properties": { + "hour": { + "format": "int32", + "description": "The hour.", + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "minute": { + "format": "int32", + "description": "The minute.", + "maximum": 59, + "minimum": 0, + "type": "integer" + } + } + }, + "ScalingHostPoolReference": { + "description": "Scaling plan reference to hostpool.", + "type": "object", + "properties": { + "hostPoolArmPath": { + "type": "string", + "description": "Arm path of referenced hostpool." + }, + "scalingPlanEnabled": { + "type": "boolean", + "description": "Is the scaling plan enabled for this hostpool." + } + } + }, + "ScalingPlanList": { + "type": "object", + "title": "ScalingPlanList", + "description": "List of scaling plan definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of scaling plan definitions.", + "items": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlanPatch": { + "type": "object", + "description": "Scaling plan properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated", + "x-nullable": true + }, + "properties": { + "description": "Detailed properties for scaling plan", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPatchProperties" + } + } + }, + "ScalingPlanPatchProperties": { + "type": "object", + "description": "Scaling plan properties.", + "properties": { + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + } + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + } + } + } + }, + "PrivateEndpointConnectionWithSystemData": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResultWithSystemData": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "ScalingPlanPersonalSchedulePatch": { + "type": "object", + "description": "ScalingPlanPersonalSchedule properties that can be patched.", + "properties": { + "properties": { + "description": "Detailed properties for ScalingPlanPersonalSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPersonalScheduleProperties" + } + } + }, + "ScalingPlanPersonalScheduleList": { + "type": "object", + "title": "ScalingPlanPersonalScheduleList", + "description": "List of ScalingPlanPersonalSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ScalingPlanPersonalSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlanPersonalSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPersonalSchedule definition.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for ScalingPlanPersonalSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPersonalScheduleProperties", + "x-nullable": false + } + } + }, + "ScalingPlanPersonalScheduleProperties": { + "description": "A ScalingPlanPersonalSchedule.", + "type": "object", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpAutoStartHosts": { + "enum": [ + "None", + "WithAssignedUser", + "All" + ], + "x-ms-enum": { + "name": "StartupBehavior", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts." + }, + { + "value": "WithAssignedUser", + "description": "Session hosts with an assigned user will be started during Ramp Up" + }, + { + "value": "All", + "description": "All personal session hosts in the hostpool will be started during ramp up." + } + ] + }, + "type": "string", + "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool." + }, + "rampUpStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually." + }, + "rampUpActionOnDisconnect": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the ramp up period." + }, + "rampUpMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period." + }, + "rampUpActionOnLogoff": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the ramp up period." + }, + "rampUpMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period." + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase." + }, + "peakActionOnDisconnect": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the peak period." + }, + "peakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period." + }, + "peakActionOnLogoff": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the peak period." + }, + "peakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase." + }, + "rampDownActionOnDisconnect": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the ramp down period." + }, + "rampDownMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period." + }, + "rampDownActionOnLogoff": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the ramp down period." + }, + "rampDownMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase." + }, + "offPeakActionOnDisconnect": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the off-peak period." + }, + "offPeakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period." + }, + "offPeakActionOnLogoff": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the off-peak period." + }, + "offPeakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period." + } + } + } + }, + "parameters": { + "HostPoolNameParameter": { + "name": "hostPoolName", + "in": "path", + "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", + "type": "string", + "description": "The name of the host pool within the specified resource group", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "MSIXPackageFullNameParameter": { + "name": "msixPackageFullName", + "in": "path", + "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", + "type": "string", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "maxLength": 100, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "AppAttachPackageNameParameter": { + "name": "appAttachPackageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the App Attach package arm object", + "maxLength": 100, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$", + "x-ms-parameter-location": "method" + }, + "ApplicationGroupNameParameter": { + "name": "applicationGroupName", + "in": "path", + "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", + "type": "string", + "description": "The name of the application group", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", + "type": "string", + "description": "The name of the application within the specified application group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "DesktopNameParameter": { + "name": "desktopName", + "in": "path", + "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", + "type": "string", + "description": "The name of the desktop within the specified desktop group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", + "type": "string", + "description": "The name of the workspace", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "SessionHostNameParameter": { + "name": "sessionHostName", + "in": "path", + "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", + "type": "string", + "description": "The name of the session host within the specified host pool", + "maxLength": 48, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "UserSessionIdParameter": { + "name": "userSessionId", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user session within the specified session host", + "maxLength": 24, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "StartMenuItemNameParameter": { + "name": "startMenuItemName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the start menu item within the specified host pool", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "MSIXImageURIParameter": { + "name": "msixImageURI", + "in": "path", + "required": true, + "type": "string", + "description": "URI to the MSIX Image (VHD/CIM).", + "maxLength": 100, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ScalingPlanNameParameter": { + "name": "scalingPlanName", + "in": "path", + "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", + "type": "string", + "description": "The name of the scaling plan.", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ScalingPlanScheduleNameParameter": { + "name": "scalingPlanScheduleName", + "in": "path", + "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", + "type": "string", + "description": "The name of the ScalingPlanSchedule", + "maxLength": 64, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "vmPathParameter": { + "name": "vmPath", + "in": "query", + "required": false, + "type": "string", + "description": "The path to the VM.", + "pattern": "^[A-Z][a-z][0-9][@./-_ ]*$", + "maxLength": 1092, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ActiveSessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ActiveSessionHostConfigurations_Get.json new file mode 100644 index 000000000000..8cdf26c9794e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ActiveSessionHostConfigurations_Get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..9fe5b8c70e93 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackageInfo_Import_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackageInfo_Import_Post.json new file mode 100644 index 000000000000..7ec10eb5726e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackageInfo_Import_Post.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-04-08-preview", + "importPackageInfoRequest": { + "path": "imagepath", + "packageArchitecture": "x64" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Create.json new file mode 100644 index 000000000000..4bd4b1ad317b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Create.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-04-08-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackage": { + "location": "southcentralus", + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + }, + "201": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Delete.json new file mode 100644 index 000000000000..85b845668c34 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Delete.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-04-08-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Get.json new file mode 100644 index 000000000000..f9eaba3bdb87 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Get.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-04-08-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_ListByResourceGroup.json new file mode 100644 index 000000000000..40cc0eb250e6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_ListByResourceGroup.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-04-08-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_ListBySubscription.json new file mode 100644 index 000000000000..77403c6d66d1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_ListBySubscription.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-04-08-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Update.json new file mode 100644 index 000000000000..646425559762 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/AppAttachPackage_Update.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-04-08-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackage": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [ + "hostpool1", + "hostpool2" + ], + "keyVaultURL": "url", + "failHealthCheckOnStagingFailure": false + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Create.json new file mode 100644 index 000000000000..7d29501c717c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Create.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-04-08-preview", + "applicationGroup": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "applicationGroupType": "RemoteApp", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Delete.json new file mode 100644 index 000000000000..9fcb3041c2c0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Delete.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Get.json new file mode 100644 index 000000000000..57dbbf5f8e59 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_ListByResourceGroup.json new file mode 100644 index 000000000000..403e294d245a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_ListByResourceGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-04-08-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_ListBySubscription.json new file mode 100644 index 000000000000..9921ab10fc33 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_ListBySubscription.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-04-08-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Update.json new file mode 100644 index 000000000000..9a64c53d43ff --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ApplicationGroup_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-04-08-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Create.json new file mode 100644 index 000000000000..a6ff8b2b84ea --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Create.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2024-04-08-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Delete.json new file mode 100644 index 000000000000..6fa87550355d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Delete.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Get.json new file mode 100644 index 000000000000..e64c42c43476 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_List.json new file mode 100644 index 000000000000..511fc864e2ba --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Update.json new file mode 100644 index 000000000000..6e52884fc980 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Application_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2024-04-08-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_Get.json new file mode 100644 index 000000000000..80d557fb54fe --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_List.json new file mode 100644 index 000000000000..98769c5305bf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_Update.json new file mode 100644 index 000000000000..0531ee24556b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Desktop_Update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2024-04-08-preview", + "desktop": { + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Create.json new file mode 100644 index 000000000000..43497e505341 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Create.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Delete.json new file mode 100644 index 000000000000..38751125c02e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Delete.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Get.json new file mode 100644 index 000000000000..f71b3a627d2c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Get.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + } + }, + "default": { + "body": { + "error": { + "code": "hostPoolDoesNotExist", + "message": "Host Pool Does Not Exist" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_List.json new file mode 100644 index 000000000000..9517c427cd4f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_List.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_ListByResourceGroup.json new file mode 100644 index 000000000000..1912d11b8425 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_ListByResourceGroup.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Update.json new file mode 100644 index 000000000000..fbe6ca5f5ce9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPool_Update.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "expirationTime": "2020-10-01T15:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPools_RetrieveRegistrationToken_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPools_RetrieveRegistrationToken_Post.json new file mode 100644 index 000000000000..4c0e9b35dbb3 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPools_RetrieveRegistrationToken_Post.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixImage_Expand_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixImage_Expand_Post.json new file mode 100644 index 000000000000..908c4ab2a61f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixImage_Expand_Post.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-04-08-preview", + "msixImageURI": { + "uri": "imagepath" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/imagepath", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/msixImageURI", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias2", + "imagePath": "imagepath", + "packageName": "MsixPackageName2", + "packageFamilyName": "MsixPackage_FamilyName2", + "packageFullName": "MsixPackage_FullName2", + "displayName": "displayname2", + "packageRelativePath": "packagerelativepath2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackageDependency1", + "publisher": "PublisherName1", + "minVersion": "ver1" + }, + { + "dependencyName": "MsixPackageDependency2", + "publisher": "PublisherName2", + "minVersion": "ver2" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId1", + "description": "PackageApplicationDescription1", + "appUserModelID": "AppUserModelId1", + "friendlyName": "FriendlyName1", + "iconImageName": "Iconimagename1", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + }, + { + "appId": "AppId2", + "description": "PackageApplicationDescription2", + "appUserModelID": "AppUserModelId2", + "friendlyName": "FriendlyName2", + "iconImageName": "Iconimagename2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Create.json new file mode 100644 index 000000000000..67440096c77f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Create.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-04-08-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "description": "application-desc", + "appId": "ApplicationId", + "appUserModelID": "AppUserModelId", + "friendlyName": "friendlyname", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixTest_Dependency_Name", + "minVersion": "version", + "publisher": "PublishedName" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageName": "MsixPackage_name", + "packageRelativePath": "packagerelativepath", + "version": "version" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + }, + "201": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Delete.json new file mode 100644 index 000000000000..a831bd7e13fb --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Delete.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-04-08-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Get.json new file mode 100644 index 000000000000..47ea01b43f0a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-04-08-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_List.json new file mode 100644 index 000000000000..029dfc67ffdf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_List.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/MsixPackageFullName2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName2", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath2", + "packageName": "MsixPackage_Name2", + "packageFamilyName": "MsixPackage_FamilyName2", + "displayName": "dis2", + "packageRelativePath": "MsixPackage_RelativePackageRoot2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name2", + "publisher": "MsixPackage_Dependency_Publisher2", + "minVersion": "packageDep_version2" + } + ], + "version": "version2", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id2", + "description": "desc2", + "appUserModelID": "Application_ModelID2", + "friendlyName": "fri2", + "iconImageName": "Apptile2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Update.json new file mode 100644 index 000000000000..d3825fca98a8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/MsixPackage_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-04-08-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "isActive": true, + "isRegularRegistration": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/OperationDescription_List.json new file mode 100644 index 000000000000..a8684491910f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/OperationDescription_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/hostpools/read", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Read hostpool", + "description": "Read hostpool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.DesktopVirtualization/hostpools/write", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Write hostpool", + "description": "Write hostpool" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + } + ] + } + }, + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json new file mode 100644 index 000000000000..1b5f0077264e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json new file mode 100644 index 000000000000..88600c93c218 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_GetByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_GetByHostPool.json new file mode 100644 index 000000000000..7f4d336c67e0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_GetByHostPool.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_GetByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_GetByWorkspace.json new file mode 100644 index 000000000000..78bdf9bc81ae --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_GetByWorkspace.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_ListByHostPool.json new file mode 100644 index 000000000000..5129362c200d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_ListByHostPool.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_ListByWorkspace.json new file mode 100644 index 000000000000..1e4b0db96c40 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_ListByWorkspace.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json new file mode 100644 index 000000000000..208718628003 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-04-08-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json new file mode 100644 index 000000000000..f7bc2aa6aa4c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-04-08-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateLinkResources_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateLinkResources_ListByHostPool.json new file mode 100644 index 000000000000..e6a97a8161a4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateLinkResources_ListByHostPool.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateLinkResources/hostpool", + "type": "Microsoft.DesktopVirtualization/hostpools/privateLinkResources", + "properties": { + "groupId": "hostpool", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateLinkResources_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateLinkResources_ListByWorkspace.json new file mode 100644 index 000000000000..3facae82fdb3 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/PrivateLinkResources_ListByWorkspace.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateLinkResources/workspace", + "type": "Microsoft.DesktopVirtualization/workspaces/privateLinkResources", + "properties": { + "groupId": "workspace", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Create.json new file mode 100644 index 000000000000..a853360d9d59 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Create.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-04-08-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Delete.json new file mode 100644 index 000000000000..ec18cfc2c35d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Get.json new file mode 100644 index 000000000000..64e8f5744f9b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Get.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "PersonalScalingPlan1", + "scalingPlanScheduleName": "PersonalScalingPlanSchedule", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "PersonalScalingPlanSchedule", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/PersonalScalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_List.json new file mode 100644 index 000000000000..989e71c53d94 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_List.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekday", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + }, + { + "name": "scalingPlanScheduleWeekend", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 10, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 14, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "Deallocate", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 16, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "Deallocate", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Update.json new file mode 100644 index 000000000000..bfe9f0cfae98 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPersonalSchedule_Update.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-04-08-preview", + "scalingPlanSchedule": { + "properties": { + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Create.json new file mode 100644 index 000000000000..6d2d6a1d97d4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Create.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-04-08-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Delete.json new file mode 100644 index 000000000000..ec18cfc2c35d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Get.json new file mode 100644 index 000000000000..b9e563637154 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_List.json new file mode 100644 index 000000000000..fc04a1067057 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_List.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + }, + { + "name": "scalingPlanScheduleWeekends1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 10, + "rampUpCapacityThresholdPct": 90, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 0, + "rampDownCapacityThresholdPct": 100, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Update.json new file mode 100644 index 000000000000..01efa2f5fe7d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlanPooledSchedule_Update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-04-08-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownWaitTimeMinutes": 30 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Create.json new file mode 100644 index 000000000000..dd09fe35f33f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Create.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-04-08-preview", + "scalingPlan": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Delete.json new file mode 100644 index 000000000000..12fbf0ca527f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Delete.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Get.json new file mode 100644 index 000000000000..8abba1a1039b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Get.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of scaling plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListByHostPool.json new file mode 100644 index 000000000000..79b228c0338e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListByHostPool.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListByResourceGroup.json new file mode 100644 index 000000000000..79ffd936cd06 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListByResourceGroup.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListBySubscription.json new file mode 100644 index 000000000000..f4b980eaf703 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_ListBySubscription.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroActiveSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Update.json new file mode 100644 index 000000000000..8708827ceb05 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/ScalingPlan_Update.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-04-08-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Create.json new file mode 100644 index 000000000000..3040a8bf970d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Create.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Get.json new file mode 100644 index 000000000000..80d9f6e57901 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Get.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..96bae3dcd620 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Update.json new file mode 100644 index 000000000000..1875eadb8679 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostConfigurations_Update.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "Second Version, Updated Location", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + } + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json new file mode 100644 index 000000000000..ca6d7252f45a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "hostPoolUpdateControlParameter": { + "action": "Start", + "cancelMessage": "Host pool update started" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Create.json new file mode 100644 index 000000000000..b4076c661c36 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Create.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Get.json new file mode 100644 index 000000000000..1d85bd130d62 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_ListByHostPool.json new file mode 100644 index 000000000000..0a6d8447b941 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_ListByHostPool.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Update.json new file mode 100644 index 000000000000..2e75f52a3a8e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_Update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json new file mode 100644 index 000000000000..8f9a43afee34 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "updateSessionHostsRequestBody": { + "scheduledDateTime": "2008-09-22T14:01:54.9571247Z", + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_UpdateStatus_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_UpdateStatus_Get.json new file mode 100644 index 000000000000..82234206f128 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHostManagements_UpdateStatus_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostUpdateStatuses/default", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Delete.json new file mode 100644 index 000000000000..178d2903710c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Delete.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-04-08-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Get.json new file mode 100644 index 000000000000..436fc0732846 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_List.json new file mode 100644 index 000000000000..a6c2d07453e2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_RetryProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_RetryProvisioning_Post.json new file mode 100644 index 000000000000..acf09cb75835 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_RetryProvisioning_Post.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Update.json new file mode 100644 index 000000000000..37abf69961f1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/SessionHost_Update.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-04-08-preview", + "force": true, + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/StartMenuItem_List.json new file mode 100644 index 000000000000..c022e604c63b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/StartMenuItem_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Delete.json new file mode 100644 index 000000000000..b20b2558d635 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Delete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2024-04-08-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Disconnect_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Disconnect_Post.json new file mode 100644 index 000000000000..98093092b730 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Disconnect_Post.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Get.json new file mode 100644 index 000000000000..df0ed5840c17 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_List.json new file mode 100644 index 000000000000..3d9c61f1f1b3 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_List.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_ListByHostPool.json new file mode 100644 index 000000000000..09fa6b989dcd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_ListByHostPool.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview", + "$filter": "userPrincipalName eq 'user1@microsoft.com' and state eq 'active'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_SendMessage_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_SendMessage_Post.json new file mode 100644 index 000000000000..8ceacdd98413 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/UserSession_SendMessage_Post.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2024-04-08-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Create.json new file mode 100644 index 000000000000..27a8a04baed0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Create.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-04-08-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Delete.json new file mode 100644 index 000000000000..a0d57540f4f9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Delete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Get.json new file mode 100644 index 000000000000..381ca8daffef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_ListByResourceGroup.json new file mode 100644 index 000000000000..12c2e990f991 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_ListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_ListBySubscription.json new file mode 100644 index 000000000000..242f86982475 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_ListBySubscription.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-04-08-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Update.json new file mode 100644 index 000000000000..3fe912c624ab --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/Workspace_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-04-08-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md index 54bad6e5fc53..c3fd9598a910 100644 --- a/specification/desktopvirtualization/resource-manager/readme.md +++ b/specification/desktopvirtualization/resource-manager/readme.md @@ -26,10 +26,37 @@ These are the global settings for the DesktopVirtualizationClient API. ``` yaml openapi-type: arm -tag: package-2024-04 +tag: package-preview-2024-04 ``` +### Tag: package-preview-2024-04 + +These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-04' +input-file: + - Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json +suppressions: + - code: AvoidAdditionalProperties + from: desktopvirtualization.json + reason: False postive -> additionalProperties showing in the nested object properties, not at the top level. E.g. "object.vmTags.additionalProperties" and not "object.additionalProperties". We cannot manually exclude using where clauses because of an active bug on this rule. When this is fixed, we should be able to add a (single) where clause. + - code: XmsPageableForListCalls + from: desktopvirtualization.json + reason: False postive -> we have a singleton element in the collection, per recommendation from ARM API review, meaning that we will never return a collection hence no need for such list annotations. Learn more about this (approved) scenario @ ARM RPC Guidance https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#singleton-resources + where: + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default'].* + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostUpdateStatuses/default'].* + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default'].* + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations/default'].* + - code: EvenSegmentedPathForPutOperation + from: desktopvirtualization.json + reason: False postive -> we have a singleton element in the collection, per recommendation from ARM API review, meaning that we won't have an "even" number of segments. Learn more about this (approved) scenario @ ARM RPC Guidance https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#singleton-resources + where: + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default'] + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default'] +``` + ### Tag: package-2024-04 These settings apply only when `--tag=package-2024-04` is specified on the command line. From 50136169b8692fcc3619f79d2121ff4948b7af08 Mon Sep 17 00:00:00 2001 From: pjohari-ms <84465928+pjohari-ms@users.noreply.github.com> Date: Fri, 14 Jun 2024 03:09:55 -0500 Subject: [PATCH 178/343] [Microsoft.DocumentDB] Bug fix for stable API Version 2024-05-15 (#29346) * Bug fix for stable 2024-05-15 * Test commit. Will revert later * Revert "Test commit. Will revert later" This reverts commit 03a99872aecc2590cf47b2f174660d2697ef0383. * Renamed models for better naming --------- Co-authored-by: Roopesh Manda --- .../stable/2024-05-15/services.json | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/services.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/services.json index aa3eb70549df..755de421062e 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/services.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/services.json @@ -320,7 +320,6 @@ "type": "object", "properties": { "properties": { - "x-ms-client-flatten": true, "$ref": "#/definitions/ServiceResourceCreateUpdateProperties" } } @@ -406,8 +405,8 @@ } } }, - "DataTransferServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for DataTransferServiceResource", + "DataTransferServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for DataTransferServiceResource", "type": "object", "x-ms-discriminator-value": "DataTransfer", "allOf": [ @@ -416,8 +415,8 @@ } ] }, - "SqlDedicatedGatewayServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for SqlDedicatedGatewayServiceResource", + "SqlDedicatedGatewayServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for SqlDedicatedGatewayServiceResource", "type": "object", "x-ms-discriminator-value": "SqlDedicatedGateway", "allOf": [ @@ -514,8 +513,8 @@ } } }, - "GraphAPIComputeServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for GraphAPIComputeServiceResource", + "GraphAPIComputeServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for GraphAPIComputeServiceResource", "type": "object", "x-ms-discriminator-value": "GraphAPICompute", "allOf": [ @@ -554,8 +553,8 @@ } } }, - "MaterializedViewsBuilderServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for MaterializedViewsBuilderServiceResource", + "MaterializedViewsBuilderServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for MaterializedViewsBuilderServiceResource", "type": "object", "x-ms-discriminator-value": "MaterializedViewsBuilder", "allOf": [ From ee38bd57c961a7b9f4432a4becf145a65812e9c6 Mon Sep 17 00:00:00 2001 From: James Suplizio Date: Fri, 14 Jun 2024 11:30:41 -0700 Subject: [PATCH 179/343] Update CodeownersLinter version to 1.0.0-dev.20240614.4 (#29450) * Update CodeownersLinter version to 1.0.0-dev.20240614.4 * Update codeowners-linter.yml Update codeowners-linter.yml include path --- eng/pipelines/codeowners-linter.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/eng/pipelines/codeowners-linter.yml b/eng/pipelines/codeowners-linter.yml index 3194eb1de851..fdbd55acc06b 100644 --- a/eng/pipelines/codeowners-linter.yml +++ b/eng/pipelines/codeowners-linter.yml @@ -14,7 +14,7 @@ pr: include: - .github/CODEOWNERS - .github/CODEOWNERS_baseline_errors.txt - - eng/common/pipelines/codeowners-linter.yml + - eng/pipelines/codeowners-linter.yml stages: - stage: Run @@ -31,7 +31,7 @@ stages: vmImage: ubuntu-22.04 variables: - CodeownersLinterVersion: '1.0.0-dev.20240514.2' + CodeownersLinterVersion: '1.0.0-dev.20240614.4' DotNetDevOpsFeed: "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json" RepoLabelUri: "https://azuresdkartifacts.blob.core.windows.net/azure-sdk-write-teams/repository-labels-blob" TeamUserUri: "https://azuresdkartifacts.blob.core.windows.net/azure-sdk-write-teams/azure-sdk-write-teams-blob" From d05250be71ea87b731e14c773bbe9115cd1eb97c Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Mon, 17 Jun 2024 09:07:56 +0800 Subject: [PATCH 180/343] avs, mgmt, fix incorrect tsp of dnsServices int32 (#29395) --- specification/vmware/Microsoft.AVS/models.tsp | 2 +- .../Microsoft.AVS/stable/2023-09-01/vmware.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/vmware/Microsoft.AVS/models.tsp b/specification/vmware/Microsoft.AVS/models.tsp index 96139932f959..9edbaa76c586 100644 --- a/specification/vmware/Microsoft.AVS/models.tsp +++ b/specification/vmware/Microsoft.AVS/models.tsp @@ -1630,7 +1630,7 @@ model WorkloadNetworkDnsZoneProperties { sourceIp?: string; @doc("Number of DNS Services using the DNS zone.") - dnsServices?: int32; + dnsServices?: int64; @doc("The provisioning state") @visibility("read") diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json index fb82d0d15cb2..766543f88c62 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json @@ -10471,7 +10471,7 @@ }, "dnsServices": { "type": "integer", - "format": "int32", + "format": "int64", "description": "Number of DNS Services using the DNS zone." }, "provisioningState": { From f1546dc981fa5d164d7ecd13588520457462c22c Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Mon, 17 Jun 2024 09:08:12 +0800 Subject: [PATCH 181/343] tsp, avs, remove Update model to keep consistency with stable Swagger (#29392) --- specification/vmware/Microsoft.AVS/models.tsp | 43 ------ specification/vmware/Microsoft.AVS/routes.tsp | 22 +-- .../stable/2023-09-01/vmware.json | 143 +----------------- 3 files changed, 13 insertions(+), 195 deletions(-) diff --git a/specification/vmware/Microsoft.AVS/models.tsp b/specification/vmware/Microsoft.AVS/models.tsp index 9edbaa76c586..260686539838 100644 --- a/specification/vmware/Microsoft.AVS/models.tsp +++ b/specification/vmware/Microsoft.AVS/models.tsp @@ -1248,13 +1248,6 @@ model WorkloadNetworkSegment name: string; } -@doc("NSX Segment update") -model WorkloadNetworkSegmentUpdate { - @doc("The updatable properties of a Segment update") - @extension("x-ms-client-flatten", true) - properties?: WorkloadNetworkSegmentProperties; -} - @doc("NSX Segment Properties") model WorkloadNetworkSegmentProperties { @doc("Display name of the segment.") @@ -1317,13 +1310,6 @@ model DhcpIdParameter { dhcpId: string; } -@doc("NSX DHCP update") -model WorkloadNetworkDhcpUpdate { - @doc("The updatable properties of a DHCP update") - @extension("x-ms-client-flatten", false) - properties?: WorkloadNetworkDhcpEntity; -} - @doc("Type of DHCP: SERVER or RELAY.") union DhcpTypeEnum { SERVER: "SERVER", @@ -1423,13 +1409,6 @@ model PortMirroringProfileParameter { portMirroringId: string; } -@doc("NSX Port Mirroring update") -model WorkloadNetworkPortMirroringUpdate { - @doc("The updatable properties of a Port Mirroring update") - @extension("x-ms-client-flatten", true) - properties?: WorkloadNetworkPortMirroringProperties; -} - @doc("NSX Port Mirroring Properties") model WorkloadNetworkPortMirroringProperties { @doc("Display name of the port mirroring profile.") @@ -1477,14 +1456,6 @@ model VmGroupIdParameter { vmGroupId: string; } -#suppress "@azure-tools/typespec-azure-core/casing-style" "Can not change existing name." -@doc("NSX VM Group update") -model WorkloadNetworkVMGroupUpdate { - @doc("The updatable properties of a VM Group update") - @extension("x-ms-client-flatten", true) - properties?: WorkloadNetworkVMGroupProperties; -} - #suppress "@azure-tools/typespec-azure-core/casing-style" "Can not change existing name." @doc("NSX VM Group Properties") model WorkloadNetworkVMGroupProperties { @@ -1552,13 +1523,6 @@ model DnsServiceIdParameter { dnsServiceId: string; } -@doc("NSX DNS Service update") -model WorkloadNetworkDnsServiceUpdate { - @doc("The updatable properties of a DNS Service update") - @extension("x-ms-client-flatten", true) - properties?: WorkloadNetworkDnsServiceProperties; -} - @doc("NSX DNS Service Properties") model WorkloadNetworkDnsServiceProperties { @doc("Display name of the DNS Service.") @@ -1608,13 +1572,6 @@ model DnsZoneIdParameter { dnsZoneId: string; } -@doc("NSX DNS Zone update") -model WorkloadNetworkDnsZoneUpdate { - @doc("The updatable properties of a DNS Zone update") - @extension("x-ms-client-flatten", true) - properties?: WorkloadNetworkDnsZoneProperties; -} - @doc("NSX DNS Zone Properties") model WorkloadNetworkDnsZoneProperties { @doc("Display name of the DNS Zone.") diff --git a/specification/vmware/Microsoft.AVS/routes.tsp b/specification/vmware/Microsoft.AVS/routes.tsp index b380e6871654..cbd9cce37e96 100644 --- a/specification/vmware/Microsoft.AVS/routes.tsp +++ b/specification/vmware/Microsoft.AVS/routes.tsp @@ -354,10 +354,7 @@ interface WorkloadNetworkSegments { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdateSegments") @parameterVisibility - update is ArmCustomPatchAsync< - WorkloadNetworkSegment, - WorkloadNetworkSegmentUpdate - >; + update is ArmCustomPatchAsync; #suppress "deprecated" #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" @@ -425,7 +422,8 @@ interface WorkloadNetworkDhcpConfigurations { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdateDhcp") - update is ArmCustomPatchAsync; + @parameterVisibility + update is ArmCustomPatchAsync; #suppress "deprecated" #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" @@ -514,7 +512,7 @@ interface WorkloadNetworkPortMirroringProfiles { @parameterVisibility update is ArmCustomPatchAsync< WorkloadNetworkPortMirroring, - WorkloadNetworkPortMirroringUpdate + WorkloadNetworkPortMirroring >; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "PortMirroringProfileParameter should be last, but it is breaking to correct it." @@ -594,10 +592,7 @@ interface WorkloadNetworkVmGroups { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdateVMGroup") @parameterVisibility - update is ArmCustomPatchAsync< - WorkloadNetworkVMGroup, - WorkloadNetworkVMGroupUpdate - >; + update is ArmCustomPatchAsync; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "VmGroupIdParameter should be last, but it is breaking to correct it." #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @@ -699,7 +694,7 @@ interface WorkloadNetworkDnsServices { @parameterVisibility update is ArmCustomPatchAsync< WorkloadNetworkDnsService, - WorkloadNetworkDnsServiceUpdate + WorkloadNetworkDnsService >; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "DnsServiceIdParameter should be last, but it is breaking to correct it." @@ -779,10 +774,7 @@ interface WorkloadNetworkDnsZones { #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." @operationId("WorkloadNetworks_UpdateDnsZone") @parameterVisibility - update is ArmCustomPatchAsync< - WorkloadNetworkDnsZone, - WorkloadNetworkDnsZoneUpdate - >; + update is ArmCustomPatchAsync; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "DnsZoneIdParameter should be last, but it is breaking to correct it." #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json index 766543f88c62..4ff2783afb3d 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json @@ -4366,7 +4366,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/WorkloadNetworkDhcpUpdate" + "$ref": "#/definitions/WorkloadNetworkDhcp" }, "x-ms-client-name": "workloadNetworkDhcp" } @@ -4688,7 +4688,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsServiceUpdate" + "$ref": "#/definitions/WorkloadNetworkDnsService" }, "x-ms-client-name": "workloadNetworkDnsService" } @@ -5000,7 +5000,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsZoneUpdate" + "$ref": "#/definitions/WorkloadNetworkDnsZone" }, "x-ms-client-name": "workloadNetworkDnsZone" } @@ -5417,7 +5417,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/WorkloadNetworkPortMirroringUpdate" + "$ref": "#/definitions/WorkloadNetworkPortMirroring" }, "x-ms-client-name": "workloadNetworkPortMirroring" } @@ -5975,7 +5975,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/WorkloadNetworkSegmentUpdate" + "$ref": "#/definitions/WorkloadNetworkSegment" }, "x-ms-client-name": "workloadNetworkSegment" } @@ -6405,7 +6405,7 @@ "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/WorkloadNetworkVMGroupUpdate" + "$ref": "#/definitions/WorkloadNetworkVMGroup" }, "x-ms-client-name": "workloadNetworkVMGroup" } @@ -10098,29 +10098,6 @@ "dhcpType" ] }, - "WorkloadNetworkDhcpEntityUpdate": { - "type": "object", - "description": "Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to\ninherit from", - "properties": { - "dhcpType": { - "$ref": "#/definitions/DhcpTypeEnum", - "description": "Type of DHCP: SERVER or RELAY." - }, - "displayName": { - "type": "string", - "description": "Display name of the DHCP entity." - }, - "revision": { - "type": "integer", - "format": "int64", - "description": "NSX revision number." - } - }, - "discriminator": "dhcpType", - "required": [ - "dhcpType" - ] - }, "WorkloadNetworkDhcpList": { "type": "object", "description": "The response of a WorkloadNetworkDhcp list operation.", @@ -10212,27 +10189,6 @@ ], "x-ms-discriminator-value": "RELAY" }, - "WorkloadNetworkDhcpRelayUpdate": { - "type": "object", - "description": "NSX DHCP Relay", - "properties": { - "serverAddresses": { - "type": "array", - "description": "DHCP Relay Addresses. Max 3.", - "minItems": 1, - "maxItems": 3, - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/WorkloadNetworkDhcpEntityUpdate" - } - ], - "x-ms-discriminator-value": "RELAY" - }, "WorkloadNetworkDhcpServer": { "type": "object", "description": "NSX DHCP Server", @@ -10254,38 +10210,6 @@ ], "x-ms-discriminator-value": "SERVER" }, - "WorkloadNetworkDhcpServerUpdate": { - "type": "object", - "description": "NSX DHCP Server", - "properties": { - "serverAddress": { - "type": "string", - "description": "DHCP Server Address." - }, - "leaseTime": { - "type": "integer", - "format": "int64", - "description": "DHCP Server Lease Time." - } - }, - "allOf": [ - { - "$ref": "#/definitions/WorkloadNetworkDhcpEntityUpdate" - } - ], - "x-ms-discriminator-value": "SERVER" - }, - "WorkloadNetworkDhcpUpdate": { - "type": "object", - "description": "NSX DHCP update", - "properties": { - "properties": { - "$ref": "#/definitions/WorkloadNetworkDhcpEntityUpdate", - "description": "The updatable properties of a DHCP update", - "x-ms-client-flatten": false - } - } - }, "WorkloadNetworkDnsService": { "type": "object", "description": "NSX DNS Service", @@ -10395,17 +10319,6 @@ }, "readOnly": true }, - "WorkloadNetworkDnsServiceUpdate": { - "type": "object", - "description": "NSX DNS Service update", - "properties": { - "properties": { - "$ref": "#/definitions/WorkloadNetworkDnsServiceProperties", - "description": "The updatable properties of a DNS Service update", - "x-ms-client-flatten": true - } - } - }, "WorkloadNetworkDnsServicesList": { "type": "object", "description": "The response of a WorkloadNetworkDnsService list operation.", @@ -10535,17 +10448,6 @@ }, "readOnly": true }, - "WorkloadNetworkDnsZoneUpdate": { - "type": "object", - "description": "NSX DNS Zone update", - "properties": { - "properties": { - "$ref": "#/definitions/WorkloadNetworkDnsZoneProperties", - "description": "The updatable properties of a DNS Zone update", - "x-ms-client-flatten": true - } - } - }, "WorkloadNetworkDnsZonesList": { "type": "object", "description": "The response of a WorkloadNetworkDnsZone list operation.", @@ -10768,17 +10670,6 @@ }, "readOnly": true }, - "WorkloadNetworkPortMirroringUpdate": { - "type": "object", - "description": "NSX Port Mirroring update", - "properties": { - "properties": { - "$ref": "#/definitions/WorkloadNetworkPortMirroringProperties", - "description": "The updatable properties of a Port Mirroring update", - "x-ms-client-flatten": true - } - } - }, "WorkloadNetworkProperties": { "type": "object", "description": "The properties of a workload network", @@ -11084,17 +10975,6 @@ } } }, - "WorkloadNetworkSegmentUpdate": { - "type": "object", - "description": "NSX Segment update", - "properties": { - "properties": { - "$ref": "#/definitions/WorkloadNetworkSegmentProperties", - "description": "The updatable properties of a Segment update", - "x-ms-client-flatten": true - } - } - }, "WorkloadNetworkSegmentsList": { "type": "object", "description": "The response of a WorkloadNetworkSegment list operation.", @@ -11213,17 +11093,6 @@ }, "readOnly": true }, - "WorkloadNetworkVMGroupUpdate": { - "type": "object", - "description": "NSX VM Group update", - "properties": { - "properties": { - "$ref": "#/definitions/WorkloadNetworkVMGroupProperties", - "description": "The updatable properties of a VM Group update", - "x-ms-client-flatten": true - } - } - }, "WorkloadNetworkVMGroupsList": { "type": "object", "description": "The response of a WorkloadNetworkVMGroup list operation.", From 125223f5737a5082e02bc7ef7981e5c819c7330c Mon Sep 17 00:00:00 2001 From: Mitesh Shah <58204159+mitsha-microsoft@users.noreply.github.com> Date: Mon, 17 Jun 2024 11:15:56 +0530 Subject: [PATCH 182/343] [Azure Load Testing] Introduce 2024-05-01-preview API version (#29352) Added Dataplane API Version 2024-05-01-preview for Microsoft.LoadTestService --- .../LoadTestService/client.tsp | 25 + .../CreateOrUpdateTest.json | 198 + .../CreateOrUpdateTestAppComponents.json | 60 + .../CreateOrUpdateTestProfile.json | 81 + .../CreateOrUpdateTestProfileRun.json | 99 + .../CreateOrUpdateTestRun.json | 289 + .../CreateOrUpdateTestRunAppComponents.json | 60 + ...ateOrUpdateTestRunServerMetricsConfig.json | 65 + ...CreateOrUpdateTestServerMetricsConfig.json | 65 + .../2024-05-01-preview/DeleteTest.json | 11 + .../2024-05-01-preview/DeleteTestFile.json | 12 + .../2024-05-01-preview/DeleteTestProfile.json | 11 + .../DeleteTestProfileRun.json | 11 + .../2024-05-01-preview/DeleteTestRun.json | 11 + .../examples/2024-05-01-preview/GetTest.json | 86 + .../2024-05-01-preview/GetTestFile.json | 20 + .../2024-05-01-preview/GetTestProfile.json | 36 + .../GetTestProfileRun_Executed.json | 66 + .../GetTestProfileRun_Executing.json | 38 + .../2024-05-01-preview/GetTestRun.json | 138 + .../2024-05-01-preview/GetTestRunFile.json | 20 + .../ListMetricDimensionValues.json | 23 + .../ListTestAppComponents.json | 30 + .../2024-05-01-preview/ListTestFiles.json | 25 + .../ListTestProfileRuns.json | 63 + .../2024-05-01-preview/ListTestProfiles.json | 45 + .../ListTestRunAppComponents.json | 30 + .../ListTestRunMetrics.json | 465 ++ .../ListTestRunMetricsDefinitions.json | 156 + .../ListTestRunMetricsNamespaces.json | 20 + .../ListTestRunServerMetricsConfig.json | 31 + .../2024-05-01-preview/ListTestRuns.json | 141 + .../ListTestServerMetricsConfig.json | 31 + .../2024-05-01-preview/ListTests.json | 96 + .../StopTestProfileRun.json | 52 + .../2024-05-01-preview/StopTestRun.json | 95 + .../2024-05-01-preview/UploadTestFile.json | 22 + .../loadtestservice/LoadTestService/main.tsp | 4 + .../LoadTestService/models.testprofile.tsp | 324 + .../LoadTestService/models.tsp | 109 +- .../LoadTestService/routes.tsp | 71 + .../2023-04-01-preview/loadtestservice.json | 2 +- .../2024-03-01-preview/loadtestservice.json | 2 +- .../examples/CreateOrUpdateTest.json | 198 + .../CreateOrUpdateTestAppComponents.json | 60 + .../examples/CreateOrUpdateTestProfile.json | 81 + .../CreateOrUpdateTestProfileRun.json | 99 + .../examples/CreateOrUpdateTestRun.json | 289 + .../CreateOrUpdateTestRunAppComponents.json | 60 + ...ateOrUpdateTestRunServerMetricsConfig.json | 65 + ...CreateOrUpdateTestServerMetricsConfig.json | 65 + .../examples/DeleteTest.json | 11 + .../examples/DeleteTestFile.json | 12 + .../examples/DeleteTestProfile.json | 11 + .../examples/DeleteTestProfileRun.json | 11 + .../examples/DeleteTestRun.json | 11 + .../2024-05-01-preview/examples/GetTest.json | 86 + .../examples/GetTestFile.json | 20 + .../examples/GetTestProfile.json | 36 + .../examples/GetTestProfileRun_Executed.json | 66 + .../examples/GetTestProfileRun_Executing.json | 38 + .../examples/GetTestRun.json | 138 + .../examples/GetTestRunFile.json | 20 + .../examples/ListMetricDimensionValues.json | 23 + .../examples/ListTestAppComponents.json | 30 + .../examples/ListTestFiles.json | 25 + .../examples/ListTestProfileRuns.json | 63 + .../examples/ListTestProfiles.json | 45 + .../examples/ListTestRunAppComponents.json | 30 + .../examples/ListTestRunMetrics.json | 465 ++ .../ListTestRunMetricsDefinitions.json | 156 + .../ListTestRunMetricsNamespaces.json | 20 + .../ListTestRunServerMetricsConfig.json | 31 + .../examples/ListTestRuns.json | 141 + .../examples/ListTestServerMetricsConfig.json | 31 + .../examples/ListTests.json | 96 + .../examples/StopTestProfileRun.json | 52 + .../examples/StopTestRun.json | 95 + .../examples/UploadTestFile.json | 22 + .../2024-05-01-preview/loadtestservice.json | 5410 +++++++++++++++++ .../stable/2022-11-01/loadtestservice.json | 2 +- .../loadtestservice/data-plane/readme.md | 9 + 82 files changed, 11358 insertions(+), 4 deletions(-) create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTest.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestAppComponents.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfileRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRunAppComponents.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRunServerMetricsConfig.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestServerMetricsConfig.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTest.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestFile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestProfile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestProfileRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTest.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestFile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executed.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executing.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestRunFile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListMetricDimensionValues.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestAppComponents.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestFiles.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfiles.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunAppComponents.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetrics.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetricsDefinitions.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetricsNamespaces.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunServerMetricsConfig.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRuns.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestServerMetricsConfig.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTests.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestProfileRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/UploadTestFile.json create mode 100644 specification/loadtestservice/LoadTestService/models.testprofile.tsp create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTest.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestAppComponents.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfileRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRunAppComponents.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRunServerMetricsConfig.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestServerMetricsConfig.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTest.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestFile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestProfile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestProfileRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTest.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestFile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executed.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executing.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestRunFile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListMetricDimensionValues.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestAppComponents.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestFiles.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfiles.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunAppComponents.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetrics.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetricsDefinitions.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetricsNamespaces.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunServerMetricsConfig.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRuns.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestServerMetricsConfig.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTests.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestProfileRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/UploadTestFile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json diff --git a/specification/loadtestservice/LoadTestService/client.tsp b/specification/loadtestservice/LoadTestService/client.tsp index 8f2d6060a07b..0b0a9a46833d 100644 --- a/specification/loadtestservice/LoadTestService/client.tsp +++ b/specification/loadtestservice/LoadTestService/client.tsp @@ -7,6 +7,7 @@ using Microsoft.LoadTestService; @useDependency(APIVersions.v2022_11_01) @useDependency(APIVersions.v2023_04_01_preview) +@useDependency(APIVersions.v2024_05_01_preview) namespace Customizations; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @@ -58,3 +59,27 @@ interface TestRunOperations { #suppress "@azure-tools/typespec-azure-core/no-operation-id" stopTestRun is LoadTestRun.stop; } + +@client({ + name: "TestProfileAdministrationClient", + service: Microsoft.LoadTestService, +}) +interface TestProfileAdministrationOperations { + createOrUpdateTestProfile is TestProfileAdministration.createOrUpdateTestProfile; + deleteTestProfile is TestProfileAdministration.deleteTestProfile; + getTestProfile is TestProfileAdministration.getTestProfile; + listTestProfiles is TestProfileAdministration.listTestProfiles; +} + +@client({ + name: "TestProfileRunClient", + service: Microsoft.LoadTestService, +}) +interface TestProfileRunOperations { + createOrUpdateTestProfileRun is TestProfileRunAdministration.createOrUpdateTestProfileRun; + deleteTestProfileRun is TestProfileRunAdministration.deleteTestProfileRun; + getTestProfileRun is TestProfileRunAdministration.getTestProfileRun; + listTestProfileRuns is TestProfileRunAdministration.listTestProfileRuns; + #suppress "@azure-tools/typespec-azure-core/no-operation-id" + stopTestProfileRun is TestProfileRunAdministration.stop; +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTest.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTest.json new file mode 100644 index 000000000000..45e8d327721e --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTest.json @@ -0,0 +1,198 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateTest", + "title": "Create or update a load test", + "parameters": { + "api-version": "2024-05-01-preview", + "testId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/sampleprovider/sampleresourcetype/sampleresourcename" + } + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + }, + "201": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestAppComponents.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestAppComponents.json new file mode 100644 index 000000000000..af5ede5a8e98 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestAppComponents.json @@ -0,0 +1,60 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateAppComponents", + "title": "Add or update app components to a load test", + "parameters": { + "testId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-05-01-preview", + "body": { + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "kind": "web" + } + } + } + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfile.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfile.json new file mode 100644 index 000000000000..64e2f5516732 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfile.json @@ -0,0 +1,81 @@ +{ + "operationId": "TestProfileAdministration_CreateOrUpdateTestProfile", + "title": "Create or update a test profile", + "parameters": { + "api-version": "2024-05-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfileRun.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfileRun.json new file mode 100644 index 000000000000..d0765c4ddf08 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfileRun.json @@ -0,0 +1,99 @@ +{ + "operationId": "TestProfileRunAdministration_CreateOrUpdateTestProfileRun", + "title": "Create/update and start a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview", + "body": { + "displayName": "Performance_TestProfile_Run1", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description" + } + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRun.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRun.json new file mode 100644 index 000000000000..7e873f3d33ef --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRun.json @@ -0,0 +1,289 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateTestRun", + "title": "Create/update and start a load test run", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "oldTestRunId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview", + "body": { + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "ACCEPTED", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "results.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "ACCEPTED", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://dummyurl.com/configresource", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://dummyurl.com/userpropresource", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://dummyurl.com/dummyresourceresult", + "fileName": "results.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://dummyurl.com/logresource", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRunAppComponents.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRunAppComponents.json new file mode 100644 index 000000000000..ecd7d4b4e8cf --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRunAppComponents.json @@ -0,0 +1,60 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateAppComponents", + "title": "Add or update app components to a load test run", + "parameters": { + "testRunId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-05-01-preview", + "body": { + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "kind": "web" + } + } + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRunServerMetricsConfig.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRunServerMetricsConfig.json new file mode 100644 index 000000000000..27f28ac28dbb --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestRunServerMetricsConfig.json @@ -0,0 +1,65 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateServerMetricsConfig", + "title": "Add or update server metrics configuration for a load test run", + "parameters": { + "testRunId": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2024-05-01-preview", + "body": { + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestServerMetricsConfig.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestServerMetricsConfig.json new file mode 100644 index 000000000000..4223c7705a65 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestServerMetricsConfig.json @@ -0,0 +1,65 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig", + "title": "Add or update server metrics configuration for a load test.", + "parameters": { + "testId": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2024-05-01-preview", + "body": { + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "responses": { + "200": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTest.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTest.json new file mode 100644 index 000000000000..247ecd27d59a --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTest.json @@ -0,0 +1,11 @@ +{ + "operationId": "LoadTestAdministration_DeleteTest", + "title": "Delete a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestFile.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestFile.json new file mode 100644 index 000000000000..9b1efbf348ee --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestFile.json @@ -0,0 +1,12 @@ +{ + "operationId": "LoadTestAdministration_DeleteTestFile", + "title": "Delete a file from a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "app.jmx", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestProfile.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestProfile.json new file mode 100644 index 000000000000..3c7b3ca43022 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestProfile.json @@ -0,0 +1,11 @@ +{ + "operationId": "TestProfileAdministration_DeleteTestProfile", + "title": "Delete a test profile", + "parameters": { + "api-version": "2024-05-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestProfileRun.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestProfileRun.json new file mode 100644 index 000000000000..eddc4ddff2aa --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestProfileRun.json @@ -0,0 +1,11 @@ +{ + "operationId": "TestProfileRunAdministration_DeleteTestProfileRun", + "title": "Deletes a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestRun.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestRun.json new file mode 100644 index 000000000000..c35fdc1a3dce --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/DeleteTestRun.json @@ -0,0 +1,11 @@ +{ + "operationId": "LoadTestRun_DeleteTestRun", + "title": "Delete a load test run", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTest.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTest.json new file mode 100644 index 000000000000..25c3d032ac86 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTest.json @@ -0,0 +1,86 @@ +{ + "operationId": "LoadTestAdministration_GetTest", + "title": "Get a load test.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestFile.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestFile.json new file mode 100644 index 000000000000..8ae95096a117 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestFile.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestAdministration_GetTestFile", + "title": "Get a file from a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "sample.jmx", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfile.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfile.json new file mode 100644 index 000000000000..de3ccfec49b7 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfile.json @@ -0,0 +1,36 @@ +{ + "operationId": "TestProfileAdministration_GetTestProfile", + "title": "Get a test profile.", + "parameters": { + "api-version": "2024-05-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executed.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executed.json new file mode 100644 index 000000000000..2dbfe73ad54f --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executed.json @@ -0,0 +1,66 @@ +{ + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "title": "Get a test profile run after the run has executed.", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "DONE", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "recommendations": [ + { + "category": "ThroughputOptimized", + "configurations": [ + "config2" + ] + }, + { + "category": "CostOptimized", + "configurations": [ + "config1" + ] + } + ], + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executing.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executing.json new file mode 100644 index 000000000000..25756f76a81f --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executing.json @@ -0,0 +1,38 @@ +{ + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "title": "Get a test profile run while the run is executing.", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "EXECUTING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestRun.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestRun.json new file mode 100644 index 000000000000..4131ae8e076e --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestRun.json @@ -0,0 +1,138 @@ +{ + "operationId": "LoadTestRun_GetTestRun", + "title": "Get a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + }, + "reportFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestRunFile.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestRunFile.json new file mode 100644 index 000000000000..10ea8702f31f --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestRunFile.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestRun_GetTestRunFile", + "title": "Get a file associated to a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "fileName": "sample.jmx", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListMetricDimensionValues.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListMetricDimensionValues.json new file mode 100644 index 000000000000..4607045b5f9f --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListMetricDimensionValues.json @@ -0,0 +1,23 @@ +{ + "operationId": "LoadTestRun_ListMetricDimensionValues", + "title": "List the dimension values for the given metric dimension name.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "name": "SamplerName", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricNamespace": "LoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + "HighLoadTest" + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestAppComponents.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestAppComponents.json new file mode 100644 index 000000000000..73eb95c79906 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestAppComponents.json @@ -0,0 +1,30 @@ +{ + "operationId": "LoadTestAdministration_GetAppComponents", + "title": "Get associated app component for the given test.", + "parameters": { + "testId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestFiles.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestFiles.json new file mode 100644 index 000000000000..e9291c015ab7 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestFiles.json @@ -0,0 +1,25 @@ +{ + "operationId": "LoadTestAdministration_ListTestFiles", + "title": "Get all test files.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview", + "continuationToken": "continuation token" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json new file mode 100644 index 000000000000..78af0f0b7ad3 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json @@ -0,0 +1,63 @@ +{ + "operationId": "TestProfileRunAdministration_ListTestProfileRuns", + "title": "Get all test profile runs for the specified filters.", + "parameters": { + "maxPageSize": 30, + "minStartDateTime": "2024-05-01T16:00:46.072Z", + "maxStartDateTime": "2024-05-01T16:50:46.072Z", + "minEndDateTime": "2024-05-01T16:00:46.072Z", + "maxEndDateTime": "2024-05-01T16:50:46.072Z", + "testProfileIds": "12345678-1234-1234-1234-123456789012", + "statuses": "ACCEPTED", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.eastus.cnt-prod.loadtesting.azure.com/test-profile-runs?orderby=startDateTime%20desc&continuationToken=some-value&search=Performance_TestProfile&&executionFrom=&executionTo=&maxPageSize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfiles.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfiles.json new file mode 100644 index 000000000000..fcf359be1f1a --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfiles.json @@ -0,0 +1,45 @@ +{ + "operationId": "TestProfileAdministration_ListTestProfiles", + "title": "Get all test profiles for the specified filters.", + "parameters": { + "maxPageSize": 30, + "lastModifiedStartTime": "2024-05-01T16:00:46.072Z", + "lastModifiedEndTime": "2024-05-01T16:50:46.072Z", + "testProfileIds": "12345678-1234-1234-1234-123456789012", + "testIds": "12346-abcd-6789", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.eastus.cnt-prod.loadtesting.azure.com/test-profiles?orderby=lastModifiedDateTime%20desc&continuationToken=some-value&search=Performance_TestProfile&&lastModifiedStartTime=&lastModifiedEndTime=&maxPageSize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunAppComponents.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunAppComponents.json new file mode 100644 index 000000000000..4cbe3b137b59 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunAppComponents.json @@ -0,0 +1,30 @@ +{ + "operationId": "LoadTestRun_GetAppComponents", + "title": "Get associated app component for the given test run.", + "parameters": { + "testRunId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetrics.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetrics.json new file mode 100644 index 000000000000..b20e4676f4ba --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetrics.json @@ -0,0 +1,465 @@ +{ + "operationId": "LoadTestRun_ListMetrics", + "title": "List the metric values for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricNamespace": "LoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2024-05-01-preview", + "body": { + "filters": [ + { + "name": "SamplerName", + "values": [ + "HTTP Request" + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "data": [ + { + "timestamp": "2022-10-29T08:44:40.000Z", + "value": 10.0 + }, + { + "timestamp": "2022-10-29T08:44:45.000Z", + "value": 28.0 + }, + { + "timestamp": "2022-10-29T08:44:50.000Z", + "value": 45.0 + }, + { + "timestamp": "2022-10-29T08:44:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:25.000Z", + "value": 49.0 + } + ], + "dimensionValues": [ + { + "name": "SamplerName", + "value": "HighLoadTest" + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetricsDefinitions.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetricsDefinitions.json new file mode 100644 index 000000000000..fe381e980d2b --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetricsDefinitions.json @@ -0,0 +1,156 @@ +{ + "operationId": "LoadTestRun_ListMetricDefinitions", + "title": "List the metric definitions for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metricNamespace": "LoadTestRunMetrics", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "No of concurrent virtual users", + "name": "VirtualUsers", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "Response time (Successful request)", + "name": "ResponseTime", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Percentile90", + "supportedAggregationTypes": [ + "Average", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "unit": "Milliseconds", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "Total Requests", + "name": "TotalRequests", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + }, + { + "description": "Error response code", + "name": "Errors" + } + ], + "description": "Total Errors", + "name": "Errors", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetricsNamespaces.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetricsNamespaces.json new file mode 100644 index 000000000000..b267eee16c5c --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunMetricsNamespaces.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestRun_ListMetricNamespaces", + "title": "List the metric namespaces for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "description": "Load test run metrics", + "name": "LoadTestRunMetrics" + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunServerMetricsConfig.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunServerMetricsConfig.json new file mode 100644 index 000000000000..9e05eeda011b --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRunServerMetricsConfig.json @@ -0,0 +1,31 @@ +{ + "operationId": "LoadTestRun_GetServerMetricsConfig", + "title": "List server metrics configuration for the given test run.", + "parameters": { + "testRunId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRuns.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRuns.json new file mode 100644 index 000000000000..52069019ab6a --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestRuns.json @@ -0,0 +1,141 @@ +{ + "operationId": "LoadTestRun_ListTestRuns", + "title": "List test runs.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "orderBy": "executedDateTime", + "continuationToken": "continuation token", + "search": "Performance_LoadTest_Run1", + "executionFrom": "2021-12-05T16:43:48.805Z", + "executionTo": "2021-12-05T16:43:48.805Z", + "status": "DONE,EXECUTING", + "maxPageSize": 30, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 10, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + ], + "nextLink": "https://nextlink.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestServerMetricsConfig.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestServerMetricsConfig.json new file mode 100644 index 000000000000..5be13f0aa195 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestServerMetricsConfig.json @@ -0,0 +1,31 @@ +{ + "operationId": "LoadTestAdministration_GetServerMetricsConfig", + "title": "List server metrics configuration for the given test.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTests.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTests.json new file mode 100644 index 000000000000..dd515dde706e --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTests.json @@ -0,0 +1,96 @@ +{ + "operationId": "LoadTestAdministration_ListTests", + "title": "Get all load tests.", + "parameters": { + "orderBy": "executedDateTime", + "search": "Performance_LoadTest", + "lastUpdatedStartTime": "2021-12-05T16:43:46.797Z", + "lastUpdatedEndTime": "2021-12-05T16:43:46.797Z", + "continuationToken": "continuation token", + "maxPageSize": 30, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.westus2.cnt-prod.loadtesting.azure.com/tests?orderby=executedDateTime%20desc&continuationToken=some-value&search=&testId=&executionFrom=&executionTo=&status=&maxpagesize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestProfileRun.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestProfileRun.json new file mode 100644 index 000000000000..0837614fbd0d --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestProfileRun.json @@ -0,0 +1,52 @@ +{ + "operationId": "TestProfileRunAdministration_StopTestProfileRun", + "title": "Stop a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "CANCELLING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestRun.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestRun.json new file mode 100644 index 000000000000..ecb7e5d130ee --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestRun.json @@ -0,0 +1,95 @@ +{ + "operationId": "LoadTestRun_StopTestRun", + "title": "Stop test run by name.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "CANCELLING", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "NOT_APPLICABLE", + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + } + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": null, + "logsFileInfo": null + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": null, + "testRunStatistics": null, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/UploadTestFile.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/UploadTestFile.json new file mode 100644 index 000000000000..02d4df01336d --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/UploadTestFile.json @@ -0,0 +1,22 @@ +{ + "operationId": "LoadTestAdministration_UploadTestFile", + "title": "Upload input file for a given test name.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "body": "application/octet-stream content", + "api-version": "2024-05-01-preview" + }, + "responses": { + "201": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/main.tsp b/specification/loadtestservice/LoadTestService/main.tsp index d10fd6ad079a..9eeccba0b38b 100644 --- a/specification/loadtestservice/LoadTestService/main.tsp +++ b/specification/loadtestservice/LoadTestService/main.tsp @@ -38,6 +38,10 @@ enum APIVersions { @doc("The 2024-03-01-preview version of the Azure Load Testing API.") @useDependency(Azure.Core.Versions.v1_0_Preview_2) v2024_03_01_preview: "2024-03-01-preview", + + @doc("The 2024-05-01-preview version of the Azure Load Testing API.") + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2024_05_01_preview: "2024-05-01-preview", } @doc("OAuth 2.0 Flow with Microsoft Entra ID.") diff --git a/specification/loadtestservice/LoadTestService/models.testprofile.tsp b/specification/loadtestservice/LoadTestService/models.testprofile.tsp new file mode 100644 index 000000000000..02e1e85232ac --- /dev/null +++ b/specification/loadtestservice/LoadTestService/models.testprofile.tsp @@ -0,0 +1,324 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; +using Azure.ClientGenerator.Core; + +namespace Microsoft.LoadTestService; + +@doc("Test Profile Id path parameter.") +@added(APIVersions.v2024_05_01_preview) +model TestProfileIdPathParameter { + @doc("Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.") + @maxLength(50) + @minLength(2) + @key + @visibility("read") + @pattern("^[a-z0-9_-]*$") + testProfileId: string; +} + +@doc("Test Profile Run Id path parameter.") +@added(APIVersions.v2024_05_01_preview) +model TestProfileRunIdPathParameter { + @doc("Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.") + @visibility("read") + @maxLength(50) + @minLength(2) + @key + @pattern("^[a-z0-9_-]*$") + testProfileRunId: string; +} + +@doc("Kind of the resource on which test profile is created.") +@added(APIVersions.v2024_05_01_preview) +union ResourceKind { + string, + + @doc("Resource is a Azure FunctionApp on Flex Consumption Plan.") + FunctionsFlexConsumption: "FunctionsFlexConsumption", +} + +@doc("Test profile run status.") +union TestProfileRunStatus { + string, + + @doc("Test profile run request is accepted.") + ACCEPTED: "ACCEPTED", + + @doc("Test profile run is not yet started.") + NOTSTARTED: "NOTSTARTED", + + @doc("Test profile run has started executing.") + EXECUTING: "EXECUTING", + + @doc("Test profile run has completed successfully.") + DONE: "DONE", + + @doc("Test profile run is being cancelled.") + CANCELLING: "CANCELLING", + + @doc("Test profile run is cancelled.") + CANCELLED: "CANCELLED", + + @doc("Test profile run has failed.") + FAILED: "FAILED", +} + +@doc("Category of Recommendation.") +@added(APIVersions.v2024_05_01_preview) +union RecommendationCategory { + string, + + @doc("The recommendation for this category optimizes the throughput/RPS (Requests per Second) of the app.") + ThroughputOptimized: "ThroughputOptimized", + + @doc("The recommendation for this category optimizes the cost of the app.") + CostOptimized: "CostOptimized", +} + +@doc("Resource configuration instance for a Flex Consumption based Azure Function App.") +@added(APIVersions.v2024_05_01_preview) +model FunctionFlexConsumptionResourceConfiguration { + #suppress "@azure-tools/typespec-azure-core/casing-style" "Abbreviating MB to Mb changes the meaning of the value." + @doc("Memory size of the instance. Supported values are 512, 2048, 2096.") + instanceMemoryMB: int64; + + @doc("HTTP Concurrency for the function app.") + httpConcurrency: int64; +} + +@doc("Details of a particular test run for a test profile run.") +@added(APIVersions.v2024_05_01_preview) +model TestRunDetail { + @doc("Status of the test run.") + status: Status; + + @doc("ID of the configuration on which the test ran.") + configurationId: string; + + @doc("Key value pair of extra properties associated with the test run.") + properties: Record; +} + +@doc("A recommendation object that provides a list of configuration that optimizes its category.") +@added(APIVersions.v2024_05_01_preview) +model TestProfileRunRecommendation { + @doc("Category of the recommendation.") + category: RecommendationCategory; + + @doc("List of configurations IDs for which the recommendation is applicable. These are a subset of the provided target resource configurations.") + configurations?: string[]; +} + +@doc("Configurations of a target resource. This varies with the kind of resource.") +@added(APIVersions.v2024_05_01_preview) +@discriminator("kind") +model TargetResourceConfigurations { + @doc("Kind of the resource for which the configurations apply.") + @visibility("create", "read") + kind: ResourceKind; +} + +@doc("Configurations for a Function App using Flex Consumption Plan.") +@added(APIVersions.v2024_05_01_preview) +model FunctionFlexConsumptionTargetResourceConfigurations + extends TargetResourceConfigurations { + @doc(""" + The kind value to use when providing configuration. + This should typically be not changed from its value. + """) + kind: ResourceKind.FunctionsFlexConsumption; + + @doc("A map of configurations for a Function app using Flex Consumption Plan.") + configurations?: Record; +} + +@doc("The Test Profile Model. A Test Profile resource enables you to set up a test profile which contains various configurations for a supported resource type and a load test to execute on that resource.") +@summary("Test Profile Model.") +@resource("test-profiles") +@added(APIVersions.v2024_05_01_preview) +model TestProfile { + ...TestProfileIdPathParameter; + + @maxLength(50) + @minLength(2) + @doc("Display name of the test profile.") + displayName?: string; + + @maxLength(100) + @doc("Description for the test profile.") + description?: string; + + @doc("Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated.") + @visibility("create", "read") + testId?: string; + + @doc("Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated.") + @visibility("create", "read") + targetResourceId?: string; + + @doc("Configurations of the target resource on which testing would be done.") + targetResourceConfigurations?: TargetResourceConfigurations; + + ...SystemMetaData; +} + +@doc("The Test Profile Run Model. Test Profile Run resource enables you to instantiate an already created test profile and run load tests to get recommendations on the optimal configuration for the target resource.") +@summary("Test Profile Run model.") +@resource("test-profile-runs") +@added(APIVersions.v2024_05_01_preview) +model TestProfileRun { + ...TestProfileRunIdPathParameter; + + // Begin section: Properties provided by user + @maxLength(50) + @minLength(2) + @doc("Display name for the test profile run.") + displayName?: string; + + @maxLength(100) + @doc("The test profile run description") + description?: string; + + @doc("Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated.") + @visibility("create", "read") + testProfileId?: string; + + // End section: Properties provided by user + + // Begin section: Properties populated from Test Profile + @doc("Target resource ID on which the test profile run is created") + @visibility("read") + targetResourceId?: string; + + @doc("Configurations of the target resource on which the test profile ran.") + @visibility("read") + targetResourceConfigurations?: TargetResourceConfigurations; + + // End section: Properties populated from Test Profile + + // Begin section: Test profile Run specific information + @doc("The test profile run status.") + @visibility("read") + status?: TestProfileRunStatus; + + @doc("Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run.") + @visibility("read") + errorDetails?: ErrorDetails[]; + + @doc("The test profile run start DateTime(RFC 3339 literal format).") + @visibility("read") + startDateTime?: utcDateTime; + + @doc("The test profile run end DateTime(RFC 3339 literal format).") + @visibility("read") + endDateTime?: utcDateTime; + + @doc("Test profile run duration in seconds.") + @visibility("read") + durationInSeconds?: int64; + + @doc(""" + Details of the test runs ran as part of the test profile run. + Key is the testRunId of the corresponding testRun. + """) + @visibility("read") + testRunDetails?: Record; + + @doc("Recommendations provided based on a successful test profile run.") + @visibility("read") + recommendations?: TestProfileRunRecommendation[]; + + // End section: Test profile run specific information + + ...SystemMetaData; +} + +@doc("Parameters for list test profile operation") +@added(APIVersions.v2024_05_01_preview) +model ListTestProfileQueryParams { + @doc("Maximum number of results to include in a single response.") + @query + maxpagesize?: int32; + + @doc(""" + Start DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles. + """) + @query + lastModifiedStartTime?: utcDateTime; + + @doc(""" + End DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles. + """) + @query + lastModifiedEndTime?: utcDateTime; + + @doc("Comma separated list of IDs of the test profiles to filter.") + @query + testProfileIds?: string; + + @doc("Comma separated list IDs of the tests which should be associated with the test profiles to fetch.") + @query + testIds?: string; +} + +@doc("Parameters for list test profile run operation") +@added(APIVersions.v2024_05_01_preview) +model ListTestProfileRunQueryParams { + @doc("Maximum number of results to include in a single response.") + @query + maxpagesize?: int32; + + @doc(""" + Minimum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on. + """) + @query + minStartDateTime?: utcDateTime; + + @doc(""" + Maximum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on. + """) + @query + maxStartDateTime?: utcDateTime; + + @doc(""" + Minimum End DateTime(RFC 3339 literal format) of the test profile runs to filter on. + """) + @query + minEndDateTime?: utcDateTime; + + @doc(""" + Maximum End DateTime(RFC 3339 literal format) of the test profile runs to filter on. + """) + @query + maxEndDateTime?: utcDateTime; + + @doc(""" + Start DateTime(RFC 3339 literal format) of the created time range to filter test profile runs. + """) + @query + createdDateStartTime?: utcDateTime; + + @doc(""" + End DateTime(RFC 3339 literal format) of the created time range to filter test profile runs. + """) + @query + createdDateEndTime?: utcDateTime; + + @doc("Comma separated list of IDs of the test profile runs to filter.") + @query + testProfileRunIds?: string; + + @doc("Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch.") + @query + testProfileIds?: string; + + @doc("Comma separated list of Statuses of the test profile runs to filter.") + @query + statuses?: string; +} diff --git a/specification/loadtestservice/LoadTestService/models.tsp b/specification/loadtestservice/LoadTestService/models.tsp index d9e53c981582..ff3c12a76d6b 100644 --- a/specification/loadtestservice/LoadTestService/models.tsp +++ b/specification/loadtestservice/LoadTestService/models.tsp @@ -30,9 +30,36 @@ union PFAgFunc { @doc("Criteria applies for given percentage value.") "percentage", @doc("Criteria applies for avg value.") "avg", @doc("Criteria applies for 50th percentile value.") "p50", + + @doc("Criteria applies for 75th percentile value.") + @added(APIVersions.v2024_05_01_preview) + "p75", + @doc("Criteria applies for 90th percentile value.") "p90", @doc("Criteria applies for 95th percentile value.") "p95", + + @doc("Criteria applies for 96th percentile value.") + @added(APIVersions.v2024_05_01_preview) + "p96", + + @doc("Criteria applies for 97th percentile value.") + @added(APIVersions.v2024_05_01_preview) + "p97", + + @doc("Criteria applies for 98th percentile value.") + @added(APIVersions.v2024_05_01_preview) + "p98", + @doc("Criteria applies for 99th percentile value.") "p99", + + @doc("Criteria applies for 99.9th percentile value.") + @added(APIVersions.v2024_05_01_preview) + "p99.9", + + @doc("Criteria applies for 99.99th percentile value.") + @added(APIVersions.v2024_05_01_preview) + "p99.99", + @doc("Criteria applies for minimum value.") "min", @doc("Criteria applies for maximum value.") "max", } @@ -141,9 +168,35 @@ union AggregationType { @doc("Total count.") "Count", @doc("Aggregation will be average in this case.") "None", @doc("Total sum.") "Total", + + @doc("75th percentile.") + @added(APIVersions.v2024_05_01_preview) + "Percentile75", + @doc("90th percentile.") "Percentile90", @doc("95th percentile.") "Percentile95", + + @doc("96th percentile.") + @added(APIVersions.v2024_05_01_preview) + "Percentile96", + + @doc("97th percentile.") + @added(APIVersions.v2024_05_01_preview) + "Percentile97", + + @doc("98th percentile.") + @added(APIVersions.v2024_05_01_preview) + "Percentile98", + @doc("99th percentile.") "Percentile99", + + @doc("99.9th percentile.") + @added(APIVersions.v2024_05_01_preview) + "Percentile999", + + @doc("99.99th percentile.") + @added(APIVersions.v2024_05_01_preview) + "Percentile9999", } @doc("Metric unit.") @@ -286,7 +339,7 @@ model PassFailMetric { @doc(""" The aggregation function to be applied on the client metric. Allowed functions - - ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, + - ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’, ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, ‘count’ - for requests """) @@ -675,6 +728,14 @@ model TestRun { @visibility("read") kind?: TestKind; + @added(APIVersions.v2024_05_01_preview) + @doc("Request data collection level for test run") + requestDataLevel?: RequestDataLevel; + + @added(APIVersions.v2024_05_01_preview) + @doc("Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise") + debugLogsEnabled?: boolean; + #suppress "@azure-tools/typespec-azure-core/casing-style" "IP is an abbervation and should be all caps" @added(APIVersions.v2023_04_01_preview) @doc("Inject load test engines without deploying public IP for outbound access") @@ -737,6 +798,36 @@ model TestRunStatistics { @visibility("read") pct3ResTime?: float64; + @added(APIVersions.v2024_05_01_preview) + @doc("75 percentile response time.") + @visibility("read") + pct75ResTime?: float64; + + @added(APIVersions.v2024_05_01_preview) + @doc("96 percentile response time.") + @visibility("read") + pct96ResTime?: float64; + + @added(APIVersions.v2024_05_01_preview) + @doc("97 percentile response time.") + @visibility("read") + pct97ResTime?: float64; + + @added(APIVersions.v2024_05_01_preview) + @doc("98 percentile response time.") + @visibility("read") + pct98ResTime?: float64; + + @added(APIVersions.v2024_05_01_preview) + @doc("99.9 percentile response time.") + @visibility("read") + pct999ResTime?: float64; + + @added(APIVersions.v2024_05_01_preview) + @doc("99.99 percentile response time.") + @visibility("read") + pct9999ResTime?: float64; + @doc("Throughput.") @visibility("read") throughput?: float64; @@ -796,6 +887,10 @@ model TestRunOutputArtifacts { @doc("The container for test run artifacts.") @added(APIVersions.v2023_04_01_preview) artifactsContainerInfo?: ArtifactsContainerInfo; + + @added(APIVersions.v2024_05_01_preview) + @doc("The report file for the test run.") + reportFileInfo?: TestRunFileInfo; } @doc("Artifacts container info.") @@ -1122,6 +1217,18 @@ model TestRunIdPathParameter { testRunId: string; } +@added(APIVersions.v2024_05_01_preview) +@doc("Request data collection level for test run") +union RequestDataLevel { + string, + + @doc("No request data will be collected") + NONE: "NONE", + + @doc("Request data will be collected in case of failed requests") + ERRORS: "ERRORS", +} + alias ResourceCreatedResponse = TypeSpec.Http.Response<201> & T; diff --git a/specification/loadtestservice/LoadTestService/routes.tsp b/specification/loadtestservice/LoadTestService/routes.tsp index 9b6118b7dfc9..eccc08c3d88c 100644 --- a/specification/loadtestservice/LoadTestService/routes.tsp +++ b/specification/loadtestservice/LoadTestService/routes.tsp @@ -4,6 +4,7 @@ import "@typespec/http"; import "@typespec/openapi"; import "@azure-tools/typespec-client-generator-core"; import "./models.tsp"; +import "./models.testprofile.tsp"; using Azure.Core; using Azure.Core.Traits; @@ -438,3 +439,73 @@ interface LoadTestRun { TestRunServerMetricConfig >; } + +// NOTE(mitsha): In clients.tsp, when we use `op is ` syntax, it removes all the decorators defined on the interface +// including the @added decorator and causes tsp compile client.tsp to fail. To handle this, @added is added at each operation level instead. +// Do the same whenever routes are added in a new API Version +@tag("TestProfile") +interface TestProfileAdministration { + @summary("Create a new test profile or update an existing test profile.") + @doc("Create a new test profile or update an existing test profile by providing the test profile Id.") + @added(APIVersions.v2024_05_01_preview) + createOrUpdateTestProfile is StandardResourceOperations.ResourceCreateOrUpdate; + + @summary("Delete a test profile.") + @doc("Delete a test profile by its test profile Id.") + @added(APIVersions.v2024_05_01_preview) + deleteTestProfile is StandardResourceOperations.ResourceDelete; + + @summary("Get load test profile details.") + @doc("Get load test profile details by test profile Id.") + @added(APIVersions.v2024_05_01_preview) + getTestProfile is StandardResourceOperations.ResourceRead; + + @summary("List test profiles.") + @doc(""" + Get all test profiles for the given filters. + """) + @added(APIVersions.v2024_05_01_preview) + listTestProfiles is StandardResourceOperations.ResourceList< + TestProfile, + ListQueryParametersTrait + >; +} + +@tag("TestProfileRun") +interface TestProfileRunAdministration { + @summary("Get test profile run details.") + @doc("Get test profile run details by test profile run Id.") + @added(APIVersions.v2024_05_01_preview) + getTestProfileRun is StandardResourceOperations.ResourceRead; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @summary("Create and start a new test profile run.") + @doc("Create and start a new test profile run with the given test profile run Id.") + @added(APIVersions.v2024_05_01_preview) + createOrUpdateTestProfileRun is StandardResourceOperations.ResourceCreateOrUpdate; + + @summary("Delete an existing load test profile run.") + @doc("Delete an existing load test profile run by providing the test profile run Id.") + @added(APIVersions.v2024_05_01_preview) + deleteTestProfileRun is StandardResourceOperations.ResourceDelete; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" + @summary("Stop test profile run.") + @doc("Stop test profile run for the given test profile run Id.") + @operationId("TestProfileRunAdministration_StopTestProfileRun") + @added(APIVersions.v2024_05_01_preview) + stop is StandardResourceOperations.ResourceAction< + TestProfileRun, + {}, + TestProfileRun, + {} + >; + + @summary("List test profile runs.") + @doc("Get all test profile runs for the given filters.") + @added(APIVersions.v2024_05_01_preview) + listTestProfileRuns is StandardResourceOperations.ResourceList< + TestProfileRun, + ListQueryParametersTrait + >; +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json index f045ab45e225..08bcf224b376 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json @@ -2565,7 +2565,7 @@ }, "aggregate": { "$ref": "#/definitions/PFAgFunc", - "description": "The aggregation function to be applied on the client metric. Allowed functions\n- ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’,\n‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,\n‘count’ - for requests" + "description": "The aggregation function to be applied on the client metric. Allowed functions\n- ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’,\n‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,\n‘count’ - for requests" }, "condition": { "type": "string", diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json index 43a5ebf6c1c7..5e656fd95357 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json @@ -2585,7 +2585,7 @@ }, "aggregate": { "$ref": "#/definitions/PFAgFunc", - "description": "The aggregation function to be applied on the client metric. Allowed functions\n- ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’,\n‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,\n‘count’ - for requests" + "description": "The aggregation function to be applied on the client metric. Allowed functions\n- ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’,\n‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,\n‘count’ - for requests" }, "condition": { "type": "string", diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTest.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTest.json new file mode 100644 index 000000000000..45e8d327721e --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTest.json @@ -0,0 +1,198 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateTest", + "title": "Create or update a load test", + "parameters": { + "api-version": "2024-05-01-preview", + "testId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/sampleprovider/sampleresourcetype/sampleresourcename" + } + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + }, + "201": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestAppComponents.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestAppComponents.json new file mode 100644 index 000000000000..af5ede5a8e98 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestAppComponents.json @@ -0,0 +1,60 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateAppComponents", + "title": "Add or update app components to a load test", + "parameters": { + "testId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-05-01-preview", + "body": { + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "kind": "web" + } + } + } + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfile.json new file mode 100644 index 000000000000..64e2f5516732 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfile.json @@ -0,0 +1,81 @@ +{ + "operationId": "TestProfileAdministration_CreateOrUpdateTestProfile", + "title": "Create or update a test profile", + "parameters": { + "api-version": "2024-05-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfileRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfileRun.json new file mode 100644 index 000000000000..d0765c4ddf08 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfileRun.json @@ -0,0 +1,99 @@ +{ + "operationId": "TestProfileRunAdministration_CreateOrUpdateTestProfileRun", + "title": "Create/update and start a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview", + "body": { + "displayName": "Performance_TestProfile_Run1", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description" + } + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRun.json new file mode 100644 index 000000000000..7e873f3d33ef --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRun.json @@ -0,0 +1,289 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateTestRun", + "title": "Create/update and start a load test run", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "oldTestRunId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview", + "body": { + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "ACCEPTED", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "results.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "ACCEPTED", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://dummyurl.com/configresource", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://dummyurl.com/userpropresource", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://dummyurl.com/dummyresourceresult", + "fileName": "results.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://dummyurl.com/logresource", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRunAppComponents.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRunAppComponents.json new file mode 100644 index 000000000000..ecd7d4b4e8cf --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRunAppComponents.json @@ -0,0 +1,60 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateAppComponents", + "title": "Add or update app components to a load test run", + "parameters": { + "testRunId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-05-01-preview", + "body": { + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "kind": "web" + } + } + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRunServerMetricsConfig.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRunServerMetricsConfig.json new file mode 100644 index 000000000000..27f28ac28dbb --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestRunServerMetricsConfig.json @@ -0,0 +1,65 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateServerMetricsConfig", + "title": "Add or update server metrics configuration for a load test run", + "parameters": { + "testRunId": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2024-05-01-preview", + "body": { + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestServerMetricsConfig.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestServerMetricsConfig.json new file mode 100644 index 000000000000..4223c7705a65 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestServerMetricsConfig.json @@ -0,0 +1,65 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig", + "title": "Add or update server metrics configuration for a load test.", + "parameters": { + "testId": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2024-05-01-preview", + "body": { + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "responses": { + "200": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTest.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTest.json new file mode 100644 index 000000000000..247ecd27d59a --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTest.json @@ -0,0 +1,11 @@ +{ + "operationId": "LoadTestAdministration_DeleteTest", + "title": "Delete a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestFile.json new file mode 100644 index 000000000000..9b1efbf348ee --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestFile.json @@ -0,0 +1,12 @@ +{ + "operationId": "LoadTestAdministration_DeleteTestFile", + "title": "Delete a file from a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "app.jmx", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestProfile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestProfile.json new file mode 100644 index 000000000000..3c7b3ca43022 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestProfile.json @@ -0,0 +1,11 @@ +{ + "operationId": "TestProfileAdministration_DeleteTestProfile", + "title": "Delete a test profile", + "parameters": { + "api-version": "2024-05-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestProfileRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestProfileRun.json new file mode 100644 index 000000000000..eddc4ddff2aa --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestProfileRun.json @@ -0,0 +1,11 @@ +{ + "operationId": "TestProfileRunAdministration_DeleteTestProfileRun", + "title": "Deletes a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestRun.json new file mode 100644 index 000000000000..c35fdc1a3dce --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/DeleteTestRun.json @@ -0,0 +1,11 @@ +{ + "operationId": "LoadTestRun_DeleteTestRun", + "title": "Delete a load test run", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTest.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTest.json new file mode 100644 index 000000000000..25c3d032ac86 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTest.json @@ -0,0 +1,86 @@ +{ + "operationId": "LoadTestAdministration_GetTest", + "title": "Get a load test.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestFile.json new file mode 100644 index 000000000000..8ae95096a117 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestFile.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestAdministration_GetTestFile", + "title": "Get a file from a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "sample.jmx", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfile.json new file mode 100644 index 000000000000..de3ccfec49b7 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfile.json @@ -0,0 +1,36 @@ +{ + "operationId": "TestProfileAdministration_GetTestProfile", + "title": "Get a test profile.", + "parameters": { + "api-version": "2024-05-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executed.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executed.json new file mode 100644 index 000000000000..2dbfe73ad54f --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executed.json @@ -0,0 +1,66 @@ +{ + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "title": "Get a test profile run after the run has executed.", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "DONE", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "recommendations": [ + { + "category": "ThroughputOptimized", + "configurations": [ + "config2" + ] + }, + { + "category": "CostOptimized", + "configurations": [ + "config1" + ] + } + ], + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executing.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executing.json new file mode 100644 index 000000000000..25756f76a81f --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executing.json @@ -0,0 +1,38 @@ +{ + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "title": "Get a test profile run while the run is executing.", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "EXECUTING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestRun.json new file mode 100644 index 000000000000..4131ae8e076e --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestRun.json @@ -0,0 +1,138 @@ +{ + "operationId": "LoadTestRun_GetTestRun", + "title": "Get a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + }, + "reportFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestRunFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestRunFile.json new file mode 100644 index 000000000000..10ea8702f31f --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestRunFile.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestRun_GetTestRunFile", + "title": "Get a file associated to a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "fileName": "sample.jmx", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListMetricDimensionValues.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListMetricDimensionValues.json new file mode 100644 index 000000000000..4607045b5f9f --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListMetricDimensionValues.json @@ -0,0 +1,23 @@ +{ + "operationId": "LoadTestRun_ListMetricDimensionValues", + "title": "List the dimension values for the given metric dimension name.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "name": "SamplerName", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricNamespace": "LoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + "HighLoadTest" + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestAppComponents.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestAppComponents.json new file mode 100644 index 000000000000..73eb95c79906 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestAppComponents.json @@ -0,0 +1,30 @@ +{ + "operationId": "LoadTestAdministration_GetAppComponents", + "title": "Get associated app component for the given test.", + "parameters": { + "testId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestFiles.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestFiles.json new file mode 100644 index 000000000000..e9291c015ab7 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestFiles.json @@ -0,0 +1,25 @@ +{ + "operationId": "LoadTestAdministration_ListTestFiles", + "title": "Get all test files.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview", + "continuationToken": "continuation token" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json new file mode 100644 index 000000000000..78af0f0b7ad3 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json @@ -0,0 +1,63 @@ +{ + "operationId": "TestProfileRunAdministration_ListTestProfileRuns", + "title": "Get all test profile runs for the specified filters.", + "parameters": { + "maxPageSize": 30, + "minStartDateTime": "2024-05-01T16:00:46.072Z", + "maxStartDateTime": "2024-05-01T16:50:46.072Z", + "minEndDateTime": "2024-05-01T16:00:46.072Z", + "maxEndDateTime": "2024-05-01T16:50:46.072Z", + "testProfileIds": "12345678-1234-1234-1234-123456789012", + "statuses": "ACCEPTED", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.eastus.cnt-prod.loadtesting.azure.com/test-profile-runs?orderby=startDateTime%20desc&continuationToken=some-value&search=Performance_TestProfile&&executionFrom=&executionTo=&maxPageSize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfiles.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfiles.json new file mode 100644 index 000000000000..fcf359be1f1a --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfiles.json @@ -0,0 +1,45 @@ +{ + "operationId": "TestProfileAdministration_ListTestProfiles", + "title": "Get all test profiles for the specified filters.", + "parameters": { + "maxPageSize": 30, + "lastModifiedStartTime": "2024-05-01T16:00:46.072Z", + "lastModifiedEndTime": "2024-05-01T16:50:46.072Z", + "testProfileIds": "12345678-1234-1234-1234-123456789012", + "testIds": "12346-abcd-6789", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.eastus.cnt-prod.loadtesting.azure.com/test-profiles?orderby=lastModifiedDateTime%20desc&continuationToken=some-value&search=Performance_TestProfile&&lastModifiedStartTime=&lastModifiedEndTime=&maxPageSize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunAppComponents.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunAppComponents.json new file mode 100644 index 000000000000..4cbe3b137b59 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunAppComponents.json @@ -0,0 +1,30 @@ +{ + "operationId": "LoadTestRun_GetAppComponents", + "title": "Get associated app component for the given test run.", + "parameters": { + "testRunId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetrics.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetrics.json new file mode 100644 index 000000000000..b20e4676f4ba --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetrics.json @@ -0,0 +1,465 @@ +{ + "operationId": "LoadTestRun_ListMetrics", + "title": "List the metric values for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricNamespace": "LoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2024-05-01-preview", + "body": { + "filters": [ + { + "name": "SamplerName", + "values": [ + "HTTP Request" + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "data": [ + { + "timestamp": "2022-10-29T08:44:40.000Z", + "value": 10.0 + }, + { + "timestamp": "2022-10-29T08:44:45.000Z", + "value": 28.0 + }, + { + "timestamp": "2022-10-29T08:44:50.000Z", + "value": 45.0 + }, + { + "timestamp": "2022-10-29T08:44:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:25.000Z", + "value": 49.0 + } + ], + "dimensionValues": [ + { + "name": "SamplerName", + "value": "HighLoadTest" + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetricsDefinitions.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetricsDefinitions.json new file mode 100644 index 000000000000..fe381e980d2b --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetricsDefinitions.json @@ -0,0 +1,156 @@ +{ + "operationId": "LoadTestRun_ListMetricDefinitions", + "title": "List the metric definitions for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metricNamespace": "LoadTestRunMetrics", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "No of concurrent virtual users", + "name": "VirtualUsers", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "Response time (Successful request)", + "name": "ResponseTime", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Percentile90", + "supportedAggregationTypes": [ + "Average", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "unit": "Milliseconds", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "Total Requests", + "name": "TotalRequests", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + }, + { + "description": "Error response code", + "name": "Errors" + } + ], + "description": "Total Errors", + "name": "Errors", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetricsNamespaces.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetricsNamespaces.json new file mode 100644 index 000000000000..b267eee16c5c --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunMetricsNamespaces.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestRun_ListMetricNamespaces", + "title": "List the metric namespaces for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "description": "Load test run metrics", + "name": "LoadTestRunMetrics" + } + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunServerMetricsConfig.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunServerMetricsConfig.json new file mode 100644 index 000000000000..9e05eeda011b --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRunServerMetricsConfig.json @@ -0,0 +1,31 @@ +{ + "operationId": "LoadTestRun_GetServerMetricsConfig", + "title": "List server metrics configuration for the given test run.", + "parameters": { + "testRunId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRuns.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRuns.json new file mode 100644 index 000000000000..52069019ab6a --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestRuns.json @@ -0,0 +1,141 @@ +{ + "operationId": "LoadTestRun_ListTestRuns", + "title": "List test runs.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "orderBy": "executedDateTime", + "continuationToken": "continuation token", + "search": "Performance_LoadTest_Run1", + "executionFrom": "2021-12-05T16:43:48.805Z", + "executionTo": "2021-12-05T16:43:48.805Z", + "status": "DONE,EXECUTING", + "maxPageSize": 30, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 10, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + ], + "nextLink": "https://nextlink.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestServerMetricsConfig.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestServerMetricsConfig.json new file mode 100644 index 000000000000..5be13f0aa195 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestServerMetricsConfig.json @@ -0,0 +1,31 @@ +{ + "operationId": "LoadTestAdministration_GetServerMetricsConfig", + "title": "List server metrics configuration for the given test.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTests.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTests.json new file mode 100644 index 000000000000..dd515dde706e --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTests.json @@ -0,0 +1,96 @@ +{ + "operationId": "LoadTestAdministration_ListTests", + "title": "Get all load tests.", + "parameters": { + "orderBy": "executedDateTime", + "search": "Performance_LoadTest", + "lastUpdatedStartTime": "2021-12-05T16:43:46.797Z", + "lastUpdatedEndTime": "2021-12-05T16:43:46.797Z", + "continuationToken": "continuation token", + "maxPageSize": 30, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.westus2.cnt-prod.loadtesting.azure.com/tests?orderby=executedDateTime%20desc&continuationToken=some-value&search=&testId=&executionFrom=&executionTo=&status=&maxpagesize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestProfileRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestProfileRun.json new file mode 100644 index 000000000000..0837614fbd0d --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestProfileRun.json @@ -0,0 +1,52 @@ +{ + "operationId": "TestProfileRunAdministration_StopTestProfileRun", + "title": "Stop a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "CANCELLING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestRun.json new file mode 100644 index 000000000000..ecb7e5d130ee --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestRun.json @@ -0,0 +1,95 @@ +{ + "operationId": "LoadTestRun_StopTestRun", + "title": "Stop test run by name.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "CANCELLING", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "NOT_APPLICABLE", + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + } + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": null, + "logsFileInfo": null + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": null, + "testRunStatistics": null, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/UploadTestFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/UploadTestFile.json new file mode 100644 index 000000000000..02d4df01336d --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/UploadTestFile.json @@ -0,0 +1,22 @@ +{ + "operationId": "LoadTestAdministration_UploadTestFile", + "title": "Upload input file for a given test name.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "body": "application/octet-stream content", + "api-version": "2024-05-01-preview" + }, + "responses": { + "201": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json new file mode 100644 index 000000000000..dd697dbd9d33 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json @@ -0,0 +1,5410 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Load Testing", + "version": "2024-05-01-preview", + "description": "These APIs allow end users to create, view and run load tests using Azure Load Test Service.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "https://{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "Oauth2": [ + "https://cnt-prod.loadtesting.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "Oauth2": { + "type": "oauth2", + "description": "OAuth 2.0 Flow with Microsoft Entra ID.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cnt-prod.loadtesting.azure.com/.default": "" + } + } + }, + "tags": [ + { + "name": "Test" + }, + { + "name": "TestRun" + }, + { + "name": "TestProfile" + }, + { + "name": "TestProfileRun" + } + ], + "paths": { + "/test-profile-runs": { + "get": { + "operationId": "TestProfileRunAdministration_ListTestProfileRuns", + "tags": [ + "TestProfileRun" + ], + "summary": "List test profile runs.", + "description": "Get all test profile runs for the given filters.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.maxpagesize" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.minStartDateTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.maxStartDateTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.minEndDateTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.maxEndDateTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.createdDateStartTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.createdDateEndTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.testProfileRunIds" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.testProfileIds" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.statuses" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTestProfileRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all test profile runs for the specified filters.": { + "$ref": "./examples/ListTestProfileRuns.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/test-profile-runs/{testProfileRunId}": { + "get": { + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "tags": [ + "TestProfileRun" + ], + "summary": "Get test profile run details.", + "description": "Get test profile run details by test profile run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileRunId", + "in": "path", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfileRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a test profile run after the run has executed.": { + "$ref": "./examples/GetTestProfileRun_Executed.json" + }, + "Get a test profile run while the run is executing.": { + "$ref": "./examples/GetTestProfileRun_Executing.json" + } + } + }, + "patch": { + "operationId": "TestProfileRunAdministration_CreateOrUpdateTestProfileRun", + "tags": [ + "TestProfileRun" + ], + "summary": "Create and start a new test profile run.", + "description": "Create and start a new test profile run with the given test profile run Id.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileRunId", + "in": "path", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TestProfileRunCreateOrUpdate" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfileRun" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestProfileRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Create/update and start a test profile run": { + "$ref": "./examples/CreateOrUpdateTestProfileRun.json" + } + } + }, + "delete": { + "operationId": "TestProfileRunAdministration_DeleteTestProfileRun", + "tags": [ + "TestProfileRun" + ], + "summary": "Delete an existing load test profile run.", + "description": "Delete an existing load test profile run by providing the test profile run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileRunId", + "in": "path", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deletes a test profile run": { + "$ref": "./examples/DeleteTestProfileRun.json" + } + } + } + }, + "/test-profile-runs/{testProfileRunId}:stop": { + "post": { + "operationId": "TestProfileRunAdministration_StopTestProfileRun", + "tags": [ + "TestProfileRun" + ], + "summary": "Stop test profile run.", + "description": "Stop test profile run for the given test profile run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileRunId", + "in": "path", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfileRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Stop a test profile run": { + "$ref": "./examples/StopTestProfileRun.json" + } + } + } + }, + "/test-profiles": { + "get": { + "operationId": "TestProfileAdministration_ListTestProfiles", + "tags": [ + "TestProfile" + ], + "summary": "List test profiles.", + "description": "Get all test profiles for the given filters.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.maxpagesize" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.lastModifiedStartTime" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.lastModifiedEndTime" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.testProfileIds" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.testIds" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTestProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all test profiles for the specified filters.": { + "$ref": "./examples/ListTestProfiles.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/test-profiles/{testProfileId}": { + "get": { + "operationId": "TestProfileAdministration_GetTestProfile", + "tags": [ + "TestProfile" + ], + "summary": "Get load test profile details.", + "description": "Get load test profile details by test profile Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileId", + "in": "path", + "description": "Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a test profile.": { + "$ref": "./examples/GetTestProfile.json" + } + } + }, + "patch": { + "operationId": "TestProfileAdministration_CreateOrUpdateTestProfile", + "tags": [ + "TestProfile" + ], + "summary": "Create a new test profile or update an existing test profile.", + "description": "Create a new test profile or update an existing test profile by providing the test profile Id.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileId", + "in": "path", + "description": "Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TestProfileCreateOrUpdate" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfile" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Create or update a test profile": { + "$ref": "./examples/CreateOrUpdateTestProfile.json" + } + } + }, + "delete": { + "operationId": "TestProfileAdministration_DeleteTestProfile", + "tags": [ + "TestProfile" + ], + "summary": "Delete a test profile.", + "description": "Delete a test profile by its test profile Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileId", + "in": "path", + "description": "Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delete a test profile": { + "$ref": "./examples/DeleteTestProfile.json" + } + } + } + }, + "/test-runs": { + "get": { + "operationId": "LoadTestRun_ListTestRuns", + "tags": [ + "TestRun" + ], + "summary": "Get all test runs for the given filters.", + "description": "Get all test runs for the given filters.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.orderby" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.search" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.testId" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.executionFrom" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.executionTo" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.status" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.maxpagesize" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTestRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List test runs.": { + "$ref": "./examples/ListTestRuns.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/test-runs/{testRunId}": { + "get": { + "operationId": "LoadTestRun_GetTestRun", + "tags": [ + "TestRun" + ], + "summary": "Get test run details by test run Id.", + "description": "Get test run details by test run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a load test run.": { + "$ref": "./examples/GetTestRun.json" + } + } + }, + "patch": { + "operationId": "LoadTestRun_CreateOrUpdateTestRun", + "tags": [ + "TestRun" + ], + "summary": "Create and start a new test run with the given test run Id.", + "description": "Create and start a new test run with the given test run Id.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/OldTestRunIdQueryParam" + }, + { + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TestRunCreateOrUpdate" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRun" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Create/update and start a load test run": { + "$ref": "./examples/CreateOrUpdateTestRun.json" + } + } + }, + "delete": { + "operationId": "LoadTestRun_DeleteTestRun", + "tags": [ + "TestRun" + ], + "summary": "Delete an existing load test run.", + "description": "Delete an existing load test run by providing the testRunId.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delete a load test run": { + "$ref": "./examples/DeleteTestRun.json" + } + } + } + }, + "/test-runs/{testRunId}:stop": { + "post": { + "operationId": "LoadTestRun_StopTestRun", + "tags": [ + "TestRun" + ], + "summary": "Stop test run by test run Id.", + "description": "Stop test run by test run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Stop test run by name.": { + "$ref": "./examples/StopTestRun.json" + } + } + } + }, + "/test-runs/{testRunId}/app-components": { + "get": { + "operationId": "LoadTestRun_GetAppComponents", + "tags": [ + "TestRun" + ], + "summary": "Get associated app component (collection of azure resources) for the given test\nrun.", + "description": "Get associated app component (collection of azure resources) for the given test\nrun.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunAppComponents" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get associated app component for the given test run.": { + "$ref": "./examples/ListTestRunAppComponents.json" + } + } + }, + "patch": { + "operationId": "LoadTestRun_CreateOrUpdateAppComponents", + "tags": [ + "TestRun" + ], + "summary": "Add an app component to a test run.", + "description": "Add an app component to a test run by providing the resource Id, name and type.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "App Component model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestRunAppComponentsUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunAppComponents" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestRunAppComponents" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Add or update app components to a load test run": { + "$ref": "./examples/CreateOrUpdateTestRunAppComponents.json" + } + } + } + }, + "/test-runs/{testRunId}/files/{fileName}": { + "get": { + "operationId": "LoadTestRun_GetTestRunFile", + "tags": [ + "TestRun" + ], + "summary": "Get test run file by file name.", + "description": "Get test run file by file name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Name of the file.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunFileInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a file associated to a load test run.": { + "$ref": "./examples/GetTestRunFile.json" + } + } + } + }, + "/test-runs/{testRunId}/metric-definitions": { + "get": { + "operationId": "LoadTestRun_ListMetricDefinitions", + "tags": [ + "TestRun" + ], + "summary": "List the metric definitions for a load test run.", + "description": "List the metric definitions for a load test run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "metricNamespace", + "in": "query", + "description": "Metric namespace to query metric definitions for.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/MetricDefinitionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List the metric definitions for a load test run.": { + "$ref": "./examples/ListTestRunMetricsDefinitions.json" + } + } + } + }, + "/test-runs/{testRunId}/metric-dimensions/{name}/values": { + "get": { + "operationId": "LoadTestRun_ListMetricDimensionValues", + "tags": [ + "TestRun" + ], + "summary": "List the dimension values for the given metric dimension name.", + "description": "List the dimension values for the given metric dimension name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "name", + "in": "path", + "description": "Dimension name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricname" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.interval" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricNamespace" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.timespan" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionValueList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List the dimension values for the given metric dimension name.": { + "$ref": "./examples/ListMetricDimensionValues.json" + } + } + } + }, + "/test-runs/{testRunId}/metric-namespaces": { + "get": { + "operationId": "LoadTestRun_ListMetricNamespaces", + "tags": [ + "TestRun" + ], + "summary": "List the metric namespaces for a load test run.", + "description": "List the metric namespaces for a load test run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/MetricNamespaceCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List the metric namespaces for a load test run.": { + "$ref": "./examples/ListTestRunMetricsNamespaces.json" + } + } + } + }, + "/test-runs/{testRunId}/metrics": { + "post": { + "operationId": "LoadTestRun_ListMetrics", + "tags": [ + "TestRun" + ], + "summary": "List the metric values for a load test run.", + "description": "List the metric values for a load test run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "aggregation", + "in": "query", + "description": "The aggregation", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricname" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.interval" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricNamespace" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.timespan" + }, + { + "name": "body", + "in": "body", + "description": "Metric dimension filter ", + "required": false, + "schema": { + "$ref": "#/definitions/MetricRequestPayload" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Metrics" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List the metric values for a load test run.": { + "$ref": "./examples/ListTestRunMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/test-runs/{testRunId}/server-metrics-config": { + "get": { + "operationId": "LoadTestRun_GetServerMetricsConfig", + "tags": [ + "TestRun" + ], + "summary": "Get associated server metrics configuration for the given test run.", + "description": "Get associated server metrics configuration for the given test run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List server metrics configuration for the given test run.": { + "$ref": "./examples/ListTestRunServerMetricsConfig.json" + } + } + }, + "patch": { + "operationId": "LoadTestRun_CreateOrUpdateServerMetricsConfig", + "tags": [ + "TestRun" + ], + "summary": "Configure server metrics for a test run", + "description": "Configure server metrics for a test run", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "Server metric configuration model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Add or update server metrics configuration for a load test run": { + "$ref": "./examples/CreateOrUpdateTestRunServerMetricsConfig.json" + } + } + } + }, + "/tests": { + "get": { + "operationId": "LoadTestAdministration_ListTests", + "tags": [ + "Test" + ], + "summary": "Get all load tests by the fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", + "description": "Get all load tests by the fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTestQueryParams.orderby" + }, + { + "$ref": "#/parameters/ListTestQueryParams.search" + }, + { + "$ref": "#/parameters/ListTestQueryParams.lastModifiedStartTime" + }, + { + "$ref": "#/parameters/ListTestQueryParams.lastModifiedEndTime" + }, + { + "$ref": "#/parameters/ListTestQueryParams.maxpagesize" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTest" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all load tests.": { + "$ref": "./examples/ListTests.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/tests/{testId}": { + "get": { + "operationId": "LoadTestAdministration_GetTest", + "tags": [ + "Test" + ], + "summary": "Get load test details by test Id", + "description": "Get load test details by test Id", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Test" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a load test.": { + "$ref": "./examples/GetTest.json" + } + } + }, + "patch": { + "operationId": "LoadTestAdministration_CreateOrUpdateTest", + "tags": [ + "Test" + ], + "summary": "Create a new test or update an existing test by providing the test Id.", + "description": "Create a new test or update an existing test by providing the test Id.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TestCreateOrUpdate" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Test" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Test" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Create or update a load test": { + "$ref": "./examples/CreateOrUpdateTest.json" + } + } + }, + "delete": { + "operationId": "LoadTestAdministration_DeleteTest", + "tags": [ + "Test" + ], + "summary": "Delete a test by its test Id.", + "description": "Delete a test by its test Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delete a load test": { + "$ref": "./examples/DeleteTest.json" + } + } + } + }, + "/tests/{testId}/app-components": { + "get": { + "operationId": "LoadTestAdministration_GetAppComponents", + "tags": [ + "Test" + ], + "summary": "Get associated app component (collection of azure resources) for the given test.", + "description": "Get associated app component (collection of azure resources) for the given test.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestAppComponents" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get associated app component for the given test.": { + "$ref": "./examples/ListTestAppComponents.json" + } + } + }, + "patch": { + "operationId": "LoadTestAdministration_CreateOrUpdateAppComponents", + "tags": [ + "Test" + ], + "summary": "Add an app component to a test.", + "description": "Add an app component to a test by providing the resource Id, name and type.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "App Component model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestAppComponentsUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestAppComponents" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestAppComponents" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Add or update app components to a load test": { + "$ref": "./examples/CreateOrUpdateTestAppComponents.json" + } + } + } + }, + "/tests/{testId}/files": { + "get": { + "operationId": "LoadTestAdministration_ListTestFiles", + "tags": [ + "Test" + ], + "summary": "Get all test files.", + "description": "Get all test files.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTestFileInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all test files.": { + "$ref": "./examples/ListTestFiles.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/tests/{testId}/files/{fileName}": { + "get": { + "operationId": "LoadTestAdministration_GetTestFile", + "tags": [ + "Test" + ], + "summary": "Get all the files that are associated with a test.", + "description": "Get all the files that are associated with a test.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Name of the file.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestFileInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a file from a load test": { + "$ref": "./examples/GetTestFile.json" + } + } + }, + "put": { + "operationId": "LoadTestAdministration_UploadTestFile", + "tags": [ + "Test" + ], + "summary": "Upload input file for a given test Id. File size can't be more than 50 MB.\nExisting file with same name for the given test will be overwritten. File\nshould be provided in the request body as application/octet-stream.", + "description": "Upload input file for a given test Id. File size can't be more than 50 MB.\nExisting file with same name for the given test will be overwritten. File\nshould be provided in the request body as application/octet-stream.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Unique name for test file with file extension like : App.jmx", + "required": true, + "type": "string" + }, + { + "name": "fileType", + "in": "query", + "description": "File type", + "required": false, + "type": "string", + "enum": [ + "JMX_FILE", + "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", + "URL_TEST_CONFIG_JSON", + "TEST_SCRIPT" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": true, + "values": [ + { + "name": "JMX_FILE", + "value": "JMX_FILE", + "description": "If the file is a JMX script." + }, + { + "name": "USER_PROPERTIES", + "value": "USER_PROPERTIES", + "description": "If the file is a user properties file." + }, + { + "name": "ADDITIONAL_ARTIFACTS", + "value": "ADDITIONAL_ARTIFACTS", + "description": "If the file is not among any of the other supported file types." + }, + { + "name": "ZIPPED_ARTIFACTS", + "value": "ZIPPED_ARTIFACTS", + "description": "If the file is a compressed archive containing a collection of various artifacts or resources." + }, + { + "name": "URL_TEST_CONFIG_JSON", + "value": "URL_TEST_CONFIG_JSON", + "description": "If the file is a JSON config file to define the requests for a URL test." + }, + { + "name": "TEST_SCRIPT", + "value": "TEST_SCRIPT", + "description": "If the file is a test script." + } + ] + } + }, + { + "name": "body", + "in": "body", + "description": "The file content as application/octet-stream.", + "required": true, + "schema": { + "type": "string", + "format": "binary" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestFileInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Upload input file for a given test name.": { + "$ref": "./examples/UploadTestFile.json" + } + } + }, + "delete": { + "operationId": "LoadTestAdministration_DeleteTestFile", + "tags": [ + "Test" + ], + "summary": "Delete file by the file name for a test", + "description": "Delete file by the file name for a test", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Name of the file.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delete a file from a load test": { + "$ref": "./examples/DeleteTestFile.json" + } + } + } + }, + "/tests/{testId}/server-metrics-config": { + "get": { + "operationId": "LoadTestAdministration_GetServerMetricsConfig", + "tags": [ + "Test" + ], + "summary": "List server metrics configuration for the given test.", + "description": "List server metrics configuration for the given test.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestServerMetricConfig" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List server metrics configuration for the given test.": { + "$ref": "./examples/ListTestServerMetricsConfig.json" + } + } + }, + "patch": { + "operationId": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig", + "tags": [ + "Test" + ], + "summary": "Configure server metrics for a test", + "description": "Configure server metrics for a test", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "Server metric configuration model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestServerMetricConfigUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestServerMetricConfig" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestServerMetricConfig" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Add or update server metrics configuration for a load test.": { + "$ref": "./examples/CreateOrUpdateTestServerMetricsConfig.json" + } + } + } + } + }, + "definitions": { + "AggregationType": { + "type": "string", + "description": "Aggregation type.", + "enum": [ + "Average", + "Count", + "None", + "Total", + "Percentile75", + "Percentile90", + "Percentile95", + "Percentile96", + "Percentile97", + "Percentile98", + "Percentile99", + "Percentile999", + "Percentile9999" + ], + "x-ms-enum": { + "name": "AggregationType", + "modelAsString": true, + "values": [ + { + "name": "Average", + "value": "Average", + "description": "Average value." + }, + { + "name": "Count", + "value": "Count", + "description": "Total count." + }, + { + "name": "None", + "value": "None", + "description": "Aggregation will be average in this case." + }, + { + "name": "Total", + "value": "Total", + "description": "Total sum." + }, + { + "name": "Percentile75", + "value": "Percentile75", + "description": "75th percentile." + }, + { + "name": "Percentile90", + "value": "Percentile90", + "description": "90th percentile." + }, + { + "name": "Percentile95", + "value": "Percentile95", + "description": "95th percentile." + }, + { + "name": "Percentile96", + "value": "Percentile96", + "description": "96th percentile." + }, + { + "name": "Percentile97", + "value": "Percentile97", + "description": "97th percentile." + }, + { + "name": "Percentile98", + "value": "Percentile98", + "description": "98th percentile." + }, + { + "name": "Percentile99", + "value": "Percentile99", + "description": "99th percentile." + }, + { + "name": "Percentile999", + "value": "Percentile999", + "description": "99.9th percentile." + }, + { + "name": "Percentile9999", + "value": "Percentile9999", + "description": "99.99th percentile." + } + ] + } + }, + "AppComponent": { + "type": "object", + "description": "An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)", + "properties": { + "resourceId": { + "type": "string", + "description": "fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}", + "readOnly": true + }, + "resourceName": { + "type": "string", + "description": "Azure resource name, required while creating the app component." + }, + "resourceType": { + "type": "string", + "description": "Azure resource type, required while creating the app component." + }, + "displayName": { + "type": "string", + "description": "Azure resource display name" + }, + "resourceGroup": { + "type": "string", + "description": "Resource group name of the Azure resource", + "readOnly": true + }, + "subscriptionId": { + "type": "string", + "description": "Subscription Id of the Azure resource", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Kind of Azure resource type" + } + }, + "required": [ + "resourceId", + "resourceName", + "resourceType" + ] + }, + "AppComponentUpdate": { + "type": "object", + "description": "An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)", + "properties": { + "resourceName": { + "type": "string", + "description": "Azure resource name, required while creating the app component." + }, + "resourceType": { + "type": "string", + "description": "Azure resource type, required while creating the app component." + }, + "displayName": { + "type": "string", + "description": "Azure resource display name" + }, + "kind": { + "type": "string", + "description": "Kind of Azure resource type" + } + } + }, + "ArtifactsContainerInfo": { + "type": "object", + "description": "Artifacts container info.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "This is a SAS URI to an Azure Storage Container that contains the test run artifacts." + }, + "expireDateTime": { + "type": "string", + "format": "date-time", + "description": "Expiry time of the container (RFC 3339 literal format)" + } + } + }, + "AutoStopCriteria": { + "type": "object", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window.", + "properties": { + "autoStopDisabled": { + "type": "boolean", + "description": "Whether auto-stop should be disabled. The default value is false.", + "default": false + }, + "errorRate": { + "type": "number", + "format": "float", + "description": "Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0", + "default": 90 + }, + "errorRateTimeWindowInSeconds": { + "type": "integer", + "format": "int32", + "description": "Time window during which the error percentage should be evaluated in seconds.", + "default": 60 + } + } + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "CertificateMetadata": { + "type": "object", + "description": "Certificates metadata", + "properties": { + "value": { + "type": "string", + "description": "The value of the certificate for respective type" + }, + "type": { + "$ref": "#/definitions/CertificateType", + "description": "Type of certificate" + }, + "name": { + "type": "string", + "description": "Name of the certificate." + } + } + }, + "CertificateType": { + "type": "string", + "description": "Types of certificates supported.", + "enum": [ + "AKV_CERT_URI" + ], + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true, + "values": [ + { + "name": "AKV_CERT_URI", + "value": "AKV_CERT_URI", + "description": "If the certificate is stored in an Azure Key Vault." + } + ] + } + }, + "DimensionFilter": { + "type": "object", + "description": "Dimension name and values to filter", + "properties": { + "name": { + "type": "string", + "description": "The dimension name" + }, + "values": { + "type": "array", + "description": "The dimension values. Maximum values can be 20.", + "items": { + "type": "string" + } + } + } + }, + "DimensionValue": { + "type": "object", + "description": "Represents a metric dimension value.", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "value": { + "type": "string", + "description": "The value of the dimension." + } + } + }, + "DimensionValueList": { + "type": "object", + "description": "Metrics dimension values.", + "properties": { + "name": { + "type": "string", + "description": "The dimension name", + "readOnly": true + }, + "value": { + "type": "array", + "description": "The dimension value", + "items": { + "type": "string" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "Link for the next set of values in case of paginated results, if applicable." + } + } + }, + "ErrorDetails": { + "type": "object", + "description": "Error details if there is any failure in load test run", + "properties": { + "message": { + "type": "string", + "description": "Error details in case test run was not successfully run.", + "readOnly": true + } + } + }, + "FileStatus": { + "type": "string", + "description": "File status.", + "enum": [ + "NOT_VALIDATED", + "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", + "VALIDATION_INITIATED", + "VALIDATION_NOT_REQUIRED" + ], + "x-ms-enum": { + "name": "FileStatus", + "modelAsString": true, + "values": [ + { + "name": "NOT_VALIDATED", + "value": "NOT_VALIDATED", + "description": "File is not validated." + }, + { + "name": "VALIDATION_SUCCESS", + "value": "VALIDATION_SUCCESS", + "description": "File is validated." + }, + { + "name": "VALIDATION_FAILURE", + "value": "VALIDATION_FAILURE", + "description": "File validation is failed." + }, + { + "name": "VALIDATION_INITIATED", + "value": "VALIDATION_INITIATED", + "description": "File validation is in progress." + }, + { + "name": "VALIDATION_NOT_REQUIRED", + "value": "VALIDATION_NOT_REQUIRED", + "description": "Validation is not required." + } + ] + } + }, + "FileType": { + "type": "string", + "description": "Types of file supported.", + "enum": [ + "JMX_FILE", + "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", + "URL_TEST_CONFIG_JSON", + "TEST_SCRIPT" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": true, + "values": [ + { + "name": "JMX_FILE", + "value": "JMX_FILE", + "description": "If the file is a JMX script." + }, + { + "name": "USER_PROPERTIES", + "value": "USER_PROPERTIES", + "description": "If the file is a user properties file." + }, + { + "name": "ADDITIONAL_ARTIFACTS", + "value": "ADDITIONAL_ARTIFACTS", + "description": "If the file is not among any of the other supported file types." + }, + { + "name": "ZIPPED_ARTIFACTS", + "value": "ZIPPED_ARTIFACTS", + "description": "If the file is a compressed archive containing a collection of various artifacts or resources." + }, + { + "name": "URL_TEST_CONFIG_JSON", + "value": "URL_TEST_CONFIG_JSON", + "description": "If the file is a JSON config file to define the requests for a URL test." + }, + { + "name": "TEST_SCRIPT", + "value": "TEST_SCRIPT", + "description": "If the file is a test script." + } + ] + } + }, + "FunctionFlexConsumptionResourceConfiguration": { + "type": "object", + "description": "Resource configuration instance for a Flex Consumption based Azure Function App.", + "properties": { + "instanceMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Memory size of the instance. Supported values are 512, 2048, 2096." + }, + "httpConcurrency": { + "type": "integer", + "format": "int64", + "description": "HTTP Concurrency for the function app." + } + }, + "required": [ + "instanceMemoryMB", + "httpConcurrency" + ] + }, + "FunctionFlexConsumptionResourceConfigurationCreateOrUpdate": { + "type": "object", + "description": "Resource configuration instance for a Flex Consumption based Azure Function App.", + "properties": { + "instanceMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Memory size of the instance. Supported values are 512, 2048, 2096." + }, + "httpConcurrency": { + "type": "integer", + "format": "int64", + "description": "HTTP Concurrency for the function app." + } + } + }, + "FunctionFlexConsumptionTargetResourceConfigurations": { + "type": "object", + "description": "Configurations for a Function App using Flex Consumption Plan.", + "properties": { + "configurations": { + "type": "object", + "description": "A map of configurations for a Function app using Flex Consumption Plan.", + "additionalProperties": { + "$ref": "#/definitions/FunctionFlexConsumptionResourceConfiguration" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetResourceConfigurations" + } + ], + "x-ms-discriminator-value": "FunctionsFlexConsumption" + }, + "FunctionFlexConsumptionTargetResourceConfigurationsCreateOrUpdate": { + "type": "object", + "description": "Configurations for a Function App using Flex Consumption Plan.", + "properties": { + "configurations": { + "type": "object", + "description": "A map of configurations for a Function app using Flex Consumption Plan.", + "additionalProperties": { + "$ref": "#/definitions/FunctionFlexConsumptionResourceConfigurationCreateOrUpdate" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetResourceConfigurationsCreateOrUpdate" + } + ], + "x-ms-discriminator-value": "FunctionsFlexConsumption" + }, + "LoadTestConfiguration": { + "type": "object", + "description": "Configurations for the load test.", + "properties": { + "engineInstances": { + "type": "integer", + "format": "int32", + "description": "The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test." + }, + "splitAllCSVs": { + "type": "boolean", + "description": "If false, Azure Load Testing copies and processes your input files unmodified\nacross all test engine instances. If true, Azure Load Testing splits the CSV\ninput data evenly across all engine instances. If you provide multiple CSV\nfiles, each file will be split evenly.", + "default": false + }, + "quickStartTest": { + "type": "boolean", + "description": "If true, optionalLoadTestConfig is required and JMX script for the load test is\nnot required to upload.", + "default": false + }, + "optionalLoadTestConfig": { + "$ref": "#/definitions/OptionalLoadTestConfig", + "description": "Configuration for quick load test" + }, + "regionalLoadTestConfig": { + "type": "array", + "description": "Region distribution configuration for the load test.", + "items": { + "$ref": "#/definitions/RegionalConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "MetricAvailability": { + "type": "object", + "description": "Metric availability specifies the time grain (aggregation interval or frequency)", + "properties": { + "timeGrain": { + "$ref": "#/definitions/TimeGrain", + "description": "The time grain specifies the aggregation interval for the metric. Expressed as\na duration 'PT1M', 'PT1H', etc." + } + } + }, + "MetricDefinition": { + "type": "object", + "description": "Metric definition", + "properties": { + "dimensions": { + "type": "array", + "description": "List of dimensions", + "items": { + "$ref": "#/definitions/NameAndDesc" + }, + "x-ms-identifiers": [] + }, + "description": { + "type": "string", + "description": "The metric description" + }, + "name": { + "type": "string", + "description": "The metric name" + }, + "namespace": { + "type": "string", + "description": "The namespace the metric belongs to." + }, + "primaryAggregationType": { + "$ref": "#/definitions/AggregationType", + "description": "The primary aggregation type value defining how to use the values for display." + }, + "supportedAggregationTypes": { + "type": "array", + "description": "The collection of what all aggregation types are supported.", + "items": { + "type": "string" + } + }, + "unit": { + "$ref": "#/definitions/MetricUnit", + "description": "The unit of the metric." + }, + "metricAvailabilities": { + "type": "array", + "description": "Metric availability specifies the time grain (aggregation interval or\nfrequency).", + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "x-ms-identifiers": [] + } + } + }, + "MetricDefinitionCollection": { + "type": "object", + "description": "Represents collection of metric definitions.", + "properties": { + "value": { + "type": "array", + "description": "the values for the metric definitions.", + "items": { + "$ref": "#/definitions/MetricDefinition" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ] + }, + "MetricNamespace": { + "type": "object", + "description": "Metric namespace class specifies the metadata for a metric namespace.", + "properties": { + "description": { + "type": "string", + "description": "The namespace description." + }, + "name": { + "type": "string", + "description": "The metric namespace name." + } + } + }, + "MetricNamespaceCollection": { + "type": "object", + "description": "Represents collection of metric namespaces.", + "properties": { + "value": { + "type": "array", + "description": "The values for the metric namespaces.", + "items": { + "$ref": "#/definitions/MetricNamespace" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ] + }, + "MetricRequestPayload": { + "type": "object", + "description": "Filters to fetch the set of metric.", + "properties": { + "filters": { + "type": "array", + "description": "Get metrics for specific dimension values. Example: Metric contains dimension\nlike SamplerName, Error. To retrieve all the time series data where SamplerName\nis equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be\n{\"SamplerName\", [\"HTTPRequest1\", \"HTTPRequest2\"}", + "items": { + "$ref": "#/definitions/DimensionFilter" + }, + "x-ms-identifiers": [] + } + } + }, + "MetricUnit": { + "type": "string", + "description": "Metric unit.", + "enum": [ + "NotSpecified", + "Percent", + "Count", + "Seconds", + "Milliseconds", + "Bytes", + "BytesPerSecond", + "CountPerSecond" + ], + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "No unit specified." + }, + { + "name": "Percent", + "value": "Percent", + "description": "Percentage." + }, + { + "name": "Count", + "value": "Count", + "description": "Value count." + }, + { + "name": "Seconds", + "value": "Seconds", + "description": "Seconds." + }, + { + "name": "Milliseconds", + "value": "Milliseconds", + "description": "Milliseconds" + }, + { + "name": "Bytes", + "value": "Bytes", + "description": "Bytes" + }, + { + "name": "BytesPerSecond", + "value": "BytesPerSecond", + "description": "Bytes per second" + }, + { + "name": "CountPerSecond", + "value": "CountPerSecond", + "description": "Count per second" + } + ] + } + }, + "MetricValue": { + "type": "object", + "description": "Represents a metric value.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The timestamp for the metric value in RFC 3339 format." + }, + "value": { + "type": "number", + "format": "double", + "description": "The metric value." + } + } + }, + "Metrics": { + "type": "object", + "description": "The response to a metrics query.", + "properties": { + "value": { + "type": "array", + "description": "The TimeSeriesElement items on this page", + "items": { + "$ref": "#/definitions/TimeSeriesElement" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NameAndDesc": { + "type": "object", + "description": "The name and description", + "properties": { + "description": { + "type": "string", + "description": "The description" + }, + "name": { + "type": "string", + "description": "The name" + } + } + }, + "OptionalLoadTestConfig": { + "type": "object", + "description": "Configuration for quick load test", + "properties": { + "endpointUrl": { + "type": "string", + "description": "Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login" + }, + "requestsPerSecond": { + "type": "integer", + "format": "int32", + "description": "Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it." + }, + "maxResponseTimeInMs": { + "type": "integer", + "format": "int32", + "description": "Maximum response time in milliseconds of the API/endpoint." + }, + "virtualUsers": { + "type": "integer", + "format": "int32", + "description": "No of concurrent virtual users." + }, + "rampUpTime": { + "type": "integer", + "format": "int32", + "description": "Ramp up time in seconds." + }, + "duration": { + "type": "integer", + "format": "int32", + "description": "Test run duration in seconds." + } + } + }, + "PFAgFunc": { + "type": "string", + "description": "Aggregation functions for pass/fail criteria.", + "enum": [ + "count", + "percentage", + "avg", + "p50", + "p75", + "p90", + "p95", + "p96", + "p97", + "p98", + "p99", + "p99.9", + "p99.99", + "min", + "max" + ], + "x-ms-enum": { + "name": "PFAgFunc", + "modelAsString": true, + "values": [ + { + "name": "count", + "value": "count", + "description": "Criteria applies for count value." + }, + { + "name": "percentage", + "value": "percentage", + "description": "Criteria applies for given percentage value." + }, + { + "name": "avg", + "value": "avg", + "description": "Criteria applies for avg value." + }, + { + "name": "p50", + "value": "p50", + "description": "Criteria applies for 50th percentile value." + }, + { + "name": "p75", + "value": "p75", + "description": "Criteria applies for 75th percentile value." + }, + { + "name": "p90", + "value": "p90", + "description": "Criteria applies for 90th percentile value." + }, + { + "name": "p95", + "value": "p95", + "description": "Criteria applies for 95th percentile value." + }, + { + "name": "p96", + "value": "p96", + "description": "Criteria applies for 96th percentile value." + }, + { + "name": "p97", + "value": "p97", + "description": "Criteria applies for 97th percentile value." + }, + { + "name": "p98", + "value": "p98", + "description": "Criteria applies for 98th percentile value." + }, + { + "name": "p99", + "value": "p99", + "description": "Criteria applies for 99th percentile value." + }, + { + "name": "p99.9", + "value": "p99.9", + "description": "Criteria applies for 99.9th percentile value." + }, + { + "name": "p99.99", + "value": "p99.99", + "description": "Criteria applies for 99.99th percentile value." + }, + { + "name": "min", + "value": "min", + "description": "Criteria applies for minimum value." + }, + { + "name": "max", + "value": "max", + "description": "Criteria applies for maximum value." + } + ] + } + }, + "PFMetrics": { + "type": "string", + "description": "Metrics for pass/fail criteria.", + "enum": [ + "response_time_ms", + "latency", + "error", + "requests", + "requests_per_sec" + ], + "x-ms-enum": { + "name": "PFMetrics", + "modelAsString": true, + "values": [ + { + "name": "response_time_ms", + "value": "response_time_ms", + "description": "Pass fail criteria for response time metric in milliseconds." + }, + { + "name": "latency", + "value": "latency", + "description": "Pass fail criteria for latency metric in milliseconds." + }, + { + "name": "error", + "value": "error", + "description": "Pass fail criteria for error metric." + }, + { + "name": "requests", + "value": "requests", + "description": "Pass fail criteria for total requests." + }, + { + "name": "requests_per_sec", + "value": "requests_per_sec", + "description": "Pass fail criteria for request per second." + } + ] + } + }, + "PFResult": { + "type": "string", + "description": "Pass/fail criteria result.", + "enum": [ + "passed", + "undetermined", + "failed" + ], + "x-ms-enum": { + "name": "PFResult", + "modelAsString": true, + "values": [ + { + "name": "passed", + "value": "passed", + "description": "Given pass fail criteria metric has passed." + }, + { + "name": "undetermined", + "value": "undetermined", + "description": "Given pass fail criteria metric couldn't determine." + }, + { + "name": "failed", + "value": "failed", + "description": "Given pass fail criteria metric has failed." + } + ] + } + }, + "PFTestResult": { + "type": "string", + "description": "Test result based on pass/fail criteria.", + "enum": [ + "PASSED", + "NOT_APPLICABLE", + "FAILED" + ], + "x-ms-enum": { + "name": "PFTestResult", + "modelAsString": true, + "values": [ + { + "name": "PASSED", + "value": "PASSED", + "description": "Pass/fail criteria has passed." + }, + { + "name": "NOT_APPLICABLE", + "value": "NOT_APPLICABLE", + "description": "Pass/fail criteria is not applicable." + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Pass/fail criteria has failed." + } + ] + } + }, + "PagedTest": { + "type": "object", + "description": "Paged collection of Test items", + "properties": { + "value": { + "type": "array", + "description": "The Test items on this page", + "items": { + "$ref": "#/definitions/Test" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTestFileInfo": { + "type": "object", + "description": "Paged collection of TestFileInfo items", + "properties": { + "value": { + "type": "array", + "description": "The TestFileInfo items on this page", + "items": { + "$ref": "#/definitions/TestFileInfo" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTestProfile": { + "type": "object", + "description": "Paged collection of TestProfile items", + "properties": { + "value": { + "type": "array", + "description": "The TestProfile items on this page", + "items": { + "$ref": "#/definitions/TestProfile" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTestProfileRun": { + "type": "object", + "description": "Paged collection of TestProfileRun items", + "properties": { + "value": { + "type": "array", + "description": "The TestProfileRun items on this page", + "items": { + "$ref": "#/definitions/TestProfileRun" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTestRun": { + "type": "object", + "description": "Paged collection of TestRun items", + "properties": { + "value": { + "type": "array", + "description": "The TestRun items on this page", + "items": { + "$ref": "#/definitions/TestRun" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PassFailCriteria": { + "type": "object", + "description": "Pass fail criteria for a test.", + "properties": { + "passFailMetrics": { + "type": "object", + "description": "Map of id and pass fail metrics { id : pass fail metrics }.", + "additionalProperties": { + "$ref": "#/definitions/PassFailMetric" + } + } + } + }, + "PassFailMetric": { + "type": "object", + "description": "Pass fail metric", + "properties": { + "clientMetric": { + "$ref": "#/definitions/PFMetrics", + "description": "The client metric on which the criteria should be applied." + }, + "aggregate": { + "$ref": "#/definitions/PFAgFunc", + "description": "The aggregation function to be applied on the client metric. Allowed functions\n- ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’,\n‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,\n‘count’ - for requests" + }, + "condition": { + "type": "string", + "description": "The comparison operator. Supported types ‘>’, ‘<’ " + }, + "requestName": { + "type": "string", + "description": "Request name for which the Pass fail criteria has to be applied " + }, + "value": { + "type": "number", + "format": "double", + "description": "The value to compare with the client metric. Allowed values - ‘error : [0.0 ,\n100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms." + }, + "action": { + "type": "string", + "description": "Action taken after the threshold is met. Default is ‘continue’.", + "default": "continue", + "enum": [ + "continue", + "stop" + ], + "x-ms-enum": { + "name": "PFAction", + "modelAsString": true, + "values": [ + { + "name": "continue", + "value": "continue", + "description": "Test will continue to run even if pass fail metric criteria metric gets failed." + }, + { + "name": "stop", + "value": "stop", + "description": "Test run will stop if pass fail criteria metric is not passed." + } + ] + } + }, + "actualValue": { + "type": "number", + "format": "double", + "description": "The actual value of the client metric for the test run.", + "readOnly": true + }, + "result": { + "$ref": "#/definitions/PFResult", + "description": "Outcome of the test run.", + "readOnly": true + } + } + }, + "RecommendationCategory": { + "type": "string", + "description": "Category of Recommendation.", + "enum": [ + "ThroughputOptimized", + "CostOptimized" + ], + "x-ms-enum": { + "name": "RecommendationCategory", + "modelAsString": true, + "values": [ + { + "name": "ThroughputOptimized", + "value": "ThroughputOptimized", + "description": "The recommendation for this category optimizes the throughput/RPS (Requests per Second) of the app." + }, + { + "name": "CostOptimized", + "value": "CostOptimized", + "description": "The recommendation for this category optimizes the cost of the app." + } + ] + } + }, + "RegionalConfiguration": { + "type": "object", + "description": "Region distribution configuration for the load test.", + "properties": { + "engineInstances": { + "type": "integer", + "format": "int32", + "description": " The number of engine instances to execute load test in specified region. Supported values are in range of 1-400." + }, + "region": { + "type": "string", + "description": "Azure region name.\nThe region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as \"eastus\".\nThe region name must match one of the strings in the \"Name\" column returned from running the \"az account list-locations -o table\" Azure CLI command." + } + }, + "required": [ + "engineInstances", + "region" + ] + }, + "RequestDataLevel": { + "type": "string", + "description": "Request data collection level for test run", + "enum": [ + "NONE", + "ERRORS" + ], + "x-ms-enum": { + "name": "RequestDataLevel", + "modelAsString": true, + "values": [ + { + "name": "NONE", + "value": "NONE", + "description": "No request data will be collected" + }, + { + "name": "ERRORS", + "value": "ERRORS", + "description": "Request data will be collected in case of failed requests" + } + ] + } + }, + "ResourceKind": { + "type": "string", + "description": "Kind of the resource on which test profile is created.", + "enum": [ + "FunctionsFlexConsumption" + ], + "x-ms-enum": { + "name": "ResourceKind", + "modelAsString": true, + "values": [ + { + "name": "FunctionsFlexConsumption", + "value": "FunctionsFlexConsumption", + "description": "Resource is a Azure FunctionApp on Flex Consumption Plan." + } + ] + } + }, + "ResourceMetric": { + "type": "object", + "description": "Associated metric definition for particular metrics of the azure resource (\nRefer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).", + "properties": { + "id": { + "type": "string", + "description": "Unique name for metric.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Azure resource id." + }, + "metricNamespace": { + "type": "string", + "description": "Metric name space." + }, + "displayDescription": { + "type": "string", + "description": "Metric description." + }, + "name": { + "type": "string", + "description": "The invariant value of metric name" + }, + "aggregation": { + "type": "string", + "description": "Metric aggregation." + }, + "unit": { + "type": "string", + "description": "Metric unit." + }, + "resourceType": { + "type": "string", + "description": "Azure resource type." + } + }, + "required": [ + "resourceId", + "metricNamespace", + "name", + "aggregation", + "resourceType" + ] + }, + "ResourceMetricUpdate": { + "type": "object", + "description": "Associated metric definition for particular metrics of the azure resource (\nRefer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).", + "properties": { + "resourceId": { + "type": "string", + "description": "Azure resource id." + }, + "metricNamespace": { + "type": "string", + "description": "Metric name space." + }, + "displayDescription": { + "type": "string", + "description": "Metric description." + }, + "name": { + "type": "string", + "description": "The invariant value of metric name" + }, + "aggregation": { + "type": "string", + "description": "Metric aggregation." + }, + "unit": { + "type": "string", + "description": "Metric unit." + }, + "resourceType": { + "type": "string", + "description": "Azure resource type." + } + } + }, + "Secret": { + "type": "object", + "description": "Secret", + "properties": { + "value": { + "type": "string", + "description": "The value of the secret for the respective type" + }, + "type": { + "$ref": "#/definitions/SecretType", + "description": "Type of secret" + } + } + }, + "SecretType": { + "type": "string", + "description": "Types of secrets supported.", + "enum": [ + "AKV_SECRET_URI", + "SECRET_VALUE" + ], + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true, + "values": [ + { + "name": "AKV_SECRET_URI", + "value": "AKV_SECRET_URI", + "description": "If the secret is stored in an Azure Key Vault." + }, + { + "name": "SECRET_VALUE", + "value": "SECRET_VALUE", + "description": "If the secret value provided as plain text." + } + ] + } + }, + "Status": { + "type": "string", + "description": "Test run status.", + "enum": [ + "ACCEPTED", + "NOTSTARTED", + "PROVISIONING", + "PROVISIONED", + "CONFIGURING", + "CONFIGURED", + "EXECUTING", + "EXECUTED", + "DEPROVISIONING", + "DEPROVISIONED", + "DONE", + "CANCELLING", + "CANCELLED", + "FAILED", + "VALIDATION_SUCCESS", + "VALIDATION_FAILURE" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "ACCEPTED", + "value": "ACCEPTED", + "description": "Test run request is accepted." + }, + { + "name": "NOTSTARTED", + "value": "NOTSTARTED", + "description": "Test run is not yet started." + }, + { + "name": "PROVISIONING", + "value": "PROVISIONING", + "description": "Test run is provisioning." + }, + { + "name": "PROVISIONED", + "value": "PROVISIONED", + "description": "Test run is provisioned." + }, + { + "name": "CONFIGURING", + "value": "CONFIGURING", + "description": "Test run is getting configured." + }, + { + "name": "CONFIGURED", + "value": "CONFIGURED", + "description": "Test run configuration is done." + }, + { + "name": "EXECUTING", + "value": "EXECUTING", + "description": "Test run has started executing." + }, + { + "name": "EXECUTED", + "value": "EXECUTED", + "description": "Test run execution is completed." + }, + { + "name": "DEPROVISIONING", + "value": "DEPROVISIONING", + "description": "Test run is getting deprovisioned." + }, + { + "name": "DEPROVISIONED", + "value": "DEPROVISIONED", + "description": "Test run is deprovisioned." + }, + { + "name": "DONE", + "value": "DONE", + "description": "Test run is completed." + }, + { + "name": "CANCELLING", + "value": "CANCELLING", + "description": "Test run is being cancelled." + }, + { + "name": "CANCELLED", + "value": "CANCELLED", + "description": "Test run request is cancelled." + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Test run request is failed." + }, + { + "name": "VALIDATION_SUCCESS", + "value": "VALIDATION_SUCCESS", + "description": "Test run JMX file is validated." + }, + { + "name": "VALIDATION_FAILURE", + "value": "VALIDATION_FAILURE", + "description": "Test run JMX file validation is failed." + } + ] + } + }, + "TargetResourceConfigurations": { + "type": "object", + "description": "Configurations of a target resource. This varies with the kind of resource.", + "properties": { + "kind": { + "$ref": "#/definitions/ResourceKind", + "description": "Kind of the resource for which the configurations apply.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "TargetResourceConfigurationsCreateOrUpdate": { + "type": "object", + "description": "Configurations of a target resource. This varies with the kind of resource.", + "properties": { + "kind": { + "$ref": "#/definitions/ResourceKind", + "description": "Kind of the resource for which the configurations apply.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "Test": { + "type": "object", + "description": "Load test model.", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "autoStopCriteria": { + "$ref": "#/definitions/AutoStopCriteria", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata." + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of pairs.", + "additionalProperties": { + "type": "string" + } + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "baselineTestRunId": { + "type": "string", + "description": "Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs" + }, + "inputArtifacts": { + "$ref": "#/definitions/TestInputArtifacts", + "description": "The input artifacts for the test.", + "readOnly": true + }, + "testId": { + "type": "string", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The test description.", + "maxLength": 100 + }, + "displayName": { + "type": "string", + "description": "Display name of a test.", + "minLength": 2, + "maxLength": 50 + }, + "subnetId": { + "type": "string", + "description": "Subnet ID on which the load test instances should run." + }, + "kind": { + "$ref": "#/definitions/TestKind", + "description": "Kind of test." + }, + "publicIPDisabled": { + "type": "boolean", + "description": "Inject load test engines without deploying public IP for outbound access" + }, + "keyvaultReferenceIdentityType": { + "type": "string", + "description": "Type of the managed identity referencing the Key vault." + }, + "keyvaultReferenceIdentityId": { + "type": "string", + "description": "Resource Id of the managed identity referencing the Key vault." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "testId" + ] + }, + "TestAppComponents": { + "type": "object", + "description": "Test app components", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponent" + } + }, + "testId": { + "type": "string", + "description": "Test identifier", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "components" + ] + }, + "TestAppComponentsUpdate": { + "type": "object", + "description": "Test app components", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponentUpdate" + } + } + } + }, + "TestCreateOrUpdate": { + "type": "object", + "description": "Load test model.", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "autoStopCriteria": { + "$ref": "#/definitions/AutoStopCriteria", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata." + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of pairs.", + "additionalProperties": { + "type": "string" + } + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "baselineTestRunId": { + "type": "string", + "description": "Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs" + }, + "description": { + "type": "string", + "description": "The test description.", + "maxLength": 100 + }, + "displayName": { + "type": "string", + "description": "Display name of a test.", + "minLength": 2, + "maxLength": 50 + }, + "subnetId": { + "type": "string", + "description": "Subnet ID on which the load test instances should run." + }, + "kind": { + "$ref": "#/definitions/TestKind", + "description": "Kind of test." + }, + "publicIPDisabled": { + "type": "boolean", + "description": "Inject load test engines without deploying public IP for outbound access" + }, + "keyvaultReferenceIdentityType": { + "type": "string", + "description": "Type of the managed identity referencing the Key vault." + }, + "keyvaultReferenceIdentityId": { + "type": "string", + "description": "Resource Id of the managed identity referencing the Key vault." + } + } + }, + "TestFileInfo": { + "type": "object", + "description": "Test file info.", + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file." + }, + "url": { + "type": "string", + "format": "uri", + "description": "File URL.", + "readOnly": true + }, + "fileType": { + "$ref": "#/definitions/FileType", + "description": "File type", + "readOnly": true + }, + "expireDateTime": { + "type": "string", + "format": "date-time", + "description": "Expiry time of the file (RFC 3339 literal format)", + "readOnly": true + }, + "validationStatus": { + "$ref": "#/definitions/FileStatus", + "description": "Validation status of the file", + "readOnly": true + }, + "validationFailureDetails": { + "type": "string", + "description": "Validation failure error details", + "readOnly": true + } + }, + "required": [ + "fileName" + ] + }, + "TestInputArtifacts": { + "type": "object", + "description": "The input artifacts for the test.", + "properties": { + "configFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "File info" + }, + "testScriptFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "File info" + }, + "userPropFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "File info" + }, + "inputArtifactsZipFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "File info" + }, + "urlTestConfigFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "The config json file for url based test" + }, + "additionalFileInfo": { + "type": "array", + "description": "Additional supported files for the test run", + "items": { + "$ref": "#/definitions/TestFileInfo" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "TestKind": { + "type": "string", + "description": "Test kind", + "enum": [ + "URL", + "JMX", + "Locust" + ], + "x-ms-enum": { + "name": "TestKind", + "modelAsString": true, + "values": [ + { + "name": "URL", + "value": "URL", + "description": "URL Test" + }, + { + "name": "JMX", + "value": "JMX", + "description": "JMX Test" + }, + { + "name": "Locust", + "value": "Locust", + "description": "Locust Test" + } + ] + } + }, + "TestProfile": { + "type": "object", + "title": "Test Profile Model.", + "description": "The Test Profile Model. A Test Profile resource enables you to set up a test profile which contains various configurations for a supported resource type and a load test to execute on that resource.", + "properties": { + "testProfileId": { + "type": "string", + "description": "Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name of the test profile.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "Description for the test profile.", + "maxLength": 100 + }, + "testId": { + "type": "string", + "description": "Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceId": { + "type": "string", + "description": "Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceConfigurations": { + "$ref": "#/definitions/TargetResourceConfigurations", + "description": "Configurations of the target resource on which testing would be done." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "testProfileId" + ] + }, + "TestProfileCreateOrUpdate": { + "type": "object", + "title": "Test Profile Model.", + "description": "The Test Profile Model. A Test Profile resource enables you to set up a test profile which contains various configurations for a supported resource type and a load test to execute on that resource.", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the test profile.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "Description for the test profile.", + "maxLength": 100 + }, + "testId": { + "type": "string", + "description": "Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceId": { + "type": "string", + "description": "Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceConfigurations": { + "$ref": "#/definitions/TargetResourceConfigurationsCreateOrUpdate", + "description": "Configurations of the target resource on which testing would be done." + } + } + }, + "TestProfileRun": { + "type": "object", + "title": "Test Profile Run model.", + "description": "The Test Profile Run Model. Test Profile Run resource enables you to instantiate an already created test profile and run load tests to get recommendations on the optimal configuration for the target resource.", + "properties": { + "testProfileRunId": { + "type": "string", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name for the test profile run.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The test profile run description", + "maxLength": 100 + }, + "testProfileId": { + "type": "string", + "description": "Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceId": { + "type": "string", + "description": "Target resource ID on which the test profile run is created", + "readOnly": true + }, + "targetResourceConfigurations": { + "$ref": "#/definitions/TargetResourceConfigurations", + "description": "Configurations of the target resource on which the test profile ran.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/TestProfileRunStatus", + "description": "The test profile run status.", + "readOnly": true + }, + "errorDetails": { + "type": "array", + "description": "Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run.", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The test profile run start DateTime(RFC 3339 literal format).", + "readOnly": true + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The test profile run end DateTime(RFC 3339 literal format).", + "readOnly": true + }, + "durationInSeconds": { + "type": "integer", + "format": "int64", + "description": "Test profile run duration in seconds.", + "readOnly": true + }, + "testRunDetails": { + "type": "object", + "description": "Details of the test runs ran as part of the test profile run.\nKey is the testRunId of the corresponding testRun.", + "additionalProperties": { + "$ref": "#/definitions/TestRunDetail" + }, + "readOnly": true + }, + "recommendations": { + "type": "array", + "description": "Recommendations provided based on a successful test profile run.", + "items": { + "$ref": "#/definitions/TestProfileRunRecommendation" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "testProfileRunId" + ] + }, + "TestProfileRunCreateOrUpdate": { + "type": "object", + "title": "Test Profile Run model.", + "description": "The Test Profile Run Model. Test Profile Run resource enables you to instantiate an already created test profile and run load tests to get recommendations on the optimal configuration for the target resource.", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for the test profile run.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The test profile run description", + "maxLength": 100 + }, + "testProfileId": { + "type": "string", + "description": "Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "TestProfileRunRecommendation": { + "type": "object", + "description": "A recommendation object that provides a list of configuration that optimizes its category.", + "properties": { + "category": { + "$ref": "#/definitions/RecommendationCategory", + "description": "Category of the recommendation." + }, + "configurations": { + "type": "array", + "description": "List of configurations IDs for which the recommendation is applicable. These are a subset of the provided target resource configurations.", + "items": { + "type": "string" + } + } + }, + "required": [ + "category" + ] + }, + "TestProfileRunStatus": { + "type": "string", + "description": "Test profile run status.", + "enum": [ + "ACCEPTED", + "NOTSTARTED", + "EXECUTING", + "DONE", + "CANCELLING", + "CANCELLED", + "FAILED" + ], + "x-ms-enum": { + "name": "TestProfileRunStatus", + "modelAsString": true, + "values": [ + { + "name": "ACCEPTED", + "value": "ACCEPTED", + "description": "Test profile run request is accepted." + }, + { + "name": "NOTSTARTED", + "value": "NOTSTARTED", + "description": "Test profile run is not yet started." + }, + { + "name": "EXECUTING", + "value": "EXECUTING", + "description": "Test profile run has started executing." + }, + { + "name": "DONE", + "value": "DONE", + "description": "Test profile run has completed successfully." + }, + { + "name": "CANCELLING", + "value": "CANCELLING", + "description": "Test profile run is being cancelled." + }, + { + "name": "CANCELLED", + "value": "CANCELLED", + "description": "Test profile run is cancelled." + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Test profile run has failed." + } + ] + } + }, + "TestRun": { + "type": "object", + "description": "Load test run model", + "properties": { + "testRunId": { + "type": "string", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "autoStopCriteria": { + "$ref": "#/definitions/AutoStopCriteria", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata" + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of pairs.", + "additionalProperties": { + "type": "string" + } + }, + "errorDetails": { + "type": "array", + "description": "Error details if there is any failure in load test run", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "testRunStatistics": { + "type": "object", + "description": "Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run.\nThe sampler name is the same as the name mentioned in the test script.\nSampler name \"Total\" represents the aggregated statistics of all the samplers.", + "additionalProperties": { + "$ref": "#/definitions/TestRunStatistics" + }, + "readOnly": true + }, + "regionalStatistics": { + "type": "object", + "description": "Regional statistics. Key is the Azure region name and value is the test run statistics.\nThe region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as \"eastus\".\nThe region name must match one of the strings in the \"Name\" column returned from running the \"az account list-locations -o table\" Azure CLI command.", + "additionalProperties": { + "$ref": "#/definitions/TestRunStatistics" + }, + "readOnly": true + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "testArtifacts": { + "$ref": "#/definitions/TestRunArtifacts", + "description": "Collection of test run artifacts", + "readOnly": true + }, + "testResult": { + "$ref": "#/definitions/PFTestResult", + "description": "Test result for pass/Fail criteria used during the test run.", + "readOnly": true + }, + "virtualUsers": { + "type": "integer", + "format": "int32", + "description": "Number of virtual users, for which test has been run.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name of a testRun.", + "minLength": 2, + "maxLength": 50 + }, + "testId": { + "type": "string", + "description": "Associated test Id.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The test run description.", + "maxLength": 100 + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The test run status.", + "readOnly": true + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The test run start DateTime(RFC 3339 literal format).", + "readOnly": true + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The test run end DateTime(RFC 3339 literal format).", + "readOnly": true + }, + "executedDateTime": { + "type": "string", + "format": "date-time", + "description": "Test run initiated time.", + "readOnly": true + }, + "portalUrl": { + "type": "string", + "description": "Portal url.", + "readOnly": true + }, + "duration": { + "type": "integer", + "format": "int64", + "description": "Test run duration in milliseconds.", + "readOnly": true + }, + "subnetId": { + "type": "string", + "description": "Subnet ID on which the load test instances should run.", + "readOnly": true + }, + "kind": { + "$ref": "#/definitions/TestKind", + "description": "Type of test.", + "readOnly": true + }, + "requestDataLevel": { + "$ref": "#/definitions/RequestDataLevel", + "description": "Request data collection level for test run" + }, + "debugLogsEnabled": { + "type": "boolean", + "description": "Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise" + }, + "publicIPDisabled": { + "type": "boolean", + "description": "Inject load test engines without deploying public IP for outbound access", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "testRunId" + ] + }, + "TestRunAppComponents": { + "type": "object", + "description": "Test run app component", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponent" + } + }, + "testRunId": { + "type": "string", + "description": "Test run identifier", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "components" + ] + }, + "TestRunAppComponentsUpdate": { + "type": "object", + "description": "Test run app component", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponentUpdate" + } + } + } + }, + "TestRunArtifacts": { + "type": "object", + "description": "Collection of test run artifacts", + "properties": { + "inputArtifacts": { + "$ref": "#/definitions/TestRunInputArtifacts", + "description": "The input artifacts for the test run.", + "readOnly": true + }, + "outputArtifacts": { + "$ref": "#/definitions/TestRunOutputArtifacts", + "description": "The output artifacts for the test run." + } + } + }, + "TestRunCreateOrUpdate": { + "type": "object", + "description": "Load test run model", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "autoStopCriteria": { + "$ref": "#/definitions/AutoStopCriteria", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata" + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of pairs.", + "additionalProperties": { + "type": "string" + } + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "displayName": { + "type": "string", + "description": "Display name of a testRun.", + "minLength": 2, + "maxLength": 50 + }, + "testId": { + "type": "string", + "description": "Associated test Id.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The test run description.", + "maxLength": 100 + }, + "requestDataLevel": { + "$ref": "#/definitions/RequestDataLevel", + "description": "Request data collection level for test run" + }, + "debugLogsEnabled": { + "type": "boolean", + "description": "Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise" + } + } + }, + "TestRunDetail": { + "type": "object", + "description": "Details of a particular test run for a test profile run.", + "properties": { + "status": { + "$ref": "#/definitions/Status", + "description": "Status of the test run." + }, + "configurationId": { + "type": "string", + "description": "ID of the configuration on which the test ran." + }, + "properties": { + "type": "object", + "description": "Key value pair of extra properties associated with the test run.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "status", + "configurationId", + "properties" + ] + }, + "TestRunFileInfo": { + "type": "object", + "description": "Test run file info.", + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file." + }, + "url": { + "type": "string", + "format": "uri", + "description": "File URL.", + "readOnly": true + }, + "fileType": { + "$ref": "#/definitions/FileType", + "description": "File type", + "readOnly": true + }, + "expireDateTime": { + "type": "string", + "format": "date-time", + "description": "Expiry time of the file (RFC 3339 literal format)", + "readOnly": true + }, + "validationStatus": { + "$ref": "#/definitions/FileStatus", + "description": "Validation status of the file", + "readOnly": true + }, + "validationFailureDetails": { + "type": "string", + "description": "Validation failure error details", + "readOnly": true + } + }, + "required": [ + "fileName" + ] + }, + "TestRunInputArtifacts": { + "type": "object", + "description": "The input artifacts for the test run.", + "properties": { + "configFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "testScriptFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "userPropFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "inputArtifactsZipFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "urlTestConfigFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "The config json file for url based test" + }, + "additionalFileInfo": { + "type": "array", + "description": "Additional supported files for the test run", + "items": { + "$ref": "#/definitions/TestRunFileInfo" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "TestRunOutputArtifacts": { + "type": "object", + "description": "The output artifacts for the test run.", + "properties": { + "resultFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "logsFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "artifactsContainerInfo": { + "$ref": "#/definitions/ArtifactsContainerInfo", + "description": "The container for test run artifacts." + }, + "reportFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "The report file for the test run." + } + } + }, + "TestRunServerMetricConfig": { + "type": "object", + "description": "Test run server metrics configuration", + "properties": { + "testRunId": { + "type": "string", + "description": "Test run identifier", + "readOnly": true + }, + "metrics": { + "type": "object", + "description": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).", + "additionalProperties": { + "$ref": "#/definitions/ResourceMetric" + } + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + } + }, + "TestRunStatistics": { + "type": "object", + "description": "Test run statistics.", + "properties": { + "transaction": { + "type": "string", + "description": "Transaction name.", + "readOnly": true + }, + "sampleCount": { + "type": "number", + "format": "double", + "description": "Sampler count.", + "readOnly": true + }, + "errorCount": { + "type": "number", + "format": "double", + "description": "Error count.", + "readOnly": true + }, + "errorPct": { + "type": "number", + "format": "double", + "description": "Error percentage.", + "readOnly": true + }, + "meanResTime": { + "type": "number", + "format": "double", + "description": "Mean response time.", + "readOnly": true + }, + "medianResTime": { + "type": "number", + "format": "double", + "description": "Median response time.", + "readOnly": true + }, + "maxResTime": { + "type": "number", + "format": "double", + "description": "Max response time.", + "readOnly": true + }, + "minResTime": { + "type": "number", + "format": "double", + "description": "Minimum response time.", + "readOnly": true + }, + "pct1ResTime": { + "type": "number", + "format": "double", + "description": "90 percentile response time.", + "readOnly": true + }, + "pct2ResTime": { + "type": "number", + "format": "double", + "description": "95 percentile response time.", + "readOnly": true + }, + "pct3ResTime": { + "type": "number", + "format": "double", + "description": "99 percentile response time.", + "readOnly": true + }, + "pct75ResTime": { + "type": "number", + "format": "double", + "description": "75 percentile response time.", + "readOnly": true + }, + "pct96ResTime": { + "type": "number", + "format": "double", + "description": "96 percentile response time.", + "readOnly": true + }, + "pct97ResTime": { + "type": "number", + "format": "double", + "description": "97 percentile response time.", + "readOnly": true + }, + "pct98ResTime": { + "type": "number", + "format": "double", + "description": "98 percentile response time.", + "readOnly": true + }, + "pct999ResTime": { + "type": "number", + "format": "double", + "description": "99.9 percentile response time.", + "readOnly": true + }, + "pct9999ResTime": { + "type": "number", + "format": "double", + "description": "99.99 percentile response time.", + "readOnly": true + }, + "throughput": { + "type": "number", + "format": "double", + "description": "Throughput.", + "readOnly": true + }, + "receivedKBytesPerSec": { + "type": "number", + "format": "double", + "description": "Received network bytes.", + "readOnly": true + }, + "sentKBytesPerSec": { + "type": "number", + "format": "double", + "description": "Send network bytes.", + "readOnly": true + } + } + }, + "TestServerMetricConfig": { + "type": "object", + "description": "Test server metrics configuration", + "properties": { + "testId": { + "type": "string", + "description": "Test identifier", + "readOnly": true + }, + "metrics": { + "type": "object", + "description": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).", + "additionalProperties": { + "$ref": "#/definitions/ResourceMetric" + } + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "metrics" + ] + }, + "TestServerMetricConfigUpdate": { + "type": "object", + "description": "Test server metrics configuration", + "properties": { + "metrics": { + "type": "object", + "description": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).", + "additionalProperties": { + "$ref": "#/definitions/ResourceMetricUpdate" + } + } + } + }, + "TimeGrain": { + "type": "string", + "description": "Time Grain", + "enum": [ + "PT5S", + "PT10S", + "PT1M", + "PT5M", + "PT1H" + ], + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true, + "values": [ + { + "name": "PT5S", + "value": "PT5S", + "description": "5 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT10S", + "value": "PT10S", + "description": "10 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT1M", + "value": "PT1M", + "description": "1 minute" + }, + { + "name": "PT5M", + "value": "PT5M", + "description": "5 minutes, available only if test run duration is greater than 1 minute." + }, + { + "name": "PT1H", + "value": "PT1H", + "description": "1 hour, available only if test run duration is greater than 1 minute." + } + ] + } + }, + "TimeSeriesElement": { + "type": "object", + "description": "The time series returned when a data query is performed.", + "properties": { + "data": { + "type": "array", + "description": "An array of data points representing the metric values.", + "items": { + "$ref": "#/definitions/MetricValue" + }, + "x-ms-identifiers": [] + }, + "dimensionValues": { + "type": "array", + "description": "The dimension values ", + "items": { + "$ref": "#/definitions/DimensionValue" + }, + "x-ms-identifiers": [] + } + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "ListTestProfileQueryParams.lastModifiedEndTime": { + "name": "lastModifiedEndTime", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileQueryParams.lastModifiedStartTime": { + "name": "lastModifiedStartTime", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Maximum number of results to include in a single response.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "ListTestProfileQueryParams.testIds": { + "name": "testIds", + "in": "query", + "description": "Comma separated list IDs of the tests which should be associated with the test profiles to fetch.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestProfileQueryParams.testProfileIds": { + "name": "testProfileIds", + "in": "query", + "description": "Comma separated list of IDs of the test profiles to filter.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.createdDateEndTime": { + "name": "createdDateEndTime", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of the created time range to filter test profile runs.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.createdDateStartTime": { + "name": "createdDateStartTime", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of the created time range to filter test profile runs.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.maxEndDateTime": { + "name": "maxEndDateTime", + "in": "query", + "description": "Maximum End DateTime(RFC 3339 literal format) of the test profile runs to filter on.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.maxStartDateTime": { + "name": "maxStartDateTime", + "in": "query", + "description": "Maximum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Maximum number of results to include in a single response.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.minEndDateTime": { + "name": "minEndDateTime", + "in": "query", + "description": "Minimum End DateTime(RFC 3339 literal format) of the test profile runs to filter on.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.minStartDateTime": { + "name": "minStartDateTime", + "in": "query", + "description": "Minimum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.statuses": { + "name": "statuses", + "in": "query", + "description": "Comma separated list of Statuses of the test profile runs to filter.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.testProfileIds": { + "name": "testProfileIds", + "in": "query", + "description": "Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.testProfileRunIds": { + "name": "testProfileRunIds", + "in": "query", + "description": "Comma separated list of IDs of the test profile runs to filter.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.lastModifiedEndTime": { + "name": "lastModifiedEndTime", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of the last updated time range to filter tests.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.lastModifiedStartTime": { + "name": "lastModifiedStartTime", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of the last updated time range to filter tests.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Number of results in response.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.orderby": { + "name": "orderby", + "in": "query", + "description": "Sort on the supported fields in (field asc/desc) format. eg:\nlastModifiedDateTime asc. Supported fields - lastModifiedDateTime", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.search": { + "name": "search", + "in": "query", + "description": "Prefix based, case sensitive search on searchable fields - displayName,\ncreatedBy. For example, to search for a test, with display name is Login Test,\nthe search parameter can be Login.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.executionFrom": { + "name": "executionFrom", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of test-run execution time filter range.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.executionTo": { + "name": "executionTo", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of test-run execution time filter range.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Number of results in response.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.orderby": { + "name": "orderby", + "in": "query", + "description": "Sort on the supported fields in (field asc/desc) format. eg: executedDateTime\nasc. Supported fields - executedDateTime", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.search": { + "name": "search", + "in": "query", + "description": "Prefix based, case sensitive search on searchable fields - description,\nexecutedUser. For example, to search for a test run, with description 500 VUs,\nthe search parameter can be 500.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.status": { + "name": "status", + "in": "query", + "description": "Comma separated list of test run status.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.testId": { + "name": "testId", + "in": "query", + "description": "Unique name of an existing load test.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MetricDimensionsRequest.interval": { + "name": "interval", + "in": "query", + "description": "The interval (i.e. timegrain) of the query.", + "required": false, + "type": "string", + "default": "PT1M", + "enum": [ + "PT5S", + "PT10S", + "PT1M", + "PT5M", + "PT1H" + ], + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true, + "values": [ + { + "name": "PT5S", + "value": "PT5S", + "description": "5 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT10S", + "value": "PT10S", + "description": "10 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT1M", + "value": "PT1M", + "description": "1 minute" + }, + { + "name": "PT5M", + "value": "PT5M", + "description": "5 minutes, available only if test run duration is greater than 1 minute." + }, + { + "name": "PT1H", + "value": "PT1H", + "description": "1 hour, available only if test run duration is greater than 1 minute." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "MetricDimensionsRequest.metricNamespace": { + "name": "metricNamespace", + "in": "query", + "description": "Metric namespace to query metric definitions for.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MetricDimensionsRequest.metricname": { + "name": "metricname", + "in": "query", + "description": "Metric name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MetricDimensionsRequest.timespan": { + "name": "timespan", + "in": "query", + "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OldTestRunIdQueryParam": { + "name": "oldTestRunId", + "in": "query", + "description": "Existing test run identifier that should be rerun, if this is provided, the\ntest will run with the JMX file, configuration and app components from the\nexisting test run. You can override the configuration values for new test run\nin the request body.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json index 05d685fae804..6e91cb52212a 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json @@ -2487,7 +2487,7 @@ }, "aggregate": { "$ref": "#/definitions/PFAgFunc", - "description": "The aggregation function to be applied on the client metric. Allowed functions\n- ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’,\n‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,\n‘count’ - for requests" + "description": "The aggregation function to be applied on the client metric. Allowed functions\n- ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’,\n‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,\n‘count’ - for requests" }, "condition": { "type": "string", diff --git a/specification/loadtestservice/data-plane/readme.md b/specification/loadtestservice/data-plane/readme.md index 404eed05c964..544b7e65a130 100644 --- a/specification/loadtestservice/data-plane/readme.md +++ b/specification/loadtestservice/data-plane/readme.md @@ -27,6 +27,15 @@ tag: package-2022-11-01 title: LoadTestingClient ``` +### Tag: package-2024-05-01-preview + +These settings apply only when `--tag=package-2024-05-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-05-01-preview' +input-file: + - Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json +``` + ### Tag: package-2024-03-01-preview From c1621be15f5fc810775426cf7e122778dfa8f6bf Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Mon, 17 Jun 2024 09:31:18 -0700 Subject: [PATCH 183/343] Added information to the query uri parameter: 'Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline.' (#29356) --- specification/maps/data-plane/Weather/stable/1.1/weather.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/maps/data-plane/Weather/stable/1.1/weather.json b/specification/maps/data-plane/Weather/stable/1.1/weather.json index 8840792349e5..47d5ab673171 100644 --- a/specification/maps/data-plane/Weather/stable/1.1/weather.json +++ b/specification/maps/data-plane/Weather/stable/1.1/weather.json @@ -243,7 +243,7 @@ "name": "query", "in": "query", "x-ms-client-name": "coordinates", - "description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline.", "required": true, "x-ms-parameter-location": "method", "type": "array", From 62da663a094b3c7de14d1ffc51d65d8f3adcc055 Mon Sep 17 00:00:00 2001 From: Gaurav Date: Mon, 17 Jun 2024 22:44:46 +0530 Subject: [PATCH 184/343] adding typespec for stable version (#28694) * adding typespec for stable version * adding examples * adding files after npm ci * adding typespec for stable version * adding examples * adding files after npm ci * adding v5 version as per comment * Revert "adding v5 version as per comment" This reverts commit a703a142e8b643a693c26773c8ea79a6e8cfbe8e. * making subscription id optional * resloving comments * resolving typespec validation failure --------- Co-authored-by: Gaurav Bang --- .../LiftrBase/main.tsp | 2 +- ...zations_CreateOrUpdate_MaximumSet_Gen.json | 6 +- .../Organizations_Get_MaximumSet_Gen.json | 2 +- ...ns_ListByResourceGroup_MaximumSet_Gen.json | 2 +- ...ons_ListBySubscription_MaximumSet_Gen.json | 2 +- .../Organizations_Update_MaximumSet_Gen.json | 2 +- .../Operations_List_MaximumSet_Gen.json | 28 +++ ...zations_CreateOrUpdate_MaximumSet_Gen.json | 180 ++++++++++++++++++ .../Organizations_Delete_MaximumSet_Gen.json | 18 ++ .../Organizations_Get_MaximumSet_Gen.json | 72 +++++++ ...ns_ListByResourceGroup_MaximumSet_Gen.json | 76 ++++++++ ...ons_ListBySubscription_MaximumSet_Gen.json | 75 ++++++++ .../Organizations_Update_MaximumSet_Gen.json | 110 +++++++++++ .../Astronomer.Astro.Management/main.tsp | 6 + .../2023-08-01-preview/astronomer.json | 1 - ...zations_CreateOrUpdate_MaximumSet_Gen.json | 6 +- .../Organizations_Get_MaximumSet_Gen.json | 2 +- ...ns_ListByResourceGroup_MaximumSet_Gen.json | 2 +- ...ons_ListBySubscription_MaximumSet_Gen.json | 2 +- .../Organizations_Update_MaximumSet_Gen.json | 2 +- .../stable/2023-08-01/astronomer.json | 53 ++---- ...zations_CreateOrUpdate_MaximumSet_Gen.json | 20 +- .../Organizations_Get_MaximumSet_Gen.json | 2 +- ...ns_ListByResourceGroup_MaximumSet_Gen.json | 2 +- ...ons_ListBySubscription_MaximumSet_Gen.json | 2 +- .../Organizations_Update_MaximumSet_Gen.json | 2 +- 26 files changed, 609 insertions(+), 68 deletions(-) create mode 100644 specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Operations_List_MaximumSet_Gen.json create mode 100644 specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Delete_MaximumSet_Gen.json create mode 100644 specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Get_MaximumSet_Gen.json create mode 100644 specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Update_MaximumSet_Gen.json diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp b/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp index 7ce7ff252b5b..fe620391ece8 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp +++ b/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp @@ -37,7 +37,7 @@ scalar Uri extends string; @doc("Marketplace details for an organization") model MarketplaceDetails { @doc("Azure subscription id for the the marketplace offer is purchased from") - subscriptionId: string; + subscriptionId?: string; @doc("Marketplace subscription status") subscriptionStatus?: MarketplaceSubscriptionStatus; diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json index 44601e85204c..9746d08fba78 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -9,7 +9,7 @@ "resource": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", @@ -57,7 +57,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", @@ -120,7 +120,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Get_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Get_MaximumSet_Gen.json index 8e1da8995b2c..4cc58a87b3c5 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Get_MaximumSet_Gen.json +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Get_MaximumSet_Gen.json @@ -12,7 +12,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json index 38106c6829ae..25dd69bacd87 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -13,7 +13,7 @@ { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json index 825a5ec960aa..017e0ea4bd51 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -12,7 +12,7 @@ { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Update_MaximumSet_Gen.json index 24ed2b970a05..c8ccca13a19c 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01-preview/Organizations_Update_MaximumSet_Gen.json @@ -45,7 +45,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Operations_List_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..ed6f62bf99ea --- /dev/null +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "zabhglnki", + "isDataAction": true, + "display": { + "provider": "hgepwsvbptqbigephgxoxyll", + "resource": "thhzqbtxxi", + "operation": "teozafbxkiagahfypii", + "description": "nkucjlsbtriwdgedbxlknbwfz" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "resl" + } + } + } +} diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..1fe89dc80cb7 --- /dev/null +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,180 @@ +{ + "title": "Organizations_CreateOrUpdate - generated by [MaximumSet] rule", + "operationId": "Organizations_CreateOrUpdate", + "parameters": { + "api-version": "2023-08-01", + "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3", + "resourceGroupName": "rgastronomer", + "organizationName": "U.1-:7", + "resource": { + "properties": { + "marketplace": { + "subscriptionId": null, + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "astronomer1591719760654", + "offerId": "astro", + "planId": "astro-paygo", + "planName": "Monthly Pay-As-You-Go", + "termUnit": "Monthly", + "termId": "gmz7xq9ge3py" + } + }, + "user": { + "firstName": "nfh", + "lastName": "lazfbstcccykibvcrxpmglqam", + "emailAddress": ".K_@e7N-g1.xjqnbPs", + "upn": "xtutvycpxjrtoftx", + "phoneNumber": "inxkscllh" + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "lskgzdmziusgrsucv", + "workspaceId": "vcrupxwpaba", + "organizationName": "3-", + "workspaceName": "9.:06", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "mklfypyujwumgwdzae", + "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "aadDomains": [ + "kfbleh" + ], + "provisioningState": "Succeeded" + } + } + }, + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "mhqthlsatwvqkl" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplace": { + "subscriptionId": null, + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "gfsqxygpnerxmvols", + "offerId": "krzkefmpxztqyusidzgpchfaswuyce", + "planId": "kndxzygsanuiqzwbfbbvoipv", + "planName": "pwqjwlq", + "termUnit": "xyygyzcazkuelz", + "termId": "pwds" + } + }, + "user": { + "firstName": "nfh", + "lastName": "lazfbstcccykibvcrxpmglqam", + "emailAddress": ".K_@e7N-g1.xjqnbPs", + "upn": "xtutvycpxjrtoftx", + "phoneNumber": "inxkscllh" + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "lskgzdmziusgrsucv", + "workspaceId": "vcrupxwpaba", + "organizationName": "3-", + "workspaceName": "9.:06", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "mklfypyujwumgwdzae", + "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "aadDomains": [ + "kfbleh" + ], + "provisioningState": "Succeeded" + } + } + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + }, + "tags": {}, + "location": "mhqthlsatwvqkl", + "id": "/subscriptions/6f490d74-8eb4-4e7d-ae07-c75776710bfa/resourceGroups/resourcegroup/providers/Astronomer.Astro/organizations/astro1234", + "name": "ycyrfvupthkudm", + "type": "ldwwclcpqssjomo", + "systemData": { + "createdBy": "zw", + "createdByType": "User", + "createdAt": "2023-07-25T11:16:12.868Z", + "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-25T11:16:12.868Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "marketplace": { + "subscriptionId": null, + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "gfsqxygpnerxmvols", + "offerId": "krzkefmpxztqyusidzgpchfaswuyce", + "planId": "kndxzygsanuiqzwbfbbvoipv", + "planName": "pwqjwlq", + "termUnit": "xyygyzcazkuelz", + "termId": "pwds" + } + }, + "user": { + "firstName": "nfh", + "lastName": "lazfbstcccykibvcrxpmglqam", + "emailAddress": ".K_@e7N-g1.xjqnbPs", + "upn": "xtutvycpxjrtoftx", + "phoneNumber": "inxkscllh" + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "lskgzdmziusgrsucv", + "workspaceId": "vcrupxwpaba", + "organizationName": "3-", + "workspaceName": "9.:06", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "mklfypyujwumgwdzae", + "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "aadDomains": [ + "kfbleh" + ], + "provisioningState": "Succeeded" + } + } + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + }, + "tags": {}, + "location": "mhqthlsatwvqkl", + "id": "bhslekyvgkfomahtvjiin", + "name": "ycyrfvupthkudm", + "type": "ldwwclcpqssjomo", + "systemData": { + "createdBy": "zw", + "createdByType": "User", + "createdAt": "2023-07-25T11:16:12.868Z", + "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-25T11:16:12.868Z" + } + } + } + } +} diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Delete_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a8c32f205090 --- /dev/null +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Organizations_Delete - generated by [MaximumSet] rule", + "operationId": "Organizations_Delete", + "parameters": { + "api-version": "2023-08-01", + "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3", + "resourceGroupName": "rgastronomer", + "organizationName": "q:" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Get_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..27db2f217a47 --- /dev/null +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Get_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "Organizations_Get - generated by [MaximumSet] rule", + "operationId": "Organizations_Get", + "parameters": { + "api-version": "2023-08-01", + "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3", + "resourceGroupName": "rgastronomer", + "organizationName": "S PS" + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplace": { + "subscriptionId": null, + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "gfsqxygpnerxmvols", + "offerId": "krzkefmpxztqyusidzgpchfaswuyce", + "planId": "kndxzygsanuiqzwbfbbvoipv", + "planName": "pwqjwlq", + "termUnit": "xyygyzcazkuelz", + "termId": "pwds" + } + }, + "user": { + "firstName": "nfh", + "lastName": "lazfbstcccykibvcrxpmglqam", + "emailAddress": ".K_@e7N-g1.xjqnbPs", + "upn": "xtutvycpxjrtoftx", + "phoneNumber": "inxkscllh" + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "lskgzdmziusgrsucv", + "workspaceId": "vcrupxwpaba", + "organizationName": "3-", + "workspaceName": "9.:06", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "mklfypyujwumgwdzae", + "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "aadDomains": [ + "kfbleh" + ], + "provisioningState": "Succeeded" + } + } + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + }, + "tags": {}, + "location": "mhqthlsatwvqkl", + "id": "bhslekyvgkfomahtvjiin", + "name": "ycyrfvupthkudm", + "type": "ldwwclcpqssjomo", + "systemData": { + "createdBy": "zw", + "createdByType": "User", + "createdAt": "2023-07-25T11:16:12.868Z", + "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-25T11:16:12.868Z" + } + } + } + } +} diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..6c7829796d4b --- /dev/null +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "Organizations_ListByResourceGroup - generated by [MaximumSet] rule", + "operationId": "Organizations_ListByResourceGroup", + "parameters": { + "api-version": "2023-08-01", + "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3", + "resourceGroupName": "rgastronomer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplace": { + "subscriptionId": null, + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "gfsqxygpnerxmvols", + "offerId": "krzkefmpxztqyusidzgpchfaswuyce", + "planId": "kndxzygsanuiqzwbfbbvoipv", + "planName": "pwqjwlq", + "termUnit": "xyygyzcazkuelz", + "termId": "pwds" + } + }, + "user": { + "firstName": "nfh", + "lastName": "lazfbstcccykibvcrxpmglqam", + "emailAddress": ".K_@e7N-g1.xjqnbPs", + "upn": "xtutvycpxjrtoftx", + "phoneNumber": "inxkscllh" + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "lskgzdmziusgrsucv", + "workspaceId": "vcrupxwpaba", + "organizationName": "3-", + "workspaceName": "9.:06", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "mklfypyujwumgwdzae", + "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "aadDomains": [ + "kfbleh" + ], + "provisioningState": "Succeeded" + } + } + }, + "identity": { + "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "mhqthlsatwvqkl", + "id": "bhslekyvgkfomahtvjiin", + "name": "ycyrfvupthkudm", + "type": "ldwwclcpqssjomo", + "systemData": { + "createdBy": "zw", + "createdByType": "User", + "createdAt": "2023-07-25T11:16:12.868Z", + "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-25T11:16:12.868Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..abc4954a7a5a --- /dev/null +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "Organizations_ListBySubscription - generated by [MaximumSet] rule", + "operationId": "Organizations_ListBySubscription", + "parameters": { + "api-version": "2023-08-01", + "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplace": { + "subscriptionId": null, + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "gfsqxygpnerxmvols", + "offerId": "krzkefmpxztqyusidzgpchfaswuyce", + "planId": "kndxzygsanuiqzwbfbbvoipv", + "planName": "pwqjwlq", + "termUnit": "xyygyzcazkuelz", + "termId": "pwds" + } + }, + "user": { + "firstName": "nfh", + "lastName": "lazfbstcccykibvcrxpmglqam", + "emailAddress": ".K_@e7N-g1.xjqnbPs", + "upn": "xtutvycpxjrtoftx", + "phoneNumber": "inxkscllh" + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "lskgzdmziusgrsucv", + "workspaceId": "vcrupxwpaba", + "organizationName": "3-", + "workspaceName": "9.:06", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "mklfypyujwumgwdzae", + "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "aadDomains": [ + "kfbleh" + ], + "provisioningState": "Succeeded" + } + } + }, + "identity": { + "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "mhqthlsatwvqkl", + "id": "bhslekyvgkfomahtvjiin", + "name": "ycyrfvupthkudm", + "type": "ldwwclcpqssjomo", + "systemData": { + "createdBy": "zw", + "createdByType": "User", + "createdAt": "2023-07-25T11:16:12.868Z", + "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-25T11:16:12.868Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..3e35f8e7a994 --- /dev/null +++ b/specification/liftrastronomer/Astronomer.Astro.Management/examples/2023-08-01/Organizations_Update_MaximumSet_Gen.json @@ -0,0 +1,110 @@ +{ + "title": "Organizations_Update", + "operationId": "Organizations_Update", + "parameters": { + "api-version": "2023-08-01", + "subscriptionId": "43454B17-172A-40FE-80FA-549EA23D12B3", + "resourceGroupName": "rgastronomer", + "organizationName": "6.", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": { + "key1474": "bqqyipxnbbxryhznyaosmtpo" + }, + "properties": { + "user": { + "firstName": "qeuofehzypzljgcuysugefbgxde", + "lastName": "g", + "emailAddress": ".K_@e7N-g1.xjqnbPs", + "upn": "uwtprzdfpsqmktx", + "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + }, + "partnerOrganizationProperties": { + "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", + "workspaceId": "xsepuskdhejaadusyxq", + "organizationName": "U2P_", + "workspaceName": "L.-y_--:", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "mklfypyujwumgwdzae", + "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "aadDomains": [ + "kfbleh" + ], + "provisioningState": "Succeeded" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplace": { + "subscriptionId": null, + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "gfsqxygpnerxmvols", + "offerId": "krzkefmpxztqyusidzgpchfaswuyce", + "planId": "kndxzygsanuiqzwbfbbvoipv", + "planName": "pwqjwlq", + "termUnit": "xyygyzcazkuelz", + "termId": "pwds" + } + }, + "user": { + "firstName": "qeuofehzypzljgcuysugefbgxde", + "lastName": "g", + "emailAddress": ".K_@e7N-g1.xjqnbPs", + "upn": "uwtprzdfpsqmktx", + "phoneNumber": "aqpyxznvqpgkzohevynofrjdfgoo" + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "lrtmbkvyvvoszhjevohkmyjhfyty", + "workspaceId": "xsepuskdhejaadusyxq", + "organizationName": "U2P_", + "workspaceName": "L.-y_--:", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "mklfypyujwumgwdzae", + "singleSignOnUrl": "ymmtzkyghvinvhgnqlzwrr", + "aadDomains": [ + "kfbleh" + ], + "provisioningState": "Succeeded" + } + } + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "b5684bd7-7958-4c0e-9795-d686c31746d2", + "tenantId": "b5684bd7-7958-4c0e-9795-d686c31746d2" + }, + "tags": {}, + "location": "mhqthlsatwvqkl", + "id": "bhslekyvgkfomahtvjiin", + "name": "ycyrfvupthkudm", + "type": "ldwwclcpqssjomo", + "systemData": { + "createdBy": "zw", + "createdByType": "User", + "createdAt": "2023-07-25T11:16:12.868Z", + "lastModifiedBy": "isirkhwcppaqoqzoebybzikzbzkjzf", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-25T11:16:12.868Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp b/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp index e02856267934..3c8e39dadbc4 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp +++ b/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp @@ -26,6 +26,12 @@ enum Versions { @useDependency(LiftrBase.Versions.v1_preview) @useDependency(LiftrBase.Data.Versions.v1_preview) v1_preview: "2023-08-01-preview", + + @doc("Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1, LiftrBase.Versions.v1_preview, LiftrBase.Data.Versions.v1_preview") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(LiftrBase.Versions.v1_preview) + @useDependency(LiftrBase.Data.Versions.v1_preview) + v1: "2023-08-01", } interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json index 3bff98bd57a9..544b4801dee7 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json @@ -569,7 +569,6 @@ } }, "required": [ - "subscriptionId", "offerDetails" ] }, diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json index 44601e85204c..9746d08fba78 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -9,7 +9,7 @@ "resource": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", @@ -57,7 +57,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", @@ -120,7 +120,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json index 8e1da8995b2c..4cc58a87b3c5 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json @@ -12,7 +12,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json index 38106c6829ae..25dd69bacd87 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -13,7 +13,7 @@ { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json index 825a5ec960aa..017e0ea4bd51 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -12,7 +12,7 @@ { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json index 24ed2b970a05..c8ccca13a19c 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json @@ -45,7 +45,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json index e27681e04aab..6aa1f9e141de 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json @@ -60,7 +60,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -99,7 +99,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OrganizationResourceListResult" } @@ -141,7 +141,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OrganizationResourceListResult" } @@ -193,7 +193,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OrganizationResource" } @@ -322,7 +322,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OrganizationResource" } @@ -330,14 +330,14 @@ "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -389,19 +389,19 @@ "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." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -569,7 +569,6 @@ } }, "required": [ - "subscriptionId", "offerDetails" ] }, @@ -777,11 +776,7 @@ "properties": { "$ref": "#/definitions/LiftrBase.Data.OrganizationProperties", "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", @@ -849,24 +844,6 @@ "description": "Organization properties" } } - }, - "Versions": { - "type": "string", - "description": "Supported API versions for the Astronomer.Astro resource provider.", - "enum": [ - "2023-08-01" - ], - "x-ms-enum": { - "name": "Versions", - "modelAsString": true, - "values": [ - { - "name": "v1_preview", - "value": "2023-08-01", - "description": "Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1, LiftrBase.Versions.v1_preview, LiftrBase.Data.Versions.v1_preview" - } - ] - } } }, "parameters": {} diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json index f4705c201759..1fe89dc80cb7 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -9,15 +9,15 @@ "resource": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { - "publisherId": "gfsqxygpnerxmvols", - "offerId": "krzkefmpxztqyusidzgpchfaswuyce", - "planId": "kndxzygsanuiqzwbfbbvoipv", - "planName": "pwqjwlq", - "termUnit": "xyygyzcazkuelz", - "termId": "pwds" + "publisherId": "astronomer1591719760654", + "offerId": "astro", + "planId": "astro-paygo", + "planName": "Monthly Pay-As-You-Go", + "termUnit": "Monthly", + "termId": "gmz7xq9ge3py" } }, "user": { @@ -57,7 +57,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", @@ -100,7 +100,7 @@ }, "tags": {}, "location": "mhqthlsatwvqkl", - "id": "bhslekyvgkfomahtvjiin", + "id": "/subscriptions/6f490d74-8eb4-4e7d-ae07-c75776710bfa/resourceGroups/resourcegroup/providers/Astronomer.Astro/organizations/astro1234", "name": "ycyrfvupthkudm", "type": "ldwwclcpqssjomo", "systemData": { @@ -120,7 +120,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Get_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Get_MaximumSet_Gen.json index 3948d6ee97d0..27db2f217a47 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Get_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Get_MaximumSet_Gen.json @@ -12,7 +12,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json index a91cf744c759..6c7829796d4b 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -13,7 +13,7 @@ { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_ListBySubscription_MaximumSet_Gen.json index 32e0a22e9f44..abc4954a7a5a 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_ListBySubscription_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -12,7 +12,7 @@ { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Update_MaximumSet_Gen.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Update_MaximumSet_Gen.json index bb2f5bb42d7d..3e35f8e7a994 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Update_MaximumSet_Gen.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/examples/Organizations_Update_MaximumSet_Gen.json @@ -45,7 +45,7 @@ "body": { "properties": { "marketplace": { - "subscriptionId": "ntthclydlpqmasr", + "subscriptionId": null, "subscriptionStatus": "PendingFulfillmentStart", "offerDetails": { "publisherId": "gfsqxygpnerxmvols", From 20b41952d06e5e413e0dc18e747b266b195b1063 Mon Sep 17 00:00:00 2001 From: Zunli Hu Date: Tue, 18 Jun 2024 01:16:40 +0800 Subject: [PATCH 185/343] Release app microsoft.app 2024 02 02 preview (#29312) * Adds base for updating Microsoft.App from version preview/2023-11-02-preview to version 2024-02-02-preview * Updates readme * Updates API version in new specs and examples * Functions Extension endpoint for Web RP (#27873) * Functions extension api-spec commit * merge with latest * Functions Extension in 2024-02-02-preview * correcetd version in readme * avacado fail fix - version * pattern addition * fix for PathForResourceAction * lint diff and model validation checks * AutoRest exception fix * endpoint response as string and not schema * response schema with string * example schema * example within spec * extension example with data * extensions example with body * body as string * [Microsoft.App] add runtime attribute to app configuration (#27892) * add configuration.runtime for apps * Add Nacos For Java Component. (#28045) * Add Nacos For Java Component. * fix spell check. * [Container Apps] Update Runtime to add DotNet support (#28001) * [Container Apps] Update Runtime to add DotNet support * Remove default value * Rename dotNet to dotnet * [Container Apps] Remove AspireResourceServerApi type for DotNetComponent (#28005) * [Container Apps] Remove AspireResourceServerApi type for DotNetComponent * Only keep changes to 2024-02-02-preview * [ContainerApp] Support peer traffic encryption. (#28129) * Make the JavaComponent definitions polymorphism and expose fqdn for sba and eureka (#28102) * Make the JavaComponent definitions polymorphism * fix api version * revert error response change * refine examples * fix default value * fix * fix * try to remove required * try remove require in patch body * fix * try fix lint * fix * add suppression for discriminator * fix --------- Co-authored-by: Xuyang Cao * ContainerAppsBuild and ContainerAppsPatch API (#27982) * Added CloudBuild and CloudPatch * Fixed pipeline errors * Added ContainerApp example * Fixed typo in example * Fixed linting error * Fixed spacing * Addressed comments * Addressed comments and modified sample * Fixed linting error * Addressed comments * Linting * Fixed typo * Fixed Typo * Resolving model validation error * [Microsoft.App] add java agent related properties (#28192) * add java agent related properties * fix build error * fix format * re-run pipeline * update enum list and fix typo * revert cspell config * update level field type from enum to string * add identifiers for array prop * Fix error response for aca (#28425) * fix * fix * Adding identity for scale rules (#28283) * Adding identity for scale rules * fix scale example * Fix schema issue for Microsoft.App in 2024-02-02-preview (#28454) * fix * fix * fix * fix * fix * fix * Update Container Apps Swagger Schema to include kind property (#28405) * Added support for KIND property to container apps schema * added reference to example request schema * prettier check * changes to example conforming to swagger * used enum for app kind * minor fixes * merged main * Revert "merged main" This reverts commit 2437d6078cfdb072b0bed97bb9d75af75ac812a6. * fixed checks * Add detailed job execution to api (#27977) * Add detailed job execution to api * Add fields * address comment * add x-ms-identifiers * prettier * address comments * Address comments * Address comments * update example * Fix property name * Fix example * [Microsoft.App] optimize java agent related properties (#28573) * optimize java agent related props * fix * adding logging property to include logger settings --------- Co-authored-by: Bowen Wan * Add accountName for queueScaler (#28672) * add accountName for queueScaler * updated example * updated * updated * updated * Adding identity settings (#28117) * Adding identity settings * fix casing in examples * Switch to array since ARM doesn't allow dictionaries. * identity property should be required. * prettier * Updating description * Adding Jobs spec * Update specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Jobs.json Co-authored-by: Jitin John * Move IdentitySettings to CommonDefinitions --------- Co-authored-by: Jitin John * Add SessionPools and Sessions (#28047) * Add SessionPools.json and Sessions.json * Add private endpoint connections for managed environment (#28775) * add pe * fix * fix * fix * fix * fix * fix * use v5 * fix * fix * Add support for SMB storage in connectedEnvironment (#29158) * Add support for SMB storage in connectedEnvironment * move smb properties to common * fix reference --------- Co-authored-by: anandgmenon02@gmail.com * API spec for LogicApps extension on Microsoft.App (#29083) * API spec for LogicApps extension on Microsoft.App * format * fix typos * fix issues * fix example references * fix more issues * fix issues * fix more model validation * fix * fix model * fix format * fix lintdiff * fix example * fix headers * add delete * add missing file --------- Co-authored-by: Anand G Menon * Add publicNetworkAccess in managed environment (#29092) * fix * fix * fix example * fix lint * revert previous change for patch * fix go sdk duplicate schema * fix go sdk duplicate schema * fix billing meter * fix billing meter --------- Co-authored-by: Jitin John Co-authored-by: SushmithaVReddy Co-authored-by: sonwan2020 Co-authored-by: Xiangyang Yu Co-authored-by: daniv-msft <48293037+daniv-msft@users.noreply.github.com> Co-authored-by: Xuyang Cao Co-authored-by: Xuyang Cao Co-authored-by: Harry Li <110055355+harryli0108@users.noreply.github.com> Co-authored-by: Jimmy Fang Co-authored-by: Vaclav Turecek Co-authored-by: Shubham Sachdeva <114050289+Shubhrmcf-07@users.noreply.github.com> Co-authored-by: lihaMSFT Co-authored-by: Bowen Wan Co-authored-by: njucz <740360112@qq.com> Co-authored-by: yitaopan Co-authored-by: anandgmenon Co-authored-by: anandgmenon02@gmail.com --- cSpell.json | 6 + custom-words.txt | 1 + .../2024-02-02-preview/AppResiliency.json | 312 +++ .../2024-02-02-preview/AuthConfigs.json | 1034 ++++++++ .../AvailableWorkloadProfiles.json | 149 ++ .../2024-02-02-preview/BillingMeters.json | 128 + .../preview/2024-02-02-preview/Builders.json | 491 ++++ .../preview/2024-02-02-preview/Builds.json | 475 ++++ .../2024-02-02-preview/CommonDefinitions.json | 2173 +++++++++++++++++ .../ConnectedEnvironments.json | 469 ++++ .../ConnectedEnvironmentsCertificates.json | 315 +++ .../ConnectedEnvironmentsDaprComponents.json | 307 +++ .../ConnectedEnvironmentsStorages.json | 294 +++ .../2024-02-02-preview/ContainerApps.json | 1549 ++++++++++++ .../ContainerAppsBuilds.json | 348 +++ .../ContainerAppsPatches.json | 555 +++++ .../ContainerAppsRevisions.json | 677 +++++ .../2024-02-02-preview/Diagnostics.json | 873 +++++++ .../2024-02-02-preview/DotNetComponents.json | 479 ++++ .../FunctionsExtension.json | 107 + .../preview/2024-02-02-preview/Global.json | 140 ++ .../2024-02-02-preview/JavaComponents.json | 561 +++++ .../preview/2024-02-02-preview/Jobs.json | 1285 ++++++++++ .../LogicAppsExtension.json | 750 ++++++ .../ManagedEnvironments.json | 1915 +++++++++++++++ ...nmentsDaprComponentResiliencyPolicies.json | 302 +++ .../ManagedEnvironmentsDaprComponents.json | 313 +++ .../ManagedEnvironmentsDaprSubscriptions.json | 276 +++ .../ManagedEnvironmentsStorages.json | 300 +++ .../2024-02-02-preview/SessionPools.json | 703 ++++++ .../2024-02-02-preview/SourceControls.json | 456 ++++ .../2024-02-02-preview/Subscriptions.json | 80 + .../preview/2024-02-02-preview/Usages.json | 188 ++ .../AppResiliency_CreateOrUpdate.json | 176 ++ .../examples/AppResiliency_Delete.json | 13 + .../examples/AppResiliency_Get.json | 68 + .../examples/AppResiliency_List.json | 71 + .../examples/AppResiliency_Patch.json | 76 + .../examples/AuthConfigs_CreateOrUpdate.json | 61 + .../examples/AuthConfigs_Delete.json | 13 + .../examples/AuthConfigs_Get.json | 39 + .../examples/AuthConfigs_ListByContainer.json | 43 + .../AvailableWorkloadProfiles_Get.json | 159 ++ .../examples/BillingMeters_Get.json | 81 + .../examples/Builders_CreateOrUpdate.json | 128 + .../examples/Builders_Delete.json | 18 + .../examples/Builders_Get.json | 56 + .../Builders_ListByResourceGroup.json | 102 + .../examples/Builders_ListBySubscription.json | 101 + .../examples/Builders_Update.json | 66 + .../examples/Builds_CreateOrUpdate.json | 214 ++ .../Builds_CreateOrUpdate_NoConfig.json | 61 + .../examples/Builds_Delete.json | 19 + .../examples/Builds_Get.json | 85 + .../examples/Builds_ListAuthToken.json | 20 + .../Builds_ListByBuilderResource.json | 159 ++ .../examples/Certificate_CreateOrUpdate.json | 40 + ...rtificate_CreateOrUpdate_FromKeyVault.json | 46 + .../examples/Certificate_Delete.json | 13 + .../examples/Certificate_Get.json | 33 + .../Certificates_CheckNameAvailability.json | 21 + ...Certificates_ListByManagedEnvironment.json | 55 + .../examples/Certificates_Patch.json | 42 + ...nvironmentsCertificate_CreateOrUpdate.json | 38 + ...nnectedEnvironmentsCertificate_Delete.json | 13 + .../ConnectedEnvironmentsCertificate_Get.json | 32 + ...ntsCertificates_CheckNameAvailability.json | 21 + ...rtificates_ListByConnectedEnvironment.json | 53 + ...nnectedEnvironmentsCertificates_Patch.json | 41 + ...ronmentsDaprComponents_CreateOrUpdate.json | 107 + ...ctedEnvironmentsDaprComponents_Delete.json | 13 + ...nnectedEnvironmentsDaprComponents_Get.json | 61 + ...nectedEnvironmentsDaprComponents_List.json | 64 + ...nvironmentsDaprComponents_ListSecrets.json | 26 + ...edEnvironmentsStorages_CreateOrUpdate.json | 35 + .../ConnectedEnvironmentsStorages_Delete.json | 13 + .../ConnectedEnvironmentsStorages_Get.json | 25 + .../ConnectedEnvironmentsStorages_List.json | 28 + .../ConnectedEnvironments_CreateOrUpdate.json | 73 + .../ConnectedEnvironments_Delete.json | 23 + .../examples/ConnectedEnvironments_Get.json | 42 + ...ectedEnvironments_ListByResourceGroup.json | 63 + ...nectedEnvironments_ListBySubscription.json | 54 + .../examples/ConnectedEnvironments_Patch.json | 42 + .../examples/ContainerAppsBuilds_Delete.json | 19 + .../examples/ContainerAppsBuilds_Get.json | 83 + ...ontainerAppsBuilds_ListByContainerApp.json | 155 ++ .../ContainerAppsDiagnostics_Get.json | 68 + .../ContainerAppsDiagnostics_List.json | 38 + .../examples/ContainerAppsPatches_Apply.json | 53 + .../examples/ContainerAppsPatches_Delete.json | 19 + .../examples/ContainerAppsPatches_Get.json | 48 + ...ntainerAppsPatches_ListByContainerApp.json | 103 + .../ContainerAppsPatches_Skip_Configure.json | 21 + .../ContainerApps_CheckNameAvailability.json | 21 + .../ContainerApps_CreateOrUpdate.json | 654 +++++ ...s_CreateOrUpdate_ConnectedEnvironment.json | 458 ++++ .../examples/ContainerApps_Delete.json | 17 + .../examples/ContainerApps_Get.json | 212 ++ .../examples/ContainerApps_GetAuthToken.json | 24 + .../ContainerApps_Kind_CreateOrUpdate.json | 196 ++ .../ContainerApps_ListByResourceGroup.json | 145 ++ .../ContainerApps_ListBySubscription.json | 157 ++ ...tainerApps_ListCustomHostNameAnalysis.json | 42 + .../examples/ContainerApps_ListSecrets.json | 23 + ...ontainerApps_ManagedBy_CreateOrUpdate.json | 204 ++ .../examples/ContainerApps_Patch.json | 286 +++ ...rApps_SourceToCloudApp_CreateOrUpdate.json | 490 ++++ .../examples/ContainerApps_Start.json | 143 ++ .../examples/ContainerApps_Stop.json | 143 ++ .../ContainerApps_TcpApp_CreateOrUpdate.json | 201 ++ ...aprComponentResiliencyPolicies_Delete.json | 14 + .../DaprComponentResiliencyPolicies_Get.json | 54 + .../DaprComponentResiliencyPolicies_List.json | 57 + ...iencyPolicy_CreateOrUpdate_AllOptions.json | 136 ++ ...ncyPolicy_CreateOrUpdate_OutboundOnly.json | 85 + ...cyPolicy_CreateOrUpdate_SparseOptions.json | 88 + ...s_CreateOrUpdate_SecretStoreComponent.json | 98 + ...DaprComponents_CreateOrUpdate_Secrets.json | 107 + .../examples/DaprComponents_Delete.json | 13 + ...prComponents_Get_SecretStoreComponent.json | 57 + .../examples/DaprComponents_Get_Secrets.json | 61 + .../examples/DaprComponents_List.json | 152 ++ .../examples/DaprComponents_ListSecrets.json | 24 + ...CreateOrUpdate_BulkSubscribeAndScopes.json | 77 + ...criptions_CreateOrUpdate_DefaultRoute.json | 50 + ..._CreateOrUpdate_RouteRulesAndMetadata.json | 90 + .../examples/DaprSubscriptions_Delete.json | 13 + ...scriptions_Get_BulkSubscribeAndScopes.json | 35 + .../DaprSubscriptions_Get_DefaultRoute.json | 26 + ...bscriptions_Get_RouteRulesAndMetadata.json | 39 + .../examples/DaprSubscriptions_List.json | 73 + .../DotNetComponents_CreateOrUpdate.json | 58 + ...Components_CreateOrUpdate_ServiceBind.json | 76 + .../examples/DotNetComponents_Delete.json | 17 + .../examples/DotNetComponents_Get.json | 29 + .../DotNetComponents_Get_ServiceBind.json | 35 + .../examples/DotNetComponents_List.json | 46 + .../DotNetComponents_List_ServiceBind.json | 58 + .../examples/DotNetComponents_Patch.json | 45 + .../DotNetComponents_Patch_ServiceBind.json | 57 + .../examples/FunctionsExtension_Post.json | 15 + .../JavaComponents_CreateOrUpdate.json | 76 + ...Components_CreateOrUpdate_ServiceBind.json | 88 + .../examples/JavaComponents_Delete.json | 17 + .../examples/JavaComponents_Get.json | 36 + .../JavaComponents_Get_ServiceBind.json | 39 + .../examples/JavaComponents_List.json | 56 + .../JavaComponents_List_ServiceBind.json | 62 + .../examples/JavaComponents_Patch.json | 56 + .../JavaComponents_Patch_ServiceBind.json | 65 + .../examples/Job_CreateorUpdate.json | 325 +++ ...b_CreateorUpdate_ConnectedEnvironment.json | 219 ++ .../Job_CreateorUpdate_EventTrigger.json | 226 ++ .../examples/Job_Delete.json | 17 + .../examples/Job_Execution_Get.json | 51 + .../examples/Job_Executions_Get.json | 76 + .../2024-02-02-preview/examples/Job_Get.json | 99 + .../examples/Job_GetDetector.json | 68 + .../examples/Job_ListDetectors.json | 38 + .../examples/Job_ListSecrets.json | 23 + .../examples/Job_Patch.json | 114 + .../examples/Job_ProxyGet.json | 55 + .../examples/Job_Start.json | 51 + .../examples/Job_Stop_Execution.json | 17 + .../examples/Job_Stop_Multiple.json | 60 + .../examples/Jobs_ListByResourceGroup.json | 100 + .../examples/Jobs_ListBySubscription.json | 99 + .../examples/LogicApps_Create.json | 30 + .../examples/LogicApps_Delete.json | 13 + ...gicApps_DeleteDeployWorkflowArtifacts.json | 18 + .../examples/LogicApps_Get.json | 19 + .../examples/LogicApps_GetWorkflow.json | 58 + .../examples/LogicApps_ListCallbackURL.json | 26 + .../examples/LogicApps_ListConnections.json | 45 + .../examples/LogicApps_ListWorkflows.json | 49 + ...LogicApps_PostDeployWorkflowArtifacts.json | 58 + .../ManagedCertificate_CreateOrUpdate.json | 50 + .../examples/ManagedCertificate_Delete.json | 13 + .../examples/ManagedCertificate_Get.json | 24 + ...Certificates_ListByManagedEnvironment.json | 47 + .../examples/ManagedCertificates_Patch.json | 30 + .../ManagedEnvironmentDiagnostics_Get.json | 68 + .../ManagedEnvironmentDiagnostics_List.json | 37 + ...ateEndpointConnections_CreateOrUpdate.json | 59 + ...mentPrivateEndpointConnections_Delete.json | 17 + ...ronmentPrivateEndpointConnections_Get.json | 31 + ...onmentPrivateEndpointConnections_List.json | 52 + ...dEnvironmentPrivateLinkResources_List.json | 30 + .../ManagedEnvironmentUsages_List.json | 25 + ...edEnvironmentsStorages_CreateOrUpdate.json | 35 + ...sStorages_CreateOrUpdate_NfsAzureFile.json | 34 + .../ManagedEnvironmentsStorages_Delete.json | 13 + .../ManagedEnvironmentsStorages_Get.json | 25 + ...EnvironmentsStorages_Get_NfsAzureFile.json | 25 + .../ManagedEnvironmentsStorages_List.json | 40 + .../ManagedEnvironments_CreateOrUpdate.json | 318 +++ ...tomInfrastructureResourceGroup_Create.json | 168 ++ .../examples/ManagedEnvironments_Delete.json | 18 + .../examples/ManagedEnvironments_Get.json | 78 + .../ManagedEnvironments_GetAuthToken.json | 23 + ...nagedEnvironments_ListByResourceGroup.json | 93 + ...anagedEnvironments_ListBySubscription.json | 98 + ...nvironments_ListWorkloadProfileStates.json | 36 + .../examples/ManagedEnvironments_Patch.json | 71 + .../examples/Operations_List.json | 24 + .../examples/Replicas_Get.json | 39 + .../examples/Replicas_List.json | 42 + .../examples/Revisions_Activate.json | 12 + .../examples/Revisions_Deactivate.json | 12 + .../examples/Revisions_Get.json | 54 + .../examples/Revisions_List.json | 57 + .../examples/Revisions_Restart.json | 12 + .../examples/SessionPools_CreateOrUpdate.json | 150 ++ .../examples/SessionPools_Delete.json | 16 + .../examples/SessionPools_Get.json | 60 + .../SessionPools_ListByResourceGroup.json | 64 + .../SessionPools_ListBySubscription.json | 63 + .../examples/SessionPools_Patch.json | 102 + .../SourceControls_CreateOrUpdate.json | 107 + .../examples/SourceControls_Delete.json | 18 + .../examples/SourceControls_Get.json | 41 + .../SourceControls_ListByContainer.json | 45 + ...iptions_GetCustomDomainVerificationId.json | 12 + .../examples/Usages_List.json | 33 + specification/app/resource-manager/readme.md | 54 +- 226 files changed, 31786 insertions(+), 3 deletions(-) create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AppResiliency.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AvailableWorkloadProfiles.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/BillingMeters.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Builders.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Builds.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsCertificates.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsDaprComponents.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsStorages.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerApps.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsBuilds.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsPatches.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsRevisions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Diagnostics.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/DotNetComponents.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/FunctionsExtension.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Global.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/JavaComponents.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Jobs.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/LogicAppsExtension.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironments.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponents.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprSubscriptions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsStorages.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/SessionPools.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/SourceControls.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Subscriptions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Usages.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_ListByContainer.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AvailableWorkloadProfiles_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/BillingMeters_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Update.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_CreateOrUpdate_NoConfig.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_ListAuthToken.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_ListByBuilderResource.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_CreateOrUpdate_FromKeyVault.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_CheckNameAvailability.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_ListByManagedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_ListByContainerApp.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsDiagnostics_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsDiagnostics_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Apply.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_ListByContainerApp.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Skip_Configure.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CheckNameAvailability.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_GetAuthToken.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Kind_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListSecrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Start.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Stop.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_CreateOrUpdate_Secrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Get_SecretStoreComponent.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Get_Secrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_ListSecrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_DefaultRoute.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_CreateOrUpdate_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Get_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_List_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Patch_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/FunctionsExtension_Post.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_CreateOrUpdate_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Get_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_List_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Patch_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate_EventTrigger.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Execution_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Executions_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_GetDetector.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ListDetectors.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ListSecrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ProxyGet.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Start.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Stop_Execution.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Stop_Multiple.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Jobs_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Jobs_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Create.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_DeleteDeployWorkflowArtifacts.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_GetWorkflow.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListCallbackURL.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListConnections.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListWorkflows.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_PostDeployWorkflowArtifacts.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificates_ListByManagedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificates_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentDiagnostics_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentDiagnostics_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateLinkResources_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentUsages_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_GetAuthToken.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListWorkloadProfileStates.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Operations_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Replicas_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Replicas_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Activate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Deactivate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Restart.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_ListByContainer.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Subscriptions_GetCustomDomainVerificationId.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Usages_List.json diff --git a/cSpell.json b/cSpell.json index 016c6a42c54b..416e3c5e1d89 100644 --- a/cSpell.json +++ b/cSpell.json @@ -247,6 +247,12 @@ "otlp" ] }, + { + "filename": "**/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerApps.json", + "words": [ + "workflowapp" + ] + }, { "filename": "**/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json", "words": [ diff --git a/custom-words.txt b/custom-words.txt index 9332326fade7..575b10b85ea6 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1868,6 +1868,7 @@ myvolume myworkbooks n'eventtype n'recognition +nacos nadella nagios nameserver diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AppResiliency.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AppResiliency.json new file mode 100644 index 000000000000..8df69887e8f0 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AppResiliency.json @@ -0,0 +1,312 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-02-02-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies/{name}": { + "put": { + "tags": [ + "AppResiliency" + ], + "summary": "Create or update an application's resiliency policy.", + "description": "Create or update container app resiliency policy.", + "operationId": "AppResiliency_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "description": "Name of the resiliency policy.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "resiliencyEnvelope", + "in": "body", + "description": "The resiliency policy to create or update.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + "201": { + "description": "App Resiliency create or update has been started.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update App Resiliency": { + "$ref": "./examples/AppResiliency_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "AppResiliency" + ], + "summary": "Update an application's resiliency policy.", + "description": "Update container app resiliency policy.", + "operationId": "AppResiliency_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "description": "Name of the resiliency policy.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "resiliencyEnvelope", + "in": "body", + "description": "The resiliency policy to update.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update App Resiliency": { + "$ref": "./examples/AppResiliency_Patch.json" + } + } + }, + "delete": { + "tags": [ + "AppResiliency" + ], + "summary": "Delete an application's resiliency policy.", + "description": "Delete container app resiliency policy.", + "operationId": "AppResiliency_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "description": "Name of the resiliency policy.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Resiliency policy deleted successfully." + }, + "204": { + "description": "Resiliency policy does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete App Resiliency": { + "$ref": "./examples/AppResiliency_Delete.json" + } + } + }, + "get": { + "tags": [ + "AppResiliency" + ], + "summary": "Get an application's resiliency policy.", + "description": "Get container app resiliency policy.", + "operationId": "AppResiliency_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "description": "Name of the resiliency policy.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Resiliency": { + "$ref": "./examples/AppResiliency_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies": { + "get": { + "tags": [ + "AppResiliency" + ], + "summary": "List an application's resiliency policies.", + "description": "List container app resiliency policies.", + "operationId": "AppResiliency_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliencyCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Resiliency": { + "$ref": "./examples/AppResiliency_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json new file mode 100644 index 000000000000..761332185ddc --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json @@ -0,0 +1,1034 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs": { + "get": { + "tags": [ + "ContainerAppsAuthConfigs" + ], + "summary": "Get the Container App AuthConfigs in a given resource group.", + "operationId": "ContainerAppsAuthConfigs_ListByContainerApp", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AuthConfigCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Auth Configs by Container Apps": { + "$ref": "./examples/AuthConfigs_ListByContainer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}": { + "get": { + "tags": [ + "ContainerAppsAuthConfigs" + ], + "summary": "Get a AuthConfig of a Container App.", + "operationId": "ContainerAppsAuthConfigs_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "authConfigName", + "in": "path", + "description": "Name of the Container App AuthConfig.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AuthConfig" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's AuthConfig": { + "$ref": "./examples/AuthConfigs_Get.json" + } + } + }, + "put": { + "tags": [ + "ContainerAppsAuthConfigs" + ], + "summary": "Create or update the AuthConfig for a Container App.", + "description": "Create or update the AuthConfig for a Container App.", + "operationId": "ContainerAppsAuthConfigs_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "authConfigName", + "in": "path", + "description": "Name of the Container App AuthConfig.", + "required": true, + "type": "string" + }, + { + "name": "authConfigEnvelope", + "in": "body", + "description": "Properties used to create a Container App AuthConfig", + "required": true, + "schema": { + "$ref": "#/definitions/AuthConfig" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/AuthConfig" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Container App AuthConfig": { + "$ref": "./examples/AuthConfigs_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ContainerAppsAuthConfigs" + ], + "summary": "Delete a Container App AuthConfig.", + "description": "Delete a Container App AuthConfig.", + "operationId": "ContainerAppsAuthConfigs_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "authConfigName", + "in": "path", + "description": "Name of the Container App AuthConfig.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App deleted successfully." + }, + "204": { + "description": "Container App AuthConfig does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Container App AuthConfig": { + "$ref": "./examples/AuthConfigs_Delete.json" + } + } + } + } + }, + "definitions": { + "AuthConfigCollection": { + "description": "AuthConfig collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AuthConfig" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "AuthConfig": { + "description": "Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "AuthConfig resource specific properties", + "type": "object", + "properties": { + "platform": { + "$ref": "#/definitions/AuthPlatform", + "description": "The configuration settings of the platform of ContainerApp Service Authentication/Authorization." + }, + "globalValidation": { + "$ref": "#/definitions/GlobalValidation", + "description": "The configuration settings that determines the validation flow of users using Service Authentication/Authorization." + }, + "identityProviders": { + "$ref": "#/definitions/IdentityProviders", + "description": "The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization." + }, + "login": { + "$ref": "#/definitions/Login", + "description": "The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization." + }, + "httpSettings": { + "$ref": "#/definitions/HttpSettings", + "description": "The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization." + }, + "encryptionSettings": { + "$ref": "#/definitions/EncryptionSettings", + "description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization." + } + }, + "x-ms-client-flatten": true + } + } + }, + "AuthPlatform": { + "description": "The configuration settings of the platform of ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "enabled": { + "description": "true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.", + "type": "boolean" + }, + "runtimeVersion": { + "description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module.", + "type": "string" + } + } + }, + "GlobalValidation": { + "description": "The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "unauthenticatedClientAction": { + "description": "The action to take when an unauthenticated client attempts to access the app.", + "enum": [ + "RedirectToLoginPage", + "AllowAnonymous", + "Return401", + "Return403" + ], + "type": "string", + "x-ms-enum": { + "name": "UnauthenticatedClientActionV2", + "modelAsString": false + } + }, + "redirectToProvider": { + "description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\".", + "type": "string" + }, + "excludedPaths": { + "description": "The paths for which unauthenticated flow would not be redirected to the login page.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HttpSettings": { + "description": "The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "requireHttps": { + "description": "false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true.", + "type": "boolean" + }, + "routes": { + "$ref": "#/definitions/HttpSettingsRoutes", + "description": "The configuration settings of the paths HTTP requests." + }, + "forwardProxy": { + "$ref": "#/definitions/ForwardProxy", + "description": "The configuration settings of a forward proxy used to make the requests." + } + } + }, + "EncryptionSettings": { + "description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "containerAppAuthEncryptionSecretName": { + "description": "The secret name which is referenced for EncryptionKey.", + "type": "string" + }, + "containerAppAuthSigningSecretName": { + "description": "The secret name which is referenced for SigningKey.", + "type": "string" + } + } + }, + "HttpSettingsRoutes": { + "description": "The configuration settings of the paths HTTP requests.", + "type": "object", + "properties": { + "apiPrefix": { + "description": "The prefix that should precede all the authentication/authorization paths.", + "type": "string" + } + } + }, + "ForwardProxy": { + "description": "The configuration settings of a forward proxy used to make the requests.", + "type": "object", + "properties": { + "convention": { + "description": "The convention used to determine the url of the request made.", + "enum": [ + "NoProxy", + "Standard", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ForwardProxyConvention", + "modelAsString": false + } + }, + "customHostHeaderName": { + "description": "The name of the header containing the host of the request.", + "type": "string" + }, + "customProtoHeaderName": { + "description": "The name of the header containing the scheme of the request.", + "type": "string" + } + } + }, + "Login": { + "description": "The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "routes": { + "$ref": "#/definitions/LoginRoutes", + "description": "The routes that specify the endpoints used for login and logout requests." + }, + "tokenStore": { + "$ref": "#/definitions/TokenStore", + "description": "The configuration settings of the token store." + }, + "preserveUrlFragmentsForLogins": { + "description": "true if the fragments from the request are preserved after the login request is made; otherwise, false.", + "type": "boolean" + }, + "allowedExternalRedirectUrls": { + "description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.", + "type": "array", + "items": { + "type": "string" + } + }, + "cookieExpiration": { + "$ref": "#/definitions/CookieExpiration", + "description": "The configuration settings of the session cookie's expiration." + }, + "nonce": { + "$ref": "#/definitions/Nonce", + "description": "The configuration settings of the nonce used in the login flow." + } + } + }, + "LoginRoutes": { + "description": "The routes that specify the endpoints used for login and logout requests.", + "type": "object", + "properties": { + "logoutEndpoint": { + "description": "The endpoint at which a logout request should be made.", + "type": "string" + } + } + }, + "TokenStore": { + "description": "The configuration settings of the token store.", + "type": "object", + "properties": { + "enabled": { + "description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false.", + "type": "boolean" + }, + "tokenRefreshExtensionHours": { + "format": "double", + "description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours.", + "type": "number" + }, + "azureBlobStorage": { + "$ref": "#/definitions/BlobStorageTokenStore", + "description": "The configuration settings of the storage of the tokens if blob storage is used." + } + } + }, + "BlobStorageTokenStore": { + "description": "The configuration settings of the storage of the tokens if blob storage is used.", + "type": "object", + "required": [ + "sasUrlSettingName" + ], + "properties": { + "sasUrlSettingName": { + "description": "The name of the app secrets containing the SAS URL of the blob storage containing the tokens.", + "type": "string" + } + } + }, + "CookieExpiration": { + "description": "The configuration settings of the session cookie's expiration.", + "type": "object", + "properties": { + "convention": { + "description": "The convention used when determining the session cookie's expiration.", + "enum": [ + "FixedTime", + "IdentityProviderDerived" + ], + "type": "string", + "x-ms-enum": { + "name": "CookieExpirationConvention", + "modelAsString": false + } + }, + "timeToExpiration": { + "description": "The time after the request is made when the session cookie should expire.", + "type": "string" + } + } + }, + "Nonce": { + "description": "The configuration settings of the nonce used in the login flow.", + "type": "object", + "properties": { + "validateNonce": { + "description": "false if the nonce should not be validated while completing the login flow; otherwise, true.", + "type": "boolean" + }, + "nonceExpirationInterval": { + "description": "The time after the request is made when the nonce should expire.", + "type": "string" + } + } + }, + "IdentityProviders": { + "description": "The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "azureActiveDirectory": { + "$ref": "#/definitions/AzureActiveDirectory", + "description": "The configuration settings of the Azure Active directory provider." + }, + "facebook": { + "$ref": "#/definitions/Facebook", + "description": "The configuration settings of the Facebook provider." + }, + "gitHub": { + "$ref": "#/definitions/GitHub", + "description": "The configuration settings of the GitHub provider." + }, + "google": { + "$ref": "#/definitions/Google", + "description": "The configuration settings of the Google provider." + }, + "twitter": { + "$ref": "#/definitions/Twitter", + "description": "The configuration settings of the Twitter provider." + }, + "apple": { + "$ref": "#/definitions/Apple", + "description": "The configuration settings of the Apple provider." + }, + "azureStaticWebApps": { + "$ref": "#/definitions/AzureStaticWebApps", + "description": "The configuration settings of the Azure Static Web Apps provider." + }, + "customOpenIdConnectProviders": { + "description": "The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomOpenIdConnectProvider" + } + } + } + }, + "AzureActiveDirectory": { + "description": "The configuration settings of the Azure Active directory provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AzureActiveDirectoryRegistration", + "description": "The configuration settings of the Azure Active Directory app registration." + }, + "login": { + "$ref": "#/definitions/AzureActiveDirectoryLogin", + "description": "The configuration settings of the Azure Active Directory login flow." + }, + "validation": { + "$ref": "#/definitions/AzureActiveDirectoryValidation", + "description": "The configuration settings of the Azure Active Directory token validation flow." + }, + "isAutoProvisioned": { + "description": "Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property.", + "type": "boolean" + } + } + }, + "AzureActiveDirectoryLogin": { + "description": "The configuration settings of the Azure Active Directory login flow.", + "type": "object", + "properties": { + "loginParameters": { + "description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".", + "type": "array", + "items": { + "type": "string" + } + }, + "disableWWWAuthenticate": { + "description": "true if the www-authenticate provider should be omitted from the request; otherwise, false.", + "type": "boolean" + } + } + }, + "AzureActiveDirectoryRegistration": { + "description": "The configuration settings of the Azure Active Directory app registration.", + "type": "object", + "properties": { + "openIdIssuer": { + "description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html", + "type": "string" + }, + "clientId": { + "description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret of the relying party application.", + "type": "string" + }, + "clientSecretCertificateThumbprint": { + "description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional.", + "type": "string" + }, + "clientSecretCertificateSubjectAlternativeName": { + "description": "An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional.", + "type": "string" + }, + "clientSecretCertificateIssuer": { + "description": "An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional.", + "type": "string" + } + } + }, + "AzureActiveDirectoryValidation": { + "description": "The configuration settings of the Azure Active Directory token validation flow.", + "type": "object", + "properties": { + "jwtClaimChecks": { + "$ref": "#/definitions/JwtClaimChecks", + "description": "The configuration settings of the checks that should be made while validating the JWT Claims." + }, + "allowedAudiences": { + "description": "The list of audiences that can make successful authentication/authorization requests.", + "type": "array", + "items": { + "type": "string" + } + }, + "defaultAuthorizationPolicy": { + "$ref": "#/definitions/DefaultAuthorizationPolicy", + "description": "The configuration settings of the default authorization policy." + } + } + }, + "JwtClaimChecks": { + "description": "The configuration settings of the checks that should be made while validating the JWT Claims.", + "type": "object", + "properties": { + "allowedGroups": { + "description": "The list of the allowed groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedClientApplications": { + "description": "The list of the allowed client applications.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DefaultAuthorizationPolicy": { + "description": "The configuration settings of the Azure Active Directory default authorization policy.", + "type": "object", + "properties": { + "allowedPrincipals": { + "$ref": "#/definitions/AllowedPrincipals", + "description": "The configuration settings of the Azure Active Directory allowed principals." + }, + "allowedApplications": { + "description": "The configuration settings of the Azure Active Directory allowed applications.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AllowedPrincipals": { + "description": "The configuration settings of the Azure Active Directory allowed principals.", + "type": "object", + "properties": { + "groups": { + "description": "The list of the allowed groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "identities": { + "description": "The list of the allowed identities.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Facebook": { + "description": "The configuration settings of the Facebook provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Facebook provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AppRegistration", + "description": "The configuration settings of the app registration for the Facebook provider." + }, + "graphApiVersion": { + "description": "The version of the Facebook api to be used while logging in.", + "type": "string" + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + } + } + }, + "AppRegistration": { + "description": "The configuration settings of the app registration for providers that have app ids and app secrets", + "type": "object", + "properties": { + "appId": { + "description": "The App ID of the app used for login.", + "type": "string" + }, + "appSecretSettingName": { + "description": "The app setting name that contains the app secret.", + "type": "string" + } + } + }, + "LoginScopes": { + "description": "The configuration settings of the login flow, including the scopes that should be requested.", + "type": "object", + "properties": { + "scopes": { + "description": "A list of the scopes that should be requested while authenticating.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GitHub": { + "description": "The configuration settings of the GitHub provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the GitHub provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/ClientRegistration", + "description": "The configuration settings of the app registration for the GitHub provider." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + } + } + }, + "ClientRegistration": { + "description": "The configuration settings of the app registration for providers that have client ids and client secrets", + "type": "object", + "properties": { + "clientId": { + "description": "The Client ID of the app used for login.", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret.", + "type": "string" + } + } + }, + "Google": { + "description": "The configuration settings of the Google provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Google provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/ClientRegistration", + "description": "The configuration settings of the app registration for the Google provider." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + }, + "validation": { + "$ref": "#/definitions/AllowedAudiencesValidation", + "description": "The configuration settings of the Azure Active Directory token validation flow." + } + } + }, + "AllowedAudiencesValidation": { + "description": "The configuration settings of the Allowed Audiences validation flow.", + "type": "object", + "properties": { + "allowedAudiences": { + "description": "The configuration settings of the allowed list of audiences from which to validate the JWT token.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Twitter": { + "description": "The configuration settings of the Twitter provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Twitter provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/TwitterRegistration", + "description": "The configuration settings of the app registration for the Twitter provider." + } + } + }, + "TwitterRegistration": { + "description": "The configuration settings of the app registration for the Twitter provider.", + "type": "object", + "properties": { + "consumerKey": { + "description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in", + "type": "string" + }, + "consumerSecretSettingName": { + "description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in.", + "type": "string" + } + } + }, + "Apple": { + "description": "The configuration settings of the Apple provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Apple provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AppleRegistration", + "description": "The configuration settings of the Apple registration." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + } + } + }, + "AppleRegistration": { + "description": "The configuration settings of the registration for the Apple provider", + "type": "object", + "properties": { + "clientId": { + "description": "The Client ID of the app used for login.", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret.", + "type": "string" + } + } + }, + "AzureStaticWebApps": { + "description": "The configuration settings of the Azure Static Web Apps provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AzureStaticWebAppsRegistration", + "description": "The configuration settings of the Azure Static Web Apps registration." + } + } + }, + "AzureStaticWebAppsRegistration": { + "description": "The configuration settings of the registration for the Azure Static Web Apps provider", + "type": "object", + "properties": { + "clientId": { + "description": "The Client ID of the app used for login.", + "type": "string" + } + } + }, + "CustomOpenIdConnectProvider": { + "description": "The configuration settings of the custom Open ID Connect provider.", + "type": "object", + "properties": { + "enabled": { + "description": "false if the custom Open ID provider provider should not be enabled; otherwise, true.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/OpenIdConnectRegistration", + "description": "The configuration settings of the app registration for the custom Open ID Connect provider." + }, + "login": { + "$ref": "#/definitions/OpenIdConnectLogin", + "description": "The configuration settings of the login flow of the custom Open ID Connect provider." + } + } + }, + "OpenIdConnectRegistration": { + "description": "The configuration settings of the app registration for the custom Open ID Connect provider.", + "type": "object", + "properties": { + "clientId": { + "description": "The client id of the custom Open ID Connect provider.", + "type": "string" + }, + "clientCredential": { + "$ref": "#/definitions/OpenIdConnectClientCredential", + "description": "The authentication credentials of the custom Open ID Connect provider." + }, + "openIdConnectConfiguration": { + "$ref": "#/definitions/OpenIdConnectConfig", + "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider." + } + } + }, + "OpenIdConnectClientCredential": { + "description": "The authentication client credentials of the custom Open ID Connect provider.", + "type": "object", + "properties": { + "method": { + "description": "The method that should be used to authenticate the user.", + "enum": [ + "ClientSecretPost" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientCredentialMethod", + "modelAsString": false + } + }, + "clientSecretSettingName": { + "description": "The app setting that contains the client secret for the custom Open ID Connect provider.", + "type": "string" + } + } + }, + "OpenIdConnectConfig": { + "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider.", + "type": "object", + "properties": { + "authorizationEndpoint": { + "description": "The endpoint to be used to make an authorization request.", + "type": "string" + }, + "tokenEndpoint": { + "description": "The endpoint to be used to request a token.", + "type": "string" + }, + "issuer": { + "description": "The endpoint that issues the token.", + "type": "string" + }, + "certificationUri": { + "description": "The endpoint that provides the keys necessary to validate the token.", + "type": "string" + }, + "wellKnownOpenIdConfiguration": { + "description": "The endpoint that contains all the configuration endpoints for the provider.", + "type": "string" + } + } + }, + "OpenIdConnectLogin": { + "description": "The configuration settings of the login flow of the custom Open ID Connect provider.", + "type": "object", + "properties": { + "nameClaimType": { + "description": "The name of the claim that contains the users name.", + "type": "string" + }, + "scopes": { + "description": "A list of the scopes that should be requested while authenticating.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AvailableWorkloadProfiles.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AvailableWorkloadProfiles.json new file mode 100644 index 000000000000..450677e2c8db --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/AvailableWorkloadProfiles.json @@ -0,0 +1,149 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/availableManagedEnvironmentsWorkloadProfileTypes": { + "get": { + "tags": [ + "AvailableWorkloadProfiles" + ], + "summary": "Get available workload profiles by location.", + "description": "Get all available workload profiles for a location.", + "operationId": "AvailableWorkloadProfiles_Get", + "parameters": [ + { + "$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/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailableWorkloadProfilesCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BillingMeters_Get": { + "$ref": "./examples/AvailableWorkloadProfiles_Get.json" + } + } + } + } + }, + "definitions": { + "AvailableWorkloadProfile": { + "description": "A workload profile with specific hardware configure to run container apps.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Region of the workload profile." + }, + "properties": { + "description": "Revision resource specific properties", + "type": "object", + "properties": { + "category": { + "description": "Used to categorize workload profiles.", + "type": "string" + }, + "applicability": { + "type": "string", + "description": "indicates whether the profile is default for the location.", + "enum": [ + "LocationDefault", + "Custom" + ], + "x-ms-enum": { + "name": "Applicability", + "modelAsString": true + } + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Number of cores in CPU." + }, + "memoryGiB": { + "type": "integer", + "format": "int32", + "description": "Memory in GiB." + }, + "gpus": { + "type": "integer", + "format": "int32", + "description": "Number of GPUs." + }, + "displayName": { + "type": "string", + "description": "The everyday name of the workload profile." + } + } + } + } + }, + "AvailableWorkloadProfilesCollection": { + "description": "Collection of available workload profiles in the location.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of workload profiles.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailableWorkloadProfile" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/BillingMeters.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/BillingMeters.json new file mode 100644 index 000000000000..9988b8ddc78c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/BillingMeters.json @@ -0,0 +1,128 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/billingMeters": { + "get": { + "tags": [ + "BillingMeters" + ], + "summary": "Get billing meters by location.", + "description": "Get all billingMeters for a location.", + "operationId": "BillingMeters_Get", + "parameters": [ + { + "$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/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BillingMeterCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingMeters_Get": { + "$ref": "./examples/BillingMeters_Get.json" + } + } + } + } + }, + "definitions": { + "BillingMeter": { + "description": "Billing meter.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + }, + "location": { + "type": "string", + "description": "Region for the billing meter." + }, + "properties": { + "description": "Revision resource specific properties", + "type": "object", + "properties": { + "category": { + "description": "Used to categorize billing meters.", + "type": "string" + }, + "meterType": { + "type": "string", + "description": "Billing meter type." + }, + "displayName": { + "type": "string", + "description": "The everyday name of the billing meter." + } + } + } + } + }, + "BillingMeterCollection": { + "description": "Collection of billing meters.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of billing meters.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeter" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Builders.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Builders.json new file mode 100644 index 000000000000..dd4e6ae1fc18 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Builders.json @@ -0,0 +1,491 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-02-02-preview" + }, + "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" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/builders": { + "get": { + "tags": [ + "Builders" + ], + "operationId": "Builders_ListBySubscription", + "description": "List BuilderResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Builders_ListBySubscription_0": { + "$ref": "./examples/Builders_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders": { + "get": { + "tags": [ + "Builders" + ], + "operationId": "Builders_ListByResourceGroup", + "description": "List BuilderResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Builders_ListByResourceGroup_0": { + "$ref": "./examples/Builders_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}": { + "get": { + "tags": [ + "Builders" + ], + "operationId": "Builders_Get", + "description": "Get a BuilderResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builders_Get_0": { + "$ref": "./examples/Builders_Get.json" + } + } + }, + "put": { + "tags": [ + "Builders" + ], + "operationId": "Builders_CreateOrUpdate", + "description": "Create or update a BuilderResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "name": "builderEnvelope", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + } + ], + "responses": { + "200": { + "description": "ARM create or update operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + }, + "201": { + "description": "ARM create or update operation has been started.", + "schema": { + "$ref": "#/definitions/BuilderResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Builders_CreateOrUpdate_0": { + "$ref": "./examples/Builders_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Builders" + ], + "operationId": "Builders_Update", + "description": "Update a BuilderResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "name": "builderEnvelope", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/BuilderResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builders_Update_0": { + "$ref": "./examples/Builders_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Builders" + ], + "operationId": "Builders_Delete", + "description": "Delete a BuilderResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builders_Delete_0": { + "$ref": "./examples/Builders_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "BuilderProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/BuilderProvisioningState", + "description": "Provisioning state of a builder resource.", + "readOnly": true + }, + "environmentId": { + "type": "string", + "description": "Resource ID of the container apps environment that the builder is associated with.", + "format": "arm-id" + }, + "containerRegistries": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistry" + }, + "x-ms-identifiers": [ + "containerRegistryServer" + ], + "description": "List of mappings of container registries and the managed identity used to connect to it." + } + }, + "description": "The builder properties.", + "required": [ + "environmentId" + ] + }, + "BuilderResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/BuilderProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "Information about the SourceToCloud builder resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "BuilderCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BuilderResource" + }, + "description": "The BuilderResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "description": "The response of a BuilderResource list operation.", + "required": [ + "value" + ] + }, + "BuilderResourceUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/BuilderResourceUpdateProperties", + "x-ms-client-flatten": true + } + }, + "description": "The type used for update operations of the BuilderResource." + }, + "BuilderResourceUpdateProperties": { + "type": "object", + "properties": { + "environmentId": { + "type": "string", + "description": "Resource ID of the container apps environment that the builder is associated with.", + "format": "arm-id" + } + }, + "description": "The updatable properties of the BuilderResource." + }, + "ContainerRegistry": { + "type": "object", + "properties": { + "containerRegistryServer": { + "type": "string", + "description": "Login server of the container registry." + }, + "identityResourceId": { + "type": "string", + "description": "Resource ID of the managed identity.", + "format": "arm-id" + } + }, + "description": "Model representing a mapping from a container registry to the identity used to connect to it.", + "required": [ + "containerRegistryServer", + "identityResourceId" + ] + }, + "BuilderProvisioningState": { + "type": "string", + "description": "Resource instance provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "BuilderProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "parameters": { + "BuilderNameParameter": { + "name": "builderName", + "in": "path", + "required": true, + "description": "The name of the builder.", + "minLength": 2, + "maxLength": 32, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Builds.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Builds.json new file mode 100644 index 000000000000..b83c6b14f0d0 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Builds.json @@ -0,0 +1,475 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-02-02-preview" + }, + "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" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds": { + "get": { + "tags": [ + "Builds" + ], + "operationId": "BuildsByBuilderResource_List", + "description": "List BuildResource resources by BuilderResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuildCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Builds_ListByBuilderResource_0": { + "$ref": "./examples/Builds_ListByBuilderResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}": { + "get": { + "tags": [ + "Builds" + ], + "operationId": "Builds_Get", + "description": "Get a BuildResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuildResource" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builds_Get_0": { + "$ref": "./examples/Builds_Get.json" + } + } + }, + "put": { + "tags": [ + "Builds" + ], + "operationId": "Builds_CreateOrUpdate", + "description": "Create a BuildResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + }, + { + "name": "buildEnvelope", + "in": "body", + "required": true, + "description": "Resource create or update parameters.", + "schema": { + "$ref": "#/definitions/BuildResource" + } + } + ], + "responses": { + "200": { + "description": "ARM create or update operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuildResource" + } + }, + "201": { + "description": "ARM create or update operation has been started.", + "schema": { + "$ref": "#/definitions/BuildResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Builds_CreateOrUpdate_WithConfig": { + "$ref": "./examples/Builds_CreateOrUpdate.json" + }, + "Builds_CreateOrUpdate_NoConfig": { + "$ref": "./examples/Builds_CreateOrUpdate_NoConfig.json" + } + } + }, + "delete": { + "tags": [ + "Builds" + ], + "operationId": "Builds_Delete", + "description": "Delete a BuildResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builds_Delete_0": { + "$ref": "./examples/Builds_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}/listAuthToken": { + "post": { + "tags": [ + "Builds" + ], + "operationId": "BuildAuthToken_List", + "description": "Gets the token used to connect to the endpoint where source code can be uploaded for a build.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BuildToken" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Build Auth Token": { + "$ref": "./examples/Builds_ListAuthToken.json" + } + } + } + } + }, + "definitions": { + "BuildConfiguration": { + "type": "object", + "properties": { + "baseOs": { + "type": "string", + "description": "Base OS used to build and run the app." + }, + "platform": { + "type": "string", + "description": "Platform to be used to build and run the app." + }, + "platformVersion": { + "type": "string", + "description": "Platform version to be used to build and run the app." + }, + "environmentVariables": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of environment variables to be passed to the build, secrets should not be used in environment variable." + }, + "preBuildSteps": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/PreBuildStep" + }, + "x-ms-identifiers": [], + "description": "List of steps to perform before the build." + } + }, + "description": "Configuration of the build." + }, + "BuildProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/BuildProvisioningState", + "description": "Build provisioning state.", + "readOnly": true + }, + "buildStatus": { + "$ref": "#/definitions/BuildStatus", + "description": "Status of the build once it has been provisioned.", + "readOnly": true + }, + "destinationContainerRegistry": { + "$ref": "./CommonDefinitions.json#/definitions/ContainerRegistryWithCustomImage", + "description": "Container registry that the final image will be uploaded to." + }, + "configuration": { + "$ref": "#/definitions/BuildConfiguration", + "description": "Configuration of the build." + }, + "uploadEndpoint": { + "type": "string", + "description": "Endpoint to which the source code should be uploaded.", + "readOnly": true + }, + "logStreamEndpoint": { + "type": "string", + "description": "Endpoint from which the build logs can be streamed.", + "readOnly": true + }, + "tokenEndpoint": { + "type": "string", + "description": "Endpoint to use to retrieve an authentication token for log streaming and uploading source code.", + "readOnly": true + } + }, + "description": "The build properties." + }, + "BuildResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/BuildProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "Information pertaining to an individual build.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BuildCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BuildResource" + }, + "description": "The BuildResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "description": "The response of a BuildResource list operation.", + "required": [ + "value" + ] + }, + "BuildStatus": { + "type": "string", + "description": "Status of the build once it has been provisioned.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "BuildStatus", + "modelAsString": true + } + }, + "BuildToken": { + "description": "Build Auth Token.", + "type": "object", + "properties": { + "token": { + "type": "string", + "x-ms-secret": true, + "description": "Authentication token.", + "readOnly": true + }, + "expires": { + "format": "date-time", + "description": "Token expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "BuildProvisioningState": { + "type": "string", + "description": "Resource instance provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "BuildProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "parameters": { + "BuildNameParameter": { + "name": "buildName", + "in": "path", + "required": true, + "description": "The name of a build.", + "minLength": 2, + "maxLength": 64, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json new file mode 100644 index 000000000000..f74c1f325b6a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json @@ -0,0 +1,2173 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "EnvironmentVar": { + "description": "Container App container environment variable.", + "type": "object", + "properties": { + "name": { + "description": "Environment variable name.", + "type": "string" + }, + "value": { + "description": "Non-secret environment variable value.", + "type": "string" + }, + "secretRef": { + "description": "Name of the Container App secret from which to pull the environment variable value.", + "type": "string" + } + } + }, + "WorkloadProfileName": { + "description": "Workload profile name for container apps to execute on.", + "type": "string" + }, + "WorkloadProfileType": { + "description": "Workload profile type for container apps to execute on.", + "type": "string" + }, + "BaseContainer": { + "description": "Container App base container definition.", + "type": "object", + "properties": { + "image": { + "description": "Container image tag.", + "type": "string" + }, + "imageType": { + "description": "The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image.", + "type": "string", + "enum": [ + "CloudBuild", + "ContainerImage" + ], + "x-ms-enum": { + "name": "imageType", + "modelAsString": true + } + }, + "name": { + "description": "Custom container name.", + "type": "string" + }, + "command": { + "description": "Container start command.", + "type": "array", + "items": { + "type": "string" + } + }, + "args": { + "description": "Container start command arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "env": { + "description": "Container environment variables.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVar" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resources": { + "$ref": "#/definitions/ContainerResources", + "description": "Container resource requirements." + }, + "volumeMounts": { + "description": "Container volume mounts.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "volumeName" + ] + } + } + }, + "InitContainer": { + "description": "Container App init container definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseContainer" + } + ] + }, + "Container": { + "description": "Container App container definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseContainer" + } + ], + "properties": { + "probes": { + "description": "List of probes for the container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAppProbe" + }, + "x-ms-identifiers": [ + "type" + ] + } + } + }, + "ContainerResources": { + "description": "Container App container resource requirements.", + "type": "object", + "properties": { + "cpu": { + "format": "double", + "description": "Required CPU in cores, e.g. 0.5", + "type": "number" + }, + "memory": { + "description": "Required memory, e.g. \"250Mb\"", + "type": "string" + }, + "ephemeralStorage": { + "description": "Ephemeral Storage, e.g. \"1Gi\"", + "type": "string", + "readOnly": true + } + } + }, + "ContainerAppProbe": { + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", + "type": "object", + "properties": { + "failureThreshold": { + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.", + "type": "integer", + "format": "int32" + }, + "httpGet": { + "description": "HTTPGet specifies the http request to perform.", + "type": "object", + "required": [ + "port" + ], + "properties": { + "host": { + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.", + "type": "string" + }, + "httpHeaders": { + "description": "Custom headers to set in the request. HTTP allows repeated headers.", + "type": "array", + "items": { + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "description": "The header field name", + "type": "string" + }, + "value": { + "description": "The header field value", + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "path": { + "description": "Path to access on the HTTP server.", + "type": "string" + }, + "port": { + "description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.", + "type": "integer", + "format": "int32" + }, + "scheme": { + "description": "Scheme to use for connecting to the host. Defaults to HTTP.", + "enum": [ + "HTTP", + "HTTPS" + ], + "type": "string", + "x-ms-enum": { + "name": "Scheme", + "modelAsString": true + } + } + } + }, + "initialDelaySeconds": { + "description": "Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.", + "type": "integer", + "format": "int32" + }, + "tcpSocket": { + "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.", + "type": "object", + "required": [ + "port" + ], + "properties": { + "host": { + "description": "Optional: Host name to connect to, defaults to the pod IP.", + "type": "string" + }, + "port": { + "description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.", + "type": "integer", + "format": "int32" + } + } + }, + "terminationGracePeriodSeconds": { + "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)", + "type": "integer", + "format": "int64" + }, + "timeoutSeconds": { + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.", + "type": "integer", + "format": "int32" + }, + "type": { + "description": "The type of probe.", + "enum": [ + "Liveness", + "Readiness", + "Startup" + ], + "type": "string", + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + } + } + }, + "ContainerRegistryWithCustomImage": { + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it." + }, + "image": { + "type": "string", + "description": "Full name that the final image should be uploaded as, including both image name and tag." + } + }, + "description": "Container registry that the final image will be uploaded to.", + "required": [ + "server" + ] + }, + "CustomScaleRule": { + "description": "Container App container Custom scaling rule.", + "type": "object", + "properties": { + "type": { + "description": "Type of the custom scale rule\neg: azure-servicebus, redis etc.", + "type": "string" + }, + "metadata": { + "description": "Metadata properties to describe custom scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the custom scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "CustomDomainConfiguration": { + "type": "object", + "description": "Configuration properties for apps environment custom domain", + "properties": { + "customDomainVerificationId": { + "description": "Id used to verify domain name ownership", + "type": "string", + "readOnly": true + }, + "dnsSuffix": { + "type": "string", + "description": "Dns suffix for the environment domain", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "certificateKeyVaultProperties": { + "description": "Certificate stored in Azure Key Vault.", + "$ref": "#/definitions/CertificateKeyVaultProperties" + }, + "certificateValue": { + "format": "byte", + "description": "PFX or PEM blob", + "type": "string", + "x-ms-secret": true + }, + "certificatePassword": { + "description": "Certificate password", + "type": "string", + "x-ms-secret": true + }, + "expirationDate": { + "format": "date-time", + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + }, + "subjectName": { + "description": "Subject name of the certificate.", + "type": "string", + "readOnly": true + } + } + }, + "DefaultErrorResponse": { + "description": "App Service error response.", + "type": "object", + "properties": { + "error": { + "description": "Error model.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "details": { + "type": "array", + "description": "Details or the error", + "items": { + "description": "Detailed errors.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "x-ms-identifiers": [ + "code" + ] + }, + "innererror": { + "description": "More information to debug error.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + } + } + }, + "HttpGet": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "URL to make HTTP GET request against." + }, + "fileName": { + "type": "string", + "description": "Name of the file that the request should be saved to." + }, + "headers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of headers to send with the request." + } + }, + "description": "Model representing a http get request.", + "required": [ + "url" + ] + }, + "HttpScaleRule": { + "description": "Container App container Http scaling rule.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata properties to describe http scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the custom scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "PreBuildStep": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the pre-build step." + }, + "scripts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of custom commands to run." + }, + "httpGet": { + "$ref": "./CommonDefinitions.json#/definitions/HttpGet", + "description": "Http get request to send before the build.", + "x-ms-identifiers": [] + } + }, + "description": "Model representing a pre-build step." + }, + "TcpScaleRule": { + "description": "Container App container Tcp scaling rule.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata properties to describe tcp scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the tcp scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "QueueScaleRule": { + "description": "Container App container Azure Queue based scaling rule.", + "type": "object", + "properties": { + "accountName": { + "description": "Storage account name. required if using managed identity to authenticate", + "type": "string" + }, + "queueName": { + "description": "Queue name.", + "type": "string" + }, + "queueLength": { + "format": "int32", + "description": "Queue length.", + "type": "integer" + }, + "auth": { + "description": "Authentication secrets for the queue scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "Scale": { + "description": "Container App scaling configurations.", + "type": "object", + "properties": { + "minReplicas": { + "format": "int32", + "description": "Optional. Minimum number of container replicas.", + "type": "integer" + }, + "maxReplicas": { + "format": "int32", + "description": "Optional. Maximum number of container replicas. Defaults to 10 if not set.", + "type": "integer", + "default": 10 + }, + "rules": { + "description": "Scaling rules.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ScaleRule": { + "description": "Container App container scaling rule.", + "type": "object", + "properties": { + "name": { + "description": "Scale Rule Name", + "type": "string" + }, + "azureQueue": { + "$ref": "#/definitions/QueueScaleRule", + "description": "Azure Queue based scaling." + }, + "custom": { + "$ref": "#/definitions/CustomScaleRule", + "description": "Custom scale rule." + }, + "http": { + "$ref": "#/definitions/HttpScaleRule", + "description": "HTTP requests based scaling." + }, + "tcp": { + "$ref": "#/definitions/TcpScaleRule", + "description": "Tcp requests based scaling." + } + } + }, + "ScaleRuleAuth": { + "description": "Auth Secrets for Scale Rule", + "type": "object", + "properties": { + "secretRef": { + "description": "Name of the secret from which to pull the auth params.", + "type": "string" + }, + "triggerParameter": { + "description": "Trigger Parameter that uses the secret", + "type": "string" + } + } + }, + "Secret": { + "description": "Secret definition.", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string" + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "identity": { + "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.", + "type": "string" + }, + "keyVaultUrl": { + "description": "Azure Key Vault URL pointing to the secret referenced by the container app.", + "type": "string" + } + } + }, + "Template": { + "description": "Container App versioned application definition.\nDefines the desired state of an immutable revision.\nAny changes to this section Will result in a new revision being created", + "type": "object", + "properties": { + "revisionSuffix": { + "description": "User friendly suffix that is appended to the revision name", + "type": "string" + }, + "terminationGracePeriodSeconds": { + "description": "Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.", + "format": "int64", + "type": "integer" + }, + "initContainers": { + "description": "List of specialized containers that run before app containers.", + "type": "array", + "items": { + "$ref": "#/definitions/InitContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "containers": { + "description": "List of container definitions for the Container App.", + "type": "array", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "scale": { + "$ref": "#/definitions/Scale", + "description": "Scaling properties for the Container App." + }, + "volumes": { + "description": "List of volume definitions for the Container App.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "serviceBinds": { + "description": "List of container app services bound to the app", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceBind" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Volume": { + "description": "Volume definitions for the Container App.", + "type": "object", + "properties": { + "name": { + "description": "Volume name.", + "type": "string" + }, + "storageType": { + "description": "Storage type for the volume. If not provided, use EmptyDir.", + "enum": [ + "AzureFile", + "EmptyDir", + "Secret", + "NfsAzureFile", + "Smb" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageName": { + "description": "Name of storage resource. No need to provide for EmptyDir and Secret.", + "type": "string" + }, + "secrets": { + "description": "List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.", + "type": "array", + "items": { + "$ref": "#/definitions/SecretVolumeItem" + }, + "x-ms-identifiers": [ + "secretRef" + ] + }, + "mountOptions": { + "description": "Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string.", + "type": "string" + } + } + }, + "SecretVolumeItem": { + "description": "Secret to be added to volume.", + "type": "object", + "properties": { + "secretRef": { + "description": "Name of the Container App secret from which to pull the secret value.", + "type": "string" + }, + "path": { + "description": "Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.", + "type": "string" + } + } + }, + "VolumeMount": { + "description": "Volume mount for the Container App.", + "type": "object", + "properties": { + "volumeName": { + "description": "This must match the Name of a Volume.", + "type": "string" + }, + "mountPath": { + "description": "Path within the container at which the volume should be mounted.Must not contain ':'.", + "type": "string" + }, + "subPath": { + "description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).", + "type": "string" + } + } + }, + "DaprComponentsCollection": { + "description": "Dapr Components ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DaprComponent" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DaprComponent": { + "description": "Dapr Component.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Dapr Component resource specific properties", + "type": "object", + "properties": { + "componentType": { + "description": "Component type", + "type": "string" + }, + "version": { + "description": "Component version", + "type": "string" + }, + "ignoreErrors": { + "description": "Boolean describing if the component errors are ignores", + "type": "boolean", + "default": false + }, + "initTimeout": { + "description": "Initialization timeout", + "type": "string" + }, + "secrets": { + "description": "Collection of secrets used by a Dapr component", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "secretStoreComponent": { + "description": "Name of a Dapr component to retrieve component secrets from", + "type": "string" + }, + "metadata": { + "description": "Component metadata", + "type": "array", + "items": { + "$ref": "#/definitions/DaprMetadata" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "scopes": { + "description": "Names of container apps that can use this Dapr component", + "type": "array", + "items": { + "type": "string" + } + }, + "serviceComponentBind": { + "description": "List of container app services that are bound to the Dapr component", + "type": "array", + "items": { + "$ref": "#/definitions/DaprComponentServiceBinding" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "DaprMetadata": { + "description": "Dapr component metadata.", + "type": "object", + "properties": { + "name": { + "description": "Metadata property name.", + "type": "string" + }, + "value": { + "description": "Metadata property value.", + "type": "string" + }, + "secretRef": { + "description": "Name of the Dapr Component secret from which to pull the metadata property value.", + "type": "string" + } + } + }, + "DaprComponentServiceBinding": { + "description": "Configuration to bind a Dapr Component to a dev ContainerApp Service", + "type": "object", + "properties": { + "name": { + "description": "Name of the service bind", + "type": "string" + }, + "serviceId": { + "description": "Resource id of the target service", + "type": "string" + }, + "metadata": { + "description": "Service bind metadata", + "type": "array", + "$ref": "#/definitions/DaprServiceBindMetadata" + } + } + }, + "DaprServiceBindMetadata": { + "description": "Dapr component metadata.", + "type": "object", + "properties": { + "name": { + "description": "Service bind metadata property name.", + "type": "string" + }, + "value": { + "description": "Service bind metadata property value.", + "type": "string" + } + } + }, + "DaprSecretsCollection": { + "description": "Dapr component Secrets Collection for ListSecrets Action.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of secrets used by a Dapr component", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSecret" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DaprSecret": { + "description": "Dapr component Secret for ListSecrets Action", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-secret": true, + "readOnly": true + } + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "DaprComponentResiliencyPoliciesCollection": { + "description": "Dapr Component Resiliency Policies ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DaprComponentResiliencyPolicy" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DaprComponentResiliencyPolicy": { + "description": "Dapr Component Resiliency Policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Dapr Component Resiliency Policy resource specific properties", + "type": "object", + "properties": { + "inboundPolicy": { + "description": "The optional inbound component resiliency policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyConfiguration" + }, + "outboundPolicy": { + "description": "The optional outbound component resiliency policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyConfiguration" + } + }, + "x-ms-client-flatten": true + } + } + }, + "DaprComponentResiliencyPolicyConfiguration": { + "description": "Dapr Component Resiliency Policy Configuration.", + "type": "object", + "properties": { + "httpRetryPolicy": { + "description": "The optional HTTP retry policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration" + }, + "timeoutPolicy": { + "description": "The optional timeout policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyTimeoutPolicyConfiguration" + }, + "circuitBreakerPolicy": { + "description": "The optional circuit breaker policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration" + } + }, + "additionalProperties": false + }, + "DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration": { + "description": "Dapr Component Resiliency Policy Circuit Breaker Policy Configuration.", + "type": "object", + "properties": { + "consecutiveErrors": { + "description": "The number of consecutive errors before the circuit is opened.", + "type": "integer", + "format": "int32" + }, + "timeoutInSeconds": { + "description": "The interval in seconds until a retry attempt is made after the circuit is opened.", + "type": "integer", + "format": "int32" + }, + "intervalInSeconds": { + "description": "The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeoutInSeconds value will be used.", + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration": { + "description": "Dapr Component Resiliency Policy HTTP Retry Policy Configuration.", + "type": "object", + "properties": { + "maxRetries": { + "description": "The optional maximum number of retries", + "type": "integer", + "format": "int32" + }, + "retryBackOff": { + "description": "The optional retry backoff configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration" + } + }, + "additionalProperties": false + }, + "DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration": { + "description": "Dapr Component Resiliency Policy HTTP Retry Backoff Configuration.", + "type": "object", + "properties": { + "initialDelayInMilliseconds": { + "description": "The optional initial delay in milliseconds before an operation is retried", + "type": "integer", + "format": "int32" + }, + "maxIntervalInMilliseconds": { + "description": "The optional maximum time interval in milliseconds between retry attempts", + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "DaprComponentResiliencyPolicyTimeoutPolicyConfiguration": { + "description": "Dapr Component Resiliency Policy Timeout Policy Configuration.", + "type": "object", + "properties": { + "responseTimeoutInSeconds": { + "description": "The optional response timeout in seconds", + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "DaprSubscriptionsCollection": { + "description": "Dapr Subscriptions ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DaprSubscription" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DaprSubscription": { + "description": "Dapr PubSub Event Subscription.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Dapr PubSub Event Subscription resource specific properties", + "type": "object", + "properties": { + "pubsubName": { + "description": "Dapr PubSub component name", + "type": "string" + }, + "topic": { + "description": "Topic name", + "type": "string" + }, + "deadLetterTopic": { + "description": "Deadletter topic name", + "type": "string" + }, + "routes": { + "description": "Subscription routes", + "$ref": "#/definitions/DaprSubscriptionRoutes" + }, + "scopes": { + "description": "Application scopes to restrict the subscription to specific apps.", + "type": "array", + "items": { + "type": "string" + } + }, + "metadata": { + "description": "Subscription metadata", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "bulkSubscribe": { + "description": "Bulk subscription options", + "$ref": "#/definitions/DaprSubscriptionBulkSubscribeOptions" + } + }, + "x-ms-client-flatten": true + } + } + }, + "DaprSubscriptionBulkSubscribeOptions": { + "description": "Dapr PubSub Bulk Subscription Options.", + "type": "object", + "properties": { + "enabled": { + "description": "Enable bulk subscription", + "type": "boolean", + "default": false + }, + "maxMessagesCount": { + "description": "Maximum number of messages to deliver in a bulk message.", + "type": "integer", + "format": "int32" + }, + "maxAwaitDurationMs": { + "description": "Maximum duration in milliseconds to wait before a bulk message is sent to the app.", + "type": "integer", + "format": "int32" + } + } + }, + "DaprSubscriptionRoutes": { + "description": "Dapr PubSub Event Subscription Routes configuration.", + "type": "object", + "properties": { + "rules": { + "description": "The list of Dapr PubSub Event Subscription Route Rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DaprSubscriptionRouteRule" + }, + "x-ms-identifiers": [] + }, + "default": { + "description": "The default path to deliver events that do not match any of the rules.", + "type": "string" + } + }, + "additionalProperties": false + }, + "DaprSubscriptionRouteRule": { + "description": "Dapr Pubsub Event Subscription Route Rule is used to specify the condition for sending a message to a specific path.", + "type": "object", + "properties": { + "match": { + "description": "The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default. The rules are tested in the order specified, so they should be define from most-to-least specific. The default route should appear last in the list.", + "type": "string" + }, + "path": { + "description": "The path for events that match this rule", + "type": "string" + } + } + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "AzureFileProperties": { + "description": "Azure File Properties.", + "type": "object", + "properties": { + "accountName": { + "description": "Storage account name for azure file.", + "type": "string" + }, + "accountKey": { + "description": "Storage account key for azure file.", + "type": "string", + "x-ms-secret": true + }, + "accessMode": { + "description": "Access mode for storage", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true + } + }, + "shareName": { + "description": "Azure file share name.", + "type": "string" + } + } + }, + "NfsAzureFileProperties": { + "description": "NFS Azure File Properties.", + "type": "object", + "properties": { + "server": { + "description": "Server for NFS azure file.", + "type": "string" + }, + "accessMode": { + "description": "Access mode for storage", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true + } + }, + "shareName": { + "description": "NFS Azure file share name.", + "type": "string" + } + } + }, + "SmbStorage": { + "description": "SMB storage properties", + "type": "object", + "properties": { + "host": { + "description": "The host name or IP address of the SMB server.", + "type": "string" + }, + "shareName": { + "description": "The path to the SMB shared folder.", + "type": "string" + }, + "username": { + "description": "The user to log on to the SMB server.", + "type": "string" + }, + "domain": { + "description": "The domain name for the user.", + "type": "string" + }, + "password": { + "description": "The password for the user.", + "type": "string", + "x-ms-secret": true + }, + "accessMode": { + "description": "Access mode for storage", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true + } + } + } + }, + "CertificateKeyVaultProperties": { + "description": "Properties for a certificate stored in a Key Vault.", + "type": "object", + "properties": { + "identity": { + "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.", + "type": "string" + }, + "keyVaultUrl": { + "description": "URL pointing to the Azure Key Vault secret that holds the certificate.", + "type": "string" + } + } + }, + "Certificate": { + "description": "Certificate used for Custom Domain bindings of Container Apps in a Managed Environment", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Certificate resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the certificate.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "DeleteFailed", + "Pending" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": true + } + }, + "certificateKeyVaultProperties": { + "description": "Properties for a certificate stored in a Key Vault.", + "$ref": "#/definitions/CertificateKeyVaultProperties" + }, + "password": { + "description": "Certificate password.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "subjectName": { + "description": "Subject name of the certificate.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "Subject alternative names the certificate applies to.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "value": { + "format": "byte", + "description": "PFX or PEM blob", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "issuer": { + "description": "Certificate issuer.", + "type": "string", + "readOnly": true + }, + "issueDate": { + "format": "date-time", + "description": "Certificate issue Date.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "format": "date-time", + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + }, + "valid": { + "description": "Is the certificate valid?.", + "type": "boolean", + "readOnly": true + }, + "publicKeyHash": { + "description": "Public key hash.", + "type": "string", + "readOnly": true + }, + "certificateType": { + "description": "The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA`", + "type": "string", + "enum": [ + "ServerSSLCertificate", + "ImagePullTrustedCA" + ], + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true + } + } + } + } + }, + "x-ms-client-flatten": true + }, + "CertificateCollection": { + "description": "Collection of Certificates.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CertificatePatch": { + "description": "A certificate to update", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + } + }, + "ManagedCertificate": { + "description": "Managed certificates used for Custom Domain bindings of Container Apps in a Managed Environment", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Certificate resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the certificate.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "DeleteFailed", + "Pending" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": true + } + }, + "subjectName": { + "description": "Subject name of the certificate.", + "type": "string" + }, + "error": { + "description": "Any error occurred during the certificate provision.", + "type": "string", + "readOnly": true + }, + "domainControlValidation": { + "description": "Selected type of domain control validation for managed certificates.", + "enum": [ + "CNAME", + "HTTP", + "TXT" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedCertificateDomainControlValidation", + "modelAsString": true + } + }, + "validationToken": { + "description": "A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates.", + "type": "string", + "readOnly": true + } + } + } + }, + "x-ms-client-flatten": true + }, + "ManagedCertificatePatch": { + "description": "A managed certificate to update", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + } + }, + "ManagedCertificateCollection": { + "description": "Collection of Managed Certificates.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCertificate" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "JobTemplate": { + "description": "Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created", + "type": "object", + "properties": { + "initContainers": { + "description": "List of specialized containers that run before app containers.", + "type": "array", + "items": { + "$ref": "#/definitions/InitContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "containers": { + "description": "List of container definitions for the Container App.", + "type": "array", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "volumes": { + "description": "List of volume definitions for the Container App.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ServiceBind": { + "description": "Configuration to bind a ContainerApp to a dev ContainerApp Service", + "type": "object", + "properties": { + "serviceId": { + "description": "Resource id of the target service", + "type": "string" + }, + "name": { + "description": "Name of the service bind", + "type": "string" + }, + "clientType": { + "description": "Type of the client to be used to connect to the service", + "type": "string" + }, + "customizedKeys": { + "description": "Customized keys for customizing injected values to the app", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AppResiliencyCollection": { + "description": "Collection of AppResiliency policies", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AppResiliency" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "AppResiliency": { + "description": "Configuration to setup App Resiliency", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "type": "object", + "description": "App Resiliency resource specific properties", + "properties": { + "timeoutPolicy": { + "description": "Policy to set request timeouts", + "$ref": "#/definitions/TimeoutPolicy" + }, + "httpRetryPolicy": { + "description": "Policy that defines http request retry conditions", + "$ref": "#/definitions/HttpRetryPolicy" + }, + "tcpRetryPolicy": { + "description": "Policy that defines tcp request retry conditions", + "$ref": "#/definitions/TcpRetryPolicy" + }, + "circuitBreakerPolicy": { + "description": "Policy that defines circuit breaker conditions", + "$ref": "#/definitions/CircuitBreakerPolicy" + }, + "httpConnectionPool": { + "description": "Defines parameters for http connection pooling", + "$ref": "#/definitions/HttpConnectionPool" + }, + "tcpConnectionPool": { + "description": "Defines parameters for tcp connection pooling", + "$ref": "#/definitions/TcpConnectionPool" + } + }, + "x-ms-client-flatten": true + } + } + }, + "TimeoutPolicy": { + "description": "Policy to set request timeouts", + "type": "object", + "properties": { + "responseTimeoutInSeconds": { + "description": "Timeout, in seconds, for a request to respond", + "format": "int32", + "type": "integer" + }, + "connectionTimeoutInSeconds": { + "description": "Timeout, in seconds, for a request to initiate a connection", + "format": "int32", + "type": "integer" + } + } + }, + "HttpRetryPolicy": { + "description": "Policy that defines http request retry conditions", + "type": "object", + "properties": { + "maxRetries": { + "description": "Maximum number of times a request will retry", + "format": "int32", + "type": "integer" + }, + "retryBackOff": { + "description": "Settings for retry backoff characteristics", + "type": "object", + "properties": { + "initialDelayInMilliseconds": { + "description": "Initial delay, in milliseconds, before retrying a request", + "format": "int64", + "type": "integer" + }, + "maxIntervalInMilliseconds": { + "description": "Maximum interval, in milliseconds, between retries", + "format": "int64", + "type": "integer" + } + }, + "x-ms-client-flatten": true + }, + "matches": { + "description": "Conditions that must be met for a request to be retried", + "type": "object", + "properties": { + "headers": { + "description": "Headers that must be present for a request to be retried", + "type": "array", + "items": { + "$ref": "#/definitions/HeaderMatch" + }, + "x-ms-identifiers": [ + "header" + ] + }, + "httpStatusCodes": { + "description": "Additional http status codes that can trigger a retry", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "x-ms-identifiers": [] + }, + "errors": { + "description": "Errors that can trigger a retry", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-client-flatten": true + } + }, + "x-ms-client-flatten": true + }, + "TcpRetryPolicy": { + "description": "Policy that defines tcp request retry conditions", + "type": "object", + "properties": { + "maxConnectAttempts": { + "description": "Maximum number of attempts to connect to the tcp service", + "format": "int32", + "type": "integer" + } + } + }, + "CircuitBreakerPolicy": { + "description": "Policy that defines circuit breaker conditions", + "type": "object", + "properties": { + "consecutiveErrors": { + "description": "Number of consecutive errors before the circuit breaker opens", + "format": "int32", + "type": "integer" + }, + "intervalInSeconds": { + "description": "The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s.", + "format": "int32", + "type": "integer" + }, + "maxEjectionPercent": { + "description": "Maximum percentage of hosts that will be ejected after failure threshold has been met", + "format": "int32", + "type": "integer" + } + } + }, + "HttpConnectionPool": { + "description": "Defines parameters for http connection pooling", + "type": "object", + "properties": { + "http1MaxPendingRequests": { + "description": "Maximum number of pending http1 requests allowed", + "format": "int32", + "type": "integer" + }, + "http2MaxRequests": { + "description": "Maximum number of http2 requests allowed", + "format": "int32", + "type": "integer" + } + } + }, + "TcpConnectionPool": { + "description": "Defines parameters for tcp connection pooling", + "type": "object", + "properties": { + "maxConnections": { + "description": "Maximum number of tcp connections allowed", + "format": "int32", + "type": "integer" + } + } + }, + "HeaderMatch": { + "description": "Conditions required to match a header", + "type": "object", + "properties": { + "header": { + "description": "Name of the header", + "type": "string" + }, + "match": { + "description": "Type of match to perform", + "type": "object", + "properties": { + "exactMatch": { + "description": "Exact value of the header", + "type": "string" + }, + "prefixMatch": { + "description": "Prefix value of the header", + "type": "string" + }, + "suffixMatch": { + "description": "Suffix value of the header", + "type": "string" + }, + "regexMatch": { + "description": "Regex value of the header", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "EnvironmentVariable": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Environment variable name." + }, + "value": { + "type": "string", + "description": "Environment variable value." + } + }, + "description": "Model representing an environment variable.", + "required": [ + "name", + "value" + ] + }, + "PrivateEndpoint": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "groupIds": { + "description": "The group ids for the private endpoint resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the private endpoint connection." + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Waiting", + "Updating", + "Deleting", + "Pending" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "List of private endpoint connection associated with the specified resource" + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "A list of private link resources" + }, + "IdentitySettings": { + "description": "Optional settings for a Managed Identity that is assigned to the Container App.", + "type": "object", + "required": [ + "identity" + ], + "properties": { + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + }, + "lifecycle": { + "description": "Use to select the lifecycle stages of a Container App during which the Managed Identity should be available.", + "enum": [ + "Init", + "Main", + "None", + "All" + ], + "type": "string", + "default": "All", + "x-ms-enum": { + "name": "IdentitySettingsLifeCycle", + "modelAsString": true + } + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json new file mode 100644 index 000000000000..1cf75ddbcaff --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json @@ -0,0 +1,469 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/connectedEnvironments": { + "get": { + "tags": [ + "ConnectedEnvironments" + ], + "summary": "Get all connectedEnvironments for a subscription.", + "description": "Get all connectedEnvironments for a subscription.", + "operationId": "ConnectedEnvironments_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List connected environments by subscription": { + "$ref": "./examples/ConnectedEnvironments_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments": { + "get": { + "tags": [ + "ConnectedEnvironments" + ], + "operationId": "ConnectedEnvironments_ListByResourceGroup", + "description": "Get all connectedEnvironments in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List environments by resource group": { + "$ref": "./examples/ConnectedEnvironments_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}": { + "get": { + "tags": [ + "ConnectedEnvironments" + ], + "operationId": "ConnectedEnvironments_Get", + "description": "Get the properties of an connectedEnvironment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connectedEnvironment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get connected environment by connectedEnvironmentName": { + "$ref": "./examples/ConnectedEnvironments_Get.json" + } + } + }, + "put": { + "tags": [ + "ConnectedEnvironments" + ], + "description": "Creates or updates an connectedEnvironment.", + "operationId": "ConnectedEnvironments_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connectedEnvironment.", + "required": true, + "type": "string" + }, + { + "name": "environmentEnvelope", + "in": "body", + "description": "Configuration details of the connectedEnvironment.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create kube environments": { + "$ref": "./examples/ConnectedEnvironments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ConnectedEnvironments" + ], + "summary": "Delete an connectedEnvironment.", + "description": "Delete an connectedEnvironment.", + "operationId": "ConnectedEnvironments_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connectedEnvironment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "202": { + "description": "Delete operation is accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "ConnectedEnvironment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete connected environment by connectedEnvironmentName": { + "$ref": "./examples/ConnectedEnvironments_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ConnectedEnvironments" + ], + "summary": "Update connected Environment's properties.", + "description": "Patches a Managed Environment. Only patching of tags is supported currently", + "operationId": "ConnectedEnvironments_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connectedEnvironment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Managed Environment": { + "$ref": "./examples/ConnectedEnvironments_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/checkNameAvailability": { + "post": { + "tags": [ + "ConnectedEnvironments" + ], + "summary": "Checks the resource connectedEnvironmentName availability.", + "description": "Checks if resource connectedEnvironmentName is available.", + "operationId": "ConnectedEnvironments_CheckNameAvailability", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "checkNameAvailabilityRequest", + "in": "body", + "description": "The check connectedEnvironmentName availability request.", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_CheckNameAvailability": { + "$ref": "./examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json" + } + } + } + } + }, + "definitions": { + "ConnectedEnvironment": { + "description": "An environment for Kubernetes cluster specialized for web workloads by Azure App Service", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./CommonDefinitions.json#/definitions/ExtendedLocation" + }, + "properties": { + "description": "ConnectedEnvironment resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Kubernetes Environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Waiting", + "InitializationInProgress", + "InfrastructureSetupInProgress", + "InfrastructureSetupComplete", + "ScheduledForDelete" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConnectedEnvironmentProvisioningState", + "modelAsString": true + } + }, + "deploymentErrors": { + "description": "Any errors that occurred during deployment or deployment validation", + "type": "string", + "readOnly": true + }, + "defaultDomain": { + "description": "Default Domain Name for the cluster", + "type": "string", + "readOnly": true + }, + "staticIp": { + "description": "Static IP of the connectedEnvironment", + "type": "string" + }, + "daprAIConnectionString": { + "type": "string", + "description": "Application Insights connection string used by Dapr to export Service to Service communication telemetry", + "x-ms-secret": true + }, + "customDomainConfiguration": { + "$ref": "./CommonDefinitions.json#/definitions/CustomDomainConfiguration", + "description": "Custom domain configuration for the environment" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ConnectedEnvironmentCollection": { + "description": "Collection of connectedEnvironments", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsCertificates.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsCertificates.json new file mode 100644 index 000000000000..95e1ca51cd54 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsCertificates.json @@ -0,0 +1,315 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates": { + "get": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Get the Certificates in a given connected environment.", + "operationId": "ConnectedEnvironmentsCertificates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CertificateCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Certificates by Connected Environment": { + "$ref": "./examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}": { + "get": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Get the specified Certificate.", + "operationId": "ConnectedEnvironmentsCertificates_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Certificate": { + "$ref": "./examples/ConnectedEnvironmentsCertificate_Get.json" + } + } + }, + "put": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Create or Update a Certificate.", + "operationId": "ConnectedEnvironmentsCertificates_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "description": "Certificate to be created or updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Certificate": { + "$ref": "./examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Deletes the specified Certificate.", + "operationId": "ConnectedEnvironmentsCertificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Certificate does not exist" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Certificate": { + "$ref": "./examples/ConnectedEnvironmentsCertificate_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Update properties of a certificate", + "description": "Patches a certificate. Currently only patching of tags is supported", + "operationId": "ConnectedEnvironmentsCertificates_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "required": true, + "description": "Properties of a certificate that need to be updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CertificatePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Certificate updated successfully.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Certificate": { + "$ref": "./examples/ConnectedEnvironmentsCertificates_Patch.json" + } + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsDaprComponents.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsDaprComponents.json new file mode 100644 index 000000000000..c3bc637fc0cf --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsDaprComponents.json @@ -0,0 +1,307 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents": { + "get": { + "tags": [ + "DaprComponents" + ], + "summary": "Get the Dapr Components for a connected environment.", + "operationId": "ConnectedEnvironmentsDaprComponents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Dapr Components": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}": { + "get": { + "tags": [ + "DaprComponents" + ], + "summary": "Get a dapr component.", + "operationId": "ConnectedEnvironmentsDaprComponents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Dapr Component": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_Get.json" + } + } + }, + "put": { + "tags": [ + "DaprComponents" + ], + "summary": "Creates or updates a Dapr Component.", + "description": "Creates or updates a Dapr Component in a connected environment.", + "operationId": "ConnectedEnvironmentsDaprComponents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "name": "daprComponentEnvelope", + "in": "body", + "description": "Configuration details of the Dapr Component.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update dapr component": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "DaprComponents" + ], + "summary": "Delete a Dapr Component.", + "description": "Delete a Dapr Component from a connected environment.", + "operationId": "ConnectedEnvironmentsDaprComponents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Environment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete dapr component": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_Delete.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}/listSecrets": { + "post": { + "tags": [ + "DaprComponents" + ], + "summary": "List secrets for a dapr component", + "operationId": "ConnectedEnvironmentsDaprComponents_ListSecrets", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSecretsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Secrets": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json" + } + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsStorages.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsStorages.json new file mode 100644 index 000000000000..f31ea3860897 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsStorages.json @@ -0,0 +1,294 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages": { + "get": { + "tags": [ + "ConnectedEnvironmentsStorages" + ], + "summary": "Get all storages for a connectedEnvironment.", + "description": "Get all storages for a connectedEnvironment.", + "operationId": "ConnectedEnvironmentsStorages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentStoragesCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List environments storages by subscription": { + "$ref": "./examples/ConnectedEnvironmentsStorages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}": { + "get": { + "tags": [ + "ConnectedEnvironmentsStorages" + ], + "summary": "Get storage for a connectedEnvironment.", + "description": "Get storage for a connectedEnvironment.", + "operationId": "ConnectedEnvironmentsStorages_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentStorage" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "get a environments storage properties by subscription": { + "$ref": "./examples/ConnectedEnvironmentsStorages_Get.json" + } + } + }, + "put": { + "tags": [ + "ConnectedEnvironmentsStorages" + ], + "summary": "Create or update storage for a connectedEnvironment.", + "description": "Create or update storage for a connectedEnvironment.", + "operationId": "ConnectedEnvironmentsStorages_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "name": "storageEnvelope", + "in": "body", + "description": "Configuration details of storage.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentStorage" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentStorage" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update environments storage": { + "$ref": "./examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ConnectedEnvironmentsStorages" + ], + "summary": "Delete storage for a connectedEnvironment.", + "description": "Delete storage for a connectedEnvironment.", + "operationId": "ConnectedEnvironmentsStorages_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "Storage does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List environments storages by subscription": { + "$ref": "./examples/ConnectedEnvironmentsStorages_Delete.json" + } + } + } + } + }, + "definitions": { + "ConnectedEnvironmentStoragesCollection": { + "description": "Collection of Storage for Environments", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of storage resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedEnvironmentStorage" + } + } + } + }, + "ConnectedEnvironmentStorage": { + "description": "Storage resource for connectedEnvironment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Storage properties", + "type": "object", + "properties": { + "azureFile": { + "$ref": "./CommonDefinitions.json#/definitions/AzureFileProperties", + "description": "Azure file properties" + }, + "smb": { + "$ref": "./CommonDefinitions.json#/definitions/SmbStorage", + "description": "SMB storage properties" + } + } + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerApps.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerApps.json new file mode 100644 index 000000000000..4127e12e03a3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerApps.json @@ -0,0 +1,1549 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/containerApps": { + "get": { + "tags": [ + "ContainerApps" + ], + "summary": "Get the Container Apps in a given subscription.", + "operationId": "ContainerApps_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps by subscription": { + "$ref": "./examples/ContainerApps_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps": { + "get": { + "tags": [ + "ContainerApps" + ], + "summary": "Get the Container Apps in a given resource group.", + "operationId": "ContainerApps_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps by resource group": { + "$ref": "./examples/ContainerApps_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}": { + "get": { + "tags": [ + "ContainerApps" + ], + "summary": "Get the properties of a Container App.", + "operationId": "ContainerApps_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App": { + "$ref": "./examples/ContainerApps_Get.json" + } + } + }, + "put": { + "tags": [ + "ContainerApps" + ], + "summary": "Create or update a Container App.", + "description": "Create or update a Container App.", + "operationId": "ContainerApps_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "containerAppEnvelope", + "in": "body", + "description": "Properties used to create a container app", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "No change performed on the Container App.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "201": { + "description": "Container App create or update has been started.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Container App": { + "$ref": "./examples/ContainerApps_CreateOrUpdate.json" + }, + "Create or Update Tcp App": { + "$ref": "./examples/ContainerApps_TcpApp_CreateOrUpdate.json" + }, + "Create or Update ManagedBy App": { + "$ref": "./examples/ContainerApps_ManagedBy_CreateOrUpdate.json" + }, + "Create or Update App Kind": { + "$ref": "./examples/ContainerApps_Kind_CreateOrUpdate.json" + }, + "Create or Update App On A Connected Environment": { + "$ref": "./examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json" + }, + "Create or Update SourceToCloud App": { + "$ref": "./examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "ContainerApps" + ], + "summary": "Delete a Container App.", + "description": "Delete a Container App.", + "operationId": "ContainerApps_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App deleted successfully." + }, + "202": { + "description": "Delete operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Container App does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Container App": { + "$ref": "./examples/ContainerApps_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "ContainerApps" + ], + "summary": "Update properties of a Container App", + "description": "Patches a Container App using JSON Merge Patch", + "operationId": "ContainerApps_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "containerAppEnvelope", + "in": "body", + "required": true, + "description": "Properties of a Container App that need to be updated", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "202": { + "description": "Patch operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Container App": { + "$ref": "./examples/ContainerApps_Patch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listCustomHostNameAnalysis": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "Analyzes a custom hostname for a Container App", + "operationId": "ContainerApps_ListCustomHostNameAnalysis", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "customHostname", + "in": "query", + "description": "Custom hostname.", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomHostnameAnalysisResult" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze Custom Hostname": { + "$ref": "./examples/ContainerApps_ListCustomHostNameAnalysis.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listSecrets": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "List secrets for a container app", + "operationId": "ContainerApps_ListSecrets", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Secrets": { + "$ref": "./examples/ContainerApps_ListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/getAuthtoken": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "Get auth token for a container app", + "operationId": "ContainerApps_GetAuthToken", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppAuthToken" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App Auth Token": { + "$ref": "./examples/ContainerApps_GetAuthToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/start": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "Start a container app", + "operationId": "ContainerApps_Start", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + } + ], + "responses": { + "200": { + "description": "Container App started successfully.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "202": { + "description": "Start operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Start Container App": { + "$ref": "./examples/ContainerApps_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/stop": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "Stop a container app", + "operationId": "ContainerApps_Stop", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + } + ], + "responses": { + "200": { + "description": "Container App stopped successfully.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "202": { + "description": "Stop operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop Container App": { + "$ref": "./examples/ContainerApps_Stop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Configuration": { + "description": "Non versioned Container App configuration properties that define the mutable settings of a Container app", + "type": "object", + "properties": { + "secrets": { + "description": "Collection of secrets used by a Container app", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "activeRevisionsMode": { + "description": "ActiveRevisionsMode controls how active revisions are handled for the Container app:\nMultiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.", + "enum": [ + "Multiple", + "Single" + ], + "type": "string", + "default": "Single", + "x-ms-enum": { + "name": "ActiveRevisionsMode", + "modelAsString": true + } + }, + "ingress": { + "$ref": "#/definitions/Ingress", + "description": "Ingress configurations." + }, + "registries": { + "description": "Collection of private container registry credentials for containers used by the Container app", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryCredentials" + }, + "x-ms-identifiers": [ + "server" + ] + }, + "dapr": { + "$ref": "#/definitions/Dapr", + "description": "Dapr configuration for the Container App." + }, + "runtime": { + "$ref": "#/definitions/Runtime", + "description": "App runtime configuration for the Container App." + }, + "maxInactiveRevisions": { + "format": "int32", + "description": "Optional. Max inactive revisions a Container App can have.", + "type": "integer" + }, + "service": { + "$ref": "#/definitions/Service", + "description": "Container App to be a dev Container App Service" + }, + "identitySettings": { + "description": "Optional settings for Managed Identities that are assigned to the Container App. If a Managed Identity is not specified here, default settings will be used.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/IdentitySettings" + }, + "x-ms-identifiers": [ + "identity" + ] + } + } + }, + "ContainerApp": { + "description": "Container App.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./CommonDefinitions.json#/definitions/ExtendedLocation" + }, + "identity": { + "description": "managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "managedBy": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "kind": { + "type": "string", + "enum": [ + "workflowapp" + ], + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-enum": { + "name": "kind", + "modelAsString": true + }, + "description": "Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value." + }, + "properties": { + "description": "ContainerApp resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Container App.", + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerAppProvisioningState", + "modelAsString": true + } + }, + "managedEnvironmentId": { + "description": "Deprecated. Resource ID of the Container App's environment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentId": { + "description": "Resource ID of environment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "workloadProfileName": { + "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileName", + "description": "Workload profile name to pin for container app execution." + }, + "patchingConfiguration": { + "description": "Container App auto patch configuration.", + "type": "object", + "properties": { + "patchingMode": { + "description": "Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching.", + "type": "string", + "enum": [ + "Automatic", + "Manual", + "Disabled" + ], + "x-ms-enum": { + "name": "patchingMode", + "modelAsString": true + } + } + } + }, + "latestRevisionName": { + "description": "Name of the latest revision of the Container App.", + "type": "string", + "readOnly": true + }, + "latestReadyRevisionName": { + "description": "Name of the latest ready revision of the Container App.", + "type": "string", + "readOnly": true + }, + "latestRevisionFqdn": { + "description": "Fully Qualified Domain Name of the latest revision of the Container App.", + "type": "string", + "readOnly": true + }, + "customDomainVerificationId": { + "description": "Id used to verify domain name ownership", + "type": "string", + "readOnly": true + }, + "configuration": { + "$ref": "#/definitions/Configuration", + "description": "Non versioned Container App configuration properties." + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/Template", + "description": "Container App versioned application definition." + }, + "outboundIpAddresses": { + "description": "Outbound IP Addresses for container app.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "eventStreamEndpoint": { + "description": "The endpoint of the eventstream of the container app.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "ContainerAppCollection": { + "description": "Container App collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerApp" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "Dapr": { + "description": "Container App Dapr configuration.", + "type": "object", + "properties": { + "enabled": { + "description": "Boolean indicating if the Dapr side car is enabled", + "type": "boolean", + "default": false + }, + "appId": { + "description": "Dapr application identifier", + "type": "string" + }, + "appProtocol": { + "description": "Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http", + "enum": [ + "http", + "grpc" + ], + "type": "string", + "default": "http", + "x-ms-enum": { + "name": "appProtocol", + "modelAsString": true + } + }, + "appPort": { + "format": "int32", + "description": "Tells Dapr which port your application is listening on", + "type": "integer" + }, + "httpReadBufferSize": { + "type": "integer", + "description": "Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.", + "format": "int32" + }, + "httpMaxRequestSize": { + "type": "integer", + "description": "Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB.", + "format": "int32" + }, + "logLevel": { + "description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.", + "enum": [ + "info", + "debug", + "warn", + "error" + ], + "type": "string", + "x-ms-enum": { + "name": "logLevel", + "modelAsString": true + } + }, + "enableApiLogging": { + "description": "Enables API logging for the Dapr sidecar", + "type": "boolean" + } + } + }, + "Runtime": { + "description": "Container App Runtime configuration.", + "type": "object", + "properties": { + "java": { + "description": "Java app configuration", + "type": "object", + "properties": { + "enableMetrics": { + "description": "Enable jmx core metrics for the java app", + "type": "boolean" + }, + "javaAgent": { + "description": "Diagnostic capabilities achieved by java agent", + "type": "object", + "properties": { + "enabled": { + "description": "Enable java agent injection for the java app.", + "type": "boolean" + }, + "logging": { + "description": "Capabilities on the java logging scenario.", + "type": "object", + "properties": { + "loggerSettings": { + "description": "Settings of the logger for the java app.", + "type": "array", + "items": { + "$ref": "#/definitions/LoggerSetting" + }, + "x-ms-identifiers": [ + "logger", + "level" + ] + } + } + } + } + } + } + }, + "dotnet": { + "description": ".NET app configuration", + "type": "object", + "properties": { + "autoConfigureDataProtection": { + "description": "Auto configure the ASP.NET Core Data Protection feature", + "type": "boolean" + } + } + } + } + }, + "LoggerSetting": { + "description": "Logger settings for java workloads.", + "type": "object", + "required": [ + "logger", + "level" + ], + "properties": { + "logger": { + "description": "Logger name.", + "type": "string" + }, + "level": { + "description": "The specified logger's log level.", + "enum": [ + "off", + "error", + "info", + "debug", + "trace", + "warn" + ], + "type": "string", + "x-ms-enum": { + "name": "level", + "modelAsString": true + } + } + } + }, + "Ingress": { + "description": "Container App Ingress configuration.", + "type": "object", + "properties": { + "fqdn": { + "description": "Hostname.", + "type": "string", + "readOnly": true + }, + "external": { + "description": "Bool indicating if app exposes an external http endpoint", + "default": false, + "type": "boolean" + }, + "targetPort": { + "format": "int32", + "description": "Target Port in containers for traffic from ingress", + "type": "integer" + }, + "exposedPort": { + "format": "int32", + "description": "Exposed Port in containers for TCP traffic from ingress", + "type": "integer" + }, + "transport": { + "description": "Ingress transport protocol", + "enum": [ + "auto", + "http", + "http2", + "tcp" + ], + "type": "string", + "default": "auto", + "x-ms-enum": { + "name": "IngressTransportMethod", + "modelAsString": true + } + }, + "traffic": { + "description": "Traffic weights for app's revisions", + "type": "array", + "items": { + "$ref": "#/definitions/TrafficWeight" + }, + "x-ms-identifiers": [ + "revisionName" + ] + }, + "customDomains": { + "description": "custom domain bindings for Container Apps' hostnames.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "allowInsecure": { + "description": "Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections", + "type": "boolean", + "default": false + }, + "ipSecurityRestrictions": { + "description": "Rules to restrict incoming IP address.", + "type": "array", + "items": { + "$ref": "#/definitions/IpSecurityRestrictionRule" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "stickySessions": { + "description": "Sticky Sessions for Single Revision Mode", + "type": "object", + "properties": { + "affinity": { + "description": "Sticky Session Affinity", + "enum": [ + "sticky", + "none" + ], + "type": "string", + "x-ms-enum": { + "name": "affinity", + "modelAsString": true + } + } + } + }, + "clientCertificateMode": { + "description": "Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate.", + "enum": [ + "ignore", + "accept", + "require" + ], + "type": "string", + "x-ms-enum": { + "name": "IngressClientCertificateMode", + "modelAsString": true + } + }, + "corsPolicy": { + "description": "CORS policy for container app", + "$ref": "#/definitions/CorsPolicy" + }, + "additionalPortMappings": { + "description": "Settings to expose additional ports on container app", + "type": "array", + "items": { + "$ref": "#/definitions/IngressPortMapping" + }, + "x-ms-identifiers": [ + "targetPort" + ] + }, + "targetPortHttpScheme": { + "description": "Whether an http app listens on http or https", + "enum": [ + "http", + "https" + ], + "type": "string", + "x-ms-enum": { + "name": "IngressTargetPortHttpScheme", + "modelAsString": true + } + } + } + }, + "RegistryCredentials": { + "description": "Container App Private Registry", + "type": "object", + "properties": { + "server": { + "description": "Container Registry Server", + "type": "string" + }, + "username": { + "description": "Container Registry Username", + "type": "string" + }, + "passwordSecretRef": { + "description": "The name of the Secret that contains the registry login password", + "type": "string" + }, + "identity": { + "description": "A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'", + "type": "string" + } + } + }, + "SecretsCollection": { + "description": "Container App Secrets Collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAppSecret" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ContainerAppSecret": { + "description": "Container App Secret.", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-secret": true, + "readOnly": true + }, + "identity": { + "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.", + "type": "string", + "readOnly": true + }, + "keyVaultUrl": { + "description": "Azure Key Vault URL pointing to the secret referenced by the container app.", + "type": "string", + "readOnly": true + } + } + }, + "TrafficWeight": { + "description": "Traffic weight assigned to a revision", + "type": "object", + "properties": { + "revisionName": { + "description": "Name of a revision", + "type": "string" + }, + "weight": { + "format": "int32", + "description": "Traffic weight assigned to a revision", + "type": "integer" + }, + "latestRevision": { + "description": "Indicates that the traffic weight belongs to a latest stable revision", + "default": false, + "type": "boolean" + }, + "label": { + "description": "Associates a traffic label with a revision", + "type": "string" + } + } + }, + "CustomDomain": { + "description": "Custom Domain of a Container App", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Hostname.", + "type": "string" + }, + "bindingType": { + "description": "Custom Domain binding type.", + "enum": [ + "Disabled", + "SniEnabled" + ], + "type": "string", + "x-ms-enum": { + "name": "bindingType", + "modelAsString": true + } + }, + "certificateId": { + "description": "Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.", + "type": "string" + } + } + }, + "IpSecurityRestrictionRule": { + "description": "Rule to restrict incoming IP address.", + "type": "object", + "required": [ + "name", + "ipAddressRange", + "action" + ], + "properties": { + "name": { + "description": "Name for the IP restriction rule.", + "type": "string" + }, + "description": { + "description": "Describe the IP restriction rule that is being sent to the container-app. This is an optional field.", + "type": "string" + }, + "ipAddressRange": { + "description": "CIDR notation to match incoming IP address", + "type": "string" + }, + "action": { + "description": "Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "action", + "modelAsString": true + } + } + } + }, + "CorsPolicy": { + "description": "Cross-Origin-Resource-Sharing policy", + "type": "object", + "required": [ + "allowedOrigins" + ], + "properties": { + "allowedOrigins": { + "description": "Specifies the content for the access-control-allow-origins header", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedMethods": { + "description": "Specifies the content for the access-control-allow-methods header", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedHeaders": { + "description": "Specifies the content for the access-control-allow-headers header", + "type": "array", + "items": { + "type": "string" + } + }, + "exposeHeaders": { + "description": "Specifies the content for the access-control-expose-headers header ", + "type": "array", + "items": { + "type": "string" + } + }, + "maxAge": { + "format": "int32", + "description": "Specifies the content for the access-control-max-age header", + "type": "integer" + }, + "allowCredentials": { + "description": "Specifies whether the resource allows credentials", + "type": "boolean" + } + } + }, + "IngressPortMapping": { + "description": "Port mappings of container app ingress", + "type": "object", + "required": [ + "external", + "targetPort" + ], + "properties": { + "external": { + "description": "Specifies whether the app port is accessible outside of the environment", + "type": "boolean" + }, + "targetPort": { + "format": "int32", + "description": "Specifies the port user's container listens on", + "type": "integer" + }, + "exposedPort": { + "format": "int32", + "description": "Specifies the exposed port for the target port. If not specified, it defaults to target port", + "type": "integer" + } + } + }, + "CustomHostnameAnalysisResult": { + "description": "Custom domain analysis.", + "type": "object", + "properties": { + "hostName": { + "description": "Host name that was analyzed", + "type": "string", + "readOnly": true + }, + "isHostnameAlreadyVerified": { + "description": "true if hostname is already verified; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "customDomainVerificationTest": { + "description": "DNS verification test result.", + "enum": [ + "Passed", + "Failed", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DnsVerificationTestResult", + "modelAsString": false + } + }, + "customDomainVerificationFailureInfo": { + "description": "Raw failure information if DNS verification fails.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "details": { + "type": "array", + "description": "Details or the error", + "items": { + "description": "Detailed errors.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "x-ms-identifiers": [ + "code" + ] + } + }, + "readOnly": true + }, + "hasConflictOnManagedEnvironment": { + "description": "true if there is a conflict on the Container App's managed environment; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "conflictWithEnvironmentCustomDomain": { + "description": "true if there is a conflict on the Container App's managed environment level custom domain; otherwise, false.", + "type": "boolean", + "readOnly": true + }, + "conflictingContainerAppResourceId": { + "description": "Name of the conflicting Container App on the Managed Environment if it's within the same subscription.", + "type": "string", + "readOnly": true + }, + "cNameRecords": { + "description": "CName records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "txtRecords": { + "description": "TXT records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "aRecords": { + "description": "A records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "alternateCNameRecords": { + "description": "Alternate CName records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "alternateTxtRecords": { + "description": "Alternate TXT records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + }, + "ContainerAppAuthToken": { + "description": "Container App Auth Token.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Container App auth token resource specific properties", + "type": "object", + "properties": { + "token": { + "description": "Auth token value.", + "type": "string", + "x-ms-secret": true, + "readOnly": true + }, + "expires": { + "format": "date-time", + "description": "Token expiration date.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "Service": { + "description": "Container App to be a dev service", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Dev ContainerApp service type", + "type": "string" + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsBuilds.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsBuilds.json new file mode 100644 index 000000000000..29ccd1df1772 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsBuilds.json @@ -0,0 +1,348 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-02-02-preview" + }, + "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" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/builds": { + "get": { + "tags": [ + "ContainerAppsBuilds" + ], + "operationId": "ContainerAppsBuildsByContainerApp_List", + "description": "List Container Apps Build resources by Container App", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ContainerAppsBuildCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ContainerAppsBuilds_ListByContainerApp_0": { + "$ref": "./examples/ContainerAppsBuilds_ListByContainerApp.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/builds/{buildName}": { + "get": { + "tags": [ + "ContainerAppsBuilds" + ], + "operationId": "ContainerAppsBuilds_Get", + "description": "Get a Container Apps Build resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsBuildNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ContainerAppsBuildResource" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ContainerAppsBuilds_Get_0": { + "$ref": "./examples/ContainerAppsBuilds_Get.json" + } + } + }, + "delete": { + "tags": [ + "ContainerAppsBuilds" + ], + "operationId": "ContainerAppsBuilds_Delete", + "description": "Delete a Container Apps Build resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsBuildNameParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ContainerAppsBuilds_Delete_0": { + "$ref": "./examples/ContainerAppsBuilds_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ContainerAppsBuildConfiguration": { + "type": "object", + "properties": { + "baseOs": { + "type": "string", + "description": "Base OS used to build and run the app.", + "readOnly": true + }, + "platform": { + "type": "string", + "description": "Platform to be used to build and run the app.", + "readOnly": true + }, + "platformVersion": { + "type": "string", + "description": "Platform version to be used to build and run the app.", + "readOnly": true + }, + "environmentVariables": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of environment variables to be passed to the build, secrets should not be used in environment variable.", + "readOnly": true + }, + "preBuildSteps": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/PreBuildStep" + }, + "x-ms-identifiers": [], + "description": "List of steps to perform before the build.", + "readOnly": true + } + }, + "description": "Configuration of the build." + }, + "ContainerAppsBuildProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/BuildProvisioningState", + "description": "Build provisioning state.", + "readOnly": true + }, + "buildStatus": { + "$ref": "#/definitions/BuildStatus", + "description": "Status of the build once it has been provisioned.", + "readOnly": true + }, + "destinationContainerRegistry": { + "$ref": "./CommonDefinitions.json#/definitions/ContainerRegistryWithCustomImage", + "description": "Container registry that the final image will be uploaded to.", + "readOnly": true + }, + "configuration": { + "$ref": "#/definitions/ContainerAppsBuildConfiguration", + "description": "Configuration of the build.", + "readOnly": true + }, + "logStreamEndpoint": { + "type": "string", + "description": "Endpoint from which the build logs can be streamed.", + "readOnly": true + } + }, + "description": "The ContainerAppBuild properties." + }, + "ContainerAppsBuildResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ContainerAppsBuildProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "description": "Information pertaining to an individual build.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ContainerAppsBuildCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAppsBuildResource" + }, + "description": "The Container Apps Build Resource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "description": "The response of a Container Apps Build Resource list operation.", + "required": [ + "value" + ] + }, + "BuildStatus": { + "type": "string", + "description": "Status of the build once it has been provisioned.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "BuildStatus", + "modelAsString": true + }, + "readOnly": true + }, + "BuildProvisioningState": { + "type": "string", + "description": "Resource instance provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "BuildProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "parameters": { + "ContainerAppsBuildNameParameter": { + "name": "buildName", + "in": "path", + "required": true, + "description": "The name of a build.", + "minLength": 2, + "maxLength": 64, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + }, + "ContainerAppsNameParameter": { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App the Build is associated.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsPatches.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsPatches.json new file mode 100644 index 000000000000..08b9440c444d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsPatches.json @@ -0,0 +1,555 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-02-02-preview" + }, + "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" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches": { + "get": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_ListByContainerApp", + "description": "List Container Apps Patch resources by ContainerApp.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation. For example, $filter=properties/patchApplyStatus eq 'Succeeded'", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PatchCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ContainerAppsPatches_ListByContainerApp_0": { + "$ref": "./examples/ContainerAppsPatches_ListByContainerApp.json" + } + }, + "x-ms-odata": "#/definitions/ContainerAppsContainerAppsPatchResource" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}": { + "get": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_Get", + "description": "Get details for specific Container Apps Patch by patch name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsPatchNameParameter" + } + ], + "responses": { + "200": { + "description": "Patch information retrieved successfully.", + "schema": { + "$ref": "#/definitions/ContainerAppsPatchResource" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ContainerAppsPatches_Get_0": { + "$ref": "./examples/ContainerAppsPatches_Get.json" + } + } + }, + "delete": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_Delete", + "description": "Delete specific Container Apps Patch by patch name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsPatchNameParameter" + } + ], + "responses": { + "202": { + "description": "Patch deletion has been started.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Patch does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerAppsPatches_Delete_0": { + "$ref": "./examples/ContainerAppsPatches_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}/skipConfig": { + "post": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_SkipConfigure", + "description": "Configure the Container Apps Patch skip option by patch name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsPatchNameParameter" + }, + { + "name": "patchSkipConfig", + "in": "body", + "required": true, + "description": "Configure patcher to skip a patch or not.", + "schema": { + "$ref": "#/definitions/PatchSkipConfig" + } + } + ], + "responses": { + "202": { + "description": "Updating patch skipping detail. Updating status tracked by location header.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerAppsPatches_Skip_Configure_0": { + "$ref": "./examples/ContainerAppsPatches_Skip_Configure.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}/apply": { + "post": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_Apply", + "description": "Apply a Container Apps Patch resource with patch name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsPatchNameParameter" + } + ], + "responses": { + "200": { + "description": "Patching operation completed successfully.", + "schema": { + "$ref": "#/definitions/ContainerAppsPatchResource" + } + }, + "202": { + "description": "Patching operation has been started.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerAppsPatches_Apply_0": { + "$ref": "./examples/ContainerAppsPatches_Apply.json" + } + } + } + } + }, + "definitions": { + "ContainerAppsPatchResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PatchProperties", + "description": "Properties that describes current states of the patch resource.", + "x-ms-mutability": [ + "read", + "update" + ] + } + }, + "description": "Container App Patch", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PatchApplyStatus": { + "type": "string", + "description": "The status of the patch once it has been provisioned", + "enum": [ + "NotStarted", + "RebaseInProgress", + "CreatingRevision", + "Succeeded", + "Canceled", + "RebaseFailed", + "RevisionCreationFailed", + "ImagePushPullFailed", + "ManuallySkipped" + ], + "x-ms-enum": { + "name": "PatchApplyStatus", + "modelAsString": true + }, + "readOnly": true + }, + "DetectionStatus": { + "type": "string", + "description": "The status of the patch detection.", + "enum": [ + "Succeeded", + "RegistryLoginFailed", + "Failed" + ], + "x-ms-enum": { + "name": "DetectionStatus", + "modelAsString": true + }, + "readOnly": true + }, + "PatchDetails": { + "description": "The detailed info of patch operation performing when applying a patch.", + "type": "object", + "required": [ + "targetContainerName", + "targetImage", + "lastDetectionTime", + "detectionStatus" + ], + "properties": { + "targetContainerName": { + "type": "string", + "description": "The name of the target container for the patch.", + "readOnly": true + }, + "targetImage": { + "type": "string", + "description": "The name of the target image for the patch.", + "readOnly": true + }, + "lastDetectionTime": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp that describes the latest detection was done.", + "readOnly": true + }, + "detectionStatus": { + "$ref": "#/definitions/DetectionStatus", + "description": "The status of the patch detection.", + "readOnly": true + }, + "newImageName": { + "type": "string", + "description": "The name of the new image created by the patch.", + "readOnly": true + }, + "newLayer": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The details of the new layer for the target image." + }, + "frameworkAndVersion": { + "type": "string", + "description": "The framework and its version in the new run image for the target image." + }, + "osAndVersion": { + "type": "string", + "description": "The OS name and its version in the new run image for the target image." + } + }, + "description": "New layer update details in the target image.", + "readOnly": true + }, + "oldLayer": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The details of the old layer for the target image." + }, + "frameworkAndVersion": { + "type": "string", + "description": "The framework and its version in the old run image for the target image." + }, + "osAndVersion": { + "type": "string", + "description": "The OS name and its version in the old run image for the target image." + } + }, + "description": "The old layer details in the target image.", + "readOnly": true + }, + "patchType": { + "type": "string", + "description": "The type for the patch.", + "enum": [ + "FrameworkSecurity", + "OSSecurity", + "FrameworkAndOSSecurity", + "Other" + ], + "x-ms-enum": { + "name": "PatchType", + "modelAsString": true + }, + "readOnly": true + } + }, + "readOnly": true + }, + "PatchProperties": { + "description": "Top level properties that describes current states of the patch resource", + "type": "object", + "properties": { + "targetEnvironmentId": { + "format": "arm-id", + "type": "string", + "description": "The Azure resource id of the target environment for the patch." + }, + "targetContainerAppId": { + "format": "arm-id", + "type": "string", + "description": "The Azure resource id of the target container app for the patch." + }, + "targetRevisionId": { + "format": "arm-id", + "type": "string", + "description": "The Azure resource id of the target revision for the patch." + }, + "patchApplyStatus": { + "$ref": "#/definitions/PatchApplyStatus", + "description": "The status of the patch operation.", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp that describes when the patch object was created.", + "readOnly": true + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp that describes when the patch object was last updated.", + "readOnly": true + }, + "patchDetails": { + "description": "Detailed info describes the patch operation for the target container app.", + "type": "array", + "items": { + "$ref": "#/definitions/PatchDetails" + }, + "x-ms-identifiers": [], + "readOnly": true + } + }, + "readOnly": true + }, + "PatchCollection": { + "description": "Container App patch collection", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of patch resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAppsPatchResource" + } + }, + "nextLink": { + "description": "the link to the next page of items", + "type": "string", + "format": "uri" + } + } + }, + "PatchSkipConfig": { + "description": "The configuration for patcher to skip a patch or not.", + "type": "object", + "properties": { + "skip": { + "type": "boolean", + "description": "The flag to indicate whether to skip the patch or not." + } + } + } + }, + "parameters": { + "ContainerAppsPatchNameParameter": { + "name": "patchName", + "in": "path", + "required": true, + "description": "The name of the patch", + "minLength": 2, + "maxLength": 64, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + }, + "ContainerAppsNameParameter": { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App the Patch is associated.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsRevisions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsRevisions.json new file mode 100644 index 000000000000..f0340ff91039 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerAppsRevisions.json @@ -0,0 +1,677 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions": { + "get": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Get the Revisions for a given Container App.", + "operationId": "ContainerAppsRevisions_ListRevisions", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App for which Revisions are needed.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RevisionCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container App's revisions": { + "$ref": "./examples/Revisions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Revision" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}": { + "get": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Get a revision of a Container App.", + "operationId": "ContainerAppsRevisions_GetRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Revision" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's revision": { + "$ref": "./examples/Revisions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/activate": { + "post": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Activates a revision for a Container App", + "operationId": "ContainerAppsRevisions_ActivateRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App revision was activated" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Activate Container App's revision": { + "$ref": "./examples/Revisions_Activate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/deactivate": { + "post": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Deactivates a revision for a Container App", + "operationId": "ContainerAppsRevisions_DeactivateRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App revision was deactivated" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deactivate Container App's revision": { + "$ref": "./examples/Revisions_Deactivate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas/{replicaName}": { + "get": { + "tags": [ + "ContainerAppsRevisionReplicas" + ], + "summary": "Get a replica for a Container App Revision.", + "operationId": "ContainerAppsRevisionReplicas_GetReplica", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "name": "replicaName", + "in": "path", + "description": "Name of the Container App Revision Replica.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's revision replica": { + "$ref": "./examples/Replicas_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas": { + "get": { + "tags": [ + "ContainerAppsRevisionReplicas" + ], + "summary": "List replicas for a Container App Revision.", + "operationId": "ContainerAppsRevisionReplicas_ListReplicas", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicaCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container App's replicas": { + "$ref": "./examples/Replicas_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/restart": { + "post": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Restarts a revision for a Container App", + "operationId": "ContainerAppsRevisions_RestartRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App revision was restarted" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart Container App's revision": { + "$ref": "./examples/Revisions_Restart.json" + } + } + } + } + }, + "definitions": { + "Revision": { + "description": "Container App Revision.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Revision resource specific properties", + "type": "object", + "properties": { + "createdTime": { + "format": "date-time", + "description": "Timestamp describing when the revision was created\nby controller", + "type": "string", + "readOnly": true + }, + "lastActiveTime": { + "format": "date-time", + "description": "Timestamp describing when the revision was last active. Only meaningful when revision is inactive", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "Fully qualified domain name of the revision", + "type": "string", + "readOnly": true + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/Template", + "description": "Container App Revision Template with all possible settings and the\ndefaults if user did not provide them. The defaults are populated\nas they were at the creation time", + "readOnly": true + }, + "active": { + "description": "Boolean describing if the Revision is Active", + "type": "boolean", + "readOnly": true + }, + "replicas": { + "format": "int32", + "description": "Number of pods currently running for this revision", + "type": "integer", + "readOnly": true + }, + "trafficWeight": { + "format": "int32", + "description": "Traffic weight assigned to this revision", + "type": "integer", + "readOnly": true + }, + "provisioningError": { + "description": "Optional Field - Platform Error Message", + "type": "string", + "readOnly": true + }, + "healthState": { + "description": "Current health State of the revision", + "enum": [ + "Healthy", + "Unhealthy", + "None" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RevisionHealthState", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Current provisioning State of the revision", + "enum": [ + "Provisioning", + "Provisioned", + "Failed", + "Deprovisioning", + "Deprovisioned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RevisionProvisioningState", + "modelAsString": true + } + }, + "runningState": { + "description": "Current running state of the revision", + "enum": [ + "Running", + "Processing", + "Stopped", + "Degraded", + "Failed", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RevisionRunningState", + "modelAsString": true + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "RevisionCollection": { + "description": "Container App Revisions collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Revision" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "Replica": { + "description": "Container App Revision Replica.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Replica resource specific properties", + "type": "object", + "properties": { + "createdTime": { + "type": "string", + "description": "Timestamp describing when the pod was created by controller", + "format": "date-time", + "readOnly": true + }, + "runningState": { + "description": "Current running state of the replica", + "enum": [ + "Running", + "NotRunning", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerAppReplicaRunningState", + "modelAsString": true + } + }, + "runningStateDetails": { + "description": "The details of replica current running state", + "type": "string", + "readOnly": true + }, + "containers": { + "description": "The containers collection under a replica.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "initContainers": { + "description": "The init containers collection under a replica.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaContainer" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "ReplicaCollection": { + "description": "Container App Revision Replicas collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Replica" + } + } + } + }, + "ReplicaContainer": { + "description": "Container object under Container App Revision Replica.", + "type": "object", + "properties": { + "name": { + "description": "The Name of the Container", + "type": "string" + }, + "containerId": { + "description": "The Id of the Container", + "type": "string" + }, + "ready": { + "description": "The container ready status", + "type": "boolean" + }, + "started": { + "description": "The container start status", + "type": "boolean" + }, + "restartCount": { + "format": "int32", + "description": "The container restart count", + "type": "integer" + }, + "runningState": { + "description": "Current running state of the container", + "enum": [ + "Running", + "Terminated", + "Waiting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerAppContainerRunningState", + "modelAsString": true + } + }, + "runningStateDetails": { + "description": "The details of container current running state", + "type": "string", + "readOnly": true + }, + "logStreamEndpoint": { + "description": "Log Stream endpoint", + "type": "string", + "readOnly": true + }, + "execEndpoint": { + "description": "Container exec endpoint", + "type": "string", + "readOnly": true + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Diagnostics.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Diagnostics.json new file mode 100644 index 000000000000..ca593975fac6 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Diagnostics.json @@ -0,0 +1,873 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get the list of diagnostics for a given Container App.", + "operationId": "ContainerAppsDiagnostics_ListDetectors", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App for which detector info is needed.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the list of available diagnostics for a given Container App": { + "$ref": "./examples/ContainerAppsDiagnostics_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors/{detectorName}": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get a diagnostics result of a Container App.", + "operationId": "ContainerAppsDiagnostics_GetDetector", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Name of the Container App Detector.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Diagnostics" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's diagnostics info": { + "$ref": "./examples/ContainerAppsDiagnostics_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get the Revisions for a given Container App.", + "operationId": "ContainerAppsDiagnostics_ListRevisions", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App for which Revisions are needed.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./ContainerAppsRevisions.json#/definitions/RevisionCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container App's revisions": { + "$ref": "./examples/Revisions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Revision" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/{revisionName}": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get a revision of a Container App.", + "operationId": "ContainerAppsDiagnostics_GetRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./ContainerAppsRevisions.json#/definitions/Revision" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's revision": { + "$ref": "./examples/Revisions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/rootApi/": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get the properties of a Container App.", + "operationId": "ContainerAppsDiagnostics_GetRoot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./ContainerApps.json#/definitions/ContainerApp" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App": { + "$ref": "./examples/ContainerApps_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors": { + "get": { + "tags": [ + "ManagedEnvironments", + "Diagnostics" + ], + "summary": "Get the list of diagnostics for a given Managed Environment.", + "description": "Get the list of diagnostics for a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironmentDiagnostics_ListDetectors", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the list of available diagnostic data for a managed environments": { + "$ref": "./examples/ManagedEnvironmentDiagnostics_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors/{detectorName}": { + "get": { + "tags": [ + "ManagedEnvironments", + "Diagnostics" + ], + "summary": "Get the diagnostics data for a given Managed Environment.", + "description": "Get the diagnostics data for a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironmentDiagnostics_GetDetector", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Name of the Managed Environment detector.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Diagnostics" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get diagnostic data for a managed environments": { + "$ref": "./examples/ManagedEnvironmentDiagnostics_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectorProperties/rootApi/": { + "get": { + "tags": [ + "ManagedEnvironments", + "Diagnostics" + ], + "summary": "Get the properties of a Managed Environment.", + "description": "Get the properties of a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironmentsDiagnostics_GetRoot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./ManagedEnvironments.json#/definitions/ManagedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get environments by name": { + "$ref": "./examples/ManagedEnvironments_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors": { + "get": { + "tags": [ + "Jobs", + "Diagnostics" + ], + "summary": "Get the list of diagnostics for a given Container App Job.", + "description": "Get the list of diagnostics for a Container App Job.", + "operationId": "Jobs_ListDetectors", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Jobs.json#/parameters/JobNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the list of available diagnostic data for a Container App Job": { + "$ref": "./examples/Job_ListDetectors.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors/{detectorName}": { + "get": { + "tags": [ + "Jobs", + "Diagnostics" + ], + "summary": "Get the diagnostics data for a given Container App Job.", + "description": "Get the diagnostics data for a Container App Job.", + "operationId": "Jobs_GetDetector", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Jobs.json#/parameters/JobNameParameter" + }, + { + "name": "detectorName", + "in": "path", + "description": "Name of the Container App Job detector.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Diagnostics" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get diagnostic data for a Container App Job": { + "$ref": "./examples/Job_GetDetector.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectorProperties/{apiName}": { + "get": { + "tags": [ + "Jobs", + "Diagnostics" + ], + "summary": "Get the properties for a given Container App Job.", + "description": "Get the properties of a Container App Job.", + "operationId": "Jobs_ProxyGet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Jobs.json#/parameters/JobNameParameter" + }, + { + "name": "apiName", + "in": "path", + "description": "Proxy API Name for Container App Job.", + "required": true, + "enum": [ + "rootApi" + ], + "type": "string", + "pattern": "^[-\\w\\._]+$", + "x-ms-enum": { + "name": "ApiName", + "modelAsString": false + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./Jobs.json#/definitions/Job" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App Job by name": { + "$ref": "./examples/Job_ProxyGet.json" + } + } + } + } + }, + "definitions": { + "DiagnosticsCollection": { + "description": "Diagnostics data collection for a resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of diagnostic data.", + "type": "array", + "items": { + "$ref": "#/definitions/Diagnostics" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "Diagnostics": { + "description": "Diagnostics data for a resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Diagnostics resource specific properties", + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/DiagnosticsDefinition", + "description": "Metadata of the diagnostics response." + }, + "dataset": { + "description": "Set of data collections associated with the response.", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticsDataApiResponse" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/DiagnosticsStatus", + "description": "Status of the diagnostics response." + }, + "dataProviderMetadata": { + "$ref": "#/definitions/DiagnosticDataProviderMetadata", + "description": "List of data providers' metadata." + } + } + } + } + }, + "DiagnosticsDefinition": { + "description": "Metadata of the diagnostics response", + "type": "object", + "properties": { + "id": { + "description": "Unique detector name", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Display Name of the detector", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Details of the diagnostics info", + "type": "string", + "readOnly": true + }, + "author": { + "description": "Authors' names of the detector", + "type": "string", + "readOnly": true + }, + "category": { + "description": "Category of the detector", + "type": "string", + "readOnly": true + }, + "supportTopicList": { + "description": "List of support topics", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticSupportTopic" + } + }, + "analysisTypes": { + "description": "List of analysis types", + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "description": "Authors' names of the detector", + "type": "string", + "readOnly": true + }, + "score": { + "description": "Authors' names of the detector", + "type": "number", + "readOnly": true + } + } + }, + "DiagnosticSupportTopic": { + "description": "Support topic information", + "type": "object", + "properties": { + "id": { + "description": "Unique topic identifier", + "type": "string", + "readOnly": true + }, + "pesId": { + "description": "PES identifier", + "type": "string", + "readOnly": true + } + } + }, + "DiagnosticsDataApiResponse": { + "description": "Diagnostics data returned from a detector", + "type": "object", + "properties": { + "table": { + "description": "Table response", + "$ref": "#/definitions/DiagnosticDataTableResponseObject" + }, + "renderingProperties": { + "description": "Details of the table response", + "$ref": "#/definitions/DiagnosticRendering" + } + } + }, + "DiagnosticDataTableResponseObject": { + "description": "Diagnostics data table", + "type": "object", + "properties": { + "tableName": { + "description": "Table name", + "type": "string" + }, + "columns": { + "description": "Columns in the table", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticDataTableResponseColumn" + }, + "x-ms-identifiers": [ + "columnName" + ] + }, + "rows": { + "description": "Rows in the table", + "type": "array", + "items": { + "type": "object" + }, + "x-ms-identifiers": [] + } + } + }, + "DiagnosticDataTableResponseColumn": { + "description": "Diagnostics data column", + "type": "object", + "properties": { + "columnName": { + "description": "Column name", + "type": "string" + }, + "dataType": { + "description": "Data type of the column", + "type": "string" + }, + "columnType": { + "description": "Column type", + "type": "string" + } + } + }, + "DiagnosticRendering": { + "description": "Rendering details of a diagnostics table", + "type": "object", + "properties": { + "type": { + "format": "int32", + "description": "Rendering type", + "type": "integer" + }, + "title": { + "description": "Title of the table", + "type": "string" + }, + "description": { + "description": "Description of the table", + "type": "string" + }, + "isVisible": { + "description": "Flag if the table should be rendered", + "type": "boolean" + } + } + }, + "DiagnosticsStatus": { + "description": "Rendering details of a diagnostics table", + "type": "object", + "properties": { + "message": { + "description": "Diagnostic message", + "type": "string" + }, + "statusId": { + "format": "int32", + "description": "Status", + "type": "integer" + } + } + }, + "DiagnosticDataProviderMetadata": { + "description": "Details of a diagnostics data provider", + "type": "object", + "properties": { + "providerName": { + "description": "Name of data provider", + "type": "string" + }, + "propertyBag": { + "description": "Collection of properties", + "type": "array", + "items": { + "description": "Property details", + "type": "object", + "properties": { + "name": { + "description": "Property name", + "type": "string" + }, + "value": { + "description": "Property value", + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/DotNetComponents.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/DotNetComponents.json new file mode 100644 index 000000000000..2746b51735ea --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/DotNetComponents.json @@ -0,0 +1,479 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-02-02-preview" + }, + "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" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/dotNetComponents": { + "get": { + "tags": [ + "DotNetComponents" + ], + "summary": "Get the .NET Components for a managed environment.", + "operationId": "DotNetComponents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/DotNetComponentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List .NET Components": { + "$ref": "./examples/DotNetComponents_List.json" + }, + "List .NET Components with ServiceBinds": { + "$ref": "./examples/DotNetComponents_List_ServiceBind.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/dotNetComponents/{name}": { + "get": { + "tags": [ + "DotNetComponents" + ], + "summary": "Get a .NET Component.", + "operationId": "DotNetComponents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the .NET Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get .NET Component": { + "$ref": "./examples/DotNetComponents_Get.json" + }, + "Get .NET Component with ServiceBinds": { + "$ref": "./examples/DotNetComponents_Get_ServiceBind.json" + } + } + }, + "put": { + "tags": [ + "DotNetComponents" + ], + "summary": "Creates or updates a .NET Component.", + "description": "Creates or updates a .NET Component in a Managed Environment.", + "operationId": "DotNetComponents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the .NET Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dotNetComponentEnvelope", + "in": "body", + "description": "Configuration details of the .NET Component.", + "required": true, + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + } + ], + "responses": { + "200": { + "description": "No change performed on the .NET Component.", + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "201": { + "description": ".NET Component create or update has been started.", + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or Update .NET Component": { + "$ref": "./examples/DotNetComponents_CreateOrUpdate.json" + }, + "Create or Update .NET Component with ServiceBinds": { + "$ref": "./examples/DotNetComponents_CreateOrUpdate_ServiceBind.json" + } + } + }, + "patch": { + "tags": [ + "DotNetComponents" + ], + "summary": "Update properties of a .NET Component", + "description": "Patches a .NET Component using JSON Merge Patch", + "operationId": "DotNetComponents_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the .NET Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dotNetComponentEnvelope", + "in": "body", + "description": "Configuration details of the .NET Component.", + "required": true, + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "202": { + "description": "Patch operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch .NET Component": { + "$ref": "./examples/DotNetComponents_Patch.json" + }, + "Patch .NET Component with ServiceBinds": { + "$ref": "./examples/DotNetComponents_Patch_ServiceBind.json" + } + } + }, + "delete": { + "tags": [ + "DotNetComponents" + ], + "summary": "Delete a .NET Component.", + "description": "Delete a .NET Component.", + "operationId": "DotNetComponents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the .NET Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Delete operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": ".NET Component does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete .NET Component": { + "$ref": "./examples/DotNetComponents_Delete.json" + } + } + } + } + }, + "definitions": { + "DotNetComponentConfigurationProperty": { + "description": "Configuration properties for a .NET Component", + "type": "object", + "properties": { + "propertyName": { + "description": "The name of the property", + "type": "string" + }, + "value": { + "description": "The value of the property", + "type": "string" + } + } + }, + "DotNetComponentServiceBind": { + "description": "Configuration to bind a .NET Component to another .NET Component", + "type": "object", + "properties": { + "name": { + "description": "Name of the service bind", + "type": "string" + }, + "serviceId": { + "description": "Resource id of the target service", + "format": "arm-id", + "type": "string" + } + } + }, + "DotNetComponent": { + "description": ".NET Component.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": ".NET Component resource specific properties", + "type": "object", + "properties": { + "componentType": { + "description": "Type of the .NET Component.", + "enum": [ + "AspireDashboard" + ], + "type": "string", + "x-ms-enum": { + "name": "DotNetComponentType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the .NET Component.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DotNetComponentProvisioningState", + "modelAsString": true + } + }, + "configurations": { + "description": "List of .NET Components configuration properties", + "type": "array", + "items": { + "$ref": "#/definitions/DotNetComponentConfigurationProperty" + }, + "x-ms-identifiers": [ + "propertyName" + ] + }, + "serviceBinds": { + "description": "List of .NET Components that are bound to the .NET component", + "type": "array", + "items": { + "$ref": "#/definitions/DotNetComponentServiceBind" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "DotNetComponentsCollection": { + "description": ".NET Components ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/FunctionsExtension.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/FunctionsExtension.json new file mode 100644 index 000000000000..7e21e2244647 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/FunctionsExtension.json @@ -0,0 +1,107 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client", + "description": "Functions is an extension resource to revisions and the api listed is used to proxy the call from Web RP to the function app's host process, this api is not exposed to users and only Web RP is allowed to invoke functions extension resource." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/providers/Microsoft.App/functions/{functionAppName}/invoke": { + "post": { + "tags": [ + "FunctionsExtension" + ], + "summary": "Proxies a Functions host call to the function app backed by the container app.", + "operationId": "FunctionsExtension_InvokeFunctionsHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision, the parent resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "functionAppName", + "in": "path", + "description": "Name of the Function App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Functions host call response.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Invoke Functions host using Functions Extension API": { + "$ref": "./examples/FunctionsExtension_Post.json" + } + } + } + } + }, + "definitions": { + "FunctionsProxySerializedResponse": { + "type": "string", + "description": "Functions host call response as a serialized string, a common type of string is used as multiple response structures are possible." + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Global.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Global.json new file mode 100644 index 000000000000..eafcb049f4be --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Global.json @@ -0,0 +1,140 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.App/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available RP operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AvailableOperations" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all operations": { + "$ref": "./examples/Operations_List.json" + } + } + } + } + }, + "definitions": { + "AvailableOperations": { + "description": "Available operations of the service", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationDetail" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationDetail": { + "description": "Operation detail payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "type": "string" + }, + "resource": { + "description": "Resource of the operation", + "type": "string" + }, + "operation": { + "description": "Localized friendly name for the operation", + "type": "string" + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string" + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/JavaComponents.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/JavaComponents.json new file mode 100644 index 000000000000..fe3b6aa0c386 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/JavaComponents.json @@ -0,0 +1,561 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-02-02-preview" + }, + "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" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents": { + "get": { + "tags": [ + "JavaComponents" + ], + "summary": "Get the Java Components for a managed environment.", + "operationId": "JavaComponents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/JavaComponentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Java Components": { + "$ref": "./examples/JavaComponents_List.json" + }, + "List Java Components with ServiceBinds": { + "$ref": "./examples/JavaComponents_List_ServiceBind.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents/{name}": { + "get": { + "tags": [ + "JavaComponents" + ], + "summary": "Get a Java Component.", + "operationId": "JavaComponents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Java Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JavaComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Java Component": { + "$ref": "./examples/JavaComponents_Get.json" + }, + "Get Java Component with ServiceBinds": { + "$ref": "./examples/JavaComponents_Get_ServiceBind.json" + } + } + }, + "put": { + "tags": [ + "JavaComponents" + ], + "summary": "Creates or updates a Java Component.", + "description": "Creates or updates a Java Component in a Managed Environment.", + "operationId": "JavaComponents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Java Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "javaComponentEnvelope", + "in": "body", + "description": "Configuration details of the Java Component.", + "required": true, + "schema": { + "$ref": "#/definitions/JavaComponent" + } + } + ], + "responses": { + "200": { + "description": "No change performed on the Java Component.", + "schema": { + "$ref": "#/definitions/JavaComponent" + } + }, + "201": { + "description": "Java Component create or update has been started.", + "schema": { + "$ref": "#/definitions/JavaComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or Update Java Component": { + "$ref": "./examples/JavaComponents_CreateOrUpdate.json" + }, + "Create or Update Java Component with ServiceBinds": { + "$ref": "./examples/JavaComponents_CreateOrUpdate_ServiceBind.json" + } + } + }, + "patch": { + "tags": [ + "JavaComponents" + ], + "summary": "Update properties of a Java Component", + "description": "Patches a Java Component using JSON Merge Patch", + "operationId": "JavaComponents_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Java Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "javaComponentEnvelope", + "in": "body", + "description": "Configuration details of the Java Component.", + "required": true, + "schema": { + "$ref": "#/definitions/JavaComponent" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/JavaComponent" + } + }, + "202": { + "description": "Patch operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch Java Component": { + "$ref": "./examples/JavaComponents_Patch.json" + }, + "Patch Java Component with ServiceBinds": { + "$ref": "./examples/JavaComponents_Patch_ServiceBind.json" + } + } + }, + "delete": { + "tags": [ + "JavaComponents" + ], + "summary": "Delete a Java Component.", + "description": "Delete a Java Component.", + "operationId": "JavaComponents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Java Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Delete operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Java Component does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Java Component": { + "$ref": "./examples/JavaComponents_Delete.json" + } + } + } + } + }, + "definitions": { + "JavaComponentConfigurationProperty": { + "description": "Configuration properties for a Java Component", + "type": "object", + "properties": { + "propertyName": { + "description": "The name of the property", + "type": "string" + }, + "value": { + "description": "The value of the property", + "type": "string" + } + } + }, + "JavaComponentServiceBind": { + "description": "Configuration to bind a Java Component to another Java Component", + "type": "object", + "properties": { + "name": { + "description": "Name of the service bind", + "type": "string" + }, + "serviceId": { + "description": "Resource id of the target service", + "format": "arm-id", + "type": "string" + } + } + }, + "JavaComponent": { + "description": "Java Component.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Java Component resource specific properties", + "type": "object", + "$ref": "#/definitions/JavaComponentProperties" + } + } + }, + "JavaComponentProperties": { + "description": "Java Component common properties.", + "type": "object", + "required": [ + "componentType" + ], + "properties": { + "componentType": { + "description": "Type of the Java Component.", + "enum": [ + "SpringBootAdmin", + "SpringCloudEureka", + "SpringCloudConfig", + "Nacos" + ], + "type": "string", + "x-ms-enum": { + "name": "JavaComponentType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the Java Component.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JavaComponentProvisioningState", + "modelAsString": true + } + }, + "configurations": { + "description": "List of Java Components configuration properties", + "type": "array", + "items": { + "$ref": "#/definitions/JavaComponentConfigurationProperty" + }, + "x-ms-identifiers": [ + "propertyName" + ] + }, + "serviceBinds": { + "description": "List of Java Components that are bound to the Java component", + "type": "array", + "items": { + "$ref": "#/definitions/JavaComponentServiceBind" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-client-flatten": true, + "discriminator": "componentType" + }, + "JavaComponentIngress": { + "description": "Container App Ingress configuration.", + "type": "object", + "properties": { + "fqdn": { + "description": "Hostname of the Java Component endpoint", + "type": "string", + "readOnly": true + } + } + }, + "SpringBootAdminComponent": { + "description": "Spring Boot Admin properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JavaComponentProperties" + } + ], + "properties": { + "ingress": { + "$ref": "#/definitions/JavaComponentIngress", + "description": "Java Component Ingress configurations." + } + }, + "x-ms-discriminator-value": "SpringBootAdmin" + }, + "NacosComponent": { + "description": "Nacos properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JavaComponentProperties" + } + ], + "properties": { + "ingress": { + "$ref": "#/definitions/JavaComponentIngress", + "description": "Java Component Ingress configurations." + } + }, + "x-ms-discriminator-value": "Nacos" + }, + "SpringCloudEurekaComponent": { + "description": "Spring Cloud Eureka properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JavaComponentProperties" + } + ], + "properties": { + "ingress": { + "$ref": "#/definitions/JavaComponentIngress", + "description": "Java Component Ingress configurations." + } + }, + "x-ms-discriminator-value": "SpringCloudEureka" + }, + "SpringCloudConfigComponent": { + "description": "Spring Cloud Config properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JavaComponentProperties" + } + ], + "properties": {}, + "x-ms-discriminator-value": "SpringCloudConfig" + }, + "JavaComponentsCollection": { + "description": "Java Components ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JavaComponent" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Jobs.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Jobs.json new file mode 100644 index 000000000000..436805be7ced --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Jobs.json @@ -0,0 +1,1285 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get the Container Apps Jobs in a given subscription.", + "operationId": "Jobs_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobsCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Jobs by subscription": { + "$ref": "./examples/Jobs_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get the Container Apps Jobs in a given resource group.", + "operationId": "Jobs_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Jobs by resource group": { + "$ref": "./examples/Jobs_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get the properties of a Container Apps Job.", + "operationId": "Jobs_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container Apps Job": { + "$ref": "./examples/Job_Get.json" + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "summary": "Create or Update a Container Apps Job.", + "description": "Create or Update a Container Apps Job.", + "operationId": "Jobs_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "name": "JobEnvelope", + "in": "body", + "description": "Properties used to create a container apps job", + "required": true, + "schema": { + "$ref": "#/definitions/Job" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Container Apps Job create has been started.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "200": { + "description": "No change performed on the Container Apps Job.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Container Apps Job": { + "$ref": "./examples/Job_CreateorUpdate.json" + }, + "Create or Update Container Apps Job With Event Driven Trigger": { + "$ref": "./examples/Job_CreateorUpdate_EventTrigger.json" + }, + "Create or Update Container Apps Job On A Connected Environment": { + "$ref": "./examples/Job_CreateorUpdate_ConnectedEnvironment.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "summary": "Delete a Container Apps Job.", + "description": "Delete a Container Apps Job.", + "operationId": "Jobs_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container Apps Job deleted successfully." + }, + "202": { + "description": "Delete operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Container Apps Job does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Container Apps Job": { + "$ref": "./examples/Job_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "summary": "Update properties of a Container Apps Job", + "description": "Patches a Container Apps Job using JSON Merge Patch", + "operationId": "Jobs_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "name": "JobEnvelope", + "in": "body", + "required": true, + "description": "Properties used to create a container apps job", + "schema": { + "$ref": "#/definitions/JobPatchProperties" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Patch operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Container Apps Job": { + "$ref": "./examples/Job_Patch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/start": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "Start a Container Apps Job", + "operationId": "Jobs_Start", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "name": "template", + "in": "body", + "description": "Properties used to start a job execution.", + "required": false, + "schema": { + "$ref": "#/definitions/JobExecutionTemplate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobExecutionBase" + } + }, + "202": { + "description": "OK", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Run a Container Apps Job": { + "$ref": "./examples/Job_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}/stop": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "Terminates execution of a running container apps job", + "operationId": "Jobs_StopExecution", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/JobExecutionNameParameter" + } + ], + "responses": { + "200": { + "description": "Container Apps Jobs terminated successfully." + }, + "202": { + "description": "OK", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Terminate a Container Apps Job": { + "$ref": "./examples/Job_Stop_Execution.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/stop": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "Terminates execution of a running container apps job", + "operationId": "Jobs_StopMultipleExecutions", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + } + ], + "responses": { + "200": { + "description": "List of all the job executions that were requested to be stopped", + "schema": { + "$ref": "#/definitions/ContainerAppJobExecutions" + } + }, + "202": { + "description": "OK", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Terminate Multiple Container Apps Job": { + "$ref": "./examples/Job_Stop_Multiple.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get a Container Apps Job's executions", + "operationId": "JobsExecutions_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppJobExecutions" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Container Apps Job Executions": { + "$ref": "./examples/Job_Executions_Get.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get details of a single job execution", + "operationId": "JobExecution", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/JobExecutionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobExecution" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a single Job Execution": { + "$ref": "./examples/Job_Execution_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/listSecrets": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "List secrets for a container apps job", + "operationId": "Jobs_ListSecrets", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobSecretsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Job Secrets": { + "$ref": "./examples/Job_ListSecrets.json" + } + } + } + } + }, + "parameters": { + "JobNameParameter": { + "name": "jobName", + "in": "path", + "description": "Job Name", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + }, + "JobExecutionNameParameter": { + "name": "jobExecutionName", + "in": "path", + "description": "Job execution name.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "JobConfiguration": { + "description": "Non versioned Container Apps Job configuration properties", + "type": "object", + "required": [ + "replicaTimeout", + "triggerType" + ], + "properties": { + "secrets": { + "description": "Collection of secrets used by a Container Apps Job", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "triggerType": { + "description": "Trigger type of the job", + "enum": [ + "Schedule", + "Event", + "Manual" + ], + "type": "string", + "default": "Manual", + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true + } + }, + "replicaTimeout": { + "description": "Maximum number of seconds a replica is allowed to run.", + "format": "int32", + "type": "integer" + }, + "replicaRetryLimit": { + "format": "int32", + "description": "Maximum number of retries before failing the job.", + "type": "integer" + }, + "manualTriggerConfig": { + "type": "object", + "description": "Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default", + "properties": { + "replicaCompletionCount": { + "$ref": "#/definitions/ReplicaCompletionCount" + }, + "parallelism": { + "$ref": "#/definitions/Parallelism" + } + } + }, + "scheduleTriggerConfig": { + "description": "Cron formatted repeating trigger schedule (\"* * * * *\") for cronjobs. Properties completions and parallelism would be set to 1 by default", + "required": [ + "cronExpression" + ], + "type": "object", + "properties": { + "replicaCompletionCount": { + "$ref": "#/definitions/ReplicaCompletionCount" + }, + "cronExpression": { + "description": "Cron formatted repeating schedule (\"* * * * *\") of a Cron Job.", + "type": "string" + }, + "parallelism": { + "$ref": "#/definitions/Parallelism" + } + } + }, + "eventTriggerConfig": { + "type": "object", + "description": "Trigger configuration of an event driven job.", + "properties": { + "replicaCompletionCount": { + "$ref": "#/definitions/ReplicaCompletionCount" + }, + "parallelism": { + "$ref": "#/definitions/Parallelism" + }, + "scale": { + "$ref": "#/definitions/JobScale" + } + } + }, + "registries": { + "description": "Collection of private container registry credentials used by a Container apps job", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryCredentials" + }, + "x-ms-identifiers": [ + "server" + ] + }, + "identitySettings": { + "description": "Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/IdentitySettings" + }, + "x-ms-identifiers": [ + "identity" + ] + } + } + }, + "Job": { + "type": "object", + "description": "Container App Job", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./CommonDefinitions.json#/definitions/ExtendedLocation" + }, + "identity": { + "description": "Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "description": "Container Apps Job resource specific properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Container Apps Job.", + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobProvisioningState", + "modelAsString": true + } + }, + "environmentId": { + "description": "Resource ID of environment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "workloadProfileName": { + "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileName", + "description": "Workload profile name to pin for container apps job execution." + }, + "configuration": { + "$ref": "#/definitions/JobConfiguration", + "description": "Container Apps Job configuration properties." + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/JobTemplate", + "description": "Container Apps job definition." + }, + "outboundIpAddresses": { + "description": "Outbound IP Addresses of a container apps job.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "eventStreamEndpoint": { + "description": "The endpoint of the eventstream of the container apps job.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "JobPatchProperties": { + "type": "object", + "description": "Container Apps Job resource specific properties.", + "properties": { + "extendedLocation": { + "$ref": "./CommonDefinitions.json#/definitions/ExtendedLocation" + }, + "identity": { + "description": "Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "type": "object", + "properties": { + "environmentId": { + "description": "Resource ID of environment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "configuration": { + "$ref": "#/definitions/JobConfiguration", + "description": "Container Apps Job configuration properties." + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/JobTemplate", + "description": "Container Apps job definition." + }, + "outboundIpAddresses": { + "description": "Outbound IP Addresses of a container apps job.", + "type": "array", + "items": { + "type": "string" + } + }, + "eventStreamEndpoint": { + "description": "The endpoint of the eventstream of the container apps job.", + "type": "string" + } + } + } + } + }, + "JobsCollection": { + "description": "Container Apps Jobs collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Job" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "RegistryCredentials": { + "description": "Container App Private Registry", + "type": "object", + "properties": { + "server": { + "description": "Container Registry Server", + "type": "string" + }, + "username": { + "description": "Container Registry Username", + "type": "string" + }, + "passwordSecretRef": { + "description": "The name of the Secret that contains the registry login password", + "type": "string" + }, + "identity": { + "description": "A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'", + "type": "string" + } + } + }, + "JobSecretsCollection": { + "description": "Container Apps Job Secrets Collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ReplicaCompletionCount": { + "description": "Minimum number of successful replica completions before overall job completion.", + "format": "int32", + "type": "integer" + }, + "Parallelism": { + "description": "Number of parallel replicas of a job that can run at a given time.", + "format": "int32", + "type": "integer" + }, + "PollingInterval": { + "description": "Interval to check each event source in seconds. Defaults to 30s", + "format": "int32", + "type": "integer" + }, + "JobScaleRule": { + "description": "Scaling rule.", + "type": "object", + "properties": { + "name": { + "description": "Scale Rule Name", + "type": "string" + }, + "type": { + "description": "Type of the scale rule\neg: azure-servicebus, redis etc.", + "type": "string" + }, + "metadata": { + "description": "Metadata properties to describe the scale rule.", + "type": "object" + }, + "auth": { + "description": "Authentication secrets for the scale rule.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/ScaleRuleAuth" + } + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the job, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "JobScale": { + "description": "Scaling configurations for event driven jobs.", + "type": "object", + "properties": { + "pollingInterval": { + "$ref": "#/definitions/PollingInterval" + }, + "minExecutions": { + "format": "int32", + "description": "Minimum number of job executions that are created for a trigger, default 0", + "type": "integer", + "default": 0 + }, + "maxExecutions": { + "format": "int32", + "description": "Maximum number of job executions that are created for a trigger, default 100.", + "type": "integer", + "default": 100 + }, + "rules": { + "description": "Scaling rules.", + "type": "array", + "items": { + "$ref": "#/definitions/JobScaleRule" + } + } + } + }, + "JobExecutionBase": { + "description": "Container App's Job execution name.", + "type": "object", + "properties": { + "name": { + "description": "Job execution name.", + "type": "string" + }, + "id": { + "description": "Job execution Id.", + "type": "string" + } + } + }, + "JobExecution": { + "description": "Container Apps Job execution.", + "type": "object", + "properties": { + "name": { + "description": "Job execution Name.", + "type": "string" + }, + "id": { + "description": "Job execution Id.", + "type": "string" + }, + "type": { + "description": "Job execution type", + "type": "string" + }, + "properties": { + "description": "Container Apps Job execution specific properties.", + "type": "object", + "properties": { + "status": { + "description": "Current running State of the job", + "enum": [ + "Running", + "Processing", + "Stopped", + "Degraded", + "Failed", + "Unknown", + "Succeeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobExecutionRunningState", + "modelAsString": true + } + }, + "startTime": { + "description": "Job execution start time.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "Job execution end time.", + "format": "date-time", + "type": "string" + }, + "template": { + "description": "Job's execution container.", + "$ref": "#/definitions/JobExecutionTemplate" + }, + "detailedStatus": { + "description": "Detailed status of the job execution.", + "$ref": "#/definitions/ExecutionStatus" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ExecutionStatus": { + "description": "Container Apps Job execution status.", + "type": "object", + "properties": { + "replicas": { + "description": "Replicas in the execution.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaExecutionStatus" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ReplicaExecutionStatus": { + "description": "Container Apps Job execution replica status.", + "type": "object", + "properties": { + "name": { + "description": "Replica Name.", + "type": "string" + }, + "containers": { + "description": "Containers in the execution replica", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerExecutionStatus" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ContainerExecutionStatus": { + "description": "Container Apps Job execution container status. Contains status code and reason", + "type": "object", + "properties": { + "name": { + "description": "Container Name.", + "type": "string" + }, + "code": { + "description": "Exit code", + "type": "integer", + "format": "int32" + }, + "additionalInformation": { + "description": "Additional information for the container status", + "type": "string" + }, + "status": { + "description": "Status of the container", + "type": "string" + } + } + }, + "ContainerAppJobExecutions": { + "description": "Container App executions collection ARM resource.", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobExecution" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "JobExecutionNamesCollection": { + "description": "Container App executions names list.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobExecutionBase" + } + } + } + }, + "JobExecutionTemplate": { + "description": "Job's execution template, containing container configuration for a job's execution", + "type": "object", + "properties": { + "containers": { + "description": "List of container definitions for the Container Apps Job.", + "type": "array", + "items": { + "$ref": "#/definitions/JobExecutionContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "initContainers": { + "description": "List of specialized containers that run before job containers.", + "type": "array", + "items": { + "$ref": "#/definitions/JobExecutionContainer" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "JobExecutionContainer": { + "description": "Container Apps Jobs execution container definition.", + "type": "object", + "properties": { + "image": { + "description": "Container image tag.", + "type": "string" + }, + "name": { + "description": "Custom container name.", + "type": "string" + }, + "command": { + "description": "Container start command.", + "type": "array", + "items": { + "type": "string" + } + }, + "args": { + "description": "Container start command arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "env": { + "description": "Container environment variables.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVar" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resources": { + "$ref": "./CommonDefinitions.json#/definitions/ContainerResources", + "description": "Container resource requirements." + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/LogicAppsExtension.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/LogicAppsExtension.json new file mode 100644 index 000000000000..a47c30b68340 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/LogicAppsExtension.json @@ -0,0 +1,750 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client", + "description": "Logic app is an extension resource on container app and the extension resource enables logic specific operations on the container app through the APIs listed." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}": { + "get": { + "tags": [ + "LogicApps" + ], + "summary": "Gets a logic app extension resource.", + "operationId": "LogicApps_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicApp" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get logic app extension by name ": { + "$ref": "./examples/LogicApps_Get.json" + } + } + }, + "put": { + "operationId": "LogicApps_CreateOrUpdate", + "tags": [ + "LogicApps" + ], + "description": "Create or update a Logic App extension resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "resource", + "in": "body", + "description": "Logic app resource properties.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicApp" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicApp" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/LogicApp" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create logic app extension": { + "$ref": "./examples/LogicApps_Create.json" + } + } + }, + "delete": { + "operationId": "LogicApps_Delete", + "tags": [ + "LogicApps" + ], + "description": "Deletes a Logic App extension resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Extension resource does not exist" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create logic app extension": { + "$ref": "./examples/LogicApps_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/workflows": { + "get": { + "tags": [ + "LogicApps" + ], + "summary": "List the workflows for a logic app.", + "operationId": "LogicApps_ListWorkflows", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Workflow information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelopeCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List the workflows": { + "$ref": "./examples/LogicApps_ListWorkflows.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/workflows/{workflowName}": { + "get": { + "tags": [ + "LogicApps" + ], + "summary": "Get workflow information by its name", + "operationId": "LogicApps_GetWorkflow", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "workflowName", + "in": "path", + "description": "Workflow name.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Workflow information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "GET a workflow": { + "$ref": "./examples/LogicApps_GetWorkflow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/deployWorkflowArtifacts": { + "post": { + "tags": [ + "LogicApps" + ], + "description": "Creates or updates the artifacts for the logic app", + "operationId": "LogicApps_DeployWorkflowArtifacts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "workflowArtifacts", + "in": "body", + "description": "Application settings and files of the workflow.", + "required": false, + "x-ms-secret": true, + "schema": { + "$ref": "#/definitions/WorkflowArtifacts" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Artifacts deployed." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deploys workflow artifacts": { + "$ref": "./examples/LogicApps_PostDeployWorkflowArtifacts.json" + }, + "Delete workflow artifacts": { + "$ref": "./examples/LogicApps_DeleteDeployWorkflowArtifacts.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/listWorkflowsConnections": { + "post": { + "tags": [ + "LogicApps" + ], + "summary": "Gets logic app's connections.", + "operationId": "LogicApps_ListWorkflowsConnections", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connections information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List the Workflows Configuration Connections": { + "$ref": "./examples/LogicApps_ListConnections.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/invoke": { + "post": { + "tags": [ + "LogicApps" + ], + "summary": "Proxies a the API call to the logic app backed by the container app.", + "operationId": "LogicApps_Invoke", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the LogicApp App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "x-ms-logicApps-proxy-path", + "in": "header", + "description": "The proxy path for the API call", + "required": true, + "type": "string" + }, + { + "name": "x-ms-logicApps-proxy-method", + "in": "header", + "description": "The proxy method for the API call", + "required": true, + "type": "string", + "enum": [ + "GET", + "POST" + ], + "x-ms-enum": { + "name": "LogicAppsProxyMethod", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Logic App call response.", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get workflow list call back URL": { + "$ref": "./examples/LogicApps_ListCallbackURL.json" + } + } + } + } + }, + "definitions": { + "LogicApp": { + "type": "object", + "description": "A logic app extension resource", + "properties": { + "properties": { + "$ref": "#/definitions/LogicAppProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LogicAppProperties": { + "type": "object", + "description": "The properties of logic apps extension." + }, + "WorkflowEnvelope": { + "description": "Workflow properties definition.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the resource type." + }, + "kind": { + "type": "string", + "description": "The resource kind." + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "properties": { + "description": "Additional workflow properties.", + "type": "object", + "properties": { + "files": { + "description": "Gets or sets the files.", + "$ref": "#/definitions/WorkflowFiles" + }, + "flowState": { + "description": "Gets or sets the state of the workflow.", + "$ref": "#/definitions/WorkflowState" + }, + "health": { + "$ref": "#/definitions/WorkflowHealth", + "description": "Gets or sets workflow health." + } + } + } + } + }, + "WorkflowEnvelopeCollection": { + "description": "Collection of workflow information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "WorkflowFiles": { + "description": "Gets or sets the files.", + "type": "object" + }, + "WorkflowHealth": { + "description": "Represents the workflow health.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Gets or sets the workflow health state.", + "enum": [ + "NotSpecified", + "Healthy", + "Unhealthy", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkflowHealthState", + "modelAsString": false + } + }, + "error": { + "$ref": "#/definitions/ErrorEntity", + "description": "Gets or sets the workflow error." + } + } + }, + "WorkflowState": { + "type": "string", + "description": "The workflow state.", + "enum": [ + "NotSpecified", + "Completed", + "Enabled", + "Disabled", + "Deleted", + "Suspended" + ], + "x-ms-enum": { + "name": "WorkflowState", + "modelAsString": true + } + }, + "WorkflowArtifacts": { + "type": "object", + "properties": { + "appSettings": { + "$ref": "#/definitions/Object", + "description": "Application settings of the workflow." + }, + "files": { + "$ref": "#/definitions/WorkflowFiles", + "description": "Files of the app." + }, + "filesToDelete": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Files of the app to delete." + } + }, + "description": "The workflow filter." + }, + "Object": { + "type": "object", + "properties": {} + }, + "ErrorEntity": { + "description": "Body of the error response returned from the API.", + "type": "object", + "properties": { + "extendedCode": { + "description": "Type of error.", + "type": "string" + }, + "messageTemplate": { + "description": "Message template.", + "type": "string" + }, + "parameters": { + "description": "Parameters for the template.", + "type": "array", + "items": { + "type": "string" + } + }, + "innerErrors": { + "description": "Inner errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorEntity" + }, + "x-ms-identifiers": [] + }, + "details": { + "description": "Error Details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorEntity" + }, + "x-ms-identifiers": [] + }, + "target": { + "description": "The error target.", + "type": "string" + }, + "code": { + "description": "Basic error code.", + "type": "string" + }, + "message": { + "description": "Any details of the error.", + "type": "string" + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironments.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironments.json new file mode 100644 index 000000000000..50b8ed1122ef --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironments.json @@ -0,0 +1,1915 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/managedEnvironments": { + "get": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get all Environments for a subscription.", + "description": "Get all Managed Environments for a subscription.", + "operationId": "ManagedEnvironments_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List environments by subscription": { + "$ref": "./examples/ManagedEnvironments_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments": { + "get": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get all the Environments in a resource group.", + "description": "Get all the Managed Environments in a resource group.", + "operationId": "ManagedEnvironments_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List environments by resource group": { + "$ref": "./examples/ManagedEnvironments_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}": { + "get": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get the properties of a Managed Environment.", + "description": "Get the properties of a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironments_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get environments by name": { + "$ref": "./examples/ManagedEnvironments_Get.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Creates or updates a Managed Environment.", + "description": "Creates or updates a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironments_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "environmentEnvelope", + "in": "body", + "description": "Configuration details of the Environment.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create environments": { + "$ref": "./examples/ManagedEnvironments_CreateOrUpdate.json" + }, + "Create environment with custom infrastructureResourceGroup": { + "$ref": "./examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json" + } + } + }, + "delete": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Delete a Managed Environment.", + "description": "Delete a Managed Environment if it does not have any container apps.", + "operationId": "ManagedEnvironments_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "202": { + "description": "Delete operation is in progress" + }, + "204": { + "description": "Environment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete environment by name": { + "$ref": "./examples/ManagedEnvironments_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Update Managed Environment's properties.", + "description": "Patches a Managed Environment using JSON Merge Patch", + "operationId": "ManagedEnvironments_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "environmentEnvelope", + "in": "body", + "description": "Configuration details of the Environment.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "202": { + "description": "Patch operation is in progress." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Managed Environment": { + "$ref": "./examples/ManagedEnvironments_Patch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates": { + "get": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Get the Certificates in a given managed environment.", + "operationId": "Certificates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CertificateCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Certificates by Managed Environment": { + "$ref": "./examples/Certificates_ListByManagedEnvironment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}": { + "get": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Get the specified Certificate.", + "operationId": "Certificates_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Certificate": { + "$ref": "./examples/Certificate_Get.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Create or Update a Certificate.", + "operationId": "Certificates_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "description": "Certificate to be created or updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Certificate": { + "$ref": "./examples/Certificate_CreateOrUpdate.json" + }, + "Create or Update Certificate using Managed Identity": { + "$ref": "./examples/Certificate_CreateOrUpdate_FromKeyVault.json" + } + } + }, + "delete": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Deletes the specified Certificate.", + "operationId": "Certificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Certificate does not exist" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Certificate": { + "$ref": "./examples/Certificate_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Update properties of a certificate", + "description": "Patches a certificate. Currently only patching of tags is supported", + "operationId": "Certificates_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "required": true, + "description": "Properties of a certificate that need to be updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CertificatePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Certificate updated successfully.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Certificate": { + "$ref": "./examples/Certificates_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}": { + "get": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Get the specified Managed Certificate.", + "operationId": "ManagedCertificates_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateName", + "in": "path", + "description": "Name of the Managed Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Certificate": { + "$ref": "./examples/ManagedCertificate_Get.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Create or Update a Managed Certificate.", + "operationId": "ManagedCertificates_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateName", + "in": "path", + "description": "Name of the Managed Certificate.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateEnvelope", + "in": "body", + "description": "Managed Certificate to be created or updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + "400": { + "description": "Bad Request.", + "x-ms-error-response": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or Update Certificate": { + "$ref": "./examples/ManagedCertificate_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Deletes the specified Managed Certificate.", + "operationId": "ManagedCertificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateName", + "in": "path", + "description": "Name of the Managed Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Certificate does not exist" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Certificate": { + "$ref": "./examples/ManagedCertificate_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Update tags of a managed certificate", + "description": "Patches a managed certificate. Oly patching of tags is supported", + "operationId": "ManagedCertificates_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateName", + "in": "path", + "description": "Name of the Managed Certificate.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateEnvelope", + "in": "body", + "required": true, + "description": "Properties of a managed certificate that need to be updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificatePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Managed Certificate updated successfully.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Managed Certificate": { + "$ref": "./examples/ManagedCertificates_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates": { + "get": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Get the Managed Certificates in a given managed environment.", + "operationId": "ManagedCertificates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificateCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Managed Certificates by Managed Environment": { + "$ref": "./examples/ManagedCertificates_ListByManagedEnvironment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/checkNameAvailability": { + "post": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Checks the resource name availability.", + "description": "Checks if resource name is available.", + "operationId": "Namespaces_CheckNameAvailability", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "checkNameAvailabilityRequest", + "in": "body", + "description": "The check name availability request.", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "ContainerApps_CheckNameAvailability": { + "$ref": "./examples/ContainerApps_CheckNameAvailability.json" + }, + "Certificates_CheckNameAvailability": { + "$ref": "./examples/Certificates_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/getAuthtoken": { + "post": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get auth token for a managed environment", + "description": "Checks if resource name is available.", + "operationId": "ManagedEnvironments_GetAuthToken", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnvironmentAuthToken" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Environment Auth Token": { + "$ref": "./examples/ManagedEnvironments_GetAuthToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/workloadProfileStates": { + "get": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get all workload Profile States for a Managed Environment..", + "description": "Get all workload Profile States for a Managed Environment.", + "operationId": "ManagedEnvironments_ListWorkloadProfileStates", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/workloadProfileStatesCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List environments by subscription": { + "$ref": "./examples/ManagedEnvironments_ListWorkloadProfileStates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateEndpointConnections": { + "get": { + "tags": [ + "ManagedEnvironments", + "PrivateEndpointConnections" + ], + "summary": "List private endpoint connections for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateEndpointConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "ManagedEnvironments", + "PrivateEndpointConnections" + ], + "summary": "Get a private endpoint connection for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Private Endpoint Connection by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironments", + "PrivateEndpointConnections" + ], + "summary": "Update the state of a private endpoint connection for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnectionEnvelope", + "in": "body", + "description": "The resource of private endpoint and its properties", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Private Endpoint Connection by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ManagedEnvironments", + "PrivateEndpointConnections" + ], + "summary": "Delete a private endpoint connection for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No content. Already deleted." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a Private Endpoint Connection by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateLinkResources": { + "get": { + "tags": [ + "ManagedEnvironments", + "PrivateLinkResources" + ], + "summary": "List private link resources for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateLinkResources_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateLinkResources_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AppLogsConfiguration": { + "description": "Configuration of application logs", + "type": "object", + "properties": { + "destination": { + "description": "Logs destination, can be 'log-analytics', 'azure-monitor' or 'none'", + "type": "string" + }, + "logAnalyticsConfiguration": { + "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'", + "$ref": "#/definitions/LogAnalyticsConfiguration" + } + } + }, + "AppInsightsConfiguration": { + "description": "Configuration of Application Insights ", + "type": "object", + "properties": { + "connectionString": { + "description": "Application Insights connection string", + "type": "string", + "x-ms-secret": true + } + } + }, + "OpenTelemetryConfiguration": { + "description": "Configuration of Open Telemetry", + "type": "object", + "properties": { + "destinationsConfiguration": { + "description": "Open telemetry destinations configuration", + "$ref": "#/definitions/DestinationsConfiguration" + }, + "tracesConfiguration": { + "description": "Open telemetry trace configuration", + "$ref": "#/definitions/TracesConfiguration" + }, + "logsConfiguration": { + "description": "Open telemetry logs configuration", + "$ref": "#/definitions/LogsConfiguration" + }, + "metricsConfiguration": { + "description": "Open telemetry metrics configuration", + "$ref": "#/definitions/MetricsConfiguration" + } + } + }, + "DestinationsConfiguration": { + "description": "Configuration of Open Telemetry destinations", + "type": "object", + "properties": { + "dataDogConfiguration": { + "description": "Open telemetry datadog destination configuration", + "$ref": "#/definitions/DataDogConfiguration" + }, + "otlpConfigurations": { + "description": "Open telemetry otlp configurations", + "type": "array", + "items": { + "$ref": "#/definitions/OtlpConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DataDogConfiguration": { + "description": "Configuration of datadog ", + "type": "object", + "properties": { + "site": { + "description": "The data dog site", + "type": "string" + }, + "key": { + "description": "The data dog api key", + "type": "string", + "x-ms-secret": true + } + } + }, + "OtlpConfiguration": { + "description": "Configuration of otlp ", + "type": "object", + "properties": { + "name": { + "description": "The name of otlp configuration", + "type": "string" + }, + "endpoint": { + "description": "The endpoint of otlp configuration", + "type": "string" + }, + "insecure": { + "description": "Boolean indicating if otlp configuration is insecure", + "type": "boolean" + }, + "headers": { + "description": "Headers of otlp configurations", + "type": "array", + "items": { + "$ref": "#/definitions/Header" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "Header": { + "description": "Header of otlp configuration", + "type": "object", + "properties": { + "key": { + "description": "The key of otlp configuration header", + "type": "string" + }, + "value": { + "description": "The value of otlp configuration header", + "type": "string" + } + } + }, + "TracesConfiguration": { + "description": "Configuration of Open Telemetry traces", + "type": "object", + "properties": { + "destinations": { + "description": "Open telemetry traces destinations", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "LogsConfiguration": { + "description": "Configuration of Open Telemetry logs", + "type": "object", + "properties": { + "destinations": { + "description": "Open telemetry logs destinations", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MetricsConfiguration": { + "description": "Configuration of Open Telemetry metrics", + "type": "object", + "properties": { + "destinations": { + "description": "Open telemetry metrics destinations", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "KedaConfiguration": { + "type": "object", + "description": "Configuration properties Keda component", + "properties": { + "version": { + "type": "string", + "readOnly": true, + "description": "The version of Keda" + } + } + }, + "DaprConfiguration": { + "type": "object", + "description": "Configuration properties Dapr component", + "properties": { + "version": { + "type": "string", + "readOnly": true, + "description": "The version of Dapr" + } + } + }, + "VnetConfiguration": { + "type": "object", + "description": "Configuration properties for apps environment to join a Virtual Network", + "properties": { + "internal": { + "type": "boolean", + "description": "Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "infrastructureSubnetId": { + "type": "string", + "description": "Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dockerBridgeCidr": { + "type": "string", + "description": "CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "platformReservedCidr": { + "type": "string", + "description": "IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "platformReservedDnsIP": { + "type": "string", + "description": " An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "Mtls": { + "type": "object", + "description": "Configuration properties for mutual TLS authentication", + "properties": { + "enabled": { + "type": "boolean", + "description": "Boolean indicating whether the mutual TLS authentication is enabled" + } + } + }, + "ManagedEnvironment": { + "description": "An environment for hosting container apps", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "kind": { + "type": "string", + "description": "Kind of the Environment." + }, + "identity": { + "description": "Managed identities for the Managed Environment to interact with other Azure services without maintaining any secrets or credentials in code.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "description": "Managed environment resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Waiting", + "InitializationInProgress", + "InfrastructureSetupInProgress", + "InfrastructureSetupComplete", + "ScheduledForDelete", + "UpgradeRequested", + "UpgradeFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EnvironmentProvisioningState", + "modelAsString": true + } + }, + "daprAIInstrumentationKey": { + "type": "string", + "description": "Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry", + "x-ms-secret": true + }, + "daprAIConnectionString": { + "type": "string", + "description": "Application Insights connection string used by Dapr to export Service to Service communication telemetry", + "x-ms-secret": true + }, + "vnetConfiguration": { + "description": "Vnet configuration for the environment", + "$ref": "#/definitions/VnetConfiguration" + }, + "deploymentErrors": { + "description": "Any errors that occurred during deployment or deployment validation", + "type": "string", + "readOnly": true + }, + "defaultDomain": { + "description": "Default Domain Name for the cluster", + "type": "string", + "readOnly": true + }, + "staticIp": { + "description": "Static IP of the Environment", + "type": "string", + "readOnly": true + }, + "appLogsConfiguration": { + "$ref": "#/definitions/AppLogsConfiguration", + "description": "Cluster configuration which enables the log daemon to export\napp logs to a destination. Currently only \"log-analytics\" is\nsupported" + }, + "appInsightsConfiguration": { + "$ref": "#/definitions/AppInsightsConfiguration", + "description": "Environment level Application Insights configuration" + }, + "openTelemetryConfiguration": { + "$ref": "#/definitions/OpenTelemetryConfiguration", + "description": "Environment Open Telemetry configuration" + }, + "zoneRedundant": { + "description": "Whether or not this Managed Environment is zone-redundant.", + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "customDomainConfiguration": { + "$ref": "./CommonDefinitions.json#/definitions/CustomDomainConfiguration", + "description": "Custom domain configuration for the environment" + }, + "eventStreamEndpoint": { + "description": "The endpoint of the eventstream of the Environment.", + "type": "string", + "readOnly": true + }, + "workloadProfiles": { + "description": "Workload profiles configured for the Managed Environment.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadProfile" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "kedaConfiguration": { + "$ref": "#/definitions/KedaConfiguration", + "description": "The configuration of Keda component." + }, + "daprConfiguration": { + "$ref": "#/definitions/DaprConfiguration", + "description": "The configuration of Dapr component." + }, + "infrastructureResourceGroup": { + "description": "Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "peerAuthentication": { + "description": "Peer authentication settings for the Managed Environment", + "type": "object", + "properties": { + "mtls": { + "description": "Mutual TLS authentication settings for the Managed Environment", + "$ref": "#/definitions/Mtls" + } + } + }, + "peerTrafficConfiguration": { + "description": "Peer traffic settings for the Managed Environment", + "type": "object", + "properties": { + "encryption": { + "description": "Peer traffic encryption settings for the Managed Environment", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Boolean indicating whether the peer traffic encryption is enabled" + } + } + } + } + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the resource.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'.", + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "ManagedEnvironmentsCollection": { + "description": "Collection of Environments", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "LogAnalyticsConfiguration": { + "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'", + "type": "object", + "properties": { + "customerId": { + "description": "Log analytics customer id", + "type": "string" + }, + "sharedKey": { + "description": "Log analytics customer key", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "dynamicJsonColumns": { + "description": "Boolean indicating whether to parse json string log into dynamic json columns", + "type": "boolean" + } + } + }, + "EnvironmentAuthToken": { + "description": "Environment Auth Token.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Environment auth token resource specific properties", + "type": "object", + "properties": { + "token": { + "description": "Auth token value.", + "type": "string", + "x-ms-secret": true, + "readOnly": true + }, + "expires": { + "format": "date-time", + "description": "Token expiration date.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "WorkloadProfile": { + "description": "Workload profile to scope container app execution.", + "type": "object", + "properties": { + "name": { + "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileName", + "description": "Workload profile type for the workloads to run on." + }, + "workloadProfileType": { + "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileType", + "description": "Workload profile type for the workloads to run on." + }, + "minimumCount": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity." + }, + "maximumCount": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity." + } + }, + "required": [ + "name", + "workloadProfileType" + ] + }, + "workloadProfileStates": { + "description": "Collection of all the workload Profile States for a Managed Environment..", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Workload Profile resource specific properties.", + "type": "object", + "properties": { + "minimumCount": { + "type": "integer", + "format": "int32", + "description": "Minimum count of instances." + }, + "maximumCount": { + "type": "integer", + "format": "int32", + "description": "Maximum count of nodes." + }, + "currentCount": { + "type": "integer", + "format": "int32", + "description": "Current count of nodes." + } + } + } + } + }, + "workloadProfileStatesCollection": { + "description": "Collection of workloadProfileStates", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/workloadProfileStates" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json new file mode 100644 index 000000000000..a09de762ccad --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json @@ -0,0 +1,302 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}/resiliencyPolicies": { + "get": { + "tags": [ + "DaprComponentResiliencyPolicies" + ], + "summary": "Get the resiliency policies for a Dapr component.", + "operationId": "DaprComponentResiliencyPolicies_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPoliciesCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Dapr component resiliency policies": { + "$ref": "./examples/DaprComponentResiliencyPolicies_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}/resiliencyPolicies/{name}": { + "get": { + "tags": [ + "DaprComponentResiliencyPolicies" + ], + "summary": "Get a Dapr component resiliency policy.", + "operationId": "DaprComponentResiliencyPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr Component Resiliency Policy.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPolicy" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Dapr component resiliency policy": { + "$ref": "./examples/DaprComponentResiliencyPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "DaprComponentResiliencyPolicies" + ], + "summary": "Creates or updates a Dapr component resiliency policy.", + "description": "Creates or updates a resiliency policy for a Dapr component.", + "operationId": "DaprComponentResiliencyPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr Component Resiliency Policy.", + "required": true, + "type": "string" + }, + { + "name": "daprComponentResiliencyPolicyEnvelope", + "in": "body", + "description": "Configuration details of the Dapr Component Resiliency Policy.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPolicy" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPolicy" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update dapr component resiliency policy with all options": { + "$ref": "./examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json" + }, + "Create or update dapr component resiliency policy with outbound policy only": { + "$ref": "./examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json" + }, + "Create or update dapr component resiliency policy with sparse options": { + "$ref": "./examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json" + } + } + }, + "delete": { + "tags": [ + "DaprComponentResiliencyPolicies" + ], + "summary": "Delete a Dapr component resiliency policy.", + "description": "Delete a resiliency policy for a Dapr component.", + "operationId": "DaprComponentResiliencyPolicies_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr Component Resiliency Policy.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Dapr component does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete dapr component resiliency policy": { + "$ref": "./examples/DaprComponentResiliencyPolicies_Delete.json" + } + }, + "x-ms-long-running-operation": false + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponents.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponents.json new file mode 100644 index 000000000000..5c46c3838bcd --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponents.json @@ -0,0 +1,313 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents": { + "get": { + "tags": [ + "DaprComponents" + ], + "summary": "Get the Dapr Components for a managed environment.", + "operationId": "DaprComponents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Dapr Components": { + "$ref": "./examples/DaprComponents_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}": { + "get": { + "tags": [ + "DaprComponents" + ], + "summary": "Get a dapr component.", + "operationId": "DaprComponents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Dapr Component with secrets": { + "$ref": "./examples/DaprComponents_Get_Secrets.json" + }, + "Get Dapr Component with secret store component": { + "$ref": "./examples/DaprComponents_Get_SecretStoreComponent.json" + } + } + }, + "put": { + "tags": [ + "DaprComponents" + ], + "summary": "Creates or updates a Dapr Component.", + "description": "Creates or updates a Dapr Component in a Managed Environment.", + "operationId": "DaprComponents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "name": "daprComponentEnvelope", + "in": "body", + "description": "Configuration details of the Dapr Component.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update dapr component with secrets": { + "$ref": "./examples/DaprComponents_CreateOrUpdate_Secrets.json" + }, + "Create or update dapr component with secret store component": { + "$ref": "./examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json" + } + } + }, + "delete": { + "tags": [ + "DaprComponents" + ], + "summary": "Delete a Dapr Component.", + "description": "Delete a Dapr Component from a Managed Environment.", + "operationId": "DaprComponents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Environment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete dapr component": { + "$ref": "./examples/DaprComponents_Delete.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}/listSecrets": { + "post": { + "tags": [ + "DaprComponents" + ], + "summary": "List secrets for a dapr component", + "operationId": "DaprComponents_ListSecrets", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSecretsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Secrets": { + "$ref": "./examples/DaprComponents_ListSecrets.json" + } + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprSubscriptions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprSubscriptions.json new file mode 100644 index 000000000000..c338438c86f6 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprSubscriptions.json @@ -0,0 +1,276 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprSubscriptions": { + "get": { + "tags": [ + "DaprSubscriptions" + ], + "summary": "Get the Dapr subscriptions for a managed environment.", + "operationId": "DaprSubscriptions_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscriptionsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Dapr subscriptions": { + "$ref": "./examples/DaprSubscriptions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprSubscriptions/{name}": { + "get": { + "tags": [ + "DaprSubscriptions" + ], + "summary": "Get a dapr subscription.", + "operationId": "DaprSubscriptions_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscription" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Dapr subscription with default route only": { + "$ref": "./examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json" + }, + "Get Dapr subscription with bulk subscribe configuration and scopes": { + "$ref": "./examples/DaprSubscriptions_Get_DefaultRoute.json" + }, + "GetDapr subscription with route rules and metadata": { + "$ref": "./examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json" + } + } + }, + "put": { + "tags": [ + "DaprSubscriptions" + ], + "summary": "Creates or updates a Dapr subscription.", + "description": "Creates or updates a Dapr subscription in a Managed Environment.", + "operationId": "DaprSubscriptions_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr subscription.", + "required": true, + "type": "string" + }, + { + "name": "daprSubscriptionEnvelope", + "in": "body", + "description": "Configuration details of the Dapr subscription.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscription" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscription" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update dapr subscription with default route only": { + "$ref": "./examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json" + }, + "Create or update dapr subscription with bulk subscribe configuration and scopes": { + "$ref": "./examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json" + }, + "Create or update dapr subscription with route rules and metadata": { + "$ref": "./examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json" + } + } + }, + "delete": { + "tags": [ + "DaprSubscriptions" + ], + "summary": "Delete a Dapr subscription.", + "description": "Delete a Dapr subscription from a Managed Environment.", + "operationId": "DaprSubscriptions_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Environment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete dapr subscription": { + "$ref": "./examples/DaprSubscriptions_Delete.json" + } + }, + "x-ms-long-running-operation": false + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsStorages.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsStorages.json new file mode 100644 index 000000000000..60e901e86b83 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsStorages.json @@ -0,0 +1,300 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages": { + "get": { + "tags": [ + "ManagedEnvironmentsStorages" + ], + "summary": "Get all storages for a managedEnvironment.", + "description": "Get all storages for a managedEnvironment.", + "operationId": "ManagedEnvironmentsStorages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentStoragesCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List environments storages by subscription": { + "$ref": "./examples/ManagedEnvironmentsStorages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}": { + "get": { + "tags": [ + "ManagedEnvironmentsStorages" + ], + "summary": "Get storage for a managedEnvironment.", + "description": "Get storage for a managedEnvironment.", + "operationId": "ManagedEnvironmentsStorages_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentStorage" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "get a environments storage": { + "$ref": "./examples/ManagedEnvironmentsStorages_Get.json" + }, + "get a environments storage for NFS Azure file": { + "$ref": "./examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironmentsStorages" + ], + "summary": "Create or update storage for a managedEnvironment.", + "description": "Create or update storage for a managedEnvironment.", + "operationId": "ManagedEnvironmentsStorages_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "name": "storageEnvelope", + "in": "body", + "description": "Configuration details of storage.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedEnvironmentStorage" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentStorage" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update environments storage": { + "$ref": "./examples/ManagedEnvironmentsStorages_CreateOrUpdate.json" + }, + "Create or update environments storage for NFS Azure file": { + "$ref": "./examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json" + } + } + }, + "delete": { + "tags": [ + "ManagedEnvironmentsStorages" + ], + "summary": "Delete storage for a managedEnvironment.", + "description": "Delete storage for a managedEnvironment.", + "operationId": "ManagedEnvironmentsStorages_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "Storage does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List environments storages by subscription": { + "$ref": "./examples/ManagedEnvironmentsStorages_Delete.json" + } + } + } + } + }, + "definitions": { + "ManagedEnvironmentStoragesCollection": { + "description": "Collection of Storage for Environments", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of storage resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedEnvironmentStorage" + } + } + } + }, + "ManagedEnvironmentStorage": { + "description": "Storage resource for managedEnvironment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Storage properties", + "type": "object", + "properties": { + "azureFile": { + "$ref": "./CommonDefinitions.json#/definitions/AzureFileProperties", + "description": "Azure file properties" + }, + "nfsAzureFile": { + "$ref": "./CommonDefinitions.json#/definitions/NfsAzureFileProperties", + "description": "NFS Azure file properties" + } + } + } + } + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/SessionPools.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/SessionPools.json new file mode 100644 index 000000000000..03349d08a356 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/SessionPools.json @@ -0,0 +1,703 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-02-02-preview" + }, + "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" + } + } + }, + "parameters": { + "SessionPoolNameParameter": { + "name": "sessionPoolName", + "in": "path", + "description": "Name of the session pool.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63 + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/sessionPools": { + "get": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Get the session pools in a given subscription.", + "operationId": "ContainerAppsSessionPools_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SessionPoolCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Session Pools by subscription": { + "$ref": "./examples/SessionPools_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools": { + "get": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Get the session pools in a given resource group of a subscription.", + "operationId": "ContainerAppsSessionPools_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SessionPoolCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Session Pools by resource group": { + "$ref": "./examples/SessionPools_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools/{sessionPoolName}": { + "get": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Get the properties of a session pool.", + "operationId": "ContainerAppsSessionPools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SessionPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Session Pool": { + "$ref": "./examples/SessionPools_Get.json" + } + } + }, + "put": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Create or update a session pool.", + "description": "Create or update a session pool with the given properties.", + "operationId": "ContainerAppsSessionPools_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SessionPoolNameParameter" + }, + { + "name": "sessionPoolEnvelope", + "in": "body", + "description": "Properties used to create a session pool", + "required": true, + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Update succeeded", + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + "201": { + "description": "Session pool creation has started.", + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or Update Session Pool": { + "$ref": "./examples/SessionPools_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Update properties of a session pool", + "description": "Patches a session pool using JSON merge patch", + "operationId": "ContainerAppsSessionPools_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SessionPoolNameParameter" + }, + { + "name": "sessionPoolEnvelope", + "in": "body", + "description": "Properties used to create a session pool", + "required": true, + "schema": { + "$ref": "#/definitions/SessionPoolUpdatableProperties" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Update succeeded", + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + "202": { + "description": "Session pool update has been started.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Update Session Pool": { + "$ref": "./examples/SessionPools_Patch.json" + } + } + }, + "delete": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Delete a session pool.", + "description": "Delete the session pool with the given name.", + "operationId": "ContainerAppsSessionPools_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SessionPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Session pool delete has been started.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Session pool does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Session Pool": { + "$ref": "./examples/SessionPools_Delete.json" + } + } + } + } + }, + "definitions": { + "ScaleConfiguration": { + "description": "Scale configuration.", + "type": "object", + "properties": { + "maxConcurrentSessions": { + "description": "The maximum count of sessions at the same time.", + "type": "integer", + "format": "int32" + }, + "readySessionInstances": { + "description": "The minimum count of ready session instances.", + "type": "integer", + "format": "int32" + } + } + }, + "SessionPoolSecret": { + "description": "Secret definition.", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string" + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "DynamicPoolConfiguration": { + "description": "Dynamic pool configuration.", + "type": "object", + "properties": { + "executionType": { + "description": "The execution type of the session pool.", + "enum": [ + "Timed" + ], + "type": "string", + "x-ms-enum": { + "name": "ExecutionType", + "modelAsString": true + } + }, + "cooldownPeriodInSeconds": { + "description": "The cooldown period of a session in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "SessionRegistryCredentials": { + "description": "Session pool private registry credentials.", + "type": "object", + "properties": { + "registryServer": { + "description": "Container registry server.", + "type": "string" + }, + "username": { + "description": "Container registry username.", + "type": "string" + }, + "passwordSecretRef": { + "description": "The name of the secret that contains the registry login password", + "type": "string" + } + } + }, + "SessionContainerResources": { + "description": "Container resource requirements for sessions of the session pool.", + "type": "object", + "properties": { + "cpu": { + "format": "double", + "description": "Required CPU in cores, e.g. 0.5", + "type": "number" + }, + "memory": { + "description": "Required memory, e.g. \"250Mb\"", + "type": "string" + } + } + }, + "SessionContainer": { + "description": "Container definitions for the sessions of the session pool.", + "type": "object", + "properties": { + "image": { + "description": "Container image tag.", + "type": "string" + }, + "name": { + "description": "Custom container name.", + "type": "string" + }, + "command": { + "description": "Container start command.", + "type": "array", + "items": { + "type": "string" + } + }, + "args": { + "description": "Container start command arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "env": { + "description": "Container environment variables.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVar" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resources": { + "$ref": "#/definitions/SessionContainerResources", + "description": "Container resource requirements." + } + } + }, + "SessionIngress": { + "description": "Session pool ingress configuration.", + "type": "object", + "properties": { + "targetPort": { + "format": "int32", + "description": "Target port in containers for traffic from ingress", + "type": "integer" + } + } + }, + "CustomContainerTemplate": { + "description": "Custom container configuration.", + "type": "object", + "properties": { + "registryCredentials": { + "description": "Private container registry credentials for containers used by the sessions of the session pool.", + "$ref": "#/definitions/SessionRegistryCredentials" + }, + "containers": { + "description": "List of container definitions for the sessions of the session pool.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "ingress": { + "description": "Session pool ingress configuration.", + "$ref": "#/definitions/SessionIngress" + } + } + }, + "SessionNetworkConfiguration": { + "description": "Session network configuration.", + "type": "object", + "properties": { + "status": { + "description": "Network status for the sessions.", + "type": "string", + "enum": [ + "EgressEnabled", + "EgressDisabled" + ], + "x-ms-enum": { + "name": "SessionNetworkStatus", + "modelAsString": true + } + } + } + }, + "SessionPool": { + "description": "Container App session pool.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Container App session pool resource specific properties", + "type": "object", + "properties": { + "environmentId": { + "description": "Resource ID of the session pool's environment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.App/managedEnvironments" + } + ] + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "containerType": { + "description": "The container type of the sessions.", + "enum": [ + "CustomContainer", + "PythonLTS" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true + } + }, + "poolManagementType": { + "description": "The pool management type of the session pool.", + "enum": [ + "Manual", + "Dynamic" + ], + "type": "string", + "x-ms-enum": { + "name": "PoolManagementType", + "modelAsString": true + } + }, + "nodeCount": { + "description": "The number of nodes the session pool is using.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "scaleConfiguration": { + "description": "The scale configuration of the session pool.", + "$ref": "#/definitions/ScaleConfiguration" + }, + "secrets": { + "description": "The secrets of the session pool.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionPoolSecret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "dynamicPoolConfiguration": { + "description": "The pool configuration if the poolManagementType is dynamic.", + "$ref": "#/definitions/DynamicPoolConfiguration" + }, + "customContainerTemplate": { + "description": "The custom container configuration if the containerType is CustomContainer.", + "$ref": "#/definitions/CustomContainerTemplate" + }, + "sessionNetworkConfiguration": { + "description": "The network configuration of the sessions in the session pool.", + "$ref": "#/definitions/SessionNetworkConfiguration" + }, + "poolManagementEndpoint": { + "description": "The endpoint to manage the pool.", + "type": "string", + "format": "uri", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the session pool.", + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SessionPoolProvisioningState", + "modelAsString": true + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "SessionPoolUpdatableProperties": { + "description": "Container App session pool updatable properties.", + "type": "object", + "properties": { + "properties": { + "description": "Session pool resource specific updatable properties.", + "type": "object", + "properties": { + "scaleConfiguration": { + "description": "The scale configuration of the session pool.", + "$ref": "#/definitions/ScaleConfiguration" + }, + "secrets": { + "description": "The secrets of the session pool.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionPoolSecret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "dynamicPoolConfiguration": { + "description": "The pool configuration if the poolManagementType is dynamic.", + "$ref": "#/definitions/DynamicPoolConfiguration" + }, + "customContainerTemplate": { + "description": "The custom container configuration if the containerType is CustomContainer.", + "$ref": "#/definitions/CustomContainerTemplate" + }, + "sessionNetworkConfiguration": { + "description": "The network configuration of the sessions in the session pool.", + "$ref": "#/definitions/SessionNetworkConfiguration" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SessionPoolCollection": { + "description": "Session pool collection Azure resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionPool" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/SourceControls.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/SourceControls.json new file mode 100644 index 000000000000..17e323d29504 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/SourceControls.json @@ -0,0 +1,456 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols": { + "get": { + "tags": [ + "ContainerAppsSourceControls" + ], + "summary": "Get the Container App SourceControls in a given resource group.", + "operationId": "ContainerAppsSourceControls_ListByContainerApp", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControlCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App's Source Controls": { + "$ref": "./examples/SourceControls_ListByContainer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}": { + "get": { + "tags": [ + "ContainerAppsSourceControls" + ], + "summary": "Get a SourceControl of a Container App.", + "operationId": "ContainerAppsSourceControls_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "sourceControlName", + "in": "path", + "description": "Name of the Container App SourceControl.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's SourceControl": { + "$ref": "./examples/SourceControls_Get.json" + } + } + }, + "put": { + "tags": [ + "ContainerAppsSourceControls" + ], + "summary": "Create or update the SourceControl for a Container App.", + "description": "Create or update the SourceControl for a Container App.", + "operationId": "ContainerAppsSourceControls_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "sourceControlName", + "in": "path", + "description": "Name of the Container App SourceControl.", + "required": true, + "type": "string" + }, + { + "name": "sourceControlEnvelope", + "in": "body", + "description": "Properties used to create a Container App SourceControl", + "required": true, + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Container App SourceControl": { + "$ref": "./examples/SourceControls_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ContainerAppsSourceControls" + ], + "summary": "Delete a Container App SourceControl.", + "description": "Delete a Container App SourceControl.", + "operationId": "ContainerAppsSourceControls_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "sourceControlName", + "in": "path", + "description": "Name of the Container App SourceControl.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App SourceControl deleted successfully." + }, + "202": { + "description": "Delete operation is in progress." + }, + "204": { + "description": "Container App SourceControl does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Container App SourceControl": { + "$ref": "./examples/SourceControls_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "SourceControl": { + "description": "Container App SourceControl.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SourceControl resource specific properties", + "type": "object", + "properties": { + "operationState": { + "description": "Current provisioning State of the operation", + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SourceControlOperationState", + "modelAsString": true + } + }, + "repoUrl": { + "description": "The repo url which will be integrated to ContainerApp.", + "type": "string" + }, + "branch": { + "description": "The branch which will trigger the auto deployment", + "type": "string" + }, + "githubActionConfiguration": { + "$ref": "#/definitions/GithubActionConfiguration", + "description": "Container App Revision Template with all possible settings and the\ndefaults if user did not provide them. The defaults are populated\nas they were at the creation time" + } + }, + "x-ms-client-flatten": true + } + } + }, + "GithubActionConfiguration": { + "description": "Configuration properties that define the mutable settings of a Container App SourceControl", + "type": "object", + "properties": { + "registryInfo": { + "$ref": "#/definitions/RegistryInfo", + "description": "Registry configurations." + }, + "azureCredentials": { + "$ref": "#/definitions/AzureCredentials", + "description": "AzureCredentials configurations." + }, + "contextPath": { + "description": "Context path", + "type": "string" + }, + "githubPersonalAccessToken": { + "description": "One time Github PAT to configure github environment", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "image": { + "description": "Image name", + "type": "string" + }, + "publishType": { + "description": "Code or Image", + "type": "string" + }, + "os": { + "description": "Operation system", + "type": "string" + }, + "runtimeStack": { + "description": "Runtime stack", + "type": "string" + }, + "runtimeVersion": { + "description": "Runtime version", + "type": "string" + }, + "buildEnvironmentVariables": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of environment variables to be passed to the build." + } + } + }, + "RegistryInfo": { + "description": "Container App registry information.", + "type": "object", + "properties": { + "registryUrl": { + "description": "registry server Url.", + "type": "string" + }, + "registryUserName": { + "description": "registry username.", + "type": "string" + }, + "registryPassword": { + "description": "registry secret.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "AzureCredentials": { + "description": "Container App credentials.", + "type": "object", + "properties": { + "clientId": { + "description": "Client Id.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "clientSecret": { + "description": "Client Secret.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "tenantId": { + "description": "Tenant Id.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "kind": { + "description": "Kind of auth github does for deploying the template", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "subscriptionId": { + "description": "Subscription Id.", + "type": "string" + } + } + }, + "SourceControlCollection": { + "description": "SourceControl collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SourceControl" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Subscriptions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Subscriptions.json new file mode 100644 index 000000000000..6a74297a95c1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Subscriptions.json @@ -0,0 +1,80 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/getCustomDomainVerificationId": { + "post": { + "tags": [ + "Subscriptions" + ], + "description": "Get the verification id of a subscription used for verifying custom domains", + "operationId": "GetCustomDomainVerificationId", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The custom domain verification id has been returned successfully.", + "schema": { + "$ref": "#/definitions/CustomDomainVerificationId" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List all operations": { + "$ref": "./examples/Subscriptions_GetCustomDomainVerificationId.json" + } + } + } + } + }, + "definitions": { + "CustomDomainVerificationId": { + "description": "Custom domain verification Id of a subscription", + "type": "string", + "readOnly": true + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Usages.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Usages.json new file mode 100644 index 000000000000..6de8b6dc6612 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Usages.json @@ -0,0 +1,188 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "Usages_List", + "description": "Gets, for the specified location, the current resource usage information as well as the limits under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List usages": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "ManagedEnvironmentUsages_List", + "description": "Gets the current usage information as well as the limits for environment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed environment usages": { + "$ref": "./examples/ManagedEnvironmentUsages_List.json" + } + } + } + } + }, + "definitions": { + "UsageName": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "number", + "format": "float", + "description": "The current usage of the resource." + }, + "limit": { + "type": "number", + "format": "float", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_CreateOrUpdate.json new file mode 100644 index 000000000000..1d8c86039dad --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_CreateOrUpdate.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "name": "resiliency-policy-1", + "api-version": "2024-02-02-preview", + "resiliencyEnvelope": { + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Delete.json new file mode 100644 index 000000000000..6a0df0ab8a98 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "name": "resiliency-policy-1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Get.json new file mode 100644 index 000000000000..64ef21559efa --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "name": "resiliency-policy-1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_List.json new file mode 100644 index 000000000000..8457479a162f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_List.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Patch.json new file mode 100644 index 000000000000..0f881c276fa2 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AppResiliency_Patch.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "name": "resiliency-policy-1", + "api-version": "2024-02-02-preview", + "resiliencyEnvelope": { + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 30, + "connectionTimeoutInSeconds": 40 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 30, + "connectionTimeoutInSeconds": 40 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_CreateOrUpdate.json new file mode 100644 index 000000000000..5150f276ddba --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_CreateOrUpdate.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "authConfigName": "current", + "api-version": "2024-02-02-preview", + "authConfigEnvelope": { + "properties": { + "platform": { + "enabled": true + }, + "globalValidation": { + "unauthenticatedClientAction": "AllowAnonymous" + }, + "identityProviders": { + "facebook": { + "registration": { + "appId": "123", + "appSecretSettingName": "facebook-secret" + } + } + }, + "encryptionSettings": { + "containerAppAuthEncryptionSecretName": "testEncryptionSecretName", + "containerAppAuthSigningSecretName": "testSigningSecretName" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/authconfigs/current", + "name": "current", + "type": "Microsoft.App/containerapps/authconfigs", + "properties": { + "platform": { + "enabled": true + }, + "globalValidation": { + "unauthenticatedClientAction": "AllowAnonymous" + }, + "identityProviders": { + "facebook": { + "registration": { + "appId": "123", + "appSecretSettingName": "facebook-secret" + } + } + }, + "encryptionSettings": { + "containerAppAuthEncryptionSecretName": "testEncryptionSecretName", + "containerAppAuthSigningSecretName": "testSigningSecretName" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_Delete.json new file mode 100644 index 000000000000..76c3422b8a3e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "authConfigName": "current", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_Get.json new file mode 100644 index 000000000000..38216caa89d1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "authConfigName": "current", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/authconfigs/current", + "name": "current", + "type": "Microsoft.App/containerapps/authconfigs", + "properties": { + "platform": { + "enabled": true + }, + "globalValidation": { + "unauthenticatedClientAction": "AllowAnonymous" + }, + "identityProviders": { + "facebook": { + "registration": { + "appId": "123", + "appSecretSettingName": "facebook-secret" + } + } + }, + "encryptionSettings": { + "containerAppAuthEncryptionSecretName": "testEncryptionSecretName", + "containerAppAuthSigningSecretName": "testSigningSecretName" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_ListByContainer.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_ListByContainer.json new file mode 100644 index 000000000000..031938f66bb1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AuthConfigs_ListByContainer.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/authconfigs/current", + "name": "current", + "type": "Microsoft.App/containerapps/authconfigs", + "properties": { + "platform": { + "enabled": true + }, + "globalValidation": { + "unauthenticatedClientAction": "AllowAnonymous" + }, + "identityProviders": { + "facebook": { + "registration": { + "appId": "123", + "appSecretSettingName": "facebook-secret" + } + } + }, + "encryptionSettings": { + "containerAppAuthEncryptionSecretName": "testEncryptionSecretName", + "containerAppAuthSigningSecretName": "testSigningSecretName" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AvailableWorkloadProfiles_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AvailableWorkloadProfiles_Get.json new file mode 100644 index 000000000000..1d3d157f5eb7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/AvailableWorkloadProfiles_Get.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "East US", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "East US", + "properties": { + "displayName": "Dedicated-D4", + "category": "General purpose D-series", + "applicability": "LocationDefault", + "cores": 4, + "memoryGiB": 16 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-D4", + "name": "Dedicated-D4", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-D8", + "category": "General purpose D-series", + "applicability": "Custom", + "cores": 8, + "memoryGiB": 32 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-D8", + "name": "Dedicated-D4", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-D16", + "category": "General purpose D-series", + "applicability": "Custom", + "cores": 16, + "memoryGiB": 64 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-D16", + "name": "Dedicated-D16", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-E4", + "category": "Memory optimized E-series", + "applicability": "Custom", + "cores": 4, + "memoryGiB": 32 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-E4", + "name": "Dedicated-E4", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-E8", + "category": "Memory optimized E-series", + "applicability": "Custom", + "cores": 8, + "memoryGiB": 64 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-E8", + "name": "Dedicated-E8", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-E16", + "category": "Memory optimized E-series", + "applicability": "Custom", + "cores": 16, + "memoryGiB": 128 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-E16", + "name": "Dedicated-E16", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-F4", + "category": "Compute optimized F-series", + "applicability": "Custom", + "cores": 4, + "memoryGiB": 8 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-F4", + "name": "Dedicated-F4", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-F8", + "category": "Compute optimized F-series", + "applicability": "Custom", + "cores": 8, + "memoryGiB": 16 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-F8", + "name": "Dedicated-F8", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-F16", + "category": "Compute optimized F-series", + "applicability": "Custom", + "cores": 16, + "memoryGiB": 32 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-F16", + "name": "Dedicated-F16", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-NC48-A100", + "category": "GPU-NC-A100", + "applicability": "Custom", + "cores": 48, + "memoryGiB": 440, + "gpus": 2 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/NC48-A100", + "name": "NC48-A100", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Consumption", + "category": "Consumption", + "applicability": "Custom", + "cores": 3, + "memoryGiB": 3 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Consumption", + "name": "Consumption", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/BillingMeters_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/BillingMeters_Get.json new file mode 100644 index 000000000000..be1d6e091a4d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/BillingMeters_Get.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "East US", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "East US", + "properties": { + "category": "General purpose D-series", + "meterType": "CPU", + "displayName": "General Purpose Cores per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/GeneralPurposeDseriesCPU", + "name": "GeneralPurposeDseriesCPU", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "General purpose D-series", + "meterType": "Memory", + "displayName": "General Purpose Memory GiB per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/GeneralPurposeDseriesMemory", + "name": "GeneralPurposeDseriesMemory", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "Memory optimized E-series", + "meterType": "CPU", + "displayName": "Memory Optimized Cores per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/MemoryOptimizedEseriesCPU", + "name": "MemoryOptimizedEseriesCPU", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "Memory optimized E-series", + "meterType": "Memory", + "displayName": "Memory Optimized Memory GiB per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/MemoryOptimizedEseriesMemory", + "name": "MemoryOptimizedEseriesMemory", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "Compute optimized F-series", + "meterType": "CPU", + "displayName": "Compute Optimized Cores per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/ComputeOptimizedFseriesCPU", + "name": "ComputeOptimizedFseriesCPU", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "Compute optimized F-series", + "meterType": "Memory", + "displayName": "Compute Optimized Memory GiB per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/GeneralComputeMemory", + "name": "GeneralComputeMemory", + "type": "Microsoft.App/billingMeters" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_CreateOrUpdate.json new file mode 100644 index 000000000000..f28b2b4b39e6 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_CreateOrUpdate.json @@ -0,0 +1,128 @@ +{ + "operationId": "Builders_CreateOrUpdate", + "title": "Builders_CreateOrUpdate_0", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "api-version": "2024-02-02-preview", + "builderEnvelope": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "tags": { + "company": "Microsoft" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder", + "name": "testBuilder", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "company": "Microsoft" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder", + "name": "testBuilder", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Creating", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "company": "Microsoft" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Delete.json new file mode 100644 index 000000000000..3e27c17b4a63 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Delete.json @@ -0,0 +1,18 @@ +{ + "operationId": "Builders_Delete", + "title": "Builders_Delete_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Get.json new file mode 100644 index 000000000000..8f0e63a2bb0f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Get.json @@ -0,0 +1,56 @@ +{ + "operationId": "Builders_Get", + "title": "Builders_Get_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder", + "name": "testBuilder", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_ListByResourceGroup.json new file mode 100644 index 000000000000..92d5543fc20f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_ListByResourceGroup.json @@ -0,0 +1,102 @@ +{ + "operationId": "Builders_ListByResourceGroup", + "title": "Builders_ListByResourceGroup_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder1", + "name": "testBuilder1", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder2", + "name": "testBuilder2", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_ListBySubscription.json new file mode 100644 index 000000000000..efbef655455c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_ListBySubscription.json @@ -0,0 +1,101 @@ +{ + "operationId": "Builders_ListBySubscription", + "title": "Builders_ListBySubscription_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.App/builders/testBuilder1", + "name": "testBuilder1", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg2/providers/Microsoft.App/builders/testBuilder2", + "name": "testBuilder2", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Update.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Update.json new file mode 100644 index 000000000000..d9eb9d549837 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builders_Update.json @@ -0,0 +1,66 @@ +{ + "operationId": "Builders_Update", + "title": "Builders_Update_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "builderEnvelope": { + "tags": { + "mytag1": "myvalue1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder", + "name": "testBuilder", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "mytag1": "myvalue1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_CreateOrUpdate.json new file mode 100644 index 000000000000..8b96db97826f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_CreateOrUpdate.json @@ -0,0 +1,214 @@ +{ + "operationId": "Builds_CreateOrUpdate", + "title": "Builds_CreateOrUpdate_WithConfig", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild-123456789az", + "api-version": "2024-02-02-preview", + "buildEnvelope": { + "properties": { + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild-123456789az", + "name": "testBuild-123456789az", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/build", + "properties": { + "provisioningState": "Creating", + "buildStatus": "NotStarted", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_CreateOrUpdate_NoConfig.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_CreateOrUpdate_NoConfig.json new file mode 100644 index 000000000000..c1d10a677cec --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_CreateOrUpdate_NoConfig.json @@ -0,0 +1,61 @@ +{ + "operationId": "Builds_CreateOrUpdate", + "title": "Builds_CreateOrUpdate_NoConfig", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild", + "api-version": "2024-02-02-preview", + "buildEnvelope": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/build", + "properties": { + "provisioningState": "Creating", + "buildStatus": "InProgress", + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_Delete.json new file mode 100644 index 000000000000..6c651e9aad9c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "Builds_Delete", + "title": "Builds_Delete_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_Get.json new file mode 100644 index 000000000000..63934edc08e3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_Get.json @@ -0,0 +1,85 @@ +{ + "operationId": "Builds_Get", + "title": "Builds_Get_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_ListAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_ListAuthToken.json new file mode 100644 index 000000000000..632042f3c1fb --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_ListAuthToken.json @@ -0,0 +1,20 @@ +{ + "operationId": "Builds_ListAuthToken", + "title": "Builds_ListAuthToken_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "token": "foobartoken", + "expires": "2022-07-14T19:22:50.3080223Z" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_ListByBuilderResource.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_ListByBuilderResource.json new file mode 100644 index 000000000000..5a9520e79299 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Builds_ListByBuilderResource.json @@ -0,0 +1,159 @@ +{ + "operationId": "Builds_ListByBuilderResource", + "title": "Builds_ListByBuilderResource_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild1", + "name": "testBuild1", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild2", + "name": "testBuild2", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_CreateOrUpdate.json new file mode 100644 index 000000000000..5999caa31c96 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_CreateOrUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview", + "certificateEnvelope": { + "location": "East US", + "properties": { + "password": "private key password", + "value": "Y2VydA==", + "certificateType": "ImagePullTrustedCA" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ImagePullTrustedCA" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_CreateOrUpdate_FromKeyVault.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_CreateOrUpdate_FromKeyVault.json new file mode 100644 index 000000000000..1cdb9a9cba67 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_CreateOrUpdate_FromKeyVault.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview", + "certificateEnvelope": { + "location": "East US", + "properties": { + "certificateKeyVaultProperties": { + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi", + "keyVaultUrl": "https://xxxxxxxx.vault.azure.net/certificates/certName" + }, + "certificateType": "ServerSSLCertificate" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "certificateKeyVaultProperties": { + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi", + "keyVaultUrl": "https://xxxxxxxx.vault.azure.net/certificates/certName" + }, + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ServerSSLCertificate" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_Delete.json new file mode 100644 index 000000000000..f515650196b0 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_Get.json new file mode 100644 index 000000000000..12f7cd09e941 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificate_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ServerSSLCertificate" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_CheckNameAvailability.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_CheckNameAvailability.json new file mode 100644 index 000000000000..4c1f99f96a9b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_CheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "checkNameAvailabilityRequest": { + "name": "testcertificatename", + "type": "Microsoft.App/managedEnvironments/certificates" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_ListByManagedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_ListByManagedEnvironment.json new file mode 100644 index 000000000000..3fde4ee0eafb --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_ListByManagedEnvironment.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ImagePullTrustedCA" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ServerSSLCertificate" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_Patch.json new file mode 100644 index 000000000000..9f7cc066f5d2 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Certificates_Patch.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview", + "certificateEnvelope": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ServerSSLCertificate" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json new file mode 100644 index 000000000000..027d91161400 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview", + "certificateEnvelope": { + "location": "East US", + "properties": { + "password": "private key password", + "value": "Y2VydA==" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certififcates/certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_Delete.json new file mode 100644 index 000000000000..bd41f8b4c136 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_Get.json new file mode 100644 index 000000000000..a9c55d528421 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificate_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json new file mode 100644 index 000000000000..adc6081e5268 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "checkNameAvailabilityRequest": { + "name": "testcertificatename", + "type": "Microsoft.App/connectedEnvironments/certificates" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json new file mode 100644 index 000000000000..99ad8cbee8b6 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_Patch.json new file mode 100644 index 000000000000..4688ad3c86a3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsCertificates_Patch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview", + "certificateEnvelope": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json new file mode 100644 index 000000000000..c5570c1d6e5a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview", + "daprComponentEnvelope": { + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey", + "value": "keyvalue" + } + ], + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/connectedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_Delete.json new file mode 100644 index 000000000000..9944ae43caf3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_Get.json new file mode 100644 index 000000000000..75780289169f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_Get.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/connectedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_List.json new file mode 100644 index 000000000000..80ed9c2a64d5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/myenvironment/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/connectedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json new file mode 100644 index 000000000000..c29291d8d943 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "secret1", + "value": "value1" + }, + { + "name": "secret2", + "value": "value2" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json new file mode 100644 index 000000000000..13c87a897df6 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "env", + "storageName": "jlaw-demo1", + "api-version": "2024-02-02-preview", + "storageEnvelope": { + "properties": { + "azureFile": { + "accountName": "account1", + "accountKey": "key", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/env/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/connectedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_Delete.json new file mode 100644 index 000000000000..b3781009d837 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "env", + "storageName": "jlaw-demo1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_Get.json new file mode 100644 index 000000000000..b7d638b8e36d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "env", + "storageName": "jlaw-demo1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/env/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/connectedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_List.json new file mode 100644 index 000000000000..9988502db243 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironmentsStorages_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "managedEnv", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/connectedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_CreateOrUpdate.json new file mode 100644 index 000000000000..ce2d0c0ca46c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_CreateOrUpdate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testenv", + "api-version": "2024-02-02-preview", + "kind": "kubernetes", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "environmentEnvelope": { + "location": "East US", + "properties": { + "staticIp": "1.2.3.4", + "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", + "customDomainConfiguration": { + "dnsSuffix": "www.my-name.com", + "certificateValue": "Y2VydA==", + "certificatePassword": "private key password" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testenv", + "name": "testenv", + "type": "Microsoft.App/connectedEnvironments", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testenv.k4apps.io", + "staticIp": "1.2.3.4", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testenv", + "name": "testenv", + "type": "Microsoft.App/connectedEnvironments", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Waiting", + "deploymentErrors": null, + "defaultDomain": "testenv.k4apps.io", + "staticIp": "1.2.3.4" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Delete.json new file mode 100644 index 000000000000..b5367dc0d0e3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "examplekenv", + "api-version": "2024-02-02-preview", + "kind": "kubernetes", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/localtions/eastus/operationResults/00000" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Get.json new file mode 100644 index 000000000000..4a9fa4280769 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "examplekenv", + "api-version": "2024-02-02-preview", + "kind": "kubernetes", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/examplekenv", + "name": "examplekenv", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "examplekenv.k4apps.io", + "staticIp": "20.42.33.145", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_ListByResourceGroup.json new file mode 100644 index 000000000000..de227a641cd7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_ListByResourceGroup.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample1", + "name": "sample1", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "sample1.k4apps.io", + "staticIp": "20.42.33.145", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample2", + "name": "sample2", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "sample2.k4apps.io", + "staticIp": "52.142.21.61", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name2.com", + "subjectName": "CN=www.my-name2.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_ListBySubscription.json new file mode 100644 index 000000000000..6c18b5f2a7cf --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample1", + "name": "sample1", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "sample1.k4apps.io", + "staticIp": "20.42.33.145", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.App/connectedEnvironments/sample2", + "name": "sample2", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "sample2.k4apps.io", + "staticIp": "52.142.21.61", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name2.com", + "subjectName": "CN=www.my-name2.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Patch.json new file mode 100644 index 000000000000..5042a0c63ec8 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ConnectedEnvironments_Patch.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testenv", + "api-version": "2024-02-02-preview", + "location": "East US", + "environmentEnvelope": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testenv", + "name": "testenv", + "type": "Microsoft.App/connectedEnvironments", + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testenv.k4apps.io", + "staticIp": "20.42.33.145", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_Delete.json new file mode 100644 index 000000000000..a6e7dd629aae --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "ContainerAppsBuilds_Delete", + "title": "ContainerAppsBuilds_Delete_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "testCapp", + "buildName": "testBuild" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_Get.json new file mode 100644 index 000000000000..d97fb1076f11 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_Get.json @@ -0,0 +1,83 @@ +{ + "operationId": "ContainerAppsBuilds_Get", + "title": "ContainerAppsBuilds_Get_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "testCapp", + "buildName": "testBuild" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/containerApps/testCapp/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/containerApps/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_ListByContainerApp.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_ListByContainerApp.json new file mode 100644 index 000000000000..c9ecb1116a04 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsBuilds_ListByContainerApp.json @@ -0,0 +1,155 @@ +{ + "operationId": "ContainerAppsBuildsByContainerApp_List", + "title": "ContainerAppsBuilds_ListByContainerApp_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "testCapp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/containerApps/testCapp/builds/testBuild1", + "name": "testBuild1", + "type": "Microsoft.App/containerApps/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/containerApps/testCapp/builds/testBuild2", + "name": "testBuild2", + "type": "Microsoft.App/containerApps/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsDiagnostics_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsDiagnostics_Get.json new file mode 100644 index 000000000000..4ac6ca21c9f4 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsDiagnostics_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "containerAppName": "mikono-capp-stage1", + "detectorName": "cappcontainerappnetworkIO", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/containerApps/mikono-capp-stage1/detectors/cappcontainerappnetworkIO", + "name": "cappcontainerappnetworkIO", + "type": "Microsoft.App/containerapps/detectors", + "properties": { + "metadata": { + "id": "cappcontainerappnetworkIO", + "name": "Container App Network Inbound and Outbound", + "description": "This detector shows the Container App Network Inbound and Outbound.", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Detector", + "score": 0 + }, + "dataset": [ + { + "table": { + "tableName": "", + "columns": [ + { + "columnName": "TimeStamp", + "dataType": "DateTime" + }, + { + "columnName": "Metric", + "dataType": "String" + }, + { + "columnName": "Average", + "dataType": "Double" + } + ], + "rows": [ + [ + "2022-03-15T21:35:00", + "RxBytes", + 0 + ] + ] + }, + "renderingProperties": { + "type": 8, + "title": "Container Apps Network Inbound ", + "description": "", + "isVisible": true + } + } + ], + "status": { + "statusId": 3 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsDiagnostics_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsDiagnostics_List.json new file mode 100644 index 000000000000..5ecd6ed14c8c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsDiagnostics_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "containerAppName": "mikono-capp-stage1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/containerApps/mikono-capp-stage1/detectors/cappContainerAppAvailabilityMetrics", + "name": "cappContainerAppAvailabilityMetrics", + "type": "Microsoft.App/containerapps/detectors", + "properties": { + "metadata": { + "id": "cappContainerAppAvailabilityMetrics", + "name": "Availability Metrics for Container Apps", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Analysis", + "score": 0 + }, + "dataset": [], + "status": { + "statusId": 4 + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Apply.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Apply.json new file mode 100644 index 000000000000..80d7f5ad06d7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Apply.json @@ -0,0 +1,53 @@ +{ + "operationId": "ContainerAppsPatches_Apply", + "title": "ContainerAppsPatches_Apply_0", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app", + "patchName": "testPatch-25fe4b", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app/patches/testPatch-25fe4b", + "name": "testPatch-25fe4b", + "type": "Microsoft.App/containerApps/patches", + "properties": { + "targetEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/test-env", + "targetContainerAppId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app", + "targetRevisionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/apps/test-app/revisions/test-app--jm3vvry", + "patchApplyStatus": "Succeeded", + "createdAt": "2022-10-10T12:06:20.3421+00:00", + "lastModifiedAt": "2022-10-10T12:06:20.3421+00:00", + "patchDetails": [ + { + "targetContainerName": "test-container", + "targetImage": "testregistry.azurecr.io/test-image:latest", + "lastDetectionTime": "2022-10-10T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:latest-patched-202210101206", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.5-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.5", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + } + ] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Delete.json new file mode 100644 index 000000000000..04efed473e0b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "ContainerAppsPatches_Delete", + "title": "ContainerAppsPatches_Delete_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app", + "patchName": "testPatch-25fe4b" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Get.json new file mode 100644 index 000000000000..ea4f21e49a65 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Get.json @@ -0,0 +1,48 @@ +{ + "operationId": "ContainerAppsPatches_Get", + "title": "ContainerAppsPatches_Get_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app", + "patchName": "testPatch-25fe4b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app/patches/testPatch-25fe4b", + "name": "testPatch-25fe4b", + "type": "Microsoft.App/containerApps/patches", + "properties": { + "targetEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/test-env", + "targetContainerAppId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app", + "targetRevisionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/apps/test-app/revisions/test-app--jm3vvry", + "patchApplyStatus": "NotStarted", + "createdAt": "2022-10-10T12:06:20.3421+00:00", + "lastModifiedAt": "2022-10-10T12:06:20.3421+00:00", + "patchDetails": [ + { + "targetContainerName": "test-container", + "targetImage": "testregistry.azurecr.io/test-image:latest", + "lastDetectionTime": "2022-10-10T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:latest-patched-202210101206", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.5-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.5", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_ListByContainerApp.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_ListByContainerApp.json new file mode 100644 index 000000000000..cd681fe2c7df --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_ListByContainerApp.json @@ -0,0 +1,103 @@ +{ + "operationId": "ContainerAppsPatches_ListByContainerApp", + "title": "ContainerAppsPatches_ListByContainerApp_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app/patches/testPatch-25fe4b", + "name": "testPatch-25fe4b", + "type": "Microsoft.App/containerApps/patches", + "properties": { + "targetEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/test-env", + "targetContainerAppId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app", + "targetRevisionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/apps/test-app/revisions/test-app--jm3vvry", + "patchApplyStatus": "NotStarted", + "createdAt": "2022-10-10T12:06:20.3421+00:00", + "lastModifiedAt": "2022-10-10T12:06:20.3421+00:00", + "patchDetails": [ + { + "targetContainerName": "test-container", + "targetImage": "testregistry.azurecr.io/test-image:release-1-patched-202209101206203421", + "lastDetectionTime": "2022-10-10T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:release-1-patched-202210101206185241", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.9-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.9", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app/patches/testPatch-27c3d5", + "name": "testPatch-27c3d5", + "type": "Microsoft.App/containerApps/patches", + "properties": { + "targetEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/test-env", + "targetContainerAppId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app", + "targetRevisionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app2/revisions/test-app--z79h4oc", + "patchApplyStatus": "Succeeded", + "createdAt": "2022-09-10T12:06:20.3421+00:00", + "lastModifiedAt": "2022-09-20T12:06:20.3421+00:00", + "patchDetails": [ + { + "targetContainerName": "test-container", + "targetImage": "testregistry.azurecr.io/test-image:release-1", + "lastDetectionTime": "2022-09-21T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:release-1-patched-202209101206203421", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.5-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.5", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + }, + { + "targetContainerName": "test-container-2", + "targetImage": "testregistry.azurecr.io/test-image:release-2", + "lastDetectionTime": "2022-09-21T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:release-2-patched-202209101206203421", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.0-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.0", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Skip_Configure.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Skip_Configure.json new file mode 100644 index 000000000000..d163e0735848 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerAppsPatches_Skip_Configure.json @@ -0,0 +1,21 @@ +{ + "operationId": "ContainerAppsPatches_SkipConfigure", + "title": "ContainerAppsPatches_Skip_Configure_0", + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app", + "patchName": "testPatch-25fe4b", + "patchSkipConfig": { + "skip": true + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CheckNameAvailability.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CheckNameAvailability.json new file mode 100644 index 000000000000..f2817a3b7128 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "checkNameAvailabilityRequest": { + "name": "testcappname", + "type": "Microsoft.App/containerApps" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CreateOrUpdate.json new file mode 100644 index 000000000000..264e6e8897d7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CreateOrUpdate.json @@ -0,0 +1,654 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview", + "containerAppEnvelope": { + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": {} + } + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerApp0-ab1234", + "label": "production" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "clientCertificateMode": "accept", + "corsPolicy": { + "allowedOrigins": [ + "https://a.test.com", + "https://b.test.com" + ], + "allowedMethods": [ + "GET", + "POST" + ], + "allowedHeaders": [ + "HEADER1", + "HEADER2" + ], + "exposeHeaders": [ + "HEADER3", + "HEADER4" + ], + "maxAge": 1234, + "allowCredentials": true + }, + "additionalPortMappings": [ + { + "external": true, + "targetPort": 1234 + }, + { + "external": false, + "targetPort": 2345, + "exposedPort": 3456 + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + }, + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v1", + "name": "testcontainerApp0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "custom": { + "type": "http", + "metadata": { + "concurrentRequests": "50" + } + } + }, + { + "name": "servicebus", + "custom": { + "type": "azure-servicebus", + "metadata": { + "queueName": "myqueue", + "namespace": "mynamespace", + "messageCount": "5" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + }, + { + "name": "azure-queue", + "azureQueue": { + "accountName": "account1", + "queueName": "queue1", + "queueLength": 1, + "identity": "system" + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/redisService", + "name": "redisService", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + }, + { + "name": "servicebus", + "custom": { + "type": "azure-servicebus", + "metadata": { + "queueName": "myqueue", + "namespace": "mynamespace", + "messageCount": "5" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + }, + { + "name": "azure-queue", + "azureQueue": { + "accountName": "account1", + "queueName": "queue1", + "queueLength": 1, + "identity": "system" + } + } + ] + }, + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + }, + { + "name": "servicebus", + "custom": { + "type": "azure-servicebus", + "metadata": { + "queueName": "myqueue", + "namespace": "mynamespace", + "messageCount": "5" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + }, + { + "name": "azure-queue", + "azureQueue": { + "accountName": "account1", + "queueName": "queue1", + "queueLength": 1, + "identity": "system" + } + } + ] + }, + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json new file mode 100644 index 000000000000..a760228e8b9b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json @@ -0,0 +1,458 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview", + "containerAppEnvelope": { + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerApp0-ab1234", + "label": "production" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "clientCertificateMode": "accept", + "corsPolicy": { + "allowedOrigins": [ + "https://a.test.com", + "https://b.test.com" + ], + "allowedMethods": [ + "GET", + "POST" + ], + "allowedHeaders": [ + "HEADER1", + "HEADER2" + ], + "exposeHeaders": [ + "HEADER3", + "HEADER4" + ], + "maxAge": 1234, + "allowCredentials": true + }, + "additionalPortMappings": [ + { + "external": true, + "targetPort": 1234 + }, + { + "external": false, + "targetPort": 2345, + "exposedPort": 3456 + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v1", + "name": "testcontainerApp0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "custom": { + "type": "http", + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Delete.json new file mode 100644 index 000000000000..12356b7aabda --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testWorkerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-02-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Get.json new file mode 100644 index 000000000000..16dc66ca173d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Get.json @@ -0,0 +1,212 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + }, + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + }, + { + "name": "servicebus", + "custom": { + "type": "azure-servicebus", + "metadata": { + "queueName": "myqueue", + "namespace": "mynamespace", + "messageCount": "5" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service", + "name": "service", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "404": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_GetAuthToken.json new file mode 100644 index 000000000000..d2da0962562d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_GetAuthToken.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps/accesstoken", + "location": "East US", + "properties": { + "token": "testToken", + "expires": "2022-07-14T19:22:50.3080223Z" + } + } + }, + "404": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Kind_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Kind_CreateOrUpdate.json new file mode 100644 index 000000000000..9cedb25e64b6 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Kind_CreateOrUpdate.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "testcontainerAppKind", + "api-version": "2024-02-02-preview", + "containerAppEnvelope": { + "location": "East Us", + "managedBy": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Web/sites/testcontainerAppKind", + "kind": "workflowapp", + "properties": { + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "configuration": { + "activeRevisionsMode": "Single", + "ingress": { + "external": true, + "targetPort": 80, + "allowInsecure": true + } + }, + "template": { + "containers": [ + { + "image": "default/logicapps-base:latest", + "name": "logicapps-container", + "resources": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 30 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerapps/testcontainerAppKind", + "name": "testcontainerAppKind", + "type": "Microsoft.App/containerApps", + "location": "East US", + "managedBy": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Web/sites/testcontainerAppKind", + "kind": "workflowapp", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "workloadProfileName": null, + "latestRevisionName": "testcontainerAppKind--2rltv14", + "latestReadyRevisionName": "testcontainerAppKind--2rltv14", + "latestRevisionFqdn": "testcontainerAppKind--2rltv14.nicefield-53acf186.eastus.azurecontainerapps-test.io", + "configuration": { + "activeRevisionsMode": "Single", + "ingress": { + "fqdn": "testcontainerAppKind.nicefield-53acf186.eastus.azurecontainerapps-test.io", + "external": true, + "targetPort": 80, + "exposedPort": 0, + "transport": "auto", + "traffic": [ + { + "weight": 100, + "latestRevision": true + } + ], + "customDomains": null, + "allowInsecure": true, + "ipSecurityRestrictions": null, + "corsPolicy": null, + "clientCertificateMode": null, + "stickySessions": null, + "additionalPortMappings": null, + "targetPortHttpScheme": null + }, + "registries": null, + "dapr": null, + "runtime": null, + "maxInactiveRevisions": 100, + "service": null + }, + "template": { + "revisionSuffix": "", + "terminationGracePeriodSeconds": null, + "containers": [ + { + "image": "default/logicapps-base:latest", + "imageType": "ContainerImage", + "name": "logicapps-container", + "resources": { + "cpu": 1.0, + "memory": "2Gi", + "ephemeralStorage": "4Gi" + } + } + ], + "initContainers": null, + "scale": { + "minReplicas": 1, + "maxReplicas": 30, + "rules": null + }, + "volumes": null, + "serviceBinds": null + }, + "eventStreamEndpoint": "https://azurecontainerapps-test.dev/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/containerApps/testcontainerAppKind/eventstream" + }, + "identity": { + "type": "None" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerapps/testcontainerAppKind", + "name": "testcontainerAppKind", + "type": "Microsoft.App/containerApps", + "location": "East US", + "managedBy": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Web/sites/testcontainerAppKind", + "kind": "workflowapp", + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "workloadProfileName": null, + "latestRevisionName": "testcontainerAppKind--2rltv14", + "latestReadyRevisionName": "testcontainerAppKind--2rltv14", + "latestRevisionFqdn": "testcontainerAppKind--2rltv14.nicefield-53acf186.eastus.azurecontainerapps-test.io", + "configuration": { + "activeRevisionsMode": "Single", + "ingress": { + "fqdn": "testcontainerAppKind.nicefield-53acf186.eastus.azurecontainerapps-test.io", + "external": true, + "targetPort": 80, + "exposedPort": 0, + "transport": "auto", + "traffic": [ + { + "weight": 100, + "latestRevision": true + } + ], + "customDomains": null, + "allowInsecure": true, + "ipSecurityRestrictions": null, + "corsPolicy": null, + "clientCertificateMode": null, + "stickySessions": null, + "additionalPortMappings": null, + "targetPortHttpScheme": null + }, + "registries": null, + "dapr": null, + "runtime": null, + "maxInactiveRevisions": 100, + "service": null + }, + "template": { + "revisionSuffix": "", + "terminationGracePeriodSeconds": null, + "containers": [ + { + "image": "default/logicapps-base:latest", + "imageType": "ContainerImage", + "name": "logicapps-container", + "resources": { + "cpu": 1.0, + "memory": "2Gi", + "ephemeralStorage": "4Gi" + } + } + ], + "initContainers": null, + "scale": { + "minReplicas": 1, + "maxReplicas": 30, + "rules": null + }, + "volumes": null, + "serviceBinds": null + }, + "eventStreamEndpoint": "https://azurecontainerapps-test.dev/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/containerApps/testcontainerAppKind/eventstream" + }, + "identity": { + "type": "None" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListByResourceGroup.json new file mode 100644 index 000000000000..086b70ab7985 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListByResourceGroup.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListBySubscription.json new file mode 100644 index 000000000000..d2e2397e27e0 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListBySubscription.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service", + "name": "service", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json new file mode 100644 index 000000000000..60869a359213 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "customHostname": "my.name.corp", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hostName": "my.name.corp", + "isHostnameAlreadyVerified": true, + "customDomainVerificationTest": "Passed", + "customDomainVerificationFailureInfo": {}, + "hasConflictOnManagedEnvironment": false, + "conflictingContainerAppResourceId": "", + "cNameRecords": [ + "cNameRecord1", + "cNameRecord2" + ], + "txtRecords": [ + "txtRecord1", + "txtRecord2" + ], + "aRecords": [ + "aRecord1", + "aRecord2" + ], + "alternateCNameRecords": [ + "cNameRecord1", + "cNameRecord2" + ], + "alternateTxtRecords": [ + "txtRecord1", + "txtRecord2" + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListSecrets.json new file mode 100644 index 000000000000..596dcc587405 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ListSecrets.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "secret1" + }, + { + "name": "secret2" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json new file mode 100644 index 000000000000..93a76de10edd --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerAppManagedBy", + "api-version": "2024-02-02-preview", + "containerAppEnvelope": { + "location": "East US", + "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerAppManagedBy-ab1234" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppManagedBy:v1", + "name": "testcontainerAppManagedBy", + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", + "name": "testcontainerAppManagedBy", + "type": "Microsoft.App/containerApps", + "location": "East US", + "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerAppManagedBy-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerAppManagedBy-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerAppManagedBy-ab4321" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppManagedBy:v4", + "name": "testcontainerAppManagedBy", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", + "name": "testcontainerAppManagedBy", + "type": "Microsoft.App/containerApps", + "location": "East US", + "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerAppManagedBy-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerAppManagedBy-ab4321" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppManagedBy:v4", + "name": "testcontainerAppManagedBy", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Patch.json new file mode 100644 index 000000000000..8c8412800ca8 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Patch.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview", + "containerAppEnvelope": { + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerApp0-ab1234", + "label": "production" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + } + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v1", + "name": "testcontainerApp0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "custom": { + "type": "http", + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service", + "name": "service", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/containerappOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-02-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json new file mode 100644 index 000000000000..a29cf611974c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json @@ -0,0 +1,490 @@ +{ + "operationId": "ContainerApps_CreateOrUpdate", + "title": "ContainerApps_SourceToCloudApp_CreateOrUpdate", + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview", + "containerAppEnvelope": { + "location": "East US", + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerApp0-ab1234", + "label": "production" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "clientCertificateMode": "accept", + "corsPolicy": { + "allowedOrigins": [ + "https://a.test.com", + "https://b.test.com" + ], + "allowedMethods": [ + "GET", + "POST" + ], + "allowedHeaders": [ + "HEADER1", + "HEADER2" + ], + "exposeHeaders": [ + "HEADER3", + "HEADER4" + ], + "maxAge": 1234, + "allowCredentials": true + }, + "additionalPortMappings": [ + { + "external": true, + "targetPort": 1234 + }, + { + "external": false, + "targetPort": 2345, + "exposedPort": 3456 + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + } + }, + "patchingConfiguration": { + "patchingMode": "Automatic" + }, + "template": { + "containers": [ + { + "image": "", + "imageType": "CloudBuild", + "name": "testcontainerApp0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "custom": { + "type": "http", + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/redisService", + "name": "redisService", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + } + }, + "patchingConfiguration": { + "patchingMode": "Automatic" + }, + "template": { + "containers": [ + { + "image": "mcr.microsoft.com/k8se/cloudbuild-waiting-upload:latest", + "imageType": "CloudBuild", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + } + }, + "patchingConfiguration": { + "patchingMode": "Automatic" + }, + "template": { + "containers": [ + { + "image": "mcr.microsoft.com/k8se/cloudbuild-waiting-upload:latest", + "imageType": "CloudBuild", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Start.json new file mode 100644 index 000000000000..f3f290603d7d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Start.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testWorkerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-02-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Stop.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Stop.json new file mode 100644 index 000000000000..f3f290603d7d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_Stop.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testWorkerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-02-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json new file mode 100644 index 000000000000..c2ee2e7c352b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerAppTcp", + "api-version": "2024-02-02-preview", + "containerAppEnvelope": { + "location": "East US", + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerAppTcp-ab1234" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppTcp:v1", + "name": "testcontainerAppTcp", + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", + "name": "testcontainerAppTcp", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerAppTcp-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerAppTcp-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerAppTcp-ab4321" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppTcp:v4", + "name": "testcontainerAppTcp", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", + "name": "testcontainerAppTcp", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerAppTcp-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerAppTcp-ab4321" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppTcp:v4", + "name": "testcontainerAppTcp", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_Delete.json new file mode 100644 index 000000000000..759ca63dcc32 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_Get.json new file mode 100644 index 000000000000..9829dd271d77 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_List.json new file mode 100644 index 000000000000..0815ad7364f9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicies_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "something", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json new file mode 100644 index 000000000000..4402c89a937d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-02-02-preview", + "daprComponentResiliencyPolicyEnvelope": { + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10, + "intervalInSeconds": 4 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10, + "intervalInSeconds": 4 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10, + "intervalInSeconds": 4 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json new file mode 100644 index 000000000000..0779a0445883 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-02-02-preview", + "daprComponentResiliencyPolicyEnvelope": { + "properties": { + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json new file mode 100644 index 000000000000..d1af9620b863 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-02-02-preview", + "daprComponentResiliencyPolicyEnvelope": { + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20 + } + }, + "outboundPolicy": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20 + } + }, + "outboundPolicy": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20 + } + }, + "outboundPolicy": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json new file mode 100644 index 000000000000..1ac2127e111b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview", + "daprComponentEnvelope": { + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_CreateOrUpdate_Secrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_CreateOrUpdate_Secrets.json new file mode 100644 index 000000000000..154f7f94f2df --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_CreateOrUpdate_Secrets.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview", + "daprComponentEnvelope": { + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey", + "value": "keyvalue" + } + ], + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Delete.json new file mode 100644 index 000000000000..4c16123b388c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Get_SecretStoreComponent.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Get_SecretStoreComponent.json new file mode 100644 index 000000000000..79c00c9c11f3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Get_SecretStoreComponent.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Get_Secrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Get_Secrets.json new file mode 100644 index 000000000000..05f7ab75bc7a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_Get_Secrets.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_List.json new file mode 100644 index 000000000000..711d7fed8f46 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_List.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprcomponents/vaultdog", + "name": "vaultdog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "value": "" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprcomponents/vaultdog", + "name": "vaultdog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "secretRef": "cosmosdb/url" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "cosmosdb/masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_ListSecrets.json new file mode 100644 index 000000000000..c0b0ee54fe79 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprComponents_ListSecrets.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "secret1" + }, + { + "name": "secret2" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json new file mode 100644 index 000000000000..95fa8519ac0d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mysubscription", + "api-version": "2024-02-02-preview", + "daprSubscriptionEnvelope": { + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "default": "/products" + }, + "scopes": [ + "warehouseapp", + "customersupportapp" + ], + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + }, + "scopes": [ + "warehouseapp", + "customersupportapp" + ], + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + }, + "scopes": [ + "warehouseapp", + "customersupportapp" + ], + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json new file mode 100644 index 000000000000..210408890c28 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mysubscription", + "api-version": "2024-02-02-preview", + "daprSubscriptionEnvelope": { + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "default": "/products" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json new file mode 100644 index 000000000000..43765041844a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mysubscription", + "api-version": "2024-02-02-preview", + "daprSubscriptionEnvelope": { + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "metadata": { + "foo": "bar", + "hello": "world" + }, + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + }, + "metadata": { + "foo": "bar", + "hello": "world" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + }, + "metadata": { + "foo": "bar", + "hello": "world" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Delete.json new file mode 100644 index 000000000000..7e5c8f15bd35 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mysubscription", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json new file mode 100644 index 000000000000..3d11556bd88a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mypubsubcomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + }, + "scopes": [ + "warehouseapp", + "customersupportapp" + ], + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_DefaultRoute.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_DefaultRoute.json new file mode 100644 index 000000000000..79bff876fcc7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_DefaultRoute.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mypubsubcomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json new file mode 100644 index 000000000000..0beee76ad4d1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mypubsubcomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + }, + "metadata": { + "foo": "bar", + "hello": "world" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_List.json new file mode 100644 index 000000000000..e3781e4bdd0d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DaprSubscriptions_List.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mybulksubscription", + "name": "mybulksubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + }, + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mydefaultsubscription", + "name": "mydefaultsubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/myroutingsubscription", + "name": "myroutingsubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + }, + "metadata": { + "foo": "bar", + "hello": "world" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_CreateOrUpdate.json new file mode 100644 index 000000000000..eb1ec7de749d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-02-02-preview", + "dotNetComponentEnvelope": { + "properties": { + "componentType": "AspireDashboard", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "InProgress", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_CreateOrUpdate_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_CreateOrUpdate_ServiceBind.json new file mode 100644 index 000000000000..a1a9b883ef1e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_CreateOrUpdate_ServiceBind.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-02-02-preview", + "dotNetComponentEnvelope": { + "properties": { + "componentType": "AspireDashboard", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "InProgress", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Delete.json new file mode 100644 index 000000000000..2a1cf9489257 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-02-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Get.json new file mode 100644 index 000000000000..bbabae892f66 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Get_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Get_ServiceBind.json new file mode 100644 index 000000000000..2b6f2e791346 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Get_ServiceBind.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_List.json new file mode 100644 index 000000000000..e237d132c66a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/blueshark", + "name": "blueshark", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat", + "name": "yellowcat", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "MyOtherDotNetComponentType", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "timeout-value", + "value": "10000ms" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_List_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_List_ServiceBind.json new file mode 100644 index 000000000000..b1a774690465 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_List_ServiceBind.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/blueshark", + "name": "blueshark", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat", + "name": "yellowcat", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "MyOtherDotNetComponentType", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "timeout-value", + "value": "10000ms" + } + ], + "serviceBinds": [ + { + "name": "blueshark", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/blueshark" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Patch.json new file mode 100644 index 000000000000..f9649749921f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-02-02-preview", + "dotNetComponentEnvelope": { + "properties": { + "componentType": "AspireDashboard", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-02-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Patch_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Patch_ServiceBind.json new file mode 100644 index 000000000000..a954ab257b8b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/DotNetComponents_Patch_ServiceBind.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-02-02-preview", + "dotNetComponentEnvelope": { + "properties": { + "componentType": "AspireDashboard", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-02-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/FunctionsExtension_Post.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/FunctionsExtension_Post.json new file mode 100644 index 000000000000..3a17f1c4c2b6 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/FunctionsExtension_Post.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "revisionName": "testcontainerApp0-pjxhsye", + "functionAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": "{\"status\":\"success\"}" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_CreateOrUpdate.json new file mode 100644 index 000000000000..b1fc9b0e06cb --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_CreateOrUpdate.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-02-02-preview", + "javaComponentEnvelope": { + "properties": { + "componentType": "SpringBootAdmin", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "InProgress", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_CreateOrUpdate_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_CreateOrUpdate_ServiceBind.json new file mode 100644 index 000000000000..d950c4db254c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_CreateOrUpdate_ServiceBind.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-02-02-preview", + "javaComponentEnvelope": { + "properties": { + "componentType": "SpringBootAdmin", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "InProgress", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Delete.json new file mode 100644 index 000000000000..3c68cdf02361 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-02-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Get.json new file mode 100644 index 000000000000..8c7fdcf7bf6d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Get_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Get_ServiceBind.json new file mode 100644 index 000000000000..453ae3ef40a4 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Get_ServiceBind.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_List.json new file mode 100644 index 000000000000..dc255672539b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_List.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/blueshark", + "name": "blueshark", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat", + "name": "yellowcat", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringCloudEureka", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.cloud.config.server.git.uri", + "value": "" + } + ], + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_List_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_List_ServiceBind.json new file mode 100644 index 000000000000..fb4a2c3134de --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_List_ServiceBind.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/blueshark", + "name": "blueshark", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat", + "name": "yellowcat", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringCloudEureka", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.cloud.config.server.git.uri", + "value": "" + } + ], + "serviceBinds": [ + { + "name": "blueshark", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/blueshark" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Patch.json new file mode 100644 index 000000000000..09af6e597e05 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Patch.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-02-02-preview", + "javaComponentEnvelope": { + "properties": { + "componentType": "SpringBootAdmin", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-02-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Patch_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Patch_ServiceBind.json new file mode 100644 index 000000000000..b3fe0c9839cb --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/JavaComponents_Patch_ServiceBind.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-02-02-preview", + "javaComponentEnvelope": { + "properties": { + "componentType": "SpringBootAdmin", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-02-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate.json new file mode 100644 index 000000000000..ba22bf5f5cca --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-02-02-preview", + "JobEnvelope": { + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": {} + } + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v1", + "name": "testcontainerAppsJob0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 5, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": { + "Location": "location" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json new file mode 100644 index 000000000000..09994aab570f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-02-02-preview", + "JobEnvelope": { + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v1", + "name": "testcontainerAppsJob0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 5, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": { + "Location": "location" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate_EventTrigger.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate_EventTrigger.json new file mode 100644 index 000000000000..8534fa2bd3bf --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_CreateorUpdate_EventTrigger.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-02-02-preview", + "JobEnvelope": { + "location": "East US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": {} + } + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "eventTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4, + "scale": { + "pollingInterval": 40, + "minExecutions": 1, + "maxExecutions": 5, + "rules": [ + { + "name": "servicebuscalingrule", + "type": "azure-servicebus", + "metadata": { + "topicName": "my-topic" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + ] + } + }, + "triggerType": "Event" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v1", + "name": "testcontainerAppsJob0" + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "eventTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4, + "scale": { + "pollingInterval": 20, + "minExecutions": 1, + "maxExecutions": 5, + "rules": [ + { + "name": "servicebuscalingrule", + "type": "azure-servicebus", + "metadata": { + "topicName": "my-topic" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + ] + } + }, + "triggerType": "Event" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": { + "Location": "location" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "eventTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4, + "scale": { + "minExecutions": 1, + "maxExecutions": 5, + "pollingInterval": 20, + "rules": [ + { + "name": "servicebuscalingrule", + "type": "azure-servicebus", + "metadata": { + "queueName": "my-queue", + "messageCount": "50" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + ] + } + }, + "triggerType": "Event" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Delete.json new file mode 100644 index 000000000000..c8dc40a1097f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testWorkerContainerAppsJob0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testWorkerContainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-02-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Execution_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Execution_Get.json new file mode 100644 index 000000000000..f08b7bd45961 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Execution_Get.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "jobExecutionName": "jobExecution1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "jobExecution1", + "properties": { + "status": "Running", + "startTime": "2023-02-13T20:37:30+00:00", + "endTime": "2023-02-13T20:47:30+00:00", + "template": { + "containers": [ + { + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", + "resources": { + "cpu": 0.5, + "memory": "1Gi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerappsjob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.5, + "memory": "1Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Executions_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Executions_Get.json new file mode 100644 index 000000000000..fb513886b93f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Executions_Get.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "testcontainerAppJob-27944454", + "properties": { + "status": "Running", + "startTime": "2023-02-13T20:37:30+00:00", + "endTime": "2023-02-13T20:47:30+00:00", + "detailedStatus": { + "replicas": [ + { + "name": "testcontainerappsjob0-0", + "containers": [ + { + "name": "container1", + "code": 0, + "additionalInformation": "Completed", + "status": "Succeeded" + }, + { + "name": "container2", + "code": 0, + "additionalInformation": "Completed", + "status": "Succeeded" + } + ] + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", + "resources": { + "cpu": 0.5, + "memory": "1Gi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerappsjob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.5, + "memory": "1Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Get.json new file mode 100644 index 000000000000..833497a48e72 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Get.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_GetDetector.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_GetDetector.json new file mode 100644 index 000000000000..a03947a4d2cc --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_GetDetector.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "jobName": "mikonojob1", + "detectorName": "containerappjobnetworkIO", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/jobs/mikonojob1/detectors/containerappjobnetworkIO", + "name": "containerappjobnetworkIO", + "type": "Microsoft.App/jobs/detectors", + "properties": { + "metadata": { + "id": "containerappjobnetworkIO", + "name": "Container App Job Network Inbound and Outbound", + "description": "This detector shows the Container App Job Network Inbound and Outbound.", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Detector", + "score": 0 + }, + "dataset": [ + { + "table": { + "tableName": "", + "columns": [ + { + "columnName": "TimeStamp", + "dataType": "DateTime" + }, + { + "columnName": "Metric", + "dataType": "String" + }, + { + "columnName": "Average", + "dataType": "Double" + } + ], + "rows": [ + [ + "2022-03-15T21:35:00", + "RxBytes", + 0 + ] + ] + }, + "renderingProperties": { + "type": 8, + "title": "Container App Job Network Inbound ", + "description": "", + "isVisible": true + } + } + ], + "status": { + "statusId": 3 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ListDetectors.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ListDetectors.json new file mode 100644 index 000000000000..694f68b73ad9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ListDetectors.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "jobName": "mikonojob1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/jobs/mikonojob1/detectors/cappjobContainerAppAvailabilityMetrics", + "name": "cappjobContainerAppAvailabilityMetrics", + "type": "Microsoft.App/containerapps/detectors", + "properties": { + "metadata": { + "id": "cappjobContainerAppAvailabilityMetrics", + "name": "Availability Metrics for Container App Jobs", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Analysis", + "score": 0 + }, + "dataset": [], + "status": { + "statusId": 4 + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ListSecrets.json new file mode 100644 index 000000000000..38a3db7c1029 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ListSecrets.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "secret1" + }, + { + "name": "secret2" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Patch.json new file mode 100644 index 000000000000..d4eed8355af4 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Patch.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-02-02-preview", + "JobEnvelope": { + "properties": { + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v1", + "name": "testcontainerAppsJob0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/containerappsjobOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-02-02-preview" + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ProxyGet.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ProxyGet.json new file mode 100644 index 000000000000..abe27f8d4e60 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_ProxyGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "apiName": "rootApi", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0/detectorproperties/rootApi", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Start.json new file mode 100644 index 000000000000..766b768efdf2 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Start.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "testcontainerAppsJob0-pjxhsye", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}" + } + }, + "202": { + "headers": { + "Location": "location" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Stop_Execution.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Stop_Execution.json new file mode 100644 index 000000000000..b7a380db1bdf --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Stop_Execution.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "jobExecutionName": "jobExecution1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "location" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Stop_Multiple.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Stop_Multiple.json new file mode 100644 index 000000000000..e7323189743f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Job_Stop_Multiple.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "jobExecutionName": { + "value": [ + { + "name": "jobExecution-27944453" + }, + { + "name": "jobExecution-27944452" + }, + { + "name": "jobExecution-27944451" + } + ] + }, + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "jobExecution-27944453", + "properties": { + "status": "Running", + "startTime": "2023-02-13T20:37:30+00:00", + "endTime": "2023-02-13T20:47:30+00:00" + } + }, + { + "name": "jobExecution-27944452", + "properties": { + "status": "Running", + "startTime": "2023-02-13T21:37:30+00:00", + "endTime": "2023-02-13T21:47:30+00:00" + } + }, + { + "name": "jobExecution-27944453", + "properties": { + "status": "Running", + "startTime": "2023-02-13T22:37:30+00:00", + "endTime": "2023-02-13T22:47:30+00:00" + } + } + ], + "nextLink": null + } + }, + "202": { + "headers": { + "Location": "location" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Jobs_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Jobs_ListByResourceGroup.json new file mode 100644 index 000000000000..54bdde78aa9d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Jobs_ListByResourceGroup.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", + "name": "testcontainerAppsJob1", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "scheduleTriggerConfig": { + "replicaCompletionCount": 1, + "cronExpression": "* * * * 5", + "parallelism": 4 + }, + "triggerType": "Scheduled" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob1:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testinitcontainerAppsJob1:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Jobs_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Jobs_ListBySubscription.json new file mode 100644 index 000000000000..3bbd7d406c7f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Jobs_ListBySubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", + "name": "testcontainerAppsJob1", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "scheduleTriggerConfig": { + "replicaCompletionCount": 1, + "cronExpression": "* * * * 5", + "parallelism": 5 + }, + "triggerType": "Scheduled" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob1:v4", + "name": "testcontainerAppsJob1", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob1:v4", + "name": "testinitcontainerAppsJob1", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Create.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Create.json new file mode 100644 index 000000000000..a86db9001ea0 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Create.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "resource": { + "properties": {} + }, + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/logicApps", + "properties": {} + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/logicApps", + "properties": {} + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Delete.json new file mode 100644 index 000000000000..7d827dd38e12 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_DeleteDeployWorkflowArtifacts.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_DeleteDeployWorkflowArtifacts.json new file mode 100644 index 000000000000..02cc32523b4f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_DeleteDeployWorkflowArtifacts.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "containerAppName": "testapp2", + "logicAppName": "testapp2", + "api-version": "2024-02-02-preview", + "workflowArtifacts": { + "filesToDelete": [ + "test/workflow.json", + "test/" + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Get.json new file mode 100644 index 000000000000..ce517459d0a5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_Get.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/logicApps", + "properties": {} + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_GetWorkflow.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_GetWorkflow.json new file mode 100644 index 000000000000..25282b8ce271 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_GetWorkflow.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "workflowName": "stateful1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0/workflows/stateful1", + "name": "testcontainerApp0/stateful1", + "type": "Microsoft.App/logicApps/workflows", + "kind": "Stateful", + "location": "East US", + "properties": { + "files": { + "workflow.json": { + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "actions": {}, + "contentVersion": "1.0.0.0", + "outputs": {}, + "parameters": {}, + "triggers": {} + } + }, + "connections.json": { + "managedApiConnections": { + "office365": { + "api": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/brazilsouth/managedApis/office365" + }, + "connection": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/connections/office365-1" + }, + "connectionRuntimeUrl": "string", + "authentication": { + "type": "Raw", + "scheme": "Key", + "parameter": "@appsetting('office365-connectionKey')" + } + } + } + } + }, + "flowState": "Enabled", + "health": { + "state": "Healthy" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListCallbackURL.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListCallbackURL.json new file mode 100644 index 000000000000..81b943fa0172 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListCallbackURL.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "containerAppName": "testapp2", + "logicAppName": "testapp2", + "api-version": "2024-02-02-preview", + "x-ms-logicapps-proxy-path": "/runtime/webhooks/workflow/api/management/workflows/Stateful1/triggers/When_a_HTTP_request_is_received/listCallbackUrl", + "x-ms-logicapps-proxy-method": "POST" + }, + "responses": { + "200": { + "body": { + "value": "https://testapp2.livelyriver-730e4fd9.eastasia.azurecontainerapps.io:443/api/test/triggers/When_a_HTTP_request_is_received/invoke?api-version=2022-05-01&sp=%2Ftriggers%2FWhen_a_HTTP_request_is_received%2Frun&sv=1.0&sig= ", + "method": "POST", + "basePath": "https://testapp2.livelyriver-730e4fd9.eastasia.azurecontainerapps.io /api/test/triggers/When_a_HTTP_request_is_received/invoke", + "queries": { + "api-version": "2022-05-01", + "sp": "/triggers/When_a_HTTP_request_is_received/run", + "sv": "1.0", + "sig": "IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListConnections.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListConnections.json new file mode 100644 index 000000000000..e6efb65f9e5d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListConnections.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "containerAppName": "testapp2", + "logicAppName": "testapp2", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testapp2/providers/Microsoft.App/logicApps/testapp2/workflowconfigurations/connections", + "name": "testapp2/connections", + "type": "Microsoft.App/logicApps/workflowsconfiguration", + "location": "East US", + "properties": { + "files": { + "connections.json": { + "managedApiConnections": { + "office365": { + "api": { + "id": "string" + }, + "connection": { + "id": "string" + }, + "connectionRuntimeUrl": "string", + "authentication": { + "type": "Raw", + "scheme": "Key", + "parameter": "@appsetting('office365-connectionKey')" + } + } + } + } + }, + "health": { + "state": "Healthy" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListWorkflows.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListWorkflows.json new file mode 100644 index 000000000000..d8dbf8f14ca7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_ListWorkflows.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0/workflows/a1", + "name": "testcontainerApp0/a1", + "type": "Microsoft.App/logicApps/workflows", + "location": "East US", + "kind": "Stateful", + "properties": { + "flowState": "Enabled", + "health": { + "state": "Healthy" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0/workflows/stateful2", + "name": "testcontainerApp0/stateful2", + "type": "Microsoft.App/logicApps/workflows", + "location": "East US", + "kind": "Stateful", + "properties": { + "flowState": "Enabled", + "health": { + "state": "Unhealthy", + "error": { + "code": "InvalidWorkflowJson", + "message": "Invalid character after parsing property name. Expected ':' but got: \". Path '', line 2, position 2." + } + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_PostDeployWorkflowArtifacts.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_PostDeployWorkflowArtifacts.json new file mode 100644 index 000000000000..809240af6ff7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/LogicApps_PostDeployWorkflowArtifacts.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "containerAppName": "testapp2", + "logicAppName": "testapp2", + "api-version": "2024-02-02-preview", + "workflowArtifacts": { + "files": { + "test1/workflow.json": { + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "actions": {}, + "contentVersion": "1.0.0.0", + "outputs": {}, + "triggers": { + "When_events_are_available_in_Event_hub": { + "inputs": { + "parameters": { + "eventHubName": "test123" + }, + "serviceProviderConfiguration": { + "connectionName": "eventHub", + "operationId": "receiveEvents", + "serviceProviderId": "/serviceProviders/eventHub" + } + }, + "splitOn": "@triggerOutputs()?['body']", + "type": "ServiceProvider" + } + } + }, + "kind": "Stateful" + }, + "connections.json": { + "serviceProviderConnections": { + "eventHub": { + "parameterValues": { + "connectionString": "@appsetting('eventHub_connectionString')" + }, + "serviceProvider": { + "id": "/serviceProviders/eventHub" + }, + "displayName": "example1" + } + }, + "managedApiConnections": {} + } + }, + "appSettings": { + "eventHub_connectionString": "Endpoint=sb://example.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=EXAMPLE1a2b3c4d5e6fEXAMPLE=" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_CreateOrUpdate.json new file mode 100644 index 000000000000..1db2236b3b47 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_CreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "managedCertificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview", + "managedCertificateEnvelope": { + "location": "East US", + "properties": { + "subjectName": "my-subject-name.company.country.net", + "domainControlValidation": "CNAME" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "CNAME" + } + } + }, + "201": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/locations/eastus/managedCertificateOperationStatuses/dc27c9cd-370f-4623-95d4-827b6dc4120a?api-version=2022-06-01-preview&azureAsyncOperation=true" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Pending", + "domainControlValidation": "CNAME" + } + } + }, + "400": { + "code": "ManagedCertNoUpdate", + "message": "Properties of managed certificates cannot be updated. Please delete the current resource and retry or use a different resource id." + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_Delete.json new file mode 100644 index 000000000000..60f6ad443250 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "managedCertificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_Get.json new file mode 100644 index 000000000000..9eed300b334e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificate_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "managedCertificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "CNAME" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificates_ListByManagedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificates_ListByManagedEnvironment.json new file mode 100644 index 000000000000..f95d6aa878a9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificates_ListByManagedEnvironment.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "CNAME" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name-root", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "HTTP" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name-txt", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=txt.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "TXT" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificates_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificates_Patch.json new file mode 100644 index 000000000000..d99f69f0b0e1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedCertificates_Patch.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "managedCertificateName": "certificate-firendly-name", + "api-version": "2024-02-02-preview", + "managedCertificateEnvelope": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "CNAME" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentDiagnostics_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentDiagnostics_Get.json new file mode 100644 index 000000000000..fdfd9ac979a9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentDiagnostics_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "environmentName": "mikonokubeenv", + "detectorName": "ManagedEnvAvailabilityMetrics", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/managedEnvironments/mikonokubeenv/detectors/ManagedEnvAvailabilityMetrics", + "name": "ManagedEnvAvailabilityMetrics", + "type": "Microsoft.App/managedEnvironments/detectors", + "properties": { + "metadata": { + "id": "ManagedEnvAvailabilityMetrics", + "name": "Managed Env Netowrk Inbound and Outbound", + "description": "This detector shows the Managed Environment Network Inbound and Outbound.", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Detector", + "score": 0 + }, + "dataset": [ + { + "table": { + "tableName": "", + "columns": [ + { + "columnName": "TimeStamp", + "dataType": "DateTime" + }, + { + "columnName": "Metric", + "dataType": "String" + }, + { + "columnName": "Average", + "dataType": "Double" + } + ], + "rows": [ + [ + "2022-03-15T21:35:00", + "RxBytes", + 0 + ] + ] + }, + "renderingProperties": { + "type": 8, + "title": "Managed Environment Network Inbound ", + "description": "", + "isVisible": true + } + } + ], + "status": { + "statusId": 3 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentDiagnostics_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentDiagnostics_List.json new file mode 100644 index 000000000000..0d502b2bafe5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentDiagnostics_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "environmentName": "mikonokubeenv", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/managedEnvironments/mikonokubeenv/detectors/ManagedEnvAvailabilityMetrics", + "name": "ManagedEnvAvailabilityMetrics", + "type": "Microsoft.App/managedEnvironments/detectors", + "properties": { + "metadata": { + "id": "ManagedEnvAvailabilityMetrics", + "name": "Availability Metrics for Managed Environments", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Analysis", + "score": 0 + }, + "dataset": [], + "status": { + "statusId": 4 + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json new file mode 100644 index 000000000000..cedd909d474e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "privateEndpointConnectionName": "jlaw-demo1", + "api-version": "2024-02-02-preview", + "privateEndpointConnectionEnvelope": { + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Approved" + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..5b3f5fc826ef --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "privateEndpointConnectionName": "jlaw-demo1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/localtions/eastus/operationResults/00000" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..0983ced9b07d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "privateEndpointConnectionName": "jlaw-demo1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Waiting" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_List.json new file mode 100644 index 000000000000..798df0cc0c32 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_List.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Waiting" + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo2", + "name": "jlaw-demo2", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateLinkResources_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateLinkResources_List.json new file mode 100644 index 000000000000..a24efc92bc06 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentPrivateLinkResources_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateLinkResources/managedEnvironments", + "name": "managedEnvironments", + "properties": { + "groupId": "managedEnvironments", + "requiredMembers": [ + "managedEnvironments" + ], + "requiredZoneNames": [ + "privatelink.northcentralusstage.azurecontainerapps.io" + ] + }, + "type": "Microsoft.App/managedEnvironments/privateLinkResources" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentUsages_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentUsages_List.json new file mode 100644 index 000000000000..95758605cedb --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentUsages_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-02-02-preview", + "subscriptionId": "subid", + "resourceGroupName": "examplerg", + "environmentName": "jlaw-demo1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 0.5, + "limit": 10, + "name": { + "localizedValue": "Managed Environment Consumption Cores", + "value": "ManagedEnvironmentConsumptionCores" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json new file mode 100644 index 000000000000..1b2b899ad88a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-02-02-preview", + "storageEnvelope": { + "properties": { + "azureFile": { + "accountName": "account1", + "accountKey": "key", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json new file mode 100644 index 000000000000..dfd6941d46c3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-02-02-preview", + "storageEnvelope": { + "properties": { + "nfsAzureFile": { + "server": "server1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "nfsAzureFile": { + "server": "server1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Delete.json new file mode 100644 index 000000000000..316368f55a51 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Get.json new file mode 100644 index 000000000000..3127d8922881 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json new file mode 100644 index 000000000000..209f7f7ee039 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "nfsAzureFile": { + "server": "server1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_List.json new file mode 100644 index 000000000000..4545b0ebe885 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironmentsStorages_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo2", + "name": "jlaw-demo2", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "nfsAzureFile": { + "server": "server1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_CreateOrUpdate.json new file mode 100644 index 000000000000..e22257345e3f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_CreateOrUpdate.json @@ -0,0 +1,318 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-02-02-preview", + "environmentEnvelope": { + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + }, + "properties": { + "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string", + "sharedKey": "string", + "dynamicJsonColumns": true + } + }, + "appInsightsConfiguration": { + "connectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://eastus-8.in.applicationinsights.azure.com/;LiveEndpoint=https://eastus.livediagnostics.monitor.azure.com/" + }, + "openTelemetryConfiguration": { + "destinationsConfiguration": { + "dataDogConfiguration": { + "site": "string", + "key": "000000000000000000000000" + }, + "otlpConfigurations": [ + { + "name": "dashboard", + "endpoint": "dashboard.k8s.region.azurecontainerapps.io:80", + "insecure": true, + "headers": [ + { + "key": "api-key", + "value": "xxxxxxxxxxx" + } + ] + } + ] + }, + "tracesConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "logsConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "metricsConfiguration": { + "destinations": [ + "dataDog" + ] + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "dnsSuffix": "www.my-name.com", + "certificateValue": "Y2VydA==", + "certificatePassword": "1234" + }, + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "peerAuthentication": { + "mtls": { + "enabled": true + } + }, + "peerTrafficConfiguration": { + "encryption": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string", + "dynamicJsonColumns": true + } + }, + "openTelemetryConfiguration": { + "destinationsConfiguration": { + "dataDogConfiguration": { + "site": "datadoghq.com", + "key": null + }, + "otlpConfigurations": [ + { + "name": "dashboard", + "endpoint": "dashboard.k8s.region.azurecontainerapps.io:80", + "insecure": true + } + ] + }, + "tracesConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "logsConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "metricsConfiguration": { + "destinations": [ + "dataDog" + ] + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "appInsightsConfiguration": null, + "infrastructureResourceGroup": "capp-svc-testcontainerenv-eastus", + "peerAuthentication": { + "mtls": { + "enabled": true + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "InitializationInProgress", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "openTelemetryConfiguration": { + "destinationsConfiguration": { + "dataDogConfiguration": { + "site": "datadoghq.com", + "key": null + }, + "otlpConfigurations": [ + { + "name": "dashboard", + "endpoint": "dashboard.k8s.region.azurecontainerapps.io:80", + "insecure": true + } + ] + }, + "tracesConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "logsConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "metricsConfiguration": { + "destinations": [ + "dataDog" + ] + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "appInsightsConfiguration": null, + "infrastructureResourceGroup": "capp-svc-testcontainerenv-eastus", + "peerAuthentication": { + "mtls": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json new file mode 100644 index 000000000000..3806215cb0a8 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-02-02-preview", + "environmentEnvelope": { + "location": "East US", + "properties": { + "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string", + "sharedKey": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "dnsSuffix": "www.my-name.com", + "certificateValue": "Y2VydA==", + "certificatePassword": "1234" + }, + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "InitializationInProgress", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Delete.json new file mode 100644 index 000000000000..f0b38bc056df --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "examplekenv", + "api-version": "2024-02-02-preview", + "location": "East US" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/localtions/eastus/operationResults/00000" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Get.json new file mode 100644 index 000000000000..bc5a1cefea8d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Get.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "jlaw-demo1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "kedaConfiguration": { + "version": "2.8.1" + }, + "daprConfiguration": { + "version": "1.9" + }, + "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus", + "peerAuthentication": { + "mtls": { + "enabled": true + } + }, + "peerTrafficConfiguration": { + "encryption": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_GetAuthToken.json new file mode 100644 index 000000000000..0bd8979c31c9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_GetAuthToken.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "rg", + "environmentName": "testenv", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testenv", + "name": "testenv", + "type": "Microsoft.App/environments/accesstoken", + "location": "East US", + "properties": { + "token": "testToken", + "expires": "2022-07-14T19:22:50.3080223Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListByResourceGroup.json new file mode 100644 index 000000000000..32533fb87d57 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "appLogsConfiguration": null, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus" + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/demo1", + "name": "demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "demo1.k4apps.io", + "staticIp": "52.142.21.61", + "appLogsConfiguration": null, + "zoneRedundant": true, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name2.com", + "subjectName": "CN=www.my-name2.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "infrastructureResourceGroup": "capp-svc-demo1-northcentralus" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListBySubscription.json new file mode 100644 index 000000000000..36b8b0ba8302 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListBySubscription.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "appLogsConfiguration": null, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus" + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.App/managedEnvironments/demo1", + "name": "demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "demo1.k4apps.io", + "staticIp": "52.142.21.61", + "appLogsConfiguration": { + "destination": "log-analytics", + "logAnalyticsConfiguration": { + "customerId": "9ccccd4a-268f-4a9a-8d03-9bfe77c3fbd2", + "dynamicJsonColumns": true + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name2.com", + "subjectName": "CN=www.my-name2.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "infrastructureResourceGroup": "capp-svc-demo1-northcentralus" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListWorkloadProfileStates.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListWorkloadProfileStates.json new file mode 100644 index 000000000000..86c6e0dff660 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_ListWorkloadProfileStates.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "jlaw-demo1", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/workloadProfileStates/GP1", + "name": "GP1", + "type": "/providers/Microsoft.App/workloadProfileStates", + "properties": { + "minimumCount": 3, + "maximumCount": 10, + "currentCount": 3 + } + }, + { + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/workloadProfileStates/MO3", + "name": "MO3", + "type": "/providers/Microsoft.App/workloadProfileStates", + "properties": { + "minimumCount": 0, + "maximumCount": 2, + "currentCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Patch.json new file mode 100644 index 000000000000..f185e71d760c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/ManagedEnvironments_Patch.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-02-02-preview", + "environmentEnvelope": { + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "zoneRedundant": true, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/managedEnvironmentOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-02-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Operations_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Operations_List.json new file mode 100644 index 000000000000..e61e6ba0be16 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Operations_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.App/containerApps/Read", + "display": { + "provider": "Microsoft Apps", + "resource": "Container App", + "operation": "Get Container App", + "description": "Get the properties of a Container App" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Replicas_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Replicas_Get.json new file mode 100644 index 000000000000..14640e67c604 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Replicas_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "myapp", + "revisionName": "myapp--0wlqy09", + "replicaName": "myapp--0wlqy09-5d9774cff-5wnd8", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8", + "name": "myapp--0wlqy09-5d9774cff-5wnd8", + "type": "Microsoft.Web/containerapps/revisions/replicas", + "properties": { + "createdTime": "2022-01-25T19:42:45Z", + "runningState": "Running", + "runningStateDetails": "testDetail", + "containers": [ + { + "name": "hello92", + "containerId": "containerd://6bac7bb3afed1c704b5fe563c34c0ecf59ac30c766bb73488f7fa552dc42ee54", + "ready": true, + "started": true, + "restartCount": 0, + "runningState": "Running", + "runningStateDetails": "testDetail", + "logStreamEndpoint": "testLogStreamEndpoint", + "execEndpoint": "testExecEndpoint" + } + ], + "initContainers": [] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Replicas_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Replicas_List.json new file mode 100644 index 000000000000..0aa4508bb1e9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Replicas_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "myapp", + "revisionName": "myapp--0wlqy09", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8", + "name": "myapp--0wlqy09-5d9774cff-5wnd8", + "type": "Microsoft.Web/containerapps/revisions/replicas", + "properties": { + "createdTime": "2022-01-25T19:42:45Z", + "runningState": "Running", + "runningStateDetails": "testDetail", + "containers": [ + { + "name": "hello92", + "containerId": "containerd://6bac7bb3afed1c704b5fe563c34c0ecf59ac30c766bb73488f7fa552dc42ee54", + "ready": true, + "started": true, + "restartCount": 0, + "runningState": "Running", + "runningStateDetails": "testDetail", + "logStreamEndpoint": "testLogStreamEndpoint", + "execEndpoint": "testExecEndpoint" + } + ], + "initContainers": [] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Activate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Activate.json new file mode 100644 index 000000000000..c2075a047240 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Activate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "revisionName": "testcontainerApp0-pjxhsye", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Deactivate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Deactivate.json new file mode 100644 index 000000000000..c2075a047240 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Deactivate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "revisionName": "testcontainerApp0-pjxhsye", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Get.json new file mode 100644 index 000000000000..b00eb63a4712 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "revisionName": "testcontainerApp0-pjxhsye", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/revisions/testcontainerApp0-pjxhsye", + "name": "testcontainerApp0-pjxhsye", + "type": "Microsoft.App/containerApps/revisions", + "properties": { + "createdTime": "2021-05-24T21:24:22+00:00", + "lastActiveTime": "2021-05-24T21:24:22+00:00", + "fqdn": "testcontainerApp0-pjxhsye.politehill-ab123456.eastus.azurecontainerapps.io", + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v2", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "trafficWeight": 80, + "active": true, + "replicas": 1, + "runningState": "Running" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_List.json new file mode 100644 index 000000000000..90d51d2ed704 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/revisions/testcontainerApp0-pjxhsye", + "name": "testcontainerApp0-pjxhsye", + "type": "Microsoft.App/containerApps/revisions", + "properties": { + "createdTime": "2021-05-24T21:24:22+00:00", + "lastActiveTime": "2021-05-24T21:24:22+00:00", + "fqdn": "testcontainerApp0-pjxhsye.politehill-ab123456.eastus.azurecontainerapps.io", + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v2", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "trafficWeight": 80, + "active": true, + "replicas": 1 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Restart.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Restart.json new file mode 100644 index 000000000000..20f7d6fd0bad --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Revisions_Restart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testStaticSite0", + "revisionName": "testcontainerApp0-pjxhsye", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_CreateOrUpdate.json new file mode 100644 index 000000000000..3273ae624a7c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_CreateOrUpdate.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "sessionPoolName": "testsessionpool", + "api-version": "2024-02-02-preview", + "sessionPoolEnvelope": { + "location": "East US", + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "nodeCount": 1, + "containerType": "CustomContainer", + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Delete.json new file mode 100644 index 000000000000..58c54fb1091e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "sessionPoolName": "testsessionpool", + "api-version": "2024-02-02-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/operationResults/amF3YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-02-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Get.json new file mode 100644 index 000000000000..9320abcb31bb --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "sessionPoolName": "testsessionpool", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "nodeCount": 1, + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_ListByResourceGroup.json new file mode 100644 index 000000000000..2e4abdcea310 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "nodeCount": 1, + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_ListBySubscription.json new file mode 100644 index 000000000000..5e2137f3da0c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "nodeCount": 1, + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Patch.json new file mode 100644 index 000000000000..d6c72577ab0c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SessionPools_Patch.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "sessionPoolName": "testsessionpool", + "api-version": "2024-02-02-preview", + "sessionPoolEnvelope": { + "properties": { + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "nodeCount": 1, + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/operationResults/amF3YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-02-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_CreateOrUpdate.json new file mode 100644 index 000000000000..2d3ac66ec5f5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_CreateOrUpdate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "sourceControlName": "current", + "api-version": "2024-02-02-preview", + "sourceControlEnvelope": { + "properties": { + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "test-registry.azurecr.io", + "registryUserName": "test-registry", + "registryPassword": "" + }, + "azureCredentials": { + "clientId": "", + "clientSecret": "", + "tenantId": "", + "kind": "feaderated" + }, + "contextPath": "./", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "githubPersonalAccessToken": "test" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/sourcecontrols/current", + "name": "current", + "type": "Microsoft.App/containerapps/sourcecontrols", + "properties": { + "operationState": "InProgress", + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "test-registry.azurecr.io", + "registryUserName": "testreg" + }, + "contextPath": "./", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ] + } + } + } + }, + "201": { + "headers": { + "location": "https://localhost/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/sourcecontrols/currentInOperationModel/operationresults/5a7f31af-8ae5-489b-a67e-f0a2d11df796?api-version=2021-03-01" + }, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/sourcecontrols/current", + "name": "current", + "type": "Microsoft.App/containerapps/sourcecontrols", + "properties": { + "operationState": "InProgress", + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "test-registry.azurecr.io", + "registryUserName": "test-registry" + }, + "contextPath": "./", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_Delete.json new file mode 100644 index 000000000000..aaff50f3e387 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "sourceControlName": "current", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://localhost/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/sourcecontrols/currentInOperationModel/operationresults/14a787ee-c65f-462d-8a8b-897f69a2ab4f?api-version=2021-03-01" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_Get.json new file mode 100644 index 000000000000..7f3ce5b40576 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "sourceControlName": "current", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/sourcecontrols/current", + "name": "current", + "type": "Microsoft.App/containerapps/sourcecontrols", + "properties": { + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "xwang971reg.azurecr.io", + "registryUserName": "xwang971reg" + }, + "contextPath": "./", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_ListByContainer.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_ListByContainer.json new file mode 100644 index 000000000000..8a6995e2a244 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/SourceControls_ListByContainer.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/sourcecontrols/current", + "name": "current", + "type": "Microsoft.App/containerapps/sourcecontrols", + "properties": { + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "xwang971reg.azurecr.io", + "registryUserName": "xwang971reg" + }, + "contextPath": "./", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Subscriptions_GetCustomDomainVerificationId.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Subscriptions_GetCustomDomainVerificationId.json new file mode 100644 index 000000000000..fe57e90a0e0e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Subscriptions_GetCustomDomainVerificationId.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "d27c3573-f76e-4b26-b871-0ccd2203d08c", + "api-version": "2024-02-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": "5B406D5E790BBD224468CE0AA814C396203C7CE755F135A80E35D41865E51967" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Usages_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Usages_List.json new file mode 100644 index 000000000000..031f8594ca87 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/examples/Usages_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2024-02-02-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 5, + "limit": 10, + "name": { + "localizedValue": "ManagedEnvironmentCount", + "value": "ManagedEnvironmentCount" + }, + "unit": "Count" + }, + { + "currentValue": 3, + "limit": 20, + "name": { + "localizedValue": "ManagedEnvironmentCores", + "value": "ManagedEnvironmentCores" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/readme.md b/specification/app/resource-manager/readme.md index 79d130f87fb8..c3bf3a8afd65 100644 --- a/specification/app/resource-manager/readme.md +++ b/specification/app/resource-manager/readme.md @@ -26,9 +26,56 @@ These are the global settings for the app. ``` yaml openapi-type: arm -tag: package-2024-03 +tag: package-preview-2024-02 ``` +### Tag: package-preview-2024-02 + +These settings apply only when `--tag=package-preview-2024-02` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-02' +input-file: + - Microsoft.App/preview/2024-02-02-preview/AppResiliency.json + - Microsoft.App/preview/2024-02-02-preview/AuthConfigs.json + - Microsoft.App/preview/2024-02-02-preview/AvailableWorkloadProfiles.json + - Microsoft.App/preview/2024-02-02-preview/BillingMeters.json + - Microsoft.App/preview/2024-02-02-preview/Builders.json + - Microsoft.App/preview/2024-02-02-preview/Builds.json + - Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json + - Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironments.json + - Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsCertificates.json + - Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsDaprComponents.json + - Microsoft.App/preview/2024-02-02-preview/ConnectedEnvironmentsStorages.json + - Microsoft.App/preview/2024-02-02-preview/ContainerApps.json + - Microsoft.App/preview/2024-02-02-preview/ContainerAppsRevisions.json + - Microsoft.App/preview/2024-02-02-preview/ContainerAppsBuilds.json + - Microsoft.App/preview/2024-02-02-preview/ContainerAppsPatches.json + - Microsoft.App/preview/2024-02-02-preview/Diagnostics.json + - Microsoft.App/preview/2024-02-02-preview/DotNetComponents.json + - Microsoft.App/preview/2024-02-02-preview/Global.json + - Microsoft.App/preview/2024-02-02-preview/JavaComponents.json + - Microsoft.App/preview/2024-02-02-preview/Jobs.json + - Microsoft.App/preview/2024-02-02-preview/ManagedEnvironments.json + - Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json + - Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprComponents.json + - Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsDaprSubscriptions.json + - Microsoft.App/preview/2024-02-02-preview/ManagedEnvironmentsStorages.json + - Microsoft.App/preview/2024-02-02-preview/SourceControls.json + - Microsoft.App/preview/2024-02-02-preview/Subscriptions.json + - Microsoft.App/preview/2024-02-02-preview/Usages.json + - Microsoft.App/preview/2024-02-02-preview/FunctionsExtension.json + - Microsoft.App/preview/2024-02-02-preview/LogicAppsExtension.json + - Microsoft.App/preview/2024-02-02-preview/SessionPools.json +directive: + - suppress: PatchBodyParametersSchema + from: JavaComponents.json + reason: | + Java Component is using componentType as the discriminator. While the discriminator is a required property, this rule prevent it being present in the patch request body. + - suppress: LroErrorContent + from: SessionPools.json + reason: | + Using the same error response as other APIs. +``` ### Tag: package-2024-03 @@ -56,6 +103,7 @@ input-file: - Microsoft.App/stable/2024-03-01/Subscriptions.json - Microsoft.App/stable/2024-03-01/Usages.json ``` + ### Tag: package-preview-2023-11 These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. @@ -129,12 +177,12 @@ directive: - suppress: LroErrorContent from: Builds.json reason: | - We are not using the common error response for these new resources to promote consistency + We are not using the common error response for these new resources to promote consistency with the rest of the Microsoft.App RP, as it also doesn't use the common-types error. - suppress: LroErrorContent from: Builders.json reason: | - We are not using the common error response for these new resources to promote consistency + We are not using the common error response for these new resources to promote consistency with the rest of the Microsoft.App RP, as it also doesn't use the common-types error. ``` From c0a830f11641652d5b2b0a35656ef1f815707971 Mon Sep 17 00:00:00 2001 From: Chenglong Liu <48578056+ChenglongLiu@users.noreply.github.com> Date: Mon, 17 Jun 2024 10:18:10 -0700 Subject: [PATCH 186/343] Move 2024-05-01-preview for CDN private specs to public (#29369) --- .../preview/2024-05-01-preview/afdx.json | 6902 ++++++++++++++++ .../preview/2024-05-01-preview/cdn.json | 7352 +++++++++++++++++ .../cdnwebapplicationfirewall.json | 977 +++ .../examples/AFDCustomDomains_Create.json | 213 + .../examples/AFDCustomDomains_Delete.json | 18 + .../examples/AFDCustomDomains_Get.json | 58 + .../AFDCustomDomains_ListByProfile.json | 61 + ...DCustomDomains_RefreshValidationToken.json | 17 + .../examples/AFDCustomDomains_Update.json | 135 + .../examples/AFDEndpoints_Create.json | 70 + .../examples/AFDEndpoints_Delete.json | 18 + .../examples/AFDEndpoints_Get.json | 27 + .../examples/AFDEndpoints_ListByProfile.json | 30 + .../AFDEndpoints_ListResourceUsage.json | 27 + .../examples/AFDEndpoints_PurgeContent.json | 25 + .../examples/AFDEndpoints_Update.json | 52 + .../AFDEndpoints_ValidateCustomDomain.json | 21 + .../examples/AFDOriginGroups_Create.json | 99 + .../examples/AFDOriginGroups_Delete.json | 18 + .../examples/AFDOriginGroups_Get.json | 34 + .../AFDOriginGroups_ListByProfile.json | 37 + .../AFDOriginGroups_ListResourceUsage.json | 27 + .../examples/AFDOriginGroups_Update.json | 76 + .../examples/AFDOrigins_Create.json | 87 + .../examples/AFDOrigins_Delete.json | 19 + .../examples/AFDOrigins_Get.json | 33 + .../AFDOrigins_ListByOriginGroup.json | 36 + .../examples/AFDOrigins_Update.json | 65 + ...rofiles_CheckEndpointNameAvailability.json | 23 + ...AFDProfiles_CheckHostNameAvailability.json | 20 + .../AFDProfiles_ListResourceUsage.json | 26 + .../examples/AFDProfiles_Upgrade.json | 63 + .../examples/AFDProfiles_ValidateSecret.json | 22 + .../examples/CdnProfiles_CanMigrate.json | 26 + .../examples/CdnProfiles_Migrate.json | 31 + .../CheckEndpointNameAvailability.json | 22 + .../examples/CheckNameAvailability.json | 18 + ...CheckNameAvailabilityWithSubscription.json | 19 + .../examples/CustomDomains_Create.json | 65 + .../examples/CustomDomains_Delete.json | 32 + .../CustomDomains_DisableCustomHttps.json | 45 + ...tomDomains_EnableCustomHttpsUsingBYOC.json | 60 + ...CustomHttpsUsingCDNManagedCertificate.json | 54 + .../examples/CustomDomains_Get.json | 27 + .../CustomDomains_ListByEndpoint.json | 30 + .../examples/EdgeNodes_List.json | 107 + .../examples/Endpoints_Create.json | 546 ++ .../examples/Endpoints_Delete.json | 18 + .../examples/Endpoints_Get.json | 79 + .../examples/Endpoints_ListByProfile.json | 86 + .../examples/Endpoints_ListResourceUsage.json | 29 + .../examples/Endpoints_LoadContent.json | 22 + .../examples/Endpoints_PurgeContent.json | 22 + .../examples/Endpoints_Start.json | 86 + .../examples/Endpoints_Stop.json | 86 + .../examples/Endpoints_Update.json | 141 + .../Endpoints_ValidateCustomDomain.json | 21 + .../examples/KeyGroups_Create.json | 70 + .../examples/KeyGroups_Delete.json | 17 + .../examples/KeyGroups_Get.json | 33 + .../examples/KeyGroups_ListByProfile.json | 79 + ...LogAnalytics_GetLogAnalyticsLocations.json | 60 + .../LogAnalytics_GetLogAnalyticsMetrics.json | 71 + .../LogAnalytics_GetLogAnalyticsRankings.json | 82 + ...LogAnalytics_GetLogAnalyticsResources.json | 55 + ...ogAnalytics_GetWafLogAnalyticsMetrics.json | 132 + ...gAnalytics_GetWafLogAnalyticsRankings.json | 42 + .../examples/Operations_List.json | 93 + .../examples/OriginGroups_Create.json | 112 + .../examples/OriginGroups_Delete.json | 19 + .../examples/OriginGroups_Get.json | 44 + .../examples/OriginGroups_ListByEndpoint.json | 41 + .../examples/OriginGroups_Update.json | 74 + .../examples/Origins_Create.json | 95 + .../examples/Origins_Delete.json | 19 + .../examples/Origins_Get.json | 33 + .../examples/Origins_ListByEndpoint.json | 36 + .../examples/Origins_Update.json | 68 + .../examples/Profiles_CanMigrate.json | 31 + .../examples/Profiles_Create.json | 98 + .../examples/Profiles_Delete.json | 17 + .../examples/Profiles_GenerateSsoUri.json | 15 + .../examples/Profiles_Get.json | 33 + .../examples/Profiles_List.json | 56 + .../Profiles_ListByResourceGroup.json | 57 + .../examples/Profiles_ListResourceUsage.json | 22 + ...ofiles_ListSupportedOptimizationTypes.json | 18 + .../examples/Profiles_Migrate.json | 43 + .../examples/Profiles_MigrationAbort.json | 18 + .../examples/Profiles_MigrationCommit.json | 16 + .../examples/Profiles_Update.json | 68 + .../examples/ResourceUsage_List.json | 20 + .../examples/Routes_Create.json | 200 + .../examples/Routes_Delete.json | 19 + .../examples/Routes_Get.json | 60 + .../examples/Routes_ListByEndpoint.json | 63 + .../examples/Routes_Update.json | 151 + .../examples/RuleSets_Create.json | 33 + .../examples/RuleSets_Delete.json | 18 + .../examples/RuleSets_Get.json | 22 + .../examples/RuleSets_ListByProfile.json | 25 + .../examples/RuleSets_ListResourceUsage.json | 27 + .../examples/Rules_Create.json | 158 + .../Rules_Create_AfdUrlSigningAction.json | 196 + .../examples/Rules_Delete.json | 19 + .../examples/Rules_Get.json | 50 + .../examples/Rules_ListByRuleSet.json | 53 + .../examples/Rules_Update.json | 107 + ...Secrets_CreateCustomerCertificateType.json | 107 + ...ecrets_CreateMtlsCertificateChainType.json | 79 + .../Secrets_CreateUrlSigningKeyType.json | 80 + .../examples/Secrets_Delete.json | 18 + .../examples/Secrets_Get.json | 38 + .../examples/Secrets_ListByProfile.json | 55 + .../examples/SecurityPolicies_Create.json | 135 + .../examples/SecurityPolicies_Delete.json | 18 + .../examples/SecurityPolicies_Get.json | 43 + .../SecurityPolicies_ListByProfile.json | 46 + .../examples/SecurityPolicies_Patch.json | 103 + .../examples/ValidateProbe.json | 18 + .../examples/WafListManagedRuleSets.json | 53 + .../examples/WafListPolicies.json | 265 + .../examples/WafPatchPolicy.json | 275 + .../examples/WafPolicyCreateOrUpdate.json | 508 ++ .../examples/WafPolicyDelete.json | 12 + .../examples/WafPolicyGet.json | 139 + .../AFDProfiles_Upgrade_WithoutWaf.yaml | 28 + specification/cdn/resource-manager/readme.md | 11 + 128 files changed, 23379 insertions(+) create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/afdx.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/cdn.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/cdnwebapplicationfirewall.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_RefreshValidationToken.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_PurgeContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ValidateCustomDomain.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_ListByOriginGroup.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_CheckEndpointNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_CheckHostNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_Upgrade.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ValidateSecret.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CdnProfiles_CanMigrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CdnProfiles_Migrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckEndpointNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckNameAvailabilityWithSubscription.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_DisableCustomHttps.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/EdgeNodes_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_LoadContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_PurgeContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Start.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Stop.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ValidateCustomDomain.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsLocations.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsMetrics.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsRankings.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsResources.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetWafLogAnalyticsRankings.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Operations_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_CanMigrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_GenerateSsoUri.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListByResourceGroup.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListSupportedOptimizationTypes.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Migrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_MigrationAbort.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_MigrationCommit.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/ResourceUsage_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Create_AfdUrlSigningAction.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_ListByRuleSet.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateCustomerCertificateType.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateMtlsCertificateChainType.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateUrlSigningKeyType.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Patch.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/ValidateProbe.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafListManagedRuleSets.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafListPolicies.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPatchPolicy.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyCreateOrUpdate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyDelete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyGet.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/afdx.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/afdx.json new file mode 100644 index 000000000000..a59df08620af --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/afdx.json @@ -0,0 +1,6902 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure Front Door resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/checkEndpointNameAvailability": { + "post": { + "tags": [ + "CheckEndpointNameAvailability" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.", + "operationId": "CheckEndpointNameAvailability", + "x-ms-examples": { + "CheckEndpointNameAvailability": { + "$ref": "./examples/CheckEndpointNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkEndpointNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkEndpointNameAvailability": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.", + "operationId": "AFDProfiles_CheckEndpointNameAvailability", + "x-ms-examples": { + "CheckEndpointNameAvailability": { + "$ref": "./examples/AFDProfiles_CheckEndpointNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkEndpointNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/usages": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile.", + "operationId": "AFDProfiles_ListResourceUsage", + "x-ms-examples": { + "AFDProfiles_ListResourceUsage": { + "$ref": "./examples/AFDProfiles_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkHostNameAvailability": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.", + "operationId": "AFDProfiles_CheckHostNameAvailability", + "x-ms-examples": { + "AFDProfiles_CheckHostNameAvailability": { + "$ref": "./examples/AFDProfiles_CheckHostNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "checkHostNameAvailabilityInput", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckHostNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/validateSecret": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Validate a Secret in the profile.", + "operationId": "AFDProfiles_ValidateSecret", + "x-ms-examples": { + "Validate_Secret": { + "$ref": "./examples/AFDProfiles_ValidateSecret.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "name": "validateSecretInput", + "in": "body", + "description": "The Secret source.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateSecretInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateSecretOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/upgrade": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.", + "operationId": "AFDProfiles_Upgrade", + "x-ms-examples": { + "AFDProfiles_Upgrade": { + "$ref": "./examples/AFDProfiles_Upgrade.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "name": "profileUpgradeParameters", + "in": "body", + "description": "Profile upgrade input parameter.", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpgradeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "./cdn.json#/definitions/Profile" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains": { + "get": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Lists existing AzureFrontDoor domains.", + "operationId": "AFDCustomDomains_ListByProfile", + "x-ms-examples": { + "AFDCustomDomains_ListByProfile": { + "$ref": "./examples/AFDCustomDomains_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomainListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.", + "operationId": "AFDCustomDomains_Get", + "x-ms-examples": { + "AFDCustomDomains_Get": { + "$ref": "./examples/AFDCustomDomains_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Creates a new domain within the specified profile.", + "operationId": "AFDCustomDomains_Create", + "x-ms-examples": { + "AFDCustomDomains_Create": { + "$ref": "./examples/AFDCustomDomains_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "name": "customDomain", + "in": "body", + "description": "Domain properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new domain has been created.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Updates an existing domain within a profile.", + "operationId": "AFDCustomDomains_Update", + "x-ms-examples": { + "AFDCustomDomains_Update": { + "$ref": "./examples/AFDCustomDomains_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "name": "customDomainUpdateProperties", + "in": "body", + "description": "Domain properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDDomainUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.", + "operationId": "AFDCustomDomains_Delete", + "x-ms-examples": { + "AFDCustomDomains_Delete": { + "$ref": "./examples/AFDCustomDomains_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the domain was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}/refreshValidationToken": { + "post": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Updates the domain validation token.", + "operationId": "AFDCustomDomains_RefreshValidationToken", + "x-ms-examples": { + "AFDCustomDomains_Delete": { + "$ref": "./examples/AFDCustomDomains_RefreshValidationToken.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. Please poll the targeted custom domain and check the 'validationProperties' field for the new validation token values.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints": { + "get": { + "tags": [ + "AFDEndpoints" + ], + "description": "Lists existing AzureFrontDoor endpoints.", + "operationId": "AFDEndpoints_ListByProfile", + "x-ms-examples": { + "AFDEndpoints_ListByProfile": { + "$ref": "./examples/AFDEndpoints_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpointListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}": { + "get": { + "tags": [ + "AFDEndpoints" + ], + "description": "Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Get", + "x-ms-examples": { + "AFDEndpoints_Get": { + "$ref": "./examples/AFDEndpoints_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDEndpoints" + ], + "description": "Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Create", + "x-ms-examples": { + "AFDEndpoints_Create": { + "$ref": "./examples/AFDEndpoints_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpoint", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDEndpoints" + ], + "description": "Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.", + "operationId": "AFDEndpoints_Update", + "x-ms-examples": { + "AFDEndpoints_Update": { + "$ref": "./examples/AFDEndpoints_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpointUpdateProperties", + "in": "body", + "description": "Endpoint update properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDEndpointUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDEndpoints" + ], + "description": "Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Delete", + "x-ms-examples": { + "AFDEndpoints_Delete": { + "$ref": "./examples/AFDEndpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Removes a content from AzureFrontDoor.", + "operationId": "AFDEndpoints_PurgeContent", + "x-ms-examples": { + "AFDEndpoints_PurgeContent": { + "$ref": "./examples/AFDEndpoints_PurgeContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contents", + "in": "body", + "description": "The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/AfdPurgeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/usages": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile.", + "operationId": "AFDEndpoints_ListResourceUsage", + "x-ms-examples": { + "AFDEndpoints_ListResourceUsage": { + "$ref": "./examples/AFDEndpoints_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.", + "operationId": "AFDEndpoints_ValidateCustomDomain", + "x-ms-examples": { + "Endpoints_ValidateCustomDomain": { + "$ref": "./examples/AFDEndpoints_ValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "./cdn.json#/definitions/ValidateCustomDomainInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups": { + "get": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Lists all of the existing origin groups within a profile.", + "operationId": "AFDOriginGroups_ListByProfile", + "x-ms-examples": { + "AFDOriginGroups_ListByProfile": { + "$ref": "./examples/AFDOriginGroups_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroupListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}": { + "get": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Gets an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Get", + "x-ms-examples": { + "AFDOriginGroups_Get": { + "$ref": "./examples/AFDOriginGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Creates a new origin group within the specified profile.", + "operationId": "AFDOriginGroups_Create", + "x-ms-examples": { + "AFDOriginGroups_Create": { + "$ref": "./examples/AFDOriginGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroup", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin group has been created.", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Updates an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Update", + "x-ms-examples": { + "AFDOriginGroups_Update": { + "$ref": "./examples/AFDOriginGroups_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originGroupUpdateProperties", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginGroupUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Deletes an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Delete", + "x-ms-examples": { + "AFDOriginGroups_Delete": { + "$ref": "./examples/AFDOriginGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin group was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/usages": { + "post": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile..", + "operationId": "AFDOriginGroups_ListResourceUsage", + "x-ms-examples": { + "AFDOriginGroups_ListResourceUsage": { + "$ref": "./examples/AFDOriginGroups_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins": { + "get": { + "tags": [ + "AFDOrigins" + ], + "description": "Lists all of the existing origins within an origin group.", + "operationId": "AFDOrigins_ListByOriginGroup", + "x-ms-examples": { + "AFDOrigins_ListByOriginGroup": { + "$ref": "./examples/AFDOrigins_ListByOriginGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}": { + "get": { + "tags": [ + "AFDOrigins" + ], + "description": "Gets an existing origin within an origin group.", + "operationId": "AFDOrigins_Get", + "x-ms-examples": { + "AFDOrigins_Get": { + "$ref": "./examples/AFDOrigins_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDOrigins" + ], + "description": "Creates a new origin within the specified origin group.", + "operationId": "AFDOrigins_Create", + "x-ms-examples": { + "AFDOrigins_Create": { + "$ref": "./examples/AFDOrigins_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin that is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "origin", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin has been created.", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDOrigins" + ], + "description": "Updates an existing origin within an origin group.", + "operationId": "AFDOrigins_Update", + "x-ms-examples": { + "AFDOrigins_Update": { + "$ref": "./examples/AFDOrigins_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originUpdateProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDOrigins" + ], + "description": "Deletes an existing origin within an origin group.", + "operationId": "AFDOrigins_Delete", + "x-ms-examples": { + "AFDOrigins_Delete": { + "$ref": "./examples/AFDOrigins_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes": { + "get": { + "tags": [ + "Routes" + ], + "description": "Lists all of the existing origins within a profile.", + "operationId": "Routes_ListByEndpoint", + "x-ms-examples": { + "Routes_ListByEndpoint": { + "$ref": "./examples/Routes_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}": { + "get": { + "tags": [ + "Routes" + ], + "description": "Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Get", + "x-ms-examples": { + "Routes_Get": { + "$ref": "./examples/Routes_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Routes" + ], + "description": "Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Create", + "x-ms-examples": { + "Routes_Create": { + "$ref": "./examples/Routes_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "name": "route", + "in": "body", + "description": "Route properties", + "required": true, + "schema": { + "$ref": "#/definitions/Route" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Routes" + ], + "description": "Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Update", + "x-ms-examples": { + "Routes_Update": { + "$ref": "./examples/Routes_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "name": "routeUpdateProperties", + "in": "body", + "description": "Route update properties", + "required": true, + "schema": { + "$ref": "#/definitions/RouteUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Routes" + ], + "description": "Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Delete", + "x-ms-examples": { + "Routes_Delete": { + "$ref": "./examples/Routes_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets": { + "get": { + "tags": [ + "RuleSets" + ], + "description": "Lists existing AzureFrontDoor rule sets within a profile.", + "operationId": "RuleSets_ListByProfile", + "x-ms-examples": { + "RuleSets_ListByProfile": { + "$ref": "./examples/RuleSets_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSetListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}": { + "get": { + "tags": [ + "RuleSets" + ], + "description": "Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.", + "operationId": "RuleSets_Get", + "x-ms-examples": { + "RuleSets_Get": { + "$ref": "./examples/RuleSets_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RuleSets" + ], + "description": "Creates a new rule set within the specified profile.", + "operationId": "RuleSets_Create", + "x-ms-examples": { + "RuleSets_Create": { + "$ref": "./examples/RuleSets_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new rule set has been created.", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RuleSets" + ], + "description": "Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.", + "operationId": "RuleSets_Delete", + "x-ms-examples": { + "RuleSets_Delete": { + "$ref": "./examples/RuleSets_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the rule set was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/usages": { + "post": { + "tags": [ + "RuleSets" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile..", + "operationId": "RuleSets_ListResourceUsage", + "x-ms-examples": { + "RuleSets_ListResourceUsage": { + "$ref": "./examples/RuleSets_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules": { + "get": { + "tags": [ + "Rules" + ], + "description": "Lists all of the existing delivery rules within a rule set.", + "operationId": "Rules_ListByRuleSet", + "x-ms-examples": { + "Rules_ListByRuleSet": { + "$ref": "./examples/Rules_ListByRuleSet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}": { + "get": { + "tags": [ + "Rules" + ], + "description": "Gets an existing delivery rule within a rule set.", + "operationId": "Rules_Get", + "x-ms-examples": { + "Rules_Get": { + "$ref": "./examples/Rules_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Rules" + ], + "description": "Creates a new delivery rule within the specified rule set.", + "operationId": "Rules_Create", + "x-ms-examples": { + "Rules_Create": { + "$ref": "./examples/Rules_Create.json" + }, + "Rules_Create_AfdUrlSigningAction": { + "$ref": "./examples/Rules_Create_AfdUrlSigningAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "rule", + "in": "body", + "description": "The delivery rule properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Rules" + ], + "description": "Updates an existing delivery rule within a rule set.", + "operationId": "Rules_Update", + "x-ms-examples": { + "Rules_Update": { + "$ref": "./examples/Rules_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "ruleUpdateProperties", + "in": "body", + "description": "Delivery rule properties", + "required": true, + "schema": { + "$ref": "#/definitions/RuleUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Rules" + ], + "description": "Deletes an existing delivery rule within a rule set.", + "operationId": "Rules_Delete", + "x-ms-examples": { + "Rules_Delete": { + "$ref": "./examples/Rules_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies": { + "get": { + "tags": [ + "SecurityPolicies" + ], + "description": "Lists security policies associated with the profile", + "operationId": "SecurityPolicies_ListByProfile", + "x-ms-examples": { + "SecurityPolicies_ListByProfile": { + "$ref": "./examples/SecurityPolicies_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicyListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}": { + "get": { + "tags": [ + "SecurityPolicies" + ], + "description": "Gets an existing security policy within a profile.", + "operationId": "SecurityPolicies_Get", + "x-ms-examples": { + "SecurityPolicies_Get": { + "$ref": "./examples/SecurityPolicies_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "SecurityPolicies" + ], + "description": "Creates a new security policy within the specified profile.", + "operationId": "SecurityPolicies_Create", + "x-ms-examples": { + "SecurityPolicies_Create": { + "$ref": "./examples/SecurityPolicies_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicy", + "in": "body", + "description": "The security policy properties.", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SecurityPolicies" + ], + "description": "Updates an existing security policy within a profile.", + "operationId": "SecurityPolicies_Patch", + "x-ms-examples": { + "SecurityPolicies_Patch": { + "$ref": "./examples/SecurityPolicies_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyUpdateProperties", + "in": "body", + "description": "Security policy update properties", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPolicyUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SecurityPolicies" + ], + "description": "Deletes an existing security policy within profile.", + "operationId": "SecurityPolicies_Delete", + "x-ms-examples": { + "SecurityPolicies_Delete": { + "$ref": "./examples/SecurityPolicies_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets": { + "get": { + "tags": [ + "Secrets" + ], + "description": "Lists existing AzureFrontDoor secrets.", + "operationId": "Secrets_ListByProfile", + "x-ms-examples": { + "Secrets_ListByProfile": { + "$ref": "./examples/Secrets_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}": { + "get": { + "tags": [ + "Secrets" + ], + "description": "Gets an existing Secret within a profile.", + "operationId": "Secrets_Get", + "x-ms-examples": { + "Secrets_Get": { + "$ref": "./examples/Secrets_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Secrets" + ], + "description": "Creates a new Secret within the specified profile.", + "operationId": "Secrets_Create", + "x-ms-examples": { + "Secrets_Create": { + "$ref": "./examples/Secrets_CreateCustomerCertificateType.json" + }, + "Secrets_CreateUrlSigningKeyType": { + "$ref": "./examples/Secrets_CreateUrlSigningKeyType.json" + }, + "Secrets_CreateMtlsCertificateChainType": { + "$ref": "./examples/Secrets_CreateMtlsCertificateChainType.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "name": "secret", + "in": "body", + "description": "The Secret properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Secret" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Secrets" + ], + "description": "Deletes an existing Secret within profile.", + "operationId": "Secrets_Delete", + "x-ms-examples": { + "Secrets_Delete": { + "$ref": "./examples/Secrets_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/keyGroups": { + "get": { + "tags": [ + "KeyGroups" + ], + "description": "Lists existing AzureFrontDoor KeyGroups.", + "operationId": "KeyGroups_ListByProfile", + "x-ms-examples": { + "KeyGroups_ListByProfile": { + "$ref": "./examples/KeyGroups_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KeyGroupListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/keyGroups/{keyGroupName}": { + "get": { + "tags": [ + "KeyGroups" + ], + "description": "Gets an existing KeyGroup within a profile.", + "operationId": "KeyGroups_Get", + "x-ms-examples": { + "KeyGroups_Get": { + "$ref": "./examples/KeyGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/keyGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KeyGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "KeyGroups" + ], + "description": "Creates or updates a new KeyGroup within the specified profile.", + "operationId": "KeyGroups_CreateUpdate", + "x-ms-examples": { + "KeyGroups_Create": { + "$ref": "./examples/KeyGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/keyGroupNameParameter" + }, + { + "name": "keyGroup", + "in": "body", + "description": "The KeyGroup properties.", + "required": true, + "schema": { + "$ref": "#/definitions/KeyGroup" + } + } + ], + "responses": { + "200": { + "description": "OK. Update succeeded for an existing key group.", + "schema": { + "$ref": "#/definitions/KeyGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new key group has been created.", + "schema": { + "$ref": "#/definitions/KeyGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "KeyGroups" + ], + "description": "Deletes an existing KeyGroup within profile.", + "operationId": "KeyGroups_Delete", + "x-ms-examples": { + "KeyGroups_Delete": { + "$ref": "./examples/KeyGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/keyGroupNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the key group was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsMetrics": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsMetrics", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsMetrics": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsMetrics.json" + } + }, + "description": "Get log report for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string", + "enum": [ + "clientRequestCount", + "clientRequestTraffic", + "clientRequestBandwidth", + "originRequestTraffic", + "originRequestBandwidth", + "totalLatency" + ], + "x-ms-enum": { + "name": "LogMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "granularity", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "LogMetricsGranularity", + "modelAsString": true + } + }, + { + "name": "groupBy", + "in": "query", + "type": "array", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "httpStatusCode", + "protocol", + "cacheStatus", + "countryOrRegion", + "customDomain" + ], + "x-ms-enum": { + "name": "LogMetricsGroupBy", + "modelAsString": true + } + } + }, + { + "name": "continents", + "type": "array", + "in": "query", + "collectionFormat": "multi", + "required": false, + "items": { + "type": "string" + } + }, + { + "name": "countryOrRegions", + "type": "array", + "in": "query", + "collectionFormat": "multi", + "required": false, + "items": { + "type": "string" + } + }, + { + "name": "customDomains", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + } + }, + { + "name": "protocols", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/MetricsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsRankings": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsRankings", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsRankings": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsRankings.json" + } + }, + "description": "Get log analytics ranking report for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "rankings", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "url", + "referrer", + "browser", + "userAgent", + "countryOrRegion" + ], + "x-ms-enum": { + "name": "LogRanking", + "modelAsString": true + } + } + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount", + "clientRequestTraffic", + "hitCount", + "missCount", + "userErrorCount", + "errorCount" + ], + "x-ms-enum": { + "name": "LogRankingMetric", + "modelAsString": true + } + } + }, + { + "name": "maxRanking", + "in": "query", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "customDomains", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/RankingsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsLocations": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsLocations", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsLocations": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsLocations.json" + } + }, + "description": "Get all available location names for AFD log analytics report.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/ContinentsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsResources": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsResources", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsResources": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsResources.json" + } + }, + "description": "Get all endpoints and custom domains available for AFD log report", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/ResourcesResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics": { + "get": { + "tags": [ + "WafLogAnalytics" + ], + "operationId": "LogAnalytics_GetWafLogAnalyticsMetrics", + "x-ms-examples": { + "LogAnalytics_GetWafLogAnalyticsMetrics": { + "$ref": "./examples/LogAnalytics_GetWafLogAnalyticsMetrics.json" + } + }, + "description": "Get Waf related log analytics report for AFD profile.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount" + ], + "x-ms-enum": { + "name": "WafMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "granularity", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "WafGranularity", + "modelAsString": true + } + }, + { + "name": "actions", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "allow", + "block", + "log", + "redirect" + ], + "x-ms-enum": { + "name": "WafAction", + "modelAsString": true + } + } + }, + { + "name": "groupBy", + "in": "query", + "type": "array", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "httpStatusCode", + "customDomain" + ], + "x-ms-enum": { + "name": "WafRankingGroupBy", + "modelAsString": true + } + } + }, + { + "name": "ruleTypes", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "managed", + "custom", + "bot" + ], + "x-ms-enum": { + "name": "WafRuleType", + "modelAsString": true + } + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WafMetricsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings": { + "get": { + "tags": [ + "WafLogAnalytics" + ], + "operationId": "LogAnalytics_GetWafLogAnalyticsRankings", + "x-ms-examples": { + "LogAnalytics_GetWafLogAnalyticsRankings": { + "$ref": "./examples/LogAnalytics_GetWafLogAnalyticsRankings.json" + } + }, + "description": "Get WAF log analytics charts for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount" + ], + "x-ms-enum": { + "name": "WafMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "maxRanking", + "in": "query", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "rankings", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "action", + "ruleGroup", + "ruleId", + "userAgent", + "clientIp", + "url", + "countryOrRegion", + "ruleType" + ], + "x-ms-enum": { + "name": "WafRankingType", + "modelAsString": true + } + } + }, + { + "name": "actions", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "allow", + "block", + "log", + "redirect" + ], + "x-ms-enum": { + "name": "WafAction", + "modelAsString": true + } + } + }, + { + "name": "ruleTypes", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "managed", + "custom", + "bot" + ], + "x-ms-enum": { + "name": "WafRuleType", + "modelAsString": true + } + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WafRankingsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ProfileChangeSkuWafMapping": { + "type": "object", + "description": "Parameters required for profile upgrade.", + "required": [ + "securityPolicyName", + "changeToWafPolicy" + ], + "properties": { + "securityPolicyName": { + "description": "The security policy name.", + "type": "string" + }, + "changeToWafPolicy": { + "description": "The new waf resource for the security policy to use.", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "ProfileUpgradeParameters": { + "type": "object", + "description": "Parameters required for profile upgrade.", + "required": [ + "wafMappingList" + ], + "properties": { + "wafMappingList": { + "description": "Web Application Firewall (WAF) and security policy mapping for the profile upgrade", + "type": "array", + "items": { + "description": "List of waf mappings", + "$ref": "#/definitions/ProfileChangeSkuWafMapping" + }, + "x-ms-identifiers": [] + } + } + }, + "AfdPurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + }, + "domains": { + "description": "List of domains.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Certificate": { + "description": "Certificate used for https", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/SecretType" + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedCertificate": { + "description": "Managed Certificate used for https", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ] + }, + "CustomerCertificate": { + "description": "Customer Certificate used for https", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Certificate version.", + "type": "string" + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "useLatestVersion": { + "description": "Whether to use the latest version for the certificate", + "type": "boolean" + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFirstPartyManagedCertificate": { + "description": "Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ] + }, + "ValidateSecretInput": { + "description": "Input of the secret to be validated.", + "type": "object", + "required": [ + "secretSource", + "secretType" + ], + "properties": { + "secretType": { + "description": "The secret type.", + "$ref": "#/definitions/SecretType" + }, + "secretSource": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Secret version, if customer is using a specific version.", + "type": "string" + } + } + }, + "ValidateSecretOutput": { + "description": "Output of the validated secret.", + "type": "object", + "properties": { + "status": { + "description": "The validation status.", + "enum": [ + "Valid", + "Invalid", + "AccessDenied", + "CertificateExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "message": { + "description": "Detailed error message", + "type": "string" + } + } + }, + "KeyGroup": { + "description": "Contains a list of references of UrlSigningKey type secret objects.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/KeyGroupProperties" + } + } + }, + "KeyGroupProperties": { + "description": "The JSON object that contains the properties of the key group to create.", + "allOf": [ + { + "$ref": "#/definitions/KeyGroupUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "KeyGroupUpdatePropertiesParameters": { + "description": "The JSON object containing properties of key group to create or update.", + "type": "object", + "properties": { + "keyReferences": { + "description": "Names of UrlSigningKey type secret objects", + "type": "array", + "items": { + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "x-ms-identifiers": [] + } + } + }, + "KeyGroupListResult": { + "description": "Result of the request to list keyGroups. It contains a list of KeyGroup objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/KeyGroup" + }, + "description": "List of AzureFrontDoor KeyGroup within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of KeyGroup objects if there are any." + } + } + }, + "AFDDomainListResult": { + "description": "Result of the request to list domains. It contains a list of domain objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDDomain" + }, + "description": "List of AzureFrontDoor domains within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of domain objects if there are any." + } + } + }, + "AFDDomain": { + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDDomainProperties" + } + } + }, + "AFDDomainProperties": { + "description": "The JSON object that contains the properties of the domain to create.", + "type": "object", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/AFDDomainUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "domainValidationState": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.", + "readOnly": true, + "enum": [ + "Unknown", + "Submitting", + "Pending", + "Rejected", + "TimedOut", + "PendingRevalidation", + "Approved", + "RefreshingValidationToken", + "InternalError" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainValidationState", + "modelAsString": true + } + }, + "hostName": { + "description": "The host name of the domain. Must be a domain name.", + "type": "string" + }, + "extendedProperties": { + "description": "Key-Value pair representing migration properties for domains.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "validationProperties": { + "description": "Values the customer needs to validate domain ownership", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/DomainValidationProperties" + }, + "referencedRoutePaths": { + "description": "The JSON object list that contains the overall picture of how routes are used for the shared custom domain across different profiles.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AFDDomainReferencedRoutePath" + }, + "x-ms-identifiers": [ + "/routeId/id" + ] + } + } + }, + "AFDDomainUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDDomainUpdatePropertiesParameters" + } + } + }, + "AFDDomainUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the domain to create.", + "type": "object", + "properties": { + "profileName": { + "description": "The name of the profile which holds the domain.", + "type": "string", + "readOnly": true + }, + "tlsSettings": { + "description": "The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.", + "type": "object", + "$ref": "#/definitions/AFDDomainHttpsParameters" + }, + "mtlsSettings": { + "description": "The configuration specifying how to enable mutual TLS for the domain, including specifying allowed FQDN and which server certificate(s) to use.", + "type": "object", + "$ref": "#/definitions/AFDDomainMtlsParameters" + }, + "azureDnsZone": { + "description": "Resource reference to the Azure DNS zone", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "preValidatedCustomDomainResourceId": { + "description": "Resource reference to the Azure resource where custom domain ownership was prevalidated", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "DomainValidationProperties": { + "description": "The JSON object that contains the properties to validate a domain.", + "type": "object", + "properties": { + "validationToken": { + "description": "Challenge used for DNS TXT record or file based validation", + "readOnly": true, + "type": "string" + }, + "expirationDate": { + "description": "The date time that the token expires", + "readOnly": true, + "type": "string" + } + } + }, + "AFDDomainHttpsParameters": { + "description": "The JSON object that contains the properties to secure a domain.", + "type": "object", + "required": [ + "certificateType" + ], + "properties": { + "certificateType": { + "description": "Defines the source of the SSL certificate.", + "enum": [ + "CustomerCertificate", + "ManagedCertificate", + "AzureFirstPartyManagedCertificate" + ], + "type": "string", + "x-ms-enum": { + "name": "AfdCertificateType", + "modelAsString": true + } + }, + "cipherSuiteSetType": { + "description": "cipher suite set type that will be used for Https", + "enum": [ + "Customized", + "TLS10_2019", + "TLS12_2022", + "TLS12_2023" + ], + "type": "string", + "x-ms-enum": { + "name": "AfdCipherSuiteSetType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https when cipherSuiteSetType is Customized.", + "enum": [ + "TLS10", + "TLS12", + "TLS13" + ], + "type": "string", + "x-ms-enum": { + "name": "AfdMinimumTlsVersion", + "modelAsString": false + } + }, + "customizedCipherSuiteSet": { + "description": "Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized.", + "type": "object", + "$ref": "#/definitions/AFDDomainHttpsCustomizedCipherSuiteSet" + }, + "secret": { + "description": "Resource reference to the secret. ie. subs/rg/profile/secret", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "AFDDomainHttpsCustomizedCipherSuiteSet": { + "description": "Customized cipher suite set object that will be used for Https when cipherSuiteSetType is Customized.", + "type": "object", + "properties": { + "cipherSuiteSetForTls10": { + "description": "Cipher suites for TLS 1.0. Required at least one in minimumTlsVersion TLS 1.0.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "ECDHE_RSA_AES128_SHA", + "ECDHE_RSA_AES256_SHA", + "AES256_SHA", + "AES128_SHA" + ], + "x-ms-enum": { + "name": "AfdCustomizedCipherSuiteForTls10", + "modelAsString": true + } + } + }, + "cipherSuiteSetForTls12": { + "description": "Cipher suites for TLS 1.2. Required at least one in minimumTlsVersion TLS 1.2, option in minimumTlsVersion TLS 1.0.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "ECDHE_RSA_AES128_GCM_SHA256", + "ECDHE_RSA_AES256_GCM_SHA384", + "DHE_RSA_AES256_GCM_SHA384", + "DHE_RSA_AES128_GCM_SHA256", + "ECDHE_RSA_AES128_SHA256", + "ECDHE_RSA_AES256_SHA384", + "AES256_GCM_SHA384", + "AES128_GCM_SHA256", + "AES256_SHA256", + "AES128_SHA256" + ], + "x-ms-enum": { + "name": "AfdCustomizedCipherSuiteForTls12", + "modelAsString": true + } + } + }, + "cipherSuiteSetForTls13": { + "description": "Cipher suites for TLS 1.3. Required at least one in minimumTlsVersion TLS 1.0, TLS 1.2, TLS 1.3.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_AES_128_GCM_SHA256", + "TLS_AES_256_GCM_SHA384" + ], + "x-ms-enum": { + "name": "AfdCustomizedCipherSuiteForTls13", + "modelAsString": true + } + } + } + } + }, + "AFDDomainReferencedRoutePath": { + "description": "route configuration of the shared custom domain.", + "type": "object", + "properties": { + "routeId": { + "description": "Resource reference to the route.", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "paths": { + "description": "List of paths of the route.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AFDDomainMtlsParameters": { + "description": "The JSON object that contains the properties to configure mutual TLS for a custom domain with FQDN. Mutual TLS cannot be configured for custom domains with wildcard host names.", + "type": "object", + "properties": { + "secrets": { + "description": "List of one or two of Resource References (ie. subs/rg/profile/secret) to Secrets of type MtlsCertificateChain to use in mutual TLS handshake.", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/ResourceReference" + } + }, + "otherAllowedFqdn": { + "description": "List of FQDN that will be accepted for mutual TLS validation in addition to custom domain's hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "certificateValidation": { + "description": "Set to Enabled by default. If set to Disabled, validation of client certificate chain for mutual TLS handshake will be skipped.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + }, + "certificatePassthrough": { + "description": "Set to Disabled by default. If set to Enabled, then selected client certificate chain(s) are sent directly to origin using reserved header.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + }, + "ocsp": { + "description": "Set to Enabled by default. If set to Disabled, revocation status of client certificate chain will be checked before establishing mutual TLS connection.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "SecurityPolicy": { + "description": "SecurityPolicy association for AzureFrontDoor profile", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPolicyProperties" + } + } + }, + "SecurityPolicyProperties": { + "description": "The json object that contains properties required to create a security policy", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the security policy.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "object which contains security policy parameters", + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + } + }, + "SecurityPolicyUpdateParameters": { + "description": "The JSON object containing security policy update parameters.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPolicyUpdateProperties" + } + } + }, + "SecurityPolicyUpdateProperties": { + "description": "The json object that contains properties required to update a security policy", + "type": "object", + "properties": { + "parameters": { + "description": "object which contains security policy parameters", + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + } + }, + "SecurityPolicyPropertiesParameters": { + "description": "The json object containing security policy parameters", + "discriminator": "type", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of the Security policy to create.", + "enum": [ + "WebApplicationFirewall" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityPolicyType", + "modelAsString": true + } + } + } + }, + "SecurityPolicyWebApplicationFirewallParameters": { + "description": "The json object containing security policy waf parameters", + "x-ms-discriminator-value": "WebApplicationFirewall", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + ], + "properties": { + "wafPolicy": { + "type": "object", + "description": "Resource ID.", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "associations": { + "description": "Waf associations", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityPolicyWebApplicationFirewallAssociation" + }, + "x-ms-identifiers": [] + } + } + }, + "SecurityPolicyWebApplicationFirewallAssociation": { + "description": "settings for security policy patterns to match", + "type": "object", + "properties": { + "domains": { + "description": "List of domains.", + "type": "array", + "items": { + "$ref": "#/definitions/ActivatedResourceReference" + } + }, + "patternsToMatch": { + "description": "List of paths", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SecurityPolicyListResult": { + "description": "Result of the request to list security policies. It contains a list of security policy objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SecurityPolicy" + }, + "description": "List of Security policies within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of security policy objects if there is any." + } + } + }, + "AutoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoGeneratedDomainNameLabelScope", + "modelAsString": true + } + }, + "AFDEndpoint": { + "description": "Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format .azureedge.net.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDEndpointProperties" + } + } + }, + "AFDEndpointProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDEndpointPropertiesUpdateParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "hostName": { + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", + "type": "string", + "readOnly": true + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope" + } + } + }, + "AFDEndpointListResult": { + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDEndpoint" + }, + "description": "List of AzureFrontDoor endpoints within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of endpoint objects if there is any." + } + } + }, + "AFDEndpointUpdateParameters": { + "type": "object", + "description": "Properties required to create or update an endpoint.", + "properties": { + "tags": { + "description": "Endpoint tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDEndpointPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDEndpointPropertiesUpdateParameters": { + "description": "The JSON object containing endpoint update parameters.", + "type": "object", + "properties": { + "profileName": { + "description": "The name of the profile which holds the endpoint.", + "type": "string", + "readOnly": true + }, + "enabledState": { + "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "CompressionSettings": { + "description": "settings for compression.", + "type": "object", + "properties": { + "contentTypesToCompress": { + "description": "List of content types on which compression applies. The value should be a valid MIME type.", + "type": "array", + "items": { + "type": "string" + } + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "boolean" + } + } + }, + "AFDEndpointProtocols": { + "description": "Supported protocols for the customer's endpoint.", + "enum": [ + "Http", + "Https" + ], + "type": "string", + "x-ms-enum": { + "name": "AFDEndpointProtocols", + "modelAsString": true + } + }, + "SecretListResult": { + "description": "Result of the request to list secrets. It contains a list of Secret objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Secret" + }, + "description": "List of AzureFrontDoor secrets within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of Secret objects if there are any." + } + } + }, + "Secret": { + "description": "Friendly Secret name mapping to the any Secret or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecretProperties" + } + } + }, + "SecretProperties": { + "description": "The JSON object that contains the properties of the Secret to create.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the secret.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "object which contains secret parameters", + "$ref": "#/definitions/SecretParameters" + } + } + }, + "SecretParameters": { + "description": "The json object containing secret parameters", + "discriminator": "type", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/SecretType" + } + } + }, + "SecretType": { + "description": "The type of the secret resource.", + "enum": [ + "UrlSigningKey", + "CustomerCertificate", + "ManagedCertificate", + "AzureFirstPartyManagedCertificate", + "MtlsCertificateChain" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true + } + }, + "UrlSigningKeyParameters": { + "description": "Url signing key parameters", + "x-ms-discriminator-value": "UrlSigningKey", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "required": [ + "keyId", + "secretSource", + "secretVersion" + ], + "properties": { + "keyId": { + "description": "Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.", + "type": "string" + }, + "secretSource": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Version of the secret to be used", + "type": "string" + } + } + }, + "ManagedCertificateParameters": { + "description": "Managed Certificate used for https", + "x-ms-discriminator-value": "ManagedCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "properties": { + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "CustomerCertificateParameters": { + "description": "Customer Certificate used for https", + "x-ms-discriminator-value": "CustomerCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "required": [ + "secretSource" + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Version of the secret to be used", + "type": "string" + }, + "useLatestVersion": { + "description": "Whether to use the latest version for the certificate", + "type": "boolean" + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFirstPartyManagedCertificateParameters": { + "description": "Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.", + "x-ms-discriminator-value": "AzureFirstPartyManagedCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference", + "readOnly": true + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "AfdSecretMtlsCertificateChain": { + "description": "Server-side certificate used for mTLS validation", + "x-ms-discriminator-value": "MtlsCertificateChain", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "required": [ + "secretSource", + "secretVersion" + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Version of the secret to be used", + "type": "string" + }, + "expirationDate": { + "description": "Soonest expiration date among certificates in customer's certificate chain in ISO 8601 compliant format yyyy-MM-ddTHH:mm:ss.fffffffK in UTC", + "type": "string", + "readOnly": true + } + } + }, + "RuleSetListResult": { + "description": "Result of the request to list rule sets. It contains a list of rule set objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RuleSet" + }, + "description": "List of AzureFrontDoor rule sets within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of rule set objects if there are any." + } + } + }, + "RuleSet": { + "description": "Friendly RuleSet name mapping to the any RuleSet or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleSetProperties" + } + } + }, + "RuleSetProperties": { + "description": "The JSON object that contains the properties of the Rule Set to create.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the rule set.", + "type": "string", + "readOnly": true + } + } + }, + "AFDOrigin": { + "description": "Azure Front Door origin is the source of the content being delivered via Azure Front Door. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginProperties" + } + } + }, + "AFDOriginProperties": { + "description": "The JSON object that contains the properties of the origin.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/AFDOriginUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "AFDOriginUpdateParameters": { + "type": "object", + "description": "AFDOrigin properties needed for origin update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDOriginUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin.", + "type": "object", + "properties": { + "originGroupName": { + "description": "The name of the origin group which contains this origin.", + "type": "string", + "readOnly": true + }, + "azureOrigin": { + "description": "Resource reference to the Azure origin resource.", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "hostName": { + "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "default": 80 + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "format": "int32", + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "default": 443 + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "sharedPrivateLinkResource": { + "description": "The properties of the private link resource for private origin.", + "type": "object", + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + }, + "enabledState": { + "description": "Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + }, + "enforceCertificateNameCheck": { + "description": "Whether to enable certificate name check at origin level", + "type": "boolean", + "default": true + } + } + }, + "SharedPrivateLinkResourceProperties": { + "type": "object", + "properties": { + "privateLink": { + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference", + "description": "The resource id of the resource the shared private link resource is for." + }, + "privateLinkLocation": { + "type": "string", + "description": "The location of the shared private link resource" + }, + "groupId": { + "type": "string", + "description": "The group id from the provider of resource the shared private link resource is for." + }, + "requestMessage": { + "type": "string", + "description": "The request message for requesting approval of the shared private link resource." + }, + "status": { + "type": "string", + "description": "Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": false + } + } + }, + "description": "Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin." + }, + "AFDOriginListResult": { + "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDOrigin" + }, + "description": "List of Azure Front Door origins within an Azure Front Door endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "AFDOriginGroup": { + "description": "AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginGroupProperties" + } + } + }, + "AFDOriginGroupProperties": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDOriginGroupUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "AFDOriginGroupUpdateParameters": { + "type": "object", + "description": "AFDOrigin group properties needed for origin group creation or update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginGroupUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDOriginGroupUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "properties": { + "profileName": { + "description": "The name of the profile which holds the origin group.", + "type": "string", + "readOnly": true + }, + "loadBalancingSettings": { + "description": "Load balancing settings for a backend pool", + "$ref": "#/definitions/LoadBalancingSettingsParameters" + }, + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "./cdn.json#/definitions/HealthProbeParameters" + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "sessionAffinityState": { + "description": "Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "LoadBalancingSettingsParameters": { + "description": "Round-Robin load balancing settings for a backend pool", + "type": "object", + "properties": { + "sampleSize": { + "description": "The number of samples to consider for load balancing decisions", + "type": "integer", + "format": "int32" + }, + "successfulSamplesRequired": { + "description": "The number of samples within the sample period that must succeed", + "type": "integer", + "format": "int32" + }, + "additionalLatencyInMilliseconds": { + "description": "The additional latency in milliseconds for probes to fall into the lowest latency bucket", + "type": "integer", + "format": "int32" + } + } + }, + "AFDOriginGroupListResult": { + "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDOriginGroup" + }, + "description": "List of Azure Front Door origin groups within an Azure Front Door endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "RouteListResult": { + "description": "Result of the request to list routes. It contains a list of route objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Route" + }, + "description": "List of AzureFrontDoor routes within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of route objects if there are any." + } + } + }, + "Route": { + "description": "Friendly Routes name mapping to the any Routes or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteProperties" + } + } + }, + "RouteProperties": { + "description": "The JSON object that contains the properties of the Routes to create.", + "allOf": [ + { + "$ref": "#/definitions/RouteUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "required": [ + "originGroup" + ] + }, + "RouteUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteUpdatePropertiesParameters" + } + } + }, + "RouteUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the domain to create.", + "type": "object", + "properties": { + "endpointName": { + "description": "The name of the endpoint which holds the route.", + "type": "string", + "readOnly": true + }, + "customDomains": { + "description": "Domains referenced by this endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/ActivatedResourceReference" + } + }, + "originGroup": { + "description": "A reference to the origin group.", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "originPath": { + "description": "A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", + "type": "string" + }, + "ruleSets": { + "description": "rule sets referenced by this endpoint.", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/ResourceReference" + } + }, + "supportedProtocols": { + "description": "List of supported protocols for this route.", + "type": "array", + "items": { + "$ref": "#/definitions/AFDEndpointProtocols" + }, + "default": [ + "Http", + "Https" + ] + }, + "patternsToMatch": { + "description": "The route patterns of the rule.", + "type": "array", + "items": { + "type": "string", + "description": "A route pattern of the rule. Must not have any * except possibly after the final / at the end of the path." + } + }, + "cacheConfiguration": { + "description": "The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "$ref": "#/definitions/AfdRouteCacheConfiguration" + }, + "forwardingProtocol": { + "description": "Protocol this rule will use when forwarding traffic to backends.", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "ForwardingProtocol", + "modelAsString": true + }, + "default": "MatchRequest" + }, + "linkToDefaultDomain": { + "description": "whether this route will be linked to the default endpoint domain.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LinkToDefaultDomain", + "modelAsString": true + }, + "default": "Disabled" + }, + "httpsRedirect": { + "description": "Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "httpsRedirect", + "modelAsString": true + }, + "default": "Disabled" + }, + "enabledState": { + "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + }, + "grpcState": { + "description": "Whether or not gRPC is enabled on this route. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AFDRouteGrpcState", + "modelAsString": true + } + } + } + }, + "AfdRouteCacheConfiguration": { + "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "properties": { + "queryStringCachingBehavior": { + "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.", + "enum": [ + "IgnoreQueryString", + "UseQueryString", + "IgnoreSpecifiedQueryStrings", + "IncludeSpecifiedQueryStrings" + ], + "type": "string", + "x-ms-enum": { + "name": "afdQueryStringCachingBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string" + }, + "compressionSettings": { + "description": "compression settings.", + "type": "object", + "$ref": "#/definitions/CompressionSettings" + } + } + }, + "RuleListResult": { + "description": "Result of the request to list rules. It contains a list of rule objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Rule" + }, + "description": "List of AzureFrontDoor rules within a rule set." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of rule objects if there are any." + } + } + }, + "Rule": { + "description": "Friendly Rules name mapping to the any Rules or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleProperties" + } + } + }, + "RuleProperties": { + "description": "The JSON object that contains the properties of the Rules to create.", + "type": "object", + "required": [ + "order", + "actions" + ], + "allOf": [ + { + "$ref": "#/definitions/RuleUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "RuleUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleUpdatePropertiesParameters" + } + } + }, + "RuleUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the rule to update.", + "type": "object", + "properties": { + "ruleSetName": { + "description": "The name of the rule set containing the rule.", + "type": "string", + "readOnly": true + }, + "order": { + "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.", + "type": "integer", + "format": "int32" + }, + "conditions": { + "description": "A list of conditions that must be matched for the actions to be executed", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/DeliveryRuleCondition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "actions": { + "description": "A list of actions that are executed when all the conditions of a rule are satisfied.", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/DeliveryRuleAction" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "matchProcessingBehavior": { + "description": "If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.", + "type": "string", + "enum": [ + "Continue", + "Stop" + ], + "x-ms-enum": { + "name": "MatchProcessingBehavior", + "modelAsString": true + }, + "default": "Continue" + } + } + }, + "AfdUrlSigningAction": { + "description": "Defines the url signing action for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "AfdUrlSigning", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/AfdUrlSigningActionParameters" + } + } + }, + "AfdUrlSigningActionParameters": { + "description": "Defines the parameters for the Url Signing action.", + "type": "object", + "required": [ + "typeName", + "keyGroupReference" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleAfdUrlSigningActionParameters" + ], + "x-ms-enum": { + "name": "typeName", + "modelAsString": true + } + }, + "keyGroupReference": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/keyGroups/{keyGroupName}", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "algorithm": { + "description": "Algorithm to use for URL signing", + "type": "string", + "enum": [ + "SHA256" + ], + "x-ms-enum": { + "name": "algorithm", + "modelAsString": true + } + }, + "parameterNameOverride": { + "description": "Defines which query string parameters in the url to be considered for expires, key id etc. ", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/UrlSigningParamIdentifier" + }, + "x-ms-identifiers": [ + "paramName" + ] + } + } + }, + "CheckEndpointNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "./cdn.json#/definitions/ResourceType" + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope" + } + } + }, + "CheckEndpointNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "availableHostname": { + "description": "Returns the available hostname generated based on the AutoGeneratedDomainNameLabelScope when the name is available, otherwise it returns empty string", + "readOnly": true, + "type": "string" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckHostNameAvailabilityInput": { + "description": "Input of CheckHostNameAvailability API.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name to validate.", + "type": "string" + } + } + }, + "ValidationToken": { + "description": "The validation token.", + "type": "object", + "properties": { + "token": { + "readOnly": true, + "type": "string" + } + } + }, + "AFDStateProperties": { + "description": "The tracking states for afd resources.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "description": "Provisioning status", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "AfdProvisioningState", + "modelAsString": true + } + }, + "deploymentStatus": { + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true + } + } + } + }, + "AfdErrorResponse": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + } + } + }, + "MetricsResponse": { + "description": "Metrics Response", + "type": "object", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "granularity": { + "type": "string", + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "MetricsGranularity", + "modelAsString": true + } + }, + "series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "unit": { + "type": "string", + "enum": [ + "count", + "bytes", + "bitsPerSecond", + "milliSeconds" + ], + "x-ms-enum": { + "name": "MetricsSeriesUnit", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "RankingsResponse": { + "description": "Rankings Response", + "type": "object", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "tables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ranking": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "metrics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + }, + "percentage": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "ContinentsResponse": { + "description": "Continents Response", + "type": "object", + "properties": { + "continents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + } + }, + "countryOrRegions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "continentId": { + "type": "string" + } + } + } + } + } + }, + "ResourcesResponse": { + "description": "Resources Response", + "type": "object", + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "history": { + "type": "boolean" + }, + "customDomains": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "endpointId": { + "type": "string" + }, + "history": { + "type": "boolean" + } + } + } + } + } + } + }, + "customDomains": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "endpointId": { + "type": "string" + }, + "history": { + "type": "boolean" + } + } + } + } + } + }, + "WafMetricsResponse": { + "description": "Waf Metrics Response", + "type": "object", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "granularity": { + "type": "string", + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "WafMetricsGranularity", + "modelAsString": true + } + }, + "series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "unit": { + "type": "string", + "enum": [ + "count" + ], + "x-ms-enum": { + "name": "WafMetricsSeriesUnit", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "WafRankingsResponse": { + "description": "Waf Rankings Response", + "type": "object", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupValues": { + "type": "array", + "items": { + "type": "string" + } + }, + "metrics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + }, + "percentage": { + "type": "number", + "format": "double" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "UsageName": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "A string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "A localized string describing the resource name." + } + }, + "description": "The usage names." + }, + "Usage": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource identifier." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current value of the usage." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The limit of usage." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes resource usage." + }, + "UsagesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "The list usages operation response." + }, + "ActivatedResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "isActive": { + "readOnly": true, + "type": "boolean", + "description": "Whether the resource is active or inactive" + } + }, + "description": "Reference to another resource along with its state.", + "type": "object", + "x-ms-azure-resource": true + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2023-07-01-preview." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "profileNameParameter": { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group." + }, + "keyGroupNameParameter": { + "name": "keyGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method", + "description": "Name of the KeyGroup under the profile." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/cdn.json new file mode 100644 index 000000000000..b2ba7c002827 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/cdn.json @@ -0,0 +1,7352 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.", + "operationId": "Profiles_List", + "x-ms-examples": { + "Profiles_List": { + "$ref": "./examples/Profiles_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.", + "operationId": "Profiles_ListByResourceGroup", + "x-ms-examples": { + "Profiles_ListByResourceGroup": { + "$ref": "./examples/Profiles_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Get", + "x-ms-examples": { + "Profiles_Get": { + "$ref": "./examples/Profiles_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Profiles" + ], + "description": "Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.", + "operationId": "Profiles_Create", + "x-ms-examples": { + "Profiles_Create": { + "$ref": "./examples/Profiles_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "description": "Profile properties needed to create a new profile.", + "in": "body", + "name": "profile", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new profile has been created.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Profiles" + ], + "description": "Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Update", + "x-ms-examples": { + "Profiles_Update": { + "$ref": "./examples/Profiles_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "profileUpdateParameters", + "in": "body", + "description": "Profile properties needed to update an existing profile.", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Profiles" + ], + "description": "Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.", + "operationId": "Profiles_Delete", + "x-ms-examples": { + "Profiles_Delete": { + "$ref": "./examples/Profiles_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the profile was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/canMigrate": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_CanMigrate", + "x-ms-examples": { + "Profiles_CanMigrate": { + "$ref": "./examples/Profiles_CanMigrate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Properties needed to check if cdn profile or classic frontdoor can be migrated.", + "in": "body", + "name": "canMigrateParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CanMigrateParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CanMigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/migrate": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.", + "operationId": "Profiles_Migrate", + "x-ms-examples": { + "Profiles_Migrate": { + "$ref": "./examples/Profiles_Migrate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Properties needed to migrate the profile.", + "in": "body", + "name": "migrationParameters", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationCommit": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Commit the migrated Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_MigrationCommit", + "x-ms-examples": { + "Profiles_MigrationCommit": { + "$ref": "./examples/Profiles_MigrationCommit.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", + "operationId": "Profiles_GenerateSsoUri", + "x-ms-examples": { + "Profiles_GenerateSsoUri": { + "$ref": "./examples/Profiles_GenerateSsoUri.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SsoUri" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.", + "operationId": "Profiles_ListSupportedOptimizationTypes", + "x-ms-examples": { + "Profiles_ListSupportedOptimizationTypes": { + "$ref": "./examples/Profiles_ListSupportedOptimizationTypes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportedOptimizationTypesListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile.", + "operationId": "Profiles_ListResourceUsage", + "x-ms-examples": { + "Profiles_ListResourceUsage": { + "$ref": "./examples/Profiles_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Lists existing CDN endpoints.", + "operationId": "Endpoints_ListByProfile", + "x-ms-examples": { + "Endpoints_ListByProfile": { + "$ref": "./examples/Endpoints_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EndpointListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Get", + "x-ms-examples": { + "Endpoints_Get": { + "$ref": "./examples/Endpoints_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "description": "Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Create", + "x-ms-examples": { + "Endpoints_Create": { + "$ref": "./examples/Endpoints_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpoint", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Endpoints" + ], + "description": "Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.", + "operationId": "Endpoints_Update", + "x-ms-examples": { + "Endpoints_Update": { + "$ref": "./examples/Endpoints_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpointUpdateProperties", + "in": "body", + "description": "Endpoint update properties", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Endpoints" + ], + "description": "Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Delete", + "x-ms-examples": { + "Endpoints_Delete": { + "$ref": "./examples/Endpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the endpoint was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Starts an existing CDN endpoint that is on a stopped state.", + "operationId": "Endpoints_Start", + "x-ms-examples": { + "Endpoints_Start": { + "$ref": "./examples/Endpoints_Start.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Stops an existing running CDN endpoint.", + "operationId": "Endpoints_Stop", + "x-ms-examples": { + "Endpoints_Stop": { + "$ref": "./examples/Endpoints_Stop.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Removes a content from CDN.", + "operationId": "Endpoints_PurgeContent", + "x-ms-examples": { + "Endpoints_PurgeContent": { + "$ref": "./examples/Endpoints_PurgeContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/PurgeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Pre-loads a content to CDN. Available for Verizon Profiles.", + "operationId": "Endpoints_LoadContent", + "x-ms-examples": { + "Endpoints_LoadContent": { + "$ref": "./examples/Endpoints_LoadContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ", + "required": true, + "schema": { + "$ref": "#/definitions/LoadParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.", + "operationId": "Endpoints_ValidateCustomDomain", + "x-ms-examples": { + "Endpoints_ValidateCustomDomain": { + "$ref": "./examples/Endpoints_ValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateCustomDomainInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Checks the quota and usage of geo filters and custom domains under the given endpoint.", + "operationId": "Endpoints_ListResourceUsage", + "x-ms-examples": { + "Endpoints_ListResourceUsage": { + "$ref": "./examples/Endpoints_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins": { + "get": { + "tags": [ + "Origins" + ], + "description": "Lists all of the existing origins within an endpoint.", + "operationId": "Origins_ListByEndpoint", + "x-ms-examples": { + "Origins_ListByEndpoint": { + "$ref": "./examples/Origins_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}": { + "get": { + "tags": [ + "Origins" + ], + "description": "Gets an existing origin within an endpoint.", + "operationId": "Origins_Get", + "x-ms-examples": { + "Origins_Get": { + "$ref": "./examples/Origins_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Origins" + ], + "description": "Creates a new origin within the specified endpoint.", + "operationId": "Origins_Create", + "x-ms-examples": { + "Origins_Create": { + "$ref": "./examples/Origins_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin that is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "origin", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin has been created.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Origins" + ], + "description": "Updates an existing origin within an endpoint.", + "operationId": "Origins_Update", + "x-ms-examples": { + "Origins_Update": { + "$ref": "./examples/Origins_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originUpdateProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Origins" + ], + "description": "Deletes an existing origin within an endpoint.", + "operationId": "Origins_Delete", + "x-ms-examples": { + "Origins_Delete": { + "$ref": "./examples/Origins_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Lists all of the existing origin groups within an endpoint.", + "operationId": "OriginGroups_ListByEndpoint", + "x-ms-examples": { + "OriginsGroups_ListByEndpoint": { + "$ref": "./examples/OriginGroups_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroupListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Gets an existing origin group within an endpoint.", + "operationId": "OriginGroups_Get", + "x-ms-examples": { + "OriginGroups_Get": { + "$ref": "./examples/OriginGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OriginGroups" + ], + "description": "Creates a new origin group within the specified endpoint.", + "operationId": "OriginGroups_Create", + "x-ms-examples": { + "OriginGroups_Create": { + "$ref": "./examples/OriginGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroup", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin group has been created.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "OriginGroups" + ], + "description": "Updates an existing origin group within an endpoint.", + "operationId": "OriginGroups_Update", + "x-ms-examples": { + "OriginGroups_Update": { + "$ref": "./examples/OriginGroups_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroupUpdateProperties", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroupUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "OriginGroups" + ], + "description": "Deletes an existing origin group within an endpoint.", + "operationId": "OriginGroups_Delete", + "x-ms-examples": { + "OriginGroups_Delete": { + "$ref": "./examples/OriginGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Lists all of the existing custom domains within an endpoint.", + "operationId": "CustomDomains_ListByEndpoint", + "x-ms-examples": { + "CustomDomains_ListByEndpoint": { + "$ref": "./examples/CustomDomains_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomainListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Gets an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Get", + "x-ms-examples": { + "CustomDomains_Get": { + "$ref": "./examples/CustomDomains_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CustomDomains" + ], + "description": "Creates a new custom domain within an endpoint.", + "operationId": "CustomDomains_Create", + "x-ms-examples": { + "CustomDomains_Create": { + "$ref": "./examples/CustomDomains_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Properties required to create a new custom domain.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new custom domain has been created.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CustomDomains" + ], + "description": "Deletes an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Delete", + "x-ms-examples": { + "CustomDomains_Delete": { + "$ref": "./examples/CustomDomains_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "204": { + "description": "No Content. The request has been accepted but the custom domain was not found" + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Disable https delivery of the custom domain.", + "operationId": "CustomDomains_DisableCustomHttps", + "x-ms-examples": { + "CustomDomains_DisableCustomHttps": { + "$ref": "./examples/CustomDomains_DisableCustomHttps.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Enable https delivery of the custom domain.", + "operationId": "CustomDomains_EnableCustomHttps", + "x-ms-examples": { + "CustomDomains_EnableCustomHttpsUsingYourOwnCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingBYOC.json" + }, + "CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainHttpsParameters", + "in": "body", + "description": "The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default.", + "required": false, + "schema": { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailability", + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailabilityWithSubscription" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailabilityWithSubscription", + "x-ms-examples": { + "CheckNameAvailabilityWithSubscription": { + "$ref": "./examples/CheckNameAvailabilityWithSubscription.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe": { + "post": { + "tags": [ + "ValidateProbe" + ], + "description": "Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.", + "operationId": "ValidateProbe", + "x-ms-examples": { + "ValidateProbe": { + "$ref": "./examples/ValidateProbe.json" + } + }, + "parameters": [ + { + "name": "validateProbeInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateProbeInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateProbeOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage": { + "post": { + "tags": [ + "CheckResourceUsage" + ], + "description": "Check the quota and actual usage of the CDN profiles under the given subscription.", + "operationId": "ResourceUsage_List", + "x-ms-examples": { + "ResourceUsage_List": { + "$ref": "./examples/ResourceUsage_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available CDN REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/edgenodes": { + "get": { + "tags": [ + "Edgenodes" + ], + "description": "Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.", + "operationId": "EdgeNodes_List", + "x-ms-examples": { + "EdgeNodes_List": { + "$ref": "./examples/EdgeNodes_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EdgenodeResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/cdnCanMigrateToAfd": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.", + "operationId": "CdnProfiles_CdnCanMigrateToAfd", + "x-ms-examples": { + "Profiles_CdnCanMigrate": { + "$ref": "./examples/CdnProfiles_CanMigrate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CanMigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/cdnMigrateToAfd": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. This step prepares the profile for migration and will be followed by Commit to finalize the migration.", + "operationId": "CdnProfiles_CdnMigrateToAfd", + "x-ms-examples": { + "Profiles_CdnMigrate": { + "$ref": "./examples/CdnProfiles_Migrate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "description": "Properties needed to migrate the profile.", + "in": "body", + "name": "migrationParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CdnMigrationToAfdParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationAbort": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Abort the migration to Azure Frontdoor Premium/Standard.", + "operationId": "Profiles_MigrationAbort", + "x-ms-examples": { + "Profiles_CdnMigrationCommit": { + "$ref": "./examples/Profiles_MigrationAbort.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MigrationResultEmpty" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "Profile": { + "description": "A profile is a logical grouping of endpoints that share the same settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "description": "The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile.", + "$ref": "#/definitions/Sku" + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile." + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities).", + "type": "object", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfileProperties" + } + }, + "required": [ + "sku" + ] + }, + "ProfileProperties": { + "description": "The JSON object that contains the properties required to create a profile.", + "properties": { + "resourceState": { + "description": "Resource status of the profile.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting", + "Disabled", + "Migrating", + "Migrated", + "PendingMigrationCommit", + "CommittingMigration", + "AbortingMigration" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfileResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the profile.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "ProfileProvisioningState", + "modelAsString": true + } + }, + "extendedProperties": { + "description": "Key-Value pair representing additional properties for profiles.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "frontDoorId": { + "readOnly": true, + "type": "string", + "description": "The Id of the frontdoor." + }, + "originResponseTimeoutSeconds": { + "description": "Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.", + "type": "integer", + "format": "int32", + "minimum": 16, + "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileLogScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the log scrubbing config. Default value is Enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ProfileScrubbingState", + "modelAsString": true + } + }, + "scrubbingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ProfileScrubbingRules" + }, + "x-ms-identifiers": [], + "description": "List of log scrubbing rules applied to the Azure Front Door profile logs." + } + } + }, + "ProfileListResult": { + "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Profile" + }, + "description": "List of CDN profiles within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of profile objects if there are any." + } + } + }, + "ProfileUpdateParameters": { + "type": "object", + "description": "Properties required to update a profile.", + "properties": { + "tags": { + "description": "Profile tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities).", + "type": "object", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfilePropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "ProfilePropertiesUpdateParameters": { + "type": "object", + "description": "The JSON object containing profile update parameters.", + "properties": { + "originResponseTimeoutSeconds": { + "description": "Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.", + "type": "integer", + "format": "int32", + "minimum": 16, + "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules to scrub sensitive fields in logs", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileScrubbingRules": { + "description": "Defines the contents of the log scrubbing rules.", + "type": "object", + "required": [ + "matchVariable", + "selectorMatchOperator" + ], + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestIPAddress", + "RequestUri", + "QueryStringArgNames" + ], + "description": "The variable to be scrubbed from the logs.", + "x-ms-enum": { + "name": "scrubbingRuleEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.", + "x-ms-enum": { + "name": " scrubbingRuleEntryMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to." + }, + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Defines the state of a log scrubbing rule. Default value is enabled.", + "x-ms-enum": { + "name": " scrubbingRuleEntryState", + "modelAsString": true + } + } + } + }, + "CanMigrateResult": { + "type": "object", + "description": "Result for canMigrate operation.", + "properties": { + "id": { + "description": "Resource ID.", + "format": "arm-id", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CanMigrateProperties" + } + }, + "x-ms-azure-resource": true + }, + "CanMigrateProperties": { + "type": "object", + "properties": { + "canMigrate": { + "readOnly": true, + "description": "Flag that says if the profile can be migrated", + "type": "boolean" + }, + "defaultSku": { + "readOnly": true, + "description": "Recommended sku for the migration", + "type": "string", + "enum": [ + "Standard_AzureFrontDoor", + "Premium_AzureFrontDoor" + ], + "x-ms-enum": { + "name": "CanMigrateDefaultSku", + "modelAsString": true + } + }, + "errors": { + "items": { + "description": "List of migration errors", + "$ref": "#/definitions/MigrationErrorType" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "MigrationErrorType": { + "description": "Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Resource which has the problem.", + "readOnly": true, + "type": "string" + }, + "errorMessage": { + "description": "Error message indicating why the operation failed.", + "readOnly": true, + "type": "string" + }, + "nextSteps": { + "description": "Describes what needs to be done to fix the problem", + "readOnly": true, + "type": "string" + } + } + }, + "CanMigrateParameters": { + "type": "object", + "description": "Request body for CanMigrate operation.", + "required": [ + "classicResourceReference" + ], + "properties": { + "classicResourceReference": { + "description": "Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.", + "$ref": "#/definitions/ResourceReference" + } + }, + "x-ms-azure-resource": true + }, + "MigrationParameters": { + "type": "object", + "description": "Request body for Migrate operation.", + "required": [ + "classicResourceReference", + "sku", + "profileName" + ], + "properties": { + "sku": { + "description": "Sku for the migration", + "$ref": "#/definitions/Sku" + }, + "classicResourceReference": { + "description": "Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.", + "$ref": "#/definitions/ResourceReference" + }, + "profileName": { + "description": "Name of the new profile that need to be created.", + "type": "string" + }, + "migrationWebApplicationFirewallMappings": { + "description": "Waf mapping for the migrated profile", + "type": "array", + "items": { + "description": "List of waf mappings", + "$ref": "#/definitions/MigrationWebApplicationFirewallMapping" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-azure-resource": true + }, + "MigrationWebApplicationFirewallMapping": { + "description": "Web Application Firewall Mapping ", + "type": "object", + "properties": { + "migratedFrom": { + "description": "Migration From Waf policy", + "$ref": "#/definitions/ResourceReference" + }, + "migratedTo": { + "description": "Migration to Waf policy", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "MigrateResult": { + "type": "object", + "description": "Result for migrate operation.", + "properties": { + "id": { + "description": "Resource ID.", + "format": "arm-id", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MigrateResultProperties" + } + }, + "x-ms-azure-resource": true + }, + "MigrateResultProperties": { + "type": "object", + "properties": { + "migratedProfileResourceId": { + "readOnly": true, + "description": "Arm resource id of the migrated profile", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "SsoUri": { + "description": "The URI required to login to the supplemental portal from the Azure portal.", + "type": "object", + "properties": { + "ssoUriValue": { + "description": "The URI used to login to the supplemental portal.", + "readOnly": true, + "type": "string" + } + } + }, + "SupportedOptimizationTypesListResult": { + "description": "The result of the GetSupportedOptimizationTypes API", + "type": "object", + "properties": { + "supportedOptimizationTypes": { + "description": "Supported optimization types for a profile.", + "readOnly": true, + "items": { + "$ref": "#/definitions/OptimizationType" + }, + "type": "array" + } + } + }, + "Endpoint": { + "description": "CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointProperties" + } + } + }, + "EndpointProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + ], + "properties": { + "hostName": { + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", + "type": "string", + "readOnly": true + }, + "origins": { + "description": "The source of the content being delivered via CDN.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOrigin" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "originGroups": { + "description": "The origin groups comprising of origins that are used for load balancing the traffic based on availability.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOriginGroup" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "customDomains": { + "description": "The custom domains under the endpoint.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DeepCreatedCustomDomain" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resourceState": { + "description": "Resource status of the endpoint.", + "readOnly": true, + "enum": [ + "Creating", + "Deleting", + "Running", + "Starting", + "Stopped", + "Stopping" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the endpoint.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "EndpointProvisioningState", + "modelAsString": true + } + } + } + }, + "EndpointListResult": { + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Endpoint" + }, + "description": "List of CDN endpoints within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of endpoint objects if there is any." + } + } + }, + "EndpointUpdateParameters": { + "type": "object", + "description": "Properties required to create or update an endpoint.", + "properties": { + "tags": { + "description": "Endpoint tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "EndpointPropertiesUpdateParameters": { + "description": "The JSON object containing endpoint update parameters.", + "properties": { + "originPath": { + "description": "A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", + "type": "string" + }, + "contentTypesToCompress": { + "description": "List of content types on which compression applies. The value should be a valid MIME type.", + "type": "array", + "items": { + "type": "string" + } + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "boolean" + }, + "isHttpAllowed": { + "description": "Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean", + "default": true + }, + "isHttpsAllowed": { + "description": "Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean", + "default": true + }, + "queryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "$ref": "#/definitions/QueryStringCachingBehavior", + "default": "NotSet" + }, + "optimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.", + "$ref": "#/definitions/OptimizationType" + }, + "probePath": { + "description": "Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.", + "type": "string" + }, + "geoFilters": { + "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/", + "type": "array", + "items": { + "$ref": "#/definitions/GeoFilter" + }, + "x-ms-identifiers": [] + }, + "defaultOriginGroup": { + "description": "A reference to the origin group.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + }, + "urlSigningKeys": { + "description": "List of keys used to validate the signed URL hashes.", + "type": "array", + "items": { + "$ref": "#/definitions/UrlSigningKey" + }, + "x-ms-identifiers": [ + "keyId" + ] + }, + "deliveryPolicy": { + "description": "A policy that specifies the delivery rules to be used for an endpoint.", + "type": "object", + "required": [ + "rules" + ], + "properties": { + "description": { + "description": "User-friendly description of the policy.", + "type": "string" + }, + "rules": { + "description": "A list of the delivery rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "webApplicationFirewallPolicyLink": { + "description": "Defines the Web Application Firewall policy for the endpoint (if applicable)", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + } + } + }, + "DeliveryRule": { + "description": "A rule that specifies a set of actions and conditions", + "type": "object", + "required": [ + "order", + "actions" + ], + "properties": { + "name": { + "description": "Name of the rule", + "type": "string" + }, + "order": { + "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.", + "type": "integer", + "format": "int32" + }, + "conditions": { + "description": "A list of conditions that must be matched for the actions to be executed", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleCondition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "actions": { + "description": "A list of actions that are executed when all the conditions of a rule are satisfied.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleAction" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DeliveryRuleCondition": { + "description": "A condition for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the condition for the delivery rule.", + "type": "string", + "enum": [ + "RemoteAddress", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeader", + "RequestBody", + "RequestScheme", + "UrlPath", + "UrlFileExtension", + "UrlFileName", + "HttpVersion", + "Cookies", + "IsDevice", + "SocketAddr", + "ClientPort", + "ServerPort", + "HostName", + "SslProtocol" + ], + "x-ms-enum": { + "name": "MatchVariable", + "modelAsString": true + } + } + } + }, + "DeliveryRuleRemoteAddressCondition": { + "description": "Defines the RemoteAddress condition for the delivery rule.", + "x-ms-discriminator-value": "RemoteAddress", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RemoteAddressMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestMethodCondition": { + "description": "Defines the RequestMethod condition for the delivery rule.", + "x-ms-discriminator-value": "RequestMethod", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestMethodMatchConditionParameters" + } + } + }, + "DeliveryRuleQueryStringCondition": { + "description": "Defines the QueryString condition for the delivery rule.", + "x-ms-discriminator-value": "QueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/QueryStringMatchConditionParameters" + } + } + }, + "DeliveryRulePostArgsCondition": { + "description": "Defines the PostArgs condition for the delivery rule.", + "x-ms-discriminator-value": "PostArgs", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/PostArgsMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestUriCondition": { + "description": "Defines the RequestUri condition for the delivery rule.", + "x-ms-discriminator-value": "RequestUri", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestUriMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestHeaderCondition": { + "description": "Defines the RequestHeader condition for the delivery rule.", + "x-ms-discriminator-value": "RequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestHeaderMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestBodyCondition": { + "description": "Defines the RequestBody condition for the delivery rule.", + "x-ms-discriminator-value": "RequestBody", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestBodyMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestSchemeCondition": { + "description": "Defines the RequestScheme condition for the delivery rule.", + "x-ms-discriminator-value": "RequestScheme", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestSchemeMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlPathCondition": { + "description": "Defines the UrlPath condition for the delivery rule.", + "x-ms-discriminator-value": "UrlPath", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlPathMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileExtensionCondition": { + "description": "Defines the UrlFileExtension condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileExtension", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileExtensionMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileNameCondition": { + "description": "Defines the UrlFileName condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileName", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileNameMatchConditionParameters" + } + } + }, + "DeliveryRuleHttpVersionCondition": { + "description": "Defines the HttpVersion condition for the delivery rule.", + "x-ms-discriminator-value": "HttpVersion", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/HttpVersionMatchConditionParameters" + } + } + }, + "DeliveryRuleCookiesCondition": { + "description": "Defines the Cookies condition for the delivery rule.", + "x-ms-discriminator-value": "Cookies", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/CookiesMatchConditionParameters" + } + } + }, + "DeliveryRuleIsDeviceCondition": { + "description": "Defines the IsDevice condition for the delivery rule.", + "x-ms-discriminator-value": "IsDevice", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/IsDeviceMatchConditionParameters" + } + } + }, + "DeliveryRuleSocketAddrCondition": { + "description": "Defines the SocketAddress condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "SocketAddr", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/SocketAddrMatchConditionParameters" + } + } + }, + "DeliveryRuleClientPortCondition": { + "description": "Defines the ClientPort condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "ClientPort", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/ClientPortMatchConditionParameters" + } + } + }, + "DeliveryRuleServerPortCondition": { + "description": "Defines the ServerPort condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "ServerPort", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/ServerPortMatchConditionParameters" + } + } + }, + "DeliveryRuleHostNameCondition": { + "description": "Defines the HostName condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "HostName", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/HostNameMatchConditionParameters" + } + } + }, + "DeliveryRuleSslProtocolCondition": { + "description": "Defines the SslProtocol condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "SslProtocol", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/SslProtocolMatchConditionParameters" + } + } + }, + "RemoteAddressMatchConditionParameters": { + "description": "Defines the parameters for RemoteAddress match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRemoteAddressConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch" + ], + "x-ms-enum": { + "name": "RemoteAddressOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestMethodMatchConditionParameters": { + "description": "Defines the parameters for RequestMethod match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRequestMethodConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "RequestMethodOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "GET", + "HEAD", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "TRACE" + ] + } + } + } + }, + "QueryStringMatchConditionParameters": { + "description": "Defines the parameters for QueryString match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleQueryStringConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "QueryStringOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "PostArgsMatchConditionParameters": { + "description": "Defines the parameters for PostArgs match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRulePostArgsConditionParameters" + ] + }, + "selector": { + "description": "Name of PostArg to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "PostArgsOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestUriMatchConditionParameters": { + "description": "Defines the parameters for RequestUri match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRequestUriConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestUriOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestHeaderMatchConditionParameters": { + "description": "Defines the parameters for RequestHeader match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRequestHeaderConditionParameters" + ] + }, + "selector": { + "description": "Name of Header to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestHeaderOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestBodyMatchConditionParameters": { + "description": "Defines the parameters for RequestBody match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRequestBodyConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestBodyOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestSchemeMatchConditionParameters": { + "description": "Defines the parameters for RequestScheme match conditions ", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRequestSchemeConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ] + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "HTTP", + "HTTPS" + ] + } + } + } + }, + "UrlPathMatchConditionParameters": { + "description": "Defines the parameters for UrlPath match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleUrlPathMatchConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "Wildcard", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlPathOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileExtensionMatchConditionParameters": { + "description": "Defines the parameters for UrlFileExtension match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleUrlFileExtensionMatchConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlFileExtensionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileNameMatchConditionParameters": { + "description": "Defines the parameters for UrlFilename match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleUrlFilenameConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlFileNameOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "HttpVersionMatchConditionParameters": { + "description": "Defines the parameters for HttpVersion match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleHttpVersionConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "HttpVersionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "CookiesMatchConditionParameters": { + "description": "Defines the parameters for Cookies match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleCookiesConditionParameters" + ] + }, + "selector": { + "description": "Name of Cookies to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "CookiesOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "IsDeviceMatchConditionParameters": { + "description": "Defines the parameters for IsDevice match conditions", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleIsDeviceConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "IsDeviceOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Mobile", + "Desktop" + ] + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "SocketAddrMatchConditionParameters": { + "description": "Defines the parameters for SocketAddress match conditions", + "type": "object", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleSocketAddrConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch" + ], + "x-ms-enum": { + "name": "SocketAddrOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "ClientPortMatchConditionParameters": { + "description": "Defines the parameters for ClientPort match conditions", + "type": "object", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleClientPortConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "ClientPortOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "ServerPortMatchConditionParameters": { + "description": "Defines the parameters for ServerPort match conditions", + "type": "object", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleServerPortConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "ServerPortOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "HostNameMatchConditionParameters": { + "description": "Defines the parameters for HostName match conditions", + "type": "object", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleHostNameConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "HostNameOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "SslProtocolMatchConditionParameters": { + "description": "Defines the parameters for SslProtocol match conditions", + "type": "object", + "required": [ + "operator", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleSslProtocolConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "SslProtocolOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "$ref": "#/definitions/SslProtocol" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "DeliveryRuleAction": { + "description": "An action for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the action for the delivery rule.", + "type": "string", + "enum": [ + "CacheExpiration", + "CacheKeyQueryString", + "ModifyRequestHeader", + "ModifyResponseHeader", + "UrlRedirect", + "UrlRewrite", + "UrlSigning", + "OriginGroupOverride", + "RouteConfigurationOverride", + "AfdUrlSigning" + ], + "x-ms-enum": { + "name": "DeliveryRuleAction", + "modelAsString": true + } + } + } + }, + "UrlRedirectAction": { + "description": "Defines the url redirect action for the delivery rule.", + "x-ms-discriminator-value": "UrlRedirect", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRedirectActionParameters" + } + } + }, + "UrlRedirectActionParameters": { + "description": "Defines the parameters for the url redirect action.", + "required": [ + "redirectType", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleUrlRedirectActionParameters" + ] + }, + "redirectType": { + "description": "The redirect type the rule will use when redirecting traffic.", + "type": "string", + "enum": [ + "Moved", + "Found", + "TemporaryRedirect", + "PermanentRedirect" + ], + "x-ms-enum": { + "name": "RedirectType", + "modelAsString": true + } + }, + "destinationProtocol": { + "description": "Protocol to use for the redirect. The default value is MatchRequest", + "type": "string", + "enum": [ + "MatchRequest", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "DestinationProtocol", + "modelAsString": true + } + }, + "customPath": { + "description": "The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.", + "type": "string" + }, + "customHostname": { + "description": "Host to redirect. Leave empty to use the incoming host as the destination host.", + "type": "string" + }, + "customQueryString": { + "description": "The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. ? and & will be added automatically so do not include them.", + "type": "string" + }, + "customFragment": { + "type": "string", + "description": "Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #." + } + } + }, + "UrlSigningAction": { + "description": "Defines the url signing action for the delivery rule.", + "x-ms-discriminator-value": "UrlSigning", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlSigningActionParameters" + } + } + }, + "UrlSigningActionParameters": { + "description": "Defines the parameters for the Url Signing action.", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleUrlSigningActionParameters" + ] + }, + "algorithm": { + "description": "Algorithm to use for URL signing", + "type": "string", + "enum": [ + "SHA256" + ], + "x-ms-enum": { + "name": "algorithm", + "modelAsString": true + } + }, + "parameterNameOverride": { + "description": "Defines which query string parameters in the url to be considered for expires, key id etc. ", + "type": "array", + "items": { + "$ref": "#/definitions/UrlSigningParamIdentifier" + }, + "x-ms-identifiers": [ + "paramName" + ] + } + } + }, + "UrlSigningParamIdentifier": { + "description": "Defines how to identify a parameter for a specific purpose e.g. expires", + "required": [ + "paramIndicator", + "paramName" + ], + "properties": { + "paramIndicator": { + "description": "Indicates the purpose of the parameter", + "type": "string", + "enum": [ + "Expires", + "KeyId", + "Signature" + ], + "x-ms-enum": { + "name": "paramIndicator", + "modelAsString": true + } + }, + "paramName": { + "description": "Parameter name", + "type": "string" + } + } + }, + "OriginGroupOverrideAction": { + "description": "Defines the origin group override action for the delivery rule.", + "x-ms-discriminator-value": "OriginGroupOverride", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/OriginGroupOverrideActionParameters" + } + } + }, + "OriginGroupOverrideActionParameters": { + "description": "Defines the parameters for the origin group override action.", + "required": [ + "originGroup", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleOriginGroupOverrideActionParameters" + ] + }, + "originGroup": { + "description": "defines the OriginGroup that would override the DefaultOriginGroup.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "UrlRewriteAction": { + "description": "Defines the url rewrite action for the delivery rule.", + "x-ms-discriminator-value": "UrlRewrite", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRewriteActionParameters" + } + } + }, + "UrlRewriteActionParameters": { + "description": "Defines the parameters for the url rewrite action.", + "required": [ + "sourcePattern", + "destination", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleUrlRewriteActionParameters" + ] + }, + "sourcePattern": { + "description": "define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.", + "type": "string" + }, + "destination": { + "description": "Define the relative URL to which the above requests will be rewritten by.", + "type": "string" + }, + "preserveUnmatchedPath": { + "description": "Whether to preserve unmatched path. Default value is true.", + "type": "boolean" + } + } + }, + "DeliveryRuleRequestHeaderAction": { + "description": "Defines the request header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyRequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "DeliveryRuleResponseHeaderAction": { + "description": "Defines the response header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyResponseHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "HeaderActionParameters": { + "description": "Defines the parameters for the request header action.", + "required": [ + "headerAction", + "headerName", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleHeaderActionParameters" + ] + }, + "headerAction": { + "description": "Action to perform", + "type": "string", + "enum": [ + "Append", + "Overwrite", + "Delete" + ], + "x-ms-enum": { + "name": "HeaderAction", + "modelAsString": true + } + }, + "headerName": { + "description": "Name of the header to modify", + "type": "string" + }, + "value": { + "description": "Value for the specified action", + "type": "string" + } + } + }, + "DeliveryRuleCacheExpirationAction": { + "description": "Defines the cache expiration action for the delivery rule.", + "x-ms-discriminator-value": "CacheExpiration", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheExpirationActionParameters" + } + } + }, + "CacheExpirationActionParameters": { + "description": "Defines the parameters for the cache expiration action.", + "required": [ + "cacheBehavior", + "cacheType", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleCacheExpirationActionParameters" + ] + }, + "cacheBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "BypassCache", + "Override", + "SetIfMissing" + ], + "x-ms-enum": { + "name": "cacheBehavior", + "modelAsString": true + } + }, + "cacheType": { + "description": "The level at which the content needs to be cached.", + "type": "string", + "enum": [ + "All" + ], + "x-ms-enum": { + "name": "CacheType", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "type": "string", + "x-nullable": true + } + } + }, + "DeliveryRuleCacheKeyQueryStringAction": { + "description": "Defines the cache-key query string action for the delivery rule.", + "x-ms-discriminator-value": "CacheKeyQueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheKeyQueryStringActionParameters" + } + } + }, + "CacheKeyQueryStringActionParameters": { + "description": "Defines the parameters for the cache-key query string action.", + "required": [ + "queryStringBehavior", + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleCacheKeyQueryStringBehaviorActionParameters" + ] + }, + "queryStringBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "Include", + "IncludeAll", + "Exclude", + "ExcludeAll" + ], + "x-ms-enum": { + "name": "queryStringBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string", + "x-nullable": true + } + } + }, + "DeliveryRuleRouteConfigurationOverrideAction": { + "description": "Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles.", + "type": "object", + "x-ms-discriminator-value": "RouteConfigurationOverride", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/RouteConfigurationOverrideActionParameters" + } + } + }, + "RouteConfigurationOverrideActionParameters": { + "description": "Defines the parameters for the route configuration override action.", + "type": "object", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRouteConfigurationOverrideActionParameters" + ] + }, + "originGroupOverride": { + "description": "A reference to the origin group override configuration. Leave empty to use the default origin group on route.", + "type": "object", + "$ref": "#/definitions/OriginGroupOverride" + }, + "cacheConfiguration": { + "description": "The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "$ref": "#/definitions/CacheConfiguration" + } + } + }, + "OriginGroupOverride": { + "description": "Defines the parameters for the origin group override configuration.", + "type": "object", + "properties": { + "originGroup": { + "description": "defines the OriginGroup that would override the DefaultOriginGroup on route.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + }, + "forwardingProtocol": { + "description": "Protocol this rule will use when forwarding traffic to backends.", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "ForwardingProtocol", + "modelAsString": true + } + } + } + }, + "CacheConfiguration": { + "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "properties": { + "queryStringCachingBehavior": { + "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.", + "enum": [ + "IgnoreQueryString", + "UseQueryString", + "IgnoreSpecifiedQueryStrings", + "IncludeSpecifiedQueryStrings" + ], + "type": "string", + "x-ms-enum": { + "name": "ruleQueryStringCachingBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string" + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ruleIsCompressionEnabled", + "modelAsString": true + } + }, + "cacheBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "HonorOrigin", + "OverrideAlways", + "OverrideIfOriginMissing" + ], + "x-ms-enum": { + "name": "ruleCacheBehavior", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "type": "string" + } + } + }, + "transform": { + "description": "Describes what transforms are applied before matching", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "transform", + "modelAsString": true + } + }, + "SslProtocol": { + "description": "The protocol of an established TLS connection.", + "type": "string", + "enum": [ + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ], + "x-ms-enum": { + "name": "SslProtocol", + "modelAsString": true + } + }, + "DeepCreatedOrigin": { + "description": "The main origin of CDN content which is added when creating a CDN endpoint.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin name which must be unique within the endpoint. ", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginProperties" + } + }, + "x-ms-azure-resource": false + }, + "DeepCreatedOriginProperties": { + "description": "Properties of the origin created on the CDN endpoint.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not. By default, origin is always enabled.", + "type": "boolean" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateLinkLocation": { + "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated", + "type": "string" + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link.", + "type": "string" + }, + "privateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "$ref": "#/definitions/PrivateEndpointStatus", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": false + }, + "DeepCreatedOriginGroup": { + "description": "The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin group name which must be unique within the endpoint.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginGroupProperties" + } + }, + "x-ms-azure-resource": false + }, + "DeepCreatedOriginGroupProperties": { + "description": "Properties of the origin group created on the CDN endpoint.", + "type": "object", + "required": [ + "origins" + ], + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + }, + "x-ms-azure-resource": false + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another resource.", + "x-ms-azure-resource": true + }, + "GeoFilter": { + "description": "Rules defining user's geo access within a CDN endpoint.", + "type": "object", + "required": [ + "relativePath", + "action", + "countryCodes" + ], + "properties": { + "relativePath": { + "description": "Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.)", + "type": "string" + }, + "action": { + "description": "Action of the geo filter, i.e. allow or block access.", + "enum": [ + "Block", + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoFilterActions", + "modelAsString": false + } + }, + "countryCodes": { + "description": "Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UrlSigningKey": { + "description": "Url signing key", + "required": [ + "keyId", + "keySourceParameters" + ], + "properties": { + "keyId": { + "description": "Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.", + "type": "string" + }, + "keySourceParameters": { + "description": "Defines the parameters for using customer key vault for Url Signing Key.", + "$ref": "#/definitions/KeyVaultSigningKeyParameters" + } + } + }, + "KeyVaultSigningKeyParameters": { + "description": "Describes the parameters for using a user's KeyVault for URL Signing Key.", + "required": [ + "typeName", + "subscriptionId", + "resourceGroupName", + "vaultName", + "secretName", + "secretVersion" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "KeyVaultSigningKeyParameters" + ] + }, + "subscriptionId": { + "description": "Subscription Id of the user's Key Vault containing the secret", + "type": "string" + }, + "resourceGroupName": { + "description": "Resource group of the user's Key Vault containing the secret", + "type": "string" + }, + "vaultName": { + "description": "The name of the user's Key Vault containing the secret", + "type": "string" + }, + "secretName": { + "description": "The name of secret in Key Vault.", + "type": "string" + }, + "secretVersion": { + "description": "The version(GUID) of secret in Key Vault.", + "type": "string" + } + } + }, + "LoadParameters": { + "type": "object", + "description": "Parameters required for content load.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be loaded. Path should be a relative file URL of the origin.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Origin": { + "description": "CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginProperties" + } + } + }, + "OriginProperties": { + "description": "The JSON object that contains the properties of the origin.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "OriginProvisioningState", + "modelAsString": true + } + }, + "privateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "$ref": "#/definitions/PrivateEndpointStatus", + "type": "string", + "readOnly": true + } + } + }, + "OriginUpdateParameters": { + "type": "object", + "description": "Origin properties needed for origin update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin.", + "properties": { + "hostName": { + "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not", + "type": "boolean" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateLinkLocation": { + "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated", + "type": "string" + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link.", + "type": "string" + } + } + }, + "OriginListResult": { + "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Origin" + }, + "description": "List of CDN origins within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "OriginGroup": { + "description": "Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupProperties" + } + } + }, + "OriginGroupProperties": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin group.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginGroupResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin group.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "OriginGroupProvisioningState", + "modelAsString": true + } + } + } + }, + "OriginGroupUpdateParameters": { + "type": "object", + "description": "Origin group properties needed for origin group creation or update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginGroupUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin group.", + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + } + }, + "HealthProbeParameters": { + "description": "The JSON object that contains the properties to send health probes to origin.", + "properties": { + "probePath": { + "description": "The path relative to the origin that is used to determine the health of the origin.", + "type": "string" + }, + "probeRequestType": { + "description": "The type of health probe request that is made.", + "enum": [ + "NotSet", + "GET", + "HEAD" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthProbeRequestType", + "modelAsString": false + } + }, + "probeProtocol": { + "description": "Protocol to use for health probe.", + "type": "string", + "enum": [ + "NotSet", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProbeProtocol", + "modelAsString": false + } + }, + "probeIntervalInSeconds": { + "description": "The number of seconds between health probes.Default is 240sec.", + "type": "integer", + "format": "int32", + "maximum": 255, + "minimum": 1 + } + } + }, + "ResponseBasedOriginErrorDetectionParameters": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.", + "properties": { + "responseBasedDetectedErrorTypes": { + "description": "Type of response errors for real user requests for which origin will be deemed unhealthy", + "type": "string", + "enum": [ + "None", + "TcpErrorsOnly", + "TcpAndHttpErrors" + ], + "x-ms-enum": { + "name": "ResponseBasedDetectedErrorTypes", + "modelAsString": false + } + }, + "responseBasedFailoverThresholdPercentage": { + "description": "The percentage of failed requests in the sample where failover should trigger.", + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0 + }, + "httpErrorRanges": { + "description": "The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpErrorRangeParameters" + }, + "x-ms-identifiers": [] + } + } + }, + "HttpErrorRangeParameters": { + "description": "The JSON object that represents the range for http status codes", + "properties": { + "begin": { + "description": "The inclusive start of the http status code range.", + "type": "integer", + "format": "int32", + "maximum": 999, + "minimum": 100 + }, + "end": { + "description": "The inclusive end of the http status code range.", + "type": "integer", + "format": "int32", + "maximum": 999, + "minimum": 100 + } + } + }, + "OriginGroupListResult": { + "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OriginGroup" + }, + "description": "List of CDN origin groups within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "DeepCreatedCustomDomain": { + "description": "Custom domains created on the CDN endpoint.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Custom domain name.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedCustomDomainProperties" + } + } + }, + "DeepCreatedCustomDomainProperties": { + "description": "Properties of the custom domain created on the CDN endpoint.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + }, + "validationData": { + "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", + "type": "string" + } + } + }, + "CustomDomain": { + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainProperties": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + }, + "resourceState": { + "description": "Resource status of the custom domain.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomDomainResourceState", + "modelAsString": true + } + }, + "customHttpsProvisioningState": { + "description": "Provisioning status of the custom domain.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + }, + "customHttpsProvisioningSubstate": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.", + "readOnly": true, + "enum": [ + "SubmittingDomainControlValidationRequest", + "PendingDomainControlValidationREquestApproval", + "DomainControlValidationRequestApproved", + "DomainControlValidationRequestRejected", + "DomainControlValidationRequestTimedOut", + "IssuingCertificate", + "DeployingCertificate", + "CertificateDeployed", + "DeletingCertificate", + "CertificateDeleted" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningSubstate", + "modelAsString": true + } + }, + "customHttpsParameters": { + "description": "Certificate parameters for securing custom HTTPS", + "$ref": "#/definitions/CustomDomainHttpsParameters" + }, + "validationData": { + "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning status of Custom Https of the custom domain.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + } + } + }, + "CustomDomainParameters": { + "description": "The customDomain JSON object required for custom domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainPropertiesParameters" + } + } + }, + "CustomDomainPropertiesParameters": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "CustomDomainHttpsParameters": { + "description": "The JSON object that contains the properties to secure a custom domain.", + "discriminator": "certificateSource", + "required": [ + "certificateSource", + "protocolType" + ], + "properties": { + "certificateSource": { + "description": "Defines the source of the SSL certificate.", + "enum": [ + "AzureKeyVault", + "Cdn" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateSource", + "modelAsString": true + } + }, + "protocolType": { + "description": "Defines the TLS extension protocol that is used for secure delivery.", + "enum": [ + "ServerNameIndication", + "IPBased" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https", + "enum": [ + "None", + "TLS10", + "TLS12" + ], + "type": "string", + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": false + } + } + } + }, + "CdnManagedHttpsParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "x-ms-discriminator-value": "Cdn", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "$ref": "#/definitions/CdnCertificateSourceParameters" + } + } + }, + "CdnCertificateSourceParameters": { + "description": "Defines the parameters for using CDN managed certificate for securing custom domain.", + "required": [ + "typeName", + "certificateType" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "CdnCertificateSourceParameters" + ] + }, + "certificateType": { + "description": "Type of certificate used", + "enum": [ + "Shared", + "Dedicated" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true + } + } + } + }, + "UserManagedHttpsParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "x-ms-discriminator-value": "AzureKeyVault", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "$ref": "#/definitions/KeyVaultCertificateSourceParameters" + } + } + }, + "KeyVaultCertificateSourceParameters": { + "description": "Describes the parameters for using a user's KeyVault certificate for securing custom domain.", + "required": [ + "typeName", + "subscriptionId", + "resourceGroupName", + "vaultName", + "secretName", + "updateRule", + "deleteRule" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "KeyVaultCertificateSourceParameters" + ] + }, + "subscriptionId": { + "description": "Subscription Id of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "resourceGroupName": { + "description": "Resource group of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "vaultName": { + "description": "The name of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "secretName": { + "description": "The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.", + "type": "string" + }, + "secretVersion": { + "description": "The version(GUID) of Key Vault Secret in Key Vault.", + "type": "string" + }, + "updateRule": { + "description": "Describes the action that shall be taken when the certificate is updated in Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "UpdateRule", + "modelAsString": true + } + }, + "deleteRule": { + "description": "Describes the action that shall be taken when the certificate is removed from Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "DeleteRule", + "modelAsString": true + } + } + } + }, + "CustomDomainListResult": { + "description": "Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "description": "List of CDN CustomDomains within an endpoint." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ValidateCustomDomainInput": { + "description": "Input of the custom domain to be validated for DNS mapping.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "ValidateCustomDomainOutput": { + "description": "Output of custom domain validation.", + "type": "object", + "properties": { + "customDomainValidated": { + "description": "Indicates whether the custom domain is valid or not.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the custom domain is not valid.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message describing why the custom domain is not valid.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "#/definitions/ResourceType" + } + } + }, + "CheckNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "ValidateProbeInput": { + "description": "Input of the validate probe API.", + "properties": { + "probeURL": { + "description": "The probe URL to validate.", + "type": "string" + } + }, + "required": [ + "probeURL" + ], + "type": "object" + }, + "ValidateProbeOutput": { + "description": "Output of the validate probe API.", + "properties": { + "isValid": { + "description": "Indicates whether the probe URL is accepted or not.", + "readOnly": true, + "type": "boolean" + }, + "errorCode": { + "description": "Specifies the error code when the probe url is not accepted.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the probe URL is not accepted.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ResourceUsageListResult": { + "description": "Output of check resource usage API.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceUsage" + }, + "x-ms-identifiers": [ + "resourceType" + ], + "description": "List of resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ResourceUsage": { + "description": "Output of check resource usage API.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type for which the usage is provided." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Unit of the usage. e.g. count.", + "enum": [ + "count" + ], + "x-ms-enum": { + "name": "ResourceUsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Actual value of usage on the specified resource type." + }, + "limit": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Quota of the specified resource type." + } + } + }, + "ResourceType": { + "description": "Type of CDN resource used in CheckNameAvailability.", + "enum": [ + "Microsoft.Cdn/Profiles/Endpoints", + "Microsoft.Cdn/Profiles/AfdEndpoints" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true + } + }, + "OperationsListResult": { + "description": "Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of CDN operations supported by the CDN resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "CDN REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "readOnly": true, + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Cdn", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "readOnly": true, + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of operation.", + "readOnly": true, + "type": "string" + } + } + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of operations." + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include log specifications.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Log specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "LogSpecification": { + "description": "Log specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of log specification." + }, + "displayName": { + "type": "string", + "description": "Display name of log specification." + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of specification." + }, + "logFilterPattern": { + "type": "string", + "description": "Pattern to filter based on name" + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'." + }, + "aggregationType": { + "type": "string", + "description": "The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'." + }, + "availabilities": { + "description": "Retention policies of a resource metric.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "x-ms-identifiers": [] + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "dimensions": { + "type": "array", + "description": "The dimensions of metric", + "items": { + "$ref": "#/definitions/DimensionProperties" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Property to specify whether to fill gap with zero." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern to filter based on name" + }, + "isInternal": { + "type": "boolean", + "description": "Property to specify metric is internal or not." + } + } + }, + "DimensionProperties": { + "description": "Type of operation: get, read, delete, etc.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "internalName": { + "type": "string", + "description": "Internal name of dimension." + } + } + }, + "MetricAvailability": { + "description": "Retention policy of a resource metric.", + "type": "object", + "properties": { + "timeGrain": { + "type": "string" + }, + "blobDuration": { + "type": "string" + } + } + }, + "EdgenodeResult": { + "description": "Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EdgeNode" + }, + "description": "Edge node of CDN service." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of edgenode list results if there are any." + } + } + }, + "EdgeNode": { + "description": "Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EdgeNodeProperties" + } + } + }, + "EdgeNodeProperties": { + "description": "The JSON object that contains the properties required to create an edgenode.", + "required": [ + "ipAddressGroups" + ], + "properties": { + "ipAddressGroups": { + "description": "List of ip address groups.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressGroup" + }, + "x-ms-identifiers": [ + "deliveryRegion" + ] + } + } + }, + "IpAddressGroup": { + "description": "CDN Ip address group", + "type": "object", + "properties": { + "deliveryRegion": { + "description": "The delivery region of the ip address group", + "type": "string" + }, + "ipv4Addresses": { + "description": "The list of ip v4 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + }, + "x-ms-identifiers": [ + "baseIpAddress" + ] + }, + "ipv6Addresses": { + "description": "The list of ip v6 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + }, + "x-ms-identifiers": [ + "baseIpAddress" + ] + } + } + }, + "cidrIpAddress": { + "description": "CIDR Ip address", + "type": "object", + "properties": { + "baseIpAddress": { + "description": "Ip address itself.", + "type": "string" + }, + "prefixLength": { + "description": "The length of the prefix of the ip address.", + "type": "integer", + "format": "int32" + } + } + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "SystemData": { + "description": "Read only system data", + "readOnly": true, + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "An identifier for the identity that created the resource" + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that created the resource" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)" + }, + "lastModifiedBy": { + "type": "string", + "description": "An identifier for the identity that last modified the resource" + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "user", + "application", + "managedIdentity", + "key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "required": [ + "location" + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "QueryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "enum": [ + "IgnoreQueryString", + "BypassCaching", + "UseQueryString", + "NotSet" + ], + "type": "string", + "x-ms-enum": { + "name": "QueryStringCachingBehavior", + "modelAsString": false + } + }, + "PrivateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "type": "string", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "PrivateEndpointStatus", + "modelAsString": true + } + }, + "Sku": { + "description": "Standard_Verizon = The SKU name for a Standard Verizon CDN profile.\nPremium_Verizon = The SKU name for a Premium Verizon CDN profile.\nCustom_Verizon = The SKU name for a Custom Verizon CDN profile.\nStandard_Akamai = The SKU name for an Akamai CDN profile.\nStandard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model.\nStandard_Microsoft = The SKU name for a Standard Microsoft CDN profile.\nStandard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile.\nPremium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile.\nStandard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model.\nStandard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model.\nStandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model.\nStandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model.\nStandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.\n", + "properties": { + "name": { + "description": "Name of the pricing tier.", + "enum": [ + "Standard_Verizon", + "Premium_Verizon", + "Custom_Verizon", + "Standard_Akamai", + "Standard_ChinaCdn", + "Standard_Microsoft", + "Standard_AzureFrontDoor", + "Premium_AzureFrontDoor", + "Standard_955BandWidth_ChinaCdn", + "Standard_AvgBandWidth_ChinaCdn", + "StandardPlus_ChinaCdn", + "StandardPlus_955BandWidth_ChinaCdn", + "StandardPlus_AvgBandWidth_ChinaCdn" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + } + }, + "type": "object" + }, + "OptimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.", + "enum": [ + "GeneralWebDelivery", + "GeneralMediaStreaming", + "VideoOnDemandMediaStreaming", + "LargeFileDownload", + "DynamicSiteAcceleration" + ], + "type": "string", + "x-ms-enum": { + "name": "OptimizationType", + "modelAsString": true + } + }, + "ErrorResponse": { + "title": "Error response", + "description": "Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + } + } + }, + "CdnMigrationToAfdParameters": { + "type": "object", + "description": "Request body for Migrate operation.", + "required": [ + "sku" + ], + "properties": { + "sku": { + "description": "Sku for the migration", + "$ref": "#/definitions/Sku" + }, + "migrationEndpointMappings": { + "description": "A name map between classic CDN endpoints and AFD Premium/Standard endpoints.", + "type": "array", + "items": { + "description": "List of endpoint mappings", + "$ref": "#/definitions/MigrationEndpointMapping" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-azure-resource": true + }, + "MigrationEndpointMapping": { + "description": "CDN Endpoint Mapping.", + "type": "object", + "properties": { + "migratedFrom": { + "description": "The name of the old endpoint.", + "type": "string" + }, + "migratedTo": { + "description": "The name for the new endpoint.", + "type": "string" + } + } + }, + "MigrationResultEmpty": { + "description": "Empty 200 response.", + "type": "object", + "properties": {} + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-05-01-preview." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "profileNameParameter": { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/cdnwebapplicationfirewall.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/cdnwebapplicationfirewall.json new file mode 100644 index 000000000000..f63ae487d275 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/cdnwebapplicationfirewall.json @@ -0,0 +1,977 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "Azure CDN WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules for Azure CDN" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "Policies_List", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "Policies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Policy": { + "$ref": "./examples/WafPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Create or update policy with specified rule set name within a resource group.", + "operationId": "Policies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "cdnWebApplicationFirewallPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group", + "operationId": "Policies_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "CdnWebApplicationFirewallPolicy parameters to be patched.", + "in": "body", + "name": "cdnWebApplicationFirewallPolicyPatchParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPatchPolicy.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy", + "operationId": "Policies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "No Content. The request has been accepted but the policy was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete protection policy": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/cdnWebApplicationFirewallManagedRuleSets": { + "get": { + "tags": [ + "WebApplicationFirewallManagedRuleSets" + ], + "description": "Lists all available managed rule sets.", + "operationId": "ManagedRuleSets_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall managed rule sets.", + "schema": { + "$ref": "#/definitions/ManagedRuleSetDefinitionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListManagedRuleSets.json" + } + } + } + } + }, + "definitions": { + "CdnWebApplicationFirewallPolicyList": { + "description": "Defines a list of WebApplicationFirewallPolicies for Azure CDN. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + }, + "description": "List of Azure CDN WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "CdnWebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy for Azure CDN.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the web application firewall policy.", + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyProperties" + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + }, + "sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.", + "$ref": "./cdn.json#/definitions/Sku" + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "./cdn.json#/definitions/TrackedResource" + } + ] + }, + "CdnWebApplicationFirewallPolicyPatchParameters": { + "type": "object", + "description": "Properties required to update a CdnWebApplicationFirewallPolicy.", + "properties": { + "tags": { + "description": "CdnWebApplicationFirewallPolicy tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CdnWebApplicationFirewallPolicyProperties": { + "description": "Defines CDN web application firewall policy properties.", + "properties": { + "policySettings": { + "description": "Describes policySettings for policy", + "$ref": "#/definitions/policySettings" + }, + "rateLimitRules": { + "description": "Describes rate limit rules inside the policy.", + "$ref": "#/definitions/RateLimitRuleList" + }, + "customRules": { + "description": "Describes custom rules inside the policy.", + "$ref": "#/definitions/CustomRuleList" + }, + "managedRules": { + "description": "Describes managed rules inside the policy.", + "$ref": "#/definitions/ManagedRuleSetList" + }, + "endpointLinks": { + "description": "Describes Azure CDN endpoints associated with this Web Application Firewall policy.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CdnEndpoint" + } + }, + "extendedProperties": { + "description": "Key-Value pair representing additional properties for Web Application Firewall policy.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the WebApplicationFirewallPolicy.", + "enum": [ + "Creating", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyResourceState", + "modelAsString": true + } + } + } + }, + "policySettings": { + "description": "Defines contents of a web application firewall global configuration", + "properties": { + "enabledState": { + "description": "describes if the policy is in enabled state or disabled state", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "PolicyEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "Describes if it is in detection mode or prevention mode at policy level.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "PolicyMode", + "modelAsString": true + } + }, + "defaultRedirectUrl": { + "description": "If action type is redirect, this field represents the default redirect URL for the client.", + "type": "string" + }, + "defaultCustomBlockResponseStatusCode": { + "description": "If the action type is block, this field defines the default customer overridable http response status code.", + "type": "integer", + "format": "int32", + "enum": [ + 200, + 403, + 405, + 406, + 429 + ] + }, + "defaultCustomBlockResponseBody": { + "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + } + } + }, + "CdnEndpoint": { + "description": "Defines the ARM Resource ID for the linked endpoints", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "ARM Resource ID string." + } + } + }, + "CustomRuleList": { + "description": "Defines contents of custom rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/CustomRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "CustomRule": { + "description": "Defines the common attributes for a custom rule that can be included in a waf policy", + "type": "object", + "required": [ + "name", + "priority", + "matchConditions", + "action" + ], + "properties": { + "name": { + "description": "Defines the name of the custom rule", + "type": "string" + }, + "enabledState": { + "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "CustomRuleEnabledState", + "modelAsString": true + } + }, + "priority": { + "description": "Defines in what order this rule be evaluated in the overall list of custom rules", + "type": "integer", + "format": "int32", + "maximum": 1000, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + }, + "x-ms-identifiers": [] + }, + "action": { + "description": "Describes what action to be applied when rule matches", + "$ref": "#/definitions/ActionType" + } + } + }, + "RateLimitRuleList": { + "description": "Defines contents of rate limit rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/RateLimitRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RateLimitRule": { + "description": "Defines a rate limiting rule that can be included in a waf policy", + "type": "object", + "required": [ + "rateLimitThreshold", + "rateLimitDurationInMinutes" + ], + "properties": { + "rateLimitThreshold": { + "description": "Defines rate limit threshold.", + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false + }, + "rateLimitDurationInMinutes": { + "description": "Defines rate limit duration. Default is 1 minute.", + "type": "integer", + "format": "int32", + "maximum": 60, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + } + }, + "allOf": [ + { + "$ref": "#/definitions/CustomRule" + } + ] + }, + "MatchCondition": { + "description": "Define match conditions", + "required": [ + "matchVariable", + "operator", + "matchValue" + ], + "properties": { + "matchVariable": { + "description": "Match variable to compare against.", + "type": "string", + "enum": [ + "RemoteAddr", + "SocketAddr", + "RequestMethod", + "RequestHeader", + "RequestUri", + "QueryString", + "RequestBody", + "Cookies", + "PostArgs" + ], + "x-ms-enum": { + "name": "WafMatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs.", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "RegEx" + ], + "x-ms-enum": { + "name": "operator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if the result of this condition should be negated.", + "type": "boolean" + }, + "matchValue": { + "description": "List of possible match values.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/TransformType" + } + } + } + }, + "TransformType": { + "description": "Describes what transforms were applied before matching.", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "TransformType", + "modelAsString": true + } + }, + "ManagedRuleSetList": { + "description": "Defines the list of managed rule sets for the policy.", + "properties": { + "managedRuleSets": { + "description": "List of rule sets.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + }, + "x-ms-identifiers": [ + "ruleSetType", + "ruleSetVersion" + ] + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "anomalyScore": { + "description": "Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests.", + "type": "integer", + "format": "int32", + "maximum": 20, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "ruleGroupOverrides": { + "description": "Defines the rule overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + }, + "x-ms-identifiers": [ + "ruleGroupName" + ] + } + } + }, + "ManagedRuleGroupOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "Describes the managed rule group within the rule set to override", + "type": "string" + }, + "rules": { + "description": "List of rules that will be enabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + }, + "x-ms-identifiers": [ + "ruleId" + ] + } + } + }, + "ManagedRuleOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "enabledState": { + "description": "Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + }, + "action": { + "description": "Describes the override action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + } + } + }, + "ManagedRuleSetDefinitionList": { + "description": "List of managed rule set definitions available for use in a policy.", + "properties": { + "value": { + "description": "List of managed rule set definitions.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSetDefinition" + } + }, + "nextLink": { + "type": "string", + "description": "URL to retrieve next set of managed rule set definitions." + } + } + }, + "ManagedRuleSetDefinition": { + "description": "Describes a managed rule set definition.", + "properties": { + "properties": { + "description": "Describes managed rule set definition properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedRuleSetDefinitionProperties" + }, + "sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.", + "$ref": "./cdn.json#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "./cdn.json#/definitions/Resource" + } + ] + }, + "ManagedRuleSetDefinitionProperties": { + "description": "Properties for a managed rule set definition.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Provisioning state of the managed rule set." + }, + "ruleSetType": { + "type": "string", + "readOnly": true, + "description": "Type of the managed rule set." + }, + "ruleSetVersion": { + "type": "string", + "readOnly": true, + "description": "Version of the managed rule set type." + }, + "ruleGroups": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleGroupDefinition" + }, + "x-ms-identifiers": [ + "ruleGroupName" + ], + "description": "Rule groups of the managed rule set." + } + } + }, + "ManagedRuleGroupDefinition": { + "description": "Describes a managed rule group.", + "properties": { + "ruleGroupName": { + "type": "string", + "readOnly": true, + "description": "Name of the managed rule group." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the managed rule group." + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleDefinition" + }, + "x-ms-identifiers": [ + "ruleId" + ], + "description": "List of rules within the managed rule group." + } + } + }, + "ManagedRuleDefinition": { + "description": "Describes a managed rule definition.", + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Describes the functionality of the managed rule.", + "readOnly": true, + "type": "string" + } + } + }, + "ActionType": { + "description": "Defines the action to take on rule match.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log", + "Redirect" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-05-01-preview." + }, + "PolicyNameParameter": { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "x-ms-parameter-location": "method", + "description": "The name of the CdnWebApplicationFirewallPolicy." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Create.json new file mode 100644 index 000000000000..42591d243fa6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Create.json @@ -0,0 +1,213 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1", + "customDomain": { + "properties": { + "hostName": "www.someDomain.net", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "cipherSuiteSetType": "Customized", + "minimumTlsVersion": "TLS12", + "customizedCipherSuiteSet": { + "cipherSuiteSetForTls10": [], + "cipherSuiteSetForTls12": [ + "ECDHE_RSA_AES128_GCM_SHA256" + ], + "cipherSuiteSetForTls13": [ + "TLS_AES_128_GCM_SHA256", + "TLS_AES_256_GCM_SHA384" + ] + } + }, + "mtlsSettings": { + "secrets": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name2" + } + ], + "otherAllowedFqdn": [ + "foo.contoso.com" + ] + }, + "azureDnsZone": { + "id": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "cipherSuiteSetType": "Customized", + "minimumTlsVersion": "TLS12", + "customizedCipherSuiteSet": { + "cipherSuiteSetForTls10": [], + "cipherSuiteSetForTls12": [ + "ECDHE_RSA_AES128_GCM_SHA256" + ], + "cipherSuiteSetForTls13": [ + "TLS_AES_128_GCM_SHA256", + "TLS_AES_256_GCM_SHA384" + ] + }, + "secret": { + "id": "" + } + }, + "mtlsSettings": { + "secrets": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name2" + } + ], + "otherAllowedFqdn": [ + "foo.contoso.com" + ], + "certificateValidation": "Enabled", + "certificatePassthrough": "Disabled", + "ocsp": "Enabled" + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "cipherSuiteSetType": "Customized", + "minimumTlsVersion": "TLS12", + "customizedCipherSuiteSet": { + "cipherSuiteSetForTls10": [], + "cipherSuiteSetForTls12": [ + "ECDHE_RSA_AES128_GCM_SHA256" + ], + "cipherSuiteSetForTls13": [ + "TLS_AES_128_GCM_SHA256", + "TLS_AES_256_GCM_SHA384" + ] + }, + "secret": { + "id": "" + } + }, + "mtlsSettings": { + "secrets": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name2" + } + ], + "otherAllowedFqdn": [ + "foo.contoso.com" + ], + "certificateValidation": "Enabled", + "certificatePassthrough": "Disabled", + "ocsp": "Enabled" + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "mtlsSettings": { + "secrets": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name2" + } + ], + "otherAllowedFqdn": [ + "foo.contoso.com" + ], + "certificateValidation": "Enabled", + "certificatePassthrough": "Disabled", + "ocsp": "Enabled" + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Delete.json new file mode 100644 index 000000000000..38df30ebb86e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Get.json new file mode 100644 index 000000000000..77442da48334 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Get.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "mtlsSettings": { + "secrets": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name2" + } + ], + "otherAllowedFqdn": [ + "foo.contoso.com" + ], + "certificateValidation": "Enabled", + "certificatePassthrough": "Disabled", + "ocsp": "Enabled" + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Pending", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_ListByProfile.json new file mode 100644 index 000000000000..9c261edf102c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_ListByProfile.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "mtlsSettings": { + "secrets": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name2" + } + ], + "otherAllowedFqdn": [ + "foo.contoso.com" + ], + "certificateValidation": "Enabled", + "certificatePassthrough": "Disabled", + "ocsp": "Enabled" + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Pending", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_RefreshValidationToken.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_RefreshValidationToken.json new file mode 100644 index 000000000000..0292445a78d6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_RefreshValidationToken.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Update.json new file mode 100644 index 000000000000..e912d3125cdc --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDCustomDomains_Update.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1", + "customDomainUpdateProperties": { + "properties": { + "tlsSettings": { + "certificateType": "CustomerCertificate", + "minimumTlsVersion": "TLS12" + }, + "mtlsSettings": { + "secrets": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name2" + } + ], + "otherAllowedFqdn": [ + "foo.contoso.com" + ], + "certificateValidation": "Enabled", + "certificatePassthrough": "Disabled", + "ocsp": "Enabled" + }, + "azureDnsZone": { + "id": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert" + } + }, + "mtlsSettings": { + "secrets": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name2" + } + ], + "otherAllowedFqdn": [ + "foo.contoso.com" + ], + "certificateValidation": "Enabled", + "certificatePassthrough": "Disabled", + "ocsp": "Enabled" + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Approved", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert" + } + }, + "mtlsSettings": { + "secrets": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/name2" + } + ], + "otherAllowedFqdn": [ + "foo.contoso.com" + ], + "certificateValidation": "Enabled", + "certificatePassthrough": "Disabled", + "ocsp": "Enabled" + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Approved", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Create.json new file mode 100644 index 000000000000..894b8ffd41a7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Create.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpoint": { + "tags": {}, + "location": "global", + "properties": { + "enabledState": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "201": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Delete.json new file mode 100644 index 000000000000..cd695aee7f2c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Get.json new file mode 100644 index 000000000000..26c625951cd7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ListByProfile.json new file mode 100644 index 000000000000..09c63c297ae8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ListByProfile.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ListResourceUsage.json new file mode 100644 index 000000000000..5c0f0cb82af5 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "name": { + "value": "route", + "localizedValue": "route" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_PurgeContent.json new file mode 100644 index 000000000000..ca4354bc39c0 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_PurgeContent.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contents": { + "contentPaths": [ + "/folder1" + ], + "domains": [ + "endpoint1-abcdefghijklmnop.z01.azurefd.net" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Update.json new file mode 100644 index 000000000000..5bfd6fe74f79 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_Update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpointUpdateProperties": { + "tags": {}, + "properties": { + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-ezh7ddcmguaeajfu.z01.azureedge.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ValidateCustomDomain.json new file mode 100644 index 000000000000..9c1880f6f11e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDEndpoints_ValidateCustomDomain.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Create.json new file mode 100644 index 000000000000..6334997db41f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Create.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originGroup": { + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path2", + "probeRequestType": "NotSet", + "probeProtocol": "NotSet", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Delete.json new file mode 100644 index 000000000000..cff6e02a0cb6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Get.json new file mode 100644 index 000000000000..a1a72abbba06 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_ListByProfile.json new file mode 100644 index 000000000000..63156fe69e27 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_ListByProfile.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_ListResourceUsage.json new file mode 100644 index 000000000000..aa71a25478bf --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "name": { + "value": "origin", + "localizedValue": "origin" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Update.json new file mode 100644 index 000000000000..c8bccbc8e5d7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOriginGroups_Update.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originGroupUpdateProperties": { + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path2", + "probeRequestType": "NotSet", + "probeProtocol": "NotSet", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Create.json new file mode 100644 index 000000000000..5ec5cff5dfdb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Create.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1", + "origin": { + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Delete.json new file mode 100644 index 000000000000..5c72f691a5cc --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Get.json new file mode 100644 index 000000000000..36b782e5660c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_ListByOriginGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_ListByOriginGroup.json new file mode 100644 index 000000000000..4edf4ab90da0 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_ListByOriginGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Update.json new file mode 100644 index 000000000000..b3eb0b023e7b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDOrigins_Update.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1", + "originUpdateProperties": { + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_CheckEndpointNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_CheckEndpointNameAvailability.json new file mode 100644 index 000000000000..a27289fbaf40 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_CheckEndpointNameAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "myResourceGroup", + "profileName": "profile1", + "checkEndpointNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/AfdEndpoints", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available", + "availableHostname": "" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_CheckHostNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_CheckHostNameAvailability.json new file mode 100644 index 000000000000..bdce7392c2ba --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_CheckHostNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "checkHostNameAvailabilityInput": { + "hostName": "www.someDomain.net" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Conflict", + "message": "The hostname 'www.someDomain.net' is already owned by another profile." + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ListResourceUsage.json new file mode 100644 index 000000000000..abcaedbc6694 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ListResourceUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "name": { + "value": "afdendpoint", + "localizedValue": "afdendpoint" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_Upgrade.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_Upgrade.json new file mode 100644 index 000000000000..81f1e0324b7a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_Upgrade.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profileUpgradeParameters": { + "wafMappingList": [ + { + "securityPolicyName": "securityPolicy1", + "changeToWafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "name": "profile1", + "location": "Global", + "kind": "frontdoor", + "tags": {}, + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "properties": { + "extendedProperties": {}, + "frontDoorId": "id", + "originResponseTimeoutSeconds": 60, + "provisioningState": "Succeeded", + "resourceState": "Enabled" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "name": "profile1", + "location": "Global", + "kind": "frontdoor", + "tags": {}, + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "properties": { + "originResponseTimeoutSeconds": 60, + "frontDoorId": "id", + "extendedProperties": {}, + "resourceState": "Upgrading", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ValidateSecret.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ValidateSecret.json new file mode 100644 index 000000000000..9eec791b7db5 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ValidateSecret.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "validateSecretInput": { + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName" + }, + "secretType": "CustomerCertificate" + } + }, + "responses": { + "200": { + "body": { + "status": "Valid", + "message": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CdnProfiles_CanMigrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CdnProfiles_CanMigrate.json new file mode 100644 index 000000000000..3f4426cc8bb9 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CdnProfiles_CanMigrate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/canmigrateresults/profile1", + "type": "Microsoft.Cdn/profiles/canmigrate", + "properties": { + "canMigrate": true, + "defaultSku": "Standard_AzureFrontDoor", + "errors": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CdnProfiles_Migrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CdnProfiles_Migrate.json new file mode 100644 index 000000000000..0e9394d82ea8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CdnProfiles_Migrate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1", + "migrationParameters": { + "sku": { + "name": "Standard_AzureFrontDoor" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/profiles/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckEndpointNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckEndpointNameAvailability.json new file mode 100644 index 000000000000..b5f05290643e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckEndpointNameAvailability.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "myResourceGroup", + "checkEndpointNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/AfdEndpoints", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available", + "availableHostname": "" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..7b97a922b1c7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckNameAvailabilityWithSubscription.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckNameAvailabilityWithSubscription.json new file mode 100644 index 000000000000..088c4afbcde8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CheckNameAvailabilityWithSubscription.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Create.json new file mode 100644 index 000000000000..0b39c77a906a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customDomainProperties": { + "properties": { + "hostName": "www.someDomain.net" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Delete.json new file mode 100644 index 000000000000..d5f083b51eac --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Delete.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_DisableCustomHttps.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_DisableCustomHttps.json new file mode 100644 index 000000000000..56bfa8c5449b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_DisableCustomHttps.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "CertificateDeleted", + "validationData": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json new file mode 100644 index 000000000000..46396c82d8d6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "AzureKeyVault", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "typeName": "KeyVaultCertificateSourceParameters", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "vaultName": "kv", + "secretName": "secret1", + "secretVersion": "00000000-0000-0000-0000-000000000000", + "updateRule": "NoAction", + "deleteRule": "NoAction" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabled", + "customHttpsProvisioningSubstate": "CertificateDeployed", + "validationData": "validationdata" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json new file mode 100644 index 000000000000..5b16f5f259bb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "Cdn", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "typeName": "CdnCertificateSourceParameters", + "certificateType": "Shared" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabled", + "customHttpsProvisioningSubstate": "CertificateDeployed", + "validationData": "validationdata" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Get.json new file mode 100644 index 000000000000..7765c01482f0 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_ListByEndpoint.json new file mode 100644 index 000000000000..ff24ec956fb6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/CustomDomains_ListByEndpoint.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/EdgeNodes_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/EdgeNodes_List.json new file mode 100644 index 000000000000..a8f15391e296 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/EdgeNodes_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Standard_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "180.240.184.128", + "prefixLength": 25 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Premium_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Premium_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Custom_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Custom_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "2606:2800:420b::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Create.json new file mode 100644 index 000000000000..371482c94297 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Create.json @@ -0,0 +1,546 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpoint": { + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "properties": { + "originHostHeader": "www.bing.com", + "originPath": "/photos", + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "typeName": "DeliveryRuleRemoteAddressConditionParameters" + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*", + "typeName": "DeliveryRuleHeaderActionParameters" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip", + "typeName": "DeliveryRuleHeaderActionParameters" + } + } + ] + } + ] + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Delete.json new file mode 100644 index 000000000000..cd695aee7f2c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Get.json new file mode 100644 index 000000000000..b6f8f8484194 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "customDomains": [ + { + "name": "www-someDomain-net", + "properties": { + "hostName": "www.someDomain.Net", + "validationData": null + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ListByProfile.json new file mode 100644 index 000000000000..9393b2b56cfe --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ListByProfile.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "customDomains": [ + { + "name": "www-someDomain-net", + "properties": { + "hostName": "www.someDomain.Net", + "validationData": null + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ListResourceUsage.json new file mode 100644 index 000000000000..19fb66ca77bf --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ListResourceUsage.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "customdomain", + "unit": "count", + "currentValue": 1, + "limit": 20 + }, + { + "resourceType": "geofilter", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_LoadContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_LoadContent.json new file mode 100644 index 000000000000..10b442049490 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_LoadContent.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_PurgeContent.json new file mode 100644 index 000000000000..10b442049490 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_PurgeContent.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Start.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Start.json new file mode 100644 index 000000000000..ccc55d39f970 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Start.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Stop.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Stop.json new file mode 100644 index 000000000000..a44780328284 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Stop.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Update.json new file mode 100644 index 000000000000..beaaa0af55c2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_Update.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpointUpdateProperties": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ValidateCustomDomain.json new file mode 100644 index 000000000000..9c1880f6f11e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Endpoints_ValidateCustomDomain.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Create.json new file mode 100644 index 000000000000..b872aef3291a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Create.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1", + "keyGroupName": "kg1", + "keyGroup": { + "properties": { + "keyReferences": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keyGroups/kg1", + "name": "kg1", + "type": "Microsoft.Cdn/profiles/keygroups", + "properties": { + "keyReferences": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3" + } + ], + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keyGroups/kg1", + "name": "kg1", + "type": "Microsoft.Cdn/profiles/keygroups", + "properties": { + "keyReferences": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3" + } + ], + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Delete.json new file mode 100644 index 000000000000..d670f1e8cdbe --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1", + "keyGroupName": "kg1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Get.json new file mode 100644 index 000000000000..86927e551688 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1", + "keyGroupName": "kg1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keyGroups/kg1", + "name": "kg1", + "type": "Microsoft.Cdn/profiles/keygroups", + "properties": { + "keyReferences": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3" + } + ], + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_ListByProfile.json new file mode 100644 index 000000000000..7b3340e56bcc --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/KeyGroups_ListByProfile.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keyGroups/kg1", + "name": "kg1", + "type": "Microsoft.Cdn/profiles/keygroups", + "properties": { + "keyReferences": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3" + } + ], + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keyGroups/kg2", + "name": "kg2", + "type": "Microsoft.Cdn/profiles/keygroups", + "properties": { + "keyReferences": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2" + } + ], + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keyGroups/kg-at-max-capacity", + "name": "kg-at-max-capacity", + "type": "Microsoft.Cdn/profiles/keygroups", + "properties": { + "keyReferences": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret4" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret5" + } + ], + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsLocations.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsLocations.json new file mode 100644 index 000000000000..93c24e943ec1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsLocations.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": "clientRequestCount", + "granularity": "PT5M", + "groupBy": "httpStatusCode", + "dateTimeBegin": "2020-11-04T05:00:00.000Z", + "dateTimeEnd": "2020-11-04T06:00:00.000Z" + }, + "responses": { + "200": { + "body": { + "continents": [ + { + "id": "africa" + }, + { + "id": "antarctica" + }, + { + "id": "asia" + }, + { + "id": "europe" + }, + { + "id": "northAmerica" + }, + { + "id": "oceania" + }, + { + "id": "southAmerica" + } + ], + "countryOrRegions": [ + { + "id": "dz", + "continentId": "africa" + }, + { + "id": "ao", + "continentId": "africa" + }, + { + "id": "bw", + "continentId": "africa" + }, + { + "id": "bi", + "continentId": "africa" + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsMetrics.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsMetrics.json new file mode 100644 index 000000000000..5e89c7c9d34b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsMetrics.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": [ + "clientRequestCount" + ], + "granularity": "PT5M", + "groupBy": [ + "protocol" + ], + "dateTimeBegin": "2020-11-04T04:30:00.000Z", + "dateTimeEnd": "2020-11-04T05:00:00.000Z", + "customDomains": [ + "customdomain1.azurecdn.net", + "customdomain2.azurecdn.net" + ], + "protocols": [ + "https" + ] + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T12:30:27.554+08:00", + "dateTimeEnd": "2020-11-04T13:00:27.554+08:00", + "granularity": "PT5M", + "series": [ + { + "metric": "clientRequestCount", + "unit": "count", + "groups": [ + { + "name": "protocol", + "value": "https" + } + ], + "data": [ + { + "dateTime": "2020-11-04T04:35:00+00:00", + "value": 4250 + }, + { + "dateTime": "2020-11-04T04:40:00+00:00", + "value": 3120 + }, + { + "dateTime": "2020-11-04T04:45:00+00:00", + "value": 2221 + }, + { + "dateTime": "2020-11-04T04:50:00+00:00", + "value": 2466 + }, + { + "dateTime": "2020-11-04T04:55:00+00:00", + "value": 2654 + }, + { + "dateTime": "2020-11-04T05:00:00+00:00", + "value": 3565 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsRankings.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsRankings.json new file mode 100644 index 000000000000..760ac2499ab8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsRankings.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "rankings": [ + "url" + ], + "metrics": [ + "clientRequestCount" + ], + "maxRanking": "5", + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:49:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:49:27.554+08:00", + "tables": [ + { + "ranking": "url", + "data": [ + { + "name": "https://testdomain.com/favicon.png", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 2336, + "percentage": 8.28133862733976 + } + ] + }, + { + "name": "https://testdomain.com/js/app.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 2140, + "percentage": 7.586500283607488 + } + ] + }, + { + "name": "https://testdomain.com/js/lang/en.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1536, + "percentage": 5.445263754963131 + } + ] + }, + { + "name": "https://testdomain.com/js/lib.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1480, + "percentage": 5.246738513896767 + } + ] + }, + { + "name": "https://cdn.exam.net/css/lib.css", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1452, + "percentage": 5.147475893363584 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsResources.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsResources.json new file mode 100644 index 000000000000..2bb1d747e3be --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetLogAnalyticsResources.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "endpoints": [ + { + "id": "endpoint1", + "name": "endpoint1.azureedge.net", + "history": false, + "customDomains": [ + { + "id": "customdomain1.azurecdn.net", + "name": "customdomain1.azurecdn.net", + "endpointId": "enbdpiont1", + "history": true + }, + { + "id": "customdomain2.azurecdn.net", + "name": "customdomain2.azurecdn.net", + "endpointId": null, + "history": true + } + ] + } + ], + "customDomains": [ + { + "id": "customdomain1.azurecdn.net", + "name": "customdomain1.azurecdn.net", + "endpointId": null, + "history": true + }, + { + "id": "customdomain2.azurecdn.net", + "name": "customdomain2.azurecdn.net", + "endpointId": null, + "history": true + }, + { + "id": "customdomain3.azurecdn.net", + "name": "customdomain3.azurecdn.net", + "endpointId": null, + "history": true + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json new file mode 100644 index 000000000000..db977a1f40c3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": [ + "clientRequestCount" + ], + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z", + "actions": [ + "block", + "log" + ], + "granularity": "PT5M" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:30:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:00:27.554+08:00", + "granularity": "PT5M", + "series": [ + { + "metric": "clientRequestCount", + "unit": "count", + "groups": [], + "data": [ + { + "dateTime": "2020-11-04T07:05:00+00:00", + "value": 2 + }, + { + "dateTime": "2020-11-04T07:10:00+00:00", + "value": 32 + }, + { + "dateTime": "2020-11-04T07:15:00+00:00", + "value": 31 + }, + { + "dateTime": "2020-11-04T07:20:00+00:00", + "value": 63 + }, + { + "dateTime": "2020-11-04T07:25:00+00:00", + "value": 50 + }, + { + "dateTime": "2020-11-04T07:30:00+00:00", + "value": 12 + }, + { + "dateTime": "2020-11-04T07:35:00+00:00", + "value": 8 + }, + { + "dateTime": "2020-11-04T07:40:00+00:00", + "value": 21 + }, + { + "dateTime": "2020-11-04T07:45:00+00:00", + "value": 30 + }, + { + "dateTime": "2020-11-04T07:50:00+00:00", + "value": 18 + }, + { + "dateTime": "2020-11-04T07:55:00+00:00", + "value": 28 + }, + { + "dateTime": "2020-11-04T08:00:00+00:00", + "value": 3 + }, + { + "dateTime": "2020-11-04T08:05:00+00:00", + "value": 58 + }, + { + "dateTime": "2020-11-04T08:10:00+00:00", + "value": 42 + }, + { + "dateTime": "2020-11-04T08:15:00+00:00", + "value": 17 + }, + { + "dateTime": "2020-11-04T08:20:00+00:00", + "value": 21 + }, + { + "dateTime": "2020-11-04T08:25:00+00:00", + "value": 41 + }, + { + "dateTime": "2020-11-04T08:30:00+00:00", + "value": 8 + }, + { + "dateTime": "2020-11-04T08:35:00+00:00", + "value": 15 + }, + { + "dateTime": "2020-11-04T08:40:00+00:00", + "value": 25 + }, + { + "dateTime": "2020-11-04T08:45:00+00:00", + "value": 13 + }, + { + "dateTime": "2020-11-04T08:50:00+00:00", + "value": 17 + }, + { + "dateTime": "2020-11-04T08:55:00+00:00", + "value": 29 + }, + { + "dateTime": "2020-11-04T09:00:00+00:00", + "value": 17 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetWafLogAnalyticsRankings.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetWafLogAnalyticsRankings.json new file mode 100644 index 000000000000..48a669361510 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/LogAnalytics_GetWafLogAnalyticsRankings.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "rankings": [ + "ruleId" + ], + "metrics": [ + "clientRequestCount" + ], + "maxRanking": "5", + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:49:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:49:27.554+08:00", + "groups": [ + "ruleId" + ], + "data": [ + { + "groupValues": [ + "BlockRateLimit" + ], + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1268, + "percentage": 0 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Operations_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..b7185146a68e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Operations_List.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cdn/register/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Microsoft.Cdn Resource Provider", + "operation": "Registers the Microsoft.Cdn Resource Provider" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/profiles/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/profiles/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/CheckResourceUsage/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "CheckResourceUsage" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/GenerateSsoUri/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "GenerateSsoUri" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Create.json new file mode 100644 index 000000000000..ae4fbe5c3355 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Create.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "origingroup1", + "originGroup": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "201": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "originGroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Delete.json new file mode 100644 index 000000000000..abaf8dd6a4b7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Get.json new file mode 100644 index 000000000000..16db83f967ef --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpAndHttpErrors", + "responseBasedFailoverThresholdPercentage": 10, + "httpErrorRanges": [ + { + "begin": 500, + "end": 505 + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_ListByEndpoint.json new file mode 100644 index 000000000000..d86b47a3b4c8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_ListByEndpoint.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Update.json new file mode 100644 index 000000000000..1cae396cf8b5 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/OriginGroups_Update.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1", + "originGroupUpdateProperties": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Create.json new file mode 100644 index 000000000000..f42e67214cc2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Create.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "origin": { + "properties": { + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Delete.json new file mode 100644 index 000000000000..fc16b92f8170 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "origin1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Get.json new file mode 100644 index 000000000000..898856fc629c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_ListByEndpoint.json new file mode 100644 index 000000000000..c2a82bb3060a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_ListByEndpoint.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Update.json new file mode 100644 index 000000000000..6d3fc2fedd77 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Origins_Update.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "originUpdateProperties": { + "properties": { + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_CanMigrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_CanMigrate.json new file mode 100644 index 000000000000..723820fbfb0a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_CanMigrate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "canMigrateParameters": { + "classicResourceReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/yaoshitest/providers/Microsoft.Cdn/operationresults/operationid/profileresults/DummyProfile/canmigrateresults/DummyProfile", + "type": "Microsoft.Cdn/canmigrate", + "properties": { + "canMigrate": true, + "defaultSku": "Standard_AzureFrontDoor", + "errors": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Create.json new file mode 100644 index 000000000000..1d625236f31a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Create.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profile": { + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "201": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": null, + "state": "Enabled" + } + ] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": null, + "state": "Enabled" + } + ] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Creating", + "resourceState": "Creating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Delete.json new file mode 100644 index 000000000000..5392d7b48d09 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_GenerateSsoUri.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_GenerateSsoUri.json new file mode 100644 index 000000000000..dcf7427b4b52 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_GenerateSsoUri.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "ssoUriValue": "https://someuri.com" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Get.json new file mode 100644 index 000000000000..fe19a71e9acf --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_List.json new file mode 100644 index 000000000000..ac4bdbbe107a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_List.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListByResourceGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListByResourceGroup.json new file mode 100644 index 000000000000..5ce64f1ec608 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListResourceUsage.json new file mode 100644 index 000000000000..0dd6f3ddfad2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListResourceUsage.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "endpoint", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListSupportedOptimizationTypes.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListSupportedOptimizationTypes.json new file mode 100644 index 000000000000..6e299d6ce6f2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_ListSupportedOptimizationTypes.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "supportedOptimizationTypes": [ + "GeneralWebDelivery", + "DynamicSiteAcceleration" + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Migrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Migrate.json new file mode 100644 index 000000000000..269c15a689c2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Migrate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "migrationParameters": { + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "classicResourceReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname" + }, + "profileName": "profile1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_MigrationAbort.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_MigrationAbort.json new file mode 100644 index 000000000000..f3b777ba33cb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_MigrationAbort.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_MigrationCommit.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_MigrationCommit.json new file mode 100644 index 000000000000..9febfdb5f112 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_MigrationCommit.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Update.json new file mode 100644 index 000000000000..bbd1790c87a3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Profiles_Update.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profileUpdateParameters": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Updating", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/ResourceUsage_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/ResourceUsage_List.json new file mode 100644 index 000000000000..8fa798284245 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/ResourceUsage_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "profile", + "unit": "count", + "currentValue": 31, + "limit": 200 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Create.json new file mode 100644 index 000000000000..ae0dd98600ce --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Create.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1", + "route": { + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "grpcState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "grpcState": "Enabled" + } + } + }, + "201": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "grpcState": "Enabled" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted", + "grpcState": "Enabled" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Delete.json new file mode 100644 index 000000000000..07d6ccf51ca9 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Get.json new file mode 100644 index 000000000000..18ca702b85e3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1" + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "grpcState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_ListByEndpoint.json new file mode 100644 index 000000000000..3b3505828277 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_ListByEndpoint.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "grpcState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Update.json new file mode 100644 index 000000000000..71c741c820f1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Routes_Update.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1", + "routeUpdateProperties": { + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "grpcState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "grpcState": "Enabled" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted", + "grpcState": "Enabled" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Create.json new file mode 100644 index 000000000000..4bec01f6245d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Create.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Delete.json new file mode 100644 index 000000000000..ecd14da93a4f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Get.json new file mode 100644 index 000000000000..b52cde0228ef --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_ListByProfile.json new file mode 100644 index 000000000000..5bce8246a1b1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_ListByProfile.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_ListResourceUsage.json new file mode 100644 index 000000000000..900710d696e7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/RuleSets_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "name": { + "value": "rule", + "localizedValue": "rule" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Create.json new file mode 100644 index 000000000000..7da1449c96f7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Create.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1", + "rule": { + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Create_AfdUrlSigningAction.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Create_AfdUrlSigningAction.json new file mode 100644 index 000000000000..f176bfbccc59 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Create_AfdUrlSigningAction.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1", + "rule": { + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false + } + } + ], + "actions": [ + { + "name": "AfdUrlSigning", + "parameters": { + "typeName": "DeliveryRuleAfdUrlSigningActionParameters", + "keyGroupReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keygroups/kg1" + }, + "algorithm": "SHA256", + "parameterNameOverride": [ + { + "paramIndicator": "Expires", + "paramName": "Expiration-Date" + }, + { + "paramIndicator": "Signature", + "paramName": "Sig-Hash" + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false + } + } + ], + "actions": [ + { + "name": "AfdUrlSigning", + "parameters": { + "typeName": "DeliveryRuleAfdUrlSigningActionParameters", + "keyGroupReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keygroups/kg1" + }, + "algorithm": "SHA256", + "parameterNameOverride": [ + { + "paramIndicator": "Expires", + "paramName": "Expiration-Date" + }, + { + "paramIndicator": "Signature", + "paramName": "Sig-Hash" + } + ] + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false + } + } + ], + "actions": [ + { + "name": "AfdUrlSigning", + "parameters": { + "typeName": "DeliveryRuleAfdUrlSigningActionParameters", + "keyGroupReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keygroups/kg1" + }, + "algorithm": "SHA256", + "parameterNameOverride": [ + { + "paramIndicator": "Expires", + "paramName": "Expiration-Date" + }, + { + "paramIndicator": "Signature", + "paramName": "Sig-Hash" + } + ] + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false + } + } + ], + "actions": [ + { + "name": "AfdUrlSigning", + "parameters": { + "typeName": "DeliveryRuleAfdUrlSigningActionParameters", + "keyGroupReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keygroups/kg1" + }, + "algorithm": "SHA256", + "parameterNameOverride": [ + { + "paramIndicator": "Expires", + "paramName": "Expiration-Date" + }, + { + "paramIndicator": "Signature", + "paramName": "Sig-Hash" + } + ] + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Delete.json new file mode 100644 index 000000000000..b71f730e6055 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Get.json new file mode 100644 index 000000000000..802eaec865d0 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_ListByRuleSet.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_ListByRuleSet.json new file mode 100644 index 000000000000..bf3ebc624af2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_ListByRuleSet.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Update.json new file mode 100644 index 000000000000..5226f38205fd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Rules_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1", + "ruleUpdateProperties": { + "properties": { + "order": 1, + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateCustomerCertificateType.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateCustomerCertificateType.json new file mode 100644 index 000000000000..cddc40cf2702 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateCustomerCertificateType.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1", + "secret": { + "properties": { + "parameters": { + "type": "CustomerCertificate", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename" + }, + "useLatestVersion": false + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateMtlsCertificateChainType.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateMtlsCertificateChainType.json new file mode 100644 index 000000000000..d701ee8b1853 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateMtlsCertificateChainType.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1", + "secret": { + "properties": { + "parameters": { + "type": "MtlsCertificateChain", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/mTLSCertificateChainname" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "MtlsCertificateChain", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/mTLSCertificateChainName" + }, + "expirationDate": "2025-01-01T00:00:00-00:00" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "MtlsCertificateChain", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/mTLSCertificateChainName" + }, + "expirationDate": "2025-01-01T00:00:00-00:00" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "MtlsCertificateChain", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/mTLSCertificateChainName" + }, + "expirationDate": "2025-01-01T00:00:00-00:00" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateUrlSigningKeyType.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateUrlSigningKeyType.json new file mode 100644 index 000000000000..ff81c653b478 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateUrlSigningKeyType.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1", + "secret": { + "properties": { + "parameters": { + "type": "UrlSigningKey", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/urlsigningkeyname" + }, + "keyId": "customKeyId" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "UrlSigningKey", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/urlsigningkeyname" + }, + "keyId": "customKeyId" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "UrlSigningKey", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/urlsigningkeyname" + }, + "keyId": "customKeyId" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "UrlSigningKey", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/urlsigningkeyname" + }, + "keyId": "customKeyId" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_Delete.json new file mode 100644 index 000000000000..9064ae4cae97 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_Get.json new file mode 100644 index 000000000000..48cd02c088d1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1" + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_ListByProfile.json new file mode 100644 index 000000000000..81a368190ff6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_ListByProfile.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/autogenerated_secret_name", + "type": "Microsoft.Cdn/profiles/secrets", + "name": "69f05517-6aaf-4a1e-a96d-f8c02f66c756-test12-afdx-test-domains-azfdtest-xyz", + "properties": { + "parameters": { + "type": "ManagedCertificate", + "subject": "bar.contoso.com", + "expirationDate": "2025-01-01T00:00:00-00:00" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Create.json new file mode 100644 index 000000000000..3b8845d1855b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Create.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1", + "securityPolicy": { + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Delete.json new file mode 100644 index 000000000000..6e60a4b9d665 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Get.json new file mode 100644 index 000000000000..815230eff030 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1" + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_ListByProfile.json new file mode 100644 index 000000000000..2c6951d41253 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_ListByProfile.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Patch.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Patch.json new file mode 100644 index 000000000000..c7e6834c0e0a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/SecurityPolicies_Patch.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1", + "securityPolicyUpdateProperties": { + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/ValidateProbe.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/ValidateProbe.json new file mode 100644 index 000000000000..f7cb48c58052 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/ValidateProbe.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "validateProbeInput": { + "probeURL": "https://www.bing.com/image" + } + }, + "responses": { + "200": { + "body": { + "isValid": true, + "errorCode": "None", + "message": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafListManagedRuleSets.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafListManagedRuleSets.json new file mode 100644 index 000000000000..2f4be6c384fd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafListManagedRuleSets.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "DefaultRuleSet_1.0", + "id": "/subscriptions/subid/providers/Microsoft.Cdn/CdnWebApplicationFirewallManagedRuleSets", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallmanagedrulesets", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "provisioningState": "Succeeded", + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroups": [ + { + "ruleGroupName": "Group1", + "description": "Description for rule group 1.", + "rules": [ + { + "ruleId": "GROUP1-0001", + "description": "Generic managed web application firewall rule." + }, + { + "ruleId": "GROUP1-0002", + "description": "Generic managed web application firewall rule." + } + ] + }, + { + "ruleGroupName": "Group2", + "description": "Description for rule group 2.", + "rules": [ + { + "ruleId": "GROUP2-0001", + "description": "Generic managed web application firewall rule." + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafListPolicies.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafListPolicies.json new file mode 100644 index 000000000000..15bbbb7104f0 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafListPolicies.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + }, + { + "name": "VerizonStandardCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/VerizonStandardCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Verizon" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "ECRS", + "ruleSetVersion": "2018-11-2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "XSS", + "rules": [ + { + "ruleId": "XSS-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "XSS-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPatchPolicy.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPatchPolicy.json new file mode 100644 index 000000000000..211483b02c11 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPatchPolicy.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy", + "cdnWebApplicationFirewallPolicyPatchParameters": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "foo": "bar" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 403, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Creating", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 403, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyCreateOrUpdate.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..8016e485e87f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,508 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy", + "cdnWebApplicationFirewallPolicy": { + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "policySettings": { + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "201": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-05-01-preview" + }, + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Creating", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 3, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyDelete.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..0b26ce66fa99 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyGet.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyGet.json new file mode 100644 index 000000000000..a2ded5a64068 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/WafPolicyGet.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy" + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml new file mode 100644 index 000000000000..7259132992bd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml @@ -0,0 +1,28 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json +scope: ResourceGroup +variables: + afdprofileName: + type: string + prefix: afdprofile +scenarios: + - scenario: GeneratedScenario + steps: + - step: CheckNameAvailabilityWithSubscription + operationId: CheckNameAvailabilityWithSubscription + exampleFile: ../examples/CheckNameAvailabilityWithSubscription.json + - step: AFDProfiles_Create + operationId: Profiles_Create + parameters: + profileName: $(afdprofileName) + profile: + location: "global" + sku: + name: Standard_AzureFrontDoor + identity: + type: "SystemAssigned" + - step: AFDProfiles_Upgrade + operationId: AFDProfiles_Upgrade + parameters: + profileName: $(afdprofileName) + profileUpgradeParameters: + wafMappingList: [] diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index 63200494df5b..67dd1ebba94f 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -33,6 +33,17 @@ tag: package-2024-02 ``` +### Tag: package-preview-2024-05 + +These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-05' +input-file: + - Microsoft.Cdn/preview/2024-05-01-preview/afdx.json + - Microsoft.Cdn/preview/2024-05-01-preview/cdn.json + - Microsoft.Cdn/preview/2024-05-01-preview/cdnwebapplicationfirewall.json +``` + ### Tag: package-2024-02 These settings apply only when `--tag=package-2024-02` is specified on the command line. From 963641f41419c5e71131fefbe4ea6db299631125 Mon Sep 17 00:00:00 2001 From: deeksha345 <34255011+deeksha345@users.noreply.github.com> Date: Mon, 17 Jun 2024 18:18:03 -0700 Subject: [PATCH 187/343] Deesharma/connectedclusternewversion (#29148) * adding new api version off base version 2024-02-01-preview * updating the api version in all files * updated to the connectedClusters.json for the new api version * updating readme.md * updating the api version to be consistent with the past versions * Updating the description of a few properties * Update connectedClusters.json for prettier check * Update GetClusterExample.json Adding example for agentState in getClusterExample * Update GetProvisionedClusterExample.json * Update GetClusterExample.json Update get cluster example with all the newly added properties to the cc swagger * Update GetClusterExample.json * Update GetClusterExample.json * Update CreateCluster_KindExample.json * Update CreateCluster_KindExample.json * Create sdk-suppressions.yaml * add azure-sdk-for-go suppression --------- Co-authored-by: Yuchao Yan Co-authored-by: Alancere <804873052@qq.com> --- .../2024-06-01-preview/connectedClusters.json | 1081 +++++++++++++++++ ...tersListClusterCredentialResultCSPAAD.json | 30 + ...rsListClusterCredentialResultCSPToken.json | 30 + ...stersListClusterCredentialResultHPAAD.json | 24 + ...ersListClusterCredentialResultHPToken.json | 24 + .../examples/CreateClusterExample.json | 83 ++ .../CreateClusterPrivateLinkExample.json | 89 ++ .../examples/CreateCluster_KindExample.json | 154 +++ .../examples/DeleteClusterExample.json | 18 + .../examples/GetClusterExample.json | 76 ++ .../GetClustersByResourceGroupExample.json | 87 ++ .../GetClustersBySubscriptionExample.json | 86 ++ .../GetProvisionedClusterExample.json | 68 ++ ...ListConnectedClusterOperationsExample.json | 41 + .../examples/UpdateClusterExample.json | 55 + .../resource-manager/readme.md | 8 + .../resource-manager/sdk-suppressions.yaml | 9 + 17 files changed, 1963 insertions(+) create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/connectedClusters.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateClusterPrivateLinkExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateCluster_KindExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/DeleteClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClustersByResourceGroupExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClustersBySubscriptionExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetProvisionedClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ListConnectedClusterOperationsExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/UpdateClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/sdk-suppressions.yaml diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/connectedClusters.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/connectedClusters.json new file mode 100644 index 000000000000..b4e05223d18e --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/connectedClusters.json @@ -0,0 +1,1081 @@ +{ + "swagger": "2.0", + "info": { + "title": "ConnectedKubernetesClient", + "version": "2024-06-01-preview", + "description": "Azure Connected Cluster Resource Provider API for onboarding a Kubernetes Cluster to Azure Arc" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}": { + "put": { + "summary": "Register a new Kubernetes cluster with Azure Resource Manager.", + "operationId": "ConnectedCluster_Create", + "description": "API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "CreateClusterExample": { + "$ref": "./examples/CreateClusterExample.json" + }, + "CreateCluster_KindExample": { + "$ref": "./examples/CreateCluster_KindExample.json" + }, + "CreateClusterPrivateLinkExample": { + "$ref": "./examples/CreateClusterPrivateLinkExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "name": "ConnectedCluster", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedCluster" + }, + "description": "Parameters supplied to Create a Connected Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "201": { + "description": "Resource creation request accepted", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "summary": "Updates a connected cluster.", + "operationId": "ConnectedCluster_Update", + "description": "API to update certain properties of the connected cluster resource", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "UpdateClusterExample": { + "$ref": "./examples/UpdateClusterExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "name": "ConnectedClusterPatch", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedClusterPatch" + }, + "description": "Parameters supplied to update Connected Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "summary": "Get the properties of the specified connected cluster.", + "operationId": "ConnectedCluster_Get", + "description": "Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClusterExample": { + "$ref": "./examples/GetClusterExample.json" + }, + "GetProvisionedClusterExample": { + "$ref": "./examples/GetProvisionedClusterExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + } + ], + "responses": { + "200": { + "description": "Resource retrieved successfully.", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "summary": "Delete a connected cluster.", + "operationId": "ConnectedCluster_Delete", + "description": "Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "DeleteClusterExample": { + "$ref": "./examples/DeleteClusterExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Resource deletion is in progress" + }, + "204": { + "description": "The resource was not found but the request is well formed" + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}/listClusterUserCredential": { + "post": { + "summary": "Gets cluster user credentials of a connected cluster", + "operationId": "ConnectedCluster_ListClusterUserCredential", + "description": "Gets cluster user credentials of the connected cluster with a specified resource group and name.", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "ListClusterUserCredentialExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultCSPAAD.json" + }, + "ListClusterUserCredentialNonAadExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultCSPToken.json" + }, + "ListClusterUserCredentialCSPExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultHPAAD.json" + }, + "ListClusterUserCredentialNonAadCSPExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultHPToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "required": true, + "name": "Properties", + "schema": { + "$ref": "#/definitions/ListClusterUserCredentialProperties" + }, + "description": "ListClusterUserCredential properties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters": { + "get": { + "summary": "Lists all connected clusters in the given ResourceGroup", + "operationId": "ConnectedCluster_ListByResourceGroup", + "description": "API to enumerate registered connected K8s clusters under a Resource Group", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClustersExample": { + "$ref": "./examples/GetClustersByResourceGroupExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedClusterList" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Kubernetes/connectedClusters": { + "get": { + "summary": "Lists all connected clusters in the given Subscription", + "operationId": "ConnectedCluster_ListBySubscription", + "description": "API to enumerate registered connected K8s clusters under a Subscription", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClustersBySubscriptionExample": { + "$ref": "./examples/GetClustersBySubscriptionExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedClusterList" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Kubernetes/operations": { + "get": { + "description": "Lists all of the available API operations for Connected Cluster resource.", + "operationId": "Operations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListConnectedClusterOperationsExample": { + "$ref": "./examples/ListConnectedClusterOperationsExample.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationList": { + "type": "object", + "description": "The paginated list of connected cluster API operations.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of connected cluster API operations." + }, + "nextLink": { + "type": "string", + "description": "The link to fetch the next page of connected cluster API operations." + } + } + }, + "Operation": { + "type": "object", + "description": "The Connected cluster API operation", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {Microsoft.Kubernetes}/{resource}/{operation}" + }, + "display": { + "type": "object", + "readOnly": true, + "description": "The object that represents the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Service provider: Microsoft.Kubernetes" + }, + "resource": { + "type": "string", + "description": "Connected Cluster Resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "Operation type: Read, write, delete, etc." + }, + "description": { + "type": "string", + "description": "Description of the operation." + } + } + } + } + }, + "ConnectedClusterList": { + "description": "The paginated list of connected Clusters", + "type": "object", + "properties": { + "value": { + "description": "The list of connected clusters", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "nextLink": { + "description": "The link to fetch the next page of connected clusters", + "type": "string" + } + } + }, + "ConnectedCluster": { + "type": "object", + "required": [ + "properties", + "identity" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ConnectedClusterIdentity", + "description": "The identity of the connected cluster." + }, + "kind": { + "$ref": "#/definitions/ConnectedClusterKind", + "description": "The kind of connected cluster." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectedClusterProperties", + "description": "Describes the connected cluster resource properties." + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a connected cluster." + }, + "ConnectedClusterIdentity": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of connected cluster identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.", + "default": "SystemAssigned", + "enum": [ + "None", + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the connected cluster." + }, + "ConnectedClusterKind": { + "type": "string", + "description": "Indicates the kind of Arc connected cluster based on host infrastructure.", + "enum": [ + "ProvisionedCluster" + ], + "x-ms-enum": { + "name": "ConnectedClusterKind", + "modelAsString": true + } + }, + "ConnectedClusterProperties": { + "type": "object", + "required": [ + "agentPublicKeyCertificate" + ], + "properties": { + "agentPublicKeyCertificate": { + "type": "string", + "description": "Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure." + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The Kubernetes version of the connected cluster resource" + }, + "totalNodeCount": { + "readOnly": true, + "type": "integer", + "description": "Number of nodes present in the connected cluster resource" + }, + "totalCoreCount": { + "readOnly": true, + "format": "int32", + "type": "integer", + "description": "Number of CPU cores present in the connected cluster resource" + }, + "agentVersion": { + "readOnly": true, + "type": "string", + "description": "Version of the agent running on the connected cluster resource" + }, + "provisioningState": { + "$ref": "#/definitions/ConnectedClusterProvisioningState", + "description": "Provisioning state of the connected cluster resource." + }, + "distribution": { + "type": "string", + "description": "The Kubernetes distribution running on this connected cluster." + }, + "distributionVersion": { + "type": "string", + "description": "The Kubernetes distribution version on this connected cluster." + }, + "infrastructure": { + "type": "string", + "description": "The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on." + }, + "offering": { + "type": "string", + "readOnly": true, + "description": "Connected cluster offering" + }, + "managedIdentityCertificateExpirationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Expiration time of the managed identity certificate" + }, + "lastConnectivityTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Time representing the last instance when heart beat was received from the cluster" + }, + "connectivityStatus": { + "type": "string", + "readOnly": true, + "description": "Represents the connectivity status of the connected cluster.", + "enum": [ + "Connecting", + "Connected", + "Offline", + "Expired" + ], + "x-ms-enum": { + "name": "ConnectivityStatus", + "modelAsString": true + } + }, + "privateLinkState": { + "type": "string", + "description": "Property which describes the state of private link on a connected cluster resource.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PrivateLinkState", + "modelAsString": true + } + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any." + }, + "azureHybridBenefit": { + "type": "string", + "description": "Indicates whether Azure Hybrid Benefit is opted in", + "enum": [ + "True", + "False", + "NotApplicable" + ], + "default": "NotApplicable", + "x-ms-enum": { + "name": "AzureHybridBenefit", + "modelAsString": true + } + }, + "aadProfile": { + "description": "AAD profile for the connected cluster.", + "$ref": "#/definitions/AadProfile" + }, + "arcAgentProfile": { + "description": "Arc agentry configuration for the provisioned cluster.", + "$ref": "#/definitions/ArcAgentProfile" + }, + "securityProfile": { + "description": "Security profile for the connected cluster.", + "$ref": "#/definitions/SecurityProfile" + }, + "oidcIssuerProfile": { + "description": "Open ID Connect (OIDC) Issuer Profile for the connected cluster.", + "$ref": "#/definitions/OidcIssuerProfile" + }, + "miscellaneousProperties": { + "description": "More properties related to the Connected Cluster", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "description": "Properties of the connected cluster." + }, + "CredentialResults": { + "type": "object", + "properties": { + "hybridConnectionConfig": { + "$ref": "#/definitions/HybridConnectionConfig", + "description": "Contains the REP (rendezvous endpoint) and “Sender” access token.", + "readOnly": true + }, + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list of credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "ConnectedClusterProvisioningState": { + "type": "string", + "description": "The current deployment state of connectedClusters.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ConnectedClusterPatch": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectedClusterPatchProperties", + "description": "Describes the connected cluster resource properties that can be updated during PATCH operation." + } + }, + "description": "Object containing updates for patch operations." + }, + "ConnectedClusterPatchProperties": { + "type": "object", + "properties": { + "distribution": { + "type": "string", + "description": "Represents the distribution of the connected cluster" + }, + "distributionVersion": { + "type": "string", + "description": "Represents the Kubernetes distribution version on this connected cluster." + }, + "azureHybridBenefit": { + "type": "string", + "description": "Indicates whether Azure Hybrid Benefit is opted in", + "enum": [ + "True", + "False", + "NotApplicable" + ], + "x-ms-enum": { + "name": "AzureHybridBenefit", + "modelAsString": true + } + } + }, + "description": "Properties which can be patched on the connected cluster resource." + }, + "HybridConnectionConfig": { + "type": "object", + "description": "Contains the REP (rendezvous endpoint) and “Sender” access token.", + "properties": { + "expirationTime": { + "description": "Timestamp when this token will be expired.", + "type": "integer", + "readOnly": true, + "format": "int64" + }, + "hybridConnectionName": { + "description": "Name of the connection", + "type": "string", + "readOnly": true + }, + "relay": { + "description": "Name of the relay.", + "type": "string", + "readOnly": true + }, + "token": { + "description": "Sender access token", + "type": "string", + "readOnly": true + } + } + }, + "AadProfile": { + "type": "object", + "description": "AAD Profile specifies attributes for Azure Active Directory integration.", + "properties": { + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + } + }, + "SecurityProfile": { + "type": "object", + "description": "Security Profile specifies attributes for cluster security features.", + "properties": { + "workloadIdentity": { + "type": "object", + "description": "The workload identity feature webhook.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable or disable the workload identity Webhook" + } + } + } + } + }, + "OidcIssuerProfile": { + "type": "object", + "description": "OIDC Issuer Profile specifies attributes for workload identity integration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable oidc issuer for workload identity integration." + }, + "issuerUrl": { + "type": "string", + "description": "The issuer url for hybrid clusters connected to Arc used for the workload identity feature.", + "readOnly": true + }, + "selfHostedIssuerUrl": { + "type": "string", + "description": "The issuer url for public cloud clusters - AKS, EKS, GKE - used for the workload identity feature." + } + } + }, + "ArcAgentProfile": { + "description": "Defines the Arc Agent properties for the clusters.", + "type": "object", + "properties": { + "desiredAgentVersion": { + "type": "string", + "description": "Version of the Arc agents to be installed on the cluster resource" + }, + "agentAutoUpgrade": { + "type": "string", + "description": "Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AutoUpgradeOptions", + "modelAsString": true + } + }, + "systemComponents": { + "type": "array", + "description": "List of system extensions that are installed on the cluster resource.", + "items": { + "$ref": "#/definitions/SystemComponent" + } + }, + "agentErrors": { + "type": "array", + "description": "List of arc agentry and system components errors on the cluster resource.", + "items": { + "$ref": "#/definitions/AgentError" + } + }, + "agentState": { + "type": "string", + "description": "Represents the current state of the Arc agentry and its dependent components.", + "readOnly": true + } + } + }, + "AgentError": { + "description": "Agent Errors if any during agent or system component upgrade.", + "type": "object", + "properties": { + "message": { + "type": "string", + "readOnly": true, + "description": "Agent error message." + }, + "severity": { + "type": "string", + "readOnly": true, + "description": "Severity of the error message." + }, + "component": { + "type": "string", + "readOnly": true, + "description": "Agent component where error message occured." + }, + "time": { + "format": "date-time", + "description": "The timestamp of error occured (UTC).", + "type": "string", + "readOnly": true + } + } + }, + "SystemComponent": { + "description": "System extensions and its current versions installed on the cluster resource.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the system extension" + }, + "userSpecifiedVersion": { + "type": "string", + "description": "Version of the system extension to be installed on the cluster resource." + }, + "majorVersion": { + "type": "integer", + "format": "int32", + "description": "Major Version of the system extension that is currently installed on the cluster resource." + }, + "currentVersion": { + "type": "string", + "readOnly": true, + "description": "Version of the system extension that is currently installed on the cluster resource." + } + } + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdBy": { + "description": "The identity that created the resource.", + "type": "string" + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string" + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string" + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of resource modification (UTC).", + "type": "string" + } + }, + "readOnly": true + }, + "ListClusterUserCredentialProperties": { + "type": "object", + "required": [ + "authenticationMethod", + "clientProxy" + ], + "properties": { + "authenticationMethod": { + "type": "string", + "description": "The mode of client authentication.", + "enum": [ + "Token", + "AAD" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "clientProxy": { + "type": "boolean", + "description": "Boolean value to indicate whether the request is for client side proxy or not" + } + }, + "description": "" + } + }, + "parameters": { + "ClusterNamePathParam": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Kubernetes cluster on which get is called.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json new file mode 100644 index 000000000000..0c0dffb481fc --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview", + "Properties": { + "authenticationMethod": "AAD", + "clientProxy": true + } + }, + "responses": { + "200": { + "body": { + "hybridConnectionConfig": { + "expirationTime": 1631196183, + "hybridConnectionName": "microsoft.kubernetes/connectedclusters/229dc73f7b07196c79a93d4362d9c7fc4ed34df3e95290d27c56cec2dbb82865/1631185383340987904", + "relay": "azgnrelay-ph0-l1", + "token": "SharedAccessSignature 123456789034675890pbduwegiavifkuw647o02423bbhfouseb" + }, + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json new file mode 100644 index 000000000000..57d71deaa7cb --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview", + "Properties": { + "authenticationMethod": "Token", + "clientProxy": true + } + }, + "responses": { + "200": { + "body": { + "hybridConnectionConfig": { + "expirationTime": 1631196183, + "hybridConnectionName": "microsoft.kubernetes/connectedclusters/229dc73f7b07196c79a93d4362d9c7fc4ed34df3e95290d27c56cec2dbb82865/1631185383340987904", + "relay": "azgnrelay-ph0-l1", + "token": "SharedAccessSignature 123456789034675890pbduwegiavifkuw647o02423bbhfouseb" + }, + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json new file mode 100644 index 000000000000..3cf22bb4204e --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview", + "Properties": { + "authenticationMethod": "AAD", + "clientProxy": false + } + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json new file mode 100644 index 000000000000..a46396c0298f --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview", + "Properties": { + "authenticationMethod": "Token", + "clientProxy": false + } + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateClusterExample.json new file mode 100644 index 000000000000..333a59e4015e --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateClusterExample.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview", + "ConnectedCluster": { + "location": "East US", + "tags": {}, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Succeeded", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Accepted", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable" + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateClusterPrivateLinkExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateClusterPrivateLinkExample.json new file mode 100644 index 000000000000..48f780b2f6d1 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateClusterPrivateLinkExample.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview", + "ConnectedCluster": { + "location": "East US", + "tags": {}, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Accepted", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateCluster_KindExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateCluster_KindExample.json new file mode 100644 index 000000000000..ffa549265729 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/CreateCluster_KindExample.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview", + "ConnectedCluster": { + "location": "East US", + "tags": {}, + "identity": { + "type": "SystemAssigned" + }, + "kind": "ProvisionedCluster", + "properties": { + "agentPublicKeyCertificate": "", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "oidcIssuerProfile": { + "enabled": true + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "majorVersion": 0 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "kind": "ProvisionedCluster", + "properties": { + "agentPublicKeyCertificate": "", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Succeeded", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "oidcIssuerProfile": { + "enabled": true, + "issuerUrl": "https://oidcdiscovery-northamerica-endpoint-gbcge4adgqebgxev.z01.azurefd.net/885hc665-0g4a-4a4b-732b-e4950new3bed/" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "agentState": "Succeeded", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0", + "majorVersion": 0 + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Accepted", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "oidcIssuerProfile": { + "enabled": true, + "issuerUrl": "https://oidcdiscovery-northamerica-endpoint-gbcge4adgqebgxev.z01.azurefd.net/885hc665-0g4a-4a4b-732b-e4950new3bed/" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "agentState": "Succeeded", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0", + "majorVersion": 0 + } + ] + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/DeleteClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/DeleteClusterExample.json new file mode 100644 index 000000000000..1bdae7aaa4eb --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/DeleteClusterExample.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.Kubernetes/locations/eastasia/operationStatuses/eb4c5b0b-35c7-4de9-8b9c-d51bf24dd729", + "Location": "https://management.azure.com/providers/Microsoft.Kubernetes/locations/eastasia/operationStatuses/eb4c5b0b-35c7-4de9-8b9c-d51bf24dd729*B31BD6830F326F0DAC6966963A274F89A70EDF802817A03F8CC944233B6E6C2E?api-version=2024-06-01-preview&t=638325565717977058&c=MIIHADCCBeigAwIBAgITHgMjMN6vpcEQg2_WbgAAAyMw3jANBgkqhkiG9w0BAQsFADBEMRMwEQYKCZImiZPyLGQBGRYDR0JMMRMwEQYKCZImiZPyLGQBGRYDQU1FMRgwFgYDVQQDEw9BTUUgSW5mcmEgQ0EgMDYwHhcNMjMwODAzMDczNjQzWhcNMjQwNzI4MDczNjQzWjBAMT4wPAYDVQQDEzVhc3luY29wZXJhdGlvbnNpZ25pbmdjZXJ0aWZpY2F0ZS5tYW5hZ2VtZW50LmF6dXJlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKtqtBNpyBDffqSjU2vKc-q1Ku3MtRBZR4VV9i6TdAcmNpVmw6W8QNgsa-z0zaqgCcjkLIFSUySU0_7_r4cjNFPDGVj0Y3gPDesFRunHaZsZoA2l235ZxgkOhmI9Eq_hgRKbBV-_zy1PbegjuigJTDOv4tC_xxRRMMioo273xgqG_kUrJVmb5EpU0OONBJtawx7E17himPHTOSCk6f__KaMY6z55v5motGTAEvs40N_pYLk36d4xWMWAfMSqoQu0fCiDTOBh9fXR1Mix28dh2is83JJOEmTls4gNVGZ4_gVn6DrVk-sPnD5sGs789lwzBSlRdpOoJMUnxOgMEgc_JB0CAwEAAaOCA-0wggPpMCcGCSsGAQQBgjcVCgQaMBgwCgYIKwYBBQUHAwEwCgYIKwYBBQUHAwIwPQYJKwYBBAGCNxUHBDAwLgYmKwYBBAGCNxUIhpDjDYTVtHiE8Ys-hZvdFs6dEoFggvX2K4Py0SACAWQCAQowggHLBggrBgEFBQcBAQSCAb0wggG5MGMGCCsGAQUFBzAChldodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpaW5mcmEvQ2VydHMvQkwyUEtJSU5UQ0EwMi5BTUUuR0JMX0FNRSUyMEluZnJhJTIwQ0ElMjAwNi5jcnQwUwYIKwYBBQUHMAKGR2h0dHA6Ly9jcmwxLmFtZS5nYmwvYWlhL0JMMlBLSUlOVENBMDIuQU1FLkdCTF9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3J0MFMGCCsGAQUFBzAChkdodHRwOi8vY3JsMi5hbWUuZ2JsL2FpYS9CTDJQS0lJTlRDQTAyLkFNRS5HQkxfQU1FJTIwSW5mcmElMjBDQSUyMDA2LmNydDBTBggrBgEFBQcwAoZHaHR0cDovL2NybDMuYW1lLmdibC9haWEvQkwyUEtJSU5UQ0EwMi5BTUUuR0JMX0FNRSUyMEluZnJhJTIwQ0ElMjAwNi5jcnQwUwYIKwYBBQUHMAKGR2h0dHA6Ly9jcmw0LmFtZS5nYmwvYWlhL0JMMlBLSUlOVENBMDIuQU1FLkdCTF9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3J0MB0GA1UdDgQWBBQQBQ6aI7w4CwOrsQOypzq30e50CDAOBgNVHQ8BAf8EBAMCBaAwggEmBgNVHR8EggEdMIIBGTCCARWgggERoIIBDYY_aHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraWluZnJhL0NSTC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsMS5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsMi5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsMy5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsNC5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JsMBcGA1UdIAQQMA4wDAYKKwYBBAGCN3sBATAfBgNVHSMEGDAWgBTxRmjG8cPwKy19i2rhsvm-NfzRQTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAD5C_x4drGztlnmLaCdpAyL9KN3LkK_sr-VeDz0s3SwQ30lixsYUUfohjlbSqgoq5GW7WmEgMVuyHCv3nUc01REq-CK7A2xlhD68sfOKqXdpPFsjDCyVEFxuigozWoM3jh9ffTPLM-0cuvpIUH3sOooWAL0Y2RpShpYCxzE7ufkpuFvrs0SPvDNxn7Ga6gYdqvqXsGni-J8I4mQ5sPmZa23Nqq3RDpkYkMunjIJkX7_3p-mX4Wcnm5j93_oLnn7WRkjMF3gwwCcJGn_2yLAeVeJ8E4TNZA2_mfmwo7zGwRDV0VT4JM6evNGxDXVG9XG3hdGlZaoe_TTL5yyWR4CmM2A&s=oBCOqB7wr6rL3h0KEYh91fsSQOpjJEXV_-trbTwQJpxCgOFmN7OStVj0qiAoxRrAIJtCZHCDQnA_JjawmDlVQM7kkXVg9mg3GSG0ucDBu-G8dqYoEoS7dQu_1GKrEpyzQXCPZ4J9QZy1wDh5MmwftdAqyJ3XjTa5AFHlmnjJJiOQ0NAp4sM94-f5_Ru5ycMUdfjItDz_JjOjzSjsl6HSWMHdjvcqGUmbc7onurDb54T5hpNuioO3ex3YH7NdKP18-i66CsOx2MfidCgL6GGOw-KcVH89BPzXY8nxVqnCE54sc0EAjoyz0FU2pESjdrvJutP4c9HJc2rCJjLkxhujCQ&h=e_aACIZc0Bg5Zoog38uTxuuAtK2U6Zd6X45h4sVfHnM" + } + }, + "204": {} + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClusterExample.json new file mode 100644 index 000000000000..ee3e9fb68b6c --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClusterExample.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-12-17T07:14:58.865041Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + }, + "securityProfile": { + "workloadIdentity": { + "enabled": true + } + }, + "oidcIssuerProfile": { + "enabled": true, + "issuerUrl": "https://oidcdiscovery-northamerica-endpoint-gbcge4adgqebgxev.z01.azurefd.net/885hc665-0g4a-4a4b-732b-e4950new3bed/" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "agentState": "Failed", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0" + } + ], + "agentErrors": [ + { + "message": "Upgrade failed for agent extension Strato, version not found", + "severity": "Error", + "component": "Strato", + "time": "2020-12-17T07:14:58.865041Z" + } + ] + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClustersByResourceGroupExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClustersByResourceGroupExample.json new file mode 100644 index 000000000000..c1f628e40568 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClustersByResourceGroupExample.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + }, + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "XIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.1", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClustersBySubscriptionExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClustersBySubscriptionExample.json new file mode 100644 index 000000000000..cf00b220a68d --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetClustersBySubscriptionExample.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + }, + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster2", + "name": "connectedCluster2", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "XIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.16.3", + "totalNodeCount": 4, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetProvisionedClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetProvisionedClusterExample.json new file mode 100644 index 000000000000..a9ae0c461da3 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/GetProvisionedClusterExample.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-12-17T07:14:58.865041Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "ProvisionedCluster", + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "agentState": "Succeeded", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0", + "majorVersion": 0 + } + ] + }, + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ListConnectedClusterOperationsExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ListConnectedClusterOperationsExample.json new file mode 100644 index 000000000000..3809efca37ef --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/ListConnectedClusterOperationsExample.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Kubernetes/connectedClusters/write", + "display": { + "provider": "Microsoft.connectedClusters", + "resource": "connectedClusters", + "operation": "Create ConnectedCluster", + "description": "Create any ConnectedCluster" + } + }, + { + "name": "Microsoft.Kubernetes/connectedClusters/read", + "display": { + "provider": "Microsoft.Kubernetes", + "resource": "connectedClusters", + "operation": "Get ConnectedCluster", + "description": "Get any ConnectedCluster" + } + }, + { + "name": "Microsoft.Kubernetes/connectedClusters/delete", + "display": { + "provider": "Microsoft.Kubernetes", + "resource": "connectedClusters", + "operation": "Delete ConnectedCluster", + "description": "Delete any ConnectedCluster" + } + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/UpdateClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/UpdateClusterExample.json new file mode 100644 index 000000000000..61cb437453f7 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-06-01-preview/examples/UpdateClusterExample.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "ConnectedClusterPatch": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-12-17T07:14:58.865041Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/readme.md b/specification/hybridkubernetes/resource-manager/readme.md index 2d43e396759f..ec1567f476d2 100644 --- a/specification/hybridkubernetes/resource-manager/readme.md +++ b/specification/hybridkubernetes/resource-manager/readme.md @@ -30,6 +30,14 @@ openapi-subtype: rpaas tag: package-2024-01 ``` +### Tag: package-preview-2024-06-01 + +These settings apply only when `--tag=package-preview-2024-06-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-06-01' +input-file: + - Microsoft.Kubernetes/preview/2024-06-01-preview/connectedClusters.json +``` ### Tag: package-preview-2024-02-01 diff --git a/specification/hybridkubernetes/resource-manager/sdk-suppressions.yaml b/specification/hybridkubernetes/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..76fb39393581 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,9 @@ +suppressions: + azure-sdk-for-python: + - package: azure-mgmt-hybridkubernetes + breaking-changes: + - Model ConnectedClusterPatch no longer has parameter properties + azure-sdk-for-go: + - package: sdk/resourcemanager/hybridkubernetes/armhybridkubernetes + breaking-changes: + - Type of `ConnectedClusterPatch.Properties` has been changed from `any` to `*ConnectedClusterPatchProperties` \ No newline at end of file From 7d5a68d0c3a5d1a1054f64240255d45516886887 Mon Sep 17 00:00:00 2001 From: Han Chiang Date: Tue, 18 Jun 2024 09:37:19 +0800 Subject: [PATCH 188/343] Update detection description (#29457) --- specification/ai/Face/routes.detection.tsp | 2 +- .../ai/data-plane/Face/preview/v1.1-preview.1/Face.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/ai/Face/routes.detection.tsp b/specification/ai/Face/routes.detection.tsp index c338620c3972..18a54399cfb8 100644 --- a/specification/ai/Face/routes.detection.tsp +++ b/specification/ai/Face/routes.detection.tsp @@ -16,7 +16,7 @@ namespace Face; @summary("Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.") @doc(""" > [!IMPORTANT] - > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. + > Microsoft has retired or restricted facial recognition capabilities that can be used to try to infer emotional states and identity attributes which, if misused, can subject people to stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email Azure Face API if you have a responsible use case that would benefit from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. * * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. diff --git a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json index e24dd4411b38..7f17cd879a5f 100644 --- a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json +++ b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json @@ -88,7 +88,7 @@ "post": { "operationId": "FaceDetectionOperations_DetectFromUrl", "summary": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.", - "description": "> [!IMPORTANT]\n> To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.\n\n*\n * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.\n * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.\n * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model\n * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.\n * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.\n * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.", + "description": "> [!IMPORTANT]\n> Microsoft has retired or restricted facial recognition capabilities that can be used to try to infer emotional states and identity attributes which, if misused, can subject people to stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email Azure Face API if you have a responsible use case that would benefit from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.\n\n*\n * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.\n * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.\n * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model\n * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.\n * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.\n * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.", "parameters": [ { "name": "detectionModel", @@ -5584,7 +5584,7 @@ "post": { "operationId": "FaceDetectionOperations_Detect", "summary": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.", - "description": "> [!IMPORTANT]\n> To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.\n\n*\n * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.\n * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.\n * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model\n * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.\n * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.\n * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.", + "description": "> [!IMPORTANT]\n> Microsoft has retired or restricted facial recognition capabilities that can be used to try to infer emotional states and identity attributes which, if misused, can subject people to stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email Azure Face API if you have a responsible use case that would benefit from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.\n\n*\n * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.\n * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.\n * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model\n * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.\n * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.\n * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.", "consumes": [ "application/octet-stream" ], From 641b67953d0c3307073699390cd536f8272ae9a2 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Tue, 18 Jun 2024 10:16:26 +0800 Subject: [PATCH 189/343] [AppComplianceAutomation] update python config (#29455) * appcomplianceautomation--tsp * client.tsp format --- .../AppComplianceAutomation.Management/client.tsp | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/client.tsp diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/client.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/client.tsp new file mode 100644 index 000000000000..745941d727e8 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/client.tsp @@ -0,0 +1,9 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.AppComplianceAutomation, + "AppComplianceAutomationMgmt", + "python" +); From ba1f6b2c72383085ddcbadfc2d43437d70e310b4 Mon Sep 17 00:00:00 2001 From: Mitesh Shah <58204159+mitsha-microsoft@users.noreply.github.com> Date: Tue, 18 Jun 2024 11:02:58 +0530 Subject: [PATCH 190/343] [Azure Load Testing] Updated FileType.URL_TEST_CONFIG_JSON to FileType.URL_TEST_CONFIG (#29467) Updated FileType.URL_TEST_CONFIG_JSON to FileType.URL_TEST_CONFIG --- .../loadtestservice/LoadTestService/models.tsp | 2 +- .../preview/2023-04-01-preview/loadtestservice.json | 12 ++++++------ .../preview/2024-03-01-preview/loadtestservice.json | 12 ++++++------ .../preview/2024-05-01-preview/loadtestservice.json | 12 ++++++------ 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/specification/loadtestservice/LoadTestService/models.tsp b/specification/loadtestservice/LoadTestService/models.tsp index ff3c12a76d6b..5f1ccb5d57ba 100644 --- a/specification/loadtestservice/LoadTestService/models.tsp +++ b/specification/loadtestservice/LoadTestService/models.tsp @@ -115,7 +115,7 @@ union FileType { @added(APIVersions.v2023_04_01_preview) @doc("If the file is a JSON config file to define the requests for a URL test.") - "URL_TEST_CONFIG_JSON", + "URL_TEST_CONFIG", @added(APIVersions.v2024_03_01_preview) @doc("If the file is a test script.") diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json index 08bcf224b376..913e64089223 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json @@ -1370,7 +1370,7 @@ "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", - "URL_TEST_CONFIG_JSON" + "URL_TEST_CONFIG" ], "x-ms-enum": { "name": "FileType", @@ -1397,8 +1397,8 @@ "description": "If the file is a compressed archive containing a collection of various artifacts or resources." }, { - "name": "URL_TEST_CONFIG_JSON", - "value": "URL_TEST_CONFIG_JSON", + "name": "URL_TEST_CONFIG", + "value": "URL_TEST_CONFIG", "description": "If the file is a JSON config file to define the requests for a URL test." } ] @@ -1981,7 +1981,7 @@ "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", - "URL_TEST_CONFIG_JSON" + "URL_TEST_CONFIG" ], "x-ms-enum": { "name": "FileType", @@ -2008,8 +2008,8 @@ "description": "If the file is a compressed archive containing a collection of various artifacts or resources." }, { - "name": "URL_TEST_CONFIG_JSON", - "value": "URL_TEST_CONFIG_JSON", + "name": "URL_TEST_CONFIG", + "value": "URL_TEST_CONFIG", "description": "If the file is a JSON config file to define the requests for a URL test." } ] diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json index 5e656fd95357..f88f86bd0645 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json @@ -1370,7 +1370,7 @@ "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", - "URL_TEST_CONFIG_JSON", + "URL_TEST_CONFIG", "TEST_SCRIPT" ], "x-ms-enum": { @@ -1398,8 +1398,8 @@ "description": "If the file is a compressed archive containing a collection of various artifacts or resources." }, { - "name": "URL_TEST_CONFIG_JSON", - "value": "URL_TEST_CONFIG_JSON", + "name": "URL_TEST_CONFIG", + "value": "URL_TEST_CONFIG", "description": "If the file is a JSON config file to define the requests for a URL test." }, { @@ -1987,7 +1987,7 @@ "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", - "URL_TEST_CONFIG_JSON", + "URL_TEST_CONFIG", "TEST_SCRIPT" ], "x-ms-enum": { @@ -2015,8 +2015,8 @@ "description": "If the file is a compressed archive containing a collection of various artifacts or resources." }, { - "name": "URL_TEST_CONFIG_JSON", - "value": "URL_TEST_CONFIG_JSON", + "name": "URL_TEST_CONFIG", + "value": "URL_TEST_CONFIG", "description": "If the file is a JSON config file to define the requests for a URL test." }, { diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json index dd697dbd9d33..b0cdb8ed7c12 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json @@ -1884,7 +1884,7 @@ "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", - "URL_TEST_CONFIG_JSON", + "URL_TEST_CONFIG", "TEST_SCRIPT" ], "x-ms-enum": { @@ -1912,8 +1912,8 @@ "description": "If the file is a compressed archive containing a collection of various artifacts or resources." }, { - "name": "URL_TEST_CONFIG_JSON", - "value": "URL_TEST_CONFIG_JSON", + "name": "URL_TEST_CONFIG", + "value": "URL_TEST_CONFIG", "description": "If the file is a JSON config file to define the requests for a URL test." }, { @@ -2537,7 +2537,7 @@ "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", - "URL_TEST_CONFIG_JSON", + "URL_TEST_CONFIG", "TEST_SCRIPT" ], "x-ms-enum": { @@ -2565,8 +2565,8 @@ "description": "If the file is a compressed archive containing a collection of various artifacts or resources." }, { - "name": "URL_TEST_CONFIG_JSON", - "value": "URL_TEST_CONFIG_JSON", + "name": "URL_TEST_CONFIG", + "value": "URL_TEST_CONFIG", "description": "If the file is a JSON config file to define the requests for a URL test." }, { From 51cbd0e070cbbe29abbef09b29066f0bace78527 Mon Sep 17 00:00:00 2001 From: Sahil Arora Date: Mon, 17 Jun 2024 23:10:21 -0700 Subject: [PATCH 191/343] Fix foundation types in azure fleet (#29477) * fix foundation types in azure fleet * Update readme.md --------- Co-authored-by: Sahil Arora Co-authored-by: Yuchao Yan --- specification/azurefleet/AzureFleet.Management/fleet.tsp | 4 ++-- .../preview/2023-11-01-preview/azurefleet.json | 9 +++++---- .../preview/2024-05-01-preview/azurefleet.json | 9 +++++---- specification/azurefleet/resource-manager/readme.md | 2 +- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/specification/azurefleet/AzureFleet.Management/fleet.tsp b/specification/azurefleet/AzureFleet.Management/fleet.tsp index d3760b3cde01..f1c124a7cac3 100644 --- a/specification/azurefleet/AzureFleet.Management/fleet.tsp +++ b/specification/azurefleet/AzureFleet.Management/fleet.tsp @@ -46,10 +46,10 @@ model FleetUpdate { } model ManagedServiceIdentityUpdate - is OptionalProperties>; + is OptionalProperties>; model ResourcePlanUpdate - is OptionalProperties>; + is OptionalProperties>; @doc("The status of the current operation.") @Azure.Core.lroStatus diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json index 7ea6f4dabd42..3a7a0582b6b8 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json @@ -486,14 +486,14 @@ } }, "definitions": { - "Azure.ResourceManager.Legacy.ManagedServiceIdentityType": { + "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType": { "type": "string", "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "enum": [ "None", "SystemAssigned", "UserAssigned", - "SystemAssigned, UserAssigned" + "SystemAssigned,UserAssigned" ], "x-ms-enum": { "name": "ManagedServiceIdentityType", @@ -516,7 +516,7 @@ }, { "name": "SystemAndUserAssigned", - "value": "SystemAssigned, UserAssigned", + "value": "SystemAssigned,UserAssigned", "description": "System and user assigned managed identity." } ] @@ -738,12 +738,13 @@ "description": "The template for adding optional properties.", "properties": { "type": { - "$ref": "#/definitions/Azure.ResourceManager.Legacy.ManagedServiceIdentityType", + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType", "description": "The type of managed identity assigned to this resource." }, "userAssignedIdentities": { "type": "object", "description": "The identities assigned to this resource by the user.", + "x-nullable": true, "additionalProperties": { "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json index d23085838d30..fe99e2db4dc9 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json @@ -465,14 +465,14 @@ } }, "definitions": { - "Azure.ResourceManager.Legacy.ManagedServiceIdentityType": { + "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType": { "type": "string", "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "enum": [ "None", "SystemAssigned", "UserAssigned", - "SystemAssigned, UserAssigned" + "SystemAssigned,UserAssigned" ], "x-ms-enum": { "name": "ManagedServiceIdentityType", @@ -495,7 +495,7 @@ }, { "name": "SystemAndUserAssigned", - "value": "SystemAssigned, UserAssigned", + "value": "SystemAssigned,UserAssigned", "description": "System and user assigned managed identity." } ] @@ -727,12 +727,13 @@ "description": "The template for adding optional properties.", "properties": { "type": { - "$ref": "#/definitions/Azure.ResourceManager.Legacy.ManagedServiceIdentityType", + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType", "description": "The type of managed identity assigned to this resource." }, "userAssignedIdentities": { "type": "object", "description": "The identities assigned to this resource by the user.", + "x-nullable": true, "additionalProperties": { "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" } diff --git a/specification/azurefleet/resource-manager/readme.md b/specification/azurefleet/resource-manager/readme.md index 52c0e08b17be..d3f91ed2ee8c 100644 --- a/specification/azurefleet/resource-manager/readme.md +++ b/specification/azurefleet/resource-manager/readme.md @@ -63,7 +63,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net-track2 - - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js From dde5c5c698e882c9de24e9c02f178e2a60fded63 Mon Sep 17 00:00:00 2001 From: Pooja Shetty <85922721+poshett@users.noreply.github.com> Date: Tue, 18 Jun 2024 11:43:22 +0530 Subject: [PATCH 192/343] Adding new version "2024-06-15-preview" in Microsoft.Elastic with Resubscribe API (#29377) * Base API Commit * Changing API version to 2024-06-15-preview * Adding Resubscribe API * Updating readme.md * Updating summary * Updating tag * Updating example name * Prettier check fix * Adding LRO support for monitors update and resubscribe APIs * Fixing LintDiff * Fixing ModelValidation * Fixing LintDiff * LintDiff fix * Adding ResourceProviderDefaultErrorResponseV6 * Prettier fix * Changing v6 error response name * Revert "Changing v6 error response name" This reverts commit 1e43182606786cc5ee836a4d42d34910a202af0f. * Revert "Prettier fix" This reverts commit b2acd89598fc2b1f9a67e605d2e44e7cd6934cd8. * Revert "Adding ResourceProviderDefaultErrorResponseV6" This reverts commit 8a7d7057387cdd0d266b8378c1f33f94b4c163dc. * Adding v5 error response reference * Adding publisher and offer ids in Connected resources API response --- .../preview/2024-06-15-preview/elastic.json | 3659 +++++++++++++++++ .../examples/AllTrafficFilters_list.json | 36 + .../AssociateTrafficFilter_Update.json | 16 + .../AssociatedFiltersForDeployment_list.json | 36 + .../examples/BillingInfo_Get.json | 29 + .../ConnectedPartnerResources_List.json | 24 + .../examples/DeploymentInfo_List.json | 28 + .../DetachAndDeleteTrafficFilter_Delete.json | 12 + .../examples/DetachTrafficFilters_Update.json | 16 + .../examples/ElasticVersions_List.json | 20 + .../examples/ExternalUserInfo.json | 25 + .../examples/IPTrafficFilter_Create.json | 18 + .../examples/Monitor_Upgrade.json | 18 + .../examples/MonitoredResources_List.json | 21 + ...MonitoredSubscriptions_CreateorUpdate.json | 152 + .../MonitoredSubscriptions_Delete.json | 17 + .../examples/MonitoredSubscriptions_Get.json | 60 + .../examples/MonitoredSubscriptions_List.json | 64 + .../MonitoredSubscriptions_Update.json | 108 + .../examples/Monitors_Create.json | 115 + .../examples/Monitors_Delete.json | 17 + .../examples/Monitors_Get.json | 43 + .../examples/Monitors_List.json | 45 + .../Monitors_ListByResourceGroup.json | 46 + .../examples/Monitors_Update.json | 125 + .../examples/OpenAI_CreateOrUpdate.json | 44 + .../examples/OpenAI_Delete.json | 13 + .../examples/OpenAI_Get.json | 24 + .../examples/OpenAI_GetStatus.json | 18 + .../examples/OpenAI_List.json | 27 + .../examples/Operations_List.json | 23 + .../examples/Organizations_GetApiKey.json | 18 + ..._GetElasticToAzureSubscriptionMapping.json | 25 + .../examples/Organizations_Resubscribe.json | 22 + .../PrivateLinkTrafficFilters_Create.json | 19 + .../examples/TagRules_CreateOrUpdate.json | 59 + .../examples/TagRules_Delete.json | 18 + .../examples/TagRules_Get.json | 38 + .../examples/TagRules_List.json | 41 + .../examples/TrafficFilters_Delete.json | 12 + .../examples/UpgradableVersions_Details.json | 19 + .../examples/VMCollection_Update.json | 15 + .../examples/VMHost_List.json | 19 + .../examples/VMIngestion_Details.json | 16 + .../elastic/resource-manager/readme.md | 11 +- 45 files changed, 5230 insertions(+), 1 deletion(-) create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/elastic.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AllTrafficFilters_list.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AssociateTrafficFilter_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AssociatedFiltersForDeployment_list.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/BillingInfo_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ConnectedPartnerResources_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DeploymentInfo_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DetachAndDeleteTrafficFilter_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DetachTrafficFilters_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ElasticVersions_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ExternalUserInfo.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/IPTrafficFilter_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitor_Upgrade.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredResources_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_CreateorUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_ListByResourceGroup.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_CreateOrUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_GetStatus.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Operations_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_GetApiKey.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_Resubscribe.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/PrivateLinkTrafficFilters_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_CreateOrUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TrafficFilters_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/UpgradableVersions_Details.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMCollection_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMHost_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMIngestion_Details.json diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/elastic.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/elastic.json new file mode 100644 index 000000000000..2b598edbc5ae --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/elastic.json @@ -0,0 +1,3659 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Elastic", + "version": "2024-06-15-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Microsoft Entra ID OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Elastic/operations": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all operations provided by Microsoft.Elastic.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified subscription.", + "operationId": "Monitors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_List": { + "$ref": "./examples/Monitors_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/elasticVersions": { + "get": { + "tags": [ + "ElasticVersions" + ], + "summary": "Get a list of available versions for a region.", + "operationId": "ElasticVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "query", + "name": "region", + "description": "Region where elastic deployment will take place.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticVersionsListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticVersions_List": { + "$ref": "./examples/ElasticVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified resource group.", + "operationId": "Monitors_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup": { + "$ref": "./examples/Monitors_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "Get the properties of a specific monitor resource.", + "operationId": "Monitors_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get": { + "$ref": "./examples/Monitors_Get.json" + } + } + }, + "put": { + "tags": [ + "MonitorsResource" + ], + "summary": "Create a monitor resource.", + "operationId": "Monitors_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic monitor resource model", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Monitors_Create": { + "$ref": "./examples/Monitors_Create.json" + } + } + }, + "patch": { + "tags": [ + "MonitorsResource" + ], + "summary": "Update a monitor resource.", + "operationId": "Monitors_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic resource model update parameters.", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Monitors_Update": { + "$ref": "./examples/Monitors_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitorsResource" + ], + "summary": "Delete a monitor resource.", + "operationId": "Monitors_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_Delete": { + "$ref": "./examples/Monitors_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List all the subscriptions currently being monitored by the Elastic monitor resource.", + "operationId": "MonitoredSubscriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List all the subscriptions currently being monitored by the Elastic monitor resource.", + "operationId": "MonitoredSubscriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "Add the subscriptions that should be monitored by the Elastic monitor resource.", + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_AddMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_CreateorUpdate.json" + } + } + }, + "patch": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Elastic monitor resource", + "operationId": "MonitoredSubscriptions_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_UpdateMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Elastic monitor resource", + "operationId": "MonitoredSubscriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_DeleteMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listMonitoredResources": { + "post": { + "tags": [ + "MonitoredResources" + ], + "summary": "List the resources currently being monitored by the Elastic monitor resource.", + "operationId": "MonitoredResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MonitoredResources_List": { + "$ref": "./examples/MonitoredResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listDeploymentInfo": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource.", + "operationId": "DeploymentInfo_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DeploymentInfo_List": { + "$ref": "./examples/DeploymentInfo_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createOrUpdateExternalUser": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Create User inside elastic deployment which are used by customers to perform operations on the elastic deployment", + "operationId": "ExternalUser_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic External User Creation Parameters", + "schema": { + "$ref": "#/definitions/ExternalUserInfo" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExternalUserCreationResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalUser_CreateOrUpdate": { + "$ref": "./examples/ExternalUserInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace and organization info mapped to the given monitor.", + "operationId": "BillingInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listConnectedPartnerResources": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", + "operationId": "ConnectedPartnerResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectedPartnerResources_List": { + "$ref": "./examples/ConnectedPartnerResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations": { + "get": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "List OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModelListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OpenAI_List": { + "$ref": "./examples/OpenAI_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}": { + "get": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Get OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_Get": { + "$ref": "./examples/OpenAI_Get.json" + } + } + }, + "put": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Create or update a OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_CreateOrUpdate": { + "$ref": "./examples/OpenAI_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Delete OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_Delete": { + "$ref": "./examples/OpenAI_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}/getStatus": { + "post": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Get OpenAI integration status for a given integration.", + "operationId": "OpenAI_GetStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationStatusResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_GetStatus": { + "$ref": "./examples/OpenAI_GetStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "Rules" + ], + "summary": "List the tag rules for a given monitor resource.", + "operationId": "TagRules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRulesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_List": { + "$ref": "./examples/TagRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules/{ruleSetName}": { + "put": { + "tags": [ + "Rules" + ], + "summary": "Create or update a tag rule set for a given monitor resource.", + "operationId": "TagRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + }, + { + "description": "request body of MonitoringTagRules", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate": { + "$ref": "./examples/TagRules_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Rules" + ], + "summary": "Get a tag rule set for a given monitor resource.", + "operationId": "TagRules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get": { + "$ref": "./examples/TagRules_Get.json" + } + } + }, + "delete": { + "tags": [ + "Rules" + ], + "summary": "Delete a tag rule set for a given monitor resource.", + "operationId": "TagRules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TagRules_Delete": { + "$ref": "./examples/TagRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listVMHost": { + "post": { + "tags": [ + "VMHHostList" + ], + "summary": "List the vm resources currently being monitored by the Elastic monitor resource.", + "operationId": "VMHost_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMHostListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VMHost_List": { + "$ref": "./examples/VMHost_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmIngestionDetails": { + "post": { + "tags": [ + "VMIngestionDetails" + ], + "summary": "List the vm ingestion details that will be monitored by the Elastic monitor resource.", + "operationId": "VMIngestion_Details", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMIngestionDetailsResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMIngestion_Details": { + "$ref": "./examples/VMIngestion_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmCollectionUpdate": { + "post": { + "tags": [ + "VMCollectionUpdate" + ], + "summary": "Update the vm details that will be monitored by the Elastic monitor resource.", + "operationId": "VMCollection_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "VM resource Id", + "schema": { + "$ref": "#/definitions/VMCollectionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMCollection_Update": { + "$ref": "./examples/VMCollection_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listUpgradableVersions": { + "post": { + "tags": [ + "MonitorUpgradableVersions" + ], + "summary": "List of upgradable versions for a given monitor resource.", + "operationId": "UpgradableVersions_Details", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UpgradableVersionsList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "UpgradableVersions_Details": { + "$ref": "./examples/UpgradableVersions_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/upgrade": { + "post": { + "tags": [ + "DeploymentUpdate" + ], + "summary": "Upgradable version for a monitor resource.", + "operationId": "Monitor_Upgrade", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic Monitor Upgrade Parameters", + "schema": { + "$ref": "#/definitions/ElasticMonitorUpgrade" + } + } + ], + "responses": { + "202": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitor_Upgrade": { + "$ref": "./examples/Monitor_Upgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAllTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all traffic filters for the account.", + "operationId": "AllTrafficFilters_list", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "AllTrafficFilters_list": { + "$ref": "./examples/AllTrafficFilters_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAssociatedTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all associated traffic filters for the given deployment.", + "operationId": "listAssociatedTrafficFilters_list", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "listAssociatedTrafficFilters_list": { + "$ref": "./examples/AssociatedFiltersForDeployment_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociateIPFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate IP traffic filter for the given deployment.", + "operationId": "createAndAssociateIPFilter_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "ips", + "description": "List of ips", + "type": "string" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociateIPFilter_Create": { + "$ref": "./examples/IPTrafficFilter_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociatePLFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate private link traffic filter for the given deployment.", + "operationId": "createAndAssociatePLFilter_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointGuid", + "description": "Guid of the private endpoint", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointName", + "description": "Name of the private endpoint", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociatePLFilter_Create": { + "$ref": "./examples/PrivateLinkTrafficFilters_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/associateTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Associate traffic filter for the given deployment.", + "operationId": "AssociateTrafficFilter_Associate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "AssociateTrafficFilter_Associate": { + "$ref": "./examples/AssociateTrafficFilter_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachAndDeleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach and Delete traffic filter from the given deployment.", + "operationId": "DetachAndDeleteTrafficFilter_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DetachAndDeleteTrafficFilter_Delete": { + "$ref": "./examples/DetachAndDeleteTrafficFilter_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach traffic filter for the given deployment.", + "operationId": "DetachTrafficFilter_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "DetachTrafficFilter_Update": { + "$ref": "./examples/DetachTrafficFilters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/deleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Delete traffic filter from the account.", + "operationId": "TrafficFilters_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TrafficFilters_Delete": { + "$ref": "./examples/TrafficFilters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getOrganizationApiKey": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "description": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "operationId": "Organizations_GetApiKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "body", + "name": "body", + "description": "Email Id parameter of the User Organization, of which the API Key must be returned", + "schema": { + "$ref": "#/definitions/UserEmailId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UserApiKeyResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetApiKey": { + "$ref": "./examples/Organizations_GetApiKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getElasticOrganizationToAzureSubscriptionMapping": { + "post": { + "tags": [ + "UserOrganization" + ], + "summary": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "description": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "operationId": "Organizations_GetElasticToAzureSubscriptionMapping", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetElasticToAzureSubscriptionMapping": { + "$ref": "./examples/Organizations_GetElasticToAzureSubscriptionMapping.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/resubscribe": { + "post": { + "tags": [ + "Resubscribe" + ], + "summary": "Resubscribe the Elasticsearch Organization.", + "operationId": "Organizations_Resubscribe", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Resubscribe Properties", + "schema": { + "$ref": "#/definitions/ResubscribeProperties" + } + } + ], + "responses": { + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Organizations_Resubscribe": { + "$ref": "./examples/Organizations_Resubscribe.json" + } + } + } + } + }, + "definitions": { + "ErrorResponseBody": { + "description": "Error response body.", + "title": "ErrorResponseBody", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Error target.", + "type": "string" + }, + "details": { + "description": "Error details.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + } + }, + "ResourceProviderDefaultErrorResponse": { + "description": "RP default error response.", + "type": "object", + "properties": { + "error": { + "description": "Response body of Error", + "readOnly": true, + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider, i.e., Microsoft.Elastic.", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'monitors'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write monitors'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A Microsoft.Elastic REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name, i.e., {provider}/{resource}/{operation}.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list the Microsoft.Elastic operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Microsoft.Elastic provider.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "Microsoft.Elastic SKU.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU.", + "type": "string" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "description": "Provisioning state of Elastic resource.", + "title": "ProvisioningState", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + }, + "readOnly": true + }, + "MonitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MonitoringStatus" + } + }, + "ElasticCloudUser": { + "description": "Details of the user's elastic account.", + "type": "object", + "properties": { + "emailAddress": { + "description": "Email of the Elastic User Account.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "User Id of the elastic account of the User.", + "type": "string", + "readOnly": true + }, + "elasticCloudSsoDefaultUrl": { + "description": "Elastic cloud default dashboard sso URL of the Elastic user account.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticCloudDeployment": { + "description": "Details of the user's elastic deployment associated with the monitor resource.", + "type": "object", + "properties": { + "name": { + "description": "Elastic deployment name", + "type": "string", + "readOnly": true + }, + "deploymentId": { + "description": "Elastic deployment Id", + "type": "string", + "readOnly": true + }, + "azureSubscriptionId": { + "description": "Associated Azure subscription Id for the elastic deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchRegion": { + "description": "Region where Deployment at Elastic side took place.", + "type": "string", + "readOnly": true + }, + "elasticsearchServiceUrl": { + "description": "Elasticsearch ingestion endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaServiceUrl": { + "description": "Kibana endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaSsoUrl": { + "description": "Kibana dashboard sso URL of the Elastic deployment.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticProperties": { + "description": "Elastic Resource Properties.", + "type": "object", + "properties": { + "elasticCloudUser": { + "description": "Details of the user's elastic account.", + "$ref": "#/definitions/ElasticCloudUser" + }, + "elasticCloudDeployment": { + "description": "Details of the elastic cloud deployment.", + "$ref": "#/definitions/ElasticCloudDeployment" + } + } + }, + "CompanyInfo": { + "description": "Company information of the user to be passed to partners.", + "type": "object", + "properties": { + "domain": { + "description": "Domain of the company", + "maxLength": 250, + "type": "string" + }, + "business": { + "description": "Business of the company", + "maxLength": 64, + "type": "string" + }, + "employeesNumber": { + "description": "Number of employees in the company", + "maxLength": 20, + "type": "string" + }, + "state": { + "description": "State of the company location.", + "maxLength": 64, + "type": "string" + }, + "country": { + "description": "Country of the company location.", + "maxLength": 64, + "type": "string" + } + } + }, + "UserInfo": { + "description": "User Information to be passed to partners.", + "type": "object", + "properties": { + "firstName": { + "description": "First name of the user", + "maxLength": 50, + "type": "string" + }, + "lastName": { + "description": "Last name of the user", + "maxLength": 50, + "type": "string" + }, + "companyName": { + "description": "Company name of the user", + "maxLength": 64, + "type": "string" + }, + "emailAddress": { + "description": "Email of the user used by Elastic for contacting them if needed", + "pattern": "^([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)@(([a-zA-Z-_0-9]+\\.)+[a-zA-Z]{2,})$", + "type": "string" + }, + "companyInfo": { + "description": "Company information of the user to be passed to partners.", + "$ref": "#/definitions/CompanyInfo" + } + } + }, + "PlanDetails": { + "description": "Plan details of the monitor resource.", + "type": "object", + "properties": { + "offerID": { + "description": "Offer ID of the plan", + "type": "string" + }, + "publisherID": { + "description": "Publisher ID of the plan", + "type": "string" + }, + "termID": { + "description": "Term ID of the plan", + "type": "string" + }, + "planID": { + "description": "Plan ID", + "type": "string" + }, + "planName": { + "description": "Plan Name", + "type": "string" + } + } + }, + "LiftrResourceCategories": { + "enum": [ + "Unknown", + "MonitorLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "LiftrResourceCategories" + }, + "readOnly": true + }, + "MonitorProperties": { + "description": "Properties specific to the monitor resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitor resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "monitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "$ref": "#/definitions/MonitoringStatus" + }, + "elasticProperties": { + "description": "Elastic cloud properties.", + "$ref": "#/definitions/ElasticProperties" + }, + "userInfo": { + "description": "User information.", + "$ref": "#/definitions/UserInfo", + "x-ms-mutability": [ + "create" + ] + }, + "planDetails": { + "description": "Plan details of the monitor resource.", + "$ref": "#/definitions/PlanDetails" + }, + "version": { + "description": "Version of elastic of the monitor resource", + "type": "string" + }, + "subscriptionState": { + "description": "State of the Azure Subscription containing the monitor resource", + "type": "string" + }, + "saaSAzureSubscriptionStatus": { + "description": "Status of Azure Subscription where Marketplace SaaS is located.", + "type": "string" + }, + "sourceCampaignName": { + "description": "Name of the marketing campaign.", + "type": "string" + }, + "sourceCampaignId": { + "description": "A unique identifier associated with the campaign.", + "type": "string" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories" + }, + "liftrResourcePreference": { + "description": "The priority of the resource.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "generateApiKey": { + "description": "Flag to determine if User API Key has to be generated and shared.", + "type": "boolean" + } + } + }, + "ManagedIdentityTypes": { + "enum": [ + "SystemAssigned" + ], + "type": "string", + "description": "Managed Identity types.", + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedIdentityTypes" + } + }, + "IdentityProperties": { + "description": "Identity properties.", + "type": "object", + "properties": { + "principalId": { + "description": "The identity ID.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Managed identity type.", + "$ref": "#/definitions/ManagedIdentityTypes" + } + } + }, + "ElasticMonitorResource": { + "description": "Monitor resource.", + "required": [ + "location" + ], + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the monitor resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the monitor resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitor resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "SKU of the monitor resource.", + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "description": "Properties of the monitor resource.", + "$ref": "#/definitions/MonitorProperties", + "x-ms-client-flatten": false + }, + "identity": { + "description": "Identity properties of the monitor resource.", + "$ref": "#/definitions/IdentityProperties" + }, + "tags": { + "description": "The tags of the monitor resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "description": "The location of the monitor resource", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "ElasticMonitorResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticMonitorResourceUpdateParameters": { + "description": "Monitor resource update parameters.", + "type": "object", + "properties": { + "tags": { + "description": "elastic monitor resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SendingLogs": { + "enum": [ + "True", + "False" + ], + "type": "string", + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "title": "SendingLogs", + "x-ms-enum": { + "modelAsString": true, + "name": "SendingLogs" + } + }, + "MonitoredResource": { + "description": "The properties of a resource currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string" + }, + "sendingLogs": { + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "$ref": "#/definitions/SendingLogs" + }, + "reasonForLogsStatus": { + "description": "Reason for why the resource is sending logs (or why it is not sending).", + "type": "string" + } + } + }, + "SubscriptionList": { + "description": "The request to update subscriptions needed to be monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "operation": { + "description": "The operation for the patch on the resource.", + "enum": [ + "AddBegin", + "AddComplete", + "DeleteBegin", + "DeleteComplete", + "Active" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Operation" + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "monitoredSubscriptionList": { + "description": "List of subscriptions and the state of the monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscription" + }, + "x-ms-identifiers": [ + "properties/subscriptionId" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + } + } + }, + "MonitoredResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoredResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "MonitoredSubscriptionProperties": { + "description": "The request to update subscriptions needed to be monitored by the Elastic monitor resource.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SubscriptionList" + } + } + }, + "MonitoredSubscriptionPropertiesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + } + }, + "TagAction": { + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TagAction" + } + }, + "FilteringTag": { + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.", + "type": "object", + "properties": { + "name": { + "description": "The name (also known as the key) of the tag.", + "type": "string" + }, + "value": { + "description": "The value of the tag.", + "type": "string" + }, + "action": { + "description": "Valid actions for a filtering tag.", + "$ref": "#/definitions/TagAction" + } + } + }, + "ElasticVersionListFormat": { + "description": "Elastic Version List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticVersionListProperties" + } + } + }, + "ElasticVersionListProperties": { + "description": "Elastic Version Properties", + "type": "object", + "properties": { + "version": { + "description": "Available elastic version of the given region", + "type": "string" + } + } + }, + "ElasticVersionsListResponse": { + "description": "List of elastic versions available in a region.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/version" + ], + "items": { + "$ref": "#/definitions/ElasticVersionListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "LogRules": { + "description": "Set of rules for sending logs for the Monitor resource.", + "type": "object", + "properties": { + "sendAadLogs": { + "description": "Flag specifying if AAD logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendSubscriptionLogs": { + "description": "Flag specifying if subscription logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendActivityLogs": { + "description": "Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.", + "type": "boolean" + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MonitoringTagRulesProperties": { + "description": "Definition of the properties for a TagRules resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitoring tag rules.", + "$ref": "#/definitions/ProvisioningState" + }, + "logRules": { + "description": "Rules for sending logs.", + "$ref": "#/definitions/LogRules" + } + } + }, + "MonitoringTagRules": { + "description": "Capture logs and metrics of Azure resources based on ARM tags.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the rule set.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the rule set.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the rule set.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the monitoring tag rules.", + "$ref": "#/definitions/MonitoringTagRulesProperties", + "x-ms-client-flatten": false + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "MonitoringTagRulesListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "MonitoredSubscription": { + "description": "The list of subscriptions and it's monitoring status by current Elastic monitor.", + "type": "object", + "properties": { + "subscriptionId": { + "description": "The subscriptionId to be monitored.", + "required": [ + "subscriptionId" + ], + "type": "string" + }, + "status": { + "description": "The state of monitoring.", + "enum": [ + "InProgress", + "Active", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + }, + "type": "string" + }, + "error": { + "description": "The reason of not monitoring the subscription.", + "type": "string" + }, + "tagRules": { + "$ref": "#/definitions/MonitoringTagRulesProperties" + } + } + }, + "OpenAIIntegrationProperties": { + "description": "Open AI Integration details.", + "type": "object", + "properties": { + "openAIResourceId": { + "description": "The resource id of Open AI resource", + "type": "string", + "format": "arm-id" + }, + "openAIResourceEndpoint": { + "description": "The API endpoint for Open AI resource", + "type": "string" + }, + "openAIConnectorId": { + "description": "The connector id of Open AI resource", + "type": "string" + }, + "key": { + "description": "Value of API key for Open AI resource", + "type": "string", + "x-ms-secret": true + }, + "lastRefreshAt": { + "format": "date-time", + "description": "Last Update Timestamp for key updation", + "type": "string", + "readOnly": true + } + } + }, + "OpenAIIntegrationRPModel": { + "description": "Capture properties of Open AI resource Integration.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the integration.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the integration.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the integration.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OpenAIIntegrationProperties" + } + } + }, + "OpenAIIntegrationRPModelListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OpenAIIntegrationStatusResponse": { + "description": "Status of the OpenAI Integration", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OpenAIIntegrationStatusResponseProperties" + } + } + }, + "OpenAIIntegrationStatusResponseProperties": { + "description": "Status of the OpenAI Integration", + "type": "object", + "properties": { + "status": { + "description": "Status of the OpenAI Integration", + "type": "string" + } + } + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscription": { + "description": "Marketplace Subscription", + "type": "object", + "properties": { + "id": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + }, + "publisherId": { + "description": "Publisher Id of the Marketplace offer.", + "type": "string" + }, + "offerId": { + "description": "Offer Id of the Marketplace offer,", + "type": "string" + } + } + }, + "marketplaceName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceResourceId": { + "description": "Marketplace Subscription Details: Resource URI", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + }, + "subscribed": { + "description": "Flag specifying if the Marketplace status is subscribed or not.", + "type": "boolean" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "id": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "name": { + "description": "The Elastic Organization Name.", + "type": "string" + }, + "partnerEntityUri": { + "description": "Link to the elastic organization page", + "type": "string" + } + } + }, + "ConnectedPartnerResourceProperties": { + "description": "Connected Partner Resource Properties", + "type": "object", + "properties": { + "partnerDeploymentName": { + "description": "Elastic deployment name", + "type": "string" + }, + "partnerDeploymentUri": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string" + }, + "azureResourceId": { + "description": "The azure resource Id of the deployment.", + "type": "string" + }, + "location": { + "description": "The location of the deployment.", + "type": "string" + } + } + }, + "ConnectedPartnerResourcesListFormat": { + "description": "Connected Partner Resources List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedPartnerResourceProperties" + } + } + }, + "ConnectedPartnerResourcesListResponse": { + "description": " List of all active elastic deployments.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/azureResourceId" + ], + "items": { + "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticDeploymentStatus": { + "description": "Flag specifying if the Elastic deployment status is healthy or not.", + "enum": [ + "Healthy", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ElasticDeploymentStatus" + } + }, + "DeploymentInfoResponse": { + "description": "The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.", + "type": "object", + "properties": { + "status": { + "description": "The Elastic deployment status.", + "$ref": "#/definitions/ElasticDeploymentStatus", + "readOnly": true + }, + "version": { + "description": "Version of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "memoryCapacity": { + "description": "RAM capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "diskCapacity": { + "description": "Disk capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchEndPoint": { + "description": "Elasticsearch endpoint in Elastic cloud deployment. This is either the aliased_endpoint if available, or the service_url otherwise.", + "type": "string", + "readOnly": true + }, + "deploymentUrl": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + } + } + }, + "ExternalUserCreationResponse": { + "description": "The properties of the response we got from elastic while creating external user", + "type": "object", + "properties": { + "created": { + "description": "Shows if user is created or updated", + "type": "boolean", + "readOnly": true + } + } + }, + "ExternalUserInfo": { + "description": "The properties of the request required for creating user on elastic side", + "type": "object", + "properties": { + "userName": { + "description": "Username of the user to be created or updated", + "type": "string" + }, + "fullName": { + "description": "Full name of the user to be created or updated", + "type": "string" + }, + "password": { + "x-ms-secret": true, + "description": "Password of the user to be created or updated", + "type": "string" + }, + "emailId": { + "description": "Email id of the user to be created or updated", + "type": "string" + }, + "roles": { + "description": "Roles to be assigned for created or updated user", + "type": "array", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "VMHostListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/VMResources" + } + }, + "nextLink": { + "description": "Link to the next Vm resource Id, if any.", + "type": "string" + } + } + }, + "VMResources": { + "description": "The vm resource properties that is currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "vmResourceId": { + "description": "The ARM id of the VM resource.", + "type": "string" + } + } + }, + "VMIngestionDetailsResponse": { + "description": "The vm ingestion details to install an agent.", + "type": "object", + "properties": { + "cloudId": { + "description": "The cloudId of given Elastic monitor resource.", + "type": "string" + }, + "ingestionKey": { + "description": "Ingestion details to install agent on given VM.", + "type": "string", + "x-ms-secret": true + } + } + }, + "OperationName": { + "enum": [ + "Add", + "Delete" + ], + "type": "string", + "description": "Operation to be performed on the given vm resource id.", + "title": "OperationName", + "x-ms-enum": { + "modelAsString": true, + "name": "OperationName" + } + }, + "VMCollectionUpdate": { + "description": "Update VM resource collection.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "vmResourceId": { + "description": "ARM id of the VM resource.", + "type": "string" + }, + "operationName": { + "description": "Operation to be performed for given VM.", + "$ref": "#/definitions/OperationName" + } + } + }, + "UpgradableVersionsList": { + "description": "Stack Versions that this version can upgrade to", + "type": "object", + "properties": { + "currentVersion": { + "type": "string", + "description": "Current version of the elastic monitor" + }, + "upgradableVersions": { + "type": "array", + "x-ms-identifiers": [], + "description": "Stack Versions that this version can upgrade to", + "items": { + "type": "string" + } + } + } + }, + "ElasticTrafficFilterResponse": { + "description": "List of elastic traffic filters in the account", + "type": "object", + "properties": { + "rulesets": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of elastic traffic filters in the account", + "items": { + "$ref": "#/definitions/ElasticTrafficFilter" + } + } + } + }, + "ElasticTrafficFilter": { + "description": "Elastic traffic filter object", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the elastic filter" + }, + "name": { + "type": "string", + "description": "Name of the elastic filter" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter" + }, + "region": { + "type": "string", + "description": "Region of the elastic filter" + }, + "type": { + "enum": [ + "ip", + "azure_private_endpoint" + ], + "type": "string", + "description": "Type of the elastic filter", + "x-ms-enum": { + "modelAsString": true, + "name": "type" + } + }, + "includeByDefault": { + "type": "boolean", + "description": "IncludeByDefault for the elastic filter" + }, + "rules": { + "type": "array", + "description": "Rules in the elastic filter", + "items": { + "$ref": "#/definitions/ElasticTrafficFilterRule" + } + } + } + }, + "ElasticTrafficFilterRule": { + "description": "Elastic traffic filter rule object", + "type": "object", + "properties": { + "source": { + "type": "string", + "description": "IP of the elastic filter rule" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter rule" + }, + "azureEndpointGuid": { + "type": "string", + "description": "Guid of Private Endpoint in the elastic filter rule" + }, + "azureEndpointName": { + "type": "string", + "description": "Name of the Private Endpoint in the elastic filter rule" + }, + "id": { + "type": "string", + "description": "Id of the elastic filter rule" + } + } + }, + "ElasticMonitorUpgrade": { + "description": "Upgrade elastic monitor version", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Version to which the elastic monitor should be upgraded to" + } + } + }, + "UserEmailId": { + "description": "Email Id of the User Organization, of which the API Key must be returned", + "type": "object", + "properties": { + "emailId": { + "type": "string", + "description": "The User email Id" + } + } + }, + "UserApiKeyResponse": { + "description": "The User Api Key created for the Organization associated with the User Email Id that was passed in the request", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UserApiKeyResponseProperties" + } + } + }, + "UserApiKeyResponseProperties": { + "type": "object", + "properties": { + "apiKey": { + "description": "The User Api Key Generated based on GenerateApiKey flag. This is applicable for non-Portal clients only.", + "type": "string", + "x-ms-secret": true + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponse": { + "description": "The Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponseProperties" + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponseProperties": { + "description": "The properties of Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Organization belongs and gets billed into. This is empty for a new user OR a user without an Elastic Organization.", + "type": "string" + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + }, + "elasticOrganizationId": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "elasticOrganizationName": { + "description": "The Elastic Organization Name.", + "type": "string" + } + } + }, + "ResubscribeProperties": { + "description": "Resubscribe Properties", + "type": "object", + "properties": { + "planId": { + "description": "Newly selected plan Id to create the new Marketplace subscription for Resubscribe", + "type": "string" + }, + "term": { + "description": "Newly selected term to create the new Marketplace subscription for Resubscribe", + "type": "string" + }, + "subscriptionId": { + "description": "Newly selected Azure Subscription Id in which the new Marketplace subscription will be created for Resubscribe", + "type": "string" + }, + "resourceGroup": { + "description": "Newly selected Azure resource group in which the new Marketplace subscription will be created for Resubscribe", + "type": "string" + }, + "organizationId": { + "description": "Organization Id of the Elastic Organization that needs to be resubscribed", + "type": "string" + } + } + } + }, + "parameters": { + "MonitorNameParameter": { + "in": "path", + "name": "monitorName", + "description": "Monitor resource name", + "required": true, + "type": "string", + "pattern": "^.*$", + "x-ms-parameter-location": "method" + }, + "RuleSetNameParameter": { + "in": "path", + "name": "ruleSetName", + "description": "Tag Rule Set resource name", + "required": true, + "type": "string", + "pattern": "^.*$", + "x-ms-parameter-location": "method" + }, + "OpenAIIntegrationNameParameter": { + "in": "path", + "name": "integrationName", + "description": "OpenAI Integration name", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AllTrafficFilters_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AllTrafficFilters_list.json new file mode 100644 index 000000000000..19bec156f65d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AllTrafficFilters_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AssociateTrafficFilter_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AssociateTrafficFilter_Update.json new file mode 100644 index 000000000000..f2d15eccaa22 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AssociateTrafficFilter_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/associateTrafficFilter?api-version=2024-06-15-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AssociatedFiltersForDeployment_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AssociatedFiltersForDeployment_list.json new file mode 100644 index 000000000000..19bec156f65d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/AssociatedFiltersForDeployment_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/BillingInfo_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..c7283f373608 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/BillingInfo_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "subscribed": true + }, + "partnerBillingEntity": { + "id": "1234567890", + "name": "elasticOrganizationName", + "partnerEntityUri": "https://example.com" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ConnectedPartnerResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ConnectedPartnerResources_List.json new file mode 100644 index 000000000000..840635133bfa --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ConnectedPartnerResources_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "partnerDeploymentName": "deploymentname", + "partnerDeploymentUri": "https://examplessourl.com", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US 2" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DeploymentInfo_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DeploymentInfo_List.json new file mode 100644 index 000000000000..b8fcf1ac048d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DeploymentInfo_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "status": "Healthy", + "version": "7.9.3", + "memoryCapacity": "1024", + "diskCapacity": "245760", + "elasticsearchEndPoint": "alias.es.eastus2.staging.azure.foundit.no", + "deploymentUrl": "https://endpoint.eastus.kb.azure.elastic-cloud.com:9243", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DetachAndDeleteTrafficFilter_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DetachAndDeleteTrafficFilter_Delete.json new file mode 100644 index 000000000000..59dde58492e1 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DetachAndDeleteTrafficFilter_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DetachTrafficFilters_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DetachTrafficFilters_Update.json new file mode 100644 index 000000000000..03dd33523da2 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/DetachTrafficFilters_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/detachTrafficFilter?api-version=2024-06-15-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ElasticVersions_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ElasticVersions_List.json new file mode 100644 index 000000000000..9078d501f296 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ElasticVersions_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "region": "myregion", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "version1" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ExternalUserInfo.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ExternalUserInfo.json new file mode 100644 index 000000000000..cdd69d2edca1 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/ExternalUserInfo.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "UserName": "newuser", + "FullName": "fullname", + "Password": "Password", + "EmailId": "myemail@outlook.com", + "Roles": [ + "admin", + "other_role1" + ] + } + }, + "responses": { + "200": { + "body": { + "created": true + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/IPTrafficFilter_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/IPTrafficFilter_Create.json new file mode 100644 index 000000000000..bb598fcb69d6 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/IPTrafficFilter_Create.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "ips": "192.168.131.0, 192.168.132.6/22" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociateIPFilter?api-version=2024-06-15-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitor_Upgrade.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitor_Upgrade.json new file mode 100644 index 000000000000..8fa4ff1d8857 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitor_Upgrade.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "version": "7.15.1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/upgrade?api-version=2024-06-15-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredResources_List.json new file mode 100644 index 000000000000..f4f8f4b58fec --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredResources_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "sendingLogs": "True", + "reasonForLogsStatus": "CapturedByRules" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_CreateorUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_CreateorUpdate.json new file mode 100644 index 000000000000..1944d8ab381b --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_CreateorUpdate.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddBegin", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..c1cb1f74e0fe --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Elastic/monitors/test?api-version=2024-06-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..8ad49011dc87 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..7ba5fe9c7fb8 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..34fb333f8ac9 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/MonitoredSubscriptions_Update.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddComplete", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Elastic/monitors/test?api-version=2024-06-15-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Create.json new file mode 100644 index 000000000000..5ea5484f61b1 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Create.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + }, + "planDetails": { + "offerID": "00000", + "publisherID": "1234", + "termID": "free_Monthly", + "planID": "xxxyyy", + "planName": "myPlan" + }, + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed", + "sourceCampaignName": "Elastic", + "sourceCampaignId": "0000" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Delete.json new file mode 100644 index 000000000000..6f63822c8a2b --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname?api-version=2022-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Get.json new file mode 100644 index 000000000000..27d3ed0571da --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_List.json new file mode 100644 index 000000000000..1ab1244a8f0d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_ListByResourceGroup.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..11dedd058caa --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_ListByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Update.json new file mode 100644 index 000000000000..ce96b075054b --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Monitors_Update.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname?api-version=2024-06-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_CreateOrUpdate.json new file mode 100644 index 000000000000..60e4d61d9153 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_CreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default", + "requestBody": { + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "key": "**" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "openAIConnectorId": "0000000000000000", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "openAIConnectorId": "0000000000000000", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_Delete.json new file mode 100644 index 000000000000..ba5ad97d7db8 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_Get.json new file mode 100644 index 000000000000..1702b79251d5 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "openAIConnectorId": "0000000000000000", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_GetStatus.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_GetStatus.json new file mode 100644 index 000000000000..626f4a467ef3 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_GetStatus.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "Succeeded" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_List.json new file mode 100644 index 000000000000..91f95728dcbb --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/OpenAI_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "openAIConnectorId": "0000000000000000", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Operations_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Operations_List.json new file mode 100644 index 000000000000..c0104571f96a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Elastic/monitors/write", + "display": { + "provider": "Microsoft.Elastic", + "resource": "monitors", + "operation": "write", + "description": "Write monitors resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_GetApiKey.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_GetApiKey.json new file mode 100644 index 000000000000..effcb747e4a9 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_GetApiKey.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "requestBody": { + "emailId": "myemail@outlook.com" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "apiKey": "AbCdEfGhIjKlMnOpQrStUvWxYz" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json new file mode 100644 index 000000000000..825e1744e12a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + }, + "elasticOrganizationId": "1234567890", + "elasticOrganizationName": "elasticOrganizationName" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_Resubscribe.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_Resubscribe.json new file mode 100644 index 000000000000..f2d895cb5ee0 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/Organizations_Resubscribe.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "planId": "planId", + "term": "term", + "subscriptionId": "subscriptionId", + "resourceGroup": "resourceGroup", + "organizationId": "organizationId" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/resubscribe?api-version=2024-06-15-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/PrivateLinkTrafficFilters_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/PrivateLinkTrafficFilters_Create.json new file mode 100644 index 000000000000..7aa3d7c2168f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/PrivateLinkTrafficFilters_Create.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "privateEndpointName": "myPrivateEndpoint", + "privateEndpointGuid": "fdb54d3b-e85e-4d08-8958-0d2f7g523df9" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociatePLFilter?api-version=2022-07-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..bee373e7997b --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "requestBody": { + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Elastic/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_Delete.json new file mode 100644 index 000000000000..8b65c9175eba --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/tagRules/tagRuleName?api-version=2024-06-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_Get.json new file mode 100644 index 000000000000..0a00c0eb61af --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Elastic/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_List.json new file mode 100644 index 000000000000..f7d9d1c79a8c --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TagRules_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Elastic/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TrafficFilters_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TrafficFilters_Delete.json new file mode 100644 index 000000000000..59dde58492e1 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/TrafficFilters_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/UpgradableVersions_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/UpgradableVersions_Details.json new file mode 100644 index 000000000000..e2cb9e051258 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/UpgradableVersions_Details.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "currentVersion": "7.15.0", + "upgradableVersions": [ + "7.15.1", + "7.16.0" + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMCollection_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMCollection_Update.json new file mode 100644 index 000000000000..ae13608a7900 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMCollection_Update.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM", + "operationName": "Add" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMHost_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMHost_List.json new file mode 100644 index 000000000000..94b2e4a11c5d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMHost_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMIngestion_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMIngestion_Details.json new file mode 100644 index 000000000000..1688011dad85 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-06-15-preview/examples/VMIngestion_Details.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "cloudId": "myid123", + "ingestionKey": "Vmingeationkey" + } + } + } +} diff --git a/specification/elastic/resource-manager/readme.md b/specification/elastic/resource-manager/readme.md index 5b81de2d87e9..cd366b7401f8 100644 --- a/specification/elastic/resource-manager/readme.md +++ b/specification/elastic/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the elastic. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-05-01-preview +tag: package-2024-06-15-preview ``` ### Tag: package-2021-09-01-preview @@ -191,6 +191,15 @@ input-file: - Microsoft.Elastic/preview/2024-05-01-preview/elastic.json ``` +### Tag: package-2024-06-15-preview + +These settings apply only when `--tag=package-2024-06-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-06-15-preview' +input-file: + - Microsoft.Elastic/preview/2024-06-15-preview/elastic.json +``` + --- # Code Generation From baf818ed2864f4ebdc1f539adebd3538b187c1d3 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Tue, 18 Jun 2024 15:49:36 +0800 Subject: [PATCH 193/343] mgmt, java config in readme.java.md (#29478) --- .../resource-manager/readme.java.md | 10 ++++++++++ specification/oracle/resource-manager/readme.java.md | 2 ++ specification/scvmm/resource-manager/readme.java.md | 2 ++ 3 files changed, 14 insertions(+) create mode 100644 specification/appcomplianceautomation/resource-manager/readme.java.md diff --git a/specification/appcomplianceautomation/resource-manager/readme.java.md b/specification/appcomplianceautomation/resource-manager/readme.java.md new file mode 100644 index 000000000000..68abe98c06a7 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/readme.java.md @@ -0,0 +1,10 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +service-name: "App Compliance Automation" +uuid-as-string: true +stream-style-serialization: true +``` diff --git a/specification/oracle/resource-manager/readme.java.md b/specification/oracle/resource-manager/readme.java.md index 01cdabebe9ad..d779212fdcc0 100644 --- a/specification/oracle/resource-manager/readme.java.md +++ b/specification/oracle/resource-manager/readme.java.md @@ -4,4 +4,6 @@ These settings apply only when `--java` is specified on the command line. ``` yaml $(java) client-flattened-annotation-target: disabled +uuid-as-string: true +stream-style-serialization: true ``` diff --git a/specification/scvmm/resource-manager/readme.java.md b/specification/scvmm/resource-manager/readme.java.md index 134228ed936f..5748f31393b0 100644 --- a/specification/scvmm/resource-manager/readme.java.md +++ b/specification/scvmm/resource-manager/readme.java.md @@ -6,4 +6,6 @@ Please also specify `--azure-libraries-for-java-folder= Date: Tue, 18 Jun 2024 19:57:12 +0800 Subject: [PATCH 194/343] Update api description (#29431) * update api description * Update routes.tsp * Update routes.tsp --- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 4 +--- .../preview/2023-10-01-preview/purviewdatamap.json | 2 +- .../preview/2024-03-01-preview/purviewdatamap.json | 2 +- .../stable/2023-09-01/purviewdatamap.json | 2 +- 4 files changed, 4 insertions(+), 6 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index d47f16bf8ce1..8e42754d7f19 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -2051,9 +2051,7 @@ interface Type { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" - Create all atlas type definitions in bulk, only new definitions will be - created. - Any changes to the existing definitions will be discarded. + Create all atlas type definitions in bulk. Please avoid recreating existing types. """) @route("/atlas/v2/types/typedefs") @post diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json index e9de0cc4ad57..6ded253a23b4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/preview/2023-10-01-preview/purviewdatamap.json @@ -3889,7 +3889,7 @@ "tags": [ "Type" ], - "description": "Create all atlas type definitions in bulk, only new definitions will be created.\nAny changes to the existing definitions will be discarded.", + "description": "Create all atlas type definitions in bulk. Please avoid recreating existing types.", "operationId": "Type_BulkCreate", "x-ms-examples": { "Type_BulkCreate": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json index 315f5ba6a6a8..0e2f6d6c71f6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json @@ -3943,7 +3943,7 @@ }, "post": { "operationId": "Type_BulkCreate", - "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", + "description": "Create all atlas type definitions in bulk. Please avoid recreating existing types.", "parameters": [ { "name": "body", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 22ad76fcf1c7..ecda9cc408ec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -3943,7 +3943,7 @@ }, "post": { "operationId": "Type_BulkCreate", - "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", + "description": "Create all atlas type definitions in bulk. Please avoid recreating existing types.", "parameters": [ { "name": "body", From beaa815ae7f656ce826d9cb8f1078514c3fb407c Mon Sep 17 00:00:00 2001 From: Bill Wert Date: Tue, 18 Jun 2024 15:08:50 -0700 Subject: [PATCH 195/343] update options (#29484) * update options * update client.tsp * update comment --- specification/eventgrid/Azure.Messaging.EventGrid/client.tsp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp index efc120374ada..b6b26dbd65ba 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp @@ -153,9 +153,10 @@ namespace Customizations { @@access(rejectCloudEvents, Access.internal, "javascript"); @@access(renewCloudEventLocks, Access.internal, "javascript"); -//Mark models as public (except ReceiveResult, PublishResult) +//Mark models as public (except ReceiveResult, which is made public through customization in languages other than Java.) //BUG: Bypassing Go for now as it marks all models as internal @@access(AcknowledgeResult, Access.public); +@@access(ReceiveResult, Access.public, "java"); @@access(ReleaseResult, Access.public); @@access(RejectResult, Access.public); @@access(RenewCloudEventLocksResult, Access.public); From 791127791193940fae3e3f81275c35e32659da95 Mon Sep 17 00:00:00 2001 From: Ryan Lo <55516393+mryanlo@users.noreply.github.com> Date: Tue, 18 Jun 2024 15:38:18 -0700 Subject: [PATCH 196/343] update code owners (#29485) --- .github/CODEOWNERS | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 07cfc34e7c0c..ac4c89231ee0 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -107,6 +107,9 @@ /specification/deploymentmanager/ @netrock +# PRLabel: %Device Registry +/specification/deviceregistry/ @marcodalessandro @rohankhandelwal @riteshrao + # PRLabel: %Device Update /specification/deviceupdate/data-plane/ @mikekistler @Azure/api-stewardship-board From 9f024124361561030653abd1e8ec6d5ad1080c1a Mon Sep 17 00:00:00 2001 From: Libba Lawrence Date: Tue, 18 Jun 2024 16:00:06 -0700 Subject: [PATCH 197/343] [EG] Update ReadME (#29481) * update * Update specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/README.md * nit * add * update * Update specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/README.md Co-authored-by: Laurent Mazuel --------- Co-authored-by: Laurent Mazuel --- .../README.md | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/README.md b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/README.md index e4b570b824e2..fbbaa2816aba 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/README.md +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/README.md @@ -21,7 +21,7 @@ model AcsChatMessageReceivedEventData { ...AcsChatMessageEventBaseProperties; /** The body of the chat message. */ - messageBody ?: string; + messageBody : string; } ~~~ @@ -32,15 +32,13 @@ Adding `@usage` and `@access` to `client.tsp`: @@access(EventGrid.AcsChatMessageReceivedEventData, Access.public) ~~~ -# How To Run +# For Service System Events PR Approval -Within Azure.Messaging.EventGrid.SystemEvents: - - -To generate the EventGrid SystemEvents from TypeSpec: - -With `Azure.Messaging.EventGrid.SystemEvents` as your root directory: - - `tsp compile client.tsp --emit YOUR_EMITTER` - -To generate the swagger file YOUR_EMITTER would be @azure-tools/typespec-autorest. \ No newline at end of file +1) Write your service's system events in TypeSpec. +2) Generate the swagger for your service's system events off of TypeSpec, following the steps below: + - Install TypeSpec `npm install @typespec/compiler` + - Install the emitter `npm install @azure-tools/typespec-autorest` + - Under `/Azure.Messaging.EventGrid.SystemEvents/`: + - Run `npx tsp compile main.tsp --emit @azure-tools/typespec-autorest` +3) Verify the generated swagger under `/data-plane/Microsoft.EventGrid/2024-01-01/` accurately depicts your system events and commit it. +4) Final PR must contain the TypeSpec and the Swagger generated from the TypeSpec. \ No newline at end of file From 777a55d5e66ddd80bc7cf8d90d11dd7ab96e533c Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 18 Jun 2024 16:20:58 -0700 Subject: [PATCH 198/343] Add api-key auth --- .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++++------ .../GetEmbeddings_MaximumSet_Gen.json | 18 ++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 16 ++++++------ .../GetImageEmbeddings_MaximumSet_Gen.json | 20 +++++++------- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 ++++++------ .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- specification/ai/ModelClient/main.tsp | 3 ++- specification/ai/ModelClient/tspconfig.yaml | 1 + .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++++------ .../GetEmbeddings_MaximumSet_Gen.json | 18 ++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 16 ++++++------ .../GetImageEmbeddings_MaximumSet_Gen.json | 20 +++++++------- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 ++++++------ .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +-- .../preview/2024-05-01-preview/openapi.json | 8 ++++++ 19 files changed, 131 insertions(+), 121 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index 4ff8acaaead7..628a8ffcba69 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,46 +10,46 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": 0, "stream": true, - "presence_penalty": -1, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "frovutrcmwrzcoszelrglkuvpbukzu" + "dtkmhtrwtadjcn" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 6 + "seed": 22 } }, "responses": { "200": { "body": { - "id": "hpcvgnonpjyzffximnagg", - "created": 27, - "model": "iextgrfegfy", + "id": "hnnexvpxbxbbhouyyrebztae", + "created": 15, + "model": "ztdoenkqeuvcjnhwuvl", "usage": { - "completion_tokens": 22, - "prompt_tokens": 9, - "total_tokens": 7 + "completion_tokens": 18, + "prompt_tokens": 28, + "total_tokens": 24 }, "choices": [ { - "index": 10, + "index": 27, "finish_reason": "stop", "message": { "role": "system", - "content": "kjzmsqcgjl", + "content": "rgjrjvxvimmgqfezque", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "maltrnwbhsjytwjfgxdshcbwup" + "id": "jqsmltehjfkxf" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index b2bc30ea4e5b..691358f346e7 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "hpcvgnonpjyzffximnagg", - "created": 27, - "model": "iextgrfegfy", + "id": "hnnexvpxbxbbhouyyrebztae", + "created": 15, + "model": "ztdoenkqeuvcjnhwuvl", "usage": { - "completion_tokens": 22, - "prompt_tokens": 9, - "total_tokens": 7 + "completion_tokens": 18, + "prompt_tokens": 28, + "total_tokens": 24 }, "choices": [ { - "index": 10, + "index": 27, "finish_reason": "stop", "message": { "role": "system", - "content": "kjzmsqcgjl" + "content": "rgjrjvxvimmgqfezque" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index c96b52844d7c..e8c68b509c51 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "mhldnzatps" + "g" ], - "dimensions": 28, + "dimensions": 9, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "eydebtydwpajdafhqiqtfdklcgrln", + "id": "hrzmwfxztaxekeuthsktbs", "data": [ { "embedding": [ - 15 + 17 ], - "index": 7 + "index": 3 } ], "usage": { - "input_tokens": 18, - "prompt_tokens": 30, - "total_tokens": 30 + "input_tokens": 17, + "prompt_tokens": 11, + "total_tokens": 12 }, - "model": "bxrwbixgoipxiqouemwamsccfmpwut" + "model": "vlhzbxcly" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index 9ce30dd55f38..dec57071f6cf 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "mjcfkghomsiauazvrqizay" + "bbvbzqhmvubujvromttbfphl" ] } }, "responses": { "200": { "body": { - "id": "eydebtydwpajdafhqiqtfdklcgrln", + "id": "hrzmwfxztaxekeuthsktbs", "data": [ { "embedding": [ - 15 + 17 ], - "index": 7 + "index": 3 } ], "usage": { - "input_tokens": 18, - "prompt_tokens": 30, - "total_tokens": 30 + "input_tokens": 17, + "prompt_tokens": 11, + "total_tokens": 12 }, - "model": "bxrwbixgoipxiqouemwamsccfmpwut" + "model": "vlhzbxcly" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index 4361c7f71835..d9a3452b6f53 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "eplktjwsrhtw", - "text": "esoizlgwokdrrxvlmtz" + "image": "knopxwjjsihgk", + "text": "bnpyvsxyyrbqivjudxwliul" } ], - "dimensions": 27, + "dimensions": 11, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "eydebtydwpajdafhqiqtfdklcgrln", + "id": "hrzmwfxztaxekeuthsktbs", "data": [ { "embedding": [ - 15 + 17 ], - "index": 7 + "index": 3 } ], "usage": { - "input_tokens": 18, - "prompt_tokens": 30, - "total_tokens": 30 + "input_tokens": 17, + "prompt_tokens": 11, + "total_tokens": 12 }, - "model": "bxrwbixgoipxiqouemwamsccfmpwut" + "model": "vlhzbxcly" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 4d64fd232563..05cc9271e602 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "eplktjwsrhtw" + "image": "knopxwjjsihgk" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "eydebtydwpajdafhqiqtfdklcgrln", + "id": "hrzmwfxztaxekeuthsktbs", "data": [ { "embedding": [ - 15 + 17 ], - "index": 7 + "index": 3 } ], "usage": { - "input_tokens": 18, - "prompt_tokens": 30, - "total_tokens": 30 + "input_tokens": 17, + "prompt_tokens": 11, + "total_tokens": 12 }, - "model": "bxrwbixgoipxiqouemwamsccfmpwut" + "model": "vlhzbxcly" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index d482cf194f94..011684b0d4a9 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "aakbqaphhuvebuxpcrve", + "model_name": "sqwvxjoxvdglyzazzbqi", "model_type": "embeddings", - "model_provider_name": "mokbftoapmemqczizfxzibtt" + "model_provider_name": "brcafsevsrrnjvbtv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index 0f5b7fef7433..dd0668d0bde1 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "aakbqaphhuvebuxpcrve", + "model_name": "sqwvxjoxvdglyzazzbqi", "model_type": "embeddings", - "model_provider_name": "mokbftoapmemqczizfxzibtt" + "model_provider_name": "brcafsevsrrnjvbtv" } } } diff --git a/specification/ai/ModelClient/main.tsp b/specification/ai/ModelClient/main.tsp index aa9695d23cab..6f818f00b9a3 100644 --- a/specification/ai/ModelClient/main.tsp +++ b/specification/ai/ModelClient/main.tsp @@ -8,9 +8,10 @@ using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.Core; +// Once MaaP/MaaS endpoints support "api-key" header, we can remove BearerAuth from here #suppress "@azure-tools/typespec-autorest/unsupported-http-auth-scheme" @useAuth( - BearerAuth | OAuth2Auth<[ + ApiKeyAuth | BearerAuth | OAuth2Auth<[ { type: OAuth2FlowType.implicit, authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index 136e4c500f15..b2b3c1054c0d 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -11,6 +11,7 @@ linter: - "@azure-tools/typespec-azure-rulesets/data-plane" disable: "@azure-tools/typespec-azure-core/casing-style": "Disabled since JSON payload in REST API does not conform to Azure guidelines with regards to casing" + "@azure-tools/typespec-azure-core/no-string-discriminator": "Use an extensible union instead of a plain string" options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "data-plane" diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 4ff8acaaead7..628a8ffcba69 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,46 +10,46 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": 0, "stream": true, - "presence_penalty": -1, + "presence_penalty": -2, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "frovutrcmwrzcoszelrglkuvpbukzu" + "dtkmhtrwtadjcn" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 6 + "seed": 22 } }, "responses": { "200": { "body": { - "id": "hpcvgnonpjyzffximnagg", - "created": 27, - "model": "iextgrfegfy", + "id": "hnnexvpxbxbbhouyyrebztae", + "created": 15, + "model": "ztdoenkqeuvcjnhwuvl", "usage": { - "completion_tokens": 22, - "prompt_tokens": 9, - "total_tokens": 7 + "completion_tokens": 18, + "prompt_tokens": 28, + "total_tokens": 24 }, "choices": [ { - "index": 10, + "index": 27, "finish_reason": "stop", "message": { "role": "system", - "content": "kjzmsqcgjl", + "content": "rgjrjvxvimmgqfezque", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "maltrnwbhsjytwjfgxdshcbwup" + "id": "jqsmltehjfkxf" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index b2bc30ea4e5b..691358f346e7 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "hpcvgnonpjyzffximnagg", - "created": 27, - "model": "iextgrfegfy", + "id": "hnnexvpxbxbbhouyyrebztae", + "created": 15, + "model": "ztdoenkqeuvcjnhwuvl", "usage": { - "completion_tokens": 22, - "prompt_tokens": 9, - "total_tokens": 7 + "completion_tokens": 18, + "prompt_tokens": 28, + "total_tokens": 24 }, "choices": [ { - "index": 10, + "index": 27, "finish_reason": "stop", "message": { "role": "system", - "content": "kjzmsqcgjl" + "content": "rgjrjvxvimmgqfezque" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index c96b52844d7c..e8c68b509c51 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "mhldnzatps" + "g" ], - "dimensions": 28, + "dimensions": 9, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "eydebtydwpajdafhqiqtfdklcgrln", + "id": "hrzmwfxztaxekeuthsktbs", "data": [ { "embedding": [ - 15 + 17 ], - "index": 7 + "index": 3 } ], "usage": { - "input_tokens": 18, - "prompt_tokens": 30, - "total_tokens": 30 + "input_tokens": 17, + "prompt_tokens": 11, + "total_tokens": 12 }, - "model": "bxrwbixgoipxiqouemwamsccfmpwut" + "model": "vlhzbxcly" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 9ce30dd55f38..dec57071f6cf 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "mjcfkghomsiauazvrqizay" + "bbvbzqhmvubujvromttbfphl" ] } }, "responses": { "200": { "body": { - "id": "eydebtydwpajdafhqiqtfdklcgrln", + "id": "hrzmwfxztaxekeuthsktbs", "data": [ { "embedding": [ - 15 + 17 ], - "index": 7 + "index": 3 } ], "usage": { - "input_tokens": 18, - "prompt_tokens": 30, - "total_tokens": 30 + "input_tokens": 17, + "prompt_tokens": 11, + "total_tokens": 12 }, - "model": "bxrwbixgoipxiqouemwamsccfmpwut" + "model": "vlhzbxcly" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index 4361c7f71835..d9a3452b6f53 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "eplktjwsrhtw", - "text": "esoizlgwokdrrxvlmtz" + "image": "knopxwjjsihgk", + "text": "bnpyvsxyyrbqivjudxwliul" } ], - "dimensions": 27, + "dimensions": 11, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "eydebtydwpajdafhqiqtfdklcgrln", + "id": "hrzmwfxztaxekeuthsktbs", "data": [ { "embedding": [ - 15 + 17 ], - "index": 7 + "index": 3 } ], "usage": { - "input_tokens": 18, - "prompt_tokens": 30, - "total_tokens": 30 + "input_tokens": 17, + "prompt_tokens": 11, + "total_tokens": 12 }, - "model": "bxrwbixgoipxiqouemwamsccfmpwut" + "model": "vlhzbxcly" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 4d64fd232563..05cc9271e602 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "eplktjwsrhtw" + "image": "knopxwjjsihgk" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "eydebtydwpajdafhqiqtfdklcgrln", + "id": "hrzmwfxztaxekeuthsktbs", "data": [ { "embedding": [ - 15 + 17 ], - "index": 7 + "index": 3 } ], "usage": { - "input_tokens": 18, - "prompt_tokens": 30, - "total_tokens": 30 + "input_tokens": 17, + "prompt_tokens": 11, + "total_tokens": 12 }, - "model": "bxrwbixgoipxiqouemwamsccfmpwut" + "model": "vlhzbxcly" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index d482cf194f94..011684b0d4a9 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "aakbqaphhuvebuxpcrve", + "model_name": "sqwvxjoxvdglyzazzbqi", "model_type": "embeddings", - "model_provider_name": "mokbftoapmemqczizfxzibtt" + "model_provider_name": "brcafsevsrrnjvbtv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 0f5b7fef7433..dd0668d0bde1 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "aakbqaphhuvebuxpcrve", + "model_name": "sqwvxjoxvdglyzazzbqi", "model_type": "embeddings", - "model_provider_name": "mokbftoapmemqczizfxzibtt" + "model_provider_name": "brcafsevsrrnjvbtv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json index e7a769627aa4..a6d6dd598ce0 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json @@ -19,6 +19,9 @@ "application/json" ], "security": [ + { + "ApiKeyAuth": [] + }, { "OAuth2Auth": [ "https://ml.azure.com/.default" @@ -26,6 +29,11 @@ } ], "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, "OAuth2Auth": { "type": "oauth2", "flow": "implicit", From 084b190f3b4d3385076ec31cc60a839d4987ab98 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 19 Jun 2024 12:08:20 +0800 Subject: [PATCH 199/343] [scvmm] disable flatten (#29479) * scvmm-config * Update tspconfig.yaml --- specification/scvmm/ScVmm.Management/tspconfig.yaml | 4 ---- specification/scvmm/resource-manager/readme.python.md | 5 +++++ 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/specification/scvmm/ScVmm.Management/tspconfig.yaml b/specification/scvmm/ScVmm.Management/tspconfig.yaml index c8328383295e..21d2a3394ac8 100644 --- a/specification/scvmm/ScVmm.Management/tspconfig.yaml +++ b/specification/scvmm/ScVmm.Management/tspconfig.yaml @@ -11,10 +11,6 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/scvmm.json" examples-directory: "{project-root}/examples" - "@azure-tools/typespec-python": - package-dir: "azure-mgmt-scvmm" - package-name: "{package-dir}" - flavor: "azure" linter: disable: extends: diff --git a/specification/scvmm/resource-manager/readme.python.md b/specification/scvmm/resource-manager/readme.python.md index ca94d10594b0..b7097c82e235 100644 --- a/specification/scvmm/resource-manager/readme.python.md +++ b/specification/scvmm/resource-manager/readme.python.md @@ -17,3 +17,8 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/scvmm/azure-mgmt-scvmm/azure/mgmt/scvmm ``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` From fac5e7bd84c8403abcb6a32d472e413a70c628cf Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 19 Jun 2024 12:09:38 +0800 Subject: [PATCH 200/343] [appcomplianceautomation] title&disable flatten (#29480) * appcomplianceautomation-config * Update tspconfig.yaml --- .../AppComplianceAutomation.Management/tspconfig.yaml | 4 ---- .../resource-manager/readme.python.md | 6 ++++++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml index f7b8f046327c..283ae137044f 100644 --- a/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml @@ -13,10 +13,6 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/appcomplianceautomation.json" examples-directory: "{project-root}/examples" - "@azure-tools/typespec-python": - flavor: azure - package-dir: "azure-mgmt-appcomplianceautomation" - package-name: "{package-dir}" "@azure-tools/typespec-ts": flavor: azure package-dir: "arm-appcomplianceautomation" diff --git a/specification/appcomplianceautomation/resource-manager/readme.python.md b/specification/appcomplianceautomation/resource-manager/readme.python.md index 59945f5f5443..72a155fd0dc6 100644 --- a/specification/appcomplianceautomation/resource-manager/readme.python.md +++ b/specification/appcomplianceautomation/resource-manager/readme.python.md @@ -4,6 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. ``` yaml $(python) +title: AppComplianceAutomationMgmtClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-appcomplianceautomation @@ -16,3 +17,8 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/appcomplianceautomation/azure-mgmt-appcomplianceautomation/azure/mgmt/appcomplianceautomation ``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` From 9942cf289579976351b4fe7b6b3280c1fee3785c Mon Sep 17 00:00:00 2001 From: Haoling Dong <87355844+haolingdong-msft@users.noreply.github.com> Date: Wed, 19 Jun 2024 13:17:23 +0800 Subject: [PATCH 201/343] Update tspconfig.yaml (#29476) --- .../azurefleet/AzureFleet.Management/tspconfig.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml index 766d0dc18cb5..6e187771dfb0 100644 --- a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml +++ b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml @@ -27,3 +27,9 @@ options: package-dir: "azure-mgmt-computefleet" package-name: "{package-dir}" flavor: "azure" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-computefleet" + namespace: com.azure.resourcemanager.computefleet + service-name: Compute Fleet + examples-directory: "examples" + flavor: azure From 061505b89d5d0bbcc9f980e2276f79ff354ce286 Mon Sep 17 00:00:00 2001 From: Mary Gao Date: Wed, 19 Jun 2024 14:26:29 +0800 Subject: [PATCH 202/343] Update the name from ResourceProvisioningState to ProvisioningState (#29490) * Update the name from ResourceProvisioningState to ProvisioningState * Update the swagger spec * Update the swagger spec --- .../scvmm/ScVmm.Management/models.tsp | 20 ++++++++--------- .../stable/2023-10-07/scvmm.json | 22 +++++++++---------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/specification/scvmm/ScVmm.Management/models.tsp b/specification/scvmm/ScVmm.Management/models.tsp index bbc58d95d93e..74022dcb1eca 100644 --- a/specification/scvmm/ScVmm.Management/models.tsp +++ b/specification/scvmm/ScVmm.Management/models.tsp @@ -32,7 +32,7 @@ model QueryForceDelete { } /** The provisioning state of the resource. */ -union ResourceProvisioningState { +union ProvisioningState { string, Azure.ResourceManager.ResourceProvisioningState, @@ -200,7 +200,7 @@ model VmmServerProperties { /** Provisioning state of the resource. */ @visibility("read") - provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; + provisioningState?: ProvisioningState; } /** Credentials to connect to VmmServer. */ @@ -254,7 +254,7 @@ model CloudProperties { /** Provisioning state of the resource. */ @visibility("read") - provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; + provisioningState?: ProvisioningState; } /** Cloud Capacity model */ @@ -309,7 +309,7 @@ model VirtualNetworkProperties { /** Provisioning state of the resource. */ @visibility("read") - provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; + provisioningState?: ProvisioningState; } /** Defines the resource properties. */ @@ -387,7 +387,7 @@ model VirtualMachineTemplateProperties { /** Provisioning state of the resource. */ @visibility("read") - provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; + provisioningState?: ProvisioningState; } /** Network Interface model */ @@ -510,7 +510,7 @@ model AvailabilitySetProperties { /** Provisioning state of the resource. */ @visibility("read") - provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; + provisioningState?: ProvisioningState; } /** The inventory type */ @@ -550,7 +550,7 @@ model InventoryItemProperties { /** Provisioning state of the resource. */ @visibility("read") - provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; + provisioningState?: ProvisioningState; } /** Defines the resource properties. */ @@ -580,7 +580,7 @@ model VirtualMachineInstanceProperties { /** Provisioning state of the resource. */ @visibility("read") - provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; + provisioningState?: ProvisioningState; } /** Virtual Machine Instance Properties Update model */ @@ -799,7 +799,7 @@ model VmInstanceHybridIdentityMetadataProperties { /** Provisioning state of the resource. */ @visibility("read") - provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; + provisioningState?: ProvisioningState; } /** Defines the create checkpoint action properties. */ @@ -848,7 +848,7 @@ model GuestAgentProperties { /** Provisioning state of the resource. */ @visibility("read") - provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; + provisioningState?: ProvisioningState; } /** Username / Password Credentials to connect to guest. */ diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json index b363355e44c4..d53c2c453e9c 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json @@ -3224,7 +3224,7 @@ } }, "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } @@ -3391,7 +3391,7 @@ "x-ms-client-name": "storageQosPolicies" }, "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } @@ -3550,7 +3550,7 @@ "readOnly": true }, "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } @@ -3880,7 +3880,7 @@ "readOnly": true }, "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } @@ -4237,7 +4237,7 @@ ] } }, - "ResourceProvisioningState": { + "ProvisioningState": { "type": "string", "description": "The provisioning state of the resource.", "enum": [ @@ -4251,7 +4251,7 @@ "Created" ], "x-ms-enum": { - "name": "ResourceProvisioningState", + "name": "ProvisioningState", "modelAsString": true, "values": [ { @@ -4645,7 +4645,7 @@ "readOnly": true }, "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } @@ -4952,7 +4952,7 @@ ] }, "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } @@ -5057,7 +5057,7 @@ "readOnly": true }, "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } @@ -5127,7 +5127,7 @@ "description": "Gets or sets the Public Key." }, "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } @@ -5239,7 +5239,7 @@ "readOnly": true }, "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", + "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } From 89fc547a195b7202ac9731b6dc17596776b12185 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Wed, 19 Jun 2024 17:51:39 +0800 Subject: [PATCH 203/343] mgmt, java config, client/title for appcomplianceautomation (#29498) --- .../tspconfig.yaml | 12 ++++++------ .../resource-manager/readme.java.md | 3 ++- specification/oracle/Oracle.Database/tspconfig.yaml | 10 +++++----- specification/oracle/resource-manager/readme.java.md | 2 +- specification/scvmm/resource-manager/readme.java.md | 2 +- 5 files changed, 15 insertions(+), 14 deletions(-) diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml index 283ae137044f..77659b374742 100644 --- a/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml @@ -19,12 +19,12 @@ options: packageDetails: name: "@azure/arm-appcomplianceautomation" examples-directory: "{project-root}/examples" - "@azure-tools/typespec-java": - flavor: azure - package-dir: "azure-resourcemanager-appcomplianceautomation" - namespace: "com.azure.resourcemanager.appcomplianceautomation" - service-name: "App Compliance Automation" - examples-directory: "examples" + # "@azure-tools/typespec-java": + # flavor: azure + # package-dir: "azure-resourcemanager-appcomplianceautomation" + # namespace: "com.azure.resourcemanager.appcomplianceautomation" + # service-name: "App Compliance Automation" + # examples-directory: "examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/appcomplianceautomation/resource-manager/readme.java.md b/specification/appcomplianceautomation/resource-manager/readme.java.md index 68abe98c06a7..f5b439bc1462 100644 --- a/specification/appcomplianceautomation/resource-manager/readme.java.md +++ b/specification/appcomplianceautomation/resource-manager/readme.java.md @@ -4,7 +4,8 @@ These settings apply only when `--java` is specified on the command line. ``` yaml $(java) client-flattened-annotation-target: disabled +title: AppComplianceAutomationClient service-name: "App Compliance Automation" uuid-as-string: true -stream-style-serialization: true +output-model-immutable: true ``` diff --git a/specification/oracle/Oracle.Database/tspconfig.yaml b/specification/oracle/Oracle.Database/tspconfig.yaml index 3c83003a4bed..fa6f46b6a1d4 100644 --- a/specification/oracle/Oracle.Database/tspconfig.yaml +++ b/specification/oracle/Oracle.Database/tspconfig.yaml @@ -17,11 +17,11 @@ options: packageDetails: name: "@azure/arm-oracledatabase" flavor: azure - "@azure-tools/typespec-java": - package-dir: "azure-resourcemanager-oracledatabase" - namespace: com.azure.resourcemanager.oracledatabase - partial-update: true - flavor: azure + # "@azure-tools/typespec-java": + # package-dir: "azure-resourcemanager-oracledatabase" + # namespace: com.azure.resourcemanager.oracledatabase + # partial-update: true + # flavor: azure "@azure-tools/typespec-python": package-dir: "azure-mgmt-oracledatabase" package-name: "{package-dir}" diff --git a/specification/oracle/resource-manager/readme.java.md b/specification/oracle/resource-manager/readme.java.md index d779212fdcc0..aa511b93e4ad 100644 --- a/specification/oracle/resource-manager/readme.java.md +++ b/specification/oracle/resource-manager/readme.java.md @@ -5,5 +5,5 @@ These settings apply only when `--java` is specified on the command line. ``` yaml $(java) client-flattened-annotation-target: disabled uuid-as-string: true -stream-style-serialization: true +output-model-immutable: true ``` diff --git a/specification/scvmm/resource-manager/readme.java.md b/specification/scvmm/resource-manager/readme.java.md index 5748f31393b0..eabda07cf99a 100644 --- a/specification/scvmm/resource-manager/readme.java.md +++ b/specification/scvmm/resource-manager/readme.java.md @@ -7,5 +7,5 @@ title: SCVMMClient description: "SCVMM Client" client-flattened-annotation-target: disabled uuid-as-string: true -stream-style-serialization: true +output-model-immutable: true ``` From e6bcee165b6e15c62b661b8eccbcd560dbc63549 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 19 Jun 2024 06:34:42 -0700 Subject: [PATCH 204/343] Go back to azure-ai-inference package name --- specification/ai/ModelClient/tspconfig.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index b2b3c1054c0d..a26f4bb590e9 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -20,6 +20,6 @@ options: output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" "@azure-tools/typespec-python": package-mode: dataplane - package-dir: "azure-ai-runtime-inference" + package-dir: "azure-ai-inference" package-name: "{package-dir}" flavor: azure From 186c1ebb4b84a7127bfd347941aee1f07e0b2fca Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 19 Jun 2024 07:38:40 -0700 Subject: [PATCH 205/343] Remove api-key auth --- .../GetChatCompletions_MaximumSet_Gen.json | 24 +- .../GetChatCompletions_MinimumSet_Gen.json | 16 +- .../GetEmbeddings_MaximumSet_Gen.json | 18 +- .../GetEmbeddings_MinimumSet_Gen.json | 16 +- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 +- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 +- .../GetModelInfo_MaximumSet_Gen.json | 4 +- .../GetModelInfo_MinimumSet_Gen.json | 4 +- specification/ai/ModelClient/main.tsp | 3 +- .../ModelClient/models/chat_completions.tsp | 234 +++++++++--------- .../ai/ModelClient/models/common.tsp | 28 +-- .../ai/ModelClient/models/embeddings.tsp | 26 +- .../ModelClient/models/image_embeddings.tsp | 38 +-- specification/ai/ModelClient/routes.tsp | 28 +-- .../GetChatCompletions_MaximumSet_Gen.json | 24 +- .../GetChatCompletions_MinimumSet_Gen.json | 16 +- .../GetEmbeddings_MaximumSet_Gen.json | 18 +- .../GetEmbeddings_MinimumSet_Gen.json | 16 +- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 +- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 +- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +- .../preview/2024-05-01-preview/openapi.json | 8 - 23 files changed, 296 insertions(+), 305 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index 628a8ffcba69..1daf23c01717 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, + "frequency_penalty": 1, "stream": true, "presence_penalty": -2, "temperature": 0, @@ -18,38 +18,38 @@ "max_tokens": 0, "response_format": "text", "stop": [ - "dtkmhtrwtadjcn" + "wweqvyuu" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 22 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "hnnexvpxbxbbhouyyrebztae", - "created": 15, - "model": "ztdoenkqeuvcjnhwuvl", + "id": "xcjpjdpmiysj", + "created": 18, + "model": "lglvjvjgmdddzihtvmcbnvkyhjzra", "usage": { - "completion_tokens": 18, - "prompt_tokens": 28, - "total_tokens": 24 + "completion_tokens": 30, + "prompt_tokens": 22, + "total_tokens": 28 }, "choices": [ { - "index": 27, + "index": 3, "finish_reason": "stop", "message": { "role": "system", - "content": "rgjrjvxvimmgqfezque", + "content": "divildjbudgnfdwwmghwehkxer", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "jqsmltehjfkxf" + "id": "lfxfzpbpxpiaadkiaatsbxymuyhysl" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index 691358f346e7..d15787f43508 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "hnnexvpxbxbbhouyyrebztae", - "created": 15, - "model": "ztdoenkqeuvcjnhwuvl", + "id": "xcjpjdpmiysj", + "created": 18, + "model": "lglvjvjgmdddzihtvmcbnvkyhjzra", "usage": { - "completion_tokens": 18, - "prompt_tokens": 28, - "total_tokens": 24 + "completion_tokens": 30, + "prompt_tokens": 22, + "total_tokens": 28 }, "choices": [ { - "index": 27, + "index": 3, "finish_reason": "stop", "message": { "role": "system", - "content": "rgjrjvxvimmgqfezque" + "content": "divildjbudgnfdwwmghwehkxer" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index e8c68b509c51..0cf36eb1079b 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "g" + "hrppmaq" ], - "dimensions": 9, + "dimensions": 28, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "hrzmwfxztaxekeuthsktbs", + "id": "oy", "data": [ { "embedding": [ - 17 + 13 ], - "index": 3 + "index": 11 } ], "usage": { - "input_tokens": 17, - "prompt_tokens": 11, - "total_tokens": 12 + "input_tokens": 3, + "prompt_tokens": 22, + "total_tokens": 20 }, - "model": "vlhzbxcly" + "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index dec57071f6cf..3ddf2339e771 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "bbvbzqhmvubujvromttbfphl" + "ljibozyqlurpe" ] } }, "responses": { "200": { "body": { - "id": "hrzmwfxztaxekeuthsktbs", + "id": "oy", "data": [ { "embedding": [ - 17 + 13 ], - "index": 3 + "index": 11 } ], "usage": { - "input_tokens": 17, - "prompt_tokens": 11, - "total_tokens": 12 + "input_tokens": 3, + "prompt_tokens": 22, + "total_tokens": 20 }, - "model": "vlhzbxcly" + "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index d9a3452b6f53..3b795f6e1575 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "knopxwjjsihgk", - "text": "bnpyvsxyyrbqivjudxwliul" + "image": "sfhihwmxxiu", + "text": "pnwbh" } ], - "dimensions": 11, + "dimensions": 3, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "hrzmwfxztaxekeuthsktbs", + "id": "oy", "data": [ { "embedding": [ - 17 + 13 ], - "index": 3 + "index": 11 } ], "usage": { - "input_tokens": 17, - "prompt_tokens": 11, - "total_tokens": 12 + "input_tokens": 3, + "prompt_tokens": 22, + "total_tokens": 20 }, - "model": "vlhzbxcly" + "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 05cc9271e602..8901e88a1ffd 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "knopxwjjsihgk" + "image": "sfhihwmxxiu" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "hrzmwfxztaxekeuthsktbs", + "id": "oy", "data": [ { "embedding": [ - 17 + 13 ], - "index": 3 + "index": 11 } ], "usage": { - "input_tokens": 17, - "prompt_tokens": 11, - "total_tokens": 12 + "input_tokens": 3, + "prompt_tokens": 22, + "total_tokens": 20 }, - "model": "vlhzbxcly" + "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index 011684b0d4a9..c0831624b3a8 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "sqwvxjoxvdglyzazzbqi", + "model_name": "dwohhribkeyagqneghlwsmutopdrd", "model_type": "embeddings", - "model_provider_name": "brcafsevsrrnjvbtv" + "model_provider_name": "ioclhlabtzxqakbxyuejelssomftb" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index dd0668d0bde1..7c94a2db5b14 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "sqwvxjoxvdglyzazzbqi", + "model_name": "dwohhribkeyagqneghlwsmutopdrd", "model_type": "embeddings", - "model_provider_name": "brcafsevsrrnjvbtv" + "model_provider_name": "ioclhlabtzxqakbxyuejelssomftb" } } } diff --git a/specification/ai/ModelClient/main.tsp b/specification/ai/ModelClient/main.tsp index 6f818f00b9a3..aa9695d23cab 100644 --- a/specification/ai/ModelClient/main.tsp +++ b/specification/ai/ModelClient/main.tsp @@ -8,10 +8,9 @@ using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.Core; -// Once MaaP/MaaS endpoints support "api-key" header, we can remove BearerAuth from here #suppress "@azure-tools/typespec-autorest/unsupported-http-auth-scheme" @useAuth( - ApiKeyAuth | BearerAuth | OAuth2Auth<[ + BearerAuth | OAuth2Auth<[ { type: OAuth2FlowType.implicit, authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 6de8a3f1003a..044165ceca7a 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -11,62 +11,62 @@ namespace ModelClient; alias ChatCompletionsOptions = { @doc(""" - The collection of context messages associated with this chat completions request. - Typical usage begins with a chat message for the System role that provides instructions for - the behavior of the assistant, followed by alternating messages between the User and - Assistant roles. - """) + The collection of context messages associated with this chat completions request. + Typical usage begins with a chat message for the System role that provides instructions for + the behavior of the assistant, followed by alternating messages between the User and + Assistant roles. + """) @minItems(1) messages: ChatRequestMessage[]; @doc(""" - A value that influences the probability of generated tokens appearing based on their cumulative - frequency in generated text. - Positive values will make tokens less likely to appear as their frequency increases and - decrease the likelihood of the model repeating the same statements verbatim. - Supported range is [-2, 2]. - """) + A value that influences the probability of generated tokens appearing based on their cumulative + frequency in generated text. + Positive values will make tokens less likely to appear as their frequency increases and + decrease the likelihood of the model repeating the same statements verbatim. + Supported range is [-2, 2]. + """) @maxValue(2.0) @minValue(-2.0) frequency_penalty?: float32 = 0.0; @doc(""" - A value indicating whether chat completions should be streamed for this request. - """) + A value indicating whether chat completions should be streamed for this request. + """) stream?: boolean; @doc(""" - A value that influences the probability of generated tokens appearing based on their existing - presence in generated text. - Positive values will make tokens less likely to appear when they already exist and increase the - model's likelihood to output new topics. - Supported range is [-2, 2]. - """) + A value that influences the probability of generated tokens appearing based on their existing + presence in generated text. + Positive values will make tokens less likely to appear when they already exist and increase the + model's likelihood to output new topics. + Supported range is [-2, 2]. + """) @maxValue(2.0) @minValue(-2.0) presence_penalty?: float32 = 0.0; @doc(""" - The sampling temperature to use that controls the apparent creativity of generated completions. - Higher values will make output more random while lower values will make results more focused - and deterministic. - It is not recommended to modify temperature and top_p for the same completions request as the - interaction of these two settings is difficult to predict. - Supported range is [0, 1]. - """) + The sampling temperature to use that controls the apparent creativity of generated completions. + Higher values will make output more random while lower values will make results more focused + and deterministic. + It is not recommended to modify temperature and top_p for the same completions request as the + interaction of these two settings is difficult to predict. + Supported range is [0, 1]. + """) @maxValue(1.0) @minValue(0.0) temperature?: float32 = 0.7; @doc(""" - An alternative to sampling with temperature called nucleus sampling. This value causes the - model to consider the results of tokens with the provided probability mass. As an example, a - value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be - considered. - It is not recommended to modify temperature and top_p for the same completions request as the - interaction of these two settings is difficult to predict. - Supported range is [0, 1]. - """) + An alternative to sampling with temperature called nucleus sampling. This value causes the + model to consider the results of tokens with the provided probability mass. As an example, a + value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be + considered. + It is not recommended to modify temperature and top_p for the same completions request as the + interaction of these two settings is difficult to predict. + Supported range is [0, 1]. + """) @maxValue(1.0) @minValue(0.0) top_p?: float32 = 1.0; @@ -90,14 +90,14 @@ alias ChatCompletionsOptions = { @encodedName("application/json", "tool_choice") @doc(""" - If specified, the model will configure which of the provided tools it can use for the chat completions response. - """) + If specified, the model will configure which of the provided tools it can use for the chat completions response. + """) toolChoice?: ChatCompletionsToolSelection; @doc(""" - If specified, the system will make a best effort to sample deterministically such that repeated requests with the - same seed and parameters should return the same result. Determinism is not guaranteed." - """) + If specified, the system will make a best effort to sample deterministically such that repeated requests with the + same seed and parameters should return the same result. Determinism is not guaranteed." + """) seed?: int64; }; @@ -119,16 +119,16 @@ alias ChatCompletionsCommon = { `model`: string; @doc(""" - Usage information for tokens processed and generated as part of this completions operation. - """) + Usage information for tokens processed and generated as part of this completions operation. + """) usage: CompletionsUsage; }; @doc(""" -Representation of the response data from a chat completions request. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") + Representation of the response data from a chat completions request. + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. + """) model ChatCompletions { ...ChatCompletionsCommon; @@ -142,11 +142,11 @@ model ChatCompletions { } @doc(""" -Represents a response update to a chat completions request, when the service is streaming updates -using Server Sent Events (SSE). -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. -""") + Represents a response update to a chat completions request, when the service is streaming updates + using Server Sent Events (SSE). + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. + """) model StreamingChatCompletionsUpdate { ...ChatCompletionsCommon; @@ -160,10 +160,10 @@ model StreamingChatCompletionsUpdate { } @doc(""" -Representation of the token counts processed for a completions request. -Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and -other consumers. -""") + Representation of the token counts processed for a completions request. + Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and + other consumers. + """) model CompletionsUsage { @doc("The number of tokens generated across all completions emissions.") completion_tokens: int32; @@ -176,8 +176,8 @@ model CompletionsUsage { } @doc(""" -Representation of the manner in which a completions response concluded. -""") + Representation of the manner in which a completions response concluded. + """) union CompletionsFinishReason { string, @@ -215,21 +215,21 @@ union ChatRole { } @doc(""" -An representation of a response format configuration usable by Chat Completions. Can be used to enable JSON -mode. -""") + An representation of a response format configuration usable by Chat Completions. Can be used to enable JSON + mode. + """) union ChatCompletionsResponseFormat { string, @doc(""" - The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response - content that adheres to a specific schema. - """) + The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response + content that adheres to a specific schema. + """) text: "text", @doc(""" - A response format for Chat Completions that restricts responses to emitting valid JSON objects. - """) + A response format for Chat Completions that restricts responses to emitting valid JSON objects. + """) json_object: "json_object", } @@ -244,10 +244,10 @@ alias ChatChoiceCommon = { }; @doc(""" -The representation of a single prompt completion as part of an overall chat completions request. -Generally, `n` choices are generated per provided prompt with a default value of 1. -Token limits and other settings may limit the number of choices generated. -""") + The representation of a single prompt completion as part of an overall chat completions request. + Generally, `n` choices are generated per provided prompt with a default value of 1. + Token limits and other settings may limit the number of choices generated. + """) model ChatChoice { ...ChatChoiceCommon; @@ -256,11 +256,11 @@ model ChatChoice { } @doc(""" -Represents an update to a single prompt completion when the service is streaming updates -using Server Sent Events (SSE). -Generally, `n` choices are generated per provided prompt with a default value of 1. -Token limits and other settings may limit the number of choices generated. -""") + Represents an update to a single prompt completion when the service is streaming updates + using Server Sent Events (SSE). + Generally, `n` choices are generated per provided prompt with a default value of 1. + Token limits and other settings may limit the number of choices generated. + """) model StreamingChatChoiceUpdate { ...ChatChoiceCommon; @@ -276,9 +276,9 @@ model ChatRequestMessage { } @doc(""" -A request chat message containing system instructions that influence how the model will generate a chat completions -response. -""") + A request chat message containing system instructions that influence how the model will generate a chat completions + response. + """) model ChatRequestSystemMessage extends ChatRequestMessage { @doc("The chat role associated with this message, which is always 'system' for system messages.") role: ChatRole.system; @@ -308,9 +308,9 @@ model ChatRequestAssistantMessage extends ChatRequestMessage { @encodedName("application/json", "tool_calls") @doc(""" - The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat - completions request to resolve as configured. - """) + The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat + completions request to resolve as configured. + """) toolCalls?: ChatCompletionsToolCall[]; } @@ -339,9 +339,9 @@ model ChatResponseMessage { @encodedName("application/json", "tool_calls") @doc(""" - The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat - completions request to resolve as configured. - """) + The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat + completions request to resolve as configured. + """) toolCalls?: ChatCompletionsToolCall[]; } @@ -355,20 +355,20 @@ union ChatCompletionsToolSelectionPreset { string, @doc(""" - Specifies that the model may either use any of the tools provided in this chat completions request or - instead return a standard chat completions response as if no tools were provided. - """) + Specifies that the model may either use any of the tools provided in this chat completions request or + instead return a standard chat completions response as if no tools were provided. + """) auto: "auto", @doc(""" - Specifies that the model should not respond with a tool call and should instead provide a standard chat - completions response. Response content may still be influenced by the provided tool definitions. - """) + Specifies that the model should not respond with a tool call and should instead provide a standard chat + completions response. Response content may still be influenced by the provided tool definitions. + """) none: "none", @doc(""" - Specifies that the model should respond with a call to one or more tools. - """) + Specifies that the model should respond with a call to one or more tools. + """) required: "required", } @@ -403,8 +403,8 @@ model ChatCompletionsToolDefinition { } @doc(""" -The definition information for a chat completions function tool that can call a function in response to a tool call. -""") + The definition information for a chat completions function tool that can call a function in response to a tool call. + """) model ChatCompletionsFunctionToolDefinition extends ChatCompletionsToolDefinition { @doc("The object name, which is always 'function'.") @@ -415,16 +415,16 @@ model ChatCompletionsFunctionToolDefinition } @doc(""" -The definition of a caller-specified function that chat completions may invoke in response to matching user input. -""") + The definition of a caller-specified function that chat completions may invoke in response to matching user input. + """) model FunctionDefinition { @doc("The name of the function to be called.") name: string; @doc(""" - A description of what the function does. The model will use this description when selecting the function and - interpreting its parameters. - """) + A description of what the function does. The model will use this description when selecting the function and + interpreting its parameters. + """) description?: string; #suppress "@azure-tools/typespec-azure-core/no-unknown" "External API shape takes an arbitrary json" @@ -434,9 +434,9 @@ model FunctionDefinition { @discriminator("type") @doc(""" -An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested -chat completion. -""") + An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested + chat completion. + """) model ChatCompletionsToolCall { @doc("The object type.") type: string; @@ -446,9 +446,9 @@ model ChatCompletionsToolCall { } @doc(""" -A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents -a function invocation needed for a subsequent chat completions request to resolve. -""") + A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents + a function invocation needed for a subsequent chat completions request to resolve. + """) model ChatCompletionsFunctionToolCall extends ChatCompletionsToolCall { @doc("The type of tool call, in this case always 'function'.") type: "function"; @@ -463,11 +463,11 @@ model FunctionCall { name: string; @doc(""" - The arguments to call the function with, as generated by the model in JSON format. - Note that the model does not always generate valid JSON, and may hallucinate parameters - not defined by your function schema. Validate the arguments in your code before calling - your function. - """) + The arguments to call the function with, as generated by the model in JSON format. + Note that the model does not always generate valid JSON, and may hallucinate parameters + not defined by your function schema. Validate the arguments in your code before calling + your function. + """) arguments: string; } @@ -503,9 +503,9 @@ model ChatMessageImageUrl { url: url; @doc(""" - The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and - accuracy. - """) + The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and + accuracy. + """) detail?: ChatMessageImageDetailLevel; } @@ -517,14 +517,14 @@ union ChatMessageImageDetailLevel { auto: "auto", @doc(""" - Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer - tokens but may also be less accurate for highly detailed images. - """) + Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer + tokens but may also be less accurate for highly detailed images. + """) low: "low", @doc(""" - Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed - images but may also be slower and consume more tokens. - """) + Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed + images but may also be slower and consume more tokens. + """) high: "high", } diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index e40f5de07340..fa2f60d221e1 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -21,9 +21,9 @@ union EmbeddingInputType { } @doc(""" -The format of the embeddings result. -Returns a 422 error if the model doesn't support the value or parameter. -""") + The format of the embeddings result. + Returns a 422 error if the model doesn't support the value or parameter. + """) union EmbeddingEncodingFormat { string, @@ -47,10 +47,10 @@ union EmbeddingEncodingFormat { } @doc(""" -Representation of the response data from an embeddings request. -Embeddings measure the relatedness of text strings and are commonly used for search, clustering, -recommendations, and other similar scenarios. -""") + Representation of the response data from an embeddings request. + Embeddings measure the relatedness of text strings and are commonly used for search, clustering, + recommendations, and other similar scenarios. + """) model EmbeddingsResult { @doc("Unique identifier for the embeddings result.") id: string; @@ -89,10 +89,10 @@ model EmbeddingsUsage { input_tokens: int32; @doc(""" - Number of tokens used for the prompt sent to the AI model. Typically identical to `input_tokens`. - However, certain AI models may add extra tokens to the input hence the number can be higher. - (for example when input_type="query"). - """) + Number of tokens used for the prompt sent to the AI model. Typically identical to `input_tokens`. + However, certain AI models may add extra tokens to the input hence the number can be higher. + (for example when input_type="query"). + """) prompt_tokens: int32; @doc("Total number of tokens transacted in this request/response.") @@ -136,9 +136,9 @@ union ModelType { alias AdditionalRequestHeaders = { @doc(""" - Controls what happens if unknown parameters are passed in the JSON request payload. - This sets the HTTP request header `unknown-parameters`. - """) + Controls what happens if unknown parameters are passed in the JSON request payload. + This sets the HTTP request header `unknown-parameters`. + """) @header("unknown-parameters") unknown_params?: UnknownParams; }; diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index 3ff26946eda1..2d732863062b 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -8,27 +8,27 @@ namespace ModelClient; alias EmbeddingsOptions = { @doc(""" - Input text to embed, encoded as a string or array of tokens. - To embed multiple inputs in a single request, pass an array - of strings or array of token arrays. - """) + Input text to embed, encoded as a string or array of tokens. + To embed multiple inputs in a single request, pass an array + of strings or array of token arrays. + """) input: string[]; @doc(""" - Optional. The number of dimensions the resulting output embeddings should have. - Passing null causes the model to use its default value. - Returns a 422 error if the model doesn't support the value or parameter. - """) + Optional. The number of dimensions the resulting output embeddings should have. + Passing null causes the model to use its default value. + Returns a 422 error if the model doesn't support the value or parameter. + """) dimensions?: int32; @doc(""" - Optional. The desired format for the returned embeddings. - """) + Optional. The desired format for the returned embeddings. + """) encoding_format?: EmbeddingEncodingFormat; @doc(""" - Optional. The type of the input. - Returns a 422 error if the model doesn't support the value or parameter. - """) + Optional. The type of the input. + Returns a 422 error if the model doesn't support the value or parameter. + """) input_type?: EmbeddingInputType; }; diff --git a/specification/ai/ModelClient/models/image_embeddings.tsp b/specification/ai/ModelClient/models/image_embeddings.tsp index 1f0daa56302e..15826bbc28e5 100644 --- a/specification/ai/ModelClient/models/image_embeddings.tsp +++ b/specification/ai/ModelClient/models/image_embeddings.tsp @@ -8,42 +8,42 @@ namespace ModelClient; alias ImageEmbeddingsOptions = { @doc(""" - Input image to embed. To embed multiple inputs in a single request, pass an array. - The input must not exceed the max input tokens for the model. - """) + Input image to embed. To embed multiple inputs in a single request, pass an array. + The input must not exceed the max input tokens for the model. + """) input: EmbeddingInput[]; @doc(""" - Optional. The number of dimensions the resulting output embeddings should have. - Passing null causes the model to use its default value. - Returns a 422 error if the model doesn't support the value or parameter. - """) + Optional. The number of dimensions the resulting output embeddings should have. + Passing null causes the model to use its default value. + Returns a 422 error if the model doesn't support the value or parameter. + """) dimensions?: int32; @doc(""" - Optional. The number of dimensions the resulting output embeddings should have. - Passing null causes the model to use its default value. - Returns a 422 error if the model doesn't support the value or parameter. - """) + Optional. The number of dimensions the resulting output embeddings should have. + Passing null causes the model to use its default value. + Returns a 422 error if the model doesn't support the value or parameter. + """) encoding_format?: EmbeddingEncodingFormat; @doc(""" - Optional. The type of the input. - Returns a 422 error if the model doesn't support the value or parameter. - """) + Optional. The type of the input. + Returns a 422 error if the model doesn't support the value or parameter. + """) input_type?: EmbeddingInputType; }; @doc("Represents an image with optional text.") model EmbeddingInput { @doc(""" - The input image, in PNG format. - """) + The input image, in PNG format. + """) image: string; @doc(""" - Optional. The text input to feed into the model (like DINO, CLIP). - Returns a 422 error if the model doesn't support the value or parameter. - """) + Optional. The text input to feed into the model (like DINO, CLIP). + Returns a 422 error if the model doesn't support the value or parameter. + """) text?: string; } diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 2cf9b5378f25..7279e2f66871 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -16,11 +16,11 @@ using Azure.Core; namespace ModelClient; @doc(""" -Gets chat completions for the provided chat messages. -Completions support a wide variety of tasks and generate text that continues from or "completes" -provided prompt data. The method makes a REST API call to the `/chat/completions` route -on the given endpoint. -""") + Gets chat completions for the provided chat messages. + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. The method makes a REST API call to the `/chat/completions` route + on the given endpoint. + """) @actionSeparator("/") @route("chat/completions") op getChatCompletions is Azure.Core.RpcOperation< @@ -32,9 +32,9 @@ op getChatCompletions is Azure.Core.RpcOperation< >; @doc(""" -Return the embedding vectors for given text prompts. -The method makes a REST API call to the `/embeddings` route on the given endpoint. -""") + Return the embedding vectors for given text prompts. + The method makes a REST API call to the `/embeddings` route on the given endpoint. + """) @actionSeparator("/") @route("embeddings") op getEmbeddings is Azure.Core.RpcOperation< @@ -46,9 +46,9 @@ op getEmbeddings is Azure.Core.RpcOperation< >; @doc(""" -Return the embedding vectors for given images. -The method makes a REST API call to the `/images/embeddings` route on the given endpoint. -""") + Return the embedding vectors for given images. + The method makes a REST API call to the `/images/embeddings` route on the given endpoint. + """) @actionSeparator("/") @route("images/embeddings") op getImageEmbeddings is Azure.Core.RpcOperation< @@ -60,9 +60,9 @@ op getImageEmbeddings is Azure.Core.RpcOperation< >; @doc(""" -Returns information about the AI model. -The method makes a REST API call to the `/info` route on the given endpoint. -""") + Returns information about the AI model. + The method makes a REST API call to the `/info` route on the given endpoint. + """) @actionSeparator("/") @route("info") @get diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 628a8ffcba69..1daf23c01717 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, + "frequency_penalty": 1, "stream": true, "presence_penalty": -2, "temperature": 0, @@ -18,38 +18,38 @@ "max_tokens": 0, "response_format": "text", "stop": [ - "dtkmhtrwtadjcn" + "wweqvyuu" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 22 + "seed": 21 } }, "responses": { "200": { "body": { - "id": "hnnexvpxbxbbhouyyrebztae", - "created": 15, - "model": "ztdoenkqeuvcjnhwuvl", + "id": "xcjpjdpmiysj", + "created": 18, + "model": "lglvjvjgmdddzihtvmcbnvkyhjzra", "usage": { - "completion_tokens": 18, - "prompt_tokens": 28, - "total_tokens": 24 + "completion_tokens": 30, + "prompt_tokens": 22, + "total_tokens": 28 }, "choices": [ { - "index": 27, + "index": 3, "finish_reason": "stop", "message": { "role": "system", - "content": "rgjrjvxvimmgqfezque", + "content": "divildjbudgnfdwwmghwehkxer", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "jqsmltehjfkxf" + "id": "lfxfzpbpxpiaadkiaatsbxymuyhysl" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 691358f346e7..d15787f43508 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "hnnexvpxbxbbhouyyrebztae", - "created": 15, - "model": "ztdoenkqeuvcjnhwuvl", + "id": "xcjpjdpmiysj", + "created": 18, + "model": "lglvjvjgmdddzihtvmcbnvkyhjzra", "usage": { - "completion_tokens": 18, - "prompt_tokens": 28, - "total_tokens": 24 + "completion_tokens": 30, + "prompt_tokens": 22, + "total_tokens": 28 }, "choices": [ { - "index": 27, + "index": 3, "finish_reason": "stop", "message": { "role": "system", - "content": "rgjrjvxvimmgqfezque" + "content": "divildjbudgnfdwwmghwehkxer" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index e8c68b509c51..0cf36eb1079b 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "g" + "hrppmaq" ], - "dimensions": 9, + "dimensions": 28, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "hrzmwfxztaxekeuthsktbs", + "id": "oy", "data": [ { "embedding": [ - 17 + 13 ], - "index": 3 + "index": 11 } ], "usage": { - "input_tokens": 17, - "prompt_tokens": 11, - "total_tokens": 12 + "input_tokens": 3, + "prompt_tokens": 22, + "total_tokens": 20 }, - "model": "vlhzbxcly" + "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index dec57071f6cf..3ddf2339e771 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "bbvbzqhmvubujvromttbfphl" + "ljibozyqlurpe" ] } }, "responses": { "200": { "body": { - "id": "hrzmwfxztaxekeuthsktbs", + "id": "oy", "data": [ { "embedding": [ - 17 + 13 ], - "index": 3 + "index": 11 } ], "usage": { - "input_tokens": 17, - "prompt_tokens": 11, - "total_tokens": 12 + "input_tokens": 3, + "prompt_tokens": 22, + "total_tokens": 20 }, - "model": "vlhzbxcly" + "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index d9a3452b6f53..3b795f6e1575 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "knopxwjjsihgk", - "text": "bnpyvsxyyrbqivjudxwliul" + "image": "sfhihwmxxiu", + "text": "pnwbh" } ], - "dimensions": 11, + "dimensions": 3, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "hrzmwfxztaxekeuthsktbs", + "id": "oy", "data": [ { "embedding": [ - 17 + 13 ], - "index": 3 + "index": 11 } ], "usage": { - "input_tokens": 17, - "prompt_tokens": 11, - "total_tokens": 12 + "input_tokens": 3, + "prompt_tokens": 22, + "total_tokens": 20 }, - "model": "vlhzbxcly" + "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 05cc9271e602..8901e88a1ffd 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "knopxwjjsihgk" + "image": "sfhihwmxxiu" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "hrzmwfxztaxekeuthsktbs", + "id": "oy", "data": [ { "embedding": [ - 17 + 13 ], - "index": 3 + "index": 11 } ], "usage": { - "input_tokens": 17, - "prompt_tokens": 11, - "total_tokens": 12 + "input_tokens": 3, + "prompt_tokens": 22, + "total_tokens": 20 }, - "model": "vlhzbxcly" + "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 011684b0d4a9..c0831624b3a8 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "sqwvxjoxvdglyzazzbqi", + "model_name": "dwohhribkeyagqneghlwsmutopdrd", "model_type": "embeddings", - "model_provider_name": "brcafsevsrrnjvbtv" + "model_provider_name": "ioclhlabtzxqakbxyuejelssomftb" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index dd0668d0bde1..7c94a2db5b14 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "sqwvxjoxvdglyzazzbqi", + "model_name": "dwohhribkeyagqneghlwsmutopdrd", "model_type": "embeddings", - "model_provider_name": "brcafsevsrrnjvbtv" + "model_provider_name": "ioclhlabtzxqakbxyuejelssomftb" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json index a6d6dd598ce0..e7a769627aa4 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json @@ -19,9 +19,6 @@ "application/json" ], "security": [ - { - "ApiKeyAuth": [] - }, { "OAuth2Auth": [ "https://ml.azure.com/.default" @@ -29,11 +26,6 @@ } ], "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "api-key", - "in": "header" - }, "OAuth2Auth": { "type": "oauth2", "flow": "implicit", From d15d528c272bda96ecee82003d06998ca1efea4f Mon Sep 17 00:00:00 2001 From: Chaofan Yang <140705226+mschaofan@users.noreply.github.com> Date: Thu, 20 Jun 2024 00:48:25 +0800 Subject: [PATCH 206/343] Update description of runId to infer customer to use new GUID for create run (#29447) * Update description of runId to infer customer to use new GUID for create run * Refine description --- .../preview/2022-03-01-preview/runNotebook.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/runNotebook.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/runNotebook.json index 4c119c292946..bc8b214b37c0 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/runNotebook.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/runNotebook.json @@ -534,7 +534,7 @@ "maxLength": 100, "required": true, "type": "string", - "description": "Notebook run id.", + "description": "Notebook run id. For Create Run, you can generate a new GUID and use it here. For other actions, this is the same ID used in Create Run.", "x-ms-parameter-location": "method" }, "Endpoint": { From b48d5d72073a296514d3d4db77887d8711526ccc Mon Sep 17 00:00:00 2001 From: GuptaVertika <149072034+GuptaVertika@users.noreply.github.com> Date: Wed, 19 Jun 2024 23:36:52 +0530 Subject: [PATCH 207/343] Guptavertika/release network microsoft.network official 2024 01 01 (#29302) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Adds base for updating Microsoft.Network from version stable/2023-11-01 to version 2024-01-01 * Updates readme * Updates API version in new specs and examples * Add examples for Subnet peering and v6 Subnet peering. (#28827) Add examples for Subnet peering and v6 Subnet peering. --------- Co-authored-by: saurabh83 * Init (#29127) Co-authored-by: Abhishek Shah * Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 (#29048) Co-authored-by: Arsheen Khatib (from Dev Box) * Added NoHealthyBackendsBehavior (#28868) Added the property "NoHealthyBackendsBehavior" to the Probe properties. * VirtualNetworkGatewayConnection using key vault for authentication. (#28760) * Add parameters for cert based auth connection * retrigger checks * retrigger checks * lintDiff * Trigger Build * revert PATCH changes * fix * change managed identity to v5 * add format and description * rresolving conflict * resolving readme file * Revert "VirtualNetworkGatewayConnection using key vault for authentication. (#28760)" This reverts commit c37ec243f1ed3abf88fb923eeee02d93d646a7c7. * Lint diff error suppress * Guptavertika/release network microsoft.network official 2024 01 01 (#29367) * added networkidentifier under vnet->subet->serviceendpoint * added format :armid and updated description * corrected the type * fixed response * response type fixed example --------- Co-authored-by: Bhupesh Bhatt * Adding GET operaton for Network Virtual Appliance Inbound Secuirty Rule (#29339) (#29375) * Fix for PR VirtualNetworkGatewayConnection using key vault for authentication. (#29357) (#29376) * Fix * Fix2 --------- Co-authored-by: Khushboo Baheti * Add CrossConnection Name as an optional query parameter in List ExpressRoute CrossConnection (#29251) * Add CrossConnection name as an optional query parameter for List CrossConnection * update example * Addressing comments * Change to OData filtering * Fix the parameter reference * Update --------- Co-authored-by: Jianqi Zhao * initial changes (#29235) * Changed type of networkIdentifier from PublicIPAddress to SubResource (#29469) * added networkidentifier under vnet->subet->serviceendpoint * added format :armid and updated description * corrected the type * fixed response * response type fixed example * Changed type of networkIdentifier from ./publicIpAddress.json#/definitions/PublicIPAddress to ./network.json#/definitions/SubResource --------- Co-authored-by: Bhupesh Bhatt --------- Co-authored-by: saurabh83 Co-authored-by: saurabh83 Co-authored-by: Abhishek Shah <16267081+abhi7860@users.noreply.github.com> Co-authored-by: Abhishek Shah Co-authored-by: AFK1194 Co-authored-by: Arsheen Khatib (from Dev Box) Co-authored-by: Eugenio Peña García <70240915+EugenioPena@users.noreply.github.com> Co-authored-by: daweiwang-microsoft <165709729+daweiwang-microsoft@users.noreply.github.com> Co-authored-by: Bhupesh Kumar Bhatt <52891188+bhupeshbhatt1985@users.noreply.github.com> Co-authored-by: Bhupesh Bhatt Co-authored-by: Ashutosh Mishra <163998769+ashutmi@users.noreply.github.com> Co-authored-by: Khushboo Baheti <37917868+Khushboo-Baheti@users.noreply.github.com> Co-authored-by: Khushboo Baheti Co-authored-by: jianzhao1992 <125631957+jianzhao1992@users.noreply.github.com> Co-authored-by: Jianqi Zhao Co-authored-by: nimaller <71352534+nimaller@users.noreply.github.com> --- .../VirtualNetworkSubnetPeeringCreate.json | 145 + .../VirtualNetworkSubnetPeeringGet.json | 65 + .../VirtualNetworkSubnetPeeringSync.json | 133 + .../VirtualNetworkV6SubnetPeeringCreate.json | 137 + .../VirtualNetworkV6SubnetPeeringGet.json | 61 + .../VirtualNetworkV6SubnetPeeringSync.json | 125 + .../stable/2023-11-01/virtualNetwork.json | 18 + .../stable/2024-01-01/applicationGateway.json | 4058 +++++++ ...applicationGatewayWafDynamicManifests.json | 257 + .../2024-01-01/applicationSecurityGroup.json | 406 + .../2024-01-01/availableDelegations.json | 178 + .../2024-01-01/availableServiceAliases.json | 171 + .../stable/2024-01-01/azureFirewall.json | 1342 +++ .../2024-01-01/azureFirewallFqdnTag.json | 130 + .../stable/2024-01-01/azureWebCategory.json | 184 + .../stable/2024-01-01/bastionHost.json | 1114 ++ .../2024-01-01/checkDnsAvailability.json | 96 + .../cloudServiceNetworkInterface.json | 222 + .../cloudServicePublicIpAddress.json | 241 + .../stable/2024-01-01/cloudServiceSwap.json | 280 + .../stable/2024-01-01/customIpPrefix.json | 522 + .../stable/2024-01-01/ddosCustomPolicy.json | 310 + .../stable/2024-01-01/ddosProtectionPlan.json | 450 + .../stable/2024-01-01/dscpConfiguration.json | 513 + .../stable/2024-01-01/endpointService.json | 119 + ...tionGatewayAvailableRequestHeadersGet.json | 13 + ...ionGatewayAvailableResponseHeadersGet.json | 13 + ...ionGatewayAvailableServerVariablesGet.json | 13 + ...licationGatewayAvailableSslOptionsGet.json | 64 + ...ilableSslOptionsPredefinedPoliciesGet.json | 101 + ...vailableSslOptionsPredefinedPolicyGet.json | 48 + ...icationGatewayAvailableWafRuleSetsGet.json | 37 + .../ApplicationGatewayBackendHealthGet.json | 61 + .../ApplicationGatewayBackendHealthTest.json | 49 + .../examples/ApplicationGatewayCreate.json | 778 ++ .../examples/ApplicationGatewayDelete.json | 17 + .../examples/ApplicationGatewayGet.json | 389 + .../examples/ApplicationGatewayList.json | 392 + .../examples/ApplicationGatewayListAll.json | 391 + ...atewayPrivateEndpointConnectionDelete.json | 18 + ...onGatewayPrivateEndpointConnectionGet.json | 29 + ...nGatewayPrivateEndpointConnectionList.json | 32 + ...atewayPrivateEndpointConnectionUpdate.json | 40 + ...icationGatewayPrivateLinkResourceList.json | 28 + .../examples/ApplicationGatewayStart.json | 16 + .../examples/ApplicationGatewayStop.json | 16 + .../ApplicationGatewayUpdateTags.json | 148 + .../ApplicationSecurityGroupCreate.json | 38 + .../ApplicationSecurityGroupDelete.json | 13 + .../examples/ApplicationSecurityGroupGet.json | 22 + .../ApplicationSecurityGroupList.json | 35 + .../ApplicationSecurityGroupListAll.json | 34 + .../ApplicationSecurityGroupUpdateTags.json | 33 + .../AutoApprovedPrivateLinkServicesGet.json | 24 + ...edPrivateLinkServicesResourceGroupGet.json | 25 + .../AvailableDelegationsResourceGroupGet.json | 25 + .../AvailableDelegationsSubscriptionGet.json | 24 + .../AvailablePrivateEndpointTypesGet.json | 20 + ...ePrivateEndpointTypesResourceGroupGet.json | 21 + .../examples/AvailableServiceAliasesList.json | 27 + ...ableServiceAliasesListByResourceGroup.json | 28 + .../examples/AzureFirewallDelete.json | 13 + ...ureFirewallFqdnTagsListBySubscription.json | 28 + .../2024-01-01/examples/AzureFirewallGet.json | 177 + ...reFirewallGetWithAdditionalProperties.json | 179 + .../AzureFirewallGetWithIpGroups.json | 189 + .../AzureFirewallGetWithMgmtSubnet.json | 190 + .../examples/AzureFirewallGetWithZones.json | 181 + .../AzureFirewallListByResourceGroup.json | 193 + .../AzureFirewallListBySubscription.json | 192 + .../AzureFirewallListLearnedIPPrefixes.json | 19 + .../examples/AzureFirewallPacketCapture.json | 59 + .../2024-01-01/examples/AzureFirewallPut.json | 497 + .../examples/AzureFirewallPutInHub.json | 115 + ...reFirewallPutWithAdditionalProperties.json | 507 + .../AzureFirewallPutWithIpGroups.json | 505 + .../AzureFirewallPutWithMgmtSubnet.json | 507 + .../examples/AzureFirewallPutWithZones.json | 509 + .../examples/AzureFirewallUpdateTags.json | 33 + .../AzureWebCategoriesListBySubscription.json | 23 + .../examples/AzureWebCategoryGet.json | 20 + .../examples/BastionHostDelete.json | 17 + .../examples/BastionHostDeveloperDelete.json | 17 + .../examples/BastionHostDeveloperGet.json | 37 + .../examples/BastionHostDeveloperPut.json | 82 + .../2024-01-01/examples/BastionHostGet.json | 55 + .../examples/BastionHostGetWithZones.json | 58 + .../BastionHostListByResourceGroup.json | 95 + .../BastionHostListBySubscription.json | 119 + .../2024-01-01/examples/BastionHostPatch.json | 66 + .../2024-01-01/examples/BastionHostPut.json | 113 + .../examples/BastionHostPutWithZones.json | 116 + .../examples/BastionSessionDelete.json | 36 + .../examples/BastionSessionsList.json | 34 + .../examples/BastionShareableLinkCreate.json | 49 + .../examples/BastionShareableLinkDelete.json | 30 + .../BastionShareableLinkDeleteByToken.json | 21 + .../examples/BastionShareableLinkGet.json | 44 + .../examples/CheckDnsNameAvailability.json | 15 + .../CheckPrivateLinkServiceVisibility.json | 18 + ...eLinkServiceVisibilityByResourceGroup.json | 19 + .../CloudServiceNetworkInterfaceGet.json | 62 + .../CloudServiceNetworkInterfaceList.json | 112 + .../examples/CloudServicePublicIpGet.json | 34 + .../examples/CloudServicePublicIpListAll.json | 52 + ...rviceRoleInstanceNetworkInterfaceList.json | 65 + .../CloudServiceRoleInstancePublicIpList.json | 37 + .../examples/CloudServiceSwapGet.json | 21 + .../examples/CloudServiceSwapList.json | 24 + .../examples/CloudServiceSwapPut.json | 18 + .../ConfigurationPolicyGroupDelete.json | 14 + .../examples/ConfigurationPolicyGroupGet.json | 41 + ...licyGroupListByVpnServerConfiguration.json | 66 + .../examples/ConfigurationPolicyGroupPut.json | 82 + .../CustomIpPrefixCreateCustomizedValues.json | 65 + .../examples/CustomIpPrefixDelete.json | 13 + .../examples/CustomIpPrefixGet.json | 32 + .../examples/CustomIpPrefixList.json | 122 + .../examples/CustomIpPrefixListAll.json | 264 + .../examples/CustomIpPrefixUpdateTags.json | 46 + .../examples/DdosCustomPolicyCreate.json | 37 + .../examples/DdosCustomPolicyDelete.json | 20 + .../examples/DdosCustomPolicyGet.json | 22 + .../examples/DdosCustomPolicyUpdateTags.json | 32 + .../examples/DdosProtectionPlanCreate.json | 42 + .../examples/DdosProtectionPlanDelete.json | 17 + .../examples/DdosProtectionPlanGet.json | 32 + .../examples/DdosProtectionPlanList.json | 55 + .../examples/DdosProtectionPlanListAll.json | 60 + .../DdosProtectionPlanUpdateTags.json | 34 + .../examples/DefaultSecurityRuleGet.json | 33 + .../examples/DefaultSecurityRuleList.json | 136 + .../examples/DscpConfigurationCreate.json | 231 + .../examples/DscpConfigurationDelete.json | 13 + .../examples/DscpConfigurationGet.json | 88 + .../examples/DscpConfigurationList.json | 167 + .../examples/DscpConfigurationListAll.json | 166 + .../EffectiveRoutesListForConnection.json | 50 + .../EffectiveRoutesListForRouteTable.json | 50 + .../EffectiveRoutesListForVirtualHub.json | 47 + .../examples/EndpointServicesList.json | 30 + .../ExpressRouteCircuitARPTableList.json | 29 + ...xpressRouteCircuitAuthorizationCreate.json | 36 + ...xpressRouteCircuitAuthorizationDelete.json | 18 + .../ExpressRouteCircuitAuthorizationGet.json | 24 + .../ExpressRouteCircuitAuthorizationList.json | 26 + .../ExpressRouteCircuitConnectionCreate.json | 74 + .../ExpressRouteCircuitConnectionDelete.json | 19 + .../ExpressRouteCircuitConnectionGet.json | 36 + .../ExpressRouteCircuitConnectionList.json | 54 + .../examples/ExpressRouteCircuitCreate.json | 84 + ...sRouteCircuitCreateOnExpressRoutePort.json | 87 + .../examples/ExpressRouteCircuitDelete.json | 17 + .../examples/ExpressRouteCircuitGet.json | 38 + ...xpressRouteCircuitListByResourceGroup.json | 91 + ...ExpressRouteCircuitListBySubscription.json | 90 + .../ExpressRouteCircuitPeeringCreate.json | 75 + .../ExpressRouteCircuitPeeringDelete.json | 18 + .../ExpressRouteCircuitPeeringGet.json | 61 + .../ExpressRouteCircuitPeeringList.json | 88 + .../ExpressRouteCircuitPeeringStats.json | 19 + .../ExpressRouteCircuitRouteTableList.json | 30 + ...ressRouteCircuitRouteTableSummaryList.json | 30 + .../examples/ExpressRouteCircuitStats.json | 18 + .../ExpressRouteCircuitUpdateTags.json | 48 + .../ExpressRouteConnectionCreate.json | 138 + .../ExpressRouteConnectionDelete.json | 14 + .../examples/ExpressRouteConnectionGet.json | 56 + .../examples/ExpressRouteConnectionList.json | 59 + ...sRouteCrossConnectionBgpPeeringCreate.json | 75 + ...sRouteCrossConnectionBgpPeeringDelete.json | 18 + ...ressRouteCrossConnectionBgpPeeringGet.json | 37 + ...essRouteCrossConnectionBgpPeeringList.json | 40 + .../ExpressRouteCrossConnectionGet.json | 32 + .../ExpressRouteCrossConnectionList.json | 34 + ...uteCrossConnectionListByResourceGroup.json | 34 + .../ExpressRouteCrossConnectionUpdate.json | 36 + ...ExpressRouteCrossConnectionUpdateTags.json | 41 + .../ExpressRouteCrossConnectionsArpTable.json | 29 + ...xpressRouteCrossConnectionsRouteTable.json | 37 + ...outeCrossConnectionsRouteTableSummary.json | 35 + .../examples/ExpressRouteGatewayCreate.json | 66 + .../examples/ExpressRouteGatewayDelete.json | 13 + .../examples/ExpressRouteGatewayGet.json | 26 + ...xpressRouteGatewayListByResourceGroup.json | 74 + ...ExpressRouteGatewayListBySubscription.json | 73 + .../ExpressRouteGatewayUpdateTags.json | 37 + .../examples/ExpressRouteLinkGet.json | 27 + .../examples/ExpressRouteLinkList.json | 44 + .../ExpressRoutePortAuthorizationCreate.json | 40 + .../ExpressRoutePortAuthorizationDelete.json | 14 + .../ExpressRoutePortAuthorizationGet.json | 25 + .../ExpressRoutePortAuthorizationList.json | 28 + .../examples/ExpressRoutePortCreate.json | 115 + .../examples/ExpressRoutePortDelete.json | 13 + .../examples/ExpressRoutePortGet.json | 60 + .../examples/ExpressRoutePortList.json | 62 + .../ExpressRoutePortListByResourceGroup.json | 63 + .../examples/ExpressRoutePortUpdateLink.json | 123 + .../examples/ExpressRoutePortUpdateTags.json | 64 + .../ExpressRoutePortsLocationGet.json | 28 + .../ExpressRoutePortsLocationList.json | 26 + .../examples/ExpressRouteProviderList.json | 60 + .../examples/FirewallPolicyDelete.json | 17 + .../examples/FirewallPolicyDraftDelete.json | 12 + .../examples/FirewallPolicyDraftDeploy.json | 16 + .../examples/FirewallPolicyDraftGet.json | 101 + .../examples/FirewallPolicyDraftPut.json | 281 + .../examples/FirewallPolicyGet.json | 123 + .../FirewallPolicyListByResourceGroup.json | 53 + .../FirewallPolicyListBySubscription.json | 52 + ...rewallPolicyNatRuleCollectionGroupGet.json | 54 + ...rewallPolicyNatRuleCollectionGroupPut.json | 133 + .../examples/FirewallPolicyPatch.json | 128 + .../examples/FirewallPolicyPut.json | 344 + ...FirewallPolicyQuerySignatureOverrides.json | 68 + ...cyQuerySignatureOverridesFilterValues.json | 22 + ...rewallPolicyRuleCollectionGroupDelete.json | 18 + ...lPolicyRuleCollectionGroupDraftDelete.json | 13 + ...wallPolicyRuleCollectionGroupDraftGet.json | 48 + ...wallPolicyRuleCollectionGroupDraftPut.json | 118 + .../FirewallPolicyRuleCollectionGroupGet.json | 51 + ...FirewallPolicyRuleCollectionGroupList.json | 54 + .../FirewallPolicyRuleCollectionGroupPut.json | 124 + ...ollectionGroupWithHttpHeadersToInsert.json | 143 + ...icyRuleCollectionGroupWithIpGroupsGet.json | 50 + ...cyRuleCollectionGroupWithIpGroupsList.json | 54 + ...icyRuleCollectionGroupWithIpGroupsPut.json | 119 + ...leCollectionGroupWithWebCategoriesGet.json | 52 + ...eCollectionGroupWithWebCategoriesList.json | 55 + ...leCollectionGroupWithWebCategoriesPut.json | 125 + .../FirewallPolicySignatureOverridesGet.json | 24 + .../FirewallPolicySignatureOverridesList.json | 28 + ...FirewallPolicySignatureOverridesPatch.json | 34 + .../FirewallPolicySignatureOverridesPut.json | 34 + .../GenerateExpressRoutePortsLOA.json | 19 + ...alWanVpnServerConfigurationVpnProfile.json | 20 + ...ApplicationGatewayWafDynamicManifests.json | 65 + ...tionGatewayWafDynamicManifestsDefault.json | 61 + .../2024-01-01/examples/GetInboundRoutes.json | 38 + .../examples/GetOutboundRoutes.json | 38 + .../GetVirtualWanVpnServerConfigurations.json | 20 + .../examples/HubRouteTableDelete.json | 14 + .../2024-01-01/examples/HubRouteTableGet.json | 47 + .../examples/HubRouteTableList.json | 81 + .../2024-01-01/examples/HubRouteTablePut.json | 104 + .../HubVirtualNetworkConnectionDelete.json | 14 + .../HubVirtualNetworkConnectionGet.json | 82 + .../HubVirtualNetworkConnectionList.json | 149 + .../HubVirtualNetworkConnectionPut.json | 194 + .../examples/InboundNatRuleCreate.json | 66 + .../examples/InboundNatRuleDelete.json | 26 + .../examples/InboundNatRuleGet.json | 32 + .../examples/InboundNatRuleList.json | 54 + .../examples/InboundSecurityRuleGet.json | 36 + .../examples/InboundSecurityRulePut.json | 80 + .../examples/IpAllocationCreate.json | 52 + .../examples/IpAllocationDelete.json | 13 + .../2024-01-01/examples/IpAllocationGet.json | 26 + .../2024-01-01/examples/IpAllocationList.json | 42 + .../IpAllocationListByResourceGroup.json | 43 + .../examples/IpAllocationUpdateTags.json | 37 + .../2024-01-01/examples/IpGroupsCreate.json | 69 + .../2024-01-01/examples/IpGroupsDelete.json | 13 + .../2024-01-01/examples/IpGroupsGet.json | 33 + .../examples/IpGroupsListByResourceGroup.json | 57 + .../examples/IpGroupsListBySubscription.json | 56 + .../examples/IpGroupsUpdateTags.json | 43 + ...sPoolListWithBackendAddressesPoolType.json | 50 + ...endAddressPoolWithBackendAddressesGet.json | 47 + ...endAddressPoolWithBackendAddressesPut.json | 107 + .../LoadBalancerBackendAddressPoolDelete.json | 26 + .../LoadBalancerBackendAddressPoolGet.json | 32 + .../LoadBalancerBackendAddressPoolList.json | 35 + .../examples/LoadBalancerCreate.json | 342 + ...ncerCreateGatewayLoadBalancerConsumer.json | 351 + ...oadBalancerProviderWithOneBackendPool.json | 333 + ...oadBalancerProviderWithTwoBackendPool.json | 364 + .../LoadBalancerCreateGlobalTier.json | 317 + .../LoadBalancerCreateStandardSku.json | 342 + .../LoadBalancerCreateWithInboundNatPool.json | 180 + .../LoadBalancerCreateWithOutboundRules.json | 426 + ...ancerCreateWithSyncModePropertyOnPool.json | 355 + .../examples/LoadBalancerCreateWithZones.json | 351 + .../examples/LoadBalancerDelete.json | 25 + ...oadBalancerFrontendIPConfigurationGet.json | 38 + ...adBalancerFrontendIPConfigurationList.json | 41 + .../2024-01-01/examples/LoadBalancerGet.json | 140 + ...dBalancerGetInboundNatRulePortMapping.json | 163 + .../2024-01-01/examples/LoadBalancerList.json | 162 + .../examples/LoadBalancerListAll.json | 161 + .../LoadBalancerLoadBalancingRuleGet.json | 38 + .../LoadBalancerLoadBalancingRuleList.json | 41 + ...oadBalancerNetworkInterfaceListSimple.json | 59 + .../LoadBalancerNetworkInterfaceListVmss.json | 112 + .../examples/LoadBalancerOutboundRuleGet.json | 34 + .../LoadBalancerOutboundRuleList.json | 37 + .../examples/LoadBalancerProbeGet.json | 33 + .../examples/LoadBalancerProbeList.json | 36 + .../examples/LoadBalancerUpdateTags.json | 133 + .../LoadBalancersSwapPublicIpAddresses.json | 39 + .../examples/LocalNetworkGatewayCreate.json | 60 + .../examples/LocalNetworkGatewayDelete.json | 17 + .../examples/LocalNetworkGatewayGet.json | 29 + .../examples/LocalNetworkGatewayList.json | 49 + .../LocalNetworkGatewayUpdateTags.json | 38 + .../MigrateLoadBalancerToIPBased.json | 24 + .../examples/NatGatewayCreateOrUpdate.json | 89 + .../2024-01-01/examples/NatGatewayDelete.json | 25 + .../2024-01-01/examples/NatGatewayGet.json | 40 + .../2024-01-01/examples/NatGatewayList.json | 71 + .../examples/NatGatewayListAll.json | 70 + .../examples/NatGatewayUpdateTags.json | 50 + .../2024-01-01/examples/NatRuleDelete.json | 14 + .../2024-01-01/examples/NatRuleGet.json | 31 + .../2024-01-01/examples/NatRuleList.json | 76 + .../2024-01-01/examples/NatRulePut.json | 94 + .../examples/NetworkInterfaceCreate.json | 141 + ...faceCreateGatewayLoadBalancerConsumer.json | 110 + .../examples/NetworkInterfaceDelete.json | 17 + .../NetworkInterfaceEffectiveNSGList.json | 78 + ...tworkInterfaceEffectiveRouteTableList.json | 75 + .../examples/NetworkInterfaceGet.json | 75 + .../NetworkInterfaceIPConfigurationGet.json | 45 + .../NetworkInterfaceIPConfigurationList.json | 31 + .../examples/NetworkInterfaceList.json | 110 + .../examples/NetworkInterfaceListAll.json | 95 + .../NetworkInterfaceLoadBalancerList.json | 140 + ...etworkInterfaceTapConfigurationCreate.json | 46 + ...etworkInterfaceTapConfigurationDelete.json | 18 + .../NetworkInterfaceTapConfigurationGet.json | 25 + .../NetworkInterfaceTapConfigurationList.json | 28 + .../examples/NetworkInterfaceUpdateTags.json | 58 + ...rActiveConnectivityConfigurationsList.json | 59 + ...rkManagerActiveSecurityAdminRulesList.json | 73 + ...tworkManagerAdminRuleCollectionDelete.json | 20 + .../NetworkManagerAdminRuleCollectionGet.json | 37 + ...NetworkManagerAdminRuleCollectionList.json | 41 + .../NetworkManagerAdminRuleCollectionPut.json | 71 + .../NetworkManagerAdminRuleDelete.json | 21 + .../examples/NetworkManagerAdminRuleGet.json | 56 + .../examples/NetworkManagerAdminRuleList.json | 60 + .../examples/NetworkManagerAdminRulePut.json | 127 + .../examples/NetworkManagerCommitPost.json | 47 + ...anagerConnectionManagementGroupDelete.json | 12 + ...rkManagerConnectionManagementGroupGet.json | 33 + ...kManagerConnectionManagementGroupList.json | 37 + ...rkManagerConnectionManagementGroupPut.json | 61 + ...rkManagerConnectionSubscriptionDelete.json | 12 + ...tworkManagerConnectionSubscriptionGet.json | 33 + ...workManagerConnectionSubscriptionList.json | 37 + ...tworkManagerConnectionSubscriptionPut.json | 61 + ...anagerConnectivityConfigurationDelete.json | 20 + ...rkManagerConnectivityConfigurationGet.json | 49 + ...kManagerConnectivityConfigurationList.json | 53 + ...rkManagerConnectivityConfigurationPut.json | 108 + .../NetworkManagerDefaultAdminRuleGet.json | 57 + .../NetworkManagerDefaultAdminRulePut.json | 107 + .../examples/NetworkManagerDelete.json | 19 + .../NetworkManagerDeploymentStatusList.json | 51 + ...fectiveConnectivityConfigurationsList.json | 54 + ...anagerEffectiveSecurityAdminRulesList.json | 68 + .../examples/NetworkManagerGet.json | 40 + .../examples/NetworkManagerGroupDelete.json | 20 + .../examples/NetworkManagerGroupGet.json | 32 + .../examples/NetworkManagerGroupList.json | 36 + .../examples/NetworkManagerGroupPut.json | 63 + .../examples/NetworkManagerList.json | 45 + .../examples/NetworkManagerListAll.json | 44 + .../examples/NetworkManagerPatch.json | 52 + .../examples/NetworkManagerPut.json | 91 + .../NetworkManagerScopeConnectionDelete.json | 15 + .../NetworkManagerScopeConnectionGet.json | 36 + .../NetworkManagerScopeConnectionList.json | 40 + .../NetworkManagerScopeConnectionPut.json | 66 + ...nagerSecurityAdminConfigurationDelete.json | 19 + ...kManagerSecurityAdminConfigurationGet.json | 34 + ...ManagerSecurityAdminConfigurationList.json | 38 + ...kManagerSecurityAdminConfigurationPut.json | 65 + .../NetworkManagerStaticMemberDelete.json | 15 + .../NetworkManagerStaticMemberGet.json | 31 + .../NetworkManagerStaticMemberList.json | 37 + .../NetworkManagerStaticMemberPut.json | 64 + .../NetworkProfileCreateConfigOnly.json | 110 + .../examples/NetworkProfileDelete.json | 13 + .../examples/NetworkProfileGetConfigOnly.json | 84 + .../NetworkProfileGetWithContainerNic.json | 203 + .../examples/NetworkProfileList.json | 97 + .../examples/NetworkProfileListAll.json | 84 + .../examples/NetworkProfileUpdateTags.json | 58 + .../examples/NetworkSecurityGroupCreate.json | 235 + .../NetworkSecurityGroupCreateWithRule.json | 282 + .../examples/NetworkSecurityGroupDelete.json | 23 + .../examples/NetworkSecurityGroupGet.json | 136 + .../examples/NetworkSecurityGroupList.json | 231 + .../examples/NetworkSecurityGroupListAll.json | 230 + .../NetworkSecurityGroupRuleCreate.json | 57 + .../NetworkSecurityGroupRuleDelete.json | 22 + .../examples/NetworkSecurityGroupRuleGet.json | 28 + .../NetworkSecurityGroupRuleList.json | 31 + .../NetworkSecurityGroupUpdateTags.json | 130 + ...tworkVirtualApplianceConnectionDelete.json | 23 + .../NetworkVirtualApplianceConnectionGet.json | 48 + ...NetworkVirtualApplianceConnectionList.json | 51 + .../NetworkVirtualApplianceConnectionPut.json | 118 + .../NetworkVirtualApplianceDelete.json | 22 + .../NetworkVirtualApplianceEmptyRestart.json | 23 + .../examples/NetworkVirtualApplianceGet.json | 152 + ...rkVirtualApplianceListByResourceGroup.json | 150 + ...orkVirtualApplianceListBySubscription.json | 149 + .../examples/NetworkVirtualAppliancePut.json | 332 + .../NetworkVirtualApplianceSaaSPut.json | 86 + .../NetworkVirtualApplianceSiteDelete.json | 23 + .../NetworkVirtualApplianceSiteGet.json | 29 + .../NetworkVirtualApplianceSiteList.json | 33 + .../NetworkVirtualApplianceSitePut.json | 59 + .../NetworkVirtualApplianceSkuGet.json | 34 + .../NetworkVirtualApplianceSkuList.json | 36 + ...etworkVirtualApplianceSpecificRestart.json | 30 + .../NetworkVirtualApplianceUpdateTags.json | 70 + ...tworkWatcherAvailableProvidersListGet.json | 71 + ...workWatcherAzureReachabilityReportGet.json | 85 + ...NetworkWatcherConnectionMonitorCreate.json | 142 + ...ConnectionMonitorCreateWithArcNetwork.json | 215 + ...NetworkWatcherConnectionMonitorDelete.json | 17 + .../NetworkWatcherConnectionMonitorGet.json | 57 + .../NetworkWatcherConnectionMonitorList.json | 104 + .../NetworkWatcherConnectionMonitorQuery.json | 80 + .../NetworkWatcherConnectionMonitorStart.json | 17 + .../NetworkWatcherConnectionMonitorStop.json | 17 + ...orkWatcherConnectionMonitorUpdateTags.json | 45 + ...tworkWatcherConnectionMonitorV2Create.json | 206 + .../NetworkWatcherConnectivityCheck.json | 83 + .../examples/NetworkWatcherCreate.json | 40 + .../examples/NetworkWatcherDelete.json | 16 + .../NetworkWatcherFlowLogConfigure.json | 62 + .../examples/NetworkWatcherFlowLogCreate.json | 97 + .../examples/NetworkWatcherFlowLogDelete.json | 17 + .../examples/NetworkWatcherFlowLogGet.json | 52 + .../examples/NetworkWatcherFlowLogList.json | 87 + .../NetworkWatcherFlowLogStatusQuery.json | 52 + .../NetworkWatcherFlowLogUpdateTags.json | 55 + .../examples/NetworkWatcherGet.json | 23 + .../examples/NetworkWatcherIpFlowVerify.json | 34 + .../examples/NetworkWatcherList.json | 37 + .../examples/NetworkWatcherListAll.json | 36 + ...WatcherNetworkConfigurationDiagnostic.json | 201 + .../examples/NetworkWatcherNextHopGet.json | 33 + .../NetworkWatcherPacketCaptureCreate.json | 56 + .../NetworkWatcherPacketCaptureDelete.json | 17 + .../NetworkWatcherPacketCaptureGet.json | 37 + ...etworkWatcherPacketCaptureQueryStatus.json | 34 + .../NetworkWatcherPacketCaptureStop.json | 17 + .../NetworkWatcherPacketCapturesList.json | 58 + .../NetworkWatcherSecurityGroupViewGet.json | 144 + .../examples/NetworkWatcherTopologyGet.json | 39 + .../NetworkWatcherTroubleshootGet.json | 74 + ...NetworkWatcherTroubleshootResultQuery.json | 70 + .../examples/NetworkWatcherUpdateTags.json | 32 + .../2024-01-01/examples/OperationList.json | 137 + .../examples/P2SVpnGatewayDelete.json | 13 + .../P2SVpnGatewayGenerateVpnProfile.json | 19 + .../2024-01-01/examples/P2SVpnGatewayGet.json | 106 + .../P2SVpnGatewayGetConnectionHealth.json | 82 + ...VpnGatewayGetConnectionHealthDetailed.json | 23 + .../examples/P2SVpnGatewayList.json | 203 + .../P2SVpnGatewayListByResourceGroup.json | 199 + .../2024-01-01/examples/P2SVpnGatewayPut.json | 256 + .../examples/P2SVpnGatewayReset.json | 82 + .../examples/P2SVpnGatewayUpdateTags.json | 115 + ...pnGatewaysDisconnectP2sVpnConnections.json | 18 + .../PeerExpressRouteCircuitConnectionGet.json | 32 + ...PeerExpressRouteCircuitConnectionList.json | 53 + .../examples/PrivateEndpointCreate.json | 165 + ...rivateEndpointCreateForManualApproval.json | 161 + .../PrivateEndpointCreateWithASG.json | 145 + .../examples/PrivateEndpointDelete.json | 13 + .../PrivateEndpointDnsZoneGroupCreate.json | 90 + .../PrivateEndpointDnsZoneGroupDelete.json | 14 + .../PrivateEndpointDnsZoneGroupGet.json | 68 + .../PrivateEndpointDnsZoneGroupList.json | 80 + .../examples/PrivateEndpointGet.json | 80 + .../PrivateEndpointGetForManualApproval.json | 72 + .../examples/PrivateEndpointGetWithASG.json | 65 + .../examples/PrivateEndpointList.json | 151 + .../examples/PrivateEndpointListAll.json | 216 + .../examples/PrivateLinkServiceCreate.json | 159 + .../examples/PrivateLinkServiceDelete.json | 13 + ...erviceDeletePrivateEndpointConnection.json | 14 + .../examples/PrivateLinkServiceGet.json | 77 + ...nkServiceGetPrivateEndpointConnection.json | 25 + .../examples/PrivateLinkServiceList.json | 141 + .../examples/PrivateLinkServiceListAll.json | 142 + ...kServiceListPrivateEndpointConnection.json | 40 + ...erviceUpdatePrivateEndpointConnection.json | 37 + ...PublicIpAddressCreateCustomizedValues.json | 79 + .../PublicIpAddressCreateDefaults.json | 53 + .../examples/PublicIpAddressCreateDns.json | 63 + ...ressCreateDnsWithDomainNameLabelScope.json | 66 + .../examples/PublicIpAddressDelete.json | 17 + .../examples/PublicIpAddressGet.json | 43 + ...ublicIpAddressGetDdosProtectionStatus.json | 23 + .../examples/PublicIpAddressList.json | 90 + .../examples/PublicIpAddressListAll.json | 79 + .../examples/PublicIpAddressUpdateTags.json | 40 + .../PublicIpPrefixCreateCustomizedValues.json | 72 + .../PublicIpPrefixCreateDefaults.json | 59 + .../examples/PublicIpPrefixDelete.json | 13 + .../examples/PublicIpPrefixGet.json | 35 + .../examples/PublicIpPrefixList.json | 56 + .../examples/PublicIpPrefixListAll.json | 76 + .../examples/PublicIpPrefixUpdateTags.json | 40 + .../QueryInboundNatRulePortMapping.json | 41 + .../examples/RouteFilterCreate.json | 95 + .../examples/RouteFilterDelete.json | 13 + .../2024-01-01/examples/RouteFilterGet.json | 42 + .../2024-01-01/examples/RouteFilterList.json | 44 + .../RouteFilterListByResourceGroup.json | 45 + .../examples/RouteFilterRuleCreate.json | 53 + .../examples/RouteFilterRuleDelete.json | 14 + .../examples/RouteFilterRuleGet.json | 27 + .../RouteFilterRuleListByRouteFilter.json | 30 + .../examples/RouteFilterUpdateTags.json | 46 + .../2024-01-01/examples/RouteMapDelete.json | 14 + .../2024-01-01/examples/RouteMapGet.json | 56 + .../2024-01-01/examples/RouteMapList.json | 59 + .../2024-01-01/examples/RouteMapPut.json | 139 + .../2024-01-01/examples/RouteTableCreate.json | 39 + .../examples/RouteTableCreateWithRoute.json | 70 + .../2024-01-01/examples/RouteTableDelete.json | 13 + .../2024-01-01/examples/RouteTableGet.json | 33 + .../2024-01-01/examples/RouteTableList.json | 47 + .../examples/RouteTableListAll.json | 44 + .../examples/RouteTableRouteCreate.json | 39 + .../examples/RouteTableRouteDelete.json | 14 + .../examples/RouteTableRouteGet.json | 22 + .../examples/RouteTableRouteList.json | 34 + .../examples/RouteTableUpdateTags.json | 32 + .../examples/RoutingIntentDelete.json | 14 + .../2024-01-01/examples/RoutingIntentGet.json | 38 + .../examples/RoutingIntentList.json | 41 + .../2024-01-01/examples/RoutingIntentPut.json | 85 + .../SecurityPartnerProviderDelete.json | 13 + .../examples/SecurityPartnerProviderGet.json | 30 + ...ityPartnerProviderListByResourceGroup.json | 33 + ...rityPartnerProviderListBySubscription.json | 32 + .../examples/SecurityPartnerProviderPut.json | 60 + .../SecurityPartnerProviderUpdateTags.json | 32 + .../examples/ServiceCommunityList.json | 56 + .../examples/ServiceEndpointPolicyCreate.json | 41 + ...iceEndpointPolicyCreateWithDefinition.json | 83 + ...ServiceEndpointPolicyDefinitionCreate.json | 52 + ...ServiceEndpointPolicyDefinitionDelete.json | 14 + .../ServiceEndpointPolicyDefinitionGet.json | 26 + .../ServiceEndpointPolicyDefinitionList.json | 29 + .../examples/ServiceEndpointPolicyDelete.json | 13 + .../examples/ServiceEndpointPolicyGet.json | 37 + .../examples/ServiceEndpointPolicyList.json | 63 + .../ServiceEndpointPolicyListAll.json | 64 + .../ServiceEndpointPolicyUpdateTags.json | 47 + .../ServiceTagInformationListResult.json | 42 + ...mationListResultWithNoAddressPrefixes.json | 36 + ...ceTagInformationListResultWithTagname.json | 30 + .../2024-01-01/examples/ServiceTagsList.json | 89 + .../2024-01-01/examples/SubnetCreate.json | 36 + .../examples/SubnetCreateServiceEndpoint.json | 61 + ...reateServiceEndpointNetworkIdentifier.json | 70 + .../examples/SubnetCreateWithDelegation.json | 60 + .../SubnetCreateWithSharingScope.json | 40 + .../2024-01-01/examples/SubnetDelete.json | 18 + .../stable/2024-01-01/examples/SubnetGet.json | 21 + .../examples/SubnetGetWithDelegation.json | 33 + .../examples/SubnetGetWithSharingScope.json | 23 + .../2024-01-01/examples/SubnetList.json | 32 + .../SubnetPrepareNetworkPolicies.json | 20 + .../SubnetUnprepareNetworkPolicies.json | 20 + .../stable/2024-01-01/examples/UsageList.json | 265 + .../examples/UsageListSpacedLocation.json | 335 + .../VirtualHubBgpConnectionDelete.json | 14 + .../examples/VirtualHubBgpConnectionGet.json | 27 + .../examples/VirtualHubBgpConnectionList.json | 30 + .../examples/VirtualHubBgpConnectionPut.json | 52 + .../2024-01-01/examples/VirtualHubDelete.json | 13 + .../2024-01-01/examples/VirtualHubGet.json | 40 + .../VirtualHubIpConfigurationDelete.json | 14 + .../VirtualHubIpConfigurationGet.json | 25 + .../VirtualHubIpConfigurationList.json | 28 + .../VirtualHubIpConfigurationPut.json | 46 + .../2024-01-01/examples/VirtualHubList.json | 140 + .../VirtualHubListByResourceGroup.json | 141 + .../2024-01-01/examples/VirtualHubPut.json | 83 + .../VirtualHubRouteTableV2Delete.json | 14 + .../examples/VirtualHubRouteTableV2Get.json | 47 + .../examples/VirtualHubRouteTableV2List.json | 72 + .../examples/VirtualHubRouteTableV2Put.json | 113 + .../examples/VirtualHubUpdateTags.json | 48 + ...tualNetworkCheckIPAddressAvailability.json | 23 + .../examples/VirtualNetworkCreate.json | 59 + ...ualNetworkCreateServiceEndpointPolicy.json | 126 + .../VirtualNetworkCreateServiceEndpoints.json | 111 + .../examples/VirtualNetworkCreateSubnet.json | 82 + ...etworkCreateSubnetWithAddressPrefixes.json | 91 + ...tualNetworkCreateSubnetWithDelegation.json | 114 + ...irtualNetworkCreateWithBgpCommunities.json | 93 + .../VirtualNetworkCreateWithEncryption.json | 94 + .../examples/VirtualNetworkDelete.json | 17 + ...VirtualNetworkGatewayConnectionCreate.json | 189 + ...VirtualNetworkGatewayConnectionDelete.json | 17 + .../VirtualNetworkGatewayConnectionGet.json | 65 + ...tualNetworkGatewayConnectionGetIkeSas.json | 18 + ...lNetworkGatewayConnectionGetSharedKey.json | 16 + .../VirtualNetworkGatewayConnectionReset.json | 15 + ...etworkGatewayConnectionResetSharedKey.json | 23 + ...lNetworkGatewayConnectionSetSharedKey.json | 25 + ...rkGatewayConnectionStartPacketCapture.json | 18 + ...onnectionStartPacketCaptureFilterData.json | 21 + ...orkGatewayConnectionStopPacketCapture.json | 21 + ...ualNetworkGatewayConnectionUpdateTags.json | 75 + .../VirtualNetworkGatewayConnectionsList.json | 117 + .../examples/VirtualNetworkGatewayDelete.json | 17 + ...etworkGatewayGenerateVpnClientPackage.json | 19 + ...rtualNetworkGatewayGenerateVpnProfile.json | 19 + .../examples/VirtualNetworkGatewayGet.json | 134 + ...tualNetworkGatewayGetAdvertisedRoutes.json | 19 + ...VirtualNetworkGatewayGetBGPPeerStatus.json | 18 + ...orkGatewayGetVpnClientIpsecParameters.json | 22 + ...NetworkGatewayGetVpnProfilePackageUrl.json | 18 + ...rkGatewayGetVpnclientConnectionHealth.json | 49 + .../VirtualNetworkGatewayLearnedRoutes.json | 18 + .../examples/VirtualNetworkGatewayList.json | 224 + .../VirtualNetworkGatewayNatRuleDelete.json | 18 + .../VirtualNetworkGatewayNatRuleGet.json | 36 + .../VirtualNetworkGatewayNatRuleList.json | 56 + .../VirtualNetworkGatewayNatRulePut.json | 80 + .../examples/VirtualNetworkGatewayReset.json | 81 + ...NetworkGatewayResetVpnClientSharedKey.json | 16 + ...orkGatewaySetVpnClientIpsecParameters.json | 37 + ...rtualNetworkGatewayStartPacketCapture.json | 18 + ...rkGatewayStartPacketCaptureFilterData.json | 21 + ...irtualNetworkGatewayStopPacketCapture.json | 21 + ...rtualNetworkGatewaySupportedVpnDevice.json | 13 + .../examples/VirtualNetworkGatewayUpdate.json | 352 + .../VirtualNetworkGatewayUpdateTags.json | 98 + ...rkGatewayVpnDeviceConfigurationScript.json | 18 + ...rkGatewaysDisconnectP2sVpnConnections.json | 22 + ...VirtualNetworkGatewaysListConnections.json | 41 + .../examples/VirtualNetworkGet.json | 42 + ...VirtualNetworkGetDdosProtectionStatus.json | 33 + ...tualNetworkGetResourceNavigationLinks.json | 28 + ...tualNetworkGetServiceAssociationLinks.json | 31 + ...lNetworkGetWithServiceAssociationLink.json | 69 + ...VirtualNetworkGetWithSubnetDelegation.json | 54 + .../examples/VirtualNetworkList.json | 64 + .../examples/VirtualNetworkListAll.json | 63 + .../examples/VirtualNetworkListUsage.json | 36 + .../examples/VirtualNetworkPeeringCreate.json | 86 + ...ateWithRemoteVirtualNetworkEncryption.json | 82 + .../examples/VirtualNetworkPeeringDelete.json | 18 + .../examples/VirtualNetworkPeeringGet.json | 43 + ...GetWithRemoteVirtualNetworkEncryption.json | 41 + .../examples/VirtualNetworkPeeringList.json | 76 + ...istWithRemoteVirtualNetworkEncryption.json | 72 + .../examples/VirtualNetworkPeeringSync.json | 87 + .../VirtualNetworkScalableGatewayGet.json | 106 + .../VirtualNetworkScalableGatewayUpdate.json | 269 + .../VirtualNetworkSubnetPeeringCreate.json | 145 + .../VirtualNetworkSubnetPeeringGet.json | 65 + .../VirtualNetworkSubnetPeeringSync.json | 133 + .../examples/VirtualNetworkTapCreate.json | 62 + .../examples/VirtualNetworkTapDelete.json | 13 + .../examples/VirtualNetworkTapGet.json | 32 + .../examples/VirtualNetworkTapList.json | 55 + .../examples/VirtualNetworkTapListAll.json | 54 + .../examples/VirtualNetworkTapUpdateTags.json | 40 + .../examples/VirtualNetworkUpdateTags.json | 39 + .../VirtualNetworkV6SubnetPeeringCreate.json | 137 + .../VirtualNetworkV6SubnetPeeringGet.json | 61 + .../VirtualNetworkV6SubnetPeeringSync.json | 125 + .../examples/VirtualRouterDelete.json | 13 + .../2024-01-01/examples/VirtualRouterGet.json | 38 + .../VirtualRouterListByResourceGroup.json | 41 + .../VirtualRouterListBySubscription.json | 40 + .../VirtualRouterPeerListAdvertisedRoute.json | 74 + .../VirtualRouterPeerListLearnedRoute.json | 56 + .../examples/VirtualRouterPeeringDelete.json | 14 + .../examples/VirtualRouterPeeringGet.json | 23 + .../examples/VirtualRouterPeeringList.json | 26 + .../examples/VirtualRouterPeeringPut.json | 41 + .../2024-01-01/examples/VirtualRouterPut.json | 77 + .../2024-01-01/examples/VirtualWANDelete.json | 13 + .../2024-01-01/examples/VirtualWANGet.json | 35 + .../2024-01-01/examples/VirtualWANList.json | 60 + .../VirtualWANListByResourceGroup.json | 61 + .../2024-01-01/examples/VirtualWANPut.json | 70 + .../examples/VirtualWANUpdateTags.json | 42 + .../VirtualWanSupportedSecurityProviders.json | 22 + .../examples/VmssNetworkInterfaceGet.json | 65 + .../VmssNetworkInterfaceIpConfigGet.json | 39 + .../VmssNetworkInterfaceIpConfigList.json | 42 + .../examples/VmssNetworkInterfaceList.json | 118 + .../2024-01-01/examples/VmssPublicIpGet.json | 34 + .../examples/VmssPublicIpListAll.json | 52 + .../examples/VmssVmNetworkInterfaceList.json | 68 + .../examples/VmssVmPublicIpList.json | 37 + .../examples/VpnConnectionDelete.json | 14 + .../2024-01-01/examples/VpnConnectionGet.json | 106 + .../examples/VpnConnectionList.json | 107 + .../2024-01-01/examples/VpnConnectionPut.json | 203 + .../VpnConnectionStartPacketCapture.json | 21 + ...onnectionStartPacketCaptureFilterData.json | 22 + .../VpnConnectionStopPacketCapture.json | 22 + .../2024-01-01/examples/VpnGatewayDelete.json | 13 + .../2024-01-01/examples/VpnGatewayGet.json | 207 + .../2024-01-01/examples/VpnGatewayList.json | 304 + .../VpnGatewayListByResourceGroup.json | 280 + .../2024-01-01/examples/VpnGatewayPut.json | 377 + .../2024-01-01/examples/VpnGatewayReset.json | 107 + .../VpnGatewayStartPacketCapture.json | 14 + ...pnGatewayStartPacketCaptureFilterData.json | 17 + .../examples/VpnGatewayStopPacketCapture.json | 17 + .../examples/VpnGatewayUpdateTags.json | 115 + .../VpnServerConfigurationDelete.json | 13 + .../examples/VpnServerConfigurationGet.json | 114 + .../examples/VpnServerConfigurationList.json | 214 + ...erverConfigurationListByResourceGroup.json | 211 + .../examples/VpnServerConfigurationPut.json | 304 + .../VpnServerConfigurationUpdateTags.json | 112 + .../2024-01-01/examples/VpnSiteDelete.json | 13 + .../2024-01-01/examples/VpnSiteGet.json | 57 + .../examples/VpnSiteLinkConnectionGet.json | 48 + .../VpnSiteLinkConnectionGetIkeSas.json | 20 + .../examples/VpnSiteLinkConnectionList.json | 49 + .../examples/VpnSiteLinkConnectionReset.json | 13 + .../2024-01-01/examples/VpnSiteLinkGet.json | 30 + .../examples/VpnSiteLinkListByVpnSite.json | 50 + .../2024-01-01/examples/VpnSiteList.json | 88 + .../examples/VpnSiteListByResourceGroup.json | 88 + .../2024-01-01/examples/VpnSitePut.json | 144 + .../examples/VpnSiteUpdateTags.json | 48 + .../VpnSitesConfigurationDownload.json | 22 + .../examples/WafListAllPolicies.json | 159 + .../2024-01-01/examples/WafListPolicies.json | 159 + .../examples/WafPolicyCreateOrUpdate.json | 753 ++ .../2024-01-01/examples/WafPolicyDelete.json | 17 + .../2024-01-01/examples/WafPolicyGet.json | 303 + .../examples/expressRouteProviderPort.json | 28 + .../expressRouteProviderPortList.json | 46 + .../2024-01-01/expressRouteCircuit.json | 2525 +++++ .../expressRouteCrossConnection.json | 1016 ++ .../stable/2024-01-01/expressRoutePort.json | 1310 +++ .../2024-01-01/expressRouteProviderPort.json | 225 + .../stable/2024-01-01/firewallPolicy.json | 2719 +++++ .../stable/2024-01-01/ipAllocation.json | 454 + .../stable/2024-01-01/ipGroups.json | 430 + .../stable/2024-01-01/loadBalancer.json | 2766 +++++ .../stable/2024-01-01/natGateway.json | 469 + .../stable/2024-01-01/network.json | 439 + .../stable/2024-01-01/networkInterface.json | 1628 +++ .../stable/2024-01-01/networkManager.json | 753 ++ .../networkManagerActiveConfiguration.json | 345 + .../2024-01-01/networkManagerConnection.json | 426 + ...tworkManagerConnectivityConfiguration.json | 458 + .../networkManagerEffectiveConfiguration.json | 337 + .../2024-01-01/networkManagerGroup.json | 601 + .../networkManagerScopeConnection.json | 297 + ...workManagerSecurityAdminConfiguration.json | 1158 ++ .../stable/2024-01-01/networkProfile.json | 622 ++ .../2024-01-01/networkSecurityGroup.json | 991 ++ .../2024-01-01/networkVirtualAppliance.json | 1592 +++ .../stable/2024-01-01/networkWatcher.json | 4854 ++++++++ .../stable/2024-01-01/operation.json | 271 + .../stable/2024-01-01/privateEndpoint.json | 1038 ++ .../stable/2024-01-01/privateLinkService.json | 1091 ++ .../stable/2024-01-01/publicIpAddress.json | 712 ++ .../stable/2024-01-01/publicIpPrefix.json | 509 + .../stable/2024-01-01/routeFilter.json | 822 ++ .../stable/2024-01-01/routeTable.json | 768 ++ .../2024-01-01/securityPartnerProvider.json | 441 + .../stable/2024-01-01/serviceCommunity.json | 158 + .../2024-01-01/serviceEndpointPolicy.json | 762 ++ .../stable/2024-01-01/serviceTags.json | 262 + .../stable/2024-01-01/usage.json | 160 + .../stable/2024-01-01/virtualNetwork.json | 2290 ++++ .../2024-01-01/virtualNetworkGateway.json | 4489 ++++++++ .../stable/2024-01-01/virtualNetworkTap.json | 426 + .../stable/2024-01-01/virtualRouter.json | 698 ++ .../stable/2024-01-01/virtualWan.json | 9723 +++++++++++++++++ .../2024-01-01/vmssNetworkInterface.json | 374 + .../2024-01-01/vmssPublicIpAddress.json | 241 + .../2024-01-01/webapplicationfirewall.json | 1028 ++ .../network/resource-manager/readme.md | 77 +- 791 files changed, 117069 insertions(+), 1 deletion(-) create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringSync.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringSync.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationGateway.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationGatewayWafDynamicManifests.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationSecurityGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/availableDelegations.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/availableServiceAliases.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewall.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewallFqdnTag.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureWebCategory.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/bastionHost.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/checkDnsAvailability.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServiceNetworkInterface.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServicePublicIpAddress.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServiceSwap.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/customIpPrefix.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ddosCustomPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ddosProtectionPlan.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/dscpConfiguration.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/endpointService.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableServerVariablesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayBackendHealthGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayBackendHealthTest.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateLinkResourceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayStart.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayStop.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AutoApprovedPrivateLinkServicesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsResourceGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsSubscriptionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailablePrivateEndpointTypesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableServiceAliasesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableServiceAliasesListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallFqdnTagsListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithAdditionalProperties.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithIpGroups.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithMgmtSubnet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithZones.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListLearnedIPPrefixes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutInHub.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithAdditionalProperties.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithIpGroups.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithMgmtSubnet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithZones.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureWebCategoriesListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureWebCategoryGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostGetWithZones.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPatch.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPutWithZones.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionSessionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionSessionsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkDeleteByToken.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckDnsNameAvailability.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckPrivateLinkServiceVisibility.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceNetworkInterfaceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceNetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServicePublicIpGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServicePublicIpListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceRoleInstanceNetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceRoleInstancePublicIpList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixCreateCustomizedValues.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DefaultSecurityRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DefaultSecurityRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForRouteTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForVirtualHub.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EndpointServicesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitARPTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringStats.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitRouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitRouteTableSummaryList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitStats.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsArpTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsRouteTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteLinkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteLinkList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortUpdateLink.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortsLocationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortsLocationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteProviderList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftDeploy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyNatRuleCollectionGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyNatRuleCollectionGroupPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyPatch.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyQuerySignatureOverrides.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyQuerySignatureOverridesFilterValues.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithHttpHeadersToInsert.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesPatch.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GenerateExpressRoutePortsLOA.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetApplicationGatewayWafDynamicManifests.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetInboundRoutes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetOutboundRoutes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetVirtualWanVpnServerConfigurations.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTablePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundSecurityRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundSecurityRulePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGlobalTier.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateStandardSku.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithInboundNatPool.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithOutboundRules.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithSyncModePropertyOnPool.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithZones.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerFrontendIPConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerFrontendIPConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerGetInboundNatRulePortMapping.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerLoadBalancingRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerLoadBalancingRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerNetworkInterfaceListSimple.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerNetworkInterfaceListVmss.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerOutboundRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerOutboundRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerProbeGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerProbeList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancersSwapPublicIpAddresses.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/MigrateLoadBalancerToIPBased.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayCreateOrUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRulePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceCreateGatewayLoadBalancerConsumer.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceEffectiveNSGList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceEffectiveRouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceIPConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceIPConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceLoadBalancerList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerActiveConnectivityConfigurationsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerActiveSecurityAdminRulesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRulePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerCommitPost.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDefaultAdminRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDefaultAdminRulePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDeploymentStatusList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerEffectiveConnectivityConfigurationsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerEffectiveSecurityAdminRulesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerPatch.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileCreateConfigOnly.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileGetConfigOnly.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileGetWithContainerNic.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupCreateWithRule.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceEmptyRestart.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualAppliancePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSaaSPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSitePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSkuGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSkuList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSpecificRestart.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherAvailableProvidersListGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherAzureReachabilityReportGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorQuery.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorStart.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorStop.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorV2Create.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectivityCheck.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogConfigure.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogStatusQuery.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherIpFlowVerify.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherNextHopGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureQueryStatus.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureStop.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCapturesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherSecurityGroupViewGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTopologyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTroubleshootGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTroubleshootResultQuery.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/OperationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGenerateVpnProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGetConnectionHealth.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayReset.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PeerExpressRouteCircuitConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PeerExpressRouteCircuitConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreateForManualApproval.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreateWithASG.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGetForManualApproval.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGetWithASG.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateCustomizedValues.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDefaults.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDns.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressGetDdosProtectionStatus.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixCreateCustomizedValues.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixCreateDefaults.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/QueryInboundNatRulePortMapping.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleListByRouteFilter.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableCreateWithRoute.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceCommunityList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyCreateWithDefinition.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResult.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResultWithNoAddressPrefixes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResultWithTagname.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateServiceEndpoint.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateServiceEndpointNetworkIdentifier.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateWithDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateWithSharingScope.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGetWithDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGetWithSharingScope.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetPrepareNetworkPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetUnprepareNetworkPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/UsageList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/UsageListSpacedLocation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Delete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Get.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2List.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Put.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCheckIPAddressAvailability.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateServiceEndpoints.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnetWithDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateWithBgpCommunities.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateWithEncryption.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionReset.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayLearnedRoutes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRulePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayReset.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStartPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStopPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaysListConnections.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetDdosProtectionStatus.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetResourceNavigationLinks.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetServiceAssociationLinks.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetWithServiceAssociationLink.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetWithSubnetDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkListUsage.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringSync.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkScalableGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkScalableGatewayUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringSync.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringSync.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeerListAdvertisedRoute.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeerListLearnedRoute.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWanSupportedSecurityProviders.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceIpConfigGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceIpConfigList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssPublicIpGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssPublicIpListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssVmNetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssVmPublicIpList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStartPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStartPacketCaptureFilterData.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStopPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayReset.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStartPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStartPacketCaptureFilterData.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStopPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionGetIkeSas.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionReset.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkListByVpnSite.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSitePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSitesConfigurationDownload.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafListAllPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafListPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyCreateOrUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/expressRouteProviderPort.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/expressRouteProviderPortList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteCircuit.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteCrossConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRoutePort.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteProviderPort.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/firewallPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ipAllocation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ipGroups.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/loadBalancer.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/natGateway.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/network.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkInterface.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManager.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerActiveConfiguration.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerConnectivityConfiguration.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerEffectiveConfiguration.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerScopeConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerSecurityAdminConfiguration.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkSecurityGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkWatcher.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/operation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateEndpoint.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateLinkService.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/publicIpAddress.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/publicIpPrefix.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeFilter.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/securityPartnerProvider.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceCommunity.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceEndpointPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/usage.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetwork.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetworkTap.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualRouter.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualWan.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/vmssNetworkInterface.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/vmssPublicIpAddress.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/webapplicationfirewall.json diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringCreate.json new file mode 100644 index 000000000000..4d47ac7c4b02 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringCreate.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringGet.json new file mode 100644 index 000000000000..7100fba7e263 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringGet.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringSync.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringSync.json new file mode 100644 index 000000000000..01152b6e25f6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkSubnetPeeringSync.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "syncRemoteAddressSpace": "true", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringCreate.json new file mode 100644 index 000000000000..ed514a50f1ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringCreate.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringGet.json new file mode 100644 index 000000000000..bafaa6b2a1db --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringSync.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringSync.json new file mode 100644 index 000000000000..56e6071c2f06 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkV6SubnetPeeringSync.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "syncRemoteAddressSpace": "true", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetwork.json index 6cc56c72b275..cf1511a114b5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetwork.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetwork.json @@ -1010,6 +1010,12 @@ }, "Get peering with remote virtual network encryption": { "$ref": "./examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json" + }, + "Get subnet peering": { + "$ref": "./examples/VirtualNetworkSubnetPeeringGet.json" + }, + "Get V6 subnet peering": { + "$ref": "./examples/VirtualNetworkV6SubnetPeeringGet.json" } } }, @@ -1100,6 +1106,18 @@ }, "Create peering with remote virtual network encryption": { "$ref": "./examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json" + }, + "Create subnet peering": { + "$ref": "./examples/VirtualNetworkSubnetPeeringCreate.json" + }, + "Sync subnet Peering": { + "$ref": "./examples/VirtualNetworkSubnetPeeringSync.json" + }, + "Create V6 Subnet peering": { + "$ref": "./examples/VirtualNetworkV6SubnetPeeringCreate.json" + }, + "Sync V6 Subnet Peering": { + "$ref": "./examples/VirtualNetworkV6SubnetPeeringSync.json" } }, "x-ms-long-running-operation": true, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationGateway.json new file mode 100644 index 000000000000..6bdea13fbc6f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationGateway.json @@ -0,0 +1,4058 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}": { + "delete": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Delete", + "x-ms-examples": { + "Delete ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayDelete.json" + } + }, + "description": "Deletes the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Get", + "x-ms-examples": { + "Get ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayGet.json" + } + }, + "description": "Gets the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_CreateOrUpdate", + "description": "Creates or updates the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "Parameters supplied to the create or update application gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Application Gateway": { + "$ref": "./examples/ApplicationGatewayCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_UpdateTags", + "x-ms-examples": { + "Update Application Gateway tags": { + "$ref": "./examples/ApplicationGatewayUpdateTags.json" + } + }, + "description": "Updates the specified application gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update application gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_List", + "x-ms-examples": { + "Lists all application gateways in a resource group": { + "$ref": "./examples/ApplicationGatewayList.json" + } + }, + "description": "Lists all application gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAll", + "x-ms-examples": { + "Lists all application gateways in a subscription": { + "$ref": "./examples/ApplicationGatewayListAll.json" + } + }, + "description": "Gets all the application gateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/start": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Start", + "x-ms-examples": { + "Start Application Gateway": { + "$ref": "./examples/ApplicationGatewayStart.json" + } + }, + "description": "Starts the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation starts the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/stop": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Stop", + "x-ms-examples": { + "Stop Application Gateway": { + "$ref": "./examples/ApplicationGatewayStop.json" + } + }, + "description": "Stops the specified application gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_BackendHealth", + "description": "Gets the backend health of the specified application gateway in a resource group.", + "x-ms-examples": { + "Get Backend Health": { + "$ref": "./examples/ApplicationGatewayBackendHealthGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayBackendHealth" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/getBackendHealthOnDemand": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_BackendHealthOnDemand", + "description": "Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.", + "x-ms-examples": { + "Test Backend Health": { + "$ref": "./examples/ApplicationGatewayBackendHealthTest.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." + }, + { + "name": "probeRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGatewayOnDemandProbe" + }, + "description": "Request body for on-demand test probe operation." + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthOnDemand" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateLinkResources": { + "get": { + "tags": [ + "ApplicationGatewayPrivateLinkResources" + ], + "operationId": "ApplicationGatewayPrivateLinkResources_List", + "x-ms-examples": { + "Lists all private link resources on application gateway": { + "$ref": "./examples/ApplicationGatewayPrivateLinkResourceList.json" + } + }, + "description": "Lists all private link resources on an application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of private link resources on application gateway.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}": { + "delete": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_Delete", + "x-ms-examples": { + "Delete Application Gateway Private Endpoint Connection": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionDelete.json" + } + }, + "description": "Deletes the specified private endpoint connection on application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway private endpoint connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_Update", + "description": "Updates the specified private endpoint connection on application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + }, + "description": "Parameters supplied to update application gateway private endpoint connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting private endpoint connection on application gateway.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Application Gateway Private Endpoint Connection": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection on application gateway.", + "x-ms-examples": { + "Get Application Gateway Private Endpoint Connection": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway private endpoint connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an application gateway private endpoint connection.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections": { + "get": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_List", + "x-ms-examples": { + "Lists all private endpoint connections on application gateway": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionList.json" + } + }, + "description": "Lists all private endpoint connections on an application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of private endpoint connections on application gateway.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableServerVariables": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableServerVariables", + "x-ms-examples": { + "Get Available Server Variables": { + "$ref": "./examples/ApplicationGatewayAvailableServerVariablesGet.json" + } + }, + "description": "Lists all available server variables.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available server variables.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableServerVariablesResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableRequestHeaders": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableRequestHeaders", + "x-ms-examples": { + "Get Available Request Headers": { + "$ref": "./examples/ApplicationGatewayAvailableRequestHeadersGet.json" + } + }, + "description": "Lists all available request headers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available request headers.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableRequestHeadersResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableResponseHeaders": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableResponseHeaders", + "x-ms-examples": { + "Get Available Response Headers": { + "$ref": "./examples/ApplicationGatewayAvailableResponseHeadersGet.json" + } + }, + "description": "Lists all available response headers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available response headers.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableResponseHeadersResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableWafRuleSets", + "x-ms-examples": { + "Get Available Waf Rule Sets": { + "$ref": "./examples/ApplicationGatewayAvailableWafRuleSetsGet.json" + } + }, + "description": "Lists all available web application firewall rule sets.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall rule sets.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableWafRuleSetsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslOptions", + "x-ms-examples": { + "Get Available Ssl Options": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json" + } + }, + "description": "Lists available Ssl options for configuring Ssl policy.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns all available Ssl options for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslPredefinedPolicies", + "x-ms-examples": { + "Get Available Ssl Predefined Policies": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "Lists all SSL predefined policies for configuring Ssl policy.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a lists of all Ssl predefined policies for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslPredefinedPolicies" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_GetSslPredefinedPolicy", + "x-ms-examples": { + "Get Available Ssl Predefined Policy by name": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json" + } + }, + "description": "Gets Ssl predefined policy with the specified policy name.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "predefinedPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of Ssl predefined policy." + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a Ssl predefined policy with the specified policy name.", + "schema": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ApplicationGatewayOnDemandProbe": { + "properties": { + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used for the probe." + }, + "host": { + "type": "string", + "description": "Host name to send the probe to." + }, + "path": { + "type": "string", + "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." + }, + "pickHostNameFromBackendHttpSettings": { + "type": "boolean", + "description": "Whether the host header should be picked from the backend http settings. Default value is false." + }, + "match": { + "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", + "description": "Criterion for classifying a healthy probe response." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to backend pool of application gateway to which probe request will be sent." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to backend http setting of application gateway to be used for test probe." + } + }, + "description": "Details of on demand test probe request." + }, + "ApplicationGatewayBackendHealthOnDemand": { + "properties": { + "backendAddressPool": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", + "description": "Reference to an ApplicationGatewayBackendAddressPool resource." + }, + "backendHealthHttpSettings": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings", + "description": "Application gateway BackendHealthHttp settings." + } + }, + "description": "Result of on demand test probe." + }, + "ApplicationGatewayBackendHealth": { + "properties": { + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthPool" + }, + "description": "A list of ApplicationGatewayBackendHealthPool resources." + } + }, + "description": "Response for ApplicationGatewayBackendHealth API service call." + }, + "ApplicationGatewayBackendHealthPool": { + "properties": { + "backendAddressPool": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", + "description": "Reference to an ApplicationGatewayBackendAddressPool resource." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings" + }, + "description": "List of ApplicationGatewayBackendHealthHttpSettings resources." + } + }, + "description": "Application gateway BackendHealth pool." + }, + "ApplicationGatewayBackendHealthHttpSettings": { + "properties": { + "backendHttpSettings": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings", + "description": "Reference to an ApplicationGatewayBackendHttpSettings resource." + }, + "servers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthServer" + }, + "description": "List of ApplicationGatewayBackendHealthServer resources." + } + }, + "description": "Application gateway BackendHealthHttp settings." + }, + "ApplicationGatewayBackendHealthServer": { + "properties": { + "address": { + "type": "string", + "description": "IP address or FQDN of backend server." + }, + "ipConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "Reference to IP configuration of backend server." + }, + "health": { + "type": "string", + "description": "Health of backend server.", + "enum": [ + "Unknown", + "Up", + "Down", + "Partial", + "Draining" + ], + "x-ms-enum": { + "name": "ApplicationGatewayBackendHealthServerHealth", + "modelAsString": true + } + }, + "healthProbeLog": { + "type": "string", + "description": "Health Probe Log." + } + }, + "description": "Application gateway backendhealth http settings." + }, + "ApplicationGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Name of an application gateway SKU.", + "enum": [ + "Standard_Small", + "Standard_Medium", + "Standard_Large", + "WAF_Medium", + "WAF_Large", + "Standard_v2", + "WAF_v2", + "Basic" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of an application gateway.", + "enum": [ + "Standard", + "WAF", + "Standard_v2", + "WAF_v2", + "Basic" + ], + "x-ms-enum": { + "name": "ApplicationGatewayTier", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity (instance count) of an application gateway." + }, + "family": { + "type": "string", + "description": "Family of an application gateway SKU.", + "enum": [ + "Generation_1", + "Generation_2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySkuFamily", + "modelAsString": true + } + } + }, + "description": "SKU of an application gateway." + }, + "ApplicationGatewaySslPolicy": { + "properties": { + "disabledSslProtocols": { + "type": "array", + "description": "Ssl protocols to be disabled on application gateway.", + "items": { + "type": "string", + "$ref": "#/definitions/ProtocolsEnum" + } + }, + "policyType": { + "type": "string", + "description": "Type of Ssl Policy.", + "enum": [ + "Predefined", + "Custom", + "CustomV2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyType", + "modelAsString": true + } + }, + "policyName": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of Ssl predefined policy." + }, + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order to application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Application Gateway Ssl policy." + }, + "ApplicationGatewayClientAuthConfiguration": { + "properties": { + "verifyClientCertIssuerDN": { + "type": "boolean", + "description": "Verify client certificate issuer name on the application gateway." + }, + "verifyClientRevocation": { + "type": "string", + "description": "Verify client certificate revocation status.", + "enum": [ + "None", + "OCSP" + ], + "x-ms-enum": { + "name": "ApplicationGatewayClientRevocationOptions", + "modelAsString": true + } + } + }, + "description": "Application gateway client authentication configuration." + }, + "ApplicationGatewayIPConfigurationPropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource. A subnet from where application gateway gets its private address." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway IP configuration resource." + } + }, + "description": "Properties of IP configuration of an application gateway." + }, + "ApplicationGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat", + "description": "Properties of the application gateway IP configuration." + }, + "name": { + "type": "string", + "description": "Name of the IP configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." + }, + "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the authentication certificate resource." + } + }, + "description": "Authentication certificates properties of an application gateway." + }, + "ApplicationGatewayAuthenticationCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat", + "description": "Properties of the application gateway authentication certificate." + }, + "name": { + "type": "string", + "description": "Name of the authentication certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authentication certificates of an application gateway." + }, + "ApplicationGatewayTrustedRootCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the trusted root certificate resource." + } + }, + "description": "Trusted Root certificates properties of an application gateway." + }, + "ApplicationGatewayTrustedRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat", + "description": "Properties of the application gateway trusted root certificate." + }, + "name": { + "type": "string", + "description": "Name of the trusted root certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Trusted Root certificates of an application gateway." + }, + "ApplicationGatewayTrustedClientCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "validatedCertData": { + "readOnly": true, + "type": "string", + "description": "Validated certificate data." + }, + "clientCertIssuerDN": { + "readOnly": true, + "type": "string", + "description": "Distinguished name of client certificate issuer." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the trusted client certificate resource." + } + }, + "description": "Trusted client certificates properties of an application gateway." + }, + "ApplicationGatewayTrustedClientCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayTrustedClientCertificatePropertiesFormat", + "description": "Properties of the application gateway trusted client certificate." + }, + "name": { + "type": "string", + "description": "Name of the trusted client certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Trusted client certificates of an application gateway." + }, + "ApplicationGatewaySslCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." + }, + "password": { + "type": "string", + "description": "Password for the pfx file specified in data. Only applicable in PUT request." + }, + "publicCertData": { + "readOnly": true, + "type": "string", + "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." + }, + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the SSL certificate resource." + } + }, + "description": "Properties of SSL certificates of an application gateway." + }, + "ApplicationGatewaySslCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat", + "description": "Properties of the application gateway SSL certificate." + }, + "name": { + "type": "string", + "description": "Name of the SSL certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "SSL certificates of an application gateway." + }, + "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "PrivateIPAddress of the network interface IP Configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the PublicIP resource." + }, + "privateLinkConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the application gateway private link configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the frontend IP configuration resource." + } + }, + "description": "Properties of Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat", + "description": "Properties of the application gateway frontend IP configuration." + }, + "name": { + "type": "string", + "description": "Name of the frontend IP configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendPortPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "Frontend port." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the frontend port resource." + } + }, + "description": "Properties of Frontend port of an application gateway." + }, + "ApplicationGatewayFrontendPort": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat", + "description": "Properties of the application gateway frontend port." + }, + "name": { + "type": "string", + "description": "Name of the frontend port that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend port of an application gateway." + }, + "ApplicationGatewayBackendAddress": { + "properties": { + "fqdn": { + "type": "string", + "description": "Fully qualified domain name (FQDN)." + }, + "ipAddress": { + "type": "string", + "description": "IP address." + } + }, + "description": "Backend address of an application gateway." + }, + "ApplicationGatewayBackendAddressPoolPropertiesFormat": { + "properties": { + "backendIPConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "Collection of references to IPs defined in network interfaces." + }, + "backendAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddress" + }, + "description": "Backend addresses." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the backend address pool resource." + } + }, + "description": "Properties of Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendAddressPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat", + "description": "Properties of the application gateway backend address pool." + }, + "name": { + "type": "string", + "description": "Name of the backend address pool that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The destination port on the backend." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used to communicate with the backend." + }, + "cookieBasedAffinity": { + "type": "string", + "description": "Cookie based affinity.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCookieBasedAffinity", + "modelAsString": true + } + }, + "requestTimeout": { + "type": "integer", + "format": "int32", + "description": "Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Probe resource of an application gateway." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway authentication certificates." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway trusted root certificates." + }, + "connectionDraining": { + "$ref": "#/definitions/ApplicationGatewayConnectionDraining", + "description": "Connection draining of the backend http settings resource." + }, + "hostName": { + "type": "string", + "description": "Host header to be sent to the backend servers." + }, + "pickHostNameFromBackendAddress": { + "type": "boolean", + "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." + }, + "affinityCookieName": { + "type": "string", + "description": "Cookie name to use for the affinity cookie." + }, + "probeEnabled": { + "type": "boolean", + "description": "Whether the probe is enabled. Default value is false." + }, + "path": { + "type": "string", + "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the backend HTTP settings resource." + } + }, + "description": "Properties of Backend address pool settings of an application gateway." + }, + "ApplicationGatewayBackendHttpSettings": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat", + "description": "Properties of the application gateway backend HTTP settings." + }, + "name": { + "type": "string", + "description": "Name of the backend http settings that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend address pool settings of an application gateway." + }, + "ApplicationGatewayBackendSettingsPropertiesFormat": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The destination port on the backend." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used to communicate with the backend." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Probe resource of an application gateway." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway trusted root certificates." + }, + "hostName": { + "type": "string", + "description": "Server name indication to be sent to the backend servers for Tls protocol." + }, + "pickHostNameFromBackendAddress": { + "type": "boolean", + "description": "Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the backend HTTP settings resource." + } + }, + "description": "Properties of Backend address pool settings of an application gateway." + }, + "ApplicationGatewayBackendSettings": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendSettingsPropertiesFormat", + "description": "Properties of the application gateway backend settings." + }, + "name": { + "type": "string", + "description": "Name of the backend settings that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend address pool settings of an application gateway." + }, + "ApplicationGatewaySslProfilePropertiesFormat": { + "properties": { + "trustedClientCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway trusted client certificates." + }, + "sslPolicy": { + "$ref": "#/definitions/ApplicationGatewaySslPolicy", + "description": "SSL policy of the application gateway resource." + }, + "clientAuthConfiguration": { + "$ref": "#/definitions/ApplicationGatewayClientAuthConfiguration", + "description": "Client authentication configuration of the application gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the HTTP listener resource." + } + }, + "description": "Properties of SSL profile of an application gateway." + }, + "ApplicationGatewaySslProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslProfilePropertiesFormat", + "description": "Properties of the application gateway SSL profile." + }, + "name": { + "type": "string", + "description": "Name of the SSL profile that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "SSL profile of an application gateway." + }, + "ApplicationGatewayHttpListenerPropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend IP configuration resource of an application gateway." + }, + "frontendPort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend port resource of an application gateway." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "Protocol of the HTTP listener." + }, + "hostName": { + "type": "string", + "description": "Host name of HTTP listener." + }, + "sslCertificate": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL certificate resource of an application gateway." + }, + "sslProfile": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL profile resource of the application gateway." + }, + "requireServerNameIndication": { + "type": "boolean", + "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the HTTP listener resource." + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the HTTP listener." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the FirewallPolicy resource." + }, + "hostNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Host names for HTTP Listener that allows special wildcard characters as well." + } + }, + "description": "Properties of HTTP listener of an application gateway." + }, + "ApplicationGatewayHttpListener": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat", + "description": "Properties of the application gateway HTTP listener." + }, + "name": { + "type": "string", + "description": "Name of the HTTP listener that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Http listener of an application gateway." + }, + "ApplicationGatewayListenerPropertiesFormat": { + "type": "object", + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend IP configuration resource of an application gateway." + }, + "frontendPort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend port resource of an application gateway." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "Protocol of the listener." + }, + "sslCertificate": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL certificate resource of an application gateway." + }, + "sslProfile": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL profile resource of the application gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the listener resource." + }, + "hostNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Server Name Indications(SNI) for TLS Multi-site Listener that allows special wildcard characters as well." + } + }, + "description": "Properties of listener of an application gateway." + }, + "ApplicationGatewayListener": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayListenerPropertiesFormat", + "description": "Properties of the application gateway listener." + }, + "name": { + "type": "string", + "description": "Name of the listener that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Listener of an application gateway." + }, + "ApplicationGatewayPathRulePropertiesFormat": { + "properties": { + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Path rules of URL path map." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of URL path map path rule." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of URL path map path rule." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of URL path map path rule." + }, + "rewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Rewrite rule set resource of URL path map path rule." + }, + "loadDistributionPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Load Distribution Policy resource of URL path map path rule." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the path rule resource." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the FirewallPolicy resource." + } + }, + "description": "Properties of path rule of an application gateway." + }, + "ApplicationGatewayPathRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat", + "description": "Properties of the application gateway path rule." + }, + "name": { + "type": "string", + "description": "Name of the path rule that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Path rule of URL path map of an application gateway." + }, + "ApplicationGatewayProbePropertiesFormat": { + "properties": { + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used for the probe." + }, + "host": { + "type": "string", + "description": "Host name to send the probe to." + }, + "path": { + "type": "string", + "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." + }, + "unhealthyThreshold": { + "type": "integer", + "format": "int32", + "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." + }, + "pickHostNameFromBackendHttpSettings": { + "type": "boolean", + "description": "Whether the host header should be picked from the backend http settings. Default value is false." + }, + "pickHostNameFromBackendSettings": { + "type": "boolean", + "description": "Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false." + }, + "minServers": { + "type": "integer", + "format": "int32", + "description": "Minimum number of servers that are always marked healthy. Default value is 0." + }, + "match": { + "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", + "description": "Criterion for classifying a healthy probe response." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the probe resource." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Basic, Standard_v2 and WAF_v2 only.", + "minimum": 1, + "maximum": 65535 + } + }, + "description": "Properties of probe of an application gateway." + }, + "ApplicationGatewayProbeHealthResponseMatch": { + "properties": { + "body": { + "type": "string", + "description": "Body that must be contained in the health response. Default value is empty." + }, + "statusCodes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." + } + }, + "description": "Application gateway probe health response match." + }, + "ApplicationGatewayProbe": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat", + "description": "Properties of the application gateway probe." + }, + "name": { + "type": "string", + "description": "Name of the probe that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Probe of the application gateway." + }, + "ApplicationGatewayRequestRoutingRulePropertiesFormat": { + "properties": { + "ruleType": { + "type": "string", + "description": "Rule type.", + "enum": [ + "Basic", + "PathBasedRouting" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRequestRoutingRuleType", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false, + "maximum": 20000, + "exclusiveMaximum": false, + "description": "Priority of the request routing rule." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of the application gateway." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of the application gateway." + }, + "httpListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Http listener resource of the application gateway." + }, + "urlPathMap": { + "$ref": "./network.json#/definitions/SubResource", + "description": "URL path map resource of the application gateway." + }, + "rewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Rewrite Rule Set resource in Basic rule of the application gateway." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of the application gateway." + }, + "loadDistributionPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Load Distribution Policy resource of the application gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the request routing rule resource." + } + }, + "description": "Properties of request routing rule of the application gateway." + }, + "ApplicationGatewayRequestRoutingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat", + "description": "Properties of the application gateway request routing rule." + }, + "name": { + "type": "string", + "description": "Name of the request routing rule that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Request routing rule of an application gateway." + }, + "ApplicationGatewayRoutingRulePropertiesFormat": { + "type": "object", + "properties": { + "ruleType": { + "type": "string", + "description": "Rule type.", + "enum": [ + "Basic", + "PathBasedRouting" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRequestRoutingRuleType", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false, + "maximum": 20000, + "exclusiveMaximum": false, + "description": "Priority of the routing rule." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of the application gateway." + }, + "backendSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend settings resource of the application gateway." + }, + "listener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Listener resource of the application gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the request routing rule resource." + } + }, + "required": [ + "priority" + ], + "description": "Properties of routing rule of the application gateway." + }, + "ApplicationGatewayRoutingRule": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRoutingRulePropertiesFormat", + "description": "Properties of the application gateway routing rule." + }, + "name": { + "type": "string", + "description": "Name of the routing rule that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Routing rule of an application gateway." + }, + "ApplicationGatewayRewriteRuleSet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat", + "description": "Properties of the application gateway rewrite rule set." + }, + "name": { + "type": "string", + "description": "Name of the rewrite rule set that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Rewrite rule set of an application gateway." + }, + "ApplicationGatewayRewriteRuleSetPropertiesFormat": { + "properties": { + "rewriteRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRule" + }, + "description": "Rewrite rules in the rewrite rule set." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the rewrite rule set resource." + } + }, + "description": "Properties of rewrite rule set of the application gateway." + }, + "ApplicationGatewayRewriteRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the rewrite rule that is unique within an Application Gateway." + }, + "ruleSequence": { + "type": "integer", + "description": "Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet." + }, + "conditions": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRuleCondition" + }, + "description": "Conditions based on which the action set execution will be evaluated." + }, + "actionSet": { + "type": "object", + "$ref": "#/definitions/ApplicationGatewayRewriteRuleActionSet", + "description": "Set of actions to be done as part of the rewrite Rule." + } + }, + "description": "Rewrite rule of an application gateway." + }, + "ApplicationGatewayRewriteRuleCondition": { + "properties": { + "variable": { + "type": "string", + "description": "The condition parameter of the RewriteRuleCondition." + }, + "pattern": { + "type": "string", + "description": "The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition." + }, + "ignoreCase": { + "type": "boolean", + "description": "Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison." + }, + "negate": { + "type": "boolean", + "description": "Setting this value as truth will force to check the negation of the condition given by the user." + } + }, + "description": "Set of conditions in the Rewrite Rule in Application Gateway." + }, + "ApplicationGatewayRewriteRuleActionSet": { + "properties": { + "requestHeaderConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" + }, + "description": "Request Header Actions in the Action Set." + }, + "responseHeaderConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" + }, + "description": "Response Header Actions in the Action Set." + }, + "urlConfiguration": { + "$ref": "#/definitions/ApplicationGatewayUrlConfiguration", + "description": "Url Configuration Action in the Action Set." + } + }, + "description": "Set of actions in the Rewrite Rule in Application Gateway." + }, + "ApplicationGatewayHeaderConfiguration": { + "properties": { + "headerName": { + "type": "string", + "description": "Header name of the header configuration." + }, + "headerValueMatcher": { + "type": "object", + "$ref": "#/definitions/HeaderValueMatcher", + "description": "An optional field under \"Rewrite Action\". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud" + }, + "headerValue": { + "type": "string", + "description": "Header value of the header configuration." + } + }, + "description": "Header configuration of the Actions set in Application Gateway." + }, + "HeaderValueMatcher": { + "type": "object", + "properties": { + "pattern": { + "type": "string", + "description": "The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite." + }, + "ignoreCase": { + "type": "boolean", + "description": "Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison." + }, + "negate": { + "type": "boolean", + "description": "Setting this value as truth will force to check the negation of the condition given by the user in the pattern field." + } + }, + "description": "An optional field under \"Rewrite Action\". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud" + }, + "ApplicationGatewayUrlConfiguration": { + "properties": { + "modifiedPath": { + "type": "string", + "description": "Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null." + }, + "modifiedQueryString": { + "type": "string", + "description": "Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null." + }, + "reroute": { + "type": "boolean", + "description": "If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false." + } + }, + "description": "Url configuration of the Actions set in Application Gateway." + }, + "ApplicationGatewayRedirectConfigurationPropertiesFormat": { + "properties": { + "redirectType": { + "type": "string", + "$ref": "#/definitions/RedirectTypeEnum", + "description": "HTTP redirection type." + }, + "targetListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to a listener to redirect the request to." + }, + "targetUrl": { + "type": "string", + "description": "Url to redirect the request to." + }, + "includePath": { + "type": "boolean", + "description": "Include path in the redirected url." + }, + "includeQueryString": { + "type": "boolean", + "description": "Include query string in the redirected url." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Request routing specifying redirect configuration." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Url path maps specifying default redirect configuration." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Path rules specifying redirect configuration." + } + }, + "description": "Properties of redirect configuration of the application gateway." + }, + "ApplicationGatewayRedirectConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat", + "description": "Properties of the application gateway redirect configuration." + }, + "name": { + "type": "string", + "description": "Name of the redirect configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Redirect configuration of an application gateway." + }, + "ApplicationGatewayPrivateLinkConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateLinkConfigurationProperties", + "description": "Properties of the application gateway private link configuration." + }, + "name": { + "type": "string", + "description": "Name of the private link configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Private Link Configuration on an application gateway." + }, + "ApplicationGatewayPrivateLinkConfigurationProperties": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkIpConfiguration" + }, + "description": "An array of application gateway private link ip configurations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway private link configuration." + } + }, + "description": "Properties of private link configuration on an application gateway." + }, + "ApplicationGatewayPrivateLinkIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateLinkIpConfigurationProperties", + "description": "Properties of an application gateway private link ip configuration." + }, + "name": { + "type": "string", + "description": "The name of application gateway private link ip configuration." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The application gateway private link ip configuration." + }, + "ApplicationGatewayPrivateLinkIpConfigurationProperties": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource." + }, + "primary": { + "type": "boolean", + "description": "Whether the ip configuration is primary or not." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway private link IP configuration." + } + }, + "description": "Properties of an application gateway private link IP configuration." + }, + "ApplicationGatewayPrivateLinkResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateLinkResourceProperties", + "description": "Properties of the application gateway private link resource." + }, + "name": { + "type": "string", + "description": "Name of the private link resource that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "PrivateLink Resource of an application gateway." + }, + "ApplicationGatewayPrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "Group identifier of private link resource.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "Required member names of private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required DNS zone names of the the private link resource." + } + }, + "description": "Properties of a private link resource." + }, + "ApplicationGatewayPrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkResource" + }, + "description": "List of private link resources of an application gateway." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGatewayPrivateLinkResources API service call. Gets all private link resources for an application gateway." + }, + "ApplicationGatewayPrivateEndpointConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnectionProperties", + "description": "Properties of the application gateway private endpoint connection." + }, + "name": { + "type": "string", + "description": "Name of the private endpoint connection on an application gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Private Endpoint connection on an application gateway." + }, + "ApplicationGatewayPrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "readOnly": true, + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "./privateLinkService.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway private endpoint connection resource." + }, + "linkIdentifier": { + "readOnly": true, + "type": "string", + "description": "The consumer link id." + } + }, + "description": "Properties of Private Link Resource of an application gateway." + }, + "ApplicationGatewayPrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + }, + "description": "List of private endpoint connections on an application gateway." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGatewayPrivateEndpointConnection API service call. Gets all private endpoint connections for an application gateway." + }, + "ApplicationGatewayPropertiesFormat": { + "properties": { + "sku": { + "$ref": "#/definitions/ApplicationGatewaySku", + "description": "SKU of the application gateway resource." + }, + "sslPolicy": { + "$ref": "#/definitions/ApplicationGatewaySslPolicy", + "description": "SSL policy of the application gateway resource." + }, + "operationalState": { + "readOnly": true, + "type": "string", + "description": "Operational state of the application gateway resource.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping" + ], + "x-ms-enum": { + "name": "ApplicationGatewayOperationalState", + "modelAsString": true + } + }, + "gatewayIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayIPConfiguration" + }, + "description": "Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" + }, + "description": "Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificate" + }, + "description": "Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "trustedClientCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayTrustedClientCertificate" + }, + "description": "Trusted client certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "sslCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslCertificate" + }, + "description": "SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" + }, + "description": "Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "frontendPorts": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendPort" + }, + "description": "Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "probes": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayProbe" + }, + "description": "Probes of the application gateway resource." + }, + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" + }, + "description": "Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" + }, + "description": "Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "backendSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendSettings" + }, + "description": "Backend settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "httpListeners": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHttpListener" + }, + "description": "Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayListener" + }, + "description": "Listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "sslProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslProfile" + }, + "description": "SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayUrlPathMap" + }, + "description": "URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" + }, + "description": "Request routing rules of the application gateway resource." + }, + "routingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRoutingRule" + }, + "description": "Routing rules of the application gateway resource." + }, + "rewriteRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRuleSet" + }, + "description": "Rewrite rules for the application gateway resource." + }, + "redirectConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" + }, + "description": "Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "webApplicationFirewallConfiguration": { + "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration", + "description": "Web application firewall configuration." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the FirewallPolicy resource." + }, + "enableHttp2": { + "type": "boolean", + "description": "Whether HTTP2 is enabled on the application gateway resource." + }, + "enableFips": { + "type": "boolean", + "description": "Whether FIPS is enabled on the application gateway resource." + }, + "autoscaleConfiguration": { + "$ref": "#/definitions/ApplicationGatewayAutoscaleConfiguration", + "description": "Autoscale Configuration." + }, + "privateLinkConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkConfiguration" + }, + "description": "PrivateLink configurations on application gateway." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + }, + "description": "Private Endpoint connections on application gateway." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the application gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway resource." + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the application gateway resource." + }, + "forceFirewallPolicyAssociation": { + "type": "boolean", + "description": "If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config." + }, + "loadDistributionPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayLoadDistributionPolicy" + }, + "description": "Load distribution policies of the application gateway resource." + }, + "globalConfiguration": { + "$ref": "#/definitions/ApplicationGatewayGlobalConfiguration", + "description": "Global Configuration." + }, + "defaultPredefinedSslPolicy": { + "$ref": "#/definitions/PolicyNameEnum", + "readOnly": true, + "description": "The default predefined SSL Policy applied on the application gateway resource." + } + }, + "description": "Properties of the application gateway." + }, + "ApplicationGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPropertiesFormat", + "description": "Properties of the application gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the application gateway, if configured." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Application gateway resource." + }, + "ApplicationGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "List of an application gateways in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGateways API service call." + }, + "ApplicationGatewayUrlPathMapPropertiesFormat": { + "properties": { + "defaultBackendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend address pool resource of URL path map." + }, + "defaultBackendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend http settings resource of URL path map." + }, + "defaultRewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default Rewrite rule set resource of URL path map." + }, + "defaultRedirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default redirect configuration resource of URL path map." + }, + "defaultLoadDistributionPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default Load Distribution Policy resource of URL path map." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPathRule" + }, + "description": "Path rule of URL path map resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the URL path map resource." + } + }, + "description": "Properties of UrlPathMap of the application gateway." + }, + "ApplicationGatewayUrlPathMap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat", + "description": "Properties of the application gateway URL path map." + }, + "name": { + "type": "string", + "description": "Name of the URL path map that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." + }, + "ApplicationGatewayWebApplicationFirewallConfiguration": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the web application firewall is enabled or not." + }, + "firewallMode": { + "type": "string", + "description": "Web application firewall mode.", + "enum": [ + "Detection", + "Prevention" + ], + "x-ms-enum": { + "name": "ApplicationGatewayFirewallMode", + "modelAsString": true + } + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the rule set type." + }, + "disabledRuleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" + }, + "description": "The disabled rule groups." + }, + "requestBodyCheck": { + "type": "boolean", + "description": "Whether allow WAF to check request Body." + }, + "maxRequestBodySize": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size for WAF." + }, + "maxRequestBodySizeInKb": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size in Kb for WAF." + }, + "fileUploadLimitInMb": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Maximum file upload size in Mb for WAF." + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallExclusion" + }, + "description": "The exclusion list." + } + }, + "required": [ + "enabled", + "firewallMode", + "ruleSetType", + "ruleSetVersion" + ], + "description": "Application gateway web application firewall configuration." + }, + "ApplicationGatewayAutoscaleConfiguration": { + "properties": { + "minCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Lower bound on number of Application Gateway capacity." + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "minimum": 2, + "exclusiveMinimum": false, + "description": "Upper bound on number of Application Gateway capacity." + } + }, + "required": [ + "minCapacity" + ], + "description": "Application Gateway autoscale configuration." + }, + "ApplicationGatewayConnectionDraining": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether connection draining is enabled or not." + }, + "drainTimeoutInSec": { + "type": "integer", + "format": "int32", + "maximum": 3600, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." + } + }, + "required": [ + "enabled", + "drainTimeoutInSec" + ], + "description": "Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration." + }, + "ApplicationGatewayFirewallDisabledRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the rule group that will be disabled." + }, + "rules": { + "type": "array", + "items": { + "type": "integer", + "format": "int32", + "x-nullable": false + }, + "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." + } + }, + "required": [ + "ruleGroupName" + ], + "description": "Allows to disable rules within a rule group or an entire rule group." + }, + "ApplicationGatewayAvailableServerVariablesResult": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Response for ApplicationGatewayAvailableServerVariables API service call." + }, + "ApplicationGatewayAvailableRequestHeadersResult": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Response for ApplicationGatewayAvailableRequestHeaders API service call." + }, + "ApplicationGatewayAvailableResponseHeadersResult": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Response for ApplicationGatewayAvailableResponseHeaders API service call." + }, + "ApplicationGatewayFirewallExclusion": { + "properties": { + "matchVariable": { + "type": "string", + "description": "The variable to be excluded." + }, + "selectorMatchOperator": { + "type": "string", + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to." + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." + } + }, + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Allow to exclude some variable satisfy the condition for the WAF check." + }, + "ApplicationGatewayAvailableWafRuleSetsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSet" + }, + "description": "The list of application gateway rule sets." + } + }, + "description": "Response for ApplicationGatewayAvailableWafRuleSets API service call." + }, + "ApplicationGatewayFirewallRuleSet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat", + "description": "Properties of the application gateway firewall rule set." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleSetPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the web application firewall rule set." + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the web application firewall rule set type." + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleGroup" + }, + "description": "The rule groups of the web application firewall rule set." + }, + "tiers": { + "type": "array", + "description": "Tier of an application gateway that support the rule set.", + "items": { + "type": "string", + "enum": [ + "Standard", + "WAF", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewayTierTypes", + "modelAsString": true + } + } + } + }, + "required": [ + "ruleSetType", + "ruleSetVersion", + "ruleGroups" + ], + "description": "Properties of the web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the web application firewall rule group." + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule group." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRule" + }, + "description": "The rules of the web application firewall rule group." + } + }, + "required": [ + "ruleGroupName", + "rules" + ], + "description": "A web application firewall rule group." + }, + "ApplicationGatewayFirewallRule": { + "properties": { + "ruleId": { + "type": "integer", + "format": "int32", + "description": "The identifier of the web application firewall rule." + }, + "ruleIdString": { + "type": "string", + "description": "The string representation of the web application firewall rule identifier." + }, + "state": { + "type": "string", + "description": "The string representation of the web application firewall rule state.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApplicationGatewayWafRuleStateTypes", + "modelAsString": true + } + }, + "action": { + "type": "string", + "description": "The string representation of the web application firewall rule action.", + "enum": [ + "None", + "AnomalyScoring", + "Allow", + "Block", + "Log" + ], + "x-ms-enum": { + "name": "ApplicationGatewayWafRuleActionTypes", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule." + } + }, + "required": [ + "ruleId" + ], + "description": "A web application firewall rule." + }, + "ApplicationGatewayAvailableSslOptions": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat", + "description": "Properties of the application gateway available SSL options." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewayAvailableSslOptionsPropertiesFormat": { + "properties": { + "predefinedPolicies": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of available Ssl predefined policy." + }, + "defaultPolicy": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of the Ssl predefined policy applied by default to application gateway." + }, + "availableCipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "List of available Ssl cipher suites." + }, + "availableProtocols": { + "type": "array", + "items": { + "$ref": "#/definitions/ProtocolsEnum" + }, + "description": "List of available Ssl protocols." + } + }, + "description": "Properties of ApplicationGatewayAvailableSslOptions." + }, + "ApplicationGatewayAvailableSslPredefinedPolicies": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + }, + "description": "List of available Ssl predefined policy." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewaySslPredefinedPolicy": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Ssl predefined policy." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat", + "description": "Properties of the application gateway SSL predefined policy." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "An Ssl predefined policy." + }, + "ApplicationGatewaySslPredefinedPolicyPropertiesFormat": { + "properties": { + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order for application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Properties of ApplicationGatewaySslPredefinedPolicy." + }, + "ApplicationGatewayCustomError": { + "properties": { + "statusCode": { + "type": "string", + "description": "Status code of the application gateway custom error.", + "enum": [ + "HttpStatus400", + "HttpStatus403", + "HttpStatus404", + "HttpStatus405", + "HttpStatus408", + "HttpStatus500", + "HttpStatus502", + "HttpStatus503", + "HttpStatus504" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCustomErrorStatusCode", + "modelAsString": true + } + }, + "customErrorPageUrl": { + "type": "string", + "description": "Error page URL of the application gateway custom error." + } + }, + "description": "Custom error of an application gateway." + }, + "PolicyNameEnum": { + "type": "string", + "description": "Ssl predefined policy name enums.", + "enum": [ + "AppGwSslPolicy20150501", + "AppGwSslPolicy20170401", + "AppGwSslPolicy20170401S", + "AppGwSslPolicy20220101", + "AppGwSslPolicy20220101S" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyName", + "modelAsString": true + } + }, + "ProtocolsEnum": { + "type": "string", + "description": "Ssl protocol enums.", + "enum": [ + "TLSv1_0", + "TLSv1_1", + "TLSv1_2", + "TLSv1_3" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslProtocol", + "modelAsString": true + } + }, + "CipherSuitesEnum": { + "type": "string", + "description": "Ssl cipher suites enums.", + "enum": [ + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslCipherSuite", + "modelAsString": true + } + }, + "RedirectTypeEnum": { + "type": "string", + "description": "Redirect type enum.", + "enum": [ + "Permanent", + "Found", + "SeeOther", + "Temporary" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRedirectType", + "modelAsString": true + } + }, + "ApplicationGatewayProtocol": { + "type": "string", + "description": "Application Gateway protocol.", + "enum": [ + "Http", + "Https", + "Tcp", + "Tls" + ], + "x-ms-enum": { + "name": "ApplicationGatewayProtocol", + "modelAsString": true, + "values": [ + { + "value": "Http", + "description": "Supported for httpListeners and backendHttpSettingsCollection properties." + }, + { + "value": "Https", + "description": "Supported for httpListeners and backendHttpSettingsCollection properties." + }, + { + "value": "Tcp", + "description": "Supported for listeners and backendSettingsCollection properties." + }, + { + "value": "Tls", + "description": "Supported for listeners and backendSettingsCollection properties." + } + ] + } + }, + "ApplicationGatewayLoadDistributionPolicyPropertiesFormat": { + "properties": { + "loadDistributionTargets": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayLoadDistributionTarget" + }, + "description": "Load Distribution Targets resource of an application gateway." + }, + "loadDistributionAlgorithm": { + "$ref": "#/definitions/ApplicationGatewayLoadDistributionAlgorithmEnum", + "description": "Load Distribution Targets resource of an application gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Load Distribution Policy resource." + } + }, + "description": "Properties of Load Distribution Policy of an application gateway." + }, + "ApplicationGatewayLoadDistributionPolicy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayLoadDistributionPolicyPropertiesFormat", + "description": "Properties of the application gateway load distribution policy." + }, + "name": { + "type": "string", + "description": "Name of the load distribution policy that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Load Distribution Policy of an application gateway." + }, + "ApplicationGatewayLoadDistributionTargetPropertiesFormat": { + "properties": { + "weightPerServer": { + "type": "integer", + "format": "int32", + "maximum": 100, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "description": "Weight per server. Range between 1 and 100." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of the application gateway." + } + } + }, + "ApplicationGatewayLoadDistributionTarget": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayLoadDistributionTargetPropertiesFormat", + "description": "Properties of the application gateway load distribution target." + }, + "name": { + "type": "string", + "description": "Name of the load distribution policy that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Load Distribution Target of an application gateway." + }, + "ApplicationGatewayLoadDistributionAlgorithmEnum": { + "type": "string", + "description": "Load Distribution Algorithm enums.", + "enum": [ + "RoundRobin", + "LeastConnections", + "IpHash" + ], + "x-ms-enum": { + "name": "ApplicationGatewayLoadDistributionAlgorithm", + "modelAsString": true + } + }, + "ApplicationGatewayGlobalConfiguration": { + "properties": { + "enableRequestBuffering": { + "type": "boolean", + "description": "Enable request buffering." + }, + "enableResponseBuffering": { + "type": "boolean", + "description": "Enable response buffering." + } + }, + "description": "Application Gateway global configuration." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationGatewayWafDynamicManifests.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationGatewayWafDynamicManifests.json new file mode 100644 index 000000000000..3fe983c8aaf0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationGatewayWafDynamicManifests.json @@ -0,0 +1,257 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests/dafault": { + "get": { + "operationId": "ApplicationGatewayWafDynamicManifestsDefault_Get", + "description": "Gets the regional application gateway waf manifest.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region where the nrp are located at." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the regional application gateway waf manifest", + "schema": { + "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets WAF default manifest": { + "$ref": "./examples/GetApplicationGatewayWafDynamicManifestsDefault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests": { + "get": { + "operationId": "ApplicationGatewayWafDynamicManifests_Get", + "description": "Gets the regional application gateway waf manifest.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region where the nrp are located at." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the regional application gateway waf manifest", + "schema": { + "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets WAF manifests": { + "$ref": "./examples/GetApplicationGatewayWafDynamicManifests.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ApplicationGatewayWafDynamicManifestResultList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestResult" + }, + "description": "The list of application gateway waf manifest." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "type": "object", + "description": "Response for ApplicationGatewayWafDynamicManifests API service call." + }, + "ApplicationGatewayWafDynamicManifestResult": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestPropertiesResult", + "description": "Properties of the ApplicationGatewayWafDynamicManifest ." + } + }, + "type": "object", + "description": "Response for ApplicationGatewayWafDynamicManifest API service call." + }, + "ApplicationGatewayWafDynamicManifestPropertiesResult": { + "description": "Properties of ApplicationGatewayWafDynamicManifest.", + "type": "object", + "properties": { + "defaultRuleSet": { + "description": "The default ruleset.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DefaultRuleSetPropertyFormat" + }, + "availableRuleSets": { + "description": "The available rulesets.", + "x-ms-client-flatten": true, + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallManifestRuleSet" + }, + "x-ms-identifiers": [] + } + } + }, + "DefaultRuleSetPropertyFormat": { + "description": "the default web application firewall rule set.", + "type": "object", + "properties": { + "ruleSetType": { + "description": "The type of the web application firewall rule set.", + "type": "string" + }, + "ruleSetVersion": { + "description": "The version of the web application firewall rule set type.", + "type": "string" + } + } + }, + "ApplicationGatewayFirewallManifestRuleSet": { + "description": "Properties of the web application firewall rule set.", + "type": "object", + "properties": { + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the web application firewall rule set type." + }, + "status": { + "type": "string", + "description": "The rule set status", + "enum": [ + "Preview", + "GA", + "Supported", + "Deprecated" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRuleSetStatusOptions", + "modelAsString": true + } + }, + "tiers": { + "type": "array", + "description": "Tier of an application gateway that support the rule set.", + "items": { + "type": "string", + "enum": [ + "Standard", + "WAF", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewayTierTypes", + "modelAsString": true + } + } + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "applicationGateway.json#/definitions/ApplicationGatewayFirewallRuleGroup" + }, + "description": "The rule groups of the web application firewall rule set.", + "x-ms-identifiers": [] + } + }, + "required": [ + "ruleSetType", + "ruleSetVersion", + "ruleGroups" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationSecurityGroup.json new file mode 100644 index 000000000000..e687e7fbe1b3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationSecurityGroup.json @@ -0,0 +1,406 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}": { + "delete": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Delete", + "description": "Deletes the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete application security group": { + "$ref": "./examples/ApplicationSecurityGroupDelete.json" + } + } + }, + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Get", + "description": "Gets information about the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get application security group": { + "$ref": "./examples/ApplicationSecurityGroupGet.json" + } + } + }, + "put": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_CreateOrUpdate", + "description": "Creates or updates an application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "Parameters supplied to the create or update ApplicationSecurityGroup operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create application security group": { + "$ref": "./examples/ApplicationSecurityGroupCreate.json" + } + } + }, + "patch": { + "tags": [ + "applicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_UpdateTags", + "description": "Updates an application security group's tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update application security group tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ApplicationSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update application security group tags": { + "$ref": "./examples/ApplicationSecurityGroupUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_ListAll", + "description": "Gets all application security groups in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all application security groups": { + "$ref": "./examples/ApplicationSecurityGroupListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_List", + "description": "Gets all the application security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List load balancers in resource group": { + "$ref": "./examples/ApplicationSecurityGroupList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ApplicationSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat", + "description": "Properties of the application security group." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "An application security group in a resource group." + }, + "ApplicationSecurityGroupPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application security group resource." + } + }, + "description": "Application security group properties." + }, + "ApplicationSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "A list of application security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of application security groups." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/availableDelegations.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/availableDelegations.json new file mode 100644 index 000000000000..d2af404bf03c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/availableDelegations.json @@ -0,0 +1,178 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableDelegations_List", + "description": "Gets all of the available subnet delegations for this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available delegations": { + "$ref": "./examples/AvailableDelegationsSubscriptionGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableResourceGroupDelegations_List", + "description": "Gets all of the available subnet delegations for this resource group in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available delegations in the resource group": { + "$ref": "./examples/AvailableDelegationsResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AvailableDelegationsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableDelegation" + }, + "description": "An array of available delegations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available delegations." + }, + "AvailableDelegation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the AvailableDelegation resource." + }, + "id": { + "type": "string", + "description": "A unique identifier of the AvailableDelegation resource." + }, + "type": { + "type": "string", + "description": "Resource type." + }, + "serviceName": { + "type": "string", + "description": "The name of the service and resource." + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The actions permitted to the service upon delegation." + } + }, + "description": "The serviceName of an AvailableDelegation indicates a possible delegation for a subnet." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/availableServiceAliases.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/availableServiceAliases.json new file mode 100644 index 000000000000..67f186d21d57 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/availableServiceAliases.json @@ -0,0 +1,171 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableServiceAliases": { + "get": { + "operationId": "AvailableServiceAliases_List", + "description": "Gets all available service aliases for this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all available service aliases for the subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableServiceAliasesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available service aliases": { + "$ref": "./examples/AvailableServiceAliasesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableServiceAliases": { + "get": { + "operationId": "AvailableServiceAliases_ListByResourceGroup", + "description": "Gets all available service aliases for this resource group in this region.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all available service aliases for the resource group in the region.", + "schema": { + "$ref": "#/definitions/AvailableServiceAliasesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available service aliases in the resource group": { + "$ref": "./examples/AvailableServiceAliasesListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AvailableServiceAlias": { + "properties": { + "name": { + "type": "string", + "description": "The name of the service alias." + }, + "id": { + "type": "string", + "description": "The ID of the service alias." + }, + "type": { + "type": "string", + "description": "The type of the resource." + }, + "resourceName": { + "type": "string", + "description": "The resource name of the service alias." + } + }, + "description": "The available service alias." + }, + "AvailableServiceAliasesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableServiceAlias" + }, + "description": "An array of available service aliases." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available service aliases." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewall.json new file mode 100644 index 000000000000..df777fa6ecc5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewall.json @@ -0,0 +1,1342 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}": { + "delete": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_Delete", + "description": "Deletes the specified Azure Firewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Azure Firewall": { + "$ref": "./examples/AzureFirewallDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_Get", + "description": "Gets the specified Azure Firewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure Firewall": { + "$ref": "./examples/AzureFirewallGet.json" + }, + "Get Azure Firewall With Zones": { + "$ref": "./examples/AzureFirewallGetWithZones.json" + }, + "Get Azure Firewall With management subnet": { + "$ref": "./examples/AzureFirewallGetWithMgmtSubnet.json" + }, + "Get Azure Firewall With Additional Properties": { + "$ref": "./examples/AzureFirewallGetWithAdditionalProperties.json" + }, + "Get Azure Firewall With IpGroups": { + "$ref": "./examples/AzureFirewallGetWithIpGroups.json" + } + } + }, + "put": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_CreateOrUpdate", + "description": "Creates or updates the specified Azure Firewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 56, + "description": "The name of the Azure Firewall." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureFirewall" + }, + "description": "Parameters supplied to the create or update Azure Firewall operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Azure Firewall": { + "$ref": "./examples/AzureFirewallPut.json" + }, + "Create Azure Firewall With Zones": { + "$ref": "./examples/AzureFirewallPutWithZones.json" + }, + "Create Azure Firewall With management subnet": { + "$ref": "./examples/AzureFirewallPutWithMgmtSubnet.json" + }, + "Create Azure Firewall in virtual Hub": { + "$ref": "./examples/AzureFirewallPutInHub.json" + }, + "Create Azure Firewall With Additional Properties": { + "$ref": "./examples/AzureFirewallPutWithAdditionalProperties.json" + }, + "Create Azure Firewall With IpGroups": { + "$ref": "./examples/AzureFirewallPutWithIpGroups.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_UpdateTags", + "description": "Updates tags of an Azure Firewall resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Firewall." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update azure firewall tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Update successful. The operation returns the resulting AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Azure Firewall Tags": { + "$ref": "./examples/AzureFirewallUpdateTags.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls": { + "get": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_List", + "description": "Lists all Azure Firewalls in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of AzureFirewall resources.", + "schema": { + "$ref": "#/definitions/AzureFirewallListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Firewalls for a given resource group": { + "$ref": "./examples/AzureFirewallListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls": { + "get": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_ListAll", + "description": "Gets all the Azure Firewalls in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of AzureFirewall resources.", + "schema": { + "$ref": "#/definitions/AzureFirewallListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Firewalls for a given subscription": { + "$ref": "./examples/AzureFirewallListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}/learnedIPPrefixes": { + "post": { + "operationId": "AzureFirewalls_ListLearnedPrefixes", + "description": "Retrieves a list of all IP prefixes that azure firewall has learned to not SNAT.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the azure firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of learnt SNAT IP prefixes for no SNAT.", + "schema": { + "$ref": "#/definitions/IPPrefixesList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AzureFirewallListLearnedPrefixes": { + "$ref": "./examples/AzureFirewallListLearnedIPPrefixes.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}/packetCapture": { + "post": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_PacketCapture", + "description": "Runs a packet capture on AzureFirewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 56, + "pattern": "^[a-zA-Z0-9]", + "description": "The name of the Azure Firewall." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallPacketCaptureParameters" + }, + "description": "Parameters supplied to run packet capture on azure firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AzureFirewallPacketCapture": { + "$ref": "./examples/AzureFirewallPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "AzureFirewallIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "readOnly": true, + "description": "The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet' or 'AzureFirewallManagementSubnet'." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the PublicIP resource. This field is a mandatory input if subnet is not null." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Azure firewall IP configuration resource." + } + }, + "description": "Properties of IP configuration of an Azure Firewall." + }, + "AzureFirewallIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallIPConfigurationPropertiesFormat", + "description": "Properties of the azure firewall IP configuration." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an Azure Firewall." + }, + "AzureFirewallPublicIPAddress": { + "properties": { + "address": { + "type": "string", + "description": "Public IP Address value." + } + }, + "description": "Public IP Address associated with azure firewall." + }, + "AzureFirewallIpGroups": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource ID." + }, + "changeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number." + } + }, + "description": "IpGroups associated with azure firewall." + }, + "HubPublicIPAddresses": { + "properties": { + "addresses": { + "type": "array", + "description": "The list of Public IP addresses associated with azure firewall or IP addresses to be retained.", + "items": { + "$ref": "#/definitions/AzureFirewallPublicIPAddress" + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of Public IP addresses associated with azure firewall." + } + }, + "description": "Public IP addresses associated with azure firewall." + }, + "HubIPAddresses": { + "properties": { + "publicIPs": { + "description": "Public IP addresses associated with azure firewall.", + "$ref": "#/definitions/HubPublicIPAddresses" + }, + "privateIPAddress": { + "type": "string", + "description": "Private IP Address associated with azure firewall." + } + }, + "description": "IP addresses associated with azure firewall." + }, + "IpGroups": { + "type": "array", + "description": "List of IpGroups associated with azure firewall.", + "items": { + "$ref": "#/definitions/AzureFirewallIpGroups" + } + }, + "AzureFirewallPropertiesFormat": { + "properties": { + "applicationRuleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallApplicationRuleCollection" + }, + "description": "Collection of application rule collections used by Azure Firewall." + }, + "natRuleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNatRuleCollection" + }, + "description": "Collection of NAT rule collections used by Azure Firewall." + }, + "networkRuleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRuleCollection" + }, + "description": "Collection of network rule collections used by Azure Firewall." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallIPConfiguration" + }, + "description": "IP configuration of the Azure Firewall resource." + }, + "managementIpConfiguration": { + "$ref": "#/definitions/AzureFirewallIPConfiguration", + "description": "IP configuration of the Azure Firewall used for management traffic." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Azure firewall resource." + }, + "threatIntelMode": { + "description": "The operation mode for Threat Intelligence.", + "$ref": "#/definitions/AzureFirewallThreatIntelMode" + }, + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The virtualHub to which the firewall belongs." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The firewallPolicy associated with this azure firewall." + }, + "hubIPAddresses": { + "description": "IP addresses associated with AzureFirewall.", + "$ref": "#/definitions/HubIPAddresses" + }, + "ipGroups": { + "readOnly": true, + "description": "IpGroups associated with AzureFirewall.", + "$ref": "#/definitions/IpGroups" + }, + "sku": { + "description": "The Azure Firewall Resource SKU.", + "$ref": "#/definitions/AzureFirewallSku" + }, + "additionalProperties": { + "$ref": "#/definitions/AzureFirewallAdditionalProperties", + "description": "The additional properties used to further config this azure firewall." + } + }, + "description": "Properties of the Azure Firewall." + }, + "AzureFirewall": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallPropertiesFormat", + "description": "Properties of the azure firewall." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Azure Firewall resource." + }, + "AzureFirewallListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewall" + }, + "description": "List of Azure Firewalls in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListAzureFirewalls API service call." + }, + "AzureFirewallThreatIntelMode": { + "type": "string", + "description": "The operation mode for Threat Intel.", + "enum": [ + "Alert", + "Deny", + "Off" + ], + "x-ms-enum": { + "name": "AzureFirewallThreatIntelMode", + "modelAsString": true + } + }, + "AzureFirewallAdditionalProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The additional properties of azure firewall." + }, + "AzureFirewallApplicationRuleCollectionPropertiesFormat": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the application rule collection resource." + }, + "action": { + "$ref": "#/definitions/AzureFirewallRCAction", + "description": "The action type of a rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallApplicationRule" + }, + "description": "Collection of rules used by a application rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application rule collection resource." + } + }, + "description": "Properties of the application rule collection." + }, + "AzureFirewallApplicationRuleCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat", + "description": "Properties of the azure firewall application rule collection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the Azure firewall. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Application rule collection resource." + }, + "AzureFirewallApplicationRuleProtocol": { + "properties": { + "protocolType": { + "description": "Protocol type.", + "$ref": "#/definitions/AzureFirewallApplicationRuleProtocolType" + }, + "port": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false, + "description": "Port number for the protocol, cannot be greater than 64000. This field is optional." + } + }, + "description": "Properties of the application rule protocol." + }, + "AzureFirewallApplicationRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the application rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallApplicationRuleProtocol" + }, + "description": "Array of ApplicationRuleProtocols." + }, + "targetFqdns": { + "type": "array", + "description": "List of FQDNs for this rule.", + "items": { + "type": "string" + } + }, + "fqdnTags": { + "type": "array", + "description": "List of FQDN Tags for this rule.", + "items": { + "type": "string" + } + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + } + }, + "description": "Properties of an application rule." + }, + "AzureFirewallNatRuleCollectionProperties": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the NAT rule collection resource." + }, + "action": { + "$ref": "#/definitions/AzureFirewallNatRCAction", + "description": "The action type of a NAT rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNatRule" + }, + "description": "Collection of rules used by a NAT rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NAT rule collection resource." + } + }, + "description": "Properties of the NAT rule collection." + }, + "AzureFirewallNatRuleCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallNatRuleCollectionProperties", + "description": "Properties of the azure firewall NAT rule collection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the Azure firewall. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "NAT rule collection resource." + }, + "AzureFirewallNatRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the NAT rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "destinationAddresses": { + "type": "array", + "description": "List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of destination ports.", + "items": { + "type": "string" + } + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRuleProtocol" + }, + "description": "Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule." + }, + "translatedAddress": { + "type": "string", + "description": "The translated address for this NAT rule." + }, + "translatedPort": { + "type": "string", + "description": "The translated port for this NAT rule." + }, + "translatedFqdn": { + "type": "string", + "description": "The translated FQDN for this NAT rule." + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + } + }, + "description": "Properties of a NAT rule." + }, + "AzureFirewallNatRCAction": { + "properties": { + "type": { + "description": "The type of action.", + "$ref": "#/definitions/AzureFirewallNatRCActionType" + } + }, + "description": "AzureFirewall NAT Rule Collection Action." + }, + "AzureFirewallNatRCActionType": { + "type": "string", + "description": "The action type of a NAT rule collection.", + "enum": [ + "Snat", + "Dnat" + ], + "x-ms-enum": { + "name": "AzureFirewallNatRCActionType", + "modelAsString": true + } + }, + "AzureFirewallNetworkRuleCollectionPropertiesFormat": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the network rule collection resource." + }, + "action": { + "$ref": "#/definitions/AzureFirewallRCAction", + "description": "The action type of a rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRule" + }, + "description": "Collection of rules used by a network rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network rule collection resource." + } + }, + "description": "Properties of the network rule collection." + }, + "AzureFirewallNetworkRuleCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat", + "description": "Properties of the azure firewall network rule collection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the Azure firewall. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Network rule collection resource." + }, + "AzureFirewallNetworkRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the network rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRuleProtocol" + }, + "description": "Array of AzureFirewallNetworkRuleProtocols." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "destinationAddresses": { + "type": "array", + "description": "List of destination IP addresses.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of destination ports.", + "items": { + "type": "string" + } + }, + "destinationFqdns": { + "type": "array", + "description": "List of destination FQDNs.", + "items": { + "type": "string" + } + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + }, + "destinationIpGroups": { + "type": "array", + "description": "List of destination IpGroups for this rule.", + "items": { + "type": "string" + } + } + }, + "description": "Properties of the network rule." + }, + "AzureFirewallRCAction": { + "properties": { + "type": { + "description": "The type of action.", + "$ref": "#/definitions/AzureFirewallRCActionType" + } + }, + "description": "Properties of the AzureFirewallRCAction." + }, + "AzureFirewallRCActionType": { + "type": "string", + "description": "The action type of a rule collection.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "AzureFirewallRCActionType", + "modelAsString": true + } + }, + "AzureFirewallNetworkRuleProtocol": { + "type": "string", + "description": "The protocol of a Network Rule resource.", + "enum": [ + "TCP", + "UDP", + "Any", + "ICMP" + ], + "x-ms-enum": { + "name": "AzureFirewallNetworkRuleProtocol", + "modelAsString": true + } + }, + "AzureFirewallApplicationRuleProtocolType": { + "type": "string", + "description": "The protocol type of a Application Rule resource.", + "enum": [ + "Http", + "Https", + "Mssql" + ], + "x-ms-enum": { + "name": "AzureFirewallApplicationRuleProtocolType", + "modelAsString": true + } + }, + "AzureFirewallSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of an Azure Firewall SKU.", + "enum": [ + "AZFW_VNet", + "AZFW_Hub" + ], + "x-ms-enum": { + "name": "AzureFirewallSkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of an Azure Firewall.", + "enum": [ + "Standard", + "Premium", + "Basic" + ], + "x-ms-enum": { + "name": "AzureFirewallSkuTier", + "modelAsString": true + } + } + }, + "description": "SKU of an Azure Firewall." + }, + "IPPrefixesList": { + "type": "object", + "properties": { + "ipPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "IP Prefix value." + } + }, + "description": "List of SNAT IP Prefixes learnt by firewall to not SNAT" + }, + "FirewallPacketCaptureParametersFormat": { + "type": "object", + "properties": { + "durationInSeconds": { + "type": "integer", + "format": "int32", + "maximum": 1800, + "exclusiveMaximum": false, + "minimum": 30, + "exclusiveMinimum": false, + "description": "Duration of packet capture in seconds." + }, + "numberOfPacketsToCapture": { + "type": "integer", + "format": "int32", + "maximum": 90000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Number of packets to be captured." + }, + "sasUrl": { + "type": "string", + "description": "Upload capture location" + }, + "fileName": { + "type": "string", + "description": "Name of file to be uploaded to sasURL" + }, + "protocol": { + "$ref": "#/definitions/AzureFirewallNetworkRuleProtocol", + "description": "The protocol of packets to capture" + }, + "flags": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallPacketCaptureFlags" + }, + "description": "The tcp-flag type to be captured. Used with protocol TCP", + "x-ms-identifiers": [] + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallPacketCaptureRule" + }, + "description": "Rules to filter packet captures.", + "x-ms-identifiers": [] + } + }, + "description": "Packet capture parameters on azure firewall." + }, + "AzureFirewallPacketCaptureFlags": { + "type": "object", + "properties": { + "type": { + "description": "Flags to capture", + "$ref": "#/definitions/AzureFirewallPacketCaptureFlagsType" + } + }, + "description": "Properties of the AzureFirewallRCAction." + }, + "AzureFirewallPacketCaptureFlagsType": { + "type": "string", + "description": "The flags type to be captured.", + "enum": [ + "fin", + "syn", + "rst", + "push", + "ack", + "urg" + ], + "x-ms-enum": { + "name": "AzureFirewallPacketCaptureFlagsType", + "modelAsString": true + } + }, + "AzureFirewallPacketCaptureRule": { + "type": "object", + "properties": { + "sources": { + "type": "array", + "description": "List of source IP addresses/subnets to be captured.", + "items": { + "type": "string" + } + }, + "destinations": { + "type": "array", + "description": "List of destination IP addresses/subnets to be captured.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of ports to be captured.", + "items": { + "type": "string" + } + } + }, + "description": "Group of src/dest ips and ports to be captured." + }, + "FirewallPacketCaptureParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FirewallPacketCaptureParametersFormat", + "description": "Properties of the azure firewall." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Azure Firewall Packet Capture Parameters resource." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewallFqdnTag.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewallFqdnTag.json new file mode 100644 index 000000000000..d0c3af2a9015 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewallFqdnTag.json @@ -0,0 +1,130 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewallFqdnTags": { + "get": { + "tags": [ + "AzureFirewallFqdnTags" + ], + "operationId": "AzureFirewallFqdnTags_ListAll", + "description": "Gets all the Azure Firewall FQDN Tags in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Azure Firewall FQDN Tag resources.", + "schema": { + "$ref": "#/definitions/AzureFirewallFqdnTagListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Firewall FQDN Tags for a given subscription": { + "$ref": "./examples/AzureFirewallFqdnTagsListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AzureFirewallFqdnTagPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Azure firewall FQDN tag resource." + }, + "fqdnTagName": { + "type": "string", + "readOnly": true, + "description": "The name of this FQDN Tag." + } + }, + "description": "Azure Firewall FQDN Tag Properties." + }, + "AzureFirewallFqdnTag": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallFqdnTagPropertiesFormat", + "description": "Properties of the azure firewall FQDN tag." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Azure Firewall FQDN Tag Resource." + }, + "AzureFirewallFqdnTagListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallFqdnTag" + }, + "description": "List of Azure Firewall FQDN Tags in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListAzureFirewallFqdnTags API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureWebCategory.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureWebCategory.json new file mode 100644 index 000000000000..10d928c85c0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureWebCategory.json @@ -0,0 +1,184 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureWebCategories/{name}": { + "get": { + "tags": [ + "WebCategories" + ], + "operationId": "WebCategories_Get", + "description": "Gets the specified Azure Web Category.", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the azureWebCategory." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands resourceIds back referenced by the azureWebCategory resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting azureWebCategory resource.", + "schema": { + "$ref": "#/definitions/AzureWebCategory" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure Web Category by name": { + "$ref": "./examples/AzureWebCategoryGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureWebCategories": { + "get": { + "tags": [ + "WebCategories" + ], + "operationId": "WebCategories_ListBySubscription", + "description": "Gets all the Azure Web Categories in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Azure Web Category resources.", + "schema": { + "$ref": "#/definitions/AzureWebCategoryListResult" + } + }, + "default": { + "description": "Unexpected Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Web Categories for a given subscription": { + "$ref": "./examples/AzureWebCategoriesListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AzureWebCategoryPropertiesFormat": { + "properties": { + "group": { + "type": "string", + "readOnly": true, + "description": "The name of the group that the category belongs to." + } + }, + "description": "Azure Web Category Properties." + }, + "AzureWebCategory": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureWebCategoryPropertiesFormat", + "description": "Properties of the Azure Web Category." + }, + "id": { + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "Azure Web Category Resource." + }, + "AzureWebCategoryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureWebCategory" + }, + "description": "List of Azure Web Categories for a given Subscription." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListAzureWebCategories API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/bastionHost.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/bastionHost.json new file mode 100644 index 000000000000..adcb7970a24b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/bastionHost.json @@ -0,0 +1,1114 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}": { + "delete": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_Delete", + "description": "Deletes the specified Bastion Host.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Bastion Host": { + "$ref": "./examples/BastionHostDelete.json" + }, + "Delete Developer Bastion Host": { + "$ref": "./examples/BastionHostDeveloperDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_Get", + "description": "Gets the specified Bastion Host.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an BastionHost resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Bastion Host": { + "$ref": "./examples/BastionHostGet.json" + }, + "Get Developer Bastion Host": { + "$ref": "./examples/BastionHostDeveloperGet.json" + }, + "Get Bastion Host With Zones": { + "$ref": "./examples/BastionHostGetWithZones.json" + } + } + }, + "put": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_CreateOrUpdate", + "description": "Creates or updates the specified Bastion Host.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BastionHost" + }, + "description": "Parameters supplied to the create or update Bastion Host operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting Bastion Host resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting Bastion Host resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Bastion Host": { + "$ref": "./examples/BastionHostPut.json" + }, + "Create Bastion Host With Zones": { + "$ref": "./examples/BastionHostPutWithZones.json" + }, + "Create Developer Bastion Host": { + "$ref": "./examples/BastionHostDeveloperPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_UpdateTags", + "description": "Updates Tags for BastionHost resource", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update BastionHost tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting BastionHost resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Patch Bastion Host": { + "$ref": "./examples/BastionHostPatch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts": { + "get": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_List", + "description": "Lists all Bastion Hosts in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Bastion Host resources.", + "schema": { + "$ref": "#/definitions/BastionHostListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Bastion Hosts for a given subscription": { + "$ref": "./examples/BastionHostListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts": { + "get": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_ListByResourceGroup", + "description": "Lists all Bastion Hosts in a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of BastionHost resources.", + "schema": { + "$ref": "#/definitions/BastionHostListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Bastion Hosts for a given resource group": { + "$ref": "./examples/BastionHostListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/createShareableLinks": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "PutBastionShareableLink", + "description": "Creates a Bastion Shareable Links for all the VMs specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkRequest" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of shareable links for the specified VMs, giving appropriate error messages as needed.", + "schema": { + "$ref": "#/definitions/BastionShareableLinkListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/deleteShareableLinks": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "DeleteBastionShareableLink", + "description": "Deletes the Bastion Shareable Links for all the VMs specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkRequest" + } + ], + "responses": { + "200": { + "description": "Success. The operation deleted the BastionShareableLinks associated with the VMs, if they existed. No return body." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/deleteShareableLinksByToken": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "DeleteBastionShareableLinkByToken", + "description": "Deletes the Bastion Shareable Links for all the tokens specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkTokenRequest" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkDeleteByToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getShareableLinks": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "GetBastionShareableLink", + "description": "Return the Bastion Shareable Links for all the VMs specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkRequest" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of shareable links for the specified VMs, giving appropriate error messages as needed.", + "schema": { + "$ref": "#/definitions/BastionShareableLinkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns the Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getActiveSessions": { + "post": { + "tags": [ + "BastionHosts" + ], + "operationId": "GetActiveSessions", + "description": "Returns the list of currently active sessions on the Bastion.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of active sessions on the Bastion.", + "schema": { + "$ref": "#/definitions/BastionActiveSessionListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns a list of currently active sessions on the Bastion": { + "$ref": "./examples/BastionSessionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/disconnectActiveSessions": { + "post": { + "tags": [ + "BastionHosts" + ], + "operationId": "DisconnectActiveSessions", + "description": "Returns the list of currently active sessions on the Bastion.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SessionIdsParameters" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of sessions with the state of deleted/failed/not found.", + "schema": { + "$ref": "#/definitions/BastionSessionDeleteResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Deletes the specified active session": { + "$ref": "./examples/BastionSessionDelete.json" + } + } + } + } + }, + "definitions": { + "Sku": { + "description": "The sku of this Bastion Host.", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku of this Bastion Host.", + "enum": [ + "Basic", + "Standard", + "Developer", + "Premium" + ], + "default": "Standard", + "x-ms-enum": { + "name": "BastionHostSkuName", + "modelAsString": true + } + } + }, + "type": "object" + }, + "IPRule": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed." + } + }, + "type": "object" + }, + "BastionHostIPConfigurationPropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the PublicIP resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the bastion host IP configuration resource." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "Private IP allocation method." + } + }, + "required": [ + "subnet", + "publicIPAddress" + ], + "description": "Properties of IP configuration of an Bastion Host." + }, + "BastionHostIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BastionHostIPConfigurationPropertiesFormat", + "description": "Represents the ip configuration associated with the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Ip configuration type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an Bastion Host." + }, + "BastionHostPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionHostIPConfiguration" + }, + "description": "IP configuration of the Bastion Host resource." + }, + "dnsName": { + "type": "string", + "description": "FQDN for the endpoint on which bastion host is accessible." + }, + "virtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to an existing virtual network required for Developer Bastion Host only." + }, + "networkAcls": { + "properties": { + "ipRules": { + "type": "array", + "items": { + "description": "IP rule with specific IP or IP range in CIDR format.", + "$ref": "#/definitions/IPRule" + }, + "description": "Sets the IP ACL rules for Developer Bastion Host." + } + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the bastion host resource." + }, + "scaleUnits": { + "type": "integer", + "format": "int32", + "description": "The scale units for the Bastion Host resource.", + "minimum": 2, + "maximum": 50 + }, + "disableCopyPaste": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Copy/Paste feature of the Bastion Host resource." + }, + "enableFileCopy": { + "type": "boolean", + "default": false, + "description": "Enable/Disable File Copy feature of the Bastion Host resource." + }, + "enableIpConnect": { + "type": "boolean", + "default": false, + "description": "Enable/Disable IP Connect feature of the Bastion Host resource." + }, + "enableShareableLink": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Shareable Link of the Bastion Host resource." + }, + "enableTunneling": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Tunneling feature of the Bastion Host resource." + }, + "enableKerberos": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Kerberos feature of the Bastion Host resource." + }, + "enableSessionRecording": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Session Recording feature of the Bastion Host resource." + } + }, + "description": "Properties of the Bastion Host." + }, + "BastionHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BastionHostPropertiesFormat", + "description": "Represents the bastion host resource." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "sku": { + "description": "The sku of this Bastion Host.", + "$ref": "#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Bastion Host resource." + }, + "BastionHostListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionHost" + }, + "description": "List of Bastion Hosts in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListBastionHosts API service call." + }, + "BastionShareableLink": { + "properties": { + "vm": { + "$ref": "#/definitions/VM", + "description": "Reference of the virtual machine resource." + }, + "bsl": { + "type": "string", + "readOnly": true, + "description": "The unique Bastion Shareable Link to the virtual machine." + }, + "createdAt": { + "type": "string", + "readOnly": true, + "description": "The time when the link was created." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Optional field indicating the warning or error message related to the vm in case of partial failure." + } + }, + "required": [ + "vm" + ], + "description": "Bastion Shareable Link." + }, + "BastionShareableLinkListRequest": { + "properties": { + "vms": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionShareableLink" + }, + "description": "List of VM references." + } + }, + "description": "Post request for Create/Delete/Get Bastion Shareable Link endpoints." + }, + "BastionShareableLinkTokenListRequest": { + "type": "object", + "properties": { + "tokens": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Bastion Shareable Link Token." + } + }, + "description": "Post request for Delete Bastion Shareable Link By Token endpoint." + }, + "BastionShareableLinkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionShareableLink" + }, + "description": "List of Bastion Shareable Links for the request." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for all the Bastion Shareable Link endpoints." + }, + "BastionActiveSession": { + "properties": { + "sessionId": { + "type": "string", + "readOnly": true, + "description": "A unique id for the session." + }, + "startTime": { + "type": "object", + "readOnly": true, + "description": "The time when the session started." + }, + "targetSubscriptionId": { + "type": "string", + "readOnly": true, + "description": "The subscription id for the target virtual machine." + }, + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The type of the resource." + }, + "targetHostName": { + "type": "string", + "readOnly": true, + "description": "The host name of the target." + }, + "targetResourceGroup": { + "type": "string", + "readOnly": true, + "description": "The resource group of the target." + }, + "userName": { + "type": "string", + "readOnly": true, + "description": "The user name who is active on this session." + }, + "targetIpAddress": { + "type": "string", + "readOnly": true, + "description": "The IP Address of the target." + }, + "protocol": { + "type": "string", + "readOnly": true, + "description": "The protocol used to connect to the target.", + "enum": [ + "SSH", + "RDP" + ], + "x-ms-enum": { + "name": "BastionConnectProtocol", + "modelAsString": true + } + }, + "targetResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource id of the target." + }, + "sessionDurationInMins": { + "type": "number", + "readOnly": true, + "description": "Duration in mins the session has been active." + } + }, + "description": "The session detail for a target." + }, + "BastionActiveSessionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionActiveSession" + }, + "description": "List of active sessions on the bastion." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for GetActiveSessions." + }, + "BastionSessionState": { + "properties": { + "sessionId": { + "type": "string", + "readOnly": true, + "description": "A unique id for the session." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Used for extra information." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the session. Disconnected/Failed/NotFound." + } + }, + "description": "The session state detail for a target." + }, + "BastionSessionDeleteResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionSessionState" + }, + "description": "List of sessions with their corresponding state." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for DisconnectActiveSessions." + }, + "VM": { + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "SessionIds": { + "properties": { + "sessionIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of session IDs." + } + }, + "description": "List of session IDs." + } + }, + "parameters": { + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "BastionShareableLinkRequest": { + "name": "bslRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BastionShareableLinkListRequest" + }, + "description": "Post request for Create/Delete/Get Bastion Shareable Link endpoints.", + "x-ms-parameter-location": "method" + }, + "BastionShareableLinkTokenRequest": { + "name": "bslTokenRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BastionShareableLinkTokenListRequest" + }, + "description": "Post request for Delete Bastion Shareable Link By Token endpoint.", + "x-ms-parameter-location": "method" + }, + "BastionHostName": { + "name": "bastionHostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Bastion Host.", + "x-ms-parameter-location": "method" + }, + "SessionIdsParameters": { + "name": "sessionIds", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionIds" + }, + "description": "The list of sessionids to disconnect.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/checkDnsAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/checkDnsAvailability.json new file mode 100644 index 000000000000..a05576dc029d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/checkDnsAvailability.json @@ -0,0 +1,96 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability": { + "get": { + "operationId": "CheckDnsNameAvailability", + "description": "Checks whether a domain name in the cloudapp.azure.com zone is available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "domainNameLabel", + "in": "query", + "required": true, + "type": "string", + "description": "The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the DNS name is available.", + "schema": { + "$ref": "#/definitions/DnsNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check Dns Name Availability": { + "$ref": "./examples/CheckDnsNameAvailability.json" + } + } + } + } + }, + "definitions": { + "DnsNameAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Domain availability (True/False)." + } + }, + "description": "Response for the CheckDnsNameAvailability API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServiceNetworkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServiceNetworkInterface.json new file mode 100644 index 000000000000..3b40c7f7e91e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServiceNetworkInterface.json @@ -0,0 +1,222 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListCloudServiceRoleInstanceNetworkInterfaces", + "description": "Gets information about all network interfaces in a role instance in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of role instance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List cloud service role instance network interfaces": { + "$ref": "./examples/CloudServiceRoleInstanceNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListCloudServiceNetworkInterfaces", + "description": "Gets all network interfaces in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List cloud service network interfaces": { + "$ref": "./examples/CloudServiceNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetCloudServiceNetworkInterface", + "description": "Get the specified network interface in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of role instance." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get cloud service network interface": { + "$ref": "./examples/CloudServiceNetworkInterfaceGet.json" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServicePublicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServicePublicIpAddress.json new file mode 100644 index 000000000000..232e9a1b47c2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServicePublicIpAddress.json @@ -0,0 +1,241 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListCloudServicePublicIPAddresses", + "description": "Gets information about all public IP addresses on a cloud service level.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPInterface resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSPublicIP": { + "$ref": "./examples/CloudServicePublicIpListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListCloudServiceRoleInstancePublicIPAddresses", + "description": "Gets information about all public IP addresses in a role instance IP configuration in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of role instance." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The network interface name." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The IP configuration name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSVMPublicIP": { + "$ref": "./examples/CloudServiceRoleInstancePublicIpList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}": { + "get": { + "operationId": "PublicIPAddresses_GetCloudServicePublicIPAddress", + "description": "Get the specified public IP address in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The role instance name." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IP configuration." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP Address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "x-ms-examples": { + "GetVMSSPublicIP": { + "$ref": "./examples/CloudServicePublicIpGet.json" + } + }, + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServiceSwap.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServiceSwap.json new file mode 100644 index 000000000000..447be4da5371 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/cloudServiceSwap.json @@ -0,0 +1,280 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots/{singletonResource}": { + "get": { + "tags": [ + "VipSwap" + ], + "operationId": "VipSwap_Get", + "description": "Gets the SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production", + "parameters": [ + { + "name": "groupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "singletonResource", + "in": "path", + "required": true, + "type": "string", + "description": "Specifies a synthetic proxy resource that cannot be created or deleted. Value must be set to swap.", + "enum": [ + "swap" + ], + "x-ms-enum": { + "name": "singletonResource", + "modelAsString": false + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + }, + "200": { + "description": "Request successful. The operation returns the slot type for the specified cloud service.", + "schema": { + "$ref": "#/definitions/SwapResource" + } + } + }, + "x-ms-examples": { + "Get swap resource": { + "$ref": "./examples/CloudServiceSwapGet.json" + } + } + }, + "put": { + "tags": [ + "VipSwap" + ], + "operationId": "VipSwap_Create", + "description": "Performs vip swap operation on swappable cloud services.", + "parameters": [ + { + "name": "groupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "singletonResource", + "in": "path", + "required": true, + "type": "string", + "description": "Specifies a synthetic resource that cannot be created or deleted. Value must be set to swap.", + "enum": [ + "swap" + ], + "x-ms-enum": { + "name": "singletonResource", + "modelAsString": false + } + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SwapResource" + }, + "description": "SwapResource object where slot type should be the target slot after vip swap for the specified cloud service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Put vip swap operation.": { + "$ref": "./examples/CloudServiceSwapPut.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots": { + "get": { + "tags": [ + "VipSwap" + ], + "operationId": "VipSwap_List", + "description": "Gets the list of SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production", + "parameters": [ + { + "name": "groupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + }, + "200": { + "description": "Request successful. The operation returns the slot type for the specified cloud service.", + "schema": { + "$ref": "#/definitions/SwapResourceListResult" + } + } + }, + "x-ms-examples": { + "Get swap resource list": { + "$ref": "./examples/CloudServiceSwapList.json" + } + } + } + } + }, + "definitions": { + "SwapResource": { + "type": "object", + "properties": { + "id": { + "description": "Resource Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SwapResourceProperties" + } + }, + "description": "SwapResource to represent slot type on the specified cloud service." + }, + "SwapResourceProperties": { + "description": "Swap resource properties", + "type": "object", + "properties": { + "slotType": { + "description": "Specifies slot info on a cloud service", + "type": "string", + "enum": [ + "Production", + "Staging" + ], + "x-ms-enum": { + "name": "slotType", + "modelAsString": false + } + } + } + }, + "SwapResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SwapResource" + } + } + }, + "description": "SwapResource List with single entry to represent slot type on the specified cloud service." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/customIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/customIpPrefix.json new file mode 100644 index 000000000000..5e9898d894cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/customIpPrefix.json @@ -0,0 +1,522 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}": { + "delete": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_Delete", + "description": "Deletes the specified custom IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "customIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the CustomIpPrefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete custom IP prefix": { + "$ref": "./examples/CustomIpPrefixDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_Get", + "description": "Gets the specified custom IP prefix in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "customIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the custom IP prefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting CustomIpPrefix resource.", + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get custom IP prefix": { + "$ref": "./examples/CustomIpPrefixGet.json" + } + } + }, + "put": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_CreateOrUpdate", + "description": "Creates or updates a custom IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "customIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the custom IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + }, + "description": "Parameters supplied to the create or update custom IP prefix operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting CustomIpPrefix resource.", + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting CustomIpPrefix resource.", + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create custom IP prefix allocation method": { + "$ref": "./examples/CustomIpPrefixCreateCustomizedValues.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_UpdateTags", + "description": "Updates custom IP prefix tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "customIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the custom IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update custom IP prefix tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting customIpPrefix resource.", + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update public IP address tags": { + "$ref": "./examples/CustomIpPrefixUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/customIpPrefixes": { + "get": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_ListAll", + "description": "Gets all the custom IP prefixes in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of CustomIpPrefix resources.", + "schema": { + "$ref": "#/definitions/CustomIpPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all custom IP prefixes": { + "$ref": "./examples/CustomIpPrefixListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes": { + "get": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_List", + "description": "Gets all custom IP prefixes in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of CustomIpPrefix resources.", + "schema": { + "$ref": "#/definitions/CustomIpPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group Custom IP prefixes": { + "$ref": "./examples/CustomIpPrefixList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "CustomIpPrefixPropertiesFormat": { + "properties": { + "asn": { + "type": "string", + "description": "The ASN for CIDR advertising. Should be an integer as string." + }, + "cidr": { + "type": "string", + "description": "The prefix range in CIDR notation. Should include the start address and the prefix length." + }, + "signedMessage": { + "type": "string", + "description": "Signed message for WAN validation." + }, + "authorizationMessage": { + "type": "string", + "description": "Authorization message for WAN validation." + }, + "customIpPrefixParent": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix." + }, + "childCustomIpPrefixes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of all Children for IPv6 /48 CustomIpPrefix." + }, + "commissionedState": { + "type": "string", + "description": "The commissioned state of the Custom IP Prefix.", + "enum": [ + "Provisioning", + "Provisioned", + "Commissioning", + "CommissionedNoInternetAdvertise", + "Commissioned", + "Decommissioning", + "Deprovisioning", + "Deprovisioned" + ], + "x-ms-enum": { + "name": "CommissionedState", + "modelAsString": true + } + }, + "expressRouteAdvertise": { + "type": "boolean", + "description": "Whether to do express route advertise." + }, + "geo": { + "type": "string", + "description": "The Geo for CIDR advertising. Should be an Geo code.", + "enum": [ + "GLOBAL", + "AFRI", + "APAC", + "EURO", + "LATAM", + "NAM", + "ME", + "OCEANIA", + "AQ" + ], + "x-ms-enum": { + "name": "Geo", + "modelAsString": true + } + }, + "noInternetAdvertise": { + "type": "boolean", + "description": "Whether to Advertise the range to Internet." + }, + "prefixType": { + "type": "string", + "description": "Type of custom IP prefix. Should be Singular, Parent, or Child.", + "enum": [ + "Singular", + "Parent", + "Child" + ], + "x-ms-enum": { + "name": "CustomIpPrefixType", + "modelAsString": true + } + }, + "publicIpPrefixes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of all referenced PublicIpPrefixes." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the custom IP prefix resource." + }, + "failedReason": { + "readOnly": true, + "type": "string", + "description": "The reason why resource is in failed state." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the custom IP prefix resource." + } + }, + "description": "Custom IP prefix properties." + }, + "CustomIpPrefix": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the custom IP prefix." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomIpPrefixPropertiesFormat", + "description": "Custom IP prefix properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Custom IP prefix resource." + }, + "CustomIpPrefixListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomIpPrefix" + }, + "description": "A list of Custom IP prefixes that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListCustomIpPrefixes API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ddosCustomPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ddosCustomPolicy.json new file mode 100644 index 000000000000..4d4fc3512fab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ddosCustomPolicy.json @@ -0,0 +1,310 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}": { + "delete": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_Delete", + "description": "Deletes the specified DDoS custom policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete DDoS custom policy": { + "$ref": "./examples/DdosCustomPolicyDelete.json" + } + } + }, + "get": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_Get", + "description": "Gets information about the specified DDoS custom policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DDoS custom policy": { + "$ref": "./examples/DdosCustomPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_CreateOrUpdate", + "description": "Creates or updates a DDoS custom policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + }, + "description": "Parameters supplied to the create or update operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create DDoS custom policy": { + "$ref": "./examples/DdosCustomPolicyCreate.json" + } + } + }, + "patch": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_UpdateTags", + "description": "Update a DDoS custom policy tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update DDoS custom policy resource tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DDoS Custom policy Update tags": { + "$ref": "./examples/DdosCustomPolicyUpdateTags.json" + } + } + } + } + }, + "definitions": { + "DdosCustomPolicy": { + "description": "A DDoS custom policy in a resource group.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DdosCustomPolicyPropertiesFormat", + "description": "Properties of the DDoS custom policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "DdosCustomPolicyPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the DDoS custom policy resource." + } + }, + "description": "DDoS custom policy properties." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ddosProtectionPlan.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ddosProtectionPlan.json new file mode 100644 index 000000000000..a1f6f2207766 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/ddosProtectionPlan.json @@ -0,0 +1,450 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}": { + "delete": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Delete", + "description": "Deletes the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanDelete.json" + } + } + }, + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Get", + "description": "Gets information about the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanGet.json" + } + } + }, + "put": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_CreateOrUpdate", + "description": "Creates or updates a DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "Parameters supplied to the create or update operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanCreate.json" + } + } + }, + "patch": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_UpdateTags", + "description": "Update a DDoS protection plan tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the update DDoS protection plan resource tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DDoS protection plan Update tags": { + "$ref": "./examples/DdosProtectionPlanUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_List", + "description": "Gets all DDoS protection plans in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all DDoS protection plans": { + "$ref": "./examples/DdosProtectionPlanListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_ListByResourceGroup", + "description": "Gets all the DDoS protection plans in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List DDoS protection plans in resource group": { + "$ref": "./examples/DdosProtectionPlanList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DdosProtectionPlan": { + "description": "A DDoS protection plan in a resource group.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DdosProtectionPlanPropertiesFormat", + "description": "Properties of the DDoS protection plan." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + } + }, + "DdosProtectionPlanPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the DDoS protection plan resource." + }, + "publicIPAddresses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of public IPs associated with the DDoS protection plan resource. This list is read-only." + }, + "virtualNetworks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of virtual networks associated with the DDoS protection plan resource. This list is read-only." + } + }, + "description": "DDoS protection plan properties." + }, + "DdosProtectionPlanListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "A list of DDoS protection plans." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of DDoS protection plans." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/dscpConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/dscpConfiguration.json new file mode 100644 index 000000000000..c81b3c92ad0d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/dscpConfiguration.json @@ -0,0 +1,513 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations/{dscpConfigurationName}": { + "put": { + "tags": [ + "DscpConfiguration" + ], + "operationId": "DscpConfiguration_CreateOrUpdate", + "description": "Creates or updates a DSCP Configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "dscpConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DscpConfiguration" + }, + "description": "Parameters supplied to the create or update dscp configuration operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DscpConfiguration resource.", + "schema": { + "$ref": "#/definitions/DscpConfiguration" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DscpConfiguration resource.", + "schema": { + "$ref": "#/definitions/DscpConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create DSCP Configuration": { + "$ref": "./examples/DscpConfigurationCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "DscpConfiguration" + ], + "operationId": "DscpConfiguration_Delete", + "description": "Deletes a DSCP Configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "dscpConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete DSCP Configuration": { + "$ref": "./examples/DscpConfigurationDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "DscpConfiguration" + ], + "operationId": "DscpConfiguration_Get", + "description": "Gets a DSCP Configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "dscpConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting DSCP Configuration resource.", + "schema": { + "$ref": "#/definitions/DscpConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Dscp Configuration": { + "$ref": "./examples/DscpConfigurationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations": { + "get": { + "tags": [ + "DscpConfigurations" + ], + "operationId": "DscpConfiguration_List", + "description": "Gets a DSCP Configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting DSCP Configuration resource.", + "schema": { + "$ref": "#/definitions/DscpConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Dscp Configuration": { + "$ref": "./examples/DscpConfigurationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dscpConfigurations": { + "get": { + "tags": [ + "DscpConfigurations" + ], + "operationId": "DscpConfiguration_ListAll", + "description": "Gets all dscp configurations in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "#/definitions/DscpConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all network interfaces": { + "$ref": "./examples/DscpConfigurationListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DscpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DscpConfigurationPropertiesFormat", + "description": "Properties of the network interface." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Differentiated Services Code Point configuration for any given network interface" + }, + "DscpConfigurationPropertiesFormat": { + "properties": { + "markings": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "List of markings to be used in the configuration." + }, + "sourceIpRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosIpRange" + }, + "description": "Source IP ranges." + }, + "destinationIpRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosIpRange" + }, + "description": "Destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosPortRange" + }, + "description": "Sources port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosPortRange" + }, + "description": "Destination port ranges." + }, + "protocol": { + "type": "string", + "enum": [ + "DoNotUse", + "Icmp", + "Tcp", + "Udp", + "Gre", + "Esp", + "Ah", + "Vxlan", + "All" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + }, + "description": "RNM supported protocol types." + }, + "qosDefinitionCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/QosDefinition" + }, + "description": "QoS object definitions" + }, + "qosCollectionId": { + "type": "string", + "readOnly": true, + "description": "Qos Collection ID generated by RNM." + }, + "associatedNetworkInterfaces": { + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "readOnly": true, + "description": "Associated Network Interfaces to the DSCP Configuration." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DSCP Configuration resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the DSCP Configuration resource." + } + }, + "description": "Differentiated Services Code Point configuration properties." + }, + "QosDefinition": { + "type": "object", + "properties": { + "markings": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "List of markings to be used in the configuration." + }, + "sourceIpRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosIpRange" + }, + "description": "Source IP ranges." + }, + "destinationIpRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosIpRange" + }, + "description": "Destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosPortRange" + }, + "description": "Sources port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosPortRange" + }, + "description": "Destination port ranges." + }, + "protocol": { + "type": "string", + "enum": [ + "DoNotUse", + "Icmp", + "Tcp", + "Udp", + "Gre", + "Esp", + "Ah", + "Vxlan", + "All" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + }, + "description": "RNM supported protocol types." + } + }, + "description": "Quality of Service defines the traffic configuration between endpoints. Mandatory to have one marking." + }, + "QosIpRange": { + "properties": { + "startIP": { + "type": "string", + "description": "Start IP Address." + }, + "endIP": { + "type": "string", + "description": "End IP Address." + } + }, + "description": "Qos Traffic Profiler IP Range properties." + }, + "QosPortRange": { + "properties": { + "start": { + "type": "integer", + "format": "int32", + "description": "Qos Port Range start." + }, + "end": { + "type": "integer", + "format": "int32", + "description": "Qos Port Range end." + } + }, + "description": "Qos Traffic Profiler Port range properties." + }, + "DscpConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DscpConfiguration" + }, + "description": "A list of dscp configurations in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the DscpConfigurationList API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/endpointService.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/endpointService.json new file mode 100644 index 000000000000..bdb1e3f97024 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/endpointService.json @@ -0,0 +1,119 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices": { + "get": { + "operationId": "AvailableEndpointServices_List", + "description": "List what values of endpoint services are available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location to check available endpoint services." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns list of available endpoint services.", + "schema": { + "$ref": "#/definitions/EndpointServicesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EndpointServicesList": { + "$ref": "./examples/EndpointServicesList.json" + } + } + } + } + }, + "definitions": { + "EndpointServicesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointServiceResult" + }, + "description": "List of available endpoint services in a region." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListAvailableEndpointServices API service call." + }, + "EndpointServiceResult": { + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint service.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the endpoint service.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Endpoint service." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json new file mode 100644 index 000000000000..792e57dd7707 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4" + }, + "responses": { + "200": { + "body": [ + "Accept-Charset" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json new file mode 100644 index 000000000000..4089adeb7bd1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4" + }, + "responses": { + "200": { + "body": [ + "Access-Control-Allow-Origin" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableServerVariablesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableServerVariablesGet.json new file mode 100644 index 000000000000..e8b2f4b7ff16 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableServerVariablesGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4" + }, + "responses": { + "200": { + "body": [ + "request_query" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsGet.json new file mode 100644 index 000000000000..de84ed7a2cd6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsGet.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default", + "type": "Microsoft.Network/ApplicationGatewayAvailableSslOptions", + "properties": { + "predefinedPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20150501" + }, + { + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401" + }, + { + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401S" + } + ], + "defaultPolicy": "AppGwSslPolicy20150501", + "availableCipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" + ], + "availableProtocols": [ + "TLSv1_0", + "TLSv1_1", + "TLSv1_2" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json new file mode 100644 index 000000000000..b829f92115aa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AppGwSslPolicy20150501", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20150501", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_0" + } + }, + { + "name": "AppGwSslPolicy20170401", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_1" + } + }, + { + "name": "AppGwSslPolicy20170401S", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401S", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_2" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json new file mode 100644 index 000000000000..d6531414cf4d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "predefinedPolicyName": "AppGwSslPolicy20150501" + }, + "responses": { + "200": { + "body": { + "name": "AppGwSslPolicy20150501", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20150501", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_0" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json new file mode 100644 index 000000000000..d1ab37ee122b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "OWASP_3.0", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets/", + "type": "Microsoft.Network/applicationGatewayAvailableWafRuleSets", + "properties": { + "provisioningState": "Succeeded", + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0", + "ruleGroups": [ + { + "ruleGroupName": "General", + "description": "", + "rules": [ + { + "ruleId": 200004, + "ruleIdString": "200004", + "description": "Possible Multipart Unmatched Boundary." + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayBackendHealthGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayBackendHealthGet.json new file mode 100644 index 000000000000..e5ab9e7e7c2c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayBackendHealthGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "appgw", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "backendAddressPools": [ + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.8", + "health": "Up" + } + ] + } + ] + }, + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + ] + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayBackendHealthTest.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayBackendHealthTest.json new file mode 100644 index 000000000000..8e943e2ece01 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayBackendHealthTest.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "probeRequest": { + "protocol": "Http", + "pickHostNameFromBackendHttpSettings": true, + "path": "/", + "timeout": 30, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + } + } + }, + "responses": { + "200": { + "body": { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHealthHttpSettings": { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayCreate.json new file mode 100644 index 000000000000..be43c4e70958 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayCreate.json @@ -0,0 +1,778 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "eastus", + "properties": { + "sku": { + "name": "Standard_v2", + "tier": "Standard_v2", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "****", + "password": "****" + } + }, + { + "name": "sslcert2", + "properties": { + "keyVaultSecretId": "https://kv/secret" + } + } + ], + "trustedRootCertificates": [ + { + "name": "rootcert", + "properties": { + "data": "****" + } + }, + { + "name": "rootcert1", + "properties": { + "keyVaultSecretId": "https://kv/secret" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "properties": { + "data": "****" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + }, + { + "name": "appgwfp80", + "properties": { + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.0.1" + }, + { + "ipAddress": "10.0.0.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "properties": { + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "properties": { + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_add_x_forwarded_for_proxy}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc" + } + } + } + ] + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.0.0.1" + }, + { + "ipAddress": "10.0.0.2" + } + ] + } + } + ], + "loadDistributionPolicies": [], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true, + "verifyClientRevocation": "OCSP" + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "listeners": [], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "reroute": true + } + } + } + ] + } + } + ], + "routingRules": [], + "probes": [], + "redirectConfigurations": [], + "privateEndpointConnections": [], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + }, + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.0.0.1" + }, + { + "ipAddress": "10.0.0.2" + } + ] + } + } + ], + "loadDistributionPolicies": [], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "listeners": [], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b" + } + } + } + ] + } + } + ], + "routingRules": [], + "probes": [], + "redirectConfigurations": [], + "privateEndpointConnections": [], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayDelete.json new file mode 100644 index 000000000000..e3328d527226 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayGet.json new file mode 100644 index 000000000000..bb235ed777d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayGet.json @@ -0,0 +1,389 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****", + "validatedCertData": "****", + "clientCertIssuerDN": "CN=User1, OU=Eng, O=Company Ltd, L=D4, S=Arizona, C=US" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + "10.0.0.1", + "10.0.0.2" + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true, + "verifyClientRevocation": "OCSP" + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "defaultLoadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "priority": 20, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b", + "reroute": false + } + } + } + ] + } + } + ], + "probes": [], + "privateLinkConfigurations": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "natNicIpconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "primary": true, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + }, + { + "name": "natNicIpconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ] + } + } + ], + "privateEndpointConnections": [], + "loadDistributionPolicies": [ + { + "name": "ldp1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1", + "properties": { + "loadDistributionAlgorithm": "RoundRobin", + "loadDistributionTargets": [ + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 40, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + } + } + }, + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 60, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1" + } + } + } + ] + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayList.json new file mode 100644 index 000000000000..e95b0fc50161 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayList.json @@ -0,0 +1,392 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****", + "validatedCertData": "****", + "clientCertIssuerDN": "CN=User1, OU=Eng, O=Company Ltd, L=D4, S=Arizona, C=US" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + "10.0.0.1", + "10.0.0.2" + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true, + "verifyClientRevocation": "OCSP" + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "defaultLoadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "priority": 20, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b", + "reroute": false + } + } + } + ] + } + } + ], + "probes": [], + "privateLinkConfigurations": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "natNicIpconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "primary": true, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + }, + { + "name": "natNicIpconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ] + } + } + ], + "privateEndpointConnections": [], + "loadDistributionPolicies": [ + { + "name": "ldp1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1", + "properties": { + "loadDistributionAlgorithm": "RoundRobin", + "loadDistributionTargets": [ + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 40, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + } + } + }, + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 60, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1" + } + } + } + ] + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayListAll.json new file mode 100644 index 000000000000..2246b4639a7a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayListAll.json @@ -0,0 +1,391 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****", + "validatedCertData": "****", + "clientCertIssuerDN": "CN=User1, OU=Eng, O=Company Ltd, L=D4, S=Arizona, C=US" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + "10.0.0.1", + "10.0.0.2" + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true, + "verifyClientRevocation": "OCSP" + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "defaultLoadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "priority": 20, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b", + "reroute": false + } + } + } + ] + } + } + ], + "probes": [], + "privateLinkConfigurations": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "natNicIpconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "primary": true, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + }, + { + "name": "natNicIpconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ] + } + } + ], + "privateEndpointConnections": [], + "loadDistributionPolicies": [ + { + "name": "ldp1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1", + "properties": { + "loadDistributionAlgorithm": "RoundRobin", + "loadDistributionTargets": [ + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 40, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + } + } + }, + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 60, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1" + } + } + } + ] + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..f8327a8795e6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "connectionName": "connection1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..19d88ac03ab0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "connectionName": "connection1" + }, + "responses": { + "200": { + "body": { + "name": "coonection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/connection1", + "type": "Microsoft.Network/applicationGateways/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approval Done" + }, + "linkIdentifier": "805319460" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json new file mode 100644 index 000000000000..9a0b166e2d27 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "coonection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/connection1", + "type": "Microsoft.Network/applicationGateways/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approval Done" + }, + "linkIdentifier": "805319460" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..5846bb4237fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "connectionName": "connection1", + "parameters": { + "name": "connection1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPlePeConnection", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + }, + "linkIdentifier": "linkId" + } + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateLinkResourceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateLinkResourceList.json new file mode 100644 index 000000000000..c233de9f66e1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayPrivateLinkResourceList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/privateLink1", + "type": "Microsoft.Network/applicationGateways/privateLinkResources", + "properties": { + "groupId": "privateLink1", + "requiredMembers": [ + "privateLink1" + ], + "requiredZoneNames": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayStart.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayStart.json new file mode 100644 index 000000000000..3a456e241538 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayStop.json new file mode 100644 index 000000000000..3a456e241538 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayUpdateTags.json new file mode 100644 index 000000000000..66fd7a13076c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationGatewayUpdateTags.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "AppGw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "AppGw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw", + "type": "Microsoft.Network/applicationGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "sku": { + "name": "Standard_Small", + "tier": "Standard", + "capacity": 2 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "GatewayIp01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/gatewayIPConfigurations/GatewayIp01", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1" + } + } + } + ], + "sslCertificates": [], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "FrontEndConfig01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicIp1" + } + } + } + ], + "frontendPorts": [ + { + "name": "FrontEndPort01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "Pool01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.10.10.1" + }, + { + "ipAddress": "10.10.10.2" + }, + { + "ipAddress": "10.10.10.3" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "PoolSetting01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "pickHostNameFromBackendAddress": false, + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "listener1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01" + }, + "protocol": "Http", + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "Rule01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/requestRoutingRules/Rule01", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01" + } + } + } + ], + "probes": [], + "redirectConfigurations": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupCreate.json new file mode 100644 index 000000000000..98c3914236f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupCreate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg", + "parameters": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupDelete.json new file mode 100644 index 000000000000..5372605bd6d2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupGet.json new file mode 100644 index 000000000000..d9bb99e3bd0a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupList.json new file mode 100644 index 000000000000..ce321ac6a49b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupListAll.json new file mode 100644 index 000000000000..138e699ef1b2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupUpdateTags.json new file mode 100644 index 000000000000..9154a9e8b4ef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ApplicationSecurityGroupUpdateTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AutoApprovedPrivateLinkServicesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AutoApprovedPrivateLinkServicesGet.json new file mode 100644 index 000000000000..8aa16a3f17a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AutoApprovedPrivateLinkServicesGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "regionName", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls3" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json new file mode 100644 index 000000000000..81c20c9a20ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "regionName", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls3" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsResourceGroupGet.json new file mode 100644 index 000000000000..44d179838def --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsResourceGroupGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "westcentralus", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsSubscriptionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsSubscriptionGet.json new file mode 100644 index 000000000000..4713fa5cf33b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsSubscriptionGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "westcentralus", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailablePrivateEndpointTypesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailablePrivateEndpointTypesGet.json new file mode 100644 index 000000000000..87394c07c7f8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailablePrivateEndpointTypesGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "regionName", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/providers/Microsoft.Network/availablePrivateEndpointTypes/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availablePrivateEndpointTypes", + "resourceName": "Microsoft.Provider/resourceType" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json new file mode 100644 index 000000000000..2e573bd9aaca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "regionName", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availablePrivateEndpointTypes/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availablePrivateEndpointTypes", + "resourceName": "Microsoft.Provider/resourceType" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableServiceAliasesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableServiceAliasesList.json new file mode 100644 index 000000000000..5903346535bd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableServiceAliasesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "westcentralus", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "servicesAzure", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzure", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure" + }, + { + "name": "servicesAzureManagedInstance", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzureManagedInstance", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure/ManagedInstance" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableServiceAliasesListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableServiceAliasesListByResourceGroup.json new file mode 100644 index 000000000000..67552f7d5e85 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableServiceAliasesListByResourceGroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "westcentralus", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "servicesAzure", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzure", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure" + }, + { + "name": "servicesAzureManagedInstance", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzureManagedInstance", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure/ManagedInstance" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallDelete.json new file mode 100644 index 000000000000..9de43b9b0bf3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallFqdnTagsListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallFqdnTagsListBySubscription.json new file mode 100644 index 000000000000..c0f13686735a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallFqdnTagsListBySubscription.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "azfwfqdntag", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewallFqdnTags/azfwfqdntag", + "type": "Microsoft.Network/azureFirewallFqdnTags", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "fqdnTagName": "azfwfqdntag" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGet.json new file mode 100644 index 000000000000..8c529e33026d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGet.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithAdditionalProperties.json new file mode 100644 index 000000000000..0f3257d60b0e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithIpGroups.json new file mode 100644 index 000000000000..4174aaf21933 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithIpGroups.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups3" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [ + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "changeNumber": "5" + }, + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2", + "changeNumber": "4" + }, + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups3", + "changeNumber": "1" + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithMgmtSubnet.json new file mode 100644 index 000000000000..66df33280b6c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithZones.json new file mode 100644 index 000000000000..531e8492eb8f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallGetWithZones.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US 2", + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListByResourceGroup.json new file mode 100644 index 000000000000..8fc8dfd9e599 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListByResourceGroup.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListBySubscription.json new file mode 100644 index 000000000000..10daf931b69c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListBySubscription.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListLearnedIPPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListLearnedIPPrefixes.json new file mode 100644 index 000000000000..36fe9aec1138 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallListLearnedIPPrefixes.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azureFirewall1" + }, + "responses": { + "202": {}, + "200": { + "body": { + "ipPrefixes": [ + "10.101.0.0/16", + "10.102.0.0/16" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPacketCapture.json new file mode 100644 index 000000000000..c9b956952b9b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPacketCapture.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azureFirewall1", + "parameters": { + "properties": { + "durationInSeconds": 300, + "numberOfPacketsToCapture": 5000, + "sasUrl": "someSASURL", + "fileName": "azureFirewallPacketCapture", + "protocol": "Any", + "flags": [ + { + "type": "syn" + }, + { + "type": "fin" + } + ], + "filters": [ + { + "sources": [ + "20.1.1.0" + ], + "destinations": [ + "20.1.2.0" + ], + "destinationPorts": [ + "4500" + ] + }, + { + "sources": [ + "10.1.1.0", + "10.1.1.1" + ], + "destinations": [ + "10.1.2.0" + ], + "destinationPorts": [ + "123", + "80" + ] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPut.json new file mode 100644 index 000000000000..537c44d73f86 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPut.json @@ -0,0 +1,497 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutInHub.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutInHub.json new file mode 100644 index 000000000000..4594c2e39f5b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutInHub.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_Hub", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "firewallPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1" + }, + "hubIPAddresses": { + "publicIPs": { + "addresses": [], + "count": 1 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_Hub", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "firewallPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1" + }, + "hubIPAddresses": { + "publicIPs": { + "addresses": [ + { + "address": "13.73.240.12" + } + ], + "count": 1 + }, + "privateIPAddress": "10.0.0.0" + }, + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_Hub", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "firewallPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1" + }, + "hubIPAddresses": { + "publicIPs": { + "addresses": [ + { + "address": "13.73.240.12" + } + ], + "count": 1 + }, + "privateIPAddress": "10.0.0.0" + }, + "ipGroups": [], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithAdditionalProperties.json new file mode 100644 index 000000000000..905351cf3ccb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -0,0 +1,507 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithIpGroups.json new file mode 100644 index 000000000000..01385ce0f9b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithIpGroups.json @@ -0,0 +1,505 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [ + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "changeNumber": "5" + }, + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2", + "changeNumber": "4" + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithMgmtSubnet.json new file mode 100644 index 000000000000..b0bba862b837 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -0,0 +1,507 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithZones.json new file mode 100644 index 000000000000..581ab399ea78 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPutWithZones.json @@ -0,0 +1,509 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "location": "West US 2", + "tags": { + "key1": "value1" + }, + "zones": [ + "1", + "2", + "3" + ], + "properties": { + "threatIntelMode": "Alert", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US 2", + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US 2", + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallUpdateTags.json new file mode 100644 index 000000000000..6954c64f3c5a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallUpdateTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "azfwtest", + "azureFirewallName": "fw1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "fw1", + "id": "/subscriptions/subid/resourceGroups/azfwtest/providers/Microsoft.Network/azureFirewalls/fw1", + "type": "Microsoft.Network/azureFirewalls", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureWebCategoriesListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureWebCategoriesListBySubscription.json new file mode 100644 index 000000000000..56c8b5ceaab4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureWebCategoriesListBySubscription.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "4de8428a-4a92-4cea-90ff-b47128b8cab8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Arts", + "id": "/subscriptions/4de8428a-4a92-4cea-90ff-b47128b8cab8/providers/Microsoft.Network/azureWebCategories/Arts", + "type": "Microsoft.Network/azureWebCategories", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "group": "General" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureWebCategoryGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureWebCategoryGet.json new file mode 100644 index 000000000000..c3c81e516c66 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureWebCategoryGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "4de8428a-4a92-4cea-90ff-b47128b8cab8", + "name": "Arts" + }, + "responses": { + "200": { + "body": { + "name": "Arts", + "id": "/subscriptions/4de8428a-4a92-4cea-90ff-b47128b8cab8/providers/Microsoft.Network/azureWebCategories/Arts", + "type": "Microsoft.Network/azureWebCategories", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "group": "General" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDelete.json new file mode 100644 index 000000000000..7c2ef63df08b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperDelete.json new file mode 100644 index 000000000000..807fe84d7718 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg2", + "bastionHostName": "bastionhostdeveloper" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperGet.json new file mode 100644 index 000000000000..982c1eaf117f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhostdeveloper'" + }, + "responses": { + "200": { + "body": { + "name": "bastionhostdeveloper'", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Developer" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "dnsName": "omnibrain.uswest.bastionglobal.azure.com", + "ipConfigurations": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperPut.json new file mode 100644 index 000000000000..902a852059af --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostDeveloperPut.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg2", + "bastionHostName": "bastionhostdeveloper", + "sku": { + "name": "Developer" + }, + "parameters": { + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "ipConfigurations": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "bastionhostdeveloper", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Developer" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "omnibrain.uswest.bastionglobal.azure.com", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "ipConfigurations": [] + } + } + }, + "201": { + "body": { + "name": "bastionhostdeveloper'", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Developer" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "omnibrain.uswest.bastionglobal.azure.com", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "ipConfigurations": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostGet.json new file mode 100644 index 000000000000..9b01a15f8d4e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant'" + }, + "responses": { + "200": { + "body": { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "sku": { + "name": "Standard" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostGetWithZones.json new file mode 100644 index 000000000000..018f4237dfa8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostGetWithZones.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant'" + }, + "responses": { + "200": { + "body": { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "sku": { + "name": "Standard" + }, + "zones": [ + "1", + "2" + ], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostListByResourceGroup.json new file mode 100644 index 000000000000..a135be124490 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostListByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AzureBastionSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + }, + { + "name": "bastionhost2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost2", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Premium" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": true, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost2/bastionHostIpConfigurations/IpConf", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureBastionSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName2" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostListBySubscription.json new file mode 100644 index 000000000000..2748884ce5b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostListBySubscription.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AzureBastionSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + }, + { + "name": "bastionhostdeveloper", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Developer" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "dnsName": "omnibrain.uswest.bastionglobal.azure.com", + "ipConfigurations": [] + } + }, + { + "name": "bastionhost3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost3", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Premium" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": true, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost3/bastionHostIpConfigurations/IpConf", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet3/subnets/AzureBastionSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName3" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPatch.json new file mode 100644 index 000000000000..ad6feeb607c6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPatch.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "200": { + "body": { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + }, + "sku": { + "name": "Standard" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPut.json new file mode 100644 index 000000000000..65e08e9e747b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPut.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "sku": { + "name": "Standard" + }, + "zones": [], + "parameters": { + "properties": { + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "bastionhost", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPutWithZones.json new file mode 100644 index 000000000000..6b04ef5a47a7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionHostPutWithZones.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "sku": { + "name": "Standard" + }, + "zones": [ + "1", + "2" + ], + "parameters": { + "properties": { + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "bastionhost", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionSessionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionSessionDelete.json new file mode 100644 index 000000000000..99a8a0acc625 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionSessionDelete.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "sessionIds": [ + "session1", + "session2", + "session3" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sessionId": "session1", + "message": "session session1 invalidated!", + "state": "Disconnected" + }, + { + "sessionId": "session2", + "message": "session session2 could not be disconnected!", + "state": "Failed" + }, + { + "sessionId": "session3", + "message": "session session3 not found!", + "state": "NotFound" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionSessionsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionSessionsList.json new file mode 100644 index 000000000000..25c853dafab9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionSessionsList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sessionId": "sessionId", + "startTime": "2019-1-1T12:00:00.0000Z", + "targetSubscriptionId": "subid", + "resourceType": "VM", + "targetHostName": "vm01", + "targetResourceGroup": "rg1", + "userName": "user", + "targetIpAddress": "1.1.1.1", + "protocol": "SSH", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm01", + "sessionDurationInMins": 0.0 + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getActiveSessions/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkCreate.json new file mode 100644 index 000000000000..17f5741bbe9d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkCreate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslRequest": { + "vms": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm1", + "createdAt": "2019-10-18T12:00:00.0000Z" + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm2", + "createdAt": "2019-10-17T12:00:00.0000Z" + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkDelete.json new file mode 100644 index 000000000000..d018d07e301c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkDelete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslRequest": { + "vms": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + } + } + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkDeleteByToken.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkDeleteByToken.json new file mode 100644 index 000000000000..2270d5c7103a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkDeleteByToken.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslTokenRequest": { + "tokens": [ + "abcd1234-efgh-hijk-5678-abcdefgh1234", + "dcba4321-hgfe-kjih-8765-hgfedcba4321" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkGet.json new file mode 100644 index 000000000000..505d8edf7b1e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/BastionShareableLinkGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslRequest": { + "vms": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm1", + "createdAt": "2019-10-18T12:00:00.0000Z" + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm2", + "createdAt": "2019-10-17T12:00:00.0000Z" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckDnsNameAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckDnsNameAvailability.json new file mode 100644 index 000000000000..62658a78e118 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckDnsNameAvailability.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "location": "westus", + "domainNameLabel": "testdns" + }, + "responses": { + "200": { + "body": { + "available": false + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckPrivateLinkServiceVisibility.json new file mode 100644 index 000000000000..da5fcdd759d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckPrivateLinkServiceVisibility.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "location": "westus", + "parameters": { + "privateLinkServiceAlias": "mypls.00000000-0000-0000-0000-000000000000.azure.privatelinkservice" + } + }, + "responses": { + "200": { + "body": { + "visible": true + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json new file mode 100644 index 000000000000..71984e816166 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "location": "westus", + "resourceGroupName": "rg1", + "parameters": { + "privateLinkServiceAlias": "mypls.00000000-0000-0000-0000-000000000000.azure.privatelinkservice" + } + }, + "responses": { + "200": { + "body": { + "visible": true + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceNetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceNetworkInterfaceGet.json new file mode 100644 index 000000000000..17acc67c1f47 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceNetworkInterfaceGet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1", + "cloudServiceName": "cs1", + "roleInstanceName": "TestVMRole_IN_0" + }, + "responses": { + "200": { + "body": { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "dns.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceNetworkInterfaceList.json new file mode 100644 index 000000000000..cf879e8db4d2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceNetworkInterfaceList.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cloudServiceName": "cs1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true + } + }, + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServicePublicIpGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServicePublicIpGet.json new file mode 100644 index 000000000000..76f3efb0768e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServicePublicIpGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "cloudServiceName": "cs1", + "resourceGroupName": "cs-tester", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "roleInstanceName": "Test_VM_0", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1", + "publicIpAddressName": "pub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServicePublicIpListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServicePublicIpListAll.json new file mode 100644 index 000000000000..669198a5fa59 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServicePublicIpListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "cloudServiceName": "cs1", + "resourceGroupName": "cs-tester", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_3/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_3/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm3.testvmssacc", + "fqdn": "vm3.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.118.216", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceRoleInstanceNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceRoleInstanceNetworkInterfaceList.json new file mode 100644 index 000000000000..6d094a16a9ab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceRoleInstanceNetworkInterfaceList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cloudServiceName": "cs1", + "roleInstanceName": "TestVMRole_IN_0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceRoleInstancePublicIpList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceRoleInstancePublicIpList.json new file mode 100644 index 000000000000..9da0bc6f83d2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceRoleInstancePublicIpList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "cloudServiceName": "cs1", + "resourceGroupName": "cs-tester", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "roleInstanceName": "Test_VM_0", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapGet.json new file mode 100644 index 000000000000..40b4a05669f1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "groupName": "rg1", + "resourceName": "testCloudService", + "singletonResource": "swap" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/testCloudService/providers/Microsoft.Network/cloudServiceSlots/swap", + "name": "swap", + "type": "Microsoft.Network/cloudServiceSlots", + "properties": { + "slotType": "Staging" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapList.json new file mode 100644 index 000000000000..155aaeb160fc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "groupName": "rg1", + "resourceName": "testCloudService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/testCloudService/providers/Microsoft.Network/cloudServiceSlots/swap", + "name": "swap", + "type": "Microsoft.Network/cloudServiceSlots", + "properties": { + "slotType": "Staging" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapPut.json new file mode 100644 index 000000000000..61067c0b0190 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CloudServiceSwapPut.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "groupName": "rg1", + "resourceName": "testCloudService", + "singletonResource": "swap", + "parameters": { + "properties": { + "slotType": "Production" + } + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupDelete.json new file mode 100644 index 000000000000..aeeacf5b3755 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "configurationPolicyGroupName": "policyGroup1", + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupGet.json new file mode 100644 index 000000000000..c5d243d8584b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "configurationPolicyGroupName": "policyGroup1", + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnServerConfigurations/configurationPolicyGroups", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json new file mode 100644 index 000000000000..7ad204ab3a89 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnServerConfigurations/configurationPolicyGroups", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupPut.json new file mode 100644 index 000000000000..8874e01eb1e0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ConfigurationPolicyGroupPut.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "configurationPolicyGroupName": "policyGroup1", + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VpnServerConfigurationPolicyGroupParameters": { + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + } + }, + "201": { + "body": { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixCreateCustomizedValues.json new file mode 100644 index 000000000000..c85c32a562a5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixCreateCustomizedValues.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "customIpPrefixName": "test-customipprefix", + "zones": [ + "1" + ], + "parameters": { + "location": "westus", + "properties": { + "cidr": "0.0.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "192.168.254.2/24", + "commissionedState": "Provisioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + }, + "201": { + "body": { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "192.168.254.2/24", + "commissionedState": "Provisioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixDelete.json new file mode 100644 index 000000000000..adecbb57dacf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "customIpPrefixName": "test-customipprefix" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixGet.json new file mode 100644 index 000000000000..22c051ae26cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "customIpPrefixName": "test-customipprefix" + }, + "responses": { + "200": { + "body": { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.0.0/24", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixList.json new file mode 100644 index 000000000000..2383dc262455 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixList.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.0.0/24", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix2", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.1.0/30", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix4", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix4", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "2607:f0d1:1002:0001::/64", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [], + "customIpPrefixParent": { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix5" + } + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix5", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix5", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "2607:f0d1:1002::/48", + "commissionedState": "Provisioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix4" + } + ] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixListAll.json new file mode 100644 index 000000000000..b7fffd660a5c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixListAll.json @@ -0,0 +1,264 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.0.0/24", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/customIpPrefixes/test-customipprefix2", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.2.0/23", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix3", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix3", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.4.0/22", + "commissionedState": "Provisioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix4", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix4", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "2607:f0d1:1002:0001::/64", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [], + "customIpPrefixParent": { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix5" + } + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix5", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix5", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "2607:f0d1:1002::/48", + "commissionedState": "Provisioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix4" + } + ] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix6", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Failed", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.5.0/22", + "commissionedState": "ProvisionFailed", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "CustomerSignatureNotVerified", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix7", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.6.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "asn": "11", + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "geo": "GLOBAL", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "expressRouteAdvertise": true, + "noInternetAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "expressRouteAdvertise": true, + "noInternetAdvertise": false, + "failedReason": "", + "prefixType": "Parent", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixUpdateTags.json new file mode 100644 index 000000000000..9abda083671e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/CustomIpPrefixUpdateTags.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "customIpPrefixName": "test-customipprefix", + "zones": [ + "1" + ], + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "192.168.254.2/24", + "commissionedState": "Provisioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/customIpPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyCreate.json new file mode 100644 index 000000000000..fd244baa19af --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyCreate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy", + "parameters": { + "location": "centraluseuap" + } + }, + "responses": { + "200": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyDelete.json new file mode 100644 index 000000000000..09e8195945ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy", + "parameters": { + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/locations/tempLocation/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyGet.json new file mode 100644 index 000000000000..e244a3f20fcc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy" + }, + "responses": { + "200": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyUpdateTags.json new file mode 100644 index 000000000000..b05df9b4f862 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosCustomPolicyUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanCreate.json new file mode 100644 index 000000000000..3ccf32db0ba2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanCreate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan", + "parameters": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [], + "virtualNetworks": [] + } + } + }, + "201": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [], + "virtualNetworks": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanDelete.json new file mode 100644 index 000000000000..c68c614070d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/locations/tempLocation/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanGet.json new file mode 100644 index 000000000000..86c0de735fa3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanList.json new file mode 100644 index 000000000000..3f3bbd2d02fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanListAll.json new file mode 100644 index 000000000000..3ab25016b8a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanListAll.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet1" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip3" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanUpdateTags.json new file mode 100644 index 000000000000..a3d4b41075c5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DdosProtectionPlanUpdateTags.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [], + "virtualNetworks": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DefaultSecurityRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DefaultSecurityRuleGet.json new file mode 100644 index 000000000000..f1c075977610 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DefaultSecurityRuleGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1", + "defaultSecurityRuleName": "AllowVnetInBound" + }, + "responses": { + "200": { + "body": { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DefaultSecurityRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DefaultSecurityRuleList.json new file mode 100644 index 000000000000..1cccfb1eb1ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DefaultSecurityRuleList.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationCreate.json new file mode 100644 index 000000000000..47b547108f02 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationCreate.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "dscpConfigurationName": "mydscpconfig", + "parameters": { + "properties": { + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 10, + "end": 11 + }, + { + "start": 20, + "end": 21 + } + ], + "destinationPortRanges": [ + { + "start": 15, + "end": 15 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ], + "associatedNetworkInterfaces": [], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e" + }, + "type": "Microsoft.Network/dscpConfiguration" + } + }, + "201": { + "body": { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ], + "associatedNetworkInterfaces": [], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e" + }, + "type": "Microsoft.Network/dscpConfiguration" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationDelete.json new file mode 100644 index 000000000000..b46bd2f60cc1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "dscpConfigurationName": "mydscpConfig" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationGet.json new file mode 100644 index 000000000000..430404049929 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationGet.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "dscpConfigurationName": "mydscpConfig" + }, + "responses": { + "200": { + "body": { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2" + ], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationList.json new file mode 100644 index 000000000000..4101dcf8283c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationList.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2" + ], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + }, + { + "name": "mydscpConfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic4" + ], + "qosCollectionId": "9as24mf6-d9cb-7a7f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationListAll.json new file mode 100644 index 000000000000..0644cda9a567 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/DscpConfigurationListAll.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2" + ], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + }, + { + "name": "mydscpConfig2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/dscpConfiguration/mydscpConfig2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/test-nic3", + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/test-nic4" + ], + "qosCollectionId": "9as24mf6-d9cb-7a7f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForConnection.json new file mode 100644 index 000000000000..e8635e2638e5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForConnection.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2024-01-01", + "effectiveRoutesParameters": { + "resourceId": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "virtualWanResourceType": "ExpressRouteConnection" + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "properties": { + "output": { + "value": [ + { + "addressPrefixes": [ + "10.147.128.0/17" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0" + ], + "nextHopType": "Remote Hub", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0", + "asPath": "65520-65520" + }, + { + "addressPrefixes": [ + "10.0.0.0/16" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1" + ], + "nextHopType": "ExpressRouteGateway", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1", + "asPath": "12076-12076" + } + ] + } + } + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForRouteTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForRouteTable.json new file mode 100644 index 000000000000..93bd177662b0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForRouteTable.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2024-01-01", + "effectiveRoutesParameters": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "virtualWanResourceType": "RouteTable" + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "properties": { + "output": { + "value": [ + { + "addressPrefixes": [ + "10.147.128.0/17" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0" + ], + "nextHopType": "Remote Hub", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0", + "asPath": "65520-65520" + }, + { + "addressPrefixes": [ + "10.0.0.0/16" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1" + ], + "nextHopType": "ExpressRouteGateway", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1", + "asPath": "12076-12076" + } + ] + } + } + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForVirtualHub.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForVirtualHub.json new file mode 100644 index 000000000000..9c0ea656c891 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EffectiveRoutesListForVirtualHub.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2024-01-01", + "effectiveRoutesParameters": null + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "properties": { + "output": { + "value": [ + { + "addressPrefixes": [ + "10.147.128.0/17" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0" + ], + "nextHopType": "Remote Hub", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0", + "asPath": "65520-65520" + }, + { + "addressPrefixes": [ + "10.0.0.0/16" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1" + ], + "nextHopType": "ExpressRouteGateway", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1", + "asPath": "12076-12076" + } + ] + } + } + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EndpointServicesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EndpointServicesList.json new file mode 100644 index 000000000000..3f3e11914253 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/EndpointServicesList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.Sql", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.AzureActiveDirectory", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitARPTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitARPTableList.json new file mode 100644 index 000000000000..a88e086ec673 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitARPTableList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "IPAddress", + "macAddress": "macAddress" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationCreate.json new file mode 100644 index 000000000000..da9d9686e630 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "authorizationName": "authorizatinName", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "authorizationParameters": { + "properties": {} + } + }, + "responses": { + "201": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available" + } + } + }, + "200": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationDelete.json new file mode 100644 index 000000000000..cff0a5d15024 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationGet.json new file mode 100644 index 000000000000..3a61bcc3893b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": { + "body": { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + }, + "type": "Microsoft.Network/expressRouteCircuits/authorizations" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationList.json new file mode 100644 index 000000000000..d597cd4c7ea2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitAuthorizationList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionCreate.json new file mode 100644 index 000000000000..48406964a443 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionCreate.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "type": "Microsoft.Network/expressRouteCircuits/peerings/connections", + "expressRouteCircuitConnectionParameters": { + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/29", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::/125" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionDelete.json new file mode 100644 index 000000000000..458019c08d64 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionGet.json new file mode 100644 index 000000000000..4b70d797e82a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + }, + "type": "Microsoft.Network/expressRouteCircuits/peerings/connections" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionList.json new file mode 100644 index 000000000000..c1d1896b0889 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitConnectionList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + } + }, + { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSEUR", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSEUR", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharckteurope/providers/Microsoft.Network/expressRouteCircuits/dedharcktams/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitCreate.json new file mode 100644 index 000000000000..bba440fe286c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitCreate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "parameters": { + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + }, + "properties": { + "authorizations": [], + "peerings": [], + "allowClassicOperations": false, + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 200 + } + }, + "location": "Brazil South" + } + }, + "responses": { + "201": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "Brazil South", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + }, + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "Brazil South", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json new file mode 100644 index 000000000000..25966790b747 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "type": "Microsoft.Network/expressRouteCircuits", + "circuitName": "expressRouteCircuit1", + "parameters": { + "location": "westus", + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + }, + "properties": { + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName" + }, + "enableDirectPortRateLimit": false, + "authorizationKey": "b0be57f5-1fba-463b-adec-ffe767354cdd", + "bandwidthInGbps": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName" + }, + "enableDirectPortRateLimit": false, + "authorizationKey": "b0be57f5-1fba-463b-adec-ffe767354cdd", + "authorizationStatus": "Enabled", + "bandwidthInGbps": 10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + }, + "201": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName" + }, + "enableDirectPortRateLimit": false, + "authorizationKey": "b0be57f5-1fba-463b-adec-ffe767354cdd", + "authorizationStatus": "Enabled", + "bandwidthInGbps": 10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitDelete.json new file mode 100644 index 000000000000..70e6bb20ad18 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitGet.json new file mode 100644 index 000000000000..6144d95d8108 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitListByResourceGroup.json new file mode 100644 index 000000000000..6bc956b530f9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitListByResourceGroup.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitListBySubscription.json new file mode 100644 index 000000000000..4881569fe9cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitListBySubscription.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringCreate.json new file mode 100644 index 000000000000..d84a7a215912 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200 + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName" + } + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringDelete.json new file mode 100644 index 000000000000..0b872322c675 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringGet.json new file mode 100644 index 000000000000..7a9172c887b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "peeringName": "MicrosoftPeering" + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + }, + "routeFilter": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName" + } + }, + "type": "Microsoft.Network/expressRouteCircuits/peerings" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringList.json new file mode 100644 index 000000000000..17f84cfb397a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringList.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + }, + "expressRouteConnection": "" + } + }, + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "10.0.0.0/30", + "secondaryPeerAddressPrefix": "10.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringStats.json new file mode 100644 index 000000000000..27d9099dc967 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitPeeringStats.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": { + "body": { + "primarybytesIn": 537408, + "primarybytesOut": 44032550, + "secondarybytesIn": 0, + "secondarybytesOut": 39002500 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitRouteTableList.json new file mode 100644 index 000000000000..d1a95fc3e9c6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitRouteTableList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "network": "", + "nextHop": "", + "locPrf": "", + "weight": 0, + "path": "" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitRouteTableSummaryList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitRouteTableSummaryList.json new file mode 100644 index 000000000000..90e317c7b536 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitRouteTableSummaryList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "neighbor": "100.65.171.1", + "v": 4, + "as": 9583, + "upDown": "never", + "statePfxRcd": "Idle" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitStats.json new file mode 100644 index 000000000000..784b7af62965 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitStats.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primarybytesIn": 537408, + "primarybytesOut": 44032550, + "secondarybytesIn": 0, + "secondarybytesOut": 39002500 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitUpdateTags.json new file mode 100644 index 000000000000..07f5cffe023c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCircuitUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "ertest", + "circuitName": "er1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 1000 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "0b392c2e-1e9d-46d7-b5e0-9ce90ca6b60c", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionCreate.json new file mode 100644 index 000000000000..aba45479f8a6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionCreate.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "expressRouteGatewayName": "gateway-2", + "resourceGroupName": "resourceGroupName", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "connectionName": "connectionName", + "putExpressRouteConnectionParameters": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName", + "name": "connectionName", + "properties": { + "routingWeight": 2, + "authorizationKey": "authorizationKey", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 2, + "enableInternetSecurity": false, + "expressRouteGatewayBypass": false, + "enablePrivateLinkFastPath": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + }, + "201": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 2, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionDelete.json new file mode 100644 index 000000000000..46af71fbacf5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "connectionName": "connectionName", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionGet.json new file mode 100644 index 000000000000..3adf8e195e23 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "connectionName": "connectionName" + }, + "responses": { + "200": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 1, + "enableInternetSecurity": false, + "expressRouteGatewayBypass": false, + "enablePrivateLinkFastPath": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionList.json new file mode 100644 index 000000000000..f91e10117079 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteConnectionList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "resourceGroupName", + "expressRouteGatewayName": "expressRouteGatewayName", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 1, + "enableInternetSecurity": false, + "expressRouteGatewayBypass": false, + "enablePrivateLinkFastPath": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json new file mode 100644 index 000000000000..d58681e11015 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json new file mode 100644 index 000000000000..86bbeefd7813 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json new file mode 100644 index 000000000000..2fa010cdcfa4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json new file mode 100644 index 000000000000..788ea94f0792 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionGet.json new file mode 100644 index 000000000000..9a6adf4e2c82 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "CrossConnection-SiliconValley", + "crossConnectionName": "" + }, + "responses": { + "200": { + "body": { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionList.json new file mode 100644 index 000000000000..6c44ea317ffe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "name": "" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json new file mode 100644 index 000000000000..4a27517fc831 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "CrossConnection-SiliconValley", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSilicon-Valley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionUpdate.json new file mode 100644 index 000000000000..5ac50e5c5c35 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "CrossConnection-SiliconValley", + "crossConnectionName": "", + "parameters": { + "properties": { + "serviceProviderProvisioningState": "NotProvisioned" + } + } + }, + "responses": { + "200": { + "body": { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionUpdateTags.json new file mode 100644 index 000000000000..39d546ce9021 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionUpdateTags.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "CrossConnection-SiliconValley", + "crossConnectionName": "", + "crossConnectionParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsArpTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsArpTable.json new file mode 100644 index 000000000000..c04d98bb2d1c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsArpTable.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "192.116.14.254", + "macAddress": "885a.9269.9110" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsRouteTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsRouteTable.json new file mode 100644 index 000000000000..c70675f3bc68 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsRouteTable.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "network": "10.6.0.0/16", + "nextHop": "10.6.1.12", + "locPrf": "", + "weight": 0, + "path": "65514" + }, + { + "network": "10.7.0.0/16", + "nextHop": "10.7.1.13", + "locPrf": "", + "weight": 0, + "path": "65514" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json new file mode 100644 index 000000000000..8e331268e76a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "neighbor": "10.6.1.112", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "Active" + }, + { + "neighbor": "10.6.1.113", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "1" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayCreate.json new file mode 100644 index 000000000000..66506245a65d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "expressRouteGatewayName": "gateway-2", + "subscriptionId": "subid", + "resourceGroupName": "resourceGroupName", + "api-version": "2024-01-01", + "putExpressRouteGatewayParameters": { + "location": "westus", + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupId/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + }, + "allowNonVirtualWanTraffic": false + } + } + }, + "responses": { + "201": { + "body": { + "name": "gateway-2", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + }, + "allowNonVirtualWanTraffic": false + } + } + }, + "200": { + "body": { + "name": "gateway-2", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + }, + "allowNonVirtualWanTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayDelete.json new file mode 100644 index 000000000000..1613a8cac871 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayGet.json new file mode 100644 index 000000000000..56e3793792d5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "allowNonVirtualWanTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayListByResourceGroup.json new file mode 100644 index 000000000000..eb1c48e0c884 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayListByResourceGroup.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2 + } + }, + "allowNonVirtualWanTraffic": false, + "expressRouteConnections": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "f28e9c99-78d8-4248-a855-c54cf6beb99d", + "routingWeight": 1, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hvirtualHubNameub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayListBySubscription.json new file mode 100644 index 000000000000..ad733e861d93 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayListBySubscription.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2 + } + }, + "allowNonVirtualWanTraffic": false, + "expressRouteConnections": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "f28e9c99-78d8-4248-a855-c54cf6beb99d", + "routingWeight": 1, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hvirtualHubNameub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayUpdateTags.json new file mode 100644 index 000000000000..91b4b7d42180 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteGatewayUpdateTags.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "expressRouteGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "allowNonVirtualWanTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteLinkGet.json new file mode 100644 index 000000000000..db143874783d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteLinkGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "linkName": "linkName" + }, + "responses": { + "200": { + "body": { + "name": "linkName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/linkName", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocationName", + "connectorType": "LC", + "adminState": "Disabled" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteLinkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteLinkList.json new file mode 100644 index 000000000000..98cc9440fb6c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteLinkList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocation1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "name": "link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "coloLocation": "coloLocation2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationCreate.json new file mode 100644 index 000000000000..b870edfb279d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "expressRoutePortName": "expressRoutePortName", + "resourceGroupName": "rg1", + "authorizationName": "authorizatinName", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "authorizationParameters": { + "properties": {} + } + }, + "responses": { + "201": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/expressRoutePortName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available", + "circuitResourceUri": "" + }, + "type": "Microsoft.Network/expressRoutePorts/authorizations" + } + }, + "200": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/expressRoutePortName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available", + "circuitResourceUri": "" + }, + "type": "Microsoft.Network/expressRoutePorts/authorizations" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationDelete.json new file mode 100644 index 000000000000..22203ddd57ae --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "expressRoutePortName": "expressRoutePortName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationGet.json new file mode 100644 index 000000000000..36ec8cfa4f45 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "expressRoutePortName": "expressRoutePortName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/expressRoutePortName/authorizations/authorizationName", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available", + "circuitResourceUri": "" + }, + "type": "Microsoft.Network/expressRoutePorts/authorizations" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationList.json new file mode 100644 index 000000000000..e4a237d539b4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "expressRoutePortName": "expressRoutePortName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/expressRoutePortName/authorizations/authorizationName", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available", + "circuitResourceUri": "" + }, + "type": "Microsoft.Network/expressRoutePorts/authorizations" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortCreate.json new file mode 100644 index 000000000000..63e82b711ba4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortCreate.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ", + "billingType": "UnlimitedData" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortDelete.json new file mode 100644 index 000000000000..e760dbdbee10 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortGet.json new file mode 100644 index 000000000000..909dbe773cd0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortGet.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocation1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "coloLocation": "coloLocation2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortList.json new file mode 100644 index 000000000000..2faaa47d7c7a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortList.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocation1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "coloLocation": "coloLocation2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortListByResourceGroup.json new file mode 100644 index 000000000000..e5b015679101 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortListByResourceGroup.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocation1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "coloLocation": "coloLocation2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortUpdateLink.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortUpdateLink.json new file mode 100644 index 000000000000..9ad2d1c69cc2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortUpdateLink.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "links": [ + { + "name": "link1", + "properties": { + "adminState": "Enabled" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortUpdateTags.json new file mode 100644 index 000000000000..933876448c19 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortUpdateTags.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortsLocationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortsLocationGet.json new file mode 100644 index 000000000000..effaf03bb0a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortsLocationGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "locationName": "locationName" + }, + "responses": { + "200": { + "body": { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsoft.Network/expressRoutePortsLocations/locationName", + "type": "Microsoft.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [ + { + "offerName": "100 Gbps", + "valueInGbps": 100 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortsLocationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortsLocationList.json new file mode 100644 index 000000000000..e99cb97ed4c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortsLocationList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsoft.Network/expressRoutePortsLocations/locationName", + "type": "Microsoft.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteProviderList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteProviderList.json new file mode 100644 index 000000000000..5e4d02b3fa5f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRouteProviderList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "providerName", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/", + "type": "Microsoft.Network/expressRouteServiceProviders", + "properties": { + "provisioningState": "Succeeded", + "peeringLocations": [ + "peeringLocation1", + "peeringLocation2" + ], + "bandwidthsOffered": [ + { + "offerName": "50Mbps", + "valueInMbps": 50 + }, + { + "offerName": "100Mbps", + "valueInMbps": 100 + }, + { + "offerName": "200Mbps", + "valueInMbps": 200 + }, + { + "offerName": "500Mbps", + "valueInMbps": 500 + }, + { + "offerName": "1Gbps", + "valueInMbps": 1000 + }, + { + "offerName": "2Gbps", + "valueInMbps": 2000 + }, + { + "offerName": "5Gbps", + "valueInMbps": 5000 + }, + { + "offerName": "10Gbps", + "valueInMbps": 10000 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDelete.json new file mode 100644 index 000000000000..eac12afdd01d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Network/locations/region1" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftDelete.json new file mode 100644 index 000000000000..430b3d42c8d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftDeploy.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftDeploy.json new file mode 100644 index 000000000000..8140f23b6c71 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftDeploy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftGet.json new file mode 100644 index 000000000000..5ee5281df296 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftGet.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "intrusionDetection": { + "mode": "Alert", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftPut.json new file mode 100644 index 000000000000..7d76257814cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyDraftPut.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + } + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyGet.json new file mode 100644 index 000000000000..b7ee953f488f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyGet.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "size": "0.5MB", + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyListByResourceGroup.json new file mode 100644 index 000000000000..373f19fa9600 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "sku": { + "tier": "Standard" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyListBySubscription.json new file mode 100644 index 000000000000..329057d79215 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyListBySubscription.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "sku": { + "tier": "Standard" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyNatRuleCollectionGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyNatRuleCollectionGroupGet.json new file mode 100644 index 000000000000..20cc966e1c2b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyNatRuleCollectionGroupGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyNatRuleCollection", + "action": { + "type": "DNAT" + }, + "rules": [ + { + "ruleType": "NatRule", + "name": "NatRule1", + "translatedFqdn": "internalhttpserver", + "translatedPort": "8080", + "ipProtocols": [ + "TCP", + "UDP" + ], + "sourceAddresses": [ + "2.2.2.2" + ], + "sourceIpGroups": [], + "destinationAddresses": [ + "152.23.32.23" + ], + "destinationPorts": [ + "8080" + ] + } + ], + "name": "NatRC", + "priority": 100 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyNatRuleCollectionGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyNatRuleCollectionGroupPut.json new file mode 100644 index 000000000000..88ba4888b7b0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyNatRuleCollectionGroupPut.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyNatRuleCollection", + "priority": 100, + "name": "Example-Nat-Rule-Collection", + "action": { + "type": "DNAT" + }, + "rules": [ + { + "ruleType": "NatRule", + "name": "nat-rule1", + "translatedFqdn": "internalhttp.server.net", + "translatedPort": "8080", + "ipProtocols": [ + "TCP", + "UDP" + ], + "sourceAddresses": [ + "2.2.2.2" + ], + "sourceIpGroups": [], + "destinationAddresses": [ + "152.23.32.23" + ], + "destinationPorts": [ + "8080" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyNatRuleCollection", + "name": "Example-Nat-Rule-Collection", + "priority": 100, + "action": { + "type": "DNAT" + }, + "rules": [ + { + "ruleType": "NatRule", + "name": "nat-rule1", + "translatedFqdn": "internalhttp.server.net", + "translatedPort": "8080", + "ipProtocols": [ + "TCP", + "UDP" + ], + "sourceAddresses": [ + "2.2.2.2" + ], + "sourceIpGroups": [], + "destinationAddresses": [ + "152.23.32.23" + ], + "destinationPorts": [ + "8080" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyNatRuleCollection", + "name": "Example-Nat-Rule-Collection", + "priority": 100, + "action": { + "type": "DNAT" + }, + "rules": [ + { + "ruleType": "NatRule", + "name": "nat-rule1", + "translatedFqdn": "internalhttp.server.net", + "translatedPort": "8080", + "ipProtocols": [ + "TCP", + "UDP" + ], + "sourceAddresses": [ + "2.2.2.2" + ], + "sourceIpGroups": [], + "destinationAddresses": [ + "152.23.32.23" + ], + "destinationPorts": [ + "8080" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyPatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyPatch.json new file mode 100644 index 000000000000..87ca634593ea --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyPatch.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-01-01", + "subscriptionId": "subId", + "parameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyPut.json new file mode 100644 index 000000000000..2a39bdb351ae --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyPut.json @@ -0,0 +1,344 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "size": "0.5MB", + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup2" + } + ], + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "size": "0.5MB", + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup2" + } + ], + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyQuerySignatureOverrides.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyQuerySignatureOverrides.json new file mode 100644 index 000000000000..300df1eec1cf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyQuerySignatureOverrides.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "filters": [ + { + "field": "Mode", + "values": [ + "Deny" + ] + } + ], + "search": "", + "orderBy": { + "field": "severity", + "order": "Ascending" + }, + "resultsPerPage": 20, + "skip": 0 + } + }, + "responses": { + "200": { + "body": { + "signatures": [ + { + "signatureId": 2000015, + "mode": 2, + "severity": 1, + "direction": 2, + "group": "A Network Trojan was detected", + "description": "P2P Phatbot Control Connection", + "sourcePorts": [ + "any" + ], + "destinationPorts": [ + "any" + ], + "lastUpdated": "2010-07-30T00:00:00", + "inheritedFromParentPolicy": false, + "protocol": "tcp" + }, + { + "signatureId": 2000106, + "mode": 2, + "severity": 1, + "direction": 1, + "group": "Attempted User Privilege Gain", + "description": "WEB_SERVER SQL sp_delete_alert attempt", + "sourcePorts": [ + "any" + ], + "destinationPorts": [ + "any" + ], + "lastUpdated": "2019-09-27T00:00:00", + "inheritedFromParentPolicy": false, + "protocol": "http" + } + ], + "matchingRecordsCount": 2 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyQuerySignatureOverridesFilterValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyQuerySignatureOverridesFilterValues.json new file mode 100644 index 000000000000..163df3a7bde6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyQuerySignatureOverridesFilterValues.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "filterName": "severity" + } + }, + "responses": { + "200": { + "body": { + "filterValues": [ + "low", + "medium", + "high" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDelete.json new file mode 100644 index 000000000000..66cc19756f5d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Network/locations/region1" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftDelete.json new file mode 100644 index 000000000000..9092c1055670 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json new file mode 100644 index 000000000000..1970eb1704e3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftPut.json new file mode 100644 index 000000000000..06cc5e3d9985 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupDraftPut.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupGet.json new file mode 100644 index 000000000000..5a2392726be8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupGet.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "size": "1.2MB", + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupList.json new file mode 100644 index 000000000000..b045c0d10b7f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "name": "Example-Filter-Rule-Collection", + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "priority": 120, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "network-rule-1", + "ruleType": "NetworkRule", + "description": "Network rule", + "destinationAddresses": [ + "*" + ], + "sourceAddresses": [ + "10.1.25.0/24" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupPut.json new file mode 100644 index 000000000000..299aff14856e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupPut.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "size": "1.2MB", + "provisioningState": "Succeeded", + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "size": "1.2MB", + "provisioningState": "Succeeded", + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithHttpHeadersToInsert.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithHttpHeadersToInsert.json new file mode 100644 index 000000000000..cc17420ffa0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithHttpHeadersToInsert.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Allow" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Insert trusted tenants header", + "protocols": [ + { + "protocolType": "Http", + "port": 80 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "fqdnTags": [ + "WindowsVirtualDesktop" + ], + "httpHeadersToInsert": [ + { + "headerName": "Restrict-Access-To-Tenants", + "headerValue": "contoso.com,fabrikam.onmicrosoft.com" + } + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Allow" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Insert trusted tenants header", + "protocols": [ + { + "protocolType": "Http", + "port": 80 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "fqdnTags": [ + "WindowsVirtualDesktop" + ], + "httpHeadersToInsert": [ + { + "headerName": "Restrict-Access-To-Tenants", + "headerValue": "contoso.com,fabrikam.onmicrosoft.com" + } + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Allow" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Insert trusted tenants header", + "protocols": [ + { + "protocolType": "Http", + "port": 80 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "fqdnTags": [ + "WindowsVirtualDesktop" + ], + "httpHeadersToInsert": [ + { + "headerName": "Restrict-Access-To-Tenants", + "headerValue": "contoso.com,fabrikam.onmicrosoft.com" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json new file mode 100644 index 000000000000..bd05c490b421 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleGroups/ruleGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json new file mode 100644 index 000000000000..bebafcd8c97f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "name": "Example-Filter-Rule-Collection", + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "priority": 120, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "network-rule-1", + "ruleType": "NetworkRule", + "description": "Network rule", + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json new file mode 100644 index 000000000000..10f73c1acf1c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json new file mode 100644 index 000000000000..0376ba2c7853 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2" + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json new file mode 100644 index 000000000000..d3cf8508de45 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "name": "Example-Filter-Rule-Collection", + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "priority": 120, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json new file mode 100644 index 000000000000..51a88539d444 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesGet.json new file mode 100644 index 000000000000..bb7f2bf9ad2e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesList.json new file mode 100644 index 000000000000..4c592fc7e4e3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesPatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesPatch.json new file mode 100644 index 000000000000..245cad9aa0e8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesPatch.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesPut.json new file mode 100644 index 000000000000..245cad9aa0e8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/FirewallPolicySignatureOverridesPut.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GenerateExpressRoutePortsLOA.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GenerateExpressRoutePortsLOA.json new file mode 100644 index 000000000000..d2daf43554ef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GenerateExpressRoutePortsLOA.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "request": { + "customerName": "customerName" + } + }, + "responses": { + "200": { + "description": "Request successful. Returns the content as a base64 encoded string", + "body": { + "encodedContent": "TWFuIGlzIGRpc3" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json new file mode 100644 index 000000000000..e983dbb4598c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualWANName": "wan1", + "vpnClientParams": { + "vpnServerConfigurationResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1", + "authenticationMethod": "EAPTLS" + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "profileUrl": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetApplicationGatewayWafDynamicManifests.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetApplicationGatewayWafDynamicManifests.json new file mode 100644 index 000000000000..d43626f03a9e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetApplicationGatewayWafDynamicManifests.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2021-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/subid/providers/Microsoft.Network/applicationGatewayWafDynamicManifests/default", + "type": "Microsoft.Network/applicationGatewayWafDynamicManifest", + "properties": { + "defaultRuleSet": { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + }, + "availableRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "status": "0", + "tiers": [ + "WAF_v2" + ], + "ruleGroups": [ + { + "ruleGroupName": "General", + "description": "", + "rules": [ + { + "ruleId": 200002, + "ruleIdString": "200002", + "description": "Failed to Parse Request Body.", + "state": "Enabled", + "action": "AnomalyScoring" + }, + { + "ruleId": 200003, + "ruleIdString": "200003", + "description": "Multipart Request Body Strict Validation.", + "state": "Enabled", + "action": "AnomalyScoring" + }, + { + "ruleId": 200004, + "ruleIdString": "200004", + "description": "Possible Multipart Unmatched Boundary.", + "state": "Enabled", + "action": "AnomalyScoring" + } + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json new file mode 100644 index 000000000000..1cc8e34e1230 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2021-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/subid/providers/Microsoft.Network/applicationGatewayWafDynamicManifests/default", + "type": "Microsoft.Network/applicationGatewayWafDynamicManifest", + "properties": { + "defaultRuleSet": { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + }, + "availableRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "status": "0", + "tiers": [ + "WAF_v2" + ], + "ruleGroups": [ + { + "ruleGroupName": "General", + "description": "", + "rules": [ + { + "ruleId": 200002, + "ruleIdString": "200002", + "description": "Failed to Parse Request Body.", + "state": "Enabled", + "action": "AnomalyScoring" + }, + { + "ruleId": 200003, + "ruleIdString": "200003", + "description": "Multipart Request Body Strict Validation.", + "state": "Enabled", + "action": "AnomalyScoring" + }, + { + "ruleId": 200004, + "ruleIdString": "200004", + "description": "Possible Multipart Unmatched Boundary.", + "state": "Enabled", + "action": "AnomalyScoring" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetInboundRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetInboundRoutes.json new file mode 100644 index 000000000000..1fd79b510610 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetInboundRoutes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2024-01-01", + "getInboundRoutesParameters": { + "resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1", + "connectionType": "ExpressRouteConnection" + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "properties": { + "output": { + "value": [ + { + "prefix": "192.168.50.0/24", + "asPath": "65520-65520", + "bgpCommunities": "4293853166,12076,51004" + }, + { + "prefix": "10.200.0.0/16", + "asPath": "65520-65520-12076-12076", + "bgpCommunities": "4293787629,12076,51027,4293734188" + } + ] + } + } + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetOutboundRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetOutboundRoutes.json new file mode 100644 index 000000000000..b2863f48ed0e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetOutboundRoutes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2024-01-01", + "getOutboundRoutesParameters": { + "resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1", + "connectionType": "ExpressRouteConnection" + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "properties": { + "output": { + "value": [ + { + "prefix": "192.168.50.0/24", + "asPath": "65520-65520", + "bgpCommunities": "4293853166,12076,51004" + }, + { + "prefix": "10.200.0.0/16", + "asPath": "65520-65520-12076-12076", + "bgpCommunities": "4293787629,12076,51027,4293734188" + } + ] + } + } + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetVirtualWanVpnServerConfigurations.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetVirtualWanVpnServerConfigurations.json new file mode 100644 index 000000000000..21f8dd5de979 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/GetVirtualWanVpnServerConfigurations.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "virtualWANName": "wan1" + }, + "responses": { + "200": { + "description": "Request successful.", + "body": { + "vpnServerConfigurationResourceIds": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig2" + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableDelete.json new file mode 100644 index 000000000000..898c27ca8cc6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "routeTableName": "hubRouteTable1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableGet.json new file mode 100644 index 000000000000..a74feff044a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "routeTableName": "hubRouteTable1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "hubRouteTable1", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableList.json new file mode 100644 index 000000000000..d2f603bc49b6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTableList.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "hubRouteTable1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1a", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + }, + { + "name": "hubRouteTable2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route2a", + "destinationType": "CIDR", + "destinations": [ + "40.0.0.0/8", + "50.0.0.0/8", + "60.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/vn1" + } + ], + "labels": [ + "label3" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn4" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn2", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn1" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTablePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTablePut.json new file mode 100644 index 000000000000..aab0d4de9888 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubRouteTablePut.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "routeTableName": "hubRouteTable1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1", + "routeTableParameters": { + "properties": { + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "hubRouteTable1", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "hubRouteTable1", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionDelete.json new file mode 100644 index 000000000000..9dbf403b7858 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionGet.json new file mode 100644 index 000000000000..2ffda37e0115 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionGet.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "propagateStaticRoutes": true, + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionList.json new file mode 100644 index 000000000000..d94f87e2bd26 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionList.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "propagateStaticRoutes": true, + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1" + } + ] + } + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + }, + { + "name": "connection2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn2" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionPut.json new file mode 100644 index 000000000000..d1a57d5304bf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/HubVirtualNetworkConnectionPut.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "hubVirtualNetworkConnectionParameters": { + "properties": { + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Updating", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "propagateStaticRoutes": true, + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + }, + "201": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Updating", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "propagateStaticRoutes": true, + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleCreate.json new file mode 100644 index 000000000000..805e5dce4a85 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1", + "inboundNatRuleParameters": { + "properties": { + "protocol": "Tcp", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "idleTimeoutInMinutes": 4, + "enableTcpReset": false, + "enableFloatingIP": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": false, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + }, + "201": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": false, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleDelete.json new file mode 100644 index 000000000000..25687b40d5c2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleGet.json new file mode 100644 index 000000000000..1a8dca67ed61 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleList.json new file mode 100644 index 000000000000..09a152726985 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundNatRuleList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + }, + { + "name": "natRule1.3", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.3", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3392, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundSecurityRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundSecurityRuleGet.json new file mode 100644 index 000000000000..a8e2baa3823b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundSecurityRuleGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "ruleCollectionName": "rule1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "ruleType": "Permanent", + "provisioningState": "Succeeded", + "rules": [ + { + "name": "inboundRule1", + "protocol": "TCP", + "sourceAddressPrefix": "50.20.121.5/32", + "destinationPortRange": 22, + "destinationPortRanges": [ + "80-100" + ], + "appliesOn": [ + "slbip1" + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundSecurityRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundSecurityRulePut.json new file mode 100644 index 000000000000..a986f359d370 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/InboundSecurityRulePut.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "ruleCollectionName": "rule1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "properties": { + "ruleType": "Permanent", + "rules": [ + { + "name": "inboundRule1", + "protocol": "TCP", + "sourceAddressPrefix": "50.20.121.5/32", + "destinationPortRange": 22, + "destinationPortRanges": [ + "80-100" + ], + "appliesOn": [ + "slbip1" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "ruleType": "Permanent", + "provisioningState": "Succeeded", + "rules": [ + { + "name": "inboundRule1", + "protocol": "TCP", + "sourceAddressPrefix": "50.20.121.5/32", + "destinationPortRange": 22, + "destinationPortRanges": [ + "80-100" + ], + "appliesOn": [ + "slbip1" + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "ruleType": "Permanent", + "provisioningState": "Succeeded", + "rules": [ + { + "name": "inboundRule1", + "protocol": "TCP", + "sourceAddressPrefix": "50.20.121.5/32", + "destinationPortRange": 22, + "destinationPortRanges": [ + "80-100" + ], + "appliesOn": [ + "slbip1" + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationCreate.json new file mode 100644 index 000000000000..0f2354c71849 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationCreate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation", + "parameters": { + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + }, + "location": "centraluseuap" + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + }, + "201": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationDelete.json new file mode 100644 index 000000000000..0d63d84370d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationGet.json new file mode 100644 index 000000000000..44ef91cf6c13 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation" + }, + "responses": { + "200": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationList.json new file mode 100644 index 000000000000..220df4f9dd3b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipallocation1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation1", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + }, + { + "name": "test-ipallocation2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation2", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.6.0/24", + "ipamAllocationId": "57dc7256-2ff7-43f2-b9c8-85a70b5c6408", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationListByResourceGroup.json new file mode 100644 index 000000000000..3ee27b80e775 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipallocation1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation1", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + }, + { + "name": "test-ipallocation2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation2", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.6.0/24", + "ipamAllocationId": "57dc7256-2ff7-43f2-b9c8-85a70b5c6408", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationUpdateTags.json new file mode 100644 index 000000000000..d7a871846ec2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpAllocationUpdateTags.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation", + "location": "centraluseuap", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsCreate.json new file mode 100644 index 000000000000..fd0769cd4806 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsCreate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup", + "ipGroupsName": "ipGroups1", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + }, + "201": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsDelete.json new file mode 100644 index 000000000000..c9fd4ff06c54 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup", + "ipGroupsName": "ipGroups1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsGet.json new file mode 100644 index 000000000000..78e4d6685d46 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup", + "ipGroupsName": "ipGroups1" + }, + "responses": { + "200": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsListByResourceGroup.json new file mode 100644 index 000000000000..815d75ee28f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + }, + { + "name": "ipGroups2", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "14.64.39.16/32", + "41.74.146.80/31", + "42.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsListBySubscription.json new file mode 100644 index 000000000000..9c464615f17e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsListBySubscription.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "iptag1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup1/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + }, + { + "name": "iptag2", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup2/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "14.64.39.16/32", + "41.74.146.80/31", + "42.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsUpdateTags.json new file mode 100644 index 000000000000..45220f15f13a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/IpGroupsUpdateTags.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "ipGroupsName": "ipGroups1", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-01-01", + "subscriptionId": "subId", + "parameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json new file mode 100644 index 000000000000..534f81522980 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json new file mode 100644 index 000000000000..26f0e2b90e00 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json new file mode 100644 index 000000000000..ca476c2e8c03 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2024-01-01", + "parameters": { + "properties": { + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + }, + "201": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolDelete.json new file mode 100644 index 000000000000..fdd8a148163a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolGet.json new file mode 100644 index 000000000000..3d16a47758c9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolList.json new file mode 100644 index 000000000000..b897fffced70 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerBackendAddressPoolList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreate.json new file mode 100644 index 000000000000..2016b6f52594 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreate.json @@ -0,0 +1,342 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "inboundNatPools": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json new file mode 100644 index 000000000000..6a29746fbbf3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json @@ -0,0 +1,351 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json new file mode 100644 index 000000000000..2510a5110004 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + }, + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 0, + "backendPort": 0, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "All", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + }, + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + }, + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json new file mode 100644 index 000000000000..21e24a6ae954 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json @@ -0,0 +1,364 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb1", + "properties": {} + }, + { + "name": "be-lb2", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 0, + "backendPort": 0, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "All", + "loadDistribution": "Default", + "backendAddressPool": {}, + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + }, + { + "name": "be-lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 0, + "backendPort": 0, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + }, + { + "name": "be-lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGlobalTier.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGlobalTier.json new file mode 100644 index 000000000000..f36e53cfa76c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateGlobalTier.json @@ -0,0 +1,317 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard", + "tier": "Global" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancerBackendAddresses": [ + { + "name": "regional-lb1-address", + "properties": { + "loadBalancerFrontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb" + } + } + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard", + "tier": "Global" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "regional-lb1-address", + "properties": { + "loadBalancerFrontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb" + } + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard", + "tier": "Global" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "regional-lb1-address", + "properties": { + "loadBalancerFrontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb" + } + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateStandardSku.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateStandardSku.json new file mode 100644 index 000000000000..cef10be2be99 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateStandardSku.json @@ -0,0 +1,342 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithInboundNatPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithInboundNatPool.json new file mode 100644 index 000000000000..317c8485b1e2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithInboundNatPool.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + } + }, + "name": "test", + "zones": [], + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + }, + "protocol": "Tcp", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "enableTcpReset": true + }, + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "type": "Microsoft.Network/loadBalancers/inboundNatPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "type": "Microsoft.Network/loadBalancers/inboundNatPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithOutboundRules.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithOutboundRules.json new file mode 100644 index 000000000000..16dac99a5c84 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithOutboundRules.json @@ -0,0 +1,426 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "protocol": "Tcp", + "loadDistribution": "Default", + "frontendPort": 80, + "backendPort": 80, + "idleTimeoutInMinutes": 15, + "enableFloatingIP": true, + "disableOutboundSnat": true + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [ + { + "name": "rule1", + "properties": { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "protocol": "All" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "disableOutboundSnat": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "outboundRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "allocatedOutboundPorts": 1024, + "protocol": "All", + "enableTcpReset": false, + "idleTimeoutInMinutes": 4, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ] + } + } + ], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "disableOutboundSnat": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "outboundRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "allocatedOutboundPorts": 1024, + "protocol": "All", + "enableTcpReset": false, + "idleTimeoutInMinutes": 4, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ] + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithSyncModePropertyOnPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithSyncModePropertyOnPool.json new file mode 100644 index 000000000000..9cd1923c7351 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithSyncModePropertyOnPool.json @@ -0,0 +1,355 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "syncMode": "Automatic", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + } + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "syncMode": "Automatic" + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "syncMode": "Automatic" + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithZones.json new file mode 100644 index 000000000000..f0d098ab5d88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerCreateWithZones.json @@ -0,0 +1,351 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + }, + "zones": [ + "1" + ] + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerDelete.json new file mode 100644 index 000000000000..57b606161d0e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerFrontendIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerFrontendIPConfigurationGet.json new file mode 100644 index 000000000000..f654345ad768 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerFrontendIPConfigurationGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "frontendIPConfigurationName": "frontend", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerFrontendIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerFrontendIPConfigurationList.json new file mode 100644 index 000000000000..d2de0e406907 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerFrontendIPConfigurationList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerGet.json new file mode 100644 index 000000000000..6e3359baca66 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerGet.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerGetInboundNatRulePortMapping.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerGetInboundNatRulePortMapping.json new file mode 100644 index 000000000000..220f51cdce8c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerGetInboundNatRulePortMapping.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "8bec96ef-0a6a-45b8-9860-4ffde7bf3572", + "properties": { + "ipAddress": "10.0.0.4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "inboundNatRulesPortMapping": [ + { + "inboundNatRuleName": "natRule", + "frontendPort": 3389, + "backendPort": 3389 + } + ] + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 0, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendPortRangeStart": 3389, + "frontendPortRangeEnd": 4000, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + } + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerList.json new file mode 100644 index 000000000000..1ab055f46de9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerList.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [] + } + }, + { + "name": "lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb2", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerListAll.json new file mode 100644 index 000000000000..2691518e35df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerListAll.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [] + } + }, + { + "name": "lb3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb3", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerLoadBalancingRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerLoadBalancingRuleGet.json new file mode 100644 index 000000000000..cc1d43714276 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerLoadBalancingRuleGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "loadBalancingRuleName": "rule1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerLoadBalancingRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerLoadBalancingRuleList.json new file mode 100644 index 000000000000..4ee310b67c8a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerLoadBalancingRuleList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerNetworkInterfaceListSimple.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerNetworkInterfaceListSimple.json new file mode 100644 index 000000000000..5d0ee469de03 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerNetworkInterfaceListSimple.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mynic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inbound1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": false, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerNetworkInterfaceListVmss.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerNetworkInterfaceListVmss.json new file mode 100644 index 000000000000..ce048119e86f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerNetworkInterfaceListVmss.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerOutboundRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerOutboundRuleGet.json new file mode 100644 index 000000000000..a10211b2667c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerOutboundRuleGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "outboundRuleName": "rule1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerOutboundRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerOutboundRuleList.json new file mode 100644 index 000000000000..f8c60d3065a1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerOutboundRuleList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerProbeGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerProbeGet.json new file mode 100644 index 000000000000..c80d723630f8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerProbeGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "probeName": "probe1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerProbeList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerProbeList.json new file mode 100644 index 000000000000..0adefe3453bf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerProbeList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerUpdateTags.json new file mode 100644 index 000000000000..2e15dec8b14e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancerUpdateTags.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancersSwapPublicIpAddresses.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancersSwapPublicIpAddresses.json new file mode 100644 index 000000000000..cde9f2bed8db --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LoadBalancersSwapPublicIpAddresses.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "location": "westus", + "parameters": { + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfe1", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/pip2" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb2/frontendIPConfigurations/lbfe2", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip1" + } + } + } + ] + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayCreate.json new file mode 100644 index 000000000000..c5cef2e9fefa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayCreate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "localgw", + "parameters": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "11.12.13.14", + "fqdn": "site1.contoso.com" + }, + "location": "Central US" + } + }, + "responses": { + "201": { + "body": { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "11.12.13.14" + } + } + }, + "200": { + "body": { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "11.12.13.14" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayDelete.json new file mode 100644 index 000000000000..9250b81630da --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "localgw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayGet.json new file mode 100644 index 000000000000..ebd4abe357ef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "localgw" + }, + "responses": { + "200": { + "body": { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayList.json new file mode 100644 index 000000000000..e2d542cc856d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "localgw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + }, + { + "name": "localgw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.2.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..71c3b27c7fb7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/LocalNetworkGatewayUpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "lgw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "lgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "type": "Microsoft.Network/localNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "gatewayIpAddress": "12.0.0.1" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/MigrateLoadBalancerToIPBased.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/MigrateLoadBalancerToIPBased.json new file mode 100644 index 000000000000..be1f711e8faa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/MigrateLoadBalancerToIPBased.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "groupName": "rg1", + "loadBalancerName": "lb1", + "parameters": { + "pools": [ + "pool1", + "pool2" + ] + } + }, + "responses": { + "200": { + "body": { + "migratedPools": [ + "pool1", + "pool2" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayCreateOrUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayCreateOrUpdate.json new file mode 100644 index 000000000000..f5a337e495aa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayCreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natgateway", + "parameters": { + "location": "westus", + "sku": { + "name": "Standard" + }, + "properties": { + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + }, + "201": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayDelete.json new file mode 100644 index 000000000000..31abcb10ffe2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayGet.json new file mode 100644 index 000000000000..223aa8b32d7f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway" + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayList.json new file mode 100644 index 000000000000..56b1fb065aed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayList.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateway/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + }, + { + "name": "test-natGateway2", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGateway/test-natGateway2", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayListAll.json new file mode 100644 index 000000000000..1bd0d65f9e39 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayListAll.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + }, + { + "name": "test-natGateway2", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGatewayes/test-natGateway2", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayUpdateTags.json new file mode 100644 index 000000000000..2dac52d44893 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatGatewayUpdateTags.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/natGateways" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleDelete.json new file mode 100644 index 000000000000..96a7ee54058f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "natRuleName": "natRule1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleGet.json new file mode 100644 index 000000000000..690b6a167f0d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "natRuleName": "natRule1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [], + "egressVpnSiteLinkConnections": [], + "ingressVpnSiteLinkConnections": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleList.json new file mode 100644 index 000000000000..0ff22363080e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRuleList.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2" + } + ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRulePut.json new file mode 100644 index 000000000000..a0dacffd7ac2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NatRulePut.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "natRuleName": "natRule1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "NatRuleParameters": { + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2" + } + ] + } + } + }, + "201": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceCreate.json new file mode 100644 index 000000000000..370fe2c4ea1d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceCreate.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "properties": { + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + } + } + }, + { + "name": "ipconfig2", + "properties": { + "privateIPAddressPrefixLength": 28 + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + }, + { + "name": "ipconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.16/28", + "privateIPAddressPrefixLength": 28, + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": false, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + }, + "201": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + }, + { + "name": "ipconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.16/28", + "privateIPAddressPrefixLength": 28, + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": false, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceCreateGatewayLoadBalancerConsumer.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceCreateGatewayLoadBalancerConsumer.json new file mode 100644 index 000000000000..0f4753846067 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceCreateGatewayLoadBalancerConsumer.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "properties": { + "enableAcceleratedNetworking": true, + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + }, + "201": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceDelete.json new file mode 100644 index 000000000000..53dca1c567c4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceEffectiveNSGList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceEffectiveNSGList.json new file mode 100644 index 000000000000..d5f090ff0bc8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceEffectiveNSGList.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg" + }, + "association": { + "networkManager": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "networkInterface": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "effectiveSecurityRules": [ + { + "name": "securityRules/rule1", + "protocol": "Tcp", + "sourcePortRange": "456-456", + "destinationPortRange": "6579-6579", + "sourceAddressPrefix": "0.0.0.0/32", + "destinationAddressPrefix": "0.0.0.0/32", + "access": "Allow", + "priority": 234, + "direction": "Inbound" + }, + { + "name": "securityRules/default-allow-rdp", + "protocol": "Tcp", + "sourcePortRange": "0-65535", + "destinationPortRange": "3389-3389", + "sourceAddressPrefix": "1.1.1.1/32", + "destinationAddressPrefix": "0.0.0.0/0", + "access": "Allow", + "priority": 1000, + "direction": "Inbound" + }, + { + "name": "defaultSecurityRules/AllowInternetOutBound", + "protocol": "All", + "sourcePortRange": "0-65535", + "destinationPortRange": "0-65535", + "sourceAddressPrefix": "0.0.0.0/0", + "destinationAddressPrefix": "Internet", + "expandedDestinationAddressPrefix": [ + "32.0.0.0/3", + "4.0.0.0/6", + "2.0.0.0/7", + "1.0.0.0/8" + ], + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com//subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceEffectiveRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceEffectiveRouteTableList.json new file mode 100644 index 000000000000..ca52ac409a56 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceEffectiveRouteTableList.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.20.2.0/24" + ], + "nextHopType": "VnetLocal", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "0.0.0.0/0" + ], + "nextHopType": "Internet", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "10.0.0.0/8" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "100.64.0.0/10" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.16.0.0/12" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "192.168.0.0/16" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceGet.json new file mode 100644 index 000000000000..bd7c51496363 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceGet.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + }, + { + "name": "ipconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.16/28", + "privateIPAddressPrefixLength": 28, + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": false, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "test.bx.internal.cloudapp.net" + }, + "macAddress": "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "dscpConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/dscpConfiguration/mydscpconfiguration" + }, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceIPConfigurationGet.json new file mode 100644 index 000000000000..81cd1d48384c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceIPConfigurationGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "ipConfigurationName": "ipconfig1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ], + "virtualNetworkTaps": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/vTAP1" + }, + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/vTAP2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceIPConfigurationList.json new file mode 100644 index 000000000000..724cf53e7ac9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceIPConfigurationList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet12/subnets/subnet12" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceList.json new file mode 100644 index 000000000000..22e904300c98 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceList.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "test.bx.internal.cloudapp.net" + }, + "macAddress": "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type": "Microsoft.Network/networkInterfaces" + }, + { + "name": "test-nic2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet2/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + }, + { + "name": "ipconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.16/28", + "privateIPAddressPrefixLength": 28, + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": false, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceListAll.json new file mode 100644 index 000000000000..574703cfd2a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceListAll.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "test.bx.internal.cloudapp.net" + }, + "macAddress": "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type": "Microsoft.Network/networkInterfaces" + }, + { + "name": "test-nic2", + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/virtualNetworks/rgnew-vnet2/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceLoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceLoadBalancerList.json new file mode 100644 index 000000000000..74516a579071 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceLoadBalancerList.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lbname1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "frontendIPConfigurations": [ + { + "name": "lbfrontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/publicIPAddresses/myDynamicPublicIP" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "bepool1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1" + } + } + } + ], + "probes": [ + { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inbound1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationCreate.json new file mode 100644 index 000000000000..c26859e82150 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationCreate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "tapConfigurationName": "tapconfiguration1", + "api-version": "2024-01-01", + "tapConfigurationParameters": { + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + }, + "201": { + "body": { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationDelete.json new file mode 100644 index 000000000000..5f08e8fc40a0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-networkinterface", + "tapConfigurationName": "test-tapconfiguration" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-networkinterface/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationGet.json new file mode 100644 index 000000000000..dda64ecbf7a5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "tapConfigurationName": "tapconfiguration1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationList.json new file mode 100644 index 000000000000..7f42f28d5d52 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceTapConfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "mynic" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceUpdateTags.json new file mode 100644 index 000000000000..0aabb01e4db8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkInterfaceUpdateTags.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerActiveConnectivityConfigurationsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerActiveConnectivityConfigurationsList.json new file mode 100644 index 000000000000..b030deafe39c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerActiveConnectivityConfigurationsList.json @@ -0,0 +1,59 @@ +{ + "title": "Get Azure Virtual Network Manager Active Connectivity Configuration", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "parameters": { + "regions": [ + "westus" + ], + "skipToken": "fakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "region": "westus", + "commitTime": "2020-07-10T18:03:22.2578238+05:30", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "isGlobal": "True", + "deleteExistingPeering": "True", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "provisioningState": "Succeeded" + }, + "configurationGroups": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "properties": { + "description": "A group for all test Virtual Networks", + "provisioningState": "Succeeded" + } + } + ] + } + ], + "skipToken": "FakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerActiveSecurityAdminRulesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerActiveSecurityAdminRulesList.json new file mode 100644 index 000000000000..0a0de4b52e3c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerActiveSecurityAdminRulesList.json @@ -0,0 +1,73 @@ +{ + "title": "Get Azure Virtual Network Manager Active Security Admin Rules", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "parameters": { + "regions": [ + "westus" + ], + "skipToken": "fakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "region": "westus", + "commitTime": "2020-07-10T18:03:22.2578238+05:30", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "configurationDescription": "SampleDescription", + "ruleCollectionDescription": "SampleRuleCollectionDescription", + "ruleCollectionAppliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1" + } + ], + "kind": "Default", + "properties": { + "description": "Sample Admin Rule", + "flag": "AllowVnetInbound", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "direction": "Inbound", + "access": "Deny", + "priority": 1, + "provisioningState": "Succeeded" + }, + "ruleGroups": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "properties": { + "description": "A group for all test Virtual Networks", + "provisioningState": "Succeeded" + } + } + ] + } + ], + "skipToken": "FakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionDelete.json new file mode 100644 index 000000000000..d39181b01320 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionGet.json new file mode 100644 index 000000000000..dc82af551de3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection", + "name": "testRuleCollection", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample rule collection", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionList.json new file mode 100644 index 000000000000..ad282e70f6c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection", + "name": "testRuleCollection", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample rule collection", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionPut.json new file mode 100644 index 000000000000..19901e72e944 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleCollectionPut.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "ruleCollection": { + "properties": { + "description": "A sample policy", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleDelete.json new file mode 100644 index 000000000000..46c6d11819ee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleAdminRule", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleGet.json new file mode 100644 index 000000000000..8efd99f56f8f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleAdminRule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "kind": "Custom", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleList.json new file mode 100644 index 000000000000..532d12361daa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRuleList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkmanagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "kind": "Custom", + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkManagers/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRulePut.json new file mode 100644 index 000000000000..ca7520c925e1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerAdminRulePut.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleAdminRule", + "adminRule": { + "kind": "Custom", + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "kind": "Custom", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "kind": "Custom", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerCommitPost.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerCommitPost.json new file mode 100644 index 000000000000..4d8b7ca57f84 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerCommitPost.json @@ -0,0 +1,47 @@ +{ + "title": "Post Azure Virtual Network Manager Commit", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resoureGroupSample", + "networkManagerName": "testNetworkManager", + "parameters": { + "targetLocations": [ + "useast" + ], + "configurationIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resoureGroupSample/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/SampleSecurityAdminConfig" + ], + "commitType": "SecurityAdmin" + } + }, + "responses": { + "200": { + "body": { + "commitId": "testCommitId", + "targetLocations": [ + "useast" + ], + "configurationIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resoureGroupSample/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/SampleSecurityAdminConfig" + ], + "commitType": "SecurityAdmin" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + }, + "body": { + "commitId": "testCommitId", + "targetLocations": [ + "useast" + ], + "configurationIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resoureGroupSample/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/SampleSecurityAdminConfig" + ], + "commitType": "SecurityAdmin" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupDelete.json new file mode 100644 index 000000000000..b7388b5eb96f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupDelete.json @@ -0,0 +1,12 @@ +{ + "title": "Delete Management Group Connection to Azure Virtual Network Manager", + "parameters": { + "api-version": "2024-01-01", + "managementGroupId": "managementGroupA", + "networkManagerConnectionName": "TestNMConnection" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupGet.json new file mode 100644 index 000000000000..1982f0399e45 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupGet.json @@ -0,0 +1,33 @@ +{ + "title": "Get Management Group Azure Virtual Network Manager Connection", + "parameters": { + "api-version": "2024-01-01", + "managementGroupId": "managementGroupA", + "networkManagerConnectionName": "TestNMConnection" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "providers/Microsoft.Management/managementGroups/managementGroupA/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupList.json new file mode 100644 index 000000000000..8de2e805163c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupList.json @@ -0,0 +1,37 @@ +{ + "title": "List Management Group Azure Virtual Network Manager Connections", + "parameters": { + "api-version": "2024-01-01", + "managementGroupId": "managementGroupA" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "value": [ + { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupA/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + ], + "nextLink": "{baseurl}/managementGroups/subscriptionA/providers/Microsoft.Network/networkManagerConnections?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupPut.json new file mode 100644 index 000000000000..8702ee551387 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionManagementGroupPut.json @@ -0,0 +1,61 @@ +{ + "title": "Create/Update Management Group Azure Virtual Network Manager Connection", + "parameters": { + "api-version": "2024-01-01", + "managementGroupId": "managementGroupA", + "networkManagerConnectionName": "TestNMConnection", + "parameters": { + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupA/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/managementGroups/managementGroupA/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionDelete.json new file mode 100644 index 000000000000..cac88a64f43a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionDelete.json @@ -0,0 +1,12 @@ +{ + "title": "Delete Subscription Connection to Azure Virtual Network Manager", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "networkManagerConnectionName": "TestNMConnection" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionGet.json new file mode 100644 index 000000000000..c374208a5355 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionGet.json @@ -0,0 +1,33 @@ +{ + "title": "Get Subscription Azure Virtual Network Manager Connection", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "networkManagerConnectionName": "TestNMConnection" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionList.json new file mode 100644 index 000000000000..dd54c325e261 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionList.json @@ -0,0 +1,37 @@ +{ + "title": "List Subscription Azure Virtual Network Manager Connections", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionPut.json new file mode 100644 index 000000000000..b08981c4037b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectionSubscriptionPut.json @@ -0,0 +1,61 @@ +{ + "title": "Create/Update Subscription Azure Virtual Network Manager Connection", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "networkManagerConnectionName": "TestNMConnection", + "parameters": { + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationDelete.json new file mode 100644 index 000000000000..94156d92d85d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationDelete.json @@ -0,0 +1,20 @@ +{ + "title": "Get Azure Virtual Network Manager Connectivity Configuration", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestConnectivityConfig", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/connectivityConfigurations/myTestConnectivityConfig/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationGet.json new file mode 100644 index 000000000000..59757258a2a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationGet.json @@ -0,0 +1,49 @@ +{ + "title": "Get Azure Virtual Network Manager Connectivity Configuration", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestConnectivityConfig" + }, + "responses": { + "200": { + "body": { + "name": "myTestConnectivityConfig", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "type": "Microsoft.Network/networkManagers/connectivityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myHubVnet", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "isGlobal": "True", + "deleteExistingPeering": "True", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationList.json new file mode 100644 index 000000000000..56db4ec4ea29 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationList.json @@ -0,0 +1,53 @@ +{ + "title": "Get Azure Virtual Network Manager Connecitivity Configuration List", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myTestConnectivityConfig", + "id": "subscription/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "type": "Microsoft.Network/networkManagers/connectivityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myHubVnet", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "deleteExistingPeering": "True", + "isGlobal": "True", + "appliesToGroups": [ + { + "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/netwrokGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/managedNetworks/testNetworkManager/connectivityConfigurations?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationPut.json new file mode 100644 index 000000000000..1a739e3bf934 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerConnectivityConfigurationPut.json @@ -0,0 +1,108 @@ +{ + "title": "Create/Update Azure Virtual Network Manager Connectivity Configuration", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestConnectivityConfig", + "connectivityConfiguration": { + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "deleteExistingPeering": "True", + "isGlobal": "True", + "appliesToGroups": [ + { + "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "myTestConnectivityConfig", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "type": "Microsoft.Network/networkManagers/connectivityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample Connectivity Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "deleteExistingPeering": "True", + "isGlobal": "True", + "appliesToGroups": [ + { + "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/groups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "myTestConnectivityConfig", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "type": "Microsoft.Network/networkManagers/connectivityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "deleteExistingPeering": "True", + "isGlobal": "True", + "appliesToGroups": [ + { + "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDefaultAdminRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDefaultAdminRuleGet.json new file mode 100644 index 000000000000..7b972a887ee4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDefaultAdminRuleGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleDefaultAdminRule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleDefaultAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleDefaultAdminRule", + "kind": "Default", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "flag": "AllowVnetInbound", + "description": "This is Sample Default Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDefaultAdminRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDefaultAdminRulePut.json new file mode 100644 index 000000000000..13101bb49f94 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDefaultAdminRulePut.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleDefaultAdminRule", + "adminRule": { + "kind": "Default", + "properties": { + "flag": "AllowVnetInbound" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleDefaultAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleDefaultAdminRule", + "kind": "Default", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "flag": "AllowVnetInbound", + "description": "This is Sample Default Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/rules/SampleDefaultAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleDefaultAdminRule", + "kind": "Default", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "flag": "AllowVnetInbound", + "description": "This is Sample Default Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDelete.json new file mode 100644 index 000000000000..670b25e740ae --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDelete.json @@ -0,0 +1,19 @@ +{ + "title": "Delete Azure Virtual Network Manager", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDeploymentStatusList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDeploymentStatusList.json new file mode 100644 index 000000000000..d98c5ea9d908 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerDeploymentStatusList.json @@ -0,0 +1,51 @@ +{ + "title": "Post Azure Virtual Network Manager Deployment Status", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resoureGroupSample", + "networkManagerName": "testNetworkManager", + "parameters": { + "regions": [ + "eastus", + "westus" + ], + "deploymentTypes": [ + "Connectivity", + "AdminPolicy" + ], + "skipToken": "FakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentType": "AdminPolicy", + "configurationIds": [ + "SecConfig1", + "SecConfig2" + ], + "commitTime": "2021-01-26T06:58:50.883Z", + "region": "eastus", + "deploymentStatus": "Deploying", + "errorMessage": "" + }, + { + "deploymentType": "Connectivity", + "configurationIds": [ + "ConnConfig1", + "ConnConfig2" + ], + "commitTime": "2021-01-26T06:58:50.883Z", + "region": "eastus", + "deploymentStatus": "Deployed", + "errorMessage": "" + } + ], + "skipToken": "NextFakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerEffectiveConnectivityConfigurationsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerEffectiveConnectivityConfigurationsList.json new file mode 100644 index 000000000000..f49bf6c77aa4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerEffectiveConnectivityConfigurationsList.json @@ -0,0 +1,54 @@ +{ + "title": "List Azure Virtual Network Manager Effective Configuration", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "virtualNetworkName": "testVirtualNetwork", + "parameters": { + "skipToken": "FakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myHubVnet", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "isGlobal": "True", + "deleteExistingPeering": "True", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/groups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "provisioningState": "Succeeded" + }, + "configurationGroups": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "properties": { + "description": "A group for all test Virtual Networks", + "provisioningState": "Succeeded" + } + } + ] + } + ], + "skipToken": "FakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerEffectiveSecurityAdminRulesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerEffectiveSecurityAdminRulesList.json new file mode 100644 index 000000000000..89dbd8281646 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerEffectiveSecurityAdminRulesList.json @@ -0,0 +1,68 @@ +{ + "title": "List Azure Virtual Network Manager Effective Configuration", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "virtualNetworkName": "testVirtualNetwork", + "parameters": { + "skipToken": "FakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "configurationDescription": "SampleDescription", + "ruleCollectionDescription": "SampleRuleCollectionDescription", + "ruleCollectionAppliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1" + } + ], + "kind": "Default", + "properties": { + "description": "Sample Admin Rule", + "flag": "AllowVnetInbound", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "direction": "Inbound", + "access": "Deny", + "priority": 1, + "provisioningState": "Succeeded" + }, + "ruleGroups": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "properties": { + "description": "A group for all test Virtual Networks", + "provisioningState": "Succeeded" + } + } + ] + } + ], + "skipToken": "FakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGet.json new file mode 100644 index 000000000000..058791547acb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGet.json @@ -0,0 +1,40 @@ +{ + "title": "Get Azure Virtual Network Manager", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "name": "testNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "type": "Microsoft.Network/networkManagers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "SecurityUser" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupDelete.json new file mode 100644 index 000000000000..09aa228f4c13 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupDelete.json @@ -0,0 +1,20 @@ +{ + "title": "Delete Azure Virtual Network Manager Group", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/networkGroups/testNetworkGroup/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupGet.json new file mode 100644 index 000000000000..ec61e05a31a1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupGet.json @@ -0,0 +1,32 @@ +{ + "title": "Get Azure Virtual Network Manager Network Group", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup" + }, + "responses": { + "200": { + "body": { + "name": "testNetworkGroup", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup", + "type": "Microsoft.Network/networkManagers/networkGroups", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample group", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupList.json new file mode 100644 index 000000000000..4525c7d887d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupList.json @@ -0,0 +1,36 @@ +{ + "title": "List Azure Virtual Network Manager Network Groups", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNetworkGroup", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup", + "type": "Microsoft.Network/networkManagers/networkGroups", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample group", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupPut.json new file mode 100644 index 000000000000..dd09f6b33e81 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerGroupPut.json @@ -0,0 +1,63 @@ +{ + "title": "Create/Update Azure Virtual Network Manager Network Group", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup", + "parameters": { + "properties": { + "description": "A sample group" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "name": "testNetworkGroup", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup", + "type": "Microsoft.Network/networkManagers/networkGroups", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample group", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "name": "testNetworkGroup", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup", + "type": "Microsoft.Network/networkManagers/networkGroups", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample group", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerList.json new file mode 100644 index 000000000000..89fcdef31135 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerList.json @@ -0,0 +1,45 @@ +{ + "title": "List Azure Virtual Network Manager", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "type": "Microsoft.Network/networkManagers", + "etag": "sadf-asdf-asdf-asdf", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerListAll.json new file mode 100644 index 000000000000..5f4f4501a578 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerListAll.json @@ -0,0 +1,44 @@ +{ + "title": "List Azure Virtual Network Manager in Subscription", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "type": "Microsoft.Network/networkManagers", + "etag": "sadf-asdf-asdf-asdf", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "SecurityUser" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagers?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerPatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerPatch.json new file mode 100644 index 000000000000..a9df4a14de6a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerPatch.json @@ -0,0 +1,52 @@ +{ + "title": "Patch Managed Network Tags", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "type": "Microsoft.Network/networkManager", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000001" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerPut.json new file mode 100644 index 000000000000..2fa9ebd6100b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerPut.json @@ -0,0 +1,91 @@ +{ + "title": "Create/Update Azure Virtual Network Manager", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "parameters": { + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [ + "/Microsoft.Management/testmg" + ], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager", + "type": "Microsoft.Network/networkManagers", + "etag": "sadf-asdf-asdf-asdf", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [ + "Microsoft.Management/managementGroups/testMg" + ], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "TestNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager", + "type": "Microsoft.Network/networkManagers", + "etag": "sadf-asdf-asdf-asdf", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [ + "Microsoft.Management/managementGroups/testMg" + ], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionDelete.json new file mode 100644 index 000000000000..309486e97f98 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionDelete.json @@ -0,0 +1,15 @@ +{ + "title": "Delete Azure Virtual Network Manager Scope Connection", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "scopeConnectionName": "TestScopeConnection", + "force": false + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionGet.json new file mode 100644 index 000000000000..0344fdb817a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionGet.json @@ -0,0 +1,36 @@ +{ + "title": "Get Azure Virtual Network Manager Scope Connection", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "scopeConnectionName": "TestScopeConnection" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections/TestScopeConnection", + "type": "Microsoft.Network/networkManagers/scopeConnections", + "name": "TestScopeConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "connectionState": "Pending", + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000", + "description": "This is a scope connection to a cross tenant subscription." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionList.json new file mode 100644 index 000000000000..4835cb8c5424 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionList.json @@ -0,0 +1,40 @@ +{ + "title": "List Azure Virtual Network Manager Scope Connection", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections/TestScopeConnection", + "type": "Microsoft.Network/networkManagers/scopeConnections", + "name": "TestScopeConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "connectionState": "Pending", + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000", + "description": "This is a scope connection to a cross tenant subscription." + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections?api-version=2021-02-01-preview&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionPut.json new file mode 100644 index 000000000000..88f4eb8927b3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerScopeConnectionPut.json @@ -0,0 +1,66 @@ +{ + "title": "Create/Update Azure Virtual Network Manager Scope Connection", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "scopeConnectionName": "TestScopeConnection", + "parameters": { + "properties": { + "tenantId": "6babcaad-604b-40ac-a9d7-9fd97c0b779f", + "resourceId": "subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b", + "description": "This is a scope connection to a cross tenant subscription." + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections/TestScopeConnection", + "type": "Microsoft.Network/networkManagers/scopeConnections", + "name": "TestScopeConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "connectionState": "Pending", + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000", + "description": "This is a scope connection to a cross tenant subscription." + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections/TestScopeConnection", + "type": "Microsoft.Network/networkManagers/scopeConnections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "tenantId": "6babcaad-604b-40ac-a9d7-9fd97c0b779f", + "connectionState": "Pending", + "resourceId": "subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b", + "description": "This is a scope connection to a cross tenant subscription." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationDelete.json new file mode 100644 index 000000000000..57ca7e5b3a0e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationGet.json new file mode 100644 index 000000000000..4b7d2bf93c1c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationList.json new file mode 100644 index 000000000000..d622826b4331 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationPut.json new file mode 100644 index 000000000000..5407c56a8da3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerSecurityAdminConfigurationPut.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "securityAdminConfiguration": { + "properties": { + "description": "A sample policy", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberDelete.json new file mode 100644 index 000000000000..e0121740a18f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberDelete.json @@ -0,0 +1,15 @@ +{ + "title": "Delete Azure Virtual Network Manager Static Member", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SampleRG", + "networkManagerName": "TestNM", + "networkGroupName": "testNetworkGroup", + "staticMemberName": "testStaticMember" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberGet.json new file mode 100644 index 000000000000..ca0d744850a0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberGet.json @@ -0,0 +1,31 @@ +{ + "title": "Get Azure Virtual Network Manager Static Member", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup", + "staticMemberName": "testStaticMember" + }, + "responses": { + "200": { + "body": { + "name": "testStaticMember", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers/testStaticMember", + "type": "Microsoft.Network/networkManagers/networkGroups/staticMembers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberList.json new file mode 100644 index 000000000000..2ccc2a0039a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberList.json @@ -0,0 +1,37 @@ +{ + "title": "List Azure Virtual Network Manager Static Members", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testStaticMember", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers/testStaticMember", + "type": "Microsoft.Network/networkManagers/networkGroups/staticMembers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1", + "region": "useast2", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers?api-version=2024-01-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberPut.json new file mode 100644 index 000000000000..6d68e1696d7d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkManagerStaticMemberPut.json @@ -0,0 +1,64 @@ +{ + "title": "Create/Update Azure Virtual Network Manager Static Member", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup", + "staticMemberName": "testStaticMember", + "parameters": { + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "name": "testStaticMember", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers/testStaticMember", + "type": "Microsoft.Network/networkManagers/networkGroups/staticMembers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1", + "region": "useast2", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "name": "testStaticMember", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers/testStaticMember", + "type": "Microsoft.Network/networkManagers/networkGroups/staticMembers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1", + "region": "useast2", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileCreateConfigOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileCreateConfigOnly.json new file mode 100644 index 000000000000..5523c8d8c202 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileCreateConfigOnly.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1", + "parameters": { + "location": "westus", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfig1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + }, + "201": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfig1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileDelete.json new file mode 100644 index 000000000000..b5c729b4ede9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileGetConfigOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileGetConfigOnly.json new file mode 100644 index 000000000000..1f6af62c4854 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileGetConfigOnly.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + }, + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileGetWithContainerNic.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileGetWithContainerNic.json new file mode 100644 index 000000000000..dd73565df083 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileGetWithContainerNic.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ], + "containerNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth0" + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + }, + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ], + "containerNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth1" + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [ + { + "name": "containerGroup1_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup1" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup1_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup1" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup2_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup2" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup2_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup2" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup3_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup3" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup3_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup3" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileList.json new file mode 100644 index 000000000000..091d96a65861 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileList.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "name": "networkProfile1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile2", + "name": "networkProfile2", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileListAll.json new file mode 100644 index 000000000000..9d008e2728f0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileListAll.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "name": "networkProfile1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile2", + "name": "networkProfile2", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileUpdateTags.json new file mode 100644 index 000000000000..12fa917540c2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkProfileUpdateTags.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "test-np", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-np", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-np", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupCreate.json new file mode 100644 index 000000000000..62d13487fb15 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupCreate.json @@ -0,0 +1,235 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "flushConnection": false, + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "flushConnection": false, + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupCreateWithRule.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupCreateWithRule.json new file mode 100644 index 000000000000..a1501ffc86a7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupCreateWithRule.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "parameters": { + "properties": { + "securityRules": [ + { + "name": "rule1", + "properties": { + "protocol": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "destinationPortRange": "80", + "sourcePortRange": "*", + "priority": 130, + "direction": "Inbound" + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupDelete.json new file mode 100644 index 000000000000..43c171c8dc54 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2022-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2022-09-01" + } + }, + "204": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2022-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2022-09-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupGet.json new file mode 100644 index 000000000000..1572e2daa96d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupGet.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupList.json new file mode 100644 index 000000000000..95e6b379beb8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupList.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupListAll.json new file mode 100644 index 000000000000..0ab788c2c8a0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupListAll.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleCreate.json new file mode 100644 index 000000000000..85edb1ccc5ea --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "securityRuleParameters": { + "properties": { + "protocol": "*", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "destinationPortRange": "8080", + "sourcePortRange": "*", + "priority": 100, + "direction": "Outbound" + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleDelete.json new file mode 100644 index 000000000000..d6321ee9467b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleDelete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2022-09-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2022-09-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleGet.json new file mode 100644 index 000000000000..1dbc0d152c56 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleList.json new file mode 100644 index 000000000000..3a1a1db69699 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupRuleList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupUpdateTags.json new file mode 100644 index 000000000000..105bbd319e88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkSecurityGroupUpdateTags.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionDelete.json new file mode 100644 index 000000000000..9ede5c169a83 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "connectionName": "connection1", + "networkVirtualApplianceName": "nva1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionGet.json new file mode 100644 index 000000000000..e0f069f08da8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "connectionName": "connection1", + "networkVirtualApplianceName": "nva1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/NetworkVirtualAppliances/nva1/NetworkVirtualApplianceConnections/connection1", + "properties": { + "name": "connection1", + "asn": 64512, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "tunnelIdentifier": 0, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionList.json new file mode 100644 index 000000000000..8692d15f450c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "networkVirtualApplianceName": "nva1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/NetworkVirtualAppliances/nva1/NetworkVirtualApplianceConnections/connection1", + "properties": { + "name": "connection1", + "asn": 64512, + "tunnelIdentifier": 0, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionPut.json new file mode 100644 index 000000000000..b5bb723a16a6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceConnectionPut.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "connectionName": "connection1", + "networkVirtualApplianceName": "nva1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "NetworkVirtualApplianceConnectionParameters": { + "properties": { + "name": "connection1", + "asn": 64512, + "tunnelIdentifier": 0, + "enableInternetSecurity": false, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva1/networkVirtualApplianceConnections/connection1", + "properties": { + "name": "connection1", + "asn": 64512, + "tunnelIdentifier": 0, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva1/networkVirtualApplianceConnections/connection1", + "properties": { + "name": "connection1", + "asn": 64512, + "tunnelIdentifier": 0, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceDelete.json new file mode 100644 index 000000000000..22739ce8fd30 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceDelete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceEmptyRestart.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceEmptyRestart.json new file mode 100644 index 000000000000..e312a6c6f6cc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceEmptyRestart.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01" + }, + "body": { + "instanceIds": [] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceGet.json new file mode 100644 index 000000000000..15b93c893ad4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceGet.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "virtualApplianceConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/networkVirtualApplianceConnections/connection1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + }, + "virtualApplianceNics": [ + { + "nicType": "PublicNic", + "name": "publicnicipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig-2", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig-2", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_0" + }, + { + "nicType": "AdditionalNic", + "name": "exrsdwan", + "publicIpAddress": "4.231.25.19", + "privateIpAddress": "10.1.113.4", + "instanceName": "nva_0" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceListByResourceGroup.json new file mode 100644 index 000000000000..cccfacbff41d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceListByResourceGroup.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + }, + "virtualApplianceNics": [ + { + "nicType": "PublicNic", + "name": "publicnicipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig-2", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig-2", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_0" + }, + { + "nicType": "AdditionalNic", + "name": "exrsdwan", + "publicIpAddress": "4.231.25.19", + "privateIpAddress": "10.1.113.4", + "instanceName": "nva_0" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceListBySubscription.json new file mode 100644 index 000000000000..e4d2a4a46388 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceListBySubscription.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + }, + "virtualApplianceNics": [ + { + "nicType": "PublicNic", + "name": "publicnicipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig-2", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig-2", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_0" + }, + { + "nicType": "AdditionalNic", + "name": "exrsdwan", + "publicIpAddress": "4.231.25.19", + "privateIpAddress": "10.1.113.4", + "instanceName": "nva_0" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualAppliancePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualAppliancePut.json new file mode 100644 index 000000000000..d1b0366ec693 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualAppliancePut.json @@ -0,0 +1,332 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "West US", + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + }, + "virtualApplianceNics": [ + { + "nicType": "PublicNic", + "name": "publicnicipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig-2", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig-2", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_0" + }, + { + "nicType": "AdditionalNic", + "name": "exrsdwan", + "publicIpAddress": "4.231.25.19", + "privateIpAddress": "10.1.113.4", + "instanceName": "nva_0" + } + ] + } + } + }, + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + }, + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Updating", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSaaSPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSaaSPut.json new file mode 100644 index 000000000000..e1619bd6d081 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSaaSPut.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "delegation": { + "serviceName": "PaloAltoNetworks.Cloudngfw/firewalls" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "delegation": { + "serviceName": "PaloAltoNetworks.Cloudngfw/firewalls", + "provisioningState": "Succeeded" + }, + "deploymentType": "PartnerManaged", + "partnerManagedResource": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Lifter/firewalls/paloAltoFirewall", + "internalLoadBalancerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/trustILB", + "standardLoadBalancerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/trustSLB" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "delegation": { + "serviceName": "PaloAltoNetworks.Cloudngfw/firewalls", + "provisioningState": "Succeeded" + }, + "deploymentType": "PartnerManaged", + "partnerManagedResource": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Lifter/firewalls/paloAltoFirewall", + "internalLoadBalancerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/trustILB", + "standardLoadBalancerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/trustSLB" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteDelete.json new file mode 100644 index 000000000000..77cf3e9de0f2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteGet.json new file mode 100644 index 000000000000..96357a229df5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteList.json new file mode 100644 index 000000000000..d50707688fdf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSiteList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSitePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSitePut.json new file mode 100644 index 000000000000..1492d4fbe04b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSitePut.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "properties": { + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + }, + "201": { + "body": { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSkuGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSkuGet.json new file mode 100644 index 000000000000..19fde36473dc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSkuGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "skuName": "ciscoSdwan" + }, + "responses": { + "200": { + "body": { + "name": "ciscoSdwan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualApplianceSkus/ciscoSdwan", + "type": "Microsoft.Network/networkVirtualApplianceSkus", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "vendor": "Cisco", + "availableVersions": [ + "11.12" + ], + "availableScaleUnits": [ + { + "scaleUnit": "1", + "instanceCount": 2 + }, + { + "scaleUnit": "2", + "instanceCount": 2 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSkuList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSkuList.json new file mode 100644 index 000000000000..a5679181c50c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSkuList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ciscoSdwan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualApplianceSkus/ciscoSdwan", + "type": "Microsoft.Network/networkVirtualApplianceSkus", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "vendor": "Cisco", + "availableVersions": [ + "11.12" + ], + "availableScaleUnits": [ + { + "scaleUnit": "1", + "instanceCount": 2 + }, + { + "scaleUnit": "2", + "instanceCount": 2 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSpecificRestart.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSpecificRestart.json new file mode 100644 index 000000000000..0458d2259516 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceSpecificRestart.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "instanceIds": [ + "0", + "1" + ] + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01" + }, + "body": { + "instanceIds": [ + "0", + "1" + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceUpdateTags.json new file mode 100644 index 000000000000..c8e0bc0aca67 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkVirtualApplianceUpdateTags.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "virtualApplianceNics": [ + { + "name": "managementNic", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1" + }, + { + "name": "privateNic-1", + "privateIpAddress": "192.168.12.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherAvailableProvidersListGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherAvailableProvidersListGet.json new file mode 100644 index 000000000000..fa1d6f13eda0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherAvailableProvidersListGet.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "azureLocations": [ + "West US" + ], + "country": "United States", + "state": "washington", + "city": "seattle" + } + }, + "responses": { + "200": { + "body": { + "countries": [ + { + "countryName": "United States", + "states": [ + { + "stateName": "washington", + "cities": [ + { + "cityName": "seattle", + "providers": [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/availableProvidersList?api-version=2024-01-01" + }, + "body": { + "countries": [ + { + "countryName": "United States", + "states": [ + { + "stateName": "washington", + "cities": [ + { + "cityName": "seattle", + "providers": [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherAzureReachabilityReportGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherAzureReachabilityReportGet.json new file mode 100644 index 000000000000..d14675b91152 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherAzureReachabilityReportGet.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "providerLocation": { + "country": "United States", + "state": "washington" + }, + "providers": [ + "Frontier Communications of America, Inc. - ASN 5650" + ], + "azureLocations": [ + "West US" + ], + "startTime": "2017-09-07T00:00:00Z", + "endTime": "2017-09-10T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "aggregationLevel": "State", + "providerLocation": { + "country": "United States", + "state": "washington" + }, + "reachabilityReport": [ + { + "provider": "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/azureReachabilityReport?api-version=2024-01-01" + }, + "body": { + "aggregationLevel": "State", + "providerLocation": { + "country": "United States", + "state": "washington" + }, + "reachabilityReport": [ + { + "provider": "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorCreate.json new file mode 100644 index 000000000000..827e779bac84 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorCreate.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "parameters": { + "location": "eastus", + "properties": { + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "provisioningState": "Updating", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json new file mode 100644 index 000000000000..e8cd6a3b867e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "location": "centraluseuap", + "parameters": { + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/9cece3e3-0f7d-47ca-af0e-9772773f90b7/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/TESTVM", + "type": "AzureVM" + }, + { + "name": "bing", + "address": "bing.com", + "type": "ExternalAddress" + }, + { + "name": "google", + "address": "google.com", + "type": "ExternalAddress" + }, + { + "name": "ArcBasedNetwork", + "type": "AzureArcNetwork", + "subscriptionId": "9cece3e3-0f7d-47ca-af0e-9772773f90b7", + "locationDetails": { + "region": "eastus" + }, + "scope": { + "include": [ + { + "address": "172.21.128.0/20" + } + ] + } + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "ArcBasedNetwork" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/9cece3e3-0f7d-47ca-af0e-9772773f90b7/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/TESTVM" + }, + { + "name": "ArcBasedNetwork", + "type": "AzureArcNetwork", + "subscriptionId": "9cece3e3-0f7d-47ca-af0e-9772773f90b7", + "locationDetails": { + "region": "eastus" + }, + "scope": { + "include": [ + { + "address": "172.21.128.0/20" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "ArcBasedNetwork" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/9cece3e3-0f7d-47ca-af0e-9772773f90b7/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/TESTVM" + }, + { + "name": "ArcBasedNetwork", + "type": "AzureArcNetwork", + "subscriptionId": "9cece3e3-0f7d-47ca-af0e-9772773f90b7", + "locationDetails": { + "region": "eastus" + }, + "scope": { + "include": [ + { + "address": "172.21.128.0/20" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "ArcBasedNetwork" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorDelete.json new file mode 100644 index 000000000000..e5d6c5e0ef7d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorGet.json new file mode 100644 index 000000000000..2a89d525f99b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorList.json new file mode 100644 index 000000000000..78c355ae98c2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorList.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + }, + { + "name": "cm2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct2" + }, + { + "name": "destination", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorQuery.json new file mode 100644 index 000000000000..2c397ab67037 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorQuery.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": { + "body": { + "sourceStatus": "Active", + "states": [ + { + "connectionState": "Reachable", + "startTime": "2018-01-08T03:42:33.3387305Z", + "endTime": "2018-01-08T05:12:41.5265438Z", + "evaluationState": "Completed", + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1/query?api-version=2024-01-01" + }, + "body": { + "sourceStatus": "Active", + "states": [ + { + "connectionState": "Reachable", + "startTime": "2018-01-08T03:42:33.3387305Z", + "endTime": "2018-01-08T05:12:41.5265438Z", + "evaluationState": "Completed", + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorStart.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorStart.json new file mode 100644 index 000000000000..4021703dae63 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorStart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorStop.json new file mode 100644 index 000000000000..4021703dae63 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorStop.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json new file mode 100644 index 000000000000..8adbfe46798e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/`/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "startTime": "2019-09-04T02:48:10.6797393Z", + "monitoringStatus": "Running" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/networkWatchers/connectionMonitors", + "location": "westcentralus" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorV2Create.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorV2Create.json new file mode 100644 index 000000000000..e1de24f23c06 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectionMonitorV2Create.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "location": "centraluseuap", + "parameters": { + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1" + }, + { + "name": "CanaryWorkspaceVamshi", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace", + "filter": { + "type": "Include", + "items": [ + { + "type": "AgentAddress", + "address": "npmuser" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "CanaryWorkspaceVamshi" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1" + }, + { + "name": "CanaryWorkspaceVamshi", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace", + "filter": { + "type": "Include", + "items": [ + { + "type": "AgentAddress", + "address": "npmuser" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "CanaryWorkspaceVamshi" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1" + }, + { + "name": "CanaryWorkspaceVamshi", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace", + "filter": { + "type": "Include", + "items": [ + { + "type": "AgentAddress", + "address": "npmuser" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "CanaryWorkspaceVamshi" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectivityCheck.json new file mode 100644 index 000000000000..ecd9e68e5895 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherConnectivityCheck.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "destination": { + "address": "192.168.100.4", + "port": 3389 + }, + "preferredIPVersion": "IPv4" + } + }, + "responses": { + "200": { + "body": { + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ], + "connectionStatus": "Connected", + "avgLatencyInMs": 1, + "minLatencyInMs": 1, + "maxLatencyInMs": 4, + "probesSent": 100, + "probesFailed": 0 + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectivityCheck?api-version=2024-01-01" + }, + "body": { + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ], + "connectionStatus": "Connected", + "avgLatencyInMs": 1, + "minLatencyInMs": 1, + "maxLatencyInMs": 4, + "probesSent": 100, + "probesFailed": 0 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherCreate.json new file mode 100644 index 000000000000..7c8ca143c7a5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherDelete.json new file mode 100644 index 000000000000..00078411cfce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogConfigure.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogConfigure.json new file mode 100644 index 000000000000..493deb5a9098 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogConfigure.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/configureFlowLog?api-version=2024-01-01" + }, + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogCreate.json new file mode 100644 index 000000000000..3cb4d6117834 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogCreate.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "flowLogName": "fl", + "parameters": { + "location": "centraluseuap", + "properties": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabled": true, + "format": { + "type": "JSON", + "version": 1 + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Updating", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 1 + } + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + }, + "location": "centraluseuap" + } + }, + "201": { + "body": { + "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 1 + } + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + }, + "location": "centraluseuap" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogDelete.json new file mode 100644 index 000000000000..45fd16cce39f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "flowLogName": "fl" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogGet.json new file mode 100644 index 000000000000..bc17a3db436d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "flowLogName": "flowLog1" + }, + "responses": { + "200": { + "body": { + "name": "flowLog1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002", + "enabled": true, + "flowAnalyticsConfiguration": { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": false, + "workspaceId": "-", + "workspaceRegion": "-", + "trafficAnalyticsInterval": 60 + } + }, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 2 + } + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogList.json new file mode 100644 index 000000000000..7332ba65e763 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogList.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "flowLog1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002", + "enabled": true, + "flowAnalyticsConfiguration": { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": false, + "workspaceId": "-", + "workspaceRegion": "-", + "trafficAnalyticsInterval": 60 + } + }, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 2 + } + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + }, + { + "name": "flowLog2", + "id": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_centraluseuap/FlowLogs/flowLog2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/DSCP-test-vm1-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/iraflowlogtest2diag", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 2 + } + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "location": "centraluseuap", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogStatusQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogStatusQuery.json new file mode 100644 index 000000000000..31e80cb149da --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogStatusQuery.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + } + }, + "responses": { + "200": { + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryFlowLogStatus?api-version=2024-01-01" + }, + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogUpdateTags.json new file mode 100644 index 000000000000..38a9555a0275 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherFlowLogUpdateTags.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw", + "flowLogName": "fl", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 1 + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "location": "centralus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherGet.json new file mode 100644 index 000000000000..267aa66e7e32 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherIpFlowVerify.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherIpFlowVerify.json new file mode 100644 index 000000000000..8ad8c4800034 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherIpFlowVerify.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "direction": "Outbound", + "protocol": "TCP", + "localPort": "80", + "remotePort": "80", + "localIPAddress": "10.2.0.4", + "remoteIPAddress": "121.10.1.1" + } + }, + "responses": { + "200": { + "body": { + "access": "Allow", + "ruleName": "Rule1" + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/ipFlowVerify?api-version=2024-01-01" + }, + "body": { + "access": "Allow", + "ruleName": "Rule1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherList.json new file mode 100644 index 000000000000..1023788941e8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherListAll.json new file mode 100644 index 000000000000..06daec5b35a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json new file mode 100644 index 000000000000..962ce5a7a6ca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "profiles": [ + { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + } + ] + } + }, + "responses": { + "200": { + "body": { + "results": [ + { + "profile": { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + }, + "networkSecurityGroupResult": { + "securityRuleAccessResult": "Allow", + "evaluatedNetworkSecurityGroups": [ + { + "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_Cleanuptool-Allow-100", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-101", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-102", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Deny-103", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + }, + { + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + } + ] + } + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/networkConfigurationDiagnostic?api-version=2024-01-01" + }, + "body": { + "results": [ + { + "profile": { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + }, + "networkSecurityGroupResult": { + "securityRuleAccessResult": "Allow", + "evaluatedNetworkSecurityGroups": [ + { + "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_Cleanuptool-Allow-100", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-101", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-102", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Deny-103", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + }, + { + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherNextHopGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherNextHopGet.json new file mode 100644 index 000000000000..b1754af32b15 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherNextHopGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "sourceIPAddress": "10.0.0.5", + "destinationIPAddress": "10.0.0.10", + "targetNicResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "responses": { + "200": { + "body": { + "nextHopType": "VnetLocal", + "nextHopIpAddress": "10.0.0.1", + "routeTableId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/nextHop?api-version=2024-01-01" + }, + "body": { + "nextHopType": "VnetLocal", + "nextHopIpAddress": "10.0.0.1", + "routeTableId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureCreate.json new file mode 100644 index 000000000000..02d443251d99 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1", + "parameters": { + "properties": { + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "properties": { + "provisioningState": "Updating", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureDelete.json new file mode 100644 index 000000000000..fd3de8ef06bc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureGet.json new file mode 100644 index 000000000000..e65f50a4fe88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "200": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Updating", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureQueryStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureQueryStatus.json new file mode 100644 index 000000000000..70fc30427181 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureQueryStatus.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "200": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime": "2016-09-07T12:35:24Z", + "packetCaptureStatus": "Stopped", + "stopReason": "TimeExceeded", + "packetCaptureError": [] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/troubleshoot?api-version=2024-01-01" + }, + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime": "2016-09-07T12:35:24Z", + "packetCaptureStatus": "Stopped", + "stopReason": "TimeExceeded", + "packetCaptureError": [] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureStop.json new file mode 100644 index 000000000000..3ffec9976436 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCaptureStop.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCapturesList.json new file mode 100644 index 000000000000..91e691b5af92 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherPacketCapturesList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Updating", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + }, + { + "name": "pc2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", + "filePath": "D:\\capture\\pc2.cap" + }, + "filters": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherSecurityGroupViewGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherSecurityGroupViewGet.json new file mode 100644 index 000000000000..63026f4c160b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherSecurityGroupViewGet.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses": { + "200": { + "body": { + "networkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations": { + "subnetAssociation": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules": [ + { + "name": "fe_rule", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow Frontend", + "protocol": "Tcp", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "10.1.0.0/24", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 100, + "direction": "Inbound" + } + } + ] + }, + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + } + ], + "effectiveSecurityRules": [ + { + "name": "DefaultOutboundDenyAll", + "protocol": "All", + "sourcePortRange": "0-65535", + "destinationPortRange": "0-65535", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + ] + } + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryStatus?api-version=2024-01-01" + }, + "body": { + "networkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations": { + "subnetAssociation": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules": [ + { + "name": "fe_rule", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow Frontend", + "protocol": "Tcp", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "10.1.0.0/24", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 100, + "direction": "Inbound" + } + } + ] + }, + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + } + ], + "effectiveSecurityRules": [ + { + "name": "DefaultOutboundDenyAll", + "protocol": "All", + "sourcePortRange": "0-65535", + "destinationPortRange": "0-65535", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTopologyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTopologyGet.json new file mode 100644 index 000000000000..2b7ab2b9e39f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTopologyGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceGroupName": "rg2" + } + }, + "responses": { + "200": { + "body": { + "id": "ce592f46-8164-4bf2-ad36-b8e4acf6fb68", + "createdDateTime": "2017-08-02T19:31:55.9461781Z", + "lastModified": "2017-05-27T00:00:13.2005337Z", + "resources": [ + { + "name": "MultiTierApp0", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/MultiTierApp0", + "location": "westus", + "associations": [ + { + "name": "appNic0", + "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic0", + "associationType": "Contains" + }, + { + "name": "appNic10", + "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic10", + "associationType": "Contains" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTroubleshootGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTroubleshootGet.json new file mode 100644 index 000000000000..8f3a2d228f4f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTroubleshootGet.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "storagePath": "https://st1.blob.core.windows.net/cn1" + } + } + }, + "responses": { + "200": { + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/troubleshoot?api-version=2024-01-01" + }, + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTroubleshootResultQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTroubleshootResultQuery.json new file mode 100644 index 000000000000..d0145bd9367a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherTroubleshootResultQuery.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses": { + "200": { + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryTroubleshootResult?api-version=2024-01-01" + }, + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherUpdateTags.json new file mode 100644 index 000000000000..449d5a754c0c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/OperationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/OperationList.json new file mode 100644 index 000000000000..fa1d39ec9516 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/OperationList.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Network/localnetworkgateways/read", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Get LocalNetworkGateway", + "description": "Gets LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/write", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Create or update LocalNetworkGateway", + "description": "Creates or updates an existing LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/delete", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Delete LocalNetworkGateway", + "description": "Deletes LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/networkInterfaces/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Interface metric definition", + "operation": "Read Network Interface metric definitions", + "description": "Gets available metrics for the Network Interface" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BytesSentRate", + "displayName": "Bytes Sent", + "displayDescription": "Number of bytes the Network Interface sent", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + }, + { + "name": "BytesReceivedRate", + "displayName": "Bytes Received", + "displayDescription": "Number of bytes the Network Interface received", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + } + ] + } + } + }, + { + "name": "Microsoft.Network/networksecuritygroups/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Security Groups Log Definitions", + "operation": "Get Network Security Group Event Log Definitions", + "description": "Gets the events for network security group" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "NetworkSecurityGroupEvent", + "displayName": "Network Security Group Event", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupRuleCounter", + "displayName": "Network Security Group Rule Counter", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupFlowEvent", + "displayName": "Network Security Group Rule Flow Event", + "blobDuration": "PT1H" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayDelete.json new file mode 100644 index 000000000000..beefb8a034ea --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGenerateVpnProfile.json new file mode 100644 index 000000000000..64e2dd6f9fae --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGenerateVpnProfile.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "p2sVpnGateway1", + "parameters": { + "authenticationMethod": "EAPTLS" + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "profileUrl": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGet.json new file mode 100644 index 000000000000..27f1026c00a7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGet.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGetConnectionHealth.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGetConnectionHealth.json new file mode 100644 index 000000000000..571cd6e0522a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGetConnectionHealth.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json new file mode 100644 index 000000000000..133330f6c22a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "p2s-vpn-gateway-test", + "gatewayName": "p2svpngateway", + "api-version": "2024-01-01", + "request": { + "vpnUserNamesFilter": [ + "vpnUser1", + "vpnUser2" + ], + "outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/p2sconnectionhealths?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b" + } + }, + "responses": { + "200": { + "body": { + "sasUrl": "aaaaaaaaaaaaaaaaaa" + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayList.json new file mode 100644 index 000000000000..98ff5483641d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayList.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": true + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + }, + { + "name": "p2sVpnGateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.4.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": true + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "4.4.4.4" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayListByResourceGroup.json new file mode 100644 index 000000000000..3df93c4b252e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayListByResourceGroup.json @@ -0,0 +1,199 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + }, + { + "name": "p2sVpnGateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "4.4.4.4" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayPut.json new file mode 100644 index 000000000000..ab18f0076d7b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayPut.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "p2SVpnGatewayParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "1.1.1.1", + "2.2.2.2" + ], + "isRoutingPreferenceInternet": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "1.1.1.1", + "2.2.2.2" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + }, + "isRoutingPreferenceInternet": false + } + } + }, + "201": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "1.1.1.1", + "2.2.2.2" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + }, + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayReset.json new file mode 100644 index 000000000000..06d1647b2182 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayReset.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayUpdateTags.json new file mode 100644 index 000000000000..aac1a69aaf8e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2SVpnGatewayUpdateTags.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "p2SVpnGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json new file mode 100644 index 000000000000..2d1dbff2ed4f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "p2s-vpn-gateway-test", + "p2sVpnGatewayName": "p2svpngateway", + "api-version": "2024-01-01", + "request": { + "vpnConnectionIds": [ + "vpnconnId1", + "vpnconnId2" + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PeerExpressRouteCircuitConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PeerExpressRouteCircuitConnectionGet.json new file mode 100644 index 000000000000..4172a7c5e36e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PeerExpressRouteCircuitConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "connectionName": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "name": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/60aee347-e889-4a42-8c1b-0aae8b1e4013", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitB/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionWestusEastus", + "authResourceGuid": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PeerExpressRouteCircuitConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PeerExpressRouteCircuitConnectionList.json new file mode 100644 index 000000000000..43f370f277dd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PeerExpressRouteCircuitConnectionList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/60aee347-e889-4a42-8c1b-0aae8b1e4013", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitB/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionWestusEastus", + "authResourceGuid": "" + } + }, + { + "name": "c8b17193-8dd3-4f61-866d-8cdd2e2e268e", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/c8b17193-8dd3-4f61-866d-8cdd2e2e268e", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitC/peerings/AzurePrivatePeering" + }, + "addressPrefix": "30.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionCentralusEastus", + "authResourceGuid": "64283012-d377-421d-8398-f6aeb2ac7ea0" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreate.json new file mode 100644 index 000000000000..282e1f001ec5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreate.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "extendedLocation": { + "type": "EdgeZone", + "name": "edgeZone0" + }, + "parameters": { + "location": "eastus2euap", + "properties": { + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection." + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.6" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.6" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + }, + "201": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.6" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreateForManualApproval.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreateForManualApproval.json new file mode 100644 index 000000000000..cf564205ed73 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreateForManualApproval.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "parameters": { + "location": "eastus", + "properties": { + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection." + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.5" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.5" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + }, + "201": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.5" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreateWithASG.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreateWithASG.json new file mode 100644 index 000000000000..c3da6185c4e6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointCreateWithASG.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "extendedLocation": { + "type": "EdgeZone", + "name": "edgeZone0" + }, + "parameters": { + "location": "eastus2euap", + "properties": { + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection." + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "applicationSecurityGroups": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1" + } + ] + } + } + }, + "201": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDelete.json new file mode 100644 index 000000000000..3ca2d6508881 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupCreate.json new file mode 100644 index 000000000000..738d9b32b151 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupCreate.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "privateDnsZoneGroupName": "testPdnsgroup", + "parameters": { + "properties": { + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPdnsgroup", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testPdnsgroup", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupDelete.json new file mode 100644 index 000000000000..bcc9ef6fa721 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "privateDnsZoneGroupName": "testPdnsgroup" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupGet.json new file mode 100644 index 000000000000..cd9a7566f941 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupGet.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "privateDnsZoneGroupName": "testPdnsgroup" + }, + "responses": { + "200": { + "body": { + "name": "testPdnsgroup", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + }, + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone2.com", + "ipAddresses": [ + "10.0.0.6" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone2.com", + "ipAddresses": [ + "10.0.0.7" + ] + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupList.json new file mode 100644 index 000000000000..ba3f28f73f66 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointDnsZoneGroupList.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPdnsgroup1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup1", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + } + ] + } + }, + { + "name": "testPdnsgroup2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup2", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc3", + "fqdn": "abc3.zone2.com", + "ipAddresses": [ + "10.0.0.6" + ] + }, + { + "recordType": "A", + "recordSetName": "abc4", + "fqdn": "abc4.zone2.com", + "ipAddresses": [ + "10.0.0.7" + ] + } + ] + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGet.json new file mode 100644 index 000000000000..72ac9e936541 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGet.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.6" + } + }, + { + "name": "pestaticconfig2", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.7" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGetForManualApproval.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGetForManualApproval.json new file mode 100644 index 000000000000..aa604e1f971f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGetForManualApproval.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.5" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGetWithASG.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGetWithASG.json new file mode 100644 index 000000000000..d8348d1549b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointGetWithASG.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointList.json new file mode 100644 index 000000000000..a84d1fec2816 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointList.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1", + "name": "pe1", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection for pe1.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/pe1.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.10" + } + }, + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.11" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe2", + "name": "pe2", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection for pe2.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet2" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/pe2.nic.zyxw9876" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc3.cosmos1.com", + "ipAddresses": [ + "192.168.0.6" + ] + }, + { + "fqdn": "abc4.cosmos1.com", + "ipAddresses": [ + "192.168.0.7" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig3", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.8" + } + }, + { + "name": "pestaticconfig4", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.9" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointListAll.json new file mode 100644 index 000000000000..abcb4229b7d5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateEndpointListAll.json @@ -0,0 +1,216 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1", + "name": "pe1", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection for pe1.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/pe1.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig1", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.9" + } + }, + { + "name": "pestaticconfig2", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.10" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2", + "name": "pe2", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection for pe2.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet2" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/pe2.nic.zyxw9876" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc3.cosmos1.com", + "ipAddresses": [ + "192.168.0.5" + ] + }, + { + "fqdn": "abc4.cosmos1.com", + "ipAddresses": [ + "192.168.0.6" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig3", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.11" + } + }, + { + "name": "pestaticconfig4", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.12" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/privateEndpoints/pe3", + "name": "pe3", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/privateLinkServices/testPls3", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection for pe3.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet3" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg3/provders/Microsoft.Network/networkInterfaces/pe3.nic.efgh5463" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc5.cosmos2.com", + "ipAddresses": [ + "192.168.0.7" + ] + }, + { + "fqdn": "abc6.cosmos2.com", + "ipAddresses": [ + "192.168.0.8" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig5", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.13" + } + }, + { + "name": "pestaticconfig6", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.14" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceCreate.json new file mode 100644 index 000000000000..375ba16d45ea --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceCreate.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "extendedLocation": { + "type": "EdgeZone", + "name": "edgeZone0" + }, + "parameters": { + "location": "eastus", + "properties": { + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPls", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls.nic.abcd1234" + } + ] + } + } + }, + "201": { + "body": { + "name": "testPls", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceDelete.json new file mode 100644 index 000000000000..3f1ded81f475 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..1dbc8dc8f5f0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "peConnectionName": "testPlePeConnection" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceGet.json new file mode 100644 index 000000000000..472caaaa9c8a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceGet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls" + }, + "responses": { + "200": { + "body": { + "name": "testPls", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "privateEndpointConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..6509bf3b96e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "peConnectionName": "testPlePeConnection" + }, + "responses": { + "200": { + "body": { + "name": "testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceList.json new file mode 100644 index 000000000000..86349373ee77 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceList.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPls1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb1" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb1", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb1" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls1.nic.abcd1234" + } + ] + } + }, + { + "name": "testPls2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb2" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb2", + "properties": { + "privateIPAddress": "10.0.1.5", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb2" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec2", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls2.nic.efgh5678" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceListAll.json new file mode 100644 index 000000000000..add9c1b18159 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceListAll.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPls1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb1" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb1", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb1" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls1.nic.abcd1234" + } + ] + } + }, + { + "name": "testPls2", + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/testPls2", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb2" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb2", + "properties": { + "privateIPAddress": "10.0.1.5", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb2" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testPe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/testPls2.nic.efgh5678" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json new file mode 100644 index 000000000000..94fa2dbfa40a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPlePeConnection1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + }, + { + "name": "testPlePeConnection2", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe2" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "rejected by some reason." + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json new file mode 100644 index 000000000000..304b61420748 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "peConnectionName": "testPlePeConnection", + "parameters": { + "name": "testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateCustomizedValues.json new file mode 100644 index 000000000000..f913554d9c73 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateCustomizedValues.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "zones": [ + "1" + ], + "parameters": { + "properties": { + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "publicIPAddressVersion": "IPv4" + }, + "sku": { + "name": "Standard", + "tier": "Global" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "sku": { + "name": "Standard", + "tier": "Global" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "sku": { + "name": "Standard", + "tier": "Global" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDefaults.json new file mode 100644 index 000000000000..5923aa3fd84b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDefaults.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDns.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDns.json new file mode 100644 index 000000000000..810ffcb6dc0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDns.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "properties": { + "dnsSettings": { + "domainNameLabel": "dnslbl" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "fqdn": "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "fqdn": "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json new file mode 100644 index 000000000000..9e0174f80b0b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "properties": { + "dnsSettings": { + "domainNameLabel": "dnslbl", + "domainNameLabelScope": "TenantReuse" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "domainNameLabelScope": "TenantReuse", + "fqdn": "dnslbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "domainNameLabelScope": "TenantReuse", + "fqdn": "dnslbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressDelete.json new file mode 100644 index 000000000000..ff3ce6c7d650 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/locations/tempLocation/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressGet.json new file mode 100644 index 000000000000..5e754e23fe19 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "testDNS-ip" + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "Enabled", + "ddosProtectionPlan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan" + } + }, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + }, + { + "ipTagType": "FirstPartyUsage", + "tag": "Storage" + } + ] + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressGetDdosProtectionStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressGetDdosProtectionStatus.json new file mode 100644 index 000000000000..d140ef51ea37 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressGetDdosProtectionStatus.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-pip" + }, + "responses": { + "200": { + "body": { + "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip", + "publicIpAddress": "10.0.1.5", + "isWorkloadProtected": "True", + "ddosProtectionPlanId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/locations/tempLocation/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressList.json new file mode 100644 index 000000000000..1b9dbd5aebce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + }, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + }, + { + "ipTagType": "FirstPartyUsage", + "tag": "Storage" + } + ] + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/ip03", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.247", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "fqdn": "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip04", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/ip04", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.248", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "domainNameLabelScope": "TenantReuse", + "fqdn": "testlbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressListAll.json new file mode 100644 index 000000000000..6eb4f52ca65d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressListAll.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip01", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/ip01", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.247", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "fqdn": "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip02", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/ip02", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.248", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "domainNameLabelScope": "TenantReuse", + "fqdn": "testlbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressUpdateTags.json new file mode 100644 index 000000000000..73d048574754 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpAddressUpdateTags.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixCreateCustomizedValues.json new file mode 100644 index 000000000000..6471d352f3e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixCreateCustomizedValues.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "zones": [ + "1" + ], + "parameters": { + "location": "westus", + "properties": { + "publicIPAddressVersion": "IPv4", + "prefixLength": 30 + }, + "sku": { + "name": "Standard", + "tier": "Regional" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard", + "tier": "Regional" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + }, + "201": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard", + "tier": "Regional" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixCreateDefaults.json new file mode 100644 index 000000000000..a3609fea90cf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixCreateDefaults.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": { + "location": "westus", + "properties": { + "prefixLength": 30 + }, + "sku": { + "name": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + }, + "201": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixDelete.json new file mode 100644 index 000000000000..262c09b61662 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixGet.json new file mode 100644 index 000000000000..15c1301bc144 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [], + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixList.json new file mode 100644 index 000000000000..a29066619b16 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "40.85.154.2/30", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + }, + { + "name": "ipprefix03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/ipprefix03", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 31, + "ipPrefix": "40.85.153.2/31", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixListAll.json new file mode 100644 index 000000000000..001b9a82a6f9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixListAll.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "41.85.154.247/30", + "ipTags": [], + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + }, + { + "name": "ipprefix01", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/ipprefix01", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "ipPrefix": "40.85.154.247/30", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + }, + { + "name": "pfx", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/publicIPPrefixes/pfx", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/publicIPPrefixes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "ipPrefix": "25.101.84.16/30", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipTags": [], + "loadBalancerFrontendIpConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/loadBalancers/lb-pfx/frontendIPConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixUpdateTags.json new file mode 100644 index 000000000000..6360917e76dc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/PublicIpPrefixUpdateTags.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "ipPrefix": "40.85.154.247/30", + "prefixLength": 30, + "ipTags": [] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/QueryInboundNatRulePortMapping.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/QueryInboundNatRulePortMapping.json new file mode 100644 index 000000000000..225efe53bbd6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/QueryInboundNatRulePortMapping.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "groupName": "rg1", + "loadBalancerName": "lb1", + "backendPoolName": "bp1", + "parameters": { + "ipAddress": "10.0.0.4" + } + }, + "responses": { + "200": { + "body": { + "inboundNatRulePortMappings": [ + { + "inboundNatRuleName": "natRule", + "protocol": "Tcp", + "frontendPort": 3389, + "backendPort": 3389 + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bp1/queryInboundNatRulePortMapping?api-version=2024-01-01" + }, + "body": { + "inboundNatRulePortMappings": [ + { + "inboundNatRuleName": "natRule", + "protocol": "Tcp", + "frontendPort": 3389, + "backendPort": 3389 + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterCreate.json new file mode 100644 index 000000000000..423a9fff6031 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterCreate.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "routeFilterParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "rules": [ + { + "name": "ruleName", + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterDelete.json new file mode 100644 index 000000000000..f937aa3a8625 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterGet.json new file mode 100644 index 000000000000..3f84d54d488d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterList.json new file mode 100644 index 000000000000..1c70ad40aec2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterListByResourceGroup.json new file mode 100644 index 000000000000..2af1f3e30673 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleCreate.json new file mode 100644 index 000000000000..373e4130f6d4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "routeFilterRuleParameters": { + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleDelete.json new file mode 100644 index 000000000000..4cc4dae1b8af --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleGet.json new file mode 100644 index 000000000000..096d67c01a6d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "ruleName": "filterName", + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleListByRouteFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleListByRouteFilter.json new file mode 100644 index 000000000000..bf39959c1c80 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleListByRouteFilter.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "routeFilterName": "filterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterUpdateTags.json new file mode 100644 index 000000000000..f994c245c94e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterUpdateTags.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapDelete.json new file mode 100644 index 000000000000..964f5ff02df5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "routeMapName": "routeMap1", + "api-version": "2024-01-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapGet.json new file mode 100644 index 000000000000..da1ff22d97de --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "routeMapName": "routeMap1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "name": "routeMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1", + "etag": "W/\"e203e953-7ba7-4302-a246-aa2ec03f6edf\"", + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + }, + "type": "Microsoft.Network/virtualHubs/routeMaps" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapList.json new file mode 100644 index 000000000000..5882831f2248 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "routeMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1", + "etag": "W/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + }, + "type": "Microsoft.Network/virtualHubs/routeMaps" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapPut.json new file mode 100644 index 000000000000..1a7656bffa23 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteMapPut.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "routeMapName": "routeMap1", + "api-version": "2024-01-01", + "routeMapParameters": { + "properties": { + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "routeMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1", + "etag": "W/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + }, + "type": "Microsoft.Network/virtualHubs/routeMaps" + } + }, + "201": { + "body": { + "name": "routeMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1", + "etag": "W/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + }, + "type": "Microsoft.Network/virtualHubs/routeMaps" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableCreate.json new file mode 100644 index 000000000000..200fd8ff2b27 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [], + "disableBgpRoutePropagation": true + } + } + }, + "201": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableCreateWithRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableCreateWithRoute.json new file mode 100644 index 000000000000..8f75b271dbb9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableCreateWithRoute.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "parameters": { + "properties": { + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableDelete.json new file mode 100644 index 000000000000..fd174bbed676 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableGet.json new file mode 100644 index 000000000000..f9b808cf9415 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt" + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": false, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableList.json new file mode 100644 index 000000000000..2b9da2d33edc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt2", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "disableBgpRoutePropagation": true, + "provisioningState": "Succeeded", + "routes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableListAll.json new file mode 100644 index 000000000000..461c81529dd0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableListAll.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/testrt3", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteCreate.json new file mode 100644 index 000000000000..d04af17f14c2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "routeName": "route1", + "routeParameters": { + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "201": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteDelete.json new file mode 100644 index 000000000000..089f93305a0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "routeName": "route1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteGet.json new file mode 100644 index 000000000000..a841514980a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "routeName": "route1" + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteList.json new file mode 100644 index 000000000000..21cc82beda5b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableRouteList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + }, + { + "name": "route2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route2", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.2.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableUpdateTags.json new file mode 100644 index 000000000000..873c49a9c026 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteTableUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "routes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentDelete.json new file mode 100644 index 000000000000..9703569153d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "routingIntentName": "Intent1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentGet.json new file mode 100644 index 000000000000..63f45808e688 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "routingIntentName": "Intent1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": { + "body": { + "name": "Intent1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routingIntent/Intent1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + }, + "type": "Microsoft.Network/virtualHubs/routingIntent" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentList.json new file mode 100644 index 000000000000..0014e5a5c80b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Intent1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routingIntent/Intent1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + }, + "type": "Microsoft.Network/virtualHubs/routingIntent" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentPut.json new file mode 100644 index 000000000000..ec637ed8572e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RoutingIntentPut.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "routingIntentName": "Intent1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1", + "routingIntentParameters": { + "properties": { + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "Intent1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routingIntent/Intent1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + }, + "type": "Microsoft.Network/virtualHubs/routingIntent" + } + }, + "201": { + "body": { + "name": "Intent1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routingIntent/Intent1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + }, + "type": "Microsoft.Network/virtualHubs/routingIntent" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderDelete.json new file mode 100644 index 000000000000..9bdef47107a1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderGet.json new file mode 100644 index 000000000000..e15b444f31a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider" + }, + "responses": { + "200": { + "body": { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "connectionStatus": "Unknown", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderListByResourceGroup.json new file mode 100644 index 000000000000..2237a224b4f6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderListByResourceGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "connectionStatus": "Unknown", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderListBySubscription.json new file mode 100644 index 000000000000..b788a5bcb14a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderListBySubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "connectionStatus": "Unknown", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderPut.json new file mode 100644 index 000000000000..8863f840790b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderPut.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "securityProviderName": "ZScaler", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + }, + "201": { + "body": { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderUpdateTags.json new file mode 100644 index 000000000000..57033edd285a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SecurityPartnerProviderUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "fw1", + "id": "/subscriptions/subid/resourceGroups/azfwtest/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceCommunityList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceCommunityList.json new file mode 100644 index 000000000000..c856bc70d71f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceCommunityList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/skype", + "name": "skype", + "type": "Microsoft.Network/bgpServiceCommunities", + "properties": { + "serviceName": "skype", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Skype For Business Online", + "communityValue": "12076:5030", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup": "O365" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/exchange", + "name": "exchange", + "type": "Microsoft.Network/bgpServiceCommunities", + "properties": { + "serviceName": "exchange", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Exchange Online", + "communityValue": "12076:5040", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup": "O365" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyCreate.json new file mode 100644 index 000000000000..71847d079bf2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyCreate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyCreateWithDefinition.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyCreateWithDefinition.json new file mode 100644 index 000000000000..242a8a91e5bb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyCreateWithDefinition.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "parameters": { + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionCreate.json new file mode 100644 index 000000000000..4c835076037d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionCreate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition", + "ServiceEndpointPolicyDefinitions": { + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testDefinition", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionDelete.json new file mode 100644 index 000000000000..b85fbe922720 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionGet.json new file mode 100644 index 000000000000..57dcb932a731 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition" + }, + "responses": { + "200": { + "body": { + "name": "testDefinition", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionList.json new file mode 100644 index 000000000000..42b4f345c5dc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDefinitionList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDef", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDef", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDelete.json new file mode 100644 index 000000000000..7857a7d418fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "serviceEndpointPolicy1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyGet.json new file mode 100644 index 000000000000..22e60b9cac76 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testServiceEndpointPolicy" + }, + "responses": { + "200": { + "body": { + "name": "testServiceEndpointPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyList.json new file mode 100644 index 000000000000..49d43b56510f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyList.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testServiceEndpointPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + }, + { + "name": "testServiceEndpointPolicy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy1", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyListAll.json new file mode 100644 index 000000000000..4ca5f69ee46e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyListAll.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + }, + { + "name": "testPolicy1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy2", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition2", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyUpdateTags.json new file mode 100644 index 000000000000..c5b848047634 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceEndpointPolicyUpdateTags.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testServiceEndpointPolicy", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testServiceEndpointPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResult.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResult.json new file mode 100644 index 000000000000..6cdb0af56782 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResult.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "westeurope", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ApiManagement", + "id": "ApiManagement", + "properties": { + "changeNumber": "7", + "region": "", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + }, + { + "name": "ApiManagement.AustraliaCentral", + "id": "ApiManagement.AustraliaCentral", + "properties": { + "changeNumber": "2", + "region": "australiacentral", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "20.36.106.68/31", + "20.36.107.176/28" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResultWithNoAddressPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResultWithNoAddressPrefixes.json new file mode 100644 index 000000000000..b6e0f42fcc4c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResultWithNoAddressPrefixes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "westeurope", + "subscriptionId": "subid", + "noAddressPrefixes": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ApiManagement", + "id": "ApiManagement", + "properties": { + "changeNumber": "7", + "region": "", + "systemService": "AzureApiManagement", + "addressPrefixes": [] + } + }, + { + "name": "ApiManagement.AustraliaCentral", + "id": "ApiManagement.AustraliaCentral", + "properties": { + "changeNumber": "2", + "region": "australiacentral", + "systemService": "AzureApiManagement", + "addressPrefixes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResultWithTagname.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResultWithTagname.json new file mode 100644 index 000000000000..9563db3881d2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagInformationListResultWithTagname.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "westeurope", + "subscriptionId": "subid", + "tagName": "ApiManagement" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ApiManagement", + "id": "ApiManagement", + "properties": { + "changeNumber": "7", + "region": "", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagsList.json new file mode 100644 index 000000000000..8e44cb6b25ba --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ServiceTagsList.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "location": "westcentralus", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "name": "public", + "id": "/subscriptions/subId/providers/Microsoft.Network/serviceTags/public", + "type": "Microsoft.Network/serviceTags", + "changeNumber": "63", + "cloud": "Public", + "values": [ + { + "name": "ApiManagement", + "id": "ApiManagement", + "properties": { + "changeNumber": "7", + "region": "", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + }, + { + "name": "ApiManagement.AustraliaCentral", + "id": "ApiManagement.AustraliaCentral", + "properties": { + "changeNumber": "2", + "region": "australiacentral", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "20.36.106.68/31", + "20.36.107.176/28" + ] + } + }, + { + "name": "AppService", + "id": "AppService", + "properties": { + "changeNumber": "13", + "region": "", + "systemService": "AzureAppService", + "addressPrefixes": [ + "13.64.73.110/32", + "191.235.208.12/32", + "191.235.215.184/32" + ] + } + }, + { + "name": "ServiceBus", + "id": "ServiceBus", + "properties": { + "changeNumber": "10", + "region": "", + "systemService": "AzureServiceBus", + "addressPrefixes": [ + "23.98.82.96/29", + "40.68.127.68/32", + "40.70.146.64/29" + ] + } + }, + { + "name": "ServiceBus.EastUS2", + "id": "ServiceBus.EastUS2", + "properties": { + "changeNumber": "1", + "region": "eastus2", + "systemService": "AzureServiceBus", + "addressPrefixes": [ + "13.68.110.36/32", + "40.70.146.64/29" + ] + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/centraluseuap/serviceTags?api-version=2020-06-01&changenumber=changenumber&$skipToken={skipToken}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreate.json new file mode 100644 index 000000000000..e989a9c5b0c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateServiceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateServiceEndpoint.json new file mode 100644 index 000000000000..6e99dd60a60d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateServiceEndpoint.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateServiceEndpointNetworkIdentifier.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateServiceEndpointNetworkIdentifier.json new file mode 100644 index 000000000000..b6b0183ce494 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateServiceEndpointNetworkIdentifier.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "networkIdentifier": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "networkIdentifier": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "networkIdentifier": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateWithDelegation.json new file mode 100644 index 000000000000..c245af41e0d6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateWithDelegation.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subId", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateWithSharingScope.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateWithSharingScope.json new file mode 100644 index 000000000000..d74b6ac38015 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetCreateWithSharingScope.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "sharingScope": "Tenant", + "defaultOutboundAccess": false + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "sharingScope": "Tenant", + "defaultOutboundAccess": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetDelete.json new file mode 100644 index 000000000000..665cc0dc8403 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGet.json new file mode 100644 index 000000000000..ec88f492954d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGetWithDelegation.json new file mode 100644 index 000000000000..953755fd0ef5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGetWithDelegation.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGetWithSharingScope.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGetWithSharingScope.json new file mode 100644 index 000000000000..bcd712bbeed3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetGetWithSharingScope.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "sharingScope": "Tenant", + "defaultOutboundAccess": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetList.json new file mode 100644 index 000000000000..842d96ae30c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet2", + "name": "subnet2", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetPrepareNetworkPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetPrepareNetworkPolicies.json new file mode 100644 index 000000000000..70eda19730ce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetPrepareNetworkPolicies.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "subnetName": "subnet1", + "prepareNetworkPoliciesRequestParameters": { + "serviceName": "Microsoft.Sql/managedInstances" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/PrepareNetworkPolicies?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetUnprepareNetworkPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetUnprepareNetworkPolicies.json new file mode 100644 index 000000000000..272235ab7a4c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/SubnetUnprepareNetworkPolicies.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "subnetName": "subnet1", + "unprepareNetworkPoliciesRequestParameters": { + "serviceName": "Microsoft.Sql/managedInstances" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/UnprepareNetworkPolicies?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/UsageList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/UsageList.json new file mode 100644 index 000000000000..ee673923bd60 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/UsageList.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkInterfaces", + "limit": 350.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PacketCaptures", + "limit": 10.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/IPConfigurationsPerVirtualNetwork", + "limit": 4096.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PeeringsPerVirtualNetwork", + "limit": 10.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 200.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/outboundRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound Rules per Load Balancer", + "value": "outboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RoutesPerRouteTable", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/UsageListSpacedLocation.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/UsageListSpacedLocation.json new file mode 100644 index 000000000000..18f8e932cf1c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/UsageListSpacedLocation.json @@ -0,0 +1,335 @@ +{ + "parameters": { + "location": "West US", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 12.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 12.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIpPrefixes", + "limit": 2147483647.0, + "name": { + "localizedValue": "Public Ip Prefixes", + "value": "PublicIpPrefixes" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkInterfaces", + "limit": 24000.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 5.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PacketCaptures", + "limit": 100.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationSecurityGroups", + "limit": 500.0, + "name": { + "localizedValue": "Application Security Groups.", + "value": "ApplicationSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DdosProtectionPlans", + "limit": 1.0, + "name": { + "localizedValue": "DDoS Protection Plans.", + "value": "DdosProtectionPlans" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ServiceEndpointPolicies", + "limit": 200.0, + "name": { + "localizedValue": "Service Endpoint Policies", + "value": "ServiceEndpointPolicies" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkIntentPolicies", + "limit": 200.0, + "name": { + "localizedValue": "Network Intent Policies", + "value": "NetworkIntentPolicies" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/IPConfigurationsPerVirtualNetwork", + "limit": 16384.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PeeringsPerVirtualNetwork", + "limit": 50.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 1000.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkIntentPolicy", + "limit": 100.0, + "name": { + "localizedValue": "Security rules per Network Intent Policy", + "value": "SecurityRulesPerNetworkIntentPolicy" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerNetworkIntentPolicy", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Network Intent Policy", + "value": "RoutesPerNetworkIntentPolicy" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/OutboundRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound Rules per Load Balancer", + "value": "OutboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerRouteTable", + "limit": 400.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionDelete.json new file mode 100644 index 000000000000..acef833fee5d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "connectionName": "conn1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionGet.json new file mode 100644 index 000000000000..6ad635a60076 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "connectionName": "conn1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": { + "body": { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected", + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionList.json new file mode 100644 index 000000000000..76d0a08a65f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected", + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionPut.json new file mode 100644 index 000000000000..61d2d3855288 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubBgpConnectionPut.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "connectionName": "conn1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1", + "parameters": { + "properties": { + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected", + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + }, + "201": { + "body": { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected", + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubDelete.json new file mode 100644 index 000000000000..1b3b1091442a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubGet.json new file mode 100644 index 000000000000..9b56513871e3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationDelete.json new file mode 100644 index 000000000000..dfa47a0f8316 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "ipConfigName": "ipconfig1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationGet.json new file mode 100644 index 000000000000..db0bbef888b5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1", + "ipConfigName": "ipconfig1" + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationList.json new file mode 100644 index 000000000000..597b9c6c2a28 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationPut.json new file mode 100644 index 000000000000..d25c32115123 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubIpConfigurationPut.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "ipConfigName": "ipconfig1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1", + "parameters": { + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + }, + "201": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubList.json new file mode 100644 index 000000000000..690a60abde27 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubList.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "10.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "210.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubListByResourceGroup.json new file mode 100644 index 000000000000..5fe02c73de90 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubListByResourceGroup.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "10.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "210.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubPut.json new file mode 100644 index 000000000000..86b5bdf78708 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubPut.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "addressPrefix": "10.168.0.0/24", + "sku": "Basic" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.168.0.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.168.0.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Delete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Delete.json new file mode 100644 index 000000000000..02f67d6074e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "routeTableName": "virtualHubRouteTable1a", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Get.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Get.json new file mode 100644 index 000000000000..1e3770aae0d6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "routeTableName": "virtualHubRouteTable1a", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "virtualHubRouteTable1a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2List.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2List.json new file mode 100644 index 000000000000..7cad10cab2b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2List.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "virtualHubRouteTable1a", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + }, + { + "name": "virtualHubRouteTable1b", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1b", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.30.0.0/16", + "20.40.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Branches" + ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Put.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Put.json new file mode 100644 index 000000000000..7e573a83c1a5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubRouteTableV2Put.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "routeTableName": "virtualHubRouteTable1a", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1", + "virtualHubRouteTableV2Parameters": { + "properties": { + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "virtualHubRouteTable1a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "virtualHubRouteTable1a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubUpdateTags.json new file mode 100644 index 000000000000..85c0571564ed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualHubUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.168.0.0/24", + "sku": "Basic", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCheckIPAddressAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCheckIPAddressAvailability.json new file mode 100644 index 000000000000..1ab515aed3e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCheckIPAddressAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "ipAddress": "10.0.1.4" + }, + "responses": { + "200": { + "body": { + "available": false, + "availableIPAddresses": [ + "10.0.1.5", + "10.0.1.6", + "10.0.1.7", + "10.0.1.8", + "10.0.1.9" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreate.json new file mode 100644 index 000000000000..c1d679d1e436 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "flowTimeoutInMinutes": 10 + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "flowTimeoutInMinutes": 10, + "subnets": [], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "flowTimeoutInMinutes": 10, + "subnets": [], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json new file mode 100644 index 000000000000..865de4fc62d4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "vnetTest", + "virtualNetworkName": "vnet1", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ], + "serviceEndpointPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1" + } + ] + } + } + ] + }, + "location": "eastus2euap" + } + }, + "responses": { + "200": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "serviceEndpointPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1" + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "serviceEndpointPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1" + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateServiceEndpoints.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateServiceEndpoints.json new file mode 100644 index 000000000000..fd0168535f03 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateServiceEndpoints.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "vnetTest", + "virtualNetworkName": "vnet1", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ] + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnet.json new file mode 100644 index 000000000000..8a4af37ac870 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnet.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json new file mode 100644 index 000000000000..3345b4cab926 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.0.1.0/28" + ] + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-2", + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.1.0.0/28" + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-2", + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.0.1.0/28" + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnetWithDelegation.json new file mode 100644 index 000000000000..d8bc9d338782 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateSubnetWithDelegation.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "delegations": [ + { + "name": "myDelegation", + "properties": { + "serviceName": "Microsoft.Sql/managedInstances" + } + } + ] + } + } + ] + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Sql/managedInstances", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Sql/managedInstances", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateWithBgpCommunities.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateWithBgpCommunities.json new file mode 100644 index 000000000000..e45e31be76ca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateWithBgpCommunities.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ], + "bgpCommunities": { + "virtualNetworkCommunity": "12076:20000" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "bgpCommunities": { + "virtualNetworkCommunity": "12076:20000", + "regionalCommunity": "12076:50004" + }, + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "bgpCommunities": { + "virtualNetworkCommunity": "12076:20000", + "regionalCommunity": "12076:50004" + }, + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateWithEncryption.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateWithEncryption.json new file mode 100644 index 000000000000..7ae354f8735d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkCreateWithEncryption.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ], + "encryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "encryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "encryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkDelete.json new file mode 100644 index 000000000000..2f82fd3d5d24 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionCreate.json new file mode 100644 index 000000000000..2bbdc2d99689 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionCreate.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S", + "parameters": { + "properties": { + "virtualNetworkGateway1": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1" + }, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "location": "centralus", + "tags": {} + }, + "localNetworkGateway2": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "location": "centralus", + "tags": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "connectionMode": "Default" + }, + "location": "centralus" + } + }, + "responses": { + "201": { + "body": { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "sharedKey": "Abc123", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default" + } + } + }, + "200": { + "body": { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "sharedKey": "Abc123", + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionDelete.json new file mode 100644 index 000000000000..eb62d54a07b6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "conn1" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGet.json new file mode 100644 index 000000000000..84c2cefe435e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGet.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S" + }, + "responses": { + "200": { + "body": { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "sharedKey": "Abc123", + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "connectionStatus": "Connecting", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json new file mode 100644 index 000000000000..fca5c1e9d79d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/westus/operationResults/{operationId}?api-version=2024-01-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json new file mode 100644 index 000000000000..21e030e6e557 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S" + }, + "responses": { + "200": { + "body": { + "id": "", + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionReset.json new file mode 100644 index 000000000000..2143bf3b2b4d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionReset.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "conn1" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json new file mode 100644 index 000000000000..98a1316afdfa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "conn1", + "parameters": { + "keyLength": 128 + } + }, + "responses": { + "200": { + "body": { + "keyLength": 128 + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json new file mode 100644 index 000000000000..574bd9221f42 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S", + "parameters": { + "value": "AzureAbc123" + } + }, + "responses": { + "200": { + "body": { + "id": "", + "value": "AzureAbc123" + } + }, + "201": { + "body": { + "id": "", + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json new file mode 100644 index 000000000000..920f3f7d5fdd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..6c61871f9d70 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json new file mode 100644 index 000000000000..8bd5ec1ea831 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json new file mode 100644 index 000000000000..f6c87284289f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "test", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/test", + "type": "Microsoft.Network/connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "temp1234", + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "connectionStatus": "Unknown", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionsList.json new file mode 100644 index 000000000000..86c37e622d5f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayConnectionsList.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv1", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default" + } + }, + { + "name": "conn2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "properties": {} + }, + "localNetworkGateway2": { + "properties": {}, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2" + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 20, + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.4" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.6" + } + ], + "useLocalAzureIpAddress": true, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayDelete.json new file mode 100644 index 000000000000..7f3c5ac7838f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json new file mode 100644 index 000000000000..cc56e5eaf031 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": {} + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json new file mode 100644 index 000000000000..0d41ef9c537a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": {} + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGet.json new file mode 100644 index 000000000000..8acddbb2b3dc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGet.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "IngressSnat", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.1.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json new file mode 100644 index 000000000000..e65673e98787 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "peer": "test" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json new file mode 100644 index 000000000000..dbbf3b420c88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..13f6c6add438 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json new file mode 100644 index 000000000000..4deeb61d887a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json new file mode 100644 index 000000000000..6fd2beeaed13 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "resourceGroupName": "p2s-vnet-test", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "virtualNetworkGatewayName": "vpnp2sgw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vpnConnectionId": "IKEv2_1e1cfe59-5c7c-4315-a876-b11fbfdfeed4", + "vpnConnectionDuration": 900, + "vpnConnectionTime": "2019-05-02T22:26:22", + "publicIpAddress": "167.220.2.232:45522", + "privateIpAddress": "192.168.210.2", + "vpnUserName": "gwp2schildcert", + "maxBandwidth": 240000000, + "egressPacketsTransferred": 557, + "egressBytesTransferred": 33420, + "ingressPacketsTransferred": 557, + "ingressBytesTransferred": 33420, + "maxPacketsPerSecond": 4 + }, + { + "vpnConnectionId": "IKEv2_571cfe59-2c7d-1415-e813-c51fbfdfea16", + "vpnConnectionDuration": 800, + "vpnConnectionTime": "2019-05-01T21:06:12", + "publicIpAddress": "167.220.2.232:45213", + "privateIpAddress": "192.168.210.1", + "vpnUserName": "gwp2schildcert", + "maxBandwidth": 220000000, + "egressPacketsTransferred": 357, + "egressBytesTransferred": 23420, + "ingressPacketsTransferred": 357, + "ingressBytesTransferred": 23420, + "maxPacketsPerSecond": 4 + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayLearnedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayLearnedRoutes.json new file mode 100644 index 000000000000..dbbf3b420c88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayLearnedRoutes.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayList.json new file mode 100644 index 000000000000..876f2b8a8db9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayList.json @@ -0,0 +1,224 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vpngw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw1-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/natRules/natRule1", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/natRules/natRule2", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "IngressSnat", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.14", + "peerWeight": 0 + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + }, + { + "name": "vpngw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc2", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddress": "10.1.0.7", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw2-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/natRules/natRule1", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/natRules/natRule2", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "IngressSnat", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": true, + "activeActive": false, + "disableIPSecReplayProtection": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.1.0.46", + "peerWeight": 0 + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleDelete.json new file mode 100644 index 000000000000..65de21b5d6b9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "natRuleName": "natRule1", + "virtualNetworkGatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleGet.json new file mode 100644 index 000000000000..1465a66b61ac --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "virtualNetworkGatewayName": "gateway1", + "natRuleName": "natRule1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24", + "portRange": "100-100" + } + ], + "externalMappings": [ + { + "addressSpace": "50.4.0.0/24", + "portRange": "200-200" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleList.json new file mode 100644 index 000000000000..2870d6f3d508 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRuleList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "virtualNetworkGatewayName": "gateway1", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRulePut.json new file mode 100644 index 000000000000..8c5e2d43c9b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayNatRulePut.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "natRuleName": "natRule1", + "virtualNetworkGatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "NatRuleParameters": { + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24", + "portRange": "200-300" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24", + "portRange": "300-400" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24", + "portRange": "200-300" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24", + "portRange": "300-400" + } + ] + } + } + }, + "201": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24", + "portRange": "200-300" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24", + "portRange": "300-400" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayReset.json new file mode 100644 index 000000000000..874c4331c059 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayReset.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json new file mode 100644 index 000000000000..4b5ddd137f3e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..b9abb0611d09 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "vpnclientIpsecParams": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStartPacketCapture.json new file mode 100644 index 000000000000..39f7b7adb5ce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStartPacketCapture.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..8733d4e6ca17 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStopPacketCapture.json new file mode 100644 index 000000000000..f505f81f3d88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayStopPacketCapture.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json new file mode 100644 index 000000000000..cf5a974fe2e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayUpdate.json new file mode 100644 index 000000000000..82319faf654f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayUpdate.json @@ -0,0 +1,352 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "enableDnsForwarding": true, + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2", + "properties": { + "type": "Static", + "mode": "IngressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1" + }, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20, + "radiusServerSecret": "radiusServerSecret" + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2", + "properties": { + "type": "Static", + "mode": "IngressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "enableDnsForwarding": true, + "inboundDnsForwardingEndpoint": "10.0.1.14", + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + }, + "201": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2", + "properties": { + "type": "Static", + "mode": "IngressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "enableDnsForwarding": true, + "enablePrivateIpAddress": false, + "inboundDnsForwardingEndpoint": "10.0.1.14", + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..51cb6a041558 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayUpdateTags.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + }, + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testpub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.254", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json new file mode 100644 index 000000000000..82871ee56737 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngw", + "parameters": { + "vendor": "Cisco", + "deviceFamily": "ISR", + "firmwareVersion": "IOS 15.1 (Preview)" + } + }, + "responses": { + "200": { + "body": "! Microsoft Corporation\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Sample VPN tunnel configuration template for IOS-based devices\r\n!\r\n! This configuration template applies to Cisco VPN devices running IOS 15.1 or beyond (ISR or ASR)\r\n!\r\n\r\n\r\n\t\t\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! ACL rules\r\n!\r\n! Some VPN devices require explicit ACL rules to allow cross-premises traffic:\r\n!\r\n! 1. Allow traffic between on premises address ranges and VNet address ranges\r\n! 2. Allow IKE traffic (UDP:500) between on premises VPN devices and Azure VPN gateway\r\n! 3. Allow IPsec traffic (Proto:ESP) between on premises VPN devices and Azure VPN gateway\r\n!\r\n\t\t\r\naccess-list 101 permit ip 10.1.0.0 0.0.255.255 10.0.0.0 0.0.255.255\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Internet Key Exchange (IKE) configuration\r\n!\r\n! This section specifies the authentication, encryption, hashing, and Diffie-Hellman group parameters for IKE\r\n! main mode or phase 1\r\n!\r\n\r\ncrypto ikev2 proposal SwaggerS2S-proposal\r\n encryption DES3\r\n integrity SHA384\r\n group DHGroup24\r\n lifetime 3600\r\n exit\r\n\r\ncrypto ikev2 policy SwaggerS2S-policy\r\n proposal SwaggerS2S-proposal\r\n exit\r\n\r\ncrypto ikev2 keyring SwaggerBranch-keyring\r\n\t\t\r\n\t\tpeer 52.173.199.254\r\n\t\taddress 52.173.199.254\r\n\t\tpre-shared-key lALEHuppeopJmA94exRNiRr2QzuZ6lOsvzu5IlJUEA6LthbTc8g5MTT86MCsGNMzGkTAaLuLnEJoD1Cn4cIlr94qKZm9drsgllzWvsPNezS71stAkaW1Bb7h6GBnDlDP\r\n exit\r\n\r\ncrypto ikev2 profile SwaggerS2S-profile\r\n match address local 10.3.0.0\r\n\tmatch identity remote address 52.173.199.254 255.255.255.255\r\n\t\t\r\n authentication remote pre-share\r\n authentication local pre-share\r\n keyring SwaggerBranch-keyring\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! IPsec configuration\r\n!\r\n! This section specifies encryption, authentication, tunnel mode properties for the Phase 2 negotiation\r\n!\r\ncrypto ipsec transform-set SwaggerS2S-TransformSet DES3 DES3\r\n mode tunnel\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Crypto map configuration\r\n!\r\n! This section defines a crypto profile that binds the cross-premises network traffic to the IPsec and IKE\r\n! policy profiles for this connection. Then defines the VTI (virtual tunnel interface) with the crypto\r\n! profile. A random interface number (tunnel 1) was used with a random link local address (169.254.0.1/28)\r\n! for the tunnel interface. If either selection is already used in the VPN device, please select another\r\n! interface number or address. The only requirement is that they must not overlap with another interface\r\n! on the same VPN device.\r\n!\r\ncrypto ipsec profile SwaggerS2S-IPsecProfile\r\n set transform-set SwaggerS2S-TransformSet\r\n set ikev2-profile SwaggerS2S-profile\r\n set pfs None\r\n set security-association lifetime 3600\r\n exit\r\n\r\n\r\nint tunnel 52.173.199.254\r\n ip address 169.254.0.1 255.255.255.252\r\n ip tcp adjust-mss 1350\r\n tunnel source 10.3.0.0\r\n tunnel mode ipsec ipv4\r\n tunnel destination 52.173.199.254\r\n tunnel protection ipsec profile SwaggerS2S-IPsecProfile\r\n exit\r\n\r\n\tip route 10.0.0.0 255.255.0.0 tunnel 52.173.199.254 " + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json new file mode 100644 index 000000000000..d49489d3cc03 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "vpn-gateway-test", + "virtualNetworkGatewayName": "vpngateway", + "api-version": "2024-01-01", + "request": { + "vpnConnectionIds": [ + "vpnconnId1", + "vpnconnId2" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaysListConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaysListConnections.json new file mode 100644 index 000000000000..9b414863ffe3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGatewaysListConnections.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "virtualNetworkGatewayName": "test-vpn-gateway-1", + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vpn-connection", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/connections/test-vpn-connection", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-1" + }, + "virtualNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/testrg-2/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-2" + }, + "connectionType": "Vnet2Vnet", + "routingWeight": 22, + "enableBgp": true, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGet.json new file mode 100644 index 000000000000..fa48ef33a446 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.1.0/24", + "ipConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + } + ] + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetDdosProtectionStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetDdosProtectionStatus.json new file mode 100644 index 000000000000..b1b181d3aa62 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetDdosProtectionStatus.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "top": 75 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip", + "publicIpAddress": "10.0.1.5", + "isWorkloadProtected": "True", + "ddosProtectionPlanId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan" + }, + { + "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip2", + "publicIpAddress": "10.0.1.6", + "isWorkloadProtected": "False" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/ddosProtectionStatus?api-version=2024-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetResourceNavigationLinks.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetResourceNavigationLinks.json new file mode 100644 index 000000000000..4d4020c56b1b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetResourceNavigationLinks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "vnet", + "subnetName": "subnet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "redisCache_redis-tester", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet/resourceNavigationLinks/redisCache_redis-tester", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworks/subnets/resourceNavigationLinks", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.Cache/redis", + "link": "/subscriptions/subid/resourceGroups/another-rg/providers/Microsoft.Cache/Redis/redis-tester" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetServiceAssociationLinks.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetServiceAssociationLinks.json new file mode 100644 index 000000000000..541c59da0061 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetServiceAssociationLinks.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "vnet", + "subnetName": "subnet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "acisal", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet/serviceAssociationLinks/acisal", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.ContainerInstance/containerGroups", + "allowDelete": true, + "locations": [ + "westus" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetWithServiceAssociationLink.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetWithServiceAssociationLink.json new file mode 100644 index 000000000000..b49af49986c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetWithServiceAssociationLink.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.214.0/24", + "ipConfigurationProfiles": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1" + } + ], + "serviceAssociationLinks": [ + { + "name": "serviceAssociationLink1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/serviceAssociationLinks/serviceAssociationLink1", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.Provider/resourceType" + } + } + ], + "serviceEndpoints": [], + "delegations": [ + { + "name": "aciDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/aciDelegation", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/virtualNetworks/subnets/action" + ] + } + } + ] + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetWithSubnetDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetWithSubnetDelegation.json new file mode 100644 index 000000000000..4cf0b95313cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkGetWithSubnetDelegation.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.1.0/24", + "ipConfigurations": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + } + ], + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkList.json new file mode 100644 index 000000000000..ed7cfc3259e9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkList.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkListAll.json new file mode 100644 index 000000000000..c2da6daffa00 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkListAll.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkListUsage.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkListUsage.json new file mode 100644 index 000000000000..84745113e1ef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkListUsage.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "virtualNetworkName": "vnetName", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": -1.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/GatewaySubnet", + "limit": -1.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/newSubnet", + "limit": 3.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringCreate.json new file mode 100644 index 000000000000..6b8805606a44 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringCreate.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json new file mode 100644 index 000000000000..e9a22f1f76a4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringDelete.json new file mode 100644 index 000000000000..ab6faf737b73 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringGet.json new file mode 100644 index 000000000000..0895c187fc0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json new file mode 100644 index 000000000000..1131308f3f6a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringList.json new file mode 100644 index 000000000000..acfc9b9e8c28 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringList.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "13.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "13.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20003", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json new file mode 100644 index 000000000000..bf3132e0239c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "13.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20003", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringSync.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringSync.json new file mode 100644 index 000000000000..4544236b624e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkPeeringSync.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "syncRemoteAddressSpace": "true", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkScalableGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkScalableGatewayGet.json new file mode 100644 index 000000000000..a13f6cfb8fe6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkScalableGatewayGet.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "ergw" + }, + "responses": { + "200": { + "body": { + "name": "ergw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Static", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "IngressSnat", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "ErGwScale", + "tier": "ErGwScale", + "capacity": 2 + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2, + "max": 3 + } + }, + "gatewayType": "ExpressRoute", + "vpnType": "PolicyBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "vpnClientConfiguration": null, + "bgpSettings": null, + "customRoutes": null, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkScalableGatewayUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkScalableGatewayUpdate.json new file mode 100644 index 000000000000..d7721e299db1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkScalableGatewayUpdate.json @@ -0,0 +1,269 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "ergw", + "parameters": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Static", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1" + } + ], + "gatewayType": "ExpressRoute", + "vpnType": "PolicyBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2", + "properties": { + "type": "Static", + "mode": "IngressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "ErGwScale", + "tier": "ErGwScale" + }, + "vpnClientConfiguration": null, + "bgpSettings": null, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "name": "ergw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2", + "properties": { + "type": "Static", + "mode": "IngressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "ErGwScale", + "tier": "ErGwScale", + "capacity": 0 + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2, + "max": 3 + } + }, + "gatewayType": "ExpressRoute", + "vpnType": "PolicyBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "vpnClientConfiguration": null, + "bgpSettings": null, + "customRoutes": null, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + }, + "201": { + "body": { + "name": "ergw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Static", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2", + "properties": { + "type": "Static", + "mode": "IngressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "ErGwScale", + "tier": "ErGwScale", + "capacity": 2 + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2, + "max": 3 + } + }, + "gatewayType": "ExpressRoute", + "vpnType": "PolicyBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "enablePrivateIpAddress": false, + "vpnClientConfiguration": null, + "bgpSettings": null, + "customRoutes": null, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringCreate.json new file mode 100644 index 000000000000..29b40f78eb7b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringCreate.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringGet.json new file mode 100644 index 000000000000..d99be4a12392 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringGet.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringSync.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringSync.json new file mode 100644 index 000000000000..91618d800953 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkSubnetPeeringSync.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "syncRemoteAddressSpace": "true", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapCreate.json new file mode 100644 index 000000000000..234a2d7ee9b4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapCreate.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap", + "parameters": { + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/ipconfig1" + } + }, + "location": "centraluseuap" + } + }, + "responses": { + "200": { + "body": { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + }, + "201": { + "body": { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapDelete.json new file mode 100644 index 000000000000..506ff95c579e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapGet.json new file mode 100644 index 000000000000..70948ba22db9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "testvtap" + }, + "responses": { + "200": { + "body": { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapList.json new file mode 100644 index 000000000000..16bc0f65f4f0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + }, + { + "name": "testvtap2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap2", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapListAll.json new file mode 100644 index 000000000000..0111996502a7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapListAll.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + }, + { + "name": "testvtap2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap2", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapUpdateTags.json new file mode 100644 index 000000000000..7bc4ead8f8e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkTapUpdateTags.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap", + "tapParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/test-vtap", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + }, + "type": "Microsoft.Network/virtualNetworkTaps" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkUpdateTags.json new file mode 100644 index 000000000000..e4f43316561f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkUpdateTags.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringCreate.json new file mode 100644 index 000000000000..921295e2b40e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringCreate.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringGet.json new file mode 100644 index 000000000000..ddccc3f7213f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringSync.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringSync.json new file mode 100644 index 000000000000..d867c4121f41 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualNetworkV6SubnetPeeringSync.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "syncRemoteAddressSpace": "true", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterDelete.json new file mode 100644 index 000000000000..3328f771b4fb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterGet.json new file mode 100644 index 000000000000..5d6502d7a316 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": { + "body": { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterListByResourceGroup.json new file mode 100644 index 000000000000..d87629b5d87b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterListBySubscription.json new file mode 100644 index 000000000000..e6f2ca99cc04 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterListBySubscription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeerListAdvertisedRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeerListAdvertisedRoute.json new file mode 100644 index 000000000000..fafe4f106838 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeerListAdvertisedRoute.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "hubName": "virtualRouter1", + "connectionName": "peer1" + }, + "responses": { + "202": {}, + "200": { + "body": { + "RouteServiceRole_IN_0": [ + { + "localAddress": "10.85.3.4", + "network": "10.45.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + }, + { + "localAddress": "10.85.3.4", + "network": "10.85.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + }, + { + "localAddress": "10.85.3.4", + "network": "10.100.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + } + ], + "RouteServiceRole_IN_1": [ + { + "localAddress": "10.85.3.4", + "network": "10.45.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + }, + { + "localAddress": "10.85.3.4", + "network": "10.85.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + }, + { + "localAddress": "10.85.3.4", + "network": "10.100.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeerListLearnedRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeerListLearnedRoute.json new file mode 100644 index 000000000000..a1a78eec1a7c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeerListLearnedRoute.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "hubName": "virtualRouter1", + "connectionName": "peer1" + }, + "responses": { + "202": {}, + "200": { + "body": { + "RouteServiceRole_IN_0": [ + { + "localAddress": "10.85.3.4", + "network": "10.101.0.0/16", + "nextHop": "10.85.4.4", + "sourcePeer": "10.85.4.4", + "origin": "EBgp", + "asPath": "65002-65001", + "weight": 32768 + }, + { + "localAddress": "10.85.3.5", + "network": "10.101.0.0/16", + "nextHop": "10.85.4.4", + "sourcePeer": "10.85.4.4", + "origin": "EBgp", + "asPath": "65002-65001", + "weight": 32768 + } + ], + "RouteServiceRole_IN_1": [ + { + "localAddress": "10.85.3.4", + "network": "10.101.0.0/16", + "nextHop": "10.85.4.4", + "sourcePeer": "10.85.4.4", + "origin": "EBgp", + "asPath": "65002-65001", + "weight": 32768 + }, + { + "localAddress": "10.85.3.5", + "network": "10.101.0.0/16", + "nextHop": "10.85.4.4", + "sourcePeer": "10.85.4.4", + "origin": "EBgp", + "asPath": "65002-65001", + "weight": 32768 + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringDelete.json new file mode 100644 index 000000000000..95b7b4244b92 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "peeringName": "peering1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringGet.json new file mode 100644 index 000000000000..fb6c64bdbaf9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "peeringName": "peering1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": { + "body": { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringList.json new file mode 100644 index 000000000000..dac4a96c1ba3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringPut.json new file mode 100644 index 000000000000..c67ef57a355a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPeeringPut.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "peeringName": "peering1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter", + "parameters": { + "properties": { + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + }, + "responses": { + "200": { + "body": { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + }, + "201": { + "body": { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPut.json new file mode 100644 index 000000000000..a58561b51e0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualRouterPut.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + }, + "201": { + "body": { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANDelete.json new file mode 100644 index 000000000000..9ccbefc68c90 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "VirtualWANName": "virtualWan1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANGet.json new file mode 100644 index 000000000000..9527d12cf85e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANList.json new file mode 100644 index 000000000000..4c8962c65a59 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANListByResourceGroup.json new file mode 100644 index 000000000000..5c4683426329 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub4" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite4" + ], + "type": "Basic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANPut.json new file mode 100644 index 000000000000..3acb0468b9c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANPut.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "WANParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "disableVpnEncryption": false, + "type": "Basic" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANUpdateTags.json new file mode 100644 index 000000000000..7b808d702fea --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWANUpdateTags.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "WANParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWanSupportedSecurityProviders.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWanSupportedSecurityProviders.json new file mode 100644 index 000000000000..a693822ba668 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VirtualWanSupportedSecurityProviders.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "virtualWANName": "wan1" + }, + "responses": { + "200": { + "description": "Request successful.", + "body": { + "supportedProviders": [ + { + "name": "AzureFirewall", + "url": "", + "type": "Native" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceGet.json new file mode 100644 index 000000000000..146f80e3d7f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceGet.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses": { + "200": { + "body": { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "dns.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceIpConfigGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceIpConfigGet.json new file mode 100644 index 000000000000..5b7c23b7b56b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceIpConfigGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceIpConfigList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceIpConfigList.json new file mode 100644 index 000000000000..e14de4e82a72 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceIpConfigList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceList.json new file mode 100644 index 000000000000..0ec937148391 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssNetworkInterfaceList.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssPublicIpGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssPublicIpGet.json new file mode 100644 index 000000000000..229c15712a0d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssPublicIpGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1", + "publicIpAddressName": "pub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssPublicIpListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssPublicIpListAll.json new file mode 100644 index 000000000000..605e0b831869 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssPublicIpListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm3.testvmssacc", + "fqdn": "vm3.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.118.216", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssVmNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssVmNetworkInterfaceList.json new file mode 100644 index 000000000000..e4f1cbf14ebf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssVmNetworkInterfaceList.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssVmPublicIpList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssVmPublicIpList.json new file mode 100644 index 000000000000..d21f5d40ed03 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VmssVmPublicIpList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionDelete.json new file mode 100644 index 000000000000..ad709591af5c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionGet.json new file mode 100644 index 000000000000..d758e6f501b5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionGet.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "trafficSelectorPolicies": [], + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "ResponderOnly" + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "InitiatorOnly" + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionList.json new file mode 100644 index 000000000000..ee337fe3d283 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionList.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "trafficSelectorPolicies": [], + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "Default" + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "Default" + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionPut.json new file mode 100644 index 000000000000..5db96448462f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionPut.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VpnConnectionParameters": { + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "properties": { + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "vpnLinkConnectionMode": "Default", + "usePolicyBasedTrafficSelectors": false + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "trafficSelectorPolicies": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "Default" + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "trafficSelectorPolicies": [] + } + } + }, + "201": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "Default" + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "trafficSelectorPolicies": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStartPacketCapture.json new file mode 100644 index 000000000000..feeec49f3f8d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStartPacketCapture.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "vpnConnectionName": "vpnConnection1", + "parameters": { + "linkConnectionNames": [ + "siteLink1", + "siteLink2" + ] + } + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..46d96c428b67 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStartPacketCaptureFilterData.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "vpnConnectionName": "vpnConnection1", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}", + "linkConnectionNames": [ + "siteLink1", + "siteLink2" + ] + } + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStopPacketCapture.json new file mode 100644 index 000000000000..3f7c437c4050 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnConnectionStopPacketCapture.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "vpnConnectionName": "vpnConnection1", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D", + "linkConnectionNames": [ + "vpnSiteLink1", + "vpnSiteLink2" + ] + } + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayDelete.json new file mode 100644 index 000000000000..36dcf7f86400 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayGet.json new file mode 100644 index 000000000000..b6cb98cb53ac --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayGet.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "properties": { + "type": "Dynamic", + "mode": "IgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + }, + { + "name": "nat04", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link2" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + } + ], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayList.json new file mode 100644 index 000000000000..3b14656a85e1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayList.json @@ -0,0 +1,304 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "properties": { + "type": "Dynamic", + "mode": "IgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + }, + { + "name": "nat04", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link2" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + } + ], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayListByResourceGroup.json new file mode 100644 index 000000000000..0b9a9f5ca9eb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayListByResourceGroup.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + } + ], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayPut.json new file mode 100644 index 000000000000..4522041065c6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayPut.json @@ -0,0 +1,377 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "location": "westcentralus", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "properties": { + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + } + ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "customBgpIpAddresses": [ + "169.254.21.5" + ] + }, + { + "ipconfigurationId": "Instance1", + "customBgpIpAddresses": [ + "169.254.21.10" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "ipConfigurationId": "" + } + } + ], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + } + } + ], + "isRoutingPreferenceInternet": false + } + } + }, + "201": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + } + } + ], + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayReset.json new file mode 100644 index 000000000000..6ff950340b00 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayReset.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "gatewayName": "vpngw", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStartPacketCapture.json new file mode 100644 index 000000000000..4fb968e99192 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStartPacketCapture.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "vpngw" + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..802bf1843768 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStartPacketCaptureFilterData.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "vpngw", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}" + } + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStopPacketCapture.json new file mode 100644 index 000000000000..e86efc442f91 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayStopPacketCapture.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "vpngw", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D" + } + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayUpdateTags.json new file mode 100644 index 000000000000..2c515c38b076 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnGatewayUpdateTags.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationDelete.json new file mode 100644 index 000000000000..bdbd70254aee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationGet.json new file mode 100644 index 000000000000..d9e67c4bffa3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationGet.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationList.json new file mode 100644 index 000000000000..bcc16a250e59 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationList.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret": "", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "vpnServerConfiguration2", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationListByResourceGroup.json new file mode 100644 index 000000000000..9c9f95a23e23 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationListByResourceGroup.json @@ -0,0 +1,211 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret": "", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration2", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret": "", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationPut.json new file mode 100644 index 000000000000..89b2b5f88eba --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationPut.json @@ -0,0 +1,304 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VpnServerConfigurationParameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25, + "radiusServerSecret": "radiusServerSecret" + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationUpdateTags.json new file mode 100644 index 000000000000..0c3763f57339 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnServerConfigurationUpdateTags.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VpnServerConfigurationParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret": "", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteDelete.json new file mode 100644 index 000000000000..05db89ed96c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteGet.json new file mode 100644 index 000000000000..d68a947d78c1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionGet.json new file mode 100644 index 000000000000..f91802d2ab1e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "vpnGatewayCustomBgpAddresses": [ + { + "ipConfigurationId": "Instance0", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "Instance1", + "customBgpIpAddress": "169.254.21.3" + } + ], + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "dpdTimeoutSeconds": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionGetIkeSas.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionGetIkeSas.json new file mode 100644 index 000000000000..c93ed77306bd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionGetIkeSas.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/westus/operationResults/{operationId}?api-version=2024-01-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionList.json new file mode 100644 index 000000000000..91386fadbae6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "connectionName": "vpnConnection1" + }, + "responses": { + "200": { + "body": [ + { + "name": "Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "vpnGatewayCustomBgpAddresses": [ + { + "ipConfigurationId": "Instance0", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "Instance1", + "customBgpIpAddress": "169.254.21.3" + } + ], + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "dpdTimeoutSeconds": 0 + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionReset.json new file mode 100644 index 000000000000..1a1571a85599 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkConnectionReset.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1" + }, + "responses": { + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkGet.json new file mode 100644 index 000000000000..bf9b69512af4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "vpnSiteLinkName": "vpnSiteLink1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkListByVpnSite.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkListByVpnSite.json new file mode 100644 index 000000000000..01fab0f168f8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteLinkListByVpnSite.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "vpnSiteName": "vpnSite1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 200 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + }, + { + "name": "vpnSiteLink2", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.40.40.46", + "linkProperties": { + "linkSpeedInMbps": 200 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.1", + "asn": 1234 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteList.json new file mode 100644 index 000000000000..d2033b0c858e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteList.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + }, + "isSecuritySite": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteListByResourceGroup.json new file mode 100644 index 000000000000..b6f1c465e6e0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteListByResourceGroup.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSitePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSitePut.json new file mode 100644 index 000000000000..0e88d0d8db7f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSitePut.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "properties": { + "ipAddress": "50.50.50.56", + "fqdn": "link1.vpnsite1.contoso.com", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ], + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": false + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteUpdateTags.json new file mode 100644 index 000000000000..a058b0e38b93 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSiteUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSitesConfigurationDownload.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSitesConfigurationDownload.json new file mode 100644 index 000000000000..34744ec28f88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/VpnSitesConfigurationDownload.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2024-01-01", + "virtualWANName": "wan1", + "request": { + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/abc" + ], + "outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/vpnFile?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b" + } + }, + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafListAllPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafListAllPolicies.json new file mode 100644 index 000000000000..1d790c5aa52c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafListAllPolicies.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Prevention", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": "*" + } + ] + } + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + } + ], + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafListPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafListPolicies.json new file mode 100644 index 000000000000..13774554ea81 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafListPolicies.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny" + } + ] + } + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyCreateOrUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..733cc7ce2ec2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,753 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1", + "parameters": { + "location": "WestUs", + "properties": { + "policySettings": { + "jsChallengeCookieExpirationInMins": 100, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny" + } + ] + } + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-931-APPLICATION-ATTACK-RFI", + "rules": [ + { + "ruleId": "931120", + "state": "Enabled", + "action": "Log" + }, + { + "ruleId": "931130", + "state": "Disabled", + "action": "AnomalyScoring" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "UnknownBots", + "rules": [ + { + "ruleId": "300700", + "state": "Enabled", + "action": "JSChallenge" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-930-APPLICATION-ATTACK-LFI", + "rules": [ + { + "ruleId": "930120" + } + ] + }, + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "EndsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.1", + "ruleGroups": [] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "test" + }, + { + "matchVariable": "RequestArgValues", + "selectorMatchOperator": "StartsWith", + "selector": "test" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "action": "Block", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ] + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + }, + { + "name": "Rule4", + "priority": 4, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "matchValues": [ + "Bot" + ] + } + ], + "action": "JSChallenge" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "jsChallengeCookieExpirationInMins": 100, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny" + } + ] + } + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-931-APPLICATION-ATTACK-RFI", + "rules": [ + { + "ruleId": "931120", + "state": "Enabled", + "action": "Log" + }, + { + "ruleId": "931130", + "state": "Disabled", + "action": "AnomalyScoring" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "UnknownBots", + "rules": [ + { + "ruleId": "300700", + "state": "Enabled", + "action": "JSChallenge" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-930-APPLICATION-ATTACK-LFI", + "rules": [ + { + "ruleId": "930120" + } + ] + }, + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "EndsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.1", + "ruleGroups": [] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "test" + }, + { + "matchVariable": "RequestArgValues", + "selectorMatchOperator": "StartsWith", + "selector": "test" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + }, + { + "name": "Rule4", + "priority": 4, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Bot" + ] + } + ], + "action": "JSChallenge" + } + ] + } + } + }, + "201": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "jsChallengeCookieExpirationInMins": 100 + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-931-APPLICATION-ATTACK-RFI", + "rules": [ + { + "ruleId": "931120", + "state": "Enabled", + "action": "Log" + }, + { + "ruleId": "931130", + "state": "Disabled", + "action": "AnomalyScoring" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "UnknownBots", + "rules": [ + { + "ruleId": "300700", + "state": "Enabled", + "action": "JSChallenge" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-930-APPLICATION-ATTACK-LFI", + "rules": [ + { + "ruleId": "930120" + } + ] + }, + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "EndsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.1", + "ruleGroups": [] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "test" + }, + { + "matchVariable": "RequestArgValues", + "selectorMatchOperator": "StartsWith", + "selector": "test" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + }, + { + "name": "Rule4", + "priority": 4, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Bot" + ] + } + ], + "action": "JSChallenge" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..af9b82f5f899 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyGet.json new file mode 100644 index 000000000000..f4b60aa49925 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/WafPolicyGet.json @@ -0,0 +1,303 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Prevention", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "jsChallengeCookieExpirationInMins": 100, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny" + } + ] + } + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + }, + { + "name": "Rule4", + "priority": 4, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Bot" + ] + } + ], + "action": "JSChallenge" + } + ], + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-942-APPLICATION-ATTACK-SQLI", + "rules": [ + { + "ruleId": "942130", + "state": "Disabled", + "action": "AnomalyScoring" + }, + { + "ruleId": "942110", + "state": "Disabled", + "action": "AnomalyScoring" + }, + { + "ruleId": "942140", + "state": "Enabled", + "action": "Log" + } + ] + }, + { + "ruleGroupName": "REQUEST-920-PROTOCOL-ENFORCEMENT", + "rules": [ + { + "ruleId": "920100", + "state": "Disabled", + "action": "AnomalyScoring" + }, + { + "ruleId": "920120", + "state": "Disabled", + "action": "AnomalyScoring" + }, + { + "ruleId": "920130", + "state": "Enabled", + "action": "Block" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "UnknownBots", + "rules": [ + { + "ruleId": "300700", + "state": "Enabled", + "action": "JSChallenge" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "testHeader1" + }, + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "StartsWith", + "selector": "testHeader2" + }, + { + "matchVariable": "RequestArgValues", + "selectorMatchOperator": "StartsWith", + "selector": "hello" + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-930-APPLICATION-ATTACK-LFI", + "rules": [ + { + "ruleId": "930120" + } + ] + }, + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "EndsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.1", + "ruleGroups": [] + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/expressRouteProviderPort.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/expressRouteProviderPort.json new file mode 100644 index 000000000000..1603d958efe9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/expressRouteProviderPort.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "locationName": "SiliconValley", + "subscriptionId": "subid", + "providerport": "abc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair1", + "type": "Microsoft.Network/expressRouteProviderPort", + "location": "uswest", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "portPairDescriptor": "bvtazureixpportpair1", + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "peeringLocation": "SiliconValley", + "overprovisionFactor": 4, + "portBandwidthInMbps": 4000, + "usedBandwidthInMbps": 2500, + "remainingBandwidthInMbps": 1500 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/expressRouteProviderPortList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/expressRouteProviderPortList.json new file mode 100644 index 000000000000..00eeb672f21d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/expressRouteProviderPortList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair1", + "type": "Microsoft.Network/expressRouteProviderPort", + "location": "uswest", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "portPairDescriptor": "bvtazureixpportpair1", + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "peeringLocation": "SiliconValley", + "overprovisionFactor": 4, + "portBandwidthInMbps": 4000, + "usedBandwidthInMbps": 2500, + "remainingBandwidthInMbps": 1500 + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair2", + "type": "Microsoft.Network/expressRouteProviderPort", + "location": "uswest", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "portPairDescriptor": "bvtazureixpportpair2", + "primaryAzurePort": "bvtazureixp02", + "secondaryAzurePort": "bvtazureixp02", + "peeringLocation": "seattle", + "overprovisionFactor": 4, + "portBandwidthInMbps": 4000, + "usedBandwidthInMbps": 1200, + "remainingBandwidthInMbps": 1800 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteCircuit.json new file mode 100644 index 000000000000..bf35a68db04a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteCircuit.json @@ -0,0 +1,2525 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Delete", + "description": "Deletes the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Get", + "description": "Gets the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_CreateOrUpdate", + "description": "Creates or updates an authorization in the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "name": "authorizationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "Parameters supplied to the create or update express route circuit authorization operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations": { + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_List", + "description": "Gets all authorizations in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitAuthorization resources.", + "schema": { + "$ref": "#/definitions/AuthorizationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Delete", + "description": "Deletes the specified peering from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit Peerings": { + "$ref": "./examples/ExpressRouteCircuitPeeringDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Get", + "description": "Gets the specified peering for the express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Peering": { + "$ref": "./examples/ExpressRouteCircuitPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "Parameters supplied to the create or update express route circuit peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRouteCircuit Peerings": { + "$ref": "./examples/ExpressRouteCircuitPeeringCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_List", + "description": "Gets all peerings in a specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Peerings": { + "$ref": "./examples/ExpressRouteCircuitPeeringList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Delete", + "description": "Deletes the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Get", + "description": "Gets the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Express Route Circuit Connection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionGet": { + "$ref": "./examples/ExpressRouteCircuitConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_CreateOrUpdate", + "description": "Creates or updates a Express Route Circuit Connection in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "name": "expressRouteCircuitConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "Parameters supplied to the create or update express route circuit connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionCreate": { + "$ref": "./examples/ExpressRouteCircuitConnectionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections": { + "get": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_List", + "description": "Gets all global reach connections associated with a private peering in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitConnections resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Connection": { + "$ref": "./examples/ExpressRouteCircuitConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections/{connectionName}": { + "get": { + "tags": [ + "PeerExpressRouteCircuitConnections" + ], + "operationId": "PeerExpressRouteCircuitConnections_Get", + "description": "Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peer express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Peer Express Route Circuit Connection resource.", + "schema": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PeerExpressRouteCircuitConnectionGet": { + "$ref": "./examples/PeerExpressRouteCircuitConnectionGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections": { + "get": { + "tags": [ + "PeerExpressRouteCircuitConnections" + ], + "operationId": "PeerExpressRouteCircuitConnections_List", + "description": "Gets all global reach peer connections associated with a private peering in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PeerExpressRouteCircuitConnections resources.", + "schema": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Peer ExpressRouteCircuit Connection": { + "$ref": "./examples/PeerExpressRouteCircuitConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}": { + "delete": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Delete", + "description": "Deletes the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Disabling' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Get", + "description": "Gets information about the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_CreateOrUpdate", + "description": "Creates or updates an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "Parameters supplied to the create or update express route circuit operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitCreate.json" + }, + "Create ExpressRouteCircuit on ExpressRoutePort": { + "$ref": "./examples/ExpressRouteCircuitCreateOnExpressRoutePort.json" + } + } + }, + "patch": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_UpdateTags", + "description": "Updates an express route circuit tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route circuit tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Express Route Circuit Tags": { + "$ref": "./examples/ExpressRouteCircuitUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitArpTable" + ], + "operationId": "ExpressRouteCircuits_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsArpTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "List ARP Table": { + "$ref": "./examples/ExpressRouteCircuitARPTableList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTable" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRouteTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "List Route Tables": { + "$ref": "./examples/ExpressRouteCircuitRouteTableList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTableSummary" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTableSummary", + "description": "Gets the currently advertised routes table summary associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRoutesTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "List Route Table Summary": { + "$ref": "./examples/ExpressRouteCircuitRouteTableSummaryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetStats", + "description": "Gets all the stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Traffic Stats": { + "$ref": "./examples/ExpressRouteCircuitStats.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetPeeringStats", + "description": "Gets all stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Peering Traffic Stats": { + "$ref": "./examples/ExpressRouteCircuitPeeringStats.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_List", + "description": "Gets all the express route circuits in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a resource group": { + "$ref": "./examples/ExpressRouteCircuitListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_ListAll", + "description": "Gets all the express route circuits in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuit resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a subscription": { + "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders": { + "get": { + "tags": [ + "ExpressRouteServiceProviders" + ], + "operationId": "ExpressRouteServiceProviders_List", + "description": "Gets all the available express route service providers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteServiceProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRoute providers": { + "$ref": "./examples/ExpressRouteProviderList.json" + } + } + } + } + }, + "definitions": { + "AuthorizationPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "authorizationUseStatus": { + "type": "string", + "description": "The authorization use status.", + "enum": [ + "Available", + "InUse" + ], + "x-ms-enum": { + "name": "AuthorizationUseStatus", + "modelAsString": true + } + }, + "connectionResourceUri": { + "readOnly": true, + "type": "string", + "description": "The reference to the ExpressRoute connection resource using the authorization." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the authorization resource." + } + }, + "description": "Properties of ExpressRouteCircuitAuthorization." + }, + "ExpressRouteCircuitAuthorization": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationPropertiesFormat", + "description": "Properties of the express route circuit authorization." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authorization in an ExpressRouteCircuit resource." + }, + "AuthorizationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The authorizations in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit." + }, + "ExpressRouteCircuitPeeringConfig": { + "properties": { + "advertisedPublicPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The reference to AdvertisedPublicPrefixes." + }, + "advertisedCommunities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The communities of bgp peering. Specified for microsoft peering." + }, + "advertisedPublicPrefixesState": { + "readOnly": true, + "type": "string", + "description": "The advertised public prefix state of the Peering resource.", + "enum": [ + "NotConfigured", + "Configuring", + "Configured", + "ValidationNeeded" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringAdvertisedPublicPrefixState", + "modelAsString": true + } + }, + "legacyMode": { + "type": "integer", + "format": "int32", + "description": "The legacy mode of the peering." + }, + "customerASN": { + "type": "integer", + "format": "int32", + "description": "The CustomerASN of the peering." + }, + "routingRegistryName": { + "type": "string", + "description": "The RoutingRegistryName of the configuration." + } + }, + "description": "Specifies the peering configuration." + }, + "Ipv6ExpressRouteCircuitPeeringConfig": { + "properties": { + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "routeFilter": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the RouteFilter resource." + }, + "state": { + "type": "string", + "description": "The state of peering.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringState", + "modelAsString": true + } + } + }, + "description": "Contains IPv6 peering config." + }, + "ExpressRouteCircuitStats": { + "properties": { + "primarybytesIn": { + "type": "integer", + "format": "int64", + "description": "The Primary BytesIn of the peering." + }, + "primarybytesOut": { + "type": "integer", + "format": "int64", + "description": "The primary BytesOut of the peering." + }, + "secondarybytesIn": { + "type": "integer", + "format": "int64", + "description": "The secondary BytesIn of the peering." + }, + "secondarybytesOut": { + "type": "integer", + "format": "int64", + "description": "The secondary BytesOut of the peering." + } + }, + "description": "Contains stats associated with the peering." + }, + "ExpressRouteCircuitPeeringPropertiesFormat": { + "properties": { + "peeringType": { + "$ref": "#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "stats": { + "$ref": "#/definitions/ExpressRouteCircuitStats", + "description": "The peering stats of express route circuit." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route circuit peering resource." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "readOnly": true, + "type": "string", + "description": "Who was the last to modify the peering." + }, + "routeFilter": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the RouteFilter resource." + }, + "ipv6PeeringConfig": { + "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + }, + "expressRouteConnection": { + "$ref": "./virtualWan.json#/definitions/ExpressRouteConnectionId", + "description": "The ExpressRoute connection." + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "The list of circuit connections associated with Azure Private Peering for this circuit." + }, + "peeredConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnection" + }, + "readOnly": true, + "description": "The list of peered circuit connections associated with Azure Private Peering for this circuit." + } + }, + "description": "Properties of the express route circuit peering." + }, + "ExpressRouteCircuitPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat", + "description": "Properties of the express route circuit peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRouteCircuit resource." + }, + "ExpressRouteCircuitPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The peerings in an express route circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit." + }, + "ExpressRoutePeeringType": { + "type": "string", + "description": "The peering type.", + "enum": [ + "AzurePublicPeering", + "AzurePrivatePeering", + "MicrosoftPeering" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringType", + "modelAsString": true + } + }, + "ExpressRoutePeeringState": { + "type": "string", + "description": "The state of peering.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringState", + "modelAsString": true + } + }, + "Ipv6CircuitConnectionConfig": { + "description": "IPv6 Circuit Connection properties for global reach.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "/125 IP address space to carve out customer addresses for global reach." + }, + "circuitConnectionStatus": { + "readOnly": true, + "$ref": "#/definitions/CircuitConnectionStatus", + "description": "Express Route Circuit connection state." + } + } + }, + "ExpressRouteCircuitConnectionPropertiesFormat": { + "properties": { + "expressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection." + }, + "peerExpressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." + }, + "addressPrefix": { + "type": "string", + "description": "/29 IP address space to carve out Customer addresses for tunnels." + }, + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "ipv6CircuitConnectionConfig": { + "$ref": "#/definitions/Ipv6CircuitConnectionConfig", + "description": "IPv6 Address PrefixProperties of the express route circuit connection." + }, + "circuitConnectionStatus": { + "$ref": "#/definitions/CircuitConnectionStatus", + "description": "Express Route Circuit connection state." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route circuit connection resource." + } + }, + "description": "Properties of the express route circuit connection." + }, + "ExpressRouteCircuitConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat", + "description": "Properties of the express route circuit connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Express Route Circuit Connection in an ExpressRouteCircuitPeering resource." + }, + "ExpressRouteCircuitConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "The global reach connection associated with Private Peering in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListConnections API service call retrieves all global reach connections that belongs to a Private Peering for an ExpressRouteCircuit." + }, + "PeerExpressRouteCircuitConnectionPropertiesFormat": { + "properties": { + "expressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the circuit." + }, + "peerExpressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." + }, + "addressPrefix": { + "type": "string", + "description": "/29 IP address space to carve out Customer addresses for tunnels." + }, + "circuitConnectionStatus": { + "$ref": "#/definitions/CircuitConnectionStatus", + "description": "Express Route Circuit connection state." + }, + "connectionName": { + "type": "string", + "description": "The name of the express route circuit connection resource." + }, + "authResourceGuid": { + "type": "string", + "description": "The resource guid of the authorization used for the express route circuit connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the peer express route circuit connection resource." + } + }, + "description": "Properties of the peer express route circuit connection." + }, + "PeerExpressRouteCircuitConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PeerExpressRouteCircuitConnectionPropertiesFormat", + "description": "Properties of the peer express route circuit connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource." + }, + "PeerExpressRouteCircuitConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnection" + }, + "description": "The global reach peer circuit connection associated with Private Peering in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeeredConnections API service call retrieves all global reach peer circuit connections that belongs to a Private Peering for an ExpressRouteCircuit." + }, + "ExpressRouteCircuitSku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU." + }, + "tier": { + "type": "string", + "description": "The tier of the SKU.", + "enum": [ + "Standard", + "Premium", + "Basic", + "Local" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuTier", + "modelAsString": true + } + }, + "family": { + "type": "string", + "description": "The family of the SKU.", + "enum": [ + "UnlimitedData", + "MeteredData" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuFamily", + "modelAsString": true + } + } + }, + "description": "Contains SKU in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitServiceProviderProperties": { + "properties": { + "serviceProviderName": { + "type": "string", + "description": "The serviceProviderName." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location." + }, + "bandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "The BandwidthInMbps." + } + }, + "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitPropertiesFormat": { + "properties": { + "allowClassicOperations": { + "type": "boolean", + "description": "Allow classic operations." + }, + "circuitProvisioningState": { + "type": "string", + "description": "The CircuitProvisioningState state of the resource." + }, + "serviceProviderProvisioningState": { + "$ref": "#/definitions/ServiceProviderProvisioningState", + "description": "The ServiceProviderProvisioningState state of the resource." + }, + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The list of authorizations." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The list of peerings." + }, + "serviceKey": { + "type": "string", + "description": "The ServiceKey." + }, + "serviceProviderNotes": { + "type": "string", + "description": "The ServiceProviderNotes." + }, + "serviceProviderProperties": { + "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties", + "description": "The ServiceProviderProperties." + }, + "expressRoutePort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource." + }, + "bandwidthInGbps": { + "type": "number", + "description": "The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource." + }, + "stag": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The identifier of the circuit traffic. Outer tag for QinQ encapsulation." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route circuit resource." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "globalReachEnabled": { + "type": "boolean", + "description": "Flag denoting global reach status." + }, + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "authorizationStatus": { + "readOnly": true, + "type": "string", + "description": "The authorization status of the Circuit." + }, + "enableDirectPortRateLimit": { + "type": "boolean", + "description": "Flag denoting rate-limiting status of the ExpressRoute direct-port circuit." + } + }, + "description": "Properties of ExpressRouteCircuit." + }, + "ExpressRouteCircuit": { + "properties": { + "sku": { + "$ref": "#/definitions/ExpressRouteCircuitSku", + "description": "The SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat", + "description": "Properties of the express route circuit." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCircuit resource." + }, + "ExpressRouteCircuitArpTable": { + "properties": { + "age": { + "type": "integer", + "format": "int32", + "description": "Entry age in minutes." + }, + "interface": { + "type": "string", + "description": "Interface address." + }, + "ipAddress": { + "type": "string", + "description": "The IP address." + }, + "macAddress": { + "type": "string", + "description": "The MAC address." + } + }, + "description": "The ARP table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsArpTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitArpTable" + }, + "description": "A list of the ARP tables." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListArpTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTable": { + "properties": { + "network": { + "type": "string", + "description": "IP address of a network entity." + }, + "nextHop": { + "type": "string", + "description": "NextHop address." + }, + "locPrf": { + "type": "string", + "description": "Local preference value as set with the set local-preference route-map configuration command." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "Route Weight." + }, + "path": { + "type": "string", + "description": "Autonomous system paths to the destination network." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsRoutesTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTable" + }, + "description": "The list of routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of the neighbor." + }, + "v": { + "type": "integer", + "format": "int32", + "description": "BGP version number spoken to the neighbor." + }, + "as": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "statePfxRcd": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "A list of ExpressRouteCircuits in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCircuit API service call." + }, + "ExpressRouteServiceProviderBandwidthsOffered": { + "properties": { + "offerName": { + "type": "string", + "description": "The OfferName." + }, + "valueInMbps": { + "type": "integer", + "format": "int32", + "description": "The ValueInMbps." + } + }, + "description": "Contains bandwidths offered in ExpressRouteServiceProvider resources." + }, + "ExpressRouteServiceProviderPropertiesFormat": { + "properties": { + "peeringLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of peering locations." + }, + "bandwidthsOffered": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProviderBandwidthsOffered" + }, + "description": "A list of bandwidths offered." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route service provider resource." + } + }, + "description": "Properties of ExpressRouteServiceProvider." + }, + "ExpressRouteServiceProvider": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat", + "description": "Properties of the express route service provider." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A ExpressRouteResourceProvider object." + }, + "ExpressRouteServiceProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProvider" + }, + "description": "A list of ExpressRouteResourceProvider resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListExpressRouteServiceProvider API service call." + }, + "CircuitConnectionStatus": { + "type": "string", + "readOnly": true, + "description": "Express Route Circuit connection state.", + "enum": [ + "Connected", + "Connecting", + "Disconnected" + ], + "x-ms-enum": { + "name": "CircuitConnectionStatus", + "modelAsString": true + } + }, + "ServiceProviderProvisioningState": { + "type": "string", + "description": "The ServiceProviderProvisioningState state of the resource.", + "enum": [ + "NotProvisioned", + "Provisioning", + "Provisioned", + "Deprovisioning" + ], + "x-ms-enum": { + "name": "ServiceProviderProvisioningState", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteCrossConnection.json new file mode 100644 index 000000000000..11f0f9af2cd8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteCrossConnection.json @@ -0,0 +1,1016 @@ +{ + "swagger": "2.0", + "info": { + "title": "ExpressRouteCrossConnection REST APIs", + "description": "The Microsoft Azure ExpressRouteCrossConnection Resource Provider REST APIs describes the operations for the connectivity provider to provision ExpressRoute circuit, create and modify BGP peering entities and troubleshoot connectivity on customer's ExpressRoute circuit.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_List", + "description": "Retrieves all the ExpressRouteCrossConnections in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=name eq '{circuitServiceKey}'.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionList": { + "$ref": "./examples/ExpressRouteCrossConnectionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_ListByResourceGroup", + "description": "Retrieves all the ExpressRouteCrossConnections in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionListByResourceGroup": { + "$ref": "./examples/ExpressRouteCrossConnectionListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_Get", + "description": "Gets details about the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group (peering location of the circuit)." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection (service key of the circuit)." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_CreateOrUpdate", + "description": "Update the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "Parameters supplied to the update express route crossConnection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_UpdateTags", + "description": "Updates an express route cross connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cross connection." + }, + { + "name": "crossConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route cross connection tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnectionTags": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_List", + "description": "Gets all peerings in a specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnectionPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringList": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Delete", + "description": "Deletes the specified peering from the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Get", + "description": "Gets the specified peering for the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "Parameters supplied to the create or update ExpressRouteCrossConnection peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringCreate": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionArpTable" + ], + "operationId": "ExpressRouteCrossConnections_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsArpTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsArpTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsArpTable.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTableSummary" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTableSummary", + "description": "Gets the route table summary associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTableSummary": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTableSummary.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTable" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTable.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ExpressRouteCrossConnectionRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of Neighbor router." + }, + "asn": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "stateOrPrefixesReceived": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCrossConnectionsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Cross Connections." + }, + "ExpressRouteCircuitReference": { + "properties": { + "id": { + "type": "string", + "description": "Corresponding Express Route Circuit Id." + } + }, + "description": "Reference to an express route circuit." + }, + "ExpressRouteCrossConnectionProperties": { + "properties": { + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the secondary port." + }, + "sTag": { + "readOnly": true, + "type": "integer", + "description": "The identifier of the circuit traffic." + }, + "peeringLocation": { + "readOnly": true, + "type": "string", + "description": "The peering location of the ExpressRoute circuit." + }, + "bandwidthInMbps": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The circuit bandwidth In Mbps." + }, + "expressRouteCircuit": { + "$ref": "#/definitions/ExpressRouteCircuitReference", + "description": "The ExpressRouteCircuit." + }, + "serviceProviderProvisioningState": { + "$ref": "./expressRouteCircuit.json#/definitions/ServiceProviderProvisioningState", + "description": "The provisioning state of the circuit in the connectivity provider system." + }, + "serviceProviderNotes": { + "type": "string", + "description": "Additional read only notes set by the connectivity provider." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route cross connection resource." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The list of peerings." + } + }, + "description": "Properties of ExpressRouteCrossConnection." + }, + "ExpressRouteCrossConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionProperties", + "description": "Properties of the express route cross connection." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCrossConnection resource." + }, + "ExpressRouteCrossConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "A list of ExpressRouteCrossConnection resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCrossConnection API service call." + }, + "ExpressRouteCrossConnectionPeeringProperties": { + "properties": { + "peeringType": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route cross connection peering resource." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "readOnly": true, + "type": "string", + "description": "Who was the last to modify the peering." + }, + "ipv6PeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + } + }, + "description": "Properties of express route cross connection peering." + }, + "ExpressRouteCrossConnectionPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringProperties", + "description": "Properties of the express route cross connection peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRoute Cross Connection resource." + }, + "ExpressRouteCrossConnectionPeeringList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The peerings in an express route cross connection." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRoutePort.json new file mode 100644 index 000000000000..722f3b9b0308 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRoutePort.json @@ -0,0 +1,1310 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_List", + "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of all ExpressRoutePort peering locations.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortsLocationList": { + "$ref": "./examples/ExpressRoutePortsLocationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations/{locationName}": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_Get", + "description": "Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the requested ExpressRoutePort peering location." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort peering location.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortsLocationGet": { + "$ref": "./examples/ExpressRoutePortsLocationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}": { + "delete": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Delete", + "description": "Deletes the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ExpressRoutePortDelete": { + "$ref": "./examples/ExpressRoutePortDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Get", + "description": "Retrieves the requested ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of ExpressRoutePort." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortGet": { + "$ref": "./examples/ExpressRoutePortGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_CreateOrUpdate", + "description": "Creates or updates the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "Parameters supplied to the create ExpressRoutePort operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ExpressRoutePortCreate": { + "$ref": "./examples/ExpressRoutePortCreate.json" + }, + "ExpressRoutePortUpdateLink": { + "$ref": "./examples/ExpressRoutePortUpdateLink.json" + } + } + }, + "patch": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_UpdateTags", + "description": "Update ExpressRoutePort tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update ExpressRoutePort resource tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortUpdateTags": { + "$ref": "./examples/ExpressRoutePortUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_ListByResourceGroup", + "description": "List all the ExpressRoutePort resources in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortListByResourceGroup": { + "$ref": "./examples/ExpressRoutePortListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_List", + "description": "List all the ExpressRoutePort resources in the specified subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortList": { + "$ref": "./examples/ExpressRoutePortList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_Get", + "description": "Retrieves the specified ExpressRouteLink resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "linkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteLink resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRouteLink resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { + "$ref": "./examples/ExpressRouteLinkGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_List", + "description": "Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteLink resources. If there are no ExpressRouteLink resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteLinkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { + "$ref": "./examples/ExpressRouteLinkList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/generateLoa": { + "post": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_GenerateLOA", + "description": "Generate a letter of authorization for the requested ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of ExpressRoutePort." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateExpressRoutePortsLOARequest" + }, + "description": "Request parameters supplied to generate a letter of authorization." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the content as a base64 encoded string.", + "schema": { + "$ref": "#/definitions/GenerateExpressRoutePortsLOAResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateExpressRoutePortLOA": { + "$ref": "./examples/GenerateExpressRoutePortsLOA.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}": { + "delete": { + "tags": [ + "ExpressRoutePortAuthorizations" + ], + "operationId": "ExpressRoutePortAuthorizations_Delete", + "description": "Deletes the specified authorization from the specified express route port.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route port." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRoutePort Authorization": { + "$ref": "./examples/ExpressRoutePortAuthorizationDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRoutePortAuthorizations" + ], + "operationId": "ExpressRoutePortAuthorizations_Get", + "description": "Gets the specified authorization from the specified express route port.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route port." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRoutePortAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRoutePort Authorization": { + "$ref": "./examples/ExpressRoutePortAuthorizationGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRoutePortAuthorizations" + ], + "operationId": "ExpressRoutePortAuthorizations_CreateOrUpdate", + "description": "Creates or updates an authorization in the specified express route port.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route port." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "name": "authorizationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + }, + "description": "Parameters supplied to the create or update express route port authorization operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoutePortAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePortAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRoutePort Authorization": { + "$ref": "./examples/ExpressRoutePortAuthorizationCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations": { + "get": { + "tags": [ + "ExpressRoutePortAuthorizations" + ], + "operationId": "ExpressRoutePortAuthorizations_List", + "description": "Gets all authorizations in an express route port.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route port." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePortAuthorization resources.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorizationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRoutePort Authorization": { + "$ref": "./examples/ExpressRoutePortAuthorizationList.json" + } + } + } + } + }, + "definitions": { + "ExpressRoutePortsLocationBandwidths": { + "title": "ExpressRoutePorts Location Bandwidths", + "description": "Real-time inventory of available ExpressRoute port bandwidths.", + "properties": { + "offerName": { + "type": "string", + "readOnly": true, + "description": "Bandwidth descriptive name." + }, + "valueInGbps": { + "type": "integer", + "readOnly": true, + "description": "Bandwidth value in Gbps." + } + } + }, + "ExpressRoutePortsLocationPropertiesFormat": { + "title": "ExpressRoutePorts Location Properties", + "description": "Properties specific to ExpressRoutePorts peering location resources.", + "properties": { + "address": { + "type": "string", + "readOnly": true, + "description": "Address of peering location." + }, + "contact": { + "type": "string", + "readOnly": true, + "description": "Contact details of peering locations." + }, + "availableBandwidths": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocationBandwidths" + }, + "description": "The inventory of available ExpressRoutePort bandwidths." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route port location resource." + } + } + }, + "ExpressRoutePortsLocation": { + "title": "ExpressRoutePorts Peering Location", + "description": "Definition of the ExpressRoutePorts peering location resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortsLocationPropertiesFormat", + "description": "ExpressRoutePort peering location properties." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortsLocationListResult": { + "title": "ExpressRoutePorts Location List Result", + "description": "Response for ListExpressRoutePortsLocations API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + }, + "description": "The list of all ExpressRoutePort peering locations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRouteLinkMacSecConfig": { + "description": "ExpressRouteLink Mac Security Configuration.", + "title": "Definition of ExpressRouteLink Mac Security configuration.", + "properties": { + "cknSecretIdentifier": { + "type": "string", + "description": "Keyvault Secret Identifier URL containing Mac security CKN key." + }, + "cakSecretIdentifier": { + "type": "string", + "description": "Keyvault Secret Identifier URL containing Mac security CAK key." + }, + "cipher": { + "type": "string", + "description": "Mac security cipher.", + "enum": [ + "GcmAes256", + "GcmAes128", + "GcmAesXpn128", + "GcmAesXpn256" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkMacSecCipher", + "modelAsString": true + } + }, + "sciState": { + "type": "string", + "description": "Sci mode enabled/disabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkMacSecSciState", + "modelAsString": true + } + } + } + }, + "ExpressRouteLinkPropertiesFormat": { + "title": "ExpressRouteLink Resource Properties", + "description": "Properties specific to ExpressRouteLink resources.", + "properties": { + "routerName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router associated with physical port." + }, + "interfaceName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router interface." + }, + "patchPanelId": { + "readOnly": true, + "type": "string", + "description": "Mapping between physical port to patch panel port." + }, + "rackId": { + "readOnly": true, + "type": "string", + "description": "Mapping of physical patch panel to rack." + }, + "coloLocation": { + "readOnly": true, + "type": "string", + "description": "Cololocation for ExpressRoute Hybrid Direct." + }, + "connectorType": { + "readOnly": true, + "type": "string", + "description": "Physical fiber port type.", + "enum": [ + "LC", + "SC" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkConnectorType", + "modelAsString": true + } + }, + "adminState": { + "type": "string", + "description": "Administrative state of the physical port.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkAdminState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route link resource." + }, + "macSecConfig": { + "$ref": "#/definitions/ExpressRouteLinkMacSecConfig", + "description": "MacSec configuration." + } + } + }, + "ExpressRouteLink": { + "title": "ExpressRouteLink", + "description": "ExpressRouteLink child resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteLinkPropertiesFormat", + "description": "ExpressRouteLink properties." + }, + "name": { + "type": "string", + "description": "Name of child port resource that is unique among child port resources of the parent." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ] + }, + "ExpressRouteLinkListResult": { + "title": "ExpressRouteLink List Result", + "description": "Response for ListExpressRouteLinks API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + }, + "description": "The list of ExpressRouteLink sub-resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRoutePortPropertiesFormat": { + "title": "ExpressRoutePort Properties", + "description": "Properties specific to ExpressRoutePort resources.", + "properties": { + "peeringLocation": { + "type": "string", + "description": "The name of the peering location that the ExpressRoutePort is mapped to physically." + }, + "bandwidthInGbps": { + "type": "integer", + "description": "Bandwidth of procured ports in Gbps." + }, + "provisionedBandwidthInGbps": { + "readOnly": true, + "type": "number", + "description": "Aggregate Gbps of associated circuit bandwidths." + }, + "mtu": { + "readOnly": true, + "type": "string", + "description": "Maximum transmission unit of the physical port pair(s)." + }, + "encapsulation": { + "type": "string", + "description": "Encapsulation method on physical ports.", + "enum": [ + "Dot1Q", + "QinQ" + ], + "x-ms-enum": { + "name": "ExpressRoutePortsEncapsulation", + "modelAsString": true + } + }, + "etherType": { + "readOnly": true, + "type": "string", + "description": "Ether type of the physical port." + }, + "allocationDate": { + "readOnly": true, + "type": "string", + "description": "Date of the physical port allocation to be used in Letter of Authorization." + }, + "links": { + "title": "ExpressRouteLink Sub-Resources", + "description": "The set of physical links of the ExpressRoutePort resource.", + "readOnly": false, + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + } + }, + "circuits": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route port resource." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the express route port resource." + }, + "billingType": { + "type": "string", + "description": "The billing type of the ExpressRoutePort resource.", + "enum": [ + "MeteredData", + "UnlimitedData" + ], + "x-ms-enum": { + "name": "ExpressRoutePortsBillingType", + "modelAsString": true + } + } + } + }, + "ExpressRoutePort": { + "title": "ExpressRoute Port", + "description": "ExpressRoutePort resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortPropertiesFormat", + "description": "ExpressRoutePort properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of ExpressRoutePort, if configured." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortListResult": { + "title": "ExpressRoute Port List Result", + "description": "Response for ListExpressRoutePorts API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "A list of ExpressRoutePort resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "GenerateExpressRoutePortsLOARequest": { + "description": "The customer name to be printed on a letter of authorization.", + "properties": { + "customerName": { + "type": "string", + "description": "The customer name." + } + }, + "required": [ + "customerName" + ] + }, + "GenerateExpressRoutePortsLOAResult": { + "description": "Response for GenerateExpressRoutePortsLOA API service call.", + "properties": { + "encodedContent": { + "type": "string", + "description": "The content as a base64 encoded string." + } + } + }, + "ExpressRoutePortAuthorizationPropertiesFormat": { + "type": "object", + "title": "ExpressRoute Port Authorization Properties", + "description": "Properties of ExpressRoutePort Authorization.", + "properties": { + "authorizationKey": { + "readOnly": true, + "type": "string", + "description": "The authorization key." + }, + "authorizationUseStatus": { + "readOnly": true, + "type": "string", + "description": "The authorization use status.", + "enum": [ + "Available", + "InUse" + ], + "x-ms-enum": { + "name": "ExpressRoutePortAuthorizationUseStatus", + "modelAsString": true + } + }, + "circuitResourceUri": { + "readOnly": true, + "type": "string", + "description": "The reference to the ExpressRoute circuit resource using the authorization." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the authorization resource." + } + } + }, + "ExpressRoutePortAuthorization": { + "type": "object", + "title": "ExpressRoute Port Authorization", + "description": "ExpressRoutePort Authorization resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortAuthorizationPropertiesFormat", + "description": "ExpressRoutePort properties." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ] + }, + "ExpressRoutePortAuthorizationListResult": { + "type": "object", + "title": "ExpressRoute Port Authorization List Result", + "description": "Response for ListExpressRoutePortAuthorizations API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + }, + "description": "The authorizations in an ExpressRoute Port." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteProviderPort.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteProviderPort.json new file mode 100644 index 000000000000..3c8e011eb68b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRouteProviderPort.json @@ -0,0 +1,225 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts": { + "get": { + "tags": [ + "ExpressRouteProviderPorts" + ], + "operationId": "ExpressRouteProviderPortsLocation_List", + "description": "Retrieves all the ExpressRouteProviderPorts in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=location eq '{state}'." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteProviderPort resources at a location. If there are no ports for the provider, an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteProviderPortListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteProviderPortList": { + "$ref": "./examples/expressRouteProviderPortList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts/{providerport}": { + "get": { + "tags": [ + "ExpressRouteProviderPorts" + ], + "operationId": "ExpressRouteProviderPort", + "description": "Retrieves detail of a provider port.", + "parameters": [ + { + "name": "providerport", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the provider port." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns detail of individual provider port resources. If there is no port, an empty result is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteProviderPort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteProviderPort": { + "$ref": "./examples/expressRouteProviderPort.json" + } + } + } + } + }, + "definitions": { + "ExpressRouteProviderPortProperties": { + "type": "object", + "properties": { + "portPairDescriptor": { + "readOnly": true, + "type": "string", + "description": "The name of the port pair." + }, + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the secondary port." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location of the port pair." + }, + "overprovisionFactor": { + "type": "integer", + "format": "int32", + "description": "Overprovisioning factor for the port pair." + }, + "portBandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "Bandwidth of the port in Mbps" + }, + "usedBandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "Used Bandwidth of the port in Mbps" + }, + "remainingBandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "Remaining Bandwidth of the port in Mbps" + } + }, + "description": "Properties of ExpressRouteProviderPort." + }, + "ExpressRouteProviderPort": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteProviderPortProperties", + "description": "Properties of the express route Service Provider Port." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteProviderPort resource." + }, + "ExpressRouteProviderPortListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteProviderPort" + }, + "description": "A list of ExpressRouteProviderPort resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteProviderPort API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/firewallPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/firewallPolicy.json new file mode 100644 index 000000000000..ba43834e6f4c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/firewallPolicy.json @@ -0,0 +1,2719 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}": { + "delete": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_Delete", + "description": "Deletes the specified Firewall Policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Firewall Policy": { + "$ref": "./examples/FirewallPolicyDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_Get", + "description": "Gets the specified Firewall Policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Firewall Policy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get FirewallPolicy": { + "$ref": "./examples/FirewallPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_CreateOrUpdate", + "description": "Creates or updates the specified Firewall Policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallPolicy" + }, + "description": "Parameters supplied to the create or update Firewall Policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting FirewallPolicy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting FirewallPolicy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create FirewallPolicy": { + "$ref": "./examples/FirewallPolicyPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_UpdateTags", + "description": "Updates tags of a Azure Firewall Policy resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update Azure Firewall Policy tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting FirewallPolicy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update FirewallPolicy Tags": { + "$ref": "./examples/FirewallPolicyPatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies": { + "get": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_List", + "description": "Lists all Firewall Policies in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of FirewallPolicy resources.", + "schema": { + "$ref": "#/definitions/FirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Firewall Policies for a given resource group": { + "$ref": "./examples/FirewallPolicyListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/firewallPolicies": { + "get": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_ListAll", + "description": "Gets all the Firewall Policies in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of FirewallPolicy resources.", + "schema": { + "$ref": "#/definitions/FirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Firewall Policies for a given subscription": { + "$ref": "./examples/FirewallPolicyListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}": { + "delete": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_Delete", + "description": "Deletes the specified FirewallPolicyRuleCollectionGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "ruleCollectionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the FirewallPolicyRuleCollectionGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete FirewallPolicyRuleCollectionGroup": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_Get", + "description": "Gets the specified FirewallPolicyRuleCollectionGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "ruleCollectionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the FirewallPolicyRuleCollectionGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a FirewallPolicyRuleCollectionGroup resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get FirewallPolicyRuleCollectionGroup": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupGet.json" + }, + "Get FirewallPolicyRuleCollectionGroup With IpGroups": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json" + }, + "Get FirewallPolicyNatRuleCollectionGroup": { + "$ref": "./examples/FirewallPolicyNatRuleCollectionGroupGet.json" + }, + "Get FirewallPolicyRuleCollectionGroup With Web Categories": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json" + } + } + }, + "put": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_CreateOrUpdate", + "description": "Creates or updates the specified FirewallPolicyRuleCollectionGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "ruleCollectionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the FirewallPolicyRuleCollectionGroup." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + }, + "description": "Parameters supplied to the create or update FirewallPolicyRuleCollectionGroup operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting FirewallPolicyRuleCollectionGroup resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting FirewallPolicyRuleCollectionGroup resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Firewall Policy Rule Collection Group": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupPut.json" + }, + "Create Firewall Policy Rule Collection Group With IP Groups": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json" + }, + "Create Firewall Policy Nat Rule Collection Group": { + "$ref": "./examples/FirewallPolicyNatRuleCollectionGroupPut.json" + }, + "Create Firewall Policy Rule Collection Group With Web Categories": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json" + }, + "Create Firewall Policy Rule Collection Group With http header to insert": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithHttpHeadersToInsert.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups": { + "get": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_List", + "description": "Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of FirewallPolicyRuleCollectionGroup resources.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all FirewallPolicyRuleCollectionGroups for a given FirewallPolicy": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupList.json" + }, + "List all FirewallPolicyRuleCollectionGroups with IpGroups for a given FirewallPolicy": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json" + }, + "List all FirewallPolicyRuleCollectionGroup With Web Categories": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/listIdpsSignatures": { + "post": { + "operationId": "FirewallPolicyIdpsSignatures_List", + "description": "Retrieves the current status of IDPS signatures for the relevant policy. Maximal amount of returned signatures is 1000.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IDPSQueryObject" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns an IDPS Query Response", + "schema": { + "$ref": "#/definitions/QueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "query signature overrides": { + "$ref": "./examples/FirewallPolicyQuerySignatureOverrides.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default": { + "patch": { + "operationId": "FirewallPolicyIdpsSignaturesOverrides_Patch", + "description": "Will update the status of policy's signature overrides for IDPS", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "description": "Will contain all properties of the object to put", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Will return the policy current signature overrides object", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "patch signature overrides": { + "$ref": "./examples/FirewallPolicySignatureOverridesPatch.json" + } + } + }, + "put": { + "description": "Will override/create a new signature overrides for the policy's IDPS", + "operationId": "FirewallPolicyIdpsSignaturesOverrides_Put", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "description": "Will contain all properties of the object to put", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Describes the new state of the signature overrides after the PUT operation", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "put signature overrides": { + "$ref": "./examples/FirewallPolicySignatureOverridesPut.json" + } + } + }, + "get": { + "description": "Returns all signatures overrides for a specific policy.", + "operationId": "FirewallPolicyIdpsSignaturesOverrides_Get", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Will return the policy current signature overrides object", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "get signature overrides": { + "$ref": "./examples/FirewallPolicySignatureOverridesGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/listIdpsFilterOptions": { + "post": { + "operationId": "FirewallPolicyIdpsSignaturesFilterValues_List", + "description": "Retrieves the current filter values for the signatures overrides", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SignatureOverridesFilterValuesQuery" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all valid filter values for the requested column", + "schema": { + "$ref": "#/definitions/SignatureOverridesFilterValuesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "query signature overrides": { + "$ref": "./examples/FirewallPolicyQuerySignatureOverridesFilterValues.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides": { + "get": { + "description": "Returns all signatures overrides objects for a specific policy as a list containing a single value.", + "operationId": "FirewallPolicyIdpsSignaturesOverrides_List", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Will return the policy current signature overrides object inside a list", + "schema": { + "$ref": "#/definitions/SignaturesOverridesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "get signature overrides": { + "$ref": "./examples/FirewallPolicySignatureOverridesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/firewallPolicyDrafts/default": { + "put": { + "description": "Create or update a draft Firewall Policy.", + "operationId": "FirewallPolicyDrafts_CreateOrUpdate", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "pattern": "^[^_\\W][\\w-._]{0,79}(?/." + }, + "privateIPAddressPrefixLength": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "x-nullable": true, + "description": "The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "privateIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "Subnet bound to the IP configuration." + }, + "primary": { + "type": "boolean", + "description": "Whether this is a primary customer address on the network interface." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "Public IP address bound to the IP configuration." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "Application security groups in which the IP configuration is included." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network interface IP configuration." + }, + "privateLinkConnectionProperties": { + "$ref": "#/definitions/NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties", + "description": "PrivateLinkConnection properties for the network interface.", + "readOnly": true + } + }, + "description": "Properties of IP configuration." + }, + "NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties": { + "properties": { + "groupId": { + "type": "string", + "readOnly": true, + "description": "The group ID for current private link connection." + }, + "requiredMemberName": { + "type": "string", + "readOnly": true, + "description": "The required member name for current private link connection." + }, + "fqdns": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "List of FQDNs for current private link connection." + } + }, + "description": "PrivateLinkConnection properties for the network interface." + }, + "NetworkInterfaceIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat", + "description": "Network interface IP configuration properties." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IPConfiguration in a network interface." + }, + "NetworkInterfaceDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection." + }, + "appliedDnsServers": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs." + }, + "internalDnsNameLabel": { + "type": "string", + "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." + }, + "internalFqdn": { + "readOnly": true, + "type": "string", + "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." + }, + "internalDomainNameSuffix": { + "readOnly": true, + "type": "string", + "description": "Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix." + } + }, + "description": "DNS settings of a network interface." + }, + "NetworkInterfacePropertiesFormat": { + "properties": { + "virtualMachine": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to a virtual machine.", + "readOnly": true + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference to the NetworkSecurityGroup resource." + }, + "privateEndpoint": { + "readOnly": true, + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", + "description": "A reference to the private endpoint to which the network interface is linked." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of IPConfigurations of the network interface." + }, + "tapConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "A list of TapConfigurations of the network interface." + }, + "dnsSettings": { + "$ref": "#/definitions/NetworkInterfaceDnsSettings", + "description": "The DNS settings in network interface." + }, + "macAddress": { + "readOnly": true, + "type": "string", + "description": "The MAC address of the network interface." + }, + "primary": { + "readOnly": true, + "type": "boolean", + "description": "Whether this is a primary network interface on a virtual machine." + }, + "vnetEncryptionSupported": { + "readOnly": true, + "type": "boolean", + "description": "Whether the virtual machine this nic is attached to supports encryption." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking." + }, + "disableTcpStateTracking": { + "type": "boolean", + "description": "Indicates whether to disable tcp state tracking." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Indicates whether IP forwarding is enabled on this network interface." + }, + "hostedWorkloads": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "A list of references to linked BareMetal resources." + }, + "dscpConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to the dscp configuration to which the network interface is linked.", + "readOnly": true + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network interface resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network interface resource." + }, + "workloadType": { + "type": "string", + "description": "WorkloadType of the NetworkInterface for BareMetal resources" + }, + "nicType": { + "type": "string", + "description": "Type of Network Interface resource.", + "enum": [ + "Standard", + "Elastic" + ], + "x-ms-enum": { + "name": "NetworkInterfaceNicType", + "modelAsString": true + } + }, + "privateLinkService": { + "$ref": "./privateLinkService.json#/definitions/PrivateLinkService", + "description": "Privatelinkservice of the network interface resource." + }, + "migrationPhase": { + "type": "string", + "description": "Migration phase of Network Interface resource.", + "enum": [ + "None", + "Prepare", + "Commit", + "Abort", + "Committed" + ], + "x-ms-enum": { + "name": "NetworkInterfaceMigrationPhase", + "modelAsString": true + } + }, + "auxiliaryMode": { + "type": "string", + "description": "Auxiliary mode of Network Interface resource.", + "enum": [ + "None", + "MaxConnections", + "Floating", + "AcceleratedConnections" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true + } + }, + "auxiliarySku": { + "type": "string", + "description": "Auxiliary sku of Network Interface resource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true + } + } + }, + "description": "NetworkInterface properties." + }, + "NetworkInterface": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the network interface." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfacePropertiesFormat", + "description": "Properties of the network interface." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A network interface in a resource group." + }, + "NetworkInterfaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "A list of network interfaces in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListNetworkInterface API service call." + }, + "NetworkInterfaceTapConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "A list of tap configurations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list tap configurations API service call." + }, + "NetworkInterfaceIPConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of ip configurations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "NetworkInterfaceLoadBalancerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/LoadBalancer" + }, + "description": "A list of load balancers." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "EffectiveNetworkSecurityGroup": { + "properties": { + "networkSecurityGroup": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of network security group that is applied." + }, + "association": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroupAssociation", + "description": "Associated resources." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "A collection of effective security rules." + }, + "tagMap": { + "type": "string", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of IP Addresses within the tag (key)." + }, + "description": "Mapping of tags to list of IP Addresses included within the tag." + } + }, + "description": "Effective network security group." + }, + "EffectiveNetworkSecurityGroupAssociation": { + "properties": { + "networkManager": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the Azure network manager if assigned." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the subnet if assigned." + }, + "networkInterface": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the network interface if assigned." + } + }, + "description": "The effective network security group association." + }, + "EffectiveNetworkSecurityRule": { + "properties": { + "name": { + "type": "string", + "description": "The name of the security rule specified by the user (if created by the user)." + }, + "protocol": { + "type": "string", + "description": "The network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "All" + ], + "x-ms-enum": { + "name": "EffectiveSecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The source address prefix." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix." + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." + }, + "expandedSourceAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The expanded source address prefix." + }, + "expandedDestinationAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Expanded destination address prefix." + }, + "access": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleAccess", + "description": "Whether network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule." + }, + "direction": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleDirection", + "description": "The direction of the rule." + } + }, + "description": "Effective network security rules." + }, + "EffectiveNetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroup" + }, + "description": "A list of effective network security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective network security groups API service call." + }, + "EffectiveRoute": { + "properties": { + "name": { + "type": "string", + "description": "The name of the user defined route. This is optional." + }, + "disableBgpRoutePropagation": { + "type": "boolean", + "description": "If true, on-premises routes are not propagated to the network interfaces in the subnet." + }, + "source": { + "type": "string", + "description": "Who created the route.", + "enum": [ + "Unknown", + "User", + "VirtualNetworkGateway", + "Default" + ], + "x-ms-enum": { + "name": "EffectiveRouteSource", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "The value of effective route.", + "enum": [ + "Active", + "Invalid" + ], + "x-ms-enum": { + "name": "EffectiveRouteState", + "modelAsString": true + } + }, + "addressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The address prefixes of the effective routes in CIDR notation." + }, + "nextHopIpAddress": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IP address of the next hop of the effective route." + }, + "nextHopType": { + "$ref": "./routeTable.json#/definitions/RouteNextHopType", + "description": "The type of Azure hop the packet should be sent to." + } + }, + "description": "Effective Route." + }, + "EffectiveRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveRoute" + }, + "description": "A list of effective routes." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective route API service call." + }, + "IPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method.", + "default": "Dynamic" + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference to the public IP resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IP configuration resource." + } + }, + "description": "Properties of IP configuration." + }, + "IPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IPConfigurationPropertiesFormat", + "description": "Properties of the IP configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManager.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManager.json new file mode 100644 index 000000000000..9f5ec598b4fb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManager.json @@ -0,0 +1,753 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManager", + "description": "The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_Get", + "description": "Gets the specified Network Manager.", + "responses": { + "200": { + "description": "OK - Returns information about the network manager.", + "schema": { + "$ref": "#/definitions/NetworkManager" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkManagersGet": { + "$ref": "./examples/NetworkManagerGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_CreateOrUpdate", + "description": "Creates or updates a Network Manager.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManager" + }, + "description": "Parameters supplied to specify which network manager is." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the network manager.", + "schema": { + "$ref": "#/definitions/NetworkManager" + } + }, + "201": { + "description": "Created - Returns information about the network manager.", + "schema": { + "$ref": "#/definitions/NetworkManager" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Put Network Manager": { + "$ref": "./examples/NetworkManagerPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "description": "Deletes a network manager.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkManagersDelete": { + "$ref": "./examples/NetworkManagerDelete.json" + } + } + }, + "patch": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_Patch", + "description": "Patch NetworkManager.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchObject" + }, + "description": "Parameters supplied to specify which network manager is." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the network manager.", + "schema": { + "$ref": "#/definitions/NetworkManager" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkManagesPatch": { + "$ref": "./examples/NetworkManagerPatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/commit": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagerCommits_Post", + "description": "Post a Network Manager Commit.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManagerCommit" + }, + "description": "Parameters supplied to specify which Managed Network commit is." + } + ], + "responses": { + "200": { + "description": "Succeed.", + "schema": { + "$ref": "#/definitions/NetworkManagerCommit" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/NetworkManagerCommit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkManageCommitPost": { + "$ref": "./examples/NetworkManagerCommitPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/listDeploymentStatus": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagerDeploymentStatus_List", + "description": "Post to List of Network Manager Deployment Status.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManagerDeploymentStatusParameter" + }, + "description": "Parameters supplied to specify which Managed Network deployment status is." + } + ], + "responses": { + "200": { + "description": "OK - Returns a list of deployment status.", + "schema": { + "$ref": "#/definitions/NetworkManagerDeploymentStatusListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkManagerDeploymentStatusList": { + "$ref": "./examples/NetworkManagerDeploymentStatusList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagers": { + "get": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_ListBySubscription", + "description": "List all network managers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the network managers.", + "schema": { + "$ref": "#/definitions/NetworkManagerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkManagersList": { + "$ref": "./examples/NetworkManagerListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers": { + "get": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_List", + "description": "List network managers in a resource group.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns a list of network managers.", + "schema": { + "$ref": "#/definitions/NetworkManagerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Network Manager": { + "$ref": "./examples/NetworkManagerList.json" + } + } + } + } + }, + "definitions": { + "NetworkManager": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkManagerProperties", + "description": "The network manager properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "The Managed Network resource" + }, + "NetworkManagerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkManager" + }, + "description": "Gets a page of NetworkManager" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NetworkManager. It contains a list of network managers and a URL link to get the next set of results." + }, + "NetworkManagerProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the network manager." + }, + "networkManagerScopes": { + "type": "object", + "properties": { + "managementGroups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of management groups." + }, + "subscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subscriptions." + }, + "crossTenantScopes": { + "readOnly": true, + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/CrossTenantScopes" + }, + "description": "List of cross tenant scopes." + } + }, + "description": "Scope of Network Manager." + }, + "networkManagerScopeAccesses": { + "type": "array", + "items": { + "type": "string", + "$ref": "#/definitions/ConfigurationType" + }, + "description": "Scope Access." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network manager resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "networkManagerScopes", + "networkManagerScopeAccesses" + ], + "description": "Properties of Managed Network" + }, + "CrossTenantScopes": { + "type": "object", + "properties": { + "tenantId": { + "readOnly": true, + "type": "string", + "description": "Tenant ID." + }, + "managementGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of management groups." + }, + "subscriptions": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of subscriptions." + } + }, + "description": "Cross tenant scopes." + }, + "NetworkManagerCommit": { + "type": "object", + "properties": { + "commitId": { + "type": "string", + "readOnly": true, + "description": "Commit Id." + }, + "targetLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of target locations." + }, + "configurationIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of configuration ids." + }, + "commitType": { + "type": "string", + "$ref": "#/definitions/ConfigurationType", + "description": "Commit Type." + } + }, + "required": [ + "targetLocations", + "commitType" + ], + "description": "Network Manager Commit." + }, + "PatchObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Object for patch operations." + }, + "NetworkManagerDeploymentStatusParameter": { + "type": "object", + "properties": { + "regions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of locations." + }, + "deploymentTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationType" + }, + "description": "List of deployment types." + }, + "skipToken": { + "description": "Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.", + "type": "string" + } + }, + "description": "Network Manager Deployment Status Parameter." + }, + "NetworkManagerDeploymentStatusListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/NetworkManagerDeploymentStatus" + }, + "description": "Gets a page of Network Manager Deployment Status" + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "A list of Network Manager Deployment Status" + }, + "NetworkManagerDeploymentStatus": { + "type": "object", + "properties": { + "commitTime": { + "type": "string", + "format": "date-time", + "description": "Commit Time." + }, + "region": { + "type": "string", + "description": "Region Name." + }, + "deploymentStatus": { + "type": "string", + "enum": [ + "NotStarted", + "Deploying", + "Deployed", + "Failed" + ], + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true + }, + "description": "Deployment Status." + }, + "configurationIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of configuration ids." + }, + "deploymentType": { + "type": "string", + "$ref": "#/definitions/ConfigurationType" + }, + "errorMessage": { + "type": "string", + "description": "Error Message." + } + }, + "description": "Network Manager Deployment Status." + }, + "ConfigurationType": { + "type": "string", + "enum": [ + "SecurityAdmin", + "Connectivity" + ], + "x-ms-enum": { + "name": "ConfigurationType", + "modelAsString": true + }, + "description": "Configuration Deployment Type." + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "x-ms-parameter-location": "method" + }, + "OperationResultIdParameter": { + "name": "operationResultId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of operation Result.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerActiveConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerActiveConfiguration.json new file mode 100644 index 000000000000..8871b4c6079b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerActiveConfiguration.json @@ -0,0 +1,345 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagerActiveConfiguration", + "description": "The Microsoft Azure Network Manager Active Configuration API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to list all active configuration by network manager.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/listActiveConnectivityConfigurations": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagerActiveConnectivityConfigurations" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveConfigurationParameter" + }, + "description": "Active Configuration Parameter." + } + ], + "operationId": "ListActiveConnectivityConfigurations", + "description": "Lists active connectivity configurations in a network manager.", + "responses": { + "200": { + "description": "Post successful. The operation returns the specified Managed Network active connectivity configuration resource.", + "schema": { + "$ref": "#/definitions/ActiveConnectivityConfigurationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Active Connectivity Configurations": { + "$ref": "./examples/NetworkManagerActiveConnectivityConfigurationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/listActiveSecurityAdminRules": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagerActiveConfigurations" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveConfigurationParameter" + }, + "description": "Active Configuration Parameter." + } + ], + "operationId": "ListActiveSecurityAdminRules", + "description": "Lists active security admin rules in a network manager.", + "responses": { + "200": { + "description": "Post successful. The operation returns the specified Managed Network active security admin rules resource.", + "schema": { + "$ref": "#/definitions/ActiveSecurityAdminRulesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Active Security Admin Rules": { + "$ref": "./examples/NetworkManagerActiveSecurityAdminRulesList.json" + } + } + } + } + }, + "definitions": { + "ActiveConfigurationParameter": { + "type": "object", + "properties": { + "regions": { + "type": "array", + "items": { + "type": "string", + "description": "region Name." + }, + "description": "List of regions." + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Effective Virtual Networks Parameter." + }, + "ActiveConnectivityConfiguration": { + "type": "object", + "properties": { + "commitTime": { + "type": "string", + "description": "Deployment time string.", + "format": "date-time" + }, + "region": { + "type": "string", + "description": "Deployment region." + } + }, + "allOf": [ + { + "$ref": "./networkManagerEffectiveConfiguration.json#/definitions/EffectiveConnectivityConfiguration" + } + ], + "description": "Active connectivity configuration." + }, + "ActiveConnectivityConfigurationsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ActiveConnectivityConfiguration" + }, + "description": "Gets a page of active connectivity configurations." + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Result of the request to list active connectivity configurations. It contains a list of active connectivity configurations and a skiptoken to get the next set of results." + }, + "ActiveSecurityAdminRulesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ActiveBaseSecurityAdminRule" + }, + "description": "Gets a page of active security admin rules." + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Result of the request to list active security admin rules. It contains a list of active security admin rules and a skiptoken to get the next set of results." + }, + "ActiveBaseSecurityAdminRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "commitTime": { + "type": "string", + "description": "Deployment time string.", + "format": "date-time" + }, + "region": { + "type": "string", + "description": "Deployment region." + }, + "configurationDescription": { + "type": "string", + "description": "A description of the security admin configuration." + }, + "ruleCollectionDescription": { + "type": "string", + "description": "A description of the rule collection." + }, + "ruleCollectionAppliesToGroups": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/NetworkManagerSecurityGroupItem" + }, + "description": "Groups for rule collection" + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "./networkManagerEffectiveConfiguration.json#/definitions/ConfigurationGroup" + }, + "description": "Effective configuration groups." + }, + "kind": { + "type": "string", + "description": "Whether the rule is custom or default.", + "enum": [ + "Custom", + "Default" + ], + "x-ms-enum": { + "name": "EffectiveAdminRuleKind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ], + "discriminator": "kind", + "description": "Network base admin rule." + }, + "ActiveSecurityAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/AdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ActiveBaseSecurityAdminRule" + } + ], + "description": "Network admin rule.", + "x-ms-discriminator-value": "Custom" + }, + "ActiveDefaultSecurityAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/DefaultAdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the default security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ActiveBaseSecurityAdminRule" + } + ], + "description": "Network default admin rule.", + "x-ms-discriminator-value": "Default" + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerConnection.json new file mode 100644 index 000000000000..d1d88634e7a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerConnection.json @@ -0,0 +1,426 @@ +{ + "swagger": "2.0", + "info": { + "title": "ScopeConnections", + "description": "The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/NetworkManagerConnectionNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "put": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "SubscriptionNetworkManagerConnections_CreateOrUpdate", + "description": "Create a network manager connection on this subscription.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + }, + "description": "Network manager connection to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "201": { + "description": "Created - Returns information about the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update Subscription Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionSubscriptionPut.json" + } + } + }, + "get": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "SubscriptionNetworkManagerConnections_Get", + "description": "Get a specified connection created by this subscription.", + "responses": { + "200": { + "description": "OK - Returns the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Subscription Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionSubscriptionGet.json" + } + } + }, + "delete": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "SubscriptionNetworkManagerConnections_Delete", + "description": "Delete specified connection created by this subscription.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Subscription Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionSubscriptionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections": { + "get": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "SubscriptionNetworkManagerConnections_List", + "description": "List all network manager connections created by this subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListTopParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the network manager connection(s).", + "schema": { + "$ref": "#/definitions/NetworkManagerConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Subscription Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionSubscriptionList.json" + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}": { + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/NetworkManagerConnectionNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "put": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "ManagementGroupNetworkManagerConnections_CreateOrUpdate", + "description": "Create a network manager connection on this management group.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + }, + "description": "Network manager connection to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "201": { + "description": "Created - Returns information about the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update Management Group Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionManagementGroupPut.json" + } + } + }, + "get": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "ManagementGroupNetworkManagerConnections_Get", + "description": "Get a specified connection created by this management group.", + "responses": { + "200": { + "description": "OK - Returns the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Management Group Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionManagementGroupGet.json" + } + } + }, + "delete": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "ManagementGroupNetworkManagerConnections_Delete", + "description": "Delete specified pending connection created by this management group.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Management Group Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionManagementGroupDelete.json" + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections": { + "get": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "ManagementGroupNetworkManagerConnections_List", + "description": "List all network manager connections created by this management group.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListTopParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the network manager connection(s).", + "schema": { + "$ref": "#/definitions/NetworkManagerConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Management Group Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionManagementGroupList.json" + } + } + } + } + }, + "definitions": { + "NetworkManagerConnection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkManagerConnectionProperties", + "description": "The scope connection properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "The Network Manager Connection resource" + }, + "NetworkManagerConnectionProperties": { + "type": "object", + "properties": { + "networkManagerId": { + "type": "string", + "description": "Network Manager Id." + }, + "connectionState": { + "x-ms-client-flatten": true, + "$ref": "./networkManagerScopeConnection.json#/definitions/ConnectionState", + "description": "Connection state." + }, + "description": { + "type": "string", + "description": "A description of the network manager connection." + } + }, + "description": "Information about the network manager connection." + }, + "NetworkManagerConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkManagerConnection" + }, + "description": "List of network manager connections." + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "List of network manager connections." + } + }, + "parameters": { + "ManagementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "description": "The management group Id which uniquely identify the Microsoft Azure management group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerConnectionNameParameter": { + "name": "networkManagerConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name for the network manager connection.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerConnectivityConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerConnectivityConfiguration.json new file mode 100644 index 000000000000..4bee9d3d93f9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerConnectivityConfiguration.json @@ -0,0 +1,458 @@ +{ + "swagger": "2.0", + "info": { + "title": "ConnectivityConfiguration", + "description": "The Microsoft Azure Virtual Network Manager Connectivity Configuration API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations/{configurationName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ConnectivityConfigurationNameParameter" + } + ], + "get": { + "tags": [ + "ConnectivityConfigurations" + ], + "operationId": "ConnectivityConfigurations_Get", + "description": "Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name", + "responses": { + "200": { + "description": "Get successful. The operation returns the specified Managed Network Connectivity Configuration resource.", + "schema": { + "$ref": "#/definitions/ConnectivityConfiguration" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ConnectivityConfigurationsGet": { + "$ref": "./examples/NetworkManagerConnectivityConfigurationGet.json" + } + } + }, + "put": { + "tags": [ + "ConnectivityConfigurations" + ], + "operationId": "ConnectivityConfigurations_CreateOrUpdate", + "description": "Creates/Updates a new network manager connectivity configuration", + "parameters": [ + { + "name": "connectivityConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectivityConfiguration" + }, + "description": "Parameters supplied to create/update a network manager connectivity configuration" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network manager connectivity configuration.", + "schema": { + "$ref": "#/definitions/ConnectivityConfiguration" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network manager connectivity configuration.", + "schema": { + "$ref": "#/definitions/ConnectivityConfiguration" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ConnectivityConfigurationsPut": { + "$ref": "./examples/NetworkManagerConnectivityConfigurationPut.json" + } + } + }, + "delete": { + "tags": [ + "ConnectivityConfigurations" + ], + "operationId": "ConnectivityConfigurations_Delete", + "description": "Deletes a network manager connectivity configuration, specified by the resource group, network manager name, and connectivity configuration name", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ConnectivityConfigurationsDelete": { + "$ref": "./examples/NetworkManagerConnectivityConfigurationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations": { + "get": { + "tags": [ + "ConnectivityConfigurations" + ], + "operationId": "ConnectivityConfigurations_List", + "description": "Lists all the network manager connectivity configuration in a specified network manager.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all network manager connectivity configuration resources in the specified network manager, in a paginated format", + "schema": { + "$ref": "#/definitions/ConnectivityConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectivityConfigurationsList": { + "$ref": "./examples/NetworkManagerConnectivityConfigurationList.json" + } + } + } + } + }, + "definitions": { + "ConnectivityConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityConfiguration" + }, + "description": "Gets a page of Connectivity Configurations" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list network manager connectivity configurations. It contains a list of configurations and a link to get the next set of results." + }, + "ConnectivityConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectivityConfigurationProperties", + "description": "Properties of a network manager connectivity configuration" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "The network manager connectivity configuration resource" + }, + "ConnectivityConfigurationProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the connectivity configuration." + }, + "connectivityTopology": { + "type": "string", + "enum": [ + "HubAndSpoke", + "Mesh" + ], + "x-ms-enum": { + "name": "ConnectivityTopology", + "modelAsString": true + }, + "description": "Connectivity topology type." + }, + "hubs": { + "type": "array", + "x-ms-identifiers": [ + "resourceId" + ], + "items": { + "$ref": "#/definitions/Hub" + }, + "description": "List of hubItems" + }, + "isGlobal": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "IsGlobal", + "modelAsString": true + }, + "description": "Flag if global mesh is supported." + }, + "appliesToGroups": { + "type": "array", + "x-ms-identifiers": [ + "networkGroupId" + ], + "items": { + "$ref": "#/definitions/connectivityGroupItem" + }, + "description": "Groups for configuration" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the connectivity configuration resource." + }, + "deleteExistingPeering": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "DeleteExistingPeering", + "modelAsString": true + }, + "description": "Flag if need to remove current existing peerings." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "connectivityTopology", + "appliesToGroups" + ], + "description": "Properties of network manager connectivity configuration" + }, + "Hub": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id." + }, + "resourceType": { + "type": "string", + "description": "Resource Type." + } + }, + "description": "Hub Item." + }, + "connectivityGroupItem": { + "type": "object", + "properties": { + "networkGroupId": { + "type": "string", + "description": "Network group Id." + }, + "useHubGateway": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "UseHubGateway", + "modelAsString": true + }, + "description": "Flag if need to use hub gateway." + }, + "isGlobal": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "IsGlobal", + "modelAsString": true + }, + "description": "Flag if global is supported." + }, + "groupConnectivity": { + "type": "string", + "enum": [ + "None", + "DirectlyConnected" + ], + "x-ms-enum": { + "name": "GroupConnectivity", + "modelAsString": true + }, + "description": "Group connectivity type." + } + }, + "description": "Connectivity group item.", + "required": [ + "networkGroupId", + "groupConnectivity" + ] + } + }, + "parameters": { + "ConnectivityConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager connectivity configuration.", + "x-ms-parameter-location": "method" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerEffectiveConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerEffectiveConfiguration.json new file mode 100644 index 000000000000..72ae8991b951 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerEffectiveConfiguration.json @@ -0,0 +1,337 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagerEffectiveConfiguration", + "description": "The Microsoft Azure Network Manager effective configuration API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listNetworkManagerEffectiveConnectivityConfigurations": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagerEffectiveConnectivityConfiguration" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./networkManagerGroup.json#/definitions/QueryRequestOptions" + }, + "description": "Parameters supplied to list correct page." + } + ], + "operationId": "ListNetworkManagerEffectiveConnectivityConfigurations", + "description": "List all effective connectivity configurations applied on a virtual network.", + "responses": { + "200": { + "description": "OK - Returns information about the configurations.", + "schema": { + "$ref": "#/definitions/NetworkManagerEffectiveConnectivityConfigurationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List effective connectivity configuration": { + "$ref": "./examples/NetworkManagerEffectiveConnectivityConfigurationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listNetworkManagerEffectiveSecurityAdminRules": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagerEffectiveSecurityAdminRules" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./networkManagerGroup.json#/definitions/QueryRequestOptions" + }, + "description": "Parameters supplied to list correct page." + } + ], + "operationId": "ListNetworkManagerEffectiveSecurityAdminRules", + "description": "List all effective security admin rules applied on a virtual network.", + "responses": { + "200": { + "description": "OK - Returns information about the configurations.", + "schema": { + "$ref": "#/definitions/NetworkManagerEffectiveSecurityAdminRulesListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List effective security admin rules": { + "$ref": "./examples/NetworkManagerEffectiveSecurityAdminRulesList.json" + } + } + } + } + }, + "definitions": { + "NetworkManagerEffectiveConnectivityConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveConnectivityConfiguration" + }, + "description": "Gets a page of NetworkManagerEffectiveConnectivityConfiguration" + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Result of the request to list networkManagerEffectiveConnectivityConfiguration. It contains a list of groups and a skiptoken to get the next set of results." + }, + "NetworkManagerEffectiveSecurityAdminRulesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveBaseSecurityAdminRule" + }, + "description": "Gets a page of NetworkManagerEffectiveSecurityAdminRules" + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Result of the request to list networkManagerEffectiveSecurityAdminRules. It contains a list of groups and a skiptoken to get the next set of results." + }, + "EffectiveConnectivityConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Connectivity configuration ID." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "./networkManagerConnectivityConfiguration.json#/definitions/ConnectivityConfigurationProperties", + "description": "Properties of a network manager connectivity configuration" + }, + "configurationGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationGroup" + }, + "description": "Effective configuration groups." + } + }, + "description": "The network manager effective connectivity configuration" + }, + "EffectiveBaseSecurityAdminRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "configurationDescription": { + "type": "string", + "description": "A description of the security admin configuration." + }, + "ruleCollectionDescription": { + "type": "string", + "description": "A description of the rule collection." + }, + "ruleCollectionAppliesToGroups": { + "type": "array", + "x-ms-identifiers": [ + "networkGroupId" + ], + "items": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/NetworkManagerSecurityGroupItem" + }, + "description": "Groups for rule collection" + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationGroup" + }, + "description": "Effective configuration groups." + }, + "kind": { + "type": "string", + "description": "Whether the rule is custom or default.", + "enum": [ + "Custom", + "Default" + ], + "x-ms-enum": { + "name": "EffectiveAdminRuleKind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ], + "discriminator": "kind", + "description": "Network base admin rule." + }, + "EffectiveSecurityAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/AdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EffectiveBaseSecurityAdminRule" + } + ], + "description": "Network admin rule.", + "x-ms-discriminator-value": "Custom" + }, + "EffectiveDefaultSecurityAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/DefaultAdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the default security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EffectiveBaseSecurityAdminRule" + } + ], + "description": "Network default admin rule.", + "x-ms-discriminator-value": "Default" + }, + "ConfigurationGroup": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Network group ID." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "./networkManagerGroup.json#/definitions/NetworkGroupProperties", + "description": "The network configuration group properties" + } + }, + "description": "The network configuration group resource" + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerGroup.json new file mode 100644 index 000000000000..3dc7a752e752 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerGroup.json @@ -0,0 +1,601 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkGroup", + "description": "The Microsoft Azure Network Group API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkGroups" + ], + "operationId": "NetworkGroups_Get", + "description": "Gets the specified network group.", + "responses": { + "200": { + "description": "OK - Returns information about the network group.", + "schema": { + "$ref": "#/definitions/NetworkGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkGroupsGet": { + "$ref": "./examples/NetworkManagerGroupGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkGroups" + ], + "operationId": "NetworkGroups_CreateOrUpdate", + "description": "Creates or updates a network group.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkGroup" + }, + "description": "Parameters supplied to the specify which network group need to create" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the network group.", + "schema": { + "$ref": "#/definitions/NetworkGroup" + }, + "headers": { + "ETag": { + "description": "The current entity tag.", + "type": "string" + } + } + }, + "201": { + "description": "Created - Returns information about the network group.", + "schema": { + "$ref": "#/definitions/NetworkGroup" + }, + "headers": { + "ETag": { + "description": "The current entity tag.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkGroupsPut": { + "$ref": "./examples/NetworkManagerGroupPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkGroups" + ], + "operationId": "NetworkGroups_Delete", + "description": "Deletes a network group.", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkGroupsDelete": { + "$ref": "./examples/NetworkManagerGroupDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups": { + "get": { + "tags": [ + "NetworkGroups" + ], + "operationId": "NetworkGroups_List", + "description": "Lists the specified network group.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the network group.", + "schema": { + "$ref": "#/definitions/NetworkGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkGroupsList": { + "$ref": "./examples/NetworkManagerGroupList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers/{staticMemberName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkGroupNameParameter" + }, + { + "$ref": "#/parameters/StaticMemberNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "StaticMembers" + ], + "operationId": "StaticMembers_Get", + "description": "Gets the specified static member.", + "responses": { + "200": { + "description": "OK - Returns information about the static member.", + "schema": { + "$ref": "#/definitions/StaticMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StaticMembersGet": { + "$ref": "./examples/NetworkManagerStaticMemberGet.json" + } + } + }, + "put": { + "tags": [ + "StaticMembers" + ], + "operationId": "StaticMembers_CreateOrUpdate", + "description": "Creates or updates a static member.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StaticMember" + }, + "description": "Parameters supplied to the specify the static member to create" + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the static member.", + "schema": { + "$ref": "#/definitions/StaticMember" + } + }, + "201": { + "description": "Created - Returns information about the static member.", + "schema": { + "$ref": "#/definitions/StaticMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StaticMemberPut": { + "$ref": "./examples/NetworkManagerStaticMemberPut.json" + } + } + }, + "delete": { + "tags": [ + "StaticMembers" + ], + "operationId": "StaticMembers_Delete", + "description": "Deletes a static member.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StaticMembersDelete": { + "$ref": "./examples/NetworkManagerStaticMemberDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers": { + "get": { + "tags": [ + "StaticMembers" + ], + "operationId": "StaticMembers_List", + "description": "Lists the specified static member.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the static member.", + "schema": { + "$ref": "#/definitions/StaticMemberListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StaticMembersList": { + "$ref": "./examples/NetworkManagerStaticMemberList.json" + } + } + } + } + }, + "definitions": { + "NetworkGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkGroupProperties", + "description": "The Network Group properties" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "The network group resource" + }, + "NetworkGroupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkGroup" + }, + "description": "Gets a page of NetworkGroup" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next set of results." + } + }, + "description": "Result of the request to list NetworkGroup. It contains a list of groups and a URL link to get the next set of results." + }, + "NetworkGroupProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the network group." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the scope assignment resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "description": "Properties of network group" + }, + "StaticMember": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StaticMemberProperties", + "description": "The Static Member properties" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "StaticMember Item." + }, + "StaticMemberListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StaticMember" + }, + "description": "Gets a page of StaticMember" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next set of results." + } + }, + "description": "Result of the request to list StaticMember. It contains a list of groups and a URL link to get the next set of results." + }, + "StaticMemberProperties": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id." + }, + "region": { + "readOnly": true, + "type": "string", + "description": "Resource region." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the scope assignment resource." + } + }, + "description": "Properties of static member." + }, + "QueryRequestOptions": { + "type": "object", + "properties": { + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Query Request Options" + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "x-ms-parameter-location": "method" + }, + "NetworkGroupNameParameter": { + "name": "networkGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network group.", + "x-ms-parameter-location": "method" + }, + "StaticMemberNameParameter": { + "name": "staticMemberName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the static member.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerScopeConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerScopeConnection.json new file mode 100644 index 000000000000..6342d7e355c2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerScopeConnection.json @@ -0,0 +1,297 @@ +{ + "swagger": "2.0", + "info": { + "title": "ScopeConnections", + "description": "The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections/{scopeConnectionName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ScopeConnectionName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "put": { + "tags": [ + "ScopeConnections" + ], + "operationId": "ScopeConnections_CreateOrUpdate", + "description": "Creates or updates scope connection from Network Manager", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopeConnection" + }, + "description": "Scope connection to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the updates scope connection.", + "schema": { + "$ref": "#/definitions/ScopeConnection" + } + }, + "201": { + "description": "Created - Returns information about the new scope connection.", + "schema": { + "$ref": "#/definitions/ScopeConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update Network Manager Scope Connection": { + "$ref": "./examples/NetworkManagerScopeConnectionPut.json" + } + } + }, + "get": { + "tags": [ + "ScopeConnections" + ], + "operationId": "ScopeConnections_Get", + "description": "Get specified scope connection created by this Network Manager.", + "responses": { + "200": { + "description": "OK - Returns the resource", + "schema": { + "$ref": "#/definitions/ScopeConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Network Manager Scope Connection": { + "$ref": "./examples/NetworkManagerScopeConnectionGet.json" + } + } + }, + "delete": { + "tags": [ + "ScopeConnections" + ], + "operationId": "ScopeConnections_Delete", + "description": "Delete the pending scope connection created by this network manager.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Network Manager Scope Connection": { + "$ref": "./examples/NetworkManagerScopeConnectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections": { + "get": { + "tags": [ + "ScopeConnections" + ], + "operationId": "ScopeConnections_List", + "description": "List all scope connections created by this network manager.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListTopParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the scope connection(s).", + "schema": { + "$ref": "#/definitions/ScopeConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Network Manager Scope Connection": { + "$ref": "./examples/NetworkManagerScopeConnectionList.json" + } + } + } + } + }, + "definitions": { + "ScopeConnection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScopeConnectionProperties", + "description": "The scope connection properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "The Scope Connections resource" + }, + "ScopeConnectionProperties": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Tenant ID." + }, + "resourceId": { + "type": "string", + "description": "Resource ID." + }, + "connectionState": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionState", + "description": "Connection State" + }, + "description": { + "type": "string", + "description": "A description of the scope connection." + } + }, + "description": "Scope connection." + }, + "ScopeConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ScopeConnection" + }, + "description": "List of scope connections." + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "List of scope connections." + }, + "ConnectionState": { + "type": "string", + "readOnly": true, + "description": "The current scope connection state.", + "enum": [ + "Connected", + "Pending", + "Conflict", + "Revoked", + "Rejected" + ], + "x-ms-enum": { + "name": "ScopeConnectionState", + "modelAsString": true + } + } + }, + "parameters": { + "ScopeConnectionName": { + "name": "scopeConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name for the cross-tenant connection.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerSecurityAdminConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerSecurityAdminConfiguration.json new file mode 100644 index 000000000000..34b2981d99f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkManagerSecurityAdminConfiguration.json @@ -0,0 +1,1158 @@ +{ + "swagger": "2.0", + "info": { + "title": "SecurityAdminConfiguration", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations": { + "get": { + "tags": [ + "SecurityAdminConfigurations" + ], + "operationId": "SecurityAdminConfigurations_List", + "description": "Lists all the network manager security admin configurations in a network manager, in a paginated format.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all security admin configuration resources in the specified network manager, in a paginated format", + "schema": { + "$ref": "#/definitions/SecurityAdminConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List security admin configurations in a network manager": { + "$ref": "./examples/NetworkManagerSecurityAdminConfigurationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + } + ], + "get": { + "tags": [ + "SecurityAdminConfigurations" + ], + "description": "Retrieves a network manager security admin configuration.", + "operationId": "SecurityAdminConfigurations_Get", + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SecurityAdminConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get security admin configurations": { + "$ref": "./examples/NetworkManagerSecurityAdminConfigurationGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityAdminConfigurations" + ], + "description": "Creates or updates a network manager security admin configuration.", + "operationId": "SecurityAdminConfigurations_CreateOrUpdate", + "parameters": [ + { + "name": "securityAdminConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityAdminConfiguration" + }, + "description": "The security admin configuration to create or update" + } + ], + "responses": { + "200": { + "description": "Updated Admin Configuration", + "schema": { + "$ref": "#/definitions/SecurityAdminConfiguration" + } + }, + "201": { + "description": "Created Admin Configuration", + "schema": { + "$ref": "#/definitions/SecurityAdminConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network manager security admin configuration": { + "$ref": "./examples/NetworkManagerSecurityAdminConfigurationPut.json" + } + } + }, + "delete": { + "tags": [ + "SecurityAdminConfigurations" + ], + "description": "Deletes a network manager security admin configuration.", + "operationId": "SecurityAdminConfigurations_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete network manager security admin configuration": { + "$ref": "./examples/NetworkManagerSecurityAdminConfigurationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections": { + "get": { + "tags": [ + "AdminRuleCollections" + ], + "operationId": "AdminRuleCollections_List", + "description": "Lists all the rule collections in a security admin configuration, in a paginated format.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all ruleCollections in the specified security configuration, in a paginated format", + "schema": { + "$ref": "#/definitions/AdminRuleCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List security admin rule collections": { + "$ref": "./examples/NetworkManagerAdminRuleCollectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + } + ], + "get": { + "tags": [ + "AdminRuleCollections" + ], + "description": "Gets a network manager security admin configuration rule collection.", + "operationId": "AdminRuleCollections_Get", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/AdminRuleCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets security admin rule collection": { + "$ref": "./examples/NetworkManagerAdminRuleCollectionGet.json" + } + } + }, + "put": { + "tags": [ + "AdminRuleCollections" + ], + "description": "Creates or updates an admin rule collection.", + "operationId": "AdminRuleCollections_CreateOrUpdate", + "parameters": [ + { + "name": "ruleCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AdminRuleCollection" + }, + "description": "The Rule Collection to create or update" + } + ], + "responses": { + "200": { + "description": "Updated Rule Collection", + "schema": { + "$ref": "#/definitions/AdminRuleCollection" + } + }, + "201": { + "description": "Created Rule Collection", + "schema": { + "$ref": "#/definitions/AdminRuleCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update an admin rule collection": { + "$ref": "./examples/NetworkManagerAdminRuleCollectionPut.json" + } + } + }, + "delete": { + "tags": [ + "AdminRuleCollections" + ], + "description": "Deletes an admin rule collection.", + "operationId": "AdminRuleCollections_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes an admin rule collection": { + "$ref": "./examples/NetworkManagerAdminRuleCollectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "get": { + "tags": [ + "AdminRules" + ], + "description": "List all network manager security configuration admin rules.", + "operationId": "AdminRules_List", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/AdminRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List security admin rules": { + "$ref": "./examples/NetworkManagerAdminRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationsRuleParameter" + } + ], + "get": { + "tags": [ + "AdminRules" + ], + "description": "Gets a network manager security configuration admin rule.", + "operationId": "AdminRules_Get", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/BaseAdminRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets security admin rule": { + "$ref": "./examples/NetworkManagerAdminRuleGet.json" + }, + "Gets security default admin rule": { + "$ref": "./examples/NetworkManagerDefaultAdminRuleGet.json" + } + } + }, + "put": { + "tags": [ + "AdminRules" + ], + "description": "Creates or updates an admin rule.", + "operationId": "AdminRules_CreateOrUpdate", + "parameters": [ + { + "name": "adminRule", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BaseAdminRule" + }, + "description": "The admin rule to create or update" + } + ], + "responses": { + "200": { + "description": "Updated rule", + "schema": { + "$ref": "#/definitions/BaseAdminRule" + } + }, + "201": { + "description": "Created rule", + "schema": { + "$ref": "#/definitions/BaseAdminRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create an admin rule": { + "$ref": "./examples/NetworkManagerAdminRulePut.json" + }, + "Create a default admin rule": { + "$ref": "./examples/NetworkManagerDefaultAdminRulePut.json" + } + } + }, + "delete": { + "tags": [ + "AdminRules" + ], + "description": "Deletes an admin rule.", + "operationId": "AdminRules_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes an admin rule": { + "$ref": "./examples/NetworkManagerAdminRuleDelete.json" + } + } + } + } + }, + "definitions": { + "SecurityAdminConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityAdminConfigurationPropertiesFormat", + "description": "Indicates the properties for the network manager security admin configuration." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Defines the security admin configuration" + }, + "SecurityAdminConfigurationPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the security configuration." + }, + "applyOnNetworkIntentPolicyBasedServices": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkIntentPolicyBasedService" + }, + "description": "Enum list of network intent policy based services." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "description": "Defines the security admin configuration properties." + }, + "SecurityAdminConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityAdminConfiguration" + }, + "description": "Gets a page of security admin configurations" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "A list of network manager security admin configurations" + }, + "AdminRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BaseAdminRule" + }, + "description": "A list of admin rules" + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "security configuration admin rule list result." + }, + "AdminRuleCollectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AdminRuleCollection" + }, + "description": "A list of network manager security admin configuration rule collections" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next set of results." + } + }, + "description": "Security admin configuration rule collection list result." + }, + "AdminRuleCollection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AdminRuleCollectionPropertiesFormat", + "description": "Indicates the properties for the network manager admin rule collection." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Defines the admin rule collection." + }, + "AdminRuleCollectionPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the admin rule collection." + }, + "appliesToGroups": { + "type": "array", + "x-ms-identifiers": [ + "networkGroupId" + ], + "items": { + "$ref": "#/definitions/NetworkManagerSecurityGroupItem" + }, + "description": "Groups for configuration" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "appliesToGroups" + ], + "description": "Defines the admin rule collection properties." + }, + "BaseAdminRule": { + "type": "object", + "properties": { + "kind": { + "type": "string", + "description": "Whether the rule is custom or default.", + "enum": [ + "Custom", + "Default" + ], + "x-ms-enum": { + "name": "AdminRuleKind", + "modelAsString": true + } + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "required": [ + "kind" + ], + "discriminator": "kind", + "description": "Network base admin rule." + }, + "AdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseAdminRule" + } + ], + "description": "Network admin rule.", + "x-ms-discriminator-value": "Custom" + }, + "AdminPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "type": "string", + "$ref": "#/definitions/RuleProtocol", + "description": "Network protocol this rule applies to." + }, + "sources": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "items": { + "$ref": "#/definitions/AddressPrefixItem" + }, + "description": "The CIDR or source IP ranges." + }, + "destinations": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "items": { + "$ref": "#/definitions/AddressPrefixItem" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "access": { + "$ref": "#/definitions/SecurityConfigurationRuleAccess", + "description": "Indicates the access allowed for this particular rule" + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4096, + "description": "The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityConfigurationRuleDirection", + "description": "Indicates if the traffic matched against the rule in inbound or outbound." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "protocol", + "access", + "direction", + "priority" + ], + "description": "Security admin rule resource." + }, + "DefaultAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DefaultAdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseAdminRule" + } + ], + "description": "Network default admin rule.", + "x-ms-discriminator-value": "Default" + }, + "DefaultAdminPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "readOnly": true, + "description": "A description for this rule. Restricted to 140 chars." + }, + "flag": { + "type": "string", + "description": "Default rule flag." + }, + "protocol": { + "type": "string", + "readOnly": true, + "$ref": "#/definitions/RuleProtocol", + "description": "Network protocol this rule applies to." + }, + "sources": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "readOnly": true, + "items": { + "$ref": "#/definitions/AddressPrefixItem" + }, + "description": "The CIDR or source IP ranges." + }, + "destinations": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "readOnly": true, + "items": { + "$ref": "#/definitions/AddressPrefixItem" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "access": { + "$ref": "#/definitions/SecurityConfigurationRuleAccess", + "readOnly": true, + "description": "Indicates the access allowed for this particular rule" + }, + "priority": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityConfigurationRuleDirection", + "readOnly": true, + "description": "Indicates if the traffic matched against the rule in inbound or outbound." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "description": "Security default admin rule resource." + }, + "SecurityConfigurationRuleAccess": { + "type": "string", + "description": "Whether network traffic is allowed or denied.", + "enum": [ + "Allow", + "Deny", + "AlwaysAllow" + ], + "x-ms-enum": { + "name": "SecurityConfigurationRuleAccess", + "modelAsString": true + } + }, + "SecurityConfigurationRuleDirection": { + "type": "string", + "description": "The direction of the rule. The direction specifies if the rule will be evaluated on incoming or outgoing traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityConfigurationRuleDirection", + "modelAsString": true + } + }, + "RuleProtocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "Icmp", + "Esp", + "Any", + "Ah" + ], + "x-ms-enum": { + "name": "SecurityConfigurationRuleProtocol", + "modelAsString": true + } + }, + "NetworkManagerSecurityGroupItem": { + "type": "object", + "properties": { + "networkGroupId": { + "type": "string", + "description": "Network manager group Id." + } + }, + "required": [ + "networkGroupId" + ], + "description": "Network manager security group item." + }, + "AddressPrefixItem": { + "type": "object", + "properties": { + "addressPrefix": { + "type": "string", + "description": "Address prefix." + }, + "addressPrefixType": { + "type": "string", + "description": "Address prefix type.", + "enum": [ + "IPPrefix", + "ServiceTag" + ], + "x-ms-enum": { + "name": "AddressPrefixType", + "modelAsString": true + } + } + }, + "description": "Address prefix item." + }, + "NetworkIntentPolicyBasedService": { + "type": "string", + "description": "Network intent policy based services.", + "enum": [ + "None", + "All", + "AllowRulesOnly" + ], + "x-ms-enum": { + "name": "NetworkIntentPolicyBasedService", + "modelAsString": true + } + } + }, + "parameters": { + "SecurityConfigurationParameter": { + "name": "configurationName", + "in": "path", + "description": "The name of the network manager Security Configuration.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleCollectionParameter": { + "name": "ruleCollectionName", + "in": "path", + "description": "The name of the network manager security Configuration rule collection.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SecurityConfigurationsRuleParameter": { + "name": "ruleName", + "in": "path", + "description": "The name of the rule.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkProfile.json new file mode 100644 index 000000000000..41c33bce59e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkProfile.json @@ -0,0 +1,622 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}": { + "delete": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_Delete", + "description": "Deletes the specified network profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NetworkProfile." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network profile": { + "$ref": "./examples/NetworkProfileDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_Get", + "description": "Gets the specified network profile in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network profile": { + "$ref": "./examples/NetworkProfileGetConfigOnly.json" + }, + "Get network profile with container network interfaces": { + "$ref": "./examples/NetworkProfileGetWithContainerNic.json" + } + } + }, + "put": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_CreateOrUpdate", + "description": "Creates or updates a network profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkProfile" + }, + "description": "Parameters supplied to the create or update network profile operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network profile defaults": { + "$ref": "./examples/NetworkProfileCreateConfigOnly.json" + } + }, + "x-ms-long-running-operation": false + }, + "patch": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_UpdateTags", + "description": "Updates network profile tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network profile tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update network profile tags": { + "$ref": "./examples/NetworkProfileUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkProfiles": { + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_ListAll", + "description": "Gets all the network profiles in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkProfile resources.", + "schema": { + "$ref": "#/definitions/NetworkProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all network profiles": { + "$ref": "./examples/NetworkProfileListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles": { + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_List", + "description": "Gets all network profiles in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkProfile resources.", + "schema": { + "$ref": "#/definitions/NetworkProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group network profiles": { + "$ref": "./examples/NetworkProfileList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NetworkProfilePropertiesFormat": { + "properties": { + "containerNetworkInterfaces": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterface" + }, + "description": "List of child container network interfaces." + }, + "containerNetworkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration" + }, + "description": "List of chid container network interface configurations." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network profile resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network profile resource." + } + }, + "description": "Network profile properties." + }, + "NetworkProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkProfilePropertiesFormat", + "description": "Network profile properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network profile resource." + }, + "NetworkProfileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkProfile" + }, + "description": "A list of network profiles that exist in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNetworkProfiles API service call." + }, + "ContainerNetworkInterfacePropertiesFormat": { + "properties": { + "containerNetworkInterfaceConfiguration": { + "readOnly": true, + "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration", + "description": "Container network interface configuration from which this container network interface is created." + }, + "container": { + "$ref": "#/definitions/Container", + "description": "Reference to the container to which this container network interface is attached." + }, + "ipConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterfaceIpConfiguration" + }, + "description": "Reference to the ip configuration on this container nic." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the container network interface resource." + } + }, + "description": "Properties of container network interface." + }, + "ContainerNetworkInterface": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfacePropertiesFormat", + "description": "Container network interface properties." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Container network interface child resource." + }, + "ContainerNetworkInterfaceConfigurationPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigurationProfile" + }, + "description": "A list of ip configurations of the container network interface configuration." + }, + "containerNetworkInterfaces": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A list of container network interfaces created from this container network interface configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the container network interface configuration resource." + } + }, + "description": "Container network interface configuration properties." + }, + "ContainerNetworkInterfaceConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfaceConfigurationPropertiesFormat", + "description": "Container network interface configuration properties." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Container network interface configuration child resource." + }, + "IPConfigurationProfilePropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource to create a container network interface ip configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IP configuration profile resource." + } + }, + "description": "IP configuration profile properties." + }, + "IPConfigurationProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IPConfigurationProfilePropertiesFormat", + "description": "Properties of the IP configuration profile." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration profile child resource." + }, + "Container": { + "properties": {}, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Reference to container resource in remote resource provider." + }, + "ContainerNetworkInterfaceIpConfigurationPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the container network interface IP configuration resource." + } + }, + "description": "Properties of the container network interface IP configuration." + }, + "ContainerNetworkInterfaceIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfaceIpConfigurationPropertiesFormat", + "description": "Properties of the container network interface IP configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "The ip configuration for a container network interface." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkSecurityGroup.json new file mode 100644 index 000000000000..99b4ade26118 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkSecurityGroup.json @@ -0,0 +1,991 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}": { + "delete": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Delete", + "description": "Deletes the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network security group": { + "$ref": "./examples/NetworkSecurityGroupDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Get", + "description": "Gets the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network security group": { + "$ref": "./examples/NetworkSecurityGroupGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "description": "Creates or updates a network security group in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "Parameters supplied to the create or update network security group operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network security group": { + "$ref": "./examples/NetworkSecurityGroupCreate.json" + }, + "Create network security group with rule": { + "$ref": "./examples/NetworkSecurityGroupCreateWithRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_UpdateTags", + "description": "Updates a network security group tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network security group tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update network security group tags": { + "$ref": "./examples/NetworkSecurityGroupUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_ListAll", + "description": "Gets all network security groups in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all network security groups": { + "$ref": "./examples/NetworkSecurityGroupListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_List", + "description": "Gets all network security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List network security groups in resource group": { + "$ref": "./examples/NetworkSecurityGroupList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { + "delete": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Delete", + "description": "Deletes the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network security rule from network security group": { + "$ref": "./examples/NetworkSecurityGroupRuleDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Get", + "description": "Get the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network security rule in network security group": { + "$ref": "./examples/NetworkSecurityGroupRuleGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_CreateOrUpdate", + "description": "Creates or updates a security rule in the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "name": "securityRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "Parameters supplied to the create or update network security rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create security rule": { + "$ref": "./examples/NetworkSecurityGroupRuleCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_List", + "description": "Gets all security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List network security rules in network security group": { + "$ref": "./examples/NetworkSecurityGroupRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_List", + "description": "Gets all default security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleList": { + "$ref": "./examples/DefaultSecurityRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules/{defaultSecurityRuleName}": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_Get", + "description": "Get the specified default network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "defaultSecurityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the default security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleGet": { + "$ref": "./examples/DefaultSecurityRuleGet.json" + } + } + } + } + }, + "definitions": { + "SecurityRulePropertiesFormat": { + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "Icmp", + "Esp", + "*", + "Ah" + ], + "x-ms-enum": { + "name": "SecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from." + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "sourceApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as source." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "destinationApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as destination." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "access": { + "$ref": "#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityRuleDirection", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the security rule resource." + } + }, + "required": [ + "protocol", + "access", + "priority", + "direction" + ], + "description": "Security rule resource." + }, + "SecurityRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityRulePropertiesFormat", + "description": "Properties of the security rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "The type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Network security rule." + }, + "SecurityRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The security rules in a network security group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group." + }, + "NetworkSecurityGroupPropertiesFormat": { + "properties": { + "flushConnection": { + "type": "boolean", + "description": "When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation." + }, + "securityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "A collection of security rules of the network security group." + }, + "defaultSecurityRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The default security rules of network security group." + }, + "networkInterfaces": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "A collection of references to network interfaces." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "flowLogs": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkWatcher.json#/definitions/FlowLog" + }, + "description": "A collection of references to flow log resources." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network security group resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network security group resource." + } + }, + "description": "Network Security Group resource." + }, + "NetworkSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat", + "description": "Properties of the network security group." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "NetworkSecurityGroup resource." + }, + "NetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "A list of NetworkSecurityGroup resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNetworkSecurityGroups API service call." + }, + "SecurityRuleAccess": { + "type": "string", + "description": "Whether network traffic is allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true + } + }, + "SecurityRuleDirection": { + "type": "string", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json new file mode 100644 index 000000000000..811205ec51b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json @@ -0,0 +1,1592 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}": { + "delete": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Delete", + "description": "Deletes the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Get", + "description": "Gets the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Network Virtual Appliance resource.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceGet.json" + } + } + }, + "patch": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_UpdateTags", + "description": "Updates a Network Virtual Appliance.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of Network Virtual Appliance." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to Update Network Virtual Appliance Tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of Network Virtual Appliance updated.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceUpdateTags.json" + } + } + }, + "put": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_CreateOrUpdate", + "description": "Creates or updates the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + }, + "description": "Parameters supplied to the create or update Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Network Virtual Appliance resource.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "201": { + "description": "Request received successfully. The operation returns the resulting Network Virtual Appliance resource.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualAppliancePut.json" + }, + "Create SaaS NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceSaaSPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/restart": { + "post": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Restart", + "description": "Restarts one or more VMs belonging to the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "NetworkVirtualApplianceInstanceIds", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceInstanceIds" + }, + "description": "Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation restarts one or more Network Virtual Appliance VM resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceInstanceIds" + } + }, + "202": { + "description": "Request accepted. The operation restarts one or more Network Virtual Appliance VM resources.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Restart All NetworkVirtualAppliance VMs in VM Scale Set": { + "$ref": "./examples/NetworkVirtualApplianceEmptyRestart.json" + }, + "Restart Specific NetworkVirtualAppliance VMs in VM Scale Set": { + "$ref": "./examples/NetworkVirtualApplianceSpecificRestart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances": { + "get": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_ListByResourceGroup", + "description": "Lists all Network Virtual Appliances in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Network Virtual Appliance resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Network Virtual Appliance for a given resource group": { + "$ref": "./examples/NetworkVirtualApplianceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualAppliances": { + "get": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_List", + "description": "Gets all Network Virtual Appliances in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Network Virtual Appliance resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Network Virtual Appliances for a given subscription": { + "$ref": "./examples/NetworkVirtualApplianceListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}": { + "delete": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_Delete", + "description": "Deletes the specified site from a Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the site." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Network Virtual Appliance Site": { + "$ref": "./examples/NetworkVirtualApplianceSiteDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_Get", + "description": "Gets the specified Virtual Appliance Site.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the site." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Network Virtual Appliance Site resource.", + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetNetwork Virtual Appliance Site": { + "$ref": "./examples/NetworkVirtualApplianceSiteGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_CreateOrUpdate", + "description": "Creates or updates the specified Network Virtual Appliance Site.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the site." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + }, + "description": "Parameters supplied to the create or update Network Virtual Appliance Site operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Network Virtual Appliance Site resource.", + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + } + }, + "201": { + "description": "Request received successfully. The operation returns the resulting Network Virtual Appliance Site resource.", + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Network Virtual Appliance Site": { + "$ref": "./examples/NetworkVirtualApplianceSitePut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites": { + "get": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_List", + "description": "Lists all Network Virtual Appliance Sites in a Network Virtual Appliance resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Network Virtual Appliance site resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceSiteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Network Virtual Appliance sites for a given Network Virtual Appliance": { + "$ref": "./examples/NetworkVirtualApplianceSiteList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus": { + "get": { + "tags": [ + "VirtualApplianceSkus" + ], + "operationId": "VirtualApplianceSkus_List", + "description": "List all SKUs available for a virtual appliance.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of all virtual appliance skus.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkVirtualApplianceSkuListResult": { + "$ref": "./examples/NetworkVirtualApplianceSkuList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus/{skuName}": { + "get": { + "tags": [ + "VirtualApplianceSkus" + ], + "operationId": "VirtualApplianceSkus_Get", + "description": "Retrieves a single available sku for network virtual appliance.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Sku." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested NetworkVirtualAppliance sku information.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceSku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkVirtualApplianceSkuGet": { + "$ref": "./examples/NetworkVirtualApplianceSkuGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/inboundSecurityRules/{ruleCollectionName}": { + "put": { + "operationId": "InboundSecurityRule_CreateOrUpdate", + "description": "Creates or updates the specified Network Virtual Appliance Inbound Security Rules.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "ruleCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of security rule collection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundSecurityRule" + }, + "description": "Parameters supplied to the create or update Network Virtual Appliance Inbound Security Rules operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Network Virtual Appliance Inbound Security Rules resource.", + "schema": { + "$ref": "#/definitions/InboundSecurityRule" + } + }, + "201": { + "description": "Request received successfully. The operation returns the resulting Network Virtual Appliance Inbound Security Rules resource.", + "schema": { + "$ref": "#/definitions/InboundSecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Network Virtual Appliance Inbound Security Rules": { + "$ref": "./examples/InboundSecurityRulePut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "InboundSecurityRule_Get", + "description": "Retrieves the available specified Network Virtual Appliance Inbound Security Rules Collection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "ruleCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of security rule collection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested Network Virtual Appliance Inbound Security Rules Collection resource.", + "schema": { + "$ref": "#/definitions/InboundSecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Network Virtual Appliance Inbound Security Rules": { + "$ref": "./examples/InboundSecurityRuleGet.json" + } + } + } + } + }, + "definitions": { + "NetworkVirtualAppliance": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkVirtualAppliancePropertiesFormat", + "description": "Properties of the Network Virtual Appliance." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The service principal that has read access to cloud-init and config blob." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "NetworkVirtualAppliance Resource." + }, + "NetworkVirtualAppliancePropertiesFormat": { + "properties": { + "nvaSku": { + "readOnly": false, + "description": "Network Virtual Appliance SKU.", + "$ref": "#/definitions/VirtualApplianceSkuProperties" + }, + "addressPrefix": { + "type": "string", + "readOnly": true, + "description": "Address Prefix." + }, + "bootStrapConfigurationBlobs": { + "type": "array", + "readOnly": false, + "description": "BootStrapConfigurationBlobs storage URLs.", + "items": { + "type": "string" + } + }, + "virtualHub": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Virtual Hub where Network Virtual Appliance is being deployed." + }, + "cloudInitConfigurationBlobs": { + "type": "array", + "readOnly": false, + "description": "CloudInitConfigurationBlob storage URLs.", + "items": { + "type": "string" + } + }, + "cloudInitConfiguration": { + "type": "string", + "readOnly": false, + "description": "CloudInitConfiguration string in plain text." + }, + "virtualApplianceAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported." + }, + "sshPublicKey": { + "type": "string", + "readOnly": false, + "description": "Public key for SSH login." + }, + "virtualApplianceNics": { + "type": "array", + "readOnly": true, + "description": "List of Virtual Appliance Network Interfaces.", + "items": { + "$ref": "#/definitions/VirtualApplianceNicProperties" + } + }, + "networkProfile": { + "type": "object", + "readOnly": false, + "description": "Network Profile containing configurations for Public and Private NIC.", + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplianceNetworkInterfaceConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "additionalNics": { + "type": "array", + "readOnly": false, + "description": "Details required for Additional Network Interface.", + "items": { + "$ref": "#/definitions/VirtualApplianceAdditionalNicProperties" + }, + "x-ms-identifiers": [] + }, + "internetIngressPublicIps": { + "type": "array", + "readOnly": false, + "description": "List of Resource Uri of Public IPs for Internet Ingress Scenario.", + "items": { + "$ref": "#/definitions/InternetIngressPublicIpsProperties" + }, + "x-ms-identifiers": [] + }, + "virtualApplianceSites": { + "type": "array", + "readOnly": true, + "description": "List of references to VirtualApplianceSite.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "virtualApplianceConnections": { + "type": "array", + "readOnly": true, + "description": "List of references to VirtualApplianceConnections.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "inboundSecurityRules": { + "type": "array", + "readOnly": true, + "description": "List of references to InboundSecurityRules.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + }, + "deploymentType": { + "type": "string", + "readOnly": true, + "description": "The deployment type. PartnerManaged for the SaaS NVA" + }, + "delegation": { + "description": "The delegation for the Virtual Appliance", + "$ref": "#/definitions/DelegationProperties" + }, + "partnerManagedResource": { + "description": "The delegation for the Virtual Appliance", + "$ref": "#/definitions/PartnerManagedResourceProperties" + } + }, + "description": "Network Virtual Appliance definition." + }, + "VirtualApplianceSkuProperties": { + "properties": { + "vendor": { + "type": "string", + "readOnly": false, + "description": "Virtual Appliance Vendor." + }, + "bundledScaleUnit": { + "type": "string", + "readOnly": false, + "description": "Virtual Appliance Scale Unit." + }, + "marketPlaceVersion": { + "type": "string", + "readOnly": false, + "description": "Virtual Appliance Version." + } + }, + "description": "Network Virtual Appliance Sku Properties." + }, + "VirtualApplianceNicProperties": { + "properties": { + "nicType": { + "type": "string", + "readOnly": true, + "description": "NIC type - PublicNic, PrivateNic, or AdditionalNic.", + "enum": [ + "PublicNic", + "PrivateNic", + "AdditionalNic" + ], + "x-ms-enum": { + "name": "NicTypeInResponse", + "modelAsString": true + } + }, + "name": { + "type": "string", + "readOnly": true, + "description": "NIC name." + }, + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "Public IP address." + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "Private IP address." + }, + "instanceName": { + "type": "string", + "readOnly": true, + "description": "Instance on which nic is attached." + } + }, + "description": "Network Virtual Appliance NIC properties." + }, + "VirtualApplianceNetworkInterfaceConfiguration": { + "type": "object", + "readOnly": false, + "description": "Represents a single NIC configuration.", + "properties": { + "type": { + "type": "string", + "description": "NIC type. This should be either PublicNic or PrivateNic.", + "enum": [ + "PublicNic", + "PrivateNic" + ], + "x-ms-enum": { + "name": "NicTypeInRequest", + "modelAsString": true + }, + "x-ms-client-name": "NicType" + }, + "properties": { + "$ref": "#/definitions/VirtualApplianceNetworkInterfaceConfigurationProperties" + } + } + }, + "VirtualApplianceNetworkInterfaceConfigurationProperties": { + "type": "object", + "readOnly": false, + "description": "Represents a single NIC configuration properties.", + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplianceIPConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualApplianceIPConfiguration": { + "type": "object", + "readOnly": false, + "description": "Represents a single IP configuration.", + "properties": { + "name": { + "type": "string", + "description": "Name of the IP configuration." + }, + "properties": { + "$ref": "#/definitions/VirtualApplianceIPConfigurationProperties" + } + } + }, + "VirtualApplianceIPConfigurationProperties": { + "type": "object", + "readOnly": false, + "description": "Represents a single IP configuration properties.", + "properties": { + "primary": { + "type": "boolean", + "description": "Whether or not this is primary IP configuration of the NIC." + } + } + }, + "VirtualApplianceAdditionalNicProperties": { + "type": "object", + "title": "Network Virtual Appliance Additional Nic Properties", + "description": "Network Virtual Appliance Additional NIC properties.", + "properties": { + "name": { + "type": "string", + "readOnly": false, + "description": "Name of additional nic" + }, + "hasPublicIp": { + "type": "boolean", + "readOnly": false, + "description": "Flag (true or false) for Intent for Public Ip on additional nic" + } + } + }, + "InternetIngressPublicIpsProperties": { + "type": "object", + "title": "Internet Ingress Public Ip Properties", + "description": "Resource Uri of Public Ip for Standard Load Balancer Frontend End.", + "properties": { + "id": { + "type": "string", + "readOnly": false, + "description": "Resource Uri of Public Ip", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } + }, + "VirtualApplianceSite": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualApplianceSiteProperties", + "description": "The properties of the Virtual Appliance Sites." + }, + "name": { + "type": "string", + "description": "Name of the virtual appliance site." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Site type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Virtual Appliance Site resource." + }, + "VirtualApplianceSiteProperties": { + "properties": { + "addressPrefix": { + "type": "string", + "readOnly": false, + "description": "Address Prefix." + }, + "o365Policy": { + "readOnly": false, + "description": "Office 365 Policy.", + "$ref": "#/definitions/Office365PolicyProperties" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the rule group." + }, + "Office365PolicyProperties": { + "properties": { + "breakOutCategories": { + "readOnly": false, + "description": "Office 365 breakout categories.", + "$ref": "#/definitions/BreakOutCategoryPolicies" + } + }, + "description": "Network Virtual Appliance Sku Properties." + }, + "BreakOutCategoryPolicies": { + "properties": { + "allow": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control breakout of o365 allow category." + }, + "optimize": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control breakout of o365 optimize category." + }, + "default": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control breakout of o365 default category." + } + }, + "description": "Network Virtual Appliance Sku Properties." + }, + "NetworkVirtualApplianceSku": { + "title": "Available NetworkVirtualApplianceSkus", + "description": "Definition of the NetworkVirtualApplianceSkus resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkVirtualApplianceSkuPropertiesFormat", + "description": "NetworkVirtualApplianceSku properties." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "NetworkVirtualApplianceSkuPropertiesFormat": { + "title": "Network Virtual Appliance Sku Properties", + "description": "Properties specific to NetworkVirtualApplianceSkus.", + "properties": { + "vendor": { + "type": "string", + "readOnly": true, + "description": "Network Virtual Appliance Sku vendor." + }, + "availableVersions": { + "type": "array", + "readOnly": true, + "description": "Available Network Virtual Appliance versions.", + "items": { + "type": "string" + } + }, + "availableScaleUnits": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualApplianceSkuInstances" + }, + "description": "The list of scale units available." + } + } + }, + "NetworkVirtualApplianceSkuInstances": { + "title": "Network Virtual Appliance Sku Instances", + "description": "List of available Sku and instances.", + "properties": { + "scaleUnit": { + "type": "string", + "readOnly": true, + "description": "Scale Unit." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Instance Count." + } + } + }, + "NetworkVirtualApplianceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualAppliance" + }, + "description": "List of Network Virtual Appliances." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListNetworkVirtualAppliances API service call." + }, + "NetworkVirtualApplianceSiteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplianceSite" + }, + "description": "List of Network Virtual Appliance sites." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListNetworkVirtualApplianceSites API service call." + }, + "NetworkVirtualApplianceSkuListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualApplianceSku" + }, + "description": "List of Network Virtual Appliance Skus that are available." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListNetworkVirtualApplianceSkus API service call." + }, + "InboundSecurityRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InboundSecurityRuleProperties", + "description": "The properties of the Inbound Security Rules." + }, + "name": { + "type": "string", + "description": "Name of security rule collection." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "NVA inbound security rule type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "NVA Inbound Security Rule resource." + }, + "InboundSecurityRuleProperties": { + "properties": { + "ruleType": { + "type": "string", + "enum": [ + "AutoExpire", + "Permanent" + ], + "x-ms-enum": { + "name": "InboundSecurityRuleType", + "modelAsString": true + }, + "description": "Rule Type. This should be either AutoExpire or Permanent. Auto Expire Rule only creates NSG rules. Permanent Rule creates NSG rule and SLB LB Rule." + }, + "rules": { + "type": "array", + "readOnly": false, + "description": "List of allowed rules.", + "items": { + "$ref": "#/definitions/InboundSecurityRules" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the Inbound Security Rules resource." + }, + "InboundSecurityRules": { + "properties": { + "name": { + "type": "string", + "description": "Name of the rule." + }, + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "InboundSecurityRulesProtocol", + "modelAsString": true + }, + "description": "Protocol. This should be either TCP or UDP." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range." + }, + "destinationPortRange": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "NVA port ranges to be opened up. One needs to provide specific ports." + }, + "destinationPortRanges": { + "type": "array", + "readOnly": false, + "description": "NVA port ranges to be opened up. One can provide a range of ports. Allowed port value between 0 and 65535.", + "items": { + "type": "string" + } + }, + "appliesOn": { + "type": "array", + "readOnly": false, + "description": "Public IP name in case of Permanent Rule type & Interface Name in case of Auto Expire Rule type", + "items": { + "type": "string" + } + } + }, + "description": "Properties of the Inbound Security Rules resource." + }, + "DelegationProperties": { + "type": "object", + "properties": { + "serviceName": { + "type": "string", + "description": "The service name to which the NVA is delegated." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the delegation." + }, + "PartnerManagedResourceProperties": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "PaloAltoNetworks.Cloudngfw/firewalls" + } + ] + }, + "description": "The partner managed resource id." + }, + "internalLoadBalancerId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/loadBalancers" + } + ] + }, + "description": "The partner managed ILB resource id" + }, + "standardLoadBalancerId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/loadBalancers" + } + ] + }, + "description": "The partner managed SLB resource id" + } + }, + "description": "Properties of the partner managed resource." + }, + "NetworkVirtualApplianceInstanceIds": { + "type": "object", + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The network virtual appliance instance ids. Omitting the network virtual appliance instance ids will result in the operation being performed on all virtual machines belonging to the network virtual appliance." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkWatcher.json new file mode 100644 index 000000000000..5cde1fcc17b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkWatcher.json @@ -0,0 +1,4854 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}": { + "put": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CreateOrUpdate", + "description": "Creates or updates a network watcher in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkWatcher" + }, + "description": "Parameters that define the network watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create network watcher": { + "$ref": "./examples/NetworkWatcherCreate.json" + } + } + }, + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Get", + "description": "Gets the specified network watcher by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network watcher": { + "$ref": "./examples/NetworkWatcherGet.json" + } + } + }, + "delete": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Delete", + "description": "Deletes the specified network watcher resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete network watcher": { + "$ref": "./examples/NetworkWatcherDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_UpdateTags", + "description": "Updates a network watcher tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network watcher tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network watcher tags": { + "$ref": "./examples/NetworkWatcherUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_List", + "description": "Gets all network watchers by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List network watchers": { + "$ref": "./examples/NetworkWatcherList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAll", + "description": "Gets all network watchers by subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List all network watchers": { + "$ref": "./examples/NetworkWatcherListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTopology", + "description": "Gets the current network topology by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TopologyParameters" + }, + "description": "Parameters that define the representation of topology." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the topology of resource group.", + "schema": { + "$ref": "#/definitions/Topology" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Topology": { + "$ref": "./examples/NetworkWatcherTopologyGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_VerifyIPFlow", + "description": "Verify IP flow from the specified VM to a location given the currently configured NSG rules.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VerificationIPFlowParameters" + }, + "description": "Parameters that define the IP flow to be verified." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the result of IP flow verification.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ip flow verify": { + "$ref": "./examples/NetworkWatcherIpFlowVerify.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetNextHop", + "description": "Gets the next hop from the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NextHopParameters" + }, + "description": "Parameters that define the source and destination endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the next hop from the VM.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get next hop": { + "$ref": "./examples/NetworkWatcherNextHopGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetVMSecurityRules", + "description": "Gets the configured and effective security group rules on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityGroupViewParameters" + }, + "description": "Parameters that define the VM to check security groups for." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns security group rules on the VM.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get security group view": { + "$ref": "./examples/NetworkWatcherSecurityGroupViewGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}": { + "put": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Create", + "description": "Create and start a packet capture on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PacketCapture" + }, + "description": "Parameters that define the create packet capture operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Get", + "description": "Gets a packet capture session by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureGet.json" + } + } + }, + "delete": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Delete", + "description": "Deletes the specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Stop", + "description": "Stops a specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the packet capture session." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureStop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_GetStatus", + "description": "Query the status of a running packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name given to the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful query of packet capture status.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + }, + "202": { + "description": "Accepted query status of packet capture.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query packet capture status": { + "$ref": "./examples/NetworkWatcherPacketCaptureQueryStatus.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures": { + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_List", + "description": "Lists all packet capture sessions within the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful packet capture enumeration request.", + "schema": { + "$ref": "#/definitions/PacketCaptureListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List packet captures": { + "$ref": "./examples/NetworkWatcherPacketCapturesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshooting", + "description": "Initiate troubleshooting on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TroubleshootingParameters" + }, + "description": "Parameters that define the resource to troubleshoot." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful troubleshooting request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get troubleshooting": { + "$ref": "./examples/NetworkWatcherTroubleshootGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshootingResult", + "description": "Get the last completed troubleshooting result on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryTroubleshootingParameters" + }, + "description": "Parameters that define the resource to query the troubleshooting result." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful get troubleshooting result request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting result request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get troubleshoot result": { + "$ref": "./examples/NetworkWatcherTroubleshootResultQuery.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_SetFlowLogConfiguration", + "description": "Configures flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogInformation" + }, + "description": "Parameters that define the configuration of flow log." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for setting flow log and traffic analytics (optional) configuration.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Configure flow log": { + "$ref": "./examples/NetworkWatcherFlowLogConfigure.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_GetFlowLogStatus", + "description": "Queries status of flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogStatusParameters" + }, + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for query flow log and traffic analytics (optional) status.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get flow log status": { + "$ref": "./examples/NetworkWatcherFlowLogStatusQuery.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CheckConnectivity", + "description": "Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectivityParameters" + }, + "description": "Parameters that determine how the connectivity check will be performed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for checking connectivity.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check connectivity": { + "$ref": "./examples/NetworkWatcherConnectivityCheck.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetAzureReachabilityReport", + "description": "NOTE: This feature is currently in preview and still being tested for stability. Gets the relative latency score for internet service providers from a specified location to Azure regions.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureReachabilityReportParameters" + }, + "description": "Parameters that determine Azure reachability report configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for Azure reachability report.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Reachability Report": { + "$ref": "./examples/NetworkWatcherAzureReachabilityReportGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAvailableProviders", + "description": "NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailableProvidersListParameters" + }, + "description": "Parameters that scope the list of available providers." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for list of available providers.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Available Providers List": { + "$ref": "./examples/NetworkWatcherAvailableProvidersListGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", + "description": "Gets Network Configuration Diagnostic data to help customers understand and debug network behavior. It provides detailed information on what security rules were applied to a specified traffic flow and the result of evaluating these rules. Customers must provide details of a flow like source, destination, protocol, etc. The API returns whether traffic was allowed or denied, the rules evaluated for the specified flow and the evaluation results.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticParameters" + }, + "description": "Parameters to get network configuration diagnostic." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the result of network configuration diagnostic.", + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Network configuration diagnostic": { + "$ref": "./examples/NetworkWatcherNetworkConfigurationDiagnostic.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}": { + "put": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_CreateOrUpdate", + "description": "Create or update a connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionMonitor" + }, + "description": "Parameters that define the operation to create a connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "migrate", + "in": "query", + "required": false, + "type": "string", + "description": "Value indicating whether connection monitor V1 should be migrated to V2 format." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create connection monitor V1": { + "$ref": "./examples/NetworkWatcherConnectionMonitorCreate.json" + }, + "Create connection monitor V2": { + "$ref": "./examples/NetworkWatcherConnectionMonitorV2Create.json" + }, + "Create connection monitor with Arc Network": { + "$ref": "./examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Get", + "description": "Gets a connection monitor by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a connection monitor.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorGet.json" + } + } + }, + "delete": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Delete", + "description": "Deletes the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_UpdateTags", + "description": "Update tags of the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update connection monitor tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns updated connection monitor.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update connection monitor tags": { + "$ref": "./examples/NetworkWatcherConnectionMonitorUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/stop": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Stop", + "description": "Stops the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the connection monitor." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorStop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/start": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Start", + "description": "Starts the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation starts the connection monitor." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorStart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/query": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Query", + "description": "Query a snapshot of the most recent connection states.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name given to the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful query of connection states.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorQueryResult" + } + }, + "202": { + "description": "Accepted query of connection states.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorQueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorQuery.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors": { + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_List", + "description": "Lists all connection monitors for the specified Network Watcher.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful connection monitor enumeration request.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List connection monitors": { + "$ref": "./examples/NetworkWatcherConnectionMonitorList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}": { + "put": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_CreateOrUpdate", + "description": "Create or update a flow log for the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLog" + }, + "description": "Parameters that define the create or update flow log resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting flow log resource.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting flow log resource.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update flow log": { + "$ref": "./examples/NetworkWatcherFlowLogCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_UpdateTags", + "description": "Update tags of the specified flow log.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update flow log tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns updated flow log.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update flow log tags": { + "$ref": "./examples/NetworkWatcherFlowLogUpdateTags.json" + } + } + }, + "get": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_Get", + "description": "Gets a flow log resource by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a flow log resource.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get flow log": { + "$ref": "./examples/NetworkWatcherFlowLogGet.json" + } + } + }, + "delete": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_Delete", + "description": "Deletes the specified flow log resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete flow log": { + "$ref": "./examples/NetworkWatcherFlowLogDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs": { + "get": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_List", + "description": "Lists all flow log resources for the specified Network Watcher.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful flow log enumeration request.", + "schema": { + "$ref": "#/definitions/FlowLogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List connection monitors": { + "$ref": "./examples/NetworkWatcherFlowLogList.json" + } + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "The error object.", + "properties": { + "error": { + "title": "Error", + "$ref": "./network.json#/definitions/ErrorDetails", + "description": "The error details object." + } + } + }, + "NetworkWatcher": { + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkWatcherPropertiesFormat", + "description": "Properties of the network watcher." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network watcher in a resource group." + }, + "NetworkWatcherPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network watcher resource." + } + }, + "description": "The network watcher properties." + }, + "NetworkWatcherListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkWatcher" + }, + "description": "List of network watcher resources." + } + }, + "description": "Response for ListNetworkWatchers API service call." + }, + "TopologyParameters": { + "properties": { + "targetResourceGroupName": { + "type": "string", + "description": "The name of the target resource group to perform topology on." + }, + "targetVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the Virtual Network resource." + }, + "targetSubnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the Subnet resource." + } + }, + "description": "Parameters that define the representation of topology." + }, + "Topology": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "GUID representing the operation id." + }, + "createdDateTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was initially created for the resource group." + }, + "lastModified": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was last modified." + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/TopologyResource" + }, + "description": "A list of topology resources." + } + }, + "description": "Topology of the specified resource group." + }, + "TopologyResource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource." + }, + "id": { + "type": "string", + "description": "ID of the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "associations": { + "type": "array", + "description": "Holds the associations the resource has with other resources in the resource group.", + "items": { + "$ref": "#/definitions/TopologyAssociation" + } + } + }, + "description": "The network resource topology information for the given resource group." + }, + "TopologyAssociation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource that is associated with the parent resource." + }, + "resourceId": { + "type": "string", + "description": "The ID of the resource that is associated with the parent resource." + }, + "associationType": { + "type": "string", + "enum": [ + "Associated", + "Contains" + ], + "x-ms-enum": { + "name": "AssociationType", + "modelAsString": true + }, + "description": "The association type of the child resource to the parent resource." + } + }, + "description": "Resources that have an association with the parent resource." + }, + "VerificationIPFlowParameters": { + "description": "Parameters that define the IP flow to be verified.", + "required": [ + "targetResourceId", + "direction", + "protocol", + "localPort", + "remotePort", + "localIPAddress", + "remoteIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The ID of the target resource to perform next-hop on." + }, + "direction": { + "$ref": "#/definitions/Direction", + "description": "The direction of the packet represented as a 5-tuple." + }, + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "IpFlowProtocol", + "modelAsString": true + }, + "description": "Protocol to be verified on." + }, + "localPort": { + "type": "string", + "description": "The local port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "remotePort": { + "type": "string", + "description": "The remote port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "localIPAddress": { + "type": "string", + "description": "The local IP address. Acceptable values are valid IPv4 addresses." + }, + "remoteIPAddress": { + "type": "string", + "description": "The remote IP address. Acceptable values are valid IPv4 addresses." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this parameter must be specified. Otherwise optional)." + } + } + }, + "VerificationIPFlowResult": { + "description": "Results of IP flow verification on the target resource.", + "properties": { + "access": { + "$ref": "./network.json#/definitions/Access", + "description": "Indicates whether the traffic is allowed or denied." + }, + "ruleName": { + "type": "string", + "description": "Name of the rule. If input is not matched against any security rule, it is not displayed." + } + } + }, + "NextHopParameters": { + "description": "Parameters that define the source and destination endpoint.", + "required": [ + "targetResourceId", + "sourceIPAddress", + "destinationIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The resource identifier of the target resource against which the action is to be performed." + }, + "sourceIPAddress": { + "type": "string", + "description": "The source IP address." + }, + "destinationIPAddress": { + "type": "string", + "description": "The destination IP address." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional)." + } + } + }, + "NextHopResult": { + "description": "The information about next hop from the specified VM.", + "properties": { + "nextHopType": { + "type": "string", + "enum": [ + "Internet", + "VirtualAppliance", + "VirtualNetworkGateway", + "VnetLocal", + "HyperNetGateway", + "None" + ], + "x-ms-enum": { + "name": "NextHopType", + "modelAsString": true + }, + "description": "Next hop type." + }, + "nextHopIpAddress": { + "type": "string", + "description": "Next hop IP Address." + }, + "routeTableId": { + "type": "string", + "description": "The resource identifier for the route table associated with the route being returned. If the route being returned does not correspond to any user created routes then this field will be the string 'System Route'." + } + } + }, + "SecurityGroupViewParameters": { + "description": "Parameters that define the VM to check security groups for.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "ID of the target VM." + } + } + }, + "SecurityGroupViewResult": { + "description": "The information about security rules applied to the specified VM.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "List of network interfaces on the specified VM.", + "items": { + "$ref": "#/definitions/SecurityGroupNetworkInterface" + } + } + } + }, + "SecurityGroupNetworkInterface": { + "description": "Network interface and all its associated security rules.", + "properties": { + "id": { + "type": "string", + "description": "ID of the network interface." + }, + "securityRuleAssociations": { + "$ref": "#/definitions/SecurityRuleAssociations", + "description": "All security rules associated with the network interface." + } + } + }, + "SecurityRuleAssociations": { + "description": "All security rules associated with the network interface.", + "properties": { + "networkInterfaceAssociation": { + "$ref": "#/definitions/NetworkInterfaceAssociation", + "description": "Network interface and it's custom security rules." + }, + "subnetAssociation": { + "$ref": "#/definitions/SubnetAssociation", + "description": "Subnet and it's custom security rules." + }, + "defaultSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + }, + "description": "Collection of default security rules of the network security group." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "Collection of effective security rules." + } + } + }, + "NetworkInterfaceAssociation": { + "description": "Network interface and its custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Network interface ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "SubnetAssociation": { + "description": "Subnet and it's custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Subnet ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "PacketCapture": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureParameters", + "description": "Properties of the packet capture." + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureParameters": { + "properties": { + "target": { + "type": "string", + "description": "The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported." + }, + "scope": { + "$ref": "#/definitions/PacketCaptureMachineScope", + "description": "A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS." + }, + "targetType": { + "description": "Target type of the resource provided.", + "type": "string", + "enum": [ + "AzureVM", + "AzureVMSS" + ], + "x-ms-enum": { + "name": "PacketCaptureTargetType", + "modelAsString": false + } + }, + "bytesToCapturePerPacket": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "default": 0, + "description": "Number of bytes captured per packet, the remaining bytes are truncated." + }, + "totalBytesPerSession": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "default": 1073741824, + "description": "Maximum size of the capture output." + }, + "timeLimitInSeconds": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 18000, + "default": 18000, + "description": "Maximum duration of the capture session in seconds." + }, + "storageLocation": { + "$ref": "#/definitions/PacketCaptureStorageLocation", + "description": "The storage location for a packet capture session." + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureFilter" + }, + "description": "A list of packet capture filters." + }, + "continuousCapture": { + "description": "This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.", + "type": "boolean" + }, + "captureSettings": { + "type": "object", + "$ref": "#/definitions/PacketCaptureSettings", + "description": "The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values." + } + }, + "required": [ + "target", + "storageLocation" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureMachineScope": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "List of AzureVMSS instances to run packet capture on.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.", + "items": { + "type": "string" + } + } + }, + "description": "A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS." + }, + "PacketCaptureStorageLocation": { + "properties": { + "storageId": { + "type": "string", + "description": "The ID of the storage account to save the packet capture session. Required if no localPath or filePath is provided." + }, + "storagePath": { + "type": "string", + "description": "The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture." + }, + "filePath": { + "type": "string", + "description": "This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional." + }, + "localPath": { + "type": "string", + "description": "This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures." + } + }, + "description": "The storage location for a packet capture session." + }, + "PacketCaptureSettings": { + "properties": { + "fileCount": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 10000, + "default": 10, + "description": "Number of file count. Default value of count is 10 and maximum number is 10000." + }, + "fileSizeInBytes": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "default": 104857600, + "description": "Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB)." + }, + "sessionTimeLimitInSeconds": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 604800, + "default": 86400, + "description": "Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day)." + } + }, + "description": "The storage location for a packet capture session." + }, + "PacketCaptureFilter": { + "properties": { + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP", + "Any" + ], + "x-ms-enum": { + "name": "PcProtocol", + "modelAsString": true + }, + "default": "Any", + "description": "Protocol to be filtered on." + }, + "localIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remoteIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "localPort": { + "type": "string", + "description": "Local port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remotePort": { + "type": "string", + "description": "Remote port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + } + }, + "description": "Filter that is applied to packet capture request. Multiple filters can be applied." + }, + "PacketCaptureListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureResult" + }, + "description": "Information about packet capture sessions." + } + }, + "description": "List of packet capture sessions." + }, + "PacketCaptureResult": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the packet capture session." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the packet capture operation." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureResultProperties", + "description": "Properties of the packet capture result." + } + }, + "description": "Information about packet capture session." + }, + "PacketCaptureResultProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the packet capture session." + } + }, + "allOf": [ + { + "$ref": "#/definitions/PacketCaptureParameters" + } + ], + "description": "The properties of a packet capture session." + }, + "PacketCaptureQueryStatusResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the packet capture resource." + }, + "id": { + "type": "string", + "description": "The ID of the packet capture resource." + }, + "captureStartTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the packet capture session." + }, + "packetCaptureStatus": { + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Stopped", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "PcStatus", + "modelAsString": true + }, + "description": "The status of the packet capture session." + }, + "stopReason": { + "type": "string", + "description": "The reason the current packet capture session was stopped." + }, + "packetCaptureError": { + "type": "array", + "description": "List of errors of packet capture session.", + "items": { + "type": "string", + "enum": [ + "InternalError", + "AgentStopped", + "CaptureFailed", + "LocalFileFailed", + "StorageFailed" + ], + "x-ms-enum": { + "name": "PcError", + "modelAsString": true + } + } + } + }, + "description": "Status of packet capture session." + }, + "TroubleshootingParameters": { + "description": "Parameters that define the resource to troubleshoot.", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The target resource to troubleshoot.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TroubleshootingProperties", + "description": "Properties of the troubleshooting resource." + } + } + }, + "QueryTroubleshootingParameters": { + "description": "Parameters that define the resource to query the troubleshooting result.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource ID to query the troubleshooting result.", + "type": "string" + } + } + }, + "TroubleshootingProperties": { + "description": "Storage location provided for troubleshoot.", + "required": [ + "storageId", + "storagePath" + ], + "properties": { + "storageId": { + "description": "The ID for the storage account to save the troubleshoot result.", + "type": "string" + }, + "storagePath": { + "description": "The path to the blob to save the troubleshoot result in.", + "type": "string" + } + } + }, + "TroubleshootingResult": { + "description": "Troubleshooting information gained from specified resource.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the troubleshooting." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the troubleshooting." + }, + "code": { + "type": "string", + "description": "The result code of the troubleshooting." + }, + "results": { + "type": "array", + "description": "Information from troubleshooting.", + "items": { + "$ref": "#/definitions/TroubleshootingDetails" + } + } + } + }, + "TroubleshootingDetails": { + "description": "Information gained from troubleshooting of specified resource.", + "properties": { + "id": { + "type": "string", + "description": "The id of the get troubleshoot operation." + }, + "reasonType": { + "type": "string", + "description": "Reason type of failure." + }, + "summary": { + "type": "string", + "description": "A summary of troubleshooting." + }, + "detail": { + "type": "string", + "description": "Details on troubleshooting results." + }, + "recommendedActions": { + "type": "array", + "description": "List of recommended actions.", + "items": { + "$ref": "#/definitions/TroubleshootingRecommendedActions" + } + } + } + }, + "TroubleshootingRecommendedActions": { + "description": "Recommended actions based on discovered issues.", + "properties": { + "actionId": { + "description": "ID of the recommended action.", + "type": "string" + }, + "actionText": { + "description": "Description of recommended actions.", + "type": "string" + }, + "actionUri": { + "description": "The uri linking to a documentation for the recommended troubleshooting actions.", + "type": "string" + }, + "actionUriText": { + "description": "The information from the URI for the recommended troubleshooting actions.", + "type": "string" + } + } + }, + "FlowLogListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FlowLog" + }, + "description": "Information about flow log resource." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "List of flow logs." + }, + "FlowLog": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FlowLogPropertiesFormat", + "description": "Properties of the flow log." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "identity": { + "description": "FlowLog resource Managed Identity", + "$ref": "./network.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A flow log resource." + }, + "FlowLogPropertiesFormat": { + "description": "Parameters that define the configuration of flow log.", + "required": [ + "targetResourceId", + "storageId" + ], + "properties": { + "targetResourceId": { + "description": "ID of network security group to which flow log will be applied.", + "type": "string" + }, + "targetResourceGuid": { + "readOnly": true, + "description": "Guid of network security group to which flow log will be applied.", + "type": "string" + }, + "storageId": { + "description": "ID of the storage account which is used to store the flow log.", + "type": "string" + }, + "enabled": { + "description": "Flag to enable/disable flow logging.", + "type": "boolean" + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicyParameters", + "description": "Parameters that define the retention policy for flow log." + }, + "format": { + "$ref": "#/definitions/FlowLogFormatParameters", + "description": "Parameters that define the flow log format." + }, + "flowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsProperties", + "description": "Parameters that define the configuration of traffic analytics." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the flow log." + } + } + }, + "FlowLogProperties": { + "description": "Parameters that define the configuration of flow log.", + "required": [ + "storageId", + "enabled" + ], + "properties": { + "storageId": { + "description": "ID of the storage account which is used to store the flow log.", + "type": "string" + }, + "enabled": { + "description": "Flag to enable/disable flow logging.", + "type": "boolean" + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicyParameters", + "description": "Parameters that define the retention policy for flow log." + }, + "format": { + "$ref": "#/definitions/FlowLogFormatParameters", + "description": "Parameters that define the flow log format." + } + } + }, + "FlowLogStatusParameters": { + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource where getting the flow log and traffic analytics (optional) status.", + "type": "string" + } + } + }, + "RetentionPolicyParameters": { + "description": "Parameters that define the retention policy for flow log.", + "properties": { + "days": { + "description": "Number of days to retain flow log records.", + "type": "integer", + "format": "int32", + "default": 0 + }, + "enabled": { + "description": "Flag to enable/disable retention.", + "type": "boolean", + "default": false + } + } + }, + "FlowLogFormatParameters": { + "description": "Parameters that define the flow log format.", + "properties": { + "type": { + "type": "string", + "description": "The file type of flow log.", + "enum": [ + "JSON" + ], + "x-ms-enum": { + "name": "FlowLogFormatType", + "modelAsString": true + } + }, + "version": { + "description": "The version (revision) of the flow log.", + "type": "integer", + "format": "int32", + "default": 0 + } + } + }, + "FlowLogInformation": { + "description": "Information on the configuration of flow log and traffic analytics (optional) .", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The ID of the resource to configure for flow log and traffic analytics (optional) .", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FlowLogProperties", + "description": "Properties of the flow log." + }, + "flowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsProperties", + "description": "Parameters that define the configuration of traffic analytics." + }, + "identity": { + "description": "FlowLog resource Managed Identity", + "$ref": "./network.json#/definitions/ManagedServiceIdentity" + } + } + }, + "TrafficAnalyticsProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "properties": { + "networkWatcherFlowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsConfigurationProperties", + "description": "Parameters that define the configuration of traffic analytics." + } + } + }, + "TrafficAnalyticsConfigurationProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "properties": { + "enabled": { + "description": "Flag to enable/disable traffic analytics.", + "type": "boolean" + }, + "workspaceId": { + "description": "The resource guid of the attached workspace.", + "type": "string" + }, + "workspaceRegion": { + "description": "The location of the attached workspace.", + "type": "string" + }, + "workspaceResourceId": { + "description": "Resource Id of the attached workspace.", + "type": "string" + }, + "trafficAnalyticsInterval": { + "description": "The interval in minutes which would decide how frequently TA service should do flow analytics.", + "type": "integer", + "format": "int32" + } + } + }, + "ConnectivityParameters": { + "description": "Parameters that determine how the connectivity check will be performed.", + "required": [ + "source", + "destination" + ], + "properties": { + "source": { + "$ref": "#/definitions/ConnectivitySource", + "description": "The source of the connection." + }, + "destination": { + "$ref": "#/definitions/ConnectivityDestination", + "description": "The destination of connection." + }, + "protocol": { + "type": "string", + "description": "Network protocol.", + "enum": [ + "Tcp", + "Http", + "Https", + "Icmp" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "protocolConfiguration": { + "$ref": "#/definitions/ProtocolConfiguration", + "description": "Configuration of the protocol." + }, + "preferredIPVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Preferred IP version of the connection." + } + } + }, + "ConnectivitySource": { + "description": "Parameters that define the source of the connection.", + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "description": "The ID of the resource from which a connectivity check will be initiated.", + "type": "string" + }, + "port": { + "description": "The source port from which a connectivity check will be performed.", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535 + } + } + }, + "ConnectivityDestination": { + "description": "Parameters that define destination of connection.", + "properties": { + "resourceId": { + "description": "The ID of the resource to which a connection attempt will be made.", + "type": "string" + }, + "address": { + "description": "The IP address or URI the resource to which a connection attempt will be made.", + "type": "string" + }, + "port": { + "description": "Port on which check connectivity will be performed.", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535 + } + } + }, + "ConnectivityInformation": { + "description": "Information on the connectivity status.", + "properties": { + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "#/definitions/ConnectivityHop" + } + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "Connected", + "Disconnected", + "Degraded" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + }, + "description": "The connection status." + }, + "avgLatencyInMs": { + "description": "Average latency in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "minLatencyInMs": { + "description": "Minimum latency in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "maxLatencyInMs": { + "description": "Maximum latency in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "probesSent": { + "description": "Total number of probes sent.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "probesFailed": { + "description": "Number of failed probes.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "ConnectivityHop": { + "description": "Information about a hop between the source and the destination.", + "properties": { + "type": { + "description": "The type of the hop.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the hop.", + "readOnly": true, + "type": "string" + }, + "address": { + "description": "The IP address of the hop.", + "readOnly": true, + "type": "string" + }, + "resourceId": { + "description": "The ID of the resource corresponding to this hop.", + "readOnly": true, + "type": "string" + }, + "nextHopIds": { + "readOnly": true, + "type": "array", + "description": "List of next hop identifiers.", + "items": { + "type": "string" + } + }, + "previousHopIds": { + "readOnly": true, + "type": "array", + "description": "List of previous hop identifiers.", + "items": { + "type": "string" + } + }, + "links": { + "readOnly": true, + "type": "array", + "description": "List of hop links.", + "items": { + "$ref": "#/definitions/HopLink" + } + }, + "previousLinks": { + "readOnly": true, + "type": "array", + "description": "List of previous hop links.", + "items": { + "$ref": "#/definitions/HopLink" + } + }, + "issues": { + "readOnly": true, + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + } + } + } + }, + "HopLink": { + "description": "Hop link.", + "properties": { + "nextHopId": { + "description": "The ID of the next hop.", + "readOnly": true, + "type": "string" + }, + "linkType": { + "description": "Link type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HopLinkProperties", + "description": "Hop link properties." + }, + "issues": { + "readOnly": true, + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + } + }, + "context": { + "readOnly": true, + "type": "object", + "description": "Provides additional context on links.", + "additionalProperties": { + "type": "string" + } + }, + "resourceId": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + } + } + }, + "HopLinkProperties": { + "description": "Hop link properties.", + "properties": { + "roundTripTimeMin": { + "description": "Minimum roundtrip time in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295 + }, + "roundTripTimeAvg": { + "description": "Average roundtrip time in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295 + }, + "roundTripTimeMax": { + "description": "Maximum roundtrip time in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295 + } + } + }, + "ConnectivityIssue": { + "description": "Information about an issue encountered in the process of checking for connectivity.", + "properties": { + "origin": { + "readOnly": true, + "type": "string", + "enum": [ + "Local", + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + }, + "description": "The origin of the issue." + }, + "severity": { + "readOnly": true, + "type": "string", + "enum": [ + "Error", + "Warning" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + }, + "description": "The severity of the issue." + }, + "type": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "AgentStopped", + "GuestFirewall", + "DnsResolution", + "SocketBind", + "NetworkSecurityRule", + "UserDefinedRoute", + "PortThrottled", + "Platform" + ], + "x-ms-enum": { + "name": "IssueType", + "modelAsString": true + }, + "description": "The type of issue." + }, + "context": { + "readOnly": true, + "type": "array", + "description": "Provides additional context on the issue.", + "items": { + "$ref": "#/definitions/IssueContext" + } + } + } + }, + "IssueContext": { + "description": "A key-value pair that provides additional context on the issue.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "ProtocolConfiguration": { + "description": "Configuration of the protocol.", + "properties": { + "HTTPConfiguration": { + "$ref": "#/definitions/HTTPConfiguration", + "description": "HTTP configuration of the connectivity check." + } + } + }, + "HTTPConfiguration": { + "properties": { + "method": { + "type": "string", + "description": "HTTP method.", + "enum": [ + "Get" + ], + "x-ms-enum": { + "name": "HTTPMethod", + "modelAsString": true + } + }, + "headers": { + "type": "array", + "description": "List of HTTP headers.", + "items": { + "$ref": "#/definitions/HTTPHeader" + } + }, + "validStatusCodes": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Valid status codes." + } + }, + "description": "HTTP configuration of the connectivity check." + }, + "HTTPHeader": { + "properties": { + "name": { + "type": "string", + "description": "The name in HTTP header." + }, + "value": { + "type": "string", + "description": "The value in HTTP header." + } + }, + "description": "The HTTP header." + }, + "AzureReachabilityReportParameters": { + "properties": { + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation", + "description": "Parameters that define a geographic location." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Internet service providers." + }, + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional Azure regions to scope the query to." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the Azure reachability report." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the Azure reachability report." + } + }, + "required": [ + "providerLocation", + "startTime", + "endTime" + ], + "description": "Geographic and time constraints for Azure reachability report." + }, + "AzureReachabilityReportLocation": { + "properties": { + "country": { + "type": "string", + "description": "The name of the country." + }, + "state": { + "type": "string", + "description": "The name of the state." + }, + "city": { + "type": "string", + "description": "The name of the city or town." + } + }, + "required": [ + "country" + ], + "description": "Parameters that define a geographic location." + }, + "AzureReachabilityReport": { + "properties": { + "aggregationLevel": { + "type": "string", + "description": "The aggregation level of Azure reachability report. Can be Country, State or City." + }, + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation", + "description": "Parameters that define a geographic location." + }, + "reachabilityReport": { + "type": "array", + "description": "List of Azure reachability report items.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportItem" + } + } + }, + "required": [ + "aggregationLevel", + "providerLocation", + "reachabilityReport" + ], + "description": "Azure reachability report details." + }, + "AzureReachabilityReportItem": { + "properties": { + "provider": { + "type": "string", + "description": "The Internet service provider." + }, + "azureLocation": { + "type": "string", + "description": "The Azure region." + }, + "latencies": { + "type": "array", + "description": "List of latency details for each of the time series.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportLatencyInfo" + } + } + }, + "description": "Azure reachability report details for a given provider location." + }, + "AzureReachabilityReportLatencyInfo": { + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "The time stamp." + }, + "score": { + "type": "integer", + "format": "int32", + "description": "The relative latency score between 1 and 100, higher values indicating a faster connection.", + "minimum": 1, + "maximum": 100 + } + }, + "description": "Details on latency for a time series." + }, + "AvailableProvidersListParameters": { + "properties": { + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Azure regions." + }, + "country": { + "type": "string", + "description": "The country for available providers list." + }, + "state": { + "type": "string", + "description": "The state for available providers list." + }, + "city": { + "type": "string", + "description": "The city or town for available providers list." + } + }, + "description": "Constraints that determine the list of available Internet service providers." + }, + "AvailableProvidersList": { + "properties": { + "countries": { + "type": "array", + "description": "List of available countries.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCountry" + } + } + }, + "required": [ + "countries" + ], + "description": "List of available countries with details." + }, + "AvailableProvidersListCountry": { + "properties": { + "countryName": { + "type": "string", + "description": "The country name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "states": { + "type": "array", + "description": "List of available states in the country.", + "items": { + "$ref": "#/definitions/AvailableProvidersListState" + } + } + }, + "description": "Country details." + }, + "AvailableProvidersListState": { + "properties": { + "stateName": { + "type": "string", + "description": "The state name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "cities": { + "type": "array", + "description": "List of available cities or towns in the state.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCity" + } + } + }, + "description": "State details." + }, + "AvailableProvidersListCity": { + "properties": { + "cityName": { + "type": "string", + "description": "The city or town name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + } + }, + "description": "City or town details." + }, + "NetworkConfigurationDiagnosticParameters": { + "description": "Parameters to get network configuration diagnostic.", + "required": [ + "targetResourceId", + "profiles" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway." + }, + "verbosityLevel": { + "type": "string", + "enum": [ + "Normal", + "Minimum", + "Full" + ], + "x-ms-enum": { + "name": "VerbosityLevel", + "modelAsString": true + }, + "description": "Verbosity level." + }, + "profiles": { + "type": "array", + "description": "List of network configuration diagnostic profiles.", + "items": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile" + } + } + } + }, + "NetworkConfigurationDiagnosticProfile": { + "description": "Parameters to compare with network configuration.", + "required": [ + "direction", + "protocol", + "source", + "destination", + "destinationPort" + ], + "properties": { + "direction": { + "$ref": "#/definitions/Direction", + "description": "The direction of the traffic." + }, + "protocol": { + "type": "string", + "description": "Protocol to be verified on. Accepted values are '*', TCP, UDP." + }, + "source": { + "type": "string", + "description": "Traffic source. Accepted values are '*', IP Address/CIDR, Service Tag." + }, + "destination": { + "type": "string", + "description": "Traffic destination. Accepted values are: '*', IP Address/CIDR, Service Tag." + }, + "destinationPort": { + "type": "string", + "description": "Traffic destination port. Accepted values are '*' and a single port in the range (0 - 65535)." + } + } + }, + "NetworkConfigurationDiagnosticResponse": { + "description": "Results of network configuration diagnostic on the target resource.", + "properties": { + "results": { + "readOnly": true, + "type": "array", + "description": "List of network configuration diagnostic results.", + "items": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResult" + } + } + } + }, + "NetworkConfigurationDiagnosticResult": { + "description": "Network configuration diagnostic result corresponded to provided traffic query.", + "properties": { + "profile": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile", + "description": "Network configuration diagnostic profile." + }, + "networkSecurityGroupResult": { + "$ref": "#/definitions/NetworkSecurityGroupResult", + "description": "Network security group result." + } + } + }, + "NetworkSecurityGroupResult": { + "description": "Network configuration diagnostic result corresponded provided traffic query.", + "properties": { + "securityRuleAccessResult": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "evaluatedNetworkSecurityGroups": { + "readOnly": true, + "type": "array", + "description": "List of results network security groups diagnostic.", + "items": { + "$ref": "#/definitions/EvaluatedNetworkSecurityGroup" + } + } + } + }, + "EvaluatedNetworkSecurityGroup": { + "description": "Results of network security group evaluation.", + "properties": { + "networkSecurityGroupId": { + "type": "string", + "description": "Network security group ID." + }, + "appliedTo": { + "type": "string", + "description": "Resource ID of nic or subnet to which network security group is applied." + }, + "matchedRule": { + "$ref": "#/definitions/MatchedRule", + "description": "Matched network security rule." + }, + "rulesEvaluationResult": { + "readOnly": true, + "type": "array", + "description": "List of network security rules evaluation results.", + "items": { + "$ref": "#/definitions/NetworkSecurityRulesEvaluationResult" + } + } + } + }, + "MatchedRule": { + "description": "Matched rule.", + "properties": { + "ruleName": { + "type": "string", + "description": "Name of the matched network security rule." + }, + "action": { + "type": "string", + "description": "The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'." + } + } + }, + "NetworkSecurityRulesEvaluationResult": { + "description": "Network security rules evaluation result.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network security rule." + }, + "protocolMatched": { + "type": "boolean", + "description": "Value indicating whether protocol is matched." + }, + "sourceMatched": { + "type": "boolean", + "description": "Value indicating whether source is matched." + }, + "sourcePortMatched": { + "type": "boolean", + "description": "Value indicating whether source port is matched." + }, + "destinationMatched": { + "type": "boolean", + "description": "Value indicating whether destination is matched." + }, + "destinationPortMatched": { + "type": "boolean", + "description": "Value indicating whether destination port is matched." + } + } + }, + "Direction": { + "type": "string", + "description": "The direction of the traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true + } + }, + "ConnectionMonitor": { + "properties": { + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorParameters", + "description": "Properties of the connection monitor." + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorParameters": { + "properties": { + "source": { + "$ref": "#/definitions/ConnectionMonitorSource", + "description": "Describes the source of connection monitor." + }, + "destination": { + "$ref": "#/definitions/ConnectionMonitorDestination", + "description": "Describes the destination of connection monitor." + }, + "autoStart": { + "type": "boolean", + "default": true, + "description": "Determines if the connection monitor will start automatically once created." + }, + "monitoringIntervalInSeconds": { + "type": "integer", + "format": "int32", + "minimum": 30, + "maximum": 1800, + "default": 60, + "description": "Monitoring interval in seconds." + }, + "endpoints": { + "type": "array", + "description": "List of connection monitor endpoints.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpoint" + } + }, + "testConfigurations": { + "type": "array", + "description": "List of connection monitor test configurations.", + "items": { + "$ref": "#/definitions/ConnectionMonitorTestConfiguration" + } + }, + "testGroups": { + "type": "array", + "description": "List of connection monitor test groups.", + "items": { + "$ref": "#/definitions/ConnectionMonitorTestGroup" + } + }, + "outputs": { + "type": "array", + "description": "List of connection monitor outputs.", + "items": { + "$ref": "#/definitions/ConnectionMonitorOutput" + } + }, + "notes": { + "type": "string", + "description": "Optional notes to be associated with the connection monitor." + } + }, + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorSource": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the source by connection monitor." + }, + "port": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "The source port used by connection monitor." + } + }, + "required": [ + "resourceId" + ], + "description": "Describes the source of connection monitor." + }, + "ConnectionMonitorDestination": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the destination by connection monitor." + }, + "address": { + "type": "string", + "description": "Address of the connection monitor destination (IP or domain name)." + }, + "port": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "The destination port used by connection monitor." + } + }, + "description": "Describes the destination of connection monitor." + }, + "ConnectionMonitorEndpoint": { + "properties": { + "name": { + "type": "string", + "description": "The name of the connection monitor endpoint." + }, + "type": { + "type": "string", + "enum": [ + "AzureVM", + "AzureVNet", + "AzureSubnet", + "ExternalAddress", + "MMAWorkspaceMachine", + "MMAWorkspaceNetwork", + "AzureArcVM", + "AzureVMSS", + "AzureArcNetwork" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + }, + "description": "The endpoint type." + }, + "resourceId": { + "type": "string", + "description": "Resource ID of the connection monitor endpoint are supported for AzureVM, AzureVMSS, AzureVNet, AzureSubnet, MMAWorkspaceMachine, MMAWorkspaceNetwork, AzureArcVM endpoint type." + }, + "address": { + "type": "string", + "description": "Address of the connection monitor endpoint. Supported for AzureVM, ExternalAddress, ArcMachine, MMAWorkspaceMachine endpoint type." + }, + "filter": { + "$ref": "#/definitions/ConnectionMonitorEndpointFilter", + "description": "Filter field is getting deprecated and should not be used. Instead use Include/Exclude scope fields for it." + }, + "scope": { + "$ref": "#/definitions/ConnectionMonitorEndpointScope", + "description": "Endpoint scope defines which target resource to monitor in case of compound resource endpoints like VMSS, AzureSubnet, AzureVNet, MMAWorkspaceNetwork, AzureArcNetwork." + }, + "coverageLevel": { + "type": "string", + "enum": [ + "Default", + "Low", + "BelowAverage", + "Average", + "AboveAverage", + "Full" + ], + "x-ms-enum": { + "name": "CoverageLevel", + "modelAsString": true + }, + "description": "Test coverage for the endpoint." + }, + "locationDetails": { + "$ref": "#/definitions/ConnectionMonitorEndpointLocationDetails", + "description": "Location details is optional and only being used for 'AzureArcNetwork' type endpoints, which contains region details." + }, + "subscriptionId": { + "type": "string", + "description": "Subscription ID for connection monitor endpoint. It's an optional parameter which is being used for 'AzureArcNetwork' type endpoint." + } + }, + "required": [ + "name" + ], + "description": "Describes the connection monitor endpoint." + }, + "ConnectionMonitorEndpointScope": { + "properties": { + "include": { + "type": "array", + "description": "List of items which needs to be included to the endpoint scope.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpointScopeItem" + } + }, + "exclude": { + "type": "array", + "description": "List of items which needs to be excluded from the endpoint scope.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpointScopeItem" + } + } + }, + "description": "Describes the connection monitor endpoint scope." + }, + "ConnectionMonitorEndpointScopeItem": { + "properties": { + "address": { + "type": "string", + "description": "The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address." + } + }, + "description": "Describes the connection monitor endpoint scope item." + }, + "ConnectionMonitorEndpointFilter": { + "properties": { + "type": { + "type": "string", + "enum": [ + "Include" + ], + "x-ms-enum": { + "name": "ConnectionMonitorEndpointFilterType", + "modelAsString": true + }, + "description": "The behavior of the endpoint filter. Currently only 'Include' is supported." + }, + "items": { + "type": "array", + "description": "List of items in the filter.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpointFilterItem" + } + } + }, + "description": "Describes the connection monitor endpoint filter." + }, + "ConnectionMonitorEndpointFilterItem": { + "properties": { + "type": { + "type": "string", + "enum": [ + "AgentAddress" + ], + "x-ms-enum": { + "name": "ConnectionMonitorEndpointFilterItemType", + "modelAsString": true + }, + "description": "The type of item included in the filter. Currently only 'AgentAddress' is supported." + }, + "address": { + "type": "string", + "description": "The address of the filter item." + } + }, + "description": "Describes the connection monitor endpoint filter item." + }, + "ConnectionMonitorTestGroup": { + "properties": { + "name": { + "type": "string", + "description": "The name of the connection monitor test group." + }, + "disable": { + "type": "boolean", + "description": "Value indicating whether test group is disabled." + }, + "testConfigurations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of test configuration names." + }, + "sources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of source endpoint names." + }, + "destinations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of destination endpoint names." + } + }, + "required": [ + "name", + "testConfigurations", + "sources", + "destinations" + ], + "description": "Describes the connection monitor test group." + }, + "ConnectionMonitorTestConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The name of the connection monitor test configuration." + }, + "testFrequencySec": { + "type": "integer", + "format": "int32", + "description": "The frequency of test evaluation, in seconds." + }, + "protocol": { + "type": "string", + "enum": [ + "Tcp", + "Http", + "Icmp" + ], + "x-ms-enum": { + "name": "ConnectionMonitorTestConfigurationProtocol", + "modelAsString": true + }, + "description": "The protocol to use in test evaluation." + }, + "preferredIPVersion": { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "PreferredIPVersion", + "modelAsString": true + }, + "description": "The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters." + }, + "httpConfiguration": { + "$ref": "#/definitions/ConnectionMonitorHttpConfiguration", + "description": "The parameters used to perform test evaluation over HTTP." + }, + "tcpConfiguration": { + "$ref": "#/definitions/ConnectionMonitorTcpConfiguration", + "description": "The parameters used to perform test evaluation over TCP." + }, + "icmpConfiguration": { + "$ref": "#/definitions/ConnectionMonitorIcmpConfiguration", + "description": "The parameters used to perform test evaluation over ICMP." + }, + "successThreshold": { + "$ref": "#/definitions/ConnectionMonitorSuccessThreshold", + "description": "The threshold for declaring a test successful." + } + }, + "required": [ + "name", + "protocol" + ], + "description": "Describes a connection monitor test configuration." + }, + "ConnectionMonitorHttpConfiguration": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "The port to connect to." + }, + "method": { + "type": "string", + "description": "The HTTP method to use.", + "enum": [ + "Get", + "Post" + ], + "x-ms-enum": { + "name": "HTTPConfigurationMethod", + "modelAsString": true + } + }, + "path": { + "type": "string", + "description": "The path component of the URI. For instance, \"/dir1/dir2\"." + }, + "requestHeaders": { + "type": "array", + "description": "The HTTP headers to transmit with the request.", + "items": { + "$ref": "#/definitions/HTTPHeader" + } + }, + "validStatusCodeRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "HTTP status codes to consider successful. For instance, \"2xx,301-304,418\"." + }, + "preferHTTPS": { + "type": "boolean", + "description": "Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit." + } + }, + "description": "Describes the HTTP configuration." + }, + "ConnectionMonitorTcpConfiguration": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "The port to connect to." + }, + "disableTraceRoute": { + "type": "boolean", + "description": "Value indicating whether path evaluation with trace route should be disabled." + }, + "destinationPortBehavior": { + "type": "string", + "description": "Destination port behavior.", + "enum": [ + "None", + "ListenIfAvailable" + ], + "x-ms-enum": { + "name": "DestinationPortBehavior", + "modelAsString": true + } + } + }, + "description": "Describes the TCP configuration." + }, + "ConnectionMonitorIcmpConfiguration": { + "properties": { + "disableTraceRoute": { + "type": "boolean", + "description": "Value indicating whether path evaluation with trace route should be disabled." + } + }, + "description": "Describes the ICMP configuration." + }, + "ConnectionMonitorSuccessThreshold": { + "properties": { + "checksFailedPercent": { + "type": "integer", + "format": "int32", + "description": "The maximum percentage of failed checks permitted for a test to evaluate as successful." + }, + "roundTripTimeMs": { + "type": "number", + "description": "The maximum round-trip time in milliseconds permitted for a test to evaluate as successful." + } + }, + "description": "Describes the threshold for declaring a test successful." + }, + "ConnectionMonitorOutput": { + "properties": { + "type": { + "type": "string", + "description": "Connection monitor output destination type. Currently, only \"Workspace\" is supported.", + "enum": [ + "Workspace" + ], + "x-ms-enum": { + "name": "OutputType", + "modelAsString": true + } + }, + "workspaceSettings": { + "$ref": "#/definitions/ConnectionMonitorWorkspaceSettings", + "description": "Describes the settings for producing output into a log analytics workspace." + } + }, + "description": "Describes a connection monitor output destination." + }, + "ConnectionMonitorWorkspaceSettings": { + "properties": { + "workspaceResourceId": { + "type": "string", + "description": "Log analytics workspace resource ID." + } + }, + "description": "Describes the settings for producing output into a log analytics workspace." + }, + "ConnectionStateSnapshot": { + "properties": { + "connectionState": { + "type": "string", + "enum": [ + "Reachable", + "Unreachable", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionState", + "modelAsString": true + }, + "description": "The connection state." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the connection snapshot." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the connection snapshot." + }, + "evaluationState": { + "type": "string", + "enum": [ + "NotStarted", + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "EvaluationState", + "modelAsString": true + }, + "description": "Connectivity analysis evaluation state." + }, + "avgLatencyInMs": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Average latency in ms." + }, + "minLatencyInMs": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Minimum latency in ms." + }, + "maxLatencyInMs": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Maximum latency in ms." + }, + "probesSent": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The number of sent probes." + }, + "probesFailed": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The number of failed probes." + }, + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "./networkWatcher.json#/definitions/ConnectivityHop" + } + } + }, + "description": "Connection state snapshot." + }, + "ConnectionMonitorListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionMonitorResult" + }, + "description": "Information about connection monitors." + } + }, + "description": "List of connection monitors." + }, + "ConnectionMonitorResult": { + "x-ms-azure-resource": true, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the connection monitor." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the connection monitor." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Connection monitor type." + }, + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorResultProperties", + "description": "Properties of the connection monitor result." + } + }, + "description": "Information about the connection monitor." + }, + "ConnectionMonitorResultProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the connection monitor." + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date and time when the connection monitor was started." + }, + "monitoringStatus": { + "readOnly": true, + "type": "string", + "description": "The monitoring status of the connection monitor." + }, + "connectionMonitorType": { + "readOnly": true, + "type": "string", + "enum": [ + "MultiEndpoint", + "SingleSourceDestination" + ], + "x-ms-enum": { + "name": "ConnectionMonitorType", + "modelAsString": true + }, + "description": "Type of connection monitor." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionMonitorParameters" + } + ], + "description": "Describes the properties of a connection monitor." + }, + "ConnectionMonitorQueryResult": { + "properties": { + "sourceStatus": { + "type": "string", + "enum": [ + "Unknown", + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ConnectionMonitorSourceStatus", + "modelAsString": true + }, + "description": "Status of connection monitor source." + }, + "states": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionStateSnapshot" + }, + "description": "Information about connection states." + } + }, + "description": "List of connection states snapshots." + }, + "ConnectionMonitorEndpointLocationDetails": { + "type": "object", + "properties": { + "region": { + "type": "string", + "description": "Region for connection monitor endpoint." + } + }, + "description": "Connection monitor endpoint location details only being used for 'AzureArcNetwork' type endpoints, which contains the region details." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/operation.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/operation.json new file mode 100644 index 000000000000..d240277e63ec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/operation.json @@ -0,0 +1,271 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Network/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all of the available Network Rest API operations.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of operations for a resource provider": { + "$ref": "./examples/OperationList.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Network operations supported by the Network resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Network REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Network.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of the operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationPropertiesFormat", + "description": "Operation properties format." + } + } + }, + "OperationPropertiesFormat": { + "description": "Description of operation properties format.", + "properties": { + "serviceSpecification": { + "description": "Specification of the service.", + "properties": { + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "description": "Operation service specification." + }, + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "description": "Operation log specification." + } + } + } + } + }, + "LogSpecification": { + "description": "Description of logging specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the specification." + }, + "displayName": { + "type": "string", + "description": "The display name of the specification." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the blob." + } + } + }, + "MetricSpecification": { + "description": "Description of metrics specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "The display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "The description of the metric." + }, + "unit": { + "type": "string", + "description": "Units the metric to be displayed in." + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type." + }, + "availabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/Availability" + }, + "description": "List of availability." + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether regional MDM account enabled." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Whether gaps would be filled with zeros." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern for the filter of the metric." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "description": "List of dimensions." + }, + "isInternal": { + "type": "boolean", + "description": "Whether the metric is internal." + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "The resource Id dimension name override." + } + } + }, + "Dimension": { + "description": "Dimension of the metric.", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "displayName": { + "type": "string", + "description": "The display name of the dimension." + }, + "internalName": { + "type": "string", + "description": "The internal name of the dimension." + } + } + }, + "Availability": { + "description": "Availability of the metric.", + "properties": { + "timeGrain": { + "type": "string", + "description": "The time grain of the availability." + }, + "retention": { + "type": "string", + "description": "The retention of the availability." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the availability blob." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateEndpoint.json new file mode 100644 index 000000000000..e85c54ab24f9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateEndpoint.json @@ -0,0 +1,1038 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}": { + "delete": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_Delete", + "description": "Deletes the specified private endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete private endpoint": { + "$ref": "./examples/PrivateEndpointDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_Get", + "description": "Gets the specified private endpoint by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get private endpoint": { + "$ref": "./examples/PrivateEndpointGet.json" + }, + "Get private endpoint with manual approval connection": { + "$ref": "./examples/PrivateEndpointGetForManualApproval.json" + }, + "Get private endpoint with application security groups": { + "$ref": "./examples/PrivateEndpointGetWithASG.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_CreateOrUpdate", + "description": "Creates or updates an private endpoint in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "description": "Parameters supplied to the create or update private endpoint operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create private endpoint": { + "$ref": "./examples/PrivateEndpointCreate.json" + }, + "Create private endpoint with manual approval connection": { + "$ref": "./examples/PrivateEndpointCreateForManualApproval.json" + }, + "Create private endpoint with application security groups": { + "$ref": "./examples/PrivateEndpointCreateWithASG.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints": { + "get": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_List", + "description": "Gets all private endpoints in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private endpoint resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private endpoints in resource group": { + "$ref": "./examples/PrivateEndpointList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateEndpoints": { + "get": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_ListBySubscription", + "description": "Gets all private endpoints in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private endpoint resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all private endpoints": { + "$ref": "./examples/PrivateEndpointListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": { + "get": { + "operationId": "AvailablePrivateEndpointTypes_List", + "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AvailablePrivateEndpointTypesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available PrivateEndpoint types": { + "$ref": "./examples/AvailablePrivateEndpointTypesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": { + "get": { + "operationId": "AvailablePrivateEndpointTypes_ListByResourceGroup", + "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AvailablePrivateEndpointTypesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available PrivateEndpoint types in the resource group": { + "$ref": "./examples/AvailablePrivateEndpointTypesResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}": { + "delete": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_Delete", + "description": "Deletes the specified private dns zone group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "privateDnsZoneGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private dns zone group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete private dns zone group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_Get", + "description": "Gets the private dns zone group resource by specified private dns zone group name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "privateDnsZoneGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private dns zone group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting privateDnsZoneGroup resource.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get private dns zone group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_CreateOrUpdate", + "description": "Creates or updates a private dns zone group in the specified private endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "privateDnsZoneGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private dns zone group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + }, + "description": "Parameters supplied to the create or update private dns zone group operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PrivateDnsZoneGroup resource.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting PrivateDnsZoneGroup resource.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create private dns zone group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups": { + "get": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_List", + "description": "Gets all private dns zone groups in a private endpoint.", + "parameters": [ + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private dns zone group resources.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroupListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private endpoints in resource group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PrivateEndpoint": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the load balancer." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointProperties", + "description": "Properties of the private endpoint." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Private endpoint resource." + }, + "PrivateEndpointProperties": { + "properties": { + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The ID of the subnet from which the private IP will be allocated." + }, + "networkInterfaces": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "An array of references to the network interfaces created for this private endpoint." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private endpoint resource." + }, + "privateLinkServiceConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceConnection" + }, + "description": "A grouping of information about the connection to the remote resource." + }, + "manualPrivateLinkServiceConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceConnection" + }, + "description": "A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource." + }, + "customDnsConfigs": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomDnsConfigPropertiesFormat" + }, + "description": "An array of custom dns configurations." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "Application security groups in which the private endpoint IP configuration is included." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointIPConfiguration" + }, + "description": "A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints." + }, + "customNetworkInterfaceName": { + "type": "string", + "description": "The custom name of the network interface attached to the private endpoint." + } + }, + "description": "Properties of the private endpoint." + }, + "CustomDnsConfigPropertiesFormat": { + "properties": { + "fqdn": { + "type": "string", + "description": "Fqdn that resolves to private endpoint ip address." + }, + "ipAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of private ip addresses of the private endpoint." + } + }, + "description": "Contains custom Dns resolution configuration from customer." + }, + "PrivateLinkServiceConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkServiceConnectionProperties", + "description": "Properties of the private link service connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "PrivateLinkServiceConnection resource." + }, + "PrivateLinkServiceConnectionProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private link service connection resource." + }, + "privateLinkServiceId": { + "type": "string", + "description": "The resource id of private link service." + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to." + }, + "requestMessage": { + "type": "string", + "description": "A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars." + }, + "privateLinkServiceConnectionState": { + "$ref": "./privateLinkService.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of read-only information about the state of the connection to the remote resource." + } + }, + "description": "Properties of the PrivateLinkServiceConnection." + }, + "PrivateEndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "description": "A list of private endpoint resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateEndpoints API service call." + }, + "PrivateDnsZoneGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + }, + "description": "A list of private dns zone group resources in a private endpoint." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateDnsZoneGroups API service call." + }, + "AvailablePrivateEndpointTypesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailablePrivateEndpointType" + }, + "description": "An array of available privateEndpoint type." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available PrivateEndpoint types." + }, + "AvailablePrivateEndpointType": { + "properties": { + "name": { + "type": "string", + "description": "The name of the service and resource." + }, + "id": { + "type": "string", + "description": "A unique identifier of the AvailablePrivateEndpoint Type resource." + }, + "type": { + "type": "string", + "description": "Resource type." + }, + "resourceName": { + "type": "string", + "description": "The name of the service and resource." + }, + "displayName": { + "type": "string", + "description": "Display name of the resource." + } + }, + "description": "The information of an AvailablePrivateEndpointType." + }, + "PrivateDnsZoneGroup": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateDnsZoneGroupPropertiesFormat", + "description": "Properties of the private dns zone group." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Private dns zone group resource." + }, + "PrivateDnsZoneGroupPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private dns zone group resource." + }, + "privateDnsZoneConfigs": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateDnsZoneConfig" + }, + "description": "A collection of private dns zone configurations of the private dns zone group." + } + }, + "description": "Properties of the private dns zone group." + }, + "PrivateDnsZoneConfig": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateDnsZonePropertiesFormat", + "description": "Properties of the private dns zone configuration." + } + }, + "description": "PrivateDnsZoneConfig resource." + }, + "PrivateDnsZonePropertiesFormat": { + "properties": { + "privateDnsZoneId": { + "type": "string", + "description": "The resource id of the private dns zone." + }, + "recordSets": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RecordSet" + }, + "description": "A collection of information regarding a recordSet, holding information to identify private resources." + } + }, + "description": "Properties of the private dns zone configuration resource." + }, + "RecordSet": { + "properties": { + "recordType": { + "type": "string", + "description": "Resource record type." + }, + "recordSetName": { + "type": "string", + "description": "Recordset name." + }, + "fqdn": { + "type": "string", + "description": "Fqdn that resolves to private endpoint ip address." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the recordset." + }, + "ttl": { + "type": "integer", + "description": "Recordset time to live." + }, + "ipAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private ip address of the private endpoint." + } + }, + "description": "A collective group of information about the record set information." + }, + "PrivateEndpointIPConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointIPConfigurationProperties", + "description": "Properties of private endpoint IP configurations." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "An IP Configuration of the private endpoint." + }, + "PrivateEndpointIPConfigurationProperties": { + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The ID of a group obtained from the remote resource that this private endpoint should connect to." + }, + "memberName": { + "type": "string", + "description": "The member name of a group obtained from the remote resource that this private endpoint should connect to." + }, + "privateIPAddress": { + "type": "string", + "description": "A private ip address obtained from the private endpoint's subnet." + } + }, + "description": "Properties of an IP Configuration of the private endpoint." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateLinkService.json new file mode 100644 index 000000000000..85c113c829fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateLinkService.json @@ -0,0 +1,1091 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}": { + "delete": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_Delete", + "description": "Deletes the specified private link service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete private link service": { + "$ref": "./examples/PrivateLinkServiceDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_Get", + "description": "Gets the specified private link service by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PrivateLinkService resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkService" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get private link service": { + "$ref": "./examples/PrivateLinkServiceGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateLinkService" + ], + "operationId": "PrivateLinkServices_CreateOrUpdate", + "description": "Creates or updates an private link service in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkService" + }, + "description": "Parameters supplied to the create or update private link service operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting privateLinkService resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkService" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting privateLinkService resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkService" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create private link service": { + "$ref": "./examples/PrivateLinkServiceCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_List", + "description": "Gets all private link services in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of privateLinkService resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private link service in resource group": { + "$ref": "./examples/PrivateLinkServiceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListBySubscription", + "description": "Gets all private link service in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PrivateLinkService resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all private list service": { + "$ref": "./examples/PrivateLinkServiceListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_GetPrivateEndpointConnection", + "description": "Get the specific private end point connection by specific private link service in the resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private end point connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting private end point connection resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get private end point connection": { + "$ref": "./examples/PrivateLinkServiceGetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_UpdatePrivateEndpointConnection", + "description": "Approve or reject private end point connection for a private link service in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private end point connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to approve or reject the private end point connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PrivateEndpointConnection resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "approve or reject private end point connection for a private link service": { + "$ref": "./examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json" + } + } + }, + "delete": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_DeletePrivateEndpointConnection", + "description": "Delete private end point connection for a private link service in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private end point connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "delete private end point connection for a private link service": { + "$ref": "./examples/PrivateLinkServiceDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListPrivateEndpointConnections", + "description": "Gets all private end point connections for a specific private link service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private end point connection resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private link service in resource group": { + "$ref": "./examples/PrivateLinkServiceListPrivateEndpointConnection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": { + "post": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibility", + "description": "Checks whether the subscription is visible to private link service.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest" + }, + "description": "The request body of CheckPrivateLinkService API call." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the subscription is visible to private link service.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceVisibility" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Check private link service visibility": { + "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": { + "post": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibilityByResourceGroup", + "description": "Checks whether the subscription is visible to private link service in the specified resource group.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest" + }, + "description": "The request body of CheckPrivateLinkService API call." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the subscription is visible to private link service.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceVisibility" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Check private link service visibility": { + "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServices", + "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of private link service id that can be linked to a private end point with auto approved": { + "$ref": "./examples/AutoApprovedPrivateLinkServicesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServicesByResourceGroup", + "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of private link service id that can be linked to a private end point with auto approved": { + "$ref": "./examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PrivateLinkService": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the load balancer." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkServiceProperties", + "description": "Properties of the private link service." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Private link service resource." + }, + "PrivateLinkServiceProperties": { + "properties": { + "loadBalancerFrontendIpConfigurations": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration" + }, + "description": "An array of references to the load balancer IP configurations." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceIpConfiguration" + }, + "description": "An array of private link service IP configurations." + }, + "networkInterfaces": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "An array of references to the network interfaces created for this private link service." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private link service resource." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "An array of list about connections to the private endpoint." + }, + "visibility": { + "allOf": [ + { + "$ref": "#/definitions/ResourceSet" + } + ], + "description": "The visibility list of the private link service." + }, + "autoApproval": { + "allOf": [ + { + "$ref": "#/definitions/ResourceSet" + } + ], + "description": "The auto-approval list of the private link service." + }, + "fqdns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Fqdn." + }, + "alias": { + "readOnly": true, + "type": "string", + "description": "The alias of the private link service." + }, + "enableProxyProtocol": { + "type": "boolean", + "description": "Whether the private link service is enabled for proxy protocol or not." + } + }, + "description": "Properties of the private link service." + }, + "ResourceSet": { + "properties": { + "subscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of subscriptions." + } + }, + "description": "The base resource set for visibility and auto-approval." + }, + "PrivateLinkServiceIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkServiceIpConfigurationProperties", + "description": "Properties of the private link service ip configuration." + }, + "name": { + "type": "string", + "description": "The name of private link service ip configuration." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The private link service ip configuration." + }, + "PrivateLinkServiceIpConfigurationProperties": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "primary": { + "type": "boolean", + "description": "Whether the ip configuration is primary or not." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private link service IP configuration resource." + }, + "privateIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4." + } + }, + "description": "Properties of private link service IP configuration." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the private end point connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "PrivateEndpointConnection resource." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "readOnly": true, + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + }, + "linkIdentifier": { + "readOnly": true, + "type": "string", + "description": "The consumer link id." + }, + "privateEndpointLocation": { + "readOnly": true, + "type": "string", + "description": "The location of the private endpoint." + } + }, + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "type": "string", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateLinkServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkService" + }, + "description": "A list of PrivateLinkService resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateLinkService API service call." + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "A list of PrivateEndpointConnection resources for a specific private link service." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateEndpointConnection API service call." + }, + "CheckPrivateLinkServiceVisibilityRequest": { + "properties": { + "privateLinkServiceAlias": { + "type": "string", + "description": "The alias of the private link service." + } + }, + "description": "Request body of the CheckPrivateLinkServiceVisibility API service call." + }, + "PrivateLinkServiceVisibility": { + "properties": { + "visible": { + "type": "boolean", + "description": "Private Link Service Visibility (True/False)." + } + }, + "description": "Response for the CheckPrivateLinkServiceVisibility API service call." + }, + "AutoApprovedPrivateLinkServicesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoApprovedPrivateLinkService" + }, + "description": "An array of auto approved private link service." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of private link service id that can be linked to a private end point with auto approved." + }, + "AutoApprovedPrivateLinkService": { + "properties": { + "privateLinkService": { + "type": "string", + "description": "The id of the private link service resource." + } + }, + "description": "The information of an AutoApprovedPrivateLinkService." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/publicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/publicIpAddress.json new file mode 100644 index 000000000000..6e6253f327de --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/publicIpAddress.json @@ -0,0 +1,712 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}": { + "delete": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Delete", + "description": "Deletes the specified public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete public IP address": { + "$ref": "./examples/PublicIpAddressDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Get", + "description": "Gets the specified public IP address in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get public IP address": { + "$ref": "./examples/PublicIpAddressGet.json" + } + } + }, + "put": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_CreateOrUpdate", + "description": "Creates or updates a static or dynamic public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "Parameters supplied to the create or update public IP address operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create public IP address defaults": { + "$ref": "./examples/PublicIpAddressCreateDefaults.json" + }, + "Create public IP address allocation method": { + "$ref": "./examples/PublicIpAddressCreateCustomizedValues.json" + }, + "Create public IP address DNS": { + "$ref": "./examples/PublicIpAddressCreateDns.json" + }, + "Create public IP address DNS with Domain Name Label Scope": { + "$ref": "./examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_UpdateTags", + "description": "Updates public IP address tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update public IP address tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update public IP address tags": { + "$ref": "./examples/PublicIpAddressUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_ListAll", + "description": "Gets all the public IP addresses in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all public IP addresses": { + "$ref": "./examples/PublicIpAddressListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_List", + "description": "Gets all public IP addresses in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group public IP addresses": { + "$ref": "./examples/PublicIpAddressList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}/ddosProtectionStatus": { + "post": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_DdosProtectionStatus", + "description": "Gets the Ddos Protection Status of a Public IP Address", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the Ddos Protection Status of this Public IP.", + "schema": { + "$ref": "#/definitions/PublicIpDdosProtectionStatusResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Get Ddos Protection Status of a Public IP Address": { + "$ref": "./examples/PublicIpAddressGetDdosProtectionStatus.json" + } + } + } + } + }, + "definitions": { + "PublicIPAddressSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a public IP address SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of a public IP address SKU.", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuTier", + "modelAsString": true + } + } + }, + "description": "SKU of a public IP address." + }, + "PublicIPAddressPropertiesFormat": { + "properties": { + "publicIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The public IP address allocation method." + }, + "publicIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "The public IP address version." + }, + "ipConfiguration": { + "readOnly": true, + "$ref": "./networkInterface.json#/definitions/IPConfiguration", + "description": "The IP configuration associated with the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/PublicIPAddressDnsSettings", + "description": "The FQDN of the DNS record associated with the public IP address." + }, + "ddosSettings": { + "$ref": "#/definitions/DdosSettings", + "description": "The DDoS protection custom policy associated with the public IP address." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IpTag" + }, + "description": "The list of tags associated with the public IP address." + }, + "ipAddress": { + "type": "string", + "description": "The IP address associated with the public IP address resource." + }, + "publicIPPrefix": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The Public IP Prefix this Public IP Address should be allocated from." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the public IP address resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the public IP address resource." + }, + "servicePublicIPAddress": { + "$ref": "#/definitions/PublicIPAddress", + "description": "The service public IP address of the public IP address resource." + }, + "natGateway": { + "$ref": "./natGateway.json#/definitions/NatGateway", + "description": "The NatGateway for the Public IP address." + }, + "migrationPhase": { + "type": "string", + "description": "Migration phase of Public IP Address.", + "enum": [ + "None", + "Prepare", + "Commit", + "Abort", + "Committed" + ], + "x-ms-enum": { + "name": "PublicIPAddressMigrationPhase", + "modelAsString": true + } + }, + "linkedPublicIPAddress": { + "$ref": "#/definitions/PublicIPAddress", + "description": "The linked public IP address of the public IP address resource." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the public IP address when the VM using it is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + } + }, + "description": "Public IP address properties." + }, + "PublicIPAddress": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the public ip address." + }, + "sku": { + "$ref": "#/definitions/PublicIPAddressSku", + "description": "The public IP address SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublicIPAddressPropertiesFormat", + "description": "Public IP address properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Public IP address resource." + }, + "PublicIPAddressListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "A list of public IP addresses that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPublicIpAddresses API service call." + }, + "PublicIPAddressDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system." + }, + "domainNameLabelScope": { + "type": "string", + "description": "The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN.", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "PublicIpAddressDnsSettingsDomainNameLabelScope", + "modelAsString": false + } + }, + "fqdn": { + "type": "string", + "description": "The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone." + }, + "reverseFqdn": { + "type": "string", + "description": "The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN." + } + }, + "description": "Contains FQDN of the DNS record associated with the public IP address." + }, + "DdosSettings": { + "properties": { + "protectionMode": { + "readOnly": false, + "type": "string", + "enum": [ + "VirtualNetworkInherited", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DdosSettingsProtectionMode", + "modelAsString": true + }, + "description": "The DDoS protection mode of the public IP" + }, + "ddosProtectionPlan": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled" + } + }, + "description": "Contains the DDoS protection settings of the public IP." + }, + "IpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: SQL." + } + }, + "description": "Contains the IpTag associated with the object." + }, + "PublicIpDdosProtectionStatusResult": { + "type": "object", + "properties": { + "publicIpAddressId": { + "type": "string", + "description": "Public IP ARM resource ID" + }, + "publicIpAddress": { + "type": "string", + "description": "IP Address of the Public IP Resource" + }, + "isWorkloadProtected": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "IsWorkloadProtected", + "modelAsString": true + }, + "description": "Value indicating whether the IP address is DDoS workload protected or not." + }, + "ddosProtectionPlanId": { + "type": "string", + "description": " DDoS protection plan Resource Id of a if IP address is protected through a plan." + } + }, + "description": "Response for GetPublicIpAddressDdosProtectionStatusOperation API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/publicIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/publicIpPrefix.json new file mode 100644 index 000000000000..46eb128a72e0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/publicIpPrefix.json @@ -0,0 +1,509 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}": { + "delete": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_Delete", + "description": "Deletes the specified public IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the PublicIpPrefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete public IP prefix": { + "$ref": "./examples/PublicIpPrefixDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_Get", + "description": "Gets the specified public IP prefix in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get public IP prefix": { + "$ref": "./examples/PublicIpPrefixGet.json" + } + } + }, + "put": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_CreateOrUpdate", + "description": "Creates or updates a static or dynamic public IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + }, + "description": "Parameters supplied to the create or update public IP prefix operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create public IP prefix defaults": { + "$ref": "./examples/PublicIpPrefixCreateDefaults.json" + }, + "Create public IP prefix allocation method": { + "$ref": "./examples/PublicIpPrefixCreateCustomizedValues.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_UpdateTags", + "description": "Updates public IP prefix tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update public IP prefix tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update public IP prefix tags": { + "$ref": "./examples/PublicIpPrefixUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPPrefixes": { + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_ListAll", + "description": "Gets all the public IP prefixes in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPPrefix resources.", + "schema": { + "$ref": "#/definitions/PublicIPPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all public IP prefixes": { + "$ref": "./examples/PublicIpPrefixListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes": { + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_List", + "description": "Gets all public IP prefixes in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPPrefix resources.", + "schema": { + "$ref": "#/definitions/PublicIPPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group public IP prefixes": { + "$ref": "./examples/PublicIpPrefixList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PublicIPPrefixSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a public IP prefix SKU.", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPPrefixSkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of a public IP prefix SKU.", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPPrefixSkuTier", + "modelAsString": true + } + } + }, + "description": "SKU of a public IP prefix." + }, + "PublicIPPrefixPropertiesFormat": { + "properties": { + "publicIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "The public IP address version." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "./publicIpAddress.json#/definitions/IpTag" + }, + "description": "The list of tags associated with the public IP prefix." + }, + "prefixLength": { + "type": "integer", + "format": "int32", + "description": "The Length of the Public IP Prefix." + }, + "ipPrefix": { + "readOnly": true, + "type": "string", + "description": "The allocated Prefix." + }, + "publicIPAddresses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ReferencedPublicIpAddress" + }, + "description": "The list of all referenced PublicIPAddresses." + }, + "loadBalancerFrontendIpConfiguration": { + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to load balancer frontend IP configuration associated with the public IP prefix." + }, + "customIPPrefix": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The customIpPrefix that this prefix is associated with." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the public IP prefix resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the public IP prefix resource." + }, + "natGateway": { + "$ref": "./natGateway.json#/definitions/NatGateway", + "description": "NatGateway of Public IP Prefix." + } + }, + "description": "Public IP prefix properties." + }, + "PublicIPPrefix": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the public ip address." + }, + "sku": { + "$ref": "#/definitions/PublicIPPrefixSku", + "description": "The public IP prefix SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublicIPPrefixPropertiesFormat", + "description": "Public IP prefix properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Public IP prefix resource." + }, + "PublicIPPrefixListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicIPPrefix" + }, + "description": "A list of public IP prefixes that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPublicIpPrefixes API service call." + }, + "ReferencedPublicIpAddress": { + "properties": { + "id": { + "type": "string", + "description": "The PublicIPAddress Reference." + } + }, + "description": "Reference to a public IP address." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeFilter.json new file mode 100644 index 000000000000..483e4994133a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeFilter.json @@ -0,0 +1,822 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}": { + "delete": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Delete", + "x-ms-examples": { + "RouteFilterDelete": { + "$ref": "./examples/RouteFilterDelete.json" + } + }, + "description": "Deletes the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Get", + "x-ms-examples": { + "RouteFilterGet": { + "$ref": "./examples/RouteFilterGet.json" + } + }, + "description": "Gets the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced express route bgp peering resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterCreate": { + "$ref": "./examples/RouteFilterCreate.json" + } + }, + "description": "Creates or updates a route filter in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "routeFilterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "Parameters supplied to the create or update route filter operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_UpdateTags", + "description": "Updates tags of a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update route filter tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update route filter tags": { + "$ref": "./examples/RouteFilterUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_ListByResourceGroup", + "x-ms-examples": { + "RouteFilterListByResourceGroup": { + "$ref": "./examples/RouteFilterListByResourceGroup.json" + } + }, + "description": "Gets all route filters in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_List", + "x-ms-examples": { + "RouteFilterList": { + "$ref": "./examples/RouteFilterList.json" + } + }, + "description": "Gets all route filters in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}": { + "delete": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Delete", + "x-ms-examples": { + "RouteFilterRuleDelete": { + "$ref": "./examples/RouteFilterRuleDelete.json" + } + }, + "description": "Deletes the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Rule was deleted or not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Get", + "x-ms-examples": { + "RouteFilterRuleGet": { + "$ref": "./examples/RouteFilterRuleGet.json" + } + }, + "description": "Gets the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterRuleCreate": { + "$ref": "./examples/RouteFilterRuleCreate.json" + } + }, + "description": "Creates or updates a route in the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter rule." + }, + { + "name": "routeFilterRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Parameters supplied to the create or update route filter rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules": { + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_ListByRouteFilter", + "x-ms-examples": { + "RouteFilterRuleListByRouteFilter": { + "$ref": "./examples/RouteFilterRuleListByRouteFilter.json" + } + }, + "description": "Gets all RouteFilterRules in a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter Rule resources.", + "schema": { + "$ref": "#/definitions/RouteFilterRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "RouteFilterRulePropertiesFormat": { + "required": [ + "access", + "routeFilterRuleType", + "communities" + ], + "properties": { + "access": { + "$ref": "./network.json#/definitions/Access", + "description": "The access type of the rule." + }, + "routeFilterRuleType": { + "type": "string", + "description": "The rule type of the rule.", + "enum": [ + "Community" + ], + "x-ms-enum": { + "name": "RouteFilterRuleType", + "modelAsString": true + } + }, + "communities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route filter rule resource." + } + }, + "description": "Route Filter Rule Resource." + }, + "RouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat", + "description": "Properties of the route filter rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource." + }, + "PatchRouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat", + "description": "Properties of the route filter rule." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource." + }, + "RouteFilterPropertiesFormat": { + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Collection of RouteFilterRules contained within a route filter." + }, + "peerings": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeering" + }, + "description": "A collection of references to express route circuit peerings." + }, + "ipv6Peerings": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeering" + }, + "description": "A collection of references to express route circuit ipv6 peerings." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route filter resource." + } + }, + "description": "Route Filter Resource." + }, + "RouteFilter": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat", + "description": "Properties of the route filter." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route Filter Resource." + }, + "PatchRouteFilter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat", + "description": "Properties of the route filter." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Resource." + }, + "RouteFilterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "A list of route filters in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilters API service call." + }, + "RouteFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "A list of RouteFilterRules in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilterRules API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeTable.json new file mode 100644 index 000000000000..c10e409f9771 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeTable.json @@ -0,0 +1,768 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}": { + "delete": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Delete", + "description": "Deletes the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "200": { + "description": "Request successful. Operation to delete was accepted." + }, + "202": { + "description": "Accepted. If route table not found returned synchronously, otherwise if found returned asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete route table": { + "$ref": "./examples/RouteTableDelete.json" + } + } + }, + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Get", + "description": "Gets the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get route table": { + "$ref": "./examples/RouteTableGet.json" + } + } + }, + "put": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_CreateOrUpdate", + "description": "Create or updates a route table in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteTable" + }, + "description": "Parameters supplied to the create or update route table operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create route table": { + "$ref": "./examples/RouteTableCreate.json" + }, + "Create route table with route": { + "$ref": "./examples/RouteTableCreateWithRoute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_UpdateTags", + "description": "Updates a route table tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update route table tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update route table tags": { + "$ref": "./examples/RouteTableUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_List", + "description": "Gets all route tables in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List route tables in resource group": { + "$ref": "./examples/RouteTableList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_ListAll", + "description": "Gets all route tables in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all route tables": { + "$ref": "./examples/RouteTableListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}": { + "delete": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Delete", + "description": "Deletes the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Route was deleted or not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete route": { + "$ref": "./examples/RouteTableRouteDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Get", + "description": "Gets the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get route": { + "$ref": "./examples/RouteTableRouteGet.json" + } + } + }, + "put": { + "tags": [ + "Routes" + ], + "operationId": "Routes_CreateOrUpdate", + "description": "Creates or updates a route in the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "name": "routeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Route" + }, + "description": "Parameters supplied to the create or update route operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create route": { + "$ref": "./examples/RouteTableRouteCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes": { + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_List", + "description": "Gets all routes in a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route resources.", + "schema": { + "$ref": "#/definitions/RouteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List routes": { + "$ref": "./examples/RouteTableRouteList.json" + } + } + } + } + }, + "definitions": { + "RoutePropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The destination CIDR to which the route applies." + }, + "nextHopType": { + "$ref": "#/definitions/RouteNextHopType", + "description": "The type of Azure hop the packet should be sent to." + }, + "nextHopIpAddress": { + "type": "string", + "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route resource." + }, + "hasBgpOverride": { + "type": "boolean", + "description": "A value indicating whether this route overrides overlapping BGP routes regardless of LPM." + } + }, + "required": [ + "nextHopType" + ], + "description": "Route resource." + }, + "Route": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoutePropertiesFormat", + "description": "Properties of the route." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "The type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route resource." + }, + "RouteTablePropertiesFormat": { + "properties": { + "routes": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "Collection of routes contained within a route table." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "disableBgpRoutePropagation": { + "type": "boolean", + "description": "Whether to disable the routes learned by BGP on that route table. True means disable." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route table resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resource GUID property of the route table." + } + }, + "description": "Route Table resource." + }, + "RouteTable": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteTablePropertiesFormat", + "description": "Properties of the route table." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route table resource." + }, + "RouteTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteTable" + }, + "description": "A list of route tables in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteTable API service call." + }, + "RouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "A list of routes in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRoute API service call." + }, + "RouteNextHopType": { + "type": "string", + "description": "The type of Azure hop the packet should be sent to.", + "enum": [ + "VirtualNetworkGateway", + "VnetLocal", + "Internet", + "VirtualAppliance", + "None" + ], + "x-ms-enum": { + "name": "RouteNextHopType", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/securityPartnerProvider.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/securityPartnerProvider.json new file mode 100644 index 000000000000..318b9b186ae7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/securityPartnerProvider.json @@ -0,0 +1,441 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}": { + "delete": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_Delete", + "description": "Deletes the specified Security Partner Provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Security Partner Provider": { + "$ref": "./examples/SecurityPartnerProviderDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_Get", + "description": "Gets the specified Security Partner Provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Security Partner Provider": { + "$ref": "./examples/SecurityPartnerProviderGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_CreateOrUpdate", + "description": "Creates or updates the specified Security Partner Provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + }, + "description": "Parameters supplied to the create or update Security Partner Provider operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Security Partner Provider": { + "$ref": "./examples/SecurityPartnerProviderPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_UpdateTags", + "description": "Updates tags of a Security Partner Provider resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update Security Partner Provider tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Security Partner Provider Tags": { + "$ref": "./examples/SecurityPartnerProviderUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders": { + "get": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_ListByResourceGroup", + "description": "Lists all Security Partner Providers in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of SecurityPartnerProvider resources.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Security Partner Providers for a given resource group": { + "$ref": "./examples/SecurityPartnerProviderListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/securityPartnerProviders": { + "get": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_List", + "description": "Gets all the Security Partner Providers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of SecurityPartnerProvider resources.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Security Partner Providers for a given subscription": { + "$ref": "./examples/SecurityPartnerProviderListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SecurityPartnerProviderPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Security Partner Provider resource." + }, + "securityProviderName": { + "description": "The security provider name.", + "$ref": "#/definitions/SecurityPartnerProvidersecurityProviderName" + }, + "connectionStatus": { + "readOnly": true, + "description": "The connection status with the Security Partner Provider.", + "$ref": "#/definitions/SecurityPartnerProviderConnectionStatus" + }, + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The virtualHub to which the Security Partner Provider belongs." + } + }, + "description": "Properties of the Security Partner Provider." + }, + "SecurityPartnerProvider": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPartnerProviderPropertiesFormat", + "description": "Properties of the Security Partner Provider." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Security Partner Provider resource." + }, + "SecurityPartnerProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityPartnerProvider" + }, + "description": "List of Security Partner Providers in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListSecurityPartnerProviders API service call." + }, + "SecurityPartnerProvidersecurityProviderName": { + "type": "string", + "description": "The Security Providers.", + "enum": [ + "ZScaler", + "IBoss", + "Checkpoint" + ], + "x-ms-enum": { + "name": "SecurityProviderName", + "modelAsString": true + } + }, + "SecurityPartnerProviderConnectionStatus": { + "type": "string", + "description": "The current state of the connection with Security Partner Provider.", + "readOnly": true, + "enum": [ + "Unknown", + "PartiallyConnected", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "SecurityPartnerProviderConnectionStatus", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceCommunity.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceCommunity.json new file mode 100644 index 000000000000..47c3f6ec2c9c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceCommunity.json @@ -0,0 +1,158 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/bgpServiceCommunities": { + "get": { + "tags": [ + "BgpServiceCommunities" + ], + "operationId": "BgpServiceCommunities_List", + "x-ms-examples": { + "ServiceCommunityList": { + "$ref": "./examples/ServiceCommunityList.json" + } + }, + "description": "Gets all the available bgp service communities.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of BgpServiceCommunity resources.", + "schema": { + "$ref": "#/definitions/BgpServiceCommunityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BGPCommunity": { + "properties": { + "serviceSupportedRegion": { + "type": "string", + "description": "The region which the service support. e.g. For O365, region is Global." + }, + "communityName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "communityValue": { + "type": "string", + "description": "The value of the bgp community. For more information: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing." + }, + "communityPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The prefixes that the bgp community contains." + }, + "isAuthorizedToUse": { + "type": "boolean", + "description": "Customer is authorized to use bgp community or not." + }, + "serviceGroup": { + "type": "string", + "description": "The service group of the bgp community contains." + } + }, + "description": "Contains bgp community information offered in Service Community resources." + }, + "BgpServiceCommunityPropertiesFormat": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "bgpCommunities": { + "type": "array", + "items": { + "$ref": "#/definitions/BGPCommunity" + }, + "description": "A list of bgp communities." + } + }, + "description": "Properties of Service Community." + }, + "BgpServiceCommunity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BgpServiceCommunityPropertiesFormat", + "description": "Properties of the BGP service community." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Service Community Properties." + }, + "BgpServiceCommunityListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpServiceCommunity" + }, + "description": "A list of service community resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListServiceCommunity API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceEndpointPolicy.json new file mode 100644 index 000000000000..ac9892fd20c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceEndpointPolicy.json @@ -0,0 +1,762 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}": { + "delete": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_Delete", + "description": "Deletes the specified service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_Get", + "description": "Gets the specified service Endpoint Policies in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get service endPoint Policy": { + "$ref": "./examples/ServiceEndpointPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_CreateOrUpdate", + "description": "Creates or updates a service Endpoint Policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + }, + "description": "Parameters supplied to the create or update service endpoint policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyCreate.json" + }, + "Create service endpoint policy with definition": { + "$ref": "./examples/ServiceEndpointPolicyCreateWithDefinition.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_UpdateTags", + "description": "Updates tags of a service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update service endpoint policy tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update service endpoint policy tags": { + "$ref": "./examples/ServiceEndpointPolicyUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ServiceEndpointPolicies": { + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_List", + "description": "Gets all the service endpoint policies in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies": { + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_ListByResourceGroup", + "description": "Gets all service endpoint Policies in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group service endpoint policies": { + "$ref": "./examples/ServiceEndpointPolicyList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}": { + "delete": { + "tags": [ + "ServiceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_Delete", + "description": "Deletes the specified ServiceEndpoint policy definitions.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Service Endpoint Policy." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete service endpoint policy definitions from service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "serviceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_Get", + "description": "Get the specified service endpoint policy definitions from service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy name." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get service endpoint definition in service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionGet.json" + } + } + }, + "put": { + "tags": [ + "serviceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_CreateOrUpdate", + "description": "Creates or updates a service endpoint policy definition in the specified service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition name." + }, + { + "name": "ServiceEndpointPolicyDefinitions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "Parameters supplied to the create or update service endpoint policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create service endpoint policy definition": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions": { + "get": { + "tags": [ + "ServiceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_ListByResourceGroup", + "description": "Gets all service endpoint policy definitions in a service end point policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicyDefinition resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List service endpoint definitions in service end point policy": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServiceEndpointPolicyDefinitionPropertiesFormat": { + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "service": { + "type": "string", + "description": "Service endpoint name." + }, + "serviceResources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of service resources." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service endpoint policy definition resource." + } + }, + "description": "Service Endpoint policy definition resource." + }, + "ServiceEndpointPolicyDefinition": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceEndpointPolicyDefinitionPropertiesFormat", + "description": "Properties of the service endpoint policy definition." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "The type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Service Endpoint policy definitions." + }, + "ServiceEndpointPolicyDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "The service endpoint policy definition in a service endpoint policy." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListServiceEndpointPolicyDefinition API service call. Retrieves all service endpoint policy definition that belongs to a service endpoint policy." + }, + "ServiceEndpointPolicyPropertiesFormat": { + "properties": { + "serviceEndpointPolicyDefinitions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "A collection of service endpoint policy definitions of the service endpoint policy." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resource GUID property of the service endpoint policy resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service endpoint policy resource." + }, + "serviceAlias": { + "type": "string", + "description": "The alias indicating if the policy belongs to a service" + }, + "contextualServiceEndpointPolicies": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A collection of contextual service endpoint policy." + } + }, + "description": "Service Endpoint Policy resource." + }, + "ServiceEndpointPolicy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceEndpointPolicyPropertiesFormat", + "description": "Properties of the service end point policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Kind of service endpoint policy. This is metadata used for the Azure portal experience." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Service End point policy resource." + }, + "ServiceEndpointPolicyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicy" + }, + "description": "A list of ServiceEndpointPolicy resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListServiceEndpointPolicies API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceTags.json new file mode 100644 index 000000000000..cc783fd7c1e2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceTags.json @@ -0,0 +1,262 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/serviceTags": { + "get": { + "operationId": "ServiceTags_List", + "description": "Gets a list of service tag information resources.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location that will be used as a reference for version (not as a filter based on location, you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to)." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns a list of service tag information resources.", + "schema": { + "$ref": "#/definitions/ServiceTagsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of service tags": { + "$ref": "./examples/ServiceTagsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/serviceTagDetails": { + "get": { + "operationId": "ServiceTagInformation_List", + "description": "Gets a list of service tag information resources with pagination.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location that will be used as a reference for cloud (not as a filter based on location, you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to)." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "noAddressPrefixes", + "in": "query", + "required": false, + "type": "boolean", + "description": "Do not return address prefixes for the tag(s)." + }, + { + "name": "tagName", + "in": "query", + "required": false, + "type": "string", + "description": "Return tag information for a particular tag." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns a list of service tag information resources.", + "schema": { + "$ref": "#/definitions/ServiceTagInformationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of service tags": { + "$ref": "./examples/ServiceTagInformationListResult.json" + }, + "Get list of service tags with no address prefixes": { + "$ref": "./examples/ServiceTagInformationListResultWithNoAddressPrefixes.json" + }, + "Get list of service tags with tag name.": { + "$ref": "./examples/ServiceTagInformationListResultWithTagname.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServiceTagsListResult": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the cloud." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of the cloud." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The azure resource type." + }, + "changeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number." + }, + "cloud": { + "type": "string", + "readOnly": true, + "description": "The name of the cloud." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTagInformation" + }, + "readOnly": true, + "description": "The list of service tag information resources." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get next page of service tag information resources." + } + }, + "description": "Response for the ListServiceTags API service call." + }, + "ServiceTagInformationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTagInformation" + }, + "description": "The list of service tag information resources." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for Get ServiceTagInformation API service call. Retrieves the list of service tag information resources." + }, + "ServiceTagInformation": { + "properties": { + "properties": { + "$ref": "#/definitions/ServiceTagInformationPropertiesFormat", + "readOnly": true, + "description": "Properties of the service tag information." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of service tag." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of service tag." + }, + "serviceTagChangeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number of service tag object for region." + } + }, + "description": "The service tag information." + }, + "ServiceTagInformationPropertiesFormat": { + "properties": { + "changeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number of service tag." + }, + "region": { + "type": "string", + "readOnly": true, + "description": "The region of service tag." + }, + "systemService": { + "type": "string", + "readOnly": true, + "description": "The name of system service." + }, + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of IP address prefixes." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the service tag." + } + }, + "description": "Properties of the service tag information." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/usage.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/usage.json new file mode 100644 index 000000000000..d48b588c9936 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/usage.json @@ -0,0 +1,160 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "Usages_List", + "description": "List network usages for a subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location where resource usage is queried.", + "pattern": "^[-\\w\\._ ]+$" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Usage resources.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List usages": { + "$ref": "./examples/UsageList.json" + }, + "List usages spaced location": { + "$ref": "./examples/UsageListSpacedLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "A string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "A localized string describing the resource name." + } + }, + "description": "The usage names." + }, + "Usage": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource identifier." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current value of the usage." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The limit of usage." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "The network resource usage." + }, + "UsagesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list network resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "The list usages operation response." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetwork.json new file mode 100644 index 000000000000..20ce59d44352 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetwork.json @@ -0,0 +1,2290 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}": { + "delete": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Delete", + "description": "Deletes the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete virtual network": { + "$ref": "./examples/VirtualNetworkDelete.json" + } + } + }, + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Get", + "description": "Gets the specified virtual network by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get virtual network": { + "$ref": "./examples/VirtualNetworkGet.json" + }, + "Get virtual network with a delegated subnet": { + "$ref": "./examples/VirtualNetworkGetWithSubnetDelegation.json" + }, + "Get virtual network with service association links": { + "$ref": "./examples/VirtualNetworkGetWithServiceAssociationLink.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_CreateOrUpdate", + "description": "Creates or updates a virtual network in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "Parameters supplied to the create or update virtual network operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create virtual network": { + "$ref": "./examples/VirtualNetworkCreate.json" + }, + "Create virtual network with subnet": { + "$ref": "./examples/VirtualNetworkCreateSubnet.json" + }, + "Create virtual network with subnet containing address prefixes": { + "$ref": "./examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json" + }, + "Create virtual network with Bgp Communities": { + "$ref": "./examples/VirtualNetworkCreateWithBgpCommunities.json" + }, + "Create virtual network with service endpoints": { + "$ref": "./examples/VirtualNetworkCreateServiceEndpoints.json" + }, + "Create virtual network with service endpoints and service endpoint policy": { + "$ref": "./examples/VirtualNetworkCreateServiceEndpointPolicy.json" + }, + "Create virtual network with delegated subnets": { + "$ref": "./examples/VirtualNetworkCreateSubnetWithDelegation.json" + }, + "Create virtual network with encryption": { + "$ref": "./examples/VirtualNetworkCreateWithEncryption.json" + } + } + }, + "patch": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_UpdateTags", + "description": "Updates a virtual network tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update virtual network tags": { + "$ref": "./examples/VirtualNetworkUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_ListAll", + "description": "Gets all virtual networks in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual networks": { + "$ref": "./examples/VirtualNetworkListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_List", + "description": "Gets all virtual networks in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual networks in resource group": { + "$ref": "./examples/VirtualNetworkList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}": { + "delete": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Delete", + "description": "Deletes the specified subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete subnet": { + "$ref": "./examples/SubnetDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Get", + "description": "Gets the specified subnet by virtual network and resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get subnet": { + "$ref": "./examples/SubnetGet.json" + }, + "Get subnet with a delegation": { + "$ref": "./examples/SubnetGetWithDelegation.json" + }, + "Get subnet with sharing scope": { + "$ref": "./examples/SubnetGetWithSharingScope.json" + } + } + }, + "put": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_CreateOrUpdate", + "description": "Creates or updates a subnet in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "subnetParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Subnet" + }, + "description": "Parameters supplied to the create or update subnet operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create subnet": { + "$ref": "./examples/SubnetCreate.json" + }, + "Create subnet with service endpoints": { + "$ref": "./examples/SubnetCreateServiceEndpoint.json" + }, + "Create subnet with a delegation": { + "$ref": "./examples/SubnetCreateWithDelegation.json" + }, + "Create subnet with sharing scope": { + "$ref": "./examples/SubnetCreateWithSharingScope.json" + }, + "Create subnet with service endpoints with network identifier": { + "$ref": "./examples/SubnetCreateServiceEndpointNetworkIdentifier.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/PrepareNetworkPolicies": { + "post": { + "operationId": "Subnets_PrepareNetworkPolicies", + "description": "Prepares a subnet by applying network intent policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "prepareNetworkPoliciesRequestParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrepareNetworkPoliciesRequest" + }, + "description": "Parameters supplied to prepare subnet by applying network intent policies." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Preparing subnet by applying network intent policies is successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prepare Network Policies": { + "$ref": "./examples/SubnetPrepareNetworkPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/UnprepareNetworkPolicies": { + "post": { + "operationId": "Subnets_UnprepareNetworkPolicies", + "description": "Unprepares a subnet by removing network intent policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "unprepareNetworkPoliciesRequestParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UnprepareNetworkPoliciesRequest" + }, + "description": "Parameters supplied to unprepare subnet to remove network intent policies." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Unpreparing subnet by removing network intent policies is successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Unprepare Network Policies": { + "$ref": "./examples/SubnetUnprepareNetworkPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ResourceNavigationLinks": { + "get": { + "operationId": "ResourceNavigationLinks_List", + "description": "Gets a list of resource navigation links for a subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of resource navigation links for the subnet.", + "schema": { + "$ref": "#/definitions/ResourceNavigationLinksListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Resource Navigation Links": { + "$ref": "./examples/VirtualNetworkGetResourceNavigationLinks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ServiceAssociationLinks": { + "get": { + "operationId": "ServiceAssociationLinks_List", + "description": "Gets a list of service association links for a subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of service association links for the subnet.", + "schema": { + "$ref": "#/definitions/ServiceAssociationLinksListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Service Association Links": { + "$ref": "./examples/VirtualNetworkGetServiceAssociationLinks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets": { + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_List", + "description": "Gets all subnets in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Subnet resources.", + "schema": { + "$ref": "#/definitions/SubnetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List subnets": { + "$ref": "./examples/SubnetList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}": { + "delete": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Delete", + "description": "Deletes the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete peering": { + "$ref": "./examples/VirtualNetworkPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Get", + "description": "Gets the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get peering": { + "$ref": "./examples/VirtualNetworkPeeringGet.json" + }, + "Get peering with remote virtual network encryption": { + "$ref": "./examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json" + }, + "Get subnet peering": { + "$ref": "./examples/VirtualNetworkSubnetPeeringGet.json" + }, + "Get V6 subnet peering": { + "$ref": "./examples/VirtualNetworkV6SubnetPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "VirtualNetworkPeeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "Parameters supplied to the create or update virtual network peering operation." + }, + { + "name": "syncRemoteAddressSpace", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "true" + ], + "x-ms-enum": { + "name": "SyncRemoteAddressSpace", + "modelAsString": true + }, + "description": "Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create peering": { + "$ref": "./examples/VirtualNetworkPeeringCreate.json" + }, + "Sync Peering": { + "$ref": "./examples/VirtualNetworkPeeringSync.json" + }, + "Create peering with remote virtual network encryption": { + "$ref": "./examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json" + }, + "Create subnet peering": { + "$ref": "./examples/VirtualNetworkSubnetPeeringCreate.json" + }, + "Sync subnet Peering": { + "$ref": "./examples/VirtualNetworkSubnetPeeringSync.json" + }, + "Create V6 Subnet peering": { + "$ref": "./examples/VirtualNetworkV6SubnetPeeringCreate.json" + }, + "Sync V6 Subnet Peering": { + "$ref": "./examples/VirtualNetworkV6SubnetPeeringSync.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings": { + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_List", + "description": "Gets all virtual network peerings in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkPeering resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List peerings": { + "$ref": "./examples/VirtualNetworkPeeringList.json" + }, + "List peerings with remote virtual network encryption": { + "$ref": "./examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability": { + "get": { + "operationId": "VirtualNetworks_CheckIPAddressAvailability", + "description": "Checks whether a private IP address is available for use.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "ipAddress", + "in": "query", + "required": true, + "type": "string", + "description": "The private IP address to be verified." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private IP address availability and list of other free addresses if the requested one is not available.", + "schema": { + "$ref": "#/definitions/IPAddressAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check IP address availability": { + "$ref": "./examples/VirtualNetworkCheckIPAddressAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/usages": { + "get": { + "operationId": "VirtualNetworks_ListUsage", + "description": "Lists usage stats.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Usage stats for vnet.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VnetGetUsage": { + "$ref": "./examples/VirtualNetworkListUsage.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/ddosProtectionStatus": { + "post": { + "operationId": "VirtualNetworks_ListDdosProtectionStatus", + "description": "Gets the Ddos Protection Status of all IP Addresses under the Virtual Network", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The max number of ip addresses to return." + }, + { + "name": "skipToken", + "in": "query", + "required": false, + "type": "string", + "description": "The skipToken that is given with nextLink." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the Ddos Protection Status of all IP Addresses under this Virtual Network.", + "schema": { + "$ref": "#/definitions/VirtualNetworkDdosProtectionStatusResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Ddos Protection Status of a Virtual Network": { + "$ref": "./examples/VirtualNetworkGetDdosProtectionStatus.json" + } + } + } + } + }, + "definitions": { + "ServiceAssociationLinkPropertiesFormat": { + "properties": { + "linkedResourceType": { + "type": "string", + "description": "Resource type of the linked resource." + }, + "link": { + "type": "string", + "description": "Link to the external resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service association link resource." + }, + "allowDelete": { + "type": "boolean", + "description": "If true, the resource can be deleted." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + } + }, + "description": "Properties of ServiceAssociationLink." + }, + "ServiceAssociationLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceAssociationLinkPropertiesFormat", + "description": "Resource navigation link properties format." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ServiceAssociationLink resource." + }, + "ResourceNavigationLinkFormat": { + "properties": { + "linkedResourceType": { + "type": "string", + "description": "Resource type of the linked resource." + }, + "link": { + "type": "string", + "description": "Link to the external resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource navigation link resource." + } + }, + "description": "Properties of ResourceNavigationLink." + }, + "ResourceNavigationLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResourceNavigationLinkFormat", + "description": "Resource navigation link properties format." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource navigation link identifier." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ResourceNavigationLink resource." + }, + "ServiceDelegationPropertiesFormat": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)." + }, + "actions": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The actions permitted to the service upon delegation." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service delegation resource." + } + }, + "description": "Properties of a service delegation." + }, + "Delegation": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceDelegationPropertiesFormat", + "description": "Properties of the subnet." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a subnet. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Details the service to which the subnet is delegated." + }, + "SubnetPropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The address prefix for the subnet." + }, + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of address prefixes for the subnet." + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference to the NetworkSecurityGroup resource." + }, + "routeTable": { + "$ref": "./routeTable.json#/definitions/RouteTable", + "description": "The reference to the RouteTable resource." + }, + "natGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Nat gateway associated with this subnet." + }, + "serviceEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPropertiesFormat" + }, + "description": "An array of service endpoints." + }, + "serviceEndpointPolicies": { + "type": "array", + "items": { + "$ref": "./serviceEndpointPolicy.json#/definitions/ServiceEndpointPolicy" + }, + "description": "An array of service endpoint policies." + }, + "privateEndpoints": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint" + }, + "description": "An array of references to private endpoints." + }, + "ipConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/IPConfiguration" + }, + "description": "An array of references to the network interface IP configurations using subnet." + }, + "ipConfigurationProfiles": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkProfile.json#/definitions/IPConfigurationProfile" + }, + "description": "Array of IP configuration profiles which reference this subnet." + }, + "ipAllocations": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of IpAllocation which reference this subnet." + }, + "resourceNavigationLinks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceNavigationLink" + }, + "description": "An array of references to the external resources using subnet." + }, + "serviceAssociationLinks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAssociationLink" + }, + "description": "An array of references to services injecting into this subnet." + }, + "delegations": { + "type": "array", + "items": { + "$ref": "#/definitions/Delegation" + }, + "description": "An array of references to the delegations on the subnet." + }, + "purpose": { + "type": "string", + "readOnly": true, + "description": "A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the subnet resource." + }, + "privateEndpointNetworkPolicies": { + "type": "string", + "default": "Disabled", + "description": "Enable or Disable apply network policies on private end point in the subnet.", + "enum": [ + "Enabled", + "Disabled", + "NetworkSecurityGroupEnabled", + "RouteTableEnabled" + ], + "x-ms-enum": { + "name": "VirtualNetworkPrivateEndpointNetworkPolicies", + "modelAsString": true + } + }, + "privateLinkServiceNetworkPolicies": { + "type": "string", + "default": "Enabled", + "description": "Enable or Disable apply network policies on private link service in the subnet.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "VirtualNetworkPrivateLinkServiceNetworkPolicies", + "modelAsString": true + } + }, + "applicationGatewayIPConfigurations": { + "type": "array", + "items": { + "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayIPConfiguration" + }, + "description": "Application gateway IP configurations of virtual network resource." + }, + "sharingScope": { + "type": "string", + "default": null, + "description": "Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.", + "enum": [ + "Tenant", + "DelegatedServices" + ], + "x-ms-enum": { + "name": "SharingScope", + "modelAsString": true + } + }, + "defaultOutboundAccess": { + "type": "boolean", + "description": "Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet." + } + }, + "description": "Properties of the subnet." + }, + "ServiceEndpointPropertiesFormat": { + "properties": { + "service": { + "type": "string", + "description": "The type of the endpoint service." + }, + "networkIdentifier": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SubResource as network identifier." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service endpoint resource." + } + }, + "description": "The service endpoint properties." + }, + "VirtualNetworkPeeringPropertiesFormat": { + "properties": { + "allowVirtualNetworkAccess": { + "type": "boolean", + "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space." + }, + "allowForwardedTraffic": { + "type": "boolean", + "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network." + }, + "allowGatewayTransit": { + "type": "boolean", + "description": "If gateway links can be used in remote virtual networking to link to this virtual network." + }, + "useRemoteGateways": { + "type": "boolean", + "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." + }, + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)." + }, + "localAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The local address space of the local virtual network that is peered." + }, + "localVirtualNetworkAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The current local address space of the local virtual network that is peered." + }, + "remoteAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the address space peered with the remote virtual network." + }, + "remoteVirtualNetworkAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the current address space of the remote virtual network." + }, + "remoteBgpCommunities": { + "$ref": "#/definitions/VirtualNetworkBgpCommunities", + "default": null, + "description": "The reference to the remote virtual network's Bgp Communities." + }, + "remoteVirtualNetworkEncryption": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkEncryption", + "default": null, + "description": "The reference to the remote virtual network's encryption" + }, + "peeringState": { + "type": "string", + "description": "The status of the virtual network peering.", + "enum": [ + "Initiated", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkPeeringState", + "modelAsString": true + } + }, + "peeringSyncLevel": { + "type": "string", + "description": "The peering sync status of the virtual network peering.", + "enum": [ + "FullyInSync", + "RemoteNotInSync", + "LocalNotInSync", + "LocalAndRemoteNotInSync" + ], + "x-ms-enum": { + "name": "VirtualNetworkPeeringLevel", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network peering resource." + }, + "doNotVerifyRemoteGateways": { + "type": "boolean", + "description": "If we need to verify the provisioning state of the remote gateway." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resourceGuid property of the Virtual Network peering resource." + }, + "peerCompleteVnets": { + "type": "boolean", + "description": "Whether complete virtual network address space is peered." + }, + "enableOnlyIPv6Peering": { + "type": "boolean", + "description": "Whether only Ipv6 address space is peered for subnet peering." + }, + "localSubnetNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of local subnet names that are subnet peered with remote virtual network." + }, + "remoteSubnetNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of remote subnet names from remote virtual network that are subnet peered." + } + }, + "description": "Properties of the virtual network peering." + }, + "Subnet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubnetPropertiesFormat", + "description": "Properties of the subnet." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Subnet in a virtual network resource." + }, + "VirtualNetworkPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", + "description": "Properties of the virtual network peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peerings in a virtual network resource." + }, + "SubnetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "The subnets in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network." + }, + "ResourceNavigationLinksListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceNavigationLink" + }, + "description": "The resource navigation links in a subnet." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ResourceNavigationLinks_List operation." + }, + "ServiceAssociationLinksListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAssociationLink" + }, + "description": "The service association links in a subnet." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ServiceAssociationLinks_List operation." + }, + "VirtualNetworkPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "The peerings in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network." + }, + "VirtualNetworkPropertiesFormat": { + "properties": { + "addressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." + }, + "dhcpOptions": { + "$ref": "#/definitions/DhcpOptions", + "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." + }, + "flowTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The FlowTimeout value (in minutes) for the Virtual Network" + }, + "subnets": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "A list of subnets in a Virtual Network." + }, + "virtualNetworkPeerings": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "A list of peerings in a Virtual Network." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resourceGuid property of the Virtual Network resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network resource." + }, + "enableDdosProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource." + }, + "enableVmProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if VM protection is enabled for all the subnets in the virtual network." + }, + "ddosProtectionPlan": { + "$ref": "./network.json#/definitions/SubResource", + "default": null, + "description": "The DDoS protection plan associated with the virtual network." + }, + "bgpCommunities": { + "$ref": "#/definitions/VirtualNetworkBgpCommunities", + "default": null, + "description": "Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET." + }, + "encryption": { + "$ref": "#/definitions/VirtualNetworkEncryption", + "default": null, + "description": "Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet." + }, + "ipAllocations": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of IpAllocation which reference this VNET." + }, + "flowLogs": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkWatcher.json#/definitions/FlowLog" + }, + "description": "A collection of references to flow log resources." + } + }, + "description": "Properties of the virtual network." + }, + "VirtualNetwork": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the virtual network." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPropertiesFormat", + "description": "Properties of the virtual network." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Virtual Network resource." + }, + "VirtualNetworkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "A list of VirtualNetwork resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworks API service call." + }, + "AddressSpace": { + "properties": { + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of address blocks reserved for this virtual network in CIDR notation." + } + }, + "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." + }, + "DhcpOptions": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of DNS servers IP addresses." + } + }, + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options." + }, + "VirtualNetworkBgpCommunities": { + "properties": { + "virtualNetworkCommunity": { + "type": "string", + "description": "The BGP community associated with the virtual network." + }, + "regionalCommunity": { + "type": "string", + "readOnly": true, + "description": "The BGP community associated with the region of the virtual network." + } + }, + "required": [ + "virtualNetworkCommunity" + ], + "description": "Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET." + }, + "VirtualNetworkEncryption": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if encryption is enabled on the virtual network." + }, + "enforcement": { + "type": "string", + "description": "If the encrypted VNet allows VM that does not support encryption", + "enum": [ + "DropUnencrypted", + "AllowUnencrypted" + ], + "x-ms-enum": { + "name": "VirtualNetworkEncryptionEnforcement", + "modelAsString": true + } + } + }, + "required": [ + "enabled" + ], + "description": "Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet." + }, + "IPAddressAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Private IP address availability." + }, + "availableIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Contains other available private IP addresses if the asked for address is taken." + }, + "isPlatformReserved": { + "type": "boolean", + "description": "Private IP address platform reserved." + } + }, + "description": "Response for CheckIPAddressAvailability API service call." + }, + "VirtualNetworkListUsageResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/VirtualNetworkUsage" + }, + "description": "VirtualNetwork usage stats." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the virtual networks GetUsage API service call." + }, + "VirtualNetworkUsage": { + "properties": { + "currentValue": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates number of IPs used from the Subnet." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Subnet identifier." + }, + "limit": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates the size of the subnet." + }, + "name": { + "$ref": "#/definitions/VirtualNetworkUsageName", + "readOnly": true, + "description": "The name containing common and localized value for usage." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Usage units. Returns 'Count'." + } + }, + "description": "Usage details for subnet." + }, + "VirtualNetworkUsageName": { + "properties": { + "localizedValue": { + "type": "string", + "readOnly": true, + "description": "Localized subnet size and usage string." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "Subnet size and usage string." + } + }, + "description": "Usage strings container." + }, + "PrepareNetworkPoliciesRequest": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service for which subnet is being prepared for." + }, + "networkIntentPolicyConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkIntentPolicyConfiguration" + }, + "description": "A list of NetworkIntentPolicyConfiguration." + } + }, + "description": "Details of PrepareNetworkPolicies for Subnet." + }, + "UnprepareNetworkPoliciesRequest": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service for which subnet is being unprepared for." + } + }, + "description": "Details of UnprepareNetworkPolicies for Subnet." + }, + "NetworkIntentPolicyConfiguration": { + "properties": { + "networkIntentPolicyName": { + "type": "string", + "description": "The name of the Network Intent Policy for storing in target subscription." + }, + "sourceNetworkIntentPolicy": { + "$ref": "#/definitions/NetworkIntentPolicy", + "description": "Source network intent policy." + } + }, + "description": "Details of NetworkIntentPolicyConfiguration for PrepareNetworkPoliciesRequest." + }, + "NetworkIntentPolicy": { + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network Intent Policy resource." + }, + "VirtualNetworkDdosProtectionStatusResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./publicIpAddress.json#/definitions/PublicIpDdosProtectionStatusResult" + }, + "x-ms-identifiers": [], + "description": "The Ddos Protection Status Result for each public ip under a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for GetVirtualNetworkDdosProtectionStatusOperation." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json new file mode 100644 index 000000000000..9310be140bf0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json @@ -0,0 +1,4489 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}": { + "put": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "Parameters supplied to create or update virtual network gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayUpdate.json" + }, + "UpdateVirtualNetworkScalableGateway": { + "$ref": "./examples/VirtualNetworkScalableGatewayUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Get", + "description": "Gets the specified virtual network gateway by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayGet.json" + }, + "GetVirtualNetworkScalableGateway": { + "$ref": "./examples/VirtualNetworkScalableGatewayGet.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Delete", + "description": "Deletes the specified virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_UpdateTags", + "description": "Updates a virtual network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayTags": { + "$ref": "./examples/VirtualNetworkGatewayUpdateTags.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_List", + "description": "Gets all virtual network gateways by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaysinResourceGroup": { + "$ref": "./examples/VirtualNetworkGatewayList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ListConnections", + "description": "Gets all the connections in a virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualNetworkGatewaysListConnections": { + "$ref": "./examples/VirtualNetworkGatewaysListConnections.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Reset", + "description": "Resets the primary of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "gatewayVip", + "in": "query", + "required": false, + "type": "string", + "description": "Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation reset the primary of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/resetvpnclientsharedkey": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ResetVpnClientSharedKey", + "description": "Resets the VPN client shared key of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reset the vpn client shared key of the virtual network gateway." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVpnClientSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayResetVpnClientSharedKey.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Generatevpnclientpackage", + "description": "Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN client package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateVPNClientPackage": { + "$ref": "./examples/VirtualNetworkGatewayGenerateVpnClientPackage.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnprofile": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GenerateVpnProfile", + "description": "Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateVirtualNetworkGatewayVPNProfile": { + "$ref": "./examples/VirtualNetworkGatewayGenerateVpnProfile.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnprofilepackageurl": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnProfilePackageUrl", + "description": "Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayVPNProfilePackageURL": { + "$ref": "./examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetBgpPeerStatus", + "description": "The GetBgpPeerStatus operation retrieves the status of all BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": false, + "type": "string", + "description": "The IP address of the peer to retrieve the status of." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of BGP peer statuses.", + "schema": { + "$ref": "#/definitions/BgpPeerStatusListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayBGPPeerStatus": { + "$ref": "./examples/VirtualNetworkGatewayGetBGPPeerStatus.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/supportedvpndevices": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SupportedVpnDevices", + "description": "Gets a xml format representation for supported vpn devices.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for supported vpn devices.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaySupportedVPNDevices": { + "$ref": "./examples/VirtualNetworkGatewaySupportedVpnDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getLearnedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetLearnedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of advertised BGP routes.", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayLearnedRoutes": { + "$ref": "./examples/VirtualNetworkGatewayLearnedRoutes.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetAdvertisedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": true, + "type": "string", + "description": "The IP address of the peer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of learned BGP routes.", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayAdvertisedRoutes": { + "$ref": "./examples/VirtualNetworkGatewayGetAdvertisedRoutes.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/setvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SetVpnclientIpsecParameters", + "description": "The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "vpnclientIpsecParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + }, + "description": "Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Set VirtualNetworkGateway VpnClientIpsecParameters": { + "$ref": "./examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnclientIpsecParameters", + "description": "The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the set vpnclient ipsec parameters for P2S client of VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Get VirtualNetworkGateway VpnClientIpsecParameters": { + "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/vpndeviceconfigurationscript": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_VpnDeviceConfigurationScript", + "description": "Gets a xml format representation for vpn device configuration script.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection for which the configuration script is generated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnDeviceScriptParameters" + }, + "description": "Parameters supplied to the generate vpn device script operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for vpn device configuration script.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVPNDeviceConfigurationScript": { + "$ref": "./examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_StartPacketCapture", + "description": "Starts packet capture on virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStartParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to start packet capture on gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture started on virtual network gateway.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Start packet capture on virtual network gateway without filter": { + "$ref": "./examples/VirtualNetworkGatewayStartPacketCapture.json" + }, + "Start packet capture on virtual network gateway with filter": { + "$ref": "./examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/stopPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_StopPacketCapture", + "description": "Stops packet capture on virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStopParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to stop packet capture on gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture stopped on virtual network gateway.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Stop packet capture on virtual network gateway": { + "$ref": "./examples/VirtualNetworkGatewayStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "Parameters supplied to the create or update virtual network gateway connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreateVirtualNetworkGatewayConnection_S2S": { + "$ref": "./examples/VirtualNetworkGatewayConnectionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Get", + "description": "Gets the specified virtual network gateway connection by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionGet.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Delete", + "description": "Deletes the specified virtual network Gateway connection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGatewayConnection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_UpdateTags", + "description": "Updates a virtual network gateway connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway connection tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayConnectionTags": { + "$ref": "./examples/VirtualNetworkGatewayConnectionUpdateTags.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_SetSharedKey", + "description": "The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + }, + "description": "Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting ConnectionSharedKey resource.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting ConnectionSharedKey resource.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SetVirtualNetworkGatewayConnectionSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayConnectionSetSharedKey.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_GetSharedKey", + "description": "The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection shared key name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resources.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnectionSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayConnectionGetSharedKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections": { + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_List", + "description": "The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation resets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewayConnectionsinResourceGroup": { + "$ref": "./examples/VirtualNetworkGatewayConnectionsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_ResetSharedKey", + "description": "The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection reset shared key Name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + }, + "description": "Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation sets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + } + }, + "202": { + "description": "Request successful. The operation sets the virtual network gateway connection shared key." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGatewayConnectionSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayConnectionResetSharedKey.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/startPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_StartPacketCapture", + "description": "Starts packet capture on virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStartParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to start packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture started on virtual network gateway connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Start packet capture on virtual network gateway connection without filter": { + "$ref": "./examples/VirtualNetworkGatewayConnectionStartPacketCapture.json" + }, + "Start packet capture on virtual network gateway connection with filter": { + "$ref": "./examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/stopPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_StopPacketCapture", + "description": "Stops packet capture on virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway Connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStopParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to stop packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture stopped on virtual network gateway connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Stop packet capture on virtual network gateway connection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/getikesas": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_GetIkeSas", + "description": "Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway Connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation GetIkeSas will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation getikesas completed on virtual network gateway connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "The operation GetIkeSas could not be completed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnectionIkeSa": { + "$ref": "./examples/VirtualNetworkGatewayConnectionGetIkeSas.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/resetconnection": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_ResetConnection", + "description": "Resets the virtual network gateway connection specified.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway Connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "The operation resetconnection could not be completed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGatewayConnection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}": { + "put": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a local network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "Parameters supplied to the create or update local network gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreateLocalNetworkGateway": { + "$ref": "./examples/LocalNetworkGatewayCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Get", + "description": "Gets the specified local network gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetLocalNetworkGateway": { + "$ref": "./examples/LocalNetworkGatewayGet.json" + } + } + }, + "delete": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Delete", + "description": "Deletes the specified local network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteLocalNetworkGateway": { + "$ref": "./examples/LocalNetworkGatewayDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_UpdateTags", + "description": "Updates a local network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update local network gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateLocalNetworkGatewayTags": { + "$ref": "./examples/LocalNetworkGatewayUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways": { + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_List", + "description": "Gets all the local network gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LocalNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/LocalNetworkGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListLocalNetworkGateways": { + "$ref": "./examples/LocalNetworkGatewayList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnclientConnectionHealth", + "description": "Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of VPN client connection health details.", + "schema": { + "$ref": "#/definitions/VpnClientConnectionHealthDetailListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayVpnclientConnectionHealth": { + "$ref": "./examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/disconnectVirtualNetworkGatewayVpnConnections": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_DisconnectVirtualNetworkGatewayVpnConnections", + "description": "Disconnect vpn connections of virtual network gateway in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "./virtualWan.json#/definitions/P2SVpnConnectionRequest" + }, + "description": "The parameters are supplied to disconnect vpn connections." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation disconnects the requested vpn connections." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Disconnect VpnConnections from Virtual Network Gateway": { + "$ref": "./examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}": { + "get": { + "operationId": "VirtualNetworkGatewayNatRules_Get", + "x-ms-examples": { + "VirtualNetworkGatewayNatRuleGet": { + "$ref": "./examples/VirtualNetworkGatewayNatRuleGet.json" + } + }, + "description": "Retrieves the details of a nat rule.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the Virtual Network Gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the nat rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualNetworkGatewayNatRules_CreateOrUpdate", + "x-ms-examples": { + "VirtualNetworkGatewayNatRulePut": { + "$ref": "./examples/VirtualNetworkGatewayNatRulePut.json" + } + }, + "description": "Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the Virtual Network Gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "NatRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + }, + "description": "Parameters supplied to create or Update a Nat Rule." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the nat rule created or updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + } + }, + "201": { + "description": "Request successful. Returns the details of the nat rule created or updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualNetworkGatewayNatRules_Delete", + "x-ms-examples": { + "VirtualNetworkGatewayNatRuleDelete": { + "$ref": "./examples/VirtualNetworkGatewayNatRuleDelete.json" + } + }, + "description": "Deletes a nat rule.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the Virtual Network Gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Nat Rule deleted." + }, + "202": { + "description": "Request received successfully. Nat Rule deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No nat rules exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules": { + "get": { + "operationId": "VirtualNetworkGatewayNatRules_ListByVirtualNetworkGateway", + "x-ms-examples": { + "VirtualNetworkGatewayNatRuleList": { + "$ref": "./examples/VirtualNetworkGatewayNatRuleList.json" + } + }, + "description": "Retrieves all nat rules for a particular virtual network gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the virtual network gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Nat rules for a virtual network gateway.", + "schema": { + "$ref": "#/definitions/ListVirtualNetworkGatewayNatRulesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the public IP resource." + }, + "privateIPAddress": { + "readOnly": true, + "type": "string", + "description": "Private IP Address for this gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway IP configuration resource." + } + }, + "description": "Properties of VirtualNetworkGatewayIPConfiguration." + }, + "VirtualNetworkGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat", + "description": "Properties of the virtual network gateway ip configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration for virtual network gateway." + }, + "VirtualNetworkGatewayNatRuleProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NAT Rule resource." + }, + "type": { + "type": "string", + "description": "The type of NAT rule for VPN NAT.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "VpnNatRuleType", + "modelAsString": true + } + }, + "mode": { + "type": "string", + "description": "The Source NAT direction of a VPN NAT.", + "enum": [ + "EgressSnat", + "IngressSnat" + ], + "x-ms-enum": { + "name": "VpnNatRuleMode", + "modelAsString": true + } + }, + "internalMappings": { + "type": "array", + "items": { + "$ref": "./virtualWan.json#/definitions/VpnNatRuleMapping" + }, + "description": "The private IP address internal mapping for NAT." + }, + "externalMappings": { + "type": "array", + "items": { + "$ref": "./virtualWan.json#/definitions/VpnNatRuleMapping" + }, + "description": "The private IP address external mapping for NAT." + }, + "ipConfigurationId": { + "type": "string", + "description": "The IP Configuration ID this NAT rule applies to." + } + }, + "description": "Parameters for VirtualNetworkGatewayNatRule." + }, + "VirtualNetworkGatewayNatRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayNatRuleProperties", + "description": "Properties of the Virtual Network Gateway NAT rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VirtualNetworkGatewayNatRule Resource." + }, + "VirtualNetworkGatewayPropertiesFormat": { + "properties": { + "autoScaleConfiguration": { + "$ref": "#/definitions/VirtualNetworkGatewayAutoScaleConfiguration", + "description": "Autoscale configuration for virutal network gateway" + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" + }, + "description": "IP configurations for virtual network gateway." + }, + "gatewayType": { + "type": "string", + "description": "The type of this virtual network gateway.", + "enum": [ + "Vpn", + "ExpressRoute", + "LocalGateway" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayType", + "modelAsString": true + } + }, + "vpnType": { + "type": "string", + "description": "The type of this virtual network gateway.", + "enum": [ + "PolicyBased", + "RouteBased" + ], + "x-ms-enum": { + "name": "VpnType", + "modelAsString": true + } + }, + "vpnGatewayGeneration": { + "type": "string", + "description": "The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.", + "enum": [ + "None", + "Generation1", + "Generation2" + ], + "x-ms-enum": { + "name": "VpnGatewayGeneration", + "modelAsString": true + } + }, + "enableBgp": { + "type": "boolean", + "description": "Whether BGP is enabled for this virtual network gateway or not." + }, + "enablePrivateIpAddress": { + "type": "boolean", + "description": "Whether private IP needs to be enabled on this gateway for connections or not." + }, + "activeActive": { + "type": "boolean", + "description": "ActiveActive flag." + }, + "disableIPSecReplayProtection": { + "type": "boolean", + "description": "disableIPSecReplayProtection flag." + }, + "gatewayDefaultSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." + }, + "sku": { + "$ref": "#/definitions/VirtualNetworkGatewaySku", + "description": "The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." + }, + "vpnClientConfiguration": { + "$ref": "#/definitions/VpnClientConfiguration", + "description": "The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations." + }, + "virtualNetworkGatewayPolicyGroups": { + "type": "array", + "description": "The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayPolicyGroup" + } + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Virtual network gateway's BGP speaker settings." + }, + "customRoutes": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the virtual network gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway resource." + }, + "enableDnsForwarding": { + "type": "boolean", + "description": "Whether dns forwarding is enabled or not." + }, + "inboundDnsForwardingEndpoint": { + "type": "string", + "readOnly": true, + "description": "The IP address allocated by the gateway to which dns requests can be sent." + }, + "vNetExtendedLocationResourceId": { + "type": "string", + "description": "Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet." + }, + "natRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + }, + "description": "NatRules for virtual network gateway." + }, + "enableBgpRouteTranslationForNat": { + "type": "boolean", + "description": "EnableBgpRouteTranslationForNat flag." + }, + "allowVirtualWanTraffic": { + "type": "boolean", + "description": "Configures this gateway to accept traffic from remote Virtual WAN networks." + }, + "allowRemoteVnetTraffic": { + "type": "boolean", + "description": "Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN." + }, + "adminState": { + "type": "string", + "description": "Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "adminState", + "modelAsString": true + } + } + }, + "description": "VirtualNetworkGateway properties." + }, + "VirtualNetworkGatewayAutoScaleConfiguration": { + "properties": { + "bounds": { + "$ref": "#/definitions/VirtualNetworkGatewayAutoScaleBounds", + "description": "The bounds of the autoscale configuration" + } + }, + "description": "Virtual Network Gateway Autoscale Configuration details" + }, + "VirtualNetworkGatewayAutoScaleBounds": { + "properties": { + "min": { + "type": "integer", + "description": "Minimum scale Units for Autoscale configuration" + }, + "max": { + "type": "integer", + "description": "Maximum Scale Units for Autoscale configuration" + } + } + }, + "VpnClientRootCertificatePropertiesFormat": { + "properties": { + "publicCertData": { + "type": "string", + "description": "The certificate public data." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN client root certificate resource." + } + }, + "required": [ + "publicCertData" + ], + "description": "Properties of SSL certificates of application gateway." + }, + "VpnClientRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat", + "description": "Properties of the vpn client root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "properties" + ], + "description": "VPN client root certificate of virtual network gateway." + }, + "VpnClientRevokedCertificatePropertiesFormat": { + "properties": { + "thumbprint": { + "type": "string", + "description": "The revoked VPN client certificate thumbprint." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN client revoked certificate resource." + } + }, + "description": "Properties of the revoked VPN client certificate of virtual network gateway." + }, + "VpnClientRevokedCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat", + "description": "Properties of the vpn client revoked certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VPN client revoked certificate of virtual network gateway." + }, + "RadiusServer": { + "properties": { + "radiusServerAddress": { + "type": "string", + "description": "The address of this radius server." + }, + "radiusServerScore": { + "type": "integer", + "format": "int64", + "description": "The initial score assigned to this radius server." + }, + "radiusServerSecret": { + "type": "string", + "description": "The secret used for this radius server." + } + }, + "required": [ + "radiusServerAddress" + ], + "description": "Radius Server Settings." + }, + "VpnClientConfiguration": { + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents Address space for P2S VpnClient." + }, + "vpnClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRootCertificate" + }, + "description": "VpnClientRootCertificate for virtual network gateway." + }, + "vpnClientRevokedCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRevokedCertificate" + }, + "description": "VpnClientRevokedCertificate for Virtual network gateway." + }, + "vpnClientProtocols": { + "type": "array", + "items": { + "type": "string", + "description": "VPN client protocol enabled for the virtual network gateway.", + "enum": [ + "IkeV2", + "SSTP", + "OpenVPN" + ], + "x-ms-enum": { + "name": "VpnClientProtocol", + "modelAsString": true + } + }, + "description": "VpnClientProtocols for Virtual network gateway." + }, + "vpnAuthenticationTypes": { + "type": "array", + "items": { + "type": "string", + "description": "VPN authentication types enabled for the virtual network gateway.", + "enum": [ + "Certificate", + "Radius", + "AAD" + ], + "x-ms-enum": { + "name": "VpnAuthenticationType", + "modelAsString": true + } + }, + "description": "VPN authentication types for the virtual network gateway.." + }, + "vpnClientIpsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "VpnClientIpsecPolicies for virtual network gateway P2S client." + }, + "radiusServerAddress": { + "type": "string", + "description": "The radius server address property of the VirtualNetworkGateway resource for vpn client connection." + }, + "radiusServerSecret": { + "type": "string", + "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection." + }, + "radiusServers": { + "type": "array", + "items": { + "$ref": "#/definitions/RadiusServer" + }, + "description": "The radiusServers property for multiple radius server configuration." + }, + "aadTenant": { + "type": "string", + "description": "The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication." + }, + "aadAudience": { + "type": "string", + "description": "The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication." + }, + "aadIssuer": { + "type": "string", + "description": "The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication." + }, + "vngClientConnectionConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VngClientConnectionConfiguration" + }, + "description": "per ip address pool connection policy for virtual network gateway P2S client." + } + }, + "description": "VpnClientConfiguration for P2S client." + }, + "VirtualNetworkGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Gateway SKU name.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw4", + "VpnGw5", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "VpnGw4AZ", + "VpnGw5AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ", + "ErGwScale" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Gateway SKU tier.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw4", + "VpnGw5", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "VpnGw4AZ", + "VpnGw5AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ", + "ErGwScale" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuTier", + "modelAsString": true + } + }, + "capacity": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The capacity." + } + }, + "description": "VirtualNetworkGatewaySku details." + }, + "BgpSettings": { + "properties": { + "asn": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The BGP speaker's ASN." + }, + "bgpPeeringAddress": { + "type": "string", + "description": "The BGP peering address and BGP identifier of this BGP speaker." + }, + "peerWeight": { + "type": "integer", + "format": "int32", + "description": "The weight added to routes learned from this BGP speaker." + }, + "bgpPeeringAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigurationBgpPeeringAddress" + }, + "description": "BGP peering address with IP configuration ID for virtual network gateway." + } + }, + "description": "BGP settings details." + }, + "BgpPeerStatus": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The virtual network gateway's local address." + }, + "neighbor": { + "type": "string", + "readOnly": true, + "description": "The remote BGP peer." + }, + "asn": { + "type": "integer", + "format": "int64", + "readOnly": true, + "minimum": 0, + "maximum": 4294967295, + "description": "The autonomous system number of the remote BGP peer." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The BGP peer state.", + "enum": [ + "Unknown", + "Stopped", + "Idle", + "Connecting", + "Connected" + ], + "x-ms-enum": { + "name": "BgpPeerState", + "modelAsString": true + } + }, + "connectedDuration": { + "type": "string", + "readOnly": true, + "description": "For how long the peering has been up." + }, + "routesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of routes learned from this peer." + }, + "messagesSent": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages sent." + }, + "messagesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages received." + } + }, + "description": "BGP peer status details." + }, + "GatewayRoute": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The gateway's local address." + }, + "network": { + "type": "string", + "readOnly": true, + "description": "The route's network prefix." + }, + "nextHop": { + "type": "string", + "readOnly": true, + "description": "The route's next hop." + }, + "sourcePeer": { + "type": "string", + "readOnly": true, + "description": "The peer this route was learned from." + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The source this route was learned from." + }, + "asPath": { + "type": "string", + "readOnly": true, + "description": "The route's AS path sequence." + }, + "weight": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The route's weight." + } + }, + "description": "Gateway routing details." + }, + "VirtualNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat", + "description": "Properties of the virtual network gateway." + }, + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of type local virtual network gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the virtual network gateway, if configured." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "VpnClientParameters": { + "properties": { + "processorArchitecture": { + "type": "string", + "description": "VPN client Processor Architecture.", + "enum": [ + "Amd64", + "X86" + ], + "x-ms-enum": { + "name": "ProcessorArchitecture", + "modelAsString": true + } + }, + "authenticationMethod": { + "$ref": "./network.json#/definitions/AuthenticationMethod", + "description": "VPN client authentication method." + }, + "radiusServerAuthCertificate": { + "type": "string", + "description": "The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only if external radius authentication has been configured with EAPTLS authentication." + }, + "clientRootCertificates": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external radius based authentication with EAPTLS." + } + }, + "description": "Vpn Client Parameters for package generation." + }, + "VirtualNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "A list of VirtualNetworkGateway resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGateways API service call." + }, + "ListVirtualNetworkGatewayNatRulesResult": { + "description": "Result of the request to list all nat rules to a virtual network gateway. It contains a list of Nat rules and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + }, + "description": "List of Nat Rules." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "BgpPeerStatusListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpPeerStatus" + }, + "description": "List of BGP peers." + } + }, + "description": "Response for list BGP peer status API service call." + }, + "GatewayRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayRoute" + }, + "description": "List of gateway routes." + } + }, + "description": "List of virtual network gateway routes." + }, + "TunnelConnectionHealth": { + "properties": { + "tunnel": { + "readOnly": true, + "type": "string", + "description": "Tunnel name." + }, + "connectionStatus": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionStatus", + "description": "Virtual Network Gateway connection status." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Ingress Bytes Transferred in this connection." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Egress Bytes Transferred in this connection." + }, + "lastConnectionEstablishedUtcTime": { + "readOnly": true, + "type": "string", + "description": "The time at which connection was established in Utc format." + } + }, + "description": "VirtualNetworkGatewayConnection properties." + }, + "VirtualNetworkGatewayConnectionPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/LocalNetworkGateway", + "description": "The reference to local network gateway resource." + }, + "ingressNatRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of ingress NatRules." + }, + "egressNatRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of egress NatRules." + }, + "connectionType": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionType", + "description": "Gateway connection type." + }, + "connectionProtocol": { + "$ref": "#/definitions/ConnectionProtocol", + "description": "Connection protocol used for this connection." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "dpdTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The dead peer detection timeout of this connection in seconds." + }, + "connectionMode": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionMode", + "description": "The connection mode for this connection." + }, + "sharedKey": { + "type": "string", + "description": "The IPSec shared key." + }, + "connectionStatus": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionStatus", + "description": "Virtual Network Gateway connection status." + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "gatewayCustomBgpIpAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayCustomBgpIpAddressIpConfiguration" + }, + "description": "GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.", + "x-ms-identifiers": [] + }, + "useLocalAzureIpAddress": { + "type": "boolean", + "description": "Use private local Azure IP for the connection." + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "trafficSelectorPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/TrafficSelectorPolicy" + }, + "description": "The Traffic Selector Policies to be considered by this connection." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the virtual network gateway connection resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway connection resource." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Bypass ExpressRoute Gateway for data forwarding." + }, + "enablePrivateLinkFastPath": { + "type": "boolean", + "description": "Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled." + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties." + }, + "VirtualNetworkGatewayConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "VirtualNetworkGatewayConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "A list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGatewayConnections API service call." + }, + "ConnectionResetSharedKey": { + "properties": { + "keyLength": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "description": "The virtual network connection reset shared key length, should between 1 and 128." + } + }, + "required": [ + "keyLength" + ], + "description": "The virtual network connection reset shared key." + }, + "ConnectionSharedKey": { + "properties": { + "value": { + "type": "string", + "description": "The virtual network connection shared key value." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "value" + ], + "description": "Response for GetConnectionSharedKey API service call." + }, + "IpsecPolicy": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." + }, + "ipsecEncryption": { + "$ref": "#/definitions/IpsecEncryption", + "description": "The IPSec encryption algorithm (IKE phase 1)." + }, + "ipsecIntegrity": { + "$ref": "#/definitions/IpsecIntegrity", + "description": "The IPSec integrity algorithm (IKE phase 1)." + }, + "ikeEncryption": { + "$ref": "#/definitions/IkeEncryption", + "description": "The IKE encryption algorithm (IKE phase 2)." + }, + "ikeIntegrity": { + "$ref": "#/definitions/IkeIntegrity", + "description": "The IKE integrity algorithm (IKE phase 2)." + }, + "dhGroup": { + "$ref": "#/definitions/DhGroup", + "description": "The DH Group used in IKE Phase 1 for initial SA." + }, + "pfsGroup": { + "$ref": "#/definitions/PfsGroup", + "description": "The Pfs Group used in IKE Phase 2 for new child SA." + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec Policy configuration for a virtual network gateway connection." + }, + "VngClientConnectionConfigurationProperties": { + "type": "object", + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents Address space for P2S VpnClient." + }, + "virtualNetworkGatewayPolicyGroups": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of references to virtualNetworkGatewayPolicyGroups" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VngClientConnectionConfiguration resource." + } + }, + "required": [ + "vpnClientAddressPool", + "virtualNetworkGatewayPolicyGroups" + ], + "description": "Properties of VngClientConnectionConfiguration." + }, + "VngClientConnectionConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VngClientConnectionConfigurationProperties", + "description": "Properties of the vpn client root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A vpn client connection configuration for client connection configuration." + }, + "VirtualNetworkGatewayPolicyGroupProperties": { + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "Shows if this is a Default VirtualNetworkGatewayPolicyGroup or not." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Priority for VirtualNetworkGatewayPolicyGroup." + }, + "policyMembers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayPolicyGroupMember" + }, + "description": "Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup.", + "x-ms-identifiers": [] + }, + "vngClientConnectionConfigurations": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of references to vngClientConnectionConfigurations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VirtualNetworkGatewayPolicyGroup resource." + } + }, + "required": [ + "priority", + "policyMembers", + "isDefault" + ], + "description": "Properties of VirtualNetworkGatewayPolicyGroup." + }, + "VirtualNetworkGatewayPolicyGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayPolicyGroupProperties", + "description": "Properties of tVirtualNetworkGatewayPolicyGroup." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Parameters for VirtualNetworkGatewayPolicyGroup." + }, + "VirtualNetworkGatewayPolicyGroupMember": { + "properties": { + "name": { + "type": "string", + "description": "Name of the VirtualNetworkGatewayPolicyGroupMember." + }, + "attributeType": { + "type": "string", + "description": "The Vpn Policy member attribute type.", + "enum": [ + "CertificateGroupId", + "AADGroupId", + "RadiusAzureGroupId" + ], + "x-ms-enum": { + "name": "VpnPolicyMemberAttributeType", + "modelAsString": true + } + }, + "attributeValue": { + "type": "string", + "description": "The value of Attribute used for this VirtualNetworkGatewayPolicyGroupMember." + } + }, + "description": "Vpn Client Connection configuration PolicyGroup member", + "type": "object" + }, + "TrafficSelectorPolicy": { + "properties": { + "localAddressRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A collection of local address spaces in CIDR format." + }, + "remoteAddressRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A collection of remote address spaces in CIDR format." + } + }, + "required": [ + "localAddressRanges", + "remoteAddressRanges" + ], + "description": "An traffic selector policy for a virtual network gateway connection." + }, + "ConnectionProtocol": { + "type": "string", + "description": "Gateway connection protocol.", + "enum": [ + "IKEv2", + "IKEv1" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionProtocol", + "modelAsString": true + } + }, + "VpnClientIPsecParameters": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for P2S client." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for P2S client.." + }, + "ipsecEncryption": { + "$ref": "#/definitions/IpsecEncryption", + "description": "The IPSec encryption algorithm (IKE phase 1)." + }, + "ipsecIntegrity": { + "$ref": "#/definitions/IpsecIntegrity", + "description": "The IPSec integrity algorithm (IKE phase 1)." + }, + "ikeEncryption": { + "$ref": "#/definitions/IkeEncryption", + "description": "The IKE encryption algorithm (IKE phase 2)." + }, + "ikeIntegrity": { + "$ref": "#/definitions/IkeIntegrity", + "description": "The IKE integrity algorithm (IKE phase 2)." + }, + "dhGroup": { + "$ref": "#/definitions/DhGroup", + "description": "The DH Group used in IKE Phase 1 for initial SA." + }, + "pfsGroup": { + "$ref": "#/definitions/PfsGroup", + "description": "The Pfs Group used in IKE Phase 2 for new child SA." + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec parameters for a virtual network gateway P2S connection." + }, + "LocalNetworkGatewayPropertiesFormat": { + "properties": { + "localNetworkAddressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "Local network site address space." + }, + "gatewayIpAddress": { + "type": "string", + "description": "IP address of local network gateway." + }, + "fqdn": { + "type": "string", + "description": "FQDN of local network gateway." + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the local network gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the local network gateway resource." + } + }, + "description": "LocalNetworkGateway properties." + }, + "LocalNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat", + "description": "Properties of the local network gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "LocalNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "A list of local network gateways that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLocalNetworkGateways API service call." + }, + "VirtualNetworkConnectionGatewayReference": { + "properties": { + "id": { + "type": "string", + "description": "The ID of VirtualNetworkGateway or LocalNetworkGateway resource." + } + }, + "required": [ + "id" + ], + "description": "A reference to VirtualNetworkGateway or LocalNetworkGateway resource." + }, + "VirtualNetworkGatewayConnectionListEntityPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/VirtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkConnectionGatewayReference", + "description": "The reference to local network gateway resource." + }, + "connectionType": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionType", + "description": "Gateway connection type." + }, + "connectionProtocol": { + "$ref": "#/definitions/ConnectionProtocol", + "description": "Connection protocol used for this connection." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "connectionMode": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionMode", + "description": "The connection mode for this connection." + }, + "sharedKey": { + "type": "string", + "description": "The IPSec shared key." + }, + "connectionStatus": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionStatus", + "description": "Virtual Network Gateway connection status." + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "gatewayCustomBgpIpAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayCustomBgpIpAddressIpConfiguration" + }, + "description": "GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.", + "x-ms-identifiers": [] + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "trafficSelectorPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/TrafficSelectorPolicy" + }, + "description": "The Traffic Selector Policies to be considered by this connection." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the virtual network gateway connection resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway connection resource." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Bypass ExpressRoute Gateway for data forwarding." + }, + "enablePrivateLinkFastPath": { + "type": "boolean", + "description": "Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled." + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties." + }, + "VirtualNetworkGatewayConnectionListEntity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntityPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "VirtualNetworkGatewayListConnectionsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntity" + }, + "description": "A list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the VirtualNetworkGatewayListConnections API service call." + }, + "VpnDeviceScriptParameters": { + "properties": { + "vendor": { + "type": "string", + "description": "The vendor for the vpn device." + }, + "deviceFamily": { + "type": "string", + "description": "The device family for the vpn device." + }, + "firmwareVersion": { + "type": "string", + "description": "The firmware version for the vpn device." + } + }, + "description": "Vpn device configuration script generation parameters." + }, + "DhGroup": { + "type": "string", + "description": "The DH Groups used in IKE Phase 1 for initial SA.", + "enum": [ + "None", + "DHGroup1", + "DHGroup2", + "DHGroup14", + "DHGroup2048", + "ECP256", + "ECP384", + "DHGroup24" + ], + "x-ms-enum": { + "name": "DhGroup", + "modelAsString": true + } + }, + "IkeEncryption": { + "type": "string", + "description": "The IKE encryption algorithm (IKE phase 2).", + "enum": [ + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeEncryption", + "modelAsString": true + } + }, + "IkeIntegrity": { + "type": "string", + "description": "The IKE integrity algorithm (IKE phase 2).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "SHA384", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeIntegrity", + "modelAsString": true + } + }, + "IpsecEncryption": { + "type": "string", + "description": "The IPSec encryption algorithm (IKE phase 1).", + "enum": [ + "None", + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecEncryption", + "modelAsString": true + } + }, + "IpsecIntegrity": { + "type": "string", + "description": "The IPSec integrity algorithm (IKE phase 1).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecIntegrity", + "modelAsString": true + } + }, + "PfsGroup": { + "type": "string", + "description": "The Pfs Groups used in IKE Phase 2 for new child SA.", + "enum": [ + "None", + "PFS1", + "PFS2", + "PFS2048", + "ECP256", + "ECP384", + "PFS24", + "PFS14", + "PFSMM" + ], + "x-ms-enum": { + "name": "PfsGroup", + "modelAsString": true + } + }, + "VirtualNetworkGatewayConnectionStatus": { + "type": "string", + "description": "Virtual Network Gateway connection status.", + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionStatus", + "modelAsString": true + } + }, + "VirtualNetworkGatewayConnectionType": { + "type": "string", + "description": "Gateway connection type.", + "enum": [ + "IPsec", + "Vnet2Vnet", + "ExpressRoute", + "VPNClient" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionType", + "modelAsString": true + } + }, + "VirtualNetworkGatewayConnectionMode": { + "type": "string", + "description": "Gateway connection type.", + "enum": [ + "Default", + "ResponderOnly", + "InitiatorOnly" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionMode", + "modelAsString": true + } + }, + "VpnClientConnectionHealthDetailListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientConnectionHealthDetail" + }, + "description": "List of vpn client connection health." + } + }, + "description": "List of virtual network gateway vpn client connection health." + }, + "VpnClientConnectionHealthDetail": { + "properties": { + "vpnConnectionId": { + "type": "string", + "readOnly": true, + "description": "The vpn client Id." + }, + "vpnConnectionDuration": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The duration time of a connected vpn client." + }, + "vpnConnectionTime": { + "type": "string", + "readOnly": true, + "description": "The start time of a connected vpn client." + }, + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "The public Ip of a connected vpn client." + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "The assigned private Ip of a connected vpn client." + }, + "vpnUserName": { + "type": "string", + "readOnly": true, + "description": "The user name of a connected vpn client." + }, + "maxBandwidth": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The max band width." + }, + "egressPacketsTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The egress packets per second." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The egress bytes per second." + }, + "ingressPacketsTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The ingress packets per second." + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The ingress bytes per second." + }, + "maxPacketsPerSecond": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The max packets transferred per second." + } + }, + "description": "VPN client connection health detail." + }, + "VpnPacketCaptureStopParameters": { + "properties": { + "sasUrl": { + "type": "string", + "description": "SAS url for packet capture on virtual network gateway." + } + }, + "description": "Stop packet capture parameters." + }, + "VpnPacketCaptureStartParameters": { + "properties": { + "filterData": { + "type": "string", + "description": "Start Packet capture parameters." + } + }, + "description": "Start packet capture parameters on virtual network gateway." + }, + "IPConfigurationBgpPeeringAddress": { + "properties": { + "ipconfigurationId": { + "type": "string", + "description": "The ID of IP configuration which belongs to gateway." + }, + "defaultBgpIpAddresses": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of default BGP peering addresses which belong to IP configuration." + }, + "customBgpIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of custom BGP peering addresses which belong to IP configuration." + }, + "tunnelIpAddresses": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of tunnel public IP addresses which belong to IP configuration." + } + }, + "description": "Properties of IPConfigurationBgpPeeringAddress." + }, + "GatewayCustomBgpIpAddressIpConfiguration": { + "type": "object", + "properties": { + "ipConfigurationId": { + "type": "string", + "description": "The IpconfigurationId of ipconfiguration which belongs to gateway." + }, + "customBgpIpAddress": { + "type": "string", + "description": "The custom BgpPeeringAddress which belongs to IpconfigurationId." + } + }, + "required": [ + "ipConfigurationId", + "customBgpIpAddress" + ], + "description": "GatewayCustomBgpIpAddressIpConfiguration for a virtual network gateway connection." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetworkTap.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetworkTap.json new file mode 100644 index 000000000000..57a590092387 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetworkTap.json @@ -0,0 +1,426 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}": { + "delete": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_Delete", + "description": "Deletes the specified virtual network tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network tap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Virtual Network Tap resource": { + "$ref": "./examples/VirtualNetworkTapDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_Get", + "description": "Gets information about the specified virtual network tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of virtual network tap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Virtual Network Tap": { + "$ref": "./examples/VirtualNetworkTapGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_CreateOrUpdate", + "description": "Creates or updates a Virtual Network Tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network tap." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + }, + "description": "Parameters supplied to the create or update virtual network tap operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Virtual Network Tap": { + "$ref": "./examples/VirtualNetworkTapCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_UpdateTags", + "description": "Updates an VirtualNetworkTap tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap." + }, + { + "name": "tapParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VirtualNetworkTap tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update virtual network tap tags": { + "$ref": "./examples/VirtualNetworkTapUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworkTaps": { + "get": { + "tags": [ + "VirtualNetworkTaps" + ], + "operationId": "VirtualNetworkTaps_ListAll", + "description": "Gets all the VirtualNetworkTaps in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTapListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual network taps": { + "$ref": "./examples/VirtualNetworkTapListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps": { + "get": { + "tags": [ + "VirtualNetworkTaps" + ], + "operationId": "VirtualNetworkTaps_ListByResourceGroup", + "description": "Gets all the VirtualNetworkTaps in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTapListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual network taps in resource group": { + "$ref": "./examples/VirtualNetworkTapList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualNetworkTap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkTapPropertiesFormat", + "description": "Virtual Network Tap Properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Virtual Network Tap resource." + }, + "VirtualNetworkTapPropertiesFormat": { + "description": "Virtual Network Tap properties.", + "properties": { + "networkInterfaceTapConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceTapConfiguration", + "description": "The reference to the Network Interface." + }, + "description": "Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resource GUID property of the virtual network tap resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network tap resource." + }, + "destinationNetworkInterfaceIPConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "The reference to the private IP Address of the collector nic that will receive the tap." + }, + "destinationLoadBalancerFrontEndIPConfiguration": { + "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration", + "description": "The reference to the private IP address on the internal Load Balancer that will receive the tap." + }, + "destinationPort": { + "type": "integer", + "description": "The VXLAN destination port that will receive the tapped traffic." + } + } + }, + "VirtualNetworkTapListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkTap" + }, + "description": "A list of VirtualNetworkTaps in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListVirtualNetworkTap API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualRouter.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualRouter.json new file mode 100644 index 000000000000..a7f8844f418f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualRouter.json @@ -0,0 +1,698 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}": { + "delete": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_Delete", + "description": "Deletes the specified Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete VirtualRouter": { + "$ref": "./examples/VirtualRouterDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_Get", + "description": "Gets the specified Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Virtual Router resource.", + "schema": { + "$ref": "#/definitions/VirtualRouter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get VirtualRouter": { + "$ref": "./examples/VirtualRouterGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_CreateOrUpdate", + "description": "Creates or updates the specified Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualRouter" + }, + "description": "Parameters supplied to the create or update Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting Virtual Router resource.", + "schema": { + "$ref": "#/definitions/VirtualRouter" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting Virtual Router resource.", + "schema": { + "$ref": "#/definitions/VirtualRouter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create VirtualRouter": { + "$ref": "./examples/VirtualRouterPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters": { + "get": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_ListByResourceGroup", + "description": "Lists all Virtual Routers in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Virtual Router resources.", + "schema": { + "$ref": "#/definitions/VirtualRouterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all Virtual Router for a given resource group": { + "$ref": "./examples/VirtualRouterListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualRouters": { + "get": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_List", + "description": "Gets all the Virtual Routers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Virtual Router resources.", + "schema": { + "$ref": "#/definitions/VirtualRouterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all Virtual Routers for a given subscription": { + "$ref": "./examples/VirtualRouterListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_Delete", + "description": "Deletes the specified peering from a Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete VirtualRouterPeering": { + "$ref": "./examples/VirtualRouterPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_Get", + "description": "Gets the specified Virtual Router Peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router Peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Virtual Router Peering resource.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get Virtual Router Peering": { + "$ref": "./examples/VirtualRouterPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_CreateOrUpdate", + "description": "Creates or updates the specified Virtual Router Peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router Peering." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + }, + "description": "Parameters supplied to the create or update Virtual Router Peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting Virtual Router Peering resource.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting Virtual Router Peering resource.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create Virtual Router Peering": { + "$ref": "./examples/VirtualRouterPeeringPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings": { + "get": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_List", + "description": "Lists all Virtual Router Peerings in a Virtual Router resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Virtual Router Peering resources.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all Virtual Router Peerings for a given Virtual Router": { + "$ref": "./examples/VirtualRouterPeeringList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualRouter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualRouterPropertiesFormat", + "description": "Properties of the Virtual Router." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualRouter Resource." + }, + "VirtualRouterPropertiesFormat": { + "properties": { + "virtualRouterAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "VirtualRouter ASN." + }, + "virtualRouterIps": { + "type": "array", + "readOnly": false, + "description": "VirtualRouter IPs.", + "items": { + "type": "string" + } + }, + "hostedSubnet": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Subnet on which VirtualRouter is hosted." + }, + "hostedGateway": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Gateway on which VirtualRouter is hosted." + }, + "peerings": { + "type": "array", + "readOnly": true, + "description": "List of references to VirtualRouterPeerings.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Virtual Router definition." + }, + "VirtualRouterPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualRouterPeeringProperties", + "description": "The properties of the Virtual Router Peering." + }, + "name": { + "type": "string", + "description": "Name of the virtual router peering that is unique within a virtual router." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Peering type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Virtual Router Peering resource." + }, + "VirtualRouterPeeringProperties": { + "properties": { + "peerAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Peer ASN." + }, + "peerIp": { + "type": "string", + "readOnly": false, + "description": "Peer IP." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the rule group." + }, + "VirtualRouterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualRouter" + }, + "description": "List of Virtual Routers." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListVirtualRouters API service call." + }, + "VirtualRouterPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualRouterPeering" + }, + "description": "List of VirtualRouterPeerings in a VirtualRouter." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListVirtualRouterPeerings API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualWan.json new file mode 100644 index 000000000000..841d5b9ea4ed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualWan.json @@ -0,0 +1,9723 @@ +{ + "swagger": "2.0", + "info": { + "title": "VirtualWANAsAServiceManagementClient", + "description": "REST API for Azure VirtualWAN As a Service.", + "version": "2024-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}": { + "get": { + "operationId": "VirtualWans_Get", + "x-ms-examples": { + "VirtualWANGet": { + "$ref": "./examples/VirtualWANGet.json" + } + }, + "description": "Retrieves the details of a VirtualWAN.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN retrieved.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualWans_CreateOrUpdate", + "x-ms-examples": { + "VirtualWANCreate": { + "$ref": "./examples/VirtualWANPut.json" + } + }, + "description": "Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "Parameters supplied to create or update VirtualWAN." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN created or updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualWAN resource.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualWans_UpdateTags", + "x-ms-examples": { + "VirtualWANUpdate": { + "$ref": "./examples/VirtualWANUpdateTags.json" + } + }, + "description": "Updates a VirtualWAN tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to Update VirtualWAN tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VirtualWans_Delete", + "x-ms-examples": { + "VirtualWANDelete": { + "$ref": "./examples/VirtualWANDelete.json" + } + }, + "description": "Deletes a VirtualWAN.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualWAN deleted." + }, + "202": { + "description": "Request received successfully. VirtualWAN deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualWANs exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWans_ListByResourceGroup", + "x-ms-examples": { + "VirtualWANListByResourceGroup": { + "$ref": "./examples/VirtualWANListByResourceGroup.json" + } + }, + "description": "Lists all the VirtualWANs in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWans_List", + "x-ms-examples": { + "VirtualWANList": { + "$ref": "./examples/VirtualWANList.json" + } + }, + "description": "Lists all the VirtualWANs in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}": { + "get": { + "operationId": "VpnSites_Get", + "x-ms-examples": { + "VpnSiteGet": { + "$ref": "./examples/VpnSiteGet.json" + } + }, + "description": "Retrieves the details of a VPN site.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite retrieved.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnSites_CreateOrUpdate", + "x-ms-examples": { + "VpnSiteCreate": { + "$ref": "./examples/VpnSitePut.json" + } + }, + "description": "Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnSite" + }, + "description": "Parameters supplied to create or update VpnSite." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VpnSites" + ], + "operationId": "VpnSites_UpdateTags", + "x-ms-examples": { + "VpnSiteUpdate": { + "$ref": "./examples/VpnSiteUpdateTags.json" + } + }, + "description": "Updates VpnSite tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VpnSite tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VpnSites_Delete", + "x-ms-examples": { + "VpnSiteDelete": { + "$ref": "./examples/VpnSiteDelete.json" + } + }, + "description": "Deletes a VpnSite.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VpnSite deleted." + }, + "202": { + "description": "Request received successfully. VpnSite deletion is in progress." + }, + "204": { + "description": "No VpnSites exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_ListByResourceGroup", + "x-ms-examples": { + "VpnSiteListByResourceGroup": { + "$ref": "./examples/VpnSiteListByResourceGroup.json" + } + }, + "description": "Lists all the vpnSites in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnSites in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName}": { + "get": { + "operationId": "VpnSiteLinks_Get", + "x-ms-examples": { + "VpnSiteGet": { + "$ref": "./examples/VpnSiteLinkGet.json" + } + }, + "description": "Retrieves the details of a VPN site link.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite." + }, + { + "name": "vpnSiteLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSiteLink being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSiteLink retrieved.", + "schema": { + "$ref": "#/definitions/VpnSiteLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks": { + "get": { + "operationId": "VpnSiteLinks_ListByVpnSite", + "x-ms-examples": { + "VpnSiteLinkListByVpnSite": { + "$ref": "./examples/VpnSiteLinkListByVpnSite.json" + } + }, + "description": "Lists all the vpnSiteLinks in a resource group for a vpn site.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnSites in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnSiteLinksResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_List", + "x-ms-examples": { + "VpnSiteList": { + "$ref": "./examples/VpnSiteList.json" + } + }, + "description": "Lists all the VpnSites in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnSites in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration": { + "post": { + "operationId": "VpnSitesConfiguration_Download", + "x-ms-examples": { + "VpnSitesConfigurationDownload": { + "$ref": "./examples/VpnSitesConfigurationDownload.json" + } + }, + "description": "Gives the sas-url to download the configurations for vpn-sites in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN for which configuration of all vpn-sites is needed." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetVpnSitesConfigurationRequest" + }, + "description": "Parameters supplied to download vpn-sites configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously. Follow the location header for sas-url to output blob." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders": { + "get": { + "operationId": "SupportedSecurityProviders", + "x-ms-examples": { + "supportedSecurityProviders": { + "$ref": "./examples/VirtualWanSupportedSecurityProviders.json" + } + }, + "description": "Gives the supported security providers for the virtual wan.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN for which supported security providers are needed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the object containing supported security providers.", + "schema": { + "$ref": "#/definitions/VirtualWanSecurityProviders" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}": { + "get": { + "operationId": "VpnServerConfigurations_Get", + "x-ms-examples": { + "VpnServerConfigurationGet": { + "$ref": "./examples/VpnServerConfigurationGet.json" + } + }, + "description": "Retrieves the details of a VpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration retrieved.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnServerConfigurations_CreateOrUpdate", + "x-ms-examples": { + "VpnServerConfigurationCreate": { + "$ref": "./examples/VpnServerConfigurationPut.json" + } + }, + "description": "Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnServerConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + }, + "description": "Parameters supplied to create or update VpnServerConfiguration." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnServerConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VpnServerConfigurations" + ], + "operationId": "VpnServerConfigurations_UpdateTags", + "x-ms-examples": { + "VpnServerConfigurationUpdate": { + "$ref": "./examples/VpnServerConfigurationUpdateTags.json" + } + }, + "description": "Updates VpnServerConfiguration tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnServerConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VpnServerConfiguration tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VpnServerConfigurations_Delete", + "x-ms-examples": { + "VpnServerConfigurationDelete": { + "$ref": "./examples/VpnServerConfigurationDelete.json" + } + }, + "description": "Deletes a VpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VpnServerConfiguration deleted." + }, + "202": { + "description": "Request received successfully. VpnServerConfiguration deletion is in progress." + }, + "204": { + "description": "No VpnServerConfigurations exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations": { + "get": { + "operationId": "VpnServerConfigurations_ListByResourceGroup", + "x-ms-examples": { + "VpnServerConfigurationListByResourceGroup": { + "$ref": "./examples/VpnServerConfigurationListByResourceGroup.json" + } + }, + "description": "Lists all the vpnServerConfigurations in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnServerConfigurations in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnServerConfigurationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName}": { + "put": { + "operationId": "ConfigurationPolicyGroups_CreateOrUpdate", + "x-ms-examples": { + "ConfigurationPolicyGroupPut": { + "$ref": "./examples/ConfigurationPolicyGroupPut.json" + } + }, + "description": "Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the ConfigurationPolicyGroup." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration." + }, + { + "name": "configurationPolicyGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ConfigurationPolicyGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnServerConfigurationPolicyGroupParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + }, + "description": "Parameters supplied to create or update a VpnServerConfiguration PolicyGroup." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration PolicyGroup created or updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + } + }, + "201": { + "description": "Request successful. Returns the details of the VpnServerConfiguration PolicyGroup retrieved.", + "schema": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "ConfigurationPolicyGroups_Delete", + "x-ms-examples": { + "ConfigurationPolicyGroupDelete": { + "$ref": "./examples/ConfigurationPolicyGroupDelete.json" + } + }, + "description": "Deletes a ConfigurationPolicyGroup.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the ConfigurationPolicyGroup." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration." + }, + { + "name": "configurationPolicyGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ConfigurationPolicyGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. ConfigurationPolicyGroup deleted." + }, + "202": { + "description": "Request received successfully. ConfigurationPolicyGroup deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No ConfigurationPolicyGroup exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "operationId": "ConfigurationPolicyGroups_Get", + "x-ms-examples": { + "ConfigurationPolicyGroupGet": { + "$ref": "./examples/ConfigurationPolicyGroupGet.json" + } + }, + "description": "Retrieves the details of a ConfigurationPolicyGroup.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration." + }, + { + "name": "configurationPolicyGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ConfigurationPolicyGroup being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the ConfigurationPolicyGroup retrieved.", + "schema": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups": { + "get": { + "operationId": "configurationPolicyGroups_ListByVpnServerConfiguration", + "x-ms-examples": { + "ConfigurationPolicyGroupListByVpnServerConfiguration": { + "$ref": "./examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json" + } + }, + "description": "Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnServerConfigurations in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnServerConfigurationPolicyGroupsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnServerConfigurations": { + "get": { + "operationId": "VpnServerConfigurations_List", + "x-ms-examples": { + "VpnServerConfigurationList": { + "$ref": "./examples/VpnServerConfigurationList.json" + } + }, + "description": "Lists all the VpnServerConfigurations in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnServerConfigurations in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnServerConfigurationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}": { + "get": { + "operationId": "VirtualHubs_Get", + "x-ms-examples": { + "VirtualHubGet": { + "$ref": "./examples/VirtualHubGet.json" + } + }, + "description": "Retrieves the details of a VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub retrieved.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualHubs_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubPut": { + "$ref": "./examples/VirtualHubPut.json" + } + }, + "description": "Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "Parameters supplied to create or update VirtualHub." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualHubs_UpdateTags", + "x-ms-examples": { + "VirtualHubUpdate": { + "$ref": "./examples/VirtualHubUpdateTags.json" + } + }, + "description": "Updates VirtualHub tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VirtualHub tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VirtualHubs_Delete", + "x-ms-examples": { + "VirtualHubDelete": { + "$ref": "./examples/VirtualHubDelete.json" + } + }, + "description": "Deletes a VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHub deleted." + }, + "202": { + "description": "Request received successfully. VirtualHub deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubs exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_ListByResourceGroup", + "x-ms-examples": { + "VirtualHubListByResourceGroup": { + "$ref": "./examples/VirtualHubListByResourceGroup.json" + } + }, + "description": "Lists all the VirtualHubs in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_List", + "x-ms-examples": { + "VirtualHubList": { + "$ref": "./examples/VirtualHubList.json" + } + }, + "description": "Lists all the VirtualHubs in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}": { + "get": { + "operationId": "RouteMaps_Get", + "x-ms-examples": { + "RouteMapGet": { + "$ref": "./examples/RouteMapGet.json" + } + }, + "description": "Retrieves the details of a RouteMap.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteMap's resource group." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub containing the RouteMap." + }, + { + "name": "routeMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteMap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteMap retrieved.", + "schema": { + "$ref": "#/definitions/RouteMap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "RouteMaps_CreateOrUpdate", + "x-ms-examples": { + "RouteMapPut": { + "$ref": "./examples/RouteMapPut.json" + } + }, + "description": "Creates a RouteMap if it doesn't exist else updates the existing one.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteMap's resource group." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub containing the RouteMap." + }, + { + "name": "routeMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteMap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "routeMapParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteMap" + }, + "description": "Parameters supplied to create or update a RouteMap." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteMap created or updated.", + "schema": { + "$ref": "#/definitions/RouteMap" + } + }, + "201": { + "description": "Request successful. Returns the details of the RouteMap retrieved.", + "schema": { + "$ref": "#/definitions/RouteMap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "RouteMaps_Delete", + "x-ms-examples": { + "RouteMapDelete": { + "$ref": "./examples/RouteMapDelete.json" + } + }, + "description": "Deletes a RouteMap.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteMap's resource group." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub containing the RouteMap." + }, + { + "name": "routeMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteMap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. RouteMap deleted." + }, + "202": { + "description": "Request received successfully. RouteMap deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No RouteMaps exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps": { + "get": { + "operationId": "RouteMaps_List", + "x-ms-examples": { + "RouteMapList": { + "$ref": "./examples/RouteMapList.json" + } + }, + "description": "Retrieves the details of all RouteMaps.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteMap's resource group'." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub containing the RouteMap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the RouteMaps for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListRouteMapsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}": { + "put": { + "operationId": "HubVirtualNetworkConnections_CreateOrUpdate", + "x-ms-examples": { + "HubVirtualNetworkConnectionPut": { + "$ref": "./examples/HubVirtualNetworkConnectionPut.json" + } + }, + "description": "Creates a hub virtual network connection if it doesn't exist else updates the existing one.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the HubVirtualNetworkConnection." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the HubVirtualNetworkConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "hubVirtualNetworkConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + }, + "description": "Parameters supplied to create or update a hub virtual network connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the hub virtual network connection created or updated.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "201": { + "description": "Request successful. Returns the details of the hub virtual network connection retrieved.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "HubVirtualNetworkConnections_Delete", + "x-ms-examples": { + "HubVirtualNetworkConnectionDelete": { + "$ref": "./examples/HubVirtualNetworkConnectionDelete.json" + } + }, + "description": "Deletes a HubVirtualNetworkConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the HubVirtualNetworkConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. HubVirtualNetworkConnection deleted." + }, + "202": { + "description": "Request received successfully. HubVirtualNetworkConnection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No HubVirtualNetworkConnection exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "operationId": "HubVirtualNetworkConnections_Get", + "x-ms-examples": { + "HubVirtualNetworkConnectionGet": { + "$ref": "./examples/HubVirtualNetworkConnectionGet.json" + } + }, + "description": "Retrieves the details of a HubVirtualNetworkConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the HubVirtualNetworkConnection retrieved.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections": { + "get": { + "operationId": "HubVirtualNetworkConnections_List", + "x-ms-examples": { + "HubVirtualNetworkConnectionList": { + "$ref": "./examples/HubVirtualNetworkConnectionList.json" + } + }, + "description": "Retrieves the details of all HubVirtualNetworkConnections.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the HubVirtualNetworkConnections for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListHubVirtualNetworkConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}": { + "get": { + "operationId": "VpnGateways_Get", + "x-ms-examples": { + "VpnGatewayGet": { + "$ref": "./examples/VpnGatewayGet.json" + } + }, + "description": "Retrieves the details of a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnGateways_CreateOrUpdate", + "x-ms-examples": { + "VpnGatewayPut": { + "$ref": "./examples/VpnGatewayPut.json" + } + }, + "description": "Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "Parameters supplied to create or Update a virtual wan vpn gateway." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn Gateway created or updated.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "201": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_UpdateTags", + "x-ms-examples": { + "VpnGatewayUpdate": { + "$ref": "./examples/VpnGatewayUpdateTags.json" + } + }, + "description": "Updates virtual wan vpn gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan vpn gateway tags." + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VpnGateways_Delete", + "x-ms-examples": { + "VpnGatewayDelete": { + "$ref": "./examples/VpnGatewayDelete.json" + } + }, + "description": "Deletes a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Gateway deleted." + }, + "202": { + "description": "Request received successfully. Vpn Gateway deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn gateways exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset": { + "post": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_Reset", + "description": "Resets the primary of the vpn gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "ipConfigurationId", + "in": "query", + "required": false, + "type": "string", + "description": "VpnGateway ipConfigurationId to specify the gateway instance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reset the primary of the VpnGateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVpnGateway": { + "$ref": "./examples/VpnGatewayReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/startpacketcapture": { + "post": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_StartPacketCapture", + "description": "Starts packet capture on vpn gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnGatewayPacketCaptureStartParameters" + }, + "description": "Vpn gateway packet capture parameters supplied to start packet capture on vpn gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation packet capture started on vpn gateway.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Start packet capture on vpn gateway without filter": { + "$ref": "./examples/VpnGatewayStartPacketCapture.json" + }, + "Start packet capture on vpn gateway with filter": { + "$ref": "./examples/VpnGatewayStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/stoppacketcapture": { + "post": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_StopPacketCapture", + "description": "Stops packet capture on vpn gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnGatewayPacketCaptureStopParameters" + }, + "description": "Vpn gateway packet capture parameters supplied to stop packet capture on vpn gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation packet capture stopped on vpn gateway.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Stop packet capture on vpn gateway": { + "$ref": "./examples/VpnGatewayStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/resetconnection": { + "post": { + "tags": [ + "vpnLinkConnections" + ], + "operationId": "VpnLinkConnections_ResetConnection", + "description": "Resets the VpnLink connection specified.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn link connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation ResetConnection will complete asynchronously." + }, + "default": { + "description": "The operation ResetConnection could not be completed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ResetVpnLinkConnection": { + "$ref": "./examples/VpnSiteLinkConnectionReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_ListByResourceGroup", + "x-ms-examples": { + "VpnGatewayListByResourceGroup": { + "$ref": "./examples/VpnGatewayListByResourceGroup.json" + } + }, + "description": "Lists all the VpnGateways in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_List", + "x-ms-examples": { + "VpnGatewayListBySubscription": { + "$ref": "./examples/VpnGatewayList.json" + } + }, + "description": "Lists all the VpnGateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}": { + "get": { + "operationId": "VpnConnections_Get", + "x-ms-examples": { + "VpnConnectionGet": { + "$ref": "./examples/VpnConnectionGet.json" + } + }, + "description": "Retrieves the details of a vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnConnections_CreateOrUpdate", + "x-ms-examples": { + "VpnConnectionPut": { + "$ref": "./examples/VpnConnectionPut.json" + } + }, + "description": "Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "Parameters supplied to create or Update a VPN Connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "201": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VpnConnections_Delete", + "x-ms-examples": { + "VpnConnectionDelete": { + "$ref": "./examples/VpnConnectionDelete.json" + } + }, + "description": "Deletes a vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Connection deleted." + }, + "202": { + "description": "Request received successfully. Vpn Connection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn connections exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}": { + "get": { + "operationId": "VpnSiteLinkConnections_Get", + "x-ms-examples": { + "VpnSiteLinkConnectionGet": { + "$ref": "./examples/VpnSiteLinkConnectionGet.json" + } + }, + "description": "Retrieves the details of a vpn site link connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection.", + "schema": { + "$ref": "#/definitions/VpnSiteLinkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/getikesas": { + "post": { + "operationId": "VpnLinkConnections_GetIkeSas", + "x-ms-examples": { + "GetVpnLinkConnectionIkeSa": { + "$ref": "./examples/VpnSiteLinkConnectionGetIkeSas.json" + } + }, + "description": "Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn link connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation GetIkeSas will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation getikesas completed on vpn site link connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "The operation GetIkeSas could not be completed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/startpacketcapture": { + "post": { + "operationId": "VpnConnections_StartPacketCapture", + "description": "Starts packet capture on Vpn connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "vpnConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnConnectionPacketCaptureStartParameters" + }, + "description": "Vpn Connection packet capture parameters supplied to start packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture started on vpn connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Start packet capture on vpn connection without filter": { + "$ref": "./examples/VpnConnectionStartPacketCapture.json" + }, + "Start packet capture on vpn connection with filter": { + "$ref": "./examples/VpnConnectionStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/stoppacketcapture": { + "post": { + "operationId": "VpnConnections_StopPacketCapture", + "description": "Stops packet capture on Vpn connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "vpnConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnConnectionPacketCaptureStopParameters" + }, + "description": "Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture stopped on vpn connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Start packet capture on vpn connection without filter": { + "$ref": "./examples/VpnConnectionStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections": { + "get": { + "operationId": "VpnConnections_ListByVpnGateway", + "x-ms-examples": { + "VpnConnectionList": { + "$ref": "./examples/VpnConnectionList.json" + } + }, + "description": "Retrieves all vpn connections for a particular virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections": { + "get": { + "operationId": "VpnLinkConnections_ListByVpnConnection", + "x-ms-examples": { + "VpnSiteLinkConnectionList": { + "$ref": "./examples/VpnSiteLinkConnectionList.json" + } + }, + "description": "Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the vpn gateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnSiteLinkConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}": { + "get": { + "operationId": "NatRules_Get", + "x-ms-examples": { + "NatRuleGet": { + "$ref": "./examples/NatRuleGet.json" + } + }, + "description": "Retrieves the details of a nat ruleGet.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the nat rule.", + "schema": { + "$ref": "#/definitions/VpnGatewayNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "NatRules_CreateOrUpdate", + "x-ms-examples": { + "NatRulePut": { + "$ref": "./examples/NatRulePut.json" + } + }, + "description": "Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "NatRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnGatewayNatRule" + }, + "description": "Parameters supplied to create or Update a Nat Rule." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the nat rule created or updated.", + "schema": { + "$ref": "#/definitions/VpnGatewayNatRule" + } + }, + "201": { + "description": "Request successful. Returns the details of the nat rule created or updated.", + "schema": { + "$ref": "#/definitions/VpnGatewayNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "NatRules_Delete", + "x-ms-examples": { + "NatRuleDelete": { + "$ref": "./examples/NatRuleDelete.json" + } + }, + "description": "Deletes a nat rule.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Nat Rule deleted." + }, + "202": { + "description": "Request received successfully. Nat Rule deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No nat rules exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules": { + "get": { + "operationId": "NatRules_ListByVpnGateway", + "x-ms-examples": { + "NatRuleList": { + "$ref": "./examples/NatRuleList.json" + } + }, + "description": "Retrieves all nat rules for a particular virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Nat rules for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnGatewayNatRulesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}": { + "get": { + "operationId": "P2sVpnGateways_Get", + "x-ms-examples": { + "P2SVpnGatewayGet": { + "$ref": "./examples/P2SVpnGatewayGet.json" + } + }, + "description": "Retrieves the details of a virtual wan p2s vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "P2sVpnGateways_CreateOrUpdate", + "x-ms-examples": { + "P2SVpnGatewayPut": { + "$ref": "./examples/P2SVpnGatewayPut.json" + } + }, + "description": "Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "p2SVpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "Parameters supplied to create or Update a virtual wan p2s vpn gateway." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn Gateway created or updated.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "201": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_UpdateTags", + "x-ms-examples": { + "P2SVpnGatewayUpdate": { + "$ref": "./examples/P2SVpnGatewayUpdateTags.json" + } + }, + "description": "Updates virtual wan p2s vpn gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "p2SVpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan p2s vpn gateway tags." + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "P2sVpnGateways_Delete", + "x-ms-examples": { + "P2SVpnGatewayDelete": { + "$ref": "./examples/P2SVpnGatewayDelete.json" + } + }, + "description": "Deletes a virtual wan p2s vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. P2SVpnGateway deleted." + }, + "202": { + "description": "Request received successfully. P2SVpnGateway deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No p2s vpn gateways exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways": { + "get": { + "operationId": "P2sVpnGateways_ListByResourceGroup", + "x-ms-examples": { + "P2SVpnGatewayListByResourceGroup": { + "$ref": "./examples/P2SVpnGatewayListByResourceGroup.json" + } + }, + "description": "Lists all the P2SVpnGateways in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the P2SVpnGateways in the resource group.", + "schema": { + "$ref": "#/definitions/ListP2SVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways": { + "get": { + "operationId": "P2sVpnGateways_List", + "x-ms-examples": { + "P2SVpnGatewayListBySubscription": { + "$ref": "./examples/P2SVpnGatewayList.json" + } + }, + "description": "Lists all the P2SVpnGateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the P2SVpnGateways in the subscription.", + "schema": { + "$ref": "#/definitions/ListP2SVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/reset": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2SVpnGateways_Reset", + "description": "Resets the primary of the p2s vpn gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reset the primary of the P2SVpnGateway.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetP2SVpnGateway": { + "$ref": "./examples/P2SVpnGatewayReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GenerateVpnProfile", + "description": "Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnProfileParameters" + }, + "description": "Parameters supplied to the generate P2SVpnGateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "$ref": "#/definitions/VpnProfileResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateP2SVpnGatewayVPNProfile": { + "$ref": "./examples/P2SVpnGatewayGenerateVpnProfile.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GetP2sVpnConnectionHealth", + "description": "Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "P2S Vpn Gateway with P2S connection health details.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "P2SVpnGatewayGetConnectionHealth": { + "$ref": "./examples/P2SVpnGatewayGetConnectionHealth.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealthDetailed": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GetP2sVpnConnectionHealthDetailed", + "description": "Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnConnectionHealthRequest" + }, + "description": "Request parameters supplied to get p2s vpn connections detailed health." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "P2S connections detailed health report.", + "schema": { + "$ref": "#/definitions/P2SVpnConnectionHealth" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "P2SVpnGatewayGetConnectionHealthDetailed": { + "$ref": "./examples/P2SVpnGatewayGetConnectionHealthDetailed.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnServerConfigurations": { + "post": { + "operationId": "VpnServerConfigurationsAssociatedWithVirtualWan_List", + "x-ms-examples": { + "GetVirtualWanVpnServerConfigurations": { + "$ref": "./examples/GetVirtualWanVpnServerConfigurations.json" + } + }, + "description": "Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN whose associated VpnServerConfigurations is needed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of associated VpnServerConfigurations list.", + "schema": { + "$ref": "#/definitions/VpnServerConfigurationsResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously. Follow the location header for list of associated VpnServerConfigurations list." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/GenerateVpnProfile": { + "post": { + "operationId": "generatevirtualwanvpnserverconfigurationvpnprofile", + "x-ms-examples": { + "GenerateVirtualWanVpnServerConfigurationVpnProfile": { + "$ref": "./examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json" + } + }, + "description": "Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN whose associated VpnServerConfigurations is needed." + }, + { + "name": "vpnClientParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualWanVpnProfileParameters" + }, + "description": "Parameters supplied to the generate VirtualWan VPN profile generation operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "$ref": "#/definitions/VpnProfileResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}": { + "get": { + "operationId": "VirtualHubRouteTableV2s_Get", + "x-ms-examples": { + "VirtualHubVirtualHubRouteTableV2Get": { + "$ref": "./examples/VirtualHubRouteTableV2Get.json" + } + }, + "description": "Retrieves the details of a VirtualHubRouteTableV2.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubRouteTableV2." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHubRouteTableV2." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHubRouteTableV2 retrieved.", + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VirtualHubRouteTableV2s_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubRouteTableV2Put": { + "$ref": "./examples/VirtualHubRouteTableV2Put.json" + } + }, + "description": "Creates a VirtualHubRouteTableV2 resource if it doesn't exist else updates the existing VirtualHubRouteTableV2.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHubRouteTableV2." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubRouteTableV2Parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + }, + "description": "Parameters supplied to create or update VirtualHubRouteTableV2." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHubRouteTableV2 created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHubRouteTableV2 created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualHubRouteTableV2s_Delete", + "x-ms-examples": { + "VirtualHubRouteTableV2Delete": { + "$ref": "./examples/VirtualHubRouteTableV2Delete.json" + } + }, + "description": "Deletes a VirtualHubRouteTableV2.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubRouteTableV2." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHubRouteTableV2." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHubRouteTableV2 deleted." + }, + "202": { + "description": "Request received successfully. VirtualHubRouteTableV2 deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubRouteTableV2s exist by the name provided." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables": { + "get": { + "operationId": "VirtualHubRouteTableV2s_List", + "x-ms-examples": { + "VirtualHubRouteTableV2List": { + "$ref": "./examples/VirtualHubRouteTableV2List.json" + } + }, + "description": "Retrieves the details of all VirtualHubRouteTableV2s.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubRouteTableV2s for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListVirtualHubRouteTableV2sResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{p2sVpnGatewayName}/disconnectP2sVpnConnections": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_DisconnectP2sVpnConnections", + "description": "Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "p2sVpnGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2S Vpn Gateway." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnConnectionRequest" + }, + "description": "The parameters are supplied to disconnect p2s vpn connections." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation disconnects the requested vpn connections." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Disconnect VpnConnections from P2sVpn Gateway": { + "$ref": "./examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteGateways": { + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_ListBySubscription", + "x-ms-examples": { + "ExpressRouteGatewayListBySubscription": { + "$ref": "./examples/ExpressRouteGatewayListBySubscription.json" + } + }, + "description": "Lists ExpressRoute gateways under a given subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteGatewayList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways": { + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_ListByResourceGroup", + "x-ms-examples": { + "ExpressRouteGatewayListByResourceGroup": { + "$ref": "./examples/ExpressRouteGatewayListByResourceGroup.json" + } + }, + "description": "Lists ExpressRoute gateways in a given resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteGatewayList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}": { + "put": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_CreateOrUpdate", + "x-ms-examples": { + "ExpressRouteGatewayCreate": { + "$ref": "./examples/ExpressRouteGatewayCreate.json" + } + }, + "description": "Creates or updates a ExpressRoute gateway in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "putExpressRouteGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + }, + "description": "Parameters required in an ExpressRoute gateway PUT operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoute gateway resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoute gateway resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_UpdateTags", + "x-ms-examples": { + "ExpressRouteGatewayUpdate": { + "$ref": "./examples/ExpressRouteGatewayUpdateTags.json" + } + }, + "description": "Updates express route gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the ExpressRouteGateway." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "expressRouteGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan express route gateway tags." + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_Get", + "x-ms-examples": { + "ExpressRouteGatewayGet": { + "$ref": "./examples/ExpressRouteGatewayGet.json" + } + }, + "description": "Fetches the details of a ExpressRoute gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation succeeded. The operation returns the ExpressRoute gateway.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_Delete", + "x-ms-examples": { + "ExpressRouteGatewayDelete": { + "$ref": "./examples/ExpressRouteGatewayDelete.json" + } + }, + "description": "Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}": { + "put": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_CreateOrUpdate", + "x-ms-examples": { + "ExpressRouteConnectionCreate": { + "$ref": "./examples/ExpressRouteConnectionCreate.json" + } + }, + "description": "Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection subresource." + }, + { + "name": "putExpressRouteConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + }, + "description": "Parameters required in an ExpressRouteConnection PUT operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_Get", + "x-ms-examples": { + "ExpressRouteConnectionGet": { + "$ref": "./examples/ExpressRouteConnectionGet.json" + } + }, + "description": "Gets the specified ExpressRouteConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_Delete", + "x-ms-examples": { + "ExpressRouteConnectionDelete": { + "$ref": "./examples/ExpressRouteConnectionDelete.json" + } + }, + "description": "Deletes a connection to a ExpressRoute circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection subresource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted, and the operation will continue asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections": { + "get": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_List", + "x-ms-examples": { + "ExpressRouteConnectionList": { + "$ref": "./examples/ExpressRouteConnectionList.json" + } + }, + "description": "Lists ExpressRouteConnections.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName}": { + "put": { + "operationId": "NetworkVirtualApplianceConnections_CreateOrUpdate", + "x-ms-examples": { + "NetworkVirtualApplianceConnectionPut": { + "$ref": "./examples/NetworkVirtualApplianceConnectionPut.json" + } + }, + "description": "Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection'", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_]+", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_]+", + "description": "The name of the NVA connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "NetworkVirtualApplianceConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + }, + "description": "Parameters supplied in an NetworkVirtualApplianceConnection PUT operation." + } + ], + "responses": { + "200": { + "description": "Update successful. Returns the details of the NVA connection created or updated.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + } + }, + "201": { + "description": "Create successful. Returns the details of the NVA connection created or updated.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "NetworkVirtualApplianceConnections_Get", + "x-ms-examples": { + "NetworkVirtualApplianceConnectionGet": { + "$ref": "./examples/NetworkVirtualApplianceConnectionGet.json" + } + }, + "description": "Retrieves the details of specified NVA connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NVA connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the NVA connection", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "NetworkVirtualApplianceConnections_Delete", + "x-ms-examples": { + "NetworkVirtualApplianceConnectionDelete": { + "$ref": "./examples/NetworkVirtualApplianceConnectionDelete.json" + } + }, + "description": "Deletes a NVA connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NVA connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful.NVA Connection deleted." + }, + "202": { + "description": "Accepted, and the operation will continue asynchronously.", + "headers": { + "location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "No NVA connections exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections": { + "get": { + "operationId": "NetworkVirtualApplianceConnections_List", + "x-ms-examples": { + "NetworkVirtualApplianceConnectionList": { + "$ref": "./examples/NetworkVirtualApplianceConnectionList.json" + } + }, + "description": "Lists NetworkVirtualApplianceConnections under the NVA.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_]+", + "description": "The name of the Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Lists all the NVA connections under an NVA.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}": { + "get": { + "operationId": "VirtualHubBgpConnection_Get", + "x-ms-examples": { + "VirtualHubVirtualHubRouteTableV2Get": { + "$ref": "./examples/VirtualHubBgpConnectionGet.json" + } + }, + "description": "Retrieves the details of a Virtual Hub Bgp Connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the Bgp Connection retrieved.", + "schema": { + "$ref": "#/definitions/BgpConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualHubBgpConnection_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubRouteTableV2Put": { + "$ref": "./examples/VirtualHubBgpConnectionPut.json" + } + }, + "description": "Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BgpConnection" + }, + "description": "Parameters of Bgp connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the BgpConnection created or updated.", + "schema": { + "$ref": "#/definitions/BgpConnection" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the BgpConnection created or updated.", + "schema": { + "$ref": "#/definitions/BgpConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualHubBgpConnection_Delete", + "x-ms-examples": { + "VirtualHubRouteTableV2Delete": { + "$ref": "./examples/VirtualHubBgpConnectionDelete.json" + } + }, + "description": "Deletes a VirtualHubBgpConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubBgpConnection." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHubBgpConnection deleted." + }, + "202": { + "description": "Request received successfully. VirtualHubBgpConnection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubBgpConnection exist by the name provided." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections": { + "get": { + "operationId": "VirtualHubBgpConnections_List", + "x-ms-examples": { + "VirtualHubRouteTableV2List": { + "$ref": "./examples/VirtualHubBgpConnectionList.json" + } + }, + "description": "Retrieves the details of all VirtualHubBgpConnections.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubBgpConnections for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListVirtualHubBgpConnectionResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/learnedRoutes": { + "post": { + "operationId": "VirtualHubBgpConnections_ListLearnedRoutes", + "description": "Retrieves a list of routes the virtual hub bgp connection has learned.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual hub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual hub bgp connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of advertised BGP routes.", + "schema": { + "$ref": "#/definitions/PeerRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualRouterPeerListLearnedRoutes": { + "$ref": "./examples/VirtualRouterPeerListLearnedRoute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/advertisedRoutes": { + "post": { + "operationId": "VirtualHubBgpConnections_ListAdvertisedRoutes", + "description": "Retrieves a list of routes the virtual hub bgp connection is advertising to the specified peer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual hub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual hub bgp connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of learned BGP routes.", + "schema": { + "$ref": "#/definitions/PeerRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualRouterPeerListAdvertisedRoutes": { + "$ref": "./examples/VirtualRouterPeerListAdvertisedRoute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}": { + "get": { + "operationId": "VirtualHubIpConfiguration_Get", + "x-ms-examples": { + "VirtualHubVirtualHubRouteTableV2Get": { + "$ref": "./examples/VirtualHubIpConfigurationGet.json" + } + }, + "description": "Retrieves the details of a Virtual Hub Ip configuration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "ipConfigName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipconfig." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the Bgp Connection retrieved.", + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualHubIpConfiguration_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubIpConfigurationPut": { + "$ref": "./examples/VirtualHubIpConfigurationPut.json" + } + }, + "description": "Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "ipConfigName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipconfig." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + }, + "description": "Hub Ip Configuration parameters." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the IpConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the IpConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualHubIpConfiguration_Delete", + "x-ms-examples": { + "VirtualHubIpConfigurationDelete": { + "$ref": "./examples/VirtualHubIpConfigurationDelete.json" + } + }, + "description": "Deletes a VirtualHubIpConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubBgpConnection." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "ipConfigName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipconfig." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHubIpConfiguration deleted." + }, + "202": { + "description": "Request received successfully. VirtualHubIpConfiguration deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubIpConfiguration exist by the name provided." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations": { + "get": { + "operationId": "VirtualHubIpConfiguration_List", + "x-ms-examples": { + "VirtualHubRouteTableV2List": { + "$ref": "./examples/VirtualHubIpConfigurationList.json" + } + }, + "description": "Retrieves the details of all VirtualHubIpConfigurations.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubIpConfigurations for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListVirtualHubIpConfigurationResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}": { + "put": { + "operationId": "HubRouteTables_CreateOrUpdate", + "x-ms-examples": { + "RouteTablePut": { + "$ref": "./examples/HubRouteTablePut.json" + } + }, + "description": "Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteTable." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "routeTableParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HubRouteTable" + }, + "description": "Parameters supplied to create or update RouteTable." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteTable created or updated.", + "schema": { + "$ref": "#/definitions/HubRouteTable" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the RouteTable created or updated.", + "schema": { + "$ref": "#/definitions/HubRouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "HubRouteTables_Get", + "x-ms-examples": { + "RouteTableGet": { + "$ref": "./examples/HubRouteTableGet.json" + } + }, + "description": "Retrieves the details of a RouteTable.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteTable." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteTable retrieved.", + "schema": { + "$ref": "#/definitions/HubRouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "HubRouteTables_Delete", + "x-ms-examples": { + "RouteTableDelete": { + "$ref": "./examples/HubRouteTableDelete.json" + } + }, + "description": "Deletes a RouteTable.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteTable." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteTable." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. RouteTable deleted." + }, + "202": { + "description": "Request received successfully. RouteTable deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No RouteTables exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables": { + "get": { + "operationId": "HubRouteTables_List", + "x-ms-examples": { + "RouteTableList": { + "$ref": "./examples/HubRouteTableList.json" + } + }, + "description": "Retrieves the details of all RouteTables.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the RouteTables for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListHubRouteTablesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/effectiveRoutes": { + "post": { + "operationId": "VirtualHubs_GetEffectiveVirtualHubRoutes", + "x-ms-examples": { + "Effective Routes for the Virtual Hub": { + "$ref": "./examples/EffectiveRoutesListForVirtualHub.json" + }, + "Effective Routes for a Route Table resource": { + "$ref": "./examples/EffectiveRoutesListForRouteTable.json" + }, + "Effective Routes for a Connection resource": { + "$ref": "./examples/EffectiveRoutesListForConnection.json" + } + }, + "description": "Gets the effective routes configured for the Virtual Hub resource or the specified resource .", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "effectiveRoutesParameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EffectiveRoutesParameters" + }, + "description": "Parameters supplied to get the effective routes for a specific resource." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the list of the effective routes or follow the location header for the effective routes list.", + "schema": { + "$ref": "#/definitions/VirtualHubEffectiveRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/inboundRoutes": { + "post": { + "operationId": "VirtualHubs_GetInboundRoutes", + "x-ms-examples": { + "Inbound Routes for the Virtual Hub on a Particular Connection": { + "$ref": "./examples/GetInboundRoutes.json" + } + }, + "description": "Gets the inbound routes configured for the Virtual Hub on a particular connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "getInboundRoutesParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetInboundRoutesParameters" + }, + "description": "Parameters supplied to get the inbound routes for a connection resource." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the list of the effective route map routes or follow the location header for the inbound routes list.", + "schema": { + "$ref": "#/definitions/EffectiveRouteMapRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/outboundRoutes": { + "post": { + "operationId": "VirtualHubs_GetOutboundRoutes", + "x-ms-examples": { + "Outbound Routes for the Virtual Hub on a Particular Connection": { + "$ref": "./examples/GetOutboundRoutes.json" + } + }, + "description": "Gets the outbound routes configured for the Virtual Hub on a particular connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "getOutboundRoutesParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetOutboundRoutesParameters" + }, + "description": "Parameters supplied to get the outbound routes for a connection resource." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the list of the effective route map routes or follow the location header for the outbound routes list.", + "schema": { + "$ref": "#/definitions/EffectiveRouteMapRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName}": { + "put": { + "operationId": "RoutingIntent_CreateOrUpdate", + "x-ms-examples": { + "RouteTablePut": { + "$ref": "./examples/RoutingIntentPut.json" + } + }, + "description": "Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RoutingIntent." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routingIntentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the per VirtualHub singleton Routing Intent resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "routingIntentParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoutingIntent" + }, + "description": "Parameters supplied to create or update RoutingIntent." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RoutingIntent created or updated.", + "schema": { + "$ref": "#/definitions/RoutingIntent" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the RoutingIntent created or updated.", + "schema": { + "$ref": "#/definitions/RoutingIntent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "RoutingIntent_Get", + "x-ms-examples": { + "RouteTableGet": { + "$ref": "./examples/RoutingIntentGet.json" + } + }, + "description": "Retrieves the details of a RoutingIntent.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RoutingIntent." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routingIntentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RoutingIntent." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RoutingIntent retrieved.", + "schema": { + "$ref": "#/definitions/RoutingIntent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "RoutingIntent_Delete", + "x-ms-examples": { + "RouteTableDelete": { + "$ref": "./examples/RoutingIntentDelete.json" + } + }, + "description": "Deletes a RoutingIntent.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RoutingIntent." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routingIntentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RoutingIntent." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. RoutingIntent deleted." + }, + "202": { + "description": "Request received successfully. RoutingIntent deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No RoutingIntent exists by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent": { + "get": { + "operationId": "RoutingIntent_List", + "x-ms-examples": { + "RoutingIntentList": { + "$ref": "./examples/RoutingIntentList.json" + } + }, + "description": "Retrieves the details of all RoutingIntent child resources of the VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the RoutingIntent resources for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListRoutingIntentResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualWanProperties": { + "properties": { + "disableVpnEncryption": { + "type": "boolean", + "description": "Vpn encryption to be disabled or not." + }, + "virtualHubs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of VirtualHubs in the VirtualWAN." + }, + "vpnSites": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of VpnSites in the VirtualWAN." + }, + "allowBranchToBranchTraffic": { + "type": "boolean", + "description": "True if branch to branch traffic is allowed." + }, + "allowVnetToVnetTraffic": { + "type": "boolean", + "description": "True if Vnet to Vnet traffic is allowed." + }, + "office365LocalBreakoutCategory": { + "description": "The office local breakout category.", + "$ref": "#/definitions/OfficeTrafficCategory" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual WAN resource." + }, + "type": { + "type": "string", + "description": "The type of the VirtualWAN." + } + }, + "description": "Parameters for VirtualWAN." + }, + "VirtualWAN": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualWanProperties", + "description": "Properties of the virtual WAN." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualWAN Resource." + }, + "ListVirtualWANsResult": { + "description": "Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "List of VirtualWANs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteProperties": { + "properties": { + "virtualWan": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the vpnSite belongs." + }, + "deviceProperties": { + "description": "The device properties.", + "$ref": "#/definitions/DeviceProperties" + }, + "ipAddress": { + "type": "string", + "description": "The ip-address for the vpn-site." + }, + "siteKey": { + "type": "string", + "description": "The key for vpn-site that can be used for connections." + }, + "addressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges." + }, + "bgpProperties": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "The set of bgp properties." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN site resource." + }, + "isSecuritySite": { + "type": "boolean", + "description": "IsSecuritySite flag." + }, + "vpnSiteLinks": { + "type": "array", + "description": "List of all vpn site links.", + "items": { + "$ref": "#/definitions/VpnSiteLink" + } + }, + "o365Policy": { + "readOnly": false, + "description": "Office365 Policy.", + "$ref": "#/definitions/O365PolicyProperties" + } + }, + "description": "Parameters for VpnSite." + }, + "VpnSite": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteProperties", + "description": "Properties of the VPN site." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnSite Resource." + }, + "ListVpnSitesResult": { + "description": "Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSite" + }, + "description": "List of VpnSites." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteLinkProperties": { + "properties": { + "linkProperties": { + "description": "The link provider properties.", + "$ref": "#/definitions/VpnLinkProviderProperties" + }, + "ipAddress": { + "type": "string", + "description": "The ip-address for the vpn-site-link." + }, + "fqdn": { + "type": "string", + "description": "FQDN of vpn-site-link." + }, + "bgpProperties": { + "$ref": "#/definitions/VpnLinkBgpSettings", + "description": "The set of bgp properties." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN site link resource." + } + }, + "description": "Parameters for VpnSite." + }, + "VpnSiteLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteLinkProperties", + "description": "Properties of the VPN site link." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnSiteLink Resource." + }, + "ListVpnSiteLinksResult": { + "description": "Result of the request to list VpnSiteLinks. It contains a list of VpnSiteLinks and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSiteLink" + }, + "description": "List of VpnSitesLinks." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "GetVpnSitesConfigurationRequest": { + "properties": { + "vpnSites": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of resource-ids of the vpn-sites for which config is to be downloaded." + }, + "outputBlobSasUrl": { + "type": "string", + "description": "The sas-url to download the configurations for vpn-sites." + } + }, + "required": [ + "outputBlobSasUrl" + ], + "description": "List of Vpn-Sites." + }, + "VirtualHubProperties": { + "properties": { + "virtualWan": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the VirtualHub belongs." + }, + "vpnGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VpnGateway associated with this VirtualHub." + }, + "p2SVpnGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The P2SVpnGateway associated with this VirtualHub." + }, + "expressRouteGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The expressRouteGateway associated with this VirtualHub." + }, + "azureFirewall": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The azureFirewall associated with this VirtualHub." + }, + "securityPartnerProvider": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The securityPartnerProvider associated with this VirtualHub." + }, + "addressPrefix": { + "type": "string", + "description": "Address-prefix for this VirtualHub." + }, + "routeTable": { + "$ref": "#/definitions/VirtualHubRouteTable", + "description": "The routeTable associated with this virtual hub." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual hub resource." + }, + "securityProviderName": { + "type": "string", + "description": "The Security Provider name." + }, + "virtualHubRouteTableV2s": { + "type": "array", + "description": "List of all virtual hub route table v2s associated with this VirtualHub.", + "items": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "sku": { + "type": "string", + "description": "The sku of this VirtualHub." + }, + "routingState": { + "$ref": "#/definitions/RoutingState", + "description": "The routing state." + }, + "bgpConnections": { + "type": "array", + "readOnly": true, + "description": "List of references to Bgp Connections.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "ipConfigurations": { + "type": "array", + "readOnly": true, + "description": "List of references to IpConfigurations.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "routeMaps": { + "type": "array", + "readOnly": true, + "description": "List of references to RouteMaps.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "virtualRouterAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "VirtualRouter ASN." + }, + "virtualRouterIps": { + "type": "array", + "readOnly": false, + "description": "VirtualRouter IPs.", + "items": { + "type": "string" + } + }, + "allowBranchToBranchTraffic": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control transit for VirtualRouter hub." + }, + "preferredRoutingGateway": { + "$ref": "#/definitions/PreferredRoutingGateway", + "description": "The preferred gateway to route on-prem traffic" + }, + "hubRoutingPreference": { + "$ref": "#/definitions/HubRoutingPreference", + "description": "The hubRoutingPreference of this VirtualHub." + }, + "virtualRouterAutoScaleConfiguration": { + "$ref": "#/definitions/VirtualRouterAutoScaleConfiguration", + "description": "The VirtualHub Router autoscale configuration." + } + }, + "description": "Parameters for VirtualHub." + }, + "VirtualRouterAutoScaleConfiguration": { + "type": "object", + "properties": { + "minCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The minimum number of scale units for VirtualHub Router." + } + }, + "description": "The VirtualHub Router autoscale configuration." + }, + "PreferredRoutingGateway": { + "type": "string", + "description": "The preferred routing gateway types", + "enum": [ + "ExpressRoute", + "VpnGateway", + "None" + ], + "x-ms-enum": { + "name": "PreferredRoutingGateway", + "modelAsString": true + } + }, + "HubRoutingPreference": { + "type": "string", + "description": "The hub routing preference gateway types", + "enum": [ + "ExpressRoute", + "VpnGateway", + "ASPath" + ], + "x-ms-enum": { + "name": "HubRoutingPreference", + "modelAsString": true + } + }, + "RoutingState": { + "type": "string", + "description": "The current routing state of the VirtualHub.", + "readOnly": true, + "enum": [ + "None", + "Provisioned", + "Provisioning", + "Failed" + ], + "x-ms-enum": { + "name": "RoutingState", + "modelAsString": true + } + }, + "BgpConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BgpConnectionProperties", + "description": "The properties of the Bgp connections." + }, + "name": { + "type": "string", + "description": "Name of the connection." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Connection type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Virtual Appliance Site resource." + }, + "BgpConnectionProperties": { + "properties": { + "peerAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Peer ASN." + }, + "peerIp": { + "type": "string", + "readOnly": false, + "description": "Peer IP." + }, + "hubVirtualNetworkConnection": { + "description": "The reference to the HubVirtualNetworkConnection resource.", + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + }, + "connectionState": { + "type": "string", + "description": "The current state of the VirtualHub to Peer.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "HubBgpConnectionStatus", + "modelAsString": true + } + } + }, + "description": "Properties of the bgp connection." + }, + "PeerRoute": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The peer's local address." + }, + "network": { + "type": "string", + "readOnly": true, + "description": "The route's network prefix." + }, + "nextHop": { + "type": "string", + "readOnly": true, + "description": "The route's next hop." + }, + "sourcePeer": { + "type": "string", + "readOnly": true, + "description": "The peer this route was learned from." + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The source this route was learned from." + }, + "asPath": { + "type": "string", + "readOnly": true, + "description": "The route's AS path sequence." + }, + "weight": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The route's weight." + } + }, + "description": "Peer routing details." + }, + "PeerRouteList": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerRoute" + }, + "x-ms-identifiers": [], + "description": "List of peer routes." + }, + "description": "Map from virtual router instance to list of peer routes." + }, + "HubIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubIPConfigurationPropertiesFormat", + "description": "The properties of the Virtual Hub IPConfigurations." + }, + "name": { + "type": "string", + "description": "Name of the Ip Configuration." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Ipconfiguration type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IpConfigurations." + }, + "HubIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference to the public IP resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IP configuration resource." + } + }, + "description": "Properties of IP configuration." + }, + "VirtualHubRouteTable": { + "properties": { + "routes": { + "type": "array", + "description": "List of all routes.", + "items": { + "$ref": "#/definitions/VirtualHubRoute" + } + } + }, + "description": "VirtualHub route table." + }, + "VirtualHubRoute": { + "properties": { + "addressPrefixes": { + "type": "array", + "description": "List of all addressPrefixes.", + "items": { + "type": "string" + } + }, + "nextHopIpAddress": { + "type": "string", + "description": "NextHop ip address." + } + }, + "description": "VirtualHub route." + }, + "VirtualHub": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualHubProperties", + "description": "Properties of the virtual hub." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualHub Resource." + }, + "ListVirtualHubsResult": { + "description": "Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "List of VirtualHubs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnGatewayProperties": { + "properties": { + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualHub to which the gateway belongs." + }, + "connections": { + "type": "array", + "description": "List of all vpn connections to the gateway.", + "items": { + "$ref": "#/definitions/VpnConnection" + } + }, + "bgpSettings": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN gateway resource." + }, + "vpnGatewayScaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit for this vpn gateway." + }, + "ipConfigurations": { + "type": "array", + "readOnly": true, + "description": "List of all IPs configured on the gateway.", + "items": { + "$ref": "#/definitions/VpnGatewayIpConfiguration" + } + }, + "enableBgpRouteTranslationForNat": { + "type": "boolean", + "description": "Enable BGP routes translation for NAT on this VpnGateway." + }, + "isRoutingPreferenceInternet": { + "type": "boolean", + "description": "Enable Routing Preference property for the Public IP Interface of the VpnGateway." + }, + "natRules": { + "type": "array", + "description": "List of all the nat Rules associated with the gateway.", + "items": { + "$ref": "#/definitions/VpnGatewayNatRule" + } + } + }, + "description": "Parameters for VpnGateway." + }, + "VpnGateway": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnGatewayProperties", + "description": "Properties of the VPN gateway." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnGateway Resource." + }, + "VpnGatewayIpConfiguration": { + "description": "IP Configuration of a VPN Gateway Resource.", + "properties": { + "id": { + "type": "string", + "description": "The identifier of the IP configuration for a VPN Gateway." + }, + "publicIpAddress": { + "type": "string", + "description": "The public IP address of this IP configuration." + }, + "privateIpAddress": { + "type": "string", + "description": "The private IP address of this IP configuration." + } + } + }, + "ListVpnGatewaysResult": { + "description": "Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "List of VpnGateways." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnNatRuleMapping": { + "properties": { + "addressSpace": { + "type": "string", + "description": "Address space for Vpn NatRule mapping." + }, + "portRange": { + "type": "string", + "description": "Port range for Vpn NatRule mapping." + } + }, + "description": "Vpn NatRule mapping." + }, + "VpnGatewayNatRuleProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NAT Rule resource." + }, + "type": { + "type": "string", + "description": "The type of NAT rule for VPN NAT.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "VpnNatRuleType", + "modelAsString": true + } + }, + "mode": { + "type": "string", + "description": "The Source NAT direction of a VPN NAT.", + "enum": [ + "EgressSnat", + "IngressSnat" + ], + "x-ms-enum": { + "name": "VpnNatRuleMode", + "modelAsString": true + } + }, + "internalMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnNatRuleMapping" + }, + "description": "The private IP address internal mapping for NAT." + }, + "externalMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnNatRuleMapping" + }, + "description": "The private IP address external mapping for NAT." + }, + "ipConfigurationId": { + "type": "string", + "description": "The IP Configuration ID this NAT rule applies to." + }, + "egressVpnSiteLinkConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of egress VpnSiteLinkConnections." + }, + "ingressVpnSiteLinkConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of ingress VpnSiteLinkConnections." + } + }, + "description": "Parameters for VpnGatewayNatRule." + }, + "VpnGatewayNatRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnGatewayNatRuleProperties", + "description": "Properties of the VpnGateway NAT rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnGatewayNatRule Resource." + }, + "ListVpnGatewayNatRulesResult": { + "description": "Result of the request to list all nat rules to a virtual wan vpn gateway. It contains a list of Nat rules and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnGatewayNatRule" + }, + "description": "List of Nat Rules." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnConnectionProperties": { + "properties": { + "remoteVpnSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Id of the connected vpn site." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "Routing weight for vpn connection." + }, + "dpdTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "DPD timeout in seconds for vpn connection." + }, + "connectionStatus": { + "description": "The connection status.", + "$ref": "#/definitions/VpnConnectionStatus" + }, + "vpnConnectionProtocolType": { + "description": "Connection protocol used for this connection.", + "$ref": "./virtualNetworkGateway.json#/definitions/ConnectionProtocol" + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Ingress bytes transferred." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Egress bytes transferred." + }, + "connectionBandwidth": { + "type": "integer", + "format": "int32", + "description": "Expected bandwidth in MBPS." + }, + "sharedKey": { + "type": "string", + "description": "SharedKey for the vpn connection." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "trafficSelectorPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/TrafficSelectorPolicy" + }, + "description": "The Traffic Selector Policies to be considered by this connection." + }, + "enableRateLimiting": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "useLocalAzureIpAddress": { + "type": "boolean", + "description": "Use local azure ip to initiate connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN connection resource." + }, + "vpnLinkConnections": { + "type": "array", + "description": "List of all vpn site link connections to the gateway.", + "items": { + "$ref": "#/definitions/VpnSiteLinkConnection" + } + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + } + }, + "description": "Parameters for VpnConnection." + }, + "VpnConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnConnectionProperties", + "description": "Properties of the VPN connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnConnection Resource." + }, + "ListVpnConnectionsResult": { + "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "List of Vpn Connections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnConnectionPacketCaptureStartParameters": { + "description": "Vpn Connection packet capture parameters supplied to start packet capture on gateway connection.", + "properties": { + "filterData": { + "type": "string", + "description": "Start Packet capture parameters on vpn connection." + }, + "linkConnectionNames": { + "type": "array", + "description": "List of site link connection names.", + "items": { + "type": "string" + } + } + } + }, + "VpnConnectionPacketCaptureStopParameters": { + "description": "Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection.", + "properties": { + "sasUrl": { + "type": "string", + "description": "SAS url for packet capture on vpn connection." + }, + "linkConnectionNames": { + "type": "array", + "description": "List of site link connection names.", + "items": { + "type": "string" + } + } + } + }, + "VpnGatewayPacketCaptureStartParameters": { + "properties": { + "filterData": { + "type": "string", + "description": "Start Packet capture parameters on vpn gateway." + } + }, + "description": "Start packet capture parameters." + }, + "VpnGatewayPacketCaptureStopParameters": { + "properties": { + "sasUrl": { + "type": "string", + "description": "SAS url for packet capture on vpn gateway." + } + }, + "description": "Stop packet capture parameters." + }, + "VpnSiteLinkConnectionProperties": { + "properties": { + "vpnSiteLink": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Id of the connected vpn site link." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "Routing weight for vpn connection." + }, + "vpnLinkConnectionMode": { + "type": "string", + "description": "Vpn link connection mode.", + "enum": [ + "Default", + "ResponderOnly", + "InitiatorOnly" + ], + "x-ms-enum": { + "name": "VpnLinkConnectionMode", + "modelAsString": true + } + }, + "connectionStatus": { + "description": "The connection status.", + "$ref": "#/definitions/VpnConnectionStatus" + }, + "vpnConnectionProtocolType": { + "description": "Connection protocol used for this connection.", + "$ref": "./virtualNetworkGateway.json#/definitions/ConnectionProtocol" + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Ingress bytes transferred." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Egress bytes transferred." + }, + "connectionBandwidth": { + "type": "integer", + "format": "int32", + "description": "Expected bandwidth in MBPS." + }, + "sharedKey": { + "type": "string", + "description": "SharedKey for the vpn connection." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "vpnGatewayCustomBgpAddresses": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/GatewayCustomBgpIpAddressIpConfiguration" + }, + "description": "vpnGatewayCustomBgpAddresses used by this connection.", + "x-ms-identifiers": [] + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "enableRateLimiting": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "useLocalAzureIpAddress": { + "type": "boolean", + "description": "Use local azure ip to initiate connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN site link connection resource." + }, + "ingressNatRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of ingress NatRules." + }, + "egressNatRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of egress NatRules." + }, + "dpdTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "Dead Peer Detection timeout in seconds for VpnLink connection." + } + }, + "description": "Parameters for VpnConnection." + }, + "VpnSiteLinkConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteLinkConnectionProperties", + "description": "Properties of the VPN site link connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnSiteLinkConnection Resource." + }, + "ListVpnSiteLinkConnectionsResult": { + "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSiteLinkConnection" + }, + "description": "List of VpnSiteLinkConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "HubVirtualNetworkConnectionProperties": { + "properties": { + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the remote virtual network." + }, + "allowHubToRemoteVnetTransit": { + "type": "boolean", + "description": "Deprecated: VirtualHub to RemoteVnet transit to enabled or not." + }, + "allowRemoteVnetToUseHubVnetGateways": { + "type": "boolean", + "description": "Deprecated: Allow RemoteVnet to use Virtual Hub's gateways." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the hub virtual network connection resource." + } + }, + "description": "Parameters for HubVirtualNetworkConnection." + }, + "HubVirtualNetworkConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubVirtualNetworkConnectionProperties", + "description": "Properties of the hub virtual network connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "HubVirtualNetworkConnection Resource." + }, + "ListHubVirtualNetworkConnectionsResult": { + "description": "List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + }, + "description": "List of HubVirtualNetworkConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "HubRouteTableProperties": { + "properties": { + "routes": { + "type": "array", + "description": "List of all routes.", + "items": { + "$ref": "#/definitions/HubRoute" + } + }, + "labels": { + "type": "array", + "description": "List of labels associated with this route table.", + "items": { + "type": "string" + } + }, + "associatedConnections": { + "type": "array", + "description": "List of all connections associated with this route table.", + "readOnly": true, + "items": { + "type": "string" + } + }, + "propagatingConnections": { + "type": "array", + "description": "List of all connections that advertise to this route table.", + "readOnly": true, + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the RouteTable resource." + } + }, + "description": "Parameters for RouteTable." + }, + "HubRouteTable": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubRouteTableProperties", + "description": "Properties of the RouteTable resource." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "RouteTable resource in a virtual hub." + }, + "HubRoute": { + "required": [ + "name", + "destinationType", + "destinations", + "nextHopType", + "nextHop" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the Route that is unique within a RouteTable. This name can be used to access this route." + }, + "destinationType": { + "type": "string", + "description": "The type of destinations (eg: CIDR, ResourceId, Service)." + }, + "destinations": { + "type": "array", + "description": "List of all destinations.", + "items": { + "type": "string" + } + }, + "nextHopType": { + "type": "string", + "description": "The type of next hop (eg: ResourceId)." + }, + "nextHop": { + "type": "string", + "description": "NextHop resource ID." + } + }, + "description": "RouteTable route." + }, + "ListHubRouteTablesResult": { + "description": "List of RouteTables and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubRouteTable" + }, + "description": "List of RouteTables." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteId": { + "properties": { + "vpnSite": { + "type": "string", + "readOnly": true, + "description": "The resource-uri of the vpn-site for which config is to be fetched." + } + }, + "description": "VpnSite Resource." + }, + "DeviceProperties": { + "properties": { + "deviceVendor": { + "type": "string", + "description": "Name of the device Vendor." + }, + "deviceModel": { + "type": "string", + "description": "Model of the device." + }, + "linkSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Link speed." + } + }, + "description": "List of properties of the device." + }, + "VirtualWanSecurityProviders": { + "properties": { + "supportedProviders": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualWanSecurityProvider" + }, + "description": "List of VirtualWAN security providers." + } + }, + "description": "Collection of SecurityProviders." + }, + "VirtualWanSecurityProvider": { + "properties": { + "name": { + "type": "string", + "description": "Name of the security provider." + }, + "url": { + "type": "string", + "description": "Url of the security provider." + }, + "type": { + "$ref": "#/definitions/VirtualWanSecurityProviderType", + "description": "Name of the security provider." + } + }, + "description": "Collection of SecurityProviders." + }, + "VpnConnectionStatus": { + "type": "string", + "description": "The current state of the vpn connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VpnConnectionStatus", + "modelAsString": true + } + }, + "TunnelConnectionStatus": { + "type": "string", + "description": "The current state of the tunnel.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "TunnelConnectionStatus", + "modelAsString": true + } + }, + "HubVirtualNetworkConnectionStatus": { + "type": "string", + "description": "The current state of the VirtualHub to vnet connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "HubVirtualNetworkConnectionStatus", + "modelAsString": true + } + }, + "OfficeTrafficCategory": { + "type": "string", + "description": "The office traffic category.", + "readOnly": true, + "enum": [ + "Optimize", + "OptimizeAndAllow", + "All", + "None" + ], + "x-ms-enum": { + "name": "OfficeTrafficCategory", + "modelAsString": true + } + }, + "VirtualWanSecurityProviderType": { + "type": "string", + "description": "The virtual wan security provider type.", + "readOnly": true, + "enum": [ + "External", + "Native" + ], + "x-ms-enum": { + "name": "VirtualWanSecurityProviderType", + "modelAsString": true + } + }, + "VpnServerConfigVpnClientRootCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "publicCertData": { + "type": "string", + "description": "The certificate public data." + } + }, + "description": "Properties of VPN client root certificate of VpnServerConfiguration." + }, + "VpnServerConfigRadiusServerRootCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "publicCertData": { + "type": "string", + "description": "The certificate public data." + } + }, + "description": "Properties of Radius Server root certificate of VpnServerConfiguration." + }, + "VpnServerConfigVpnClientRevokedCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "thumbprint": { + "type": "string", + "description": "The revoked VPN client certificate thumbprint." + } + }, + "description": "Properties of the revoked VPN client certificate of VpnServerConfiguration." + }, + "VpnServerConfigRadiusClientRootCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "thumbprint": { + "type": "string", + "description": "The Radius client root certificate thumbprint." + } + }, + "description": "Properties of the Radius client root certificate of VpnServerConfiguration." + }, + "AadAuthenticationParameters": { + "properties": { + "aadTenant": { + "type": "string", + "description": "AAD Vpn authentication parameter AAD tenant." + }, + "aadAudience": { + "type": "string", + "description": "AAD Vpn authentication parameter AAD audience." + }, + "aadIssuer": { + "type": "string", + "description": "AAD Vpn authentication parameter AAD issuer." + } + }, + "description": "AAD Vpn authentication type related parameters." + }, + "VpnServerConfigurationProperties": { + "properties": { + "name": { + "type": "string", + "description": "The name of the VpnServerConfiguration that is unique within a resource group." + }, + "vpnProtocols": { + "type": "array", + "items": { + "type": "string", + "description": "VPN protocol enabled for the VpnServerConfiguration.", + "enum": [ + "IkeV2", + "OpenVPN" + ], + "x-ms-enum": { + "name": "VpnGatewayTunnelingProtocol", + "modelAsString": true + } + }, + "description": "VPN protocols for the VpnServerConfiguration." + }, + "vpnAuthenticationTypes": { + "type": "array", + "items": { + "type": "string", + "description": "VPN authentication types enabled for the VpnServerConfiguration.", + "enum": [ + "Certificate", + "Radius", + "AAD" + ], + "x-ms-enum": { + "name": "VpnAuthenticationType", + "modelAsString": true + } + }, + "description": "VPN authentication types for the VpnServerConfiguration." + }, + "vpnClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigVpnClientRootCertificate" + }, + "description": "VPN client root certificate of VpnServerConfiguration." + }, + "vpnClientRevokedCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigVpnClientRevokedCertificate" + }, + "description": "VPN client revoked certificate of VpnServerConfiguration." + }, + "radiusServerRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigRadiusServerRootCertificate" + }, + "description": "Radius Server root certificate of VpnServerConfiguration." + }, + "radiusClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigRadiusClientRootCertificate" + }, + "description": "Radius client root certificate of VpnServerConfiguration." + }, + "vpnClientIpsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "VpnClientIpsecPolicies for VpnServerConfiguration." + }, + "radiusServerAddress": { + "type": "string", + "description": "The radius server address property of the VpnServerConfiguration resource for point to site client connection." + }, + "radiusServerSecret": { + "type": "string", + "description": "The radius secret property of the VpnServerConfiguration resource for point to site client connection." + }, + "radiusServers": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/RadiusServer" + }, + "description": "Multiple Radius Server configuration for VpnServerConfiguration." + }, + "aadAuthenticationParameters": { + "$ref": "#/definitions/AadAuthenticationParameters", + "description": "The set of aad vpn authentication parameters." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "p2SVpnGateways": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "List of references to P2SVpnGateways." + }, + "configurationPolicyGroups": { + "type": "array", + "description": "List of all VpnServerConfigurationPolicyGroups.", + "items": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + } + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "Parameters for VpnServerConfiguration." + }, + "VpnServerConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnServerConfigurationProperties", + "description": "Properties of the P2SVpnServer configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnServerConfiguration Resource." + }, + "ListVpnServerConfigurationsResult": { + "description": "Result of the request to list all VpnServerConfigurations. It contains a list of VpnServerConfigurations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfiguration" + }, + "description": "List of VpnServerConfigurations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnClientConnectionHealth": { + "properties": { + "totalIngressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "Total of the Ingress Bytes Transferred in this P2S Vpn connection." + }, + "totalEgressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "Total of the Egress Bytes Transferred in this connection." + }, + "vpnClientConnectionsCount": { + "type": "integer", + "format": "int32", + "description": "The total of p2s vpn clients connected at this time to this P2SVpnGateway." + }, + "allocatedIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allocated ip addresses to the connected p2s vpn clients." + } + }, + "description": "VpnClientConnectionHealth properties." + }, + "VpnServerConfigurationPolicyGroupProperties": { + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "Shows if this is a Default VpnServerConfigurationPolicyGroup or not." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Priority for VpnServerConfigurationPolicyGroup." + }, + "policyMembers": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroupMember" + }, + "description": "Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.", + "x-ms-identifiers": [] + }, + "p2SConnectionConfigurations": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of references to P2SConnectionConfigurations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VpnServerConfigurationPolicyGroup resource." + } + }, + "description": "Parameters for VpnServerConfigurationPolicyGroup." + }, + "VpnServerConfigurationPolicyGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnServerConfigurationPolicyGroupProperties", + "description": "Properties of the VpnServerConfigurationPolicyGroup." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnServerConfigurationPolicyGroup Resource." + }, + "VpnServerConfigurationPolicyGroupMember": { + "properties": { + "name": { + "type": "string", + "description": "Name of the VpnServerConfigurationPolicyGroupMember." + }, + "attributeType": { + "type": "string", + "description": "The Vpn Policy member attribute type.", + "enum": [ + "CertificateGroupId", + "AADGroupId", + "RadiusAzureGroupId" + ], + "x-ms-enum": { + "name": "VpnPolicyMemberAttributeType", + "modelAsString": true + } + }, + "attributeValue": { + "type": "string", + "description": "The value of Attribute used for this VpnServerConfigurationPolicyGroupMember." + } + }, + "description": "VpnServerConfiguration PolicyGroup member", + "type": "object" + }, + "ListVpnServerConfigurationPolicyGroupsResult": { + "type": "object", + "description": "Result of the request to list VpnServerConfigurationPolicyGroups. It contains a list of VpnServerConfigurationPolicyGroups and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + }, + "description": "List of VpnServerConfigurationPolicyGroups." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "P2SVpnGatewayProperties": { + "properties": { + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualHub to which the gateway belongs." + }, + "p2SConnectionConfigurations": { + "type": "array", + "description": "List of all p2s connection configurations of the gateway.", + "items": { + "$ref": "#/definitions/P2SConnectionConfiguration" + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the P2S VPN gateway resource." + }, + "vpnGatewayScaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit for this p2s vpn gateway." + }, + "vpnServerConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VpnServerConfiguration to which the p2sVpnGateway is attached to." + }, + "vpnClientConnectionHealth": { + "readOnly": true, + "$ref": "#/definitions/VpnClientConnectionHealth", + "description": "All P2S VPN clients' connection health status." + }, + "customDnsServers": { + "type": "array", + "description": "List of all customer specified DNS servers IP addresses.", + "items": { + "type": "string" + } + }, + "isRoutingPreferenceInternet": { + "type": "boolean", + "description": "Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway." + } + }, + "description": "Parameters for P2SVpnGateway." + }, + "P2SVpnGateway": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SVpnGatewayProperties", + "description": "Properties of the P2SVpnGateway." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "P2SVpnGateway Resource." + }, + "ListP2SVpnGatewaysResult": { + "description": "Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "List of P2SVpnGateways." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "P2SVpnProfileParameters": { + "properties": { + "authenticationMethod": { + "$ref": "./network.json#/definitions/AuthenticationMethod", + "description": "VPN client authentication method." + } + }, + "description": "Vpn Client Parameters for package generation." + }, + "VpnProfileResponse": { + "properties": { + "profileUrl": { + "type": "string", + "description": "URL to the VPN profile." + } + }, + "description": "Vpn Profile Response for package generation." + }, + "VpnLinkBgpSettings": { + "properties": { + "asn": { + "type": "integer", + "format": "int64", + "description": "The BGP speaker's ASN." + }, + "bgpPeeringAddress": { + "type": "string", + "description": "The BGP peering address and BGP identifier of this BGP speaker." + } + }, + "description": "BGP settings details for a link." + }, + "VpnLinkProviderProperties": { + "properties": { + "linkProviderName": { + "type": "string", + "description": "Name of the link provider." + }, + "linkSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Link speed." + } + }, + "description": "List of properties of a link provider." + }, + "VpnServerConfigurationsResponse": { + "properties": { + "vpnServerConfigurationResourceIds": { + "type": "array", + "items": { + "type": "string", + "description": "VpnServerConfiguration partial resource uri." + }, + "description": "List of VpnServerConfigurations associated with VirtualWan." + } + }, + "description": "VpnServerConfigurations list associated with VirtualWan Response." + }, + "VirtualWanVpnProfileParameters": { + "properties": { + "vpnServerConfigurationResourceId": { + "type": "string", + "description": "VpnServerConfiguration partial resource uri with which VirtualWan is associated to." + }, + "authenticationMethod": { + "$ref": "./network.json#/definitions/AuthenticationMethod", + "description": "VPN client authentication method." + } + }, + "description": "Virtual Wan Vpn profile parameters Vpn profile generation." + }, + "P2SVpnConnectionHealthRequest": { + "properties": { + "vpnUserNamesFilter": { + "type": "array", + "items": { + "type": "string", + "description": "P2S vpn user name." + }, + "description": "The list of p2s vpn user names whose p2s vpn connection detailed health to retrieve for." + }, + "outputBlobSasUrl": { + "type": "string", + "description": "The sas-url to download the P2S Vpn connection health detail." + } + }, + "description": "List of P2S Vpn connection health request." + }, + "P2SVpnConnectionHealth": { + "properties": { + "sasUrl": { + "type": "string", + "description": "Returned sas url of the blob to which the p2s vpn connection detailed health will be written." + } + }, + "description": "P2S Vpn connection detailed health written to sas url." + }, + "P2SConnectionConfigurationProperties": { + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents Address space for P2S VpnClient." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not." + }, + "configurationPolicyGroupAssociations": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to." + }, + "previousConfigurationPolicyGroupAssociations": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + }, + "description": "List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the P2SConnectionConfiguration resource." + } + }, + "description": "Parameters for P2SConnectionConfiguration." + }, + "P2SConnectionConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SConnectionConfigurationProperties", + "description": "Properties of the P2S connection configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "P2SConnectionConfiguration Resource." + }, + "VirtualHubRouteTableV2Properties": { + "properties": { + "routes": { + "type": "array", + "description": "List of all routes.", + "items": { + "$ref": "#/definitions/VirtualHubRouteV2" + } + }, + "attachedConnections": { + "type": "array", + "description": "List of all connections attached to this route table v2.", + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the virtual hub route table v2 resource." + } + }, + "description": "Parameters for VirtualHubRouteTableV2." + }, + "VirtualHubRouteTableV2": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualHubRouteTableV2Properties", + "description": "Properties of the virtual hub route table v2." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VirtualHubRouteTableV2 Resource." + }, + "VirtualHubRouteV2": { + "properties": { + "destinationType": { + "type": "string", + "description": "The type of destinations." + }, + "destinations": { + "type": "array", + "description": "List of all destinations.", + "items": { + "type": "string" + } + }, + "nextHopType": { + "type": "string", + "description": "The type of next hops." + }, + "nextHops": { + "type": "array", + "description": "NextHops ip address.", + "items": { + "type": "string" + } + } + }, + "description": "VirtualHubRouteTableV2 route." + }, + "ListVirtualHubRouteTableV2sResult": { + "description": "List of VirtualHubRouteTableV2s and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + }, + "description": "List of VirtualHubRouteTableV2s." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "P2SVpnConnectionRequest": { + "description": "List of p2s vpn connections to be disconnected.", + "properties": { + "vpnConnectionIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of p2s vpn connection Ids." + } + } + }, + "VirtualHubId": { + "properties": { + "id": { + "type": "string", + "description": "The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription." + } + }, + "description": "Virtual Hub identifier." + }, + "ExpressRouteCircuitPeeringId": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the ExpressRoute circuit peering." + } + }, + "description": "ExpressRoute circuit peering identifier." + }, + "ExpressRouteConnectionId": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of the ExpressRouteConnection." + } + }, + "description": "The ID of the ExpressRouteConnection." + }, + "ExpressRouteGatewayProperties": { + "required": [ + "virtualHub" + ], + "properties": { + "autoScaleConfiguration": { + "properties": { + "bounds": { + "properties": { + "min": { + "type": "integer", + "description": "Minimum number of scale units deployed for ExpressRoute gateway." + }, + "max": { + "type": "integer", + "description": "Maximum number of scale units deployed for ExpressRoute gateway." + } + }, + "description": "Minimum and maximum number of scale units to deploy." + } + }, + "description": "Configuration for auto scaling." + }, + "expressRouteConnections": { + "type": "array", + "description": "List of ExpressRoute connections to the ExpressRoute gateway.", + "items": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route gateway resource." + }, + "virtualHub": { + "$ref": "#/definitions/VirtualHubId", + "description": "The Virtual Hub where the ExpressRoute gateway is or will be deployed." + }, + "allowNonVirtualWanTraffic": { + "type": "boolean", + "description": "Configures this gateway to accept traffic from non Virtual WAN networks." + } + }, + "description": "ExpressRoute gateway resource properties." + }, + "ExpressRouteGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteGatewayProperties", + "description": "Properties of the express route gateway." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRoute gateway resource." + }, + "ExpressRouteGatewayList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteGateway" + }, + "description": "List of ExpressRoute gateways." + } + }, + "description": "List of ExpressRoute gateways." + }, + "ExpressRouteConnectionProperties": { + "required": [ + "expressRouteCircuitPeering" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route connection resource." + }, + "expressRouteCircuitPeering": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringId", + "description": "The ExpressRoute circuit peering." + }, + "authorizationKey": { + "type": "string", + "description": "Authorization key to establish the connection." + }, + "routingWeight": { + "type": "integer", + "description": "The routing weight associated to the connection." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Enable FastPath to vWan Firewall hub." + }, + "enablePrivateLinkFastPath": { + "type": "boolean", + "description": "Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + } + }, + "description": "Properties of the ExpressRouteConnection subresource." + }, + "ExpressRouteConnection": { + "required": [ + "name" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteConnectionProperties", + "description": "Properties of the express route connection." + }, + "name": { + "type": "string", + "description": "The name of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ExpressRouteConnection resource." + }, + "ExpressRouteConnectionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteConnection" + }, + "description": "The list of ExpressRoute connections." + } + }, + "description": "ExpressRouteConnection list." + }, + "NetworkVirtualApplianceConnectionProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NetworkVirtualApplianceConnection resource." + }, + "asn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Network Virtual Appliance ASN." + }, + "tunnelIdentifier": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Unique identifier for the connection." + }, + "bgpPeerAddress": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of bgpPeerAddresses for the NVA instances" + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + } + }, + "description": "Properties of the NetworkVirtualApplianceConnection subresource." + }, + "NetworkVirtualApplianceConnection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkVirtualApplianceConnectionProperties", + "description": "Properties of the express route connection." + }, + "name": { + "type": "string", + "description": "The name of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "NetworkVirtualApplianceConnection resource." + }, + "NetworkVirtualApplianceConnectionList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + }, + "description": "The list of NetworkVirtualAppliance connections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "NetworkVirtualApplianceConnection list." + }, + "ListVirtualHubBgpConnectionResults": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpConnection" + }, + "description": "The list of VirtualHubBgpConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "VirtualHubBgpConnections list." + }, + "ListVirtualHubIpConfigurationResults": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubIpConfiguration" + }, + "description": "The list of VirtualHubIpConfigurations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "VirtualHubIpConfigurations list." + }, + "RoutingConfiguration": { + "description": "Routing Configuration indicating the associated and propagated route tables for this connection.", + "properties": { + "associatedRouteTable": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The resource id RouteTable associated with this RoutingConfiguration." + }, + "propagatedRouteTables": { + "$ref": "#/definitions/PropagatedRouteTable", + "description": "The list of RouteTables to advertise the routes to." + }, + "vnetRoutes": { + "$ref": "#/definitions/VnetRoute", + "description": "List of routes that control routing from VirtualHub into a virtual network connection." + }, + "inboundRouteMap": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes." + }, + "outboundRouteMap": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes." + } + } + }, + "PropagatedRouteTable": { + "description": "The list of RouteTables to advertise the routes to.", + "properties": { + "labels": { + "type": "array", + "description": "The list of labels.", + "items": { + "type": "string" + } + }, + "ids": { + "type": "array", + "description": "The list of resource ids of all the RouteTables.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + } + } + }, + "VnetRoute": { + "description": "List of routes that control routing from VirtualHub into a virtual network connection.", + "properties": { + "staticRoutesConfig": { + "$ref": "#/definitions/StaticRoutesConfig", + "description": "Configuration for static routes on this HubVnetConnection." + }, + "staticRoutes": { + "type": "array", + "description": "List of all Static Routes.", + "items": { + "$ref": "#/definitions/StaticRoute" + } + }, + "bgpConnections": { + "type": "array", + "readOnly": true, + "description": "The list of references to HubBgpConnection objects.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + } + } + }, + "StaticRoutesConfig": { + "description": "Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.", + "type": "object", + "properties": { + "propagateStaticRoutes": { + "description": "Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.", + "type": "boolean", + "readOnly": true + }, + "vnetLocalRouteOverrideCriteria": { + "description": "Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.", + "$ref": "#/definitions/VnetLocalRouteOverrideCriteria" + } + } + }, + "StaticRoute": { + "description": "List of all Static Routes.", + "properties": { + "name": { + "type": "string", + "description": "The name of the StaticRoute that is unique within a VnetRoute." + }, + "addressPrefixes": { + "type": "array", + "description": "List of all address prefixes.", + "items": { + "type": "string" + } + }, + "nextHopIpAddress": { + "type": "string", + "description": "The ip address of the next hop." + } + } + }, + "VirtualHubEffectiveRouteList": { + "description": "EffectiveRoutes List.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHubEffectiveRoute" + }, + "description": "The list of effective routes configured on the virtual hub or the specified resource." + } + } + }, + "VirtualHubEffectiveRoute": { + "description": "The effective route configured on the virtual hub or specified resource.", + "properties": { + "addressPrefixes": { + "description": "The list of address prefixes.", + "type": "array", + "items": { + "type": "string" + } + }, + "nextHops": { + "description": "The list of next hops.", + "type": "array", + "items": { + "type": "string" + } + }, + "nextHopType": { + "description": "The type of the next hop.", + "type": "string" + }, + "asPath": { + "description": "The ASPath of this route.", + "type": "string" + }, + "routeOrigin": { + "description": "The origin of this route.", + "type": "string" + } + } + }, + "EffectiveRoutesParameters": { + "description": "The parameters specifying the resource whose effective routes are being requested.", + "properties": { + "resourceId": { + "type": "string", + "description": "The resource whose effective routes are being requested." + }, + "virtualWanResourceType": { + "type": "string", + "description": "The type of the specified resource like RouteTable, ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." + } + } + }, + "EffectiveRouteMapRouteList": { + "description": "EffectiveRouteMapRoute List.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveRouteMapRoute" + }, + "description": "The list of Effective RouteMap Routes configured on the connection resource.", + "x-ms-identifiers": [] + } + } + }, + "EffectiveRouteMapRoute": { + "description": "The effective RouteMap route configured on the connection resource.", + "type": "object", + "properties": { + "prefix": { + "description": "The address prefix of the route.", + "type": "string" + }, + "bgpCommunities": { + "description": "BGP communities of the route.", + "type": "string" + }, + "asPath": { + "description": "The ASPath of this route.", + "type": "string" + } + } + }, + "GetInboundRoutesParameters": { + "description": "The parameters specifying the connection resource whose inbound routes are being requested.", + "type": "object", + "properties": { + "resourceUri": { + "type": "string", + "description": "The connection resource whose inbound routes are being requested." + }, + "connectionType": { + "type": "string", + "description": "The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." + } + } + }, + "GetOutboundRoutesParameters": { + "description": "The parameters specifying the connection resource whose outbound routes are being requested.", + "type": "object", + "properties": { + "resourceUri": { + "type": "string", + "description": "The connection resource whose outbound routes are being requested." + }, + "connectionType": { + "type": "string", + "description": "The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." + } + } + }, + "O365PolicyProperties": { + "properties": { + "breakOutCategories": { + "readOnly": false, + "description": "Office365 breakout categories.", + "$ref": "#/definitions/O365BreakOutCategoryPolicies" + } + }, + "description": "The Office365 breakout policy." + }, + "O365BreakOutCategoryPolicies": { + "properties": { + "allow": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control allow category." + }, + "optimize": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control optimize category." + }, + "default": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control default category." + } + }, + "description": "Office365 breakout categories." + }, + "ListRoutingIntentResult": { + "description": "List of the routing intent result and a URL nextLink to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoutingIntent" + }, + "description": "List of RoutingIntent resource." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "RoutingIntent": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoutingIntentProperties", + "description": "Properties of the RoutingIntent resource." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The routing intent child resource of a Virtual hub.", + "type": "object" + }, + "RoutingIntentProperties": { + "properties": { + "routingPolicies": { + "type": "array", + "description": "List of routing policies.", + "readOnly": false, + "items": { + "$ref": "#/definitions/RoutingPolicy" + } + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the RoutingIntent resource." + } + }, + "description": "The properties of a RoutingIntent resource.", + "type": "object" + }, + "RoutingPolicy": { + "required": [ + "name", + "destinations", + "nextHop" + ], + "properties": { + "name": { + "type": "string", + "description": "The unique name for the routing policy." + }, + "destinations": { + "type": "array", + "description": "List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic).", + "items": { + "type": "string" + } + }, + "nextHop": { + "type": "string", + "description": "The next hop resource id on which this routing policy is applicable to." + } + }, + "description": "The routing policy object used in a RoutingIntent resource.", + "type": "object" + }, + "RouteMap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteMapProperties", + "description": "Properties of the RouteMap resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Resource id." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The RouteMap child resource of a Virtual hub.", + "type": "object" + }, + "ListRouteMapsResult": { + "description": "List of RouteMaps and a URL nextLink to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteMap" + }, + "description": "List of RouteMaps." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "RouteMapProperties": { + "properties": { + "associatedInboundConnections": { + "type": "array", + "description": "List of connections which have this RoutMap associated for inbound traffic.", + "items": { + "type": "string" + } + }, + "associatedOutboundConnections": { + "type": "array", + "description": "List of connections which have this RoutMap associated for outbound traffic.", + "items": { + "type": "string" + } + }, + "rules": { + "type": "array", + "description": "List of RouteMap rules to be applied.", + "items": { + "$ref": "#/definitions/RouteMapRule" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the RouteMap resource." + } + }, + "description": "Properties of RouteMap resource", + "type": "object" + }, + "RouteMapRule": { + "properties": { + "name": { + "type": "string", + "description": "The unique name for the rule." + }, + "matchCriteria": { + "type": "array", + "description": "List of matching criterion which will be applied to traffic.", + "items": { + "$ref": "#/definitions/Criterion" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions which will be applied on a match.", + "items": { + "$ref": "#/definitions/Action" + }, + "x-ms-identifiers": [] + }, + "nextStepIfMatched": { + "$ref": "#/definitions/NextStep", + "description": "Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'." + } + }, + "description": "A RouteMap Rule.", + "type": "object" + }, + "Criterion": { + "properties": { + "routePrefix": { + "type": "array", + "description": "List of route prefixes which this criteria matches.", + "items": { + "type": "string" + } + }, + "community": { + "type": "array", + "description": "List of BGP communities which this criteria matches.", + "items": { + "type": "string" + } + }, + "asPath": { + "type": "array", + "description": "List of AS paths which this criteria matches.", + "items": { + "type": "string" + } + }, + "matchCondition": { + "$ref": "#/definitions/RouteMapMatchCondition", + "description": "Match condition to apply RouteMap rules." + } + }, + "description": "A matching criteria which matches routes based on route prefix, community, and AS path.", + "type": "object" + }, + "Action": { + "properties": { + "type": { + "$ref": "#/definitions/RouteMapActionType", + "description": "Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'" + }, + "parameters": { + "type": "array", + "description": "List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added", + "items": { + "$ref": "#/definitions/Parameter" + }, + "x-ms-identifiers": [] + } + }, + "description": "Action to be taken on a route matching a RouteMap criterion.", + "type": "object" + }, + "Parameter": { + "properties": { + "routePrefix": { + "type": "array", + "description": "List of route prefixes.", + "items": { + "type": "string" + } + }, + "community": { + "type": "array", + "description": "List of BGP communities.", + "items": { + "type": "string" + } + }, + "asPath": { + "type": "array", + "description": "List of AS paths.", + "items": { + "type": "string" + } + } + }, + "description": "Parameters for an Action.", + "type": "object" + }, + "RouteMapMatchCondition": { + "type": "string", + "description": "Match condition to apply RouteMap rules.", + "enum": [ + "Unknown", + "Contains", + "Equals", + "NotContains", + "NotEquals" + ], + "x-ms-enum": { + "name": "RouteMapMatchCondition", + "modelAsString": true + } + }, + "NextStep": { + "type": "string", + "description": "Supported next step behaviors after a rule is applied to a matched route", + "enum": [ + "Unknown", + "Continue", + "Terminate" + ], + "x-ms-enum": { + "name": "NextStep", + "modelAsString": true + } + }, + "RouteMapActionType": { + "type": "string", + "description": "Kind of actions which can be taken on a matched route. Add, Replace, Remove refer to parameters on the route, like community or prefix", + "enum": [ + "Unknown", + "Remove", + "Add", + "Replace", + "Drop" + ], + "x-ms-enum": { + "name": "RouteMapActionType", + "modelAsString": true + } + }, + "VnetLocalRouteOverrideCriteria": { + "type": "string", + "description": "Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.", + "enum": [ + "Contains", + "Equal" + ], + "x-ms-enum": { + "name": "VnetLocalRouteOverrideCriteria", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/vmssNetworkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/vmssNetworkInterface.json new file mode 100644 index 000000000000..89562aa3062c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/vmssNetworkInterface.json @@ -0,0 +1,374 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetVMNetworkInterfaces", + "description": "Gets information about all network interfaces in a virtual machine in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set vm network interfaces": { + "$ref": "./examples/VmssVmNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetNetworkInterfaces", + "description": "Gets all network interfaces in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interfaces": { + "$ref": "./examples/VmssNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetNetworkInterface", + "description": "Get the specified network interface in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { + "$ref": "./examples/VmssNetworkInterfaceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetIpConfigurations", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of resulting NetworkInterfaceIPConfigurations resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interface ip configurations": { + "$ref": "./examples/VmssNetworkInterfaceIpConfigList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetIpConfiguration", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ip configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterfaceIPConfiguration resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { + "$ref": "./examples/VmssNetworkInterfaceIpConfigGet.json" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/vmssPublicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/vmssPublicIpAddress.json new file mode 100644 index 000000000000..d100152e7711 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/vmssPublicIpAddress.json @@ -0,0 +1,241 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetPublicIPAddresses", + "description": "Gets information about all public IP addresses on a virtual machine scale set level.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPInterface resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSPublicIP": { + "$ref": "./examples/VmssPublicIpListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetVMPublicIPAddresses", + "description": "Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The network interface name." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The IP configuration name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSVMPublicIP": { + "$ref": "./examples/VmssVmPublicIpList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}": { + "get": { + "operationId": "PublicIPAddresses_GetVirtualMachineScaleSetPublicIPAddress", + "description": "Get the specified public IP address in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IP configuration." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP Address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "x-ms-examples": { + "GetVMSSPublicIP": { + "$ref": "./examples/VmssPublicIpGet.json" + } + }, + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/webapplicationfirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/webapplicationfirewall.json new file mode 100644 index 000000000000..f7abf7c0e928 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/webapplicationfirewall.json @@ -0,0 +1,1028 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-01", + "title": "WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "WebApplicationFirewallPolicies_List", + "x-ms-examples": { + "Lists all WAF policies in a resource group": { + "$ref": "./examples/WafListPolicies.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Gets all the WAF policies in a subscription.", + "operationId": "WebApplicationFirewallPolicies_ListAll", + "x-ms-examples": { + "Lists all WAF policies in a subscription": { + "$ref": "./examples/WafListAllPolicies.json" + } + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "WebApplicationFirewallPolicies_Get", + "x-ms-examples": { + "Gets a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Creates or update policy with specified rule set name within a resource group.", + "operationId": "WebApplicationFirewallPolicies_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy.", + "operationId": "WebApplicationFirewallPolicies_Delete", + "x-ms-examples": { + "Deletes a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the policy was not found." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "WebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebApplicationFirewallPolicyPropertiesFormat", + "description": "Properties of the web application firewall policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "WebApplicationFirewallPolicyPropertiesFormat": { + "description": "Defines web application firewall policy properties.", + "required": [ + "managedRules" + ], + "properties": { + "policySettings": { + "description": "The PolicySettings for policy.", + "$ref": "#/definitions/PolicySettings" + }, + "customRules": { + "description": "The custom rules inside the policy.", + "type": "array", + "items": { + "$ref": "#/definitions/WebApplicationFirewallCustomRule" + } + }, + "applicationGateways": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./applicationGateway.json#/definitions/ApplicationGateway" + }, + "description": "A collection of references to application gateways." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the web application firewall policy resource." + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "type": "string", + "description": "Resource status of the policy.", + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallPolicyResourceState", + "modelAsString": true + } + }, + "managedRules": { + "description": "Describes the managedRules structure.", + "$ref": "#/definitions/ManagedRulesDefinition" + }, + "httpListeners": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A collection of references to application gateway http listeners." + }, + "pathBasedRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A collection of references to application gateway path rules." + } + } + }, + "WebApplicationFirewallPolicyListResult": { + "description": "Result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + }, + "description": "List of WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "ManagedRulesDefinition": { + "description": "Allow to exclude some variable satisfy the condition for the WAF check.", + "required": [ + "managedRuleSets" + ], + "properties": { + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/OwaspCrsExclusionEntry" + }, + "description": "The Exclusions that are applied on the policy." + }, + "managedRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + }, + "description": "The managed rule sets that are associated with the policy." + } + } + }, + "PolicySettings": { + "description": "Defines contents of a web application firewall global configuration.", + "properties": { + "state": { + "description": "The state of the policy.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "The mode of the policy.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallMode", + "modelAsString": true + } + }, + "requestBodyCheck": { + "type": "boolean", + "description": "Whether to allow WAF to check request Body." + }, + "requestBodyInspectLimitInKB": { + "type": "integer", + "format": "int32", + "description": "Max inspection limit in KB for request body inspection for WAF." + }, + "requestBodyEnforcement": { + "type": "boolean", + "default": true, + "description": "Whether allow WAF to enforce request body limits." + }, + "maxRequestBodySizeInKb": { + "type": "integer", + "format": "int32", + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size in Kb for WAF." + }, + "fileUploadEnforcement": { + "type": "boolean", + "default": true, + "description": "Whether allow WAF to enforce file upload limits." + }, + "fileUploadLimitInMb": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Maximum file upload size in Mb for WAF." + }, + "customBlockResponseStatusCode": { + "description": "If the action type is block, customer can override the response status code.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "customBlockResponseBody": { + "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "maxLength": 32768 + }, + "logScrubbing": { + "description": "To scrub sensitive log fields", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the log scrubbing config. Default value is Enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallScrubbingState", + "modelAsString": true + } + }, + "scrubbingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/WebApplicationFirewallScrubbingRules" + }, + "x-ms-identifiers": [], + "description": "The rules that are applied to the logs for scrubbing." + } + } + }, + "jsChallengeCookieExpirationInMins": { + "description": "Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes.", + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1440 + } + } + }, + "WebApplicationFirewallCustomRule": { + "description": "Defines contents of a web application rule.", + "required": [ + "priority", + "ruleType", + "matchConditions", + "action" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the resource that is unique within a policy. This name can be used to access the resource.", + "maxLength": 128 + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "priority": { + "description": "Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.", + "type": "integer" + }, + "state": { + "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallState", + "modelAsString": true + } + }, + "rateLimitDuration": { + "type": "string", + "description": "Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule.", + "enum": [ + "OneMin", + "FiveMins" + ], + "x-ms-enum": { + "name": "ApplicationGatewayFirewallRateLimitDuration", + "modelAsString": true + } + }, + "rateLimitThreshold": { + "description": "Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1", + "type": "integer", + "format": "int32" + }, + "ruleType": { + "description": "The rule type.", + "type": "string", + "enum": [ + "MatchRule", + "RateLimitRule", + "Invalid" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallRuleType", + "modelAsString": true + } + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + } + }, + "groupByUserSession": { + "description": "List of user session identifier group by clauses.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/GroupByUserSession" + } + }, + "action": { + "description": "Type of Actions.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log", + "JSChallenge" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallAction", + "modelAsString": true + } + } + } + }, + "Transform": { + "description": "Transforms applied before matching.", + "type": "string", + "enum": [ + "Uppercase", + "Lowercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls", + "HtmlEntityDecode" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallTransform", + "modelAsString": true + } + }, + "MatchVariable": { + "description": "Define match variables.", + "required": [ + "variableName" + ], + "properties": { + "variableName": { + "description": "Match Variable.", + "type": "string", + "enum": [ + "RemoteAddr", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeaders", + "RequestBody", + "RequestCookies" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallMatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "The selector of match variable.", + "type": "string" + } + } + }, + "MatchCondition": { + "description": "Define match conditions.", + "required": [ + "matchVariables", + "operator", + "matchValues" + ], + "properties": { + "matchVariables": { + "description": "List of match variables.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchVariable" + } + }, + "operator": { + "description": "The operator to be matched.", + "type": "string", + "enum": [ + "IPMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "Regex", + "GeoMatch", + "Any" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallOperator", + "modelAsString": true + } + }, + "negationConditon": { + "description": "Whether this is negate condition or not.", + "type": "boolean" + }, + "matchValues": { + "description": "Match value.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/Transform" + } + } + } + }, + "GroupByVariable": { + "type": "object", + "description": "Define user session group by clause variables.", + "required": [ + "variableName" + ], + "properties": { + "variableName": { + "description": "User Session clause variable.", + "type": "string", + "enum": [ + "ClientAddr", + "GeoLocation", + "None" + ], + "x-ms-enum": { + "name": "ApplicationGatewayFirewallUserSessionVariable", + "modelAsString": true + } + } + } + }, + "GroupByUserSession": { + "type": "object", + "description": "Define user session identifier group by clauses.", + "required": [ + "groupByVariables" + ], + "properties": { + "groupByVariables": { + "description": "List of group by clause variables.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/GroupByVariable" + } + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "ruleGroupOverrides": { + "description": "Defines the rule group overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + } + } + } + }, + "ManagedRuleGroupOverride": { + "type": "object", + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "The managed rule group to override.", + "type": "string" + }, + "rules": { + "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + } + } + } + }, + "ManagedRuleOverride": { + "type": "object", + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "state": { + "description": "The state of the managed rule. Defaults to Disabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + }, + "action": { + "description": "Describes the override action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + } + } + }, + "ExclusionManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set for Exclusions.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "ruleGroups": { + "description": "Defines the rule groups to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ExclusionManagedRuleGroup" + } + } + } + }, + "ExclusionManagedRuleGroup": { + "type": "object", + "description": "Defines a managed rule group to use for exclusion.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "The managed rule group for exclusion.", + "type": "string" + }, + "rules": { + "description": "List of rules that will be excluded. If none specified, all rules in the group will be excluded.", + "type": "array", + "items": { + "$ref": "#/definitions/ExclusionManagedRule" + } + } + } + }, + "ExclusionManagedRule": { + "type": "object", + "description": "Defines a managed rule to use for exclusion.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + } + } + }, + "OwaspCrsExclusionEntry": { + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Allow to exclude some variable satisfy the condition for the WAF check.", + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestHeaderNames", + "RequestCookieNames", + "RequestArgNames", + "RequestHeaderKeys", + "RequestHeaderValues", + "RequestCookieKeys", + "RequestCookieValues", + "RequestArgKeys", + "RequestArgValues" + ], + "description": "The variable to be excluded.", + "x-ms-enum": { + "name": "OwaspCrsExclusionEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "Contains", + "StartsWith", + "EndsWith", + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.", + "x-ms-enum": { + "name": "OwaspCrsExclusionEntrySelectorMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." + }, + "exclusionManagedRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ExclusionManagedRuleSet" + }, + "description": "The managed rule sets that are associated with the exclusion." + } + } + }, + "ActionType": { + "description": "Defines the action to take on rule match.", + "type": "string", + "enum": [ + "AnomalyScoring", + "Allow", + "Block", + "Log", + "JSChallenge" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + }, + "WebApplicationFirewallScrubbingRules": { + "description": "Allow certain variables to be scrubbed on WAF logs", + "type": "object", + "required": [ + "matchVariable", + "selectorMatchOperator" + ], + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestHeaderNames", + "RequestCookieNames", + "RequestArgNames", + "RequestPostArgNames", + "RequestJSONArgNames", + "RequestIPAddress" + ], + "description": "The variable to be scrubbed from the logs.", + "x-ms-enum": { + "name": "scrubbingRuleEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.", + "x-ms-enum": { + "name": " scrubbingRuleEntryMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to." + }, + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Defines the state of log scrubbing rule. Default value is Enabled.", + "x-ms-enum": { + "name": " scrubbingRuleEntryState", + "modelAsString": true + } + } + } + } + } +} diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index ba90cc7c3535..e7b06187b7da 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -28,7 +28,82 @@ These are the global settings for the Network API. title: NetworkManagementClient description: Network Client openapi-type: arm -tag: package-2023-11 +tag: package-2024-01 +``` + +### Tag: package-2024-01 + +These settings apply only when `--tag=package-2024-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-01' +input-file: + - Microsoft.Network/stable/2024-01-01/applicationGateway.json + - Microsoft.Network/stable/2024-01-01/applicationGatewayWafDynamicManifests.json + - Microsoft.Network/stable/2024-01-01/applicationSecurityGroup.json + - Microsoft.Network/stable/2024-01-01/availableDelegations.json + - Microsoft.Network/stable/2024-01-01/availableServiceAliases.json + - Microsoft.Network/stable/2024-01-01/azureFirewall.json + - Microsoft.Network/stable/2024-01-01/azureFirewallFqdnTag.json + - Microsoft.Network/stable/2024-01-01/azureWebCategory.json + - Microsoft.Network/stable/2024-01-01/bastionHost.json + - Microsoft.Network/stable/2024-01-01/checkDnsAvailability.json + - Microsoft.Network/stable/2024-01-01/cloudServiceNetworkInterface.json + - Microsoft.Network/stable/2024-01-01/cloudServicePublicIpAddress.json + - Microsoft.Network/stable/2024-01-01/cloudServiceSwap.json + - Microsoft.Network/stable/2024-01-01/customIpPrefix.json + - Microsoft.Network/stable/2024-01-01/ddosCustomPolicy.json + - Microsoft.Network/stable/2024-01-01/ddosProtectionPlan.json + - Microsoft.Network/stable/2024-01-01/dscpConfiguration.json + - Microsoft.Network/stable/2024-01-01/endpointService.json + - Microsoft.Network/stable/2024-01-01/expressRouteCircuit.json + - Microsoft.Network/stable/2024-01-01/expressRouteCrossConnection.json + - Microsoft.Network/stable/2024-01-01/expressRoutePort.json + - Microsoft.Network/stable/2024-01-01/expressRouteProviderPort.json + - Microsoft.Network/stable/2024-01-01/firewallPolicy.json + - Microsoft.Network/stable/2024-01-01/ipAllocation.json + - Microsoft.Network/stable/2024-01-01/ipGroups.json + - Microsoft.Network/stable/2024-01-01/loadBalancer.json + - Microsoft.Network/stable/2024-01-01/natGateway.json + - Microsoft.Network/stable/2024-01-01/network.json + - Microsoft.Network/stable/2024-01-01/networkInterface.json + - Microsoft.Network/stable/2024-01-01/networkManager.json + - Microsoft.Network/stable/2024-01-01/networkManagerActiveConfiguration.json + - Microsoft.Network/stable/2024-01-01/networkManagerConnection.json + - Microsoft.Network/stable/2024-01-01/networkManagerConnectivityConfiguration.json + - Microsoft.Network/stable/2024-01-01/networkManagerEffectiveConfiguration.json + - Microsoft.Network/stable/2024-01-01/networkManagerGroup.json + - Microsoft.Network/stable/2024-01-01/networkManagerScopeConnection.json + - Microsoft.Network/stable/2024-01-01/networkManagerSecurityAdminConfiguration.json + - Microsoft.Network/stable/2024-01-01/networkProfile.json + - Microsoft.Network/stable/2024-01-01/networkSecurityGroup.json + - Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json + - Microsoft.Network/stable/2024-01-01/networkWatcher.json + - Microsoft.Network/stable/2024-01-01/operation.json + - Microsoft.Network/stable/2024-01-01/privateEndpoint.json + - Microsoft.Network/stable/2024-01-01/privateLinkService.json + - Microsoft.Network/stable/2024-01-01/publicIpAddress.json + - Microsoft.Network/stable/2024-01-01/publicIpPrefix.json + - Microsoft.Network/stable/2024-01-01/routeFilter.json + - Microsoft.Network/stable/2024-01-01/routeTable.json + - Microsoft.Network/stable/2024-01-01/securityPartnerProvider.json + - Microsoft.Network/stable/2024-01-01/serviceCommunity.json + - Microsoft.Network/stable/2024-01-01/serviceEndpointPolicy.json + - Microsoft.Network/stable/2024-01-01/serviceTags.json + - Microsoft.Network/stable/2024-01-01/usage.json + - Microsoft.Network/stable/2024-01-01/virtualNetwork.json + - Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json + - Microsoft.Network/stable/2024-01-01/virtualNetworkTap.json + - Microsoft.Network/stable/2024-01-01/virtualRouter.json + - Microsoft.Network/stable/2024-01-01/virtualWan.json + - Microsoft.Network/stable/2024-01-01/vmssNetworkInterface.json + - Microsoft.Network/stable/2024-01-01/vmssPublicIpAddress.json + - Microsoft.Network/stable/2024-01-01/webapplicationfirewall.json + +suppressions: + - code: ImplementPrivateEndpointAPIs + reason: False alarm. + - code: PatchIdentityProperty + reason: False alarm. ``` ### Tag: package-2023-11-preview From 768c1f32bbfdcea80bdadf92dc2fba2c114c2dda Mon Sep 17 00:00:00 2001 From: catalinaperalta Date: Wed, 19 Jun 2024 16:14:17 -0700 Subject: [PATCH 208/343] fix endpoint (#29508) Co-authored-by: Catalina Peralta --- specification/appconfiguration/AppConfiguration/main.tsp | 2 +- .../stable/2023-11-01/appconfiguration.json | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/specification/appconfiguration/AppConfiguration/main.tsp b/specification/appconfiguration/AppConfiguration/main.tsp index b7bcf0a580d4..318d929f99f6 100644 --- a/specification/appconfiguration/AppConfiguration/main.tsp +++ b/specification/appconfiguration/AppConfiguration/main.tsp @@ -24,7 +24,7 @@ using TypeSpec.Versioning; "{endpoint}", "App Configuration service endpoint", { - endpoint: string, + endpoint: url, } ) @doc("Azure App Configuration REST API") diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json index 5dfd848776f1..fb2796e96161 100644 --- a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json @@ -21,7 +21,9 @@ "name": "endpoint", "in": "path", "required": true, - "type": "string" + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true } ] }, From 0e8670961f7e4f74753dbf9cd2507cddd7483883 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Thu, 20 Jun 2024 14:25:19 +0800 Subject: [PATCH 209/343] Update tspconfig.yaml (#29491) --- specification/oracle/Oracle.Database/tspconfig.yaml | 9 --------- 1 file changed, 9 deletions(-) diff --git a/specification/oracle/Oracle.Database/tspconfig.yaml b/specification/oracle/Oracle.Database/tspconfig.yaml index fa6f46b6a1d4..984ac2cc2975 100644 --- a/specification/oracle/Oracle.Database/tspconfig.yaml +++ b/specification/oracle/Oracle.Database/tspconfig.yaml @@ -17,15 +17,6 @@ options: packageDetails: name: "@azure/arm-oracledatabase" flavor: azure - # "@azure-tools/typespec-java": - # package-dir: "azure-resourcemanager-oracledatabase" - # namespace: com.azure.resourcemanager.oracledatabase - # partial-update: true - # flavor: azure - "@azure-tools/typespec-python": - package-dir: "azure-mgmt-oracledatabase" - package-name: "{package-dir}" - flavor: azure linter: extends: From cc92c5922e1d69bab8f0deb8e1f778f6d9455739 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Thu, 20 Jun 2024 14:33:17 +0800 Subject: [PATCH 210/343] update (#29522) --- specification/vmware/resource-manager/readme.python.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/vmware/resource-manager/readme.python.md b/specification/vmware/resource-manager/readme.python.md index 66079d0519e8..1393a85ed911 100644 --- a/specification/vmware/resource-manager/readme.python.md +++ b/specification/vmware/resource-manager/readme.python.md @@ -27,4 +27,7 @@ directive: - from: managedidentity.json where: definitions.SystemAssignedServiceIdentityType transform: $["x-ms-enum"].name = "ResourceIdentityType" +- from: swagger-document + where: paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs"] + transform: $.get.operationId = "WorkloadNetworks_ListPublicIps" ``` From d0f12e05c52d6a33b6e124bd73de66e021ad5f21 Mon Sep 17 00:00:00 2001 From: Arber Hila Date: Thu, 20 Jun 2024 10:22:07 -0700 Subject: [PATCH 211/343] ahila devcenter Microsoft.DevCenter 2024-06-01-preview API version (#29364) * Copy files from preview/2024-05-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-06-01-preview Updated the API version from preview/2024-05-01-preview to preview/2024-06-01-preview. * Added tag for 2024-06-01-preview in readme file * Add 2024-06-01-preview API changes * Fix spec linting/validation issues * add lintdiff suppression to readme for common-types sku object * fix suppression to correct file * move suppression to proper yaml tag * fix filename for suppression --------- Co-authored-by: Arber Hila Co-authored-by: Nick Depinet Co-authored-by: Nick Depinet --- .../2024-06-01-preview/commonDefinitions.json | 170 + .../preview/2024-06-01-preview/devcenter.json | 7236 +++++++++++++++++ .../examples/AttachedNetworks_Create.json | 54 + .../examples/AttachedNetworks_Delete.json | 18 + .../AttachedNetworks_GetByDevCenter.json | 32 + .../AttachedNetworks_GetByProject.json | 32 + .../AttachedNetworks_ListByDevCenter.json | 54 + .../AttachedNetworks_ListByProject.json | 54 + .../examples/Catalogs_Connect.json | 17 + .../examples/Catalogs_CreateAdo.json | 92 + .../examples/Catalogs_CreateGitHub.json | 92 + .../examples/Catalogs_Delete.json | 18 + .../examples/Catalogs_Get.json | 48 + .../Catalogs_GetSyncErrorDetails.json | 36 + .../examples/Catalogs_List.json | 50 + .../examples/Catalogs_Patch.json | 62 + .../examples/Catalogs_Sync.json | 17 + .../examples/CheckNameAvailability.json | 17 + ...opedNameAvailability_DevCenterCatalog.json | 18 + ...ScopedNameAvailability_ProjectCatalog.json | 18 + .../examples/CustomizationTasks_Get.json | 40 + .../CustomizationTasks_GetErrorDetails.json | 22 + .../CustomizationTasks_ListByCatalog.json | 42 + .../examples/DevBoxDefinitions_Create.json | 75 + .../examples/DevBoxDefinitions_Delete.json | 18 + .../examples/DevBoxDefinitions_Get.json | 37 + .../DevBoxDefinitions_GetByProject.json | 37 + .../DevBoxDefinitions_ListByDevCenter.json | 41 + .../DevBoxDefinitions_ListByProject.json | 41 + .../examples/DevBoxDefinitions_Patch.json | 50 + .../DevCenterEncryptionSets_Create.json | 84 + .../DevCenterEncryptionSets_Delete.json | 18 + .../examples/DevCenterEncryptionSets_Get.json | 41 + .../DevCenterEncryptionSets_List.json | 44 + .../DevCenterEncryptionSets_Patch.json | 52 + .../examples/DevCenters_Create.json | 93 + ...ers_CreateWithDisabledManagedNetworks.json | 100 + .../DevCenters_CreateWithEncryption.json | 124 + .../examples/DevCenters_CreateWithPlanId.json | 75 + .../DevCenters_CreateWithUserIdentity.json | 97 + .../examples/DevCenters_Delete.json | 17 + .../examples/DevCenters_Get.json | 41 + .../DevCenters_ListByResourceGroup.json | 37 + .../DevCenters_ListBySubscription.json | 36 + .../examples/DevCenters_Patch.json | 45 + .../examples/EnvironmentDefinitions_Get.json | 53 + ...onmentDefinitions_GetByProjectCatalog.json | 53 + ...nvironmentDefinitions_GetErrorDetails.json | 22 + .../EnvironmentDefinitions_ListByCatalog.json | 56 + ...nmentDefinitions_ListByProjectCatalog.json | 56 + .../examples/EnvironmentTypes_Delete.json | 13 + .../examples/EnvironmentTypes_Get.json | 33 + .../examples/EnvironmentTypes_List.json | 32 + .../examples/EnvironmentTypes_Patch.json | 41 + .../examples/EnvironmentTypes_Put.json | 63 + .../examples/Galleries_Create.json | 54 + .../examples/Galleries_Delete.json | 18 + .../examples/Galleries_Get.json | 30 + .../examples/Galleries_List.json | 50 + .../ImageDefinitions_GetByProjectCatalog.json | 32 + ...ImageDefinitions_ListByProjectCatalog.json | 35 + .../examples/ImageVersions_Get.json | 34 + .../examples/ImageVersions_GetByProject.json | 33 + .../examples/ImageVersions_List.json | 37 + .../examples/ImageVersions_ListByProject.json | 36 + .../examples/Images_Get.json | 44 + .../examples/Images_GetByProject.json | 43 + .../examples/Images_ListByDevCenter.json | 75 + .../examples/Images_ListByGallery.json | 76 + .../examples/Images_ListByProject.json | 105 + .../examples/NetworkConnections_Delete.json | 17 + .../examples/NetworkConnections_Get.json | 35 + .../NetworkConnections_GetHealthDetails.json | 37 + ...etworkConnections_ListByResourceGroup.json | 37 + ...NetworkConnections_ListBySubscription.json | 36 + .../NetworkConnections_ListHealthDetails.json | 41 + ...tOutboundNetworkDependenciesEndpoints.json | 55 + .../examples/NetworkConnections_Patch.json | 45 + .../examples/NetworkConnections_Put.json | 69 + .../NetworkConnections_RunHealthChecks.json | 16 + .../examples/OperationStatus_Get.json | 42 + .../examples/Operations_Get.json | 21 + .../examples/PlanMembers_Create.json | 66 + .../examples/PlanMembers_Delete.json | 18 + .../examples/PlanMembers_Get.json | 34 + .../examples/PlanMembers_List.json | 37 + .../examples/PlanMembers_Patch.json | 45 + .../examples/Plans_Create.json | 71 + .../examples/Plans_Delete.json | 17 + .../examples/Plans_Get.json | 35 + .../examples/Plans_ListByResourceGroup.json | 38 + .../examples/Plans_ListBySubscription.json | 37 + .../examples/Plans_Patch.json | 49 + .../examples/Pools_Delete.json | 18 + .../examples/Pools_Get.json | 46 + .../examples/Pools_GetUnhealthyStatus.json | 60 + .../examples/Pools_List.json | 49 + .../examples/Pools_Patch.json | 57 + .../examples/Pools_Put.json | 92 + .../examples/Pools_PutWithManagedNetwork.json | 99 + .../Pools_PutWithValueDevBoxDefinition.json | 119 + .../examples/Pools_RunHealthChecks.json | 17 + .../ProjectAllowedEnvironmentTypes_Get.json | 26 + .../ProjectAllowedEnvironmentTypes_List.json | 29 + ...nvironmentDefinitions_GetErrorDetails.json | 22 + .../examples/ProjectCatalogs_Connect.json | 17 + .../examples/ProjectCatalogs_CreateAdo.json | 95 + .../ProjectCatalogs_CreateGitHub.json | 95 + .../examples/ProjectCatalogs_Delete.json | 18 + .../examples/ProjectCatalogs_Get.json | 50 + .../ProjectCatalogs_GetSyncErrorDetails.json | 36 + .../examples/ProjectCatalogs_List.json | 50 + .../examples/ProjectCatalogs_Patch.json | 60 + .../examples/ProjectCatalogs_Sync.json | 17 + .../ProjectEnvironmentTypes_Delete.json | 13 + .../examples/ProjectEnvironmentTypes_Get.json | 63 + .../ProjectEnvironmentTypes_List.json | 66 + .../ProjectEnvironmentTypes_Patch.json | 85 + .../examples/ProjectEnvironmentTypes_Put.json | 146 + .../examples/Projects_Delete.json | 17 + .../examples/Projects_Get.json | 41 + .../Projects_GetInheritedSettings.json | 20 + .../Projects_ListByResourceGroup.json | 38 + .../examples/Projects_ListBySubscription.json | 37 + .../examples/Projects_Patch.json | 62 + .../examples/Projects_Put.json | 72 + .../Projects_PutWithMaxDevBoxPerUser.json | 72 + ...dules_CreateDailyShutdownPoolSchedule.json | 67 + .../examples/Schedules_Delete.json | 19 + .../examples/Schedules_Get.json | 35 + .../examples/Schedules_ListByPool.json | 38 + .../examples/Schedules_Patch.json | 46 + .../examples/Skus_ListByProject.json | 32 + .../examples/Skus_ListBySubscription.json | 30 + .../examples/Usages_ListByLocation.json | 34 + .../preview/2024-06-01-preview/vdi.json | 1958 +++++ .../devcenter/resource-manager/readme.md | 17 +- 137 files changed, 15543 insertions(+), 1 deletion(-) create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/commonDefinitions.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/devcenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_GetByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Connect.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_CreateAdo.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_CreateGitHub.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_GetSyncErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Sync.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckNameAvailability.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_GetErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_ListByCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithEncryption.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithPlanId.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithUserIdentity.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByGallery.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_GetHealthDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListHealthDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_RunHealthChecks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/OperationStatus_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Operations_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_GetUnhealthyStatus.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_PutWithManagedNetwork.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_RunHealthChecks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Connect.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_CreateAdo.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_CreateGitHub.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Sync.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_GetInheritedSettings.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_ListByPool.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Skus_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Skus_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Usages_ListByLocation.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/vdi.json diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/commonDefinitions.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/commonDefinitions.json new file mode 100644 index 000000000000..b5445a6169d9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/commonDefinitions.json @@ -0,0 +1,170 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-06-01-preview", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "Capability": { + "description": "A name/value pair to describe a capability.", + "type": "object", + "properties": { + "name": { + "description": "Name of the capability.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value of the capability.", + "type": "string", + "readOnly": true + } + } + }, + "TrackedResourceUpdate": { + "description": "Base tracked resource type for PATCH updates", + "type": "object", + "properties": { + "tags": { + "$ref": "#/definitions/Tags", + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + } + }, + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "DevCenterSku": { + "description": "The resource model definition representing SKU for DevCenter resources", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + ], + "properties": { + "resourceType": { + "type": "string", + "description": "The name of the resource type", + "readOnly": true + }, + "locations": { + "description": "SKU supported locations.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "capabilities": { + "description": "Collection of name/value pairs to describe the SKU capabilities.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Capability" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Creating", + "Created", + "Updating", + "Updated", + "Deleting", + "Deleted", + "Succeeded", + "Failed", + "Canceled", + "MovingResources", + "TransientFailure", + "RolloutInProgress", + "StorageProvisioningFailed" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + }, + "parameters": { + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the project.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "TopParameter": { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'.", + "type": "integer", + "format": "int32", + "required": false, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/devcenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/devcenter.json new file mode 100644 index 000000000000..a20f88602595 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/devcenter.json @@ -0,0 +1,7236 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-06-01-preview", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/plans": { + "get": { + "tags": [ + "Plans" + ], + "description": "Lists all devcenter plans in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Plans_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_ListBySubscription": { + "$ref": "./examples/Plans_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans": { + "get": { + "tags": [ + "Plans" + ], + "description": "Lists all devcenter plans in 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Plans_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_ListByResourceGroup": { + "$ref": "./examples/Plans_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}": { + "get": { + "tags": [ + "Plans" + ], + "description": "Gets a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + } + ], + "operationId": "Plans_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Get": { + "$ref": "./examples/Plans_Get.json" + } + } + }, + "put": { + "tags": [ + "Plans" + ], + "description": "Creates or updates a devcenter plan resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter plan.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + } + ], + "operationId": "Plans_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Create": { + "$ref": "./examples/Plans_Create.json" + } + } + }, + "patch": { + "tags": [ + "Plans" + ], + "description": "Partially updates a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter plan properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PlanUpdate" + } + } + ], + "operationId": "Plans_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Update": { + "$ref": "./examples/Plans_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Plans" + ], + "description": "Deletes a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + } + ], + "operationId": "Plans_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Delete": { + "$ref": "./examples/Plans_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}/members": { + "get": { + "tags": [ + "Plans" + ], + "description": "Lists all of the members assigned to a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "PlanMembers_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PlanMembersListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_ListByResourceGroup": { + "$ref": "./examples/PlanMembers_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}/members/{memberName}": { + "get": { + "tags": [ + "Plans" + ], + "description": "Gets a devcenter plan member.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + } + ], + "operationId": "PlanMembers_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Get": { + "$ref": "./examples/PlanMembers_Get.json" + } + } + }, + "put": { + "tags": [ + "Plans" + ], + "description": "Creates or updates a devcenter plan member resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter plan.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + } + ], + "operationId": "PlanMembers_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Create": { + "$ref": "./examples/PlanMembers_Create.json" + } + } + }, + "patch": { + "tags": [ + "Plans" + ], + "description": "Partially updates a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter plan properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PlanMemberUpdate" + } + } + ], + "operationId": "PlanMembers_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Update": { + "$ref": "./examples/PlanMembers_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Plans" + ], + "description": "Deletes a devcenter plan member", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + } + ], + "operationId": "PlanMembers_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Delete": { + "$ref": "./examples/PlanMembers_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/devcenters": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Lists all devcenters in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "DevCenters_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_ListBySubscription": { + "$ref": "./examples/DevCenters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Lists all devcenters in 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "DevCenters_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_ListByResourceGroup": { + "$ref": "./examples/DevCenters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Gets a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + } + ], + "operationId": "DevCenters_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Get": { + "$ref": "./examples/DevCenters_Get.json" + } + } + }, + "put": { + "tags": [ + "DevCenters" + ], + "description": "Creates or updates a devcenter resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenter" + } + } + ], + "operationId": "DevCenters_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Create": { + "$ref": "./examples/DevCenters_Create.json" + }, + "DevCenters_CreateWithPlanId": { + "$ref": "./examples/DevCenters_CreateWithPlanId.json" + }, + "DevCenters_CreateWithUserIdentity": { + "$ref": "./examples/DevCenters_CreateWithUserIdentity.json" + }, + "DevCenters_CreateWithEncryption": { + "$ref": "./examples/DevCenters_CreateWithEncryption.json" + }, + "DevCenters_CreateWithDisabledManagedNetworks": { + "$ref": "./examples/DevCenters_CreateWithDisabledManagedNetworks.json" + } + } + }, + "patch": { + "tags": [ + "DevCenters" + ], + "description": "Partially updates a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter properties.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterUpdate" + } + } + ], + "operationId": "DevCenters_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Update": { + "$ref": "./examples/DevCenters_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DevCenters" + ], + "description": "Deletes a devcenter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + } + ], + "operationId": "DevCenters_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Delete": { + "$ref": "./examples/DevCenters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/encryptionSets": { + "get": { + "tags": [ + "EncryptionSets" + ], + "description": "Lists all encryption sets in the devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EncryptionSets_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EncryptionSetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_List": { + "$ref": "./examples/DevCenterEncryptionSets_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/encryptionSets/{encryptionSetName}": { + "get": { + "tags": [ + "EncryptionSets" + ], + "description": "Gets a devcenter encryption set.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + } + ], + "operationId": "EncryptionSets_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Get": { + "$ref": "./examples/DevCenterEncryptionSets_Get.json" + } + } + }, + "put": { + "tags": [ + "EncryptionSets" + ], + "description": "Creates or updates a devcenter encryption set resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter encryption set.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + } + ], + "operationId": "EncryptionSets_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Create": { + "$ref": "./examples/DevCenterEncryptionSets_Create.json" + } + } + }, + "patch": { + "tags": [ + "EncryptionSets" + ], + "description": "Partially updates a devcenter encryption set.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter encryption set properties.", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionSetUpdate" + } + } + ], + "operationId": "EncryptionSets_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Update": { + "$ref": "./examples/DevCenterEncryptionSets_Patch.json" + } + } + }, + "delete": { + "tags": [ + "EncryptionSets" + ], + "description": "Deletes a devcenter encryption set", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + } + ], + "operationId": "EncryptionSets_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Delete": { + "$ref": "./examples/DevCenterEncryptionSets_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Projects_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_ListBySubscription": { + "$ref": "./examples/Projects_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects in 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Projects_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_ListByResourceGroup": { + "$ref": "./examples/Projects_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}": { + "get": { + "tags": [ + "Projects" + ], + "description": "Gets a specific 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_Get": { + "$ref": "./examples/Projects_Get.json" + } + } + }, + "put": { + "tags": [ + "Projects" + ], + "description": "Creates or updates a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "operationId": "Projects_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_CreateOrUpdate": { + "$ref": "./examples/Projects_Put.json" + }, + "Projects_CreateOrUpdateWithLimitsPerDev": { + "$ref": "./examples/Projects_PutWithMaxDevBoxPerUser.json" + } + } + }, + "patch": { + "tags": [ + "Projects" + ], + "description": "Partially updates a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdate" + } + } + ], + "operationId": "Projects_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_Update": { + "$ref": "./examples/Projects_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Projects" + ], + "description": "Deletes a project resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_Delete": { + "$ref": "./examples/Projects_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/getInheritedSettings": { + "post": { + "tags": [ + "Projects" + ], + "description": "Gets applicable inherited settings for this 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_GetInheritedSettings", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InheritedSettingsForProject" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_GetInheritedSettings": { + "$ref": "./examples/Projects_GetInheritedSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks": { + "get": { + "tags": [ + "Attached NetworkConnections." + ], + "description": "Lists the attached NetworkConnections for a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "AttachedNetworks_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_ListByProject": { + "$ref": "./examples/AttachedNetworks_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks/{attachedNetworkConnectionName}": { + "get": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Gets an attached NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_GetByProject": { + "$ref": "./examples/AttachedNetworks_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs": { + "get": { + "tags": [ + "Project Catalogs" + ], + "description": "Lists the catalogs associated with a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectCatalogs_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_List": { + "$ref": "./examples/ProjectCatalogs_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}": { + "get": { + "tags": [ + "Project Catalogs" + ], + "description": "Gets an associated project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_Get": { + "$ref": "./examples/ProjectCatalogs_Get.json" + } + } + }, + "put": { + "tags": [ + "Project Catalogs" + ], + "description": "Creates or updates a project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a catalog.", + "required": true, + "schema": { + "$ref": "#/definitions/Catalog" + } + } + ], + "operationId": "ProjectCatalogs_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_CreateOrUpdateGitHub": { + "$ref": "./examples/ProjectCatalogs_CreateGitHub.json" + }, + "ProjectCatalogs_CreateOrUpdateAdo": { + "$ref": "./examples/ProjectCatalogs_CreateAdo.json" + } + } + }, + "patch": { + "tags": [ + "Project Catalogs" + ], + "description": "Partially updates a project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project catalog properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CatalogUpdate" + } + } + ], + "operationId": "ProjectCatalogs_Patch", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "202": { + "description": "The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_Patch": { + "$ref": "./examples/ProjectCatalogs_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Project Catalogs" + ], + "description": "Deletes a project catalog resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_Delete": { + "$ref": "./examples/ProjectCatalogs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Lists the environment definitions in this project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "EnvironmentDefinitions_ListByProjectCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_ListByProjectCatalog": { + "$ref": "./examples/EnvironmentDefinitions_ListByProjectCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets an environment definition from the catalog.", + "operationId": "EnvironmentDefinitions_GetByProjectCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_GetByProjectCatalog": { + "$ref": "./examples/EnvironmentDefinitions_GetByProjectCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}/getErrorDetails": { + "post": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets Environment Definition error details", + "operationId": "ProjectCatalogEnvironmentDefinitions_GetErrorDetails", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/CatalogResourceValidationErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogEnvironmentDefinitions_GetErrorDetails": { + "$ref": "./examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/getSyncErrorDetails": { + "post": { + "tags": [ + "Project Catalogs" + ], + "description": "Gets project catalog synchronization error details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_GetSyncErrorDetails", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SyncErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_GetSyncErrorDetails": { + "$ref": "./examples/ProjectCatalogs_GetSyncErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/sync": { + "post": { + "tags": [ + "Project Catalogs" + ], + "description": "Syncs templates for a template source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Sync", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_Sync": { + "$ref": "./examples/ProjectCatalogs_Sync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/connect": { + "post": { + "tags": [ + "Project Catalogs" + ], + "description": "Connects a project catalog to enable syncing.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Connect", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_Connect": { + "$ref": "./examples/ProjectCatalogs_Connect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "description": "Lists galleries for a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Galleries_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/GalleryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Galleries_ListByDevCenter": { + "$ref": "./examples/Galleries_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}": { + "get": { + "tags": [ + "Galleries" + ], + "description": "Gets a gallery", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + } + ], + "operationId": "Galleries_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Galleries_Get": { + "$ref": "./examples/Galleries_Get.json" + } + } + }, + "put": { + "tags": [ + "Galleries" + ], + "description": "Creates or updates a gallery.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a gallery.", + "required": true, + "schema": { + "$ref": "#/definitions/Gallery" + } + } + ], + "operationId": "Galleries_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Galleries_CreateOrUpdate": { + "$ref": "./examples/Galleries_Create.json" + } + } + }, + "delete": { + "tags": [ + "Galleries" + ], + "description": "Deletes a gallery resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + } + ], + "operationId": "Galleries_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Galleries_Delete": { + "$ref": "./examples/Galleries_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Images_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByDevCenter": { + "$ref": "./examples/Images_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a gallery.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Images_ListByGallery", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByGallery": { + "$ref": "./examples/Images_ListByGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}": { + "get": { + "tags": [ + "Images" + ], + "description": "Gets a gallery image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + } + ], + "operationId": "Images_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_Get": { + "$ref": "./examples/Images_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}/versions": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Lists versions for an image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + } + ], + "operationId": "ImageVersions_ListByImage", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_ListByImage": { + "$ref": "./examples/ImageVersions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}/versions/{versionName}": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Gets an image version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + } + ], + "operationId": "ImageVersions_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Versions_Get": { + "$ref": "./examples/ImageVersions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + } + ], + "operationId": "Images_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByProject": { + "$ref": "./examples/Images_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}": { + "get": { + "tags": [ + "Images" + ], + "description": "Gets an image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/ProjectImageNameParameter" + } + ], + "operationId": "Images_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_GetByProject": { + "$ref": "./examples/Images_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}/versions": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Lists versions for an image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/ProjectImageNameParameter" + } + ], + "operationId": "ImageVersions_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_ListByProject": { + "$ref": "./examples/ImageVersions_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}/versions/{versionName}": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Gets an image version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/ProjectImageNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + } + ], + "operationId": "ImageVersions_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_GetByProject": { + "$ref": "./examples/ImageVersions_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/listSkus": { + "post": { + "tags": [ + "Project SKUs" + ], + "description": "Lists SKUs available to 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Skus_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Skus_ListByProject": { + "$ref": "./examples/Skus_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks": { + "get": { + "tags": [ + "Attached NetworkConnections." + ], + "description": "Lists the attached NetworkConnections for a DevCenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "AttachedNetworks_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_ListByDevCenter": { + "$ref": "./examples/AttachedNetworks_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks/{attachedNetworkConnectionName}": { + "get": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Gets an attached NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_GetByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_GetByDevCenter": { + "$ref": "./examples/AttachedNetworks_GetByDevCenter.json" + } + } + }, + "put": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Creates or updates an attached NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an attached NetworkConnection.", + "required": true, + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + } + ], + "operationId": "AttachedNetworks_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "AttachedNetworks_Create": { + "$ref": "./examples/AttachedNetworks_Create.json" + } + } + }, + "delete": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Un-attach a NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_Delete": { + "$ref": "./examples/AttachedNetworks_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Lists catalogs for a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Catalogs_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListByDevCenter": { + "$ref": "./examples/Catalogs_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Gets a catalog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Get": { + "$ref": "./examples/Catalogs_Get.json" + } + } + }, + "put": { + "tags": [ + "Catalogs" + ], + "description": "Creates or updates a catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a catalog.", + "required": true, + "schema": { + "$ref": "#/definitions/Catalog" + } + } + ], + "operationId": "Catalogs_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_CreateOrUpdateGitHub": { + "$ref": "./examples/Catalogs_CreateGitHub.json" + }, + "Catalogs_CreateOrUpdateAdo": { + "$ref": "./examples/Catalogs_CreateAdo.json" + } + } + }, + "patch": { + "tags": [ + "Catalogs" + ], + "description": "Partially updates a catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable catalog properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CatalogUpdate" + } + } + ], + "operationId": "Catalogs_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "202": { + "description": "The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Update": { + "$ref": "./examples/Catalogs_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Catalogs" + ], + "description": "Deletes a catalog resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Delete": { + "$ref": "./examples/Catalogs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/getSyncErrorDetails": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "post": { + "tags": [ + "Catalogs" + ], + "description": "Gets catalog synchronization error details", + "operationId": "Catalogs_GetSyncErrorDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SyncErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_GetSyncErrorDetails": { + "$ref": "./examples/Catalogs_GetSyncErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/sync": { + "post": { + "tags": [ + "Catalogs" + ], + "description": "Syncs templates for a template source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Sync", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Sync": { + "$ref": "./examples/Catalogs_Sync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/connect": { + "post": { + "tags": [ + "Catalogs" + ], + "description": "Connects a catalog to enable syncing.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Connect", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Connect": { + "$ref": "./examples/Catalogs_Connect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists environment types for the devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EnvironmentTypes_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_ListByDevCenter": { + "$ref": "./examples/EnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "EnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Get": { + "$ref": "./examples/EnvironmentTypes_Get.json" + } + } + }, + "put": { + "tags": [ + "Environment Types" + ], + "description": "Creates or updates an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an Environment Type.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + } + ], + "operationId": "EnvironmentTypes_CreateOrUpdate", + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_CreateOrUpdate": { + "$ref": "./examples/EnvironmentTypes_Put.json" + } + } + }, + "patch": { + "tags": [ + "Environment Types" + ], + "description": "Partially updates an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable environment type properties.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentTypeUpdate" + } + } + ], + "operationId": "EnvironmentTypes_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Update": { + "$ref": "./examples/EnvironmentTypes_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Environment Types" + ], + "description": "Deletes an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "EnvironmentTypes_Delete", + "responses": { + "200": { + "description": "Resource was deleted." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Delete": { + "$ref": "./examples/EnvironmentTypes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists allowed environment types for a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectAllowedEnvironmentTypes_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AllowedEnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectAllowedEnvironmentTypes_List": { + "$ref": "./examples/ProjectAllowedEnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets an allowed environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectAllowedEnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AllowedEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectAllowedEnvironmentTypes_Get": { + "$ref": "./examples/ProjectAllowedEnvironmentTypes_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists environment types for a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_List": { + "$ref": "./examples/ProjectEnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Get": { + "$ref": "./examples/ProjectEnvironmentTypes_Get.json" + } + } + }, + "put": { + "tags": [ + "Environment Types" + ], + "description": "Creates or updates a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a Project Environment Type.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + } + ], + "operationId": "ProjectEnvironmentTypes_CreateOrUpdate", + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_CreateOrUpdate": { + "$ref": "./examples/ProjectEnvironmentTypes_Put.json" + } + } + }, + "patch": { + "tags": [ + "Environment Types" + ], + "description": "Partially updates a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project environment type properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectEnvironmentTypeUpdate" + } + } + ], + "operationId": "ProjectEnvironmentTypes_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Update": { + "$ref": "./examples/ProjectEnvironmentTypes_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Environment Types" + ], + "description": "Deletes a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_Delete", + "responses": { + "200": { + "description": "Resource was deleted." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Delete": { + "$ref": "./examples/ProjectEnvironmentTypes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "List Dev Box definitions for a devcenter.", + "operationId": "DevBoxDefinitions_ListByDevCenter", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DevBoxDefinitions_ListByDevCenter": { + "$ref": "./examples/DevBoxDefinitions_ListByDevCenter.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevBoxDefinitionName" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Gets a Dev Box definition", + "operationId": "DevBoxDefinitions_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Get": { + "$ref": "./examples/DevBoxDefinitions_Get.json" + } + } + }, + "put": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Creates or updates a Dev Box definition.", + "operationId": "DevBoxDefinitions_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a Dev Box definition.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "201": { + "description": "Created. The operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Create": { + "$ref": "./examples/DevBoxDefinitions_Create.json" + } + } + }, + "patch": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Partially updates a Dev Box definition.", + "operationId": "DevBoxDefinitions_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a Dev Box definition.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBoxDefinitionUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "202": { + "description": "Accepted. The operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Patch": { + "$ref": "./examples/DevBoxDefinitions_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Deletes a Dev Box definition", + "operationId": "DevBoxDefinitions_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [], + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Delete": { + "$ref": "./examples/DevBoxDefinitions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "List Dev Box definitions configured for a project.", + "operationId": "DevBoxDefinitions_ListByProject", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DevBoxDefinitions_ListByProject": { + "$ref": "./examples/DevBoxDefinitions_ListByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions/{devBoxDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/DevBoxDefinitionName" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Gets a Dev Box definition configured for a project", + "operationId": "DevBoxDefinitions_GetByProject", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_GetByProject": { + "$ref": "./examples/DevBoxDefinitions_GetByProject.json" + } + } + } + }, + "/providers/Microsoft.DevCenter/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available resource provider operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_Get": { + "$ref": "./examples/Operations_Get.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/operationStatuses/{operationId}": { + "get": { + "description": "Gets the current status of an async operation.", + "operationId": "OperationStatuses_Get", + "summary": "Get Operation Status", + "tags": [ + "OperationStatus" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "The requested operation status", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "The requested operation status", + "headers": { + "Location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/OperationStatus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/usages": { + "get": { + "operationId": "Usages_ListByLocation", + "description": "Lists the current usages and limits in this location for the provided subscription.", + "tags": [ + "Usages" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; a list of usages is returned", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "The default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "listUsages": { + "$ref": "./examples/Usages_ListByLocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/checkScopedNameAvailability": { + "post": { + "tags": [ + "CheckScopedNameAvailability" + ], + "operationId": "CheckScopedNameAvailability_Execute", + "x-ms-examples": { + "DevcenterCatalogNameAvailability": { + "$ref": "./examples/CheckScopedNameAvailability_DevCenterCatalog.json" + }, + "ProjectCatalogNameAvailability": { + "$ref": "./examples/CheckScopedNameAvailability_ProjectCatalog.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckScopedNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Customization Tasks" + ], + "description": "List Tasks in the catalog.", + "operationId": "CustomizationTasks_ListByCatalog", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationTaskListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CustomizationTasks_ListByCatalog": { + "$ref": "./examples/CustomizationTasks_ListByCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks/{taskName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/CustomizationTaskNameParameter" + } + ], + "get": { + "tags": [ + "Customization Tasks" + ], + "description": "Gets a Task from the catalog", + "operationId": "CustomizationTasks_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomizationTasks_Get": { + "$ref": "./examples/CustomizationTasks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks/{taskName}/getErrorDetails": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/CustomizationTaskNameParameter" + } + ], + "post": { + "tags": [ + "Customization Tasks" + ], + "description": "Gets Customization Task error details", + "operationId": "CustomizationTasks_GetErrorDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/CatalogResourceValidationErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomizationTasks_GetErrorDetails": { + "$ref": "./examples/CustomizationTasks_GetErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "List environment definitions in the catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EnvironmentDefinitions_ListByCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EnvironmentDefinitions_ListByCatalog": { + "$ref": "./examples/EnvironmentDefinitions_ListByCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets an environment definition from the catalog.", + "operationId": "EnvironmentDefinitions_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_Get": { + "$ref": "./examples/EnvironmentDefinitions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}/getErrorDetails": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "post": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets Environment Definition error details", + "operationId": "EnvironmentDefinitions_GetErrorDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/CatalogResourceValidationErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_GetErrorDetails": { + "$ref": "./examples/EnvironmentDefinitions_GetErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "List Image Definitions in the catalog.", + "operationId": "ProjectCatalogImageDefinitions_ListByProjectCatalog", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImageDefinitions_ListByProjectCatalog": { + "$ref": "./examples/ImageDefinitions_ListByProjectCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "Gets an Image Definition from the catalog", + "operationId": "ProjectCatalogImageDefinitions_GetByProjectCatalog", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitions_GetByProjectCatalog": { + "$ref": "./examples/ImageDefinitions_GetByProjectCatalog.json" + } + } + } + } + }, + "definitions": { + "DevCenterPlan": { + "type": "object", + "description": "Represents a devcenter plan resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Plan properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PlanProperties" + }, + "sku": { + "description": "The SKU for DevCenters created using this definition.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + } + }, + "PlanProperties": { + "description": "Properties of the devcenter plan.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DevCenterPlanMember": { + "type": "object", + "description": "Represents a devcenter plan member resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Plan member properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PlanMemberProperties" + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "PlanMemberProperties": { + "description": "Properties of the devcenter plan member.", + "type": "object", + "properties": { + "memberId": { + "description": "The unique id of the member.", + "type": "string" + }, + "memberType": { + "description": "The type of the member (user, group)", + "enum": [ + "User", + "Group" + ], + "type": "string", + "x-ms-enum": { + "name": "PlanMemberType", + "modelAsString": true + } + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "PlanMemberUpdate": { + "description": "The devcenter plan member resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "DevCenter": { + "type": "object", + "description": "Represents a devcenter resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "DevCenter properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterProperties" + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "DevCenterProperties": { + "description": "Properties of the devcenter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevCenterUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "devCenterUri": { + "description": "The URI of the Dev Center.", + "$ref": "#/definitions/DevCenterUri", + "readOnly": true + } + } + }, + "DevCenterUpdateProperties": { + "description": "Properties of the devcenter. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "planId": { + "type": "string", + "description": "Resource Id of an associated Plan" + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption settings to be used for server-side encryption for proprietary content (such as catalogs, logs, customizations)." + }, + "displayName": { + "type": "string", + "description": "The display name of the devcenter." + }, + "projectCatalogSettings": { + "$ref": "#/definitions/DevCenterProjectCatalogSettings", + "description": "Dev Center settings to be used when associating a project with a catalog." + }, + "networkSettings": { + "$ref": "#/definitions/DevCenterNetworkSettings", + "description": "Network settings that will be enforced on network resources associated with the Dev Center." + }, + "devBoxProvisioningSettings": { + "$ref": "#/definitions/DevBoxProvisioningSettings", + "description": "Settings to be used in the provisioning of all Dev Boxes that belong to this dev center." + } + } + }, + "DevCenterEncryptionSet": { + "description": "Represents a devcenter encryption set resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterEncryptionSetProperties", + "description": "Properties of a devcenter encryption set." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "DevCenterEncryptionSetProperties": { + "description": "Properties of the devcenter encryption set.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevCenterEncryptionSetUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DevCenterEncryptionSetUpdateProperties": { + "description": "Properties of the devcenter encryption set. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devboxDisksEncryptionEnableStatus": { + "description": "Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption using DevCenter CMK is enabled or not.", + "$ref": "#/definitions/DevboxDisksEncryptionEnableStatus" + }, + "keyEncryptionKeyUrl": { + "type": "string", + "description": "Key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek." + } + } + }, + "DevboxDisksEncryptionEnableStatus": { + "description": "Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption is enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DevboxDisksEncryptionEnableStatus", + "modelAsString": true + } + }, + "DevCenterProjectCatalogSettings": { + "type": "object", + "description": "Project catalog settings for project catalogs under a project associated to this dev center.", + "properties": { + "catalogItemSyncEnableStatus": { + "description": "Whether project catalogs associated with projects in this dev center can be configured to sync catalog items.", + "$ref": "#/definitions/CatalogItemSyncEnableStatus" + } + } + }, + "DevBoxProvisioningSettings": { + "type": "object", + "description": "Provisioning settings that apply to all Dev Boxes created in this dev center", + "properties": { + "installAzureMonitorAgentEnableStatus": { + "description": "Whether project catalogs associated with projects in this dev center can be configured to sync catalog items.", + "$ref": "#/definitions/InstallAzureMonitorAgentEnableStatus" + } + } + }, + "CatalogItemSyncEnableStatus": { + "description": "Catalog item sync types enable or disable status. Indicates whether project catalogs are allowed to sync catalog items under projects associated to this dev center.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogItemSyncEnableStatus", + "modelAsString": true + } + }, + "DevCenterNetworkSettings": { + "type": "object", + "description": "Network settings for the Dev Center.", + "properties": { + "microsoftHostedNetworkEnableStatus": { + "$ref": "#/definitions/MicrosoftHostedNetworkEnableStatus" + } + } + }, + "ProjectNetworkSettings": { + "type": "object", + "description": "Network settings for the project.", + "properties": { + "microsoftHostedNetworkEnableStatus": { + "$ref": "#/definitions/MicrosoftHostedNetworkEnableStatus", + "readOnly": true + } + } + }, + "MicrosoftHostedNetworkEnableStatus": { + "description": "Indicates whether pools in this Dev Center can use Microsoft Hosted Networks. Defaults to Enabled if not set.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MicrosoftHostedNetworkEnableStatus", + "modelAsString": true + } + }, + "Encryption": { + "type": "object", + "properties": { + "customerManagedKeyEncryption": { + "$ref": "../../../../../common-types/resource-management/v4/customermanagedkeys.json#/definitions/customerManagedKeyEncryption" + } + } + }, + "InstallAzureMonitorAgentEnableStatus": { + "description": "Setting to be used when determining whether to install the Azure Monitor Agent service on Dev Boxes that belong to this dev center.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "InstallAzureMonitorAgentEnableStatus", + "modelAsString": true + } + }, + "PlanUpdate": { + "description": "The devcenter plan resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "sku": { + "description": "The SKU for DevCenters created using this definition.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + } + }, + "DevCenterUpdate": { + "description": "The devcenter resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterUpdateProperties", + "description": "Properties of a Dev Center to be updated." + } + } + }, + "EncryptionSetUpdate": { + "description": "The devcenter encryption set resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterEncryptionSetUpdateProperties", + "description": "Properties of a Dev Center encryption set to be updated." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "PlanListResult": { + "description": "Result of the list devcenter plans operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "PlanMembersListResult": { + "description": "Result of the list devcenter plan members operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevCenterListResult": { + "description": "Result of the list devcenters operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenter" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionSetListResult": { + "description": "Result of the list devcenter encryption set operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevCenterUri": { + "description": "The URI of the resource.", + "readOnly": true, + "type": "string" + }, + "Project": { + "description": "Represents a project resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectProperties", + "description": "Properties of a project." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectUpdateProperties": { + "description": "Properties of a project. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devCenterId": { + "type": "string", + "description": "Resource Id of an associated DevCenter" + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "maxDevBoxesPerUser": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. This will have no effect on existing Dev Boxes when reduced." + }, + "displayName": { + "type": "string", + "description": "The display name of the project." + }, + "catalogSettings": { + "$ref": "#/definitions/ProjectCatalogSettings", + "description": "Settings to be used when associating a project with a catalog." + } + } + }, + "ProjectCatalogSettings": { + "description": "Settings to be used when associating a project with a catalog.", + "type": "object", + "properties": { + "catalogItemSyncTypes": { + "description": "Indicates catalog item types that can be synced.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItemType" + } + } + } + }, + "ProjectProperties": { + "description": "Properties of a project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProjectUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "devCenterUri": { + "description": "The URI of the Dev Center resource this project is associated with.", + "$ref": "#/definitions/DevCenterUri", + "readOnly": true + } + } + }, + "ProjectUpdate": { + "description": "The project properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectUpdateProperties", + "description": "Properties of a project to be updated." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectListResult": { + "description": "Results of the project list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Project" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "InheritedSettingsForProject": { + "description": "Applicable inherited settings for a project.", + "type": "object", + "properties": { + "projectCatalogSettings": { + "$ref": "#/definitions/DevCenterProjectCatalogSettings", + "description": "Dev Center settings to be used when associating a project with a catalog.", + "readOnly": true + }, + "networkSettings": { + "$ref": "#/definitions/ProjectNetworkSettings", + "description": "Network settings that will be enforced on this project.", + "readOnly": true + } + } + }, + "Catalog": { + "description": "Represents a catalog.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CatalogProperties", + "description": "Catalog properties." + } + } + }, + "CatalogUpdateProperties": { + "description": "Properties of a catalog. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "gitHub": { + "description": "Properties for a GitHub catalog type.", + "$ref": "#/definitions/GitCatalog" + }, + "adoGit": { + "description": "Properties for an Azure DevOps catalog type.", + "$ref": "#/definitions/GitCatalog" + }, + "syncType": { + "enum": [ + "Manual", + "Scheduled" + ], + "description": "Indicates the type of sync that is configured for the catalog.", + "type": "string", + "x-ms-enum": { + "name": "CatalogSyncType", + "modelAsString": true + } + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "CatalogProperties": { + "description": "Properties of a catalog.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CatalogUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "syncState": { + "enum": [ + "Succeeded", + "InProgress", + "Failed", + "Canceled" + ], + "description": "The synchronization state of the catalog.", + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "CatalogSyncState", + "modelAsString": true + } + }, + "lastSyncStats": { + "description": "Stats of the latest synchronization.", + "$ref": "#/definitions/SyncStats", + "readOnly": true + }, + "connectionState": { + "enum": [ + "Connected", + "Disconnected" + ], + "description": "The connection state of the catalog.", + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "CatalogConnectionState", + "modelAsString": true + } + }, + "lastConnectionTime": { + "description": "When the catalog was last connected.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "lastSyncTime": { + "description": "When the catalog was last synced.", + "type": "string", + "readOnly": true, + "format": "date-time" + } + } + }, + "SyncStats": { + "description": "Stats of the synchronization.", + "type": "object", + "properties": { + "added": { + "description": "Count of catalog items added during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "updated": { + "description": "Count of catalog items updated during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "unchanged": { + "description": "Count of catalog items that were unchanged during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "removed": { + "description": "Count of catalog items removed during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "validationErrors": { + "description": "Count of catalog items that had validation errors during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "synchronizationErrors": { + "description": "Count of synchronization errors that occured during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "syncedCatalogItemTypes": { + "description": "Indicates catalog item types that were synced.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItemType" + } + } + } + }, + "GitCatalog": { + "description": "Properties for a Git repository catalog.", + "type": "object", + "properties": { + "uri": { + "description": "Git URI.", + "type": "string" + }, + "branch": { + "description": "Git branch.", + "type": "string" + }, + "secretIdentifier": { + "description": "A reference to the Key Vault secret containing a security token to authenticate to a Git repository.", + "type": "string" + }, + "path": { + "description": "The folder where the catalog items can be found inside the repository.", + "type": "string" + } + } + }, + "CatalogUpdate": { + "description": "The catalog's properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CatalogUpdateProperties", + "description": "Catalog properties for update." + } + } + }, + "CatalogListResult": { + "description": "Results of the catalog list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Catalog" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "SyncErrorDetails": { + "description": "Synchronization error details.", + "type": "object", + "properties": { + "operationError": { + "description": "Error information for the overall synchronization operation.", + "readOnly": true, + "$ref": "vdi.json#/definitions/CatalogErrorDetails" + }, + "conflicts": { + "description": "Catalog items that have conflicting names.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogConflictError" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "errors": { + "description": "Errors that occured during synchronization.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogSyncError" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "CatalogSyncError": { + "description": "An individual synchronization error.", + "type": "object", + "properties": { + "path": { + "description": "The path of the file the error is associated with.", + "type": "string", + "readOnly": true + }, + "errorDetails": { + "description": "Errors associated with the file.", + "type": "array", + "items": { + "$ref": "vdi.json#/definitions/CatalogErrorDetails" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "CatalogConflictError": { + "description": "An individual conflict error.", + "type": "object", + "properties": { + "path": { + "description": "The path of the file that has a conflicting name.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the conflicting catalog item.", + "type": "string", + "readOnly": true + } + } + }, + "Gallery": { + "description": "Represents a gallery.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties", + "description": "Gallery properties." + } + } + }, + "GalleryProperties": { + "description": "Properties of a gallery.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "galleryResourceId": { + "description": "The resource ID of the backing Azure Compute Gallery.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "galleryResourceId" + ] + }, + "Image": { + "description": "Represents an image.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties", + "description": "Image properties." + } + } + }, + "ImageProperties": { + "description": "Properties of an image.", + "type": "object", + "properties": { + "description": { + "description": "The description of the image.", + "type": "string", + "readOnly": true + }, + "publisher": { + "description": "The publisher of the image.", + "type": "string", + "readOnly": true + }, + "offer": { + "description": "The name of the image offer.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The SKU name for the image.", + "type": "string", + "readOnly": true + }, + "recommendedMachineConfiguration": { + "description": "The recommended machine configuration to use with the image.", + "$ref": "#/definitions/RecommendedMachineConfiguration", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "hibernateSupport": { + "description": "Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate", + "readOnly": true, + "$ref": "#/definitions/HibernateSupport" + } + } + }, + "RecommendedMachineConfiguration": { + "description": "Properties for a recommended machine configuration.", + "type": "object", + "properties": { + "memory": { + "description": "Recommended memory range.", + "$ref": "#/definitions/ResourceRange", + "readOnly": true + }, + "vCPUs": { + "description": "Recommended vCPU range.", + "$ref": "#/definitions/ResourceRange", + "readOnly": true + } + } + }, + "ResourceRange": { + "description": "Properties for a range of values.", + "type": "object", + "properties": { + "min": { + "description": "Minimum value.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "max": { + "description": "Maximum value.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ImageVersion": { + "description": "Represents an image version.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageVersionProperties", + "description": "Image version properties." + } + } + }, + "ImageVersionProperties": { + "description": "Properties of an image version.", + "type": "object", + "properties": { + "name": { + "description": "The semantic version string.", + "type": "string", + "readOnly": true + }, + "publishedDate": { + "description": "The datetime that the backing image version was published.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "excludeFromLatest": { + "description": "If the version should be excluded from being treated as the latest version.", + "type": "boolean", + "readOnly": true + }, + "osDiskImageSizeInGb": { + "description": "The size of the OS disk image, in GB.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "GalleryListResult": { + "description": "Results of the gallery list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Gallery" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageListResult": { + "description": "Results of the image list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Image" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageVersionListResult": { + "description": "Results of the image version list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ImageVersion" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "AllowedEnvironmentType": { + "description": "Represents an allowed environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AllowedEnvironmentTypeProperties", + "description": "Properties of an allowed environment type." + } + } + }, + "AllowedEnvironmentTypeProperties": { + "description": "Properties of an allowed environment type.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "displayName": { + "description": "The display name of the allowed environment type.", + "type": "string", + "readOnly": true + } + } + }, + "AllowedEnvironmentTypeListResult": { + "description": "Result of the allowed environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AllowedEnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentType": { + "description": "Represents an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentTypeProperties", + "description": "Properties of an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "EnvironmentTypeProperties": { + "description": "Properties of an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentTypeUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "EnvironmentTypeUpdate": { + "description": "The environment type for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentTypeUpdateProperties", + "description": "Properties of an environment type to be updated." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "EnvironmentTypeUpdateProperties": { + "description": "Properties of an environment type. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The display name of the environment type." + } + } + }, + "EnvironmentTypeListResult": { + "description": "Result of the environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ProjectEnvironmentType": { + "description": "Represents an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectEnvironmentTypeProperties", + "description": "Properties of an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "type": "string", + "description": "The geo-location for the environment type" + } + } + }, + "ProjectEnvironmentTypeUpdateProperties": { + "description": "Properties of a project environment type. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "deploymentTargetId": { + "description": "Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.", + "type": "string" + }, + "displayName": { + "description": "The display name of the project environment type.", + "type": "string" + }, + "status": { + "description": "Defines whether this Environment Type can be used in this Project.", + "$ref": "#/definitions/EnvironmentTypeEnableStatus" + }, + "creatorRoleAssignment": { + "description": "The role definition assigned to the environment creator on backing resources.", + "type": "object", + "properties": { + "roles": { + "type": "object", + "description": "A map of roles to assign to the environment creator.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentRole" + } + } + } + }, + "userRoleAssignments": { + "description": "Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserRoleAssignment" + } + } + } + }, + "ProjectEnvironmentTypeProperties": { + "description": "Properties of a project environment type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProjectEnvironmentTypeUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "environmentCount": { + "description": "The number of environments of this type.", + "type": "integer", + "format": "int32", + "minimum": 0, + "readOnly": true + } + } + }, + "ProjectEnvironmentTypeUpdate": { + "description": "The project environment type for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectEnvironmentTypeUpdateProperties", + "description": "Properties to configure an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectEnvironmentTypeListResult": { + "description": "Result of the project environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevBoxDefinitionListResult": { + "description": "Results of the Dev Box definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevBoxDefinitionUpdate": { + "description": "Partial update of a Dev Box definition resource.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevBoxDefinitionUpdateProperties", + "description": "Properties of a Dev Box definition to be updated." + } + } + }, + "DevBoxDefinition": { + "description": "Represents a definition for a Developer Machine.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Dev Box definition properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevBoxDefinitionProperties" + } + } + }, + "DevBoxDefinitionUpdateProperties": { + "description": "Properties of a Dev Box definition. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information." + }, + "sku": { + "description": "The SKU for Dev Boxes created using this definition.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + }, + "osStorageType": { + "description": "The storage type used for the Operating System disk of Dev Boxes created using this definition.", + "type": "string" + }, + "hibernateSupport": { + "description": "Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate", + "$ref": "#/definitions/HibernateSupport" + } + } + }, + "DevBoxDefinitionProperties": { + "description": "Properties of a Dev Box definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevBoxDefinitionUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "imageValidationStatus": { + "description": "Validation status of the configured image.", + "$ref": "vdi.json#/definitions/ImageValidationStatus", + "readOnly": true + }, + "imageValidationErrorDetails": { + "description": "Details for image validator error. Populated when the image validation is not successful.", + "$ref": "vdi.json#/definitions/ImageValidationErrorDetails", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the Dev Box Definition.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + }, + "activeImageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information for the currently active image (only populated during updates).", + "readOnly": true + } + }, + "required": [ + "imageReference", + "sku" + ] + }, + "AttachedNetworkConnection": { + "description": "Represents an attached NetworkConnection.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AttachedNetworkConnectionProperties", + "description": "Attached NetworkConnection properties." + } + } + }, + "AttachedNetworkConnectionProperties": { + "description": "Properties of an attached NetworkConnection.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "networkConnectionId": { + "description": "The resource ID of the NetworkConnection you want to attach.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkConnectionLocation": { + "description": "The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives.", + "type": "string", + "readOnly": true + }, + "healthCheckStatus": { + "$ref": "vdi.json#/definitions/HealthCheckStatus", + "readOnly": true + }, + "domainJoinType": { + "description": "AAD Join type of the network. This is populated based on the referenced Network Connection.", + "$ref": "vdi.json#/definitions/DomainJoinType", + "readOnly": true + } + }, + "required": [ + "networkConnectionId" + ] + }, + "AttachedNetworkListResult": { + "description": "Results of the Attached Networks list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/AttachedNetworkConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentRole": { + "type": "object", + "description": "A role that can be assigned to a user.", + "properties": { + "roleName": { + "description": "The common name of the Role Assignment. This is a descriptive name such as 'AcrPush'.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "This is a description of the Role Assignment.", + "type": "string", + "readOnly": true + } + } + }, + "UserRoleAssignment": { + "type": "object", + "description": "Mapping of user object ID to role assignments.", + "x-ms-client-name": "userRoleAssignmentValue", + "properties": { + "roles": { + "type": "object", + "description": "A map of roles to assign to the parent user.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentRole" + } + } + } + }, + "OperationStatus": { + "description": "The current status of an async operation", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + ], + "properties": { + "properties": { + "description": "Custom operation properties, populated only for a successful operation.", + "type": "object", + "readOnly": true + } + } + }, + "CatalogItemType": { + "description": "Indicates catalog item types.", + "enum": [ + "EnvironmentDefinition", + "ImageDefinition" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "EnvironmentTypeEnableStatus": { + "description": "Indicates whether the environment type is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentTypeEnableStatus", + "modelAsString": true + } + }, + "HibernateSupport": { + "description": "Indicates whether hibernate is enabled/disabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true + } + }, + "ListUsagesResult": { + "description": "List of Core Usages.", + "type": "object", + "properties": { + "value": { + "description": "The array page of Usages.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "The link to get the next page of Usage result.", + "type": "string", + "readOnly": true + } + } + }, + "Usage": { + "description": "The core usage details.", + "type": "object", + "properties": { + "currentValue": { + "description": "The current usage.", + "type": "integer", + "format": "int64" + }, + "limit": { + "description": "The limit integer.", + "type": "integer", + "format": "int64" + }, + "unit": { + "description": "The unit details.", + "type": "string", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "name": { + "description": "The name.", + "$ref": "#/definitions/UsageName" + }, + "id": { + "description": "The fully qualified arm resource id.", + "type": "string" + } + } + }, + "UsageName": { + "description": "The Usage Names.", + "type": "object", + "properties": { + "localizedValue": { + "description": "The localized name of the resource.", + "type": "string" + }, + "value": { + "description": "The name of the resource.", + "type": "string" + } + } + }, + "CustomizationTaskListResult": { + "description": "Results of the Task list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomizationTask" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "CustomizationTask": { + "description": "Represents a Task to be used in customizing a Dev Box.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Task properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomizationTaskProperties" + } + } + }, + "CustomizationTaskProperties": { + "description": "Properties of a Task.", + "type": "object", + "properties": { + "inputs": { + "description": "Inputs to the task.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomizationTaskInput" + }, + "readOnly": true + }, + "timeout": { + "description": "The default timeout for the task.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the Task.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + } + } + }, + "CustomizationTaskInput": { + "description": "Input for a Task.", + "type": "object", + "properties": { + "description": { + "description": "Description of the input.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the input.", + "type": "string", + "enum": [ + "string", + "number", + "boolean" + ], + "x-ms-enum": { + "name": "CustomizationTaskInputType", + "modelAsString": true + }, + "readOnly": true + }, + "required": { + "description": "Whether or not the input is required.", + "type": "boolean", + "readOnly": true + } + } + }, + "EnvironmentDefinitionListResult": { + "description": "Results of the environment definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentDefinition": { + "description": "Represents an environment definition catalog item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Environment definition properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentDefinitionProperties" + } + } + }, + "EnvironmentDefinitionProperties": { + "description": "Properties of an environment definition.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the environment definition.", + "type": "string", + "readOnly": true + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinitionParameter" + }, + "description": "Input parameters passed to an environment.", + "readOnly": true + }, + "templatePath": { + "description": "Path to the Environment Definition entrypoint file.", + "type": "string", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the environment definition.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + } + } + }, + "EnvironmentDefinitionParameter": { + "type": "object", + "description": "Properties of an Environment Definition parameter", + "properties": { + "id": { + "type": "string", + "description": "Unique ID of the parameter", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Display name of the parameter", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the parameter", + "readOnly": true + }, + "type": { + "description": "A string of one of the basic JSON types (number, integer, array, object, boolean, string)", + "$ref": "#/definitions/ParameterType", + "readOnly": true + }, + "readOnly": { + "type": "boolean", + "description": "Whether or not this parameter is read-only. If true, default should have a value.", + "readOnly": true + }, + "required": { + "type": "boolean", + "description": "Whether or not this parameter is required", + "readOnly": true + } + } + }, + "ParameterType": { + "type": "string", + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string" + ], + "description": "The type of data a parameter accepts.", + "readOnly": true, + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true, + "values": [ + { + "value": "array", + "description": "The parameter accepts an array of values." + }, + { + "value": "boolean", + "description": "The parameter accepts a boolean value." + }, + { + "value": "integer", + "description": "The parameter accepts an integer value." + }, + { + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "value": "object", + "description": "The parameter accepts an object value." + }, + { + "value": "string", + "description": "The parameter accepts a string value." + } + ] + } + }, + "CheckScopedNameAvailabilityRequest": { + "description": "The scoped name check availability request body.", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "The resource type.", + "type": "string" + }, + "scope": { + "description": "The resource id to scope the name check.", + "type": "string" + } + } + }, + "ImageDefinitionListResult": { + "description": "Results of the Image Definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageDefinition": { + "description": "Represents a definition for an Image.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Image Definition properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageDefinitionProperties" + } + } + }, + "ImageDefinitionProperties": { + "description": "Properties of an Image Definition.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information." + } + }, + "required": [ + "imageReference" + ] + } + }, + "parameters": { + "PlanNameParameter": { + "name": "planName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter plan.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "PlanMemberNameParameter": { + "name": "memberName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a devcenter plan member.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "DevCenterNameParameter": { + "name": "devCenterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$", + "minLength": 3, + "maxLength": 26 + }, + "DevCenterEncryptionSetNameParameter": { + "name": "encryptionSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter encryption set.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$", + "minLength": 3, + "maxLength": 63 + }, + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the project.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "CatalogNameParameter": { + "name": "catalogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Catalog.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "GalleryNameParameter": { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ImageNameParameter": { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]{0,78}[a-zA-Z0-9]$", + "minLength": 3, + "maxLength": 80 + }, + "ProjectImageNameParameter": { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9~][a-zA-Z0-9-.~]{0,151}[a-zA-Z0-9]$", + "minLength": 3, + "maxLength": 153 + }, + "VersionNameParameter": { + "name": "versionName", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the image.", + "x-ms-parameter-location": "method", + "pattern": "^[0-9]{1,10}[.][0-9]{1,10}[.][0-9]{1,10}$", + "minLength": 5, + "maxLength": 32 + }, + "EnvironmentTypeNameParameter": { + "name": "environmentTypeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the environment type.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "AttachedNetworkConnectionNameParameter": { + "name": "attachedNetworkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the attached NetworkConnection.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "DevBoxDefinitionName": { + "name": "devBoxDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Dev Box definition.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName').", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "description": "The Azure region", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "description": "The ID of an ongoing async operation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CustomizationTaskNameParameter": { + "name": "taskName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Task.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "EnvironmentDefinitionNameParameter": { + "name": "environmentDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Environment Definition.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ImageDefinitionNameParameter": { + "name": "imageDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Image Definition.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_Create.json new file mode 100644 index 000000000000..128033ffc00f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_Create.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3", + "body": { + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_Delete.json new file mode 100644 index 000000000000..c9af0cb42b0a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_GetByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_GetByDevCenter.json new file mode 100644 index 000000000000..a9e1d4479254 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_GetByDevCenter.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_GetByProject.json new file mode 100644 index 000000000000..af6e496b47e5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_GetByProject.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/projects/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_ListByDevCenter.json new file mode 100644 index 000000000000..f96943d667b0 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_ListByDevCenter.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/netmap1", + "name": "netmap1", + "type": "Microsoft.DevCenter/devcenters/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "Application", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/netmap2", + "name": "netmap2", + "type": "Microsoft.DevCenter/devcenters/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_ListByProject.json new file mode 100644 index 000000000000..855a280115ce --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/AttachedNetworks_ListByProject.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/netmap1", + "name": "netmap1", + "type": "Microsoft.DevCenter/projects/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "Application", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/netmap2", + "name": "netmap2", + "type": "Microsoft.DevCenter/projects/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Connect.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Connect.json new file mode 100644 index 000000000000..c5b45c5f80dc --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Connect.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_CreateAdo.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_CreateAdo.json new file mode 100644 index 000000000000..7c87ecc5bf39 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_CreateAdo.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "syncType": "Scheduled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_CreateGitHub.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_CreateGitHub.json new file mode 100644 index 000000000000..e42941258315 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_CreateGitHub.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "syncType": "Manual" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Manual" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Manual" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Delete.json new file mode 100644 index 000000000000..01363185614d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Get.json new file mode 100644 index 000000000000..56431803f829 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_GetSyncErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_GetSyncErrorDetails.json new file mode 100644 index 000000000000..34f84993b95b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_GetSyncErrorDetails.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "operationError": { + "code": "Conflict", + "message": "The source control credentials could not be validated successfully." + }, + "conflicts": [ + { + "path": "/Environments/Duplicate/manifest.yaml", + "name": "DuplicateEnvironmentName" + } + ], + "errors": [ + { + "path": "/Environments/Invalid/manifest.yaml", + "errorDetails": [ + { + "code": "ParseError", + "message": "Schema Error Within Catalog Item: Missing Name" + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_List.json new file mode 100644 index 000000000000..621960426b54 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Patch.json new file mode 100644 index 000000000000..83b06b48c300 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Patch.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "path": "/environments" + }, + "syncType": "Scheduled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/environments" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Sync.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Sync.json new file mode 100644 index 000000000000..c5b45c5f80dc --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Catalogs_Sync.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckNameAvailability.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..84b26d919f72 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/devcenters" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json new file mode 100644 index 000000000000..25192b4d4c3b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "scope": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json new file mode 100644 index 000000000000..1691a87ef0a9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/projects/catalogs", + "scope": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_Get.json new file mode 100644 index 000000000000..8c77588e3720 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "taskName": "SampleTask" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog/tasks/SampleTask", + "name": "SampleTask", + "type": "Microsoft.DevCenter/devcenters/catalogs/tasks", + "properties": { + "inputs": { + "package": { + "type": "string", + "required": true + }, + "feed": { + "type": "string" + } + }, + "timeout": 30, + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_GetErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_GetErrorDetails.json new file mode 100644 index 000000000000..cc7375b09ae6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_GetErrorDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "taskName": "SampleTask" + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "code": "ParameterValueInvalid", + "message": "Expected parameter value for 'InstanceCount' to be integer but found the string 'test'." + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_ListByCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_ListByCatalog.json new file mode 100644 index 000000000000..b2df9cbb719f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/CustomizationTasks_ListByCatalog.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog/tasks/SampleTask", + "name": "SampleTask", + "type": "Microsoft.DevCenter/devcenters/catalogs/tasks", + "properties": { + "inputs": { + "package": { + "type": "string", + "required": true + }, + "feed": { + "type": "string" + } + }, + "timeout": 30 + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Create.json new file mode 100644 index 000000000000..9add845c2a01 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Create.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox", + "body": { + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Created" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Delete.json new file mode 100644 index 000000000000..c12977e9b88d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Get.json new file mode 100644 index 000000000000..6643a11272c5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_GetByProject.json new file mode 100644 index 000000000000..452677d2fbbf --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_GetByProject.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json new file mode 100644 index 000000000000..109b10c9d7bf --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_ListByProject.json new file mode 100644 index 000000000000..d6282b4e8895 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_ListByProject.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Patch.json new file mode 100644 index 000000000000..1440314d9cbc --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevBoxDefinitions_Patch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox", + "body": { + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Create.json new file mode 100644 index 000000000000..5a22d7802dbd --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Create.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs", + "body": { + "location": "westus", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Accepted" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Accepted" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Delete.json new file mode 100644 index 000000000000..1ae4c08efc0a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Get.json new file mode 100644 index 000000000000..730f3d774db9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_List.json new file mode 100644 index 000000000000..9150ff98ed56 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Patch.json new file mode 100644 index 000000000000..e08e69e0a7a6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenterEncryptionSets_Patch.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs", + "body": { + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokekwestus", + "provisioningState": "Accepted" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Create.json new file mode 100644 index 000000000000..260071f3f341 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Create.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json new file mode 100644 index 000000000000..44dd2a938588 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Disabled" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Disabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Disabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithEncryption.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithEncryption.json new file mode 100644 index 000000000000..c8fdbea09d16 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithEncryption.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" + }, + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokek" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" + }, + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokek" + } + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" + }, + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokek" + } + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithPlanId.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithPlanId.json new file mode 100644 index 000000000000..f8f17c2a9c0d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithPlanId.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "planId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "planId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "planId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithUserIdentity.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithUserIdentity.json new file mode 100644 index 000000000000..5b38e857d49d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_CreateWithUserIdentity.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Delete.json new file mode 100644 index 000000000000..748d7b0d6dce --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Get.json new file mode 100644 index 000000000000..88b83f1855a3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_ListByResourceGroup.json new file mode 100644 index 000000000000..f2830c1fca64 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_ListBySubscription.json new file mode 100644 index 000000000000..20687ef46609 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_ListBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Patch.json new file mode 100644 index 000000000000..b41d5ed93550 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/DevCenters_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_Get.json new file mode 100644 index 000000000000..1061801f0d3e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_Get.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/devcenters/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json new file mode 100644 index 000000000000..dcf811c64d92 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/projects/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json new file mode 100644 index 000000000000..6adc501a6637 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "code": "ParameterValueInvalid", + "message": "Expected parameter value for 'InstanceCount' to be integer but found the string 'test'." + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json new file mode 100644 index 000000000000..60f66d60c483 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/devcenters/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json new file mode 100644 index 000000000000..10ca4df1f219 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/projects/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Delete.json new file mode 100644 index 000000000000..dd7b40c6ff33 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Get.json new file mode 100644 index 000000000000..377ac55d6210 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "CostCenter": "RnD" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_List.json new file mode 100644 index 000000000000..1678352ca684 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "tags": { + "CostCenter": "RnD" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Patch.json new file mode 100644 index 000000000000..0dabf731c887 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Patch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "displayName": "Dev" + }, + "tags": { + "Owner": "superuser" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Put.json new file mode 100644 index 000000000000..ce6e9f335265 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/EnvironmentTypes_Put.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest", + "body": { + "tags": { + "Owner": "superuser" + }, + "properties": { + "displayName": "Dev" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Create.json new file mode 100644 index 000000000000..f6812d1186b1 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Create.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery", + "body": { + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Delete.json new file mode 100644 index 000000000000..e0fbd962635b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Get.json new file mode 100644 index 000000000000..56606a232b31 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_List.json new file mode 100644 index 000000000000..ee483585c6df --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Galleries_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/default", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "provisioningState": "Succeeded", + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/CentralGallery" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/ImageGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/SharedGallery", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json new file mode 100644 index 000000000000..e4edd94a3d8d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "catalogName": "TeamCatalog", + "imageDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/catalogs/TeamCatalog/imagedefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/catalogs/imagedefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json new file mode 100644 index 000000000000..295218eb52cd --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "catalogName": "TeamCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/catalogs/TeamCatalog/imagedefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/catalogs/imagedefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_Get.json new file mode 100644 index 000000000000..b40c41b93b98 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "Win11", + "versionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/Win11/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/devcenters/galleries/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_GetByProject.json new file mode 100644 index 000000000000..e328ee389a05 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_GetByProject.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject", + "imageName": "~gallery~DefaultDevGallery~ContosoImageDefinition", + "versionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/project/myProject/images/~gallery~DefaultDevGallery~ContosoImageDefinition/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/project/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_List.json new file mode 100644 index 000000000000..8228d522223b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "Win11" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/Win11/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/devcenters/galleries/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_ListByProject.json new file mode 100644 index 000000000000..5cd2c26402e5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ImageVersions_ListByProject.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject", + "imageName": "~gallery~DefaultDevGallery~ContosoImageDefinition" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/project/myProject/images/~gallery~DefaultDevGallery~ContosoImageDefinition/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/project/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_Get.json new file mode 100644 index 000000000000..bce68f230847 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "ContosoBaseImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_GetByProject.json new file mode 100644 index 000000000000..cc54165a9c05 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_GetByProject.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject", + "imageName": "~gallery~DefaultDevGallery~ContosoBaseImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/project/myProject/images/~gallery~DefaultDevGallery~ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByDevCenter.json new file mode 100644 index 000000000000..e8605e6513dd --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByDevCenter.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage2", + "name": "ContosoBaseImage2", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByGallery.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByGallery.json new file mode 100644 index 000000000000..1e7381bd2225 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByGallery.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DevGallery" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage2", + "name": "ContosoBaseImage2", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByProject.json new file mode 100644 index 000000000000..20dbbbea50b2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Images_ListByProject.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myProject/images/~gallery~DefaultDevGallery~ContosoBaseImage", + "name": "~gallery~DefaultDevGallery~ContosoBaseImage", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myProject/images/~catalog~DefaultCatalog~DefaultImage", + "name": "~catalog~DefaultCatalog~DefaultImage", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myProject/images/~gallery~DefaultDevGallery~ContosoImageDefinition", + "name": "~gallery~DefaultDevGallery~ContosoImageDefinition", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Delete.json new file mode 100644 index 000000000000..9e2018d95b84 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "eastusnetwork" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Get.json new file mode 100644 index 000000000000..47fe64ddd8c4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded", + "healthCheckStatus": "Passed" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_GetHealthDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_GetHealthDetails.json new file mode 100644 index 000000000000..c5119d164863 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_GetHealthDetails.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "eastusnetwork" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/eastusnetwork/healthchecks/latest", + "name": "latest", + "type": "Microsoft.DevCenter/networkconnections/healthchecks", + "properties": { + "startDateTime": "2021-07-03T12:43:14Z", + "endDateTime": "2021-07-03T12:43:15Z", + "healthChecks": [ + { + "displayName": "Azure AD device sync", + "endDateTime": "2021-07-03T12:43:14Z", + "startDateTime": "2021-07-03T12:43:15Z", + "status": "Passed" + } + ] + }, + "systemData": { + "createdBy": "System", + "createdByType": "Application", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "System", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListByResourceGroup.json new file mode 100644 index 000000000000..6522c85aef19 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListBySubscription.json new file mode 100644 index 000000000000..b20be967ec0e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnection", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListHealthDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListHealthDetails.json new file mode 100644 index 000000000000..94b38e04e14b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListHealthDetails.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network/healthchecks/latest", + "name": "latest", + "type": "Microsoft.DevCenter/networkconnections/healthchecks", + "properties": { + "startDateTime": "2021-07-03T12:43:14Z", + "endDateTime": "2021-07-03T12:43:15Z", + "healthChecks": [ + { + "displayName": "Azure AD device sync", + "endDateTime": "2021-07-03T12:43:14Z", + "startDateTime": "2021-07-03T12:43:15Z", + "status": "Passed" + } + ] + }, + "systemData": { + "createdBy": "System", + "createdByType": "Application", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "System", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..875f6621c160 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Dev Box Service", + "endpoints": [ + { + "domainName": "devbox.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Intune", + "endpoints": [ + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Cloud PC", + "endpoints": [ + { + "domainName": "rdweb.wvd.microsoft.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Patch.json new file mode 100644 index 000000000000..8f91c177a64d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network", + "body": { + "properties": { + "domainPassword": "New Password value for user" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Put.json new file mode 100644 index 000000000000..8c8e8dd8d63b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_Put.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network", + "body": { + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "domainPassword": "Password value for user", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_RunHealthChecks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_RunHealthChecks.json new file mode 100644 index 000000000000..882e053ad081 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/NetworkConnections_RunHealthChecks.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/OperationStatus_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/OperationStatus_Get.json new file mode 100644 index 000000000000..14615519853d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/OperationStatus_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "location": "westus3", + "operationId": "3fa1a29d-e807-488d-81d1-f1c5456a08cd" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4", + "status": "Succeeded", + "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "startTime": "2020-12-01T15:16:29.500Z", + "endTime": "2020-12-01T15:16:55.100Z", + "percentComplete": 100 + } + }, + "202": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4", + "status": "Succeeded", + "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "startTime": "2020-12-01T15:16:29.500Z", + "endTime": "2020-12-01T15:16:55.100Z", + "percentComplete": 99 + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "default": { + "body": { + "error": { + "code": "OperationNotFound", + "message": "The requested async operation was not found" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Operations_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Operations_Get.json new file mode 100644 index 000000000000..1a49057a5405 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Operations_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DevCenter/devcenters/write", + "display": { + "provider": "Microsoft DevTest Center", + "resource": "Microsoft DevTest Center devcenter resource", + "operation": "write" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Create.json new file mode 100644 index 000000000000..a61d79a7efa5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Create.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "body": { + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User" + }, + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Delete.json new file mode 100644 index 000000000000..8b504ab3c92b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Get.json new file mode 100644 index 000000000000..c3ba3eee8237 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_List.json new file mode 100644 index 000000000000..272139cbe0af --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberType": "User", + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Patch.json new file mode 100644 index 000000000000..4bb1f345859d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/PlanMembers_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "body": { + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Create.json new file mode 100644 index 000000000000..cbbdd1750e88 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Create.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": {}, + "sku": { + "name": "Preview" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "hidden-title": "ContosoPlan", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Delete.json new file mode 100644 index 000000000000..97f19ec8b2f7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Get.json new file mode 100644 index 000000000000..c489ac0cab23 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_ListByResourceGroup.json new file mode 100644 index 000000000000..bb9db33cba6e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_ListBySubscription.json new file mode 100644 index 000000000000..939bed1ca488 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_ListBySubscription.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Patch.json new file mode 100644 index 000000000000..7e4ac4cf6fa7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Plans_Patch.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "body": { + "sku": { + "name": "Preview" + }, + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Delete.json new file mode 100644 index 000000000000..3feb459f5fb7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "poolName" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..0f004b6fc9d7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_GetUnhealthyStatus.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_GetUnhealthyStatus.json new file mode 100644 index 000000000000..95eeb84c0b54 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_GetUnhealthyStatus.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Unhealthy", + "healthStatusDetails": [ + { + "code": "NetworkConnectionUnhealthy", + "message": "The Pool's Network Connection is in an unhealthy state. Check the Network Connection's health status for more details." + }, + { + "code": "ImageValidationFailed", + "message": "Image validation has failed. Check the Dev Box Definition's image validation status for more details." + }, + { + "code": "IntuneValidationFailed", + "message": "Intune license validation has failed. The tenant does not have a valid Intune license." + } + ], + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_List.json new file mode 100644 index 000000000000..a6f7a811e777 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Patch.json new file mode 100644 index 000000000000..1ed280104d61 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Patch.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "devBoxDefinitionName": "WebDevBox2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox2", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Put.json new file mode 100644 index 000000000000..ad66eb8b68e3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_Put.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Pending", + "provisioningState": "Created", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_PutWithManagedNetwork.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_PutWithManagedNetwork.json new file mode 100644 index 000000000000..f2e39cdf2b94 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_PutWithManagedNetwork.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "managedNetwork", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "managedNetwork", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "managedNetwork", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Pending", + "provisioningState": "Created", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json new file mode 100644 index 000000000000..7b4d1bc16840 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionType": "Value", + "devBoxDefinitionName": "", + "devBoxDefinition": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/projects/DevProject/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + } + }, + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionType": "Value", + "devBoxDefinitionName": "", + "devBoxDefinition": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/projects/DevProject/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + } + }, + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionType": "Value", + "devBoxDefinitionName": "", + "devBoxDefinition": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/projects/DevProject/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + } + }, + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Pending", + "provisioningState": "Created", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_RunHealthChecks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_RunHealthChecks.json new file mode 100644 index 000000000000..53b73bf3e25b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Pools_RunHealthChecks.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json new file mode 100644 index 000000000000..cd8af34d70be --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/Contoso/allowedEnvironmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/allowedenvironmenttypes", + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json new file mode 100644 index 000000000000..bf7dcea07eb3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/Contoso/allowedEnvironmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/allowedenvironmenttypes", + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json new file mode 100644 index 000000000000..84db2fa4f59d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "code": "ParameterValueInvalid", + "message": "Expected parameter value for 'InstanceCount' to be integer but found the string 'test'." + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Connect.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Connect.json new file mode 100644 index 000000000000..0579ef6c3c90 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Connect.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_CreateAdo.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_CreateAdo.json new file mode 100644 index 000000000000..f3d2028e8513 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_CreateAdo.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_CreateGitHub.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_CreateGitHub.json new file mode 100644 index 000000000000..963ceb9723f3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_CreateGitHub.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Delete.json new file mode 100644 index 000000000000..00c077f6956a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Get.json new file mode 100644 index 000000000000..0fe651404d96 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json new file mode 100644 index 000000000000..ddbaa3554d06 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "operationError": { + "code": "Conflict", + "message": "The source control credentials could not be validated successfully." + }, + "conflicts": [ + { + "path": "/Environments/Duplicate/manifest.yaml", + "name": "DuplicateEnvironmentName" + } + ], + "errors": [ + { + "path": "/Environments/Invalid/manifest.yaml", + "errorDetails": [ + { + "code": "ParseError", + "message": "Schema Error Within Catalog Item: Missing Name" + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_List.json new file mode 100644 index 000000000000..62fedce75507 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/Contoso/catalogs", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Patch.json new file mode 100644 index 000000000000..a565641cee19 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Patch.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "path": "/environments" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/environments" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Sync.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Sync.json new file mode 100644 index 000000000000..0579ef6c3c90 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectCatalogs_Sync.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Delete.json new file mode 100644 index 000000000000..c39a3305a4be --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Get.json new file mode 100644 index 000000000000..d1363eb8775d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Get.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 1, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_List.json new file mode 100644 index 000000000000..1d153814dc77 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_List.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Patch.json new file mode 100644 index 000000000000..11b0418f7c4d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Patch.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + }, + "tags": { + "CostCenter": "RnD" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 1, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Put.json new file mode 100644 index 000000000000..7aeb20ef97e2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/ProjectEnvironmentTypes_Put.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + }, + "tags": { + "CostCenter": "RnD" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "displayName": "DevTest", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 0, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "hidden-title": "Dev", + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "displayName": "DevTest", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 0, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "hidden-title": "Dev", + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Delete.json new file mode 100644 index 000000000000..a3fa3e2be9d4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Get.json new file mode 100644 index 000000000000..bec1d4e21665 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "displayName": "Dev", + "catalogSettings": { + "catalogItemSyncTypes": [ + "EnvironmentDefinition" + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "hidden-title": "Dev", + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_GetInheritedSettings.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_GetInheritedSettings.json new file mode 100644 index 000000000000..669a9f61a29a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_GetInheritedSettings.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso" + }, + "responses": { + "200": { + "body": { + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_ListByResourceGroup.json new file mode 100644 index 000000000000..fc4215af32f7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myproject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_ListBySubscription.json new file mode 100644 index 000000000000..d2b8ea6519d6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_ListBySubscription.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myproject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Patch.json new file mode 100644 index 000000000000..11c039e6b619 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Patch.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "description": "This is my first project.", + "displayName": "Dev", + "catalogSettings": { + "catalogItemSyncTypes": [ + "EnvironmentDefinition" + ] + } + }, + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project. Very exciting.", + "displayName": "Dev", + "catalogSettings": { + "catalogItemSyncTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "displayName": "Dev", + "CostCenter": "R&D" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Put.json new file mode 100644 index 000000000000..185b390fb126 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_Put.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "displayName": "Dev" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "hidden-title": "Dev", + "CostCenter": "R&D" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "hidden-title": "Dev", + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json new file mode 100644 index 000000000000..35859622f5ba --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3 + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json new file mode 100644 index 000000000000..d5b99921532b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown", + "body": { + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Delete.json new file mode 100644 index 000000000000..aec5af5d69ee --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Get.json new file mode 100644 index 000000000000..57d97b1cc05f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_ListByPool.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_ListByPool.json new file mode 100644 index 000000000000..28b5605436be --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_ListByPool.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Patch.json new file mode 100644 index 000000000000..e2cf964a4439 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Schedules_Patch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown", + "body": { + "properties": { + "time": "18:00" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Skus_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Skus_ListByProject.json new file mode 100644 index 000000000000..deac555a2ab4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Skus_ListByProject.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "projects/pools", + "name": "Large", + "tier": "Premium", + "locations": [ + "CentralUS" + ] + }, + { + "resourceType": "projects/pools", + "name": "Medium", + "tier": "Standard", + "locations": [ + "CentralUS" + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Skus_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Skus_ListBySubscription.json new file mode 100644 index 000000000000..62fa2587152b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Skus_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "projects/pools", + "name": "Large", + "tier": "Premium", + "locations": [ + "CentralUS" + ] + }, + { + "resourceType": "projects/pools", + "name": "Medium", + "tier": "Standard", + "locations": [ + "CentralUS" + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Usages_ListByLocation.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Usages_ListByLocation.json new file mode 100644 index 000000000000..73073e90a9ce --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/examples/Usages_ListByLocation.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "currentValue": 2, + "limit": 8, + "unit": "Count", + "name": { + "value": "devcenters" + }, + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/Microsoft.DevCenter/locations/westus/quotas/devcenters" + }, + { + "currentValue": 5, + "limit": 30, + "unit": "Count", + "name": { + "value": "projects" + }, + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/Microsoft.DevCenter/locations/westus/quotas/projects" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/vdi.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/vdi.json new file mode 100644 index 000000000000..732622b89709 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-06-01-preview/vdi.json @@ -0,0 +1,1958 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-06-01-preview", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/skus": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "SKUs" + ], + "description": "Lists the Microsoft.DevCenter SKUs available in a subscription", + "operationId": "Skus_ListBySubscription", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Skus_ListBySubscription": { + "$ref": "./examples/Skus_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Pools" + ], + "description": "Lists pools for a project", + "operationId": "Pools_ListByProject", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Pools_ListByProject": { + "$ref": "./examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "get": { + "tags": [ + "Pools" + ], + "description": "Gets a machine pool", + "operationId": "Pools_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "./examples/Pools_Get.json" + }, + "Pools_GetUnhealthyStatus": { + "$ref": "./examples/Pools_GetUnhealthyStatus.json" + } + } + }, + "put": { + "tags": [ + "Pools" + ], + "description": "Creates or updates a machine pool", + "operationId": "Pools_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a machine pool", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "./examples/Pools_Put.json" + }, + "Pools_CreateOrUpdateWithManagedNetwork": { + "$ref": "./examples/Pools_PutWithManagedNetwork.json" + }, + "Pools_CreateOrUpdateWithValueDevBoxDefinition": { + "$ref": "./examples/Pools_PutWithValueDevBoxDefinition.json" + } + } + }, + "patch": { + "tags": [ + "Pools" + ], + "description": "Partially updates a machine pool", + "operationId": "Pools_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a machine pool", + "required": true, + "schema": { + "$ref": "#/definitions/PoolUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "./examples/Pools_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Pools" + ], + "description": "Deletes a machine pool", + "operationId": "Pools_Delete", + "parameters": [], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "./examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/runHealthChecks": { + "post": { + "tags": [ + "Pools" + ], + "description": "Triggers a refresh of the pool status.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "operationId": "Pools_RunHealthChecks", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Initiating pool status refresh.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_RefreshStatus": { + "$ref": "./examples/Pools_RunHealthChecks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Schedules" + ], + "description": "Lists schedules for a pool", + "operationId": "Schedules_ListByPool", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Schedules_ListByPool": { + "$ref": "./examples/Schedules_ListByPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ScheduleNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Schedules" + ], + "description": "Gets a schedule resource.", + "operationId": "Schedules_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_GetByPool": { + "$ref": "./examples/Schedules_Get.json" + } + } + }, + "put": { + "tags": [ + "Schedules" + ], + "description": "Creates or updates a Schedule.", + "operationId": "Schedules_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a scheduled task", + "required": true, + "schema": { + "$ref": "#/definitions/Schedule" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_CreateDailyShutdownPoolSchedule": { + "$ref": "./examples/Schedules_CreateDailyShutdownPoolSchedule.json" + } + } + }, + "patch": { + "tags": [ + "Schedules" + ], + "description": "Partially updates a Scheduled.", + "operationId": "Schedules_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a scheduled task.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_Update": { + "$ref": "./examples/Schedules_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Schedules" + ], + "description": "Deletes a Scheduled.", + "operationId": "Schedules_Delete", + "parameters": [], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_Delete": { + "$ref": "./examples/Schedules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/networkConnections": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists network connections in a subscription", + "operationId": "NetworkConnections_ListBySubscription", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListBySubscription": { + "$ref": "./examples/NetworkConnections_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists network connections in a resource group", + "operationId": "NetworkConnections_ListByResourceGroup", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListByResourceGroup": { + "$ref": "./examples/NetworkConnections_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Gets a network connection resource", + "operationId": "NetworkConnections_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Get": { + "$ref": "./examples/NetworkConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "Network Connections" + ], + "description": "Creates or updates a Network Connections resource", + "operationId": "NetworkConnections_CreateOrUpdate", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents network connection", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_CreateOrUpdate": { + "$ref": "./examples/NetworkConnections_Put.json" + } + } + }, + "patch": { + "tags": [ + "Network Connections" + ], + "description": "Partially updates a Network Connection", + "operationId": "NetworkConnections_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents network connection", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConnectionUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Update": { + "$ref": "./examples/NetworkConnections_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Network Connections" + ], + "description": "Deletes a Network Connections resource", + "operationId": "NetworkConnections_Delete", + "parameters": [], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Delete": { + "$ref": "./examples/NetworkConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists health check status details", + "operationId": "NetworkConnections_ListHealthDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/HealthCheckStatusDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListHealthDetails": { + "$ref": "./examples/NetworkConnections_ListHealthDetails.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks/latest": { + "get": { + "tags": [ + "Network Connections" + ], + "description": "Gets health check status details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "operationId": "NetworkConnections_GetHealthDetails", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/HealthCheckStatusDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_GetHealthDetails": { + "$ref": "./examples/NetworkConnections_GetHealthDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/runHealthChecks": { + "post": { + "tags": [ + "Network Connection" + ], + "description": "Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "operationId": "NetworkConnections_RunHealthChecks", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Initiating health checks.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_RunHealthChecks": { + "$ref": "./examples/NetworkConnections_RunHealthChecks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/outboundNetworkDependenciesEndpoints": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connection" + ], + "operationId": "NetworkConnections_ListOutboundNetworkDependenciesEndpoints", + "description": "Lists the endpoints that agents may call as part of Dev Box service administration. These FQDNs should be allowed for outbound access in order for the Dev Box service to function.", + "parameters": [], + "x-ms-examples": { + "ListOutboundNetworkDependencies": { + "$ref": "./examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json" + } + }, + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of outbound network dependencies.", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SkuListResult": { + "description": "Results of the Microsoft.DevCenter SKU list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "commonDefinitions.json#/definitions/DevCenterSku" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Pool": { + "description": "A pool of Virtual Machines.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Pool properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolProperties" + } + } + }, + "PoolUpdateProperties": { + "description": "Properties of a Pool. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devBoxDefinitionType": { + "description": "Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.", + "$ref": "#/definitions/PoolDevBoxDefinitionType" + }, + "devBoxDefinitionName": { + "description": "Name of a Dev Box definition in parent Project of this Pool. Will be ignored if devBoxDefinitionType is Value.", + "type": "string" + }, + "devBoxDefinition": { + "description": "A definition of the machines that are created from this Pool. Will be ignored if devBoxDefinitionType is Reference or not provided.", + "$ref": "#/definitions/PoolDevBoxDefinition" + }, + "networkConnectionName": { + "description": "Name of a Network Connection in parent Project of this Pool", + "type": "string" + }, + "licenseType": { + "description": "Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.", + "$ref": "#/definitions/LicenseType" + }, + "localAdministrator": { + "description": "Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.", + "$ref": "#/definitions/LocalAdminStatus" + }, + "stopOnDisconnect": { + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "$ref": "#/definitions/StopOnDisconnectConfiguration" + }, + "singleSignOnStatus": { + "description": "Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.", + "$ref": "#/definitions/SingleSignOnStatus" + }, + "displayName": { + "type": "string", + "description": "The display name of the pool." + }, + "virtualNetworkType": { + "description": "Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.", + "$ref": "#/definitions/VirtualNetworkType" + }, + "managedVirtualNetworkRegions": { + "type": "array", + "description": "The regions of the managed virtual network (required when managedNetworkType is Managed).", + "items": { + "type": "string" + } + } + } + }, + "PoolProperties": { + "type": "object", + "description": "Properties of a Pool", + "allOf": [ + { + "$ref": "#/definitions/PoolUpdateProperties" + } + ], + "properties": { + "healthStatus": { + "description": "Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.", + "$ref": "#/definitions/HealthStatus", + "readOnly": true + }, + "healthStatusDetails": { + "description": "Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state", + "type": "array", + "items": { + "$ref": "#/definitions/HealthStatusDetail" + }, + "x-ms-identifiers": [ + "code" + ], + "readOnly": true + }, + "devBoxCount": { + "description": "Indicates the number of provisioned Dev Boxes in this pool.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "devBoxDefinitionName", + "networkConnectionName", + "licenseType", + "localAdministrator" + ] + }, + "PoolDevBoxDefinition": { + "description": "Represents a definition for a Developer Machine.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Image reference information." + }, + "sku": { + "description": "The SKU for Dev Boxes created from the Pool.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + }, + "activeImageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Image reference information for the currently active image (only populated during updates).", + "readOnly": true + } + } + }, + "HealthStatus": { + "description": "Health status indicating whether a pool is available to create Dev Boxes.", + "enum": [ + "Unknown", + "Pending", + "Healthy", + "Warning", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "HealthStatusDetail": { + "type": "object", + "description": "Pool health status detail.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the issue.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A message describing the issue, intended to be suitable for display in a user interface", + "readOnly": true + } + } + }, + "LicenseType": { + "description": "License Types", + "enum": [ + "Windows_Client" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "LocalAdminStatus": { + "description": "Local Administrator enable or disable status. Indicates whether owners of Dev Boxes are added as local administrators on the Dev Box.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true + } + }, + "SingleSignOnStatus": { + "description": "SingleSignOn (SSO) enable or disable status. Indicates whether Dev Boxes in the Pool will have SSO enabled or disabled.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "SingleSignOnStatus", + "modelAsString": true + } + }, + "VirtualNetworkType": { + "description": "Indicates a pool uses a Virtual Network managed by Microsoft (Managed), or a customer provided Network (Unmanaged).", + "type": "string", + "enum": [ + "Managed", + "Unmanaged" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": true + } + }, + "PoolDevBoxDefinitionType": { + "description": "Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.", + "type": "string", + "enum": [ + "Reference", + "Value" + ], + "x-ms-enum": { + "name": "PoolDevBoxDefinitionType", + "modelAsString": true + } + }, + "StopOnDisconnectConfiguration": { + "type": "object", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "description": "Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.", + "$ref": "#/definitions/StopOnDisconnectEnableStatus" + }, + "gracePeriodMinutes": { + "description": "The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.", + "type": "integer", + "format": "int32" + } + } + }, + "StopOnDisconnectEnableStatus": { + "description": "Stop on disconnect enable or disable status. Indicates whether stop on disconnect to is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "StopOnDisconnectEnableStatus", + "modelAsString": true + } + }, + "PoolListResult": { + "description": "Results of the machine pool list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Pool" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "PoolUpdate": { + "description": "The pool properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolUpdateProperties", + "description": "Properties of a pool to be updated." + } + } + }, + "ImageReference": { + "type": "object", + "description": "Image reference information", + "properties": { + "id": { + "description": "Image ID, or Image version ID. When Image ID is provided, its latest version will be used.", + "type": "string" + }, + "exactVersion": { + "type": "string", + "readOnly": true, + "description": "The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use." + } + } + }, + "ImageValidationStatus": { + "description": "Image validation status", + "enum": [ + "Unknown", + "Pending", + "Succeeded", + "Failed", + "TimedOut" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageValidationStatus", + "modelAsString": true + } + }, + "ImageValidationErrorDetails": { + "type": "object", + "description": "Image validation error details", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error." + } + } + }, + "CatalogResourceValidationStatus": { + "description": "Catalog resource validation status", + "enum": [ + "Unknown", + "Pending", + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogResourceValidationStatus", + "modelAsString": true + } + }, + "CatalogResourceValidationErrorDetails": { + "type": "object", + "description": "List of validator error details. Populated when changes are made to the resource or its dependent resources that impact the validity of the Catalog resource.", + "properties": { + "errors": { + "description": "Errors associated with resources synchronized from the catalog.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogErrorDetails" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "CatalogErrorDetails": { + "type": "object", + "description": "Catalog error details", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error." + } + } + }, + "NetworkConnection": { + "type": "object", + "description": "Network related settings", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a Network Connection", + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkProperties" + } + } + }, + "NetworkConnectionUpdate": { + "description": "The network connection properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkConnectionUpdateProperties", + "description": "Properties of a network connection resource to be updated." + } + } + }, + "NetworkConnectionUpdateProperties": { + "description": "Properties of network connection. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "subnetId": { + "description": "The subnet to attach Virtual Machines to", + "type": "string" + }, + "domainName": { + "description": "Active Directory domain name", + "type": "string" + }, + "organizationUnit": { + "description": "Active Directory domain Organization Unit (OU)", + "type": "string" + }, + "domainUsername": { + "description": "The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.", + "type": "string" + }, + "domainPassword": { + "description": "The password for the account used to join domain", + "type": "string", + "x-ms-secret": true + } + } + }, + "NetworkProperties": { + "description": "Network properties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkConnectionUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "healthCheckStatus": { + "description": "Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.", + "$ref": "#/definitions/HealthCheckStatus", + "readOnly": true + }, + "networkingResourceGroupName": { + "description": "The name for resource group where NICs will be placed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "domainJoinType": { + "description": "AAD Join type.", + "$ref": "#/definitions/DomainJoinType", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "subnetId", + "domainJoinType" + ] + }, + "NetworkConnectionListResult": { + "description": "Result of the network connection list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DomainJoinType": { + "description": "Active Directory join type", + "enum": [ + "HybridAzureADJoin", + "AzureADJoin", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainJoinType", + "modelAsString": true + } + }, + "HealthCheckStatus": { + "description": "Health check status values", + "enum": [ + "Unknown", + "Pending", + "Running", + "Passed", + "Warning", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthCheckStatus", + "modelAsString": true + } + }, + "HealthCheckStatusDetails": { + "description": "Health Check details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Health check status details properties.", + "$ref": "#/definitions/HealthCheckStatusDetailsProperties" + } + } + }, + "HealthCheckStatusDetailsProperties": { + "description": "Health Check properties.", + "type": "object", + "properties": { + "startDateTime": { + "type": "string", + "description": "Start time of last execution of the health checks.", + "readOnly": true, + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "description": "End time of last execution of the health checks.", + "readOnly": true, + "format": "date-time" + }, + "healthChecks": { + "description": "Details for each health check item.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthCheck" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "HealthCheck": { + "description": "An individual health check item", + "type": "object", + "properties": { + "status": { + "description": "The status of the health check item.", + "$ref": "#/definitions/HealthCheckStatus", + "readOnly": true + }, + "displayName": { + "description": "The display name of this health check item.", + "type": "string", + "readOnly": true + }, + "startDateTime": { + "description": "Start time of health check item.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "endDateTime": { + "description": "End time of the health check item.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "errorType": { + "description": "The type of error that occurred during this health check.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action to fix the corresponding error.", + "type": "string", + "readOnly": true + }, + "additionalDetails": { + "description": "Additional details about the health check or the recommended action.", + "type": "string", + "readOnly": true + } + } + }, + "HealthCheckStatusDetailsListResult": { + "description": "Result of the network health check list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthCheckStatusDetails" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [ + "category" + ], + "description": "The collection of outbound network dependency endpoints returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "OutboundEnvironmentEndpoint": { + "type": "object", + "properties": { + "category": { + "type": "string", + "readOnly": true, + "description": "The type of service that the agent connects to." + }, + "endpoints": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [ + "domainName" + ], + "description": "The endpoints for this service for which the agent requires outbound access." + } + }, + "description": "A collection of related endpoints from the same service for which the agent requires outbound access." + }, + "EndpointDependency": { + "type": "object", + "properties": { + "domainName": { + "type": "string", + "readOnly": true, + "description": "The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Human-readable supplemental information about the dependency and when it is applicable." + }, + "endpointDetails": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [], + "description": "The list of connection details for this endpoint." + } + }, + "description": "A domain name and connection details used to access a dependency." + }, + "EndpointDetail": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The port an endpoint is connected to." + } + }, + "description": "Details about the connection between the Batch service and the endpoint." + }, + "Schedule": { + "type": "object", + "description": "Represents a Schedule to execute a task.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Properties of a Schedule resource", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleProperties" + } + } + }, + "ScheduleUpdate": { + "description": "The schedule properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleUpdateProperties", + "description": "Properties of a schedule resource to be updated." + } + } + }, + "ScheduleUpdateProperties": { + "description": "Updatable properties of a Schedule.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "type": { + "description": "Supported type this scheduled task represents.", + "$ref": "#/definitions/ScheduledType" + }, + "frequency": { + "description": "The frequency of this scheduled task.", + "$ref": "#/definitions/ScheduledFrequency" + }, + "time": { + "description": "The target time to trigger the action. The format is HH:MM.", + "type": "string" + }, + "timeZone": { + "description": "The IANA timezone id at which the schedule should execute.", + "type": "string" + }, + "state": { + "description": "Indicates whether or not this scheduled task is enabled.", + "$ref": "#/definitions/ScheduleEnableStatus" + } + } + }, + "ScheduleProperties": { + "description": "The Schedule properties defining when and what to execute.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "type", + "frequency", + "timeZone", + "time" + ] + }, + "ScheduleListResult": { + "description": "Result of the schedule list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Schedule" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ScheduledType": { + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true + } + }, + "ScheduledFrequency": { + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true + } + }, + "ScheduleEnableStatus": { + "description": "Schedule enable or disable status. Indicates whether the schedule applied to is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleEnableStatus", + "modelAsString": true + } + } + }, + "parameters": { + "PoolNameParameter": { + "name": "poolName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the pool.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "NetworkConnectionName": { + "name": "networkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Network Connection that can be applied to a Pool.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ScheduleNameParameter": { + "name": "scheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schedule that uniquely identifies it.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[-\\w]+$", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName').", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/resource-manager/readme.md b/specification/devcenter/resource-manager/readme.md index fb8fde5f3e54..b6dbd79266bb 100644 --- a/specification/devcenter/resource-manager/readme.md +++ b/specification/devcenter/resource-manager/readme.md @@ -27,10 +27,25 @@ These are the global settings for devcenter. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2024-05 +tag: package-preview-2024-06 ``` +### Tag: package-preview-2024-06 + +These settings apply only when `--tag=package-preview-2024-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-06' +input-file: + - Microsoft.DevCenter/preview/2024-06-01-preview/commonDefinitions.json + - Microsoft.DevCenter/preview/2024-06-01-preview/devcenter.json + - Microsoft.DevCenter/preview/2024-06-01-preview/vdi.json +suppressions: + - code: PatchBodyParametersSchema + from: vdi.json + reason: Patch Body comes from common-types v5 Sku object. Keeping here for consistency with existing parts of API to avoid breaking customers. +``` + ### Tag: package-preview-2024-05 These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. From c858811c29ee22362eafd8be94ad0ff808fe7cf9 Mon Sep 17 00:00:00 2001 From: v-maksymm <161892853+v-maksymm@users.noreply.github.com> Date: Thu, 20 Jun 2024 10:32:33 -0700 Subject: [PATCH 212/343] Oracle.Database. Version 2023-09-01 stable (#29397) * Oracle.Database. Version 2023-09-01 stable * Oracle.Database. Fixed examples version * Oracle.Database. Fixed examples version * Oracle.Database. Added service-dir pramater to tspconfig * Oracle.Database. Added service-dir pramater to tspconfig * Oracle.Database. Rebuild after main branch merged --- .../autonomousDatabaseBackup_create.json | 71 + .../autonomousDatabaseBackup_delete.json | 20 + .../autonomousDatabaseBackup_get.json | 37 + ...autonomousDatabaseBackup_listByParent.json | 40 + .../autonomousDatabaseBackup_patch.json | 41 + .../autonomousDatabaseCharacterSet_get.json | 21 + ...usDatabaseCharacterSet_listByLocation.json | 32 + .../autonomousDatabaseClone_create.json | 141 + ...omousDatabaseNationalCharacterSet_get.json | 21 + ...seNationalCharacterSet_listByLocation.json | 25 + .../autonomousDatabaseVersion_get.json | 21 + ...onomousDatabaseVersion_listByLocation.json | 25 + .../2023-09-01/autonomousDatabase_create.json | 136 + .../2023-09-01/autonomousDatabase_delete.json | 19 + .../autonomousDatabase_failover.json | 90 + .../autonomousDatabase_generateWallet.json | 25 + .../2023-09-01/autonomousDatabase_get.json | 63 + ...utonomousDatabase_listByResourceGroup.json | 67 + ...autonomousDatabase_listBySubscription.json | 66 + .../2023-09-01/autonomousDatabase_patch.json | 73 + .../autonomousDatabase_restore.json | 80 + .../2023-09-01/autonomousDatabase_shrink.json | 77 + .../autonomousDatabase_switchover.json | 89 + .../examples/2023-09-01/dbNodes_action.json | 50 + .../examples/2023-09-01/dbNodes_get.json | 41 + .../2023-09-01/dbNodes_listByParent.json | 45 + .../examples/2023-09-01/dbServers_get.json | 42 + .../2023-09-01/dbServers_listByParent.json | 46 + .../2023-09-01/dbSystemShapes_get.json | 40 + .../dbSystemShapes_listByLocation.json | 44 + .../2023-09-01/dnsPrivateViews_get.json | 27 + .../dnsPrivateViews_listByLocation.json | 44 + .../2023-09-01/dnsPrivateZones_get.json | 29 + .../dnsPrivateZones_listByLocation.json | 48 + .../exaInfra_addStorageCapacity.json | 95 + .../examples/2023-09-01/exaInfra_create.json | 184 + .../examples/2023-09-01/exaInfra_delete.json | 19 + .../examples/2023-09-01/exaInfra_get.json | 89 + .../exaInfra_listByResourceGroup.json | 93 + .../exaInfra_listBySubscription.json | 92 + .../examples/2023-09-01/exaInfra_patch.json | 102 + .../examples/2023-09-01/giVersions_get.json | 21 + .../2023-09-01/giVersions_listByLocation.json | 25 + .../examples/2023-09-01/operations_list.json | 25 + .../oracleSubscriptions_create.json | 56 + .../oracleSubscriptions_delete.json | 17 + .../2023-09-01/oracleSubscriptions_get.json | 29 + ...acleSubscriptions_listActivationLinks.json | 22 + ...racleSubscriptions_listBySubscription.json | 34 + ...Subscriptions_listCloudAccountDetails.json | 22 + ...criptions_listSaasSubscriptionDetails.json | 32 + .../2023-09-01/oracleSubscriptions_patch.json | 43 + .../2023-09-01/systemVersions_get.json | 20 + .../systemVersions_listByLocation.json | 24 + .../virtualNetworkAddresses_create.json | 48 + .../virtualNetworkAddresses_delete.json | 20 + .../virtualNetworkAddresses_get.json | 29 + .../virtualNetworkAddresses_listByParent.json | 33 + .../2023-09-01/vmClusters_addVms.json | 102 + .../2023-09-01/vmClusters_create.json | 224 + .../2023-09-01/vmClusters_delete.json | 19 + .../examples/2023-09-01/vmClusters_get.json | 104 + .../vmClusters_listByResourceGroup.json | 95 + .../vmClusters_listBySubscription.json | 94 + .../vmClusters_listPrivateIpAddresses.json | 27 + .../examples/2023-09-01/vmClusters_patch.json | 101 + .../2023-09-01/vmClusters_removeVms.json | 102 + .../oracle/Oracle.Database/tspconfig.yaml | 1 + .../oracle/Oracle.Database/versions.tsp | 7 +- .../autonomousDatabaseBackup_create.json | 71 + .../autonomousDatabaseBackup_delete.json | 20 + .../autonomousDatabaseBackup_get.json | 37 + ...autonomousDatabaseBackup_listByParent.json | 40 + .../autonomousDatabaseBackup_patch.json | 41 + .../autonomousDatabaseCharacterSet_get.json | 21 + ...usDatabaseCharacterSet_listByLocation.json | 32 + .../autonomousDatabaseClone_create.json | 141 + ...omousDatabaseNationalCharacterSet_get.json | 21 + ...seNationalCharacterSet_listByLocation.json | 25 + .../autonomousDatabaseVersion_get.json | 21 + ...onomousDatabaseVersion_listByLocation.json | 25 + .../examples/autonomousDatabase_create.json | 136 + .../examples/autonomousDatabase_delete.json | 19 + .../examples/autonomousDatabase_failover.json | 90 + .../autonomousDatabase_generateWallet.json | 25 + .../examples/autonomousDatabase_get.json | 63 + ...utonomousDatabase_listByResourceGroup.json | 67 + ...autonomousDatabase_listBySubscription.json | 66 + .../examples/autonomousDatabase_patch.json | 73 + .../examples/autonomousDatabase_restore.json | 80 + .../examples/autonomousDatabase_shrink.json | 77 + .../autonomousDatabase_switchover.json | 89 + .../2023-09-01/examples/dbNodes_action.json | 50 + .../2023-09-01/examples/dbNodes_get.json | 41 + .../examples/dbNodes_listByParent.json | 45 + .../2023-09-01/examples/dbServers_get.json | 42 + .../examples/dbServers_listByParent.json | 46 + .../examples/dbSystemShapes_get.json | 40 + .../dbSystemShapes_listByLocation.json | 44 + .../examples/dnsPrivateViews_get.json | 27 + .../dnsPrivateViews_listByLocation.json | 44 + .../examples/dnsPrivateZones_get.json | 29 + .../dnsPrivateZones_listByLocation.json | 48 + .../examples/exaInfra_addStorageCapacity.json | 95 + .../2023-09-01/examples/exaInfra_create.json | 184 + .../2023-09-01/examples/exaInfra_delete.json | 19 + .../2023-09-01/examples/exaInfra_get.json | 89 + .../exaInfra_listByResourceGroup.json | 93 + .../examples/exaInfra_listBySubscription.json | 92 + .../2023-09-01/examples/exaInfra_patch.json | 102 + .../2023-09-01/examples/giVersions_get.json | 21 + .../examples/giVersions_listByLocation.json | 25 + .../2023-09-01/examples/operations_list.json | 25 + .../examples/oracleSubscriptions_create.json | 56 + .../examples/oracleSubscriptions_delete.json | 17 + .../examples/oracleSubscriptions_get.json | 29 + ...acleSubscriptions_listActivationLinks.json | 22 + ...racleSubscriptions_listBySubscription.json | 34 + ...Subscriptions_listCloudAccountDetails.json | 22 + ...criptions_listSaasSubscriptionDetails.json | 32 + .../examples/oracleSubscriptions_patch.json | 43 + .../examples/systemVersions_get.json | 20 + .../systemVersions_listByLocation.json | 24 + .../virtualNetworkAddresses_create.json | 48 + .../virtualNetworkAddresses_delete.json | 20 + .../examples/virtualNetworkAddresses_get.json | 29 + .../virtualNetworkAddresses_listByParent.json | 33 + .../examples/vmClusters_addVms.json | 102 + .../examples/vmClusters_create.json | 224 + .../examples/vmClusters_delete.json | 19 + .../2023-09-01/examples/vmClusters_get.json | 104 + .../vmClusters_listByResourceGroup.json | 95 + .../vmClusters_listBySubscription.json | 94 + .../vmClusters_listPrivateIpAddresses.json | 27 + .../2023-09-01/examples/vmClusters_patch.json | 101 + .../examples/vmClusters_removeVms.json | 102 + .../stable/2023-09-01/openapi.json | 9811 +++++++++++++++++ .../oracle/resource-manager/readme.md | 11 +- 138 files changed, 17384 insertions(+), 2 deletions(-) create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseClone_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_failover.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_generateWallet.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_restore.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_shrink.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_switchover.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_action.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_addStorageCapacity.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/operations_list.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listActivationLinks.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listCloudAccountDetails.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listSaasSubscriptionDetails.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_addVms.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listPrivateIpAddresses.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_removeVms.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseCharacterSet_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseCharacterSet_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseClone_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseNationalCharacterSet_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseVersion_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseVersion_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_failover.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_generateWallet.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_listByResourceGroup.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_restore.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_shrink.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_switchover.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_action.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbServers_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbServers_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbSystemShapes_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbSystemShapes_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateViews_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateViews_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateZones_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateZones_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_addStorageCapacity.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_listByResourceGroup.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/giVersions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/giVersions_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/operations_list.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listActivationLinks.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listCloudAccountDetails.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/systemVersions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/systemVersions_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_addVms.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listByResourceGroup.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listPrivateIpAddresses.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_removeVms.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..b617d05794b5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..c487d9e41ead --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..4668780cc4a7 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_listByParent.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..41606b9bba9c --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..e6d31dfb846f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..f30cd9ff64ce --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..80cbdfb6228e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseClone_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..64d4b41b863a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..b3fe4c27c91f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..a5985b92de4a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..a7610dea57f8 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..3b939976dbc5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_create.json new file mode 100644 index 000000000000..e5f4afb3d2d0 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_delete.json new file mode 100644 index 000000000000..86a9c08c1bd8 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_failover.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_failover.json new file mode 100644 index 000000000000..e01e6b398b80 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_generateWallet.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..832ac5442248 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_get.json new file mode 100644 index 000000000000..b2c0360b3325 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..c2d79a608283 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..053f44f7c3b4 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_patch.json new file mode 100644 index 000000000000..78d378bddf6e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_restore.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_restore.json new file mode 100644 index 000000000000..ded132edc05c --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_shrink.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..98f110a7cbb1 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_switchover.json b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..dcf77e07bb1f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_action.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_action.json new file mode 100644 index 000000000000..4caeab5517c5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_get.json new file mode 100644 index 000000000000..f0bca3e58565 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_listByParent.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_listByParent.json new file mode 100644 index 000000000000..60d45307e509 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_get.json new file mode 100644 index 000000000000..acb905ed1610 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_listByParent.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_listByParent.json new file mode 100644 index 000000000000..ed3d7f23cf66 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_get.json new file mode 100644 index 000000000000..aa2a346f2b58 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..f0a2f67db6ad --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_get.json new file mode 100644 index 000000000000..db465960e008 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..dc07b372c4fc --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_get.json new file mode 100644 index 000000000000..5ac3bf72823b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..66d8c458756e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_addStorageCapacity.json b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..851ab418998f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_create.json new file mode 100644 index 000000000000..1da15945c65f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_delete.json new file mode 100644 index 000000000000..b119f726a165 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_get.json new file mode 100644 index 000000000000..96e2654c3431 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..7d7d55d0dfcb --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..f07600a26b95 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_patch.json new file mode 100644 index 000000000000..48e64b7089cb --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_get.json new file mode 100644 index 000000000000..01248923f6f5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_listByLocation.json new file mode 100644 index 000000000000..b866dca835c9 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/operations_list.json b/specification/oracle/Oracle.Database/examples/2023-09-01/operations_list.json new file mode 100644 index 000000000000..d927ae8962fc --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_create.json new file mode 100644 index 000000000000..394635d7479b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..a3f4fdd80566 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_get.json new file mode 100644 index 000000000000..e17d4cc943ff --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listActivationLinks.json b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..bf739788191a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..9b92deeb3009 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..cbc79dc9991c --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..d4d37478eac5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..e036bd953687 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_get.json new file mode 100644 index 000000000000..ff277396146b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_listByLocation.json b/specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_listByLocation.json new file mode 100644 index 000000000000..3081db7a0107 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..e4e5e4731c49 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..52044e7b9b0d --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..17965d066dc9 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_listByParent.json b/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..041bf6e58f70 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_addVms.json b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_addVms.json new file mode 100644 index 000000000000..a59cbba9cc55 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_create.json b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_create.json new file mode 100644 index 000000000000..725a39fed932 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_delete.json b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_delete.json new file mode 100644 index 000000000000..d3ecdf7acffb --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_get.json b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_get.json new file mode 100644 index 000000000000..01a8f6223cd8 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..ccacae618db0 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..13bfe7b4071a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listPrivateIpAddresses.json b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..0b6b219e0e0f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_patch.json b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_patch.json new file mode 100644 index 000000000000..76037942f35c --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_removeVms.json b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_removeVms.json new file mode 100644 index 000000000000..d7f3c0daebbc --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/tspconfig.yaml b/specification/oracle/Oracle.Database/tspconfig.yaml index 984ac2cc2975..9d705425bb6a 100644 --- a/specification/oracle/Oracle.Database/tspconfig.yaml +++ b/specification/oracle/Oracle.Database/tspconfig.yaml @@ -1,6 +1,7 @@ parameters: "service-dir": default: "sdk/oracledatabase" + emit: - "@azure-tools/typespec-autorest" diff --git a/specification/oracle/Oracle.Database/versions.tsp b/specification/oracle/Oracle.Database/versions.tsp index d9316d37da43..6536215fc8a8 100644 --- a/specification/oracle/Oracle.Database/versions.tsp +++ b/specification/oracle/Oracle.Database/versions.tsp @@ -7,5 +7,10 @@ enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_2) @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @doc("2023-09-01-preview") - v20230901: "2023-09-01-preview", + v20230901_preview: "2023-09-01-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("2023-09-01") + v20230901: "2023-09-01", } diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..b617d05794b5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..c487d9e41ead --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..4668780cc4a7 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..41606b9bba9c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..e6d31dfb846f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..f30cd9ff64ce --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..80cbdfb6228e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseClone_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..64d4b41b863a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..b3fe4c27c91f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..a5985b92de4a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseVersion_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..a7610dea57f8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..3b939976dbc5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_create.json new file mode 100644 index 000000000000..e5f4afb3d2d0 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_delete.json new file mode 100644 index 000000000000..86a9c08c1bd8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_failover.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_failover.json new file mode 100644 index 000000000000..e01e6b398b80 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_generateWallet.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..832ac5442248 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_get.json new file mode 100644 index 000000000000..b2c0360b3325 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..c2d79a608283 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..053f44f7c3b4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_patch.json new file mode 100644 index 000000000000..78d378bddf6e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_restore.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_restore.json new file mode 100644 index 000000000000..ded132edc05c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_shrink.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..98f110a7cbb1 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_switchover.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..dcf77e07bb1f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_action.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_action.json new file mode 100644 index 000000000000..4caeab5517c5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_get.json new file mode 100644 index 000000000000..f0bca3e58565 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_listByParent.json new file mode 100644 index 000000000000..60d45307e509 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbServers_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbServers_get.json new file mode 100644 index 000000000000..acb905ed1610 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbServers_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbServers_listByParent.json new file mode 100644 index 000000000000..ed3d7f23cf66 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbSystemShapes_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbSystemShapes_get.json new file mode 100644 index 000000000000..aa2a346f2b58 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbSystemShapes_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..f0a2f67db6ad --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateViews_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateViews_get.json new file mode 100644 index 000000000000..db465960e008 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateViews_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..dc07b372c4fc --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateZones_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateZones_get.json new file mode 100644 index 000000000000..5ac3bf72823b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateZones_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..66d8c458756e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_addStorageCapacity.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..851ab418998f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_create.json new file mode 100644 index 000000000000..1da15945c65f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_delete.json new file mode 100644 index 000000000000..b119f726a165 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_get.json new file mode 100644 index 000000000000..96e2654c3431 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..7d7d55d0dfcb --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..f07600a26b95 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_patch.json new file mode 100644 index 000000000000..48e64b7089cb --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/giVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/giVersions_get.json new file mode 100644 index 000000000000..01248923f6f5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/giVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/giVersions_listByLocation.json new file mode 100644 index 000000000000..b866dca835c9 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/operations_list.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/operations_list.json new file mode 100644 index 000000000000..d927ae8962fc --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_create.json new file mode 100644 index 000000000000..394635d7479b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..a3f4fdd80566 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_get.json new file mode 100644 index 000000000000..e17d4cc943ff --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listActivationLinks.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..bf739788191a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..9b92deeb3009 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..cbc79dc9991c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..d4d37478eac5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..e036bd953687 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/systemVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/systemVersions_get.json new file mode 100644 index 000000000000..ff277396146b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/systemVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/systemVersions_listByLocation.json new file mode 100644 index 000000000000..3081db7a0107 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..e4e5e4731c49 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..52044e7b9b0d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..17965d066dc9 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..041bf6e58f70 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_addVms.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_addVms.json new file mode 100644 index 000000000000..a59cbba9cc55 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_create.json new file mode 100644 index 000000000000..725a39fed932 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_delete.json new file mode 100644 index 000000000000..d3ecdf7acffb --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_get.json new file mode 100644 index 000000000000..01a8f6223cd8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..ccacae618db0 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..13bfe7b4071a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listPrivateIpAddresses.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..0b6b219e0e0f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_patch.json new file mode 100644 index 000000000000..76037942f35c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_removeVms.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_removeVms.json new file mode 100644 index 000000000000..d7f3c0daebbc --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json new file mode 100644 index 000000000000..c52ff3db2159 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json @@ -0,0 +1,9811 @@ +{ + "swagger": "2.0", + "info": { + "title": "Oracle Database Resource Manager", + "version": "2023-09-01", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "CloudExadataInfrastructures" + }, + { + "name": "DbServers" + }, + { + "name": "CloudVmClusters" + }, + { + "name": "VirtualNetworkAddresses" + }, + { + "name": "SystemVersions" + }, + { + "name": "OracleSubscriptions" + }, + { + "name": "DbNodes" + }, + { + "name": "GiVersions" + }, + { + "name": "DbSystemShapes" + }, + { + "name": "DnsPrivateViews" + }, + { + "name": "DnsPrivateZones" + }, + { + "name": "AutonomousDatabases" + }, + { + "name": "AutonomousDatabaseBackups" + }, + { + "name": "AutonomousDatabaseCharacterSets" + }, + { + "name": "AutonomousDatabaseNationalCharacterSets" + }, + { + "name": "AutonomousDatabaseVersions" + } + ], + "paths": { + "/providers/Oracle.Database/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Operations": { + "$ref": "./examples/operations_list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListBySubscription", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by subscription": { + "$ref": "./examples/autonomousDatabase_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListBySubscription", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by subscription": { + "$ref": "./examples/exaInfra_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListBySubscription", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by subscription": { + "$ref": "./examples/vmClusters_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "List AutonomousDatabaseCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db character sets by location": { + "$ref": "./examples/autonomousDatabaseCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets/{adbscharsetname}": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_Get", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "Get a AutonomousDatabaseCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "adbscharsetname", + "in": "path", + "description": "AutonomousDatabaseCharacterSet name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db character set": { + "$ref": "./examples/autonomousDatabaseCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "List AutonomousDatabaseNationalCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db national character sets by location": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets/{adbsncharsetname}": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_Get", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "Get a AutonomousDatabaseNationalCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "adbsncharsetname", + "in": "path", + "description": "AutonomousDatabaseNationalCharacterSets name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db national character set": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions": { + "get": { + "operationId": "AutonomousDatabaseVersions_ListByLocation", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "List AutonomousDbVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDbVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List an autonomous versions by location": { + "$ref": "./examples/autonomousDatabaseVersion_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions/{autonomousdbversionsname}": { + "get": { + "operationId": "AutonomousDatabaseVersions_Get", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "Get a AutonomousDbVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "autonomousdbversionsname", + "in": "path", + "description": "AutonomousDbVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get an autonomous version": { + "$ref": "./examples/autonomousDatabaseVersion_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes": { + "get": { + "operationId": "DbSystemShapes_ListByLocation", + "tags": [ + "DbSystemShapes" + ], + "description": "List DbSystemShape resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbSystemShapeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbSystemShapes by location": { + "$ref": "./examples/dbSystemShapes_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes/{dbsystemshapename}": { + "get": { + "operationId": "DbSystemShapes_Get", + "tags": [ + "DbSystemShapes" + ], + "description": "Get a DbSystemShape", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "dbsystemshapename", + "in": "path", + "description": "DbSystemShape name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DbSystemShape by name": { + "$ref": "./examples/dbSystemShapes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews": { + "get": { + "operationId": "DnsPrivateViews_ListByLocation", + "tags": [ + "DnsPrivateViews" + ], + "description": "List DnsPrivateView resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateViewListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateViews by location": { + "$ref": "./examples/dnsPrivateViews_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews/{dnsprivateviewocid}": { + "get": { + "operationId": "DnsPrivateViews_Get", + "tags": [ + "DnsPrivateViews" + ], + "description": "Get a DnsPrivateView", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "dnsprivateviewocid", + "in": "path", + "description": "DnsPrivateView OCID", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateView by name": { + "$ref": "./examples/dnsPrivateViews_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones": { + "get": { + "operationId": "DnsPrivateZones_ListByLocation", + "tags": [ + "DnsPrivateZones" + ], + "description": "List DnsPrivateZone resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateZoneListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateZones by location": { + "$ref": "./examples/dnsPrivateZones_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones/{dnsprivatezonename}": { + "get": { + "operationId": "DnsPrivateZones_Get", + "tags": [ + "DnsPrivateZones" + ], + "description": "Get a DnsPrivateZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "dnsprivatezonename", + "in": "path", + "description": "DnsPrivateZone name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateZone by name": { + "$ref": "./examples/dnsPrivateZones_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions": { + "get": { + "operationId": "GiVersions_ListByLocation", + "tags": [ + "GiVersions" + ], + "description": "List GiVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GiVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List GiVersions by location": { + "$ref": "./examples/giVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions/{giversionname}": { + "get": { + "operationId": "GiVersions_Get", + "tags": [ + "GiVersions" + ], + "description": "Get a GiVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "giversionname", + "in": "path", + "description": "GiVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GiVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a GiVersion by name": { + "$ref": "./examples/giVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions": { + "get": { + "operationId": "SystemVersions_ListByLocation", + "tags": [ + "SystemVersions" + ], + "description": "List SystemVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata System Versions by the provided filter": { + "$ref": "./examples/systemVersions_listByLocation.json" + }, + "systemVersions_listByLocation": { + "$ref": "./examples/systemVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions/{systemversionname}": { + "get": { + "operationId": "SystemVersions_Get", + "tags": [ + "SystemVersions" + ], + "description": "Get a SystemVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "systemversionname", + "in": "path", + "description": "SystemVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata System Version": { + "$ref": "./examples/systemVersions_get.json" + }, + "systemVersions_listSystemVersions": { + "$ref": "./examples/systemVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions": { + "get": { + "operationId": "OracleSubscriptions_ListBySubscription", + "tags": [ + "OracleSubscriptions" + ], + "description": "List OracleSubscription resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Oracle Subscriptions by subscription": { + "$ref": "./examples/oracleSubscriptions_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default": { + "get": { + "operationId": "OracleSubscriptions_Get", + "tags": [ + "OracleSubscriptions" + ], + "description": "Get a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_get.json" + } + } + }, + "put": { + "operationId": "OracleSubscriptions_CreateOrUpdate", + "tags": [ + "OracleSubscriptions" + ], + "description": "Create a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OracleSubscription' update operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "201": { + "description": "Resource 'OracleSubscription' create operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "OracleSubscriptions_Update", + "tags": [ + "OracleSubscriptions" + ], + "description": "Update a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "OracleSubscriptions_Delete", + "tags": [ + "OracleSubscriptions" + ], + "description": "Delete a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listActivationLinks": { + "post": { + "operationId": "OracleSubscriptions_ListActivationLinks", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Activation Links", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ActivationLinks" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Activation Links for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listActivationLinks.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listCloudAccountDetails": { + "post": { + "operationId": "OracleSubscriptions_ListCloudAccountDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Cloud Account Details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudAccountDetails" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Cloud Account details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listCloudAccountDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listSaasSubscriptionDetails": { + "post": { + "operationId": "OracleSubscriptions_ListSaasSubscriptionDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Saas Subscription Details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SaasSubscriptionDetails" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Saas Subscription details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listSaasSubscriptionDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListByResourceGroup", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by resource group": { + "$ref": "./examples/autonomousDatabase_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}": { + "get": { + "operationId": "AutonomousDatabases_Get", + "tags": [ + "AutonomousDatabases" + ], + "description": "Get a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Get": { + "$ref": "./examples/autonomousDatabase_get.json" + }, + "Get Autonomous Database": { + "$ref": "./examples/autonomousDatabase_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabases_CreateOrUpdate", + "tags": [ + "AutonomousDatabases" + ], + "description": "Create a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabase' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "201": { + "description": "Resource 'AutonomousDatabase' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "AutonomousDatabases_CreateOrUpdate_clone": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + }, + "Create Autonomous Database": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "Create clone Autonomous Database": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabases_Update", + "tags": [ + "AutonomousDatabases" + ], + "description": "Update a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Autonomous Database": { + "$ref": "./examples/autonomousDatabase_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabases_Delete", + "tags": [ + "AutonomousDatabases" + ], + "description": "Delete a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Autonomous Database": { + "$ref": "./examples/autonomousDatabase_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups": { + "get": { + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "List AutonomousDatabaseBackup resources by AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_ListByAutonomousDatabase": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + }, + "List Autonomous Database Backups by Autonomous Database.": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups/{adbbackupid}": { + "get": { + "operationId": "AutonomousDatabaseBackups_Get", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Get a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Get": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + }, + "Get Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Create a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabaseBackup' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "201": { + "description": "Resource 'AutonomousDatabaseBackup' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + }, + "Create Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabaseBackups_Update", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Update a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Update": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + }, + "Patch Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabaseBackups_Delete", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Delete a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Delete": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + }, + "Delete Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/failover": { + "post": { + "operationId": "AutonomousDatabases_Failover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform failover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Failover": { + "$ref": "./examples/autonomousDatabase_failover.json" + }, + "Perform failover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_failover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/generateWallet": { + "post": { + "operationId": "AutonomousDatabases_GenerateWallet", + "tags": [ + "AutonomousDatabases" + ], + "description": "Generate wallet action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateAutonomousDatabaseWalletDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseWalletFile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Generate wallet action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_generateWallet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/restore": { + "post": { + "operationId": "AutonomousDatabases_Restore", + "tags": [ + "AutonomousDatabases" + ], + "description": "Restores an Autonomous Database based on the provided request parameters.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreAutonomousDatabaseDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Restore": { + "$ref": "./examples/autonomousDatabase_restore.json" + }, + "Perform restore action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_restore.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/shrink": { + "post": { + "operationId": "AutonomousDatabases_Shrink", + "tags": [ + "AutonomousDatabases" + ], + "description": "This operation shrinks the current allocated storage down to the current actual used data storage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Perform shrink action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_shrink.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/switchover": { + "post": { + "operationId": "AutonomousDatabases_Switchover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform switchover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Switchover": { + "$ref": "./examples/autonomousDatabase_switchover.json" + }, + "Perform switchover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_switchover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListByResourceGroup", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by resource group": { + "$ref": "./examples/exaInfra_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}": { + "get": { + "operationId": "CloudExadataInfrastructures_Get", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Get a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata Infrastructure": { + "$ref": "./examples/exaInfra_get.json" + } + } + }, + "put": { + "operationId": "CloudExadataInfrastructures_CreateOrUpdate", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Create a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudExadataInfrastructure' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "201": { + "description": "Resource 'CloudExadataInfrastructure' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Exadata Infrastructure": { + "$ref": "./examples/exaInfra_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudExadataInfrastructures_Update", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Update a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Exadata Infrastructure": { + "$ref": "./examples/exaInfra_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudExadataInfrastructures_Delete", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Delete a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Exadata Infrastructure": { + "$ref": "./examples/exaInfra_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/addStorageCapacity": { + "post": { + "operationId": "CloudExadataInfrastructures_AddStorageCapacity", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Perform add storage capacity on exadata infra", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Perform add storage capacity on exadata infra": { + "$ref": "./examples/exaInfra_addStorageCapacity.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers": { + "get": { + "operationId": "DbServers_ListByCloudExadataInfrastructure", + "tags": [ + "DbServers" + ], + "description": "List DbServer resources by CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbServers by Exadata Infrastructure": { + "$ref": "./examples/dbServers_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers/{dbserverocid}": { + "get": { + "operationId": "DbServers_Get", + "tags": [ + "DbServers" + ], + "description": "Get a DbServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbserverocid", + "in": "path", + "description": "DbServer OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbServer by parent": { + "$ref": "./examples/dbServers_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListByResourceGroup", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by resource group": { + "$ref": "./examples/vmClusters_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}": { + "get": { + "operationId": "CloudVmClusters_Get", + "tags": [ + "CloudVmClusters" + ], + "description": "Get a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get VM Cluster": { + "$ref": "./examples/vmClusters_get.json" + } + } + }, + "put": { + "operationId": "CloudVmClusters_CreateOrUpdate", + "tags": [ + "CloudVmClusters" + ], + "description": "Create a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudVmCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "201": { + "description": "Resource 'CloudVmCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create VM Cluster": { + "$ref": "./examples/vmClusters_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudVmClusters_Update", + "tags": [ + "CloudVmClusters" + ], + "description": "Update a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmClusterUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch VM Cluster": { + "$ref": "./examples/vmClusters_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudVmClusters_Delete", + "tags": [ + "CloudVmClusters" + ], + "description": "Delete a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete VM Cluster": { + "$ref": "./examples/vmClusters_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/addVms": { + "post": { + "operationId": "CloudVmClusters_AddVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Add VMs to the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Add VMs to VM Cluster": { + "$ref": "./examples/vmClusters_addVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes": { + "get": { + "operationId": "DbNodes_ListByCloudVmCluster", + "tags": [ + "DbNodes" + ], + "description": "List DbNode resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNodeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbNodes by VM Cluster": { + "$ref": "./examples/dbNodes_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}": { + "get": { + "operationId": "DbNodes_Get", + "tags": [ + "DbNodes" + ], + "description": "Get a DbNode", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbNode": { + "$ref": "./examples/dbNodes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}/action": { + "post": { + "operationId": "DbNodes_Action", + "tags": [ + "DbNodes" + ], + "description": "VM actions on DbNode of VM Cluster by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DbNodeAction" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DbNodes_Action": { + "$ref": "./examples/dbNodes_action.json" + }, + "VM actions on DbNodes of VM Cluster": { + "$ref": "./examples/dbNodes_action.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/listPrivateIpAddresses": { + "post": { + "operationId": "CloudVmClusters_ListPrivateIpAddresses", + "tags": [ + "CloudVmClusters" + ], + "description": "List Private IP Addresses by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateIpAddressesFilter" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateIpAddressProperties" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private IP Addresses for VM Cluster": { + "$ref": "./examples/vmClusters_listPrivateIpAddresses.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/removeVms": { + "post": { + "operationId": "CloudVmClusters_RemoveVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Remove VMs from the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Remove VMs from VM Cluster": { + "$ref": "./examples/vmClusters_removeVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses": { + "get": { + "operationId": "VirtualNetworkAddresses_ListByCloudVmCluster", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "List VirtualNetworkAddress resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddressListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Virtual Network Addresses by VM Cluster": { + "$ref": "./examples/virtualNetworkAddresses_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses/{virtualnetworkaddressname}": { + "get": { + "operationId": "VirtualNetworkAddresses_Get", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Get a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_get.json" + } + } + }, + "put": { + "operationId": "VirtualNetworkAddresses_CreateOrUpdate", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Create a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualNetworkAddress' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "201": { + "description": "Resource 'VirtualNetworkAddress' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualNetworkAddresses_Delete", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Delete a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActivationLinks": { + "type": "object", + "description": "Activation Links model", + "properties": { + "newCloudAccountActivationLink": { + "type": "string", + "description": "New Cloud Account Activation Link", + "readOnly": true + }, + "existingCloudAccountActivationLink": { + "type": "string", + "description": "Existing Cloud Account Activation Link", + "readOnly": true + } + } + }, + "AddRemoveDbNode": { + "type": "object", + "description": "Add/Remove (Virtual Machine) DbNode model", + "properties": { + "dbServers": { + "type": "array", + "description": "Db servers ocids", + "items": { + "$ref": "#/definitions/Ocid" + } + } + }, + "required": [ + "dbServers" + ] + }, + "AllConnectionStringType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + } + } + }, + "ApexDetailsType": { + "type": "object", + "description": "Information about Oracle APEX Application Development.", + "properties": { + "apexVersion": { + "type": "string", + "description": "The Oracle APEX Application Development version." + }, + "ordsVersion": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) version." + } + } + }, + "AutonomousDatabase": { + "type": "object", + "description": "Autonomous Database resource model.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AutonomousDatabaseBackup": { + "type": "object", + "description": "AutonomousDatabaseBackup resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseBackupLifecycleState": { + "type": "string", + "description": "Autonomous database backup lifecycle state enum", + "enum": [ + "Creating", + "Active", + "Deleting", + "Failed", + "Updating" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "AutonomousDatabase backup is creating" + }, + { + "name": "Active", + "value": "Active", + "description": "AutonomousDatabase backup is active" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "AutonomousDatabase backup is deleting" + }, + { + "name": "Failed", + "value": "Failed", + "description": "AutonomousDatabase backup is failed" + }, + { + "name": "Updating", + "value": "Updating", + "description": "AutonomousDatabase backup is updating" + } + ] + } + }, + "AutonomousDatabaseBackupListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseBackup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseBackup items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseBackupProperties": { + "type": "object", + "description": "AutonomousDatabaseBackup resource model", + "properties": { + "autonomousDatabaseOcid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database.", + "readOnly": true + }, + "databaseSizeInTbs": { + "type": "number", + "format": "double", + "description": "The size of the database in terabytes at the time the backup was taken.", + "readOnly": true + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the backup. The name does not have to be unique.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database backup.", + "readOnly": true + }, + "isAutomatic": { + "type": "boolean", + "description": "Indicates whether the backup is user-initiated or automatic.", + "readOnly": true + }, + "isRestorable": { + "type": "boolean", + "description": "Indicates whether the backup can be used to restore the associated Autonomous Database.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseBackupLifecycleState", + "description": "The current state of the backup.", + "readOnly": true + }, + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "sizeInTbs": { + "type": "number", + "format": "double", + "description": "The backup size in terabytes (TB).", + "readOnly": true + }, + "timeAvailableTil": { + "type": "string", + "format": "date-time", + "description": "Timestamp until when the backup will be available.", + "readOnly": true + }, + "timeStarted": { + "type": "string", + "description": "The date and time the backup started.", + "readOnly": true + }, + "timeEnded": { + "type": "string", + "description": "The date and time the backup completed.", + "readOnly": true + }, + "backupType": { + "$ref": "#/definitions/AutonomousDatabaseBackupType", + "description": "The type of backup.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "AutonomousDatabaseBackupType": { + "type": "string", + "description": "Autonomous database backup type enum", + "enum": [ + "Incremental", + "Full", + "LongTerm" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupType", + "modelAsString": true, + "values": [ + { + "name": "Incremental", + "value": "Incremental", + "description": "Incremental backup" + }, + { + "name": "Full", + "value": "Full", + "description": "Full backup" + }, + { + "name": "LongTerm", + "value": "LongTerm", + "description": "LongTerm backup" + } + ] + } + }, + "AutonomousDatabaseBackupUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabaseBackup.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseBackupUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabaseBackup.", + "properties": { + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseBaseProperties": { + "type": "object", + "description": "Autonomous Database base resource model.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "dataBaseType": { + "$ref": "#/definitions/DataBaseType", + "description": "Database type to be created.", + "x-ms-mutability": [ + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "characterSet": { + "type": "string", + "description": "The character set for the autonomous database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeModel": { + "$ref": "#/definitions/ComputeModel", + "description": "The compute model of the Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbIds": { + "type": "array", + "description": "The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isRemoteDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has Cross Region Data Guard enabled.", + "readOnly": true + }, + "localDisasterRecoveryType": { + "$ref": "#/definitions/DisasterRecoveryType", + "description": "Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance.Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover.Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.", + "readOnly": true + }, + "localStandbyDb": { + "$ref": "#/definitions/AutonomousDatabaseStandbySummary", + "description": "Local Autonomous Disaster Recovery standby database details.", + "readOnly": true + }, + "failedDataRecoveryInSeconds": { + "type": "integer", + "format": "int32", + "description": "Indicates the number of seconds of data loss for a Data Guard failover.", + "readOnly": true + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isPreviewVersionWithServiceTermsAccepted": { + "type": "boolean", + "description": "Specifies if the Autonomous Database preview version is being provisioned.", + "x-ms-mutability": [ + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "ncharacterSet": { + "type": "string", + "description": "The character set for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsType", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "privateEndpointIp": { + "type": "string", + "description": "The private endpoint Ip address for the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "privateEndpointLabel": { + "type": "string", + "description": "The resource's private endpoint label.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database was created.", + "readOnly": true + }, + "timeMaintenanceBegin": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will begin.", + "readOnly": true + }, + "timeMaintenanceEnd": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will end.", + "readOnly": true + }, + "actualUsedDataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The current amount of storage in use for user and system data, in terabytes (TB).", + "readOnly": true + }, + "allocatedStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The amount of storage currently allocated for the database tables and billed for, rounded up.", + "readOnly": true + }, + "apexDetails": { + "$ref": "#/definitions/ApexDetailsType", + "description": "Information about Oracle APEX Application Development.", + "readOnly": true + }, + "availableUpgradeVersions": { + "type": "array", + "description": "List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "connectionStrings": { + "$ref": "#/definitions/ConnectionStringType", + "description": "The connection string used to connect to the Autonomous Database.", + "readOnly": true + }, + "connectionUrls": { + "$ref": "#/definitions/ConnectionUrlType", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. ", + "readOnly": true + }, + "dataSafeStatus": { + "$ref": "#/definitions/DataSafeStatusType", + "description": "Status of the Data Safe registration for this Autonomous Database.", + "readOnly": true + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "autonomousDatabaseId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "Autonomous Database ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "inMemoryAreaInGbs": { + "type": "integer", + "format": "int32", + "description": "The area assigned to In-Memory tables in Autonomous Database.", + "readOnly": true + }, + "nextLongTermBackupTimeStamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the next long-term backup would be created.", + "readOnly": true + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "isPreview": { + "type": "boolean", + "description": "Indicates if the Autonomous Database version is a preview version.", + "readOnly": true + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "memoryPerOracleComputeUnitInGbs": { + "type": "integer", + "format": "int32", + "description": "The amount of memory (in GBs) enabled per ECPU or OCPU.", + "readOnly": true + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "operationsInsightsStatus": { + "$ref": "#/definitions/OperationsInsightsStatusType", + "description": "Status of Operations Insights for this Autonomous Database.", + "readOnly": true + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "privateEndpoint": { + "type": "string", + "description": "The private endpoint for the resource.", + "readOnly": true + }, + "provisionableCpus": { + "type": "array", + "description": "An array of CPU values that an Autonomous Database can be scaled to.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "serviceConsoleUrl": { + "type": "string", + "description": "The URL of the Service Console for the Autonomous Database.", + "minLength": 10, + "maxLength": 255, + "readOnly": true + }, + "sqlWebDeveloperUrl": { + "type": "string", + "description": "The SQL Web Developer URL for the Oracle Autonomous Database.", + "minLength": 10, + "maxLength": 2048, + "readOnly": true + }, + "supportedRegionsToCloneTo": { + "type": "array", + "description": "The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.", + "maxItems": 50, + "items": { + "type": "string" + }, + "readOnly": true + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the Autonomous Database.", + "readOnly": true + }, + "timeDeletionOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be automatically deleted because of inactivity.", + "readOnly": true + }, + "timeLocalDataGuardEnabled": { + "type": "string", + "description": "The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.", + "readOnly": true + }, + "timeOfLastFailover": { + "type": "string", + "description": "The timestamp of the last failover operation.", + "readOnly": true + }, + "timeOfLastRefresh": { + "type": "string", + "description": "The date and time when last refresh happened.", + "readOnly": true + }, + "timeOfLastRefreshPoint": { + "type": "string", + "description": "The refresh point timestamp (UTC).", + "readOnly": true + }, + "timeOfLastSwitchover": { + "type": "string", + "description": "The timestamp of the last switchover operation for the Autonomous Database.", + "readOnly": true + }, + "timeReclamationOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be stopped because of inactivity.", + "readOnly": true + }, + "usedDataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The storage space consumed by Autonomous Database in GBs.", + "readOnly": true + }, + "usedDataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The amount of storage that has been used, in terabytes.", + "readOnly": true + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Database ocid", + "readOnly": true + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "discriminator": "dataBaseType", + "required": [ + "dataBaseType" + ] + }, + "AutonomousDatabaseCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + }, + "required": [ + "characterSet" + ] + }, + "AutonomousDatabaseCloneProperties": { + "type": "object", + "description": "Autonomous Database clone resource model.", + "properties": { + "source": { + "$ref": "#/definitions/SourceType", + "description": "The source of the database.", + "x-ms-mutability": [ + "create" + ] + }, + "sourceId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "The Azure ID of the Autonomous Database that was cloned to create the current Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloneType": { + "$ref": "#/definitions/CloneType", + "description": "The Autonomous Database clone type.", + "x-ms-mutability": [ + "create" + ] + }, + "isReconnectCloneEnabled": { + "type": "boolean", + "description": "Indicates if the refreshable clone can be reconnected to its source database.", + "readOnly": true + }, + "isRefreshableClone": { + "type": "boolean", + "description": "Indicates if the Autonomous Database is a refreshable clone.", + "readOnly": true + }, + "refreshableModel": { + "$ref": "#/definitions/RefreshableModelType", + "description": "The refresh mode of the clone.", + "x-ms-mutability": [ + "create" + ] + }, + "refreshableStatus": { + "$ref": "#/definitions/RefreshableStatusType", + "description": "The refresh status of the clone.", + "readOnly": true + }, + "timeUntilReconnectCloneEnabled": { + "type": "string", + "description": "The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.", + "x-ms-mutability": [ + "read", + "update" + ] + } + }, + "required": [ + "sourceId", + "cloneType" + ], + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Clone" + }, + "AutonomousDatabaseId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/autonomousDatabases" + } + ] + } + }, + "AutonomousDatabaseLifecycleState": { + "type": "string", + "description": "Autonomous database lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Unavailable", + "RestoreInProgress", + "RestoreFailed", + "BackupInProgress", + "ScaleInProgress", + "AvailableNeedsAttention", + "Updating", + "MaintenanceInProgress", + "Restarting", + "Recreating", + "RoleChangeInProgress", + "Upgrading", + "Inaccessible", + "Standby" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "RestoreInProgress", + "value": "RestoreInProgress", + "description": "Indicates that resource in RestoreInProgress state" + }, + { + "name": "RestoreFailed", + "value": "RestoreFailed", + "description": "Indicates that resource in RestoreFailed state" + }, + { + "name": "BackupInProgress", + "value": "BackupInProgress", + "description": "Indicates that resource in BackupInProgress state" + }, + { + "name": "ScaleInProgress", + "value": "ScaleInProgress", + "description": "Indicates that resource in ScaleInProgress state" + }, + { + "name": "AvailableNeedsAttention", + "value": "AvailableNeedsAttention", + "description": "Indicates that resource is available but needs attention" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Restarting", + "value": "Restarting", + "description": "Indicates that resource in Restarting state" + }, + { + "name": "Recreating", + "value": "Recreating", + "description": "Indicates that resource in Recreating state" + }, + { + "name": "RoleChangeInProgress", + "value": "RoleChangeInProgress", + "description": "Indicates that resource role change in progress state" + }, + { + "name": "Upgrading", + "value": "Upgrading", + "description": "Indicates that resource in Upgrading state" + }, + { + "name": "Inaccessible", + "value": "Inaccessible", + "description": "IIndicates that resource in Inaccessible state" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Indicates that resource in Standby state" + } + ] + } + }, + "AutonomousDatabaseListResult": { + "type": "object", + "description": "The response of a AutonomousDatabase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabase items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseNationalCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseNationalCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseNationalCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported national character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + }, + "required": [ + "characterSet" + ] + }, + "AutonomousDatabaseProperties": { + "type": "object", + "description": "Autonomous Database resource model.", + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Regular" + }, + "AutonomousDatabaseStandbySummary": { + "type": "object", + "description": "Autonomous Disaster Recovery standby database details.", + "properties": { + "lagTimeInSeconds": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover." + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "The current state of the Autonomous Database." + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state." + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database." + }, + "timeDisasterRecoveryRoleChanged": { + "type": "string", + "description": "The date and time the Disaster Recovery role was switched for the standby Autonomous Database." + } + } + }, + "AutonomousDatabaseUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabase.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AutonomousDatabaseUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabase.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsTypeUpdate", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseWalletFile": { + "type": "object", + "description": "Autonomous Database Wallet File resource model.", + "properties": { + "walletFiles": { + "type": "string", + "description": "The base64 encoded wallet files" + } + }, + "required": [ + "walletFiles" + ] + }, + "AutonomousDbVersion": { + "type": "object", + "description": "AutonomousDbVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDbVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDbVersionListResult": { + "type": "object", + "description": "The response of a AutonomousDbVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDbVersion items on this page", + "items": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDbVersionProperties": { + "type": "object", + "description": "AutonomousDbVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "Supported Autonomous Db versions.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "readOnly": true + }, + "isDefaultForFree": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is free.", + "readOnly": true + }, + "isDefaultForPaid": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is paid.", + "readOnly": true + }, + "isFreeTierEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.", + "readOnly": true + }, + "isPaidEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software has payments enabled.", + "readOnly": true + } + }, + "required": [ + "version" + ] + }, + "AutonomousMaintenanceScheduleType": { + "type": "string", + "description": "Autonomous database maintenance schedule type enum.", + "enum": [ + "Early", + "Regular" + ], + "x-ms-enum": { + "name": "AutonomousMaintenanceScheduleType", + "modelAsString": true, + "values": [ + { + "name": "Early", + "value": "Early", + "description": "Early maintenance schedule" + }, + { + "name": "Regular", + "value": "Regular", + "description": "Regular maintenance schedule" + } + ] + } + }, + "Azure.ResourceManager.ResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource type.", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ResourceProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "AzureResourceProvisioningState": { + "type": "string", + "description": "Azure Resource Provisioning State enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "x-ms-enum": { + "name": "AzureResourceProvisioningState", + "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": "Indicates that resource in Provisioning state" + } + ] + }, + "readOnly": true + }, + "CloneType": { + "type": "string", + "description": "Clone type enum", + "enum": [ + "Full", + "Metadata" + ], + "x-ms-enum": { + "name": "CloneType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full clone" + }, + { + "name": "Metadata", + "value": "Metadata", + "description": "Metadata only" + } + ] + } + }, + "CloudAccountDetails": { + "type": "object", + "description": "Cloud Account Details model", + "properties": { + "cloudAccountName": { + "type": "string", + "description": "Cloud Account name", + "readOnly": true + }, + "cloudAccountHomeRegion": { + "type": "string", + "description": "Cloud Account Home region", + "readOnly": true + } + } + }, + "CloudAccountProvisioningState": { + "type": "string", + "description": "CloudAccountProvisioningState enum", + "enum": [ + "Pending", + "Provisioning", + "Available" + ], + "x-ms-enum": { + "name": "CloudAccountProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Pending - Initial state when Oracle cloud account is not configured" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning - State when Oracle cloud account is being provisioned" + }, + { + "name": "Available", + "value": "Available", + "description": "Available - State when Oracle cloud account cloud linking is complete and it is available" + } + ] + } + }, + "CloudExadataInfrastructure": { + "type": "object", + "description": "CloudExadataInfrastructure resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + } + }, + "required": [ + "zones" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudExadataInfrastructureId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/cloudExadataInfrastructures" + } + ] + } + }, + "CloudExadataInfrastructureLifecycleState": { + "type": "string", + "description": "CloudExadataInfrastructureLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudExadataInfrastructureLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudExadataInfrastructureListResult": { + "type": "object", + "description": "The response of a CloudExadataInfrastructure list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudExadataInfrastructure items on this page", + "items": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudExadataInfrastructureProperties": { + "type": "object", + "description": "CloudExadataInfrastructure resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Exadata infra ocid", + "readOnly": true + }, + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "totalStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "availableStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "description": "The date and time the cloud Exadata infrastructure resource was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "estimatedPatchingTime": { + "$ref": "#/definitions/EstimatedPatchingTime", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "readOnly": true + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudExadataInfrastructure provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudExadataInfrastructureLifecycleState", + "description": "CloudExadataInfrastructure lifecycle state", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the cloud Exadata infrastructure resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores allocated.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory allocated in GBs.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs.", + "readOnly": true + }, + "maxDbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total local node storage available in GBs.", + "readOnly": true + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The quantity of data in the database, in terabytes.", + "readOnly": true + }, + "maxDataStorageInTbs": { + "type": "number", + "format": "double", + "description": "The total available DATA disk group size.", + "readOnly": true + }, + "dbServerVersion": { + "type": "string", + "description": "The software version of the database servers (dom0) in the Exadata infrastructure.", + "readOnly": true + }, + "storageServerVersion": { + "type": "string", + "description": "The software version of the storage servers (cells) in the Exadata infrastructure.", + "readOnly": true + }, + "activatedStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers activated for the Exadata infrastructure.", + "readOnly": true + }, + "additionalStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers for the Exadata infrastructure.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "lastMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance run.", + "readOnly": true + }, + "nextMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the next maintenance run.", + "readOnly": true + }, + "monthlyDbServerVersion": { + "type": "string", + "description": "Monthly Db Server version", + "readOnly": true + }, + "monthlyStorageServerVersion": { + "type": "string", + "description": "Monthly Storage Server version", + "readOnly": true + } + }, + "required": [ + "shape", + "displayName" + ] + }, + "CloudExadataInfrastructureUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudExadataInfrastructure.", + "properties": { + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "CloudExadataInfrastructureUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudExadataInfrastructure.", + "properties": { + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "CloudVmCluster": { + "type": "object", + "description": "CloudVmCluster resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudVmClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudVmClusterLifecycleState": { + "type": "string", + "description": "Cloud VM Cluster lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudVmClusterLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource Maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudVmClusterListResult": { + "type": "object", + "description": "The response of a CloudVmCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudVmCluster items on this page", + "items": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudVmClusterProperties": { + "type": "object", + "description": "CloudVmCluster resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Cloud VM Cluster ocid", + "readOnly": true + }, + "listenerPort": { + "type": "integer", + "format": "int64", + "description": "The port number configured for the listener on the cloud VM cluster.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the cloud VM cluster. ", + "readOnly": true + }, + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the cloud VM cluster was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "timeZone": { + "type": "string", + "description": "The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm).", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "zoneId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the zone the cloud VM cluster is associated with.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hostname": { + "type": "string", + "description": "The hostname for the cloud VM cluster.", + "minLength": 1, + "maxLength": 23, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "domain": { + "type": "string", + "description": "The domain name for the cloud VM cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "clusterName": { + "type": "string", + "description": "The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ", + "minLength": 1, + "maxLength": 11, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataStoragePercentage": { + "type": "integer", + "format": "int32", + "description": "The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isLocalBackupEnabled": { + "type": "boolean", + "description": "If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudExadataInfrastructureId": { + "$ref": "#/definitions/CloudExadataInfrastructureId", + "description": "Cloud Exadata Infrastructure ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isSparseDiskgroupEnabled": { + "type": "boolean", + "description": "If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemVersion": { + "type": "string", + "description": "Operating system version of the image.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "diskRedundancy": { + "$ref": "#/definitions/DiskRedundancy", + "description": "The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ", + "readOnly": true + }, + "scanIpIds": { + "type": "array", + "description": "The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vipIds": { + "type": "array", + "description": "The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "scanDnsName": { + "type": "string", + "description": "The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ", + "minLength": 1, + "maxLength": 72, + "readOnly": true + }, + "scanListenerPortTcp": { + "type": "integer", + "format": "int32", + "description": "The TCP Single Client Access Name (SCAN) port. The default port is 1521.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanListenerPortTcpSsl": { + "type": "integer", + "format": "int32", + "description": "The TCPS Single Client Access Name (SCAN) port. The default port is 2484.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanDnsRecordId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the Exadata hardware running the cloud VM cluster.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudVmCluster provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudVmClusterLifecycleState", + "description": "CloudVmCluster lifecycle state", + "readOnly": true + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "giVersion": { + "type": "string", + "description": "Oracle Grid Infrastructure (GI) software version", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "nsgUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupSubnetCidr": { + "type": "string", + "description": "Client OCI backup subnet CIDR, default is 192.168.252.0/22", + "minLength": 1, + "maxLength": 32, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nsgCidrs": { + "type": "array", + "description": "CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.", + "items": { + "$ref": "#/definitions/NsgCidr" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + }, + "iormConfigCache": { + "$ref": "#/definitions/ExadataIormConfig", + "description": "iormConfigCache details for cloud VM cluster.", + "readOnly": true + }, + "lastUpdateHistoryEntryId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance update history entry.", + "readOnly": true + }, + "dbServers": { + "type": "array", + "description": "The list of DB servers.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "Cluster compartmentId", + "readOnly": true + }, + "subnetOcid": { + "$ref": "#/definitions/Ocid", + "description": "Cluster subnet ocid", + "readOnly": true + } + }, + "required": [ + "hostname", + "cpuCoreCount", + "cloudExadataInfrastructureId", + "sshPublicKeys", + "vnetId", + "giVersion", + "subnetId", + "displayName" + ] + }, + "CloudVmClusterUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudVmCluster.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudVmClusterUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "CloudVmClusterUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudVmCluster.", + "properties": { + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ComputeModel": { + "type": "string", + "description": "Compute model enum", + "enum": [ + "ECPU", + "OCPU" + ], + "x-ms-enum": { + "name": "ComputeModel", + "modelAsString": true, + "values": [ + { + "name": "ECPU", + "value": "ECPU", + "description": "ECPU model type" + }, + { + "name": "OCPU", + "value": "OCPU", + "description": "OCPU model type" + } + ] + } + }, + "ConnectionStringType": { + "type": "object", + "description": "Connection strings to connect to an Oracle Autonomous Database.", + "properties": { + "allConnectionStrings": { + "$ref": "#/definitions/AllConnectionStringType", + "description": "Returns all connection strings that can be used to connect to the Autonomous Database." + }, + "dedicated": { + "type": "string", + "description": "The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "profiles": { + "type": "array", + "description": "A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.", + "items": { + "$ref": "#/definitions/ProfileType" + }, + "x-ms-identifiers": [] + } + } + }, + "ConnectionUrlType": { + "type": "object", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.", + "properties": { + "apexUrl": { + "type": "string", + "description": "Oracle Application Express (APEX) URL.", + "minLength": 10, + "maxLength": 512 + }, + "databaseTransformsUrl": { + "type": "string", + "description": "The URL of the Database Transforms for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "graphStudioUrl": { + "type": "string", + "description": "The URL of the Graph Studio for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "machineLearningNotebookUrl": { + "type": "string", + "description": "The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "mongoDbUrl": { + "type": "string", + "description": "The URL of the MongoDB API for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "ordsUrl": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "sqlDevWebUrl": { + "type": "string", + "description": "Oracle SQL Developer Web URL.", + "minLength": 10, + "maxLength": 512 + } + } + }, + "ConsumerGroup": { + "type": "string", + "description": "Consumer group enum.", + "enum": [ + "High", + "Medium", + "Low", + "Tp", + "Tpurgent" + ], + "x-ms-enum": { + "name": "ConsumerGroup", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High group" + }, + { + "name": "Medium", + "value": "Medium", + "description": "Medium group" + }, + { + "name": "Low", + "value": "Low", + "description": "Low group" + }, + { + "name": "Tp", + "value": "Tp", + "description": "TP group" + }, + { + "name": "Tpurgent", + "value": "Tpurgent", + "description": "TPurgent group" + } + ] + } + }, + "CustomerContact": { + "type": "object", + "description": "CustomerContact resource properties", + "properties": { + "email": { + "type": "string", + "description": "The email address used by Oracle to send notifications regarding databases and infrastructure.", + "minLength": 1, + "maxLength": 320 + } + }, + "required": [ + "email" + ] + }, + "DataBaseType": { + "type": "string", + "description": "Database type enum", + "enum": [ + "Regular", + "Clone" + ], + "x-ms-enum": { + "name": "DataBaseType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular DB" + }, + { + "name": "Clone", + "value": "Clone", + "description": "Clone DB" + } + ] + } + }, + "DataCollectionOptions": { + "type": "object", + "description": "DataCollectionOptions resource properties", + "properties": { + "isDiagnosticsEventsEnabled": { + "type": "boolean", + "description": "Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS.", + "default": false + }, + "isHealthMonitoringEnabled": { + "type": "boolean", + "description": "Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + }, + "isIncidentLogsEnabled": { + "type": "boolean", + "description": "Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + } + } + }, + "DataSafeStatusType": { + "type": "string", + "description": "DataSafe status type enum.", + "enum": [ + "Registering", + "Registered", + "Deregistering", + "NotRegistered", + "Failed" + ], + "x-ms-enum": { + "name": "DataSafeStatusType", + "modelAsString": true, + "values": [ + { + "name": "Registering", + "value": "Registering", + "description": "Registering status" + }, + { + "name": "Registered", + "value": "Registered", + "description": "Registered status" + }, + { + "name": "Deregistering", + "value": "Deregistering", + "description": "Deregistering status" + }, + { + "name": "NotRegistered", + "value": "NotRegistered", + "description": "NotRegistered status" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed status" + } + ] + } + }, + "DatabaseEditionType": { + "type": "string", + "description": "Database edition type enum.", + "enum": [ + "StandardEdition", + "EnterpriseEdition" + ], + "x-ms-enum": { + "name": "DatabaseEditionType", + "modelAsString": true, + "values": [ + { + "name": "StandardEdition", + "value": "StandardEdition", + "description": "Standard edition" + }, + { + "name": "EnterpriseEdition", + "value": "EnterpriseEdition", + "description": "Enterprise edition" + } + ] + } + }, + "DayOfWeek": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + }, + "required": [ + "name" + ] + }, + "DayOfWeekName": { + "type": "string", + "description": "DayOfWeekName enum", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeekName", + "modelAsString": true, + "values": [ + { + "name": "Monday", + "value": "Monday", + "description": "Monday value" + }, + { + "name": "Tuesday", + "value": "Tuesday", + "description": "Tuesday value" + }, + { + "name": "Wednesday", + "value": "Wednesday", + "description": "Wednesday value" + }, + { + "name": "Thursday", + "value": "Thursday", + "description": "Thursday value" + }, + { + "name": "Friday", + "value": "Friday", + "description": "Friday value" + }, + { + "name": "Saturday", + "value": "Saturday", + "description": "Saturday value" + }, + { + "name": "Sunday", + "value": "Sunday", + "description": "Sunday value" + } + ] + } + }, + "DayOfWeekUpdate": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + } + }, + "DbIormConfig": { + "type": "object", + "description": "DbIormConfig for cloud vm cluster", + "properties": { + "dbName": { + "type": "string", + "description": "The database name. For the default DbPlan, the dbName is default." + }, + "flashCacheLimit": { + "type": "string", + "description": "The flash cache limit for this database. This value is internally configured based on the share value assigned to the database." + }, + "share": { + "type": "integer", + "format": "int32", + "description": "The relative priority of this database.", + "minimum": 1, + "maximum": 32 + } + } + }, + "DbNode": { + "type": "object", + "description": "The DbNode resource belonging to vmCluster", + "properties": { + "properties": { + "$ref": "#/definitions/DbNodeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbNodeAction": { + "type": "object", + "description": "DbNode action object", + "properties": { + "action": { + "$ref": "#/definitions/DbNodeActionEnum", + "description": "Db action" + } + }, + "required": [ + "action" + ] + }, + "DbNodeActionEnum": { + "type": "string", + "description": "DbNode action enum", + "enum": [ + "Start", + "Stop", + "SoftReset", + "Reset" + ], + "x-ms-enum": { + "name": "DbNodeActionEnum", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "Start DbNode" + }, + { + "name": "Stop", + "value": "Stop", + "description": "Stop DbNode" + }, + { + "name": "SoftReset", + "value": "SoftReset", + "description": "Soft reset DbNode" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset DbNode" + } + ] + } + }, + "DbNodeListResult": { + "type": "object", + "description": "The response of a DbNode list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbNode items on this page", + "items": { + "$ref": "#/definitions/DbNode" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbNodeMaintenanceType": { + "type": "string", + "description": "The type of database node maintenance.", + "enum": [ + "VmdbRebootMigration" + ], + "x-ms-enum": { + "name": "DbNodeMaintenanceType", + "modelAsString": true, + "values": [ + { + "name": "VmdbRebootMigration", + "value": "VmdbRebootMigration", + "description": "VMDB reboot migration maintenance type" + } + ] + } + }, + "DbNodeProperties": { + "type": "object", + "description": "The properties of DbNodeResource", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "DbNode OCID", + "readOnly": true + }, + "additionalDetails": { + "type": "string", + "description": "Additional information about the planned maintenance.", + "readOnly": true + }, + "backupIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup IP address associated with the database node.", + "readOnly": true + }, + "backupVnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second backup VNIC.", + "readOnly": true + }, + "backupVnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup VNIC.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db node.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db node.", + "readOnly": true + }, + "dbServerId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exacc Db server associated with the database node.", + "readOnly": true + }, + "dbSystemId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DB system.", + "readOnly": true + }, + "faultDomain": { + "type": "string", + "description": "The name of the Fault Domain the instance is contained in.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "hostIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the host IP address associated with the database node.", + "readOnly": true + }, + "hostname": { + "type": "string", + "description": "The host name for the database node.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbNodeProvisioningState", + "description": "The current state of the database node.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of Db Node.", + "readOnly": true + }, + "maintenanceType": { + "$ref": "#/definitions/DbNodeMaintenanceType", + "description": "The type of database node maintenance.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated memory in GBs on the Db node.", + "readOnly": true + }, + "softwareStorageSizeInGb": { + "type": "integer", + "format": "int32", + "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database node was created.", + "readOnly": true + }, + "timeMaintenanceWindowEnd": { + "type": "string", + "format": "date-time", + "description": "End date and time of maintenance window.", + "readOnly": true + }, + "timeMaintenanceWindowStart": { + "type": "string", + "format": "date-time", + "description": "Start date and time of maintenance window.", + "readOnly": true + }, + "vnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second VNIC.", + "readOnly": true + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the VNIC.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + }, + "required": [ + "ocid", + "dbSystemId" + ] + }, + "DbNodeProvisioningState": { + "type": "string", + "description": "DnNode provisioning state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "DbNodeProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "DbServer": { + "type": "object", + "description": "DbServer resource model", + "properties": { + "properties": { + "$ref": "#/definitions/DbServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbServerListResult": { + "type": "object", + "description": "The response of a DbServer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbServer items on this page", + "items": { + "$ref": "#/definitions/DbServer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbServerPatchingDetails": { + "type": "object", + "description": "DbServer Patching Properties", + "properties": { + "estimatedPatchDuration": { + "type": "integer", + "format": "int32", + "description": "Estimated Patch Duration", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "patchingStatus": { + "$ref": "#/definitions/DbServerPatchingStatus", + "description": "Patching Status", + "readOnly": true + }, + "timePatchingEnded": { + "type": "string", + "format": "date-time", + "description": "Time Patching Ended", + "readOnly": true + }, + "timePatchingStarted": { + "type": "string", + "format": "date-time", + "description": "Time Patching Started", + "readOnly": true + } + } + }, + "DbServerPatchingStatus": { + "type": "string", + "description": "DB Server patching status enum", + "enum": [ + "Scheduled", + "MaintenanceInProgress", + "Failed", + "Complete" + ], + "x-ms-enum": { + "name": "DbServerPatchingStatus", + "modelAsString": true, + "values": [ + { + "name": "Scheduled", + "value": "Scheduled", + "description": "Patching scheduled" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Patching in progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Patching failed" + }, + { + "name": "Complete", + "value": "Complete", + "description": "Patching completed" + } + ] + } + }, + "DbServerProperties": { + "type": "object", + "description": "DbServer resource properties", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Db server name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Db Server.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the compartment.", + "readOnly": true + }, + "exadataInfrastructureId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exadata infrastructure.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db server.", + "readOnly": true + }, + "dbServerPatchingDetails": { + "$ref": "#/definitions/DbServerPatchingDetails", + "description": "dbServerPatching details of the Db server.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db server.", + "readOnly": true + }, + "vmClusterIds": { + "type": "array", + "description": "The OCID of the VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "dbNodeIds": { + "type": "array", + "description": "The OCID of the Db nodes associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of dbServer.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbServerProvisioningState", + "description": "DbServer provisioning state.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "autonomousVmClusterIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "autonomousVirtualMachineIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "maxDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The total max dbNode storage in GBs.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory size in GBs.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the Db Server was created.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DbServerProvisioningState": { + "type": "string", + "description": "DbServerProvisioningState enum", + "enum": [ + "Creating", + "Available", + "Unavailable", + "Deleting", + "Deleted", + "MaintenanceInProgress" + ], + "x-ms-enum": { + "name": "DbServerProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "Indicates that resource in Creating state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Indicates that resource in Deleting state" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Indicates that resource in Deleted state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + } + ] + } + }, + "DbSystemShape": { + "type": "object", + "description": "DbSystemShape resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DbSystemShapeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbSystemShapeListResult": { + "type": "object", + "description": "The response of a DbSystemShape list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbSystemShape items on this page", + "items": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbSystemShapeProperties": { + "type": "object", + "description": "DbSystemShape resource model", + "properties": { + "shapeFamily": { + "type": "string", + "description": "The family of the shape used for the DB system.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "availableCoreCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "minimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "runtimeMinimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "coreCountIncrement": { + "type": "integer", + "format": "int32", + "description": "The discrete number by which the CPU core count for this shape can be increased or decreased.", + "readOnly": true + }, + "minStorageCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "maxStorageCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "availableDataStoragePerServerInTbs": { + "type": "number", + "format": "double", + "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableDbNodePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "minCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled per node for this shape.", + "readOnly": true + }, + "availableMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory that can be enabled for this shape.", + "readOnly": true + }, + "minMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum memory that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage that can be enabled for this shape.", + "readOnly": true + }, + "minDbNodeStoragePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum Db Node storage that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The maximum DATA storage that can be enabled for this shape.", + "readOnly": true + }, + "minDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The minimum data storage that need be allocated for this shape.", + "readOnly": true + }, + "minimumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of database nodes available for this shape.", + "readOnly": true + }, + "maximumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of database nodes available for this shape.", + "readOnly": true + }, + "availableCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", + "readOnly": true + } + }, + "required": [ + "availableCoreCount" + ] + }, + "DisasterRecoveryType": { + "type": "string", + "description": "Disaster recovery type enum.", + "enum": [ + "Adg", + "BackupBased" + ], + "x-ms-enum": { + "name": "DisasterRecoveryType", + "modelAsString": true, + "values": [ + { + "name": "Adg", + "value": "Adg", + "description": "ADG type" + }, + { + "name": "BackupBased", + "value": "BackupBased", + "description": "Backup based type" + } + ] + } + }, + "DiskRedundancy": { + "type": "string", + "description": "Disk redundancy enum", + "enum": [ + "High", + "Normal" + ], + "x-ms-enum": { + "name": "DiskRedundancy", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High redundancy" + }, + { + "name": "Normal", + "value": "Normal", + "description": "Normal redundancy" + } + ] + } + }, + "DnsPrivateView": { + "type": "object", + "description": "DnsPrivateView resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateViewProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateViewListResult": { + "type": "object", + "description": "The response of a DnsPrivateView list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateView items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateViewProperties": { + "type": "object", + "description": "Views resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the view", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name of the view resource", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateViewsLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "timeUpdated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + }, + "required": [ + "ocid", + "isProtected", + "self", + "timeCreated", + "timeUpdated" + ] + }, + "DnsPrivateViewsLifecycleState": { + "type": "string", + "description": "DNS Private Views lifecycle state enum", + "enum": [ + "Active", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateViewsLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private View is active" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private View is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private View is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private View is updating" + } + ] + } + }, + "DnsPrivateZone": { + "type": "object", + "description": "DnsPrivateZone resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateZoneProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateZoneListResult": { + "type": "object", + "description": "The response of a DnsPrivateZone list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateZone items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateZoneProperties": { + "type": "object", + "description": "Zones resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Zone", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateZonesLifecycleState", + "description": "Zones lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "serial": { + "type": "integer", + "format": "int32", + "description": "The current serial of the zone. As seen in the zone's SOA record.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.", + "readOnly": true + }, + "viewId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.", + "readOnly": true + }, + "zoneType": { + "$ref": "#/definitions/ZoneType", + "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Zones timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + }, + "required": [ + "ocid", + "isProtected", + "self", + "serial", + "version", + "zoneType", + "timeCreated" + ] + }, + "DnsPrivateZonesLifecycleState": { + "type": "string", + "description": "DNS Private Zones lifecycle state enum", + "enum": [ + "Active", + "Creating", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateZonesLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private Zones is active" + }, + { + "name": "Creating", + "value": "Creating", + "description": "DNS Private Zones is creating" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private Zones is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private Zones is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private Zones is updating" + } + ] + } + }, + "EstimatedPatchingTime": { + "type": "object", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "properties": { + "estimatedDbServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for database server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedNetworkSwitchesPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for network switch patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedStorageServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for storage server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "totalEstimatedPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated total time required in minutes for all patching operations.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + } + } + }, + "ExadataIormConfig": { + "type": "object", + "description": "ExadataIormConfig for cloud vm cluster", + "properties": { + "dbPlans": { + "type": "array", + "description": "An array of IORM settings for all the database in the Exadata DB system.", + "items": { + "$ref": "#/definitions/DbIormConfig" + }, + "x-ms-identifiers": [] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycleState." + }, + "lifecycleState": { + "$ref": "#/definitions/IormLifecycleState", + "description": "The current state of IORM configuration for the Exadata DB system." + }, + "objective": { + "$ref": "#/definitions/Objective", + "description": "The current value for the IORM objective. The default is AUTO." + } + } + }, + "GenerateAutonomousDatabaseWalletDetails": { + "type": "object", + "description": "Autonomous Database Generate Wallet resource model.", + "properties": { + "generateType": { + "$ref": "#/definitions/GenerateType", + "description": "The type of wallet to generate." + }, + "isRegional": { + "type": "boolean", + "description": "True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only." + }, + "password": { + "$ref": "#/definitions/Password", + "description": "The password to encrypt the keys inside the wallet", + "minLength": 8 + } + }, + "required": [ + "password" + ] + }, + "GenerateType": { + "type": "string", + "description": "Generate type enum", + "enum": [ + "Single", + "All" + ], + "x-ms-enum": { + "name": "GenerateType", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "Single", + "description": "Generate single" + }, + { + "name": "All", + "value": "All", + "description": "Generate all" + } + ] + } + }, + "GiVersion": { + "type": "object", + "description": "GiVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/GiVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GiVersionListResult": { + "type": "object", + "description": "The response of a GiVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GiVersion items on this page", + "items": { + "$ref": "#/definitions/GiVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GiVersionProperties": { + "type": "object", + "description": "GiVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "A valid Oracle Grid Infrastructure (GI) software version.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + }, + "required": [ + "version" + ] + }, + "HostFormatType": { + "type": "string", + "description": "Host format type enum.", + "enum": [ + "Fqdn", + "Ip" + ], + "x-ms-enum": { + "name": "HostFormatType", + "modelAsString": true, + "values": [ + { + "name": "Fqdn", + "value": "Fqdn", + "description": "FQDN format" + }, + { + "name": "Ip", + "value": "Ip", + "description": "IP format" + } + ] + } + }, + "Intent": { + "type": "string", + "description": "Intent enum", + "enum": [ + "Retain", + "Reset" + ], + "x-ms-enum": { + "name": "Intent", + "modelAsString": true, + "values": [ + { + "name": "Retain", + "value": "Retain", + "description": "Retain intent" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset intent" + } + ] + } + }, + "IormLifecycleState": { + "type": "string", + "description": "ORM lifecycle state enum", + "enum": [ + "BootStrapping", + "Enabled", + "Disabled", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "IormLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "BootStrapping", + "value": "BootStrapping", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Indicates that resource in Enabled state" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Indicates that resource in Disabled state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "LicenseModel": { + "type": "string", + "description": "LicenseModel enum", + "enum": [ + "LicenseIncluded", + "BringYourOwnLicense" + ], + "x-ms-enum": { + "name": "LicenseModel", + "modelAsString": true, + "values": [ + { + "name": "LicenseIncluded", + "value": "LicenseIncluded", + "description": "License included" + }, + { + "name": "BringYourOwnLicense", + "value": "BringYourOwnLicense", + "description": "Bring Your Own License" + } + ] + } + }, + "LongTermBackUpScheduleDetails": { + "type": "object", + "description": "Details for the long-term backup schedule.", + "properties": { + "repeatCadence": { + "$ref": "#/definitions/RepeatCadenceType", + "description": "The frequency of the long-term backup schedule" + }, + "timeOfBackup": { + "type": "string", + "format": "date-time", + "description": "The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month." + }, + "retentionPeriodInDays": { + "$ref": "#/definitions/RetentionPeriod", + "description": "Retention period, in days, for backups." + }, + "isDisabled": { + "type": "boolean", + "description": "Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`." + } + } + }, + "MaintenanceWindow": { + "type": "object", + "description": "MaintenanceWindow resource properties", + "properties": { + "preference": { + "$ref": "#/definitions/Preference", + "description": "The maintenance window scheduling preference." + }, + "months": { + "type": "array", + "description": "Months during the year when maintenance should be performed.", + "items": { + "$ref": "#/definitions/Month" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "weeksOfMonth": { + "type": "array", + "description": "Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ", + "items": { + "type": "integer", + "format": "int32" + } + }, + "daysOfWeek": { + "type": "array", + "description": "Days during the week when maintenance should be performed.", + "items": { + "$ref": "#/definitions/DayOfWeek" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hoursOfDay": { + "type": "array", + "description": "The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC", + "items": { + "type": "integer", + "format": "int32" + } + }, + "leadTimeInWeeks": { + "type": "integer", + "format": "int32", + "description": "Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. " + }, + "patchingMode": { + "$ref": "#/definitions/PatchingMode", + "description": "Cloud Exadata infrastructure node patching method." + }, + "customActionTimeoutInMins": { + "type": "integer", + "format": "int32", + "description": "Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).", + "minimum": 0, + "maximum": 120 + }, + "isCustomActionTimeoutEnabled": { + "type": "boolean", + "description": "If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations." + }, + "isMonthlyPatchingEnabled": { + "type": "boolean", + "description": "is Monthly Patching Enabled" + } + } + }, + "Month": { + "type": "object", + "description": "Month resource properties", + "properties": { + "name": { + "$ref": "#/definitions/MonthName", + "description": "Name of the month of the year." + } + }, + "required": [ + "name" + ] + }, + "MonthName": { + "type": "string", + "description": "MonthName enum", + "enum": [ + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ], + "x-ms-enum": { + "name": "MonthName", + "modelAsString": true, + "values": [ + { + "name": "January", + "value": "January", + "description": "January value" + }, + { + "name": "February", + "value": "February", + "description": "February value" + }, + { + "name": "March", + "value": "March", + "description": "March value" + }, + { + "name": "April", + "value": "April", + "description": "April value" + }, + { + "name": "May", + "value": "May", + "description": "May value" + }, + { + "name": "June", + "value": "June", + "description": "June value" + }, + { + "name": "July", + "value": "July", + "description": "July value" + }, + { + "name": "August", + "value": "August", + "description": "August value" + }, + { + "name": "September", + "value": "September", + "description": "September value" + }, + { + "name": "October", + "value": "October", + "description": "October value" + }, + { + "name": "November", + "value": "November", + "description": "November value" + }, + { + "name": "December", + "value": "December", + "description": "December value" + } + ] + } + }, + "MsRpaasNewResourceHeader": { + "type": "object", + "description": "Header to distinguish between resource creation or update" + }, + "NsgCidr": { + "type": "object", + "description": "A rule for allowing inbound (INGRESS) IP packets", + "properties": { + "source": { + "type": "string", + "description": "Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.", + "minLength": 1, + "maxLength": 128 + }, + "destinationPortRange": { + "$ref": "#/definitions/PortRange", + "description": "Destination port range to specify particular destination ports for TCP rules." + } + }, + "required": [ + "source" + ] + }, + "Objective": { + "type": "string", + "description": "Objective enum", + "enum": [ + "LowLatency", + "HighThroughput", + "Balanced", + "Auto", + "Basic" + ], + "x-ms-enum": { + "name": "Objective", + "modelAsString": true, + "values": [ + { + "name": "LowLatency", + "value": "LowLatency", + "description": "Low latency objective" + }, + { + "name": "HighThroughput", + "value": "HighThroughput", + "description": "High throughput objective" + }, + { + "name": "Balanced", + "value": "Balanced", + "description": "Balanced objective" + }, + { + "name": "Auto", + "value": "Auto", + "description": "Auto objective" + }, + { + "name": "Basic", + "value": "Basic", + "description": "Basic objective" + } + ] + } + }, + "Ocid": { + "type": "string", + "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.", + "minLength": 1, + "maxLength": 255 + }, + "OpenModeType": { + "type": "string", + "description": "Open mode type enum.", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "OpenModeType", + "modelAsString": true, + "values": [ + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "ReadOnly mode" + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "ReadWrite mode" + } + ] + } + }, + "OperationsInsightsStatusType": { + "type": "string", + "description": "Operations Insights status type enum.", + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "NotEnabled", + "FailedEnabling", + "FailedDisabling" + ], + "x-ms-enum": { + "name": "OperationsInsightsStatusType", + "modelAsString": true, + "values": [ + { + "name": "Enabling", + "value": "Enabling", + "description": "Enabling status" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled status" + }, + { + "name": "Disabling", + "value": "Disabling", + "description": "Disabling status" + }, + { + "name": "NotEnabled", + "value": "NotEnabled", + "description": "NotEnabled status" + }, + { + "name": "FailedEnabling", + "value": "FailedEnabling", + "description": "FailedEnabling status" + }, + { + "name": "FailedDisabling", + "value": "FailedDisabling", + "description": "FailedDisabling status" + } + ] + } + }, + "OracleSubscription": { + "type": "object", + "description": "OracleSubscription resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/OracleSubscriptionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan", + "description": "Details of the resource plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OracleSubscriptionListResult": { + "type": "object", + "description": "The response of a OracleSubscription list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OracleSubscription items on this page", + "items": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OracleSubscriptionProperties": { + "type": "object", + "description": "Oracle Subscription resource model", + "properties": { + "provisioningState": { + "$ref": "#/definitions/OracleSubscriptionProvisioningState", + "description": "OracleSubscriptionProvisioningState provisioning state", + "readOnly": true + }, + "saasSubscriptionId": { + "type": "string", + "description": "SAAS subscription ID generated by Marketplace", + "readOnly": true + }, + "cloudAccountId": { + "$ref": "#/definitions/Ocid", + "description": "Cloud Account Id", + "readOnly": true + }, + "cloudAccountState": { + "$ref": "#/definitions/CloudAccountProvisioningState", + "description": "Cloud Account provisioning state.", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + } + } + }, + "OracleSubscriptionProvisioningState": { + "type": "string", + "description": "OracleSubscriptionProvisioningState enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OracleSubscriptionProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "OracleSubscriptionUpdate": { + "type": "object", + "description": "The type used for update operations of the OracleSubscription.", + "properties": { + "plan": { + "$ref": "#/definitions/PlanUpdate", + "description": "Details of the resource plan." + }, + "properties": { + "$ref": "#/definitions/OracleSubscriptionUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "OracleSubscriptionUpdateProperties": { + "type": "object", + "description": "The updatable properties of the OracleSubscription.", + "properties": { + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + } + } + }, + "Password": { + "type": "string", + "format": "password", + "description": "Password string.", + "x-ms-secret": true + }, + "PatchingMode": { + "type": "string", + "description": "Patching mode enum", + "enum": [ + "Rolling", + "NonRolling" + ], + "x-ms-enum": { + "name": "PatchingMode", + "modelAsString": true, + "values": [ + { + "name": "Rolling", + "value": "Rolling", + "description": "Rolling patching" + }, + { + "name": "NonRolling", + "value": "NonRolling", + "description": "Non Rolling patching" + } + ] + } + }, + "PeerDbDetails": { + "type": "object", + "description": "PeerDb Details", + "properties": { + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255 + } + } + }, + "PermissionLevelType": { + "type": "string", + "description": "Permission level type enum.", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "PermissionLevelType", + "modelAsString": true, + "values": [ + { + "name": "Restricted", + "value": "Restricted", + "description": "Restricted permission level" + }, + { + "name": "Unrestricted", + "value": "Unrestricted", + "description": "Unrestricted permission level" + } + ] + } + }, + "PlanUpdate": { + "type": "object", + "description": "ResourcePlanTypeUpdate model definition", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + } + }, + "PortRange": { + "type": "object", + "description": "Port Range to specify particular destination ports for TCP rules.", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum port number, which must not be greater than the maximum port number.", + "minimum": 1, + "maximum": 65535 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.", + "minimum": 1, + "maximum": 65535 + } + }, + "required": [ + "min", + "max" + ] + }, + "Preference": { + "type": "string", + "description": "Preference enum", + "enum": [ + "NoPreference", + "CustomPreference" + ], + "x-ms-enum": { + "name": "Preference", + "modelAsString": true, + "values": [ + { + "name": "NoPreference", + "value": "NoPreference", + "description": "No preference" + }, + { + "name": "CustomPreference", + "value": "CustomPreference", + "description": "Custom preference" + } + ] + } + }, + "PrivateIpAddressProperties": { + "type": "object", + "description": "PrivateIpAddress resource properties", + "properties": { + "displayName": { + "type": "string", + "description": "PrivateIpAddresses displayName" + }, + "hostnameLabel": { + "type": "string", + "description": "PrivateIpAddresses hostnameLabel" + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses Id" + }, + "ipAddress": { + "type": "string", + "description": "PrivateIpAddresses ipAddress" + }, + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses subnetId" + } + }, + "required": [ + "displayName", + "hostnameLabel", + "ocid", + "ipAddress", + "subnetId" + ] + }, + "PrivateIpAddressesFilter": { + "type": "object", + "description": "Private Ip Addresses filter", + "properties": { + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "Subnet OCID" + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "VCN OCID" + } + }, + "required": [ + "subnetId", + "vnicId" + ] + }, + "ProfileType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "consumerGroup": { + "$ref": "#/definitions/ConsumerGroup", + "description": "Consumer group used by the connection." + }, + "displayName": { + "type": "string", + "description": "A user-friendly name for the connection.", + "minLength": 1, + "maxLength": 255 + }, + "hostFormat": { + "$ref": "#/definitions/HostFormatType", + "description": "Host format used in connection string." + }, + "isRegional": { + "type": "boolean", + "description": "True for a regional connection string, applicable to cross-region DG only." + }, + "protocol": { + "$ref": "#/definitions/ProtocolType", + "description": "Protocol used by the connection." + }, + "sessionMode": { + "$ref": "#/definitions/SessionModeType", + "description": "Specifies whether the listener performs a direct hand-off of the session, or redirects the session." + }, + "syntaxFormat": { + "$ref": "#/definitions/SyntaxFormatType", + "description": "Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format." + }, + "tlsAuthentication": { + "$ref": "#/definitions/TlsAuthenticationType", + "description": "Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication." + }, + "value": { + "type": "string", + "description": "Connection string value." + } + }, + "required": [ + "displayName", + "hostFormat", + "protocol", + "sessionMode", + "syntaxFormat", + "value" + ] + }, + "ProtocolType": { + "type": "string", + "description": "Protocol type enum.", + "enum": [ + "TCP", + "TCPS" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true, + "values": [ + { + "name": "TCP", + "value": "TCP", + "description": "TCP protocol" + }, + { + "name": "TCPS", + "value": "TCPS", + "description": "TCPS protocol" + } + ] + } + }, + "RefreshableModelType": { + "type": "string", + "description": "Refreshable model type enum", + "enum": [ + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "RefreshableModelType", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatic refreshable model type" + }, + { + "name": "Manual", + "value": "Manual", + "description": "Manual refreshable model type" + } + ] + } + }, + "RefreshableStatusType": { + "type": "string", + "description": "Refreshable status type enum.", + "enum": [ + "Refreshing", + "NotRefreshing" + ], + "x-ms-enum": { + "name": "RefreshableStatusType", + "modelAsString": true, + "values": [ + { + "name": "Refreshing", + "value": "Refreshing", + "description": "Refreshing status" + }, + { + "name": "NotRefreshing", + "value": "NotRefreshing", + "description": "NotRefreshing status" + } + ] + } + }, + "RepeatCadenceType": { + "type": "string", + "description": "Repeat cadence type enum", + "enum": [ + "OneTime", + "Weekly", + "Monthly", + "Yearly" + ], + "x-ms-enum": { + "name": "RepeatCadenceType", + "modelAsString": true, + "values": [ + { + "name": "OneTime", + "value": "OneTime", + "description": "Repeat one time" + }, + { + "name": "Weekly", + "value": "Weekly", + "description": "Repeat weekly" + }, + { + "name": "Monthly", + "value": "Monthly", + "description": "Repeat monthly" + }, + { + "name": "Yearly", + "value": "Yearly", + "description": "Repeat yearly" + } + ] + } + }, + "RestoreAutonomousDatabaseDetails": { + "type": "object", + "description": "Details to restore an Oracle Autonomous Database.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time to restore the database to." + } + }, + "required": [ + "timestamp" + ] + }, + "RetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for backups.", + "minimum": 90, + "maximum": 2558 + }, + "RoleType": { + "type": "string", + "description": "Role type enum.", + "enum": [ + "Primary", + "Standby", + "DisabledStandby", + "BackupCopy", + "SnapshotStandby" + ], + "x-ms-enum": { + "name": "RoleType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary role" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Standby role" + }, + { + "name": "DisabledStandby", + "value": "DisabledStandby", + "description": "DisabledStandby role" + }, + { + "name": "BackupCopy", + "value": "BackupCopy", + "description": "BackupCopy role" + }, + { + "name": "SnapshotStandby", + "value": "SnapshotStandby", + "description": "SnapshotStandby role" + } + ] + } + }, + "SaasSubscriptionDetails": { + "type": "object", + "description": "SaaS Subscription Details model", + "properties": { + "id": { + "type": "string", + "description": "Purchased SaaS subscription ID", + "readOnly": true + }, + "subscriptionName": { + "type": "string", + "description": "SaaS subscription name", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Creation Date and Time", + "readOnly": true + }, + "offerId": { + "type": "string", + "description": "Purchased offer ID", + "readOnly": true + }, + "planId": { + "type": "string", + "description": "Purchased offer's plan ID", + "readOnly": true + }, + "saasSubscriptionStatus": { + "type": "string", + "description": "Indicates the status of the Subscription.", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Publisher ID", + "readOnly": true + }, + "purchaserEmailId": { + "type": "string", + "description": "Purchaser Email ID", + "readOnly": true + }, + "purchaserTenantId": { + "type": "string", + "description": "Purchaser Tenant ID", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Purchase Term Unit", + "readOnly": true + }, + "isAutoRenew": { + "type": "boolean", + "description": "AutoRenew flag", + "readOnly": true + }, + "isFreeTrial": { + "type": "boolean", + "description": "FreeTrial flag", + "readOnly": true + } + } + }, + "ScheduledOperationsType": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeek", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + }, + "required": [ + "dayOfWeek" + ] + }, + "ScheduledOperationsTypeUpdate": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeekUpdate", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + } + }, + "SessionModeType": { + "type": "string", + "description": "Session mode type enum.", + "enum": [ + "Direct", + "Redirect" + ], + "x-ms-enum": { + "name": "SessionModeType", + "modelAsString": true, + "values": [ + { + "name": "Direct", + "value": "Direct", + "description": "Direct session mode" + }, + { + "name": "Redirect", + "value": "Redirect", + "description": "Redirect session mode" + } + ] + } + }, + "SourceType": { + "type": "string", + "description": "Source type enum.", + "enum": [ + "None", + "Database", + "BackupFromId", + "BackupFromTimestamp", + "CloneToRefreshable", + "CrossRegionDataguard", + "CrossRegionDisasterRecovery" + ], + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None source" + }, + { + "name": "Database", + "value": "Database", + "description": "Database source" + }, + { + "name": "BackupFromId", + "value": "BackupFromId", + "description": "Backup from ID source" + }, + { + "name": "BackupFromTimestamp", + "value": "BackupFromTimestamp", + "description": "Backup from timestamp source" + }, + { + "name": "CloneToRefreshable", + "value": "CloneToRefreshable", + "description": "Clone to refreshable source" + }, + { + "name": "CrossRegionDataguard", + "value": "CrossRegionDataguard", + "description": "Cross region dataguard source" + }, + { + "name": "CrossRegionDisasterRecovery", + "value": "CrossRegionDisasterRecovery", + "description": "cross region disaster recovery source" + } + ] + } + }, + "SubnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "SyntaxFormatType": { + "type": "string", + "description": "Syntax format type enum.", + "enum": [ + "Long", + "Ezconnect", + "Ezconnectplus" + ], + "x-ms-enum": { + "name": "SyntaxFormatType", + "modelAsString": true, + "values": [ + { + "name": "Long", + "value": "Long", + "description": "Long format" + }, + { + "name": "Ezconnect", + "value": "Ezconnect", + "description": "Ezconnect format" + }, + { + "name": "Ezconnectplus", + "value": "Ezconnectplus", + "description": "Ezconnectplus format" + } + ] + } + }, + "SystemVersion": { + "type": "object", + "description": "SystemVersion resource Definition", + "properties": { + "properties": { + "$ref": "#/definitions/SystemVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SystemVersionListResult": { + "type": "object", + "description": "The response of a SystemVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SystemVersion items on this page", + "items": { + "$ref": "#/definitions/SystemVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SystemVersionProperties": { + "type": "object", + "description": "System Version Resource model", + "properties": { + "systemVersion": { + "type": "string", + "description": "A valid Oracle System Version", + "readOnly": true + } + }, + "required": [ + "systemVersion" + ] + }, + "SystemVersionsFilter": { + "type": "object", + "description": "SystemVersions filter", + "properties": { + "giVersion": { + "type": "string", + "description": "Grid Infrastructure version" + }, + "shape": { + "type": "string", + "description": "Exadata shape" + }, + "isLatestVersion": { + "type": "boolean", + "description": "Check If we have to list only latest versions" + } + }, + "required": [ + "giVersion", + "shape" + ] + }, + "TlsAuthenticationType": { + "type": "string", + "description": "TLS authentication type enum.", + "enum": [ + "Server", + "Mutual" + ], + "x-ms-enum": { + "name": "TlsAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "Server", + "value": "Server", + "description": "Server authentication" + }, + { + "name": "Mutual", + "value": "Mutual", + "description": "Mutual TLS" + } + ] + } + }, + "UpdateAction": { + "type": "string", + "description": "Update action enum", + "enum": [ + "RollingApply", + "NonRollingApply", + "PreCheck", + "RollBack" + ], + "x-ms-enum": { + "name": "UpdateAction", + "modelAsString": true, + "values": [ + { + "name": "RollingApply", + "value": "RollingApply", + "description": "Rolling apply action" + }, + { + "name": "NonRollingApply", + "value": "NonRollingApply", + "description": "Non rolling apply action" + }, + { + "name": "PreCheck", + "value": "PreCheck", + "description": "Pre-check action" + }, + { + "name": "RollBack", + "value": "RollBack", + "description": "Rollback action" + } + ] + } + }, + "ValidationError": { + "type": "object", + "description": "validation error", + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "required": [ + "code", + "message" + ] + }, + "ValidationResult": { + "type": "object", + "description": "validation result", + "properties": { + "status": { + "$ref": "#/definitions/ValidationStatus", + "description": "validation status" + }, + "error": { + "$ref": "#/definitions/ValidationError", + "description": "validation error" + } + }, + "required": [ + "status", + "error" + ] + }, + "ValidationStatus": { + "type": "string", + "description": "validation status", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Validation failed" + } + ] + }, + "readOnly": true + }, + "VirtualNetworkAddress": { + "type": "object", + "description": "Virtual IP resource belonging to a vm cluster resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkAddressProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualNetworkAddressLifecycleState": { + "type": "string", + "description": "VirtualNetworkAddressLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "VirtualNetworkAddressLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "VirtualNetworkAddressListResult": { + "type": "object", + "description": "The response of a VirtualNetworkAddress list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualNetworkAddress items on this page", + "items": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualNetworkAddressProperties": { + "type": "object", + "description": "virtualNetworkAddress resource properties", + "properties": { + "ipAddress": { + "type": "string", + "description": "Virtual network Address address.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmOcid": { + "$ref": "#/definitions/Ocid", + "description": "Virtual Machine OCID.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Application VIP OCID.", + "readOnly": true + }, + "domain": { + "type": "string", + "description": "Virtual network address fully qualified domain name.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state of the application virtual IP (VIP) address.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/VirtualNetworkAddressLifecycleState", + "description": "virtual network address lifecycle state.", + "readOnly": true + }, + "timeAssigned": { + "type": "string", + "format": "date-time", + "description": "The date and time when the create operation for the application virtual IP (VIP) address completed.", + "readOnly": true + } + } + }, + "VnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + } + }, + "WorkloadType": { + "type": "string", + "description": "WorkloadType enum", + "enum": [ + "OLTP", + "DW", + "AJD", + "APEX" + ], + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true, + "values": [ + { + "name": "OLTP", + "value": "OLTP", + "description": "OLTP - indicates an Autonomous Transaction Processing database" + }, + { + "name": "DW", + "value": "DW", + "description": "DW - indicates an Autonomous Data Warehouse database" + }, + { + "name": "AJD", + "value": "AJD", + "description": "AJD - indicates an Autonomous JSON Database" + }, + { + "name": "APEX", + "value": "APEX", + "description": "APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type." + } + ] + } + }, + "ZoneType": { + "type": "string", + "description": "Zone type enum", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "ZoneType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary zone" + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary zone" + } + ] + } + }, + "aclString": { + "type": "string", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "minLength": 1, + "maxLength": 1024 + } + }, + "parameters": {} +} diff --git a/specification/oracle/resource-manager/readme.md b/specification/oracle/resource-manager/readme.md index 252906317796..56be976c7689 100644 --- a/specification/oracle/resource-manager/readme.md +++ b/specification/oracle/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the Oracle.Database. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-09-01-preview +tag: package-2023-09-01 ``` ``` yaml @@ -44,6 +44,15 @@ input-file: - Oracle.Database/preview/2023-09-01-preview/openapi.json ``` +### Tag: package-2023-09-01 + +These settings apply only when `--tag=package-2023-09-01` is specified on the command line. + +```yaml $(tag) == 'package-2023-09-01' +input-file: + - Oracle.Database/stable/2023-09-01/openapi.json +``` + --- # Code Generation From d1296700aa6cd650970e9891dd58eef5698327fd Mon Sep 17 00:00:00 2001 From: Oscar Muller <61298360+osmuller@users.noreply.github.com> Date: Thu, 20 Jun 2024 11:50:47 -0600 Subject: [PATCH 213/343] [AKV] Add new preview version for NSP feature (#28893) * Start adding NSP changes to preview version * add example * Change to the response to be list instead of get * Add missing example file * Add missing enabledLogCategory * Fix typo * Test object type as array * Test nsp access rule change * Fixes for Lint * Add pageable * Make list not have a next link * Add xms-mutability * Make next link null for list * add NextLink allthough it isnt used * Add new preview api version and revert changes on existing one * Create preview version from latest stable * delete backup version * Fix json * Prettyfy * fix readme * Fix json * update yaml (unsure of fix) * Run prettifier * Add get endpoint * Change api-versions in examples * Fix swagger * Fix example * Add regex for association proxy name * prettifier * Change names of example * Add description to secured by perimeter * Use common file * Address feedback --- .../preview/2024-04-01-preview/common.json | 94 + .../examples/DeletedManagedHsm_Get.json | 28 + .../examples/DeletedManagedHsm_List.json | 47 + .../examples/DeletedManagedHsm_Purge.json | 15 + .../examples/ManagedHsm_CreateOrUpdate.json | 89 + .../examples/ManagedHsm_Delete.json | 17 + .../examples/ManagedHsm_Get.json | 39 + .../ManagedHsm_ListByResourceGroup.json | 68 + .../ManagedHsm_ListBySubscription.json | 67 + ...tPrivateEndpointConnectionsByResource.json | 51 + .../ManagedHsm_ListRegionsByResource.json | 27 + .../examples/ManagedHsm_Update.json | 78 + .../ManagedHsm_checkMhsmNameAvailability.json | 16 + ...edHsm_deletePrivateEndpointConnection.json | 27 + ...nagedHsm_getPrivateEndpointConnection.json | 30 + .../ManagedHsm_listPrivateLinkResources.json | 30 + ...nagedHsm_putPrivateEndpointConnection.json | 37 + .../examples/checkVaultNameAvailability.json | 17 + .../examples/createKey.json | 53 + .../examples/createSecret.json | 50 + .../examples/createVault.json | 273 ++ .../examples/createVaultWithNetworkAcls.json | 132 + .../deletePrivateEndpointConnection.json | 28 + .../examples/deleteVault.json | 16 + .../examples/getDeletedVault.json | 26 + .../2024-04-01-preview/examples/getKey.json | 48 + .../examples/getKeyVersion.json | 49 + ...rityPerimeterAssociationConfiguration.json | 89 + .../getPrivateEndpointConnection.json | 33 + .../examples/getSecret.json | 28 + .../2024-04-01-preview/examples/getVault.json | 93 + .../examples/listDeletedVaults.json | 29 + .../examples/listKeyVersions.json | 58 + .../2024-04-01-preview/examples/listKeys.json | 55 + ...rityPerimeterAssociationConfiguration.json | 92 + .../examples/listOperations.json | 332 +++ .../listPrivateEndpointConnection.json | 51 + .../examples/listPrivateLinkResources.json | 30 + .../examples/listSecrets.json | 46 + .../examples/listVault.json | 24 + .../examples/listVaultByResourceGroup.json | 98 + .../examples/listVaultBySubscription.json | 97 + .../examples/managedHsmCreateKey.json | 52 + .../examples/managedHsmGetKey.json | 47 + .../examples/managedHsmGetKeyVersion.json | 48 + .../examples/managedHsmListKeyVersions.json | 56 + .../examples/managedHsmListKeys.json | 53 + .../examples/purgeDeletedVault.json | 18 + .../putPrivateEndpointConnection.json | 39 + .../examples/updateAccessPoliciesAdd.json | 82 + .../examples/updateSecret.json | 50 + .../examples/updateVault.json | 271 ++ .../preview/2024-04-01-preview/keys.json | 672 +++++ .../2024-04-01-preview/keysManagedHsm.json | 651 +++++ .../preview/2024-04-01-preview/keyvault.json | 2186 +++++++++++++++++ .../2024-04-01-preview/managedHsm.json | 1737 +++++++++++++ .../preview/2024-04-01-preview/providers.json | 288 +++ .../preview/2024-04-01-preview/secrets.json | 491 ++++ .../keyvault/resource-manager/readme.md | 14 + 59 files changed, 9362 insertions(+) create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/common.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_Get.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_List.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_Purge.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_CreateOrUpdate.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Delete.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Get.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListByResourceGroup.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListBySubscription.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListRegionsByResource.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Update.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_checkMhsmNameAvailability.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_deletePrivateEndpointConnection.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_getPrivateEndpointConnection.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_listPrivateLinkResources.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_putPrivateEndpointConnection.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/checkVaultNameAvailability.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createKey.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createSecret.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createVault.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createVaultWithNetworkAcls.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/deletePrivateEndpointConnection.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/deleteVault.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getDeletedVault.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getKey.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getKeyVersion.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getNetworkSecurityPerimeterAssociationConfiguration.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getPrivateEndpointConnection.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getSecret.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getVault.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listDeletedVaults.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listKeyVersions.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listKeys.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listNetworkSecurityPerimeterAssociationConfiguration.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listOperations.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listPrivateEndpointConnection.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listPrivateLinkResources.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listSecrets.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVault.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVaultByResourceGroup.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVaultBySubscription.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmCreateKey.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmGetKey.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmGetKeyVersion.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmListKeyVersions.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmListKeys.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/purgeDeletedVault.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/putPrivateEndpointConnection.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateAccessPoliciesAdd.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateSecret.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateVault.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keys.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keysManagedHsm.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/managedHsm.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/providers.json create mode 100644 specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/secrets.json diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/common.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/common.json new file mode 100644 index 000000000000..7ae6889f4a0c --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/common.json @@ -0,0 +1,94 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "paths": {}, + "definitions": { + "CloudError": { + "description": "An error response from Key Vault resource provider", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "x-ms-external": true, + "type": "object" + }, + "CloudErrorBody": { + "description": "An error response from Key Vault resource provider", + "properties": { + "code": { + "type": "string", + "description": "Error code. This is a mnemonic that can be consumed programmatically." + }, + "message": { + "type": "string", + "description": "User friendly error message. The message is typically localized and may vary with service version." + } + }, + "x-ms-external": true, + "type": "object" + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the key vault resource.", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the key vault resource." + }, + "createdByType": { + "description": "The type of identity that created the key vault resource.", + "$ref": "#/definitions/IdentityType" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the key vault resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the key vault resource." + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the key vault resource.", + "$ref": "#/definitions/IdentityType" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the key vault resource last modification (UTC)." + } + }, + "type": "object" + }, + "IdentityType": { + "type": "string", + "description": "The type of identity.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "identityType", + "modelAsString": true + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_Get.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_Get.json new file mode 100644 index 000000000000..6087c892300d --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "name": "hsm1", + "location": "westus", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1", + "name": "vault-agile-drawer-6404", + "type": "Microsoft.KeyVault/deletedManagedHSMs", + "properties": { + "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "location": "westus", + "deletionDate": "2021-04-01T00:00:59Z", + "scheduledPurgeDate": "2021-04-01T00:00:59Z", + "purgeProtectionEnabled": true, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_List.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_List.json new file mode 100644 index 000000000000..50769e662bca --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1", + "name": "vault-agile-drawer-6404", + "type": "Microsoft.KeyVault/deletedManagedHSMs", + "properties": { + "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "location": "westus", + "deletionDate": "2021-04-01T00:00:59Z", + "scheduledPurgeDate": "2021-04-01T00:00:59Z", + "purgeProtectionEnabled": true, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm2", + "name": "vault-agile-drawer-6404", + "type": "Microsoft.KeyVault/deletedManagedHSMs", + "properties": { + "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2", + "location": "westus", + "deletionDate": "2021-04-01T00:00:59Z", + "scheduledPurgeDate": "2021-04-01T00:00:59Z", + "purgeProtectionEnabled": true, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedManagedHSMs?api-version=2024-04-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_Purge.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_Purge.json new file mode 100644 index 000000000000..d2d2a900a3a9 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/DeletedManagedHsm_Purge.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "name": "hsm1", + "location": "westus", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/managedHsmOperationResults/00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_CreateOrUpdate.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_CreateOrUpdate.json new file mode 100644 index 000000000000..5cddf65801e7 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "name": "hsm1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "parameters": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false + }, + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/managedHsmOperationResults/00000000-0000-0000-0000-000000000000" + }, + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false, + "hsmUri": null, + "provisioningState": "Provisioning", + "statusMessage": "Allocating hardware" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + } + }, + "200": { + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Delete.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Delete.json new file mode 100644 index 000000000000..ef27f0178be2 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "name": "hsm1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/managedHsmOperationResults/00000000-0000-0000-0000-000000000000" + } + }, + "204": {} + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Get.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Get.json new file mode 100644 index 000000000000..bd8e2f06c3be --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "name": "hsm1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + } + }, + "204": {} + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListByResourceGroup.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListByResourceGroup.json new file mode 100644 index 000000000000..b61a32175e5e --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + }, + { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false, + "hsmUri": "https://westus.hsm2.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2", + "name": "hsm2", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs?api-version=2024-04-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListBySubscription.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListBySubscription.json new file mode 100644 index 000000000000..ad076d16e946 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListBySubscription.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + }, + { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false, + "hsmUri": "https://westus.hsm2.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2", + "name": "hsm2", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/managedHSMs?api-version=2024-04-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json new file mode 100644 index 000000000000..7799fb533953 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec1", + "name": "sample-pec1", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec2", + "name": "sample-pec2", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListRegionsByResource.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListRegionsByResource.json new file mode 100644 index 000000000000..fe1234ddb630 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_ListRegionsByResource.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sample-region1", + "provisioningState": "Succeeded", + "isPrimary": true + }, + { + "name": "sample-region2", + "provisioningState": "Succeeded", + "isPrimary": false + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Update.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Update.json new file mode 100644 index 000000000000..40b86d961149 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_Update.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "name": "hsm1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "parameters": { + "tags": { + "Dept": "hsm", + "Environment": "dogfood", + "Slice": "A" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood", + "Slice": "A" + } + } + }, + "202": { + "headers": { + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/managedHsmOperationResults/00000000-0000-0000-0000-000000000000" + }, + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": false, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Updating", + "statusMessage": "ManagedHsm is updating." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood", + "Slice": "A" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_checkMhsmNameAvailability.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_checkMhsmNameAvailability.json new file mode 100644 index 000000000000..2f2b8f6c65c4 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_checkMhsmNameAvailability.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "mhsmName": { + "name": "sample-mhsm" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_deletePrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_deletePrivateEndpointConnection.json new file mode 100644 index 000000000000..63a70c661626 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_deletePrivateEndpointConnection.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "properties": { + "provisioningState": "Disconnected" + } + } + }, + "202": { + "headers": { + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec?operationid=25334578" + } + }, + "204": {} + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_getPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_getPrivateEndpointConnection.json new file mode 100644 index 000000000000..f32bc7d43a83 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_getPrivateEndpointConnection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_listPrivateLinkResources.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_listPrivateLinkResources.json new file mode 100644 index 000000000000..46d062cffec9 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_listPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateLinkResources/managedhsm", + "name": "managedhsm", + "type": "Microsoft.KeyVault/managedhsms/privateLinkResources", + "properties": { + "groupId": "managedhsms", + "requiredMembers": [ + "default" + ], + "requiredZoneNames": [ + "privatelink.managedhsm.azure.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_putPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_putPrivateEndpointConnection.json new file mode 100644 index 000000000000..e2d595fd1ff0 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/ManagedHsm_putPrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2024-04-01-preview", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "My name is Joe and I'm approving this." + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "My name is Joe and I'm approving this.", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/checkVaultNameAvailability.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/checkVaultNameAvailability.json new file mode 100644 index 000000000000..44535217abf3 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/checkVaultNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "vaultName": { + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createKey.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createKey.json new file mode 100644 index 000000000000..6ce30954456c --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createKey.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2024-04-01-preview", + "parameters": { + "properties": { + "kty": "RSA" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name", + "name": "sample-key-name", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createSecret.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createSecret.json new file mode 100644 index 000000000000..436d19dc8fdc --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createSecret.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "secretName": "secret-name", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "parameters": { + "properties": { + "value": "secret-value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514938738, + "updated": 1514938738 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https:/sample-vault.vault.azure.net/secrets/secret-name/baf6de32c4774c7c81345f6476cf90a4" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514938738, + "updated": 1514938738 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https:/sample-vault.vault.azure.net/secrets/secret-name/baf6de32c4774c7c81345f6476cf90a4" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createVault.json new file mode 100644 index 000000000000..902c5e23008e --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createVault.json @@ -0,0 +1,273 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "parameters": { + "location": "westus", + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "sku": { + "family": "A", + "name": "standard" + }, + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "publicNetworkAccess": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Deny", + "ipRules": [ + { + "value": "" + } + ], + "virtualNetworkRules": [ + { + "id": "", + "ignoreMissingVnetServiceEndpoint": false + } + ] + }, + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "privateEndpointConnections": [ + { + "id": "", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createVaultWithNetworkAcls.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createVaultWithNetworkAcls.json new file mode 100644 index 000000000000..e6a1664b52eb --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/createVaultWithNetworkAcls.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "parameters": { + "location": "westus", + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "sku": { + "family": "A", + "name": "standard" + }, + "networkAcls": { + "defaultAction": "Deny", + "bypass": "AzureServices", + "ipRules": [ + { + "value": "124.56.78.91" + }, + { + "value": "'10.91.4.0/24'" + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "networkAcls": { + "defaultAction": "Deny", + "bypass": "AzureServices", + "ipRules": [ + { + "value": "124.56.78.91/32" + }, + { + "value": "'10.91.4.0/24'" + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.network/virtualnetworks/test-vnet/subnets/subnet1" + } + ] + }, + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "networkAcls": { + "defaultAction": "Deny", + "bypass": "AzureServices", + "ipRules": [ + { + "value": "124.56.78.91/32" + }, + { + "value": "'10.91.4.0/24'" + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.network/virtualnetworks/test-vnet/subnets/subnet1" + } + ] + }, + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/deletePrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/deletePrivateEndpointConnection.json new file mode 100644 index 000000000000..9e099a0a6cbc --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/deletePrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "properties": { + "provisioningState": "Disconnected" + } + } + }, + "202": { + "headers": { + "Retry-After": "60", + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec?operationid=25334578" + } + }, + "204": {} + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/deleteVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/deleteVault.json new file mode 100644 index 000000000000..a4b7861657f4 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/deleteVault.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getDeletedVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getDeletedVault.json new file mode 100644 index 000000000000..55ecc73f6d5f --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getDeletedVault.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "vaultName": "sample-vault", + "location": "westus", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/deletedVaults", + "properties": { + "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "location": "westus", + "tags": {}, + "deletionDate": "2017-01-01T00:00:59Z", + "scheduledPurgeDate": "2017-04-01T00:00:59Z", + "purgeProtectionEnabled": true + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getKey.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getKey.json new file mode 100644 index 000000000000..f1b28061fbb2 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getKey.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name", + "name": "sample-key-name", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getKeyVersion.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getKeyVersion.json new file mode 100644 index 000000000000..c7b7edebbc17 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getKeyVersion.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "keyVersion": "fd618d9519b74f9aae94ade66b876acc", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name/versions/fd618d9519b74f9aae94ade66b876acc", + "name": "fd618d9519b74f9aae94ade66b876acc", + "type": "Microsoft.KeyVault/vaults/keys/versions", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getNetworkSecurityPerimeterAssociationConfiguration.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getNetworkSecurityPerimeterAssociationConfiguration.json new file mode 100644 index 000000000000..1c6b7e989863 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getNetworkSecurityPerimeterAssociationConfiguration.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2022-02-01-preview", + "associationProxy": "sample-association-name" + }, + "responses": { + "200": { + "body": { + "name": "0838c45c-28cb-4328-b120-8feb4a7e8699.sample-vault-eaa00d67-42fa-449a-a43f-0635227f6940", + "id": "/subscriptions/7331e83f-5157-4da5-bc69-75eac9c13958/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/networkSecurityPerimeterConfigurations/0838c45c-28cb-4328-b120-8feb4a7e8699.sample-vault-name-eaa00d67-42fa-449a-a43f-0635227f6940", + "type": "Microsoft.KeyVault/vaults/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/7331e83f-5157-4da5-bc69-75eac9c13958/resourcegroups/sample-group/providers/microsoft.network/networksecurityperimeters/sample-perimeter", + "perimeterGuid": "0838c45c-28cb-4328-b120-8feb4a7e8699", + "location": "centraluseuap" + }, + "resourceAssociation": { + "name": "sample-vault-name-eaa00d67-42fa-449a-a43f-0635227f6940", + "accessMode": "Learning" + }, + "profile": { + "name": "sample-profile", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ipRules", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.1.0.0/16" + ], + "fullyQualifiedDomainNames": [], + "subscriptions": [], + "networkSecurityPerimeters": [] + } + }, + { + "name": "subscriptionId", + "properties": { + "direction": "Inbound", + "addressPrefixes": [], + "fullyQualifiedDomainNames": [], + "subscriptions": [ + { + "id": "/subscriptions/7331e83f-5157-4da5-bc69-75eac9c13958" + } + ], + "networkSecurityPerimeters": [] + } + }, + { + "name": "fqdn", + "properties": { + "direction": "Outbound", + "addressPrefixes": [], + "fullyQualifiedDomainNames": [ + "www.contoso.com" + ], + "subscriptions": [], + "networkSecurityPerimeters": [] + } + } + ], + "diagnosticSettingsVersion": 0, + "enabledLogCategories": [ + "category1", + "category2" + ] + } + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getPrivateEndpointConnection.json new file mode 100644 index 000000000000..0b4d79da325d --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getPrivateEndpointConnection.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getSecret.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getSecret.json new file mode 100644 index 000000000000..68cab7e952e8 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getSecret.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "secretName": "secret-name", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514940950, + "updated": 1514940950 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name/77445834f7de41bab81d0723bf996860" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getVault.json new file mode 100644 index 000000000000..9173a26dabcb --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/getVault.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listDeletedVaults.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listDeletedVaults.json new file mode 100644 index 000000000000..ccbff3be8aeb --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listDeletedVaults.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "$top": 1, + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault", + "name": "vault-agile-drawer-6404", + "type": "Microsoft.KeyVault/deletedVaults", + "properties": { + "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "location": "westus", + "tags": {}, + "deletionDate": "2017-01-01T00:00:59Z", + "scheduledPurgeDate": "2017-04-01T00:00:59Z", + "purgeProtectionEnabled": true + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedVaults?api-version=2024-04-01-preview&%24skiptoken=HY3RaoMwAEX%2fRcbeYhJrnRXKYNWOuqpME0sfNcYui0Yxade19N8ne7hcDlzOvVuKX81eKKmt4G4dooLQwgqsL2NGHUDYV6o68Z4rY1e388RtNvRQn2vNJjEaMSgNvcbneMUcsKg8BFwft8DndQ0w9hu2QOiFLRs4TsNFNHzSMBFsGvTQGvuD%2f5bVuTOw4R03vPkH%2fVqNAlzm5SxfOwh7ACOA8POTlvPjILlaU1ke8jImOc23JCppQVfZnna0DXc4ISc3vSVuRo5zJE6%2bj25C3vwk2v2kEV2mMn7PyOc1DbtNGkonnzuLym1G400uI5QRZj0efw%3d%3d" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listKeyVersions.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listKeyVersions.json new file mode 100644 index 000000000000..b52a4e8e730b --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listKeyVersions.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name/versions/c2296aa24acf4daf86942bff5aca73dd", + "name": "c2296aa24acf4daf86942bff5aca73dd", + "type": "Microsoft.KeyVault/vaults/keys/versions", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598641074, + "updated": 1598641074, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/c2296aa24acf4daf86942bff5aca73dd" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name/versions/d5a04667b6f44b0ca62825f5eae93da6", + "name": "d5a04667b6f44b0ca62825f5eae93da6", + "type": "Microsoft.KeyVault/vaults/keys/versions", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598641295, + "updated": 1598641295, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/d5a04667b6f44b0ca62825f5eae93da6" + } + } + ] + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listKeys.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listKeys.json new file mode 100644 index 000000000000..47e8fe9c98b1 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listKeys.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name-1", + "name": "sample-key-name-1", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1596493796, + "updated": 1596493796, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name-1" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name-2", + "name": "sample-key-name-2", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1596493797, + "updated": 1596493797, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name-2" + } + } + ] + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listNetworkSecurityPerimeterAssociationConfiguration.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listNetworkSecurityPerimeterAssociationConfiguration.json new file mode 100644 index 000000000000..4805c1c90a90 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listNetworkSecurityPerimeterAssociationConfiguration.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2022-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "0838c45c-28cb-4328-b120-8feb4a7e8699.sample-vault-eaa00d67-42fa-449a-a43f-0635227f6940", + "id": "/subscriptions/7331e83f-5157-4da5-bc69-75eac9c13958/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/networkSecurityPerimeterConfigurations/0838c45c-28cb-4328-b120-8feb4a7e8699.sample-vault-name-eaa00d67-42fa-449a-a43f-0635227f6940", + "type": "Microsoft.KeyVault/vaults/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/7331e83f-5157-4da5-bc69-75eac9c13958/resourcegroups/sample-group/providers/microsoft.network/networksecurityperimeters/sample-perimeter", + "perimeterGuid": "0838c45c-28cb-4328-b120-8feb4a7e8699", + "location": "centraluseuap" + }, + "resourceAssociation": { + "name": "sample-vault-name-eaa00d67-42fa-449a-a43f-0635227f6940", + "accessMode": "Learning" + }, + "profile": { + "name": "sample-profile", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ipRules", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.1.0.0/16" + ], + "fullyQualifiedDomainNames": [], + "subscriptions": [], + "networkSecurityPerimeters": [] + } + }, + { + "name": "subscriptionId", + "properties": { + "direction": "Inbound", + "addressPrefixes": [], + "fullyQualifiedDomainNames": [], + "subscriptions": [ + { + "id": "/subscriptions/7331e83f-5157-4da5-bc69-75eac9c13958" + } + ], + "networkSecurityPerimeters": [] + } + }, + { + "name": "fqdn", + "properties": { + "direction": "Outbound", + "addressPrefixes": [], + "fullyQualifiedDomainNames": [ + "www.contoso.com" + ], + "subscriptions": [], + "networkSecurityPerimeters": [] + } + } + ], + "diagnosticSettingsVersion": 0, + "enabledLogCategories": [ + "category1", + "category2" + ] + } + } + } + ] + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listOperations.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listOperations.json new file mode 100644 index 000000000000..542b6fb31b1c --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listOperations.json @@ -0,0 +1,332 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.KeyVault/vaults/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault", + "operation": "View Key Vault", + "description": "View the properties of a key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault", + "operation": "Update Key Vault", + "description": "Create a new key vault or update the properties of an existing key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/delete", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault", + "operation": "Delete Key Vault", + "description": "Delete a key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/deploy/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault", + "operation": "Use Vault for Azure Deployments", + "description": "Enables access to secrets in a key vault when deploying Azure resources" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/secrets/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Secret", + "operation": "View Secret Properties", + "description": "View the properties of a secret, but not its value" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/secrets/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Secret", + "operation": "Update Secret", + "description": "Create a new secret or update the value of an existing secret" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/accessPolicies/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Access Policy", + "operation": "Update Access Policy", + "description": "Update an existing access policy by merging or replacing, or add a new access policy to a vault." + }, + "isDataAction": false + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/vaults/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault Log Definition", + "operation": "Read log definition", + "description": "Gets the available logs for a key vault" + }, + "isDataAction": false, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "AuditEvent", + "displayName": "Audit Logs", + "blobDuration": "PT1H" + } + ], + "metricSpecifications": [ + { + "name": "ServiceApiHit", + "displayName": "", + "displayDescription": "", + "unit": "", + "aggregationType": "", + "supportedAggregationTypes": [ + "" + ], + "supportedTimeGrainTypes": [ + "" + ], + "lockAggregationType": "", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "", + "toBeExportedForShoebox": true + }, + { + "name": "ActivityName", + "displayName": "", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "internalMetricName": "AuditEvent" + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/vaults/providers/Microsoft.Insights/diagnosticSettings/Read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault Diagnostic Settings", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "isDataAction": false + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/vaults/providers/Microsoft.Insights/diagnosticSettings/Write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault Diagnostic Settings", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/register/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Subscription", + "operation": "Register Subscription", + "description": "Registers a subscription" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/unregister/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Subscription", + "operation": "Unregister Subscription", + "description": "Unregisters a subscription" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/operations/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Operations", + "operation": "Available Key Vault Operations", + "description": "Lists operations available on Microsoft.KeyVault resource provider" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/checkNameAvailability/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Name Availability", + "operation": "Check Name Availability", + "description": "Checks that a key vault name is valid and is not in use" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/deletedVaults/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Soft Deleted Key Vault", + "operation": "View Soft Deleted Vaults", + "description": "View the properties of soft deleted key vaults" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/locations/deletedVaults/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Soft Deleted Key Vault", + "operation": "View Soft Deleted Key Vault", + "description": "View the properties of a soft deleted key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/locations/deletedVaults/purge/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Soft Deleted Key Vault", + "operation": "Purge Soft Deleted Key Vault", + "description": "Purge a soft deleted key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/locations/operationResults/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Long Run Operation Result", + "operation": "Check Operation Result", + "description": "Check the result of a long run operation" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/hsmPools/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "HSM pool", + "operation": "View HSM pool", + "description": "View the properties of an HSM pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/hsmPools/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "HSM pool", + "operation": "Create or Update HSM pool", + "description": "Create a new HSM pool of update the properties of an existing HSM pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/hsmPools/delete", + "display": { + "provider": "Microsoft Key Vault", + "resource": "HSM pool", + "operation": "Delete HSM pool", + "description": "Delete an HSM pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/hsmPools/joinVault/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "HSM pool", + "operation": "Join KeyVault to HSM pool", + "description": "Join a key vault to an HSM pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/managedHSMs/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Managed HSM", + "operation": "View Managed HSM", + "description": "View the properties of a Managed HSM" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/managedHSMs/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Managed HSM", + "operation": "Create or Update Managed HSM", + "description": "Create a new Managed HSM of update the properties of an existing Managed HSM" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/managedHSMs/delete", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Managed HSM", + "operation": "Delete Managed HSM", + "description": "Delete a Managed HSM" + }, + "isDataAction": false + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/vaults/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault Metric Definition", + "operation": "Read metric definition", + "description": "Gets the available metrics for a key vault" + }, + "isDataAction": false, + "properties": { + "serviceSpecification": {} + } + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/locations/deleteVirtualNetworkOrSubnets/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Location", + "operation": "Modify Network ACLs containing the deleted Vitual Network or Subnet ", + "description": "Notifies Microsoft.KeyVault that a virtual network or subnet is being deleted" + }, + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listPrivateEndpointConnection.json new file mode 100644 index 000000000000..a7bc52c79160 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listPrivateEndpointConnection.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listPrivateLinkResources.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listPrivateLinkResources.json new file mode 100644 index 000000000000..80c6c76f1c32 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateLinkResources/vault", + "name": "vault", + "type": "Microsoft.KeyVault/vaults/privateLinkResources", + "properties": { + "groupId": "vault", + "requiredMembers": [ + "default" + ], + "requiredZoneNames": [ + "privatelink.vaultcore.azure.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listSecrets.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listSecrets.json new file mode 100644 index 000000000000..6d224835bdee --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listSecrets.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514941476, + "updated": 1514941476 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name/40af42fbc10047f8a756a73211492f56" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name2", + "name": "secret-name2", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514941476, + "updated": 1514941476 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name2", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name2/cd7264a6f56c44d1b594423c80609aae" + } + } + ] + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVault.json new file mode 100644 index 000000000000..3397baaa9f83 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVault.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "$filter": "resourceType eq 'Microsoft.KeyVault/vaults'", + "$top": 1, + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {} + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?%24filter=resourceType+eq+%27Microsoft.KeyVault%2fvaults%27&%24top=4&api-version=2015-11-01&%24skiptoken=eyJuZXh0UGFydGl0aW9uS2V5IjoiMSE4IVEwTTJNVGMtIiwibmV4dFJvd0tleSI6IjEhMTMyIU5rUTRSVEU1UXpJelFUWXdORGd4UmpoRlFrSXhNVGhFUXpNd01EZEROVVJmVkVkT1RDMU5TVU5TVDFOUFJsUTZNa1ZMUlZsV1FWVk1WRG95UmxaQlZVeFVVeTFUVTFKSExVcEpUVG95UkZSRlUxUTZNa1JXUVZWTVZDMVhSVk5VVlZNLSJ9" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVaultByResourceGroup.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVaultByResourceGroup.json new file mode 100644 index 000000000000..79e2a53ee3f6 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVaultByResourceGroup.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "$top": 1, + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "premium" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "enableSoftDelete": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net/", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults?api-version=2024-04-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVaultBySubscription.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVaultBySubscription.json new file mode 100644 index 000000000000..b8ad4da188ca --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/listVaultBySubscription.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "$top": 1, + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "premium" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "enableSoftDelete": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net/", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?api-version=22024-04-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmCreateKey.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmCreateKey.json new file mode 100644 index 000000000000..0c8ab7fe2c39 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmCreateKey.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-managedhsm-name", + "keyName": "sample-key-name", + "api-version": "2024-04-01-preview", + "parameters": { + "properties": { + "kty": "RSA" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-managedhsm-name/keys/sample-key-name", + "name": "sample-key-name", + "type": "Microsoft.KeyVault/managedHSMs/keys", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmGetKey.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmGetKey.json new file mode 100644 index 000000000000..364aef747644 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmGetKey.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-managedhsm-name", + "keyName": "sample-key-name", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-managedhsm-name/keys/sample-key-name", + "name": "sample-key-name", + "type": "Microsoft.KeyVault/managedHSMs/keys", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmGetKeyVersion.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmGetKeyVersion.json new file mode 100644 index 000000000000..8f713a0d9830 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmGetKeyVersion.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-managedhsm-name", + "keyName": "sample-key-name", + "keyVersion": "fd618d9519b74f9aae94ade66b876acc", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-managedhsm-name/keys/sample-key-name/versions/fd618d9519b74f9aae94ade66b876acc", + "name": "fd618d9519b74f9aae94ade66b876acc", + "type": "Microsoft.KeyVault/managedHSMs/keys/versions", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmListKeyVersions.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmListKeyVersions.json new file mode 100644 index 000000000000..e0d953c1fee6 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmListKeyVersions.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-managedhsm-name", + "keyName": "sample-key-name", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-managedhsm-name/keys/sample-key-name/versions/c2296aa24acf4daf86942bff5aca73dd", + "name": "c2296aa24acf4daf86942bff5aca73dd", + "type": "Microsoft.KeyVault/managedHSMs/keys/versions", + "properties": { + "attributes": { + "enabled": true, + "created": 1598641074, + "updated": 1598641074, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name/c2296aa24acf4daf86942bff5aca73dd" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-managedhsm-name/keys/sample-key-name/versions/d5a04667b6f44b0ca62825f5eae93da6", + "name": "d5a04667b6f44b0ca62825f5eae93da6", + "type": "Microsoft.KeyVault/managedHSMs/keys/versions", + "properties": { + "attributes": { + "enabled": true, + "created": 1598641295, + "updated": 1598641295, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name/d5a04667b6f44b0ca62825f5eae93da6" + } + } + ] + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmListKeys.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmListKeys.json new file mode 100644 index 000000000000..04ff6206b8de --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/managedHsmListKeys.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-managedhsm-name", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-managedhsm-name/keys/sample-key-name-1", + "name": "sample-key-name-1", + "type": "Microsoft.KeyVault/managedHSMs/keys", + "properties": { + "attributes": { + "enabled": true, + "created": 1596493796, + "updated": 1596493796, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name-1" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-managedhsm-name/keys/sample-key-name-2", + "name": "sample-key-name-2", + "type": "Microsoft.KeyVault/managedHSMs/keys", + "properties": { + "attributes": { + "enabled": true, + "created": 1596493797, + "updated": 1596493797, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-managedhsm-name.managedhsm.azure.net:443/keys/sample-key-name-2" + } + } + ] + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/purgeDeletedVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/purgeDeletedVault.json new file mode 100644 index 000000000000..2b0cd6269481 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/purgeDeletedVault.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "vaultName": "sample-vault", + "location": "westus", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "headers": {} + }, + "202": { + "headers": { + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/kv-group/providers/Microsoft.KeyVault/vaults/vault1?api-version=2024-04-01-preview" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/putPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/putPrivateEndpointConnection.json new file mode 100644 index 000000000000..52a2cda55e14 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/putPrivateEndpointConnection.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2024-04-01-preview", + "properties": { + "etag": "", + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "My name is Joe and I'm approving this." + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "My name is Joe and I'm approving this.", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateAccessPoliciesAdd.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateAccessPoliciesAdd.json new file mode 100644 index 000000000000..1ee1acd2f1ba --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateAccessPoliciesAdd.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "operationKind": "add", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "parameters": { + "properties": { + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt" + ], + "secrets": [ + "get" + ], + "certificates": [ + "get" + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/", + "type": "Microsoft.KeyVault/vaults/accessPolicies", + "properties": { + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt" + ], + "secrets": [ + "get" + ], + "certificates": [ + "get" + ] + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/", + "type": "Microsoft.KeyVault/vaults/accessPolicies", + "properties": { + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt" + ], + "secrets": [ + "get" + ], + "certificates": [ + "get" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateSecret.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateSecret.json new file mode 100644 index 000000000000..c577dfb4e9e4 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateSecret.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "secretName": "secret-name", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "parameters": { + "properties": { + "value": "secret-value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514940684, + "updated": 1514940698 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name/b8c802f549764f2d97885d152f92ee9d" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514940684, + "updated": 1514940698 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name/b8c802f549764f2d97885d152f92ee9d" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateVault.json new file mode 100644 index 000000000000..6a1372a2f951 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/examples/updateVault.json @@ -0,0 +1,271 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01-preview", + "parameters": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "sku": { + "family": "A", + "name": "standard" + }, + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "publicNetworkAccess": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Deny", + "ipRules": [ + { + "value": "" + } + ], + "virtualNetworkRules": [ + { + "id": "", + "ignoreMissingVnetServiceEndpoint": false + } + ] + }, + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "privateEndpointConnections": [ + { + "id": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keys.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keys.json new file mode 100644 index 000000000000..7d3040e33574 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keys.json @@ -0,0 +1,672 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}": { + "put": { + "tags": [ + "Keys" + ], + "operationId": "Keys_CreateIfNotExist", + "description": "Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the key vault which contains the key to be created." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KeyCreateParameters" + }, + "description": "The parameters used to create the specified key." + } + ], + "responses": { + "200": { + "description": "The created key.", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a key": { + "$ref": "./examples/createKey.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_Get", + "description": "Gets the current version of the specified key from the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the key to be retrieved." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved key.", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a key": { + "$ref": "./examples/getKey.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_List", + "description": "Lists the keys in the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the keys to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved page of keys.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List keys in the vault": { + "$ref": "./examples/listKeys.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions/{keyVersion}": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_GetVersion", + "description": "Gets the specified version of the specified key in the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the key version to be retrieved." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key version to be retrieved." + }, + { + "name": "keyVersion", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-fA-F0-9]{32}$", + "description": "The version of the key to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved key version.", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a key version": { + "$ref": "./examples/getKeyVersion.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_ListVersions", + "description": "Lists the versions of the specified key in the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the key versions to be retrieved." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key versions to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved page of key versions.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List key versions in the vault": { + "$ref": "./examples/listKeyVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "KeyProperties": { + "properties": { + "attributes": { + "$ref": "#/definitions/KeyAttributes", + "description": "The attributes of the key." + }, + "kty": { + "type": "string", + "minLength": 1, + "description": "The type of the key. For valid values, see JsonWebKeyType.", + "enum": [ + "EC", + "EC-HSM", + "RSA", + "RSA-HSM" + ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } + }, + "keyOps": { + "type": "array", + "items": { + "type": "string", + "description": "The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation.", + "enum": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey", + "import", + "release" + ], + "x-ms-enum": { + "name": "JsonWebKeyOperation", + "modelAsString": true + } + } + }, + "keySize": { + "type": "integer", + "format": "int32", + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." + }, + "curveName": { + "type": "string", + "description": "The elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ + "P-256", + "P-384", + "P-521", + "P-256K" + ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true + } + }, + "keyUri": { + "type": "string", + "description": "The URI to retrieve the current version of the key.", + "readOnly": true + }, + "keyUriWithVersion": { + "type": "string", + "description": "The URI to retrieve the specific version of the key.", + "readOnly": true + }, + "rotationPolicy": { + "$ref": "#/definitions/RotationPolicy", + "description": "Key rotation policy in response. It will be used for both output and input. Omitted if empty" + }, + "release_policy": { + "$ref": "#/definitions/KeyReleasePolicy", + "description": "Key release policy in response. It will be used for both output and input. Omitted if empty" + } + }, + "description": "The properties of the key.", + "type": "object" + }, + "KeyAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether or not the object is enabled." + }, + "nbf": { + "x-ms-client-name": "NotBefore", + "type": "integer", + "format": "int64", + "description": "Not before date in seconds since 1970-01-01T00:00:00Z." + }, + "exp": { + "x-ms-client-name": "Expires", + "type": "integer", + "format": "int64", + "description": "Expiry date in seconds since 1970-01-01T00:00:00Z." + }, + "created": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + }, + "recoveryLevel": { + "type": "string", + "description": "The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.", + "enum": [ + "Purgeable", + "Recoverable+Purgeable", + "Recoverable", + "Recoverable+ProtectedSubscription" + ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + }, + "exportable": { + "type": "boolean", + "description": "Indicates if the private key can be exported.", + "default": false + } + }, + "description": "The object attributes managed by the Azure Key Vault service.", + "type": "object" + }, + "KeyCreateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the key." + }, + "properties": { + "$ref": "#/definitions/KeyProperties", + "description": "The properties of the key to be created." + } + }, + "description": "The parameters used to create a key.", + "required": [ + "properties" + ], + "x-ms-azure-resource": true, + "type": "object" + }, + "Key": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/KeyProperties", + "description": "The properties of the key." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "./keyvault.json#/definitions/Resource" + } + ], + "description": "The key resource.", + "type": "object" + }, + "KeyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Key" + }, + "description": "The key resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next page of keys." + } + }, + "description": "The page of keys.", + "type": "object" + }, + "RotationPolicy": { + "properties": { + "attributes": { + "$ref": "#/definitions/KeyRotationPolicyAttributes", + "description": "The attributes of key rotation policy." + }, + "lifetimeActions": { + "type": "array", + "items": { + "$ref": "#/definitions/LifetimeAction" + }, + "x-ms-identifiers": [], + "description": "The lifetimeActions for key rotation action." + } + }, + "type": "object" + }, + "KeyRotationPolicyAttributes": { + "properties": { + "created": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + }, + "expiryTime": { + "type": "string", + "description": "The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'." + } + }, + "type": "object" + }, + "LifetimeAction": { + "properties": { + "trigger": { + "$ref": "#/definitions/Trigger", + "description": "The trigger of key rotation policy lifetimeAction." + }, + "action": { + "$ref": "#/definitions/Action", + "description": "The action of key rotation policy lifetimeAction." + } + }, + "type": "object" + }, + "Trigger": { + "properties": { + "timeAfterCreate": { + "type": "string", + "description": "The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'." + }, + "timeBeforeExpiry": { + "type": "string", + "description": "The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'." + } + }, + "type": "object" + }, + "Action": { + "properties": { + "type": { + "type": "string", + "description": "The type of action.", + "enum": [ + "rotate", + "notify" + ], + "x-ms-enum": { + "name": "KeyRotationPolicyActionType", + "modelAsString": false + } + } + }, + "type": "object" + }, + "KeyReleasePolicy": { + "properties": { + "contentType": { + "description": "Content type and version of key release policy", + "type": "string", + "default": "application/json; charset=utf-8" + }, + "data": { + "description": "Blob encoding the policy rules under which the key can be released.", + "type": "string", + "format": "base64url" + } + }, + "type": "object" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keysManagedHsm.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keysManagedHsm.json new file mode 100644 index 000000000000..1c1030efc672 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keysManagedHsm.json @@ -0,0 +1,651 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/keys/{keyName}": { + "put": { + "tags": [ + "ManagedHsmKeys" + ], + "operationId": "ManagedHsmKeys_CreateIfNotExist", + "description": "Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedHSMName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedHSMKeyName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedHsmKeyCreateParameters" + }, + "description": "The parameters used to create the specified key." + } + ], + "responses": { + "200": { + "description": "The created key.", + "schema": { + "$ref": "#/definitions/ManagedHsmKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a key": { + "$ref": "./examples/managedHsmCreateKey.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "ManagedHsmKeys" + ], + "operationId": "ManagedHsmKeys_Get", + "description": "Gets the current version of the specified key from the specified managed HSM.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedHSMName" + }, + { + "$ref": "#/parameters/ManagedHSMKeyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved key.", + "schema": { + "$ref": "#/definitions/ManagedHsmKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a key": { + "$ref": "./examples/managedHsmGetKey.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/keys": { + "get": { + "tags": [ + "ManagedHsmKeys" + ], + "operationId": "ManagedHsmKeys_List", + "description": "Lists the keys in the specified managed HSM.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedHSMName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved page of keys.", + "schema": { + "$ref": "#/definitions/ManagedHsmKeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List keys in the managed HSM": { + "$ref": "./examples/managedHsmListKeys.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/keys/{keyName}/versions/{keyVersion}": { + "get": { + "tags": [ + "ManagedHsmKeys" + ], + "operationId": "ManagedHsmKeys_GetVersion", + "description": "Gets the specified version of the specified key in the specified managed HSM.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedHSMName" + }, + { + "$ref": "#/parameters/ManagedHSMKeyName" + }, + { + "$ref": "#/parameters/ManagedHSMKeyVersion" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved key version.", + "schema": { + "$ref": "#/definitions/ManagedHsmKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a key version": { + "$ref": "./examples/managedHsmGetKeyVersion.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/keys/{keyName}/versions": { + "get": { + "tags": [ + "ManagedHsmKeys" + ], + "operationId": "ManagedHsmKeys_ListVersions", + "description": "Lists the versions of the specified key in the specified managed HSM.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedHSMName" + }, + { + "$ref": "#/parameters/ManagedHSMKeyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved page of key versions.", + "schema": { + "$ref": "#/definitions/ManagedHsmKeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List key versions in the managed HSM": { + "$ref": "./examples/managedHsmListKeyVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "ManagedHsmKeyProperties": { + "properties": { + "attributes": { + "$ref": "#/definitions/ManagedHsmKeyAttributes", + "description": "The attributes of the key." + }, + "kty": { + "type": "string", + "minLength": 1, + "description": "The type of the key. For valid values, see JsonWebKeyType.", + "enum": [ + "EC", + "EC-HSM", + "RSA", + "RSA-HSM" + ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } + }, + "keyOps": { + "type": "array", + "items": { + "type": "string", + "description": "The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation.", + "enum": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey", + "import", + "release" + ], + "x-ms-enum": { + "name": "JsonWebKeyOperation", + "modelAsString": true + } + } + }, + "keySize": { + "type": "integer", + "format": "int32", + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." + }, + "curveName": { + "type": "string", + "description": "The elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ + "P-256", + "P-384", + "P-521", + "P-256K" + ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true + } + }, + "keyUri": { + "type": "string", + "description": "The URI to retrieve the current version of the key.", + "readOnly": true + }, + "keyUriWithVersion": { + "type": "string", + "description": "The URI to retrieve the specific version of the key.", + "readOnly": true + }, + "rotationPolicy": { + "$ref": "#/definitions/ManagedHsmRotationPolicy", + "description": "Key rotation policy in response. It will be used for both output and input. Omitted if empty" + }, + "release_policy": { + "$ref": "#/definitions/ManagedHsmKeyReleasePolicy", + "description": "Key release policy in response. It will be used for both output and input. Omitted if empty" + } + }, + "description": "The properties of the key.", + "type": "object" + }, + "ManagedHsmKeyAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether or not the object is enabled." + }, + "nbf": { + "x-ms-client-name": "NotBefore", + "type": "integer", + "format": "int64", + "description": "Not before date in seconds since 1970-01-01T00:00:00Z." + }, + "exp": { + "x-ms-client-name": "Expires", + "type": "integer", + "format": "int64", + "description": "Expiry date in seconds since 1970-01-01T00:00:00Z." + }, + "created": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + }, + "recoveryLevel": { + "type": "string", + "description": "The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.", + "enum": [ + "Purgeable", + "Recoverable+Purgeable", + "Recoverable", + "Recoverable+ProtectedSubscription" + ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + }, + "exportable": { + "type": "boolean", + "description": "Indicates if the private key can be exported." + } + }, + "description": "The object attributes managed by the Azure Key Vault service.", + "type": "object" + }, + "ManagedHsmKeyCreateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the key." + }, + "properties": { + "$ref": "#/definitions/ManagedHsmKeyProperties", + "description": "The properties of the key to be created." + } + }, + "description": "The parameters used to create a key.", + "required": [ + "properties" + ], + "x-ms-azure-resource": true, + "type": "object" + }, + "ManagedHsmKey": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedHsmKeyProperties", + "description": "The properties of the key." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/ProxyResourceWithoutSystemData" + } + ], + "description": "The key resource.", + "type": "object" + }, + "ManagedHsmKeyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedHsmKey" + }, + "description": "The key resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next page of keys." + } + }, + "description": "The page of keys.", + "type": "object" + }, + "ManagedHsmRotationPolicy": { + "properties": { + "attributes": { + "$ref": "#/definitions/ManagedHsmKeyRotationPolicyAttributes", + "description": "The attributes of key rotation policy." + }, + "lifetimeActions": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedHsmLifetimeAction" + }, + "x-ms-identifiers": [], + "description": "The lifetimeActions for key rotation action." + } + }, + "type": "object" + }, + "ManagedHsmKeyRotationPolicyAttributes": { + "properties": { + "created": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + }, + "expiryTime": { + "type": "string", + "description": "The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'." + } + }, + "type": "object" + }, + "ManagedHsmLifetimeAction": { + "properties": { + "trigger": { + "$ref": "#/definitions/ManagedHsmTrigger", + "description": "The trigger of key rotation policy lifetimeAction." + }, + "action": { + "$ref": "#/definitions/ManagedHsmAction", + "description": "The action of key rotation policy lifetimeAction." + } + }, + "type": "object" + }, + "ManagedHsmTrigger": { + "properties": { + "timeAfterCreate": { + "type": "string", + "description": "The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'." + }, + "timeBeforeExpiry": { + "type": "string", + "description": "The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'." + } + }, + "type": "object" + }, + "ManagedHsmAction": { + "properties": { + "type": { + "type": "string", + "description": "The type of action.", + "enum": [ + "rotate", + "notify" + ], + "x-ms-enum": { + "name": "KeyRotationPolicyActionType", + "modelAsString": false + } + } + }, + "type": "object" + }, + "ManagedHsmKeyReleasePolicy": { + "properties": { + "contentType": { + "description": "Content type and version of key release policy", + "type": "string", + "default": "application/json; charset=utf-8" + }, + "data": { + "description": "Blob encoding the policy rules under which the key can be released.", + "type": "string", + "format": "base64url" + } + }, + "type": "object" + }, + "ProxyResourceWithoutSystemData": { + "title": "Resource", + "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "ManagedHSMName": { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Managed HSM Pool within the specified resource group.", + "pattern": "^[A-Za-z]([A-Za-z0-9]|\\-[A-Za-z0-9])+$", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ManagedHSMKeyName": { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.", + "x-ms-parameter-location": "method" + }, + "ManagedHSMKeyVersion": { + "name": "keyVersion", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-fA-F0-9]{32}$", + "description": "The version of the key to be retrieved.", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json new file mode 100644 index 000000000000..e29b9e4757b8 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json @@ -0,0 +1,2186 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}": { + "put": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Create or update a key vault in the specified subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the server belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VaultCreateOrUpdateParameters" + }, + "description": "Parameters to create or update the vault" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created or updated vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "200": { + "description": "Created or updated vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a new vault or update an existing vault": { + "$ref": "./examples/createVault.json" + }, + "Create or update a vault with network acls": { + "$ref": "./examples/createVaultWithNetworkAcls.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_Update", + "description": "Update a key vault in the specified subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the server belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VaultPatchParameters" + }, + "description": "Parameters to patch the vault" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Patched vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "200": { + "description": "Patched vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update an existing vault": { + "$ref": "./examples/updateVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_Delete", + "description": "Deletes the specified Azure key vault.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault to delete" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK Response." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a vault": { + "$ref": "./examples/deleteVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_Get", + "description": "Gets the specified Azure key vault.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve a vault": { + "$ref": "./examples/getVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/accessPolicies/{operationKind}": { + "put": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_UpdateAccessPolicy", + "description": "Update access policies in a key vault in the specified subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "name": "operationKind", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "add", + "replace", + "remove" + ], + "x-ms-enum": { + "name": "AccessPolicyUpdateKind", + "modelAsString": false + }, + "description": "Name of the operation" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VaultAccessPolicyParameters" + }, + "description": "Access policy to merge into the vault" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The updated access policies", + "schema": { + "$ref": "#/definitions/VaultAccessPolicyParameters" + } + }, + "200": { + "description": "The updated access policies", + "schema": { + "$ref": "#/definitions/VaultAccessPolicyParameters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Add an access policy, or update an access policy with new permissions": { + "$ref": "./examples/updateAccessPoliciesAdd.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_ListByResourceGroup", + "description": "The List operation gets information about the vaults associated with the subscription and within the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all key vaults in the specified resource group.", + "schema": { + "$ref": "#/definitions/VaultListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List vaults in the specified resource group": { + "$ref": "./examples/listVaultByResourceGroup.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_ListBySubscription", + "description": "The List operation gets information about the vaults associated with the subscription.", + "parameters": [ + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all key vaults in the specified subscription.", + "schema": { + "$ref": "#/definitions/VaultListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List vaults in the specified subscription": { + "$ref": "./examples/listVaultBySubscription.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/deletedVaults": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_ListDeleted", + "description": "Gets information about the deleted vaults in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about all deleted key vaults in a subscription.", + "schema": { + "$ref": "#/definitions/DeletedVaultListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List deleted vaults in the specified subscription": { + "$ref": "./examples/listDeletedVaults.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedVaults/{vaultName}": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_GetDeleted", + "description": "Gets the deleted Azure key vault.", + "parameters": [ + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the deleted vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about the deleted vault.", + "schema": { + "$ref": "#/definitions/DeletedVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve a deleted vault": { + "$ref": "./examples/getDeletedVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedVaults/{vaultName}/purge": { + "post": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_PurgeDeleted", + "x-ms-long-running-operation": true, + "description": "Permanently deletes the specified vault. aka Purges the deleted Azure key vault.", + "parameters": [ + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the soft-deleted vault." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the soft-deleted vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The vault is purged." + }, + "202": { + "description": "Vault is being purged." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Purge a deleted vault": { + "$ref": "./examples/purgeDeletedVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resources": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_List", + "description": "The List operation gets information about the vaults associated with the subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "resourceType eq 'Microsoft.KeyVault/vaults'" + ], + "x-ms-enum": { + "name": "VaultListFilterTypes", + "modelAsString": false + }, + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "x-ms-api-version": false, + "type": "string", + "enum": [ + "2015-11-01" + ], + "x-ms-enum": { + "name": "ResourceManagerApiVersions", + "modelAsString": false + }, + "description": "Azure Resource Manager Api Version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all key vaults in the subscription.", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List vaults in the specified subscription": { + "$ref": "./examples/listVault.json" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability": { + "post": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_CheckNameAvailability", + "description": "Checks that the vault name is valid and is not already in use.", + "parameters": [ + { + "name": "vaultName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VaultCheckNameAvailabilityParameters" + }, + "description": "The name of the vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the vault name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Validate a vault name": { + "$ref": "./examples/checkVaultNameAvailability.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the key vault.", + "x-ms-examples": { + "KeyVaultGetPrivateEndpointConnection": { + "$ref": "./examples/getPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Private endpoint connection successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "204": { + "description": "The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Updates the specified private endpoint connection associated with the key vault.", + "x-ms-examples": { + "KeyVaultPutPrivateEndpointConnection": { + "$ref": "./examples/putPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The intended state of private endpoint connection." + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The state of private endpoint connection was updated successfully.", + "headers": { + "Retry-After": { + "description": "(specified only if operation does not finish synchronously) The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "(specified only if operation does not finish synchronously) The URI to poll for completion status. The response of this URI may be synchronous or asynchronous.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the key vault.", + "x-ms-examples": { + "KeyVaultDeletePrivateEndpointConnection": { + "$ref": "./examples/deletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The private endpoint connection was successfully deleted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "The private endpoint connection is being deleted.", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in the location header.", + "type": "integer", + "format": "int32" + }, + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_ListByResource", + "description": "The List operation gets information about the private endpoint connections associated with the vault.", + "x-ms-examples": { + "KeyVaultListPrivateEndpointConnection": { + "$ref": "./examples/listPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Get information about all private endpoint connections in the specified resource group.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByVault", + "description": "Gets the private link resources supported for the key vault.", + "x-ms-examples": { + "KeyVaultListPrivateLinkResources": { + "$ref": "./examples/listPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/networkSecurityPerimeterConfigurations": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfiguration" + ], + "operationId": "NetworkSecurityPerimeter_ListConfiguration", + "description": "The List operation gets information about the network security perimeter associations for the key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Get information about the network security perimeter associations of the key vault.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "KeyVaultListNetworkSecurityPerimeterAssociationConfigurations": { + "$ref": "./examples/listNetworkSecurityPerimeterAssociationConfiguration.json" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/networkSecurityPerimeterConfigurations/{associationProxyName}": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfiguration" + ], + "operationId": "NetworkSecurityPerimeter_GetConfiguration", + "description": "The Get operation gets information about the network security perimeter associations for the key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AssociationProxyNameParameter" + } + ], + "responses": { + "200": { + "description": "Get information about the network security perimeter associations of the key vault.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "KeyVaultGetNetworkSecurityPerimeterAssociationConfiguration": { + "$ref": "./examples/getNetworkSecurityPerimeterAssociationConfiguration.json" + } + }, + "produces": [ + "application/json" + ] + } + } + }, + "definitions": { + "Sku": { + "properties": { + "family": { + "type": "string", + "description": "SKU family name", + "enum": [ + "A" + ], + "x-ms-client-default": "A", + "x-ms-enum": { + "name": "SkuFamily", + "modelAsString": true + } + }, + "name": { + "type": "string", + "description": "SKU name to specify whether the key vault is a standard vault or a premium vault.", + "enum": [ + "standard", + "premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + } + }, + "description": "SKU details", + "required": [ + "name", + "family" + ], + "type": "object" + }, + "AccessPolicyEntry": { + "properties": { + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault." + }, + "objectId": { + "type": "string", + "description": "The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies." + }, + "applicationId": { + "type": "string", + "format": "uuid", + "description": " Application ID of the client making request on behalf of a principal" + }, + "permissions": { + "$ref": "#/definitions/Permissions", + "description": "Permissions the identity has for keys, secrets and certificates." + } + }, + "description": "An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.", + "required": [ + "tenantId", + "objectId", + "permissions" + ], + "type": "object" + }, + "Permissions": { + "properties": { + "keys": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "all", + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge", + "release", + "rotate", + "getrotationpolicy", + "setrotationpolicy" + ], + "x-ms-enum": { + "name": "KeyPermissions", + "modelAsString": true + } + }, + "description": "Permissions to keys" + }, + "secrets": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "all", + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "x-ms-enum": { + "name": "SecretPermissions", + "modelAsString": true + } + }, + "description": "Permissions to secrets" + }, + "certificates": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "all", + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge", + "backup", + "restore" + ], + "x-ms-enum": { + "name": "CertificatePermissions", + "modelAsString": true + } + }, + "description": "Permissions to certificates" + }, + "storage": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "all", + "get", + "list", + "delete", + "set", + "update", + "regeneratekey", + "recover", + "purge", + "backup", + "restore", + "setsas", + "listsas", + "getsas", + "deletesas" + ], + "x-ms-enum": { + "name": "StoragePermissions", + "modelAsString": true + } + }, + "description": "Permissions to storage accounts" + } + }, + "description": "Permissions the identity has for keys, secrets, certificates and storage.", + "type": "object" + }, + "VaultProperties": { + "properties": { + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "SKU details" + }, + "accessPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessPolicyEntry" + }, + "x-ms-identifiers": [ + "tenantId", + "objectId", + "permissions" + ], + "description": "An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. When `createMode` is set to `recover`, access policies are not required. Otherwise, access policies are required." + }, + "vaultUri": { + "type": "string", + "description": "The URI of the vault for performing operations on keys and secrets." + }, + "hsmPoolResourceId": { + "type": "string", + "description": "The resource id of HSM Pool.", + "readOnly": true + }, + "enabledForDeployment": { + "type": "boolean", + "description": "Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault." + }, + "enabledForDiskEncryption": { + "type": "boolean", + "description": "Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys." + }, + "enabledForTemplateDeployment": { + "type": "boolean", + "description": "Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault." + }, + "enableSoftDelete": { + "type": "boolean", + "default": true, + "description": "Property to specify whether the 'soft delete' functionality is enabled for this key vault. If it's not set to any value(true or false) when creating new key vault, it will be set to true by default. Once set to true, it cannot be reverted to false." + }, + "softDeleteRetentionInDays": { + "type": "integer", + "format": "int32", + "default": 90, + "description": "softDelete data retention days. It accepts >=7 and <=90." + }, + "enableRbacAuthorization": { + "type": "boolean", + "default": false, + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." + }, + "createMode": { + "type": "string", + "description": "The vault's create mode to indicate whether the vault need to be recovered or not.", + "enum": [ + "recover", + "default" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "enablePurgeProtection": { + "type": "boolean", + "description": "Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "Rules governing the accessibility of the key vault from specific network locations." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the vault.", + "enum": [ + "Succeeded", + "RegisteringDns" + ], + "x-ms-enum": { + "name": "VaultProvisioningState", + "modelAsString": true + } + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionItem" + }, + "description": "List of private endpoint connections associated with the key vault." + }, + "publicNetworkAccess": { + "type": "string", + "default": "enabled", + "description": "Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules." + } + }, + "required": [ + "tenantId", + "sku" + ], + "description": "Properties of the vault", + "type": "object" + }, + "VaultPatchProperties": { + "properties": { + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "SKU details" + }, + "accessPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessPolicyEntry" + }, + "x-ms-identifiers": [ + "tenantId", + "objectId", + "permissions" + ], + "description": "An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID." + }, + "enabledForDeployment": { + "type": "boolean", + "description": "Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault." + }, + "enabledForDiskEncryption": { + "type": "boolean", + "description": "Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys." + }, + "enabledForTemplateDeployment": { + "type": "boolean", + "description": "Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault." + }, + "enableSoftDelete": { + "type": "boolean", + "description": "Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot be reverted to false." + }, + "enableRbacAuthorization": { + "type": "boolean", + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change." + }, + "softDeleteRetentionInDays": { + "type": "integer", + "format": "int32", + "description": "softDelete data retention days. It accepts >=7 and <=90." + }, + "createMode": { + "type": "string", + "description": "The vault's create mode to indicate whether the vault need to be recovered or not.", + "enum": [ + "recover", + "default" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": false + } + }, + "enablePurgeProtection": { + "type": "boolean", + "description": "Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility of the vault from specific network locations." + }, + "publicNetworkAccess": { + "type": "string", + "description": "Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. If set to 'SecuredByPerimeter' then only network security perimeter rules will apply; trusted services will not be allowed through." + } + }, + "description": "Properties of the vault", + "type": "object" + }, + "VaultAccessPolicyProperties": { + "properties": { + "accessPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessPolicyEntry" + }, + "x-ms-identifiers": [ + "tenantId", + "objectId", + "permissions" + ], + "description": "An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID." + } + }, + "required": [ + "accessPolicies" + ], + "description": "Properties of the vault access policy", + "type": "object" + }, + "DeletedVaultProperties": { + "properties": { + "vaultId": { + "readOnly": true, + "type": "string", + "description": "The resource id of the original vault." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the original vault." + }, + "deletionDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The deleted date." + }, + "scheduledPurgeDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The scheduled purged date." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags of the original vault." + }, + "purgeProtectionEnabled": { + "readOnly": true, + "type": "boolean", + "description": "Purge protection status of the original vault." + } + }, + "description": "Properties of the deleted vault.", + "type": "object" + }, + "VaultCreateOrUpdateParameters": { + "properties": { + "location": { + "type": "string", + "description": "The supported Azure location where the key vault should be created." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the key vault." + }, + "properties": { + "$ref": "#/definitions/VaultProperties", + "description": "Properties of the vault" + } + }, + "description": "Parameters for creating or updating a vault", + "required": [ + "location", + "properties" + ], + "x-ms-azure-resource": true, + "type": "object" + }, + "VaultPatchParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the key vault. " + }, + "properties": { + "$ref": "#/definitions/VaultPatchProperties", + "description": "Properties of the vault" + } + }, + "description": "Parameters for creating or updating a vault", + "x-ms-azure-resource": true, + "type": "object" + }, + "VaultAccessPolicyParameters": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id of the access policy." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name of the access policy." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource name of the access policy." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The resource type of the access policy." + }, + "properties": { + "$ref": "#/definitions/VaultAccessPolicyProperties", + "description": "Properties of the access policy" + } + }, + "description": "Parameters for updating the access policy in a vault", + "required": [ + "properties" + ], + "x-ms-azure-resource": true, + "type": "object" + }, + "Vault": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier of the key vault resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the key vault resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type of the key vault resource." + }, + "location": { + "type": "string", + "description": "Azure location of the key vault resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags assigned to the key vault resource." + }, + "systemData": { + "description": "System metadata for the key vault.", + "$ref": "common.json#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/VaultProperties", + "description": "Properties of the vault" + } + }, + "required": [ + "properties" + ], + "description": "Resource information with extended details.", + "x-ms-azure-resource": true, + "type": "object" + }, + "DeletedVault": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource ID for the deleted key vault." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the key vault." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type of the key vault." + }, + "properties": { + "$ref": "#/definitions/DeletedVaultProperties", + "description": "Properties of the vault" + } + }, + "description": "Deleted vault information with extended details.", + "type": "object" + }, + "VaultListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Vault" + }, + "description": "The list of vaults." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of vaults." + } + }, + "description": "List of vaults", + "type": "object" + }, + "DeletedVaultListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedVault" + }, + "description": "The list of deleted vaults." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of deleted vaults." + } + }, + "description": "List of vaults", + "type": "object" + }, + "ResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Resource" + }, + "description": "The list of vault resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of vault resources." + } + }, + "description": "List of vault resources.", + "type": "object" + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier of the key vault resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the key vault resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type of the key vault resource." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Azure location of the key vault resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags assigned to the key vault resource." + } + }, + "description": "Key Vault resource", + "x-ms-azure-resource": true, + "type": "object" + }, + "VaultCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The vault name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.KeyVault/vaults" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.KeyVault/vaults" + } + }, + "required": [ + "name", + "type" + ], + "description": "The parameters used to check the availability of the vault name.", + "type": "object" + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "An error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response.", + "type": "object" + }, + "NetworkRuleSet": { + "properties": { + "bypass": { + "type": "string", + "description": "Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.", + "enum": [ + "AzureServices", + "None" + ], + "x-ms-enum": { + "name": "NetworkRuleBypassOptions", + "modelAsString": true + } + }, + "defaultAction": { + "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 + } + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + }, + "description": "The list of IP address rules." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "x-ms-identifiers": [ + "id" + ], + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility of a vault.", + "type": "object" + }, + "IPRule": { + "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" + ], + "description": "A rule governing the accessibility of a vault from a specific ip address or ip range.", + "type": "object" + }, + "VirtualNetworkRule": { + "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'." + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured." + } + }, + "required": [ + "id" + ], + "description": "A rule governing the accessibility of a vault from a specific virtual network.", + "type": "object" + }, + "PrivateEndpointConnectionItem": { + "properties": { + "id": { + "type": "string", + "description": "Id of private endpoint connection." + }, + "etag": { + "type": "string", + "description": "Modified whenever there is a change in the state of private endpoint connection." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Private endpoint connection properties." + } + }, + "description": "Private endpoint connection item.", + "type": "object" + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, + "etag": { + "type": "string", + "description": "Modified whenever there is a change in the state of private endpoint connection." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Private endpoint connection resource.", + "x-ms-azure-resource": true, + "type": "object" + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of private endpoint connections." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of private endpoint connections." + } + }, + "description": "List of private endpoint connections.", + "type": "object" + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Properties of the private endpoint object." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "Approval state of the private link connection." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "Provisioning state of the private endpoint connection." + } + }, + "description": "Properties of the private endpoint connection resource.", + "type": "object" + }, + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Full identifier of the private endpoint resource." + } + }, + "description": "Private endpoint object properties.", + "type": "object" + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been approved, rejected or removed by the key vault owner." + }, + "description": { + "type": "string", + "description": "The reason for approval or rejection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "enum": [ + "None" + ], + "x-ms-enum": { + "name": "ActionsRequired", + "modelAsString": true + } + } + }, + "description": "An object that represents the approval state of the private link connection.", + "type": "object" + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Failed", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources", + "type": "object" + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "A private link resource", + "type": "object" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "Group identifier of private link resource.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "Required member names of private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required DNS zone names of the the private link resource." + } + }, + "description": "Properties of a private link resource.", + "type": "object" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the resource group that contains the key vault.", + "x-ms-parameter-location": "method" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the key vault.", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the private endpoint connection associated with the key vault.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "AssociationProxyNameParameter": { + "name": "associationProxyName", + "in": "path", + "required": true, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\.[a-z][a-z0-9]*$", + "type": "string", + "description": "Association proxy name associated with the key vault.", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/managedHsm.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/managedHsm.json new file mode 100644 index 000000000000..e32ce5345c26 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/managedHsm.json @@ -0,0 +1,1737 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.", + "version": "2024-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}": { + "put": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Create or update a managed HSM Pool in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedHsm" + }, + "description": "Parameters to create or update the managed HSM Pool" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "200": { + "description": "Created or updated managed HSM Pool", + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Create a new managed HSM Pool or update an existing managed HSM Pool": { + "$ref": "./examples/ManagedHsm_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_Update", + "x-ms-long-running-operation": true, + "description": "Update a managed HSM Pool in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedHsm" + }, + "description": "Parameters to patch the managed HSM Pool" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "200": { + "description": "Patched managed HSM Pool", + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Update an existing managed HSM Pool": { + "$ref": "./examples/ManagedHsm_Update.json" + } + } + }, + "delete": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes the specified managed HSM Pool.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed HSM Pool to delete" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Delete a managed HSM Pool": { + "$ref": "./examples/ManagedHsm_Delete.json" + } + } + }, + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_Get", + "description": "Gets the specified managed HSM Pool.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed HSM Pool." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved managed HSM Pool", + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Retrieve a managed HSM Pool": { + "$ref": "./examples/ManagedHsm_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs": { + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_ListByResourceGroup", + "description": "The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all managed HSM Pools in the specified resource group.", + "schema": { + "$ref": "#/definitions/ManagedHsmListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed HSM Pools in a resource group": { + "$ref": "./examples/ManagedHsm_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/managedHSMs": { + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_ListBySubscription", + "description": "The List operation gets information about the managed HSM Pools associated with the subscription.", + "parameters": [ + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all managed HSM Pools in the specified subscription.", + "schema": { + "$ref": "#/definitions/ManagedHsmListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "List managed HSM Pools in a subscription": { + "$ref": "./examples/ManagedHsm_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections": { + "get": { + "tags": [ + "MHSMListPrivateEndpointConnections" + ], + "operationId": "MHSMPrivateEndpointConnections_ListByResource", + "description": "The List operation gets information about the private endpoint connections associated with the managed HSM Pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + } + ], + "responses": { + "200": { + "description": "Get information about all managed HSM Pools in the specified subscription.", + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionsListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "List managed HSM Pools in a subscription": { + "$ref": "./examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/deletedManagedHSMs": { + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_ListDeleted", + "description": "The List operation gets information about the deleted managed HSMs associated with the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about all managed HSMs in the specified subscription.", + "schema": { + "$ref": "#/definitions/DeletedManagedHsmListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List deleted managed HSMs in the specified subscription": { + "$ref": "./examples/DeletedManagedHsm_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedManagedHSMs/{name}": { + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_GetDeleted", + "description": "Gets the specified deleted managed HSM.", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deleted managed HSM." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the deleted managed HSM." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about the specified deleted managed HSM.", + "schema": { + "$ref": "#/definitions/DeletedManagedHsm" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Retrieve a deleted managed HSM": { + "$ref": "./examples/DeletedManagedHsm_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedManagedHSMs/{name}/purge": { + "post": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_PurgeDeleted", + "x-ms-long-running-operation": true, + "description": "Permanently deletes the specified managed HSM.", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the soft-deleted managed HSM." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the soft-deleted managed HSM." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Purge a managed HSM Pool": { + "$ref": "./examples/DeletedManagedHsm_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "MHSMPrivateEndpointConnections" + ], + "operationId": "MHSMPrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the managed HSM Pool.", + "x-ms-examples": { + "ManagedHsmGetPrivateEndpointConnection": { + "$ref": "./examples/ManagedHsm_getPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/MHSMPrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Private endpoint connection successfully returned.", + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + } + }, + "put": { + "tags": [ + "MHSMPrivateEndpointConnections" + ], + "operationId": "MHSMPrivateEndpointConnections_Put", + "description": "Updates the specified private endpoint connection associated with the managed hsm pool.", + "x-ms-examples": { + "ManagedHsmPutPrivateEndpointConnection": { + "$ref": "./examples/ManagedHsm_putPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/MHSMPrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + }, + "description": "The intended state of private endpoint connection." + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The state of private endpoint connection was updated successfully.", + "headers": { + "Retry-After": { + "description": "(specified only if operation does not finish synchronously) The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "(specified only if operation does not finish synchronously) The URI to poll for completion status. The response of this URI may be synchronous or asynchronous.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "MHSMPrivateEndpointConnections" + ], + "operationId": "MHSMPrivateEndpointConnections_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes the specified private endpoint connection associated with the managed hsm pool.", + "x-ms-examples": { + "ManagedHsmDeletePrivateEndpointConnection": { + "$ref": "./examples/ManagedHsm_deletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/MHSMPrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The private endpoint connection was successfully deleted.", + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + } + }, + "202": { + "description": "The private endpoint connection is being deleted.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateLinkResources": { + "get": { + "tags": [ + "MHSMPrivateLinkResources" + ], + "operationId": "MHSMPrivateLinkResources_ListByMHSMResource", + "description": "Gets the private link resources supported for the managed hsm pool.", + "x-ms-examples": { + "KeyVaultListPrivateLinkResources": { + "$ref": "./examples/ManagedHsm_listPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/MHSMPrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/regions": { + "get": { + "tags": [ + "MHSMListRegions" + ], + "operationId": "MHSMRegions_ListByResource", + "description": "The List operation gets information about the regions associated with the managed HSM Pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + } + ], + "responses": { + "200": { + "description": "Get information about all managed HSM Pools in the specified subscription.", + "schema": { + "$ref": "#/definitions/MHSMRegionsListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "List managed HSM Pools in a subscription": { + "$ref": "./examples/ManagedHsm_ListRegionsByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkMhsmNameAvailability": { + "post": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_CheckMhsmNameAvailability", + "description": "Checks that the managed hsm name is valid and is not already in use.", + "parameters": [ + { + "name": "mhsmName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckMhsmNameAvailabilityParameters" + }, + "description": "The name of the managed hsm." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the mhsm name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckMhsmNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Validate a managed hsm name": { + "$ref": "./examples/ManagedHsm_checkMhsmNameAvailability.json" + } + }, + "produces": [ + "application/json" + ] + } + } + }, + "definitions": { + "ManagedHsmSku": { + "properties": { + "family": { + "type": "string", + "description": "SKU Family of the managed HSM Pool", + "enum": [ + "B" + ], + "x-ms-client-default": "B", + "x-ms-enum": { + "name": "ManagedHsmSkuFamily", + "modelAsString": true + } + }, + "name": { + "type": "string", + "description": "SKU of the managed HSM Pool", + "enum": [ + "Standard_B1", + "Custom_B32", + "Custom_B6" + ], + "x-ms-enum": { + "name": "ManagedHsmSkuName", + "modelAsString": false + } + } + }, + "description": "SKU details", + "required": [ + "name", + "family" + ], + "type": "object" + }, + "ManagedHsmProperties": { + "properties": { + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool." + }, + "initialAdminObjectIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of initial administrators object ids for this managed hsm pool." + }, + "hsmUri": { + "type": "string", + "readOnly": true, + "description": "The URI of the managed hsm pool for performing operations on keys." + }, + "enableSoftDelete": { + "type": "boolean", + "default": true, + "description": "Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. Soft delete is enabled by default for all managed HSMs and is immutable." + }, + "softDeleteRetentionInDays": { + "type": "integer", + "format": "int32", + "default": 90, + "description": "Soft deleted data retention days. When you delete an HSM or a key, it will remain recoverable for the configured retention period or for a default period of 90 days. It accepts values between 7 and 90." + }, + "enablePurgeProtection": { + "type": "boolean", + "default": true, + "description": "Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true activates protection against purge for this managed HSM pool and its content - only the Managed HSM service may initiate a hard, irrecoverable deletion. Enabling this functionality is irreversible." + }, + "createMode": { + "type": "string", + "description": "The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.", + "enum": [ + "recover", + "default" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": false, + "values": [ + { + "value": "recover", + "description": "Recover the managed HSM pool from a soft-deleted resource." + }, + { + "value": "default", + "description": "Create a new managed HSM pool. This is the default option." + } + ] + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "statusMessage": { + "readOnly": true, + "type": "string", + "description": "Resource Status Message." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state.", + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Updating", + "Deleting", + "Activated", + "SecurityDomainRestore", + "Restoring" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The managed HSM Pool has been full provisioned." + }, + { + "value": "Provisioning", + "description": "The managed HSM Pool is currently being provisioned." + }, + { + "value": "Failed", + "description": "Provisioning of the managed HSM Pool has failed." + }, + { + "value": "Updating", + "description": "The managed HSM Pool is currently being updated." + }, + { + "value": "Deleting", + "description": "The managed HSM Pool is currently being deleted." + }, + { + "value": "Activated", + "description": "The managed HSM pool is ready for normal use." + }, + { + "value": "SecurityDomainRestore", + "description": "The managed HSM pool is waiting for a security domain restore action." + }, + { + "value": "Restoring", + "description": "The managed HSM pool is being restored from full HSM backup." + } + ] + } + }, + "networkAcls": { + "$ref": "#/definitions/MHSMNetworkRuleSet", + "description": "Rules governing the accessibility of the key vault from specific network locations." + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/MHSMGeoReplicatedRegion" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of all regions associated with the managed hsm pool." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionItem" + }, + "description": "List of private endpoint connections associated with the managed hsm pool." + }, + "publicNetworkAccess": { + "description": "Control permission to the managed HSM from public networks.", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "scheduledPurgeDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The scheduled purge date in UTC." + }, + "securityDomainProperties": { + "readOnly": true, + "$ref": "#/definitions/ManagedHSMSecurityDomainProperties", + "description": "Managed HSM security domain properties." + } + }, + "description": "Properties of the managed HSM Pool", + "type": "object" + }, + "ManagedHsm": { + "properties": { + "properties": { + "$ref": "#/definitions/ManagedHsmProperties", + "description": "Properties of the managed HSM" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ManagedHsmResource" + } + ], + "description": "Resource information with extended details.", + "type": "object" + }, + "ManagedHsmResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The Azure Resource Manager resource ID for the managed HSM Pool." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the managed HSM Pool." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type of the managed HSM Pool." + }, + "location": { + "type": "string", + "description": "The supported Azure location where the managed HSM Pool should be created.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "sku": { + "$ref": "#/definitions/ManagedHsmSku", + "description": "SKU details" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "systemData": { + "$ref": "common.json#/definitions/SystemData" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + }, + "description": "Managed HSM resource", + "x-ms-azure-resource": true, + "type": "object" + }, + "ManagedHsmListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedHsm" + }, + "description": "The list of managed HSM Pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed HSM Pools." + } + }, + "description": "List of managed HSM Pools", + "type": "object" + }, + "MHSMPrivateEndpointConnectionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + }, + "description": "The private endpoint connection associated with a managed HSM Pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed HSM Pools." + } + }, + "description": "List of private endpoint connections associated with a managed HSM Pools", + "type": "object" + }, + "MHSMRegionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MHSMGeoReplicatedRegion" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The region associated with a managed HSM Pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed HSM Pools." + } + }, + "description": "List of regions associated with a managed HSM Pools" + }, + "ManagedHsmError": { + "properties": { + "error": { + "readOnly": true, + "description": "The server error.", + "$ref": "#/definitions/Error" + } + }, + "description": "The error exception.", + "type": "object" + }, + "Error": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The error message." + }, + "innererror": { + "x-ms-client-name": "innerError", + "readOnly": true, + "description": "The inner error, contains a more specific error code.", + "$ref": "#/definitions/Error" + } + }, + "description": "The server error.", + "type": "object" + }, + "DeletedManagedHsm": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The Azure Resource Manager resource ID for the deleted managed HSM Pool." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the managed HSM Pool." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type of the managed HSM Pool." + }, + "properties": { + "$ref": "#/definitions/DeletedManagedHsmProperties", + "description": "Properties of the deleted managed HSM" + } + }, + "type": "object" + }, + "DeletedManagedHsmProperties": { + "properties": { + "mhsmId": { + "readOnly": true, + "type": "string", + "description": "The resource id of the original managed HSM." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the original managed HSM." + }, + "deletionDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The deleted date." + }, + "scheduledPurgeDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The scheduled purged date." + }, + "purgeProtectionEnabled": { + "readOnly": true, + "type": "boolean", + "description": "Purge protection status of the original managed HSM." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags of the original managed HSM." + } + }, + "description": "Properties of the deleted managed HSM.", + "type": "object" + }, + "DeletedManagedHsmListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedManagedHsm" + }, + "description": "The list of deleted managed HSM Pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of deleted managed HSM Pools." + } + }, + "description": "List of deleted managed HSM Pools", + "type": "object" + }, + "MHSMGeoReplicatedRegion": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the geo replicated region." + }, + "provisioningState": { + "$ref": "#/definitions/MHSMGeoReplicationRegionProvisioningState", + "description": "Provisioning state of the geo replicated region." + }, + "isPrimary": { + "type": "boolean", + "description": "A boolean value that indicates whether the region is the primary region or a secondary region." + } + }, + "description": "A region that this managed HSM Pool has been extended to." + }, + "MHSMNetworkRuleSet": { + "properties": { + "bypass": { + "type": "string", + "description": "Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.", + "enum": [ + "AzureServices", + "None" + ], + "x-ms-enum": { + "name": "NetworkRuleBypassOptions", + "modelAsString": true + } + }, + "defaultAction": { + "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 + } + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/MHSMIPRule" + }, + "x-ms-identifiers": [ + "value" + ], + "description": "The list of IP address rules." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/MHSMVirtualNetworkRule" + }, + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility of a managed hsm pool.", + "type": "object" + }, + "MHSMIPRule": { + "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" + ], + "description": "A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range.", + "type": "object" + }, + "MHSMVirtualNetworkRule": { + "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'." + } + }, + "required": [ + "id" + ], + "description": "A rule governing the accessibility of a managed hsm pool from a specific virtual network.", + "type": "object" + }, + "MHSMPrivateEndpointConnectionItem": { + "properties": { + "id": { + "type": "string", + "description": "Id of private endpoint connection." + }, + "etag": { + "type": "string", + "description": "Modified whenever there is a change in the state of private endpoint connection." + }, + "properties": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Private endpoint connection properties." + } + }, + "description": "Private endpoint connection item.", + "type": "object" + }, + "MHSMPrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, + "etag": { + "type": "string", + "description": "Modified whenever there is a change in the state of private endpoint connection." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ManagedHsmResource" + } + ], + "description": "Private endpoint connection resource.", + "x-ms-azure-resource": true, + "type": "object" + }, + "MHSMPrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/MHSMPrivateEndpoint", + "description": "Properties of the private endpoint object." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/MHSMPrivateLinkServiceConnectionState", + "description": "Approval state of the private link connection." + }, + "provisioningState": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionProvisioningState", + "description": "Provisioning state of the private endpoint connection." + } + }, + "description": "Properties of the private endpoint connection resource.", + "type": "object" + }, + "MHSMPrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Full identifier of the private endpoint resource." + } + }, + "description": "Private endpoint object properties.", + "type": "object" + }, + "MHSMPrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/MHSMPrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been approved, rejected or removed by the key vault owner." + }, + "description": { + "type": "string", + "description": "The reason for approval or rejection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "enum": [ + "None" + ], + "x-ms-enum": { + "name": "ActionsRequired", + "modelAsString": true + } + } + }, + "description": "An object that represents the approval state of the private link connection.", + "type": "object" + }, + "MHSMPrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "MHSMPrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Failed", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "MHSMPrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/MHSMPrivateLinkResource" + } + } + }, + "description": "A list of private link resources", + "type": "object" + }, + "MHSMPrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/MHSMPrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ManagedHsmResource" + } + ], + "description": "A private link resource", + "type": "object" + }, + "MHSMPrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "Group identifier of private link resource.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "Required member names of private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required DNS zone names of the the private link resource." + } + }, + "description": "Properties of a private link resource.", + "type": "object" + }, + "MHSMGeoReplicationRegionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Preprovisioning", + "Provisioning", + "Succeeded", + "Failed", + "Deleting", + "Cleanup" + ], + "x-ms-enum": { + "name": "GeoReplicationRegionProvisioningState", + "modelAsString": true + } + }, + "CheckMhsmNameAvailabilityParameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The managed hsm name." + } + }, + "required": [ + "name" + ], + "description": "The parameters used to check the availability of the managed hsm name." + }, + "CheckMhsmNameAvailabilityResult": { + "type": "object", + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "The reason that a managed hsm name could not be used. The reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": true + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "An error message explaining the Reason value in more detail." + } + }, + "description": "The CheckMhsmNameAvailability operation response." + }, + "ManagedHSMSecurityDomainProperties": { + "type": "object", + "properties": { + "activationStatus": { + "readOnly": true, + "type": "string", + "description": "Activation Status", + "enum": [ + "Active", + "NotActivated", + "Unknown", + "Failed" + ], + "x-ms-enum": { + "name": "ActivationStatus", + "modelAsString": true, + "values": [ + { + "value": "Active", + "description": "The managed HSM Pool is active." + }, + { + "value": "NotActivated", + "description": "The managed HSM Pool is not yet activated." + }, + { + "value": "Unknown", + "description": "An unknown error occurred while activating managed hsm." + }, + { + "value": "Failed", + "description": "Failed to activate managed hsm." + } + ] + } + }, + "activationStatusMessage": { + "readOnly": true, + "type": "string", + "description": "Activation Status Message." + } + }, + "description": "The security domain properties of the managed hsm." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ManagedHsmResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the resource group that contains the managed HSM pool.", + "x-ms-parameter-location": "method" + }, + "MHSMPrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the private endpoint connection associated with the managed hsm pool.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/providers.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/providers.json new file mode 100644 index 000000000000..8d32ed544bf6 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/providers.json @@ -0,0 +1,288 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.KeyVault/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Key Vault Rest API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists available Rest API operations.": { + "$ref": "./examples/listOperations.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [], + "description": "List of Storage operations supported by the Storage resource provider." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of operations." + } + }, + "type": "object" + }, + "Operation": { + "description": "Key Vault REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Key Vault.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of operation.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + }, + "isDataAction": { + "type": "boolean", + "description": "Property to specify whether the action is a data action." + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + }, + "type": "object" + }, + "ServiceSpecification": { + "description": "One property of operation, include log specifications.", + "properties": { + "logSpecifications": { + "description": "Log specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "type": "object" + }, + "LogSpecification": { + "description": "Log specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of log specification." + }, + "displayName": { + "type": "string", + "description": "Display name of log specification." + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of specification." + } + }, + "type": "object" + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'." + }, + "aggregationType": { + "type": "string", + "description": "The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'." + }, + "supportedAggregationTypes": { + "type": "array", + "description": "The supported aggregation types for the metrics.", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "lockAggregationType": { + "type": "string", + "description": "The metric lock aggregation type." + }, + "dimensions": { + "type": "array", + "description": "The dimensions of metric", + "items": { + "$ref": "#/definitions/DimensionProperties" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Property to specify whether to fill gap with zero." + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + } + }, + "type": "object" + }, + "DimensionProperties": { + "description": "Type of operation: get, read, delete, etc.", + "properties": { + "name": { + "type": "string", + "description": "Name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "toBeExportedForShoebox": { + "type": "boolean", + "description": "Property to specify whether the dimension should be exported for Shoebox." + } + }, + "type": "object" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/secrets.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/secrets.json new file mode 100644 index 000000000000..f3b6395af2ba --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-04-01-preview/secrets.json @@ -0,0 +1,491 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}": { + "put": { + "tags": [ + "Secrets" + ], + "operationId": "Secrets_CreateOrUpdate", + "description": "Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "Name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecretCreateOrUpdateParameters" + }, + "description": "Parameters to create or update the secret" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created or updated vault", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "200": { + "description": "Created or updated secret", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a secret": { + "$ref": "./examples/createSecret.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "Secrets" + ], + "operationId": "Secrets_Update", + "description": "Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "Name of the secret" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecretPatchParameters" + }, + "description": "Parameters to patch the secret" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Patched secret", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "200": { + "description": "Patched secret", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a secret": { + "$ref": "./examples/updateSecret.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "Secrets" + ], + "operationId": "Secrets_Get", + "description": "Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault." + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved secret", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a secret": { + "$ref": "./examples/getSecret.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets": { + "get": { + "tags": [ + "Secrets" + ], + "operationId": "Secrets_List", + "description": "The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault." + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about secrets in the specified vault.", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List secrets in the vault": { + "$ref": "./examples/listSecrets.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "Attributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether the object is enabled." + }, + "nbf": { + "x-ms-client-name": "NotBefore", + "type": "integer", + "format": "unixtime", + "description": "Not before date in seconds since 1970-01-01T00:00:00Z." + }, + "exp": { + "x-ms-client-name": "Expires", + "type": "integer", + "format": "unixtime", + "description": "Expiry date in seconds since 1970-01-01T00:00:00Z." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + } + }, + "description": "The object attributes managed by the KeyVault service.", + "type": "object" + }, + "SecretProperties": { + "properties": { + "value": { + "type": "string", + "description": "The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets." + }, + "contentType": { + "type": "string", + "description": "The content type of the secret." + }, + "attributes": { + "$ref": "#/definitions/SecretAttributes", + "description": "The attributes of the secret." + }, + "secretUri": { + "type": "string", + "description": "The URI to retrieve the current version of the secret.", + "readOnly": true + }, + "secretUriWithVersion": { + "type": "string", + "description": "The URI to retrieve the specific version of the secret.", + "readOnly": true + } + }, + "description": "Properties of the secret", + "type": "object" + }, + "SecretPatchProperties": { + "properties": { + "value": { + "type": "string", + "description": "The value of the secret." + }, + "contentType": { + "type": "string", + "description": "The content type of the secret." + }, + "attributes": { + "$ref": "#/definitions/SecretAttributes", + "description": "The attributes of the secret." + } + }, + "description": "Properties of the secret", + "type": "object" + }, + "SecretAttributes": { + "allOf": [ + { + "$ref": "#/definitions/Attributes" + } + ], + "description": "The secret management attributes.", + "type": "object" + }, + "SecretCreateOrUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the secret. " + }, + "properties": { + "$ref": "#/definitions/SecretProperties", + "description": "Properties of the secret" + } + }, + "description": "Parameters for creating or updating a secret", + "required": [ + "properties" + ], + "x-ms-azure-resource": true, + "type": "object" + }, + "SecretPatchParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the secret. " + }, + "properties": { + "$ref": "#/definitions/SecretPatchProperties", + "description": "Properties of the secret" + } + }, + "description": "Parameters for patching a secret", + "x-ms-azure-resource": true, + "type": "object" + }, + "Secret": { + "properties": { + "properties": { + "$ref": "#/definitions/SecretProperties", + "description": "Properties of the secret" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "./keyvault.json#/definitions/Resource" + } + ], + "description": "Resource information with extended details.", + "type": "object" + }, + "SecretListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Secret" + }, + "description": "The list of secrets." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of secrets." + } + }, + "description": "List of secrets", + "type": "object" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/keyvault/resource-manager/readme.md b/specification/keyvault/resource-manager/readme.md index c901a9f52028..fae54df7a2ee 100644 --- a/specification/keyvault/resource-manager/readme.md +++ b/specification/keyvault/resource-manager/readme.md @@ -29,6 +29,20 @@ openapi-type: arm tag: package-2023-07 ``` +### Tag: package-preview-2024-04 + +These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-04' +input-file: + - Microsoft.KeyVault/preview/2024-04-01-preview/common.json + - Microsoft.KeyVault/preview/2024-04-01-preview/keys.json + - Microsoft.KeyVault/preview/2024-04-01-preview/keysManagedHsm.json + - Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json + - Microsoft.KeyVault/preview/2024-04-01-preview/managedHsm.json + - Microsoft.KeyVault/preview/2024-04-01-preview/providers.json + - Microsoft.KeyVault/preview/2024-04-01-preview/secrets.json +``` ### Tag: package-2023-07 From 1c552f36abed39d0e2a4b744fb59f668a7706129 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Thu, 20 Jun 2024 13:49:47 -0700 Subject: [PATCH 214/343] Change ChatCompletionsOptions to a model Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/chat_completions.tsp | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index fb35be83aa62..20e6bd6b71a2 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -9,7 +9,12 @@ using Azure.ClientGenerator.Core; namespace ModelClient; -alias ChatCompletionsOptions = { +@doc(""" +The configuration information for a chat completions request. +Completions support a wide variety of tasks and generate text that continues from or "completes" +provided prompt data. +""") +model ChatCompletionsOptions = { @doc(""" The collection of context messages associated with this chat completions request. Typical usage begins with a chat message for the System role that provides instructions for From 8e420b994d3f16a0a2bfc4fc6d7945c9f57dc30b Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Thu, 20 Jun 2024 13:52:44 -0700 Subject: [PATCH 215/343] syntax Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/chat_completions.tsp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 20e6bd6b71a2..bfe138c18662 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -14,7 +14,7 @@ The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data. """) -model ChatCompletionsOptions = { +model ChatCompletionsOptions { @doc(""" The collection of context messages associated with this chat completions request. Typical usage begins with a chat message for the System role that provides instructions for @@ -107,7 +107,7 @@ model ChatCompletionsOptions = { same seed and parameters should return the same result. Determinism is not guaranteed." """) seed?: int64; -}; +} alias ChatCompletionsCommon = { @doc("A unique identifier associated with this chat completions response.") From 2af12ce8b21e4e755f3d3b1bc09fc180bd5ccaea Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Thu, 20 Jun 2024 15:14:55 -0700 Subject: [PATCH 216/343] Add 'model' to chat completions request --- .../GetChatCompletions_MaximumSet_Gen.json | 25 ++++++++++--------- .../GetChatCompletions_MinimumSet_Gen.json | 14 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 18 ++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 16 ++++++------ .../GetImageEmbeddings_MaximumSet_Gen.json | 20 +++++++-------- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 ++++++------ .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- .../ModelClient/models/chat_completions.tsp | 7 +++++- .../GetChatCompletions_MaximumSet_Gen.json | 25 ++++++++++--------- .../GetChatCompletions_MinimumSet_Gen.json | 14 +++++------ .../GetEmbeddings_MaximumSet_Gen.json | 18 ++++++------- .../GetEmbeddings_MinimumSet_Gen.json | 16 ++++++------ .../GetImageEmbeddings_MaximumSet_Gen.json | 20 +++++++-------- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 ++++++------ .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +-- .../preview/2024-05-01-preview/openapi.json | 6 ++++- 18 files changed, 129 insertions(+), 118 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index 1daf23c01717..ce5f4bd0f230 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,46 +10,47 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, + "frequency_penalty": -2, "stream": true, - "presence_penalty": -2, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "wweqvyuu" + "hdwxenghjddzdoibhygiexqlzg" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 21 + "seed": 10, + "model": "f" } }, "responses": { "200": { "body": { - "id": "xcjpjdpmiysj", - "created": 18, - "model": "lglvjvjgmdddzihtvmcbnvkyhjzra", + "id": "qasi", + "created": 10, + "model": "dqhfui", "usage": { "completion_tokens": 30, - "prompt_tokens": 22, - "total_tokens": 28 + "prompt_tokens": 5, + "total_tokens": 15 }, "choices": [ { - "index": 3, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "divildjbudgnfdwwmghwehkxer", + "content": "dutzickh", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "lfxfzpbpxpiaadkiaatsbxymuyhysl" + "id": "iergwzuviddjlebkehojkelrtnzjf" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index d15787f43508..5ea13446fa0e 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "xcjpjdpmiysj", - "created": 18, - "model": "lglvjvjgmdddzihtvmcbnvkyhjzra", + "id": "qasi", + "created": 10, + "model": "dqhfui", "usage": { "completion_tokens": 30, - "prompt_tokens": 22, - "total_tokens": 28 + "prompt_tokens": 5, + "total_tokens": 15 }, "choices": [ { - "index": 3, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "divildjbudgnfdwwmghwehkxer" + "content": "dutzickh" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index 0cf36eb1079b..123b53d0b637 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "hrppmaq" + "yyfj" ], - "dimensions": 28, + "dimensions": 25, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "oy", + "id": "yazxsmdpbqxhvxnzaoiraeodo", "data": [ { "embedding": [ - 13 + 27 ], - "index": 11 + "index": 9 } ], "usage": { - "input_tokens": 3, - "prompt_tokens": 22, - "total_tokens": 20 + "input_tokens": 5, + "prompt_tokens": 19, + "total_tokens": 18 }, - "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" + "model": "jxaepvabbkyclqiabhvbumoxjv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index 3ddf2339e771..4c8dc7cdeb64 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "ljibozyqlurpe" + "xdlqaliwkojmfycalwtfrzusjyf" ] } }, "responses": { "200": { "body": { - "id": "oy", + "id": "yazxsmdpbqxhvxnzaoiraeodo", "data": [ { "embedding": [ - 13 + 27 ], - "index": 11 + "index": 9 } ], "usage": { - "input_tokens": 3, - "prompt_tokens": 22, - "total_tokens": 20 + "input_tokens": 5, + "prompt_tokens": 19, + "total_tokens": 18 }, - "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" + "model": "jxaepvabbkyclqiabhvbumoxjv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index 3b795f6e1575..a6bb1d5b2fcd 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "sfhihwmxxiu", - "text": "pnwbh" + "image": "ydcewnfbtq", + "text": "uxfegdsf" } ], - "dimensions": 3, + "dimensions": 27, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "oy", + "id": "yazxsmdpbqxhvxnzaoiraeodo", "data": [ { "embedding": [ - 13 + 27 ], - "index": 11 + "index": 9 } ], "usage": { - "input_tokens": 3, - "prompt_tokens": 22, - "total_tokens": 20 + "input_tokens": 5, + "prompt_tokens": 19, + "total_tokens": 18 }, - "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" + "model": "jxaepvabbkyclqiabhvbumoxjv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 8901e88a1ffd..57ac3c2f33b8 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "sfhihwmxxiu" + "image": "ydcewnfbtq" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "oy", + "id": "yazxsmdpbqxhvxnzaoiraeodo", "data": [ { "embedding": [ - 13 + 27 ], - "index": 11 + "index": 9 } ], "usage": { - "input_tokens": 3, - "prompt_tokens": 22, - "total_tokens": 20 + "input_tokens": 5, + "prompt_tokens": 19, + "total_tokens": 18 }, - "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" + "model": "jxaepvabbkyclqiabhvbumoxjv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index c0831624b3a8..185baef2213a 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "dwohhribkeyagqneghlwsmutopdrd", + "model_name": "nmjvjpmwexifukpt", "model_type": "embeddings", - "model_provider_name": "ioclhlabtzxqakbxyuejelssomftb" + "model_provider_name": "qumaunlvkzpnfknl" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index 7c94a2db5b14..9dfb2eddd833 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "dwohhribkeyagqneghlwsmutopdrd", + "model_name": "nmjvjpmwexifukpt", "model_type": "embeddings", - "model_provider_name": "ioclhlabtzxqakbxyuejelssomftb" + "model_provider_name": "qumaunlvkzpnfknl" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 044165ceca7a..08b2a18f583e 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -96,9 +96,14 @@ alias ChatCompletionsOptions = { @doc(""" If specified, the system will make a best effort to sample deterministically such that repeated requests with the - same seed and parameters should return the same result. Determinism is not guaranteed." + same seed and parameters should return the same result. Determinism is not guaranteed. """) seed?: int64; + + @doc(""" + ID of the specific AI model to use, if more than one model is available on the endpoint. + """) + `model`?: string; }; alias ChatCompletionsCommon = { diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 1daf23c01717..ce5f4bd0f230 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,46 +10,47 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, + "frequency_penalty": -2, "stream": true, - "presence_penalty": -2, + "presence_penalty": 0, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "wweqvyuu" + "hdwxenghjddzdoibhygiexqlzg" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 21 + "seed": 10, + "model": "f" } }, "responses": { "200": { "body": { - "id": "xcjpjdpmiysj", - "created": 18, - "model": "lglvjvjgmdddzihtvmcbnvkyhjzra", + "id": "qasi", + "created": 10, + "model": "dqhfui", "usage": { "completion_tokens": 30, - "prompt_tokens": 22, - "total_tokens": 28 + "prompt_tokens": 5, + "total_tokens": 15 }, "choices": [ { - "index": 3, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "divildjbudgnfdwwmghwehkxer", + "content": "dutzickh", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "lfxfzpbpxpiaadkiaatsbxymuyhysl" + "id": "iergwzuviddjlebkehojkelrtnzjf" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index d15787f43508..5ea13446fa0e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "xcjpjdpmiysj", - "created": 18, - "model": "lglvjvjgmdddzihtvmcbnvkyhjzra", + "id": "qasi", + "created": 10, + "model": "dqhfui", "usage": { "completion_tokens": 30, - "prompt_tokens": 22, - "total_tokens": 28 + "prompt_tokens": 5, + "total_tokens": 15 }, "choices": [ { - "index": 3, + "index": 18, "finish_reason": "stop", "message": { "role": "system", - "content": "divildjbudgnfdwwmghwehkxer" + "content": "dutzickh" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 0cf36eb1079b..123b53d0b637 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "hrppmaq" + "yyfj" ], - "dimensions": 28, + "dimensions": 25, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,21 @@ "responses": { "200": { "body": { - "id": "oy", + "id": "yazxsmdpbqxhvxnzaoiraeodo", "data": [ { "embedding": [ - 13 + 27 ], - "index": 11 + "index": 9 } ], "usage": { - "input_tokens": 3, - "prompt_tokens": 22, - "total_tokens": 20 + "input_tokens": 5, + "prompt_tokens": 19, + "total_tokens": 18 }, - "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" + "model": "jxaepvabbkyclqiabhvbumoxjv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 3ddf2339e771..4c8dc7cdeb64 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,28 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "ljibozyqlurpe" + "xdlqaliwkojmfycalwtfrzusjyf" ] } }, "responses": { "200": { "body": { - "id": "oy", + "id": "yazxsmdpbqxhvxnzaoiraeodo", "data": [ { "embedding": [ - 13 + 27 ], - "index": 11 + "index": 9 } ], "usage": { - "input_tokens": 3, - "prompt_tokens": 22, - "total_tokens": 20 + "input_tokens": 5, + "prompt_tokens": 19, + "total_tokens": 18 }, - "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" + "model": "jxaepvabbkyclqiabhvbumoxjv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index 3b795f6e1575..a6bb1d5b2fcd 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "sfhihwmxxiu", - "text": "pnwbh" + "image": "ydcewnfbtq", + "text": "uxfegdsf" } ], - "dimensions": 3, + "dimensions": 27, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,21 @@ "responses": { "200": { "body": { - "id": "oy", + "id": "yazxsmdpbqxhvxnzaoiraeodo", "data": [ { "embedding": [ - 13 + 27 ], - "index": 11 + "index": 9 } ], "usage": { - "input_tokens": 3, - "prompt_tokens": 22, - "total_tokens": 20 + "input_tokens": 5, + "prompt_tokens": 19, + "total_tokens": 18 }, - "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" + "model": "jxaepvabbkyclqiabhvbumoxjv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 8901e88a1ffd..57ac3c2f33b8 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "sfhihwmxxiu" + "image": "ydcewnfbtq" } ] } @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "oy", + "id": "yazxsmdpbqxhvxnzaoiraeodo", "data": [ { "embedding": [ - 13 + 27 ], - "index": 11 + "index": 9 } ], "usage": { - "input_tokens": 3, - "prompt_tokens": 22, - "total_tokens": 20 + "input_tokens": 5, + "prompt_tokens": 19, + "total_tokens": 18 }, - "model": "mfsqynzwsxvpjyrnxonupcfnfyqq" + "model": "jxaepvabbkyclqiabhvbumoxjv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index c0831624b3a8..185baef2213a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "dwohhribkeyagqneghlwsmutopdrd", + "model_name": "nmjvjpmwexifukpt", "model_type": "embeddings", - "model_provider_name": "ioclhlabtzxqakbxyuejelssomftb" + "model_provider_name": "qumaunlvkzpnfknl" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 7c94a2db5b14..9dfb2eddd833 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "dwohhribkeyagqneghlwsmutopdrd", + "model_name": "nmjvjpmwexifukpt", "model_type": "embeddings", - "model_provider_name": "ioclhlabtzxqakbxyuejelssomftb" + "model_provider_name": "qumaunlvkzpnfknl" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json index e7a769627aa4..b62331935e54 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json @@ -165,7 +165,11 @@ "seed": { "type": "integer", "format": "int64", - "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed.\"" + "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed." + }, + "model": { + "type": "string", + "description": "ID of the specific AI model to use, if more than one model is available on the endpoint." } }, "required": [ From 7cc354fc7e405ea867e434deca8c79801beadc4a Mon Sep 17 00:00:00 2001 From: Shaoru Hu <49520642+HuShaoRu@users.noreply.github.com> Date: Fri, 21 Jun 2024 12:06:23 +0800 Subject: [PATCH 217/343] fix ComponentsByRelease for AKS 2024-04-02 preview api (#29425) * fix definition of ComponentsByRelease * add x-ms-identifiers * fix --- .../2024-04-02-preview/managedClusters.json | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json index 6543f78e4a2c..89d36d4fa313 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json @@ -6561,7 +6561,12 @@ "description": "List of orchestrator types and versions available for upgrade." }, "componentsByReleases": { - "$ref": "#/definitions/ComponentsByReleases" + "type": "array", + "items": { + "$ref": "#/definitions/ComponentsByRelease" + }, + "x-ms-identifiers": [], + "description": "List of components grouped by kubernetes major.minor version." } }, "required": [ @@ -7012,7 +7017,12 @@ "description": "List of orchestrator types and versions available for upgrade." }, "componentsByReleases": { - "$ref": "#/definitions/ComponentsByReleases" + "type": "array", + "items": { + "$ref": "#/definitions/ComponentsByRelease" + }, + "x-ms-identifiers": [], + "description": "List of components grouped by kubernetes major.minor version." }, "latestNodeImageVersion": { "type": "string", @@ -10077,7 +10087,7 @@ } } }, - "ComponentsByReleases": { + "ComponentsByRelease": { "type": "object", "properties": { "kubernetesVersion": { @@ -10089,6 +10099,7 @@ "items": { "$ref": "#/definitions/Component" }, + "x-ms-identifiers": [], "description": "components of current or upgraded Kubernetes version in the cluster." } }, From 0fdc8c82d0b724c26b0c3738b1c2880f31a39c6c Mon Sep 17 00:00:00 2001 From: Wei Dong <40835867+dw511214992@users.noreply.github.com> Date: Fri, 21 Jun 2024 12:07:07 +0800 Subject: [PATCH 218/343] Change 2024-05-01 to 2024-05-01-preview (#29441) * rename 2024-05-01 to 2024-05-01-preview * [HdiOnAks] Adding PublicIpTag property to ClusterPoolNetworkProfile (#29497) * Adding PublicIpTag property to ClusterPoolNetworkProfile --------- Co-authored-by: Yuan He --------- Co-authored-by: Wei Dong Co-authored-by: Yuan He Co-authored-by: Yuan He --- .../examples/ClusterUpgradeRollback.json | 2 +- .../examples/CreateAutoscaleCluster.json | 2 +- .../examples/CreateClusterPool.json | 2 +- .../CreateClusterPoolWithPrivateAks.json | 2 +- .../examples/CreateClusterPoolWithUDRAks.json | 2 +- .../examples/CreateRangerCluster.json | 2 +- .../examples/CreateSparkCluster.json | 2 +- ...CreateSparkClusterWithInternalIngress.json | 2 +- .../examples/DeleteCluster.json | 2 +- .../examples/DeleteClusterPool.json | 2 +- .../examples/GetCluster.json | 2 +- .../examples/GetClusterInstanceView.json | 2 +- .../examples/GetClusterPool.json | 2 +- .../examples/GetOperations.json | 2 +- .../examples/InstallNewClusterLibraries.json | 2 +- .../ListAvailableClusterPoolVersions.json | 2 +- .../ListAvailableClusterVersions.json | 2 +- .../ListClusterAvailableUpgrades.json | 2 +- .../examples/ListClusterInstanceViews.json | 2 +- .../examples/ListClusterJobs.json | 2 +- .../ListClusterPoolAvailableUpgrades.json | 2 +- .../ListClusterPoolUpgradeHistory.json | 2 +- .../examples/ListClusterPools.json | 2 +- .../ListClusterPoolsSubscription.json | 2 +- .../examples/ListClusterServiceConfigs.json | 2 +- .../examples/ListClusterUpgradeHistory.json | 2 +- .../ListClustersByClusterPoolName.json | 2 +- .../ListPredefinedClusterLibraries.json | 2 +- .../ListUserCustomClusterLibraries.json | 2 +- .../examples/LocationsNameAvailability.json | 2 +- .../examples/PatchCluster.json | 4 ++-- .../examples/PatchClusterPool.json | 2 +- .../examples/PatchRangerCluster.json | 4 ++-- .../examples/ResizeCluster.json | 4 ++-- .../examples/RunClusterJob.json | 2 +- .../UninstallExistingClusterLibraries.json | 2 +- .../UpgradeAKSPatchVersionForCluster.json | 2 +- .../UpgradeAKSPatchVersionForClusterPool.json | 2 +- .../examples/UpgradeHotfixForCluster.json | 2 +- .../examples/UpgradeNodeOsForClusterPool.json | 2 +- .../2024-05-01-preview}/hdinsight.json | 24 ++++++++++++++++++- .../HDInsightOnAks/readme.md | 6 ++--- 42 files changed, 69 insertions(+), 47 deletions(-) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ClusterUpgradeRollback.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/CreateAutoscaleCluster.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/CreateClusterPool.json (98%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/CreateClusterPoolWithPrivateAks.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/CreateClusterPoolWithUDRAks.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/CreateRangerCluster.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/CreateSparkCluster.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/CreateSparkClusterWithInternalIngress.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/DeleteCluster.json (92%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/DeleteClusterPool.json (92%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/GetCluster.json (98%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/GetClusterInstanceView.json (93%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/GetClusterPool.json (97%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/GetOperations.json (94%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/InstallNewClusterLibraries.json (95%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListAvailableClusterPoolVersions.json (96%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListAvailableClusterVersions.json (97%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClusterAvailableUpgrades.json (97%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClusterInstanceViews.json (94%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClusterJobs.json (96%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClusterPoolAvailableUpgrades.json (96%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClusterPoolUpgradeHistory.json (97%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClusterPools.json (97%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClusterPoolsSubscription.json (97%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClusterServiceConfigs.json (92%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClusterUpgradeHistory.json (96%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListClustersByClusterPoolName.json (98%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListPredefinedClusterLibraries.json (96%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ListUserCustomClusterLibraries.json (97%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/LocationsNameAvailability.json (90%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/PatchCluster.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/PatchClusterPool.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/PatchRangerCluster.json (98%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/ResizeCluster.json (98%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/RunClusterJob.json (97%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/UninstallExistingClusterLibraries.json (94%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/UpgradeAKSPatchVersionForCluster.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/UpgradeAKSPatchVersionForClusterPool.json (98%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/UpgradeHotfixForCluster.json (99%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/examples/UpgradeNodeOsForClusterPool.json (98%) rename specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/{stable/2024-05-01 => preview/2024-05-01-preview}/hdinsight.json (99%) diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ClusterUpgradeRollback.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ClusterUpgradeRollback.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ClusterUpgradeRollback.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ClusterUpgradeRollback.json index 1e931f56449d..30f37192210d 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ClusterUpgradeRollback.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ClusterUpgradeRollback.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "ClusterRollbackUpgradeRequest": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateAutoscaleCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateAutoscaleCluster.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateAutoscaleCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateAutoscaleCluster.json index e51c5d313167..c1854357ddce 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateAutoscaleCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateAutoscaleCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "HDInsightCluster": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPool.json similarity index 98% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateClusterPool.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPool.json index 0982e929cc78..fd76d9e50515 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateClusterPool.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPool.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "ClusterPool": { "location": "West US 2", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateClusterPoolWithPrivateAks.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithPrivateAks.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateClusterPoolWithPrivateAks.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithPrivateAks.json index cc36b83f793a..c13de49280cd 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateClusterPoolWithPrivateAks.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithPrivateAks.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "ClusterPool": { "location": "West US 2", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateClusterPoolWithUDRAks.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithUDRAks.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateClusterPoolWithUDRAks.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithUDRAks.json index c519d1d252ca..9522fe62a2ca 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateClusterPoolWithUDRAks.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithUDRAks.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "ClusterPool": { "location": "West US 2", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateRangerCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateRangerCluster.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateRangerCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateRangerCluster.json index ee0bff311ab8..5c2aea923bf2 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateRangerCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateRangerCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "HDInsightCluster": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateSparkCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkCluster.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateSparkCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkCluster.json index 08b1e6ab046a..312c941518cd 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateSparkCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "HDInsightCluster": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateSparkClusterWithInternalIngress.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkClusterWithInternalIngress.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateSparkClusterWithInternalIngress.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkClusterWithInternalIngress.json index 9195044385d7..0da021e3cde6 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/CreateSparkClusterWithInternalIngress.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkClusterWithInternalIngress.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "HDInsightCluster": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/DeleteCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteCluster.json similarity index 92% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/DeleteCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteCluster.json index f749e4432102..b689dd2b0dab 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/DeleteCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "rg1", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1" }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/DeleteClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteClusterPool.json similarity index 92% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/DeleteClusterPool.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteClusterPool.json index 698e45ac4a27..ba83e73a4e44 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/DeleteClusterPool.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteClusterPool.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "rg1", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1" }, "responses": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetCluster.json similarity index 98% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetCluster.json index 68601db4141e..6dfcce9d29a8 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1" }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetClusterInstanceView.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterInstanceView.json similarity index 93% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetClusterInstanceView.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterInstanceView.json index a93ecc5cd6af..350884ab207e 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetClusterInstanceView.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterInstanceView.json @@ -2,7 +2,7 @@ "parameters": { "clusterName": "cluster1", "resourceGroupName": "rg1", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "clusterPoolName": "clusterPool1" }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterPool.json similarity index 97% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetClusterPool.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterPool.json index a1f995f8c124..dbba4546749d 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetClusterPool.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterPool.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1" }, "responses": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetOperations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetOperations.json similarity index 94% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetOperations.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetOperations.json index 0e5cc5972613..0439980c49d3 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/GetOperations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetOperations.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "resourceGroup1", - "api-version": "2024-05-01" + "api-version": "2024-05-01-preview" }, "responses": { "200": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/InstallNewClusterLibraries.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/InstallNewClusterLibraries.json similarity index 95% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/InstallNewClusterLibraries.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/InstallNewClusterLibraries.json index 55686ed819b3..b755ec38d9e1 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/InstallNewClusterLibraries.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/InstallNewClusterLibraries.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "hiloResourceGroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterPool", "clusterName": "cluster", "operation": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListAvailableClusterPoolVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterPoolVersions.json similarity index 96% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListAvailableClusterPoolVersions.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterPoolVersions.json index 70808d6a96b0..23debec4f8d9 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListAvailableClusterPoolVersions.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterPoolVersions.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "location": "westus2", - "api-version": "2024-05-01" + "api-version": "2024-05-01-preview" }, "responses": { "200": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListAvailableClusterVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterVersions.json similarity index 97% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListAvailableClusterVersions.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterVersions.json index ef58aeee0f17..8da23c3856af 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListAvailableClusterVersions.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterVersions.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "location": "westus2", - "api-version": "2024-05-01" + "api-version": "2024-05-01-preview" }, "responses": { "200": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterAvailableUpgrades.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterAvailableUpgrades.json similarity index 97% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterAvailableUpgrades.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterAvailableUpgrades.json index badd09266d93..dbbc4bb14708 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterAvailableUpgrades.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterAvailableUpgrades.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1" }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterInstanceViews.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterInstanceViews.json similarity index 94% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterInstanceViews.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterInstanceViews.json index 33fc430df52b..f5f2eb91718b 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterInstanceViews.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterInstanceViews.json @@ -2,7 +2,7 @@ "parameters": { "clusterName": "cluster1", "resourceGroupName": "rg1", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "clusterPoolName": "clusterPool1" }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterJobs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterJobs.json similarity index 96% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterJobs.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterJobs.json index 61c42ab8c740..4494f1ddbf8b 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterJobs.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterJobs.json @@ -2,7 +2,7 @@ "parameters": { "resourceGroupName": "hiloResourcegroup", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterPool1", "clusterName": "cluster1" }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPoolAvailableUpgrades.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolAvailableUpgrades.json similarity index 96% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPoolAvailableUpgrades.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolAvailableUpgrades.json index a96a5d14d480..132617f0d41e 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPoolAvailableUpgrades.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolAvailableUpgrades.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1" }, "responses": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPoolUpgradeHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolUpgradeHistory.json similarity index 97% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPoolUpgradeHistory.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolUpgradeHistory.json index 0d00e45f6c30..5d5e3eeb615f 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPoolUpgradeHistory.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolUpgradeHistory.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1" }, "responses": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPools.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPools.json similarity index 97% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPools.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPools.json index 5ed8e5e2b63c..595e84ceba93 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPools.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPools.json @@ -2,7 +2,7 @@ "parameters": { "resourceGroupName": "hiloResourcegroup", "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2024-05-01" + "api-version": "2024-05-01-preview" }, "responses": { "200": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPoolsSubscription.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolsSubscription.json similarity index 97% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPoolsSubscription.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolsSubscription.json index cbdac3facb7d..05077a9e90d1 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterPoolsSubscription.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolsSubscription.json @@ -1,7 +1,7 @@ { "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2024-05-01" + "api-version": "2024-05-01-preview" }, "responses": { "200": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterServiceConfigs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterServiceConfigs.json similarity index 92% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterServiceConfigs.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterServiceConfigs.json index 651099ad4360..8abca07ba7d3 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterServiceConfigs.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterServiceConfigs.json @@ -2,7 +2,7 @@ "parameters": { "clusterName": "cluster1", "resourceGroupName": "rg1", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "clusterPoolName": "clusterPool1" }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterUpgradeHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterUpgradeHistory.json similarity index 96% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterUpgradeHistory.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterUpgradeHistory.json index b71581de6957..572e073a0557 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClusterUpgradeHistory.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterUpgradeHistory.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1" }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClustersByClusterPoolName.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClustersByClusterPoolName.json similarity index 98% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClustersByClusterPoolName.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClustersByClusterPoolName.json index 98ecb1a314a2..c1f1c6badd2b 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListClustersByClusterPoolName.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClustersByClusterPoolName.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1" }, "responses": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListPredefinedClusterLibraries.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListPredefinedClusterLibraries.json similarity index 96% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListPredefinedClusterLibraries.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListPredefinedClusterLibraries.json index 648a63fce069..35dfb72a8f94 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListPredefinedClusterLibraries.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListPredefinedClusterLibraries.json @@ -2,7 +2,7 @@ "parameters": { "resourceGroupName": "hiloResourceGroup", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterPool", "clusterName": "cluster", "$category": "predefined" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListUserCustomClusterLibraries.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListUserCustomClusterLibraries.json similarity index 97% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListUserCustomClusterLibraries.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListUserCustomClusterLibraries.json index c607cc3fa4a5..39ca335d1fcf 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ListUserCustomClusterLibraries.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListUserCustomClusterLibraries.json @@ -2,7 +2,7 @@ "parameters": { "resourceGroupName": "hiloResourceGroup", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterPool", "clusterName": "cluster", "$category": "custom" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/LocationsNameAvailability.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/LocationsNameAvailability.json similarity index 90% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/LocationsNameAvailability.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/LocationsNameAvailability.json index 5f1a39ce4deb..fcc1bb8d6f7d 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/LocationsNameAvailability.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/LocationsNameAvailability.json @@ -1,7 +1,7 @@ { "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "location": "southeastasia", "NameAvailabilityParameters": { "name": "contosemember1", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/PatchCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchCluster.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/PatchCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchCluster.json index 827a207535d2..48e3ae7846ed 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/PatchCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "ClusterPatchRequest": { @@ -295,7 +295,7 @@ }, "202": { "headers": { - "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2024-05-01" + "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2024-05-01-preview" }, "body": { "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/PatchClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchClusterPool.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/PatchClusterPool.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchClusterPool.json index 817baeee7498..5d2e98cf1140 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/PatchClusterPool.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchClusterPool.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterPoolTags": { "tags": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/PatchRangerCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchRangerCluster.json similarity index 98% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/PatchRangerCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchRangerCluster.json index 30486574aa40..7e143d64e6f7 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/PatchRangerCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchRangerCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "ClusterPatchRequest": { @@ -145,7 +145,7 @@ }, "202": { "headers": { - "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2024-05-01" + "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2024-05-01-preview" }, "body": { "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ResizeCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ResizeCluster.json similarity index 98% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ResizeCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ResizeCluster.json index 4874895f22c2..3f2788c9a799 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/ResizeCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ResizeCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "ClusterResizeRequest": { @@ -147,7 +147,7 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-05-01" + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-05-01-preview" } } } diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/RunClusterJob.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/RunClusterJob.json similarity index 97% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/RunClusterJob.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/RunClusterJob.json index cedeb7b9558b..1ce2c8ce6d7c 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/RunClusterJob.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/RunClusterJob.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "ClusterJob": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UninstallExistingClusterLibraries.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UninstallExistingClusterLibraries.json similarity index 94% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UninstallExistingClusterLibraries.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UninstallExistingClusterLibraries.json index f786d78e7aa4..bc475ba56dbc 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UninstallExistingClusterLibraries.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UninstallExistingClusterLibraries.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "hiloResourceGroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterPool", "clusterName": "cluster", "operation": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeAKSPatchVersionForCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForCluster.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeAKSPatchVersionForCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForCluster.json index 00ae82da3ee0..62f502387a75 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeAKSPatchVersionForCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "ClusterUpgradeRequest": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeAKSPatchVersionForClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json similarity index 98% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeAKSPatchVersionForClusterPool.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json index ccd5f8ce4689..3bce9800f950 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeAKSPatchVersionForClusterPool.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "ClusterPoolUpgradeRequest": { "properties": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeHotfixForCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeHotfixForCluster.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeHotfixForCluster.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeHotfixForCluster.json index c31c89819cc8..3cb92b9aec2f 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeHotfixForCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeHotfixForCluster.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "clusterName": "cluster1", "ClusterUpgradeRequest": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeNodeOsForClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeNodeOsForClusterPool.json similarity index 98% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeNodeOsForClusterPool.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeNodeOsForClusterPool.json index ebeb607468f0..ab008abe4317 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/examples/UpgradeNodeOsForClusterPool.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeNodeOsForClusterPool.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01", + "api-version": "2024-05-01-preview", "clusterPoolName": "clusterpool1", "ClusterPoolUpgradeRequest": { "properties": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/hdinsight.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/hdinsight.json similarity index 99% rename from specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/hdinsight.json rename to specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/hdinsight.json index 3944ba0c7116..f4b28c365114 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/stable/2024-05-01/hdinsight.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/hdinsight.json @@ -3,7 +3,7 @@ "info": { "title": "HDInsight on AKS Management Client", "description": "The HDInsight on AKS Management Client.", - "version": "2024-05-01" + "version": "2024-05-01-preview" }, "host": "management.azure.com", "schemes": [ @@ -1585,9 +1585,31 @@ "properties": { "clusterPoolVersion": { "$ref": "#/definitions/ClusterPoolVersionPattern" + }, + "publicIpTag": { + "description": "Gets or sets the IP tag for the public IPs created along with the HDInsightOnAks ClusterPools and Clusters. ", + "$ref": "#/definitions/IpTag" } } }, + "IpTag": { + "type": "object", + "required": [ + "ipTagType", + "tag" + ], + "properties": { + "ipTagType": { + "type": "string", + "description": "Gets or sets the ipTag type: Example FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc" + } + }, + "description": "Contains the IpTag associated with the public IP address" + }, "ClusterPoolComputeProfile": { "type": "object", "description": "Cluster pool compute profile.", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md index a9c33c753d59..771d534a4a3d 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md @@ -30,7 +30,7 @@ description: HDInsight Containers Management Client openapi-type: arm openapi-subtype: rpaas azure-arm: true -tag: package-2024-05 +tag: package-preview-2024-05 ``` ``` yaml @@ -45,9 +45,9 @@ modelerfour: These settings apply only when `--tag=package-2024-05` is specified on the command line. -```yaml $(tag) == 'package-2024-05' +```yaml $(tag) == 'package-preview-2024-05' input-file: - - stable/2024-05-01/hdinsight.json + - preview/2024-05-01-preview/hdinsight.json suppressions: - code: ResourceNameRestriction From 150e10e9fe4d0c2a0225dd8f99365e84b6385364 Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Fri, 21 Jun 2024 13:10:22 +0800 Subject: [PATCH 219/343] Create sdk-automation-faq.md (#29537) * Create sdk-automation-faq.md Added a document for FAQ as placeholder Added instructions of downloading SDK * Update sdk-automation-faq.md Added short link * Update sdk-automation-faq.md Added blank lines before/after screenshot. --- .../sdkautomation/sdk-automation-faq.md | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 documentation/sdkautomation/sdk-automation-faq.md diff --git a/documentation/sdkautomation/sdk-automation-faq.md b/documentation/sdkautomation/sdk-automation-faq.md new file mode 100644 index 000000000000..7eaf4147393a --- /dev/null +++ b/documentation/sdkautomation/sdk-automation-faq.md @@ -0,0 +1,34 @@ +| Short Link: | [aka.ms/azsdk/sdk-automation-faq](https://aka.ms/azsdk/sdk-automation-faq) | +|--|--| + +# FAQ + +## How to Download the Generated Artifacts + +### Prerequisites +Ensure the SDK automation CI check succeeds. If the check fails, the artifacts might not have been generated. + +### Steps to Download Artifacts +Let's take Python as an example. The results will be displayed in the pull request comment once the SDK automation CI check completes successfully, as shown in the screenshot below. + +![image](https://github.com/Azure/azure-rest-api-specs/assets/20296335/9c386007-785c-41aa-864d-9423e154b158) + +1. Navigate to `Checks` page: click on the `Details` link. + +2. View Azure DevOps Build Pipeline Run: click on the `View Azure DevOps build log for more details` link. + + ![image](https://github.com/Azure/azure-rest-api-specs/assets/20296335/64ec1f22-37df-4597-8259-3dd581656faa) + +3. Browse to Pipeline Run Result: click on the `left` arrow. + + ![image](https://github.com/Azure/azure-rest-api-specs/assets/20296335/726c2e8a-9a39-4af2-b745-0136d53bee6d) + +4. Access Artifacts Page: click on the `artifacts` link. + + ![image](https://github.com/Azure/azure-rest-api-specs/assets/20296335/b2c4c307-a430-4dec-bb09-5ac7e659a418) + +5. Locate Generated Artifacts: + The generated artifacts for Python are located under the `SDK_Artifact_Python` folder. + + ![image](https://github.com/Azure/azure-rest-api-specs/assets/20296335/4cecb794-0ec9-4092-a0cc-b45214438e1e) + From 7753cb8917f0968713c013a1f25875e8bd8dc492 Mon Sep 17 00:00:00 2001 From: bjqian Date: Fri, 21 Jun 2024 13:31:20 +0800 Subject: [PATCH 220/343] Add new api version 2024-04-01-preview for Azure SignalR and Azure Web PubSub (#29239) * Init 2024-04-01-preview from 2023-03-01 * Add Api version 2024-04-01-preview * Update to 2024-04-01-preview for web pubsub --- .../examples/Operations_List.json | 25 + ...nalRCustomCertificates_CreateOrUpdate.json | 44 + .../SignalRCustomCertificates_Delete.json | 13 + .../SignalRCustomCertificates_Get.json | 24 + .../SignalRCustomCertificates_List.json | 28 + .../SignalRCustomDomains_CreateOrUpdate.json | 36 + .../examples/SignalRCustomDomains_Delete.json | 19 + .../examples/SignalRCustomDomains_Get.json | 24 + .../examples/SignalRCustomDomains_List.json | 28 + ...nalRPrivateEndpointConnections_Delete.json | 19 + ...SignalRPrivateEndpointConnections_Get.json | 39 + ...ignalRPrivateEndpointConnections_List.json | 42 + ...nalRPrivateEndpointConnections_Update.json | 52 + .../SignalRPrivateLinkResources_List.json | 57 + ...edPrivateLinkResources_CreateOrUpdate.json | 51 + ...ReplicaSharedPrivateLinkResources_Get.json | 26 + ...eplicaSharedPrivateLinkResources_List.json | 29 + .../SignalRReplicas_CreateOrUpdate.json | 89 + .../examples/SignalRReplicas_Delete.json | 13 + .../examples/SignalRReplicas_Get.json | 41 + .../examples/SignalRReplicas_List.json | 44 + .../examples/SignalRReplicas_Restart.json | 18 + .../examples/SignalRReplicas_Update.json | 89 + ...edPrivateLinkResources_CreateOrUpdate.json | 50 + ...nalRSharedPrivateLinkResources_Delete.json | 19 + ...SignalRSharedPrivateLinkResources_Get.json | 25 + ...ignalRSharedPrivateLinkResources_List.json | 28 + .../SignalR_CheckNameAvailability.json | 20 + .../examples/SignalR_CreateOrUpdate.json | 463 ++ .../examples/SignalR_Delete.json | 18 + .../examples/SignalR_Get.json | 184 + .../examples/SignalR_ListByResourceGroup.json | 187 + .../examples/SignalR_ListBySubscription.json | 186 + .../examples/SignalR_ListKeys.json | 13 + .../examples/SignalR_ListReplicaSkus.json | 101 + .../examples/SignalR_ListSkus.json | 100 + .../examples/SignalR_RegenerateKey.json | 23 + .../examples/SignalR_Restart.json | 17 + .../examples/SignalR_Update.json | 285 ++ .../examples/Usages_List.json | 36 + .../preview/2024-04-01-preview/signalr.json | 3813 +++++++++++++++ .../signalr/resource-manager/readme.go.md | 10 + .../signalr/resource-manager/readme.java.md | 14 + .../signalr/resource-manager/readme.md | 11 +- .../signalr/resource-manager/readme.ruby.md | 11 + .../examples/Operations_List.json | 25 + .../examples/Usages_List.json | 36 + ...bSubCustomCertificates_CreateOrUpdate.json | 44 + .../WebPubSubCustomCertificates_Delete.json | 13 + .../WebPubSubCustomCertificates_Get.json | 24 + .../WebPubSubCustomCertificates_List.json | 28 + ...WebPubSubCustomDomains_CreateOrUpdate.json | 36 + .../WebPubSubCustomDomains_Delete.json | 19 + .../examples/WebPubSubCustomDomains_Get.json | 24 + .../examples/WebPubSubCustomDomains_List.json | 28 + .../WebPubSubHubs_CreateOrUpdate.json | 142 + .../examples/WebPubSubHubs_Delete.json | 19 + .../examples/WebPubSubHubs_Get.json | 55 + .../examples/WebPubSubHubs_List.json | 58 + ...bSubPrivateEndpointConnections_Delete.json | 19 + ...bPubSubPrivateEndpointConnections_Get.json | 39 + ...PubSubPrivateEndpointConnections_List.json | 42 + ...bSubPrivateEndpointConnections_Update.json | 52 + .../WebPubSubPrivateLinkResources_List.json | 57 + ...edPrivateLinkResources_CreateOrUpdate.json | 51 + ...ReplicaSharedPrivateLinkResources_Get.json | 26 + ...eplicaSharedPrivateLinkResources_List.json | 29 + .../WebPubSubReplicas_CreateOrUpdate.json | 89 + .../examples/WebPubSubReplicas_Delete.json | 13 + .../examples/WebPubSubReplicas_Get.json | 41 + .../examples/WebPubSubReplicas_List.json | 44 + .../examples/WebPubSubReplicas_Restart.json | 18 + .../examples/WebPubSubReplicas_Update.json | 89 + ...edPrivateLinkResources_CreateOrUpdate.json | 50 + ...bSubSharedPrivateLinkResources_Delete.json | 19 + ...bPubSubSharedPrivateLinkResources_Get.json | 25 + ...PubSubSharedPrivateLinkResources_List.json | 28 + .../WebPubSub_CheckNameAvailability.json | 20 + .../examples/WebPubSub_CreateOrUpdate.json | 349 ++ .../examples/WebPubSub_Delete.json | 18 + .../examples/WebPubSub_Get.json | 149 + .../WebPubSub_ListByResourceGroup.json | 152 + .../WebPubSub_ListBySubscription.json | 151 + .../examples/WebPubSub_ListKeys.json | 13 + .../examples/WebPubSub_ListReplicaSkus.json | 101 + .../examples/WebPubSub_ListSkus.json | 100 + .../examples/WebPubSub_RegenerateKey.json | 23 + .../examples/WebPubSub_Restart.json | 17 + .../examples/WebPubSub_Update.json | 206 + .../preview/2024-04-01-preview/webpubsub.json | 4125 +++++++++++++++++ .../webpubsub/resource-manager/readme.go.md | 12 +- .../webpubsub/resource-manager/readme.java.md | 14 + .../webpubsub/resource-manager/readme.md | 11 +- .../webpubsub/resource-manager/readme.ruby.md | 11 + 94 files changed, 13215 insertions(+), 3 deletions(-) create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Operations_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateLinkResources_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Restart.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_CheckNameAvailability.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListByResourceGroup.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListBySubscription.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListKeys.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListReplicaSkus.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListSkus.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_RegenerateKey.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Restart.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Usages_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/signalr.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Operations_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Usages_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateLinkResources_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Restart.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Update.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_CheckNameAvailability.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListByResourceGroup.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListBySubscription.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListKeys.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListReplicaSkus.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListSkus.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_RegenerateKey.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Restart.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Update.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/webpubsub.json diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Operations_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..0886ae4a86be --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SignalRService/SignalR/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.SignalRService", + "resource": "SignalR", + "operation": "Manage SignalR (read-only)", + "description": "View the resource settings and configurations in the management portal or through API" + }, + "properties": {} + } + ], + "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_CreateOrUpdate.json new file mode 100644 index 000000000000..b20419f1e631 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_CreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "parameters": { + "properties": { + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/SignalR/customCertificates" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/SignalR/customCertificates" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_Delete.json new file mode 100644 index 000000000000..51b490519307 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "certificateName": "myCert" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_Get.json new file mode 100644 index 000000000000..4a9c21308674 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/SignalR/customCertificates" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_List.json new file mode 100644 index 000000000000..baabf4f8e2ec --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomCertificates_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/SignalR/customCertificates" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_CreateOrUpdate.json new file mode 100644 index 000000000000..dc8e1e8b90e9 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "parameters": { + "properties": { + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert" + } + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "name": "myDomain" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customDomains/myDomain", + "name": "myDomain" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_Delete.json new file mode 100644 index 000000000000..5ec18cd59c53 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "name": "example" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_Get.json new file mode 100644 index 000000000000..0bd684bcd931 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "name": "example" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customDomains/myDomain", + "name": "myDomain" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_List.json new file mode 100644 index 000000000000..f4040a375eb6 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRCustomDomains_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "name": "myDomain" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customDomains/myDomain", + "name": "myDomain" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..f41e94e52390 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..c1f37c2850ef --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "signalr" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_List.json new file mode 100644 index 000000000000..e098c3122bc1 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "signalr" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..53e0f7868994 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateEndpointConnections_Update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "parameters": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "signalr" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateLinkResources_List.json new file mode 100644 index 000000000000..dc64fdf51852 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRPrivateLinkResources_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "signalr", + "requiredMembers": [ + "signalr" + ], + "requiredZoneNames": [ + "privatelink.service.signalr.net" + ], + "shareablePrivateLinkResourceTypes": [ + { + "name": "site", + "properties": { + "description": "Azure App Service can be used as an upstream", + "groupId": "sites", + "type": "Microsoft.Web/sites" + } + }, + { + "name": "vault", + "properties": { + "description": "Azure Key Vault can be used as credentials store", + "groupId": "vault", + "type": "Microsoft.KeyVault/vaults" + } + }, + { + "name": "table", + "properties": { + "description": "Azure Storage Table can be used as message store", + "groupId": "table", + "type": "Microsoft.Storage/storageAccounts" + } + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateLinkResources/myPrivateLink", + "name": "myPrivateLink", + "type": "privateLinkResources" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..784f6a26eff6 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..c0b5851806c6 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..61f2c355c9f1 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_CreateOrUpdate.json new file mode 100644 index 000000000000..2d9b19ca6b0b --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Delete.json new file mode 100644 index 000000000000..647328ba9798 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Get.json new file mode 100644 index 000000000000..fb61c5ad69ba --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_List.json new file mode 100644 index 000000000000..f8a35f5b2992 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Restart.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Restart.json new file mode 100644 index 000000000000..3b909cdf10de --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Restart.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Update.json new file mode 100644 index 000000000000..b710edab7add --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRReplicas_Update.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "202": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..faa39bad2b1f --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json new file mode 100644 index 000000000000..0734f4d0b427 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..ae769007caca --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..f58752ead5c9 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalRSharedPrivateLinkResources_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_CheckNameAvailability.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_CheckNameAvailability.json new file mode 100644 index 000000000000..ab3b1d7c67a1 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "parameters": { + "type": "Microsoft.SignalRService/SignalR", + "name": "mySignalRService" + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The name is already taken. Please try a different name." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_CreateOrUpdate.json new file mode 100644 index 000000000000..890693ac7296 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_CreateOrUpdate.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "api://example" + } + } + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Delete.json new file mode 100644 index 000000000000..56fbd96b99f2 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Get.json new file mode 100644 index 000000000000..b8b90a51a38a --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Get.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListByResourceGroup.json new file mode 100644 index 000000000000..5375cecf2e04 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListByResourceGroup.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListBySubscription.json new file mode 100644 index 000000000000..c29b46677832 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListBySubscription.json @@ -0,0 +1,186 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListKeys.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListKeys.json new file mode 100644 index 000000000000..546574dcf15e --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListReplicaSkus.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListReplicaSkus.json new file mode 100644 index 000000000000..4d5bb9caec1f --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListReplicaSkus.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.SignalRService/SignalR/replicas", + "sku": { + "name": "Free_F1", + "tier": "Free" + }, + "capacity": { + "minimum": 0, + "maximum": 1, + "default": 1, + "allowedValues": [ + 1 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/SignalR/replicas", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/SignalR/replicas", + "sku": { + "name": "Premium_P1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Automatic" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListSkus.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListSkus.json new file mode 100644 index 000000000000..cca51b44733c --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_ListSkus.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.SignalRService/SignalR", + "sku": { + "name": "Free_F1", + "tier": "Free" + }, + "capacity": { + "minimum": 0, + "maximum": 1, + "default": 1, + "allowedValues": [ + 1 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/SignalR", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/SignalR/replicas", + "sku": { + "name": "Premium_P1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Automatic" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_RegenerateKey.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_RegenerateKey.json new file mode 100644 index 000000000000..356f13f636a9 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_RegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "parameters": { + "keyType": "Primary" + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "body": {}, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Restart.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Restart.json new file mode 100644 index 000000000000..90014383d0a2 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Restart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Update.json new file mode 100644 index 000000000000..134ed3ce7160 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/SignalR_Update.json @@ -0,0 +1,285 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "api://example" + } + } + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Usages_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Usages_List.json new file mode 100644 index 000000000000..e04527b26478 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Usages_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage1", + "localizedValue": "Usage1" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage2", + "localizedValue": "Usage2" + }, + "unit": "Count" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/signalr.json new file mode 100644 index 000000000000..85932187a00d --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/signalr.json @@ -0,0 +1,3813 @@ +{ + "swagger": "2.0", + "info": { + "title": "SignalRManagementClient", + "description": "REST API for Azure SignalR Service", + "version": "2024-04-01-preview" + }, + "paths": { + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Checks that the resource name is valid and is not already in use.", + "operationId": "SignalR_CheckNameAvailability", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "location", + "description": "the region", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters supplied to the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_CheckNameAvailability": { + "$ref": "./examples/SignalR_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List resource usage quotas by location.", + "operationId": "Usages_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "location", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRUsageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usages_List": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "SignalR_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in the subscription.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListBySubscription": { + "$ref": "./examples/SignalR_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "SignalR_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in a resourceGroup.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListByResourceGroup": { + "$ref": "./examples/SignalR_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the resource and its properties.", + "operationId": "SignalR_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding resource.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_Get": { + "$ref": "./examples/SignalR_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a resource.", + "operationId": "SignalR_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "201": { + "description": "Created. The response describes the new resource and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalR_CreateOrUpdate": { + "$ref": "./examples/SignalR_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Operation to delete a resource.", + "operationId": "SignalR_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalR_Delete": { + "$ref": "./examples/SignalR_Delete.json" + } + } + }, + "patch": { + "tags": [ + "SignalR" + ], + "description": "Operation to update an exiting resource.", + "operationId": "SignalR_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result..", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalR_Update": { + "$ref": "./examples/SignalR_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all custom certificates.", + "operationId": "SignalRCustomCertificates_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes custom certificates of the resource.", + "schema": { + "$ref": "#/definitions/CustomCertificateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRCustomCertificates_List": { + "$ref": "./examples/SignalRCustomCertificates_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get a custom certificate.", + "operationId": "SignalRCustomCertificates_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding custom certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRCustomCertificates_Get": { + "$ref": "./examples/SignalRCustomCertificates_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a custom certificate.", + "operationId": "SignalRCustomCertificates_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "201": { + "description": "Created. The response describes the certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRCustomCertificates_CreateOrUpdate": { + "$ref": "./examples/SignalRCustomCertificates_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete a custom certificate.", + "operationId": "SignalRCustomCertificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRCustomCertificates_Delete": { + "$ref": "./examples/SignalRCustomCertificates_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all custom domains.", + "operationId": "SignalRCustomDomains_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes custom domains of the resource.", + "schema": { + "$ref": "#/definitions/CustomDomainList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRCustomDomains_List": { + "$ref": "./examples/SignalRCustomDomains_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get a custom domain.", + "operationId": "SignalRCustomDomains_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding custom domain.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRCustomDomains_Get": { + "$ref": "./examples/SignalRCustomDomains_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a custom domain.", + "operationId": "SignalRCustomDomains_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + } + ], + "responses": { + "201": { + "description": "Created. The response describes the custom domain and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRCustomDomains_CreateOrUpdate": { + "$ref": "./examples/SignalRCustomDomains_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete a custom domain.", + "operationId": "SignalRCustomDomains_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the custom domain is deleted." + }, + "202": { + "description": "Accepted. The response indicates the operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the custom domain is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRCustomDomains_Delete": { + "$ref": "./examples/SignalRCustomDomains_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Get the access keys of the resource.", + "operationId": "SignalR_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes access keys of the resource.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_ListKeys": { + "$ref": "./examples/SignalR_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List private endpoint connections", + "operationId": "SignalRPrivateEndpointConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_List": { + "$ref": "./examples/SignalRPrivateEndpointConnections_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified private endpoint connection", + "operationId": "SignalRPrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Get": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Update the state of specified private endpoint connection", + "operationId": "SignalRPrivateEndpointConnections_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "in": "body", + "name": "parameters", + "description": "The resource of private endpoint and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Update": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Update.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete the specified private endpoint connection", + "operationId": "SignalRPrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Delete": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the private link resources that need to be created for a resource.", + "operationId": "SignalRPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRPrivateLinkResources_List": { + "$ref": "./examples/SignalRPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "SignalR_RegenerateKey", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "202": { + "description": "Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalR_RegenerateKey": { + "$ref": "./examples/SignalR_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all replicas belong to this resource", + "operationId": "SignalRReplicas_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes replicas of the resource.", + "schema": { + "$ref": "#/definitions/ReplicaList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRReplicas_List": { + "$ref": "./examples/SignalRReplicas_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the replica and its properties.", + "operationId": "SignalRReplicas_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRReplicas_Get": { + "$ref": "./examples/SignalRReplicas_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a replica.", + "operationId": "SignalRReplicas_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Updated. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "201": { + "description": "Created. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRReplicas_CreateOrUpdate": { + "$ref": "./examples/SignalRReplicas_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Operation to delete a replica.", + "operationId": "SignalRReplicas_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the replica is deleted." + }, + "204": { + "description": "Success. The response indicates the replica is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRReplicas_Delete": { + "$ref": "./examples/SignalRReplicas_Delete.json" + } + } + }, + "patch": { + "tags": [ + "SignalR" + ], + "description": "Operation to update an exiting replica.", + "operationId": "SignalRReplicas_Update", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "202": { + "description": "Updated. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRReplicas_Update": { + "$ref": "./examples/SignalRReplicas_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/restart": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Operation to restart a replica.", + "operationId": "SignalRReplicas_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRReplicas_Restart": { + "$ref": "./examples/SignalRReplicas_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List shared private link resources", + "operationId": "SignalRReplicaSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRReplicaSharedPrivateLinkResources_List": { + "$ref": "./examples/SignalRReplicaSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified shared private link resource", + "operationId": "SignalRReplicaSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRReplicaSharedPrivateLinkResources_Get": { + "$ref": "./examples/SignalRReplicaSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a shared private link resource", + "operationId": "SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/skus": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all available skus of the replica resource.", + "operationId": "SignalR_ListReplicaSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all available skus of the replica resource.", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_ListReplicaSkus": { + "$ref": "./examples/SignalR_ListReplicaSkus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Operation to restart a resource.", + "operationId": "SignalR_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalR_Restart": { + "$ref": "./examples/SignalR_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List shared private link resources", + "operationId": "SignalRSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_List": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified shared private link resource", + "operationId": "SignalRSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_Get": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a shared private link resource", + "operationId": "SignalRSharedPrivateLinkResources_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete the specified shared private link resource", + "operationId": "SignalRSharedPrivateLinkResources_Delete", + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_Delete": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/skus": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all available skus of the resource.", + "operationId": "SignalR_ListSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all available skus of the resource.", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_ListSkus": { + "$ref": "./examples/SignalR_ListSkus.json" + } + } + } + } + }, + "definitions": { + "ACLAction": { + "description": "Azure Networking ACL Action.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "ACLAction", + "modelAsString": true + } + }, + "ApplicationFirewallSettings": { + "description": "Application firewall settings for the resource", + "type": "object", + "properties": { + "clientConnectionCountRules": { + "description": "Rules to control the client connection count", + "maxItems": 10, + "type": "array", + "items": { + "$ref": "#/definitions/ClientConnectionCountRule" + }, + "x-ms-identifiers": [] + } + } + }, + "ClientConnectionCountRule": { + "description": "A base class for client connection count rules", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "ThrottleByJwtSignatureRule", + "ThrottleByUserIdRule", + "ThrottleByJwtCustomClaimRule" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientConnectionCountRuleDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "CustomCertificate": { + "description": "A custom certificate.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomCertificateProperties" + } + } + }, + "CustomCertificateList": { + "description": "Custom certificates list.", + "type": "object", + "properties": { + "value": { + "description": "List of custom certificates of this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomCertificate" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomCertificateProperties": { + "description": "Custom certificate properties.", + "required": [ + "keyVaultBaseUri", + "keyVaultSecretName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "keyVaultBaseUri": { + "description": "Base uri of the KeyVault that stores certificate.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretName": { + "description": "Certificate secret name.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretVersion": { + "description": "Certificate secret version.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "CustomDomain": { + "description": "A custom domain", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainList": { + "description": "Custom domains list", + "type": "object", + "properties": { + "value": { + "description": "List of custom domains that bind to this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomDomainProperties": { + "description": "Properties of a custom domain.", + "required": [ + "customCertificate", + "domainName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "domainName": { + "description": "The custom domain name.", + "type": "string" + }, + "customCertificate": { + "$ref": "#/definitions/ResourceReference" + } + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "FeatureFlags": { + "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableMessagingLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: \"true\"/\"false\", to enable/disable live trace feature.", + "enum": [ + "ServiceMode", + "EnableConnectivityLogs", + "EnableMessagingLogs", + "EnableLiveTrace" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureFlags", + "modelAsString": true + } + }, + "IPRule": { + "description": "An IP rule", + "type": "object", + "properties": { + "value": { + "description": "An IP or CIDR or ServiceTag", + "type": "string" + }, + "action": { + "$ref": "#/definitions/ACLAction" + } + } + }, + "KeyType": { + "description": "The type of access key.", + "enum": [ + "Primary", + "Secondary", + "Salt" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + }, + "LiveTraceCategory": { + "description": "Live trace category configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.", + "type": "string" + } + } + }, + "LiveTraceConfiguration": { + "description": "Live trace configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "enabled": { + "description": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in \"categories\".\r\nAvailable values: true, false.\r\nCase insensitive.", + "default": "false", + "type": "string" + }, + "categories": { + "description": "Gets or sets the list of category configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/LiveTraceCategory" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "LogSpecification": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log.", + "type": "string" + } + } + }, + "ManagedIdentity": { + "description": "A class represent managed identities used for request and response", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityType" + }, + "userAssignedIdentities": { + "description": "Get or set the user assigned identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentityProperty" + } + }, + "principalId": { + "description": "Get the principal id for the system assigned identity.\r\nOnly be used in response.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Get the tenant id for the system assigned identity.\r\nOnly be used in response", + "type": "string", + "readOnly": true + } + } + }, + "ManagedIdentitySettings": { + "description": "Managed identity settings for upstream.", + "type": "object", + "properties": { + "resource": { + "description": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token.", + "type": "string" + } + } + }, + "ManagedIdentityType": { + "description": "Represents the identity type: systemAssigned, userAssigned, None", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Can be \"Microsoft.SignalRService/SignalR\", \"Microsoft.SignalRService/WebPubSub\", \"Microsoft.SignalRService/SignalR/replicas\" or \"Microsoft.SignalRService/WebPubSub/replicas\"", + "type": "string" + }, + "name": { + "description": "The resource name to validate. e.g.\"my-resource-name\"", + "type": "string" + } + } + }, + "NetworkACL": { + "description": "Network ACL", + "type": "object", + "properties": { + "allow": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + }, + "x-ms-identifiers": [] + }, + "deny": { + "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + }, + "x-ms-identifiers": [] + } + } + }, + "Operation": { + "description": "REST API operation supported by resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "If the operation is a data action. (for data plane rbac)", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "PrivateEndpoint": { + "description": "Private endpoint", + "type": "object", + "properties": { + "id": { + "description": "Full qualified Id of the private endpoint", + "type": "string" + } + } + }, + "PrivateEndpointACL": { + "description": "ACL for a private endpoint", + "required": [ + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkACL" + } + ], + "properties": { + "name": { + "description": "Name of the private endpoint connection", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection to an azure resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + } + }, + "PrivateEndpointConnectionList": { + "description": "A list of private endpoint connections", + "type": "object", + "properties": { + "value": { + "description": "The list of the private endpoint connections", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "groupIds": { + "description": "Group IDs", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + } + }, + "PrivateLinkResource": { + "description": "Private link resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkResourceProperties" + } + } + }, + "PrivateLinkResourceList": { + "description": "Contains a list of PrivateLinkResource and a possible link to query more results", + "type": "object", + "properties": { + "value": { + "description": "List of PrivateLinkResource", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Private link resource properties", + "type": "object", + "properties": { + "groupId": { + "description": "Group Id of the private link resource", + "type": "string" + }, + "requiredMembers": { + "description": "Required members of the private link resource", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "requiredZoneNames": { + "description": "Required private DNS zone names", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "shareablePrivateLinkResourceTypes": { + "description": "The list of resources that are onboarded to private link service", + "type": "array", + "items": { + "$ref": "#/definitions/ShareablePrivateLinkResourceType" + }, + "x-ms-identifiers": [] + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Connection state of the private endpoint connection", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus" + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStatus": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "ProvisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType" + } + } + }, + "Replica": { + "description": "A class represent a replica resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReplicaProperties" + } + } + }, + "ReplicaList": { + "type": "object", + "properties": { + "value": { + "description": "List of the replica", + "type": "array", + "items": { + "$ref": "#/definitions/Replica" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ReplicaProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.", + "default": "Enabled", + "type": "string" + }, + "resourceStopped": { + "description": "Stop or start the resource. Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" + } + } + }, + "ResourceLogCategory": { + "description": "Resource log category configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.", + "type": "string" + } + } + }, + "ResourceLogConfiguration": { + "description": "Resource log configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "categories": { + "description": "Gets or sets the list of category configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceLogCategory" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ResourceReference": { + "description": "Reference to a resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "The billing information of the resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2", + "type": "string" + }, + "tier": { + "$ref": "#/definitions/SignalRSkuTier" + }, + "size": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n Free_F1: 1;\r\n Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P2: 100,200,300,400,500,600,700,800,900,1000;", + "type": "integer" + } + } + }, + "ScaleType": { + "description": "The scale type applicable to the sku.", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "type": "string", + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true + } + }, + "ServerlessSettings": { + "description": "Serverless settings.", + "type": "object", + "properties": { + "connectionTimeoutInSeconds": { + "format": "int32", + "description": "Gets or sets Client Connection Timeout. Optional to be set.\r\nValue in seconds.\r\nDefault value is 30 seconds.\r\nCustomer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals,\r\nand want the client to disconnect more quickly after the last message is sent.\r\nYou can set the timeout to a longer period if messages are expected to be sent in longer intervals,\r\nand they want to keep the same client connection alive during this session.\r\nThe service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval.", + "default": 30, + "maximum": 120, + "minimum": 1, + "type": "integer" + } + } + }, + "ServerlessUpstreamSettings": { + "description": "The settings for the Upstream when the service is in server-less mode.", + "type": "object", + "properties": { + "templates": { + "description": "Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.", + "type": "array", + "items": { + "$ref": "#/definitions/UpstreamTemplate" + }, + "x-ms-identifiers": [] + } + } + }, + "ServiceKind": { + "description": "The kind of the service", + "enum": [ + "SignalR", + "RawWebSockets" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name", + "unit" + ] + }, + "logSpecifications": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ShareablePrivateLinkResourceProperties": { + "description": "Describes the properties of a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "description": { + "description": "The description of the resource type that has been onboarded to private link service", + "type": "string" + }, + "groupId": { + "description": "The resource provider group id for the resource that has been onboarded to private link service", + "type": "string" + }, + "type": { + "description": "The resource provider type for the resource that has been onboarded to private link service", + "type": "string" + } + } + }, + "ShareablePrivateLinkResourceType": { + "description": "Describes a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource type that has been onboarded to private link service", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ShareablePrivateLinkResourceProperties" + } + } + }, + "SharedPrivateLinkResource": { + "description": "Describes a Shared Private Link Resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + } + } + }, + "SharedPrivateLinkResourceList": { + "description": "A list of shared private link resources", + "type": "object", + "properties": { + "value": { + "description": "The list of the shared private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "SharedPrivateLinkResourceProperties": { + "description": "Describes the properties of an existing Shared Private Link Resource", + "required": [ + "groupId", + "privateLinkResourceId" + ], + "type": "object", + "properties": { + "groupId": { + "description": "The group id from the provider of resource the shared private link resource is for", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The resource id of the resource the shared private link resource is for", + "type": "string" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "requestMessage": { + "description": "The request message for requesting approval of the shared private link resource", + "type": "string" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/SharedPrivateLinkResourceStatus" + } + } + }, + "SharedPrivateLinkResourceStatus": { + "description": "Status of the shared private link resource", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": true + } + }, + "SignalRCorsSettings": { + "description": "Cross-Origin Resource Sharing (CORS) settings.", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use \"*\" to allow all. If omitted, allow all by default.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "SignalRFeature": { + "description": "Feature of a resource, which controls the runtime behavior.", + "required": [ + "flag", + "value" + ], + "type": "object", + "properties": { + "flag": { + "$ref": "#/definitions/FeatureFlags" + }, + "value": { + "description": "Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "properties": { + "description": "Optional properties related to this feature.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SignalRKeys": { + "description": "A class represents the access keys of the resource.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string", + "x-ms-secret": true + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string", + "x-ms-secret": true + }, + "primaryConnectionString": { + "description": "Connection string constructed via the primaryKey", + "type": "string", + "x-ms-secret": true + }, + "secondaryConnectionString": { + "description": "Connection string constructed via the secondaryKey", + "type": "string", + "x-ms-secret": true + } + } + }, + "SignalRNetworkACLs": { + "description": "Network ACLs for the resource", + "type": "object", + "properties": { + "defaultAction": { + "$ref": "#/definitions/ACLAction" + }, + "publicNetwork": { + "$ref": "#/definitions/NetworkACL" + }, + "privateEndpoints": { + "description": "ACLs for requests from private endpoints", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointACL" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "ipRules": { + "description": "IP rules for filtering public traffic", + "maxItems": 30, + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + }, + "x-ms-identifiers": [] + } + } + }, + "SignalRProperties": { + "description": "A class that describes the properties of the resource", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "externalIP": { + "description": "The publicly accessible IP of the resource.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the service instance.", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + }, + "version": { + "description": "Version of the resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "tls": { + "$ref": "#/definitions/SignalRTlsSettings" + }, + "hostNamePrefix": { + "description": "Deprecated.", + "type": "string", + "readOnly": true + }, + "features": { + "description": "List of the featureFlags.\r\n\r\nFeatureFlags that are not included in the parameters for the update operation will not be modified.\r\nAnd the response will only include featureFlags that are explicitly set. \r\nWhen a featureFlag is not explicitly set, its globally default value will be used\r\nBut keep in mind, the default value doesn't mean \"false\". It varies in terms of different FeatureFlags.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRFeature" + }, + "x-ms-identifiers": [] + }, + "liveTraceConfiguration": { + "$ref": "#/definitions/LiveTraceConfiguration" + }, + "resourceLogConfiguration": { + "$ref": "#/definitions/ResourceLogConfiguration" + }, + "cors": { + "$ref": "#/definitions/SignalRCorsSettings" + }, + "serverless": { + "$ref": "#/definitions/ServerlessSettings" + }, + "upstream": { + "$ref": "#/definitions/ServerlessUpstreamSettings" + }, + "networkACLs": { + "$ref": "#/definitions/SignalRNetworkACLs" + }, + "applicationFirewall": { + "$ref": "#/definitions/ApplicationFirewallSettings" + }, + "publicNetworkAccess": { + "description": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.", + "default": "Enabled", + "type": "string" + }, + "disableLocalAuth": { + "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", + "default": false, + "type": "boolean" + }, + "disableAadAuth": { + "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", + "default": false, + "type": "boolean" + }, + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.", + "default": "Enabled", + "type": "string" + }, + "resourceStopped": { + "description": "Stop or start the resource. Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" + } + } + }, + "SignalRRequestType": { + "description": "The incoming request type to the service", + "enum": [ + "ClientConnection", + "ServerConnection", + "RESTAPI", + "Trace" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRRequestType", + "modelAsString": true + } + }, + "SignalRResource": { + "description": "A class represent a resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SignalRProperties" + }, + "kind": { + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/ServiceKind" + }, + "identity": { + "$ref": "#/definitions/ManagedIdentity" + } + } + }, + "SignalRResourceList": { + "description": "Object that includes an array of resources and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resources", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRSkuTier": { + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRSkuTier", + "modelAsString": true + } + }, + "SignalRTlsSettings": { + "description": "TLS settings for the resource", + "type": "object", + "properties": { + "clientCertEnabled": { + "description": "Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier.", + "default": false, + "type": "boolean" + } + } + }, + "SignalRUsage": { + "description": "Object that describes a specific usage of the resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/SignalRUsageName" + }, + "unit": { + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", + "type": "string" + } + } + }, + "SignalRUsageList": { + "description": "Object that includes an array of the resource usages and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resource usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRUsage" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRUsageName": { + "description": "Localizable String object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "The identifier of the usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name of the usage.", + "type": "string" + } + } + }, + "Sku": { + "description": "Describes an available sku.\"", + "type": "object", + "properties": { + "resourceType": { + "description": "The resource type that this object applies to", + "type": "string", + "readOnly": true + }, + "sku": { + "readOnly": true, + "$ref": "#/definitions/ResourceSku" + }, + "capacity": { + "readOnly": true, + "$ref": "#/definitions/SkuCapacity" + } + } + }, + "SkuCapacity": { + "description": "Describes scaling information of a sku.", + "type": "object", + "properties": { + "minimum": { + "format": "int32", + "description": "The lowest permitted capacity for this resource", + "type": "integer", + "readOnly": true + }, + "maximum": { + "format": "int32", + "description": "The highest permitted capacity for this resource", + "type": "integer", + "readOnly": true + }, + "default": { + "format": "int32", + "description": "The default capacity.", + "type": "integer", + "readOnly": true + }, + "allowedValues": { + "description": "Allows capacity value list.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "scaleType": { + "readOnly": true, + "$ref": "#/definitions/ScaleType" + } + } + }, + "SkuList": { + "description": "The list skus operation response", + "type": "object", + "properties": { + "value": { + "description": "The list of skus available for the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "readOnly": true, + "x-ms-identifiers": [ + "resourceType", + "/sku/name", + "/sku/tier" + ] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string", + "readOnly": true + } + } + }, + "ThrottleByJwtCustomClaimRule": { + "description": "Throttle the client connection by a custom JWT claim", + "required": [ + "claimName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "claimName": { + "description": "The name of the claim in the JWT token. The client connection with the same claim value will be aggregated. If the claim is not found in the token, the connection will be allowed.", + "type": "string" + }, + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same Jwt claim value. Clients with the same Jwt claim will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByJwtCustomClaimRule" + }, + "ThrottleByJwtSignatureRule": { + "description": "Throttle the client connection by the JWT signature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same JWT signature. Clients with the same JWT signature will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByJwtSignatureRule" + }, + "ThrottleByUserIdRule": { + "description": "Throttle the client connection by the user ID", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same user ID. Clients with the same user ID will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByUserIdRule" + }, + "UpstreamAuthSettings": { + "description": "Upstream auth settings. If not set, no auth is used for upstream messages.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/UpstreamAuthType" + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentitySettings" + } + } + }, + "UpstreamAuthType": { + "description": "Upstream auth type enum.", + "enum": [ + "None", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "UpstreamAuthType", + "modelAsString": true + } + }, + "UpstreamTemplate": { + "description": "Upstream template item settings. It defines the Upstream URL of the incoming requests.\r\nThe template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.", + "required": [ + "urlTemplate" + ], + "type": "object", + "properties": { + "hubPattern": { + "description": "Gets or sets the matching pattern for hub names. If not set, it matches any hub.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any hub name.\r\n 2. Combine multiple hubs with \",\", for example \"hub1,hub2\", it matches \"hub1\" and \"hub2\".\r\n 3. The single hub name, for example, \"hub1\", it matches \"hub1\".", + "type": "string" + }, + "eventPattern": { + "description": "Gets or sets the matching pattern for event names. If not set, it matches any event.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name.\r\n 2. Combine multiple events with \",\", for example \"connect,disconnect\", it matches event \"connect\" and \"disconnect\".\r\n 3. The single event name, for example, \"connect\", it matches \"connect\".", + "type": "string" + }, + "categoryPattern": { + "description": "Gets or sets the matching pattern for category names. If not set, it matches any category.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any category name.\r\n 2. Combine multiple categories with \",\", for example \"connections,messages\", it matches category \"connections\" and \"messages\".\r\n 3. The single category name, for example, \"connections\", it matches the category \"connections\".", + "type": "string" + }, + "urlTemplate": { + "description": "Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.\r\nFor example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.", + "type": "string" + }, + "auth": { + "$ref": "#/definitions/UpstreamAuthSettings" + } + } + }, + "UserAssignedIdentityProperty": { + "description": "Properties of user assigned identity.", + "type": "object", + "properties": { + "principalId": { + "description": "Get the principal id for the user assigned identity", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Get the client id for the user assigned identity", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ResourceName": { + "in": "path", + "name": "resourceName", + "description": "The name of the resource.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ReplicaName": { + "in": "path", + "name": "replicaName", + "description": "The name of the replica.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "SharedPrivateLinkResourceName": { + "in": "path", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/signalr/resource-manager/readme.go.md b/specification/signalr/resource-manager/readme.go.md index 549e6abfb7c5..9117c41c08f3 100644 --- a/specification/signalr/resource-manager/readme.go.md +++ b/specification/signalr/resource-manager/readme.go.md @@ -44,6 +44,7 @@ batch: - tag: package-2023-08-01-preview - tag: package-2024-01-01-preview - tag: package-2024-03-01 + - tag: package-2024-04-01-preview ``` ### Tag: package-2018-03-01-preview and go @@ -188,4 +189,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2024-04-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2024-04-01-preview/$(namespace) ``` \ No newline at end of file diff --git a/specification/signalr/resource-manager/readme.java.md b/specification/signalr/resource-manager/readme.java.md index 36ff7d2eb406..7877e7add27c 100644 --- a/specification/signalr/resource-manager/readme.java.md +++ b/specification/signalr/resource-manager/readme.java.md @@ -32,6 +32,20 @@ batch: - tag: package-2023-08-01-preview - tag: package-2024-01-01-preview - tag: package-2024-03-01 + - tag: package-2024-04-01-preview +``` + +### Tag: package-2024-04-01-preview and java + +These settings apply only when `--tag=package-2024-04-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-04-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.signalr.v2024_04_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/signalr/mgmt-v2024_04_01_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2024-03-01 and java diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index fe84f6c27ab6..b5255f968d71 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the SignalR API. ``` yaml openapi-type: arm -tag: package-2024-03-01 +tag: package-2024-04-01-preview ``` ### Suppression @@ -71,6 +71,15 @@ directive: reason: It can introduce a breaking change when updating parameter order, since SignalR service has already shipped public versions. ``` +### Tag: package-2024-04-01-preview + +These settings apply only when `--tag=package-2024-04-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-04-01-preview' +input-file: +- Microsoft.SignalRService/preview/2024-04-01-preview/signalr.json +``` + ### Tag: package-2024-03-01 These settings apply only when `--tag=package-2024-03-01` is specified on the command line. diff --git a/specification/signalr/resource-manager/readme.ruby.md b/specification/signalr/resource-manager/readme.ruby.md index 546bced7cc55..e9cf352557d7 100644 --- a/specification/signalr/resource-manager/readme.ruby.md +++ b/specification/signalr/resource-manager/readme.ruby.md @@ -28,6 +28,17 @@ batch: - tag: package-2023-08-01-preview - tag: package-2024-01-01-preview - tag: package-2024-03-01 + - tag: package-2024-04-01-preview +``` + +### Tag: package-2024-04-01-preview and ruby + +These settings apply only when `--tag=package-2024-04-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-04-01-preview' && $(ruby) +namespace: "Azure::Signalr::Mgmt::V2024_04_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_signalr/lib ``` ### Tag: package-2024-03-01 and ruby diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Operations_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..afb4f4fd0437 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SignalRService/WebPubSub/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.SignalRService", + "resource": "WebPubSub", + "operation": "Manage WebPubSub (read-only)", + "description": "View the resource settings and configurations in the management portal or through API" + }, + "properties": {} + } + ], + "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Usages_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Usages_List.json new file mode 100644 index 000000000000..e04527b26478 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/Usages_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage1", + "localizedValue": "Usage1" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage2", + "localizedValue": "Usage2" + }, + "unit": "Count" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_CreateOrUpdate.json new file mode 100644 index 000000000000..270d490ea410 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_CreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "parameters": { + "properties": { + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/WebPubSub/customCertificates" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/WebPubSub/customCertificates" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_Delete.json new file mode 100644 index 000000000000..3fb4302915c7 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "certificateName": "myCert" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_Get.json new file mode 100644 index 000000000000..2b9ad9691e92 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/WebPubSub/customCertificates" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_List.json new file mode 100644 index 000000000000..6446e68cd019 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomCertificates_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/WebPubSub/customCertificates" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_CreateOrUpdate.json new file mode 100644 index 000000000000..f6a4a2d405cb --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "parameters": { + "properties": { + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert" + } + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "name": "myDomain" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customDomains/myDomain", + "name": "myDomain" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_Delete.json new file mode 100644 index 000000000000..e80dfd163638 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "name": "example" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_Get.json new file mode 100644 index 000000000000..872f5949f442 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "name": "example" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customDomains/myDomain", + "name": "myDomain" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_List.json new file mode 100644 index 000000000000..66925f277cd7 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubCustomDomains_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "name": "myDomain" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customDomains/myDomain", + "name": "myDomain" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_CreateOrUpdate.json new file mode 100644 index 000000000000..9ea931711974 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_CreateOrUpdate.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "parameters": { + "properties": { + "eventHandlers": [ + { + "urlTemplate": "http://host.com", + "userEventPattern": "*", + "systemEvents": [ + "connect", + "connected" + ], + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "abc" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "hubName": "exampleHub" + }, + "responses": { + "200": { + "body": { + "properties": { + "eventHandlers": [ + { + "urlTemplate": "http://host.com", + "userEventPattern": "*", + "systemEvents": [ + "connect", + "connected" + ], + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "abc" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub", + "name": "exampleHub", + "type": "Microsoft.SignalRService/WebPubSub/hubs" + } + }, + "201": { + "body": { + "properties": { + "eventHandlers": [ + { + "urlTemplate": "http://host.com", + "userEventPattern": "*", + "systemEvents": [ + "connect", + "connected" + ], + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "abc" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub", + "name": "exampleHub", + "type": "Microsoft.SignalRService/WebPubSub/hubs" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_Delete.json new file mode 100644 index 000000000000..088271d76dba --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "hubName": "exampleHub" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_Get.json new file mode 100644 index 000000000000..78be03925ebf --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "hubName": "exampleHub" + }, + "responses": { + "200": { + "body": { + "properties": { + "eventHandlers": [ + { + "urlTemplate": "http://host.com", + "userEventPattern": "*", + "systemEvents": [ + "connect", + "connected" + ], + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "abc" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub", + "name": "exampleHub", + "type": "Microsoft.SignalRService/WebPubSub/hubs" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_List.json new file mode 100644 index 000000000000..60315d54619c --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubHubs_List.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "eventHandlers": [ + { + "urlTemplate": "http://host.com", + "userEventPattern": "*", + "systemEvents": [ + "connect", + "connected" + ], + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "abc" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub", + "name": "exampleHub", + "type": "Microsoft.SignalRService/WebPubSub/hubs" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..86c1f40037f9 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..1719bc05107c --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "webpubsub" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json new file mode 100644 index 000000000000..ccea9b9f44b7 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "webpubsub" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..6b21d7dd4d3c --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "parameters": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "webpubsub" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateLinkResources_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateLinkResources_List.json new file mode 100644 index 000000000000..7e1988f7608f --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubPrivateLinkResources_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "webpubsub", + "requiredMembers": [ + "webpubsub" + ], + "requiredZoneNames": [ + "privatelink.webpubsub.azure.com" + ], + "shareablePrivateLinkResourceTypes": [ + { + "name": "site", + "properties": { + "description": "Azure App Service can be used as an upstream", + "groupId": "sites", + "type": "Microsoft.Web/sites" + } + }, + { + "name": "vault", + "properties": { + "description": "Azure Key Vault can be used as credentials store", + "groupId": "vault", + "type": "Microsoft.KeyVault/vaults" + } + }, + { + "name": "table", + "properties": { + "description": "Azure Storage Table can be used as message store", + "groupId": "table", + "type": "Microsoft.Storage/storageAccounts" + } + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateLinkResources/myPrivateLink", + "name": "myPrivateLink", + "type": "privateLinkResources" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..ab1918ef4a85 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..156e4b534742 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..4e1edfee4175 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_CreateOrUpdate.json new file mode 100644 index 000000000000..eb64b78c6a81 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Delete.json new file mode 100644 index 000000000000..49dd90f7a0e5 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Get.json new file mode 100644 index 000000000000..6aec9a5ef426 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_List.json new file mode 100644 index 000000000000..8c91d8771fc7 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Restart.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Restart.json new file mode 100644 index 000000000000..f5d0c2dcd46a --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Restart.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Update.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Update.json new file mode 100644 index 000000000000..5e5c73cb5d46 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubReplicas_Update.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "202": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..1a685e101e69 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json new file mode 100644 index 000000000000..916f43c58bb7 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..1290895fe395 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..2b85fc1874c4 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_CheckNameAvailability.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_CheckNameAvailability.json new file mode 100644 index 000000000000..cb842aef9964 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "parameters": { + "type": "Microsoft.SignalRService/WebPubSub", + "name": "myWebPubSubService" + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The name is already taken. Please try a different name." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_CreateOrUpdate.json new file mode 100644 index 000000000000..d6094ead9198 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_CreateOrUpdate.json @@ -0,0 +1,349 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Delete.json new file mode 100644 index 000000000000..ea70ec942783 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Get.json new file mode 100644 index 000000000000..aa94a4c542a0 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Get.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListByResourceGroup.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListByResourceGroup.json new file mode 100644 index 000000000000..d7487b82962b --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListByResourceGroup.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListBySubscription.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListBySubscription.json new file mode 100644 index 000000000000..17491f6012bb --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListBySubscription.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListKeys.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListKeys.json new file mode 100644 index 000000000000..dd175cd14c34 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListReplicaSkus.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListReplicaSkus.json new file mode 100644 index 000000000000..1b5653146879 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListReplicaSkus.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.SignalRService/WebPubSub/replicas", + "sku": { + "name": "Free_F1", + "tier": "Free" + }, + "capacity": { + "minimum": 0, + "maximum": 1, + "default": 1, + "allowedValues": [ + 1 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/WebPubSub/replicas", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/WebPubSub/replicas", + "sku": { + "name": "Premium_P1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Automatic" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListSkus.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListSkus.json new file mode 100644 index 000000000000..4212adfe1505 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_ListSkus.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.SignalRService/WebPubSub", + "sku": { + "name": "Free_F1", + "tier": "Free" + }, + "capacity": { + "minimum": 0, + "maximum": 1, + "default": 1, + "allowedValues": [ + 1 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/WebPubSub", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/WebPubSub/replicas", + "sku": { + "name": "Premium_P1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Automatic" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_RegenerateKey.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_RegenerateKey.json new file mode 100644 index 000000000000..29e273fc5969 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_RegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "parameters": { + "keyType": "Primary" + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "body": {}, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Restart.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Restart.json new file mode 100644 index 000000000000..fa8857cdaf0c --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Restart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Update.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Update.json new file mode 100644 index 000000000000..5df7abe167ec --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/examples/WebPubSub_Update.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/webpubsub.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/webpubsub.json new file mode 100644 index 000000000000..bf744125d0a4 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-04-01-preview/webpubsub.json @@ -0,0 +1,4125 @@ +{ + "swagger": "2.0", + "info": { + "title": "WebPubSubManagementClient", + "description": "REST API for Azure WebPubSub Service", + "version": "2024-04-01-preview" + }, + "paths": { + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Checks that the resource name is valid and is not already in use.", + "operationId": "WebPubSub_CheckNameAvailability", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "location", + "description": "the region", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters supplied to the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_CheckNameAvailability": { + "$ref": "./examples/WebPubSub_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List resource usage quotas by location.", + "operationId": "Usages_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "location", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRServiceUsageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usages_List": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "WebPubSub_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in the subscription.", + "schema": { + "$ref": "#/definitions/WebPubSubResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSub_ListBySubscription": { + "$ref": "./examples/WebPubSub_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "WebPubSub_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in a resourceGroup.", + "schema": { + "$ref": "#/definitions/WebPubSubResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSub_ListByResourceGroup": { + "$ref": "./examples/WebPubSub_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the resource and its properties.", + "operationId": "WebPubSub_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding resource.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_Get": { + "$ref": "./examples/WebPubSub_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a resource.", + "operationId": "WebPubSub_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "201": { + "description": "Created. The response describes the new resource and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSub_CreateOrUpdate": { + "$ref": "./examples/WebPubSub_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to delete a resource.", + "operationId": "WebPubSub_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSub_Delete": { + "$ref": "./examples/WebPubSub_Delete.json" + } + } + }, + "patch": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to update an exiting resource.", + "operationId": "WebPubSub_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result..", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSub_Update": { + "$ref": "./examples/WebPubSub_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all custom certificates.", + "operationId": "WebPubSubCustomCertificates_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes custom certificates of the resource.", + "schema": { + "$ref": "#/definitions/CustomCertificateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubCustomCertificates_List": { + "$ref": "./examples/WebPubSubCustomCertificates_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get a custom certificate.", + "operationId": "WebPubSubCustomCertificates_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding custom certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubCustomCertificates_Get": { + "$ref": "./examples/WebPubSubCustomCertificates_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a custom certificate.", + "operationId": "WebPubSubCustomCertificates_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "201": { + "description": "Created. The response describes the certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubCustomCertificates_CreateOrUpdate": { + "$ref": "./examples/WebPubSubCustomCertificates_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete a custom certificate.", + "operationId": "WebPubSubCustomCertificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubCustomCertificates_Delete": { + "$ref": "./examples/WebPubSubCustomCertificates_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all custom domains.", + "operationId": "WebPubSubCustomDomains_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes custom domains of the resource.", + "schema": { + "$ref": "#/definitions/CustomDomainList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubCustomDomains_List": { + "$ref": "./examples/WebPubSubCustomDomains_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get a custom domain.", + "operationId": "WebPubSubCustomDomains_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding custom domain.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubCustomDomains_Get": { + "$ref": "./examples/WebPubSubCustomDomains_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a custom domain.", + "operationId": "WebPubSubCustomDomains_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + } + ], + "responses": { + "201": { + "description": "Created. The response describes the custom domain and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubCustomDomains_CreateOrUpdate": { + "$ref": "./examples/WebPubSubCustomDomains_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete a custom domain.", + "operationId": "WebPubSubCustomDomains_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the custom domain is deleted." + }, + "202": { + "description": "Accepted. The response indicates the operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the custom domain is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubCustomDomains_Delete": { + "$ref": "./examples/WebPubSubCustomDomains_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List hub settings.", + "operationId": "WebPubSubHubs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes hub settings of the resource.", + "schema": { + "$ref": "#/definitions/WebPubSubHubList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubHubs_List": { + "$ref": "./examples/WebPubSubHubs_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get a hub setting.", + "operationId": "WebPubSubHubs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding hub setting.", + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubHubs_Get": { + "$ref": "./examples/WebPubSubHubs_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a hub setting.", + "operationId": "WebPubSubHubs_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "parameters", + "description": "The resource of WebPubSubHub and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK.The request makes no change. The response describes the existing hub setting.", + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + "201": { + "description": "Created. The response describes the hub setting and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubHubs_CreateOrUpdate": { + "$ref": "./examples/WebPubSubHubs_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete a hub setting.", + "operationId": "WebPubSubHubs_Delete", + "parameters": [ + { + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the hub setting is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubHubs_Delete": { + "$ref": "./examples/WebPubSubHubs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Get the access keys of the resource.", + "operationId": "WebPubSub_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes access keys of the resource.", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_ListKeys": { + "$ref": "./examples/WebPubSub_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List private endpoint connections", + "operationId": "WebPubSubPrivateEndpointConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_List": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Get": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Update the state of specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "in": "body", + "name": "parameters", + "description": "The resource of private endpoint and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Update": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Update.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete the specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Delete": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the private link resources that need to be created for a resource.", + "operationId": "WebPubSubPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "WebPubSub_RegenerateKey", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + } + }, + "202": { + "description": "Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSub_RegenerateKey": { + "$ref": "./examples/WebPubSub_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all replicas belong to this resource", + "operationId": "WebPubSubReplicas_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes replicas of the resource.", + "schema": { + "$ref": "#/definitions/ReplicaList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubReplicas_List": { + "$ref": "./examples/WebPubSubReplicas_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the replica and its properties.", + "operationId": "WebPubSubReplicas_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubReplicas_Get": { + "$ref": "./examples/WebPubSubReplicas_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a replica.", + "operationId": "WebPubSubReplicas_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Updated. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "201": { + "description": "Created. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubReplicas_CreateOrUpdate": { + "$ref": "./examples/WebPubSubReplicas_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to delete a replica.", + "operationId": "WebPubSubReplicas_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the replica is deleted." + }, + "204": { + "description": "Success. The response indicates the replica is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubReplicas_Delete": { + "$ref": "./examples/WebPubSubReplicas_Delete.json" + } + } + }, + "patch": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to update an exiting replica.", + "operationId": "WebPubSubReplicas_Update", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "202": { + "description": "Updated. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubReplicas_Update": { + "$ref": "./examples/WebPubSubReplicas_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/restart": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to restart a replica.", + "operationId": "WebPubSubReplicas_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubReplicas_Restart": { + "$ref": "./examples/WebPubSubReplicas_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List shared private link resources", + "operationId": "WebPubSubReplicaSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubReplicaSharedPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubReplicaSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified shared private link resource", + "operationId": "WebPubSubReplicaSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubReplicaSharedPrivateLinkResources_Get": { + "$ref": "./examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a shared private link resource", + "operationId": "WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/skus": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all available skus of the replica resource.", + "operationId": "WebPubSub_ListReplicaSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all available skus of the replica resource.", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_ListReplicaSkus": { + "$ref": "./examples/WebPubSub_ListReplicaSkus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to restart a resource.", + "operationId": "WebPubSub_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSub_Restart": { + "$ref": "./examples/WebPubSub_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List shared private link resources", + "operationId": "WebPubSubSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified shared private link resource", + "operationId": "WebPubSubSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_Get": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a shared private link resource", + "operationId": "WebPubSubSharedPrivateLinkResources_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete the specified shared private link resource", + "operationId": "WebPubSubSharedPrivateLinkResources_Delete", + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_Delete": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/skus": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all available skus of the resource.", + "operationId": "WebPubSub_ListSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all available skus of the resource.", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_ListSkus": { + "$ref": "./examples/WebPubSub_ListSkus.json" + } + } + } + } + }, + "definitions": { + "ACLAction": { + "description": "Azure Networking ACL Action.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "ACLAction", + "modelAsString": true + } + }, + "ApplicationFirewallSettings": { + "description": "Application firewall settings for the resource", + "type": "object", + "properties": { + "clientConnectionCountRules": { + "description": "Rules to control the client connection count", + "maxItems": 10, + "type": "array", + "items": { + "$ref": "#/definitions/ClientConnectionCountRule" + }, + "x-ms-identifiers": [] + } + } + }, + "ClientConnectionCountRule": { + "description": "A base class for client connection count rules", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "ThrottleByJwtSignatureRule", + "ThrottleByUserIdRule", + "ThrottleByJwtCustomClaimRule" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientConnectionCountRuleDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "CustomCertificate": { + "description": "A custom certificate.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomCertificateProperties" + } + } + }, + "CustomCertificateList": { + "description": "Custom certificates list.", + "type": "object", + "properties": { + "value": { + "description": "List of custom certificates of this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomCertificate" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomCertificateProperties": { + "description": "Custom certificate properties.", + "required": [ + "keyVaultBaseUri", + "keyVaultSecretName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "keyVaultBaseUri": { + "description": "Base uri of the KeyVault that stores certificate.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretName": { + "description": "Certificate secret name.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretVersion": { + "description": "Certificate secret version.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "CustomDomain": { + "description": "A custom domain", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainList": { + "description": "Custom domains list", + "type": "object", + "properties": { + "value": { + "description": "List of custom domains that bind to this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomDomainProperties": { + "description": "Properties of a custom domain.", + "required": [ + "customCertificate", + "domainName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "domainName": { + "description": "The custom domain name.", + "type": "string" + }, + "customCertificate": { + "$ref": "#/definitions/ResourceReference" + } + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "EventHandler": { + "description": "Properties of event handler.", + "required": [ + "urlTemplate" + ], + "type": "object", + "properties": { + "urlTemplate": { + "description": "Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in.\r\nFor example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters.", + "type": "string" + }, + "userEventPattern": { + "description": "Gets or sets the matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n 1. \"*\", it matches any event name\r\n 2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n 3. A single event name, for example, \"event1\", it matches \"event1\"", + "type": "string" + }, + "systemEvents": { + "description": "Gets or sets the list of system events.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "auth": { + "$ref": "#/definitions/UpstreamAuthSettings" + } + } + }, + "EventHubEndpoint": { + "description": "An Event Hub endpoint. \r\nThe managed identity of Web PubSub service must be enabled, and the identity should have the \"Azure Event Hubs Data sender\" role to access Event Hub.", + "required": [ + "eventHubName", + "fullyQualifiedNamespace" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventListenerEndpoint" + } + ], + "properties": { + "fullyQualifiedNamespace": { + "description": "The fully qualified namespace name of the Event Hub resource. For example, \"example.servicebus.windows.net\".", + "type": "string" + }, + "eventHubName": { + "description": "The name of the Event Hub.", + "type": "string" + } + }, + "x-ms-discriminator-value": "EventHub" + }, + "EventListener": { + "description": "A setting defines which kinds of events should be sent to which endpoint.", + "required": [ + "endpoint", + "filter" + ], + "type": "object", + "properties": { + "filter": { + "$ref": "#/definitions/EventListenerFilter" + }, + "endpoint": { + "$ref": "#/definitions/EventListenerEndpoint" + } + } + }, + "EventListenerEndpoint": { + "description": "An endpoint specifying where Web PubSub should send events to.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "EventHub" + ], + "type": "string", + "x-ms-enum": { + "name": "EventListenerEndpointDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "EventListenerFilter": { + "description": "A base class for event filter which determines whether an event should be sent to an event listener.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "EventName" + ], + "type": "string", + "x-ms-enum": { + "name": "EventListenerFilterDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "EventNameFilter": { + "description": "Filter events by their name.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventListenerFilter" + } + ], + "properties": { + "systemEvents": { + "description": "Gets or sets a list of system events. Supported events: \"connected\" and \"disconnected\". Blocking event \"connect\" is not supported because it requires a response.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "userEventPattern": { + "description": "Gets or sets a matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n 1. \"*\", it matches any event name\r\n 2. Combine multiple events with \",\", for example \"event1,event2\", it matches events \"event1\" and \"event2\"\r\n 3. A single event name, for example, \"event1\", it matches \"event1\"", + "type": "string" + } + }, + "x-ms-discriminator-value": "EventName" + }, + "IPRule": { + "description": "An IP rule", + "type": "object", + "properties": { + "value": { + "description": "An IP or CIDR or ServiceTag", + "type": "string" + }, + "action": { + "$ref": "#/definitions/ACLAction" + } + } + }, + "KeyType": { + "description": "The type of access key.", + "enum": [ + "Primary", + "Secondary", + "Salt" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + }, + "LiveTraceCategory": { + "description": "Live trace category configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.", + "type": "string" + } + } + }, + "LiveTraceConfiguration": { + "description": "Live trace configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "enabled": { + "description": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in \"categories\".\r\nAvailable values: true, false.\r\nCase insensitive.", + "default": "false", + "type": "string" + }, + "categories": { + "description": "Gets or sets the list of category configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/LiveTraceCategory" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "LogSpecification": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log.", + "type": "string" + } + } + }, + "ManagedIdentity": { + "description": "A class represent managed identities used for request and response", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityType" + }, + "userAssignedIdentities": { + "description": "Get or set the user assigned identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentityProperty" + } + }, + "principalId": { + "description": "Get the principal id for the system assigned identity.\r\nOnly be used in response.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Get the tenant id for the system assigned identity.\r\nOnly be used in response", + "type": "string", + "readOnly": true + } + } + }, + "ManagedIdentitySettings": { + "description": "Managed identity settings for upstream.", + "type": "object", + "properties": { + "resource": { + "description": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token.", + "type": "string" + } + } + }, + "ManagedIdentityType": { + "description": "Represents the identity type: systemAssigned, userAssigned, None", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Can be \"Microsoft.SignalRService/SignalR\", \"Microsoft.SignalRService/WebPubSub\", \"Microsoft.SignalRService/SignalR/replicas\" or \"Microsoft.SignalRService/WebPubSub/replicas\"", + "type": "string" + }, + "name": { + "description": "The resource name to validate. e.g.\"my-resource-name\"", + "type": "string" + } + } + }, + "NetworkACL": { + "description": "Network ACL", + "type": "object", + "properties": { + "allow": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubRequestType" + }, + "x-ms-identifiers": [] + }, + "deny": { + "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubRequestType" + }, + "x-ms-identifiers": [] + } + } + }, + "Operation": { + "description": "REST API operation supported by resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "If the operation is a data action. (for data plane rbac)", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "PrivateEndpoint": { + "description": "Private endpoint", + "type": "object", + "properties": { + "id": { + "description": "Full qualified Id of the private endpoint", + "type": "string" + } + } + }, + "PrivateEndpointACL": { + "description": "ACL for a private endpoint", + "required": [ + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkACL" + } + ], + "properties": { + "name": { + "description": "Name of the private endpoint connection", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection to an azure resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + } + }, + "PrivateEndpointConnectionList": { + "description": "A list of private endpoint connections", + "type": "object", + "properties": { + "value": { + "description": "The list of the private endpoint connections", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "groupIds": { + "description": "Group IDs", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + } + }, + "PrivateLinkResource": { + "description": "Private link resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkResourceProperties" + } + } + }, + "PrivateLinkResourceList": { + "description": "Contains a list of PrivateLinkResource and a possible link to query more results", + "type": "object", + "properties": { + "value": { + "description": "List of PrivateLinkResource", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Private link resource properties", + "type": "object", + "properties": { + "groupId": { + "description": "Group Id of the private link resource", + "type": "string" + }, + "requiredMembers": { + "description": "Required members of the private link resource", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "requiredZoneNames": { + "description": "Required private DNS zone names", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "shareablePrivateLinkResourceTypes": { + "description": "The list of resources that are onboarded to private link service", + "type": "array", + "items": { + "$ref": "#/definitions/ShareablePrivateLinkResourceType" + }, + "x-ms-identifiers": [] + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Connection state of the private endpoint connection", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus" + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStatus": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "ProvisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType" + } + } + }, + "Replica": { + "description": "A class represent a replica resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReplicaProperties" + } + } + }, + "ReplicaList": { + "type": "object", + "properties": { + "value": { + "description": "List of the replica", + "type": "array", + "items": { + "$ref": "#/definitions/Replica" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ReplicaProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.", + "default": "Enabled", + "type": "string" + }, + "resourceStopped": { + "description": "Stop or start the resource. Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" + } + } + }, + "ResourceLogCategory": { + "description": "Resource log category configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.", + "type": "string" + } + } + }, + "ResourceLogConfiguration": { + "description": "Resource log configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "categories": { + "description": "Gets or sets the list of category configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceLogCategory" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ResourceReference": { + "description": "Reference to a resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "The billing information of the resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2", + "type": "string" + }, + "tier": { + "$ref": "#/definitions/WebPubSubSkuTier" + }, + "size": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n Free_F1: 1;\r\n Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P2: 100,200,300,400,500,600,700,800,900,1000;", + "type": "integer" + } + } + }, + "ScaleType": { + "description": "The scale type applicable to the sku.", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "type": "string", + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true + } + }, + "ServiceKind": { + "description": "The kind of the service", + "enum": [ + "WebPubSub", + "SocketIO" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name", + "unit" + ] + }, + "logSpecifications": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ShareablePrivateLinkResourceProperties": { + "description": "Describes the properties of a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "description": { + "description": "The description of the resource type that has been onboarded to private link service", + "type": "string" + }, + "groupId": { + "description": "The resource provider group id for the resource that has been onboarded to private link service", + "type": "string" + }, + "type": { + "description": "The resource provider type for the resource that has been onboarded to private link service", + "type": "string" + } + } + }, + "ShareablePrivateLinkResourceType": { + "description": "Describes a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource type that has been onboarded to private link service", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ShareablePrivateLinkResourceProperties" + } + } + }, + "SharedPrivateLinkResource": { + "description": "Describes a Shared Private Link Resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + } + } + }, + "SharedPrivateLinkResourceList": { + "description": "A list of shared private link resources", + "type": "object", + "properties": { + "value": { + "description": "The list of the shared private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "SharedPrivateLinkResourceProperties": { + "description": "Describes the properties of an existing Shared Private Link Resource", + "required": [ + "groupId", + "privateLinkResourceId" + ], + "type": "object", + "properties": { + "groupId": { + "description": "The group id from the provider of resource the shared private link resource is for", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The resource id of the resource the shared private link resource is for", + "type": "string" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "requestMessage": { + "description": "The request message for requesting approval of the shared private link resource", + "type": "string" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/SharedPrivateLinkResourceStatus" + } + } + }, + "SharedPrivateLinkResourceStatus": { + "description": "Status of the shared private link resource", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": true + } + }, + "SignalRServiceUsage": { + "description": "Object that describes a specific usage of the resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/SignalRServiceUsageName" + }, + "unit": { + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", + "type": "string" + } + } + }, + "SignalRServiceUsageList": { + "description": "Object that includes an array of the resource usages and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resource usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRServiceUsage" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRServiceUsageName": { + "description": "Localizable String object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "The identifier of the usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name of the usage.", + "type": "string" + } + } + }, + "Sku": { + "description": "Describes an available sku.\"", + "type": "object", + "properties": { + "resourceType": { + "description": "The resource type that this object applies to", + "type": "string", + "readOnly": true + }, + "sku": { + "readOnly": true, + "$ref": "#/definitions/ResourceSku" + }, + "capacity": { + "readOnly": true, + "$ref": "#/definitions/SkuCapacity" + } + } + }, + "SkuCapacity": { + "description": "Describes scaling information of a sku.", + "type": "object", + "properties": { + "minimum": { + "format": "int32", + "description": "The lowest permitted capacity for this resource", + "type": "integer", + "readOnly": true + }, + "maximum": { + "format": "int32", + "description": "The highest permitted capacity for this resource", + "type": "integer", + "readOnly": true + }, + "default": { + "format": "int32", + "description": "The default capacity.", + "type": "integer", + "readOnly": true + }, + "allowedValues": { + "description": "Allows capacity value list.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "scaleType": { + "readOnly": true, + "$ref": "#/definitions/ScaleType" + } + } + }, + "SkuList": { + "description": "The list skus operation response", + "type": "object", + "properties": { + "value": { + "description": "The list of skus available for the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "readOnly": true, + "x-ms-identifiers": [ + "resourceType", + "/sku/name", + "/sku/tier" + ] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string", + "readOnly": true + } + } + }, + "ThrottleByJwtCustomClaimRule": { + "description": "Throttle the client connection by a custom JWT claim", + "required": [ + "claimName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "claimName": { + "description": "The name of the claim in the JWT token. The client connection with the same claim value will be aggregated. If the claim is not found in the token, the connection will be allowed.", + "type": "string" + }, + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same Jwt claim value. Clients with the same Jwt claim will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByJwtCustomClaimRule" + }, + "ThrottleByJwtSignatureRule": { + "description": "Throttle the client connection by the JWT signature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same JWT signature. Clients with the same JWT signature will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByJwtSignatureRule" + }, + "ThrottleByUserIdRule": { + "description": "Throttle the client connection by the user ID", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same user ID. Clients with the same user ID will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByUserIdRule" + }, + "UpstreamAuthSettings": { + "description": "Upstream auth settings. If not set, no auth is used for upstream messages.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/UpstreamAuthType" + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentitySettings" + } + } + }, + "UpstreamAuthType": { + "description": "Upstream auth type enum.", + "enum": [ + "None", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "UpstreamAuthType", + "modelAsString": true + } + }, + "UserAssignedIdentityProperty": { + "description": "Properties of user assigned identity.", + "type": "object", + "properties": { + "principalId": { + "description": "Get the principal id for the user assigned identity", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Get the client id for the user assigned identity", + "type": "string", + "readOnly": true + } + } + }, + "WebPubSubHub": { + "description": "A hub setting", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebPubSubHubProperties" + } + } + }, + "WebPubSubHubList": { + "description": "Hub setting list", + "type": "object", + "properties": { + "value": { + "description": "List of hub settings to this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubHub" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string", + "readOnly": true + } + } + }, + "WebPubSubHubProperties": { + "description": "Properties of a hub.", + "type": "object", + "properties": { + "eventHandlers": { + "description": "Event handler of a hub.", + "type": "array", + "items": { + "$ref": "#/definitions/EventHandler" + }, + "x-ms-identifiers": [] + }, + "eventListeners": { + "description": "Event listener settings for forwarding your client events to listeners.\r\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\r\nOne event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter.\r\nMaximum count of event listeners among all hubs is 10.", + "type": "array", + "items": { + "$ref": "#/definitions/EventListener" + }, + "x-ms-identifiers": [] + }, + "anonymousConnectPolicy": { + "description": "The settings for configuring if anonymous connections are allowed for this hub: \"allow\" or \"deny\". Default to \"deny\".", + "default": "deny", + "type": "string" + }, + "webSocketKeepAliveIntervalInSeconds": { + "format": "int32", + "description": "The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds.", + "default": 20, + "maximum": 120, + "minimum": 1, + "type": "integer" + } + } + }, + "WebPubSubKeys": { + "description": "A class represents the access keys of the resource.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string", + "x-ms-secret": true + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string", + "x-ms-secret": true + }, + "primaryConnectionString": { + "description": "Connection string constructed via the primaryKey", + "type": "string", + "x-ms-secret": true + }, + "secondaryConnectionString": { + "description": "Connection string constructed via the secondaryKey", + "type": "string", + "x-ms-secret": true + } + } + }, + "WebPubSubNetworkACLs": { + "description": "Network ACLs for the resource", + "type": "object", + "properties": { + "defaultAction": { + "$ref": "#/definitions/ACLAction" + }, + "publicNetwork": { + "$ref": "#/definitions/NetworkACL" + }, + "privateEndpoints": { + "description": "ACLs for requests from private endpoints", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointACL" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "ipRules": { + "description": "IP rules for filtering public traffic", + "maxItems": 30, + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + }, + "x-ms-identifiers": [] + } + } + }, + "WebPubSubProperties": { + "description": "A class that describes the properties of the resource", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "externalIP": { + "description": "The publicly accessible IP of the resource.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the service instance.", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + }, + "version": { + "description": "Version of the resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "tls": { + "$ref": "#/definitions/WebPubSubTlsSettings" + }, + "hostNamePrefix": { + "description": "Deprecated.", + "type": "string", + "readOnly": true + }, + "liveTraceConfiguration": { + "$ref": "#/definitions/LiveTraceConfiguration" + }, + "resourceLogConfiguration": { + "$ref": "#/definitions/ResourceLogConfiguration" + }, + "networkACLs": { + "$ref": "#/definitions/WebPubSubNetworkACLs" + }, + "applicationFirewall": { + "$ref": "#/definitions/ApplicationFirewallSettings" + }, + "publicNetworkAccess": { + "description": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.", + "default": "Enabled", + "type": "string" + }, + "disableLocalAuth": { + "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", + "default": false, + "type": "boolean" + }, + "disableAadAuth": { + "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", + "default": false, + "type": "boolean" + }, + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.", + "default": "Enabled", + "type": "string" + }, + "resourceStopped": { + "description": "Stop or start the resource. Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" + }, + "socketIO": { + "$ref": "#/definitions/WebPubSubSocketIOSettings" + } + } + }, + "WebPubSubRequestType": { + "description": "The incoming request type to the service", + "enum": [ + "ClientConnection", + "ServerConnection", + "RESTAPI", + "Trace" + ], + "type": "string", + "x-ms-enum": { + "name": "WebPubSubRequestType", + "modelAsString": true + } + }, + "WebPubSubResource": { + "description": "A class represent a resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebPubSubProperties" + }, + "kind": { + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/ServiceKind" + }, + "identity": { + "$ref": "#/definitions/ManagedIdentity" + } + } + }, + "WebPubSubResourceList": { + "description": "Object that includes an array of resources and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resources", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "WebPubSubSkuTier": { + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "WebPubSubSkuTier", + "modelAsString": true + } + }, + "WebPubSubSocketIOSettings": { + "description": "SocketIO settings for the resource", + "type": "object", + "properties": { + "serviceMode": { + "description": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server", + "type": "string" + } + } + }, + "WebPubSubTlsSettings": { + "description": "TLS settings for the resource", + "type": "object", + "properties": { + "clientCertEnabled": { + "description": "Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier.", + "default": false, + "type": "boolean" + } + } + } + }, + "parameters": { + "ResourceName": { + "in": "path", + "name": "resourceName", + "description": "The name of the resource.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ReplicaName": { + "in": "path", + "name": "replicaName", + "description": "The name of the replica.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "SharedPrivateLinkResourceName": { + "in": "path", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/webpubsub/resource-manager/readme.go.md b/specification/webpubsub/resource-manager/readme.go.md index 862665d9edd5..cb89ad59d2d9 100644 --- a/specification/webpubsub/resource-manager/readme.go.md +++ b/specification/webpubsub/resource-manager/readme.go.md @@ -39,6 +39,7 @@ batch: - tag: package-2023-08-01-preview - tag: package-2024-01-01-preview - tag: package-2024-03-01 + - tag: package-2024-04-01-preview ``` ### Tag: package-2021-04-01-preview and go @@ -139,4 +140,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2024-04-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2024-04-01-preview/$(namespace) +``` diff --git a/specification/webpubsub/resource-manager/readme.java.md b/specification/webpubsub/resource-manager/readme.java.md index 99e5400de83c..10ebb4d72789 100644 --- a/specification/webpubsub/resource-manager/readme.java.md +++ b/specification/webpubsub/resource-manager/readme.java.md @@ -27,6 +27,7 @@ batch: - tag: package-2023-08-01-preview - tag: package-2024-01-01-preview - tag: package-2024-03-01 + - tag: package-2024-04-01-preview ``` ### Tag: package-2021-04-01-preview and java @@ -170,4 +171,17 @@ java: output-folder: $(azure-libraries-for-java-folder)/sdk/webpubsub/mgmt-v2024_03_01 regenerate-manager: true generate-interface: true +``` + +### Tag: package-2024-04-01-preview and java + +These settings apply only when `--tag=package-2024-04-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-04-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.webpubsub.v2024_04_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/webpubsub/mgmt-v2024_04_01_preview +regenerate-manager: true +generate-interface: true ``` \ No newline at end of file diff --git a/specification/webpubsub/resource-manager/readme.md b/specification/webpubsub/resource-manager/readme.md index 898cdb1808de..b255818ce72d 100644 --- a/specification/webpubsub/resource-manager/readme.md +++ b/specification/webpubsub/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the WebPubSub API. ``` yaml openapi-type: arm -tag: package-2024-03-01 +tag: package-2024-04-01-preview ``` ### Suppression @@ -170,6 +170,15 @@ input-file: - Microsoft.SignalRService/stable/2024-03-01/webpubsub.json ``` +### Tag: package-2024-04-01-preview + +These settings apply only when `--tag=package-2024-04-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-04-01-preview' +input-file: +- Microsoft.SignalRService/preview/2024-04-01-preview/webpubsub.json +``` + --- # Code Generation diff --git a/specification/webpubsub/resource-manager/readme.ruby.md b/specification/webpubsub/resource-manager/readme.ruby.md index 37e3f818df4a..04bbc2eabc2d 100644 --- a/specification/webpubsub/resource-manager/readme.ruby.md +++ b/specification/webpubsub/resource-manager/readme.ruby.md @@ -23,6 +23,7 @@ batch: - tag: package-2023-08-01-preview - tag: package-2024-01-01-preview - tag: package-2024-03-01 + - tag: package-2024-04-01-preview ``` ### Tag: package-2021-04-01-preview and ruby @@ -133,4 +134,14 @@ Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-04-01-preview' && $(ruby) +namespace: "Azure::WebPubSub::Mgmt::V2024_04_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_webpubsub/lib ``` \ No newline at end of file From 8db92d688dd7a6ac9cab522c081f237c89071fb8 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Fri, 21 Jun 2024 18:37:01 +0800 Subject: [PATCH 221/343] disable flatten for JS for mongocluster, deploymentstacks and appcomplianceautomation (#29361) * disable flatten for JS for mongocluster * Update readme.typescript.md * update --- .../resource-manager/readme.typescript.md | 2 ++ .../mongocluster/resource-manager/readme.typescript.md | 2 ++ specification/resources/resource-manager/readme.typescript.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/specification/appcomplianceautomation/resource-manager/readme.typescript.md b/specification/appcomplianceautomation/resource-manager/readme.typescript.md index 837da7ab658b..ad2c9dc27312 100644 --- a/specification/appcomplianceautomation/resource-manager/readme.typescript.md +++ b/specification/appcomplianceautomation/resource-manager/readme.typescript.md @@ -4,6 +4,8 @@ These settings apply only when `--typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. ``` yaml $(typescript) +modelerfour: + flatten-models: false typescript: azure-arm: true package-name: "@azure/arm-appcomplianceautomation" diff --git a/specification/mongocluster/resource-manager/readme.typescript.md b/specification/mongocluster/resource-manager/readme.typescript.md index cef5b59af00e..230cd137c5c0 100644 --- a/specification/mongocluster/resource-manager/readme.typescript.md +++ b/specification/mongocluster/resource-manager/readme.typescript.md @@ -4,6 +4,8 @@ These settings apply only when `--typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. ``` yaml $(typescript) +modelerfour: + flatten-models: false typescript: azure-arm: true package-name: "@azure/arm-mongocluster" diff --git a/specification/resources/resource-manager/readme.typescript.md b/specification/resources/resource-manager/readme.typescript.md index 8fd4ad2d78e0..066d729dcc04 100644 --- a/specification/resources/resource-manager/readme.typescript.md +++ b/specification/resources/resource-manager/readme.typescript.md @@ -28,6 +28,8 @@ typescript: ``` ```yaml $(typescript) && $(package-deploymentstacks) && !$(profile-content) +modelerfour: + flatten-models: false typescript: package-name: "@azure/arm-resourcesdeploymentstacks" output-folder: "$(typescript-sdks-folder)/sdk/resourcesdeploymentstacks/arm-resourcesdeploymentstacks" From 1d96e34c91b7fdc03dd334acaf67f878ea5e663a Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Fri, 21 Jun 2024 07:31:14 -0700 Subject: [PATCH 222/343] Update documentation for Azure Maps Route v1 API (#29524) * https://msazure.visualstudio.com/One/_workitems/edit/28479372 * https://msazure.visualstudio.com/One/_workitems/edit/28479372 --- specification/maps/data-plane/Route/preview/1.0/route.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/maps/data-plane/Route/preview/1.0/route.json b/specification/maps/data-plane/Route/preview/1.0/route.json index 8b210b82e594..301fe9e9d10e 100644 --- a/specification/maps/data-plane/Route/preview/1.0/route.json +++ b/specification/maps/data-plane/Route/preview/1.0/route.json @@ -710,7 +710,7 @@ "name": "routeRepresentation", "x-ms-client-name": "routeRepresentationForBestOrder", "in": "query", - "description": "Specifies the representation of the set of routes provided as response. This parameter value can only be used in conjunction with computeBestOrder=true.", + "description": "Specifies the representation of the set of routes provided as response.", "type": "string", "enum": [ "polyline", @@ -731,7 +731,7 @@ }, { "value": "none", - "description": "Includes only the optimized waypoint indices but does not include the route geometry in the response." + "description": "Includes only the optimized waypoint indices but does not include the route geometry in the response. This parameter value can only be used in conjunction with computeBestOrder=true." } ] }, @@ -828,7 +828,7 @@ "RouteInstructionsType": { "name": "instructionsType", "in": "query", - "description": "If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none", + "description": "If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none.", "type": "string", "enum": [ "coded", From 5876f4b66ab6376b47823a2d6585204f3ab79489 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Fri, 21 Jun 2024 08:10:42 -0700 Subject: [PATCH 223/343] Remove input_tokens from embeddings usage --- .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++++------ .../GetEmbeddings_MaximumSet_Gen.json | 17 ++++++------ .../GetEmbeddings_MinimumSet_Gen.json | 15 +++++------ .../GetImageEmbeddings_MaximumSet_Gen.json | 19 +++++++------- .../GetImageEmbeddings_MinimumSet_Gen.json | 15 +++++------ .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- .../ModelClient/models/chat_completions.tsp | 1 + .../ai/ModelClient/models/common.tsp | 12 +++------ .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++++++---------- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++++++------ .../GetEmbeddings_MaximumSet_Gen.json | 17 ++++++------ .../GetEmbeddings_MinimumSet_Gen.json | 15 +++++------ .../GetImageEmbeddings_MaximumSet_Gen.json | 19 +++++++------- .../GetImageEmbeddings_MinimumSet_Gen.json | 15 +++++------ .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +-- .../preview/2024-05-01-preview/openapi.json | 10 ++----- 19 files changed, 119 insertions(+), 136 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index ce5f4bd0f230..b244b51dfe30 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": 0, "stream": true, "presence_penalty": 0, "temperature": 0, @@ -18,39 +18,39 @@ "max_tokens": 0, "response_format": "text", "stop": [ - "hdwxenghjddzdoibhygiexqlzg" + "vfxomqkhovrxtkyyazvmex" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 10, - "model": "f" + "seed": 28, + "model": "hegocluceqeqwfavwnmwecscp" } }, "responses": { "200": { "body": { - "id": "qasi", - "created": 10, - "model": "dqhfui", + "id": "eag", + "created": 16, + "model": "bcfftujqwrlhjosamwtpvsru", "usage": { - "completion_tokens": 30, - "prompt_tokens": 5, - "total_tokens": 15 + "completion_tokens": 17, + "prompt_tokens": 3, + "total_tokens": 28 }, "choices": [ { - "index": 18, + "index": 11, "finish_reason": "stop", "message": { "role": "system", - "content": "dutzickh", + "content": "sqfqcimvanxhufaxpuwaqltchbv", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "iergwzuviddjlebkehojkelrtnzjf" + "id": "mkfvplwmxxjp" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index 5ea13446fa0e..94ef6ec6379e 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "qasi", - "created": 10, - "model": "dqhfui", + "id": "eag", + "created": 16, + "model": "bcfftujqwrlhjosamwtpvsru", "usage": { - "completion_tokens": 30, - "prompt_tokens": 5, - "total_tokens": 15 + "completion_tokens": 17, + "prompt_tokens": 3, + "total_tokens": 28 }, "choices": [ { - "index": 18, + "index": 11, "finish_reason": "stop", "message": { "role": "system", - "content": "dutzickh" + "content": "sqfqcimvanxhufaxpuwaqltchbv" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index 123b53d0b637..213d37f9845c 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "yyfj" + "ivypgiezduiievgerd" ], - "dimensions": 25, + "dimensions": 30, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,20 @@ "responses": { "200": { "body": { - "id": "yazxsmdpbqxhvxnzaoiraeodo", + "id": "wzfybqqgaefhnyyp", "data": [ { "embedding": [ - 27 + 23 ], - "index": 9 + "index": 13 } ], "usage": { - "input_tokens": 5, - "prompt_tokens": 19, - "total_tokens": 18 + "prompt_tokens": 2, + "total_tokens": 11 }, - "model": "jxaepvabbkyclqiabhvbumoxjv" + "model": "muksoblvhrxtplhgqeagwo" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index 4c8dc7cdeb64..6ea121e179c7 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,27 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "xdlqaliwkojmfycalwtfrzusjyf" + "nisqlderyrvwaytwhfxck" ] } }, "responses": { "200": { "body": { - "id": "yazxsmdpbqxhvxnzaoiraeodo", + "id": "wzfybqqgaefhnyyp", "data": [ { "embedding": [ - 27 + 23 ], - "index": 9 + "index": 13 } ], "usage": { - "input_tokens": 5, - "prompt_tokens": 19, - "total_tokens": 18 + "prompt_tokens": 2, + "total_tokens": 11 }, - "model": "jxaepvabbkyclqiabhvbumoxjv" + "model": "muksoblvhrxtplhgqeagwo" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index a6bb1d5b2fcd..977fd94ea3ae 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "ydcewnfbtq", - "text": "uxfegdsf" + "image": "nardcgbukclsvpbhtvu", + "text": "ntxmijavbuoikywdbjembhhklakaz" } ], - "dimensions": 27, + "dimensions": 11, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,20 @@ "responses": { "200": { "body": { - "id": "yazxsmdpbqxhvxnzaoiraeodo", + "id": "wzfybqqgaefhnyyp", "data": [ { "embedding": [ - 27 + 23 ], - "index": 9 + "index": 13 } ], "usage": { - "input_tokens": 5, - "prompt_tokens": 19, - "total_tokens": 18 + "prompt_tokens": 2, + "total_tokens": 11 }, - "model": "jxaepvabbkyclqiabhvbumoxjv" + "model": "muksoblvhrxtplhgqeagwo" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 57ac3c2f33b8..163621adcfa3 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "ydcewnfbtq" + "image": "nardcgbukclsvpbhtvu" } ] } @@ -14,21 +14,20 @@ "responses": { "200": { "body": { - "id": "yazxsmdpbqxhvxnzaoiraeodo", + "id": "wzfybqqgaefhnyyp", "data": [ { "embedding": [ - 27 + 23 ], - "index": 9 + "index": 13 } ], "usage": { - "input_tokens": 5, - "prompt_tokens": 19, - "total_tokens": 18 + "prompt_tokens": 2, + "total_tokens": 11 }, - "model": "jxaepvabbkyclqiabhvbumoxjv" + "model": "muksoblvhrxtplhgqeagwo" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index 185baef2213a..032a6546ce8c 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "nmjvjpmwexifukpt", + "model_name": "xtcbadylzzpq", "model_type": "embeddings", - "model_provider_name": "qumaunlvkzpnfknl" + "model_provider_name": "rmrfrcpsppxuuchqitje" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index 9dfb2eddd833..ca922ff14c96 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "nmjvjpmwexifukpt", + "model_name": "xtcbadylzzpq", "model_type": "embeddings", - "model_provider_name": "qumaunlvkzpnfknl" + "model_provider_name": "rmrfrcpsppxuuchqitje" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 08b2a18f583e..0018e805b054 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -103,6 +103,7 @@ alias ChatCompletionsOptions = { @doc(""" ID of the specific AI model to use, if more than one model is available on the endpoint. """) + @clientName("DeploymentName", "csharp") `model`?: string; }; diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index fa2f60d221e1..b38347a08845 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -85,17 +85,13 @@ model EmbeddingItem { @doc("Measurement of the amount of tokens used in this request and response.") model EmbeddingsUsage { - @doc("Number of tokens in the request prompt.") - input_tokens: int32; + @doc("Number of tokens in the request.") + prompt_tokens: int32; @doc(""" - Number of tokens used for the prompt sent to the AI model. Typically identical to `input_tokens`. - However, certain AI models may add extra tokens to the input hence the number can be higher. - (for example when input_type="query"). + Total number of tokens transacted in this request/response. Should equal the + number of tokens in the request. """) - prompt_tokens: int32; - - @doc("Total number of tokens transacted in this request/response.") total_tokens: int32; } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index ce5f4bd0f230..b244b51dfe30 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": 0, "stream": true, "presence_penalty": 0, "temperature": 0, @@ -18,39 +18,39 @@ "max_tokens": 0, "response_format": "text", "stop": [ - "hdwxenghjddzdoibhygiexqlzg" + "vfxomqkhovrxtkyyazvmex" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 10, - "model": "f" + "seed": 28, + "model": "hegocluceqeqwfavwnmwecscp" } }, "responses": { "200": { "body": { - "id": "qasi", - "created": 10, - "model": "dqhfui", + "id": "eag", + "created": 16, + "model": "bcfftujqwrlhjosamwtpvsru", "usage": { - "completion_tokens": 30, - "prompt_tokens": 5, - "total_tokens": 15 + "completion_tokens": 17, + "prompt_tokens": 3, + "total_tokens": 28 }, "choices": [ { - "index": 18, + "index": 11, "finish_reason": "stop", "message": { "role": "system", - "content": "dutzickh", + "content": "sqfqcimvanxhufaxpuwaqltchbv", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "iergwzuviddjlebkehojkelrtnzjf" + "id": "mkfvplwmxxjp" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 5ea13446fa0e..94ef6ec6379e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "qasi", - "created": 10, - "model": "dqhfui", + "id": "eag", + "created": 16, + "model": "bcfftujqwrlhjosamwtpvsru", "usage": { - "completion_tokens": 30, - "prompt_tokens": 5, - "total_tokens": 15 + "completion_tokens": 17, + "prompt_tokens": 3, + "total_tokens": 28 }, "choices": [ { - "index": 18, + "index": 11, "finish_reason": "stop", "message": { "role": "system", - "content": "dutzickh" + "content": "sqfqcimvanxhufaxpuwaqltchbv" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 123b53d0b637..213d37f9845c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,9 +6,9 @@ "unknown-parameters": "error", "body": { "input": [ - "yyfj" + "ivypgiezduiievgerd" ], - "dimensions": 25, + "dimensions": 30, "encoding_format": "base64", "input_type": "text" } @@ -16,21 +16,20 @@ "responses": { "200": { "body": { - "id": "yazxsmdpbqxhvxnzaoiraeodo", + "id": "wzfybqqgaefhnyyp", "data": [ { "embedding": [ - 27 + 23 ], - "index": 9 + "index": 13 } ], "usage": { - "input_tokens": 5, - "prompt_tokens": 19, - "total_tokens": 18 + "prompt_tokens": 2, + "total_tokens": 11 }, - "model": "jxaepvabbkyclqiabhvbumoxjv" + "model": "muksoblvhrxtplhgqeagwo" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 4c8dc7cdeb64..6ea121e179c7 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,28 +5,27 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "xdlqaliwkojmfycalwtfrzusjyf" + "nisqlderyrvwaytwhfxck" ] } }, "responses": { "200": { "body": { - "id": "yazxsmdpbqxhvxnzaoiraeodo", + "id": "wzfybqqgaefhnyyp", "data": [ { "embedding": [ - 27 + 23 ], - "index": 9 + "index": 13 } ], "usage": { - "input_tokens": 5, - "prompt_tokens": 19, - "total_tokens": 18 + "prompt_tokens": 2, + "total_tokens": 11 }, - "model": "jxaepvabbkyclqiabhvbumoxjv" + "model": "muksoblvhrxtplhgqeagwo" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index a6bb1d5b2fcd..977fd94ea3ae 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,11 +7,11 @@ "body": { "input": [ { - "image": "ydcewnfbtq", - "text": "uxfegdsf" + "image": "nardcgbukclsvpbhtvu", + "text": "ntxmijavbuoikywdbjembhhklakaz" } ], - "dimensions": 27, + "dimensions": 11, "encoding_format": "base64", "input_type": "text" } @@ -19,21 +19,20 @@ "responses": { "200": { "body": { - "id": "yazxsmdpbqxhvxnzaoiraeodo", + "id": "wzfybqqgaefhnyyp", "data": [ { "embedding": [ - 27 + 23 ], - "index": 9 + "index": 13 } ], "usage": { - "input_tokens": 5, - "prompt_tokens": 19, - "total_tokens": 18 + "prompt_tokens": 2, + "total_tokens": 11 }, - "model": "jxaepvabbkyclqiabhvbumoxjv" + "model": "muksoblvhrxtplhgqeagwo" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 57ac3c2f33b8..163621adcfa3 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "ydcewnfbtq" + "image": "nardcgbukclsvpbhtvu" } ] } @@ -14,21 +14,20 @@ "responses": { "200": { "body": { - "id": "yazxsmdpbqxhvxnzaoiraeodo", + "id": "wzfybqqgaefhnyyp", "data": [ { "embedding": [ - 27 + 23 ], - "index": 9 + "index": 13 } ], "usage": { - "input_tokens": 5, - "prompt_tokens": 19, - "total_tokens": 18 + "prompt_tokens": 2, + "total_tokens": 11 }, - "model": "jxaepvabbkyclqiabhvbumoxjv" + "model": "muksoblvhrxtplhgqeagwo" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 185baef2213a..032a6546ce8c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "nmjvjpmwexifukpt", + "model_name": "xtcbadylzzpq", "model_type": "embeddings", - "model_provider_name": "qumaunlvkzpnfknl" + "model_provider_name": "rmrfrcpsppxuuchqitje" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 9dfb2eddd833..ca922ff14c96 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "nmjvjpmwexifukpt", + "model_name": "xtcbadylzzpq", "model_type": "embeddings", - "model_provider_name": "qumaunlvkzpnfknl" + "model_provider_name": "rmrfrcpsppxuuchqitje" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json index b62331935e54..bb884343aa2e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json @@ -1240,24 +1240,18 @@ "type": "object", "description": "Measurement of the amount of tokens used in this request and response.", "properties": { - "input_tokens": { - "type": "integer", - "format": "int32", - "description": "Number of tokens in the request prompt." - }, "prompt_tokens": { "type": "integer", "format": "int32", - "description": "Number of tokens used for the prompt sent to the AI model. Typically identical to `input_tokens`.\nHowever, certain AI models may add extra tokens to the input hence the number can be higher.\n(for example when input_type=\"query\")." + "description": "Number of tokens in the request." }, "total_tokens": { "type": "integer", "format": "int32", - "description": "Total number of tokens transacted in this request/response." + "description": "Total number of tokens transacted in this request/response. Should equal the\nnumber of tokens in the request." } }, "required": [ - "input_tokens", "prompt_tokens", "total_tokens" ] From a0ace9e8bb9e3fcb050d198718ce2a13197ea798 Mon Sep 17 00:00:00 2001 From: nikhilpadhye1 <68977752+nikhilpadhye1@users.noreply.github.com> Date: Fri, 21 Jun 2024 12:21:41 -0700 Subject: [PATCH 224/343] =?UTF-8?q?Moving=20missed=20changes=20from=202023?= =?UTF-8?q?-11-01=20packet=20capture=20swagger=20fix=20to=20l=E2=80=A6=20(?= =?UTF-8?q?#29473)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Adds base for updating Microsoft.Network from version stable/2023-11-01 to version 2024-01-01 * Updates readme * Updates API version in new specs and examples * Add examples for Subnet peering and v6 Subnet peering. (#28827) Add examples for Subnet peering and v6 Subnet peering. --------- Co-authored-by: saurabh83 * Init (#29127) Co-authored-by: Abhishek Shah * Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 (#29048) Co-authored-by: Arsheen Khatib (from Dev Box) * Added NoHealthyBackendsBehavior (#28868) Added the property "NoHealthyBackendsBehavior" to the Probe properties. * VirtualNetworkGatewayConnection using key vault for authentication. (#28760) * Add parameters for cert based auth connection * retrigger checks * retrigger checks * lintDiff * Trigger Build * revert PATCH changes * fix * change managed identity to v5 * add format and description * added networkidentifier under vnet->subet->serviceendpoint (#29292) * added networkidentifier under vnet->subet->serviceendpoint * resolving conflict (#29343) * Fix for PR VirtualNetworkGatewayConnection using key vault for authentication. (#29357) * Fix * Fix2 --------- Co-authored-by: Khushboo Baheti * Adding GET operaton for Network Virtual Appliance Inbound Secuirty Rule (#29339) * Moving missed changes from 2023-11-01 packet capture swagger fix to latest api version * Add CrossConnection Name as an optional query parameter in List ExpressRoute CrossConnection (#29251) * Add CrossConnection name as an optional query parameter for List CrossConnection * update example * Addressing comments * Change to OData filtering * Fix the parameter reference * Update --------- Co-authored-by: Jianqi Zhao * initial changes (#29235) * adding supression for the breaking change in azure-sdk-for-go * adding correct package for this supression --------- Co-authored-by: GuptaVertika <149072034+GuptaVertika@users.noreply.github.com> Co-authored-by: saurabh83 Co-authored-by: saurabh83 Co-authored-by: Abhishek Shah <16267081+abhi7860@users.noreply.github.com> Co-authored-by: Abhishek Shah Co-authored-by: AFK1194 Co-authored-by: Arsheen Khatib (from Dev Box) Co-authored-by: Eugenio Peña García <70240915+EugenioPena@users.noreply.github.com> Co-authored-by: daweiwang-microsoft <165709729+daweiwang-microsoft@users.noreply.github.com> Co-authored-by: Bhupesh Kumar Bhatt <52891188+bhupeshbhatt1985@users.noreply.github.com> Co-authored-by: Khushboo Baheti <37917868+Khushboo-Baheti@users.noreply.github.com> Co-authored-by: Khushboo Baheti Co-authored-by: Ashutosh Mishra <163998769+ashutmi@users.noreply.github.com> Co-authored-by: jianzhao1992 <125631957+jianzhao1992@users.noreply.github.com> Co-authored-by: Jianqi Zhao Co-authored-by: nimaller <71352534+nimaller@users.noreply.github.com> --- .../stable/2024-01-01/azureFirewall.json | 20 +---- .../examples/AzureFirewallPacketCapture.json | 80 +++++++++---------- .../resource-manager/sdk-suppressions.yaml | 6 ++ 3 files changed, 47 insertions(+), 59 deletions(-) create mode 100644 specification/network/resource-manager/sdk-suppressions.yaml diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewall.json index df777fa6ecc5..26de624c5689 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/azureFirewall.json @@ -1217,7 +1217,7 @@ }, "description": "List of SNAT IP Prefixes learnt by firewall to not SNAT" }, - "FirewallPacketCaptureParametersFormat": { + "FirewallPacketCaptureParameters": { "type": "object", "properties": { "durationInSeconds": { @@ -1267,7 +1267,7 @@ "x-ms-identifiers": [] } }, - "description": "Packet capture parameters on azure firewall." + "description": "Azure Firewall Packet Capture Parameters." }, "AzureFirewallPacketCaptureFlags": { "type": "object", @@ -1321,22 +1321,6 @@ } }, "description": "Group of src/dest ips and ports to be captured." - }, - "FirewallPacketCaptureParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FirewallPacketCaptureParametersFormat", - "description": "Properties of the azure firewall." - } - }, - "allOf": [ - { - "$ref": "./network.json#/definitions/SubResource" - } - ], - "description": "Azure Firewall Packet Capture Parameters resource." } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPacketCapture.json index c9b956952b9b..ef6fa4397e1c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPacketCapture.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AzureFirewallPacketCapture.json @@ -5,47 +5,45 @@ "resourceGroupName": "rg1", "azureFirewallName": "azureFirewall1", "parameters": { - "properties": { - "durationInSeconds": 300, - "numberOfPacketsToCapture": 5000, - "sasUrl": "someSASURL", - "fileName": "azureFirewallPacketCapture", - "protocol": "Any", - "flags": [ - { - "type": "syn" - }, - { - "type": "fin" - } - ], - "filters": [ - { - "sources": [ - "20.1.1.0" - ], - "destinations": [ - "20.1.2.0" - ], - "destinationPorts": [ - "4500" - ] - }, - { - "sources": [ - "10.1.1.0", - "10.1.1.1" - ], - "destinations": [ - "10.1.2.0" - ], - "destinationPorts": [ - "123", - "80" - ] - } - ] - } + "durationInSeconds": 300, + "numberOfPacketsToCapture": 5000, + "sasUrl": "someSASURL", + "fileName": "azureFirewallPacketCapture", + "protocol": "Any", + "flags": [ + { + "type": "syn" + }, + { + "type": "fin" + } + ], + "filters": [ + { + "sources": [ + "20.1.1.0" + ], + "destinations": [ + "20.1.2.0" + ], + "destinationPorts": [ + "4500" + ] + }, + { + "sources": [ + "10.1.1.0", + "10.1.1.1" + ], + "destinations": [ + "10.1.2.0" + ], + "destinationPorts": [ + "123", + "80" + ] + } + ] } }, "responses": { diff --git a/specification/network/resource-manager/sdk-suppressions.yaml b/specification/network/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..f5f18097c539 --- /dev/null +++ b/specification/network/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,6 @@ +suppressions: + azure-sdk-for-go: + - package: 'sdk/resourcemanager/network/armnetwork' + breaking-changes: + - Struct `FirewallPacketCaptureParametersFormat` has been removed + - Field `ID`, `Properties` of struct `FirewallPacketCaptureParameters` has been removed \ No newline at end of file From 8c122c58036255691dd7e8cb4c8ffcf7bdf56edb Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 21 Jun 2024 16:27:18 -0700 Subject: [PATCH 225/343] Leave the model property Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/chat_completions.tsp | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 2863942b014e..6a21fc17aa51 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -111,7 +111,6 @@ model ChatCompletionsOptions { @doc(""" ID of the specific AI model to use, if more than one model is available on the endpoint. """) - @clientName("DeploymentName", "csharp") `model`?: string; } From 8dd3c52b26979c5870180bca34bb80370e348193 Mon Sep 17 00:00:00 2001 From: ajtms <154369796+ajtms@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:39:21 -0700 Subject: [PATCH 226/343] Fixes for x-ms-examples used in 2023 API specification validation (#29452) * Added missing id property to some example resources. Added headers with locations to long-running operation examples. * Added some missing information on some response object typings regarding the location property used in long-running operations. * Fixed a possible typo 'azure-async-operation' to 'azure-asyncoperation' (removed a hyphen). * Ran prettier against azureFirewall.json * Applying the 2023-05-01 validation fixes to the 2023-06-01 and 2023-09-01 versions as well. * Removed duplicate property * Added missing location header to the 06 and 09 verisions, similar to the 05 version. * Added missing IDs to certain resource gets/puts. Added missing location header for long running delete operation. * Updated 2023-09-01 stable examples. * Fixed improper resource id * Fixed example errors for 2023-06-01. Fixed small whitespace typo on a 2023-09-01 file. * Updated 2023-05-01 firewall examples. Fixed small whitespace typoe missed from previous commit. * Updated 2023-04-01 examples with resource IDs. Updated some resource IDs that use the wrong firewall name in their path. * Updated firewall examples for 2023-02-01. * Added location headers for several long-running operations. Updated some location headers so their URL paths have the accurate api-version. --- .../2023-02-01/examples/AzureFirewallDelete.json | 6 +++++- .../2023-02-01/examples/AzureFirewallGet.json | 5 ++++- .../AzureFirewallGetWithAdditionalProperties.json | 5 ++++- .../examples/AzureFirewallGetWithIpGroups.json | 5 ++++- .../examples/AzureFirewallGetWithMgmtSubnet.json | 7 +++++-- .../examples/AzureFirewallGetWithZones.json | 5 ++++- .../examples/AzureFirewallListByResourceGroup.json | 7 +++++-- .../examples/AzureFirewallListBySubscription.json | 7 +++++-- .../AzureFirewallListLearnedIPPrefixes.json | 6 +++++- .../2023-02-01/examples/AzureFirewallPut.json | 13 +++++++++++-- .../AzureFirewallPutWithAdditionalProperties.json | 13 +++++++++++-- .../examples/AzureFirewallPutWithIpGroups.json | 13 +++++++++++-- .../examples/AzureFirewallPutWithMgmtSubnet.json | 13 +++++++++++-- .../examples/AzureFirewallPutWithZones.json | 13 +++++++++++-- .../examples/AzureFirewallUpdateTags.json | 6 +++++- .../2023-04-01/examples/AzureFirewallDelete.json | 6 +++++- .../2023-04-01/examples/AzureFirewallGet.json | 5 ++++- .../AzureFirewallGetWithAdditionalProperties.json | 5 ++++- .../examples/AzureFirewallGetWithIpGroups.json | 5 ++++- .../examples/AzureFirewallGetWithMgmtSubnet.json | 7 +++++-- .../examples/AzureFirewallGetWithZones.json | 5 ++++- .../examples/AzureFirewallListByResourceGroup.json | 7 +++++-- .../examples/AzureFirewallListBySubscription.json | 7 +++++-- .../AzureFirewallListLearnedIPPrefixes.json | 6 +++++- .../2023-04-01/examples/AzureFirewallPut.json | 13 +++++++++++-- .../AzureFirewallPutWithAdditionalProperties.json | 13 +++++++++++-- .../examples/AzureFirewallPutWithIpGroups.json | 13 +++++++++++-- .../examples/AzureFirewallPutWithMgmtSubnet.json | 13 +++++++++++-- .../examples/AzureFirewallPutWithZones.json | 13 +++++++++++-- .../examples/AzureFirewallUpdateTags.json | 6 +++++- .../2023-05-01/examples/AzureFirewallGet.json | 2 +- .../AzureFirewallGetWithAdditionalProperties.json | 2 +- .../examples/AzureFirewallGetWithIpGroups.json | 2 +- .../examples/AzureFirewallGetWithMgmtSubnet.json | 4 ++-- .../examples/AzureFirewallGetWithZones.json | 2 +- .../examples/AzureFirewallListByResourceGroup.json | 4 ++-- .../examples/AzureFirewallListBySubscription.json | 4 ++-- .../2023-05-01/examples/AzureFirewallPut.json | 7 +++++-- .../AzureFirewallPutWithAdditionalProperties.json | 7 +++++-- .../examples/AzureFirewallPutWithIpGroups.json | 7 +++++-- .../examples/AzureFirewallPutWithMgmtSubnet.json | 7 +++++-- .../examples/AzureFirewallPutWithZones.json | 6 ++++-- .../2023-06-01/examples/AzureFirewallDelete.json | 2 +- .../2023-06-01/examples/AzureFirewallGet.json | 2 +- .../AzureFirewallGetWithAdditionalProperties.json | 2 +- .../examples/AzureFirewallGetWithIpGroups.json | 2 +- .../examples/AzureFirewallGetWithMgmtSubnet.json | 4 ++-- .../examples/AzureFirewallGetWithZones.json | 2 +- .../examples/AzureFirewallListByResourceGroup.json | 4 ++-- .../examples/AzureFirewallListBySubscription.json | 4 ++-- .../AzureFirewallListLearnedIPPrefixes.json | 2 +- .../2023-06-01/examples/AzureFirewallPut.json | 7 +++++-- .../AzureFirewallPutWithAdditionalProperties.json | 7 +++++-- .../examples/AzureFirewallPutWithIpGroups.json | 7 +++++-- .../examples/AzureFirewallPutWithMgmtSubnet.json | 7 +++++-- .../examples/AzureFirewallPutWithZones.json | 6 ++++-- .../examples/AzureFirewallUpdateTags.json | 2 +- .../2023-09-01/examples/AzureFirewallDelete.json | 2 +- .../2023-09-01/examples/AzureFirewallGet.json | 2 +- .../AzureFirewallGetWithAdditionalProperties.json | 2 +- .../examples/AzureFirewallGetWithIpGroups.json | 2 +- .../examples/AzureFirewallGetWithMgmtSubnet.json | 4 ++-- .../examples/AzureFirewallGetWithZones.json | 2 +- .../examples/AzureFirewallListByResourceGroup.json | 4 ++-- .../examples/AzureFirewallListBySubscription.json | 4 ++-- .../AzureFirewallListLearnedIPPrefixes.json | 2 +- .../2023-09-01/examples/AzureFirewallPut.json | 7 +++++-- .../AzureFirewallPutWithAdditionalProperties.json | 7 +++++-- .../examples/AzureFirewallPutWithIpGroups.json | 7 +++++-- .../examples/AzureFirewallPutWithMgmtSubnet.json | 7 +++++-- .../examples/AzureFirewallPutWithZones.json | 6 ++++-- .../2023-11-01/examples/AzureFirewallDelete.json | 6 +++++- .../2023-11-01/examples/AzureFirewallGet.json | 5 ++++- .../AzureFirewallGetWithAdditionalProperties.json | 5 ++++- .../examples/AzureFirewallGetWithIpGroups.json | 5 ++++- .../examples/AzureFirewallGetWithMgmtSubnet.json | 7 +++++-- .../examples/AzureFirewallGetWithZones.json | 5 ++++- .../examples/AzureFirewallListByResourceGroup.json | 7 +++++-- .../examples/AzureFirewallListBySubscription.json | 7 +++++-- .../AzureFirewallListLearnedIPPrefixes.json | 6 +++++- .../2023-11-01/examples/AzureFirewallPut.json | 13 +++++++++++-- .../AzureFirewallPutWithAdditionalProperties.json | 13 +++++++++++-- .../examples/AzureFirewallPutWithIpGroups.json | 13 +++++++++++-- .../examples/AzureFirewallPutWithMgmtSubnet.json | 13 +++++++++++-- .../examples/AzureFirewallPutWithZones.json | 13 +++++++++++-- .../examples/AzureFirewallUpdateTags.json | 6 +++++- 86 files changed, 410 insertions(+), 134 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallDelete.json index 58bb91e8e96d..1549f36c6426 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallDelete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-02-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGet.json index 4a14150d0179..bb5d4711bebe 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -74,6 +75,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -123,6 +125,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithAdditionalProperties.json index 8528f6c58bb5..348f9603c5a7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -74,6 +75,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -123,6 +125,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithIpGroups.json index 681f4b69e578..ec014a403653 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithIpGroups.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithMgmtSubnet.json index 717776c62290..fde5c2952515 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -43,7 +43,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -58,6 +58,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -88,6 +89,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -137,6 +139,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithZones.json index 65408b4ab32a..0a3e0a59944f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallGetWithZones.json @@ -31,7 +31,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -48,6 +48,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -78,6 +79,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -127,6 +129,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListByResourceGroup.json index f9e12c260a60..505900184a51 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListByResourceGroup.json @@ -24,7 +24,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -40,7 +40,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -55,6 +55,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -85,6 +86,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -134,6 +136,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListBySubscription.json index 7465e94395fe..4b1c1757312e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListBySubscription.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListBySubscription.json @@ -23,7 +23,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -39,7 +39,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -54,6 +54,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -84,6 +85,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -133,6 +135,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListLearnedIPPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListLearnedIPPrefixes.json index 55c8a907d0f0..ccef685f35bc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListLearnedIPPrefixes.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallListLearnedIPPrefixes.json @@ -6,7 +6,11 @@ "azureFirewallName": "azureFirewall1" }, "responses": { - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-02-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789" + } + }, "200": { "body": { "ipPrefixes": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPut.json index d3f4760599ee..3f249562ec84 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPut.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -198,6 +201,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -228,6 +232,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -277,6 +282,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -348,7 +354,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -365,6 +371,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -395,6 +402,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -444,6 +452,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithAdditionalProperties.json index f0e4a0973d2b..912697e27b61 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -186,7 +189,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -203,6 +206,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -233,6 +237,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -282,6 +287,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -355,7 +361,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -372,6 +378,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -402,6 +409,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -451,6 +459,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithIpGroups.json index 6ca6a2d4a04b..0c796fb2d7a1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithIpGroups.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -198,6 +201,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -228,6 +232,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -277,6 +282,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -347,7 +353,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -364,6 +370,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -393,6 +400,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -442,6 +450,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithMgmtSubnet.json index b31b46ecbca6..4fdd5bd795cb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -43,6 +43,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -192,7 +195,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -209,6 +212,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -239,6 +243,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -288,6 +293,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -358,7 +364,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -375,6 +381,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -405,6 +412,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -454,6 +462,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithZones.json index a521ea9ddf73..28935f5fc47e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallPutWithZones.json @@ -36,6 +36,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -66,6 +67,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -115,6 +117,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -189,7 +192,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -206,6 +209,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -236,6 +240,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -285,6 +290,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -360,7 +366,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -377,6 +383,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -407,6 +414,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -456,6 +464,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallUpdateTags.json index efe16f0b83db..cc58879c354b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/AzureFirewallUpdateTags.json @@ -12,7 +12,11 @@ } }, "responses": { - "202": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-02-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "200": { "body": { "name": "fw1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallDelete.json index c0d6f48f8044..6a299d3ae34e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallDelete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGet.json index 74cd3b007669..147ef64a8acb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -74,6 +75,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -123,6 +125,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithAdditionalProperties.json index b0c9f6b89b4a..0f5f1009fc2a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -74,6 +75,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -123,6 +125,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithIpGroups.json index ab80ab9fd4ab..a205c1eeaa21 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithIpGroups.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithMgmtSubnet.json index aa1985bc539d..a0c06971d7e5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -43,7 +43,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -58,6 +58,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -88,6 +89,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -137,6 +139,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithZones.json index bff2ded76323..cd23f826bf1f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallGetWithZones.json @@ -31,7 +31,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -48,6 +48,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -78,6 +79,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -127,6 +129,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListByResourceGroup.json index 75a8453ead82..a5e533c84fa9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListByResourceGroup.json @@ -24,7 +24,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -40,7 +40,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -55,6 +55,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -85,6 +86,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -134,6 +136,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListBySubscription.json index 85c6726729bf..2ed72d41ea9e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListBySubscription.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListBySubscription.json @@ -23,7 +23,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -39,7 +39,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -54,6 +54,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -84,6 +85,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -133,6 +135,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListLearnedIPPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListLearnedIPPrefixes.json index ebe8df9f28ec..9c087556d9af 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListLearnedIPPrefixes.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallListLearnedIPPrefixes.json @@ -6,7 +6,11 @@ "azureFirewallName": "azureFirewall1" }, "responses": { - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789" + } + }, "200": { "body": { "ipPrefixes": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPut.json index dd59104aa8b3..c091ac1559e3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPut.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -198,6 +201,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -228,6 +232,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -277,6 +282,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -348,7 +354,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -365,6 +371,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -395,6 +402,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -444,6 +452,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithAdditionalProperties.json index ae8882c0b7f5..2dba2e578da1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -186,7 +189,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -203,6 +206,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -233,6 +237,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -282,6 +287,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -355,7 +361,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -372,6 +378,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -402,6 +409,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -451,6 +459,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithIpGroups.json index 239def47795d..586ffbf1b505 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithIpGroups.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -198,6 +201,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -228,6 +232,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -277,6 +282,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -347,7 +353,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -364,6 +370,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -393,6 +400,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -442,6 +450,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithMgmtSubnet.json index d701dc0afb61..aec994e2c7c3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -43,6 +43,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -192,7 +195,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -209,6 +212,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -239,6 +243,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -288,6 +293,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -358,7 +364,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -375,6 +381,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -405,6 +412,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -454,6 +462,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithZones.json index 30b2addf5d3c..63c955a2804e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallPutWithZones.json @@ -36,6 +36,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -66,6 +67,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -115,6 +117,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -189,7 +192,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -206,6 +209,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -236,6 +240,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -285,6 +290,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -360,7 +366,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -377,6 +383,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -407,6 +414,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -456,6 +464,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallUpdateTags.json index a597e46adcac..95bf384f7386 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-04-01/examples/AzureFirewallUpdateTags.json @@ -12,7 +12,11 @@ } }, "responses": { - "202": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "200": { "body": { "name": "fw1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json index 6d50ba91b519..ebac1e9c6ddd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json index deb24e66f98c..4434d3c79338 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json index 535a5bd21c8b..b3cff65d5334 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json index 333a9fce1a85..7e96d0b550be 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -43,7 +43,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json index 7bdd3535fd16..4ca473586e1f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json @@ -31,7 +31,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json index e5314b813c02..622e5ec63f3b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json @@ -24,7 +24,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -40,7 +40,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json index a4305fbfed69..067c7f0fd8cc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json @@ -23,7 +23,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -39,7 +39,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json index 994dc5875daa..976bcc40ef84 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -351,7 +354,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json index b2c45b0f56ab..b3882d5b7ec7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -186,7 +189,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -358,7 +361,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json index 0071150d656d..cf6be14b4c9d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -350,7 +353,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithMgmtSubnet.json index dd247ef04b46..183ebbdb42e3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -43,6 +43,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -192,7 +195,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -361,7 +364,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithZones.json index 0a9007531a61..e6e70ceea768 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithZones.json @@ -36,6 +36,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -116,6 +117,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -190,7 +192,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -364,7 +366,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallDelete.json index caf958c7093f..2df315047731 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallDelete.json @@ -9,7 +9,7 @@ "200": {}, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-06-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" } }, "204": {} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGet.json index 1b80b7f27ca1..1b49e0c054f1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithAdditionalProperties.json index af5e2c4f45e3..b7e8507a3209 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithIpGroups.json index 610f29354a52..b56cac419385 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithIpGroups.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithMgmtSubnet.json index 545f3cf4679b..0e4272f88344 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -43,7 +43,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithZones.json index 17668990980f..2b077c29b225 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallGetWithZones.json @@ -31,7 +31,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListByResourceGroup.json index 19732c4f67cc..618810dc8766 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListByResourceGroup.json @@ -24,7 +24,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -40,7 +40,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListBySubscription.json index 5d015a132b60..f4eb97bfa2d0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListBySubscription.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListBySubscription.json @@ -23,7 +23,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -39,7 +39,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListLearnedIPPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListLearnedIPPrefixes.json index ed6f48f90245..3e2962469841 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListLearnedIPPrefixes.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallListLearnedIPPrefixes.json @@ -8,7 +8,7 @@ "responses": { "202": { "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789" + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-06-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789" } }, "200": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPut.json index 665e1aa5f5d5..f6756065df64 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPut.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -351,7 +354,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithAdditionalProperties.json index 2d4c7478ecd9..72b7028ea801 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -186,7 +189,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -358,7 +361,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithIpGroups.json index 4b4dc37640d4..6bd556a5bb89 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithIpGroups.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -350,7 +353,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithMgmtSubnet.json index d9899d0b02fd..1cfbbe30ac3e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -43,6 +43,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -192,7 +195,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -361,7 +364,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithZones.json index 255da350d715..c3964fee0e32 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallPutWithZones.json @@ -36,6 +36,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -116,6 +117,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -190,7 +192,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -364,7 +366,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallUpdateTags.json index a8a3706f3d4e..9b05cf22a66c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/AzureFirewallUpdateTags.json @@ -14,7 +14,7 @@ "responses": { "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-06-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" } }, "200": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallDelete.json index 5210053d7d7f..7d0bd2e21970 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallDelete.json @@ -9,7 +9,7 @@ "200": {}, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-09-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" } }, "204": {} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGet.json index 6eef9ba17cb7..2f313279e3a6 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithAdditionalProperties.json index 1dce88a58e52..313ee6821256 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithIpGroups.json index 2b6c16e05df8..fa9710be8e7f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithIpGroups.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithMgmtSubnet.json index 1c06a13b5c70..0f91bf7342bf 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -43,7 +43,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithZones.json index fac648478a53..b3bfee32e35b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallGetWithZones.json @@ -31,7 +31,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListByResourceGroup.json index 506bfafcd4db..2d54ba1d9762 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListByResourceGroup.json @@ -24,7 +24,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -40,7 +40,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListBySubscription.json index d33cdc529335..0810a5cb7f68 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListBySubscription.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListBySubscription.json @@ -23,7 +23,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -39,7 +39,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListLearnedIPPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListLearnedIPPrefixes.json index a151f5b9ae8d..c08d2c115da0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListLearnedIPPrefixes.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallListLearnedIPPrefixes.json @@ -8,7 +8,7 @@ "responses": { "202": { "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789" + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-09-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789" } }, "200": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPut.json index b1090d287777..691bdb815f2f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPut.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -351,7 +354,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithAdditionalProperties.json index 3167701fb2cf..0401d78a0480 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -186,7 +189,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -358,7 +361,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithIpGroups.json index 154dbfac598e..8523c5338c2e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithIpGroups.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -350,7 +353,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithMgmtSubnet.json index 9cec4785cd92..6cfcc68992dc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -43,6 +43,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -192,7 +195,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -361,7 +364,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithZones.json index e9f20ac65d7f..bc3edd9c4630 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/AzureFirewallPutWithZones.json @@ -36,6 +36,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -116,6 +117,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -190,7 +192,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -364,7 +366,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallDelete.json index 7f4ad92b9a30..1d994847e0f8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallDelete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGet.json index 1875292073c4..f651d40933a3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -74,6 +75,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -123,6 +125,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithAdditionalProperties.json index e7486965d67d..7e773c8b39c0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -74,6 +75,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -123,6 +125,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithIpGroups.json index 83daa3090d67..5d038cbce0ff 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithIpGroups.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithMgmtSubnet.json index 423334aa3a0f..1d7843b21e7d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -27,7 +27,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -43,7 +43,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -58,6 +58,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -88,6 +89,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -137,6 +139,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithZones.json index 109ebfd4ed50..e47375bd54cf 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallGetWithZones.json @@ -31,7 +31,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -48,6 +48,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -78,6 +79,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -127,6 +129,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListByResourceGroup.json index c4f59bbaf328..be5843f47f79 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListByResourceGroup.json @@ -24,7 +24,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -40,7 +40,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -55,6 +55,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -85,6 +86,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -134,6 +136,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListBySubscription.json index 1d471bbd2706..87b3624cbf14 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListBySubscription.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListBySubscription.json @@ -23,7 +23,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -39,7 +39,7 @@ ], "managementIpConfiguration": { "name": "azureFirewallMgmtIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -54,6 +54,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -84,6 +85,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -133,6 +135,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListLearnedIPPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListLearnedIPPrefixes.json index 6d1db6c99368..8c3e29879f6d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListLearnedIPPrefixes.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallListLearnedIPPrefixes.json @@ -6,7 +6,11 @@ "azureFirewallName": "azureFirewall1" }, "responses": { - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789" + } + }, "200": { "body": { "ipPrefixes": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPut.json index d2d2b1d9b9c1..45e0c3359811 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPut.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -198,6 +201,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -228,6 +232,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -277,6 +282,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -348,7 +354,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -365,6 +371,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -395,6 +402,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -444,6 +452,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithAdditionalProperties.json index 927ed0fd4831..43ee3d4839a2 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -186,7 +189,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -203,6 +206,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -233,6 +237,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -282,6 +287,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -355,7 +361,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -372,6 +378,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -402,6 +409,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -451,6 +459,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithIpGroups.json index b9841fb27ca5..cd58bd1e960c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithIpGroups.json @@ -32,6 +32,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -62,6 +63,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -111,6 +113,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -181,7 +184,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -198,6 +201,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -228,6 +232,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -277,6 +282,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -347,7 +353,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -364,6 +370,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -393,6 +400,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -442,6 +450,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithMgmtSubnet.json index 7db72a929fdf..b3e4191e7621 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -43,6 +43,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -192,7 +195,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -209,6 +212,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -239,6 +243,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -288,6 +293,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -358,7 +364,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -375,6 +381,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -405,6 +412,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -454,6 +462,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithZones.json index 6f7e05b7cabf..ee5b4b6ad2c5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallPutWithZones.json @@ -36,6 +36,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -66,6 +67,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -115,6 +117,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -189,7 +192,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -206,6 +209,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -236,6 +240,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -285,6 +290,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -360,7 +366,7 @@ "ipConfigurations": [ { "name": "azureFirewallIpConfiguration", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", "etag": "w/\\00000000-0000-0000-0000-000000000000\\", "properties": { "provisioningState": "Succeeded", @@ -377,6 +383,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -407,6 +414,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -456,6 +464,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallUpdateTags.json index d47d19426169..f70c1c3bf2fc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/AzureFirewallUpdateTags.json @@ -12,7 +12,11 @@ } }, "responses": { - "202": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "200": { "body": { "name": "fw1", From a83c34348fbd25ad79a05e36816b91da0122b583 Mon Sep 17 00:00:00 2001 From: Chenglong Liu <48578056+ChenglongLiu@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:40:32 -0700 Subject: [PATCH 227/343] Fix secret source url format (#29475) --- .../examples/AFDProfiles_ValidateSecret.json | 2 +- .../examples/Secrets_CreateCustomerCertificateType.json | 2 +- .../examples/Secrets_CreateMtlsCertificateChainType.json | 8 ++++---- .../examples/Secrets_CreateUrlSigningKeyType.json | 8 ++++---- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ValidateSecret.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ValidateSecret.json index 9eec791b7db5..2b84bc734267 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ValidateSecret.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/AFDProfiles_ValidateSecret.json @@ -6,7 +6,7 @@ "profileName": "profile1", "validateSecretInput": { "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/certificate/certName" }, "secretType": "CustomerCertificate" } diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateCustomerCertificateType.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateCustomerCertificateType.json index cddc40cf2702..156190a399d3 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateCustomerCertificateType.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateCustomerCertificateType.json @@ -11,7 +11,7 @@ "type": "CustomerCertificate", "secretVersion": "abcdef1234578900abcdef1234567890", "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/secrets/certificatename" }, "useLatestVersion": false } diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateMtlsCertificateChainType.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateMtlsCertificateChainType.json index d701ee8b1853..eb3f24800831 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateMtlsCertificateChainType.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateMtlsCertificateChainType.json @@ -11,7 +11,7 @@ "type": "MtlsCertificateChain", "secretVersion": "abcdef1234578900abcdef1234567890", "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/mTLSCertificateChainname" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/secrets/mTLSCertificateChainname" } } } @@ -28,7 +28,7 @@ "type": "MtlsCertificateChain", "secretVersion": "abcdef1234578900abcdef1234567890", "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/mTLSCertificateChainName" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/secrets/mTLSCertificateChainName" }, "expirationDate": "2025-01-01T00:00:00-00:00" }, @@ -47,7 +47,7 @@ "type": "MtlsCertificateChain", "secretVersion": "abcdef1234578900abcdef1234567890", "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/mTLSCertificateChainName" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/secrets/mTLSCertificateChainName" }, "expirationDate": "2025-01-01T00:00:00-00:00" }, @@ -66,7 +66,7 @@ "type": "MtlsCertificateChain", "secretVersion": "abcdef1234578900abcdef1234567890", "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/mTLSCertificateChainName" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/secrets/mTLSCertificateChainName" }, "expirationDate": "2025-01-01T00:00:00-00:00" }, diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateUrlSigningKeyType.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateUrlSigningKeyType.json index ff81c653b478..797ed423dfe2 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateUrlSigningKeyType.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2024-05-01-preview/examples/Secrets_CreateUrlSigningKeyType.json @@ -11,7 +11,7 @@ "type": "UrlSigningKey", "secretVersion": "abcdef1234578900abcdef1234567890", "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/urlsigningkeyname" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/secrets/urlsigningkeyname" }, "keyId": "customKeyId" } @@ -29,7 +29,7 @@ "type": "UrlSigningKey", "secretVersion": "abcdef1234578900abcdef1234567890", "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/urlsigningkeyname" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/secrets/urlsigningkeyname" }, "keyId": "customKeyId" }, @@ -48,7 +48,7 @@ "type": "UrlSigningKey", "secretVersion": "abcdef1234578900abcdef1234567890", "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/urlsigningkeyname" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/secrets/urlsigningkeyname" }, "keyId": "customKeyId" }, @@ -67,7 +67,7 @@ "type": "UrlSigningKey", "secretVersion": "abcdef1234578900abcdef1234567890", "secretSource": { - "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/urlsigningkeyname" + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/kvName/secrets/urlsigningkeyname" }, "keyId": "customKeyId" }, From 9f9d14b5db982b1d554651348adc9bef4b098bdb Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Mon, 24 Jun 2024 11:01:44 +0800 Subject: [PATCH 228/343] [powerbiembedded] Update readme.md (#29551) * Update readme.md * Create readme.python.md --- .../resource-manager/readme.md | 25 +------------------ .../resource-manager/readme.python.md | 19 ++++++++++++++ 2 files changed, 20 insertions(+), 24 deletions(-) create mode 100644 specification/powerbiembedded/resource-manager/readme.python.md diff --git a/specification/powerbiembedded/resource-manager/readme.md b/specification/powerbiembedded/resource-manager/readme.md index 14113378b1b2..d3a48d8cf036 100644 --- a/specification/powerbiembedded/resource-manager/readme.md +++ b/specification/powerbiembedded/resource-manager/readme.md @@ -82,30 +82,7 @@ csharp: ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.powerbiembedded - package-name: azure-mgmt-powerbiembedded - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/powerbiembedded/azure-mgmt-powerbiembedded/azure/mgmt/powerbiembedded -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/powerbiembedded/azure-mgmt-powerbiembedded -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/powerbiembedded/resource-manager/readme.python.md b/specification/powerbiembedded/resource-manager/readme.python.md new file mode 100644 index 000000000000..4d9931a02b30 --- /dev/null +++ b/specification/powerbiembedded/resource-manager/readme.python.md @@ -0,0 +1,19 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +title: PowerBIEmbeddedManagementClient +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-powerbiembedded +namespace: azure.mgmt.powerbiembedded +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/powerbiembedded/azure-mgmt-powerbiembedded/azure/mgmt/powerbiembedded +``` From 8060dff4840044ffbcd6a1d775734e8e51d1affb Mon Sep 17 00:00:00 2001 From: "Hong Li(MSFT)" <74638143+v-hongli1@users.noreply.github.com> Date: Mon, 24 Jun 2024 13:56:45 +0800 Subject: [PATCH 229/343] Added `stream-style-serialization: false` in `readme.java.md`. (#29542) * Added `stream-style-serialization: false` in `readme.java.md`. --- specification/storagemover/resource-manager/readme.java.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 specification/storagemover/resource-manager/readme.java.md diff --git a/specification/storagemover/resource-manager/readme.java.md b/specification/storagemover/resource-manager/readme.java.md new file mode 100644 index 000000000000..2d18b4c34847 --- /dev/null +++ b/specification/storagemover/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +stream-style-serialization: false +``` \ No newline at end of file From ec7ee8842bf615c2f0354bf8b5b8725fdac9454a Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Mon, 24 Jun 2024 14:09:03 +0800 Subject: [PATCH 230/343] network, java directive (#29552) --- specification/network/resource-manager/readme.java.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/network/resource-manager/readme.java.md b/specification/network/resource-manager/readme.java.md index 8458778aedc3..acafccae4b47 100644 --- a/specification/network/resource-manager/readme.java.md +++ b/specification/network/resource-manager/readme.java.md @@ -23,6 +23,9 @@ directive: - rename-operation: from: InboundSecurityRule_CreateOrUpdate to: InboundSecurityRuleOperation_CreateOrUpdate + - rename-operation: + from: InboundSecurityRule_Get + to: InboundSecurityRuleOperation_Get - from: vmssNetworkInterface.json where: '$.info' transform: > From a8f672a39048850e4c69f73beca222db0539da03 Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Mon, 24 Jun 2024 17:54:53 +0800 Subject: [PATCH 231/343] Update sdk automation document (#29553) remove openapi hub related steps; change breaking change label property name. --- .../InstallInstructionScriptInputSchema.json | 5 --- documentation/sdkautomation/README.md | 34 +++++-------------- .../SwaggerToSdkConfigSchema.json | 2 +- 3 files changed, 9 insertions(+), 32 deletions(-) diff --git a/documentation/sdkautomation/InstallInstructionScriptInputSchema.json b/documentation/sdkautomation/InstallInstructionScriptInputSchema.json index c2dea969537c..d5befed6f1e6 100644 --- a/documentation/sdkautomation/InstallInstructionScriptInputSchema.json +++ b/documentation/sdkautomation/InstallInstructionScriptInputSchema.json @@ -19,11 +19,6 @@ // az rest --resource -u "{URL}" --output-file {FILENAME} "type": "boolean" }, - "downloadUrlPrefix": { - // All the artifacts will be uploaded and user could access the artifact via - // a link composed by this prefix and artifact filename. - "type": "string" - }, "downloadCommandTemplate": { // Download command template. Replace {URL} and {FILENAME} to get the real command. "type": "string" diff --git a/documentation/sdkautomation/README.md b/documentation/sdkautomation/README.md index 667b1d306688..f87cbaa44556 100644 --- a/documentation/sdkautomation/README.md +++ b/documentation/sdkautomation/README.md @@ -26,9 +26,9 @@ SDK Automation is launched with matrix in azure pipeline. For each language conf - repo: azure-sdk-for-js ``` ``` - 2. For TypeSpec PR, filter the list of tspconfig.yaml: find the `options` config in tspconfig.yaml, and see if the specified language is configure for that tsp-location.yaml. + 2. For TypeSpec PR, filter the list of tspconfig.yaml: find the `options` config in tspconfig.yaml, and see if the specified language emitter is configured. - If the configured language is not found here, generation for this typespec project will be skipped. + If the specific language is not configured here, generation for this typespec project will be skipped. 4. Get `specificationRepositoryConfiguration.json` from spec repo default branch. See [SpecRepoConfig](#specrepoconfig). Get the repo and branch config in the file. @@ -46,19 +46,17 @@ SDK Automation is launched with matrix in azure pipeline. For each language conf 11. Launch __buildScript__ to build the package. Collect the artifacts by config __artifactPathFromFileSearch__. This step could be skipped if it's not defined in [SwaggerToSdkConfig](#swaggertosdkconfig) and it's covered by __generateScript__ and the result could be found in [generateOutput.json](#generateoutput). -12. Upload all the package related artifacts to Azure Storage Blob Container. All the artifact for one package is uploaded in one folder. These file could be downloaded on URL prefixed by __downloadUrlPrefix__ defined in [InstallInstructionScriptInput](#installinstructionscriptinput). It's redirected by openapiHub by design, and for SDK Automation on public repo the redirect don't need auth, but for SDK Automation in private repo it requires microsoft AAD auth. User could authenticate and download via web page oauth in browser or bearer token auth with `az rest --resource` in command line. +12. Launch __changelogScript__ to get changelog and detect breaking change. This step could be skipped if changelog and breaking change could be found in [generateOutput.json](#generateoutput). If breaking change is found, the spec PR will be labelled with `BreakingChange--Sdk`. -13. Launch __changelogScript__ to get changelog and detect breaking change. This step could be skipped if changelog and breaking change could be found in [generateOutput.json](#generateoutput). If breaking change is found, the spec PR will be labelled with `CI-BreakingChange-`. +13. Launch __installInstructionScript__ to get install instruction for that package. This step could be skipped if install instruction could be found in [generateOutput.json](#generateoutput). The lite install instruction will be shown in spec PR comment, the full install instruction will be shown in generated SDK PR. -14. Launch __installInstructionScript__ to get install instruction for that package. This step could be skipped if install instruction could be found in [generateOutput.json](#generateoutput). The lite install instruction will be shown in spec PR comment, the full install instruction will be shown in generated SDK PR. - -15. Commit the package related code in SDK repository. Force push to [GenerationBranch](#generationbranch) in __integrationRepository__. Create or update [GenerationPR](#generationpr) from [GenerationBranch](#generationbranch) to [MainBranch](#mainbranch) in __integrationRepository__. If __integrationRepository__ is a fork of __mainRepository__, its [MainBranch](#mainbranch) should be synced once a day. +14. Commit the package related code in SDK repository. Force push to [GenerationBranch](#generationbranch) in __integrationRepository__. Create or update [GenerationPR](#generationpr) from [GenerationBranch](#generationbranch) to [MainBranch](#mainbranch) in __integrationRepository__. If __integrationRepository__ is a fork of __mainRepository__, its [MainBranch](#mainbranch) should be synced once a day. ### Continuous Integration (PR Merged) Trigger -Almost the same as opened PR trigger, with different on step 15: +Almost the same as opened PR trigger, with different on step 14: -15. Commit the package related code in SDK repository. Close [GenerationPR](#generationpr) and delete [GenerationBranch](#generationbranch). Force push to [IntegrationBranch](#integrationbranch) in __integrationRepository__. Create or update [IntegrationPR](#integrationpr) from [IntegrationBranch](#integrationbranch) to [MainBranch](#mainbranch) in __mainRepository__. Close the [integrationPR](#integrationPR) if __closeIntegrationPR__ in [SwaggerToSdkConfig](#swaggertosdkconfig) is set to true. +14. Commit the package related code in SDK repository. Close [GenerationPR](#generationpr) and delete [GenerationBranch](#generationbranch). Force push to [IntegrationBranch](#integrationbranch) in __integrationRepository__. Create or update [IntegrationPR](#integrationpr) from [IntegrationBranch](#integrationbranch) to [MainBranch](#mainbranch) in __mainRepository__. Close the [integrationPR](#integrationPR) if __closeIntegrationPR__ in [SwaggerToSdkConfig](#swaggertosdkconfig) is set to true. ## Definitions @@ -78,16 +76,6 @@ This is type of file `./specificationRepositoryConfiguration.json` in swagger sp "integrationRepository": "AzureSDKAutomation/azure-sdk-for-python", "mainRepository": "Azure/azure-sdk-for-python", "mainBranch": "release/v3" - }, - "azure-sdk-for-python-track2": { - "integrationRepository": "AzureSDKAutomation/azure-sdk-for-python", - "mainRepository": "Azure/azure-sdk-for-python" - }, - "azure-sdk-for-trenton": { - "integrationRepository": "Azure/azure-sdk-for-trenton", - "mainRepository": "Azure/azure-sdk-for-trenton", - "secondaryRepository": "Azure/azure-sdk-for-trenton", - "secondaryBranch": "secondary" } }, "overrides": { @@ -101,10 +89,6 @@ This is type of file `./specificationRepositoryConfiguration.json` in swagger sp "integrationRepository": "azure-sdk/azure-sdk-for-python-pr", "mainRepository": "Azure/azure-sdk-for-python-pr", "mainBranch": "release/v3" - }, - "azure-sdk-for-python-track2": { - "integrationRepository": "azure-sdk/azure-sdk-for-python-pr", - "mainRepository": "Azure/azure-sdk-for-python-pr" } } } @@ -175,7 +159,7 @@ The working folder of all the scripts is the __root folder of sdk repo__. "breakingChangeDetect": "Breaking Change" }, - "breakingChangeLabel": "CI-BreakingChange-DotNet" + "breakingChangesLabel": "BreakingChange-DotNet-Sdk" }, "artifactOptions": { // Param: @@ -214,7 +198,6 @@ Input file for generate script. ], "installInstructionInput": { "isPublic": false, - "downloadUrlPrefix": "https://openapihub.test.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/1234/azure-sdk-for-net/", "downloadCommandTemplate": "curl -L \"{URL}\" -o {FILENAME}", "trigger": "pullRequest" } @@ -278,7 +261,6 @@ Input of install instruction script. "sdk/cdn/cdn.snuget" ], "isPublic": true, - "downloadUrlPrefix": "https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/azure-rest-api-specs/1234/azure-sdk-for-net/", "downloadCommandTemplate": "curl -L \"{URL}\" -o {FILENAME}", "trigger": "pullRequest", } diff --git a/documentation/sdkautomation/SwaggerToSdkConfigSchema.json b/documentation/sdkautomation/SwaggerToSdkConfigSchema.json index b9c73b0d9cec..31a1a7c1b3f5 100644 --- a/documentation/sdkautomation/SwaggerToSdkConfigSchema.json +++ b/documentation/sdkautomation/SwaggerToSdkConfigSchema.json @@ -149,7 +149,7 @@ } } }, - "breakingChangeLabel": { + "breakingChangesLabel": { // Label to be added in spec PR if breaking change is found "type": "string" } From f28f14c35918513bd3c3cf9f30d31ee192602525 Mon Sep 17 00:00:00 2001 From: Almas Khan <162407742+almasak@users.noreply.github.com> Date: Mon, 24 Jun 2024 17:01:52 +0530 Subject: [PATCH 232/343] Make "marketplaceSubscriptionId" an optional field for "MarketplaceDetails" (#29541) --- specification/informatica/Informatica.DataManagement/main.tsp | 2 +- .../Informatica.DataManagement/stable/2024-05-08/openapi.json | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/informatica/Informatica.DataManagement/main.tsp b/specification/informatica/Informatica.DataManagement/main.tsp index 5d4910d75a44..086574ad2a0d 100644 --- a/specification/informatica/Informatica.DataManagement/main.tsp +++ b/specification/informatica/Informatica.DataManagement/main.tsp @@ -303,7 +303,7 @@ model CompanyDetails { @doc("Marketplace details.") model MarketplaceDetails { @doc("Marketplace Subscription Id") - marketplaceSubscriptionId: string; + marketplaceSubscriptionId?: string; @doc("Marketplace offer details.") offerDetails: OfferDetails; diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json index 8ef8c019e494..75f73e977db1 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json @@ -1594,7 +1594,6 @@ } }, "required": [ - "marketplaceSubscriptionId", "offerDetails" ] }, From 710e53caaa5ac6747e597b5e411ea403fee1c211 Mon Sep 17 00:00:00 2001 From: Badea Marjieh <127952241+badeamarjieh@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:30:14 +0300 Subject: [PATCH 233/343] Introduce Microsoft Fabric ARM Rest APIs (#29355) * 2023-11-01 * . * fix json file name * update resume and suspend operations * update examples of resume and suspend * fixed json format * resolve comments * . * . * . * update description * updating State model to ResourceState * fix comments --- .../Microsoft.Fabric.Management/capacity.tsp | 69 ++ ...abricCapacities_CheckNameAvailability.json | 20 + .../FabricCapacities_CreateOrUpdate.json | 85 ++ .../2023-11-01/FabricCapacities_Delete.json | 14 + .../2023-11-01/FabricCapacities_Get.json | 35 + .../FabricCapacities_ListByResourceGroup.json | 59 + .../FabricCapacities_ListBySubscription.json | 58 + .../2023-11-01/FabricCapacities_ListSkus.json | 44 + .../FabricCapacities_ListSkusForCapacity.json | 95 ++ .../2023-11-01/FabricCapacities_Resume.json | 18 + .../2023-11-01/FabricCapacities_Suspend.json | 18 + .../2023-11-01/FabricCapacities_Update.json | 52 + .../examples/2023-11-01/Operations_List.json | 65 + .../Microsoft.Fabric.Management/main.tsp | 29 + .../Microsoft.Fabric.Management/models.tsp | 168 +++ .../tspconfig.yaml | 12 + ...abricCapacities_CheckNameAvailability.json | 20 + .../FabricCapacities_CreateOrUpdate.json | 85 ++ .../examples/FabricCapacities_Delete.json | 14 + .../examples/FabricCapacities_Get.json | 35 + .../FabricCapacities_ListByResourceGroup.json | 59 + .../FabricCapacities_ListBySubscription.json | 58 + .../examples/FabricCapacities_ListSkus.json | 44 + .../FabricCapacities_ListSkusForCapacity.json | 95 ++ .../examples/FabricCapacities_Resume.json | 18 + .../examples/FabricCapacities_Suspend.json | 18 + .../examples/FabricCapacities_Update.json | 52 + .../2023-11-01/examples/Operations_List.json | 65 + .../stable/2023-11-01/fabric.json | 1088 +++++++++++++++++ .../fabric/resource-manager/readme.az.md | 28 + .../fabric/resource-manager/readme.cli.md | 1 + .../fabric/resource-manager/readme.csharp.md | 15 + .../fabric/resource-manager/readme.go.md | 11 + .../fabric/resource-manager/readme.md | 78 ++ .../fabric/resource-manager/readme.python.md | 20 + .../resource-manager/readme.typescript.md | 14 + 36 files changed, 2659 insertions(+) create mode 100644 specification/fabric/Microsoft.Fabric.Management/capacity.tsp create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_CheckNameAvailability.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_CreateOrUpdate.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Get.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListByResourceGroup.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListBySubscription.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListSkus.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListSkusForCapacity.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Resume.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Suspend.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/Operations_List.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/main.tsp create mode 100644 specification/fabric/Microsoft.Fabric.Management/models.tsp create mode 100644 specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_CheckNameAvailability.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_CreateOrUpdate.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Get.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListByResourceGroup.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListBySubscription.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListSkus.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListSkusForCapacity.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Resume.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Suspend.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/Operations_List.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json create mode 100644 specification/fabric/resource-manager/readme.az.md create mode 100644 specification/fabric/resource-manager/readme.cli.md create mode 100644 specification/fabric/resource-manager/readme.csharp.md create mode 100644 specification/fabric/resource-manager/readme.go.md create mode 100644 specification/fabric/resource-manager/readme.md create mode 100644 specification/fabric/resource-manager/readme.python.md create mode 100644 specification/fabric/resource-manager/readme.typescript.md diff --git a/specification/fabric/Microsoft.Fabric.Management/capacity.tsp b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp new file mode 100644 index 000000000000..0f44dbf03559 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp @@ -0,0 +1,69 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using Azure.ResourceManager; + +namespace Microsoft.Fabric; + +/** Fabric Capacity resource */ +model FabricCapacity is TrackedResource { + @doc("The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.") + @maxLength(63) + @minLength(3) + @pattern("^[a-z][a-z0-9]*$") + @key("capacityName") + @path + @segment("capacities") + @visibility("read") + name: string; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "The standard ResourceSkuProperty does not fit our case" + @doc("The SKU details") + sku: RpSku; +} + +@armResourceOperations +interface FabricCapacities { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrReplaceAsync; + update is ArmResourcePatchSync; + delete is ArmResourceDeleteSync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; + + @doc("Resume operation of the specified Fabric capacity instance.") + resume is ArmResourceActionNoResponseContentAsync; + + @doc("Suspend operation of the specified Fabric capacity instance.") + suspend is ArmResourceActionNoResponseContentAsync; + + checkNameAvailability is checkLocalNameAvailability; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "" + @get + @doc("List eligible SKUs for a Microsoft Fabric resource") + @segment("skus") + listSkusForCapacity( + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Foundations.DefaultProviderNamespace, + ...CapacityNameParameter, + ): RpSkuEnumerationForExistingResourceResult | ErrorResponse; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "" + @get + @doc("List eligible SKUs for Microsoft Fabric resource provider") + @segment("skus") + listSkus( + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...Azure.ResourceManager.Foundations.DefaultProviderNamespace, + ): RpSkuEnumerationForNewResourceResult | ErrorResponse; +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_CheckNameAvailability.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_CheckNameAvailability.json new file mode 100644 index 000000000000..e36fd699e1a3 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "title": "Check name availability of a capacity", + "operationId": "FabricCapacities_CheckNameAvailability", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "location": "westcentralus", + "body": { + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_CreateOrUpdate.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_CreateOrUpdate.json new file mode 100644 index 000000000000..568d4dcaa4d4 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "title": "Create or update a capacity", + "operationId": "FabricCapacities_CreateOrUpdate", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest", + "resource": { + "properties": { + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + }, + "body": { + "properties": { + "provisioningState": "Updating", + "state": "Preparing", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + }, + "body": { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json new file mode 100644 index 000000000000..decf9a4809f8 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json @@ -0,0 +1,14 @@ +{ + "title": "Delete a capacity", + "operationId": "FabricCapacities_Delete", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Get.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Get.json new file mode 100644 index 000000000000..c0d412381579 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Get.json @@ -0,0 +1,35 @@ +{ + "title": "Get a capacity", + "operationId": "FabricCapacities_Get", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListByResourceGroup.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListByResourceGroup.json new file mode 100644 index 000000000000..81f1a5643711 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "List capacities by resource group", + "operationId": "FabricCapacities_ListByResourceGroup", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + }, + { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F4", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2", + "name": "azsdktest2", + "type": "Microsoft.Fabric/capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListBySubscription.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListBySubscription.json new file mode 100644 index 000000000000..64fed8b9cf88 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "List capacities by subscription", + "operationId": "FabricCapacities_ListBySubscription", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + }, + { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F4", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2", + "name": "azsdktest2", + "type": "Microsoft.Fabric/capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListSkus.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListSkus.json new file mode 100644 index 000000000000..157513675f2f --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListSkus.json @@ -0,0 +1,44 @@ +{ + "title": "List eligible SKUs for a new capacity", + "operationId": "FabricCapacities_ListSkus", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "F8", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F64", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F128", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F512", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListSkusForCapacity.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListSkusForCapacity.json new file mode 100644 index 000000000000..6217e0eb1cab --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_ListSkusForCapacity.json @@ -0,0 +1,95 @@ +{ + "title": "List eligible SKUs for an existing capacity", + "operationId": "FabricCapacities_ListSkusForCapacity", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F16", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F8", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F64", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F1024", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F128", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F2", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F256", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F32", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F4", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F512", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F2048", + "tier": "Fabric" + } + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Resume.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Resume.json new file mode 100644 index 000000000000..ec90eb13207e --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Resume.json @@ -0,0 +1,18 @@ +{ + "title": "Resume capacity", + "operationId": "FabricCapacities_Resume", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760994159&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Suspend.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Suspend.json new file mode 100644 index 000000000000..7507ad604a2f --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Suspend.json @@ -0,0 +1,18 @@ +{ + "title": "Suspend capacity", + "operationId": "FabricCapacities_Suspend", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760994159&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json new file mode 100644 index 000000000000..0dbbee872b7c --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json @@ -0,0 +1,52 @@ +{ + "title": "Update capacity properties", + "operationId": "FabricCapacities_Update", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest", + "properties": { + "sku": { + "name": "F8", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "properties": { + "administration": { + "members": [ + "azsdktest2@microsoft.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F8", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/Operations_List.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/Operations_List.json new file mode 100644 index 000000000000..94865fd32c2e --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/Operations_List.json @@ -0,0 +1,65 @@ +{ + "title": "List operations", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Fabric/capacities/read", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Read Fabric Capacity", + "description": "Retrieves the information of the specified Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/write", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Create/Update Fabric Capacity", + "description": "Creates or updates the specified Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/delete", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Delete the Fabric Capacity", + "description": "Deletes the Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/suspend/action", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Suspend the specified Fabric capacity", + "description": "Suspend the specified Fabric capacity" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/resume/action", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Resume the specified Fabric capacity", + "description": "Resume the specified Fabric capacity" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/main.tsp b/specification/fabric/Microsoft.Fabric.Management/main.tsp new file mode 100644 index 000000000000..f8d6e9530c2b --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/main.tsp @@ -0,0 +1,29 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./capacity.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +/** Microsoft.Fabric Resource Provider management API. */ +@armProviderNamespace +@service({ + title: "Microsoft.Fabric management service", +}) +@versioned(Microsoft.Fabric.Versions) +namespace Microsoft.Fabric; + +/** The available API versions. */ +enum Versions { + /** 2023-11-01 version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + v2023_11_01: "2023-11-01", +} diff --git a/specification/fabric/Microsoft.Fabric.Management/models.tsp b/specification/fabric/Microsoft.Fabric.Management/models.tsp new file mode 100644 index 000000000000..eed2e67465b5 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/models.tsp @@ -0,0 +1,168 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; + +using TypeSpec.Http; +using Azure.Core; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using OpenAPI; + +namespace Microsoft.Fabric; + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("The Microsoft Fabric capacity properties.") +model FabricCapacityProperties { + @doc("The current deployment state of Microsoft Fabric resource. The provisioningState is to indicate states for resource provisioning.") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("The current state of Microsoft Fabric resource. The state is to indicate more states outside of resource provisioning.") + @visibility("read") + state: ResourceState; + + @doc("The capacity administration") + administration: CapacityAdministration; +} + +@doc("Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource.") +model RpSku { + @doc("The name of the SKU level.") + name: string; + + @doc("The name of the Azure pricing tier to which the SKU applies.") + tier: RpSkuTier; +} + +@doc("The name of the Azure pricing tier to which the SKU applies.") +union RpSkuTier { + string, + + @doc("Fabric tier") + fabric: "Fabric", +} + +@doc("The administration properties of the Fabric capacity resource") +model CapacityAdministration { + @doc("An array of administrator user identities.") + members: Array; +} + +@doc("The provisioning state of the Fabric capacity resource.") +union ProvisioningState { + ResourceProvisioningState, + + /** Resource is deleting */ + Deleting: "Deleting", + + /** Resource is provisioning */ + Provisioning: "Provisioning", + + /** Resource is updating */ + Updating: "Updating", + + string, +} + +@doc("The state of the Fabric capacity resource.") +union ResourceState { + /** Resource is active */ + Active: "Active", + + /** Resource is provisioning */ + Provisioning: "Provisioning", + + /** Resource is failed */ + Failed: "Failed", + + /** Resource is updating */ + Updating: "Updating", + + /** Resource is deleting */ + Deleting: "Deleting", + + /** Resource is suspending */ + Suspending: "Suspending", + + /** Resource is suspended */ + Suspended: "Suspended", + + /** Resource is pausing */ + Pausing: "Pausing", + + /** Resource is paused */ + Paused: "Paused", + + /** Resource is resuming */ + Resuming: "Resuming", + + /** Resource is scaling */ + Scaling: "Scaling", + + /** Resource is preparing */ + Preparing: "Preparing", + + string, +} + +@doc("An object that represents enumerating SKUs for new resources.") +@pagedResult +model RpSkuEnumerationForNewResourceResult { + #suppress "@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers" "" + @doc("The collection of available SKUs for new resources") + value: Array; + + @doc("Url for the next page. Null if no more pages available") + @nextLink + nextLink?: string; +} + +@doc("The SKU details") +model RpSkuDetailsForNewResource { + @doc("The resource type") + resourceType: string; + + ...RpSkuProperties; +} + +@doc("The SKU properties") +model RpSkuProperties { + @doc("The SKU's name") + name: string; + + @doc("The list of available locations for the SKU") + locations: Array; +} + +@doc("An object that represents enumerating SKUs for existing resources") +@pagedResult +model RpSkuEnumerationForExistingResourceResult { + #suppress "@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers" "" + @doc("The SKU details") + value: Array; + + @doc("Url for the next page. Null if no more pages available") + @nextLink + nextLink?: string; +} + +@doc("An object that represents SKU details for existing resources") +model RpSkuDetailsForExistingResource { + @doc("The resource type") + resourceType: string; + + @doc("The SKU details") + sku: RpSku; +} + +@doc("The name of the capacity.") +model CapacityNameParameter { + @doc("The name of the capacity.") + @maxLength(63) + @minLength(3) + @pattern("^[a-z][a-z0-9]*$") + @TypeSpec.Rest.segment("capacities") + @path + capacityName: string; +} diff --git a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml new file mode 100644 index 000000000000..b5074dd778f1 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml @@ -0,0 +1,12 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/fabric.json" + examples-directory: "{project-root}/examples" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_CheckNameAvailability.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_CheckNameAvailability.json new file mode 100644 index 000000000000..e36fd699e1a3 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "title": "Check name availability of a capacity", + "operationId": "FabricCapacities_CheckNameAvailability", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "location": "westcentralus", + "body": { + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_CreateOrUpdate.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_CreateOrUpdate.json new file mode 100644 index 000000000000..568d4dcaa4d4 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "title": "Create or update a capacity", + "operationId": "FabricCapacities_CreateOrUpdate", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest", + "resource": { + "properties": { + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + }, + "body": { + "properties": { + "provisioningState": "Updating", + "state": "Preparing", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + }, + "body": { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json new file mode 100644 index 000000000000..decf9a4809f8 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json @@ -0,0 +1,14 @@ +{ + "title": "Delete a capacity", + "operationId": "FabricCapacities_Delete", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Get.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Get.json new file mode 100644 index 000000000000..c0d412381579 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Get.json @@ -0,0 +1,35 @@ +{ + "title": "Get a capacity", + "operationId": "FabricCapacities_Get", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListByResourceGroup.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListByResourceGroup.json new file mode 100644 index 000000000000..81f1a5643711 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "List capacities by resource group", + "operationId": "FabricCapacities_ListByResourceGroup", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + }, + { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F4", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2", + "name": "azsdktest2", + "type": "Microsoft.Fabric/capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListBySubscription.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListBySubscription.json new file mode 100644 index 000000000000..64fed8b9cf88 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "List capacities by subscription", + "operationId": "FabricCapacities_ListBySubscription", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + }, + { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F4", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2", + "name": "azsdktest2", + "type": "Microsoft.Fabric/capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListSkus.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListSkus.json new file mode 100644 index 000000000000..157513675f2f --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListSkus.json @@ -0,0 +1,44 @@ +{ + "title": "List eligible SKUs for a new capacity", + "operationId": "FabricCapacities_ListSkus", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "F8", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F64", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F128", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F512", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListSkusForCapacity.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListSkusForCapacity.json new file mode 100644 index 000000000000..6217e0eb1cab --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_ListSkusForCapacity.json @@ -0,0 +1,95 @@ +{ + "title": "List eligible SKUs for an existing capacity", + "operationId": "FabricCapacities_ListSkusForCapacity", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F16", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F8", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F64", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F1024", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F128", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F2", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F256", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F32", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F4", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F512", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F2048", + "tier": "Fabric" + } + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Resume.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Resume.json new file mode 100644 index 000000000000..ec90eb13207e --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Resume.json @@ -0,0 +1,18 @@ +{ + "title": "Resume capacity", + "operationId": "FabricCapacities_Resume", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760994159&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Suspend.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Suspend.json new file mode 100644 index 000000000000..7507ad604a2f --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Suspend.json @@ -0,0 +1,18 @@ +{ + "title": "Suspend capacity", + "operationId": "FabricCapacities_Suspend", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760994159&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json new file mode 100644 index 000000000000..0dbbee872b7c --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json @@ -0,0 +1,52 @@ +{ + "title": "Update capacity properties", + "operationId": "FabricCapacities_Update", + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest", + "properties": { + "sku": { + "name": "F8", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "properties": { + "administration": { + "members": [ + "azsdktest2@microsoft.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F8", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/Operations_List.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/Operations_List.json new file mode 100644 index 000000000000..94865fd32c2e --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/Operations_List.json @@ -0,0 +1,65 @@ +{ + "title": "List operations", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Fabric/capacities/read", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Read Fabric Capacity", + "description": "Retrieves the information of the specified Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/write", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Create/Update Fabric Capacity", + "description": "Creates or updates the specified Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/delete", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Delete the Fabric Capacity", + "description": "Deletes the Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/suspend/action", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Suspend the specified Fabric capacity", + "description": "Suspend the specified Fabric capacity" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/resume/action", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Resume the specified Fabric capacity", + "description": "Resume the specified Fabric capacity" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json new file mode 100644 index 000000000000..eb8d87cc9837 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json @@ -0,0 +1,1088 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Fabric management service", + "version": "2023-11-01", + "description": "Microsoft.Fabric Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "FabricCapacities" + }, + { + "name": "Operations" + } + ], + "paths": { + "/providers/Microsoft.Fabric/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Fabric/capacities": { + "get": { + "operationId": "FabricCapacities_ListBySubscription", + "tags": [ + "FabricCapacities" + ], + "description": "List FabricCapacity resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FabricCapacityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List capacities by subscription": { + "$ref": "./examples/FabricCapacities_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Fabric/locations/{location}/checkNameAvailability": { + "post": { + "operationId": "FabricCapacities_CheckNameAvailability", + "tags": [ + "FabricCapacities" + ], + "description": "Implements local CheckNameAvailability operations", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "body", + "in": "body", + "description": "The CheckAvailability request", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check name availability of a capacity": { + "$ref": "./examples/FabricCapacities_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Fabric/skus": { + "get": { + "operationId": "FabricCapacities_ListSkus", + "tags": [ + "FabricCapacities" + ], + "description": "List eligible SKUs for Microsoft Fabric resource provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RpSkuEnumerationForNewResourceResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List eligible SKUs for a new capacity": { + "$ref": "./examples/FabricCapacities_ListSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities": { + "get": { + "operationId": "FabricCapacities_ListByResourceGroup", + "tags": [ + "FabricCapacities" + ], + "description": "List FabricCapacity resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FabricCapacityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List capacities by resource group": { + "$ref": "./examples/FabricCapacities_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}": { + "get": { + "operationId": "FabricCapacities_Get", + "tags": [ + "FabricCapacities" + ], + "description": "Get a FabricCapacity", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FabricCapacity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a capacity": { + "$ref": "./examples/FabricCapacities_Get.json" + } + } + }, + "put": { + "operationId": "FabricCapacities_CreateOrUpdate", + "tags": [ + "FabricCapacities" + ], + "description": "Create a FabricCapacity", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/FabricCapacity" + } + } + ], + "responses": { + "200": { + "description": "Resource 'FabricCapacity' update operation succeeded", + "schema": { + "$ref": "#/definitions/FabricCapacity" + } + }, + "201": { + "description": "Resource 'FabricCapacity' create operation succeeded", + "schema": { + "$ref": "#/definitions/FabricCapacity" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a capacity": { + "$ref": "./examples/FabricCapacities_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "FabricCapacities_Update", + "tags": [ + "FabricCapacities" + ], + "description": "Update a FabricCapacity", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/FabricCapacityUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FabricCapacity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update capacity properties": { + "$ref": "./examples/FabricCapacities_Update.json" + } + } + }, + "delete": { + "operationId": "FabricCapacities_Delete", + "tags": [ + "FabricCapacities" + ], + "description": "Delete a FabricCapacity", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a capacity": { + "$ref": "./examples/FabricCapacities_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/resume": { + "post": { + "operationId": "FabricCapacities_Resume", + "tags": [ + "FabricCapacities" + ], + "description": "Resume operation of the specified Fabric capacity instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Resume capacity": { + "$ref": "./examples/FabricCapacities_Resume.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/skus": { + "get": { + "operationId": "FabricCapacities_ListSkusForCapacity", + "tags": [ + "FabricCapacities" + ], + "description": "List eligible SKUs for a Microsoft Fabric resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CapacityNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RpSkuEnumerationForExistingResourceResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List eligible SKUs for an existing capacity": { + "$ref": "./examples/FabricCapacities_ListSkusForCapacity.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/suspend": { + "post": { + "operationId": "FabricCapacities_Suspend", + "tags": [ + "FabricCapacities" + ], + "description": "Suspend operation of the specified Fabric capacity instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Suspend capacity": { + "$ref": "./examples/FabricCapacities_Suspend.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, + "CapacityAdministration": { + "type": "object", + "description": "The administration properties of the Fabric capacity resource", + "properties": { + "members": { + "type": "array", + "description": "An array of administrator user identities.", + "items": { + "type": "string" + } + } + }, + "required": [ + "members" + ] + }, + "CapacityAdministrationUpdate": { + "type": "object", + "description": "The administration properties of the Fabric capacity resource", + "properties": { + "members": { + "type": "array", + "description": "An array of administrator user identities.", + "items": { + "type": "string" + } + } + } + }, + "FabricCapacity": { + "type": "object", + "description": "Fabric Capacity resource", + "properties": { + "properties": { + "$ref": "#/definitions/FabricCapacityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/RpSku", + "description": "The SKU details" + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "FabricCapacityListResult": { + "type": "object", + "description": "The response of a FabricCapacity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The FabricCapacity items on this page", + "items": { + "$ref": "#/definitions/FabricCapacity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "FabricCapacityProperties": { + "type": "object", + "description": "The Microsoft Fabric capacity properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The current deployment state of Microsoft Fabric resource. The provisioningState is to indicate states for resource provisioning.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/ResourceState", + "description": "The current state of Microsoft Fabric resource. The state is to indicate more states outside of resource provisioning.", + "readOnly": true + }, + "administration": { + "$ref": "#/definitions/CapacityAdministration", + "description": "The capacity administration" + } + }, + "required": [ + "state", + "administration" + ] + }, + "FabricCapacityUpdate": { + "type": "object", + "description": "The type used for update operations of the FabricCapacity.", + "properties": { + "sku": { + "$ref": "#/definitions/RpSkuUpdate", + "description": "The SKU details" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/FabricCapacityUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "FabricCapacityUpdateProperties": { + "type": "object", + "description": "The updatable properties of the FabricCapacity.", + "properties": { + "administration": { + "$ref": "#/definitions/CapacityAdministrationUpdate", + "description": "The capacity administration" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of the Fabric capacity resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Provisioning", + "Updating" + ], + "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": "Deleting", + "value": "Deleting", + "description": "Resource is deleting" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is provisioning" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is updating" + } + ] + }, + "readOnly": true + }, + "ResourceState": { + "type": "string", + "description": "The state of the Fabric capacity resource.", + "enum": [ + "Active", + "Provisioning", + "Failed", + "Updating", + "Deleting", + "Suspending", + "Suspended", + "Pausing", + "Paused", + "Resuming", + "Scaling", + "Preparing" + ], + "x-ms-enum": { + "name": "ResourceState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Resource is active" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is provisioning" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource is failed" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is deleting" + }, + { + "name": "Suspending", + "value": "Suspending", + "description": "Resource is suspending" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "Resource is suspended" + }, + { + "name": "Pausing", + "value": "Pausing", + "description": "Resource is pausing" + }, + { + "name": "Paused", + "value": "Paused", + "description": "Resource is paused" + }, + { + "name": "Resuming", + "value": "Resuming", + "description": "Resource is resuming" + }, + { + "name": "Scaling", + "value": "Scaling", + "description": "Resource is scaling" + }, + { + "name": "Preparing", + "value": "Preparing", + "description": "Resource is preparing" + } + ] + } + }, + "RpSku": { + "type": "object", + "description": "Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU level." + }, + "tier": { + "$ref": "#/definitions/RpSkuTier", + "description": "The name of the Azure pricing tier to which the SKU applies." + } + }, + "required": [ + "name", + "tier" + ] + }, + "RpSkuDetailsForExistingResource": { + "type": "object", + "description": "An object that represents SKU details for existing resources", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type" + }, + "sku": { + "$ref": "#/definitions/RpSku", + "description": "The SKU details" + } + }, + "required": [ + "resourceType", + "sku" + ] + }, + "RpSkuDetailsForNewResource": { + "type": "object", + "description": "The SKU details", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type" + }, + "name": { + "type": "string", + "description": "The SKU's name" + }, + "locations": { + "type": "array", + "description": "The list of available locations for the SKU", + "items": { + "$ref": "#/definitions/Azure.Core.azureLocation" + } + } + }, + "required": [ + "resourceType", + "name", + "locations" + ] + }, + "RpSkuEnumerationForExistingResourceResult": { + "type": "object", + "description": "An object that represents enumerating SKUs for existing resources", + "properties": { + "value": { + "type": "array", + "description": "The SKU details", + "items": { + "$ref": "#/definitions/RpSkuDetailsForExistingResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "Url for the next page. Null if no more pages available" + } + }, + "required": [ + "value" + ] + }, + "RpSkuEnumerationForNewResourceResult": { + "type": "object", + "description": "An object that represents enumerating SKUs for new resources.", + "properties": { + "value": { + "type": "array", + "description": "The collection of available SKUs for new resources", + "items": { + "$ref": "#/definitions/RpSkuDetailsForNewResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "Url for the next page. Null if no more pages available" + } + }, + "required": [ + "value" + ] + }, + "RpSkuProperties": { + "type": "object", + "description": "The SKU properties", + "properties": { + "name": { + "type": "string", + "description": "The SKU's name" + }, + "locations": { + "type": "array", + "description": "The list of available locations for the SKU", + "items": { + "$ref": "#/definitions/Azure.Core.azureLocation" + } + } + }, + "required": [ + "name", + "locations" + ] + }, + "RpSkuTier": { + "type": "string", + "description": "The name of the Azure pricing tier to which the SKU applies.", + "enum": [ + "Fabric" + ], + "x-ms-enum": { + "name": "RpSkuTier", + "modelAsString": true, + "values": [ + { + "name": "fabric", + "value": "Fabric", + "description": "Fabric tier" + } + ] + } + }, + "RpSkuUpdate": { + "type": "object", + "description": "Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU level." + }, + "tier": { + "$ref": "#/definitions/RpSkuTier", + "description": "The name of the Azure pricing tier to which the SKU applies." + } + } + } + }, + "parameters": { + "CapacityNameParameter": { + "name": "capacityName", + "in": "path", + "description": "The name of the capacity.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/fabric/resource-manager/readme.az.md b/specification/fabric/resource-manager/readme.az.md new file mode 100644 index 000000000000..1c2465de50e9 --- /dev/null +++ b/specification/fabric/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: fabric + namespace: azure.mgmt.fabric + package-name: azure-mgmt-fabric +az-output-folder: $(azure-cli-extension-folder)/src/fabric +python-sdk-output-folder: "$(az-output-folder)/azext_fabric/vendored_sdks/fabric" +# add additional configuration here specific for Azure CLI +# refer to the faq.md for more details +``` + + + +This is for command modules that already in azure cli main repo. +``` yaml $(az) && $(target-mode) == 'core' +az: + extensions: fabric + namespace: azure.mgmt.fabric + package-name: azure-mgmt-fabric +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/fabric +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/fabric" +``` \ No newline at end of file diff --git a/specification/fabric/resource-manager/readme.cli.md b/specification/fabric/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c6cf6ad37ea4 --- /dev/null +++ b/specification/fabric/resource-manager/readme.cli.md @@ -0,0 +1 @@ +## CLI Common Settings for all the command line tools \ No newline at end of file diff --git a/specification/fabric/resource-manager/readme.csharp.md b/specification/fabric/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..61d372320715 --- /dev/null +++ b/specification/fabric/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Fabric + output-folder: $(csharp-sdks-folder)/fabric/Microsoft.Fabric/src/Generated +``` \ No newline at end of file diff --git a/specification/fabric/resource-manager/readme.go.md b/specification/fabric/resource-manager/readme.go.md new file mode 100644 index 000000000000..6d0e6a00f5a0 --- /dev/null +++ b/specification/fabric/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/fabric/armfabric +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` \ No newline at end of file diff --git a/specification/fabric/resource-manager/readme.md b/specification/fabric/resource-manager/readme.md new file mode 100644 index 000000000000..8220d50e43fe --- /dev/null +++ b/specification/fabric/resource-manager/readme.md @@ -0,0 +1,78 @@ +# app + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Microsoft.App service. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the app. + +``` yaml +openapi-type: arm +tag: package-2023-11-01 +``` + + +### Tag: package-2023-11-01 + +These settings apply only when `--tag=package-2023-11-01` is specified on the command line. + +```yaml $(tag) == 'package-2023-11-01' +input-file: + - Microsoft.Fabric/stable/2023-11-01/fabric.json +``` +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions + - repo: azure-powershell +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) \ No newline at end of file diff --git a/specification/fabric/resource-manager/readme.python.md b/specification/fabric/resource-manager/readme.python.md new file mode 100644 index 000000000000..d8c35b158a22 --- /dev/null +++ b/specification/fabric/resource-manager/readme.python.md @@ -0,0 +1,20 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.fabric +package-name: azure-mgmt-fabric +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/fabric/azure-mgmt-fabric/azure/mgmt/fabric +``` \ No newline at end of file diff --git a/specification/fabric/resource-manager/readme.typescript.md b/specification/fabric/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..4ce06286e4df --- /dev/null +++ b/specification/fabric/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-fabric" + output-folder: "$(typescript-sdks-folder)/sdk/fabric/arm-fabric" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` \ No newline at end of file From 14e15e4f2218d461afc965d8e92964f032c5aacb Mon Sep 17 00:00:00 2001 From: xiaoxu qi Date: Tue, 25 Jun 2024 00:31:39 +0800 Subject: [PATCH 234/343] add new GA version: 2023-12-30 for Microsoft.DBForMySQL (#29031) * add base commit by copying previous version * update api version * add suppression yaml * add suppression yaml * fix suppression yaml * move suppression.yaml to service folder * fix suppression * fix path * remove migration --- .../2023-12-30/AzureADAdministrator.json | 325 +++++++++++ .../examples/AzureADAdministratorCreate.json | 49 ++ .../examples/AzureADAdministratorDelete.json | 24 + .../examples/AzureADAdministratorGet.json | 25 + .../AzureADAdministratorsListByServer.json | 28 + .../stable/2023-12-30/BackupAndExport.json | 361 ++++++++++++ .../Backups/stable/2023-12-30/Backups.json | 236 ++++++++ .../stable/2023-12-30/LongRunningBackups.json | 323 +++++++++++ .../2023-12-30/examples/BackupAndExport.json | 48 ++ .../stable/2023-12-30/examples/BackupGet.json | 23 + .../stable/2023-12-30/examples/BackupPut.json | 23 + .../examples/BackupsListByServer.json | 126 +++++ .../examples/LongRunningBackup.json | 42 ++ .../examples/LongRunningBackupGet.json | 24 + .../LongRunningBackupsListByServer.json | 27 + .../2023-12-30/examples/ValidateBackup.json | 17 + .../stable/2023-12-30/Configurations.json | 535 ++++++++++++++++++ .../examples/ConfigurationCreateOrUpdate.json | 33 ++ .../2023-12-30/examples/ConfigurationGet.json | 29 + .../examples/ConfigurationUpdate.json | 41 ++ .../examples/ConfigurationsBatchUpdate.json | 71 +++ .../examples/ConfigurationsListByServer.json | 146 +++++ .../stable/2023-12-30/Databases.json | 296 ++++++++++ .../2023-12-30/examples/DatabaseCreate.json | 40 ++ .../2023-12-30/examples/DatabaseDelete.json | 19 + .../2023-12-30/examples/DatabaseGet.json | 22 + .../examples/DatabasesListByServer.json | 34 ++ .../stable/2023-12-30/FirewallRules.json | 306 ++++++++++ .../examples/FirewallRuleCreate.json | 40 ++ .../examples/FirewallRuleDelete.json | 19 + .../2023-12-30/examples/FirewallRuleGet.json | 22 + .../examples/FirewallRulesListByServer.json | 34 ++ .../LogFiles/stable/2023-12-30/LogFiles.json | 147 +++++ .../examples/LogFilesListByServer.json | 28 + .../stable/2023-12-30/Maintenances.json | 371 ++++++++++++ .../2023-12-30/examples/MaintenanceRead.json | 28 + .../examples/MaintenanceUpdate.json | 39 ++ .../examples/MaintenancesListByServer.json | 46 ++ .../mysql/resource-manager/readme.md | 62 +- .../resource-manager/sdk-suppressions.yaml | 12 + specification/mysql/suppressions.yaml | 30 + 41 files changed, 4138 insertions(+), 13 deletions(-) create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/AzureADAdministrator.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorCreate.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorDelete.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorGet.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorsListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/BackupAndExport.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/Backups.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/LongRunningBackups.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupAndExport.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupGet.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupPut.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupsListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackup.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackupGet.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackupsListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/ValidateBackup.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/Configurations.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationCreateOrUpdate.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationGet.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationUpdate.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationsBatchUpdate.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationsListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/Databases.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseCreate.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseDelete.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseGet.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabasesListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Firewall/stable/2023-12-30/FirewallRules.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Firewall/stable/2023-12-30/examples/FirewallRuleCreate.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Firewall/stable/2023-12-30/examples/FirewallRuleDelete.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Firewall/stable/2023-12-30/examples/FirewallRuleGet.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Firewall/stable/2023-12-30/examples/FirewallRulesListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/LogFiles/stable/2023-12-30/LogFiles.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/LogFiles/stable/2023-12-30/examples/LogFilesListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Maintenance/stable/2023-12-30/Maintenances.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Maintenance/stable/2023-12-30/examples/MaintenanceRead.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Maintenance/stable/2023-12-30/examples/MaintenanceUpdate.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/Maintenance/stable/2023-12-30/examples/MaintenancesListByServer.json create mode 100644 specification/mysql/resource-manager/sdk-suppressions.yaml create mode 100644 specification/mysql/suppressions.yaml diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/AzureADAdministrator.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/AzureADAdministrator.json new file mode 100644 index 000000000000..22ae2ba6da1f --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/AzureADAdministrator.json @@ -0,0 +1,325 @@ +{ + "swagger": "2.0", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2023-12-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/administrators/{administratorName}": { + "put": { + "tags": [ + "AzureADAdministrators" + ], + "operationId": "AzureADAdministrators_CreateOrUpdate", + "x-ms-examples": { + "Create an azure ad administrator": { + "$ref": "./examples/AzureADAdministratorCreate.json" + } + }, + "description": "Creates or updates an existing Azure Active Directory administrator.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/AdministratorNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureADAdministrator" + }, + "description": "The required parameters for creating or updating an aad administrator." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureADAdministrator" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AzureADAdministrator" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "AzureADAdministrators" + ], + "operationId": "AzureADAdministrators_Delete", + "x-ms-examples": { + "Delete an azure ad administrator": { + "$ref": "./examples/AzureADAdministratorDelete.json" + } + }, + "description": "Deletes an Azure AD Administrator.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/AdministratorNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "AzureADAdministrators" + ], + "operationId": "AzureADAdministrators_Get", + "x-ms-examples": { + "Get an azure ad administrator": { + "$ref": "./examples/AzureADAdministratorGet.json" + } + }, + "description": "Gets information about an azure ad administrator.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/AdministratorNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureADAdministrator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/administrators": { + "get": { + "tags": [ + "AzureADAdministrators" + ], + "operationId": "AzureADAdministrators_ListByServer", + "x-ms-examples": { + "List Azure AD administrators in a server": { + "$ref": "./examples/AzureADAdministratorsListByServer.json" + } + }, + "description": "List all the AAD administrators in a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdministratorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AdministratorProperties": { + "type": "object", + "properties": { + "administratorType": { + "type": "string", + "description": "Type of the sever administrator.", + "enum": [ + "ActiveDirectory" + ], + "x-ms-enum": { + "name": "AdministratorType", + "modelAsString": true + } + }, + "login": { + "type": "string", + "description": "Login name of the server administrator." + }, + "sid": { + "type": "string", + "description": "SID (object ID) of the server administrator." + }, + "tenantId": { + "type": "string", + "description": "Tenant ID of the administrator." + }, + "identityResourceId": { + "type": "string", + "description": "The resource id of the identity used for AAD Authentication." + } + }, + "description": "The properties of an administrator." + }, + "AzureADAdministrator": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdministratorProperties", + "x-ms-client-flatten": true, + "description": "The properties of an administrator." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Administrator." + }, + "AdministratorListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureADAdministrator" + }, + "description": "The list of azure ad administrator of a server" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A List of azure ad administrators." + } + }, + "parameters": { + "AdministratorNameParameter": { + "name": "administratorName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "ActiveDirectory" + ], + "x-ms-enum": { + "name": "AdministratorName", + "modelAsString": true + }, + "description": "The name of the Azure AD Administrator.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorCreate.json new file mode 100644 index 000000000000..28a33c0f1b55 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorCreate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "mysqltestsvc4", + "administratorName": "ActiveDirectory", + "api-version": "2023-12-30", + "parameters": { + "properties": { + "administratorType": "ActiveDirectory", + "login": "bob@contoso.com", + "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c", + "tenantId": "c12b7025-bfe2-46c1-b463-993b5e4cd467", + "identityResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestsvc4/administrators/ActiveDirectory", + "name": "ActiveDirectory", + "type": "Microsoft.DBforMySQL/flexibleServers/administrators", + "properties": { + "administratorType": "ActiveDirectory", + "login": "bob@contoso.com", + "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c", + "tenantId": "c12b7025-bfe2-46c1-b463-993b5e4cd467", + "identityResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestsvc4/administrators/ActiveDirectory", + "name": "ActiveDirectory", + "type": "Microsoft.DBforMySQL/flexibleServers/administrators", + "properties": { + "administratorType": "ActiveDirectory", + "login": "bob@contoso.com", + "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c", + "tenantId": "c12b7025-bfe2-46c1-b463-993b5e4cd467", + "identityResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi" + } + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorDelete.json new file mode 100644 index 000000000000..eead4ea6971a --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorDelete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "mysqltestsvc4", + "administratorName": "ActiveDirectory", + "api-version": "2023-12-30" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorGet.json new file mode 100644 index 000000000000..26056a05b5b5 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "mysqltestsvc4", + "administratorName": "ActiveDirectory", + "api-version": "2023-12-30" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestsvc4/administrators/ActiveDirectory", + "name": "ActiveDirectory", + "type": "Microsoft.DBforMySQL/flexibleServers/administrators", + "properties": { + "administratorType": "ActiveDirectory", + "login": "bob@contoso.com", + "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c", + "tenantId": "c12b7025-bfe2-46c1-b463-993b5e4cd467", + "identityResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi" + } + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorsListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorsListByServer.json new file mode 100644 index 000000000000..b3a2b45b15ee --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2023-12-30/examples/AzureADAdministratorsListByServer.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "mysqltestsvc4", + "api-version": "2023-12-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestsvc4/administrators/ActiveDirectory", + "name": "ActiveDirectory", + "type": "Microsoft.DBforMySQL/flexibleServers/administrators", + "properties": { + "administratorType": "ActiveDirectory", + "login": "bob@contoso.com", + "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c", + "tenantId": "c12b7025-bfe2-46c1-b463-993b5e4cd467", + "identityResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi" + } + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/BackupAndExport.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/BackupAndExport.json new file mode 100644 index 000000000000..d6fdc32b708d --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/BackupAndExport.json @@ -0,0 +1,361 @@ +{ + "swagger": "2.0", + "consumes": [ + "application/json" + ], + "host": "management.azure.com", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2023-12-30" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backupAndExport": { + "post": { + "tags": [ + "BackupAndExport" + ], + "operationId": "BackupAndExport_Create", + "x-ms-examples": { + "Create and Export Backup": { + "$ref": "./examples/BackupAndExport.json" + } + }, + "description": "Exports the backup of the given server by creating a backup if not existing.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BackupAndExportRequest" + }, + "description": "The required parameters for creating and exporting backup of the given server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupAndExportResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to retrieve the final result after operation completes.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/validateBackup": { + "post": { + "tags": [ + "BackupAndExport" + ], + "operationId": "BackupAndExport_ValidateBackup", + "x-ms-examples": { + "Validate Backup": { + "$ref": "./examples/ValidateBackup.json" + } + }, + "description": "Validates if backup can be performed for given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateBackupResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "BackupRequestBase": { + "description": "BackupRequestBase is the base for all backup request.", + "required": [ + "backupSettings" + ], + "type": "object", + "properties": { + "backupSettings": { + "$ref": "#/definitions/BackupSettings", + "description": "Backup Settings" + } + } + }, + "BackupAndExportRequest": { + "description": "BackupAndExport API Request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupRequestBase" + } + ], + "required": [ + "backupSettings", + "targetDetails" + ], + "properties": { + "targetDetails": { + "$ref": "#/definitions/BackupStoreDetails", + "description": "Backup Target Store Details" + } + } + }, + "BackupStoreDetails": { + "description": "Details about the target where the backup content will be stored.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "FullBackupStoreDetails": { + "description": "FullBackupStoreDetails is used for scenarios where backup data is streamed/copied over to a storage destination.", + "type": "object", + "required": [ + "sasUriList" + ], + "allOf": [ + { + "$ref": "#/definitions/BackupStoreDetails" + } + ], + "properties": { + "sasUriList": { + "description": "SASUriList of storage containers where backup data is to be streamed/copied.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "BackupSettings": { + "description": "Backup Settings", + "type": "object", + "required": [ + "backupName" + ], + "properties": { + "backupName": { + "$ref": "../../../common-types/v1/common-types.json#/definitions/BackupName" + }, + "backupFormat": { + "description": "Backup Format for the current backup. (CollatedFormat is INTERNAL – DO NOT USE)", + "enum": [ + "CollatedFormat", + "Raw" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupFormat", + "modelAsString": true + } + } + } + }, + "ValidateBackupResponseProperties": { + "description": "ValidateBackup Response Properties", + "type": "object", + "properties": { + "numberOfContainers": { + "format": "int32", + "description": "Estimated no of storage containers required for resource data to be backed up.", + "type": "integer" + } + } + }, + "BackupAndExportResponseProperties": { + "description": "BackupAndExport Response Properties", + "type": "object", + "properties": { + "datasourceSizeInBytes": { + "format": "int64", + "description": "Size of datasource in bytes", + "type": "integer" + }, + "dataTransferredInBytes": { + "format": "int64", + "description": "Data transferred in bytes", + "type": "integer" + }, + "backupMetadata": { + "description": "Metadata related to backup to be stored for restoring resource in key-value pairs.", + "type": "string" + } + } + }, + "BackupAndExportResponse": { + "type": "object", + "properties": { + "status": { + "description": "The operation status", + "type": "string", + "enum": [ + "Pending", + "InProgress", + "Succeeded", + "Failed", + "CancelInProgress", + "Canceled" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false, + "values": [ + { + "value": "Pending", + "description": "The operation has been accepted but hasn't started." + }, + { + "value": "InProgress", + "description": "The operation is running" + }, + { + "value": "Succeeded", + "description": "The operation Succeeded" + }, + { + "value": "Failed", + "description": "The operation Failed" + }, + { + "value": "CancelInProgress", + "description": "The cancellation in progress" + }, + { + "value": "Canceled", + "description": "The operation has been Canceled" + } + ] + } + }, + "startTime": { + "description": "Start time", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "End time", + "type": "string", + "format": "date-time" + }, + "percentComplete": { + "description": "Operation progress (0-100).", + "type": "number", + "format": "double", + "minimum": 0, + "maximum": 100 + }, + "properties": { + "$ref": "#/definitions/BackupAndExportResponseProperties", + "x-ms-client-flatten": true, + "description": "The response properties of a backup and export operation." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + ], + "description": "Represents BackupAndExport API Response" + }, + "ValidateBackupResponse": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ValidateBackupResponseProperties", + "x-ms-client-flatten": true, + "description": "The response properties of a pre backup operation." + } + }, + "description": "Represents ValidateBackup API Response" + } + }, + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/Backups.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/Backups.json new file mode 100644 index 000000000000..7ac65cbf406b --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/Backups.json @@ -0,0 +1,236 @@ +{ + "swagger": "2.0", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2023-12-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups/{backupName}": { + "put": { + "tags": [ + "Backups" + ], + "operationId": "Backups_Put", + "x-ms-examples": { + "Create backup for a server": { + "$ref": "./examples/BackupPut.json" + } + }, + "description": "Create backup for a given server with specified backup name.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "x-ms-examples": { + "Get a backup for a server": { + "$ref": "./examples/BackupGet.json" + } + }, + "description": "List all the backups for a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "operationId": "Backups_ListByServer", + "x-ms-examples": { + "List backups for a server": { + "$ref": "./examples/BackupsListByServer.json" + } + }, + "description": "List all the backups for a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServerBackupProperties": { + "type": "object", + "properties": { + "backupType": { + "type": "string", + "description": "Backup type." + }, + "completedTime": { + "type": "string", + "format": "date-time", + "description": "Backup completed time (ISO8601 format)." + }, + "source": { + "type": "string", + "description": "Backup source" + } + }, + "description": "The properties of a server backup." + }, + "ServerBackup": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ServerBackupProperties", + "x-ms-client-flatten": true, + "description": "The properties of a server backup." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Server backup properties" + }, + "ServerBackupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerBackup" + }, + "description": "The list of backups of a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server backups." + } + }, + "parameters": { + "BackupNameParameter": { + "name": "backupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backup.", + "x-ms-parameter-location": "method", + "pattern": "^[-\\w\\._]+$" + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/LongRunningBackups.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/LongRunningBackups.json new file mode 100644 index 000000000000..ebb3a317ef7a --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/LongRunningBackups.json @@ -0,0 +1,323 @@ +{ + "swagger": "2.0", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2023-12-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backupsV2/{backupName}": { + "put": { + "tags": [ + "backupsV2" + ], + "operationId": "LongRunningBackup_Create", + "x-ms-examples": { + "Create backup for a server": { + "$ref": "./examples/LongRunningBackup.json" + } + }, + "description": "Create backup for a given server with specified backup name.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ServerBackupV2" + }, + "description": "The required parameters for creating and exporting backup of the given server." + } + ], + "responses": { + "200": { + "description": "Successfully backup.", + "schema": { + "$ref": "#/definitions/ServerBackupV2" + } + }, + "201": { + "description": "Successfully backup.", + "schema": { + "$ref": "#/definitions/ServerBackupV2" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to retrieve the final result after operation completes.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "backupsV2" + ], + "operationId": "LongRunningBackups_Get", + "x-ms-examples": { + "Get a backup for a server": { + "$ref": "./examples/LongRunningBackupGet.json" + } + }, + "description": "Get backup for a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackupV2" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backupsV2": { + "get": { + "tags": [ + "backupsV2" + ], + "operationId": "LongRunningBackups_List", + "x-ms-examples": { + "List backups for a server": { + "$ref": "./examples/LongRunningBackupsListByServer.json" + } + }, + "description": "List all the backups for a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackupV2ListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "provisioningStateProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of backup resource." + } + }, + "description": "The properties of a server backup." + }, + "ServerBackupPropertiesV2": { + "type": "object", + "properties": { + "backupNameV2": { + "type": "string", + "description": "Backup name" + }, + "backupType": { + "type": "string", + "enum": [ + "FULL" + ], + "x-ms-enum": { + "name": "backupType", + "modelAsString": true + } + }, + "completedTime": { + "type": "string", + "format": "date-time", + "description": "Backup completed time (ISO8601 format)." + }, + "source": { + "type": "string", + "description": "Backup source" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of backup resource." + } + }, + "description": "The properties of a server backup." + }, + "ServerBackupV2": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ServerBackupPropertiesV2", + "x-ms-client-flatten": true, + "description": "The properties of a server backup." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Server backup properties" + }, + "Provisioning": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/provisioningStateProperties", + "x-ms-client-flatten": true, + "description": "The properties of provisioning." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Server backup properties" + }, + "ServerBackupV2ListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerBackupV2" + }, + "description": "The list of backups of a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server backups." + } + }, + "parameters": { + "BackupNameParameter": { + "name": "backupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backup.", + "x-ms-parameter-location": "method", + "pattern": "^[-\\w\\._]+$" + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupAndExport.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupAndExport.json new file mode 100644 index 000000000000..55e56836bd39 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupAndExport.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-12-30", + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "targetDetails": { + "objectType": "FullBackupStoreDetails", + "sasUriList": [ + "sasuri1", + "sasuri2" + ] + }, + "backupSettings": { + "backupName": "customer-backup-name" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/cb9d743d-2140-4e73-b871-cd31abab1d2f/resourceGroups/mrgsumitkumatest1/providers/Microsoft.DBforMySQL/flexibleServers/servermysql-01/backupAndExport/custom-backup101", + "name": "custom-backup101", + "type": "Microsoft.DBforMySQL/flexibleServers/backupAndExport", + "status": "Failed", + "startTime": "2022-12-29T07:34:02.328326Z", + "endTime": "2022-12-29T07:37:05.6406008Z", + "percentComplete": 100, + "properties": { + "datasourceSizeInBytes": 1024, + "dataTransferredInBytes": 1024, + "backupMetadata": "{\"key1\":\"value1\",\"key2\":\"value2\"}" + }, + "error": { + "code": "AggregateException", + "message": "System.AggregateException: One or more errors occurred. (Mismatch in count of number of Commited-Blocks from service.)" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/azureAsyncOperation/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupGet.json new file mode 100644 index 000000000000..11e97d5e876a --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "backupName": "daily_20210615T160516", + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupPut.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupPut.json new file mode 100644 index 000000000000..90b443700ef8 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupPut.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "backupName": "mybackup", + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2022-05-07T07:38:01.1498043+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/customer_20220507t073755_bb392c3b-17c6-4d3f-9742-8479ca87b3ac_mybackup", + "name": "customer_20220507t073755_bb392c3b-17c6-4d3f-9742-8479ca87b3ac_mybackup", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupsListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupsListByServer.json new file mode 100644 index 000000000000..967776dc4364 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/BackupsListByServer.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-16T16:05:23.9243453+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210616T160520", + "name": "daily_20210616T160520", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-17T16:05:28.1247488+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210617T160525", + "name": "daily_20210617T160525", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-18T16:05:32.2736701+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210618T160529", + "name": "daily_20210618T160529", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-19T16:05:36.8603354+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210619T160533", + "name": "daily_20210619T160533", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-20T16:05:41.9200138+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210620T160538", + "name": "daily_20210620T160538", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-21T16:05:48.8528447+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210621T160543", + "name": "daily_20210621T160543", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-22T16:08:06.3121688+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210622T160803", + "name": "daily_20210622T160803", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-22T21:08:10.5057354+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210622T210807", + "name": "daily_20210622T210807", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-23T21:24:16.9401531+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210623T212413", + "name": "daily_20210623T212413", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-24T06:13:31.4962137+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210624T061328", + "name": "daily_20210624T061328", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackup.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackup.json new file mode 100644 index 000000000000..63e1a01d63b7 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "backupName": "testback" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2022-05-07T07:38:01.1498043+00:00", + "provisioningState": "Ready" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backupsV2/customer_20220507t073755_bb392c3b-17c6-4d3f-9742-8479ca87b3ac_mybackup", + "name": "customer_20220507t073755_bb392c3b-17c6-4d3f-9742-8479ca87b3ac_mybackup", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + } + }, + "201": { + "body": { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2022-05-07T07:38:01.1498043+00:00", + "provisioningState": "Ready" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backupsV2/customer_20220507t073755_bb392c3b-17c6-4d3f-9742-8479ca87b3ac_mybackup", + "name": "customer_20220507t073755_bb392c3b-17c6-4d3f-9742-8479ca87b3ac_mybackup", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackupGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackupGet.json new file mode 100644 index 000000000000..070f009ab376 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackupGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "backupName": "daily_20210615T160516", + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00", + "provisioningState": "Ready" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backupsV2/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforMySQL/flexibleServers/backupsV2" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackupsListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackupsListByServer.json new file mode 100644 index 000000000000..1baa3e579276 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/LongRunningBackupsListByServer.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00", + "provisioningState": "Ready" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backupsV2/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforMySQL/flexibleServers/backupsV2" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/ValidateBackup.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/ValidateBackup.json new file mode 100644 index 000000000000..d929d4d78c2d --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/stable/2023-12-30/examples/ValidateBackup.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-12-30", + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "numberOfContainers": 1 + } + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/Configurations.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/Configurations.json new file mode 100644 index 000000000000..233c5973cbea --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/Configurations.json @@ -0,0 +1,535 @@ +{ + "swagger": "2.0", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2023-12-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations/{configurationName}": { + "put": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_CreateOrUpdate", + "x-ms-examples": { + "ConfigurationCreateOrUpdate": { + "$ref": "./examples/ConfigurationCreateOrUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "x-ms-examples": { + "Get a configuration": { + "$ref": "./examples/ConfigurationGet.json" + } + }, + "description": "Gets information about a configuration of server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/updateConfigurations": { + "post": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_BatchUpdate", + "x-ms-examples": { + "ConfigurationList": { + "$ref": "./examples/ConfigurationsBatchUpdate.json" + } + }, + "description": "Update a list of configurations in a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationListForBatchUpdate" + }, + "description": "The parameters for updating a list of server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_ListByServer", + "x-ms-examples": { + "List all configurations for a server": { + "$ref": "./examples/ConfigurationsListByServer.json" + } + }, + "description": "List all the configurations in a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationTagsParameter" + }, + { + "$ref": "#/parameters/ConfigurationKeywordParameter" + }, + { + "$ref": "#/parameters/ConfigurationPageParameter" + }, + { + "$ref": "#/parameters/ConfigurationPageSizeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ConfigurationProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration." + }, + "currentValue": { + "type": "string", + "description": "Current value of the configuration." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the configuration." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "The link used to get the document from community or Azure site." + }, + "defaultValue": { + "type": "string", + "readOnly": true, + "description": "Default value of the configuration." + }, + "dataType": { + "type": "string", + "readOnly": true, + "description": "Data type of the configuration." + }, + "allowedValues": { + "type": "string", + "readOnly": true, + "description": "Allowed values of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration.", + "enum": [ + "system-default", + "user-override" + ], + "x-ms-enum": { + "name": "ConfigurationSource", + "modelAsString": true + } + }, + "isReadOnly": { + "type": "string", + "readOnly": true, + "description": "If is the configuration read only.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsReadOnly", + "modelAsString": true + } + }, + "isConfigPendingRestart": { + "type": "string", + "readOnly": true, + "description": "If is the configuration pending restart or not.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsConfigPendingRestart", + "modelAsString": true + } + }, + "isDynamicConfig": { + "type": "string", + "readOnly": true, + "description": "If is the configuration dynamic.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsDynamicConfig", + "modelAsString": true + } + } + }, + "description": "The properties of a configuration." + }, + "Configuration": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Configuration." + }, + "ConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The list of server configurations." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server configurations." + }, + "ConfigurationForBatchUpdate": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the configuration." + }, + "properties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration." + } + }, + "x-ms-client-flatten": true, + "description": "The properties can be updated for a configuration." + } + }, + "description": "Represents a Configuration." + }, + "ConfigurationListForBatchUpdate": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationForBatchUpdate" + }, + "x-ms-identifiers": [], + "description": "The list of server configurations." + }, + "resetAllToDefault": { + "type": "string", + "description": "Whether to reset all server parameters to default.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "ResetAllToDefault", + "modelAsString": true + } + } + }, + "description": "A list of server configurations to update." + } + }, + "parameters": { + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server configuration.", + "x-ms-parameter-location": "method" + }, + "ConfigurationTagsParameter": { + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "The tags of the server configuration.", + "x-ms-parameter-location": "method" + }, + "ConfigurationKeywordParameter": { + "name": "keyword", + "in": "query", + "required": false, + "type": "string", + "description": "The keyword of the server configuration.", + "x-ms-parameter-location": "method" + }, + "ConfigurationPageParameter": { + "name": "page", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The page of the server configuration.", + "x-ms-parameter-location": "method" + }, + "ConfigurationPageSizeParameter": { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The pageSize of the server configuration.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationCreateOrUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationCreateOrUpdate.json new file mode 100644 index 000000000000..0c024eec69cb --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationCreateOrUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "configurationName": "event_scheduler", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "value": "off", + "source": "user-override" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF,DISABLED", + "source": "user-override" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforMySQL/servers/configurations" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationGet.json new file mode 100644 index 000000000000..47a3f283d895 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "configurationName": "event_scheduler", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "OFF", + "description": "Indicates the status of the Event Scheduler. It is always OFF for a replica server to keep the replication consistency.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationUpdate.json new file mode 100644 index 000000000000..a58b78d4cd38 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "serverName": "testserver", + "configurationName": "event_scheduler", + "resourceGroupName": "testrg", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "value": "on", + "source": "user-override" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler. It is always OFF for a replica server to keep the replication consistency.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "user-override", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationsBatchUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationsBatchUpdate.json new file mode 100644 index 000000000000..89029817bb12 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationsBatchUpdate.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "value": [ + { + "name": "event_scheduler", + "properties": { + "value": "OFF" + } + }, + { + "name": "div_precision_increment", + "properties": { + "value": "8" + } + } + ], + "resetAllToDefault": "False" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler. It is always OFF for a replica server to keep the replication consistency.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "user-override", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Number of digits by which to increase the scale of the result of division operations.", + "defaultValue": "4", + "dataType": "Integer", + "allowedValues": "0-30", + "source": "user-override", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/div_precision_increment", + "name": "div_precision_increment", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationsListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationsListByServer.json new file mode 100644 index 000000000000..7cedc8744908 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2023-12-30/examples/ConfigurationsListByServer.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "page": 1, + "pageSize": 8 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "value": "OFF", + "description": "Tell the server to enable or disable archive engine.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "False", + "isReadOnly": "True" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/archive", + "name": "archive", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "OFF", + "description": "Allow to audit the log.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_enabled", + "name": "audit_log_enabled", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "CONNECTION", + "description": "Select the events to audit logs.", + "defaultValue": "CONNECTION", + "dataType": "Set", + "allowedValues": "DDL,DML_SELECT,DML_NONSELECT,DCL,ADMIN,DML,GENERAL,CONNECTION,TABLE_ACCESS", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_events", + "name": "audit_log_events", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "azure_superuser", + "description": "The comma-separated user list whose commands will not be in the audit logs.", + "defaultValue": "azure_superuser", + "dataType": "String", + "allowedValues": "", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_exclude_users", + "name": "audit_log_exclude_users", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "The comma-separated user list whose commands will be in the audit logs. It takes higher priority if the same user name is found in audit_log_exclude_users.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_include_users", + "name": "audit_log_include_users", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "ON", + "description": "Allow to audit the slow log.", + "defaultValue": "ON", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "True" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_slow_log_enabled", + "name": "audit_slow_log_enabled", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "OFF", + "description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "False", + "isReadOnly": "True" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/auto_generate_certs", + "name": "auto_generate_certs", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "The auto_increment_increment is intended for use with source-to-source replication, and can be used to control the operation of AUTO_INCREMENT columns.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "1-65535", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/auto_increment_increment", + "name": "auto_increment_increment", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/Databases.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/Databases.json new file mode 100644 index 000000000000..35f4bdca4826 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/Databases.json @@ -0,0 +1,296 @@ +{ + "swagger": "2.0", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2023-12-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases/{databaseName}": { + "put": { + "tags": [ + "Databases" + ], + "operationId": "Databases_CreateOrUpdate", + "x-ms-examples": { + "Create a database": { + "$ref": "./examples/DatabaseCreate.json" + } + }, + "description": "Creates a new database or updates an existing database.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "The required parameters for creating or updating a database." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Delete", + "x-ms-examples": { + "Delete a database": { + "$ref": "./examples/DatabaseDelete.json" + } + }, + "description": "Deletes a database.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Get", + "x-ms-examples": { + "Get a database": { + "$ref": "./examples/DatabaseGet.json" + } + }, + "description": "Gets information about a database.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases": { + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_ListByServer", + "x-ms-examples": { + "List databases in a server": { + "$ref": "./examples/DatabasesListByServer.json" + } + }, + "description": "List all the databases in a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DatabaseProperties": { + "type": "object", + "properties": { + "charset": { + "type": "string", + "description": "The charset of the database." + }, + "collation": { + "type": "string", + "description": "The collation of the database." + } + }, + "description": "The properties of a database." + }, + "Database": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseProperties", + "x-ms-client-flatten": true, + "description": "The properties of a database." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Database." + }, + "DatabaseListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "The list of databases housed in a server" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A List of databases." + } + }, + "parameters": { + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseCreate.json new file mode 100644 index 000000000000..52a0985f236f --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseDelete.json new file mode 100644 index 000000000000..f06bcd0c2aa0 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30" + } + }, + "204": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseGet.json new file mode 100644 index 000000000000..b1bbd614f21c --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabaseGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabasesListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabasesListByServer.json new file mode 100644 index 000000000000..57ecfa99d598 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Databases/stable/2023-12-30/examples/DatabasesListByServer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2023-12-30", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db2", + "name": "db2", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/Firewall/stable/2023-12-30/FirewallRules.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Firewall/stable/2023-12-30/FirewallRules.json new file mode 100644 index 000000000000..95a88cbc4150 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/Firewall/stable/2023-12-30/FirewallRules.json @@ -0,0 +1,306 @@ +{ + "swagger": "2.0", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2023-12-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { + "put": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "x-ms-examples": { + "Create a firewall rule": { + "$ref": "./examples/FirewallRuleCreate.json" + } + }, + "description": "Creates a new firewall rule or updates an existing firewall rule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The required parameters for creating or updating a firewall rule." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "x-ms-examples": { + "Delete a firewall rule": { + "$ref": "./examples/FirewallRuleDelete.json" + } + }, + "description": "Deletes a firewall rule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "x-ms-examples": { + "Get a firewall rule": { + "$ref": "./examples/FirewallRuleGet.json" + } + }, + "description": "Gets information about a server firewall rule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules": { + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_ListByServer", + "x-ms-examples": { + "List all firewall rules in a server": { + "$ref": "./examples/FirewallRulesListByServer.json" + } + }, + "description": "List all the firewall rules in a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "FirewallRuleProperties": { + "type": "object", + "properties": { + "startIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The start IP address of the server firewall rule. Must be IPv4 format." + }, + "endIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The end IP address of the server firewall rule. Must be IPv4 format." + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ], + "description": "The properties of a server firewall rule." + }, + "FirewallRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "x-ms-client-flatten": true, + "description": "The properties of a firewall rule." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents a server firewall rule." + }, + "FirewallRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The list of firewall rules in a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of firewall rules." + } + }, + "parameters": { + "FirewallRuleNameParameter": { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server firewall rule.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,79}(? Date: Mon, 24 Jun 2024 14:20:06 -0700 Subject: [PATCH 235/343] fix docs creating bad docstrings in purview (#29558) * fix docs creating bad docstrings in purview * fix ci --- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 8 ++------ .../stable/2023-09-01/purviewdatamap.json | 2 +- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 8e42754d7f19..e7ddc9558184 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -978,12 +978,8 @@ interface Glossary { @doc(""" Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories - separately using - - 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' - and - - 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. + separately using 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' + and 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. """) @route("/atlas/v2/glossary") @get diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index ecda9cc408ec..f2e6eb6c6382 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1604,7 +1604,7 @@ "/atlas/v2/glossary": { "get": { "operationId": "Glossary_List", - "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", + "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", "parameters": [ { "$ref": "#/parameters/AtlasApiVersionParameter" From 0ce2859b2f018adcea3d14346951ff4270dcff3d Mon Sep 17 00:00:00 2001 From: Bavneet Singh <33008256+bavneetsingh16@users.noreply.github.com> Date: Mon, 24 Jun 2024 17:00:12 -0700 Subject: [PATCH 236/343] Microsoft.Kubernetes to add preview version 2024-07-01-preview (#29487) * copy API version from 2024-06-01-preview to 2024-07-01-preview * updating API version to 2024-07-01-preview * update readme files * add configurationSettings parameter for this api version * add secret flag for protectedSettings * update readme file * made gateway as first class param * update to a more appropriate name * fix prettier issue --------- Co-authored-by: Bavneet Singh --- .../2024-07-01-preview/connectedClusters.json | 1134 +++++++++++++++++ ...tersListClusterCredentialResultCSPAAD.json | 30 + ...rsListClusterCredentialResultCSPToken.json | 30 + ...stersListClusterCredentialResultHPAAD.json | 24 + ...ersListClusterCredentialResultHPToken.json | 24 + .../examples/CreateClusterExample.json | 83 ++ .../CreateClusterPrivateLinkExample.json | 89 ++ .../examples/CreateCluster_KindExample.json | 154 +++ .../examples/DeleteClusterExample.json | 18 + .../examples/GetClusterExample.json | 76 ++ .../GetClustersByResourceGroupExample.json | 87 ++ .../GetClustersBySubscriptionExample.json | 86 ++ .../GetProvisionedClusterExample.json | 68 + ...ListConnectedClusterOperationsExample.json | 41 + .../examples/UpdateClusterExample.json | 55 + .../resource-manager/readme.go.md | 10 + .../resource-manager/readme.java.md | 13 + .../resource-manager/readme.md | 11 +- .../resource-manager/readme.ruby.md | 10 + 19 files changed, 2042 insertions(+), 1 deletion(-) create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateClusterPrivateLinkExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateCluster_KindExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/DeleteClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClustersByResourceGroupExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClustersBySubscriptionExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetProvisionedClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ListConnectedClusterOperationsExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/UpdateClusterExample.json diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json new file mode 100644 index 000000000000..08ecfbfada9e --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json @@ -0,0 +1,1134 @@ +{ + "swagger": "2.0", + "info": { + "title": "ConnectedKubernetesClient", + "version": "2024-07-01-preview", + "description": "Azure Connected Cluster Resource Provider API for onboarding a Kubernetes Cluster to Azure Arc" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}": { + "put": { + "summary": "Register a new Kubernetes cluster with Azure Resource Manager.", + "operationId": "ConnectedCluster_Create", + "description": "API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "CreateClusterExample": { + "$ref": "./examples/CreateClusterExample.json" + }, + "CreateCluster_KindExample": { + "$ref": "./examples/CreateCluster_KindExample.json" + }, + "CreateClusterPrivateLinkExample": { + "$ref": "./examples/CreateClusterPrivateLinkExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "name": "ConnectedCluster", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedCluster" + }, + "description": "Parameters supplied to Create a Connected Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "201": { + "description": "Resource creation request accepted", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "summary": "Updates a connected cluster.", + "operationId": "ConnectedCluster_Update", + "description": "API to update certain properties of the connected cluster resource", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "UpdateClusterExample": { + "$ref": "./examples/UpdateClusterExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "name": "ConnectedClusterPatch", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedClusterPatch" + }, + "description": "Parameters supplied to update Connected Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "summary": "Get the properties of the specified connected cluster.", + "operationId": "ConnectedCluster_Get", + "description": "Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClusterExample": { + "$ref": "./examples/GetClusterExample.json" + }, + "GetProvisionedClusterExample": { + "$ref": "./examples/GetProvisionedClusterExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + } + ], + "responses": { + "200": { + "description": "Resource retrieved successfully.", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "summary": "Delete a connected cluster.", + "operationId": "ConnectedCluster_Delete", + "description": "Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "DeleteClusterExample": { + "$ref": "./examples/DeleteClusterExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Resource deletion is in progress" + }, + "204": { + "description": "The resource was not found but the request is well formed" + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}/listClusterUserCredential": { + "post": { + "summary": "Gets cluster user credentials of a connected cluster", + "operationId": "ConnectedCluster_ListClusterUserCredential", + "description": "Gets cluster user credentials of the connected cluster with a specified resource group and name.", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "ListClusterUserCredentialExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultCSPAAD.json" + }, + "ListClusterUserCredentialNonAadExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultCSPToken.json" + }, + "ListClusterUserCredentialCSPExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultHPAAD.json" + }, + "ListClusterUserCredentialNonAadCSPExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultHPToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "required": true, + "name": "Properties", + "schema": { + "$ref": "#/definitions/ListClusterUserCredentialProperties" + }, + "description": "ListClusterUserCredential properties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters": { + "get": { + "summary": "Lists all connected clusters in the given ResourceGroup", + "operationId": "ConnectedCluster_ListByResourceGroup", + "description": "API to enumerate registered connected K8s clusters under a Resource Group", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClustersExample": { + "$ref": "./examples/GetClustersByResourceGroupExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedClusterList" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Kubernetes/connectedClusters": { + "get": { + "summary": "Lists all connected clusters in the given Subscription", + "operationId": "ConnectedCluster_ListBySubscription", + "description": "API to enumerate registered connected K8s clusters under a Subscription", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClustersBySubscriptionExample": { + "$ref": "./examples/GetClustersBySubscriptionExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedClusterList" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Kubernetes/operations": { + "get": { + "description": "Lists all of the available API operations for Connected Cluster resource.", + "operationId": "Operations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListConnectedClusterOperationsExample": { + "$ref": "./examples/ListConnectedClusterOperationsExample.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationList": { + "type": "object", + "description": "The paginated list of connected cluster API operations.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of connected cluster API operations." + }, + "nextLink": { + "type": "string", + "description": "The link to fetch the next page of connected cluster API operations." + } + } + }, + "Operation": { + "type": "object", + "description": "The Connected cluster API operation", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {Microsoft.Kubernetes}/{resource}/{operation}" + }, + "display": { + "type": "object", + "readOnly": true, + "description": "The object that represents the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Service provider: Microsoft.Kubernetes" + }, + "resource": { + "type": "string", + "description": "Connected Cluster Resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "Operation type: Read, write, delete, etc." + }, + "description": { + "type": "string", + "description": "Description of the operation." + } + } + } + } + }, + "ConnectedClusterList": { + "description": "The paginated list of connected Clusters", + "type": "object", + "properties": { + "value": { + "description": "The list of connected clusters", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "nextLink": { + "description": "The link to fetch the next page of connected clusters", + "type": "string" + } + } + }, + "ConnectedCluster": { + "type": "object", + "required": [ + "properties", + "identity" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ConnectedClusterIdentity", + "description": "The identity of the connected cluster." + }, + "kind": { + "$ref": "#/definitions/ConnectedClusterKind", + "description": "The kind of connected cluster." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectedClusterProperties", + "description": "Describes the connected cluster resource properties." + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a connected cluster." + }, + "ConnectedClusterIdentity": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of connected cluster identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.", + "default": "SystemAssigned", + "enum": [ + "None", + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the connected cluster." + }, + "ConnectedClusterKind": { + "type": "string", + "description": "Indicates the kind of Arc connected cluster based on host infrastructure.", + "enum": [ + "ProvisionedCluster" + ], + "x-ms-enum": { + "name": "ConnectedClusterKind", + "modelAsString": true + } + }, + "ConnectedClusterProperties": { + "type": "object", + "required": [ + "agentPublicKeyCertificate" + ], + "properties": { + "agentPublicKeyCertificate": { + "type": "string", + "description": "Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure." + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The Kubernetes version of the connected cluster resource" + }, + "totalNodeCount": { + "readOnly": true, + "type": "integer", + "description": "Number of nodes present in the connected cluster resource" + }, + "totalCoreCount": { + "readOnly": true, + "format": "int32", + "type": "integer", + "description": "Number of CPU cores present in the connected cluster resource" + }, + "agentVersion": { + "readOnly": true, + "type": "string", + "description": "Version of the agent running on the connected cluster resource" + }, + "provisioningState": { + "$ref": "#/definitions/ConnectedClusterProvisioningState", + "description": "Provisioning state of the connected cluster resource." + }, + "distribution": { + "type": "string", + "description": "The Kubernetes distribution running on this connected cluster." + }, + "distributionVersion": { + "type": "string", + "description": "The Kubernetes distribution version on this connected cluster." + }, + "infrastructure": { + "type": "string", + "description": "The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on." + }, + "offering": { + "type": "string", + "readOnly": true, + "description": "Connected cluster offering" + }, + "managedIdentityCertificateExpirationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Expiration time of the managed identity certificate" + }, + "lastConnectivityTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Time representing the last instance when heart beat was received from the cluster" + }, + "connectivityStatus": { + "type": "string", + "readOnly": true, + "description": "Represents the connectivity status of the connected cluster.", + "enum": [ + "Connecting", + "Connected", + "Offline", + "Expired" + ], + "x-ms-enum": { + "name": "ConnectivityStatus", + "modelAsString": true + } + }, + "privateLinkState": { + "type": "string", + "description": "Property which describes the state of private link on a connected cluster resource.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PrivateLinkState", + "modelAsString": true + } + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any." + }, + "azureHybridBenefit": { + "type": "string", + "description": "Indicates whether Azure Hybrid Benefit is opted in", + "enum": [ + "True", + "False", + "NotApplicable" + ], + "default": "NotApplicable", + "x-ms-enum": { + "name": "AzureHybridBenefit", + "modelAsString": true + } + }, + "aadProfile": { + "description": "AAD profile for the connected cluster.", + "$ref": "#/definitions/AadProfile" + }, + "arcAgentProfile": { + "description": "Arc agentry configuration for the provisioned cluster.", + "$ref": "#/definitions/ArcAgentProfile" + }, + "securityProfile": { + "description": "Security profile for the connected cluster.", + "$ref": "#/definitions/SecurityProfile" + }, + "oidcIssuerProfile": { + "description": "Open ID Connect (OIDC) Issuer Profile for the connected cluster.", + "$ref": "#/definitions/OidcIssuerProfile" + }, + "gateway": { + "description": "Details of the gateway used by the Arc router for connectivity.", + "$ref": "#/definitions/Gateway", + "x-nullable": true + }, + "arcAgentryConfigurations": { + "description": "Configuration settings for customizing the behavior of the connected cluster.", + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/ArcAgentryConfigurations" + }, + "x-nullable": true + }, + "miscellaneousProperties": { + "description": "More properties related to the Connected Cluster", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "description": "Properties of the connected cluster." + }, + "CredentialResults": { + "type": "object", + "properties": { + "hybridConnectionConfig": { + "$ref": "#/definitions/HybridConnectionConfig", + "description": "Contains the REP (rendezvous endpoint) and “Sender” access token.", + "readOnly": true + }, + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list of credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "ConnectedClusterProvisioningState": { + "type": "string", + "description": "The current deployment state of connectedClusters.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ConnectedClusterPatch": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectedClusterPatchProperties", + "description": "Describes the connected cluster resource properties that can be updated during PATCH operation." + } + }, + "description": "Object containing updates for patch operations." + }, + "ConnectedClusterPatchProperties": { + "type": "object", + "properties": { + "distribution": { + "type": "string", + "description": "Represents the distribution of the connected cluster" + }, + "distributionVersion": { + "type": "string", + "description": "Represents the Kubernetes distribution version on this connected cluster." + }, + "azureHybridBenefit": { + "type": "string", + "description": "Indicates whether Azure Hybrid Benefit is opted in", + "enum": [ + "True", + "False", + "NotApplicable" + ], + "x-ms-enum": { + "name": "AzureHybridBenefit", + "modelAsString": true + } + } + }, + "description": "Properties which can be patched on the connected cluster resource." + }, + "HybridConnectionConfig": { + "type": "object", + "description": "Contains the REP (rendezvous endpoint) and “Sender” access token.", + "properties": { + "expirationTime": { + "description": "Timestamp when this token will be expired.", + "type": "integer", + "readOnly": true, + "format": "int64" + }, + "hybridConnectionName": { + "description": "Name of the connection", + "type": "string", + "readOnly": true + }, + "relay": { + "description": "Name of the relay.", + "type": "string", + "readOnly": true + }, + "token": { + "description": "Sender access token", + "type": "string", + "readOnly": true + } + } + }, + "AadProfile": { + "type": "object", + "description": "AAD Profile specifies attributes for Azure Active Directory integration.", + "properties": { + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + } + }, + "SecurityProfile": { + "type": "object", + "description": "Security Profile specifies attributes for cluster security features.", + "properties": { + "workloadIdentity": { + "type": "object", + "description": "The workload identity feature webhook.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable or disable the workload identity Webhook" + } + } + } + } + }, + "OidcIssuerProfile": { + "type": "object", + "description": "OIDC Issuer Profile specifies attributes for workload identity integration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable oidc issuer for workload identity integration." + }, + "issuerUrl": { + "type": "string", + "description": "The issuer url for hybrid clusters connected to Arc used for the workload identity feature.", + "readOnly": true + }, + "selfHostedIssuerUrl": { + "type": "string", + "description": "The issuer url for public cloud clusters - AKS, EKS, GKE - used for the workload identity feature." + } + } + }, + "Gateway": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether the gateway for arc router connectivity is enabled." + }, + "resourceId": { + "type": "string", + "description": "The resource ID of the gateway used for the Arc router feature." + } + } + }, + "ArcAgentryConfigurations": { + "type": "object", + "properties": { + "feature": { + "type": "string", + "description": "Specifies the name of the feature for the configuration setting." + }, + "settings": { + "type": "object", + "description": "The configuration settings for the feature that do not contain any sensitive or secret information.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + }, + "protectedSettings": { + "type": "object", + "description": "The configuration settings for the feature that contain any sensitive or secret information.", + "x-nullable": true, + "x-ms-secret": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "ArcAgentProfile": { + "description": "Defines the Arc Agent properties for the clusters.", + "type": "object", + "properties": { + "desiredAgentVersion": { + "type": "string", + "description": "Version of the Arc agents to be installed on the cluster resource" + }, + "agentAutoUpgrade": { + "type": "string", + "description": "Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AutoUpgradeOptions", + "modelAsString": true + } + }, + "systemComponents": { + "type": "array", + "description": "List of system extensions that are installed on the cluster resource.", + "items": { + "$ref": "#/definitions/SystemComponent" + } + }, + "agentErrors": { + "type": "array", + "description": "List of arc agentry and system components errors on the cluster resource.", + "items": { + "$ref": "#/definitions/AgentError" + } + }, + "agentState": { + "type": "string", + "description": "Represents the current state of the Arc agentry and its dependent components.", + "readOnly": true + } + } + }, + "AgentError": { + "description": "Agent Errors if any during agent or system component upgrade.", + "type": "object", + "properties": { + "message": { + "type": "string", + "readOnly": true, + "description": "Agent error message." + }, + "severity": { + "type": "string", + "readOnly": true, + "description": "Severity of the error message." + }, + "component": { + "type": "string", + "readOnly": true, + "description": "Agent component where error message occured." + }, + "time": { + "format": "date-time", + "description": "The timestamp of error occured (UTC).", + "type": "string", + "readOnly": true + } + } + }, + "SystemComponent": { + "description": "System extensions and its current versions installed on the cluster resource.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the system extension" + }, + "userSpecifiedVersion": { + "type": "string", + "description": "Version of the system extension to be installed on the cluster resource." + }, + "majorVersion": { + "type": "integer", + "format": "int32", + "description": "Major Version of the system extension that is currently installed on the cluster resource." + }, + "currentVersion": { + "type": "string", + "readOnly": true, + "description": "Version of the system extension that is currently installed on the cluster resource." + } + } + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdBy": { + "description": "The identity that created the resource.", + "type": "string" + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string" + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string" + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of resource modification (UTC).", + "type": "string" + } + }, + "readOnly": true + }, + "ListClusterUserCredentialProperties": { + "type": "object", + "required": [ + "authenticationMethod", + "clientProxy" + ], + "properties": { + "authenticationMethod": { + "type": "string", + "description": "The mode of client authentication.", + "enum": [ + "Token", + "AAD" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "clientProxy": { + "type": "boolean", + "description": "Boolean value to indicate whether the request is for client side proxy or not" + } + }, + "description": "" + } + }, + "parameters": { + "ClusterNamePathParam": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Kubernetes cluster on which get is called.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json new file mode 100644 index 000000000000..f407b98182f5 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview", + "Properties": { + "authenticationMethod": "AAD", + "clientProxy": true + } + }, + "responses": { + "200": { + "body": { + "hybridConnectionConfig": { + "expirationTime": 1631196183, + "hybridConnectionName": "microsoft.kubernetes/connectedclusters/229dc73f7b07196c79a93d4362d9c7fc4ed34df3e95290d27c56cec2dbb82865/1631185383340987904", + "relay": "azgnrelay-ph0-l1", + "token": "SharedAccessSignature 123456789034675890pbduwegiavifkuw647o02423bbhfouseb" + }, + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json new file mode 100644 index 000000000000..782ef800b5c9 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview", + "Properties": { + "authenticationMethod": "Token", + "clientProxy": true + } + }, + "responses": { + "200": { + "body": { + "hybridConnectionConfig": { + "expirationTime": 1631196183, + "hybridConnectionName": "microsoft.kubernetes/connectedclusters/229dc73f7b07196c79a93d4362d9c7fc4ed34df3e95290d27c56cec2dbb82865/1631185383340987904", + "relay": "azgnrelay-ph0-l1", + "token": "SharedAccessSignature 123456789034675890pbduwegiavifkuw647o02423bbhfouseb" + }, + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json new file mode 100644 index 000000000000..83ad82437eee --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview", + "Properties": { + "authenticationMethod": "AAD", + "clientProxy": false + } + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json new file mode 100644 index 000000000000..6a7b59d40db1 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview", + "Properties": { + "authenticationMethod": "Token", + "clientProxy": false + } + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateClusterExample.json new file mode 100644 index 000000000000..e17e24030cdb --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateClusterExample.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview", + "ConnectedCluster": { + "location": "East US", + "tags": {}, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Succeeded", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Accepted", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable" + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateClusterPrivateLinkExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateClusterPrivateLinkExample.json new file mode 100644 index 000000000000..23c667043861 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateClusterPrivateLinkExample.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview", + "ConnectedCluster": { + "location": "East US", + "tags": {}, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Accepted", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateCluster_KindExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateCluster_KindExample.json new file mode 100644 index 000000000000..dca67137ecb0 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/CreateCluster_KindExample.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview", + "ConnectedCluster": { + "location": "East US", + "tags": {}, + "identity": { + "type": "SystemAssigned" + }, + "kind": "ProvisionedCluster", + "properties": { + "agentPublicKeyCertificate": "", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "oidcIssuerProfile": { + "enabled": true + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "majorVersion": 0 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "kind": "ProvisionedCluster", + "properties": { + "agentPublicKeyCertificate": "", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Succeeded", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "oidcIssuerProfile": { + "enabled": true, + "issuerUrl": "https://oidcdiscovery-northamerica-endpoint-gbcge4adgqebgxev.z01.azurefd.net/885hc665-0g4a-4a4b-732b-e4950new3bed/" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "agentState": "Succeeded", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0", + "majorVersion": 0 + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Accepted", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "oidcIssuerProfile": { + "enabled": true, + "issuerUrl": "https://oidcdiscovery-northamerica-endpoint-gbcge4adgqebgxev.z01.azurefd.net/885hc665-0g4a-4a4b-732b-e4950new3bed/" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "agentState": "Succeeded", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0", + "majorVersion": 0 + } + ] + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/DeleteClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/DeleteClusterExample.json new file mode 100644 index 000000000000..fdfbbe7feaa9 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/DeleteClusterExample.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.Kubernetes/locations/eastasia/operationStatuses/eb4c5b0b-35c7-4de9-8b9c-d51bf24dd729", + "Location": "https://management.azure.com/providers/Microsoft.Kubernetes/locations/eastasia/operationStatuses/eb4c5b0b-35c7-4de9-8b9c-d51bf24dd729*B31BD6830F326F0DAC6966963A274F89A70EDF802817A03F8CC944233B6E6C2E?api-version=2024-07-01-preview&t=638325565717977058&c=MIIHADCCBeigAwIBAgITHgMjMN6vpcEQg2_WbgAAAyMw3jANBgkqhkiG9w0BAQsFADBEMRMwEQYKCZImiZPyLGQBGRYDR0JMMRMwEQYKCZImiZPyLGQBGRYDQU1FMRgwFgYDVQQDEw9BTUUgSW5mcmEgQ0EgMDYwHhcNMjMwODAzMDczNjQzWhcNMjQwNzI4MDczNjQzWjBAMT4wPAYDVQQDEzVhc3luY29wZXJhdGlvbnNpZ25pbmdjZXJ0aWZpY2F0ZS5tYW5hZ2VtZW50LmF6dXJlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKtqtBNpyBDffqSjU2vKc-q1Ku3MtRBZR4VV9i6TdAcmNpVmw6W8QNgsa-z0zaqgCcjkLIFSUySU0_7_r4cjNFPDGVj0Y3gPDesFRunHaZsZoA2l235ZxgkOhmI9Eq_hgRKbBV-_zy1PbegjuigJTDOv4tC_xxRRMMioo273xgqG_kUrJVmb5EpU0OONBJtawx7E17himPHTOSCk6f__KaMY6z55v5motGTAEvs40N_pYLk36d4xWMWAfMSqoQu0fCiDTOBh9fXR1Mix28dh2is83JJOEmTls4gNVGZ4_gVn6DrVk-sPnD5sGs789lwzBSlRdpOoJMUnxOgMEgc_JB0CAwEAAaOCA-0wggPpMCcGCSsGAQQBgjcVCgQaMBgwCgYIKwYBBQUHAwEwCgYIKwYBBQUHAwIwPQYJKwYBBAGCNxUHBDAwLgYmKwYBBAGCNxUIhpDjDYTVtHiE8Ys-hZvdFs6dEoFggvX2K4Py0SACAWQCAQowggHLBggrBgEFBQcBAQSCAb0wggG5MGMGCCsGAQUFBzAChldodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpaW5mcmEvQ2VydHMvQkwyUEtJSU5UQ0EwMi5BTUUuR0JMX0FNRSUyMEluZnJhJTIwQ0ElMjAwNi5jcnQwUwYIKwYBBQUHMAKGR2h0dHA6Ly9jcmwxLmFtZS5nYmwvYWlhL0JMMlBLSUlOVENBMDIuQU1FLkdCTF9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3J0MFMGCCsGAQUFBzAChkdodHRwOi8vY3JsMi5hbWUuZ2JsL2FpYS9CTDJQS0lJTlRDQTAyLkFNRS5HQkxfQU1FJTIwSW5mcmElMjBDQSUyMDA2LmNydDBTBggrBgEFBQcwAoZHaHR0cDovL2NybDMuYW1lLmdibC9haWEvQkwyUEtJSU5UQ0EwMi5BTUUuR0JMX0FNRSUyMEluZnJhJTIwQ0ElMjAwNi5jcnQwUwYIKwYBBQUHMAKGR2h0dHA6Ly9jcmw0LmFtZS5nYmwvYWlhL0JMMlBLSUlOVENBMDIuQU1FLkdCTF9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3J0MB0GA1UdDgQWBBQQBQ6aI7w4CwOrsQOypzq30e50CDAOBgNVHQ8BAf8EBAMCBaAwggEmBgNVHR8EggEdMIIBGTCCARWgggERoIIBDYY_aHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraWluZnJhL0NSTC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsMS5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsMi5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsMy5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsNC5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JsMBcGA1UdIAQQMA4wDAYKKwYBBAGCN3sBATAfBgNVHSMEGDAWgBTxRmjG8cPwKy19i2rhsvm-NfzRQTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAD5C_x4drGztlnmLaCdpAyL9KN3LkK_sr-VeDz0s3SwQ30lixsYUUfohjlbSqgoq5GW7WmEgMVuyHCv3nUc01REq-CK7A2xlhD68sfOKqXdpPFsjDCyVEFxuigozWoM3jh9ffTPLM-0cuvpIUH3sOooWAL0Y2RpShpYCxzE7ufkpuFvrs0SPvDNxn7Ga6gYdqvqXsGni-J8I4mQ5sPmZa23Nqq3RDpkYkMunjIJkX7_3p-mX4Wcnm5j93_oLnn7WRkjMF3gwwCcJGn_2yLAeVeJ8E4TNZA2_mfmwo7zGwRDV0VT4JM6evNGxDXVG9XG3hdGlZaoe_TTL5yyWR4CmM2A&s=oBCOqB7wr6rL3h0KEYh91fsSQOpjJEXV_-trbTwQJpxCgOFmN7OStVj0qiAoxRrAIJtCZHCDQnA_JjawmDlVQM7kkXVg9mg3GSG0ucDBu-G8dqYoEoS7dQu_1GKrEpyzQXCPZ4J9QZy1wDh5MmwftdAqyJ3XjTa5AFHlmnjJJiOQ0NAp4sM94-f5_Ru5ycMUdfjItDz_JjOjzSjsl6HSWMHdjvcqGUmbc7onurDb54T5hpNuioO3ex3YH7NdKP18-i66CsOx2MfidCgL6GGOw-KcVH89BPzXY8nxVqnCE54sc0EAjoyz0FU2pESjdrvJutP4c9HJc2rCJjLkxhujCQ&h=e_aACIZc0Bg5Zoog38uTxuuAtK2U6Zd6X45h4sVfHnM" + } + }, + "204": {} + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClusterExample.json new file mode 100644 index 000000000000..0fc635f16f7f --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClusterExample.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-12-17T07:14:58.865041Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + }, + "securityProfile": { + "workloadIdentity": { + "enabled": true + } + }, + "oidcIssuerProfile": { + "enabled": true, + "issuerUrl": "https://oidcdiscovery-northamerica-endpoint-gbcge4adgqebgxev.z01.azurefd.net/885hc665-0g4a-4a4b-732b-e4950new3bed/" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "agentState": "Failed", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0" + } + ], + "agentErrors": [ + { + "message": "Upgrade failed for agent extension Strato, version not found", + "severity": "Error", + "component": "Strato", + "time": "2020-12-17T07:14:58.865041Z" + } + ] + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClustersByResourceGroupExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClustersByResourceGroupExample.json new file mode 100644 index 000000000000..81e9b899c6f3 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClustersByResourceGroupExample.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + }, + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "XIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.1", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClustersBySubscriptionExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClustersBySubscriptionExample.json new file mode 100644 index 000000000000..0dbc9e1c2cb5 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetClustersBySubscriptionExample.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + }, + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster2", + "name": "connectedCluster2", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "XIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.16.3", + "totalNodeCount": 4, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetProvisionedClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetProvisionedClusterExample.json new file mode 100644 index 000000000000..97deb7f8813f --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/GetProvisionedClusterExample.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-12-17T07:14:58.865041Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "ProvisionedCluster", + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "agentState": "Succeeded", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0", + "majorVersion": 0 + } + ] + }, + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ListConnectedClusterOperationsExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ListConnectedClusterOperationsExample.json new file mode 100644 index 000000000000..af936a3edca8 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/ListConnectedClusterOperationsExample.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Kubernetes/connectedClusters/write", + "display": { + "provider": "Microsoft.connectedClusters", + "resource": "connectedClusters", + "operation": "Create ConnectedCluster", + "description": "Create any ConnectedCluster" + } + }, + { + "name": "Microsoft.Kubernetes/connectedClusters/read", + "display": { + "provider": "Microsoft.Kubernetes", + "resource": "connectedClusters", + "operation": "Get ConnectedCluster", + "description": "Get any ConnectedCluster" + } + }, + { + "name": "Microsoft.Kubernetes/connectedClusters/delete", + "display": { + "provider": "Microsoft.Kubernetes", + "resource": "connectedClusters", + "operation": "Delete ConnectedCluster", + "description": "Delete any ConnectedCluster" + } + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/UpdateClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/UpdateClusterExample.json new file mode 100644 index 000000000000..0b3dfa6da321 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-07-01-preview/examples/UpdateClusterExample.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "ConnectedClusterPatch": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-12-17T07:14:58.865041Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/readme.go.md b/specification/hybridkubernetes/resource-manager/readme.go.md index e86d054f3122..db3aebf46671 100644 --- a/specification/hybridkubernetes/resource-manager/readme.go.md +++ b/specification/hybridkubernetes/resource-manager/readme.go.md @@ -26,6 +26,7 @@ batch: - tag: package-2021-10-01 - tag: package-2022-05-01-preview - tag: package-2022-10-01-preview + - tag: package-2024-07-01-preview ``` ### Tag: package-2020-01-01-preview and go @@ -81,4 +82,13 @@ Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2024-07-01-preview' && $(go) +namespace: hybridkubernetes +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2024-07-01-preview/$(namespace) ``` \ No newline at end of file diff --git a/specification/hybridkubernetes/resource-manager/readme.java.md b/specification/hybridkubernetes/resource-manager/readme.java.md index 393cd5abf1e0..d31caaf9a313 100644 --- a/specification/hybridkubernetes/resource-manager/readme.java.md +++ b/specification/hybridkubernetes/resource-manager/readme.java.md @@ -23,6 +23,7 @@ batch: - tag: package-2021-10-01 - tag: package-2022-05-01-preview - tag: package-2022-10-01-preview + - tag: package-2024-07-01-preview ``` ### Tag: package-2020-01-01-preview and java @@ -97,3 +98,15 @@ java: regenerate-manager: true generate-interface: true ``` +### Tag: package-2024-07-01-preview and java + +These settings apply only when `--tag=package-2024-07-01-preview` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-07-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.hybridkubernetes.v2024_07_01_preview + output-folder: $(azure-libraries-for-java-folder)/hybridkubernetes/resource-manager/v2024_07_01_preview +regenerate-manager: true +generate-interface: true +``` \ No newline at end of file diff --git a/specification/hybridkubernetes/resource-manager/readme.md b/specification/hybridkubernetes/resource-manager/readme.md index ec1567f476d2..0d8fced280ca 100644 --- a/specification/hybridkubernetes/resource-manager/readme.md +++ b/specification/hybridkubernetes/resource-manager/readme.md @@ -27,7 +27,16 @@ These are the global settings for the Kubernetes Connect RP. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-01 +tag: package-2024-07-01-preview +``` + +### Tag: package-2024-07-01-preview + +These settings apply only when `--tag=package-2024-07-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-07-01-preview' +input-file: + - Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json ``` ### Tag: package-preview-2024-06-01 diff --git a/specification/hybridkubernetes/resource-manager/readme.ruby.md b/specification/hybridkubernetes/resource-manager/readme.ruby.md index 11979830cf94..3df813d2d4cc 100644 --- a/specification/hybridkubernetes/resource-manager/readme.ruby.md +++ b/specification/hybridkubernetes/resource-manager/readme.ruby.md @@ -19,6 +19,7 @@ batch: - tag: package-2021-10-01 - tag: package-2022-05-01-preview - tag: package-2022-10-01-preview + - tag: package-2024-07-01-preview ``` ### Tag: package-2020-01-01-preview and ruby @@ -51,6 +52,11 @@ Please also specify `--ruby-sdks-folder=`. +### Tag: package-2024-07-01-preview and ruby + +These settings apply only when `--tag=package-2024-07-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + ```yaml $(tag) == 'package-2020-01-01-preview' && $(ruby) namespace: "Azure::Kubernetes::Mgmt::V2020_01_01_preview" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_hybridkubernetes/lib @@ -74,4 +80,8 @@ output-folder: $(ruby-sdks-folder)/management/azure_mgmt_hybridkubernetes/lib ```yaml $(tag) == 'package-2022-10-01-preview' && $(ruby) namespace: "Azure::Kubernetes::Mgmt::V2022_10_01_preview" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_hybridkubernetes/lib +``` +```yaml $(tag) == 'package-2024-07-01-preview' && $(ruby) +namespace: "Azure::Kubernetes::Mgmt::V2024_07_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_hybridkubernetes/lib ``` \ No newline at end of file From 356aa5174e8eec6ed904bf5ff104595aec8c0411 Mon Sep 17 00:00:00 2001 From: yzt Date: Tue, 25 Jun 2024 11:07:02 +0800 Subject: [PATCH 237/343] Add Web PubSub data plane version 2024-01-01 (#29445) * Add Web PubSub data plane version 2024-01-01 * Add Web PubSub data plane version 2024-01-01 --------- Co-authored-by: Liangying.Wei --- .../examples/HealthApi_GetServiceStatus.json | 8 + .../WebPubSub_AddConnectionToGroup.json | 11 + .../WebPubSub_AddConnectionsToGroups.json | 16 + .../examples/WebPubSub_AddUserToGroup.json | 11 + .../examples/WebPubSub_CheckPermission.json | 13 + .../WebPubSub_CloseAllConnections.json | 10 + .../examples/WebPubSub_CloseConnection.json | 11 + .../WebPubSub_CloseGroupConnections.json | 11 + .../WebPubSub_CloseUserConnections.json | 11 + .../examples/WebPubSub_ConnectionExists.json | 11 + .../WebPubSub_GenerateClientToken.json | 16 + .../examples/WebPubSub_GrantPermission.json | 12 + .../examples/WebPubSub_GroupExists.json | 11 + ...bPubSub_RemoveConnectionFromAllGroups.json | 10 + .../WebPubSub_RemoveConnectionFromGroup.json | 11 + ...WebPubSub_RemoveConnectionsFromGroups.json | 16 + .../WebPubSub_RemoveUserFromAllGroups.json | 10 + .../WebPubSub_RemoveUserFromGroup.json | 11 + .../examples/WebPubSub_RevokePermission.json | 12 + .../examples/WebPubSub_SendToAll.json | 12 + .../examples/WebPubSub_SendToConnection.json | 12 + .../examples/WebPubSub_SendToGroup.json | 13 + .../examples/WebPubSub_SendToUser.json | 13 + .../examples/WebPubSub_UserExists.json | 11 + .../stable/2024-01-01/webpubsub.json | 1836 +++++++++++++++++ specification/webpubsub/data-plane/readme.md | 13 +- 26 files changed, 2130 insertions(+), 2 deletions(-) create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/HealthApi_GetServiceStatus.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddConnectionToGroup.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddConnectionsToGroups.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddUserToGroup.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CheckPermission.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseAllConnections.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseConnection.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseGroupConnections.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseUserConnections.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_ConnectionExists.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GenerateClientToken.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GrantPermission.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GroupExists.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionFromAllGroups.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionFromGroup.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionsFromGroups.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveUserFromAllGroups.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveUserFromGroup.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RevokePermission.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToAll.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToConnection.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToGroup.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToUser.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_UserExists.json create mode 100644 specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/webpubsub.json diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/HealthApi_GetServiceStatus.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/HealthApi_GetServiceStatus.json new file mode 100644 index 000000000000..c3fad1730f70 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/HealthApi_GetServiceStatus.json @@ -0,0 +1,8 @@ +{ + "parameters": { + "api-version": "2024-01-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddConnectionToGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddConnectionToGroup.json new file mode 100644 index 000000000000..c50287566ac8 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddConnectionToGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "group": "group1", + "connectionId": "connection1" + }, + "responses": { + "200": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddConnectionsToGroups.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddConnectionsToGroups.json new file mode 100644 index 000000000000..305f1102db5f --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddConnectionsToGroups.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "groupsToAdd": { + "groups": [ + "group1", + "group2" + ], + "filter": "startswith(userId, 'listener-')" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddUserToGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddUserToGroup.json new file mode 100644 index 000000000000..6e80ae590e77 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_AddUserToGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "group": "group1", + "userId": "user1" + }, + "responses": { + "200": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CheckPermission.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CheckPermission.json new file mode 100644 index 000000000000..be403af4609d --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CheckPermission.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "permission": "joinLeaveGroup", + "connectionId": "connection1", + "targetName": "group1" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseAllConnections.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseAllConnections.json new file mode 100644 index 000000000000..5f4ea0292c7a --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseAllConnections.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "reason": "Close reason" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseConnection.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseConnection.json new file mode 100644 index 000000000000..93229123e499 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseConnection.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "connectionId": "connection1", + "reason": "Close reason" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseGroupConnections.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseGroupConnections.json new file mode 100644 index 000000000000..404152162a21 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseGroupConnections.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "group": "group1", + "reason": "Close reason" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseUserConnections.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseUserConnections.json new file mode 100644 index 000000000000..1fcbe8c55ccf --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_CloseUserConnections.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "userId": "user1", + "reason": "Close reason" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_ConnectionExists.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_ConnectionExists.json new file mode 100644 index 000000000000..b41ebcbd154b --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_ConnectionExists.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "connectionId": "connection1" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GenerateClientToken.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GenerateClientToken.json new file mode 100644 index 000000000000..8b1015fd4af3 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GenerateClientToken.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "userId": "user1", + "minutesToExpire": 5, + "clientType": "MQTT" + }, + "responses": { + "200": { + "body": { + "token": "ABCDEFG.ABC.ABC" + } + } + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GrantPermission.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GrantPermission.json new file mode 100644 index 000000000000..0403b11d4b18 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GrantPermission.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "permission": "joinLeaveGroup", + "connectionId": "connection1", + "targetName": "group1" + }, + "responses": { + "200": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GroupExists.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GroupExists.json new file mode 100644 index 000000000000..115192951e37 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_GroupExists.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "group": "group1" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionFromAllGroups.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionFromAllGroups.json new file mode 100644 index 000000000000..920740eaa52c --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionFromAllGroups.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "connectionId": "connection1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionFromGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionFromGroup.json new file mode 100644 index 000000000000..87714ae3c64d --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionFromGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "group": "group1", + "connectionId": "connection1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionsFromGroups.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionsFromGroups.json new file mode 100644 index 000000000000..5002c2094f97 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveConnectionsFromGroups.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "groupsToRemove": { + "groups": [ + "group1", + "group2" + ], + "filter": "startswith(userId, 'listener-')" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveUserFromAllGroups.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveUserFromAllGroups.json new file mode 100644 index 000000000000..30ea8539b82c --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveUserFromAllGroups.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "userId": "user1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveUserFromGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveUserFromGroup.json new file mode 100644 index 000000000000..c56fedbd16f8 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RemoveUserFromGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "group": "group1", + "userId": "user1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RevokePermission.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RevokePermission.json new file mode 100644 index 000000000000..650e07438ced --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_RevokePermission.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "permission": "joinLeaveGroup", + "connectionId": "connection1", + "targetName": "group1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToAll.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToAll.json new file mode 100644 index 000000000000..33caf69c17f1 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToAll.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "filter": "startswith(userId, 'listener-')", + "messageTtlSeconds": 15, + "message": "Message to send" + }, + "responses": { + "202": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToConnection.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToConnection.json new file mode 100644 index 000000000000..2d301e49865a --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToConnection.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "connectionId": "connection1", + "messageTtlSeconds": 15, + "message": "Message to send" + }, + "responses": { + "202": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToGroup.json new file mode 100644 index 000000000000..9ba0d31b7197 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToGroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "group": "group1", + "filter": "startswith(userId, 'listener-')", + "messageTtlSeconds": 15, + "message": "Message to send" + }, + "responses": { + "202": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToUser.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToUser.json new file mode 100644 index 000000000000..f9601e0dd30d --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_SendToUser.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "userId": "user1", + "filter": "startswith(userId, 'listener-')", + "messageTtlSeconds": 15, + "message": "Message to send" + }, + "responses": { + "202": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_UserExists.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_UserExists.json new file mode 100644 index 000000000000..510390d7eb85 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/examples/WebPubSub_UserExists.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "hub": "hub1", + "userId": "user1" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/webpubsub.json b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/webpubsub.json new file mode 100644 index 000000000000..795ca4ec0138 --- /dev/null +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2024-01-01/webpubsub.json @@ -0,0 +1,1836 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Web PubSub Service REST API", + "version": "2024-01-01" + }, + "paths": { + "/api/health": { + "head": { + "tags": [ + "general" + ], + "summary": "Get service health status.", + "operationId": "HealthApi_GetServiceStatus", + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The service is healthy" + }, + "default": { + "description": "Error response" + } + }, + "x-ms-examples": { + "HealthApi_GetServiceStatus": { + "$ref": "./examples/HealthApi_GetServiceStatus.json" + } + } + } + }, + "/api/hubs/{hub}/:addToGroups": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Add filtered connections to multiple groups.", + "operationId": "WebPubSub_AddConnectionsToGroups", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "groupsToAdd", + "description": "Target groups and connection filter.", + "required": true, + "schema": { + "$ref": "#/definitions/AddToGroupsRequest" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_AddConnectionsToGroups": { + "$ref": "./examples/WebPubSub_AddConnectionsToGroups.json" + } + } + } + }, + "/api/hubs/{hub}/:closeConnections": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Close the connections in the hub.", + "operationId": "WebPubSub_CloseAllConnections", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "query", + "name": "excluded", + "description": "Exclude these connectionIds when closing the connections in the hub.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "reason", + "description": "The reason closing the client connection.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_CloseAllConnections": { + "$ref": "./examples/WebPubSub_CloseAllConnections.json" + } + } + } + }, + "/api/hubs/{hub}/:generateToken": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Generate token for the client to connect Azure Web PubSub service.", + "operationId": "WebPubSub_GenerateClientToken", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "query", + "name": "userId", + "description": "User Id.", + "type": "string" + }, + { + "in": "query", + "name": "role", + "description": "Roles that the connection with the generated token will have.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minutesToExpire", + "description": "The expire time of the generated token.", + "type": "integer", + "format": "int32", + "default": 60, + "minimum": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "group", + "description": "Groups that the connection will join when it connects.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "clientType", + "description": "The type of client. Case-insensitive. If not set, it's \"Default\". For Web PubSub for Socket.IO, only the default value is supported. For Web PubSub, the valid values are 'Default' and 'MQTT'.", + "type": "string", + "default": "Default", + "enum": [ + "Default", + "MQTT" + ], + "x-ms-enum": { + "name": "WebPubSubClientType", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ClientTokenResponse" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_GenerateClientToken": { + "$ref": "./examples/WebPubSub_GenerateClientToken.json" + } + } + } + }, + "/api/hubs/{hub}/:removeFromGroups": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Remove filtered connections from multiple groups.", + "operationId": "WebPubSub_RemoveConnectionsFromGroups", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "groupsToRemove", + "description": "Target groups and connection filter.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveFromGroupsRequest" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_RemoveConnectionsFromGroups": { + "$ref": "./examples/WebPubSub_RemoveConnectionsFromGroups.json" + } + } + } + }, + "/api/hubs/{hub}/:send": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Broadcast content inside request body to all the connected client connections.", + "operationId": "WebPubSub_SendToAll", + "consumes": [ + "application/octet-stream", + "text/plain", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "query", + "name": "excluded", + "description": "Excluded connection Ids.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "message", + "description": "The payload body.", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + }, + { + "in": "query", + "name": "filter", + "description": "Following OData filter syntax to filter out the subscribers receiving the messages.", + "type": "string" + }, + { + "in": "query", + "name": "messageTtlSeconds", + "description": "The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited.", + "type": "integer", + "format": "int32", + "maximum": 300, + "minimum": 0 + } + ], + "responses": { + "202": { + "description": "The message is accepted. The service follows fire-and-forget pattern when sending messages." + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_SendToAll": { + "$ref": "./examples/WebPubSub_SendToAll.json" + } + } + } + }, + "/api/hubs/{hub}/connections/{connectionId}": { + "delete": { + "tags": [ + "webpubsub" + ], + "summary": "Close the client connection.", + "operationId": "WebPubSub_CloseConnection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "connectionId", + "description": "Target connection Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "reason", + "description": "The reason closing the client connection.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_CloseConnection": { + "$ref": "./examples/WebPubSub_CloseConnection.json" + } + } + }, + "head": { + "tags": [ + "webpubsub" + ], + "summary": "Check if the connection with the given connectionId exists.", + "operationId": "WebPubSub_ConnectionExists", + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "connectionId", + "description": "The connection Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response", + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_ConnectionExists": { + "$ref": "./examples/WebPubSub_ConnectionExists.json" + } + } + } + }, + "/api/hubs/{hub}/connections/{connectionId}/:send": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Send content inside request body to the specific connection.", + "operationId": "WebPubSub_SendToConnection", + "consumes": [ + "application/octet-stream", + "text/plain", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "connectionId", + "description": "The connection Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "message", + "description": "The payload body.", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + }, + { + "in": "query", + "name": "messageTtlSeconds", + "description": "The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited.", + "type": "integer", + "format": "int32", + "maximum": 300, + "minimum": 0 + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_SendToConnection": { + "$ref": "./examples/WebPubSub_SendToConnection.json" + } + } + } + }, + "/api/hubs/{hub}/connections/{connectionId}/groups": { + "delete": { + "tags": [ + "webpubsub" + ], + "summary": "Remove a connection from all groups.", + "operationId": "WebPubSub_RemoveConnectionFromAllGroups", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "connectionId", + "description": "Target connection Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The connection is removed from all groups." + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_RemoveConnectionFromAllGroups": { + "$ref": "./examples/WebPubSub_RemoveConnectionFromAllGroups.json" + } + } + } + }, + "/api/hubs/{hub}/groups/{group}": { + "head": { + "tags": [ + "webpubsub" + ], + "summary": "Check if there are any client connections inside the given group", + "operationId": "WebPubSub_GroupExists", + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "group", + "description": "Target group name, which length should be greater than 0 and less than 1025.", + "required": true, + "type": "string", + "maxLength": 1024, + "minLength": 1, + "pattern": "^(?!\\s+$).+$" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response", + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_GroupExists": { + "$ref": "./examples/WebPubSub_GroupExists.json" + } + } + } + }, + "/api/hubs/{hub}/groups/{group}/:closeConnections": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Close connections in the specific group.", + "operationId": "WebPubSub_CloseGroupConnections", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "group", + "description": "Target group name, which length should be greater than 0 and less than 1025.", + "required": true, + "type": "string", + "maxLength": 1024, + "minLength": 1, + "pattern": "^(?!\\s+$).+$" + }, + { + "in": "query", + "name": "excluded", + "description": "Exclude these connectionIds when closing the connections in the group.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "reason", + "description": "The reason closing the client connection.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_CloseGroupConnections": { + "$ref": "./examples/WebPubSub_CloseGroupConnections.json" + } + } + } + }, + "/api/hubs/{hub}/groups/{group}/:send": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Send content inside request body to a group of connections.", + "operationId": "WebPubSub_SendToGroup", + "consumes": [ + "application/octet-stream", + "text/plain", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "group", + "description": "Target group name, which length should be greater than 0 and less than 1025.", + "required": true, + "type": "string", + "maxLength": 1024, + "minLength": 1, + "pattern": "^(?!\\s+$).+$" + }, + { + "in": "query", + "name": "excluded", + "description": "Excluded connection Ids", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "message", + "description": "The payload body.", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + }, + { + "in": "query", + "name": "filter", + "description": "Following OData filter syntax to filter out the subscribers receiving the messages.", + "type": "string" + }, + { + "in": "query", + "name": "messageTtlSeconds", + "description": "The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited.", + "type": "integer", + "format": "int32", + "maximum": 300, + "minimum": 0 + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_SendToGroup": { + "$ref": "./examples/WebPubSub_SendToGroup.json" + } + } + } + }, + "/api/hubs/{hub}/groups/{group}/connections/{connectionId}": { + "delete": { + "tags": [ + "webpubsub" + ], + "summary": "Remove a connection from the target group.", + "operationId": "WebPubSub_RemoveConnectionFromGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "group", + "description": "Target group name, which length should be greater than 0 and less than 1025.", + "required": true, + "type": "string", + "maxLength": 1024, + "minLength": 1, + "pattern": "^(?!\\s+$).+$" + }, + { + "in": "path", + "name": "connectionId", + "description": "Target connection Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_RemoveConnectionFromGroup": { + "$ref": "./examples/WebPubSub_RemoveConnectionFromGroup.json" + } + } + }, + "put": { + "tags": [ + "webpubsub" + ], + "summary": "Add a connection to the target group.", + "operationId": "WebPubSub_AddConnectionToGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "group", + "description": "Target group name, which length should be greater than 0 and less than 1025.", + "required": true, + "type": "string", + "maxLength": 1024, + "minLength": 1, + "pattern": "^(?!\\s+$).+$" + }, + { + "in": "path", + "name": "connectionId", + "description": "Target connection Id", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_AddConnectionToGroup": { + "$ref": "./examples/WebPubSub_AddConnectionToGroup.json" + } + } + } + }, + "/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}": { + "delete": { + "tags": [ + "webpubsub" + ], + "summary": "Revoke permission for the connection.", + "operationId": "WebPubSub_RevokePermission", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "permission", + "description": "The permission: current supported actions are joinLeaveGroup and sendToGroup.", + "required": true, + "type": "string", + "enum": [ + "sendToGroup", + "joinLeaveGroup" + ], + "x-ms-enum": { + "name": "WebPubSubPermission", + "modelAsString": true + } + }, + { + "in": "path", + "name": "connectionId", + "description": "Target connection Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "targetName", + "description": "The meaning of the target depends on the specific permission. For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_RevokePermission": { + "$ref": "./examples/WebPubSub_RevokePermission.json" + } + } + }, + "head": { + "tags": [ + "webpubsub" + ], + "summary": "Check if a connection has permission to the specified action.", + "operationId": "WebPubSub_CheckPermission", + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "permission", + "description": "The permission: current supported actions are joinLeaveGroup and sendToGroup.", + "required": true, + "type": "string", + "enum": [ + "sendToGroup", + "joinLeaveGroup" + ], + "x-ms-enum": { + "name": "WebPubSubPermission", + "modelAsString": true + } + }, + { + "in": "path", + "name": "connectionId", + "description": "Target connection Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "targetName", + "description": "The meaning of the target depends on the specific permission. For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response", + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_CheckPermission": { + "$ref": "./examples/WebPubSub_CheckPermission.json" + } + } + }, + "put": { + "tags": [ + "webpubsub" + ], + "summary": "Grant permission to the connection.", + "operationId": "WebPubSub_GrantPermission", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "permission", + "description": "The permission: current supported actions are joinLeaveGroup and sendToGroup.", + "required": true, + "type": "string", + "enum": [ + "sendToGroup", + "joinLeaveGroup" + ], + "x-ms-enum": { + "name": "WebPubSubPermission", + "modelAsString": true + } + }, + { + "in": "path", + "name": "connectionId", + "description": "Target connection Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "targetName", + "description": "The meaning of the target depends on the specific permission. For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_GrantPermission": { + "$ref": "./examples/WebPubSub_GrantPermission.json" + } + } + } + }, + "/api/hubs/{hub}/users/{userId}": { + "head": { + "tags": [ + "webpubsub" + ], + "summary": "Check if there are any client connections connected for the given user.", + "operationId": "WebPubSub_UserExists", + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "userId", + "description": "Target user Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response", + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_UserExists": { + "$ref": "./examples/WebPubSub_UserExists.json" + } + } + } + }, + "/api/hubs/{hub}/users/{userId}/:closeConnections": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Close connections for the specific user.", + "operationId": "WebPubSub_CloseUserConnections", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "userId", + "description": "The user Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "excluded", + "description": "Exclude these connectionIds when closing the connections for the user.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "reason", + "description": "The reason closing the client connection.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_CloseUserConnections": { + "$ref": "./examples/WebPubSub_CloseUserConnections.json" + } + } + } + }, + "/api/hubs/{hub}/users/{userId}/:send": { + "post": { + "tags": [ + "webpubsub" + ], + "summary": "Send content inside request body to the specific user.", + "operationId": "WebPubSub_SendToUser", + "consumes": [ + "application/octet-stream", + "text/plain", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "userId", + "description": "The user Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "message", + "description": "The payload body.", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + }, + { + "in": "query", + "name": "filter", + "description": "Following OData filter syntax to filter out the subscribers receiving the messages.", + "type": "string" + }, + { + "in": "query", + "name": "messageTtlSeconds", + "description": "The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited.", + "type": "integer", + "format": "int32", + "maximum": 300, + "minimum": 0 + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_SendToUser": { + "$ref": "./examples/WebPubSub_SendToUser.json" + } + } + } + }, + "/api/hubs/{hub}/users/{userId}/groups": { + "delete": { + "tags": [ + "webpubsub" + ], + "summary": "Remove a user from all groups.", + "operationId": "WebPubSub_RemoveUserFromAllGroups", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "userId", + "description": "Target user Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The user is removed from all groups." + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_RemoveUserFromAllGroups": { + "$ref": "./examples/WebPubSub_RemoveUserFromAllGroups.json" + } + } + } + }, + "/api/hubs/{hub}/users/{userId}/groups/{group}": { + "delete": { + "tags": [ + "webpubsub" + ], + "summary": "Remove a user from the target group.", + "operationId": "WebPubSub_RemoveUserFromGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "group", + "description": "Target group name, which length should be greater than 0 and less than 1025.", + "required": true, + "type": "string", + "maxLength": 1024, + "minLength": 1, + "pattern": "^(?!\\s+$).+$" + }, + { + "in": "path", + "name": "userId", + "description": "Target user Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The user is removed from the group." + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_RemoveUserFromGroup": { + "$ref": "./examples/WebPubSub_RemoveUserFromGroup.json" + } + } + }, + "put": { + "tags": [ + "webpubsub" + ], + "summary": "Add a user to the target group.", + "operationId": "WebPubSub_AddUserToGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hub", + "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$" + }, + { + "in": "path", + "name": "group", + "description": "Target group name, which length should be greater than 0 and less than 1025.", + "required": true, + "type": "string", + "maxLength": 1024, + "minLength": 1, + "pattern": "^(?!\\s+$).+$" + }, + { + "in": "path", + "name": "userId", + "description": "Target user Id.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The version of the REST APIs.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-error-response": true, + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "WebPubSub_AddUserToGroup": { + "$ref": "./examples/WebPubSub_AddUserToGroup.json" + } + } + } + } + }, + "definitions": { + "AddToGroupsRequest": { + "description": "The request object containing targets groups and a connection filter", + "type": "object", + "properties": { + "groups": { + "description": "A list of groups which target connections will be added into", + "type": "array", + "items": { + "type": "string" + } + }, + "filter": { + "description": "An OData filter which target connections satisfy", + "type": "string" + } + } + }, + "ClientTokenResponse": { + "description": "The response object containing the token for the client", + "type": "object", + "properties": { + "token": { + "description": "The token value for the WebSocket client to connect to the service", + "type": "string" + } + } + }, + "ErrorDetail": { + "description": "The error object.", + "type": "object", + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "type": "string" + }, + "message": { + "description": "A human-readable representation of the error.", + "type": "string" + }, + "target": { + "description": "The target of the error.", + "type": "string" + }, + "details": { + "description": "An array of details about specific errors that led to this reported error.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "inner": { + "$ref": "#/definitions/InnerError" + } + } + }, + "InnerError": { + "type": "object", + "properties": { + "code": { + "description": "A more specific error code than was provided by the containing error.", + "type": "string" + }, + "inner": { + "$ref": "#/definitions/InnerError" + } + } + }, + "RemoveFromGroupsRequest": { + "description": "The request object containing targets groups and a connection filter", + "type": "object", + "properties": { + "groups": { + "description": "A list of groups which target connections will be removed from", + "type": "array", + "items": { + "type": "string" + } + }, + "filter": { + "description": "An OData filter which target connections satisfy", + "type": "string" + } + } + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "description": "HTTP or HTTPS endpoint for the Web PubSub service instance.", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "format": "url", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + } +} diff --git a/specification/webpubsub/data-plane/readme.md b/specification/webpubsub/data-plane/readme.md index 2af5241e4544..40c7969ad221 100644 --- a/specification/webpubsub/data-plane/readme.md +++ b/specification/webpubsub/data-plane/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Web PubSub Service API. ``` yaml openapi-type: data-plane -tag: package-2023-07-01 +tag: package-2024-01 ``` ### Suppression @@ -40,14 +40,23 @@ directive: ``` +### Tag: package-2024-01 + +These settings apply only when `--tag=package-2024-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-01' +input-file: + - WebPubSub/stable/2024-01-01/webpubsub.json +``` ### Tag: package-2023-07-01 These settings apply only when `--tag=package-2023-07-01` is specified on the command line. -```yaml $(tag) == 'package-2023-07-01' +``` yaml $(tag) == 'package-2023-07-01' input-file: - WebPubSub/stable/2023-07-01/webpubsub.json ``` + ### Tag: package-2022-11-01 These settings apply only when `--tag=package-2022-11-01` is specified on the command line. From 3aef2f96202eec656fca4abc4df0fbfe10b89ac0 Mon Sep 17 00:00:00 2001 From: Mitesh Shah <58204159+mitsha-microsoft@users.noreply.github.com> Date: Tue, 25 Jun 2024 10:35:35 +0530 Subject: [PATCH 238/343] Added 2023-12-01 preview API for Azure Load Testing Control Plane (#29543) * Added 2023-12-01 API Specs and Initial Examples * Added validated examples * Changes in the README and Provisioning State Suppression * Format changes * Pattern on resource names --- .../LoadTestMappings_CreateOrUpdate.json | 58 + .../LoadTestMappings_Delete.json | 13 + .../LoadTestMappings_Get.json | 31 + .../LoadTestMappings_List.json | 34 + .../LoadTestMappings_Update.json | 34 + ...oadTestProfileMappings_CreateOrUpdate.json | 57 + .../LoadTestProfileMappings_Delete.json | 13 + .../LoadTestProfileMappings_Get.json | 31 + .../LoadTestProfileMappings_List.json | 34 + .../LoadTestProfileMappings_Update.json | 34 + .../LoadTests_CreateOrUpdate.json | 121 ++ .../2023-12-01-preview/LoadTests_Delete.json | 18 + .../2023-12-01-preview/LoadTests_Get.json | 36 + .../LoadTests_ListByResourceGroup.json | 39 + .../LoadTests_ListBySubscription.json | 38 + ...tOutboundNetworkDependenciesEndpoints.json | 110 ++ .../2023-12-01-preview/LoadTests_Update.json | 82 + .../2023-12-01-preview/Operations_List.json | 46 + .../Quotas_CheckAvailability.json | 34 + .../2023-12-01-preview/Quotas_Get.json | 23 + .../2023-12-01-preview/Quotas_List.json | 26 + .../LoadTestService.Management/main.tsp | 3 + .../LoadTestService.Management/models.tsp | 61 + .../LoadTestService.Management/routes.tsp | 45 + .../LoadTestMappings_CreateOrUpdate.json | 58 + .../examples/LoadTestMappings_Delete.json | 13 + .../examples/LoadTestMappings_Get.json | 31 + .../examples/LoadTestMappings_List.json | 34 + .../examples/LoadTestMappings_Update.json | 34 + ...oadTestProfileMappings_CreateOrUpdate.json | 57 + .../LoadTestProfileMappings_Delete.json | 13 + .../examples/LoadTestProfileMappings_Get.json | 31 + .../LoadTestProfileMappings_List.json | 34 + .../LoadTestProfileMappings_Update.json | 34 + .../examples/LoadTests_CreateOrUpdate.json | 121 ++ .../examples/LoadTests_Delete.json | 18 + .../examples/LoadTests_Get.json | 36 + .../LoadTests_ListByResourceGroup.json | 39 + .../LoadTests_ListBySubscription.json | 38 + ...tOutboundNetworkDependenciesEndpoints.json | 110 ++ .../examples/LoadTests_Update.json | 82 + .../examples/Operations_List.json | 46 + .../examples/Quotas_CheckAvailability.json | 34 + .../examples/Quotas_Get.json | 23 + .../examples/Quotas_List.json | 26 + .../2023-12-01-preview/loadtestservice.json | 1728 +++++++++++++++++ .../resource-manager/readme.md | 9 + 47 files changed, 3670 insertions(+) create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_CreateOrUpdate.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Delete.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Get.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_List.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Update.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_CreateOrUpdate.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Delete.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Get.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_List.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Update.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_CreateOrUpdate.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Delete.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Get.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListByResourceGroup.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListBySubscription.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListOutboundNetworkDependenciesEndpoints.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Update.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Operations_List.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_CheckAvailability.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_Get.json create mode 100644 specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_List.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_CreateOrUpdate.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Delete.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Get.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_List.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Update.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_CreateOrUpdate.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Delete.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Get.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_List.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Update.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_CreateOrUpdate.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Delete.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Get.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListByResourceGroup.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListBySubscription.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListOutboundNetworkDependenciesEndpoints.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Update.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Operations_List.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_CheckAvailability.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_Get.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_List.json create mode 100644 specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_CreateOrUpdate.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_CreateOrUpdate.json new file mode 100644 index 000000000000..b6847087411c --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "title": "Create a Load Test Mapping Resource", + "operationId": "LoadTestMappings_CreateOrUpdate", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestMappingName": "myLoadTestMapping", + "resource": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1002", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:34:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Delete.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Delete.json new file mode 100644 index 000000000000..688176e1f150 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Delete.json @@ -0,0 +1,13 @@ +{ + "title": "Delete a Load Test Mapping Resource", + "operationId": "LoadTestMappings_Delete", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestMappingName": "myLoadTestMapping" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Get.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Get.json new file mode 100644 index 000000000000..aa5753eb2617 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Get.json @@ -0,0 +1,31 @@ +{ + "title": "Get a Load Test Mapping Resource", + "operationId": "LoadTestMappings_Get", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestMappingName": "myLoadTestMapping" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_List.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_List.json new file mode 100644 index 000000000000..18e0a5a192ba --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_List.json @@ -0,0 +1,34 @@ +{ + "title": "List all Load Test Mappings by Source Resource Id", + "operationId": "LoadTestMappings_List", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Update.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Update.json new file mode 100644 index 000000000000..2b20b6300fb6 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestMappings_Update.json @@ -0,0 +1,34 @@ +{ + "title": "Update a load test mapping", + "operationId": "LoadTestMappings_Update", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestMappingName": "myLoadTestMapping", + "properties": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_CreateOrUpdate.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_CreateOrUpdate.json new file mode 100644 index 000000000000..b99bbc3a7a0d --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "title": "Create a Load Test Profile Mappings resource", + "operationId": "LoadTestProfileMappings_CreateOrUpdate", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestProfileMappingName": "myLoadTestProfileMapping", + "resource": { + "properties": { + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1002", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:34:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Delete.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Delete.json new file mode 100644 index 000000000000..1c9ac22a0fc8 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Delete.json @@ -0,0 +1,13 @@ +{ + "title": "Delete a Load Test Profile Mapping Resource", + "operationId": "LoadTestProfileMappings_Delete", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestProfileMappingName": "myLoadTestProfileMapping" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Get.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Get.json new file mode 100644 index 000000000000..6450e5fa2b39 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Get.json @@ -0,0 +1,31 @@ +{ + "title": "Get a Load Test Profile Mapping Resource", + "operationId": "LoadTestProfileMappings_Get", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestProfileMappingName": "myLoadTestProfileMapping" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_List.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_List.json new file mode 100644 index 000000000000..f6b7653dadc5 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_List.json @@ -0,0 +1,34 @@ +{ + "title": "List Load Test Profile Mappings by Source Resource Id", + "operationId": "LoadTestProfileMappings_List", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Update.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Update.json new file mode 100644 index 000000000000..060d356dc29c --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTestProfileMappings_Update.json @@ -0,0 +1,34 @@ +{ + "title": "Update a Load Test Profile Mapping", + "operationId": "LoadTestProfileMappings_Update", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestProfileMappingName": "myLoadTestProfileMapping", + "properties": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_CreateOrUpdate.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_CreateOrUpdate.json new file mode 100644 index 000000000000..f84b7a9864a8 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_CreateOrUpdate.json @@ -0,0 +1,121 @@ +{ + "operationId": "LoadTests_CreateOrUpdate", + "title": "Create a LoadTestResource", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "loadTestName": "myLoadTest", + "LoadTestResource": { + "location": "westus", + "tags": { + "Team": "Dev Exp" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "description": "This is new load test resource", + "encryption": { + "identity": { + "type": "UserAssigned", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "12345678-1234-1234-1234-123456789012", + "tenantId": "12345678-1234-1234-4321-123456789012", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "12345678-1234-4321-1234-123456789012", + "clientId": "12345678-4321-1234-1234-123456789012" + } + } + }, + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded", + "encryption": { + "identity": { + "type": "UserAssigned", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.loadtestservice/locations/WESTUS/operationStatuses/abc?api-version=2022-12-01" + }, + "body": { + "location": "westus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "12345678-1234-1234-1234-123456789012", + "tenantId": "12345678-1234-1234-4321-123456789012", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "12345678-1234-4321-1234-123456789012", + "clientId": "12345678-4321-1234-1234-123456789012" + } + } + }, + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded", + "encryption": { + "identity": { + "type": "UserAssigned", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Delete.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Delete.json new file mode 100644 index 000000000000..d2f5cd404d13 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Delete.json @@ -0,0 +1,18 @@ +{ + "operationId": "LoadTests_Delete", + "title": "Delete a LoadTestResource.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "loadTestName": "myLoadTest" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.loadtestservice/locations/WESTUS/operationStatuses/abc?api-version=2022-12-01" + } + }, + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Get.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Get.json new file mode 100644 index 000000000000..d659ec05396f --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Get.json @@ -0,0 +1,36 @@ +{ + "operationId": "LoadTests_Get", + "title": "Get a LoadTestResource.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "loadTestName": "myLoadTest" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListByResourceGroup.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListByResourceGroup.json new file mode 100644 index 000000000000..f90482ffb4d7 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "operationId": "LoadTests_ListByResourceGroup", + "title": "List LoadTestResource resources by resource group.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListBySubscription.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListBySubscription.json new file mode 100644 index 000000000000..3f5cead7f3b3 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListBySubscription.json @@ -0,0 +1,38 @@ +{ + "operationId": "LoadTests_ListBySubscription", + "title": "List LoadTestResource resources by subscription ID.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListOutboundNetworkDependenciesEndpoints.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..2ed76648276e --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,110 @@ +{ + "operationId": "LoadTests_ListOutboundNetworkDependenciesEndpoints", + "title": "Lists the endpoints that agents may call as part of load testing.", + "parameters": { + "loadTestName": "sampleloadtest", + "resourceGroupName": "default-azureloadtest-japaneast", + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Azure Batch", + "endpoints": [ + { + "domainName": "sampleacct.japaneast.batch.azure.com", + "description": "Applicable to job manager tasks, tasks that use job scoped authentication, or any task that makes calls to Batch.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "japaneast.service.batch.azure.com", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "domainName": "autostorageaccountname.blob.core.windows.net", + "description": "AutoStorage endpoint for this Batch account. Applicable to all Azure Batch pools under this account.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.blob.core.windows.net", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.table.core.windows.net", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.queue.core.windows.net", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Microsoft Package Repository", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "description": "Only applicable to pools containing a Mount Configuration. Learn about Mount Configurations in Batch at https://docs.microsoft.com/azure/batch/virtual-file-mount.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Key Vault", + "endpoints": [ + { + "domainName": "*.vault.azure.net", + "description": "Only applicable to pools containing a Disk Encryption Configuration and whose VM size does not support encryption at host. Learn more about disk encryption in Azure Batch at https://docs.microsoft.com/azure/batch/disk-encryption. Learn more about encryption at host and supported VM sizes at https://docs.microsoft.com/azure/virtual-machines/disks-enable-host-based-encryption-portal.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Update.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Update.json new file mode 100644 index 000000000000..489575c0460f --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/LoadTests_Update.json @@ -0,0 +1,82 @@ +{ + "operationId": "LoadTests_Update", + "title": "Update a LoadTestResource.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "loadTestName": "myLoadTest", + "LoadTestResourcePatchRequestBody": { + "tags": { + "Team": "Dev Exp", + "Division": "LT" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "description": "This is new load test resource", + "encryption": { + "identity": { + "type": "SystemAssigned", + "resourceId": null + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "12345678-1234-1234-1234-123456789012", + "tenantId": "12345678-1234-1234-4321-123456789012", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "12345678-1234-4321-1234-123456789012", + "clientId": "12345678-4321-1234-1234-123456789012" + } + } + }, + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded", + "encryption": { + "identity": { + "type": "SystemAssigned", + "resourceId": null + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp", + "Division": "LT" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.loadtestservice/locations/WESTUS/operationStatuses/abc?api-version=2022-12-01" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Operations_List.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Operations_List.json new file mode 100644 index 000000000000..a9a5c1b3ab76 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Operations_List.json @@ -0,0 +1,46 @@ +{ + "operationId": "Operations_List", + "title": "List the operations for the provider.", + "parameters": { + "api-version": "2023-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.LoadTestService/loadTests/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.LoadTestService", + "resource": "loadTests", + "operation": "Creates or updates the LoadTests", + "description": "Set LoadTests" + } + }, + { + "name": "Microsoft.LoadTestService/loadTests/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.LoadTestService", + "resource": "loadTests", + "operation": "Deletes the LoadTests", + "description": "Delete LoadTests" + } + }, + { + "name": "Microsoft.LoadTestService/loadTests/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.LoadTestService", + "resource": "loadTests", + "operation": "Reads the LoadTests", + "description": "Read LoadTests" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_CheckAvailability.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_CheckAvailability.json new file mode 100644 index 000000000000..29cab6ade828 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_CheckAvailability.json @@ -0,0 +1,34 @@ +{ + "operationId": "Quotas_CheckAvailability", + "title": "Check Quota Availability on quota bucket per region per subscription.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus", + "quotaBucketName": "testQuotaBucket", + "QuotaBucketRequest": { + "properties": { + "currentUsage": 20, + "currentQuota": 40, + "newQuota": 50, + "dimensions": { + "subscriptionId": "testsubscriptionId", + "location": "westus" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.LoadTestService/locations/westus/quotas/testQuotaBucket", + "name": "testQuotaBucket", + "type": "Microsoft.LoadTestService/locations/quotas", + "properties": { + "isAvailable": false, + "availabilityStatus": "The requested quota is currently unavailable. Please request for different quota, or upgrade subscription offer type and try again later." + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_Get.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_Get.json new file mode 100644 index 000000000000..6b42bcc0c58c --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_Get.json @@ -0,0 +1,23 @@ +{ + "operationId": "Quotas_Get", + "title": "Get the available quota for a quota bucket per region per subscription.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus", + "quotaBucketName": "testQuotaBucket" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.LoadTestService/locations/westus/quotas/testQuotaBucket", + "name": "testQuotaBucket", + "type": "Microsoft.LoadTestService/locations/quotas", + "properties": { + "limit": 50, + "usage": 20 + } + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_List.json b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_List.json new file mode 100644 index 000000000000..75900512c036 --- /dev/null +++ b/specification/loadtestservice/LoadTestService.Management/examples/2023-12-01-preview/Quotas_List.json @@ -0,0 +1,26 @@ +{ + "operationId": "Quotas_List", + "title": "List quotas for a given subscription Id.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.LoadTestService/locations/westus/quotas/testQuotaBucket", + "name": "testQuotaBucket", + "type": "Microsoft.LoadTestService/locations/quotas", + "properties": { + "limit": 50, + "usage": 20 + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService.Management/main.tsp b/specification/loadtestservice/LoadTestService.Management/main.tsp index 23a0a7a2d980..662f0efca706 100644 --- a/specification/loadtestservice/LoadTestService.Management/main.tsp +++ b/specification/loadtestservice/LoadTestService.Management/main.tsp @@ -26,4 +26,7 @@ enum APIVersions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_2) v2022_12_01: "2022-12-01", + + @doc("The 2023-12-01-preview version of the Azure Load Testing Resource manager API.") + v2023_12_01_preview: "2023-12-01-preview", } diff --git a/specification/loadtestservice/LoadTestService.Management/models.tsp b/specification/loadtestservice/LoadTestService.Management/models.tsp index a84ddca037e3..9f6f2d084916 100644 --- a/specification/loadtestservice/LoadTestService.Management/models.tsp +++ b/specification/loadtestservice/LoadTestService.Management/models.tsp @@ -26,6 +26,67 @@ model LoadTestResource is TrackedResource { ...ManagedServiceIdentityProperty; } +@extensionResource +@doc("LoadTest mapping resource details") +@added(APIVersions.v2023_12_01_preview) +model LoadTestMappingResource is ProxyResource { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "Existing API" + @doc("Load Test Mapping name") + @key("loadTestMappingName") + @path + @segment("loadTestMappings") + @pattern("^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Operations on the resource are sync" +@doc("Azure LoadTest mapping resource properties.") +@added(APIVersions.v2023_12_01_preview) +model LoadTestMappingProperties { + @doc("Mapped source resource Id.") + @maxLength(1024) + sourceResourceId?: string; + + @doc("Mapped Azure Load Test resource Id.") + @maxLength(1024) + azureLoadTestingResourceId?: string; + + @doc("Mapped Azure Load Test resource test-id.") + @maxLength(256) + testId?: string; +} + +@extensionResource +@doc("LoadTest profile mapping resource details") +@added(APIVersions.v2023_12_01_preview) +model LoadTestProfileMappingResource + is ProxyResource { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "Existing API" + @doc("Load Test Profile Mapping name") + @key("loadTestProfileMappingName") + @path + @segment("loadTestProfileMappings") + @pattern("^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Operations on the resource are sync" +@doc("Azure LoadTest profile mapping resource properties.") +@added(APIVersions.v2023_12_01_preview) +model LoadTestProfileMappingProperties { + @doc("Mapped source resource Id.") + @maxLength(1024) + sourceResourceId?: string; + + @doc("Mapped Azure Load Test resource Id.") + @maxLength(1024) + azureLoadTestingResourceId?: string; + + @doc("Mapped Azure Load Test resource test-profile-id.") + @maxLength(60) + testProfileId?: string; +} + @doc("Resources provisioning states.") union ResourceState { string, diff --git a/specification/loadtestservice/LoadTestService.Management/routes.tsp b/specification/loadtestservice/LoadTestService.Management/routes.tsp index 22f4caa9240c..c42dca33c8df 100644 --- a/specification/loadtestservice/LoadTestService.Management/routes.tsp +++ b/specification/loadtestservice/LoadTestService.Management/routes.tsp @@ -5,6 +5,7 @@ import "@azure-tools/typespec-azure-resource-manager"; using Azure.ResourceManager; using OpenAPI; +using TypeSpec.Versioning; namespace Microsoft.LoadTestService; @@ -74,3 +75,47 @@ interface Quotas { CheckQuotaAvailabilityResponse >; } + +@armResourceOperations +interface LoadTestMappings { + @added(APIVersions.v2023_12_01_preview) + createOrUpdate is ArmResourceCreateOrReplaceSync; + + @added(APIVersions.v2023_12_01_preview) + get is ArmResourceRead; + + @added(APIVersions.v2023_12_01_preview) + delete is ArmResourceDeleteSync; + + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "Existing API" + @added(APIVersions.v2023_12_01_preview) + update is ArmResourcePatchSync< + LoadTestMappingResource, + LoadTestMappingProperties + >; + + @added(APIVersions.v2023_12_01_preview) + listByScope is ArmResourceListByParent; +} + +@armResourceOperations +interface LoadTestProfileMappings { + @added(APIVersions.v2023_12_01_preview) + createOrUpdate is ArmResourceCreateOrReplaceSync; + + @added(APIVersions.v2023_12_01_preview) + get is ArmResourceRead; + + @added(APIVersions.v2023_12_01_preview) + delete is ArmResourceDeleteSync; + + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "Existing API" + @added(APIVersions.v2023_12_01_preview) + update is ArmResourcePatchSync< + LoadTestProfileMappingResource, + LoadTestProfileMappingProperties + >; + + @added(APIVersions.v2023_12_01_preview) + listByScope is ArmResourceListByParent; +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_CreateOrUpdate.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_CreateOrUpdate.json new file mode 100644 index 000000000000..b6847087411c --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "title": "Create a Load Test Mapping Resource", + "operationId": "LoadTestMappings_CreateOrUpdate", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestMappingName": "myLoadTestMapping", + "resource": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1002", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:34:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Delete.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Delete.json new file mode 100644 index 000000000000..688176e1f150 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Delete.json @@ -0,0 +1,13 @@ +{ + "title": "Delete a Load Test Mapping Resource", + "operationId": "LoadTestMappings_Delete", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestMappingName": "myLoadTestMapping" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Get.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Get.json new file mode 100644 index 000000000000..aa5753eb2617 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Get.json @@ -0,0 +1,31 @@ +{ + "title": "Get a Load Test Mapping Resource", + "operationId": "LoadTestMappings_Get", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestMappingName": "myLoadTestMapping" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_List.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_List.json new file mode 100644 index 000000000000..18e0a5a192ba --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_List.json @@ -0,0 +1,34 @@ +{ + "title": "List all Load Test Mappings by Source Resource Id", + "operationId": "LoadTestMappings_List", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Update.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Update.json new file mode 100644 index 000000000000..2b20b6300fb6 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestMappings_Update.json @@ -0,0 +1,34 @@ +{ + "title": "Update a load test mapping", + "operationId": "LoadTestMappings_Update", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestMappingName": "myLoadTestMapping", + "properties": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestMappings/myLoadTestMapping", + "name": "myLoadTestMapping", + "type": "Microsoft.LoadTestService/loadTestMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_CreateOrUpdate.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_CreateOrUpdate.json new file mode 100644 index 000000000000..b99bbc3a7a0d --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "title": "Create a Load Test Profile Mappings resource", + "operationId": "LoadTestProfileMappings_CreateOrUpdate", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestProfileMappingName": "myLoadTestProfileMapping", + "resource": { + "properties": { + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1002", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:34:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Delete.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Delete.json new file mode 100644 index 000000000000..1c9ac22a0fc8 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Delete.json @@ -0,0 +1,13 @@ +{ + "title": "Delete a Load Test Profile Mapping Resource", + "operationId": "LoadTestProfileMappings_Delete", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestProfileMappingName": "myLoadTestProfileMapping" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Get.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Get.json new file mode 100644 index 000000000000..6450e5fa2b39 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Get.json @@ -0,0 +1,31 @@ +{ + "title": "Get a Load Test Profile Mapping Resource", + "operationId": "LoadTestProfileMappings_Get", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestProfileMappingName": "myLoadTestProfileMapping" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_List.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_List.json new file mode 100644 index 000000000000..f6b7653dadc5 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_List.json @@ -0,0 +1,34 @@ +{ + "title": "List Load Test Profile Mappings by Source Resource Id", + "operationId": "LoadTestProfileMappings_List", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Update.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Update.json new file mode 100644 index 000000000000..060d356dc29c --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTestProfileMappings_Update.json @@ -0,0 +1,34 @@ +{ + "title": "Update a Load Test Profile Mapping", + "operationId": "LoadTestProfileMappings_Update", + "parameters": { + "api-version": "2023-12-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "loadTestProfileMappingName": "myLoadTestProfileMapping", + "properties": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename/providers/Microsoft.LoadTestService/loadTestProfileMappings/myLoadTestProfileMapping", + "name": "myLoadTestProfileMapping", + "type": "Microsoft.LoadTestService/loadTestProfileMappings", + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + }, + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.Web/sites/sitename", + "azureLoadTestingResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "testProfileId": "123456" + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_CreateOrUpdate.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_CreateOrUpdate.json new file mode 100644 index 000000000000..f84b7a9864a8 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_CreateOrUpdate.json @@ -0,0 +1,121 @@ +{ + "operationId": "LoadTests_CreateOrUpdate", + "title": "Create a LoadTestResource", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "loadTestName": "myLoadTest", + "LoadTestResource": { + "location": "westus", + "tags": { + "Team": "Dev Exp" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "description": "This is new load test resource", + "encryption": { + "identity": { + "type": "UserAssigned", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "12345678-1234-1234-1234-123456789012", + "tenantId": "12345678-1234-1234-4321-123456789012", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "12345678-1234-4321-1234-123456789012", + "clientId": "12345678-4321-1234-1234-123456789012" + } + } + }, + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded", + "encryption": { + "identity": { + "type": "UserAssigned", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.loadtestservice/locations/WESTUS/operationStatuses/abc?api-version=2022-12-01" + }, + "body": { + "location": "westus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "12345678-1234-1234-1234-123456789012", + "tenantId": "12345678-1234-1234-4321-123456789012", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "12345678-1234-4321-1234-123456789012", + "clientId": "12345678-4321-1234-1234-123456789012" + } + } + }, + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded", + "encryption": { + "identity": { + "type": "UserAssigned", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Delete.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Delete.json new file mode 100644 index 000000000000..d2f5cd404d13 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Delete.json @@ -0,0 +1,18 @@ +{ + "operationId": "LoadTests_Delete", + "title": "Delete a LoadTestResource.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "loadTestName": "myLoadTest" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.loadtestservice/locations/WESTUS/operationStatuses/abc?api-version=2022-12-01" + } + }, + "204": {} + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Get.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Get.json new file mode 100644 index 000000000000..d659ec05396f --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Get.json @@ -0,0 +1,36 @@ +{ + "operationId": "LoadTests_Get", + "title": "Get a LoadTestResource.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "loadTestName": "myLoadTest" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListByResourceGroup.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListByResourceGroup.json new file mode 100644 index 000000000000..f90482ffb4d7 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "operationId": "LoadTests_ListByResourceGroup", + "title": "List LoadTestResource resources by resource group.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListBySubscription.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListBySubscription.json new file mode 100644 index 000000000000..3f5cead7f3b3 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListBySubscription.json @@ -0,0 +1,38 @@ +{ + "operationId": "LoadTests_ListBySubscription", + "title": "List LoadTestResource resources by subscription ID.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListOutboundNetworkDependenciesEndpoints.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..2ed76648276e --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,110 @@ +{ + "operationId": "LoadTests_ListOutboundNetworkDependenciesEndpoints", + "title": "Lists the endpoints that agents may call as part of load testing.", + "parameters": { + "loadTestName": "sampleloadtest", + "resourceGroupName": "default-azureloadtest-japaneast", + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Azure Batch", + "endpoints": [ + { + "domainName": "sampleacct.japaneast.batch.azure.com", + "description": "Applicable to job manager tasks, tasks that use job scoped authentication, or any task that makes calls to Batch.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "japaneast.service.batch.azure.com", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "domainName": "autostorageaccountname.blob.core.windows.net", + "description": "AutoStorage endpoint for this Batch account. Applicable to all Azure Batch pools under this account.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.blob.core.windows.net", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.table.core.windows.net", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.queue.core.windows.net", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Microsoft Package Repository", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "description": "Only applicable to pools containing a Mount Configuration. Learn about Mount Configurations in Batch at https://docs.microsoft.com/azure/batch/virtual-file-mount.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Key Vault", + "endpoints": [ + { + "domainName": "*.vault.azure.net", + "description": "Only applicable to pools containing a Disk Encryption Configuration and whose VM size does not support encryption at host. Learn more about disk encryption in Azure Batch at https://docs.microsoft.com/azure/batch/disk-encryption. Learn more about encryption at host and supported VM sizes at https://docs.microsoft.com/azure/virtual-machines/disks-enable-host-based-encryption-portal.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Update.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Update.json new file mode 100644 index 000000000000..489575c0460f --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/LoadTests_Update.json @@ -0,0 +1,82 @@ +{ + "operationId": "LoadTests_Update", + "title": "Update a LoadTestResource.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "loadTestName": "myLoadTest", + "LoadTestResourcePatchRequestBody": { + "tags": { + "Team": "Dev Exp", + "Division": "LT" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "description": "This is new load test resource", + "encryption": { + "identity": { + "type": "SystemAssigned", + "resourceId": null + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "12345678-1234-1234-1234-123456789012", + "tenantId": "12345678-1234-1234-4321-123456789012", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "12345678-1234-4321-1234-123456789012", + "clientId": "12345678-4321-1234-1234-123456789012" + } + } + }, + "properties": { + "description": "This is new load test resource", + "dataPlaneURI": "https://myLoadTest.00000000-0000-0000-0000-000000000000.cnt-dp.domain.com", + "provisioningState": "Succeeded", + "encryption": { + "identity": { + "type": "SystemAssigned", + "resourceId": null + }, + "keyUrl": "https://dummy.vault.azure.net/keys/dummykey1" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.LoadTestService/loadTests/myLoadTest", + "name": "myLoadTest", + "type": "Microsoft.LoadTestService/loadTests", + "tags": { + "Team": "Dev Exp", + "Division": "LT" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.loadtestservice/locations/WESTUS/operationStatuses/abc?api-version=2022-12-01" + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Operations_List.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..a9a5c1b3ab76 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Operations_List.json @@ -0,0 +1,46 @@ +{ + "operationId": "Operations_List", + "title": "List the operations for the provider.", + "parameters": { + "api-version": "2023-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.LoadTestService/loadTests/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.LoadTestService", + "resource": "loadTests", + "operation": "Creates or updates the LoadTests", + "description": "Set LoadTests" + } + }, + { + "name": "Microsoft.LoadTestService/loadTests/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.LoadTestService", + "resource": "loadTests", + "operation": "Deletes the LoadTests", + "description": "Delete LoadTests" + } + }, + { + "name": "Microsoft.LoadTestService/loadTests/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.LoadTestService", + "resource": "loadTests", + "operation": "Reads the LoadTests", + "description": "Read LoadTests" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_CheckAvailability.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_CheckAvailability.json new file mode 100644 index 000000000000..29cab6ade828 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_CheckAvailability.json @@ -0,0 +1,34 @@ +{ + "operationId": "Quotas_CheckAvailability", + "title": "Check Quota Availability on quota bucket per region per subscription.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus", + "quotaBucketName": "testQuotaBucket", + "QuotaBucketRequest": { + "properties": { + "currentUsage": 20, + "currentQuota": 40, + "newQuota": 50, + "dimensions": { + "subscriptionId": "testsubscriptionId", + "location": "westus" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.LoadTestService/locations/westus/quotas/testQuotaBucket", + "name": "testQuotaBucket", + "type": "Microsoft.LoadTestService/locations/quotas", + "properties": { + "isAvailable": false, + "availabilityStatus": "The requested quota is currently unavailable. Please request for different quota, or upgrade subscription offer type and try again later." + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_Get.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_Get.json new file mode 100644 index 000000000000..6b42bcc0c58c --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_Get.json @@ -0,0 +1,23 @@ +{ + "operationId": "Quotas_Get", + "title": "Get the available quota for a quota bucket per region per subscription.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus", + "quotaBucketName": "testQuotaBucket" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.LoadTestService/locations/westus/quotas/testQuotaBucket", + "name": "testQuotaBucket", + "type": "Microsoft.LoadTestService/locations/quotas", + "properties": { + "limit": 50, + "usage": 20 + } + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_List.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_List.json new file mode 100644 index 000000000000..75900512c036 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/examples/Quotas_List.json @@ -0,0 +1,26 @@ +{ + "operationId": "Quotas_List", + "title": "List quotas for a given subscription Id.", + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.LoadTestService/locations/westus/quotas/testQuotaBucket", + "name": "testQuotaBucket", + "type": "Microsoft.LoadTestService/locations/quotas", + "properties": { + "limit": 50, + "usage": 20 + } + } + ] + } + } + } +} diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json new file mode 100644 index 000000000000..86864978e6a7 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json @@ -0,0 +1,1728 @@ +{ + "swagger": "2.0", + "info": { + "title": "LoadTest Client", + "version": "2023-12-01-preview", + "description": "LoadTest client provides access to LoadTest Resource and it's status operations.", + "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": "LoadTests" + }, + { + "name": "Quotas" + }, + { + "name": "LoadTestMappings" + }, + { + "name": "LoadTestProfileMappings" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.LoadTestService/loadTestMappings": { + "get": { + "operationId": "LoadTestMappings_List", + "tags": [ + "LoadTestMappings" + ], + "description": "List LoadTestMappingResource resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestMappingResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all Load Test Mappings by Source Resource Id": { + "$ref": "./examples/LoadTestMappings_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.LoadTestService/loadTestMappings/{loadTestMappingName}": { + "get": { + "operationId": "LoadTestMappings_Get", + "tags": [ + "LoadTestMappings" + ], + "description": "Get a LoadTestMappingResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "loadTestMappingName", + "in": "path", + "description": "Load Test Mapping name", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestMappingResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Load Test Mapping Resource": { + "$ref": "./examples/LoadTestMappings_Get.json" + } + } + }, + "put": { + "operationId": "LoadTestMappings_CreateOrUpdate", + "tags": [ + "LoadTestMappings" + ], + "description": "Create a LoadTestMappingResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "loadTestMappingName", + "in": "path", + "description": "Load Test Mapping name", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LoadTestMappingResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LoadTestMappingResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/LoadTestMappingResource" + } + }, + "201": { + "description": "Resource 'LoadTestMappingResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/LoadTestMappingResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a Load Test Mapping Resource": { + "$ref": "./examples/LoadTestMappings_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "LoadTestMappings_Update", + "tags": [ + "LoadTestMappings" + ], + "description": "Update a LoadTestMappingResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "loadTestMappingName", + "in": "path", + "description": "Load Test Mapping name", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LoadTestMappingResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestMappingResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a load test mapping": { + "$ref": "./examples/LoadTestMappings_Update.json" + } + } + }, + "delete": { + "operationId": "LoadTestMappings_Delete", + "tags": [ + "LoadTestMappings" + ], + "description": "Delete a LoadTestMappingResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "loadTestMappingName", + "in": "path", + "description": "Load Test Mapping name", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a Load Test Mapping Resource": { + "$ref": "./examples/LoadTestMappings_Delete.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.LoadTestService/loadTestProfileMappings": { + "get": { + "operationId": "LoadTestProfileMappings_List", + "tags": [ + "LoadTestProfileMappings" + ], + "description": "List LoadTestProfileMappingResource resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestProfileMappingResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Load Test Profile Mappings by Source Resource Id": { + "$ref": "./examples/LoadTestProfileMappings_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.LoadTestService/loadTestProfileMappings/{loadTestProfileMappingName}": { + "get": { + "operationId": "LoadTestProfileMappings_Get", + "tags": [ + "LoadTestProfileMappings" + ], + "description": "Get a LoadTestProfileMappingResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "loadTestProfileMappingName", + "in": "path", + "description": "Load Test Profile Mapping name", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestProfileMappingResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Load Test Profile Mapping Resource": { + "$ref": "./examples/LoadTestProfileMappings_Get.json" + } + } + }, + "put": { + "operationId": "LoadTestProfileMappings_CreateOrUpdate", + "tags": [ + "LoadTestProfileMappings" + ], + "description": "Create a LoadTestProfileMappingResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "loadTestProfileMappingName", + "in": "path", + "description": "Load Test Profile Mapping name", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LoadTestProfileMappingResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LoadTestProfileMappingResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/LoadTestProfileMappingResource" + } + }, + "201": { + "description": "Resource 'LoadTestProfileMappingResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/LoadTestProfileMappingResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a Load Test Profile Mappings resource": { + "$ref": "./examples/LoadTestProfileMappings_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "LoadTestProfileMappings_Update", + "tags": [ + "LoadTestProfileMappings" + ], + "description": "Update a LoadTestProfileMappingResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "loadTestProfileMappingName", + "in": "path", + "description": "Load Test Profile Mapping name", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LoadTestProfileMappingResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestProfileMappingResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Load Test Profile Mapping": { + "$ref": "./examples/LoadTestProfileMappings_Update.json" + } + } + }, + "delete": { + "operationId": "LoadTestProfileMappings_Delete", + "tags": [ + "LoadTestProfileMappings" + ], + "description": "Delete a LoadTestProfileMappingResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "loadTestProfileMappingName", + "in": "path", + "description": "Load Test Profile Mapping name", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a Load Test Profile Mapping Resource": { + "$ref": "./examples/LoadTestProfileMappings_Delete.json" + } + } + } + }, + "/providers/Microsoft.LoadTestService/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List the operations for the provider.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/loadTests": { + "get": { + "operationId": "LoadTests_ListBySubscription", + "tags": [ + "LoadTests" + ], + "description": "List LoadTestResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List LoadTestResource resources by subscription ID.": { + "$ref": "./examples/LoadTests_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/locations/{location}/quotas": { + "get": { + "operationId": "Quotas_List", + "tags": [ + "Quotas" + ], + "description": "List quotas for a given subscription Id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List quotas for a given subscription Id.": { + "$ref": "./examples/Quotas_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/locations/{location}/quotas/{quotaBucketName}": { + "get": { + "operationId": "Quotas_Get", + "tags": [ + "Quotas" + ], + "description": "Get the available quota for a quota bucket per region per subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "quotaBucketName", + "in": "path", + "description": "The quota name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the available quota for a quota bucket per region per subscription.": { + "$ref": "./examples/Quotas_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/locations/{location}/quotas/{quotaBucketName}/checkAvailability": { + "post": { + "operationId": "Quotas_CheckAvailability", + "tags": [ + "Quotas" + ], + "description": "Check Quota Availability on quota bucket per region per subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "quotaBucketName", + "in": "path", + "description": "The quota name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "QuotaBucketRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaBucketRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CheckQuotaAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check Quota Availability on quota bucket per region per subscription.": { + "$ref": "./examples/Quotas_CheckAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests": { + "get": { + "operationId": "LoadTests_ListByResourceGroup", + "tags": [ + "LoadTests" + ], + "description": "List LoadTestResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List LoadTestResource resources by resource group.": { + "$ref": "./examples/LoadTests_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}": { + "get": { + "operationId": "LoadTests_Get", + "tags": [ + "LoadTests" + ], + "description": "Get a LoadTestResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "loadTestName", + "in": "path", + "description": "Load Test name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a LoadTestResource.": { + "$ref": "./examples/LoadTests_Get.json" + } + } + }, + "put": { + "operationId": "LoadTests_CreateOrUpdate", + "tags": [ + "LoadTests" + ], + "description": "Create a LoadTestResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "loadTestName", + "in": "path", + "description": "Load Test name", + "required": true, + "type": "string" + }, + { + "name": "LoadTestResource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LoadTestResource" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "Resource 'LoadTestResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/LoadTestResource" + } + }, + "201": { + "description": "Resource 'LoadTestResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/LoadTestResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a LoadTestResource": { + "$ref": "./examples/LoadTests_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LoadTests_Update", + "tags": [ + "LoadTests" + ], + "description": "Update a LoadTestResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "loadTestName", + "in": "path", + "description": "Load Test name", + "required": true, + "type": "string" + }, + { + "name": "LoadTestResourcePatchRequestBody", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LoadTestResourceUpdate" + }, + "x-ms-client-name": "properties" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoadTestResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a LoadTestResource.": { + "$ref": "./examples/LoadTests_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LoadTests_Delete", + "tags": [ + "LoadTests" + ], + "description": "Delete a LoadTestResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "loadTestName", + "in": "path", + "description": "Load Test name", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a LoadTestResource.": { + "$ref": "./examples/LoadTests_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}/outboundNetworkDependenciesEndpoints": { + "get": { + "operationId": "LoadTests_ListOutboundNetworkDependenciesEndpoints", + "tags": [ + "LoadTests" + ], + "description": "Lists the endpoints that agents may call as part of load testing.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "loadTestName", + "in": "path", + "description": "Load Test name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedOutboundEnvironmentEndpoint" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists the endpoints that agents may call as part of load testing.": { + "$ref": "./examples/LoadTests_ListOutboundNetworkDependenciesEndpoints.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "CheckQuotaAvailabilityResponse": { + "type": "object", + "description": "Check quota availability response object.", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the resource.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/CheckQuotaAvailabilityResponseProperties", + "description": "Check quota availability response properties.", + "x-ms-client-flatten": true + } + }, + "required": [ + "id", + "type" + ] + }, + "CheckQuotaAvailabilityResponseProperties": { + "type": "object", + "description": "Check quota availability response properties.", + "properties": { + "isAvailable": { + "type": "boolean", + "description": "True/False indicating whether the quota request be granted based on availability." + }, + "availabilityStatus": { + "type": "string", + "description": "Message indicating additional details to add to quota support request." + } + } + }, + "EncryptionProperties": { + "type": "object", + "description": "Key and identity details for Customer Managed Key encryption of load test resource.", + "properties": { + "identity": { + "$ref": "#/definitions/EncryptionPropertiesIdentity", + "description": "All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault." + }, + "keyUrl": { + "type": "string", + "description": "key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek." + } + } + }, + "EncryptionPropertiesIdentity": { + "type": "object", + "description": "All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.", + "properties": { + "type": { + "$ref": "#/definitions/type", + "description": "Managed identity type to use for accessing encryption key Url." + }, + "resourceId": { + "type": "string", + "description": "User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.", + "x-nullable": true + } + } + }, + "EndpointDependency": { + "type": "object", + "description": "A domain name and connection details used to access a dependency.", + "properties": { + "domainName": { + "type": "string", + "description": "The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Human-readable supplemental information about the dependency and when it is applicable.", + "readOnly": true + }, + "endpointDetails": { + "type": "array", + "description": "The list of connection details for this endpoint.", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "readOnly": true, + "x-ms-identifiers": [ + "port" + ] + } + }, + "required": [ + "domainName" + ] + }, + "EndpointDetail": { + "type": "object", + "description": "Details about the connection between the Batch service and the endpoint.", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The port an endpoint is connected to.", + "readOnly": true + } + } + }, + "LoadTestMappingProperties": { + "type": "object", + "description": "Azure LoadTest mapping resource properties.", + "properties": { + "sourceResourceId": { + "type": "string", + "description": "Mapped source resource Id.", + "maxLength": 1024 + }, + "azureLoadTestingResourceId": { + "type": "string", + "description": "Mapped Azure Load Test resource Id.", + "maxLength": 1024 + }, + "testId": { + "type": "string", + "description": "Mapped Azure Load Test resource test-id.", + "maxLength": 256 + } + } + }, + "LoadTestMappingResource": { + "type": "object", + "description": "LoadTest mapping resource details", + "properties": { + "properties": { + "$ref": "#/definitions/LoadTestMappingProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LoadTestMappingResourceListResult": { + "type": "object", + "description": "The response of a LoadTestMappingResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LoadTestMappingResource items on this page", + "items": { + "$ref": "#/definitions/LoadTestMappingResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LoadTestMappingResourceUpdate": { + "type": "object", + "description": "The type used for update operations of the LoadTestMappingResource.", + "properties": { + "properties": { + "$ref": "#/definitions/LoadTestMappingResourceUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "LoadTestMappingResourceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the LoadTestMappingResource.", + "properties": { + "sourceResourceId": { + "type": "string", + "description": "Mapped source resource Id.", + "maxLength": 1024 + }, + "azureLoadTestingResourceId": { + "type": "string", + "description": "Mapped Azure Load Test resource Id.", + "maxLength": 1024 + }, + "testId": { + "type": "string", + "description": "Mapped Azure Load Test resource test-id.", + "maxLength": 256 + } + } + }, + "LoadTestProfileMappingProperties": { + "type": "object", + "description": "Azure LoadTest profile mapping resource properties.", + "properties": { + "sourceResourceId": { + "type": "string", + "description": "Mapped source resource Id.", + "maxLength": 1024 + }, + "azureLoadTestingResourceId": { + "type": "string", + "description": "Mapped Azure Load Test resource Id.", + "maxLength": 1024 + }, + "testProfileId": { + "type": "string", + "description": "Mapped Azure Load Test resource test-profile-id.", + "maxLength": 60 + } + } + }, + "LoadTestProfileMappingResource": { + "type": "object", + "description": "LoadTest profile mapping resource details", + "properties": { + "properties": { + "$ref": "#/definitions/LoadTestProfileMappingProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LoadTestProfileMappingResourceListResult": { + "type": "object", + "description": "The response of a LoadTestProfileMappingResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LoadTestProfileMappingResource items on this page", + "items": { + "$ref": "#/definitions/LoadTestProfileMappingResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LoadTestProfileMappingResourceUpdate": { + "type": "object", + "description": "The type used for update operations of the LoadTestProfileMappingResource.", + "properties": { + "properties": { + "$ref": "#/definitions/LoadTestProfileMappingResourceUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "LoadTestProfileMappingResourceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the LoadTestProfileMappingResource.", + "properties": { + "sourceResourceId": { + "type": "string", + "description": "Mapped source resource Id.", + "maxLength": 1024 + }, + "azureLoadTestingResourceId": { + "type": "string", + "description": "Mapped Azure Load Test resource Id.", + "maxLength": 1024 + }, + "testProfileId": { + "type": "string", + "description": "Mapped Azure Load Test resource test-profile-id.", + "maxLength": 60 + } + } + }, + "LoadTestProperties": { + "type": "object", + "description": "LoadTest resource properties.", + "properties": { + "description": { + "type": "string", + "description": "Description of the resource.", + "maxLength": 512 + }, + "provisioningState": { + "$ref": "#/definitions/ResourceState", + "description": "Resource provisioning state.", + "readOnly": true + }, + "dataPlaneURI": { + "type": "string", + "description": "Resource data plane URI.", + "maxLength": 2083, + "readOnly": true + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperties", + "description": "CMK Encryption property." + } + } + }, + "LoadTestResource": { + "type": "object", + "description": "LoadTest details.", + "properties": { + "properties": { + "$ref": "#/definitions/LoadTestProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LoadTestResourceListResult": { + "type": "object", + "description": "The response of a LoadTestResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LoadTestResource items on this page", + "items": { + "$ref": "#/definitions/LoadTestResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LoadTestResourceUpdate": { + "type": "object", + "description": "The type used for update operations of the LoadTestResource.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/LoadTestResourceUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "LoadTestResourceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the LoadTestResource.", + "properties": { + "description": { + "type": "string", + "description": "Description of the resource.", + "maxLength": 512 + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperties", + "description": "CMK Encryption property." + } + } + }, + "OutboundEnvironmentEndpoint": { + "type": "object", + "description": "A collection of related endpoints from the same service for which the Batch service requires outbound access.", + "properties": { + "category": { + "type": "string", + "description": "The type of service that Azure Load Testing connects to.", + "readOnly": true + }, + "endpoints": { + "type": "array", + "description": "The endpoints for this service to which the Batch service makes outbound calls.", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "readOnly": true, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "PagedOutboundEnvironmentEndpoint": { + "type": "object", + "description": "Values returned by the List operation.", + "properties": { + "value": { + "type": "array", + "description": "The OutboundEnvironmentEndpoint items on this page", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "QuotaBucketRequest": { + "type": "object", + "description": "Request object of new quota for a quota bucket.", + "properties": { + "properties": { + "$ref": "#/definitions/QuotaBucketRequestProperties", + "description": "Request object of new quota for a quota bucket.", + "x-ms-client-flatten": true + } + } + }, + "QuotaBucketRequestProperties": { + "type": "object", + "description": "New quota request request properties.", + "properties": { + "currentUsage": { + "type": "integer", + "format": "int32", + "description": "Current quota usage of the quota bucket.", + "minimum": 0 + }, + "currentQuota": { + "type": "integer", + "format": "int32", + "description": "Current quota limit of the quota bucket.", + "minimum": 0 + }, + "newQuota": { + "type": "integer", + "format": "int32", + "description": "New quota limit of the quota bucket.", + "minimum": 0 + }, + "dimensions": { + "$ref": "#/definitions/QuotaBucketRequestPropertiesDimensions", + "description": "Dimensions for new quota request." + } + } + }, + "QuotaBucketRequestPropertiesDimensions": { + "type": "object", + "description": "Dimensions for new quota request.", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription Id dimension for new quota request of the quota bucket.", + "minLength": 1 + }, + "location": { + "type": "string", + "description": "Location dimension for new quota request of the quota bucket.", + "minLength": 1 + } + } + }, + "QuotaResource": { + "type": "object", + "description": "Quota bucket details object.", + "properties": { + "properties": { + "$ref": "#/definitions/QuotaResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "QuotaResourceListResult": { + "type": "object", + "description": "The response of a QuotaResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The QuotaResource items on this page", + "items": { + "$ref": "#/definitions/QuotaResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "QuotaResourceProperties": { + "type": "object", + "description": "Quota bucket resource properties.", + "properties": { + "limit": { + "type": "integer", + "format": "int32", + "description": "Current quota limit of the quota bucket.", + "minimum": 0 + }, + "usage": { + "type": "integer", + "format": "int32", + "description": "Current quota usage of the quota bucket.", + "minimum": 0 + }, + "provisioningState": { + "$ref": "#/definitions/ResourceState", + "description": "Resource provisioning state.", + "readOnly": true + } + } + }, + "ResourceState": { + "type": "string", + "description": "Resources provisioning states.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Deleted" + ], + "x-ms-enum": { + "name": "ResourceState", + "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": "Deleted", + "value": "Deleted", + "description": "Deleted state." + } + ] + }, + "readOnly": true + }, + "type": { + "type": "string", + "description": "Managed identity type to use for accessing encryption key Url.", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "name": "SystemAssigned", + "value": "SystemAssigned", + "description": "System assigned identity." + }, + { + "name": "UserAssigned", + "value": "UserAssigned", + "description": "User assigned identity." + } + ] + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/loadtestservice/resource-manager/readme.md b/specification/loadtestservice/resource-manager/readme.md index 16cc1f6f0221..b2cfdf070a07 100644 --- a/specification/loadtestservice/resource-manager/readme.md +++ b/specification/loadtestservice/resource-manager/readme.md @@ -30,6 +30,15 @@ openapi-subtype: rpaas tag: package-2022-12-01 ``` +### Tag: package-2023-12-01-preview + +These settings apply only when `--tag=package-2023-12-01` is specified on the command line. + +```yaml $(tag) == 'package-2023-12-01-preview' +input-file: + - Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json +``` + ### Tag: package-2022-12-01 These settings apply only when `--tag=package-2022-12-01` is specified on the command line. From 053f21f61bb9ed9c198753036f1eb6adfa0144bc Mon Sep 17 00:00:00 2001 From: Krista Pratico Date: Tue, 25 Jun 2024 11:19:13 -0700 Subject: [PATCH 239/343] fix docs creating bad docstrings in healthinsights (#29557) * fix docs creating bad docstrings in healthinsights * fix ci --- .../HealthInsights.Common/model.common.fhir.elements.tsp | 2 +- .../HealthInsights.TrialMatcher/model.trialmatcher.tsp | 2 +- .../ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp index 533733cf14cb..e76df9708d54 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp @@ -55,7 +55,7 @@ alias value_x = { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" @doc(""" Base for all elements - Based on [FHIR Element](https://www.hl7.org/fhir/datatypes.html#Element) + Based on [FHIR Element](https://www.hl7.org/fhir/R4/element.html) """) model Extension extends Element { @doc("Source of the definition for the extension code - a logical name or a URL.") diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp index ed61f08ef0c7..058ea91474e2 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp @@ -20,7 +20,7 @@ model TrialMatcherModelConfiguration { ...ModelConfiguration; @doc(""" - The clinical trials that the patient(s) should be matched to.
The trial + The clinical trials that the patient(s) should be matched to. The trial selection can be given as a list of custom clinical trials and/or a list of filters to known clinical trial registries. In case both are given, the resulting trial set is a union of the two sets. diff --git a/specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json b/specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json index 9e49f8375fbd..0fbe1b6b7e3c 100644 --- a/specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json +++ b/specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json @@ -982,7 +982,7 @@ }, "Fhir.R4.Extension": { "type": "object", - "description": "Base for all elements\nBased on [FHIR Element](https://www.hl7.org/fhir/datatypes.html#Element)", + "description": "Base for all elements\nBased on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)", "properties": { "url": { "$ref": "#/definitions/Fhir.R4.fhirUri", From 9221ebd2b5be0eee5a8f6187d78b780b874b25fa Mon Sep 17 00:00:00 2001 From: tbyfield <68976176+tbyfield@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:28:59 -0700 Subject: [PATCH 240/343] Microsoft.DevCenter 2024-07-01-preview (#29527) * Copy files from preview/2024-06-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-07-01-preview Updated the API version from preview/2024-06-01-preview to preview/2024-07-01-preview. * Added tag for 2024-07-01-preview in readme file * Change introduces a new feature in the form of an API for Imaging on top of Image Definition. * Add suppression same as previous API version * Fixed example. Ran prettier * Remove suppression * re-add suppression * Update references to commontypes to v5 for changes included in this PR * Per PR comment, renamed getDetails to getBuildDetails. Added Azure-AsyncOperation as header returned in new async post actions * Generated new example subscription id as the previous one was not passing the uuid validation locally * Remove unused ListImageBuildTaskGroupsIncludeParameter --------- Co-authored-by: Nick Depinet --- .../2024-07-01-preview/commonDefinitions.json | 170 + .../preview/2024-07-01-preview/devcenter.json | 7822 +++++++++++++++++ .../examples/AttachedNetworks_Create.json | 54 + .../examples/AttachedNetworks_Delete.json | 18 + .../AttachedNetworks_GetByDevCenter.json | 32 + .../AttachedNetworks_GetByProject.json | 32 + .../AttachedNetworks_ListByDevCenter.json | 54 + .../AttachedNetworks_ListByProject.json | 54 + .../examples/Catalogs_Connect.json | 17 + .../examples/Catalogs_CreateAdo.json | 92 + .../examples/Catalogs_CreateGitHub.json | 92 + .../examples/Catalogs_Delete.json | 18 + .../examples/Catalogs_Get.json | 48 + .../Catalogs_GetSyncErrorDetails.json | 36 + .../examples/Catalogs_List.json | 50 + .../examples/Catalogs_Patch.json | 62 + .../examples/Catalogs_Sync.json | 17 + .../examples/CheckNameAvailability.json | 17 + ...opedNameAvailability_DevCenterCatalog.json | 18 + ...ScopedNameAvailability_ProjectCatalog.json | 18 + .../examples/CustomizationTasks_Get.json | 40 + .../CustomizationTasks_GetErrorDetails.json | 22 + .../CustomizationTasks_ListByCatalog.json | 42 + .../examples/DevBoxDefinitions_Create.json | 75 + .../examples/DevBoxDefinitions_Delete.json | 18 + .../examples/DevBoxDefinitions_Get.json | 37 + .../DevBoxDefinitions_GetByProject.json | 37 + .../DevBoxDefinitions_ListByDevCenter.json | 41 + .../DevBoxDefinitions_ListByProject.json | 41 + .../examples/DevBoxDefinitions_Patch.json | 50 + .../DevCenterEncryptionSets_Create.json | 84 + .../DevCenterEncryptionSets_Delete.json | 18 + .../examples/DevCenterEncryptionSets_Get.json | 41 + .../DevCenterEncryptionSets_List.json | 44 + .../DevCenterEncryptionSets_Patch.json | 52 + .../examples/DevCenters_Create.json | 93 + ...ers_CreateWithDisabledManagedNetworks.json | 100 + .../DevCenters_CreateWithEncryption.json | 124 + .../examples/DevCenters_CreateWithPlanId.json | 75 + .../DevCenters_CreateWithUserIdentity.json | 97 + .../examples/DevCenters_Delete.json | 17 + .../examples/DevCenters_Get.json | 41 + .../DevCenters_ListByResourceGroup.json | 37 + .../DevCenters_ListBySubscription.json | 36 + .../examples/DevCenters_Patch.json | 45 + .../examples/EnvironmentDefinitions_Get.json | 53 + ...onmentDefinitions_GetByProjectCatalog.json | 53 + ...nvironmentDefinitions_GetErrorDetails.json | 22 + .../EnvironmentDefinitions_ListByCatalog.json | 56 + ...nmentDefinitions_ListByProjectCatalog.json | 56 + .../examples/EnvironmentTypes_Delete.json | 13 + .../examples/EnvironmentTypes_Get.json | 33 + .../examples/EnvironmentTypes_List.json | 32 + .../examples/EnvironmentTypes_Patch.json | 41 + .../examples/EnvironmentTypes_Put.json | 63 + .../examples/Galleries_Create.json | 54 + .../examples/Galleries_Delete.json | 18 + .../examples/Galleries_Get.json | 30 + .../examples/Galleries_List.json | 50 + .../examples/ImageDefinitions_BuildImage.json | 18 + .../ImageDefinitions_CancelImageBuild.json | 19 + .../ImageDefinitions_GetByProjectCatalog.json | 38 + .../ImageDefinitions_GetImageBuild.json | 34 + ...ImageDefinitions_GetImageBuildDetails.json | 73 + ...ImageDefinitions_ListByProjectCatalog.json | 41 + ...ions_ListImageBuildsByImageDefinition.json | 38 + .../examples/ImageVersions_Get.json | 34 + .../examples/ImageVersions_GetByProject.json | 33 + .../examples/ImageVersions_List.json | 37 + .../examples/ImageVersions_ListByProject.json | 36 + .../examples/Images_Get.json | 44 + .../examples/Images_GetByProject.json | 43 + .../examples/Images_ListByDevCenter.json | 75 + .../examples/Images_ListByGallery.json | 76 + .../examples/Images_ListByProject.json | 105 + .../examples/NetworkConnections_Delete.json | 17 + .../examples/NetworkConnections_Get.json | 35 + .../NetworkConnections_GetHealthDetails.json | 37 + ...etworkConnections_ListByResourceGroup.json | 37 + ...NetworkConnections_ListBySubscription.json | 36 + .../NetworkConnections_ListHealthDetails.json | 41 + ...tOutboundNetworkDependenciesEndpoints.json | 55 + .../examples/NetworkConnections_Patch.json | 45 + .../examples/NetworkConnections_Put.json | 69 + .../NetworkConnections_RunHealthChecks.json | 16 + .../examples/OperationStatus_Get.json | 42 + .../examples/Operations_Get.json | 21 + .../examples/PlanMembers_Create.json | 66 + .../examples/PlanMembers_Delete.json | 18 + .../examples/PlanMembers_Get.json | 34 + .../examples/PlanMembers_List.json | 37 + .../examples/PlanMembers_Patch.json | 45 + .../examples/Plans_Create.json | 71 + .../examples/Plans_Delete.json | 17 + .../examples/Plans_Get.json | 35 + .../examples/Plans_ListByResourceGroup.json | 38 + .../examples/Plans_ListBySubscription.json | 37 + .../examples/Plans_Patch.json | 49 + .../examples/Pools_Delete.json | 18 + .../examples/Pools_Get.json | 46 + .../examples/Pools_GetUnhealthyStatus.json | 60 + .../examples/Pools_List.json | 49 + .../examples/Pools_Patch.json | 57 + .../examples/Pools_Put.json | 92 + .../examples/Pools_PutWithManagedNetwork.json | 99 + .../Pools_PutWithValueDevBoxDefinition.json | 119 + .../examples/Pools_RunHealthChecks.json | 17 + .../ProjectAllowedEnvironmentTypes_Get.json | 26 + .../ProjectAllowedEnvironmentTypes_List.json | 29 + ...nvironmentDefinitions_GetErrorDetails.json | 22 + .../examples/ProjectCatalogs_Connect.json | 17 + .../examples/ProjectCatalogs_CreateAdo.json | 95 + .../ProjectCatalogs_CreateGitHub.json | 95 + .../examples/ProjectCatalogs_Delete.json | 18 + .../examples/ProjectCatalogs_Get.json | 50 + .../ProjectCatalogs_GetSyncErrorDetails.json | 36 + .../examples/ProjectCatalogs_List.json | 50 + .../examples/ProjectCatalogs_Patch.json | 60 + .../examples/ProjectCatalogs_Sync.json | 17 + .../ProjectEnvironmentTypes_Delete.json | 13 + .../examples/ProjectEnvironmentTypes_Get.json | 63 + .../ProjectEnvironmentTypes_List.json | 66 + .../ProjectEnvironmentTypes_Patch.json | 85 + .../examples/ProjectEnvironmentTypes_Put.json | 146 + .../examples/Projects_Delete.json | 17 + .../examples/Projects_Get.json | 41 + .../Projects_GetInheritedSettings.json | 20 + .../Projects_ListByResourceGroup.json | 38 + .../examples/Projects_ListBySubscription.json | 37 + .../examples/Projects_Patch.json | 62 + .../examples/Projects_Put.json | 72 + .../Projects_PutWithMaxDevBoxPerUser.json | 72 + ...dules_CreateDailyShutdownPoolSchedule.json | 67 + .../examples/Schedules_Delete.json | 19 + .../examples/Schedules_Get.json | 35 + .../examples/Schedules_ListByPool.json | 38 + .../examples/Schedules_Patch.json | 46 + .../examples/Skus_ListByProject.json | 32 + .../examples/Skus_ListBySubscription.json | 30 + .../examples/Usages_ListByLocation.json | 34 + .../preview/2024-07-01-preview/vdi.json | 1958 +++++ .../devcenter/resource-manager/readme.md | 17 +- 142 files changed, 16323 insertions(+), 1 deletion(-) create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/commonDefinitions.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/devcenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_GetByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Connect.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_CreateAdo.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_CreateGitHub.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_GetSyncErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Sync.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckNameAvailability.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_GetErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_ListByCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithEncryption.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithPlanId.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithUserIdentity.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_BuildImage.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_CancelImageBuild.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetImageBuild.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetImageBuildDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_ListImageBuildsByImageDefinition.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByGallery.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_GetHealthDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListHealthDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_RunHealthChecks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/OperationStatus_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Operations_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_GetUnhealthyStatus.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_PutWithManagedNetwork.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_RunHealthChecks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Connect.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_CreateAdo.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_CreateGitHub.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Sync.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_GetInheritedSettings.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_ListByPool.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Skus_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Skus_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Usages_ListByLocation.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/vdi.json diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/commonDefinitions.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/commonDefinitions.json new file mode 100644 index 000000000000..0a0aed864aaa --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/commonDefinitions.json @@ -0,0 +1,170 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-07-01-preview", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "Capability": { + "description": "A name/value pair to describe a capability.", + "type": "object", + "properties": { + "name": { + "description": "Name of the capability.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value of the capability.", + "type": "string", + "readOnly": true + } + } + }, + "TrackedResourceUpdate": { + "description": "Base tracked resource type for PATCH updates", + "type": "object", + "properties": { + "tags": { + "$ref": "#/definitions/Tags", + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + } + }, + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "DevCenterSku": { + "description": "The resource model definition representing SKU for DevCenter resources", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + ], + "properties": { + "resourceType": { + "type": "string", + "description": "The name of the resource type", + "readOnly": true + }, + "locations": { + "description": "SKU supported locations.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "capabilities": { + "description": "Collection of name/value pairs to describe the SKU capabilities.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Capability" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Creating", + "Created", + "Updating", + "Updated", + "Deleting", + "Deleted", + "Succeeded", + "Failed", + "Canceled", + "MovingResources", + "TransientFailure", + "RolloutInProgress", + "StorageProvisioningFailed" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + }, + "parameters": { + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the project.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "TopParameter": { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'.", + "type": "integer", + "format": "int32", + "required": false, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/devcenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/devcenter.json new file mode 100644 index 000000000000..ac1c64a495f7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/devcenter.json @@ -0,0 +1,7822 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-07-01-preview", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/plans": { + "get": { + "tags": [ + "Plans" + ], + "description": "Lists all devcenter plans in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Plans_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_ListBySubscription": { + "$ref": "./examples/Plans_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans": { + "get": { + "tags": [ + "Plans" + ], + "description": "Lists all devcenter plans in 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Plans_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_ListByResourceGroup": { + "$ref": "./examples/Plans_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}": { + "get": { + "tags": [ + "Plans" + ], + "description": "Gets a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + } + ], + "operationId": "Plans_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Get": { + "$ref": "./examples/Plans_Get.json" + } + } + }, + "put": { + "tags": [ + "Plans" + ], + "description": "Creates or updates a devcenter plan resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter plan.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + } + ], + "operationId": "Plans_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Create": { + "$ref": "./examples/Plans_Create.json" + } + } + }, + "patch": { + "tags": [ + "Plans" + ], + "description": "Partially updates a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter plan properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PlanUpdate" + } + } + ], + "operationId": "Plans_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Update": { + "$ref": "./examples/Plans_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Plans" + ], + "description": "Deletes a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + } + ], + "operationId": "Plans_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Delete": { + "$ref": "./examples/Plans_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}/members": { + "get": { + "tags": [ + "Plans" + ], + "description": "Lists all of the members assigned to a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "PlanMembers_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PlanMembersListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_ListByResourceGroup": { + "$ref": "./examples/PlanMembers_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}/members/{memberName}": { + "get": { + "tags": [ + "Plans" + ], + "description": "Gets a devcenter plan member.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + } + ], + "operationId": "PlanMembers_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Get": { + "$ref": "./examples/PlanMembers_Get.json" + } + } + }, + "put": { + "tags": [ + "Plans" + ], + "description": "Creates or updates a devcenter plan member resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter plan.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + } + ], + "operationId": "PlanMembers_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Create": { + "$ref": "./examples/PlanMembers_Create.json" + } + } + }, + "patch": { + "tags": [ + "Plans" + ], + "description": "Partially updates a devcenter 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" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter plan properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PlanMemberUpdate" + } + } + ], + "operationId": "PlanMembers_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Update": { + "$ref": "./examples/PlanMembers_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Plans" + ], + "description": "Deletes a devcenter plan member", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + } + ], + "operationId": "PlanMembers_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Delete": { + "$ref": "./examples/PlanMembers_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/devcenters": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Lists all devcenters in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "DevCenters_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_ListBySubscription": { + "$ref": "./examples/DevCenters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Lists all devcenters in 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "DevCenters_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_ListByResourceGroup": { + "$ref": "./examples/DevCenters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Gets a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + } + ], + "operationId": "DevCenters_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Get": { + "$ref": "./examples/DevCenters_Get.json" + } + } + }, + "put": { + "tags": [ + "DevCenters" + ], + "description": "Creates or updates a devcenter resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenter" + } + } + ], + "operationId": "DevCenters_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Create": { + "$ref": "./examples/DevCenters_Create.json" + }, + "DevCenters_CreateWithPlanId": { + "$ref": "./examples/DevCenters_CreateWithPlanId.json" + }, + "DevCenters_CreateWithUserIdentity": { + "$ref": "./examples/DevCenters_CreateWithUserIdentity.json" + }, + "DevCenters_CreateWithEncryption": { + "$ref": "./examples/DevCenters_CreateWithEncryption.json" + }, + "DevCenters_CreateWithDisabledManagedNetworks": { + "$ref": "./examples/DevCenters_CreateWithDisabledManagedNetworks.json" + } + } + }, + "patch": { + "tags": [ + "DevCenters" + ], + "description": "Partially updates a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter properties.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterUpdate" + } + } + ], + "operationId": "DevCenters_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Update": { + "$ref": "./examples/DevCenters_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DevCenters" + ], + "description": "Deletes a devcenter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + } + ], + "operationId": "DevCenters_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Delete": { + "$ref": "./examples/DevCenters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/encryptionSets": { + "get": { + "tags": [ + "EncryptionSets" + ], + "description": "Lists all encryption sets in the devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EncryptionSets_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EncryptionSetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_List": { + "$ref": "./examples/DevCenterEncryptionSets_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/encryptionSets/{encryptionSetName}": { + "get": { + "tags": [ + "EncryptionSets" + ], + "description": "Gets a devcenter encryption set.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + } + ], + "operationId": "EncryptionSets_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Get": { + "$ref": "./examples/DevCenterEncryptionSets_Get.json" + } + } + }, + "put": { + "tags": [ + "EncryptionSets" + ], + "description": "Creates or updates a devcenter encryption set resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter encryption set.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + } + ], + "operationId": "EncryptionSets_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Create": { + "$ref": "./examples/DevCenterEncryptionSets_Create.json" + } + } + }, + "patch": { + "tags": [ + "EncryptionSets" + ], + "description": "Partially updates a devcenter encryption set.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter encryption set properties.", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionSetUpdate" + } + } + ], + "operationId": "EncryptionSets_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Update": { + "$ref": "./examples/DevCenterEncryptionSets_Patch.json" + } + } + }, + "delete": { + "tags": [ + "EncryptionSets" + ], + "description": "Deletes a devcenter encryption set", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + } + ], + "operationId": "EncryptionSets_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Delete": { + "$ref": "./examples/DevCenterEncryptionSets_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Projects_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_ListBySubscription": { + "$ref": "./examples/Projects_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects in 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Projects_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_ListByResourceGroup": { + "$ref": "./examples/Projects_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}": { + "get": { + "tags": [ + "Projects" + ], + "description": "Gets a specific 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_Get": { + "$ref": "./examples/Projects_Get.json" + } + } + }, + "put": { + "tags": [ + "Projects" + ], + "description": "Creates or updates a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "operationId": "Projects_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_CreateOrUpdate": { + "$ref": "./examples/Projects_Put.json" + }, + "Projects_CreateOrUpdateWithLimitsPerDev": { + "$ref": "./examples/Projects_PutWithMaxDevBoxPerUser.json" + } + } + }, + "patch": { + "tags": [ + "Projects" + ], + "description": "Partially updates a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdate" + } + } + ], + "operationId": "Projects_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_Update": { + "$ref": "./examples/Projects_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Projects" + ], + "description": "Deletes a project resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_Delete": { + "$ref": "./examples/Projects_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/getInheritedSettings": { + "post": { + "tags": [ + "Projects" + ], + "description": "Gets applicable inherited settings for this 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_GetInheritedSettings", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InheritedSettingsForProject" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_GetInheritedSettings": { + "$ref": "./examples/Projects_GetInheritedSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks": { + "get": { + "tags": [ + "Attached NetworkConnections." + ], + "description": "Lists the attached NetworkConnections for a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "AttachedNetworks_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_ListByProject": { + "$ref": "./examples/AttachedNetworks_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks/{attachedNetworkConnectionName}": { + "get": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Gets an attached NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_GetByProject": { + "$ref": "./examples/AttachedNetworks_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs": { + "get": { + "tags": [ + "Project Catalogs" + ], + "description": "Lists the catalogs associated with a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectCatalogs_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_List": { + "$ref": "./examples/ProjectCatalogs_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}": { + "get": { + "tags": [ + "Project Catalogs" + ], + "description": "Gets an associated project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_Get": { + "$ref": "./examples/ProjectCatalogs_Get.json" + } + } + }, + "put": { + "tags": [ + "Project Catalogs" + ], + "description": "Creates or updates a project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a catalog.", + "required": true, + "schema": { + "$ref": "#/definitions/Catalog" + } + } + ], + "operationId": "ProjectCatalogs_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_CreateOrUpdateGitHub": { + "$ref": "./examples/ProjectCatalogs_CreateGitHub.json" + }, + "ProjectCatalogs_CreateOrUpdateAdo": { + "$ref": "./examples/ProjectCatalogs_CreateAdo.json" + } + } + }, + "patch": { + "tags": [ + "Project Catalogs" + ], + "description": "Partially updates a project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project catalog properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CatalogUpdate" + } + } + ], + "operationId": "ProjectCatalogs_Patch", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "202": { + "description": "The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_Patch": { + "$ref": "./examples/ProjectCatalogs_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Project Catalogs" + ], + "description": "Deletes a project catalog resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_Delete": { + "$ref": "./examples/ProjectCatalogs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Lists the environment definitions in this project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "EnvironmentDefinitions_ListByProjectCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_ListByProjectCatalog": { + "$ref": "./examples/EnvironmentDefinitions_ListByProjectCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets an environment definition from the catalog.", + "operationId": "EnvironmentDefinitions_GetByProjectCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_GetByProjectCatalog": { + "$ref": "./examples/EnvironmentDefinitions_GetByProjectCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}/getErrorDetails": { + "post": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets Environment Definition error details", + "operationId": "ProjectCatalogEnvironmentDefinitions_GetErrorDetails", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/CatalogResourceValidationErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogEnvironmentDefinitions_GetErrorDetails": { + "$ref": "./examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/getSyncErrorDetails": { + "post": { + "tags": [ + "Project Catalogs" + ], + "description": "Gets project catalog synchronization error details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_GetSyncErrorDetails", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SyncErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_GetSyncErrorDetails": { + "$ref": "./examples/ProjectCatalogs_GetSyncErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/sync": { + "post": { + "tags": [ + "Project Catalogs" + ], + "description": "Syncs templates for a template source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Sync", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_Sync": { + "$ref": "./examples/ProjectCatalogs_Sync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/connect": { + "post": { + "tags": [ + "Project Catalogs" + ], + "description": "Connects a project catalog to enable syncing.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Connect", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_Connect": { + "$ref": "./examples/ProjectCatalogs_Connect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "description": "Lists galleries for a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Galleries_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/GalleryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Galleries_ListByDevCenter": { + "$ref": "./examples/Galleries_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}": { + "get": { + "tags": [ + "Galleries" + ], + "description": "Gets a gallery", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + } + ], + "operationId": "Galleries_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Galleries_Get": { + "$ref": "./examples/Galleries_Get.json" + } + } + }, + "put": { + "tags": [ + "Galleries" + ], + "description": "Creates or updates a gallery.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a gallery.", + "required": true, + "schema": { + "$ref": "#/definitions/Gallery" + } + } + ], + "operationId": "Galleries_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Galleries_CreateOrUpdate": { + "$ref": "./examples/Galleries_Create.json" + } + } + }, + "delete": { + "tags": [ + "Galleries" + ], + "description": "Deletes a gallery resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + } + ], + "operationId": "Galleries_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Galleries_Delete": { + "$ref": "./examples/Galleries_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Images_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByDevCenter": { + "$ref": "./examples/Images_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a gallery.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Images_ListByGallery", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByGallery": { + "$ref": "./examples/Images_ListByGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}": { + "get": { + "tags": [ + "Images" + ], + "description": "Gets a gallery image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + } + ], + "operationId": "Images_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_Get": { + "$ref": "./examples/Images_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}/versions": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Lists versions for an image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + } + ], + "operationId": "ImageVersions_ListByImage", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_ListByImage": { + "$ref": "./examples/ImageVersions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}/versions/{versionName}": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Gets an image version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + } + ], + "operationId": "ImageVersions_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Versions_Get": { + "$ref": "./examples/ImageVersions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + } + ], + "operationId": "Images_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByProject": { + "$ref": "./examples/Images_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}": { + "get": { + "tags": [ + "Images" + ], + "description": "Gets an image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/ProjectImageNameParameter" + } + ], + "operationId": "Images_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_GetByProject": { + "$ref": "./examples/Images_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}/versions": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Lists versions for an image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/ProjectImageNameParameter" + } + ], + "operationId": "ImageVersions_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_ListByProject": { + "$ref": "./examples/ImageVersions_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}/versions/{versionName}": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Gets an image version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/ProjectImageNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + } + ], + "operationId": "ImageVersions_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_GetByProject": { + "$ref": "./examples/ImageVersions_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/listSkus": { + "post": { + "tags": [ + "Project SKUs" + ], + "description": "Lists SKUs available to 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Skus_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Skus_ListByProject": { + "$ref": "./examples/Skus_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks": { + "get": { + "tags": [ + "Attached NetworkConnections." + ], + "description": "Lists the attached NetworkConnections for a DevCenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "AttachedNetworks_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_ListByDevCenter": { + "$ref": "./examples/AttachedNetworks_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks/{attachedNetworkConnectionName}": { + "get": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Gets an attached NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_GetByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_GetByDevCenter": { + "$ref": "./examples/AttachedNetworks_GetByDevCenter.json" + } + } + }, + "put": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Creates or updates an attached NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an attached NetworkConnection.", + "required": true, + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + } + ], + "operationId": "AttachedNetworks_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "AttachedNetworks_Create": { + "$ref": "./examples/AttachedNetworks_Create.json" + } + } + }, + "delete": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Un-attach a NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_Delete": { + "$ref": "./examples/AttachedNetworks_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Lists catalogs for a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Catalogs_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListByDevCenter": { + "$ref": "./examples/Catalogs_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Gets a catalog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Get": { + "$ref": "./examples/Catalogs_Get.json" + } + } + }, + "put": { + "tags": [ + "Catalogs" + ], + "description": "Creates or updates a catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a catalog.", + "required": true, + "schema": { + "$ref": "#/definitions/Catalog" + } + } + ], + "operationId": "Catalogs_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_CreateOrUpdateGitHub": { + "$ref": "./examples/Catalogs_CreateGitHub.json" + }, + "Catalogs_CreateOrUpdateAdo": { + "$ref": "./examples/Catalogs_CreateAdo.json" + } + } + }, + "patch": { + "tags": [ + "Catalogs" + ], + "description": "Partially updates a catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable catalog properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CatalogUpdate" + } + } + ], + "operationId": "Catalogs_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "202": { + "description": "The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Update": { + "$ref": "./examples/Catalogs_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Catalogs" + ], + "description": "Deletes a catalog resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Delete": { + "$ref": "./examples/Catalogs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/getSyncErrorDetails": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "post": { + "tags": [ + "Catalogs" + ], + "description": "Gets catalog synchronization error details", + "operationId": "Catalogs_GetSyncErrorDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SyncErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_GetSyncErrorDetails": { + "$ref": "./examples/Catalogs_GetSyncErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/sync": { + "post": { + "tags": [ + "Catalogs" + ], + "description": "Syncs templates for a template source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Sync", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Sync": { + "$ref": "./examples/Catalogs_Sync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/connect": { + "post": { + "tags": [ + "Catalogs" + ], + "description": "Connects a catalog to enable syncing.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Connect", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Connect": { + "$ref": "./examples/Catalogs_Connect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists environment types for the devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EnvironmentTypes_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_ListByDevCenter": { + "$ref": "./examples/EnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "EnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Get": { + "$ref": "./examples/EnvironmentTypes_Get.json" + } + } + }, + "put": { + "tags": [ + "Environment Types" + ], + "description": "Creates or updates an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an Environment Type.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + } + ], + "operationId": "EnvironmentTypes_CreateOrUpdate", + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_CreateOrUpdate": { + "$ref": "./examples/EnvironmentTypes_Put.json" + } + } + }, + "patch": { + "tags": [ + "Environment Types" + ], + "description": "Partially updates an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable environment type properties.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentTypeUpdate" + } + } + ], + "operationId": "EnvironmentTypes_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Update": { + "$ref": "./examples/EnvironmentTypes_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Environment Types" + ], + "description": "Deletes an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "EnvironmentTypes_Delete", + "responses": { + "200": { + "description": "Resource was deleted." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Delete": { + "$ref": "./examples/EnvironmentTypes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists allowed environment types for a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectAllowedEnvironmentTypes_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AllowedEnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectAllowedEnvironmentTypes_List": { + "$ref": "./examples/ProjectAllowedEnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets an allowed environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectAllowedEnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AllowedEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectAllowedEnvironmentTypes_Get": { + "$ref": "./examples/ProjectAllowedEnvironmentTypes_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists environment types for a 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_List": { + "$ref": "./examples/ProjectEnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Get": { + "$ref": "./examples/ProjectEnvironmentTypes_Get.json" + } + } + }, + "put": { + "tags": [ + "Environment Types" + ], + "description": "Creates or updates a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a Project Environment Type.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + } + ], + "operationId": "ProjectEnvironmentTypes_CreateOrUpdate", + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_CreateOrUpdate": { + "$ref": "./examples/ProjectEnvironmentTypes_Put.json" + } + } + }, + "patch": { + "tags": [ + "Environment Types" + ], + "description": "Partially updates a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project environment type properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectEnvironmentTypeUpdate" + } + } + ], + "operationId": "ProjectEnvironmentTypes_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Update": { + "$ref": "./examples/ProjectEnvironmentTypes_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Environment Types" + ], + "description": "Deletes a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_Delete", + "responses": { + "200": { + "description": "Resource was deleted." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Delete": { + "$ref": "./examples/ProjectEnvironmentTypes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "List Dev Box definitions for a devcenter.", + "operationId": "DevBoxDefinitions_ListByDevCenter", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DevBoxDefinitions_ListByDevCenter": { + "$ref": "./examples/DevBoxDefinitions_ListByDevCenter.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevBoxDefinitionName" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Gets a Dev Box definition", + "operationId": "DevBoxDefinitions_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Get": { + "$ref": "./examples/DevBoxDefinitions_Get.json" + } + } + }, + "put": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Creates or updates a Dev Box definition.", + "operationId": "DevBoxDefinitions_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a Dev Box definition.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "201": { + "description": "Created. The operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Create": { + "$ref": "./examples/DevBoxDefinitions_Create.json" + } + } + }, + "patch": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Partially updates a Dev Box definition.", + "operationId": "DevBoxDefinitions_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a Dev Box definition.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBoxDefinitionUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "202": { + "description": "Accepted. The operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Patch": { + "$ref": "./examples/DevBoxDefinitions_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Deletes a Dev Box definition", + "operationId": "DevBoxDefinitions_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [], + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Delete": { + "$ref": "./examples/DevBoxDefinitions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "List Dev Box definitions configured for a project.", + "operationId": "DevBoxDefinitions_ListByProject", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DevBoxDefinitions_ListByProject": { + "$ref": "./examples/DevBoxDefinitions_ListByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions/{devBoxDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/DevBoxDefinitionName" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Gets a Dev Box definition configured for a project", + "operationId": "DevBoxDefinitions_GetByProject", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_GetByProject": { + "$ref": "./examples/DevBoxDefinitions_GetByProject.json" + } + } + } + }, + "/providers/Microsoft.DevCenter/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available resource provider operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_Get": { + "$ref": "./examples/Operations_Get.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/operationStatuses/{operationId}": { + "get": { + "description": "Gets the current status of an async operation.", + "operationId": "OperationStatuses_Get", + "summary": "Get Operation Status", + "tags": [ + "OperationStatus" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "The requested operation status", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "The requested operation status", + "headers": { + "Location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/OperationStatus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/usages": { + "get": { + "operationId": "Usages_ListByLocation", + "description": "Lists the current usages and limits in this location for the provided subscription.", + "tags": [ + "Usages" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; a list of usages is returned", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "The default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "listUsages": { + "$ref": "./examples/Usages_ListByLocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/checkScopedNameAvailability": { + "post": { + "tags": [ + "CheckScopedNameAvailability" + ], + "operationId": "CheckScopedNameAvailability_Execute", + "x-ms-examples": { + "DevcenterCatalogNameAvailability": { + "$ref": "./examples/CheckScopedNameAvailability_DevCenterCatalog.json" + }, + "ProjectCatalogNameAvailability": { + "$ref": "./examples/CheckScopedNameAvailability_ProjectCatalog.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckScopedNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Customization Tasks" + ], + "description": "List Tasks in the catalog.", + "operationId": "CustomizationTasks_ListByCatalog", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationTaskListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CustomizationTasks_ListByCatalog": { + "$ref": "./examples/CustomizationTasks_ListByCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks/{taskName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/CustomizationTaskNameParameter" + } + ], + "get": { + "tags": [ + "Customization Tasks" + ], + "description": "Gets a Task from the catalog", + "operationId": "CustomizationTasks_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomizationTasks_Get": { + "$ref": "./examples/CustomizationTasks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks/{taskName}/getErrorDetails": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/CustomizationTaskNameParameter" + } + ], + "post": { + "tags": [ + "Customization Tasks" + ], + "description": "Gets Customization Task error details", + "operationId": "CustomizationTasks_GetErrorDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/CatalogResourceValidationErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomizationTasks_GetErrorDetails": { + "$ref": "./examples/CustomizationTasks_GetErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "List environment definitions in the catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EnvironmentDefinitions_ListByCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EnvironmentDefinitions_ListByCatalog": { + "$ref": "./examples/EnvironmentDefinitions_ListByCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets an environment definition from the catalog.", + "operationId": "EnvironmentDefinitions_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_Get": { + "$ref": "./examples/EnvironmentDefinitions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}/getErrorDetails": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "post": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets Environment Definition error details", + "operationId": "EnvironmentDefinitions_GetErrorDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/CatalogResourceValidationErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_GetErrorDetails": { + "$ref": "./examples/EnvironmentDefinitions_GetErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "List Image Definitions in the catalog.", + "operationId": "ProjectCatalogImageDefinitions_ListByProjectCatalog", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImageDefinitions_ListByProjectCatalog": { + "$ref": "./examples/ImageDefinitions_ListByProjectCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "Gets an Image Definition from the catalog", + "operationId": "ProjectCatalogImageDefinitions_GetByProjectCatalog", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitions_GetByProjectCatalog": { + "$ref": "./examples/ImageDefinitions_GetByProjectCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/buildImage": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + } + ], + "post": { + "tags": [ + "Image Definitions" + ], + "description": "Builds an image for the specified Image Definition.", + "operationId": "ProjectCatalogImageDefinitions_BuildImage", + "parameters": [], + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogImageDefinitions_BuildImage": { + "$ref": "./examples/ImageDefinitions_BuildImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "Lists builds for a specified image definition.", + "operationId": "ProjectCatalogImageDefinitionBuilds_ListByImageDefinition", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinitionBuildListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitionBuilds_ListByImageDefinition": { + "$ref": "./examples/ImageDefinitions_ListImageBuildsByImageDefinition.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds/{buildName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionBuildNameParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "Gets a build for a specified image definition.", + "operationId": "ProjectCatalogImageDefinitionBuild_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinitionBuild" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitionBuilds_GetByImageDefinition": { + "$ref": "./examples/ImageDefinitions_GetImageBuild.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds/{buildName}/cancel": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionBuildNameParameter" + } + ], + "post": { + "tags": [ + "Image Definitions" + ], + "description": "Cancels the specified build for an image definition.", + "operationId": "ProjectCatalogImageDefinitionBuild_Cancel", + "parameters": [], + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ImageDefinitionBuilds_CancelByImageDefinition": { + "$ref": "./examples/ImageDefinitions_CancelImageBuild.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds/{buildName}/getBuildDetails": { + "post": { + "tags": [ + "Image Definitions" + ], + "description": "Gets Build details", + "operationId": "ProjectCatalogImageDefinitionBuild_GetBuildDetails", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionBuildNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinitionBuildDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogImageDefinitionBuild_GetErrorDetails": { + "$ref": "./examples/ImageDefinitions_GetImageBuildDetails.json" + } + } + } + } + }, + "definitions": { + "DevCenterPlan": { + "type": "object", + "description": "Represents a devcenter plan resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Plan properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PlanProperties" + }, + "sku": { + "description": "The SKU for DevCenters created using this definition.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + } + }, + "PlanProperties": { + "description": "Properties of the devcenter plan.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DevCenterPlanMember": { + "type": "object", + "description": "Represents a devcenter plan member resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Plan member properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PlanMemberProperties" + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "PlanMemberProperties": { + "description": "Properties of the devcenter plan member.", + "type": "object", + "properties": { + "memberId": { + "description": "The unique id of the member.", + "type": "string" + }, + "memberType": { + "description": "The type of the member (user, group)", + "enum": [ + "User", + "Group" + ], + "type": "string", + "x-ms-enum": { + "name": "PlanMemberType", + "modelAsString": true + } + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "PlanMemberUpdate": { + "description": "The devcenter plan member resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "DevCenter": { + "type": "object", + "description": "Represents a devcenter resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "DevCenter properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterProperties" + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "DevCenterProperties": { + "description": "Properties of the devcenter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevCenterUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "devCenterUri": { + "description": "The URI of the Dev Center.", + "$ref": "#/definitions/DevCenterUri", + "readOnly": true + } + } + }, + "DevCenterUpdateProperties": { + "description": "Properties of the devcenter. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "planId": { + "type": "string", + "description": "Resource Id of an associated Plan" + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption settings to be used for server-side encryption for proprietary content (such as catalogs, logs, customizations)." + }, + "displayName": { + "type": "string", + "description": "The display name of the devcenter." + }, + "projectCatalogSettings": { + "$ref": "#/definitions/DevCenterProjectCatalogSettings", + "description": "Dev Center settings to be used when associating a project with a catalog." + }, + "networkSettings": { + "$ref": "#/definitions/DevCenterNetworkSettings", + "description": "Network settings that will be enforced on network resources associated with the Dev Center." + }, + "devBoxProvisioningSettings": { + "$ref": "#/definitions/DevBoxProvisioningSettings", + "description": "Settings to be used in the provisioning of all Dev Boxes that belong to this dev center." + } + } + }, + "DevCenterEncryptionSet": { + "description": "Represents a devcenter encryption set resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterEncryptionSetProperties", + "description": "Properties of a devcenter encryption set." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "DevCenterEncryptionSetProperties": { + "description": "Properties of the devcenter encryption set.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevCenterEncryptionSetUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DevCenterEncryptionSetUpdateProperties": { + "description": "Properties of the devcenter encryption set. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devboxDisksEncryptionEnableStatus": { + "description": "Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption using DevCenter CMK is enabled or not.", + "$ref": "#/definitions/DevboxDisksEncryptionEnableStatus" + }, + "keyEncryptionKeyUrl": { + "type": "string", + "description": "Key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek." + } + } + }, + "DevboxDisksEncryptionEnableStatus": { + "description": "Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption is enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DevboxDisksEncryptionEnableStatus", + "modelAsString": true + } + }, + "DevCenterProjectCatalogSettings": { + "type": "object", + "description": "Project catalog settings for project catalogs under a project associated to this dev center.", + "properties": { + "catalogItemSyncEnableStatus": { + "description": "Whether project catalogs associated with projects in this dev center can be configured to sync catalog items.", + "$ref": "#/definitions/CatalogItemSyncEnableStatus" + } + } + }, + "DevBoxProvisioningSettings": { + "type": "object", + "description": "Provisioning settings that apply to all Dev Boxes created in this dev center", + "properties": { + "installAzureMonitorAgentEnableStatus": { + "description": "Whether project catalogs associated with projects in this dev center can be configured to sync catalog items.", + "$ref": "#/definitions/InstallAzureMonitorAgentEnableStatus" + } + } + }, + "CatalogItemSyncEnableStatus": { + "description": "Catalog item sync types enable or disable status. Indicates whether project catalogs are allowed to sync catalog items under projects associated to this dev center.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogItemSyncEnableStatus", + "modelAsString": true + } + }, + "DevCenterNetworkSettings": { + "type": "object", + "description": "Network settings for the Dev Center.", + "properties": { + "microsoftHostedNetworkEnableStatus": { + "$ref": "#/definitions/MicrosoftHostedNetworkEnableStatus" + } + } + }, + "ProjectNetworkSettings": { + "type": "object", + "description": "Network settings for the project.", + "properties": { + "microsoftHostedNetworkEnableStatus": { + "$ref": "#/definitions/MicrosoftHostedNetworkEnableStatus", + "readOnly": true + } + } + }, + "MicrosoftHostedNetworkEnableStatus": { + "description": "Indicates whether pools in this Dev Center can use Microsoft Hosted Networks. Defaults to Enabled if not set.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MicrosoftHostedNetworkEnableStatus", + "modelAsString": true + } + }, + "Encryption": { + "type": "object", + "properties": { + "customerManagedKeyEncryption": { + "$ref": "../../../../../common-types/resource-management/v4/customermanagedkeys.json#/definitions/customerManagedKeyEncryption" + } + } + }, + "InstallAzureMonitorAgentEnableStatus": { + "description": "Setting to be used when determining whether to install the Azure Monitor Agent service on Dev Boxes that belong to this dev center.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "InstallAzureMonitorAgentEnableStatus", + "modelAsString": true + } + }, + "PlanUpdate": { + "description": "The devcenter plan resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "sku": { + "description": "The SKU for DevCenters created using this definition.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + } + }, + "DevCenterUpdate": { + "description": "The devcenter resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterUpdateProperties", + "description": "Properties of a Dev Center to be updated." + } + } + }, + "EncryptionSetUpdate": { + "description": "The devcenter encryption set resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterEncryptionSetUpdateProperties", + "description": "Properties of a Dev Center encryption set to be updated." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "PlanListResult": { + "description": "Result of the list devcenter plans operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "PlanMembersListResult": { + "description": "Result of the list devcenter plan members operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevCenterListResult": { + "description": "Result of the list devcenters operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenter" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionSetListResult": { + "description": "Result of the list devcenter encryption set operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevCenterUri": { + "description": "The URI of the resource.", + "readOnly": true, + "type": "string" + }, + "Project": { + "description": "Represents a project resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectProperties", + "description": "Properties of a project." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectUpdateProperties": { + "description": "Properties of a project. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devCenterId": { + "type": "string", + "description": "Resource Id of an associated DevCenter" + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "maxDevBoxesPerUser": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. This will have no effect on existing Dev Boxes when reduced." + }, + "displayName": { + "type": "string", + "description": "The display name of the project." + }, + "catalogSettings": { + "$ref": "#/definitions/ProjectCatalogSettings", + "description": "Settings to be used when associating a project with a catalog." + } + } + }, + "ProjectCatalogSettings": { + "description": "Settings to be used when associating a project with a catalog.", + "type": "object", + "properties": { + "catalogItemSyncTypes": { + "description": "Indicates catalog item types that can be synced.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItemType" + } + } + } + }, + "ProjectProperties": { + "description": "Properties of a project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProjectUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "devCenterUri": { + "description": "The URI of the Dev Center resource this project is associated with.", + "$ref": "#/definitions/DevCenterUri", + "readOnly": true + } + } + }, + "ProjectUpdate": { + "description": "The project properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectUpdateProperties", + "description": "Properties of a project to be updated." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectListResult": { + "description": "Results of the project list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Project" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "InheritedSettingsForProject": { + "description": "Applicable inherited settings for a project.", + "type": "object", + "properties": { + "projectCatalogSettings": { + "$ref": "#/definitions/DevCenterProjectCatalogSettings", + "description": "Dev Center settings to be used when associating a project with a catalog.", + "readOnly": true + }, + "networkSettings": { + "$ref": "#/definitions/ProjectNetworkSettings", + "description": "Network settings that will be enforced on this project.", + "readOnly": true + } + } + }, + "Catalog": { + "description": "Represents a catalog.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CatalogProperties", + "description": "Catalog properties." + } + } + }, + "CatalogUpdateProperties": { + "description": "Properties of a catalog. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "gitHub": { + "description": "Properties for a GitHub catalog type.", + "$ref": "#/definitions/GitCatalog" + }, + "adoGit": { + "description": "Properties for an Azure DevOps catalog type.", + "$ref": "#/definitions/GitCatalog" + }, + "syncType": { + "enum": [ + "Manual", + "Scheduled" + ], + "description": "Indicates the type of sync that is configured for the catalog.", + "type": "string", + "x-ms-enum": { + "name": "CatalogSyncType", + "modelAsString": true + } + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "CatalogProperties": { + "description": "Properties of a catalog.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CatalogUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "syncState": { + "enum": [ + "Succeeded", + "InProgress", + "Failed", + "Canceled" + ], + "description": "The synchronization state of the catalog.", + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "CatalogSyncState", + "modelAsString": true + } + }, + "lastSyncStats": { + "description": "Stats of the latest synchronization.", + "$ref": "#/definitions/SyncStats", + "readOnly": true + }, + "connectionState": { + "enum": [ + "Connected", + "Disconnected" + ], + "description": "The connection state of the catalog.", + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "CatalogConnectionState", + "modelAsString": true + } + }, + "lastConnectionTime": { + "description": "When the catalog was last connected.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "lastSyncTime": { + "description": "When the catalog was last synced.", + "type": "string", + "readOnly": true, + "format": "date-time" + } + } + }, + "SyncStats": { + "description": "Stats of the synchronization.", + "type": "object", + "properties": { + "added": { + "description": "Count of catalog items added during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "updated": { + "description": "Count of catalog items updated during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "unchanged": { + "description": "Count of catalog items that were unchanged during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "removed": { + "description": "Count of catalog items removed during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "validationErrors": { + "description": "Count of catalog items that had validation errors during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "synchronizationErrors": { + "description": "Count of synchronization errors that occured during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "syncedCatalogItemTypes": { + "description": "Indicates catalog item types that were synced.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItemType" + } + } + } + }, + "GitCatalog": { + "description": "Properties for a Git repository catalog.", + "type": "object", + "properties": { + "uri": { + "description": "Git URI.", + "type": "string" + }, + "branch": { + "description": "Git branch.", + "type": "string" + }, + "secretIdentifier": { + "description": "A reference to the Key Vault secret containing a security token to authenticate to a Git repository.", + "type": "string" + }, + "path": { + "description": "The folder where the catalog items can be found inside the repository.", + "type": "string" + } + } + }, + "CatalogUpdate": { + "description": "The catalog's properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CatalogUpdateProperties", + "description": "Catalog properties for update." + } + } + }, + "CatalogListResult": { + "description": "Results of the catalog list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Catalog" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "SyncErrorDetails": { + "description": "Synchronization error details.", + "type": "object", + "properties": { + "operationError": { + "description": "Error information for the overall synchronization operation.", + "readOnly": true, + "$ref": "vdi.json#/definitions/CatalogErrorDetails" + }, + "conflicts": { + "description": "Catalog items that have conflicting names.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogConflictError" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "errors": { + "description": "Errors that occured during synchronization.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogSyncError" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "CatalogSyncError": { + "description": "An individual synchronization error.", + "type": "object", + "properties": { + "path": { + "description": "The path of the file the error is associated with.", + "type": "string", + "readOnly": true + }, + "errorDetails": { + "description": "Errors associated with the file.", + "type": "array", + "items": { + "$ref": "vdi.json#/definitions/CatalogErrorDetails" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "CatalogConflictError": { + "description": "An individual conflict error.", + "type": "object", + "properties": { + "path": { + "description": "The path of the file that has a conflicting name.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the conflicting catalog item.", + "type": "string", + "readOnly": true + } + } + }, + "Gallery": { + "description": "Represents a gallery.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties", + "description": "Gallery properties." + } + } + }, + "GalleryProperties": { + "description": "Properties of a gallery.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "galleryResourceId": { + "description": "The resource ID of the backing Azure Compute Gallery.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "galleryResourceId" + ] + }, + "Image": { + "description": "Represents an image.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties", + "description": "Image properties." + } + } + }, + "ImageProperties": { + "description": "Properties of an image.", + "type": "object", + "properties": { + "description": { + "description": "The description of the image.", + "type": "string", + "readOnly": true + }, + "publisher": { + "description": "The publisher of the image.", + "type": "string", + "readOnly": true + }, + "offer": { + "description": "The name of the image offer.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The SKU name for the image.", + "type": "string", + "readOnly": true + }, + "recommendedMachineConfiguration": { + "description": "The recommended machine configuration to use with the image.", + "$ref": "#/definitions/RecommendedMachineConfiguration", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "hibernateSupport": { + "description": "Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate", + "readOnly": true, + "$ref": "#/definitions/HibernateSupport" + } + } + }, + "RecommendedMachineConfiguration": { + "description": "Properties for a recommended machine configuration.", + "type": "object", + "properties": { + "memory": { + "description": "Recommended memory range.", + "$ref": "#/definitions/ResourceRange", + "readOnly": true + }, + "vCPUs": { + "description": "Recommended vCPU range.", + "$ref": "#/definitions/ResourceRange", + "readOnly": true + } + } + }, + "ResourceRange": { + "description": "Properties for a range of values.", + "type": "object", + "properties": { + "min": { + "description": "Minimum value.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "max": { + "description": "Maximum value.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ImageVersion": { + "description": "Represents an image version.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageVersionProperties", + "description": "Image version properties." + } + } + }, + "ImageVersionProperties": { + "description": "Properties of an image version.", + "type": "object", + "properties": { + "name": { + "description": "The semantic version string.", + "type": "string", + "readOnly": true + }, + "publishedDate": { + "description": "The datetime that the backing image version was published.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "excludeFromLatest": { + "description": "If the version should be excluded from being treated as the latest version.", + "type": "boolean", + "readOnly": true + }, + "osDiskImageSizeInGb": { + "description": "The size of the OS disk image, in GB.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "GalleryListResult": { + "description": "Results of the gallery list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Gallery" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageListResult": { + "description": "Results of the image list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Image" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageVersionListResult": { + "description": "Results of the image version list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ImageVersion" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "AllowedEnvironmentType": { + "description": "Represents an allowed environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AllowedEnvironmentTypeProperties", + "description": "Properties of an allowed environment type." + } + } + }, + "AllowedEnvironmentTypeProperties": { + "description": "Properties of an allowed environment type.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "displayName": { + "description": "The display name of the allowed environment type.", + "type": "string", + "readOnly": true + } + } + }, + "AllowedEnvironmentTypeListResult": { + "description": "Result of the allowed environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AllowedEnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentType": { + "description": "Represents an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentTypeProperties", + "description": "Properties of an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "EnvironmentTypeProperties": { + "description": "Properties of an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentTypeUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "EnvironmentTypeUpdate": { + "description": "The environment type for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentTypeUpdateProperties", + "description": "Properties of an environment type to be updated." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "EnvironmentTypeUpdateProperties": { + "description": "Properties of an environment type. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The display name of the environment type." + } + } + }, + "EnvironmentTypeListResult": { + "description": "Result of the environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ProjectEnvironmentType": { + "description": "Represents an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectEnvironmentTypeProperties", + "description": "Properties of an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "type": "string", + "description": "The geo-location for the environment type" + } + } + }, + "ProjectEnvironmentTypeUpdateProperties": { + "description": "Properties of a project environment type. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "deploymentTargetId": { + "description": "Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.", + "type": "string" + }, + "displayName": { + "description": "The display name of the project environment type.", + "type": "string" + }, + "status": { + "description": "Defines whether this Environment Type can be used in this Project.", + "$ref": "#/definitions/EnvironmentTypeEnableStatus" + }, + "creatorRoleAssignment": { + "description": "The role definition assigned to the environment creator on backing resources.", + "type": "object", + "properties": { + "roles": { + "type": "object", + "description": "A map of roles to assign to the environment creator.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentRole" + } + } + } + }, + "userRoleAssignments": { + "description": "Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserRoleAssignment" + } + } + } + }, + "ProjectEnvironmentTypeProperties": { + "description": "Properties of a project environment type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProjectEnvironmentTypeUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "environmentCount": { + "description": "The number of environments of this type.", + "type": "integer", + "format": "int32", + "minimum": 0, + "readOnly": true + } + } + }, + "ProjectEnvironmentTypeUpdate": { + "description": "The project environment type for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectEnvironmentTypeUpdateProperties", + "description": "Properties to configure an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectEnvironmentTypeListResult": { + "description": "Result of the project environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevBoxDefinitionListResult": { + "description": "Results of the Dev Box definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevBoxDefinitionUpdate": { + "description": "Partial update of a Dev Box definition resource.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevBoxDefinitionUpdateProperties", + "description": "Properties of a Dev Box definition to be updated." + } + } + }, + "DevBoxDefinition": { + "description": "Represents a definition for a Developer Machine.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Dev Box definition properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevBoxDefinitionProperties" + } + } + }, + "DevBoxDefinitionUpdateProperties": { + "description": "Properties of a Dev Box definition. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information." + }, + "sku": { + "description": "The SKU for Dev Boxes created using this definition.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + }, + "osStorageType": { + "description": "The storage type used for the Operating System disk of Dev Boxes created using this definition.", + "type": "string" + }, + "hibernateSupport": { + "description": "Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate", + "$ref": "#/definitions/HibernateSupport" + } + } + }, + "DevBoxDefinitionProperties": { + "description": "Properties of a Dev Box definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevBoxDefinitionUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "imageValidationStatus": { + "description": "Validation status of the configured image.", + "$ref": "vdi.json#/definitions/ImageValidationStatus", + "readOnly": true + }, + "imageValidationErrorDetails": { + "description": "Details for image validator error. Populated when the image validation is not successful.", + "$ref": "vdi.json#/definitions/ImageValidationErrorDetails", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the Dev Box Definition.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + }, + "activeImageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information for the currently active image (only populated during updates).", + "readOnly": true + } + }, + "required": [ + "imageReference", + "sku" + ] + }, + "AttachedNetworkConnection": { + "description": "Represents an attached NetworkConnection.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AttachedNetworkConnectionProperties", + "description": "Attached NetworkConnection properties." + } + } + }, + "AttachedNetworkConnectionProperties": { + "description": "Properties of an attached NetworkConnection.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "networkConnectionId": { + "description": "The resource ID of the NetworkConnection you want to attach.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkConnectionLocation": { + "description": "The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives.", + "type": "string", + "readOnly": true + }, + "healthCheckStatus": { + "$ref": "vdi.json#/definitions/HealthCheckStatus", + "readOnly": true + }, + "domainJoinType": { + "description": "AAD Join type of the network. This is populated based on the referenced Network Connection.", + "$ref": "vdi.json#/definitions/DomainJoinType", + "readOnly": true + } + }, + "required": [ + "networkConnectionId" + ] + }, + "AttachedNetworkListResult": { + "description": "Results of the Attached Networks list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/AttachedNetworkConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentRole": { + "type": "object", + "description": "A role that can be assigned to a user.", + "properties": { + "roleName": { + "description": "The common name of the Role Assignment. This is a descriptive name such as 'AcrPush'.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "This is a description of the Role Assignment.", + "type": "string", + "readOnly": true + } + } + }, + "UserRoleAssignment": { + "type": "object", + "description": "Mapping of user object ID to role assignments.", + "x-ms-client-name": "userRoleAssignmentValue", + "properties": { + "roles": { + "type": "object", + "description": "A map of roles to assign to the parent user.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentRole" + } + } + } + }, + "OperationStatus": { + "description": "The current status of an async operation", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + ], + "properties": { + "properties": { + "description": "Custom operation properties, populated only for a successful operation.", + "type": "object", + "readOnly": true + } + } + }, + "CatalogItemType": { + "description": "Indicates catalog item types.", + "enum": [ + "EnvironmentDefinition", + "ImageDefinition" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "EnvironmentTypeEnableStatus": { + "description": "Indicates whether the environment type is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentTypeEnableStatus", + "modelAsString": true + } + }, + "HibernateSupport": { + "description": "Indicates whether hibernate is enabled/disabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true + } + }, + "ListUsagesResult": { + "description": "List of Core Usages.", + "type": "object", + "properties": { + "value": { + "description": "The array page of Usages.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "The link to get the next page of Usage result.", + "type": "string", + "readOnly": true + } + } + }, + "Usage": { + "description": "The core usage details.", + "type": "object", + "properties": { + "currentValue": { + "description": "The current usage.", + "type": "integer", + "format": "int64" + }, + "limit": { + "description": "The limit integer.", + "type": "integer", + "format": "int64" + }, + "unit": { + "description": "The unit details.", + "type": "string", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "name": { + "description": "The name.", + "$ref": "#/definitions/UsageName" + }, + "id": { + "description": "The fully qualified arm resource id.", + "type": "string" + } + } + }, + "UsageName": { + "description": "The Usage Names.", + "type": "object", + "properties": { + "localizedValue": { + "description": "The localized name of the resource.", + "type": "string" + }, + "value": { + "description": "The name of the resource.", + "type": "string" + } + } + }, + "CustomizationTaskListResult": { + "description": "Results of the Task list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomizationTask" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "CustomizationTask": { + "description": "Represents a Task to be used in customizing a Dev Box.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Task properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomizationTaskProperties" + } + } + }, + "CustomizationTaskProperties": { + "description": "Properties of a Task.", + "type": "object", + "properties": { + "inputs": { + "description": "Inputs to the task.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomizationTaskInput" + }, + "readOnly": true + }, + "timeout": { + "description": "The default timeout for the task.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the Task.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + } + } + }, + "CustomizationTaskInput": { + "description": "Input for a Task.", + "type": "object", + "properties": { + "description": { + "description": "Description of the input.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the input.", + "type": "string", + "enum": [ + "string", + "number", + "boolean" + ], + "x-ms-enum": { + "name": "CustomizationTaskInputType", + "modelAsString": true + }, + "readOnly": true + }, + "required": { + "description": "Whether or not the input is required.", + "type": "boolean", + "readOnly": true + } + } + }, + "EnvironmentDefinitionListResult": { + "description": "Results of the environment definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentDefinition": { + "description": "Represents an environment definition catalog item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Environment definition properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentDefinitionProperties" + } + } + }, + "EnvironmentDefinitionProperties": { + "description": "Properties of an environment definition.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the environment definition.", + "type": "string", + "readOnly": true + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinitionParameter" + }, + "description": "Input parameters passed to an environment.", + "readOnly": true + }, + "templatePath": { + "description": "Path to the Environment Definition entrypoint file.", + "type": "string", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the environment definition.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + } + } + }, + "EnvironmentDefinitionParameter": { + "type": "object", + "description": "Properties of an Environment Definition parameter", + "properties": { + "id": { + "type": "string", + "description": "Unique ID of the parameter", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Display name of the parameter", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the parameter", + "readOnly": true + }, + "type": { + "description": "A string of one of the basic JSON types (number, integer, array, object, boolean, string)", + "$ref": "#/definitions/ParameterType", + "readOnly": true + }, + "readOnly": { + "type": "boolean", + "description": "Whether or not this parameter is read-only. If true, default should have a value.", + "readOnly": true + }, + "required": { + "type": "boolean", + "description": "Whether or not this parameter is required", + "readOnly": true + } + } + }, + "ParameterType": { + "type": "string", + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string" + ], + "description": "The type of data a parameter accepts.", + "readOnly": true, + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true, + "values": [ + { + "value": "array", + "description": "The parameter accepts an array of values." + }, + { + "value": "boolean", + "description": "The parameter accepts a boolean value." + }, + { + "value": "integer", + "description": "The parameter accepts an integer value." + }, + { + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "value": "object", + "description": "The parameter accepts an object value." + }, + { + "value": "string", + "description": "The parameter accepts a string value." + } + ] + } + }, + "CheckScopedNameAvailabilityRequest": { + "description": "The scoped name check availability request body.", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "The resource type.", + "type": "string" + }, + "scope": { + "description": "The resource id to scope the name check.", + "type": "string" + } + } + }, + "ImageDefinitionListResult": { + "description": "Results of the Image Definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageDefinition": { + "description": "Represents a definition for an Image.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Image Definition properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageDefinitionProperties" + } + } + }, + "ImageDefinitionProperties": { + "description": "Properties of an Image Definition.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information." + }, + "fileUrl": { + "description": "The URL to the repository file containing the image definition.", + "type": "string", + "readOnly": true + }, + "latestBuild": { + "$ref": "#/definitions/LatestImageBuild", + "description": "Details about the latest build." + } + } + }, + "LatestImageBuild": { + "type": "object", + "description": "Details about the latest build.", + "properties": { + "name": { + "description": "Identifier of a build.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "description": "The state of an Image Definition Build.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + } + } + }, + "ImageDefinitionBuildStatus": { + "type": "string", + "enum": [ + "Succeeded", + "Running", + "ValidationFailed", + "Failed", + "Cancelled", + "TimedOut" + ], + "description": "The state of an Image Definition Build.", + "readOnly": true, + "x-ms-enum": { + "name": "ImageDefinitionBuildStatus", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The image build has succeeded." + }, + { + "value": "Running", + "description": "The image build is running." + }, + { + "value": "ValidationFailed", + "description": "The built image has failed validation." + }, + { + "value": "Failed", + "description": "The image build has failed." + }, + { + "value": "Cancelled", + "description": "The image build has been cancelled." + }, + { + "value": "TimedOut", + "description": "The image build has timed out." + } + ] + } + }, + "ImageDefinitionBuildListResult": { + "description": "Results of the Image Definition Build list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinitionBuild" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageDefinitionBuild": { + "description": "Represents a specific build of an Image Definition.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Image Definition Build properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageDefinitionBuildProperties" + } + } + }, + "ImageDefinitionBuildProperties": { + "description": "Properties of an Image Definition Build.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "The specific image version used by the build.", + "readOnly": true + }, + "status": { + "description": "The status of the build.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "errorDetails": { + "description": "Details for image creation error. Populated when the image creation is not successful.", + "$ref": "#/definitions/ImageCreationErrorDetails", + "readOnly": true + } + } + }, + "ImageDefinitionBuildDetails": { + "description": "Represents a specific build of an Image Definition.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "The specific image version used by the build.", + "readOnly": true + }, + "status": { + "description": "The status of the build.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "errorDetails": { + "description": "Details for image creation error. Populated when the image creation is not successful.", + "$ref": "#/definitions/ImageCreationErrorDetails", + "readOnly": true + }, + "taskGroups": { + "description": "The list of task groups executed during the image definition build.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinitionBuildTaskGroup" + }, + "readOnly": true + } + } + }, + "ImageCreationErrorDetails": { + "type": "object", + "description": "Image creation error details", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error." + } + } + }, + "ImageDefinitionBuildTaskGroup": { + "description": "A task group executed during the image definition build.", + "type": "object", + "properties": { + "name": { + "description": "The name of the task group.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the task group.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "tasks": { + "description": "The list of tasks executed during the task group.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinitionBuildTask" + }, + "readOnly": true + } + } + }, + "ImageDefinitionBuildTask": { + "description": "A task executed during the image definition build.", + "type": "object", + "properties": { + "name": { + "description": "The name of the task.", + "type": "string" + }, + "parameters": { + "description": "Parameters for the task.", + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + }, + "displayName": { + "description": "Display name to help differentiate multiple instances of the same task.", + "type": "string" + }, + "id": { + "description": "ID of the task instance.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "description": "The status of the task.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + }, + "logUri": { + "description": "The URI for retrieving logs for the task execution.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "PlanNameParameter": { + "name": "planName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter plan.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "PlanMemberNameParameter": { + "name": "memberName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a devcenter plan member.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "DevCenterNameParameter": { + "name": "devCenterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$", + "minLength": 3, + "maxLength": 26 + }, + "DevCenterEncryptionSetNameParameter": { + "name": "encryptionSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter encryption set.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$", + "minLength": 3, + "maxLength": 63 + }, + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the project.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "CatalogNameParameter": { + "name": "catalogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Catalog.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "GalleryNameParameter": { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ImageNameParameter": { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]{0,78}[a-zA-Z0-9]$", + "minLength": 3, + "maxLength": 80 + }, + "ProjectImageNameParameter": { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9~][a-zA-Z0-9-.~]{0,151}[a-zA-Z0-9]$", + "minLength": 3, + "maxLength": 153 + }, + "VersionNameParameter": { + "name": "versionName", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the image.", + "x-ms-parameter-location": "method", + "pattern": "^[0-9]{1,10}[.][0-9]{1,10}[.][0-9]{1,10}$", + "minLength": 5, + "maxLength": 32 + }, + "EnvironmentTypeNameParameter": { + "name": "environmentTypeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the environment type.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "AttachedNetworkConnectionNameParameter": { + "name": "attachedNetworkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the attached NetworkConnection.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "DevBoxDefinitionName": { + "name": "devBoxDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Dev Box definition.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName').", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "description": "The Azure region", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "description": "The ID of an ongoing async operation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CustomizationTaskNameParameter": { + "name": "taskName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Task.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "EnvironmentDefinitionNameParameter": { + "name": "environmentDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Environment Definition.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ImageDefinitionNameParameter": { + "name": "imageDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Image Definition.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ImageDefinitionBuildNameParameter": { + "name": "buildName", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Image Definition Build.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_Create.json new file mode 100644 index 000000000000..fc2df13d7a0f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_Create.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3", + "body": { + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_Delete.json new file mode 100644 index 000000000000..a9db9b52708e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_GetByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_GetByDevCenter.json new file mode 100644 index 000000000000..944ecf120350 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_GetByDevCenter.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_GetByProject.json new file mode 100644 index 000000000000..03943aa4fe8c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_GetByProject.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/projects/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_ListByDevCenter.json new file mode 100644 index 000000000000..d2db9c7addac --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_ListByDevCenter.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/netmap1", + "name": "netmap1", + "type": "Microsoft.DevCenter/devcenters/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "Application", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/netmap2", + "name": "netmap2", + "type": "Microsoft.DevCenter/devcenters/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_ListByProject.json new file mode 100644 index 000000000000..57e511dc1149 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/AttachedNetworks_ListByProject.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/netmap1", + "name": "netmap1", + "type": "Microsoft.DevCenter/projects/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "Application", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/netmap2", + "name": "netmap2", + "type": "Microsoft.DevCenter/projects/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Connect.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Connect.json new file mode 100644 index 000000000000..885ae1a4216b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Connect.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_CreateAdo.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_CreateAdo.json new file mode 100644 index 000000000000..500bcd4bb47b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_CreateAdo.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "syncType": "Scheduled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_CreateGitHub.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_CreateGitHub.json new file mode 100644 index 000000000000..4c14e8c3c868 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_CreateGitHub.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "syncType": "Manual" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Manual" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Manual" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Delete.json new file mode 100644 index 000000000000..52f006227684 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Get.json new file mode 100644 index 000000000000..7e535137c5d8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_GetSyncErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_GetSyncErrorDetails.json new file mode 100644 index 000000000000..c5bfef422a55 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_GetSyncErrorDetails.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "operationError": { + "code": "Conflict", + "message": "The source control credentials could not be validated successfully." + }, + "conflicts": [ + { + "path": "/Environments/Duplicate/manifest.yaml", + "name": "DuplicateEnvironmentName" + } + ], + "errors": [ + { + "path": "/Environments/Invalid/manifest.yaml", + "errorDetails": [ + { + "code": "ParseError", + "message": "Schema Error Within Catalog Item: Missing Name" + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_List.json new file mode 100644 index 000000000000..e1f0b9a3f84e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Patch.json new file mode 100644 index 000000000000..874b0d56ec14 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Patch.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "path": "/environments" + }, + "syncType": "Scheduled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/environments" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Sync.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Sync.json new file mode 100644 index 000000000000..885ae1a4216b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Catalogs_Sync.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckNameAvailability.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..af79aaad40f3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/devcenters" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json new file mode 100644 index 000000000000..9d2ad6db61d0 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "scope": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json new file mode 100644 index 000000000000..7864c49865f3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/projects/catalogs", + "scope": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_Get.json new file mode 100644 index 000000000000..d355c23dc932 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "taskName": "SampleTask" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog/tasks/SampleTask", + "name": "SampleTask", + "type": "Microsoft.DevCenter/devcenters/catalogs/tasks", + "properties": { + "inputs": { + "package": { + "type": "string", + "required": true + }, + "feed": { + "type": "string" + } + }, + "timeout": 30, + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_GetErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_GetErrorDetails.json new file mode 100644 index 000000000000..e618d33ac176 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_GetErrorDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "taskName": "SampleTask" + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "code": "ParameterValueInvalid", + "message": "Expected parameter value for 'InstanceCount' to be integer but found the string 'test'." + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_ListByCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_ListByCatalog.json new file mode 100644 index 000000000000..8480bde55c3a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/CustomizationTasks_ListByCatalog.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog/tasks/SampleTask", + "name": "SampleTask", + "type": "Microsoft.DevCenter/devcenters/catalogs/tasks", + "properties": { + "inputs": { + "package": { + "type": "string", + "required": true + }, + "feed": { + "type": "string" + } + }, + "timeout": 30 + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Create.json new file mode 100644 index 000000000000..240d265a2192 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Create.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox", + "body": { + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Created" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Delete.json new file mode 100644 index 000000000000..4300aa76b259 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Get.json new file mode 100644 index 000000000000..2f0949dbb01c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_GetByProject.json new file mode 100644 index 000000000000..2a07e77ebb3c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_GetByProject.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json new file mode 100644 index 000000000000..18b2b90d9ed7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_ListByProject.json new file mode 100644 index 000000000000..bad741f95c47 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_ListByProject.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Patch.json new file mode 100644 index 000000000000..04e09b19bdc6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevBoxDefinitions_Patch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox", + "body": { + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Create.json new file mode 100644 index 000000000000..ad7eb57833e7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Create.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs", + "body": { + "location": "westus", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Accepted" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Accepted" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Delete.json new file mode 100644 index 000000000000..32ae969a8164 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Get.json new file mode 100644 index 000000000000..ff767630588c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_List.json new file mode 100644 index 000000000000..3ac1b3c7859c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Patch.json new file mode 100644 index 000000000000..4d9b0c4308a7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenterEncryptionSets_Patch.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs", + "body": { + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokekwestus", + "provisioningState": "Accepted" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Create.json new file mode 100644 index 000000000000..57071a9aa60b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Create.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json new file mode 100644 index 000000000000..18a6fa8bdbb6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Disabled" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Disabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Disabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithEncryption.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithEncryption.json new file mode 100644 index 000000000000..0a270f6e2032 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithEncryption.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" + }, + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokek" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" + }, + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokek" + } + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" + }, + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokek" + } + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithPlanId.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithPlanId.json new file mode 100644 index 000000000000..a1deb11b2572 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithPlanId.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "planId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "planId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "planId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithUserIdentity.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithUserIdentity.json new file mode 100644 index 000000000000..c19a75ce1057 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_CreateWithUserIdentity.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Delete.json new file mode 100644 index 000000000000..7a1038643622 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Get.json new file mode 100644 index 000000000000..e77e687749f1 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_ListByResourceGroup.json new file mode 100644 index 000000000000..65e85692d85d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_ListBySubscription.json new file mode 100644 index 000000000000..a36ec56dcf16 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_ListBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Patch.json new file mode 100644 index 000000000000..c03960b87502 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/DevCenters_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_Get.json new file mode 100644 index 000000000000..05b6447ebe88 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_Get.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/devcenters/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json new file mode 100644 index 000000000000..389731b99247 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/projects/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json new file mode 100644 index 000000000000..028c056bce09 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "code": "ParameterValueInvalid", + "message": "Expected parameter value for 'InstanceCount' to be integer but found the string 'test'." + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json new file mode 100644 index 000000000000..1400f114c604 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/devcenters/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json new file mode 100644 index 000000000000..96f6a66f2d44 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/projects/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Delete.json new file mode 100644 index 000000000000..521b649d3619 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Get.json new file mode 100644 index 000000000000..273c78176ea0 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "CostCenter": "RnD" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_List.json new file mode 100644 index 000000000000..c6fe8952150e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "tags": { + "CostCenter": "RnD" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Patch.json new file mode 100644 index 000000000000..1f7d71688122 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Patch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "displayName": "Dev" + }, + "tags": { + "Owner": "superuser" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Put.json new file mode 100644 index 000000000000..2ae1da1efe22 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/EnvironmentTypes_Put.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest", + "body": { + "tags": { + "Owner": "superuser" + }, + "properties": { + "displayName": "Dev" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Create.json new file mode 100644 index 000000000000..871687c9f8fd --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Create.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery", + "body": { + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Delete.json new file mode 100644 index 000000000000..1ef8a86d9aaa --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Get.json new file mode 100644 index 000000000000..787de3bff8c9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_List.json new file mode 100644 index 000000000000..1af7f3b573be --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Galleries_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/default", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "provisioningState": "Succeeded", + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/CentralGallery" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/ImageGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/SharedGallery", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_BuildImage.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_BuildImage.json new file mode 100644 index 000000000000..a130b6b2e206 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_BuildImage.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "c8754b2d-8da0-450b-b4c3-f379f1ba5d36", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_CancelImageBuild.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_CancelImageBuild.json new file mode 100644 index 000000000000..94a23e4a6e78 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_CancelImageBuild.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "c8754b2d-8da0-450b-b4c3-f379f1ba5d36", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage", + "buildName": "0a28fc61-6f87-4611-8fe2-32df44ab93b7" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json new file mode 100644 index 000000000000..291414ea82c2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "c8754b2d-8da0-450b-b4c3-f379f1ba5d36", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "catalogName": "TeamCatalog", + "imageDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/catalogs/TeamCatalog/imagedefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/catalogs/imagedefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "latestBuild": { + "name": "0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "status": "Running", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetImageBuild.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetImageBuild.json new file mode 100644 index 000000000000..131697dbdbf5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetImageBuild.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "c8754b2d-8da0-450b-b4c3-f379f1ba5d36", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage", + "buildName": "0a28fc61-6f87-4611-8fe2-32df44ab93b7" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog/imageDefinitions/DefaultDevImage/builds/0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "name": "0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "type": "Microsoft.DevCenter/projects/catalogs/imageDefinitions/builds", + "properties": { + "imageReference": { + "id": "/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "status": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetImageBuildDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetImageBuildDetails.json new file mode 100644 index 000000000000..7a36cb4fd68b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_GetImageBuildDetails.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "c8754b2d-8da0-450b-b4c3-f379f1ba5d36", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage", + "buildName": "0a28fc61-6f87-4611-8fe2-32df44ab93b7" + }, + "responses": { + "200": { + "body": { + "imageReference": { + "id": "/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "status": "Succeeded", + "taskGroups": [ + { + "name": "Provisioning", + "status": "Succeeded", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "tasks": [ + { + "name": "Provisioning", + "status": "Succeeded", + "displayName": "Provisioning", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "id": "e72eb35f-f406-42ec-8b93-7d18a9f7b059", + "logUri": "" + } + ] + }, + { + "name": "Customizations", + "status": "Succeeded", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "tasks": [ + { + "name": "vs2022", + "status": "Succeeded", + "displayName": "Install Visual Studio 2022", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "id": "e72eb35f-f406-42ec-8b93-7d18a9f7b059", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevProject/catalogs/CentralCatalog/imageDefinitions/DefaultDevImage/builds/0a28fc61-6f87-4611-8fe2-32df44ab93b7/logs/e72eb35f-f406-42ec-8b93-7d18a9f7b059" + } + ] + }, + { + "name": "Generalization", + "status": "Succeeded", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "tasks": [ + { + "name": "Generalization", + "status": "Succeeded", + "displayName": "Generalization", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "logUri": "" + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json new file mode 100644 index 000000000000..4a69bdcd4967 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "c8754b2d-8da0-450b-b4c3-f379f1ba5d36", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "catalogName": "TeamCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/catalogs/TeamCatalog/imagedefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/catalogs/imagedefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "latestBuild": { + "name": "0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "status": "Running", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_ListImageBuildsByImageDefinition.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_ListImageBuildsByImageDefinition.json new file mode 100644 index 000000000000..36ce4d09a121 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageDefinitions_ListImageBuildsByImageDefinition.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "c8754b2d-8da0-450b-b4c3-f379f1ba5d36", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage", + "buildName": "0a28fc61-6f87-4611-8fe2-32df44ab93b7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog/imageDefinitions/DefaultDevImage/builds/0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "name": "0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "type": "Microsoft.DevCenter/projects/catalogs/imageDefinitions/builds", + "properties": { + "imageReference": { + "id": "/subscriptions/c8754b2d-8da0-450b-b4c3-f379f1ba5d36/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "status": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_Get.json new file mode 100644 index 000000000000..5f8011d276a8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "Win11", + "versionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/Win11/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/devcenters/galleries/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_GetByProject.json new file mode 100644 index 000000000000..a3577895c036 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_GetByProject.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject", + "imageName": "~gallery~DefaultDevGallery~ContosoImageDefinition", + "versionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/project/myProject/images/~gallery~DefaultDevGallery~ContosoImageDefinition/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/project/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_List.json new file mode 100644 index 000000000000..3403d284d1c3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "Win11" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/Win11/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/devcenters/galleries/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_ListByProject.json new file mode 100644 index 000000000000..db4bcfc15f66 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ImageVersions_ListByProject.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject", + "imageName": "~gallery~DefaultDevGallery~ContosoImageDefinition" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/project/myProject/images/~gallery~DefaultDevGallery~ContosoImageDefinition/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/project/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_Get.json new file mode 100644 index 000000000000..1239625abd32 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "ContosoBaseImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_GetByProject.json new file mode 100644 index 000000000000..175b4fb467cc --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_GetByProject.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject", + "imageName": "~gallery~DefaultDevGallery~ContosoBaseImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/project/myProject/images/~gallery~DefaultDevGallery~ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByDevCenter.json new file mode 100644 index 000000000000..bdc814bf14d8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByDevCenter.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage2", + "name": "ContosoBaseImage2", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByGallery.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByGallery.json new file mode 100644 index 000000000000..fe7819204c38 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByGallery.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DevGallery" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage2", + "name": "ContosoBaseImage2", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByProject.json new file mode 100644 index 000000000000..1ee1b1caac24 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Images_ListByProject.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myProject/images/~gallery~DefaultDevGallery~ContosoBaseImage", + "name": "~gallery~DefaultDevGallery~ContosoBaseImage", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myProject/images/~catalog~DefaultCatalog~DefaultImage", + "name": "~catalog~DefaultCatalog~DefaultImage", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myProject/images/~gallery~DefaultDevGallery~ContosoImageDefinition", + "name": "~gallery~DefaultDevGallery~ContosoImageDefinition", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Delete.json new file mode 100644 index 000000000000..7bd932a6a62e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "eastusnetwork" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Get.json new file mode 100644 index 000000000000..03ccad3e9f40 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded", + "healthCheckStatus": "Passed" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_GetHealthDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_GetHealthDetails.json new file mode 100644 index 000000000000..77c85ef5ef52 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_GetHealthDetails.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "eastusnetwork" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/eastusnetwork/healthchecks/latest", + "name": "latest", + "type": "Microsoft.DevCenter/networkconnections/healthchecks", + "properties": { + "startDateTime": "2021-07-03T12:43:14Z", + "endDateTime": "2021-07-03T12:43:15Z", + "healthChecks": [ + { + "displayName": "Azure AD device sync", + "endDateTime": "2021-07-03T12:43:14Z", + "startDateTime": "2021-07-03T12:43:15Z", + "status": "Passed" + } + ] + }, + "systemData": { + "createdBy": "System", + "createdByType": "Application", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "System", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListByResourceGroup.json new file mode 100644 index 000000000000..680514076f87 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListBySubscription.json new file mode 100644 index 000000000000..bcf0aadee3f8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnection", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListHealthDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListHealthDetails.json new file mode 100644 index 000000000000..06163706358d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListHealthDetails.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network/healthchecks/latest", + "name": "latest", + "type": "Microsoft.DevCenter/networkconnections/healthchecks", + "properties": { + "startDateTime": "2021-07-03T12:43:14Z", + "endDateTime": "2021-07-03T12:43:15Z", + "healthChecks": [ + { + "displayName": "Azure AD device sync", + "endDateTime": "2021-07-03T12:43:14Z", + "startDateTime": "2021-07-03T12:43:15Z", + "status": "Passed" + } + ] + }, + "systemData": { + "createdBy": "System", + "createdByType": "Application", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "System", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..09d22a485a58 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Dev Box Service", + "endpoints": [ + { + "domainName": "devbox.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Intune", + "endpoints": [ + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Cloud PC", + "endpoints": [ + { + "domainName": "rdweb.wvd.microsoft.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Patch.json new file mode 100644 index 000000000000..f1e590af3a7d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network", + "body": { + "properties": { + "domainPassword": "New Password value for user" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Put.json new file mode 100644 index 000000000000..22a0ff08e2e8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_Put.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network", + "body": { + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "domainPassword": "Password value for user", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_RunHealthChecks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_RunHealthChecks.json new file mode 100644 index 000000000000..21ace0144673 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/NetworkConnections_RunHealthChecks.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/OperationStatus_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/OperationStatus_Get.json new file mode 100644 index 000000000000..94a93ff7360a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/OperationStatus_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "location": "westus3", + "operationId": "3fa1a29d-e807-488d-81d1-f1c5456a08cd" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4", + "status": "Succeeded", + "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "startTime": "2020-12-01T15:16:29.500Z", + "endTime": "2020-12-01T15:16:55.100Z", + "percentComplete": 100 + } + }, + "202": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4", + "status": "Succeeded", + "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "startTime": "2020-12-01T15:16:29.500Z", + "endTime": "2020-12-01T15:16:55.100Z", + "percentComplete": 99 + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "default": { + "body": { + "error": { + "code": "OperationNotFound", + "message": "The requested async operation was not found" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Operations_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Operations_Get.json new file mode 100644 index 000000000000..e59b85f510d6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Operations_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DevCenter/devcenters/write", + "display": { + "provider": "Microsoft DevTest Center", + "resource": "Microsoft DevTest Center devcenter resource", + "operation": "write" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Create.json new file mode 100644 index 000000000000..e07e3b88fd5b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Create.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "body": { + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User" + }, + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Delete.json new file mode 100644 index 000000000000..1dac889128cf --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Get.json new file mode 100644 index 000000000000..23238348030f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_List.json new file mode 100644 index 000000000000..8e793e833cb6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberType": "User", + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Patch.json new file mode 100644 index 000000000000..7648cadb4513 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/PlanMembers_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "body": { + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Create.json new file mode 100644 index 000000000000..a3e460ee64d3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Create.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": {}, + "sku": { + "name": "Preview" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "hidden-title": "ContosoPlan", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Delete.json new file mode 100644 index 000000000000..471f2e9bc197 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Get.json new file mode 100644 index 000000000000..4048e2c2631f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_ListByResourceGroup.json new file mode 100644 index 000000000000..d5d3339e563a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_ListBySubscription.json new file mode 100644 index 000000000000..cffcf9433597 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_ListBySubscription.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Patch.json new file mode 100644 index 000000000000..06994e78e6f2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Plans_Patch.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "body": { + "sku": { + "name": "Preview" + }, + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Delete.json new file mode 100644 index 000000000000..11f223e116ec --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "poolName" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..171fa301975f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_GetUnhealthyStatus.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_GetUnhealthyStatus.json new file mode 100644 index 000000000000..08ac7b91295d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_GetUnhealthyStatus.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Unhealthy", + "healthStatusDetails": [ + { + "code": "NetworkConnectionUnhealthy", + "message": "The Pool's Network Connection is in an unhealthy state. Check the Network Connection's health status for more details." + }, + { + "code": "ImageValidationFailed", + "message": "Image validation has failed. Check the Dev Box Definition's image validation status for more details." + }, + { + "code": "IntuneValidationFailed", + "message": "Intune license validation has failed. The tenant does not have a valid Intune license." + } + ], + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_List.json new file mode 100644 index 000000000000..cf35fd59ec5f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Patch.json new file mode 100644 index 000000000000..777798dd7803 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Patch.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "devBoxDefinitionName": "WebDevBox2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox2", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Put.json new file mode 100644 index 000000000000..4a9e0c9fbb2f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_Put.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Pending", + "provisioningState": "Created", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_PutWithManagedNetwork.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_PutWithManagedNetwork.json new file mode 100644 index 000000000000..ed8670f92b96 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_PutWithManagedNetwork.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "managedNetwork", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "managedNetwork", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "managedNetwork", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Pending", + "provisioningState": "Created", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json new file mode 100644 index 000000000000..b181b8a43b4a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionType": "Value", + "devBoxDefinitionName": "", + "devBoxDefinition": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/projects/DevProject/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + } + }, + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionType": "Value", + "devBoxDefinitionName": "", + "devBoxDefinition": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/projects/DevProject/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + } + }, + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionType": "Value", + "devBoxDefinitionName": "", + "devBoxDefinition": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/projects/DevProject/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + } + }, + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Pending", + "provisioningState": "Created", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_RunHealthChecks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_RunHealthChecks.json new file mode 100644 index 000000000000..5befc70469a0 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Pools_RunHealthChecks.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json new file mode 100644 index 000000000000..59b856dcb1e3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/Contoso/allowedEnvironmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/allowedenvironmenttypes", + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json new file mode 100644 index 000000000000..9157eb95b800 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/Contoso/allowedEnvironmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/allowedenvironmenttypes", + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json new file mode 100644 index 000000000000..638df299e8e5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "code": "ParameterValueInvalid", + "message": "Expected parameter value for 'InstanceCount' to be integer but found the string 'test'." + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Connect.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Connect.json new file mode 100644 index 000000000000..f9da4b06a4e5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Connect.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_CreateAdo.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_CreateAdo.json new file mode 100644 index 000000000000..216b7c8fb45f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_CreateAdo.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_CreateGitHub.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_CreateGitHub.json new file mode 100644 index 000000000000..8de6f4054414 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_CreateGitHub.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Delete.json new file mode 100644 index 000000000000..43f85ae1fd50 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Get.json new file mode 100644 index 000000000000..e1edc017195d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json new file mode 100644 index 000000000000..d471b9a5631b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "operationError": { + "code": "Conflict", + "message": "The source control credentials could not be validated successfully." + }, + "conflicts": [ + { + "path": "/Environments/Duplicate/manifest.yaml", + "name": "DuplicateEnvironmentName" + } + ], + "errors": [ + { + "path": "/Environments/Invalid/manifest.yaml", + "errorDetails": [ + { + "code": "ParseError", + "message": "Schema Error Within Catalog Item: Missing Name" + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_List.json new file mode 100644 index 000000000000..a45b40ff2b49 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/Contoso/catalogs", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Patch.json new file mode 100644 index 000000000000..f179ab382cfe --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Patch.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "path": "/environments" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/environments" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Sync.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Sync.json new file mode 100644 index 000000000000..f9da4b06a4e5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectCatalogs_Sync.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Delete.json new file mode 100644 index 000000000000..ee9373f4c724 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Get.json new file mode 100644 index 000000000000..0cb12e829201 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Get.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 1, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_List.json new file mode 100644 index 000000000000..6f2e62322952 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_List.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Patch.json new file mode 100644 index 000000000000..255041a2f899 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Patch.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + }, + "tags": { + "CostCenter": "RnD" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 1, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Put.json new file mode 100644 index 000000000000..90d062e10655 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/ProjectEnvironmentTypes_Put.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + }, + "tags": { + "CostCenter": "RnD" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "displayName": "DevTest", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 0, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "hidden-title": "Dev", + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "displayName": "DevTest", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 0, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "hidden-title": "Dev", + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Delete.json new file mode 100644 index 000000000000..124440de830e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Get.json new file mode 100644 index 000000000000..8d9b2548e29c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "displayName": "Dev", + "catalogSettings": { + "catalogItemSyncTypes": [ + "EnvironmentDefinition" + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "hidden-title": "Dev", + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_GetInheritedSettings.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_GetInheritedSettings.json new file mode 100644 index 000000000000..5ef7d3401700 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_GetInheritedSettings.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso" + }, + "responses": { + "200": { + "body": { + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_ListByResourceGroup.json new file mode 100644 index 000000000000..d75c60023367 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myproject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_ListBySubscription.json new file mode 100644 index 000000000000..75e802b41e7f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_ListBySubscription.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myproject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Patch.json new file mode 100644 index 000000000000..277d0113ee76 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Patch.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "description": "This is my first project.", + "displayName": "Dev", + "catalogSettings": { + "catalogItemSyncTypes": [ + "EnvironmentDefinition" + ] + } + }, + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project. Very exciting.", + "displayName": "Dev", + "catalogSettings": { + "catalogItemSyncTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "displayName": "Dev", + "CostCenter": "R&D" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Put.json new file mode 100644 index 000000000000..1d0ba14813e4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_Put.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "displayName": "Dev" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "hidden-title": "Dev", + "CostCenter": "R&D" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "hidden-title": "Dev", + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json new file mode 100644 index 000000000000..b9da5d4a1aac --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3 + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json new file mode 100644 index 000000000000..406336f69e51 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown", + "body": { + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Delete.json new file mode 100644 index 000000000000..024bdd60508d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Get.json new file mode 100644 index 000000000000..d4293e677d58 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_ListByPool.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_ListByPool.json new file mode 100644 index 000000000000..d5f207a2829b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_ListByPool.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Patch.json new file mode 100644 index 000000000000..e008829898f4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Schedules_Patch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown", + "body": { + "properties": { + "time": "18:00" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Skus_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Skus_ListByProject.json new file mode 100644 index 000000000000..e221d9809e40 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Skus_ListByProject.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "projects/pools", + "name": "Large", + "tier": "Premium", + "locations": [ + "CentralUS" + ] + }, + { + "resourceType": "projects/pools", + "name": "Medium", + "tier": "Standard", + "locations": [ + "CentralUS" + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Skus_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Skus_ListBySubscription.json new file mode 100644 index 000000000000..f9252bed19f8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Skus_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "projects/pools", + "name": "Large", + "tier": "Premium", + "locations": [ + "CentralUS" + ] + }, + { + "resourceType": "projects/pools", + "name": "Medium", + "tier": "Standard", + "locations": [ + "CentralUS" + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Usages_ListByLocation.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Usages_ListByLocation.json new file mode 100644 index 000000000000..7851b436ca7f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/examples/Usages_ListByLocation.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "currentValue": 2, + "limit": 8, + "unit": "Count", + "name": { + "value": "devcenters" + }, + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/Microsoft.DevCenter/locations/westus/quotas/devcenters" + }, + { + "currentValue": 5, + "limit": 30, + "unit": "Count", + "name": { + "value": "projects" + }, + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/Microsoft.DevCenter/locations/westus/quotas/projects" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/vdi.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/vdi.json new file mode 100644 index 000000000000..84cf9babc581 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-07-01-preview/vdi.json @@ -0,0 +1,1958 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-07-01-preview", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/skus": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "SKUs" + ], + "description": "Lists the Microsoft.DevCenter SKUs available in a subscription", + "operationId": "Skus_ListBySubscription", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Skus_ListBySubscription": { + "$ref": "./examples/Skus_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Pools" + ], + "description": "Lists pools for a project", + "operationId": "Pools_ListByProject", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Pools_ListByProject": { + "$ref": "./examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "get": { + "tags": [ + "Pools" + ], + "description": "Gets a machine pool", + "operationId": "Pools_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "./examples/Pools_Get.json" + }, + "Pools_GetUnhealthyStatus": { + "$ref": "./examples/Pools_GetUnhealthyStatus.json" + } + } + }, + "put": { + "tags": [ + "Pools" + ], + "description": "Creates or updates a machine pool", + "operationId": "Pools_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a machine pool", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "./examples/Pools_Put.json" + }, + "Pools_CreateOrUpdateWithManagedNetwork": { + "$ref": "./examples/Pools_PutWithManagedNetwork.json" + }, + "Pools_CreateOrUpdateWithValueDevBoxDefinition": { + "$ref": "./examples/Pools_PutWithValueDevBoxDefinition.json" + } + } + }, + "patch": { + "tags": [ + "Pools" + ], + "description": "Partially updates a machine pool", + "operationId": "Pools_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a machine pool", + "required": true, + "schema": { + "$ref": "#/definitions/PoolUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "./examples/Pools_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Pools" + ], + "description": "Deletes a machine pool", + "operationId": "Pools_Delete", + "parameters": [], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "./examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/runHealthChecks": { + "post": { + "tags": [ + "Pools" + ], + "description": "Triggers a refresh of the pool status.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "operationId": "Pools_RunHealthChecks", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Initiating pool status refresh.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_RefreshStatus": { + "$ref": "./examples/Pools_RunHealthChecks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Schedules" + ], + "description": "Lists schedules for a pool", + "operationId": "Schedules_ListByPool", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Schedules_ListByPool": { + "$ref": "./examples/Schedules_ListByPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ScheduleNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Schedules" + ], + "description": "Gets a schedule resource.", + "operationId": "Schedules_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_GetByPool": { + "$ref": "./examples/Schedules_Get.json" + } + } + }, + "put": { + "tags": [ + "Schedules" + ], + "description": "Creates or updates a Schedule.", + "operationId": "Schedules_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a scheduled task", + "required": true, + "schema": { + "$ref": "#/definitions/Schedule" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_CreateDailyShutdownPoolSchedule": { + "$ref": "./examples/Schedules_CreateDailyShutdownPoolSchedule.json" + } + } + }, + "patch": { + "tags": [ + "Schedules" + ], + "description": "Partially updates a Scheduled.", + "operationId": "Schedules_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a scheduled task.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_Update": { + "$ref": "./examples/Schedules_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Schedules" + ], + "description": "Deletes a Scheduled.", + "operationId": "Schedules_Delete", + "parameters": [], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_Delete": { + "$ref": "./examples/Schedules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/networkConnections": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists network connections in a subscription", + "operationId": "NetworkConnections_ListBySubscription", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListBySubscription": { + "$ref": "./examples/NetworkConnections_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists network connections in a resource group", + "operationId": "NetworkConnections_ListByResourceGroup", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListByResourceGroup": { + "$ref": "./examples/NetworkConnections_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Gets a network connection resource", + "operationId": "NetworkConnections_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Get": { + "$ref": "./examples/NetworkConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "Network Connections" + ], + "description": "Creates or updates a Network Connections resource", + "operationId": "NetworkConnections_CreateOrUpdate", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents network connection", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_CreateOrUpdate": { + "$ref": "./examples/NetworkConnections_Put.json" + } + } + }, + "patch": { + "tags": [ + "Network Connections" + ], + "description": "Partially updates a Network Connection", + "operationId": "NetworkConnections_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents network connection", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConnectionUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Update": { + "$ref": "./examples/NetworkConnections_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Network Connections" + ], + "description": "Deletes a Network Connections resource", + "operationId": "NetworkConnections_Delete", + "parameters": [], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Delete": { + "$ref": "./examples/NetworkConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists health check status details", + "operationId": "NetworkConnections_ListHealthDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/HealthCheckStatusDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListHealthDetails": { + "$ref": "./examples/NetworkConnections_ListHealthDetails.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks/latest": { + "get": { + "tags": [ + "Network Connections" + ], + "description": "Gets health check status details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "operationId": "NetworkConnections_GetHealthDetails", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/HealthCheckStatusDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_GetHealthDetails": { + "$ref": "./examples/NetworkConnections_GetHealthDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/runHealthChecks": { + "post": { + "tags": [ + "Network Connection" + ], + "description": "Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "operationId": "NetworkConnections_RunHealthChecks", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Initiating health checks.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_RunHealthChecks": { + "$ref": "./examples/NetworkConnections_RunHealthChecks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/outboundNetworkDependenciesEndpoints": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connection" + ], + "operationId": "NetworkConnections_ListOutboundNetworkDependenciesEndpoints", + "description": "Lists the endpoints that agents may call as part of Dev Box service administration. These FQDNs should be allowed for outbound access in order for the Dev Box service to function.", + "parameters": [], + "x-ms-examples": { + "ListOutboundNetworkDependencies": { + "$ref": "./examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json" + } + }, + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of outbound network dependencies.", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SkuListResult": { + "description": "Results of the Microsoft.DevCenter SKU list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "commonDefinitions.json#/definitions/DevCenterSku" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Pool": { + "description": "A pool of Virtual Machines.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Pool properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolProperties" + } + } + }, + "PoolUpdateProperties": { + "description": "Properties of a Pool. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devBoxDefinitionType": { + "description": "Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.", + "$ref": "#/definitions/PoolDevBoxDefinitionType" + }, + "devBoxDefinitionName": { + "description": "Name of a Dev Box definition in parent Project of this Pool. Will be ignored if devBoxDefinitionType is Value.", + "type": "string" + }, + "devBoxDefinition": { + "description": "A definition of the machines that are created from this Pool. Will be ignored if devBoxDefinitionType is Reference or not provided.", + "$ref": "#/definitions/PoolDevBoxDefinition" + }, + "networkConnectionName": { + "description": "Name of a Network Connection in parent Project of this Pool", + "type": "string" + }, + "licenseType": { + "description": "Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.", + "$ref": "#/definitions/LicenseType" + }, + "localAdministrator": { + "description": "Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.", + "$ref": "#/definitions/LocalAdminStatus" + }, + "stopOnDisconnect": { + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "$ref": "#/definitions/StopOnDisconnectConfiguration" + }, + "singleSignOnStatus": { + "description": "Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.", + "$ref": "#/definitions/SingleSignOnStatus" + }, + "displayName": { + "type": "string", + "description": "The display name of the pool." + }, + "virtualNetworkType": { + "description": "Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.", + "$ref": "#/definitions/VirtualNetworkType" + }, + "managedVirtualNetworkRegions": { + "type": "array", + "description": "The regions of the managed virtual network (required when managedNetworkType is Managed).", + "items": { + "type": "string" + } + } + } + }, + "PoolProperties": { + "type": "object", + "description": "Properties of a Pool", + "allOf": [ + { + "$ref": "#/definitions/PoolUpdateProperties" + } + ], + "properties": { + "healthStatus": { + "description": "Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.", + "$ref": "#/definitions/HealthStatus", + "readOnly": true + }, + "healthStatusDetails": { + "description": "Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state", + "type": "array", + "items": { + "$ref": "#/definitions/HealthStatusDetail" + }, + "x-ms-identifiers": [ + "code" + ], + "readOnly": true + }, + "devBoxCount": { + "description": "Indicates the number of provisioned Dev Boxes in this pool.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "devBoxDefinitionName", + "networkConnectionName", + "licenseType", + "localAdministrator" + ] + }, + "PoolDevBoxDefinition": { + "description": "Represents a definition for a Developer Machine.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Image reference information." + }, + "sku": { + "description": "The SKU for Dev Boxes created from the Pool.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + }, + "activeImageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Image reference information for the currently active image (only populated during updates).", + "readOnly": true + } + } + }, + "HealthStatus": { + "description": "Health status indicating whether a pool is available to create Dev Boxes.", + "enum": [ + "Unknown", + "Pending", + "Healthy", + "Warning", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "HealthStatusDetail": { + "type": "object", + "description": "Pool health status detail.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the issue.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A message describing the issue, intended to be suitable for display in a user interface", + "readOnly": true + } + } + }, + "LicenseType": { + "description": "License Types", + "enum": [ + "Windows_Client" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "LocalAdminStatus": { + "description": "Local Administrator enable or disable status. Indicates whether owners of Dev Boxes are added as local administrators on the Dev Box.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true + } + }, + "SingleSignOnStatus": { + "description": "SingleSignOn (SSO) enable or disable status. Indicates whether Dev Boxes in the Pool will have SSO enabled or disabled.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "SingleSignOnStatus", + "modelAsString": true + } + }, + "VirtualNetworkType": { + "description": "Indicates a pool uses a Virtual Network managed by Microsoft (Managed), or a customer provided Network (Unmanaged).", + "type": "string", + "enum": [ + "Managed", + "Unmanaged" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": true + } + }, + "PoolDevBoxDefinitionType": { + "description": "Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.", + "type": "string", + "enum": [ + "Reference", + "Value" + ], + "x-ms-enum": { + "name": "PoolDevBoxDefinitionType", + "modelAsString": true + } + }, + "StopOnDisconnectConfiguration": { + "type": "object", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "description": "Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.", + "$ref": "#/definitions/StopOnDisconnectEnableStatus" + }, + "gracePeriodMinutes": { + "description": "The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.", + "type": "integer", + "format": "int32" + } + } + }, + "StopOnDisconnectEnableStatus": { + "description": "Stop on disconnect enable or disable status. Indicates whether stop on disconnect to is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "StopOnDisconnectEnableStatus", + "modelAsString": true + } + }, + "PoolListResult": { + "description": "Results of the machine pool list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Pool" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "PoolUpdate": { + "description": "The pool properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolUpdateProperties", + "description": "Properties of a pool to be updated." + } + } + }, + "ImageReference": { + "type": "object", + "description": "Image reference information", + "properties": { + "id": { + "description": "Image ID, or Image version ID. When Image ID is provided, its latest version will be used.", + "type": "string" + }, + "exactVersion": { + "type": "string", + "readOnly": true, + "description": "The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use." + } + } + }, + "ImageValidationStatus": { + "description": "Image validation status", + "enum": [ + "Unknown", + "Pending", + "Succeeded", + "Failed", + "TimedOut" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageValidationStatus", + "modelAsString": true + } + }, + "ImageValidationErrorDetails": { + "type": "object", + "description": "Image validation error details", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error." + } + } + }, + "CatalogResourceValidationStatus": { + "description": "Catalog resource validation status", + "enum": [ + "Unknown", + "Pending", + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogResourceValidationStatus", + "modelAsString": true + } + }, + "CatalogResourceValidationErrorDetails": { + "type": "object", + "description": "List of validator error details. Populated when changes are made to the resource or its dependent resources that impact the validity of the Catalog resource.", + "properties": { + "errors": { + "description": "Errors associated with resources synchronized from the catalog.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogErrorDetails" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "CatalogErrorDetails": { + "type": "object", + "description": "Catalog error details", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error." + } + } + }, + "NetworkConnection": { + "type": "object", + "description": "Network related settings", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a Network Connection", + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkProperties" + } + } + }, + "NetworkConnectionUpdate": { + "description": "The network connection properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkConnectionUpdateProperties", + "description": "Properties of a network connection resource to be updated." + } + } + }, + "NetworkConnectionUpdateProperties": { + "description": "Properties of network connection. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "subnetId": { + "description": "The subnet to attach Virtual Machines to", + "type": "string" + }, + "domainName": { + "description": "Active Directory domain name", + "type": "string" + }, + "organizationUnit": { + "description": "Active Directory domain Organization Unit (OU)", + "type": "string" + }, + "domainUsername": { + "description": "The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.", + "type": "string" + }, + "domainPassword": { + "description": "The password for the account used to join domain", + "type": "string", + "x-ms-secret": true + } + } + }, + "NetworkProperties": { + "description": "Network properties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkConnectionUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "healthCheckStatus": { + "description": "Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.", + "$ref": "#/definitions/HealthCheckStatus", + "readOnly": true + }, + "networkingResourceGroupName": { + "description": "The name for resource group where NICs will be placed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "domainJoinType": { + "description": "AAD Join type.", + "$ref": "#/definitions/DomainJoinType", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "subnetId", + "domainJoinType" + ] + }, + "NetworkConnectionListResult": { + "description": "Result of the network connection list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DomainJoinType": { + "description": "Active Directory join type", + "enum": [ + "HybridAzureADJoin", + "AzureADJoin", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainJoinType", + "modelAsString": true + } + }, + "HealthCheckStatus": { + "description": "Health check status values", + "enum": [ + "Unknown", + "Pending", + "Running", + "Passed", + "Warning", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthCheckStatus", + "modelAsString": true + } + }, + "HealthCheckStatusDetails": { + "description": "Health Check details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Health check status details properties.", + "$ref": "#/definitions/HealthCheckStatusDetailsProperties" + } + } + }, + "HealthCheckStatusDetailsProperties": { + "description": "Health Check properties.", + "type": "object", + "properties": { + "startDateTime": { + "type": "string", + "description": "Start time of last execution of the health checks.", + "readOnly": true, + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "description": "End time of last execution of the health checks.", + "readOnly": true, + "format": "date-time" + }, + "healthChecks": { + "description": "Details for each health check item.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthCheck" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "HealthCheck": { + "description": "An individual health check item", + "type": "object", + "properties": { + "status": { + "description": "The status of the health check item.", + "$ref": "#/definitions/HealthCheckStatus", + "readOnly": true + }, + "displayName": { + "description": "The display name of this health check item.", + "type": "string", + "readOnly": true + }, + "startDateTime": { + "description": "Start time of health check item.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "endDateTime": { + "description": "End time of the health check item.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "errorType": { + "description": "The type of error that occurred during this health check.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action to fix the corresponding error.", + "type": "string", + "readOnly": true + }, + "additionalDetails": { + "description": "Additional details about the health check or the recommended action.", + "type": "string", + "readOnly": true + } + } + }, + "HealthCheckStatusDetailsListResult": { + "description": "Result of the network health check list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthCheckStatusDetails" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [ + "category" + ], + "description": "The collection of outbound network dependency endpoints returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "OutboundEnvironmentEndpoint": { + "type": "object", + "properties": { + "category": { + "type": "string", + "readOnly": true, + "description": "The type of service that the agent connects to." + }, + "endpoints": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [ + "domainName" + ], + "description": "The endpoints for this service for which the agent requires outbound access." + } + }, + "description": "A collection of related endpoints from the same service for which the agent requires outbound access." + }, + "EndpointDependency": { + "type": "object", + "properties": { + "domainName": { + "type": "string", + "readOnly": true, + "description": "The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Human-readable supplemental information about the dependency and when it is applicable." + }, + "endpointDetails": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [], + "description": "The list of connection details for this endpoint." + } + }, + "description": "A domain name and connection details used to access a dependency." + }, + "EndpointDetail": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The port an endpoint is connected to." + } + }, + "description": "Details about the connection between the Batch service and the endpoint." + }, + "Schedule": { + "type": "object", + "description": "Represents a Schedule to execute a task.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Properties of a Schedule resource", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleProperties" + } + } + }, + "ScheduleUpdate": { + "description": "The schedule properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleUpdateProperties", + "description": "Properties of a schedule resource to be updated." + } + } + }, + "ScheduleUpdateProperties": { + "description": "Updatable properties of a Schedule.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "type": { + "description": "Supported type this scheduled task represents.", + "$ref": "#/definitions/ScheduledType" + }, + "frequency": { + "description": "The frequency of this scheduled task.", + "$ref": "#/definitions/ScheduledFrequency" + }, + "time": { + "description": "The target time to trigger the action. The format is HH:MM.", + "type": "string" + }, + "timeZone": { + "description": "The IANA timezone id at which the schedule should execute.", + "type": "string" + }, + "state": { + "description": "Indicates whether or not this scheduled task is enabled.", + "$ref": "#/definitions/ScheduleEnableStatus" + } + } + }, + "ScheduleProperties": { + "description": "The Schedule properties defining when and what to execute.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "type", + "frequency", + "timeZone", + "time" + ] + }, + "ScheduleListResult": { + "description": "Result of the schedule list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Schedule" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ScheduledType": { + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true + } + }, + "ScheduledFrequency": { + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true + } + }, + "ScheduleEnableStatus": { + "description": "Schedule enable or disable status. Indicates whether the schedule applied to is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleEnableStatus", + "modelAsString": true + } + } + }, + "parameters": { + "PoolNameParameter": { + "name": "poolName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the pool.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "NetworkConnectionName": { + "name": "networkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Network Connection that can be applied to a Pool.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ScheduleNameParameter": { + "name": "scheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schedule that uniquely identifies it.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[-\\w]+$", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName').", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/resource-manager/readme.md b/specification/devcenter/resource-manager/readme.md index b6dbd79266bb..bfe88cff1717 100644 --- a/specification/devcenter/resource-manager/readme.md +++ b/specification/devcenter/resource-manager/readme.md @@ -27,10 +27,25 @@ These are the global settings for devcenter. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2024-06 +tag: package-preview-2024-07 ``` +### Tag: package-preview-2024-07 + +These settings apply only when `--tag=package-preview-2024-07` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-07' +input-file: + - Microsoft.DevCenter/preview/2024-07-01-preview/commonDefinitions.json + - Microsoft.DevCenter/preview/2024-07-01-preview/devcenter.json + - Microsoft.DevCenter/preview/2024-07-01-preview/vdi.json +suppressions: + - code: PatchBodyParametersSchema + from: vdi.json + reason: Patch Body comes from common-types v5 Sku object. Keeping here for consistency with existing parts of API to avoid breaking customers. +``` + ### Tag: package-preview-2024-06 These settings apply only when `--tag=package-preview-2024-06` is specified on the command line. From a220053360f9700f81abcdb6142769c85c3bcb27 Mon Sep 17 00:00:00 2001 From: Srikanta <51379715+srnagar@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:33:38 -0700 Subject: [PATCH 241/343] Text Translation: Enable stream style serialization (#29509) --- .../translation/Azure.AI.TextTranslation/tspconfig.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml index 754f49ac6449..0b3630b065d7 100644 --- a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml @@ -35,7 +35,6 @@ options: generate-tests: false customization-class: customization/src/main/java/TextTranslationClientBuilderCustomization.java flavor: azure - stream-style-serialization: false "@azure-tools/typespec-ts": package-dir: "ai-translation-text-rest" generateMetadata: false From 1c63635d66ae38cff18045ab416a6572d3e15f6e Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 26 Jun 2024 10:53:24 +0800 Subject: [PATCH 242/343] Update readme.python.md (#29587) * Update readme.python.md * Create readme.python.md --- .../migrate/resource-manager/readme.md | 5 ++++ .../migrate/resource-manager/readme.python.md | 23 +++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 specification/migrate/resource-manager/readme.python.md diff --git a/specification/migrate/resource-manager/readme.md b/specification/migrate/resource-manager/readme.md index 975618cb5dd2..c0c31959e15f 100644 --- a/specification/migrate/resource-manager/readme.md +++ b/specification/migrate/resource-manager/readme.md @@ -318,6 +318,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-net-track2 - repo: azure-sdk-for-go + - repo: azure-sdk-for-python - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-resource-manager-schemas @@ -327,3 +328,7 @@ swagger-to-sdk: ## Go See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) diff --git a/specification/migrate/resource-manager/readme.python.md b/specification/migrate/resource-manager/readme.python.md new file mode 100644 index 000000000000..8d7ab467a695 --- /dev/null +++ b/specification/migrate/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-migrate +namespace: azure.mgmt.migrate +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/migrate/azure-mgmt-migrate/azure/mgmt/migrate +``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` From db377f47cf7bf53bf077aa42967112a9783980d5 Mon Sep 17 00:00:00 2001 From: Risheek Rajolu Date: Wed, 26 Jun 2024 09:32:01 -0700 Subject: [PATCH 243/343] [StorageTasks] Bugfix maxpagesize type (#29534) * [StorageTasks] Bugfix maxpagesize type * add sdk-suppressions.yaml --------- Co-authored-by: Alancere <804873052@qq.com> --- .../stable/2023-05-01/storageTaskAssignments.json | 9 ++++++--- .../stable/2023-01-01/storageactions.json | 6 ++++-- .../resource-manager/sdk-suppressions.yaml | 6 ++++++ 3 files changed, 16 insertions(+), 5 deletions(-) create mode 100644 specification/storageactions/resource-manager/sdk-suppressions.yaml diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json index 1f6ee88b81b9..63386e78f87b 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json @@ -275,7 +275,8 @@ { "name": "$maxpagesize", "in": "query", - "type": "string", + "type": "integer", + "format": "int32", "description": "Optional, specifies the maximum number of storage task assignment Ids to be included in the list response." }, { @@ -326,7 +327,8 @@ { "name": "$maxpagesize", "in": "query", - "type": "string", + "type": "integer", + "format": "int32", "description": "Optional, specifies the maximum number of storage task assignment instances to be included in the list response." }, { @@ -386,7 +388,8 @@ { "name": "$maxpagesize", "in": "query", - "type": "string", + "type": "integer", + "format": "int32", "description": "Optional, specifies the maximum number of storage task assignment instances to be included in the list response." }, { diff --git a/specification/storageactions/resource-manager/Microsoft.StorageActions/stable/2023-01-01/storageactions.json b/specification/storageactions/resource-manager/Microsoft.StorageActions/stable/2023-01-01/storageactions.json index 340053249dd3..5a007ac949c1 100644 --- a/specification/storageactions/resource-manager/Microsoft.StorageActions/stable/2023-01-01/storageactions.json +++ b/specification/storageactions/resource-manager/Microsoft.StorageActions/stable/2023-01-01/storageactions.json @@ -374,7 +374,8 @@ { "name": "$maxpagesize", "in": "query", - "type": "string", + "type": "integer", + "format": "int32", "description": "Optional, specifies the maximum number of Storage Task Assignment Resource IDs to be included in the list response." }, { @@ -425,7 +426,8 @@ { "name": "$maxpagesize", "in": "query", - "type": "string", + "type": "integer", + "format": "int32", "description": "Optional, specifies the maximum number of Storage Task Assignment Resource IDs to be included in the list response." }, { diff --git a/specification/storageactions/resource-manager/sdk-suppressions.yaml b/specification/storageactions/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..5eaf3d35581f --- /dev/null +++ b/specification/storageactions/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,6 @@ +suppressions: + azure-sdk-for-go: + - package: sdk/resourcemanager/storageactions/armstorageactions + breaking-changes: + - Type of `StorageTaskAssignmentClientListOptions.Maxpagesize` has been changed from `*string` to `*int32` + - Type of `StorageTasksReportClientListOptions.Maxpagesize` has been changed from `*string` to `*int32` \ No newline at end of file From 0ed912fdfaffd5c81eb86b79df0e3b31d978d795 Mon Sep 17 00:00:00 2001 From: Braden Watkins Date: Wed, 26 Jun 2024 10:33:08 -0600 Subject: [PATCH 244/343] Billing/2024 04 01 (#28160) * Baseline for 2024-04-01 from 2020-05-01 * Updates for GA 2024-04-01 * Adding suppression as 'resource' schema is missing properties * Build fixes and PR feedback * tr lint error fix * update example * try fixing python * try removing the override * updating invoice download uri * Update reservation.json * Removing additional properties on policy * updated the resource reference and removed unused override * fixed error response * fix error * updated to proxyResourcewithTags * fix errors * Prettier check fix * merge conflict resolved * Prettier fix * reverted package.json * updated the ref * Prettier check * updated operation.json * add sdk-suppressions.yaml * remove modelerfour.lenient-model-deduplication, first stable * fix sdk-suppressions --------- Co-authored-by: Braden Watkins (from Dev Box) Co-authored-by: Umang Shah Co-authored-by: us6193 Co-authored-by: gaoyp830 <51546332+gaoyp830@users.noreply.github.com> Co-authored-by: Alancere <804873052@qq.com> --- cSpell.json | 8 + .../stable/2024-04-01/agreement.json | 315 +++ .../stable/2024-04-01/associatedTenant.json | 387 +++ .../stable/2024-04-01/availableBalance.json | 230 ++ .../stable/2024-04-01/billingAccount.json | 1324 +++++++++++ .../stable/2024-04-01/billingPermission.json | 830 +++++++ .../stable/2024-04-01/billingProfile.json | 737 ++++++ .../stable/2024-04-01/billingProperty.json | 694 ++++++ .../stable/2024-04-01/billingRequest.json | 751 ++++++ .../2024-04-01/billingRoleAssignment.json | 1953 ++++++++++++++++ .../2024-04-01/billingRoleDefinition.json | 710 ++++++ .../stable/2024-04-01/billingSavingsPlan.json | 1272 ++++++++++ .../2024-04-01/billingSubscription.json | 2082 +++++++++++++++++ .../stable/2024-04-01/customer.json | 379 +++ .../stable/2024-04-01/department.json | 204 ++ .../stable/2024-04-01/enrollmentAccount.json | 352 +++ .../examples/addressValidateInvalid.json | 36 + .../examples/addressValidateValid.json | 19 + .../2024-04-01/examples/agreementByName.json | 25 + .../agreementsListByBillingAccount.json | 62 + .../associatedTenantsCreateOrUpdate.json | 44 + .../examples/associatedTenantsDelete.json | 16 + .../examples/associatedTenantsGet.json | 23 + ...associatedTenantsListByBillingAccount.json | 37 + .../availableBalanceGetByBillingAccount.json | 51 + .../availableBalanceGetByBillingProfile.json | 40 + ...billingAccountForLegacyAccountDetails.json | 26 + .../billingAccountUpdateWithPONumber.json | 63 + .../billingAccountWithExpandForPONumber.json | 41 + ...WithRegistrationNumberWithDefaultType.json | 34 + ...AccountWithRegistrationNumberWithType.json | 35 + .../billingAccountsConfirmTransition.json | 14 + .../examples/billingAccountsGet.json | 28 + .../examples/billingAccountsGetEA.json | 47 + .../billingAccountsGetWithExpand.json | 38 + .../examples/billingAccountsList.json | 85 + ...lingAccountsListWithExpandForPONumber.json | 53 + .../examples/billingAccountsUpdate.json | 56 + ...illingPermissionsListByBillingAccount.json | 39 + ...illingPermissionsListByBillingProfile.json | 40 + .../billingPermissionsListByCustomer.json | 28 + ...issionsListByCustomerAtBillingAccount.json | 27 + .../billingPermissionsListByDepartment.json | 26 + ...ingPermissionsListByEnrollmentAccount.json | 24 + ...illingPermissionsListByInvoiceSection.json | 28 + .../billingProfilesCreateOrUpdate.json | 154 ++ .../examples/billingProfilesDelete.json | 62 + .../examples/billingProfilesGet.json | 87 + .../billingProfilesListByBillingAccount.json | 219 ++ ...filesValidateDeleteEligibilityFailure.json | 36 + ...filesValidateDeleteEligibilitySuccess.json | 12 + .../examples/billingPropertyGetMCA.json | 40 + .../examples/billingPropertyGetMOSP.json | 35 + .../examples/billingPropertyGetMPA.json | 40 + .../billingPropertyPatchCostCenter.json | 45 + ...yPatchSubscriptionServiceUsageAddress.json | 50 + .../billingRequestsCreateOrUpdate.json | 79 + .../examples/billingRequestsGet.json | 38 + .../billingRequestsListByBillingAccount.json | 68 + .../billingRequestsListByBillingProfile.json | 43 + .../billingRequestsListByCustomer.json | 47 + .../billingRequestsListByInvoiceSection.json | 47 + .../examples/billingRequestsListByUser.json | 67 + .../billingRequestsListByUserWithFilter.json | 40 + ...gRoleAssignmentCreateByBillingAccount.json | 36 + ...gRoleAssignmentCreateByBillingProfile.json | 37 + ...billingRoleAssignmentCreateByCustomer.json | 38 + ...gRoleAssignmentCreateByInvoiceSection.json | 38 + ...ignmentCreateOrUpdateByBillingAccount.json | 49 + ...eAssignmentCreateOrUpdateByDepartment.json | 50 + ...mentCreateOrUpdateByEnrollmentAccount.json | 50 + ...gRoleAssignmentDeleteByBillingAccount.json | 11 + ...gRoleAssignmentDeleteByBillingProfile.json | 12 + ...billingRoleAssignmentDeleteByCustomer.json | 13 + ...llingRoleAssignmentDeleteByDepartment.json | 12 + ...leAssignmentDeleteByEnrollmentAccount.json | 12 + ...gRoleAssignmentDeleteByInvoiceSection.json | 13 + ...lingRoleAssignmentGetByBillingAccount.json | 25 + ...lingRoleAssignmentGetByBillingProfile.json | 26 + .../billingRoleAssignmentGetByCustomer.json | 27 + .../billingRoleAssignmentGetByDepartment.json | 25 + ...gRoleAssignmentGetByEnrollmentAccount.json | 25 + ...lingRoleAssignmentGetByInvoiceSection.json | 27 + ...ingRoleAssignmentListByBillingAccount.json | 42 + ...ingRoleAssignmentListByBillingProfile.json | 43 + .../billingRoleAssignmentListByCustomer.json | 44 + ...billingRoleAssignmentListByDepartment.json | 43 + ...RoleAssignmentListByEnrollmentAccount.json | 43 + ...ingRoleAssignmentListByInvoiceSection.json | 44 + ...lingRoleDefinitionGetByBillingAccount.json | 68 + ...lingRoleDefinitionGetByBillingProfile.json | 39 + .../billingRoleDefinitionGetByCustomer.json | 46 + .../billingRoleDefinitionGetByDepartment.json | 34 + ...gRoleDefinitionGetByEnrollmentAccount.json | 33 + ...lingRoleDefinitionGetByInvoiceSection.json | 45 + ...ingRoleDefinitionListByBillingAccount.json | 205 ++ ...ingRoleDefinitionListByBillingProfile.json | 108 + .../billingRoleDefinitionListByCustomer.json | 102 + ...billingRoleDefinitionListByDepartment.json | 55 + ...RoleDefinitionListByEnrollmentAccount.json | 38 + ...ingRoleDefinitionListByInvoiceSection.json | 116 + ...illingSubscriptionAliasCreateOrUpdate.json | 96 + .../examples/billingSubscriptionAliasGet.json | 45 + .../billingSubscriptionAliasList.json | 128 + ...illingSubscriptionGetByBillingProfile.json | 34 + .../examples/billingSubscriptionMove.json | 37 + ...illingSubscriptionValidateMoveFailure.json | 22 + ...illingSubscriptionValidateMoveSuccess.json | 19 + .../examples/billingSubscriptionsCancel.json | 19 + .../examples/billingSubscriptionsDelete.json | 16 + .../examples/billingSubscriptionsGet.json | 45 + ...lingSubscriptionsListByBillingAccount.json | 128 + ...ngSubscriptionsListByBillingProfileEA.json | 29 + ...gSubscriptionsListByBillingProfileMCA.json | 83 + .../billingSubscriptionsListByCustomer.json | 78 + ...iptionsListByCustomerAtBillingAccount.json | 77 + ...gSubscriptionsListByEnrollmentAccount.json | 46 + ...lingSubscriptionsListByInvoiceSection.json | 84 + .../examples/billingSubscriptionsMerge.json | 54 + .../examples/billingSubscriptionsSplit.json | 57 + .../examples/billingSubscriptionsUpdate.json | 55 + .../examples/checkAccessByBillingAccount.json | 26 + .../examples/checkAccessByBillingProfile.json | 27 + .../examples/checkAccessByCustomer.json | 28 + .../examples/checkAccessByDepartment.json | 27 + .../checkAccessByEnrollmentAccount.json | 27 + .../examples/checkAccessByInvoiceSection.json | 28 + .../2024-04-01/examples/customersGet.json | 44 + .../customersGetByBillingAccount.json | 43 + .../customersListByBillingAccount.json | 42 + ...stomersListByBillingAccountWithExpand.json | 47 + .../customersListByBillingProfile.json | 43 + .../2024-04-01/examples/departmentGet.json | 21 + .../departmentsListByBillingAccount.json | 34 + .../enrollmentAccountByDepartment.json | 29 + .../examples/enrollmentAccountGet.json | 28 + ...nrollmentAccountsListByBillingAccount.json | 65 + .../enrollmentAccountsListByDepartment.json | 49 + .../invoiceSectionsCreateOrUpdate.json | 55 + .../examples/invoiceSectionsDelete.json | 17 + .../examples/invoiceSectionsGet.json | 25 + .../invoiceSectionsListByBillingProfile.json | 59 + ...tionsValidateDeleteEligibilityFailure.json | 33 + ...tionsValidateDeleteEligibilitySuccess.json | 13 + ...sWithCreateSubscriptionPermissionList.json | 35 + .../2024-04-01/examples/invoicesAmend.json | 15 + .../invoicesDownloadByBillingAccount.json | 22 + ...invoicesDownloadByBillingSubscription.json | 22 + ...icesDownloadDocumentsByBillingAccount.json | 30 + ...ownloadDocumentsByBillingSubscription.json | 30 + ...voicesDownloadSummaryByBillingAccount.json | 21 + .../2024-04-01/examples/invoicesGet.json | 78 + .../examples/invoicesGetByBillingAccount.json | 79 + .../invoicesGetByBillingSubscription.json | 35 + .../invoicesListByBillingAccount.json | 162 ++ .../invoicesListByBillingProfile.json | 163 ++ .../invoicesListByBillingSubscription.json | 106 + .../2024-04-01/examples/operationsList.json | 21 + .../examples/partnerTransfersCancel.json | 26 + .../examples/partnerTransfersGet.json | 41 + .../examples/partnerTransfersInitiate.json | 44 + .../examples/partnerTransfersList.json | 45 + .../paymentMethodsDeleteAtBillingProfile.json | 17 + .../examples/paymentMethodsDeleteByUser.json | 10 + .../paymentMethodsGetByBillingAccount.json | 21 + .../paymentMethodsGetByBillingProfile.json | 37 + .../examples/paymentMethodsGetByUser.json | 34 + .../paymentMethodsListByBillingAccount.json | 24 + .../paymentMethodsListByBillingProfile.json | 40 + .../examples/paymentMethodsListByUser.json | 61 + .../examples/paymentTermInvalid.json | 26 + .../2024-04-01/examples/paymentTermValid.json | 20 + .../2024-04-01/examples/paymentTermsAdd.json | 42 + .../examples/paymentTermsCancel.json | 36 + .../examples/policiesGetByBillingAccount.json | 23 + .../examples/policiesGetByBillingProfile.json | 22 + .../examples/policiesGetByCustomer.json | 21 + ...policiesGetByCustomerAtBillingAccount.json | 19 + .../examples/policiesGetBySubscription.json | 25 + .../examples/policiesPutByBillingAccount.json | 48 + .../examples/policiesPutByBillingProfile.json | 43 + .../examples/policiesPutByCustomer.json | 35 + ...policiesPutByCustomerAtBillingAccount.json | 34 + .../2024-04-01/examples/productMove.json | 35 + .../examples/productValidateMoveFailure.json | 22 + .../examples/productValidateMoveSuccess.json | 19 + .../2024-04-01/examples/productsGet.json | 31 + .../productsListByBillingAccount.json | 74 + .../productsListByBillingProfile.json | 75 + .../examples/productsListByCustomer.json | 60 + .../productsListByInvoiceSection.json | 76 + .../2024-04-01/examples/productsUpdate.json | 36 + .../examples/recipientTransfersAccept.json | 51 + .../examples/recipientTransfersDecline.json | 21 + .../examples/recipientTransfersGet.json | 37 + .../examples/recipientTransfersList.json | 41 + .../examples/recipientTransfersValidate.json | 41 + .../reservationGetByBillingAccount.json | 105 + ...ionGetByBillingAccountManagementGroup.json | 118 + ...etByBillingAccountSingleResourceGroup.json | 112 + ...rvationGetByBillingAccountSingleScope.json | 112 + .../reservationOrderGetByBillingAccount.json | 40 + ...llingAccountWithExpandPlanInformation.json | 409 ++++ ...reservationOrdersListByBillingAccount.json | 43 + .../reservationUpdateByBillingAccount.json | 116 + ...ervationsGetFromOrderByBillingAccount.json | 77 + .../reservationsListByBillingAccount.json | 91 + .../reservationsListByBillingProfile.json | 92 + ...BillingRoleAssignmentByBillingAccount.json | 48 + ...BillingRoleAssignmentByBillingProfile.json | 49 + ...esolveBillingRoleAssignmentByCustomer.json | 56 + ...BillingRoleAssignmentByInvoiceSection.json | 50 + .../savingsPlanGetByBillingAccount.json | 75 + ...ExpandRenewPropertiesByBillingAccount.json | 99 + ...erExpandedScheduleGetByBillingAccount.json | 342 +++ .../savingsPlanOrderGetByBillingAccount.json | 38 + .../savingsPlanOrderListByBillingAccount.json | 70 + .../savingsPlanUpdateByBillingAccount.json | 96 + ...ngsPlanValidateUpdateByBillingAccount.json | 29 + .../savingsPlansListByBillingAccount.json | 275 +++ .../savingsPlansListBySavingsPlanOrders.json | 68 + .../transactionSummaryGetByInvoice.json | 19 + .../transactionsDownloadByInvoice.json | 21 + .../transactionsListByBillingProfile.json | 136 ++ .../examples/transactionsListByCustomer.json | 137 ++ .../examples/transactionsListByInvoice.json | 130 + .../transactionsListByInvoiceSection.json | 137 ++ .../2024-04-01/examples/transfersCancel.json | 25 + .../2024-04-01/examples/transfersGet.json | 40 + .../examples/transfersInitiate.json | 42 + .../2024-04-01/examples/transfersList.json | 43 + .../stable/2024-04-01/invoice.json | 1364 +++++++++++ .../stable/2024-04-01/invoiceSection.json | 523 +++++ .../stable/2024-04-01/operation.json | 148 ++ .../stable/2024-04-01/payment.json | 661 ++++++ .../stable/2024-04-01/policy.json | 977 ++++++++ .../stable/2024-04-01/product.json | 826 +++++++ .../stable/2024-04-01/reservation.json | 1423 +++++++++++ .../stable/2024-04-01/transaction.json | 862 +++++++ .../stable/2024-04-01/transfers.json | 1225 ++++++++++ .../stable/2024-04-01/types.json | 363 +++ .../billing/resource-manager/readme.md | 312 ++- .../resource-manager/sdk-suppressions.yaml | 703 ++++++ 243 files changed, 33069 insertions(+), 48 deletions(-) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/agreement.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/associatedTenant.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/availableBalance.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingPermission.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingProperty.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRequest.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRoleAssignment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRoleDefinition.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSavingsPlan.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/customer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/department.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/enrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateInvalid.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateValid.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementByName.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsCreateOrUpdate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountUpdateWithPONumber.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithExpandForPONumber.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithDefaultType.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithType.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsConfirmTransition.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGetEA.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGetWithExpand.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsUpdate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByCustomerAtBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByEnrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilityFailure.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilitySuccess.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMCA.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMOSP.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMPA.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyPatchCostCenter.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyPatchSubscriptionServiceUsageAddress.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsCreateOrUpdate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUser.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByEnrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByEnrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByEnrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByEnrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasCreateOrUpdate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionGetByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionMove.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveFailure.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveSuccess.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsCancel.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileMCA.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomerAtBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsMerge.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsSplit.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsUpdate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByEnrollmentAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingAccountWithExpand.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/departmentGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/departmentsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsCreateOrUpdate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilityFailure.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilitySuccess.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsWithCreateSubscriptionPermissionList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesAmend.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadByBillingSubscription.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadSummaryByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGetByBillingSubscription.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingSubscription.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/operationsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersCancel.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersInitiate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsDeleteAtBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsDeleteByUser.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByUser.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermInvalid.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermValid.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsAdd.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsCancel.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByCustomerAtBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetBySubscription.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByCustomerAtBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productMove.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productValidateMoveFailure.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productValidateMoveSuccess.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsUpdate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersAccept.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersDecline.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersValidate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountManagementGroup.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleResourceGroup.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleScope.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrdersListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationUpdateByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsGetFromOrderByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderGetByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanUpdateByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanValidateUpdateByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListBySavingsPlanOrders.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionSummaryGetByInvoice.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsDownloadByInvoice.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByInvoice.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersCancel.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersInitiate.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/invoice.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/invoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/operation.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/payment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/policy.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/product.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/reservation.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/transaction.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/transfers.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/types.json create mode 100644 specification/billing/resource-manager/sdk-suppressions.yaml diff --git a/cSpell.json b/cSpell.json index 416e3c5e1d89..bcbba8da57cf 100644 --- a/cSpell.json +++ b/cSpell.json @@ -149,6 +149,14 @@ "Accesskey" ] }, + { + "filename": "**/specification/billing/**/*.json", + "words": [ + "mosp", + "resellee", + "cnpj" + ] + }, { "filename": "**/specification/compute/resource-manager/Microsoft.ContainerService/preview/2015-11-01-preview/containerService.json", "words": [ diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/agreement.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/agreement.json new file mode 100644 index 000000000000..573fcb62a0e7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/agreement.json @@ -0,0 +1,315 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}": { + "get": { + "tags": [ + "Agreement" + ], + "description": "Gets an agreement by ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Agreements_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "in": "path", + "name": "agreementName", + "description": "The ID that uniquely identifies an agreement.", + "required": true, + "type": "string", + "pattern": "^[a-fA-F0-9]{1,12}$" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A billing account.", + "schema": { + "$ref": "#/definitions/Agreement" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AgreementByName": { + "$ref": "./examples/agreementByName.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements": { + "get": { + "tags": [ + "Agreement" + ], + "description": "Lists the agreements for a billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Agreements_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "May be used to expand the participants.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Result of listing agreements.", + "schema": { + "$ref": "#/definitions/AgreementListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AgreementsListByBillingAccount": { + "$ref": "./examples/agreementsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Agreement": { + "description": "An agreement.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AgreementProperties" + } + }, + "x-ms-azure-resource": true + }, + "AgreementListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Agreement" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "AgreementProperties": { + "description": "An agreement.", + "type": "object", + "properties": { + "acceptanceMode": { + "description": "The mode of acceptance for an agreement.", + "enum": [ + "Other", + "ClickToAccept", + "ESignEmbedded", + "ESignOffline", + "Implicit", + "Offline", + "PhysicalSign" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AcceptanceMode", + "modelAsString": true + } + }, + "agreementLink": { + "description": "The URL to download the agreement.", + "type": "string", + "readOnly": true + }, + "billingProfileInfo": { + "description": "The list of billing profiles associated with agreement and present only for specific agreements.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingProfileInfo" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "category": { + "description": "The category of the agreement.", + "enum": [ + "Other", + "AffiliatePurchaseTerms", + "IndirectForGovernmentAgreement", + "MicrosoftCustomerAgreement", + "MicrosoftPartnerAgreement", + "UKCloudComputeFramework" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Category", + "modelAsString": true + } + }, + "displayName": { + "description": "The name of the agreement signed by a customer.", + "type": "string", + "readOnly": true + }, + "effectiveDate": { + "format": "date-time", + "description": "The date from which the agreement is effective.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "format": "date-time", + "description": "The date when the agreement expires.", + "type": "string", + "readOnly": true + }, + "participants": { + "description": "The list of participants that participates in acceptance of an agreement.", + "type": "array", + "items": { + "$ref": "#/definitions/Participant" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "status": { + "description": "The current status of the agreement.", + "type": "string", + "readOnly": true + }, + "leadBillingAccountName": { + "description": "The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms.", + "type": "string", + "readOnly": true + } + } + }, + "BillingProfileInfo": { + "description": "Details about billing profile associated with agreement and available only for specific agreements.", + "type": "object", + "properties": { + "billingAccountId": { + "description": "The fully qualified ID that uniquely identifies a billing account.", + "type": "string" + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile.", + "type": "string" + }, + "billingProfileId": { + "description": "The friendly ID that uniquely identifies a billing profile.", + "type": "string" + }, + "billingProfileSystemId": { + "description": "The fully qualified ID that uniquely identifies a billing profile.", + "type": "string" + }, + "indirectRelationshipOrganizationName": { + "description": "Billing account name. Available for a specific type of agreement.", + "type": "string" + } + } + }, + "Participant": { + "description": "Billing account name. Available for a specific type of agreement.", + "type": "object", + "properties": { + "email": { + "description": "The email address of the participant.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The acceptance status of the participant.", + "type": "string", + "readOnly": true + }, + "statusDate": { + "format": "date-time", + "description": "The date when the status got changed.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/associatedTenant.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/associatedTenant.json new file mode 100644 index 000000000000..0955a9a69583 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/associatedTenant.json @@ -0,0 +1,387 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}": { + "delete": { + "tags": [ + "AssociatedTenant" + ], + "description": "Deletes an associated tenant for a billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "AssociatedTenants_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/associatedTenantName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "AssociatedTenantsDelete": { + "$ref": "./examples/associatedTenantsDelete.json" + } + } + }, + "get": { + "tags": [ + "AssociatedTenant" + ], + "description": "Gets an associated tenant by ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "AssociatedTenants_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/associatedTenantName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "An associated tenant.", + "schema": { + "$ref": "#/definitions/AssociatedTenant" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssociatedTenantsGet": { + "$ref": "./examples/associatedTenantsGet.json" + } + } + }, + "put": { + "tags": [ + "AssociatedTenant" + ], + "description": "Create or update an associated tenant for the billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "AssociatedTenants_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/associatedTenantName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "An associated tenant.", + "required": true, + "schema": { + "$ref": "#/definitions/AssociatedTenant" + } + } + ], + "responses": { + "200": { + "description": "An associated tenant.", + "schema": { + "$ref": "#/definitions/AssociatedTenant" + } + }, + "201": { + "description": "An associated tenant.", + "schema": { + "$ref": "#/definitions/AssociatedTenant" + }, + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "AssociatedTenantsCreateOrUpdate": { + "$ref": "./examples/associatedTenantsCreateOrUpdate.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants": { + "get": { + "tags": [ + "AssociatedTenant" + ], + "description": "Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "AssociatedTenants_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "in": "query", + "name": "includeRevoked", + "description": "Can be used to get revoked associated tenants.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "A list of associated tenants.", + "schema": { + "$ref": "#/definitions/AssociatedTenantListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssociatedTenantsListByBillingAccount": { + "$ref": "./examples/associatedTenantsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AssociatedTenant": { + "description": "An associated tenant.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AssociatedTenantProperties" + } + }, + "x-ms-azure-resource": true + }, + "AssociatedTenantListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AssociatedTenant" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "AssociatedTenantProperties": { + "description": "An associated tenant.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "displayName": { + "description": "The name of the associated tenant.", + "type": "string" + }, + "tenantId": { + "description": "The ID that uniquely identifies a tenant.", + "type": "string" + }, + "billingManagementState": { + "description": "The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases.", + "enum": [ + "Other", + "NotAllowed", + "Active", + "Revoked" + ], + "type": "string", + "x-ms-enum": { + "name": "BillingManagementTenantState", + "modelAsString": true + } + }, + "provisioningManagementState": { + "description": "The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request.", + "enum": [ + "Other", + "NotRequested", + "Active", + "Pending", + "BillingRequestExpired", + "BillingRequestDeclined", + "Revoked" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningTenantState", + "modelAsString": true + } + }, + "provisioningBillingRequestId": { + "description": "The unique identifier for the billing request that is created when enabling provisioning for an associated tenant.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/availableBalance.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/availableBalance.json new file mode 100644 index 000000000000..9e9d41b07f9d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/availableBalance.json @@ -0,0 +1,230 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/availableBalance/default": { + "get": { + "tags": [ + "AvailableBalance" + ], + "description": "The Available Credit or Payment on Account Balance for a billing account. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Online Services Program.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "AvailableBalances_GetByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", + "schema": { + "$ref": "#/definitions/AvailableBalance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvailableBalanceGetByBillingAccount": { + "$ref": "./examples/availableBalanceGetByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default": { + "get": { + "tags": [ + "AvailableBalance" + ], + "description": "The Available Credit or Payment on Account Balance for a billing profile. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "AvailableBalances_GetByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", + "schema": { + "$ref": "#/definitions/AvailableBalance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvailableBalanceGetByBillingProfile": { + "$ref": "./examples/availableBalanceGetByBillingProfile.json" + } + } + } + } + }, + "definitions": { + "AvailableBalance": { + "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AvailableBalanceProperties" + } + }, + "x-ms-azure-resource": true + }, + "AvailableBalanceProperties": { + "description": "The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.", + "type": "object", + "properties": { + "amount": { + "description": "Credit amount for immediate payment.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "paymentsOnAccount": { + "description": "The list of payments on accounts.", + "type": "array", + "items": { + "$ref": "#/definitions/PaymentOnAccount" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "totalPaymentsOnAccount": { + "description": "Total amount of payments on accounts.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + } + } + }, + "PaymentOnAccount": { + "description": "A Payment on Account.", + "type": "object", + "properties": { + "amount": { + "description": "Payment on Account amount.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "billingProfileId": { + "description": "The ID of the billing profile for the payments on account.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile for the payments on account.", + "type": "string", + "readOnly": true + }, + "invoiceId": { + "description": "The ID of the invoice for which the payments on account was generated.", + "type": "string", + "readOnly": true + }, + "invoiceName": { + "description": "The name of the invoice for the payments on account.", + "type": "string", + "readOnly": true + }, + "date": { + "format": "date-time", + "description": "The date of the payments on account.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Payment on Account type.", + "enum": [ + "Other", + "None", + "CreditCard", + "Credits", + "CheckWire", + "EWallet", + "TaskOrder", + "DirectDebit" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PaymentMethodFamily", + "modelAsString": true + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingAccount.json new file mode 100644 index 000000000000..3ef42cf8a3b7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingAccount.json @@ -0,0 +1,1324 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/addPaymentTerms": { + "post": { + "tags": [ + "BillingAccount" + ], + "description": "Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingAccounts_AddPaymentTerms", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of payment term.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PaymentTerm" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "The list of billing accounts.", + "schema": { + "$ref": "#/definitions/BillingAccount" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PaymentTermsAdd": { + "$ref": "./examples/paymentTermsAdd.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/cancelPaymentTerms": { + "post": { + "tags": [ + "BillingAccount" + ], + "description": "Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingAccounts_CancelPaymentTerms", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Date after which any payment terms that needs to be cancelled.", + "required": true, + "schema": { + "format": "date-time", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The list of billing accounts.", + "schema": { + "$ref": "#/definitions/BillingAccount" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PaymentTermsCancel": { + "$ref": "./examples/paymentTermsCancel.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/confirmTransition": { + "post": { + "tags": [ + "BillingAccount" + ], + "description": "Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingAccounts_ConfirmTransition", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details for a billing account transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.", + "schema": { + "$ref": "#/definitions/TransitionDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingAccountsConfirmTransition": { + "$ref": "./examples/billingAccountsConfirmTransition.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission": { + "post": { + "tags": [ + "BillingAccount" + ], + "description": "Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InvoiceSectionWithCreateSubPermissionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoiceSectionsWithCreateSubscriptionPermissionList": { + "$ref": "./examples/invoiceSectionsWithCreateSubscriptionPermissionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/validatePaymentTerms": { + "post": { + "tags": [ + "BillingAccount" + ], + "description": "Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingAccounts_ValidatePaymentTerms", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of payment term.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PaymentTerm" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "Result of the payment terms eligibility.", + "schema": { + "$ref": "#/definitions/PaymentTermsEligibilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PaymentTermInvalid": { + "$ref": "./examples/paymentTermInvalid.json" + }, + "PaymentTermValid": { + "$ref": "./examples/paymentTermValid.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}": { + "get": { + "tags": [ + "BillingAccount" + ], + "description": "Gets a billing account by its ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingAccounts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A billing account.", + "schema": { + "$ref": "#/definitions/BillingAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingAccountsGet": { + "$ref": "./examples/billingAccountsGet.json" + }, + "BillingAccountsGetWithExpand": { + "$ref": "./examples/billingAccountsGetWithExpand.json" + }, + "BillingAccountWithRegistrationNumberWithDefaultType": { + "$ref": "./examples/billingAccountWithRegistrationNumberWithDefaultType.json" + }, + "BillingAccountWithRegistrationNumberWithType": { + "$ref": "./examples/billingAccountWithRegistrationNumberWithType.json" + }, + "BillingAccountsGetEA": { + "$ref": "./examples/billingAccountsGetEA.json" + }, + "BillingAccountWithExpandForPONumber": { + "$ref": "./examples/billingAccountWithExpandForPONumber.json" + } + } + }, + "patch": { + "tags": [ + "BillingAccount" + ], + "description": "Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingAccounts_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A billing account.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingAccountPatch" + } + } + ], + "responses": { + "200": { + "description": "A billing account.", + "schema": { + "$ref": "#/definitions/BillingAccount" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingAccountsUpdate": { + "$ref": "./examples/billingAccountsUpdate.json" + }, + "BillingAccountUpdateWithPONumber": { + "$ref": "./examples/billingAccountUpdateWithPONumber.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts": { + "get": { + "tags": [ + "BillingAccount" + ], + "description": "Lists the billing accounts that a user has access to.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingAccounts_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "includeAll", + "description": "When true, results will include Billing Accounts that the user does not have a direct role assignment on if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includeAllWithoutBillingProfiles", + "description": "When true, results will include Billing Accounts that are not fully created if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includeDeleted", + "description": "When true, results will include any billing accounts in a deleted state.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includePendingAgreement", + "description": "Includes billing accounts with agreement pending signature that the user has access to.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includeResellee", + "description": "Includes the customer's billing account of Microsoft Partner Agreement that the user has access to.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "legalOwnerTID", + "description": "Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.", + "type": "string" + }, + { + "in": "query", + "name": "legalOwnerOID", + "description": "Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "in": "query", + "name": "expand", + "description": "Expand is allowed for SoldTo and EnrollmentDetails/PONumber.", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing accounts.", + "schema": { + "$ref": "#/definitions/BillingAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingAccountsList": { + "$ref": "./examples/billingAccountsList.json" + }, + "BillingAccountForLegacyAccountDetails": { + "$ref": "./examples/billingAccountForLegacyAccountDetails.json" + }, + "BillingAccountsListWithExpandForPONumber": { + "$ref": "./examples/billingAccountsListWithExpandForPONumber.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/validateAddress": { + "post": { + "tags": [ + "BillingAccount" + ], + "description": "Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Address_Validate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Address details.", + "required": true, + "schema": { + "$ref": "./types.json#/definitions/AddressDetails" + } + } + ], + "responses": { + "200": { + "description": "Result of the address validation.", + "schema": { + "$ref": "#/definitions/AddressValidationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AddressValidateValid": { + "$ref": "./examples/addressValidateValid.json" + }, + "AddressValidateInvalid": { + "$ref": "./examples/addressValidateInvalid.json" + } + } + } + } + }, + "definitions": { + "AddressValidationResponse": { + "description": "Result of the address validation.", + "type": "object", + "properties": { + "status": { + "description": "Status of the address validation.", + "enum": [ + "Other", + "Valid", + "Invalid" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AddressValidationStatus", + "modelAsString": true + } + }, + "suggestedAddresses": { + "description": "The list of suggested addresses.", + "type": "array", + "items": { + "$ref": "./types.json#/definitions/AddressDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "validationMessage": { + "description": "Validation error message.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "BillingAccount": { + "description": "A billing account.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BillingAccountProperties" + } + }, + "x-ms-azure-resource": true + }, + "BillingAccountListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingAccount" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "BillingAccountPatch": { + "description": "A billing account.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BillingAccountProperties" + } + }, + "x-ms-azure-resource": true + }, + "BillingAccountProperties": { + "description": "A billing account.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "accountStatus": { + "description": "The current status of the billing account.", + "enum": [ + "Other", + "Active", + "UnderReview", + "Disabled", + "Deleted", + "Extended", + "Pending", + "New", + "Expired", + "Terminated", + "Transferred" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": true + } + }, + "accountType": { + "description": "The type of customer.", + "enum": [ + "Other", + "Enterprise", + "Individual", + "Partner", + "Reseller", + "ClassicPartner", + "Internal", + "Tenant", + "Business" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AccountType", + "modelAsString": true + } + }, + "accountSubType": { + "description": "The tier of the account.", + "enum": [ + "Other", + "None", + "Individual", + "Professional", + "Enterprise" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AccountSubType", + "modelAsString": true + } + }, + "accountStatusReasonCode": { + "description": "Reason for the specified billing account status.", + "enum": [ + "Other", + "UnusualActivity", + "ManuallyTerminated", + "Expired", + "Transferred", + "TerminateProcessing" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingAccountStatusReasonCode", + "modelAsString": true + } + }, + "agreementType": { + "description": "The type of agreement.", + "enum": [ + "Other", + "MicrosoftCustomerAgreement", + "EnterpriseAgreement", + "MicrosoftOnlineServicesProgram", + "MicrosoftPartnerAgreement" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AgreementType", + "modelAsString": true + } + }, + "displayName": { + "description": "The billing account name.", + "type": "string" + }, + "enrollmentDetails": { + "description": "The properties of an enrollment.", + "allOf": [ + { + "$ref": "#/definitions/EnrollmentDetails" + } + ] + }, + "hasReadAccess": { + "description": "Indicates whether user has read access to the billing account.", + "type": "boolean" + }, + "hasNoBillingProfiles": { + "description": "Indicates whether or not the billing account has any billing profiles.", + "type": "boolean" + }, + "notificationEmailAddress": { + "description": "Notification email address for legacy account. Available for agreement type Microsoft Online Services Program.", + "type": "string" + }, + "primaryBillingTenantId": { + "description": "The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant.", + "type": "string" + }, + "soldTo": { + "description": "The address of the individual or organization that is responsible for the billing account.", + "allOf": [ + { + "$ref": "./types.json#/definitions/AddressDetails" + } + ] + }, + "registrationNumber": { + "description": "Describes the registration number of the organization linked with the billing account.", + "allOf": [ + { + "$ref": "#/definitions/RegistrationNumber" + } + ] + }, + "billingRelationshipTypes": { + "description": "Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party.", + "type": "array", + "items": { + "description": "Identifies the billing relationships represented by a billing account or billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.", + "enum": [ + "Other", + "Direct", + "IndirectCustomer", + "IndirectPartner", + "CSPPartner", + "CSPCustomer" + ], + "type": "string", + "x-ms-enum": { + "name": "BillingRelationshipType", + "modelAsString": true + } + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "qualifications": { + "description": "Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "taxIds": { + "description": "A list of tax identifiers for the billing account.", + "type": "array", + "items": { + "$ref": "#/definitions/TaxIdentifier" + }, + "x-ms-identifiers": [] + } + } + }, + "EnrollmentDetails": { + "description": "The properties of an enrollment.", + "type": "object", + "properties": { + "startDate": { + "format": "date-time", + "description": "The start date of the enrollment.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The end date of the enrollment.", + "type": "string" + }, + "currency": { + "description": "The billing currency for the enrollment.", + "type": "string", + "readOnly": true + }, + "channel": { + "description": "The channel type of the enrollment.", + "type": "string", + "readOnly": true + }, + "language": { + "description": "The language for the enrollment.", + "type": "string", + "readOnly": true + }, + "countryCode": { + "description": "The country code of the enrollment.", + "type": "string", + "readOnly": true + }, + "billingCycle": { + "description": "The billing cycle for the enrollment.", + "type": "string", + "readOnly": true + }, + "extendedTermOption": { + "description": "The billing account extension opted by the company.", + "enum": [ + "Other", + "Opted-In", + "Opted-Out" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ExtendedTermOption", + "modelAsString": true + } + }, + "supportLevel": { + "description": "The support level offer associated with an enrollment.", + "enum": [ + "Other", + "Standard", + "Pro-Direct", + "Developer" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SupportLevel", + "modelAsString": true + } + }, + "supportCoverage": { + "description": "The support coverage period for the enrollment.", + "type": "string", + "readOnly": true + }, + "cloud": { + "description": "The cloud of the enrollment.", + "type": "string", + "readOnly": true + }, + "poNumber": { + "description": "The purchase order number of the enrollment.", + "type": "string" + }, + "markupStatus": { + "description": "Markup status of enrollment, applicable only for indirect enrollments.", + "enum": [ + "Other", + "Disabled", + "Preview", + "Published", + "Locked" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MarkupStatus", + "modelAsString": true + } + }, + "indirectRelationshipInfo": { + "description": "The properties of an enrollment which are applicable only for indirect enrollments.", + "allOf": [ + { + "$ref": "./types.json#/definitions/IndirectRelationshipInfo" + } + ] + }, + "invoiceRecipient": { + "description": "The contact who receives invoices of the enrollment.", + "type": "string", + "readOnly": true + } + } + }, + "InvoiceSectionWithCreateSubPermission": { + "description": "Invoice section properties with create subscription permission.", + "type": "object", + "properties": { + "billingProfileDisplayName": { + "description": "The name of the billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The fully qualified ID that uniquely identifies a billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileSystemId": { + "description": "The system generated unique identifier for a billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileStatus": { + "description": "The status of the billing profile.", + "enum": [ + "Other", + "Active", + "Disabled", + "Warned", + "Deleted", + "UnderReview" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatus", + "modelAsString": true + } + }, + "billingProfileStatusReasonCode": { + "description": "Reason for the specified billing profile status.", + "enum": [ + "Other", + "PastDue", + "UnusualActivity", + "SpendingLimitReached", + "SpendingLimitExpired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatusReasonCode", + "modelAsString": true + } + }, + "billingProfileSpendingLimit": { + "description": "The billing profile spending limit.", + "enum": [ + "Off", + "On" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SpendingLimit", + "modelAsString": true + } + }, + "enabledAzurePlans": { + "description": "Enabled azure plans for the associated billing profile.", + "type": "array", + "items": { + "$ref": "./types.json#/definitions/AzurePlan" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "The fully qualified ID that uniquely identifies an invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionSystemId": { + "description": "The system generated unique identifier for an invoice section.", + "type": "string", + "readOnly": true + } + } + }, + "InvoiceSectionWithCreateSubPermissionListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/InvoiceSectionWithCreateSubPermission" + }, + "readOnly": true, + "x-ms-identifiers": [ + "invoiceSectionId" + ] + } + } + }, + "PaymentTerm": { + "description": "The properties of payment term.", + "type": "object", + "properties": { + "term": { + "description": "Represents duration in netXX format. Always in days.", + "type": "string" + }, + "startDate": { + "format": "date-time", + "description": "The date on when the defined 'Payment Term' will be effective from and is always in UTC.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The date on when the defined 'Payment Term' will end and is always in UTC.", + "type": "string" + }, + "isDefault": { + "description": "Indicates payment term is the standard payment term.", + "type": "boolean", + "readOnly": true + } + } + }, + "PaymentTermsEligibilityDetail": { + "description": "Details of the payment terms eligibility.", + "type": "object", + "properties": { + "code": { + "description": "Indicates the reason for the ineligibility of the payment terms.", + "enum": [ + "Other", + "OverlappingPaymentTerms", + "InvalidDateFormat", + "InvalidDateRange", + "InactiveBillingAccount", + "InvalidBillingAccountType", + "NullOrEmptyPaymentTerms", + "BillingAccountNotFound", + "IneligibleBillingAccountStatus", + "InvalidTerms" + ], + "type": "string", + "x-ms-enum": { + "name": "PaymentTermsEligibilityCode", + "modelAsString": true + } + }, + "message": { + "description": "Indicates the message for the ineligibility of the payment terms.", + "type": "string" + } + } + }, + "PaymentTermsEligibilityResult": { + "description": "Result of the payment terms eligibility.", + "type": "object", + "properties": { + "eligibilityStatus": { + "description": "Indicates the eligibility status of the payment terms.", + "enum": [ + "Other", + "Valid", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "PaymentTermsEligibilityStatus", + "modelAsString": true + } + }, + "eligibilityDetails": { + "description": "Details of the payment terms eligibility.", + "type": "array", + "items": { + "$ref": "#/definitions/PaymentTermsEligibilityDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "RegistrationNumber": { + "description": "Describes the registration number of the organization linked with the billing account.", + "type": "object", + "properties": { + "id": { + "description": "The unique identification number of the organization linked with the billing account.", + "type": "string" + }, + "required": { + "description": "Identifies if the registration number is required for the billing account.", + "type": "boolean", + "readOnly": true + }, + "type": { + "description": "The types of registration number allowed based on the country of the billing account.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "TaxIdentifier": { + "description": "A tax identifier for the billing account.", + "type": "object", + "properties": { + "id": { + "description": "The id of the tax identifier.", + "type": "string" + }, + "type": { + "description": "The type of the tax identifier.", + "enum": [ + "Other", + "BrazilCcmId", + "BrazilCnpjId", + "BrazilCpfId", + "CanadianFederalExempt", + "CanadianProvinceExempt", + "ExternalTaxation", + "IndiaFederalTanId", + "IndiaFederalServiceTaxId", + "IndiaPanId", + "IndiaStateCstId", + "IndiaStateGstINId", + "IndiaStateVatId", + "IntlExempt", + "USExempt", + "VatId", + "LoveCode", + "MobileBarCode", + "NationalIdentificationNumber", + "PublicSectorId" + ], + "type": "string", + "x-ms-enum": { + "name": "TaxIdentifierType", + "modelAsString": true + } + }, + "scope": { + "description": "The scope of the tax identifier.", + "type": "string" + }, + "country": { + "description": "The country of the tax identifier.", + "type": "string" + }, + "status": { + "description": "The status of the tax identifier.", + "enum": [ + "Other", + "Valid", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "TaxIdentifierStatus", + "modelAsString": true + } + } + } + }, + "TransitionDetails": { + "description": "The details for a billing account transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.", + "type": "object", + "properties": { + "transitionDate": { + "format": "date-time", + "description": "The transition completion date.", + "type": "string", + "readOnly": true + }, + "anniversaryDay": { + "format": "int32", + "description": "The anniversary day of the pre-transitioned account of type Microsoft Online Services Program.", + "type": "integer", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingPermission.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingPermission.json new file mode 100644 index 000000000000..40ef0839c93c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingPermission.json @@ -0,0 +1,830 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermission" + ], + "description": "Lists the billing permissions the caller has on a billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of billingPermissions a caller has on a billing account.", + "schema": { + "$ref": "#/definitions/BillingPermissionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingPermissionsListByBillingAccount": { + "$ref": "./examples/billingPermissionsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermission" + ], + "description": "Lists the billing permissions the caller has on a billing profile.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of billingPermissions a caller has on a billing profile.", + "schema": { + "$ref": "#/definitions/BillingPermissionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingPermissionsListByBillingProfile": { + "$ref": "./examples/billingPermissionsListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/checkAccess": { + "post": { + "tags": [ + "BillingPermission" + ], + "description": "Provides a list of check access response objects for a billing profile.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_CheckAccessByBillingProfile", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The request object against which access of the caller will be checked.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAccessRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of check access response objects for a billing profile.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CheckAccessResponse" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckAccessByBillingProfile": { + "$ref": "./examples/checkAccessByBillingProfile.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermission" + ], + "description": "Lists the billing permissions the caller has for a customer.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_ListByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of billingPermissions a caller has on a customer.", + "schema": { + "$ref": "#/definitions/BillingPermissionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingPermissionsListByCustomer": { + "$ref": "./examples/billingPermissionsListByCustomer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/checkAccess": { + "post": { + "tags": [ + "BillingPermission" + ], + "description": "Provides a list of check access response objects for a customer.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_CheckAccessByCustomer", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The request object against which access of the caller will be checked.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAccessRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of check access response objects for a customer.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CheckAccessResponse" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckAccessByCustomer": { + "$ref": "./examples/checkAccessByCustomer.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermission" + ], + "description": "Lists the billing permissions the caller has for an invoice section.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_ListByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of billingPermissions a caller has on an invoice section.", + "schema": { + "$ref": "#/definitions/BillingPermissionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingPermissionsListByInvoiceSection": { + "$ref": "./examples/billingPermissionsListByInvoiceSection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/checkAccess": { + "post": { + "tags": [ + "BillingPermission" + ], + "description": "Provides a list of check access response objects for an invoice section.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_CheckAccessByInvoiceSection", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The request object against which access of the caller will be checked.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAccessRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of check access response objects for an invoice section.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CheckAccessResponse" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckAccessByInvoiceSection": { + "$ref": "./examples/checkAccessByInvoiceSection.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/checkAccess": { + "post": { + "tags": [ + "BillingPermission" + ], + "description": "Provides a list of check access response objects for a billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_CheckAccessByBillingAccount", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The request object against which access of the caller will be checked.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAccessRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of check access response objects for a billing account.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CheckAccessResponse" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckAccessByBillingAccount": { + "$ref": "./examples/checkAccessByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermission" + ], + "description": "Lists the billing permissions the caller has for a customer at billing account level.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_ListByCustomerAtBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of billingPermissions a caller has on a customer.", + "schema": { + "$ref": "#/definitions/BillingPermissionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingPermissionsListByCustomerAtBillingAccount": { + "$ref": "./examples/billingPermissionsListByCustomerAtBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermission" + ], + "description": "Lists the billing permissions the caller has for a department.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_ListByDepartment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of billingPermissions a caller has on a department.", + "schema": { + "$ref": "#/definitions/BillingPermissionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingPermissionsListByDepartment": { + "$ref": "./examples/billingPermissionsListByDepartment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/checkAccess": { + "post": { + "tags": [ + "BillingPermission" + ], + "description": "Provides a list of check access response objects for a department.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_CheckAccessByDepartment", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The request object against which access of the caller will be checked.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAccessRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of check access response objects for a department.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CheckAccessResponse" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckAccessByDepartment": { + "$ref": "./examples/checkAccessByDepartment.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermission" + ], + "description": "Lists the billing permissions the caller has for an enrollment account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_ListByEnrollmentAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of billingPermissions a caller has on an enrollment account.", + "schema": { + "$ref": "#/definitions/BillingPermissionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingPermissionsListByEnrollmentAccount": { + "$ref": "./examples/billingPermissionsListByEnrollmentAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/checkAccess": { + "post": { + "tags": [ + "BillingPermission" + ], + "description": "Provides a list of check access response objects for an enrollment account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingPermissions_CheckAccessByEnrollmentAccount", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The request object against which access of the caller will be checked.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAccessRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of check access response objects for an enrollment account.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CheckAccessResponse" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckAccessByEnrollmentAccount": { + "$ref": "./examples/checkAccessByEnrollmentAccount.json" + } + } + } + } + }, + "definitions": { + "BillingPermission": { + "description": "The set of allowed action and not allowed actions a caller has on a resource.", + "type": "object", + "properties": { + "actions": { + "description": "The set of actions that the caller is allowed to perform.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "notActions": { + "description": "The set of actions that the caller is not allowed to perform.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "readOnly": true + }, + "BillingPermissionListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingPermission" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "CheckAccessRequest": { + "description": "Request to check access.", + "type": "object", + "properties": { + "actions": { + "description": "List of actions passed in the request body against which the permissions will be checked.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "CheckAccessResponse": { + "description": "The properties of a check access response.", + "type": "object", + "properties": { + "accessDecision": { + "description": "Access Decision, specifies access is allowed or not.", + "enum": [ + "Other", + "Allowed", + "NotAllowed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AccessDecision", + "modelAsString": true + } + }, + "action": { + "description": "Gets or sets an action.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingProfile.json new file mode 100644 index 000000000000..6ae4572c384f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingProfile.json @@ -0,0 +1,737 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/validateDeleteEligibility": { + "post": { + "tags": [ + "BillingProfile" + ], + "description": "Validates if the billing profile can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingProfiles_ValidateDeleteEligibility", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Eligibility to delete a billing profile result.", + "schema": { + "$ref": "#/definitions/DeleteBillingProfileEligibilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingProfilesValidateDeleteEligibilitySuccess": { + "$ref": "./examples/billingProfilesValidateDeleteEligibilitySuccess.json" + }, + "BillingProfilesValidateDeleteEligibilityFailure": { + "$ref": "./examples/billingProfilesValidateDeleteEligibilityFailure.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}": { + "delete": { + "tags": [ + "BillingProfile" + ], + "description": "Deletes a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingProfiles_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "The request has succeeded with no response body." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingProfilesDelete": { + "$ref": "./examples/billingProfilesDelete.json" + } + } + }, + "get": { + "tags": [ + "BillingProfile" + ], + "description": "Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingProfiles_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A billing profile.", + "schema": { + "$ref": "#/definitions/BillingProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingProfilesGet": { + "$ref": "./examples/billingProfilesGet.json" + } + } + }, + "put": { + "tags": [ + "BillingProfile" + ], + "description": "Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement and Enterprise Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingProfiles_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A billing profile.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingProfile" + } + } + ], + "responses": { + "200": { + "description": "A billing profile.", + "schema": { + "$ref": "#/definitions/BillingProfile" + } + }, + "201": { + "description": "A billing profile.", + "schema": { + "$ref": "#/definitions/BillingProfile" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingProfilesCreateOrUpdate": { + "$ref": "./examples/billingProfilesCreateOrUpdate.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles": { + "get": { + "tags": [ + "BillingProfile" + ], + "description": "Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement of type Microsoft Customer Agreement and Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingProfiles_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "in": "query", + "name": "includeDeleted", + "description": "Can be used to get deleted billing profiles.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing profiles.", + "schema": { + "$ref": "#/definitions/BillingProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingProfilesListByBillingAccount": { + "$ref": "./examples/billingProfilesListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BillingProfile": { + "description": "A billing profile.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BillingProfileProperties" + } + }, + "x-ms-azure-resource": true + }, + "BillingProfileListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingProfile" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "BillingProfileProperties": { + "description": "A billing profile.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "billingRelationshipType": { + "description": "Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.", + "enum": [ + "Other", + "Direct", + "IndirectCustomer", + "IndirectPartner", + "CSPPartner", + "CSPCustomer" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingRelationshipType", + "modelAsString": true + } + }, + "billTo": { + "description": "Billing address.", + "allOf": [ + { + "$ref": "./types.json#/definitions/AddressDetails" + } + ] + }, + "currency": { + "description": "The currency in which the charges for the billing profile are billed.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The name of the billing profile.", + "type": "string" + }, + "enabledAzurePlans": { + "description": "Information about the enabled azure plans.", + "type": "array", + "items": { + "$ref": "./types.json#/definitions/AzurePlan" + }, + "x-ms-identifiers": [] + }, + "hasReadAccess": { + "description": "Indicates whether user has read access to the billing profile.", + "type": "boolean", + "readOnly": true + }, + "indirectRelationshipInfo": { + "description": "Identifies the billing profile that is linked to another billing profile in indirect purchase motion.", + "allOf": [ + { + "$ref": "./types.json#/definitions/IndirectRelationshipInfo" + } + ] + }, + "invoiceDay": { + "format": "int32", + "description": "The day of the month when the invoice for the billing profile is generated.", + "type": "integer", + "readOnly": true + }, + "invoiceEmailOptIn": { + "description": "Flag controlling whether the invoices for the billing profile are sent through email.", + "type": "boolean" + }, + "invoiceRecipients": { + "description": "The list of email addresses to receive invoices by email for the billing profile.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "poNumber": { + "description": "The default purchase order number that will appear on the invoices generated for the billing profile.", + "type": "string" + }, + "shipTo": { + "description": "The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used.", + "allOf": [ + { + "$ref": "./types.json#/definitions/AddressDetails" + } + ] + }, + "soldTo": { + "description": "The address of the individual or organization that is responsible for the billing account.", + "allOf": [ + { + "$ref": "./types.json#/definitions/AddressDetails" + } + ] + }, + "spendingLimit": { + "description": "The billing profile spending limit.", + "enum": [ + "Off", + "On" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SpendingLimit", + "modelAsString": true + } + }, + "spendingLimitDetails": { + "description": "The details of billing profile spending limit.", + "type": "array", + "items": { + "$ref": "#/definitions/SpendingLimitDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "status": { + "description": "The status of the billing profile.", + "enum": [ + "Other", + "Active", + "Disabled", + "Warned", + "Deleted", + "UnderReview" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatus", + "modelAsString": true + } + }, + "statusReasonCode": { + "description": "Reason for the specified billing profile status.", + "enum": [ + "Other", + "PastDue", + "UnusualActivity", + "SpendingLimitReached", + "SpendingLimitExpired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatusReasonCode", + "modelAsString": true + } + }, + "systemId": { + "description": "The system generated unique identifier for a billing profile.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetClouds": { + "description": "Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds.", + "type": "array", + "items": { + "description": "Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds.", + "enum": [ + "Other", + "Internal", + "USGov", + "USNat", + "USSec" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetCloud", + "modelAsString": true + } + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "currentPaymentTerm": { + "description": "The current payment term of the billing profile.", + "allOf": [ + { + "$ref": "#/definitions/PaymentTerm" + } + ] + }, + "otherPaymentTerms": { + "description": "The other payment terms of the billing profile.", + "type": "array", + "items": { + "$ref": "#/definitions/PaymentTerm" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "DeleteBillingProfileEligibilityDetail": { + "description": "Validation details of delete billing profile eligibility.", + "type": "object", + "properties": { + "code": { + "description": "Code of the delete invoice section eligibility response.", + "enum": [ + "None", + "ActiveCredits", + "ActiveCreditCard", + "LastBillingProfile", + "NotSupported", + "OutstandingCharges", + "PendingCharges", + "ReservedInstances", + "ActiveBillingSubscriptions" + ], + "type": "string", + "x-ms-enum": { + "name": "DeleteBillingProfileEligibilityCode", + "modelAsString": true + } + }, + "message": { + "description": "Validation message.", + "type": "string" + } + } + }, + "DeleteBillingProfileEligibilityResult": { + "description": "Eligibility to delete a billing profile result.", + "type": "object", + "properties": { + "eligibilityStatus": { + "description": "Status describing if billing profile is eligible to be deleted.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "DeleteBillingProfileEligibilityStatus", + "modelAsString": true + } + }, + "eligibilityDetails": { + "description": "Validation details of delete billing profile eligibility.", + "type": "array", + "items": { + "$ref": "#/definitions/DeleteBillingProfileEligibilityDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "PaymentTerm": { + "description": "The properties of payment term.", + "type": "object", + "properties": { + "term": { + "description": "Represents duration in netXX format. Always in days.", + "type": "string" + }, + "startDate": { + "format": "date-time", + "description": "The date on when the defined 'Payment Term' will be effective from and is always in UTC.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The date on when the defined 'Payment Term' will end and is always in UTC.", + "type": "string" + }, + "isDefault": { + "description": "Indicates payment term is the standard payment term.", + "type": "boolean", + "readOnly": true + } + } + }, + "SpendingLimitDetails": { + "description": "The billing profile spending limit.", + "type": "object", + "properties": { + "amount": { + "description": "The initial amount for the billing profile.", + "type": "number" + }, + "currency": { + "description": "The currency in which the charges for the billing profile are billed.", + "type": "string" + }, + "startDate": { + "format": "date-time", + "description": "The date when this spending limit goes into effect.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The date when this spending limit is no longer in effect.", + "type": "string" + }, + "type": { + "description": "The type of spending limit.", + "enum": [ + "Other", + "None", + "FreeAccount", + "Sandbox", + "AzureForStudents", + "AcademicSponsorship", + "AzureConsumptionCredit", + "AzurePassSponsorship", + "MpnSponsorship", + "MSDN", + "NonProfitSponsorship", + "Sponsorship", + "StartupSponsorship", + "AzureForStudentsStarter", + "VisualStudio" + ], + "type": "string", + "x-ms-enum": { + "name": "SpendingLimitType", + "modelAsString": true + } + }, + "status": { + "description": "The status of current spending limit.", + "enum": [ + "Other", + "None", + "Active", + "Expired", + "LimitReached", + "LimitRemoved" + ], + "type": "string", + "x-ms-enum": { + "name": "SpendingLimitStatus", + "modelAsString": true + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingProperty.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingProperty.json new file mode 100644 index 000000000000..1f9b8fda1c9b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingProperty.json @@ -0,0 +1,694 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default": { + "get": { + "tags": [ + "BillingProperty" + ], + "description": "Gets the billing properties for a subscription", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingProperty_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/subscriptionId" + }, + { + "in": "query", + "name": "includeBillingCountry", + "description": "A flag that specifies whether or not to include billing country.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includeTransitionStatus", + "description": "A flag that specifies whether or not to include transition status for billing accounts with agreement type Microsoft Customer Agreement.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A billing property.", + "schema": { + "$ref": "#/definitions/BillingProperty" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingPropertyGetMCA": { + "$ref": "./examples/billingPropertyGetMCA.json" + }, + "BillingPropertyGetMOSP": { + "$ref": "./examples/billingPropertyGetMOSP.json" + }, + "BillingPropertyGetMPA": { + "$ref": "./examples/billingPropertyGetMPA.json" + } + } + }, + "patch": { + "tags": [ + "BillingProperty" + ], + "description": "Updates the billing property of a subscription. Currently, cost center can be updated for billing accounts with agreement type Microsoft Customer Agreement and subscription service usage address can be updated for billing accounts with agreement type Microsoft Online Service Program.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingProperty_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/subscriptionId" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A billing property.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingProperty" + } + } + ], + "responses": { + "200": { + "description": "A billing property.", + "schema": { + "$ref": "#/definitions/BillingProperty" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingPropertyPatchCostCenter": { + "$ref": "./examples/billingPropertyPatchCostCenter.json" + }, + "BillingPropertyPatchSubscriptionServiceUsageAddress": { + "$ref": "./examples/billingPropertyPatchSubscriptionServiceUsageAddress.json" + } + } + } + } + }, + "definitions": { + "BillingProperty": { + "description": "A billing property.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BillingPropertyProperties" + } + }, + "x-ms-azure-resource": true + }, + "BillingPropertyProperties": { + "description": "A billing property.", + "type": "object", + "properties": { + "billingAccountAgreementType": { + "description": "The type of agreement.", + "enum": [ + "Other", + "MicrosoftCustomerAgreement", + "EnterpriseAgreement", + "MicrosoftOnlineServicesProgram", + "MicrosoftPartnerAgreement" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AgreementType", + "modelAsString": true + } + }, + "billingAccountDisplayName": { + "description": "The name of the billing account.", + "type": "string", + "readOnly": true + }, + "billingAccountId": { + "description": "The fully qualified ID that uniquely identifies a billing account.", + "type": "string", + "readOnly": true + }, + "accountAdminNotificationEmailAddress": { + "description": "Notification email address for legacy account. Available for agreement type Microsoft Online Services Program.", + "type": "string", + "readOnly": true + }, + "billingAccountSoldToCountry": { + "description": "The country of the individual or organization that is responsible for the billing account.", + "type": "string", + "readOnly": true + }, + "billingAccountStatus": { + "description": "The current status of the billing account.", + "enum": [ + "Other", + "Active", + "UnderReview", + "Disabled", + "Deleted", + "Extended", + "Pending", + "New", + "Expired", + "Terminated", + "Transferred" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": true + } + }, + "billingAccountStatusReasonCode": { + "description": "Reason for the specified billing account status.", + "enum": [ + "Other", + "UnusualActivity", + "ManuallyTerminated", + "Expired", + "Transferred", + "TerminateProcessing" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingAccountStatusReasonCode", + "modelAsString": true + } + }, + "billingAccountType": { + "description": "The type of customer.", + "enum": [ + "Other", + "Enterprise", + "Individual", + "Partner", + "Reseller", + "ClassicPartner", + "Internal", + "Tenant", + "Business" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AccountType", + "modelAsString": true + } + }, + "billingAccountSubType": { + "description": "The tier of the account.", + "enum": [ + "Other", + "None", + "Individual", + "Professional", + "Enterprise" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AccountSubType", + "modelAsString": true + } + }, + "billingCurrency": { + "description": "The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The fully qualified ID that uniquely identifies a billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileSpendingLimit": { + "description": "The billing profile spending limit.", + "enum": [ + "Off", + "On" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SpendingLimit", + "modelAsString": true + } + }, + "billingProfileSpendingLimitDetails": { + "description": "The details of billing profile spending limit.", + "type": "array", + "items": { + "$ref": "#/definitions/SpendingLimitDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "billingProfileStatus": { + "description": "The status of the billing profile.", + "enum": [ + "Other", + "Active", + "Disabled", + "Warned", + "Deleted", + "UnderReview" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatus", + "modelAsString": true + } + }, + "billingProfileStatusReasonCode": { + "description": "Reason for the specified billing profile status.", + "enum": [ + "Other", + "PastDue", + "UnusualActivity", + "SpendingLimitReached", + "SpendingLimitExpired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatusReasonCode", + "modelAsString": true + } + }, + "billingProfilePaymentMethodFamily": { + "description": "The payment method family of the primary payment method for the billing profile.", + "enum": [ + "Other", + "None", + "CreditCard", + "Credits", + "CheckWire", + "EWallet", + "TaskOrder", + "DirectDebit" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PaymentMethodFamily", + "modelAsString": true + } + }, + "billingProfilePaymentMethodType": { + "description": "The payment method type of the primary payment method for the billing profile.", + "type": "string", + "readOnly": true + }, + "billingTenantId": { + "description": "The Azure AD tenant ID of the billing account for the subscription.", + "type": "string", + "readOnly": true + }, + "costCenter": { + "description": "The cost center applied to the subscription. Available for agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch.", + "type": "string" + }, + "customerDisplayName": { + "description": "The name of the customer.", + "type": "string", + "readOnly": true + }, + "customerId": { + "description": "The fully qualified ID that uniquely identifies a customer.", + "type": "string", + "readOnly": true + }, + "customerStatus": { + "description": "Identifies the status of an customer. This is an upcoming property that will be populated in the future.", + "enum": [ + "Other", + "Active", + "Pending", + "Disabled", + "Warned", + "Deleted", + "UnderReview" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CustomerStatus", + "modelAsString": true + } + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "The fully qualified ID that uniquely identifies an invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionStatus": { + "description": "Identifies the status of an invoice section.", + "enum": [ + "Other", + "Active", + "Deleted", + "Disabled", + "UnderReview", + "Warned", + "Restricted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InvoiceSectionState", + "modelAsString": true + } + }, + "invoiceSectionStatusReasonCode": { + "description": "Reason for the specified invoice section status.", + "enum": [ + "Other", + "PastDue", + "UnusualActivity", + "SpendingLimitReached", + "SpendingLimitExpired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InvoiceSectionStateReasonCode", + "modelAsString": true + } + }, + "isTransitionedBillingAccount": { + "description": "Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned billing account.", + "type": "boolean", + "readOnly": true + }, + "skuDescription": { + "description": "The sku description.", + "type": "string", + "readOnly": true + }, + "skuId": { + "description": "The ID that uniquely identifies a sku.", + "type": "string", + "readOnly": true + }, + "subscriptionBillingStatus": { + "description": "The subscription status.", + "enum": [ + "Other", + "Unknown", + "Active", + "Disabled", + "Deleted", + "Warned", + "Expiring", + "Expired", + "AutoRenew", + "Cancelled", + "Suspended", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingSubscriptionStatus", + "modelAsString": true + } + }, + "subscriptionBillingStatusDetails": { + "description": "The reason codes for the subscription status.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingSubscriptionStatusDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "subscriptionBillingType": { + "description": "The type of billing subscription.", + "enum": [ + "None", + "Benefit", + "Free", + "Paid", + "PrePaid" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SubscriptionBillingType", + "modelAsString": true + } + }, + "subscriptionServiceUsageAddress": { + "description": "The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch.", + "allOf": [ + { + "$ref": "./types.json#/definitions/AddressDetails" + } + ] + }, + "subscriptionWorkloadType": { + "description": "The Azure workload type of the subscription.", + "enum": [ + "None", + "Production", + "DevTest", + "Internal" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SubscriptionWorkloadType", + "modelAsString": true + } + }, + "enrollmentDetails": { + "description": "The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.", + "allOf": [ + { + "$ref": "#/definitions/SubscriptionEnrollmentDetails" + } + ] + }, + "isAccountAdmin": { + "description": "Indicates whether user is the account admin.", + "type": "boolean", + "readOnly": true + }, + "productId": { + "description": "The ID that uniquely identifies a product.", + "type": "string", + "readOnly": true + }, + "productName": { + "description": "The ID that uniquely identifies a product.", + "type": "string", + "readOnly": true + } + } + }, + "BillingSubscriptionStatusDetails": { + "description": "The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.", + "type": "object", + "properties": { + "effectiveDate": { + "format": "date-time", + "description": "The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts.", + "type": "string", + "readOnly": true + }, + "reason": { + "description": "The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.", + "enum": [ + "None", + "Cancelled", + "PastDue", + "SuspiciousActivity", + "Other", + "Transferred", + "PolicyViolation", + "SpendingLimitReached", + "Expired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SubscriptionStatusReason", + "modelAsString": true + } + } + } + }, + "SpendingLimitDetails": { + "description": "The billing profile spending limit.", + "type": "object", + "properties": { + "amount": { + "description": "The initial amount for the billing profile.", + "type": "number" + }, + "currency": { + "description": "The currency in which the charges for the billing profile are billed.", + "type": "string" + }, + "startDate": { + "format": "date-time", + "description": "The date when this spending limit goes into effect.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "The date when this spending limit is no longer in effect.", + "type": "string" + }, + "type": { + "description": "The type of spending limit.", + "enum": [ + "Other", + "None", + "FreeAccount", + "Sandbox", + "AzureForStudents", + "AcademicSponsorship", + "AzureConsumptionCredit", + "AzurePassSponsorship", + "MpnSponsorship", + "MSDN", + "NonProfitSponsorship", + "Sponsorship", + "StartupSponsorship", + "AzureForStudentsStarter", + "VisualStudio" + ], + "type": "string", + "x-ms-enum": { + "name": "SpendingLimitType", + "modelAsString": true + } + }, + "status": { + "description": "The status of current spending limit.", + "enum": [ + "Other", + "None", + "Active", + "Expired", + "LimitReached", + "LimitRemoved" + ], + "type": "string", + "x-ms-enum": { + "name": "SpendingLimitStatus", + "modelAsString": true + } + } + } + }, + "SubscriptionEnrollmentDetails": { + "description": "The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.", + "type": "object", + "properties": { + "departmentDisplayName": { + "description": "The name of the department", + "type": "string" + }, + "departmentId": { + "description": "The ID that uniquely identifies the department.", + "type": "string" + }, + "enrollmentAccountStatus": { + "description": "The status of the enrollment account.", + "type": "string" + }, + "enrollmentAccountDisplayName": { + "description": "The name of the enrollment account.", + "type": "string" + }, + "enrollmentAccountId": { + "description": "The ID that uniquely identifies an enrollment account.", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRequest.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRequest.json new file mode 100644 index 000000000000..cbae8bca1ac8 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRequest.json @@ -0,0 +1,751 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRequests": { + "get": { + "tags": [ + "BillingRequest" + ], + "description": "The list of billing requests submitted for the billing profile.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRequests_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing requests.", + "schema": { + "$ref": "#/definitions/BillingRequestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRequestsListByBillingProfile": { + "$ref": "./examples/billingRequestsListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRequests": { + "get": { + "tags": [ + "BillingRequest" + ], + "description": "The list of billing requests submitted for the customer.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRequests_ListByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing requests.", + "schema": { + "$ref": "#/definitions/BillingRequestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRequestsListByCustomer": { + "$ref": "./examples/billingRequestsListByCustomer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRequests": { + "get": { + "tags": [ + "BillingRequest" + ], + "description": "The list of billing requests submitted for the invoice section.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRequests_ListByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing requests.", + "schema": { + "$ref": "#/definitions/BillingRequestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRequestsListByInvoiceSection": { + "$ref": "./examples/billingRequestsListByInvoiceSection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRequests": { + "get": { + "tags": [ + "BillingRequest" + ], + "description": "The list of billing requests submitted for the billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRequests_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing requests.", + "schema": { + "$ref": "#/definitions/BillingRequestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRequestsListByBillingAccount": { + "$ref": "./examples/billingRequestsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingRequests/{billingRequestName}": { + "get": { + "tags": [ + "BillingRequest" + ], + "description": "Gets a billing request by its ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRequests_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingRequestName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", + "schema": { + "$ref": "#/definitions/BillingRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRequestsGet": { + "$ref": "./examples/billingRequestsGet.json" + } + } + }, + "put": { + "tags": [ + "BillingRequest" + ], + "description": "Create or update a billing request.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRequests_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingRequestName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingRequest" + } + } + ], + "responses": { + "200": { + "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", + "schema": { + "$ref": "#/definitions/BillingRequest" + } + }, + "201": { + "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", + "schema": { + "$ref": "#/definitions/BillingRequest" + }, + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingRequestsCreateOrUpdate": { + "$ref": "./examples/billingRequestsCreateOrUpdate.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingRequests": { + "get": { + "tags": [ + "BillingRequest" + ], + "description": "The list of billing requests submitted by a user.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRequests_ListByUser", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing requests.", + "schema": { + "$ref": "#/definitions/BillingRequestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRequestsListByUser": { + "$ref": "./examples/billingRequestsListByUser.json" + }, + "BillingRequestsListByUserWithFilter": { + "$ref": "./examples/billingRequestsListByUserWithFilter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BillingRequest": { + "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BillingRequestProperties" + } + }, + "x-ms-azure-resource": true + }, + "BillingRequestListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingRequest" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "BillingRequestProperties": { + "description": "A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "additionalInformation": { + "description": "Additional information for the billing request.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "reviewedBy": { + "description": "The principal of the request reviewer. Will only be set if request is approved.", + "allOf": [ + { + "$ref": "#/definitions/Principal" + } + ] + }, + "reviewalDate": { + "format": "date-time", + "description": "The date and time when the request was reviewed.", + "type": "string", + "readOnly": true + }, + "billingAccountId": { + "description": "The fully qualified ID that uniquely identifies a billing account.", + "type": "string", + "readOnly": true + }, + "billingAccountName": { + "description": "The ID that uniquely identifies a billing account.", + "type": "string", + "readOnly": true + }, + "billingAccountDisplayName": { + "description": "The name of the billing account.", + "type": "string", + "readOnly": true + }, + "billingAccountPrimaryBillingTenantId": { + "description": "The primary tenant ID of the billing account for which the billing request was submitted.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The fully qualified ID that uniquely identifies a billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileName": { + "description": "The ID that uniquely identifies a billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile.", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "The principal of the entity who created the request.", + "allOf": [ + { + "$ref": "#/definitions/Principal" + } + ] + }, + "creationDate": { + "format": "date-time", + "description": "The date and time when the request was created.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "format": "date-time", + "description": "The date and time when the request expires.", + "type": "string", + "readOnly": true + }, + "decisionReason": { + "description": "The reason to approve or decline the request.", + "type": "string" + }, + "invoiceSectionId": { + "description": "The fully qualified ID that uniquely identifies an invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionName": { + "description": "The ID that uniquely identifies an invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section.", + "type": "string", + "readOnly": true + }, + "customerId": { + "description": "The fully qualified ID that uniquely identifies a customer.", + "type": "string", + "readOnly": true + }, + "customerName": { + "description": "The ID that uniquely identifies a customer.", + "type": "string", + "readOnly": true + }, + "customerDisplayName": { + "description": "The name of the customer.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "The fully qualified ID that uniquely identifies a billing subscription.", + "type": "string", + "readOnly": true + }, + "subscriptionName": { + "description": "The ID that uniquely identifies a billing subscription.", + "type": "string", + "readOnly": true + }, + "subscriptionDisplayName": { + "description": "The name of the billing subscription.", + "type": "string", + "readOnly": true + }, + "justification": { + "description": "Justification for submitting request.", + "type": "string" + }, + "recipients": { + "description": "The recipients of the billing request.", + "type": "array", + "items": { + "$ref": "#/definitions/Principal" + }, + "x-ms-identifiers": [] + }, + "requestScope": { + "description": "The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}').", + "type": "string" + }, + "billingScope": { + "description": "The billing scope for which the request will be applied. This is a read only property derived by the service.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of billing request.", + "enum": [ + "Other", + "Pending", + "Approved", + "Declined", + "Cancelled", + "Completed", + "Expired" + ], + "type": "string", + "x-ms-enum": { + "name": "BillingRequestStatus", + "modelAsString": true + } + }, + "type": { + "description": "Type of billing request.", + "enum": [ + "Other", + "InvoiceAccess", + "ProvisioningAccess", + "RoleAssignment", + "UpdateBillingPolicy" + ], + "type": "string", + "x-ms-enum": { + "name": "BillingRequestType", + "modelAsString": true + } + }, + "lastUpdatedBy": { + "description": "The principal of the entity who last updated the request.", + "allOf": [ + { + "$ref": "#/definitions/Principal" + } + ] + }, + "lastUpdatedDate": { + "format": "date-time", + "description": "Date and time of last update.", + "type": "string", + "readOnly": true + } + } + }, + "Principal": { + "description": "A principal who has interacted with a billing entity.", + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant id of the principal who has interacted with a billing entity.", + "type": "string" + }, + "objectId": { + "description": "The object id of the principal who has interacted with a billing entity.", + "type": "string" + }, + "upn": { + "description": "The user principal name of the principal who has interacted with a billing entity.", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRoleAssignment.json new file mode 100644 index 000000000000..8f0211bf1a08 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRoleAssignment.json @@ -0,0 +1,1953 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "delete": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Deletes a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_DeleteByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "The request has succeeded with no response body." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentDeleteByBillingProfile": { + "$ref": "./examples/billingRoleAssignmentDeleteByBillingProfile.json" + } + } + }, + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_GetByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentGetByBillingProfile": { + "$ref": "./examples/billingRoleAssignmentGetByBillingProfile.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentListByBillingProfile": { + "$ref": "./examples/billingRoleAssignmentListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/createBillingRoleAssignment": { + "post": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Adds a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_CreateByBillingProfile", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of the billing role assignment.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentProperties" + } + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "202": { + "description": "The properties of the billing role assignment.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingRoleAssignmentCreateByBillingProfile": { + "$ref": "./examples/billingRoleAssignmentCreateByBillingProfile.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "delete": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Deletes a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_DeleteByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "The request has succeeded with no response body." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentDeleteByCustomer": { + "$ref": "./examples/billingRoleAssignmentDeleteByCustomer.json" + } + } + }, + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Gets a role assignment for the caller on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_GetByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentGetByCustomer": { + "$ref": "./examples/billingRoleAssignmentGetByCustomer.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ListByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentListByCustomer": { + "$ref": "./examples/billingRoleAssignmentListByCustomer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/createBillingRoleAssignment": { + "post": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Adds a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_CreateByCustomer", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of the billing role assignment.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentProperties" + } + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "202": { + "description": "The properties of the billing role assignment.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingRoleAssignmentCreateByCustomer": { + "$ref": "./examples/billingRoleAssignmentCreateByCustomer.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/resolveBillingRoleAssignments": { + "post": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on a customer while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ResolveByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "in": "query", + "name": "resolveScopeDisplayNames", + "description": "Resolves the scope display name for each of the role assignments.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "202": { + "description": "The list of the billing role assignments.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ResolveBillingRoleAssignmentByCustomer": { + "$ref": "./examples/resolveBillingRoleAssignmentByCustomer.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "delete": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Deletes a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_DeleteByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "The request has succeeded with no response body." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentDeleteByInvoiceSection": { + "$ref": "./examples/billingRoleAssignmentDeleteByInvoiceSection.json" + } + } + }, + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_GetByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentGetByInvoiceSection": { + "$ref": "./examples/billingRoleAssignmentGetByInvoiceSection.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ListByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentListByInvoiceSection": { + "$ref": "./examples/billingRoleAssignmentListByInvoiceSection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/createBillingRoleAssignment": { + "post": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_CreateByInvoiceSection", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of the billing role assignment.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentProperties" + } + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "202": { + "description": "The properties of the billing role assignment.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingRoleAssignmentCreateByInvoiceSection": { + "$ref": "./examples/billingRoleAssignmentCreateByInvoiceSection.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/resolveBillingRoleAssignments": { + "post": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on an invoice section while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ResolveByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "in": "query", + "name": "resolveScopeDisplayNames", + "description": "Resolves the scope display name for each of the role assignments.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "202": { + "description": "The list of the billing role assignments.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ResolveBillingRoleAssignmentByInvoiceSection": { + "$ref": "./examples/resolveBillingRoleAssignmentByInvoiceSection.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/resolveBillingRoleAssignments": { + "post": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on an billing profile while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ResolveByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "in": "query", + "name": "resolveScopeDisplayNames", + "description": "Resolves the scope display name for each of the role assignments.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "202": { + "description": "The list of the billing role assignments.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ResolveBillingRoleAssignmentByBillingProfile": { + "$ref": "./examples/resolveBillingRoleAssignmentByBillingProfile.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "delete": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Deletes a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_DeleteByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "The request has succeeded with no response body." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentDeleteByBillingAccount": { + "$ref": "./examples/billingRoleAssignmentDeleteByBillingAccount.json" + } + } + }, + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_GetByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentGetByBillingAccount": { + "$ref": "./examples/billingRoleAssignmentGetByBillingAccount.json" + } + } + }, + "put": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_CreateOrUpdateByBillingAccount", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of the billing role assignment.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "201": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + }, + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BillingRoleAssignmentCreateOrUpdateByBillingAccount": { + "$ref": "./examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentListByBillingAccount": { + "$ref": "./examples/billingRoleAssignmentListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/createBillingRoleAssignment": { + "post": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_CreateByBillingAccount", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of the billing role assignment.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentProperties" + } + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "202": { + "description": "The properties of the billing role assignment.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingRoleAssignmentCreateByBillingAccount": { + "$ref": "./examples/billingRoleAssignmentCreateByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "delete": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Deletes a role assignment on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_DeleteByDepartment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "The request has succeeded with no response body." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentDeleteByDepartment": { + "$ref": "./examples/billingRoleAssignmentDeleteByDepartment.json" + } + } + }, + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Gets a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_GetByDepartment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentGetByDepartment": { + "$ref": "./examples/billingRoleAssignmentGetByDepartment.json" + } + } + }, + "put": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_CreateOrUpdateByDepartment", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of the billing role assignment.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "201": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + }, + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BillingRoleAssignmentCreateOrUpdateByDepartment": { + "$ref": "./examples/billingRoleAssignmentCreateOrUpdateByDepartment.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on a department. The operation is supported for billing accounts of type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ListByDepartment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentListByDepartment": { + "$ref": "./examples/billingRoleAssignmentListByDepartment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "delete": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Deletes a role assignment on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_DeleteByEnrollmentAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "The request has succeeded with no response body." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentDeleteByEnrollmentAccount": { + "$ref": "./examples/billingRoleAssignmentDeleteByEnrollmentAccount.json" + } + } + }, + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Gets a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_GetByEnrollmentAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentGetByEnrollmentAccount": { + "$ref": "./examples/billingRoleAssignmentGetByEnrollmentAccount.json" + } + } + }, + "put": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_CreateOrUpdateByEnrollmentAccount", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/billingRoleAssignmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of the billing role assignment.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + } + ], + "responses": { + "200": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "201": { + "description": "The properties of the billing role assignment.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + }, + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BillingRoleAssignmentCreateOrUpdateByEnrollmentAccount": { + "$ref": "./examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ListByEnrollmentAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleAssignmentListByEnrollmentAccount": { + "$ref": "./examples/billingRoleAssignmentListByEnrollmentAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/resolveBillingRoleAssignments": { + "post": { + "tags": [ + "BillingRoleAssignment" + ], + "description": "Lists the role assignments for the caller on a billing account while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleAssignments_ResolveByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "in": "query", + "name": "resolveScopeDisplayNames", + "description": "Resolves the scope display name for each of the role assignments.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + } + ], + "responses": { + "200": { + "description": "The list of the billing role assignments.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "202": { + "description": "The list of the billing role assignments.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ResolveBillingRoleAssignmentByBillingAccount": { + "$ref": "./examples/resolveBillingRoleAssignmentByBillingAccount.json" + } + } + } + } + }, + "definitions": { + "BillingRoleAssignment": { + "description": "The properties of the billing role assignment.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BillingRoleAssignmentProperties" + } + }, + "x-ms-azure-resource": true + }, + "BillingRoleAssignmentListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingRoleAssignment" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "BillingRoleAssignmentProperties": { + "description": "The properties of the billing role assignment.", + "required": [ + "roleDefinitionId" + ], + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "createdOn": { + "format": "date-time", + "description": "The date the role assignment was created.", + "type": "string", + "readOnly": true + }, + "createdByPrincipalTenantId": { + "description": "The tenant Id of the user who created the role assignment.", + "type": "string", + "readOnly": true + }, + "createdByPrincipalId": { + "description": "The object ID of the user who created the role assignment.", + "type": "string", + "readOnly": true + }, + "createdByPrincipalPuid": { + "description": "The principal PUID of the user who created the role assignment.", + "type": "string", + "readOnly": true + }, + "createdByUserEmailAddress": { + "description": "The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.", + "type": "string", + "readOnly": true + }, + "modifiedOn": { + "format": "date-time", + "description": "The date the role assignment was modified.", + "type": "string", + "readOnly": true + }, + "modifiedByPrincipalPuid": { + "description": "The principal PUID of the user who modified the role assignment.", + "type": "string", + "readOnly": true + }, + "modifiedByUserEmailAddress": { + "description": "The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.", + "type": "string", + "readOnly": true + }, + "modifiedByPrincipalId": { + "description": "The principal PUID of the user who modified the role assignment.", + "type": "string", + "readOnly": true + }, + "modifiedByPrincipalTenantId": { + "description": "The tenant Id of the user who modified the role assignment.", + "type": "string", + "readOnly": true + }, + "principalPuid": { + "description": "The principal PUID of the user to whom the role was assigned.", + "type": "string" + }, + "principalId": { + "description": "The object id of the user to whom the role was assigned.", + "type": "string" + }, + "principalTenantId": { + "description": "The principal tenant id of the user to whom the role was assigned.", + "type": "string" + }, + "roleDefinitionId": { + "description": "The ID of the role definition.", + "minLength": 1, + "type": "string" + }, + "scope": { + "description": "The scope at which the role was assigned.", + "type": "string" + }, + "userAuthenticationType": { + "description": "The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.", + "type": "string" + }, + "userEmailAddress": { + "description": "The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.", + "type": "string" + }, + "principalTenantName": { + "description": "The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account.", + "type": "string", + "readOnly": true + }, + "principalDisplayName": { + "description": "The display name of the principal to whom the role was assigned.", + "type": "string", + "readOnly": true + }, + "principalType": { + "description": "The type of a role Assignment.", + "enum": [ + "Unknown", + "None", + "User", + "Group", + "DirectoryRole", + "ServicePrincipal", + "Everyone" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + } + }, + "billingRequestId": { + "description": "The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request.", + "type": "string", + "readOnly": true + }, + "billingAccountId": { + "description": "The fully qualified ID that uniquely identifies a billing account.", + "type": "string", + "readOnly": true + }, + "billingAccountDisplayName": { + "description": "The name of the billing account.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The fully qualified ID that uniquely identifies a billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile.", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "The fully qualified ID that uniquely identifies an invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section.", + "type": "string", + "readOnly": true + }, + "customerId": { + "description": "The fully qualified ID that uniquely identifies a customer.", + "type": "string", + "readOnly": true + }, + "customerDisplayName": { + "description": "The name of the customer.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRoleDefinition.json new file mode 100644 index 000000000000..98260d12b7a2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingRoleDefinition.json @@ -0,0 +1,710 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{roleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_GetByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/roleDefinitionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of a role definition.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionGetByBillingProfile": { + "$ref": "./examples/billingRoleDefinitionGetByBillingProfile.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of role definitions.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionListByBillingProfile": { + "$ref": "./examples/billingRoleDefinitionListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleDefinitions/{roleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Gets the definition for a role on a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_GetByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/roleDefinitionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of a role definition.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionGetByCustomer": { + "$ref": "./examples/billingRoleDefinitionGetByCustomer.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Lists the role definitions for a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_ListByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of role definitions.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionListByCustomer": { + "$ref": "./examples/billingRoleDefinitionListByCustomer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{roleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_GetByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/roleDefinitionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of a role definition.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionGetByInvoiceSection": { + "$ref": "./examples/billingRoleDefinitionGetByInvoiceSection.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_ListByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of role definitions.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionListByInvoiceSection": { + "$ref": "./examples/billingRoleDefinitionListByInvoiceSection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{roleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_GetByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/roleDefinitionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of a role definition.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionGetByBillingAccount": { + "$ref": "./examples/billingRoleDefinitionGetByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of role definitions.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionListByBillingAccount": { + "$ref": "./examples/billingRoleDefinitionListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions/{roleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Gets the definition for a role on a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_GetByDepartment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/roleDefinitionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of a role definition.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionGetByDepartment": { + "$ref": "./examples/billingRoleDefinitionGetByDepartment.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_ListByDepartment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of a role definition.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionListByDepartment": { + "$ref": "./examples/billingRoleDefinitionListByDepartment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions/{roleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "Gets the definition for a role on an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_GetByEnrollmentAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/roleDefinitionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of a role definition.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionGetByEnrollmentAccount": { + "$ref": "./examples/billingRoleDefinitionGetByEnrollmentAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinition" + ], + "description": "List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingRoleDefinition_ListByEnrollmentAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of role definitions.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingRoleDefinitionListByEnrollmentAccount": { + "$ref": "./examples/billingRoleDefinitionListByEnrollmentAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BillingPermission": { + "description": "The set of allowed action and not allowed actions a caller has on a resource.", + "type": "object", + "properties": { + "actions": { + "description": "The set of actions that the caller is allowed to perform.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "notActions": { + "description": "The set of actions that the caller is not allowed to perform.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "readOnly": true + }, + "BillingRoleDefinition": { + "description": "The properties of a role definition.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BillingRoleDefinitionProperties" + } + }, + "x-ms-azure-resource": true + }, + "BillingRoleDefinitionListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingRoleDefinition" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "BillingRoleDefinitionProperties": { + "description": "The properties of a role definition.", + "required": [ + "roleName" + ], + "type": "object", + "properties": { + "description": { + "description": "The role description.", + "type": "string", + "readOnly": true + }, + "permissions": { + "description": "The billingPermissions the role has.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingPermission" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "roleName": { + "description": "The name of the role.", + "minLength": 1, + "type": "string" + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSavingsPlan.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSavingsPlan.json new file mode 100644 index 000000000000..caa2a952f25f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSavingsPlan.json @@ -0,0 +1,1272 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "BillingManagementClient", + "description": "Billing client provides access to billing resources for Azure subscriptions." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}": { + "get": { + "description": "Get a savings plan order by billing account.", + "operationId": "SavingsPlanOrders_GetByBillingAccount", + "tags": [ + "Savings plan order" + ], + "x-ms-examples": { + "SavingsPlanOrderGet": { + "$ref": "./examples/savingsPlanOrderGetByBillingAccount.json" + }, + "SavingsPlanOrderWithExpandedPaymentsGet": { + "$ref": "./examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "#/parameters/SavingsPlanOrderIdParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The request is completed.", + "schema": { + "$ref": "#/definitions/SavingsPlanOrderModel" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders": { + "get": { + "description": "List all Savings plan orders by billing account.", + "operationId": "SavingsPlanOrders_ListByBillingAccount", + "tags": [ + "Savings plan order" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SavingsPlanOrderList": { + "$ref": "./examples/savingsPlanOrderListByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "The request is completed.", + "schema": { + "$ref": "#/definitions/SavingsPlanOrderModelList" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans": { + "get": { + "description": "List savings plans in an order by billing account.", + "operationId": "SavingsPlans_ListBySavingsPlanOrder", + "tags": [ + "Savings plan" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SavingsPlansInOrderList": { + "$ref": "./examples/savingsPlansListBySavingsPlanOrders.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "#/parameters/SavingsPlanOrderIdParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request is completed.", + "schema": { + "$ref": "#/definitions/SavingsPlanModelList" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans": { + "get": { + "description": "List savings plans by billing account.", + "operationId": "SavingsPlans_ListByBillingAccount", + "tags": [ + "Savings plan" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SavingsPlansList": { + "$ref": "./examples/savingsPlansListByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + }, + { + "$ref": "#/parameters/TakeParameter" + }, + { + "$ref": "#/parameters/SelectedStateParameter" + }, + { + "$ref": "#/parameters/RefreshSummaryParameter" + } + ], + "responses": { + "200": { + "description": "The request is completed.", + "schema": { + "$ref": "#/definitions/SavingsPlanModelListResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}": { + "get": { + "description": "Get savings plan by billing account.", + "operationId": "SavingsPlans_GetByBillingAccount", + "tags": [ + "Savings plan" + ], + "x-ms-examples": { + "SavingsPlanGet": { + "$ref": "./examples/savingsPlanGetByBillingAccount.json" + }, + "SavingsPlanGetExpandRenewProperties": { + "$ref": "./examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "#/parameters/SavingsPlanOrderIdParameter" + }, + { + "$ref": "#/parameters/SavingsPlanIdParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The request is completed.", + "schema": { + "$ref": "#/definitions/SavingsPlanModel" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "description": "Update savings plan by billing account.", + "operationId": "SavingsPlans_UpdateByBillingAccount", + "tags": [ + "Savings plan" + ], + "x-ms-examples": { + "SavingsPlanUpdate": { + "$ref": "./examples/savingsPlanUpdateByBillingAccount.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "#/parameters/SavingsPlanOrderIdParameter" + }, + { + "$ref": "#/parameters/SavingsPlanIdParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/SavingsPlanUpdateRequestParameter" + } + ], + "responses": { + "200": { + "description": "The request is completed.", + "schema": { + "$ref": "#/definitions/SavingsPlanModel" + } + }, + "202": { + "description": "The request is accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URL for checking the ongoing status of the operation." + }, + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "Clients should wait for the Retry-After interval before polling again" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/validate": { + "post": { + "description": "Validate savings plan patch by billing account.", + "operationId": "SavingsPlans_ValidateUpdateByBillingAccount", + "tags": [ + "Savings plan" + ], + "x-ms-examples": { + "SavingsPlanValidateUpdate": { + "$ref": "./examples/savingsPlanValidateUpdateByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "#/parameters/SavingsPlanOrderIdParameter" + }, + { + "$ref": "#/parameters/SavingsPlanIdParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/SavingsPlanUpdateValidateRequestParameter" + } + ], + "responses": { + "200": { + "description": "The request is completed.", + "schema": { + "$ref": "#/definitions/SavingsPlanValidateResponse" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Sku": { + "type": "object", + "description": "The SKU to be applied for this resource", + "properties": { + "name": { + "type": "string", + "description": "Name of the SKU to be applied" + } + } + }, + "BillingScopeId": { + "type": "string", + "description": "Subscription that will be charged for purchasing SavingsPlan" + }, + "BillingProfileId": { + "type": "string", + "readOnly": true, + "description": "Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers." + }, + "CustomerId": { + "type": "string", + "readOnly": true, + "description": "Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers." + }, + "BillingAccountId": { + "type": "string", + "readOnly": true, + "description": "Fully-qualified identifier of the billing account where the savings plan is applied." + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state", + "readOnly": true, + "enum": [ + "PendingBilling", + "ConfirmedBilling", + "Creating", + "Failed", + "Created", + "Succeeded", + "Canceled", + "Expired" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "BillingPlan": { + "type": "string", + "description": "Represents the billing plan in ISO 8601 format. Required only for monthly purchases.", + "enum": [ + "P1M" + ], + "x-ms-enum": { + "name": "BillingPlan", + "modelAsString": true + } + }, + "Renew": { + "type": "boolean", + "default": false, + "description": "Setting this to true will automatically purchase a new benefit on the expiration date time." + }, + "BenefitTerm": { + "type": "string", + "description": "Represents the Savings plan term in ISO 8601 format.", + "enum": [ + "P1Y", + "P3Y", + "P5Y" + ], + "x-ms-enum": { + "name": "SavingsPlanTerm", + "modelAsString": true + } + }, + "DisplayName": { + "type": "string", + "description": "Display name" + }, + "AppliedScopeType": { + "type": "string", + "description": "Type of the Applied Scope.", + "enum": [ + "Single", + "Shared", + "ManagementGroup" + ], + "x-ms-enum": { + "name": "AppliedScopeType", + "modelAsString": true + } + }, + "AppliedScopeProperties": { + "type": "object", + "description": "Properties specific to applied scope type. Not required if not applicable.", + "properties": { + "tenantId": { + "$ref": "#/definitions/TenantId" + }, + "managementGroupId": { + "$ref": "#/definitions/ManagementGroupId" + }, + "subscriptionId": { + "$ref": "#/definitions/SubscriptionId" + }, + "resourceGroupId": { + "$ref": "#/definitions/ResourceGroupId" + }, + "displayName": { + "type": "string", + "description": "Display name" + } + } + }, + "TenantId": { + "type": "string", + "description": "Tenant ID where the savings plan where the benefit is applied." + }, + "ManagementGroupId": { + "type": "string", + "description": "Fully-qualified identifier of the management group where the benefit is applied." + }, + "SubscriptionId": { + "type": "string", + "description": "Fully-qualified identifier of the subscription where the benefit is applied." + }, + "ResourceGroupId": { + "type": "string", + "description": "Fully-qualified identifier of the resource group where the benefit is applied." + }, + "Commitment": { + "type": "object", + "description": "Commitment towards the benefit.", + "allOf": [ + { + "$ref": "#/definitions/Price" + } + ], + "properties": { + "grain": { + "type": "string", + "description": "Commitment grain.", + "enum": [ + "Hourly" + ], + "x-ms-enum": { + "name": "CommitmentGrain", + "modelAsString": true + } + } + } + }, + "SavingsPlanId": { + "type": "string", + "description": "Identifier of the savings plan", + "readOnly": true + }, + "ExpiryDate": { + "type": "string", + "description": "Date when the Order is expected to expire", + "readOnly": true, + "format": "date" + }, + "SavingsPlanModelList": { + "type": "object", + "description": "List of savings plans", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SavingsPlanModel" + } + }, + "nextLink": { + "type": "string", + "description": "Url to get the next page." + } + } + }, + "SavingsPlanModelListResult": { + "type": "object", + "description": "List of savings plans", + "allOf": [ + { + "$ref": "#/definitions/SavingsPlanModelList" + } + ], + "properties": { + "summary": { + "description": "The roll out count summary of the savings plans", + "$ref": "#/definitions/SavingsPlanSummaryCount" + } + } + }, + "SavingsPlanModel": { + "type": "object", + "description": "Savings plan", + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "sku": { + "description": "Savings plan SKU", + "$ref": "#/definitions/Sku" + }, + "tags": { + "description": "Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "Savings plan properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SavingsPlanModelProperties" + } + } + }, + "SavingsPlanModelProperties": { + "type": "object", + "description": "Savings plan properties", + "properties": { + "displayName": { + "$ref": "#/definitions/DisplayName" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "displayProvisioningState": { + "description": "The provisioning state of the savings plan for display, e.g. Succeeded", + "type": "string", + "readOnly": true + }, + "userFriendlyAppliedScopeType": { + "description": "The applied scope type of the savings plan for display, e.g. Shared", + "type": "string", + "readOnly": true + }, + "billingScopeId": { + "$ref": "#/definitions/BillingScopeId" + }, + "billingProfileId": { + "$ref": "#/definitions/BillingProfileId" + }, + "customerId": { + "$ref": "#/definitions/CustomerId" + }, + "billingAccountId": { + "$ref": "#/definitions/BillingAccountId" + }, + "term": { + "$ref": "#/definitions/BenefitTerm" + }, + "renew": { + "$ref": "#/definitions/Renew" + }, + "renewSource": { + "$ref": "#/definitions/RenewSource" + }, + "renewDestination": { + "$ref": "#/definitions/RenewDestination" + }, + "renewProperties": { + "$ref": "#/definitions/RenewProperties" + }, + "billingPlan": { + "$ref": "#/definitions/BillingPlan" + }, + "expiryDate": { + "$ref": "#/definitions/ExpiryDate" + }, + "appliedScopeType": { + "$ref": "#/definitions/AppliedScopeType" + }, + "appliedScopeProperties": { + "$ref": "#/definitions/AppliedScopeProperties" + }, + "commitment": { + "$ref": "#/definitions/Commitment" + }, + "effectiveDateTime": { + "type": "string", + "format": "date-time", + "description": "DateTime of the savings plan starting when this version is effective from.", + "readOnly": true + }, + "benefitStartTime": { + "type": "string", + "format": "date-time", + "description": "This is the DateTime when the savings plan benefit starts.", + "readOnly": true + }, + "expiryDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the date-time when the savings plan will expire.", + "readOnly": true + }, + "purchaseDateTime": { + "type": "string", + "format": "date-time", + "description": "Date time when the savings plan was purchased.", + "readOnly": true + }, + "utilization": { + "$ref": "#/definitions/Utilization" + }, + "extendedStatusInfo": { + "$ref": "#/definitions/ExtendedStatusInfo" + }, + "productCode": { + "$ref": "#/definitions/ProductCode" + } + } + }, + "SavingsPlanSummaryCount": { + "description": "The roll up count summary of savings plans in each state", + "type": "object", + "properties": { + "succeededCount": { + "description": "The number of savings plans in Succeeded state", + "readOnly": true, + "type": "number" + }, + "failedCount": { + "description": "The number of savings plans in Failed state", + "readOnly": true, + "type": "number" + }, + "expiringCount": { + "description": "The number of savings plans in Expiring state", + "readOnly": true, + "type": "number" + }, + "expiredCount": { + "description": "The number of savings plans in Expired state", + "readOnly": true, + "type": "number" + }, + "pendingCount": { + "description": "The number of savings plans in Pending state", + "readOnly": true, + "type": "number" + }, + "cancelledCount": { + "description": "The number of savings plans in Cancelled state", + "readOnly": true, + "type": "number" + }, + "processingCount": { + "description": "The number of savings plans in Processing state", + "readOnly": true, + "type": "number" + }, + "noBenefitCount": { + "description": "The number of savings plans in No Benefit state", + "readOnly": true, + "type": "number" + }, + "warningCount": { + "description": "The number of savings plans in Warning state", + "readOnly": true, + "type": "number" + } + } + }, + "SavingsPlanOrderModelList": { + "type": "object", + "description": "List of savings plan orders", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SavingsPlanOrderModel" + } + }, + "nextLink": { + "type": "string", + "description": "Url to get the next page." + } + } + }, + "SavingsPlanOrderModel": { + "type": "object", + "description": "Savings plan order", + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "sku": { + "description": "Savings plan SKU", + "$ref": "#/definitions/Sku" + }, + "tags": { + "description": "Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "Savings plan order properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SavingsPlanOrderModelProperties" + } + } + }, + "SavingsPlanOrderModelProperties": { + "type": "object", + "description": "Savings plan order properties", + "properties": { + "displayName": { + "$ref": "#/definitions/DisplayName" + }, + "provisioningState": { + "description": "The provisioning state of the savings plan, e.g. Succeeded", + "readOnly": true, + "type": "string" + }, + "billingScopeId": { + "$ref": "#/definitions/BillingScopeId" + }, + "billingProfileId": { + "$ref": "#/definitions/BillingProfileId" + }, + "customerId": { + "$ref": "#/definitions/CustomerId" + }, + "billingAccountId": { + "$ref": "#/definitions/BillingAccountId" + }, + "term": { + "$ref": "#/definitions/BenefitTerm" + }, + "billingPlan": { + "$ref": "#/definitions/BillingPlan" + }, + "benefitStartTime": { + "type": "string", + "format": "date-time", + "description": "DateTime when the savings plan benefit started.", + "readOnly": true + }, + "expiryDateTime": { + "type": "string", + "format": "date-time", + "description": "DateTime when the savings plan will expire.", + "readOnly": true + }, + "expiryDate": { + "$ref": "#/definitions/ExpiryDate" + }, + "planInformation": { + "$ref": "#/definitions/BillingPlanInformation" + }, + "savingsPlans": { + "type": "array", + "items": { + "$ref": "#/definitions/SavingsPlanId" + } + }, + "extendedStatusInfo": { + "$ref": "#/definitions/ExtendedStatusInfo" + }, + "productCode": { + "$ref": "#/definitions/ProductCode" + } + } + }, + "SavingsPlanUpdateRequest": { + "type": "object", + "description": "Savings plan patch request", + "properties": { + "properties": { + "$ref": "#/definitions/SavingsPlanUpdateRequestProperties" + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "tags": { + "description": "Tags for this reservation", + "$ref": "#/definitions/Tags" + } + } + }, + "SavingsPlanUpdateRequestProperties": { + "type": "object", + "description": "Savings plan patch request", + "properties": { + "displayName": { + "$ref": "#/definitions/DisplayName" + }, + "appliedScopeType": { + "$ref": "#/definitions/AppliedScopeType" + }, + "appliedScopeProperties": { + "$ref": "#/definitions/AppliedScopeProperties" + }, + "renew": { + "$ref": "#/definitions/Renew" + }, + "renewProperties": { + "$ref": "#/definitions/RenewProperties" + } + } + }, + "RenewSource": { + "type": "string", + "description": "SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed." + }, + "RenewDestination": { + "type": "string", + "description": "SavingsPlan Id of the SavingsPlan which is purchased because of renew." + }, + "RenewProperties": { + "type": "object", + "description": "Properties specific to renew.", + "properties": { + "purchaseProperties": { + "$ref": "#/definitions/PurchaseRequest" + } + } + }, + "PurchaseRequest": { + "type": "object", + "description": "Purchase request.", + "properties": { + "sku": { + "$ref": "#/definitions/Sku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PurchaseRequestProperties" + } + } + }, + "PurchaseRequestProperties": { + "type": "object", + "description": "Purchase request properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Friendly name of the savings plan" + }, + "billingScopeId": { + "$ref": "#/definitions/BillingScopeId" + }, + "term": { + "$ref": "#/definitions/BenefitTerm" + }, + "billingPlan": { + "$ref": "#/definitions/BillingPlan" + }, + "appliedScopeType": { + "$ref": "#/definitions/AppliedScopeType" + }, + "commitment": { + "$ref": "#/definitions/Commitment" + }, + "renew": { + "$ref": "#/definitions/Renew" + }, + "appliedScopeProperties": { + "$ref": "#/definitions/AppliedScopeProperties" + } + } + }, + "Price": { + "type": "object", + "description": "The price.", + "properties": { + "currencyCode": { + "type": "string", + "description": "The ISO 4217 3-letter currency code for the currency used by this purchase record." + }, + "amount": { + "type": "number", + "format": "double" + } + } + }, + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource Tags" + }, + "ProductCode": { + "type": "string", + "description": "Represents UPN" + }, + "BillingPlanInformation": { + "type": "object", + "description": "Information describing the type of billing plan for this savings plan.", + "properties": { + "pricingCurrencyTotal": { + "$ref": "#/definitions/Price", + "description": "Amount of money to be paid for the Order. Tax is not included." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "Date when the billing plan has started." + }, + "nextPaymentDueDate": { + "type": "string", + "format": "date", + "description": "For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off." + }, + "transactions": { + "type": "array", + "items": { + "$ref": "#/definitions/PaymentDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "PaymentDetail": { + "type": "object", + "description": "Information about payment related to a savings plan order.", + "properties": { + "dueDate": { + "type": "string", + "format": "date", + "description": "Date when the payment needs to be done." + }, + "paymentDate": { + "type": "string", + "format": "date", + "description": "Date when the transaction is completed. Null when it is scheduled." + }, + "pricingCurrencyTotal": { + "$ref": "#/definitions/Price", + "description": "Amount in pricing currency. Tax not included." + }, + "billingCurrencyTotal": { + "$ref": "#/definitions/Price", + "description": "Amount charged in Billing currency. Tax not included. Is null for future payments" + }, + "status": { + "$ref": "#/definitions/PaymentStatus" + }, + "extendedStatusInfo": { + "$ref": "#/definitions/ExtendedStatusInfo" + } + } + }, + "PaymentStatus": { + "type": "string", + "description": "Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future.", + "enum": [ + "Succeeded", + "Failed", + "Scheduled", + "Cancelled", + "Completed", + "Pending" + ], + "x-ms-enum": { + "name": "PaymentStatus", + "modelAsString": true + } + }, + "Utilization": { + "readOnly": true, + "type": "object", + "description": "Savings plan utilization", + "properties": { + "trend": { + "description": "The trend for a savings plan's utilization", + "readOnly": true, + "type": "string" + }, + "aggregates": { + "description": "The array of aggregates of a savings plan's utilization", + "type": "array", + "items": { + "$ref": "#/definitions/UtilizationAggregates" + }, + "x-ms-identifiers": [] + } + } + }, + "UtilizationAggregates": { + "description": "The aggregate values of savings plan utilization", + "type": "object", + "properties": { + "grain": { + "description": "The grain of the aggregate", + "readOnly": true, + "type": "number" + }, + "grainUnit": { + "description": "The grain unit of the aggregate", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The aggregate value", + "readOnly": true, + "type": "number" + }, + "valueUnit": { + "description": "The aggregate value unit", + "readOnly": true, + "type": "string" + } + } + }, + "ExtendedStatusInfo": { + "type": "object", + "readOnly": true, + "description": "Extended status information", + "properties": { + "statusCode": { + "type": "string", + "description": "Status code providing additional information." + }, + "message": { + "type": "string", + "description": "The message giving detailed information about the status code." + }, + "properties": { + "type": "object", + "description": "Properties specific to credit line check failure", + "x-ms-client-flatten": true, + "properties": { + "subscriptionId": { + "type": "string", + "description": "The subscription that has failed credit line check." + } + } + } + } + }, + "SavingsPlanUpdateValidateRequest": { + "type": "object", + "description": "Savings plan update validate request.", + "properties": { + "benefits": { + "type": "array", + "description": "The benefits of a savings plan.", + "items": { + "$ref": "#/definitions/SavingsPlanUpdateRequestProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "SavingsPlanValidateResponse": { + "type": "object", + "description": "Savings plan update validate response.", + "properties": { + "benefits": { + "type": "array", + "items": { + "$ref": "#/definitions/SavingsPlanValidResponseProperty" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "Url to get the next page." + } + } + }, + "SavingsPlanValidResponseProperty": { + "type": "object", + "description": "Benefit scope response property", + "properties": { + "valid": { + "type": "boolean", + "description": "Indicates if the provided input is valid" + }, + "reasonCode": { + "type": "string", + "description": "Failure reason code if the provided input is invalid" + }, + "reason": { + "type": "string", + "description": "Failure reason if the provided input is invalid" + } + } + } + }, + "parameters": { + "ExpandParameter": { + "name": "expand", + "description": "May be used to expand the planInformation.", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "string" + }, + "SkipTokenParameter": { + "name": "skiptoken", + "description": "The number of savings plans to skip from the list before returning results", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "number" + }, + "TakeParameter": { + "name": "take", + "description": "The number of savings plans to return", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "number" + }, + "SelectedStateParameter": { + "name": "selectedState", + "description": "The selected provisioning state", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "string" + }, + "RefreshSummaryParameter": { + "name": "refreshSummary", + "description": "To indicate whether to refresh the roll up counts of the savings plans group by provisioning states", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "string" + }, + "SavingsPlanOrderIdParameter": { + "name": "savingsPlanOrderId", + "description": "Order ID of the savings plan", + "in": "path", + "x-ms-parameter-location": "method", + "required": true, + "type": "string" + }, + "SavingsPlanIdParameter": { + "name": "savingsPlanId", + "description": "ID of the savings plan", + "in": "path", + "x-ms-parameter-location": "method", + "required": true, + "type": "string" + }, + "SavingsPlanUpdateRequestParameter": { + "name": "body", + "description": "Request body for patching a savings plan order alias", + "in": "body", + "x-ms-parameter-location": "method", + "required": true, + "schema": { + "$ref": "#/definitions/SavingsPlanUpdateRequest" + } + }, + "SavingsPlanUpdateValidateRequestParameter": { + "name": "body", + "description": "Request body for patching a savings plan order alias", + "in": "body", + "x-ms-parameter-location": "method", + "required": true, + "schema": { + "$ref": "#/definitions/SavingsPlanUpdateValidateRequest" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json new file mode 100644 index 000000000000..976b7926e0e9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json @@ -0,0 +1,2082 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions/{billingSubscriptionName}": { + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_GetByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", + "type": "string" + } + ], + "responses": { + "200": { + "description": "A billing subscription.", + "schema": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionGetByBillingProfile": { + "$ref": "./examples/billingSubscriptionGetByBillingProfile.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "in": "query", + "name": "includeDeleted", + "description": "Can be used to get deleted billing subscriptions.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing subscriptions.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionsListByBillingProfileMCA": { + "$ref": "./examples/billingSubscriptionsListByBillingProfileMCA.json" + }, + "BillingSubscriptionsListByBillingProfileEA": { + "$ref": "./examples/billingSubscriptionsListByBillingProfileEA.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_ListByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/customerNameParameter" + }, + { + "in": "query", + "name": "includeDeleted", + "description": "Can be used to get deleted billing subscriptions.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing subscriptions.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionsListByCustomer": { + "$ref": "./examples/billingSubscriptionsListByCustomer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_ListByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + }, + { + "in": "query", + "name": "includeDeleted", + "description": "Can be used to get deleted billing subscriptions.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing subscriptions.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionsListByInvoiceSection": { + "$ref": "./examples/billingSubscriptionsListByInvoiceSection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases/{aliasName}": { + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptionsAliases_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionAliasNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A billing subscription alias.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionAlias" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionAliasGet": { + "$ref": "./examples/billingSubscriptionAliasGet.json" + } + } + }, + "put": { + "tags": [ + "BillingSubscription" + ], + "description": "Creates or updates a billing subscription by its alias ID. The operation is supported for seat based billing subscriptions.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptionsAliases_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionAliasNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A billing subscription alias.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingSubscriptionAlias" + } + } + ], + "responses": { + "200": { + "description": "The billing subscription alias.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionAlias" + } + }, + "201": { + "description": "The billing subscription alias.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionAlias" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingSubscriptionAliasCreateOrUpdate": { + "$ref": "./examples/billingSubscriptionAliasCreateOrUpdate.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases": { + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Lists the subscription aliases for a billing account. The operation is supported for seat based billing subscriptions.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptionsAliases_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "in": "query", + "name": "includeDeleted", + "description": "Can be used to get deleted billing subscriptions.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing subscription aliases.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionAliasListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionAliasList": { + "$ref": "./examples/billingSubscriptionAliasList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/cancel": { + "post": { + "tags": [ + "BillingSubscription" + ], + "description": "Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_Cancel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request parameters for cancel customer subscription.", + "required": true, + "schema": { + "$ref": "#/definitions/CancelSubscriptionRequest" + } + } + ], + "responses": { + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingSubscriptionsCancel": { + "$ref": "./examples/billingSubscriptionsCancel.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/merge": { + "post": { + "tags": [ + "BillingSubscription" + ], + "description": "Merges the billing subscription provided in the request with a target billing subscription.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_Merge", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request parameters that are provided to merge the two billing subscriptions.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingSubscriptionMergeRequest" + } + } + ], + "responses": { + "200": { + "description": "The billing properties of a subscription.", + "schema": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingSubscriptionsMerge": { + "$ref": "./examples/billingSubscriptionsMerge.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/move": { + "post": { + "tags": [ + "BillingSubscription" + ], + "description": "Moves charges for a subscription to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_Move", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request parameters to transfer billing subscription.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveBillingSubscriptionRequest" + } + } + ], + "responses": { + "200": { + "description": "The billing properties of a subscription.", + "schema": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingSubscriptionMove": { + "$ref": "./examples/billingSubscriptionMove.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/split": { + "post": { + "tags": [ + "BillingSubscription" + ], + "description": "Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_Split", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request parameters that are provided to split the billing subscription.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingSubscriptionSplitRequest" + } + } + ], + "responses": { + "200": { + "description": "The billing properties of a subscription.", + "schema": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingSubscriptionsSplit": { + "$ref": "./examples/billingSubscriptionsSplit.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/validateMoveEligibility": { + "post": { + "tags": [ + "BillingSubscription" + ], + "description": "Validates if charges for a subscription can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_ValidateMoveEligibility", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request parameters to transfer billing subscription.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveBillingSubscriptionRequest" + } + } + ], + "responses": { + "200": { + "description": "The billing properties of a subscription.", + "schema": { + "$ref": "#/definitions/MoveBillingSubscriptionEligibilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionValidateMoveSuccess": { + "$ref": "./examples/billingSubscriptionValidateMoveSuccess.json" + }, + "BillingSubscriptionValidateMoveFailure": { + "$ref": "./examples/billingSubscriptionValidateMoveFailure.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}": { + "delete": { + "tags": [ + "BillingSubscription" + ], + "description": "Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingSubscriptionsDelete": { + "$ref": "./examples/billingSubscriptionsDelete.json" + } + } + }, + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement, and Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", + "type": "string" + } + ], + "responses": { + "200": { + "description": "A billing subscription.", + "schema": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionsGet": { + "$ref": "./examples/billingSubscriptionsGet.json" + } + } + }, + "patch": { + "tags": [ + "BillingSubscription" + ], + "description": "Updates the properties of a billing subscription.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingSubscriptionNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The billing properties of a subscription.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingSubscriptionPatch" + } + } + ], + "responses": { + "200": { + "description": "The billing properties of a subscription.", + "schema": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BillingSubscriptionsUpdate": { + "$ref": "./examples/billingSubscriptionsUpdate.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Lists the subscriptions for a billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "in": "query", + "name": "includeDeleted", + "description": "Can be used to get deleted billing subscriptions.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includeTenantSubscriptions", + "description": "Can be used to get tenant-owned billing subscriptions. This field is only applies to Microsoft Online Services Program billing accounts.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includeFailed", + "description": "Can be used to get failed billing subscriptions.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing subscriptions.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionsListByBillingAccount": { + "$ref": "./examples/billingSubscriptionsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_ListByCustomerAtBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/customerNameParameter" + }, + { + "in": "query", + "name": "includeDeleted", + "description": "Can be used to get deleted billing subscriptions.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges`", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing subscriptions.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionsListByCustomerAtBillingAccount": { + "$ref": "./examples/billingSubscriptionsListByCustomerAtBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscription" + ], + "description": "Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_ListByEnrollmentAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of billing subscriptions.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingSubscriptionsListByEnrollmentAccount": { + "$ref": "./examples/billingSubscriptionsListByEnrollmentAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Beneficiary": { + "description": "Details of the beneficiary.", + "type": "object", + "properties": { + "tenantId": { + "description": "The ID that uniquely identifies a tenant.", + "type": "string" + }, + "objectId": { + "description": "The ID that uniquely identifies a user in a tenant.", + "type": "string" + } + } + }, + "BillingSubscription": { + "description": "The billing properties of a subscription.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "description": "The properties of a(n) BillingSubscription", + "$ref": "#/definitions/BillingSubscriptionProperties", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "BillingSubscriptionAlias": { + "description": "A billing subscription alias.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "description": "The properties of a(n) BillingSubscriptionAlias", + "$ref": "#/definitions/BillingSubscriptionAliasProperties", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "BillingSubscriptionAliasListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingSubscriptionAlias" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "BillingSubscriptionAliasProperties": { + "description": "A billing subscription alias.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BillingSubscriptionProperties" + } + ], + "properties": { + "billingSubscriptionId": { + "description": "The ID of the billing subscription with the subscription alias.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "BillingSubscriptionListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "totalCount": { + "description": "Total number of records.", + "type": "number", + "format": "int32", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingSubscription" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "BillingSubscriptionMergeRequest": { + "description": "Request parameters that are provided to merge the two billing subscriptions.", + "type": "object", + "properties": { + "targetBillingSubscriptionName": { + "description": "The ID of the target billing subscription that will be merged with the source subscription provided in the request.", + "type": "string" + }, + "quantity": { + "format": "int32", + "description": "The quantity of the source billing subscription that will be merged with the target billing subscription.", + "type": "integer" + } + } + }, + "BillingSubscriptionPatch": { + "description": "The billing properties of a subscription.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "description": "The properties of a(n) BillingSubscription", + "$ref": "#/definitions/BillingSubscriptionProperties", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "BillingSubscriptionProperties": { + "description": "The billing properties of a subscription.", + "type": "object", + "properties": { + "autoRenew": { + "description": "Indicates whether auto renewal is turned on or off for a product.", + "enum": [ + "Off", + "On" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoRenew", + "modelAsString": true + } + }, + "beneficiaryTenantId": { + "description": "The provisioning tenant of the subscription.", + "type": "string" + }, + "beneficiary": { + "description": "The beneficiary of the billing subscription.", + "$ref": "#/definitions/Beneficiary" + }, + "billingFrequency": { + "description": "The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y", + "type": "string" + }, + "billingProfileId": { + "description": "The fully qualified ID that uniquely identifies a billing profile.", + "type": "string" + }, + "billingPolicies": { + "type": "object", + "description": "Dictionary of billing policies associated with the subscription.", + "additionalProperties": { + "type": "string" + }, + "maxItems": 50, + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileName": { + "description": "The ID that uniquely identifies a billing profile.", + "type": "string", + "readOnly": true + }, + "consumptionCostCenter": { + "description": "The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts.", + "type": "string" + }, + "customerId": { + "description": "The fully qualified ID that uniquely identifies a customer.", + "type": "string" + }, + "customerDisplayName": { + "description": "The name of the customer.", + "type": "string", + "readOnly": true + }, + "customerName": { + "description": "The ID that uniquely identifies a customer.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The name of the billing subscription.", + "type": "string" + }, + "enrollmentAccountId": { + "description": "The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.", + "type": "string", + "readOnly": true + }, + "enrollmentAccountDisplayName": { + "description": "The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.", + "type": "string", + "readOnly": true + }, + "enrollmentAccountSubscriptionDetails": { + "x-ms-client-flatten": true, + "description": "Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.", + "$ref": "#/definitions/EnrollmentAccountSubscriptionDetails" + }, + "invoiceSectionId": { + "description": "The fully qualified ID that uniquely identifies an invoice section.", + "type": "string" + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionName": { + "description": "The ID that uniquely identifies an invoice section.", + "type": "string", + "readOnly": true + }, + "lastMonthCharges": { + "description": "The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.", + "$ref": "./types.json#/definitions/Amount", + "readOnly": true + }, + "monthToDateCharges": { + "description": "The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.", + "$ref": "./types.json#/definitions/Amount", + "readOnly": true + }, + "nextBillingCycleDetails": { + "description": "Next billing cycle details of the subscription.", + "$ref": "#/definitions/NextBillingCycleDetails" + }, + "offerId": { + "description": "The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts.", + "type": "string", + "readOnly": true + }, + "productCategory": { + "description": "The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.", + "type": "string", + "readOnly": true + }, + "productType": { + "description": "Type of the product for which the subscription is purchased.", + "type": "string", + "readOnly": true + }, + "productTypeId": { + "description": "Id of the product for which the subscription is purchased.", + "type": "string" + }, + "purchaseDate": { + "format": "date-time", + "description": "Purchase date of the product in UTC time.", + "type": "string", + "readOnly": true + }, + "quantity": { + "format": "int64", + "description": "The quantity of licenses or fulfillment units for the subscription.", + "type": "integer" + }, + "reseller": { + "description": "Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.", + "$ref": "./types.json#/definitions/Reseller" + }, + "renewalTermDetails": { + "description": "Details for the next renewal term of a subscription.", + "$ref": "#/definitions/RenewalTermDetails" + }, + "skuId": { + "description": "The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.", + "type": "string" + }, + "skuDescription": { + "description": "The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.", + "type": "string", + "readOnly": true + }, + "systemOverrides": { + "description": "System imposed policies that regulate behavior of the subscription.", + "$ref": "#/definitions/SystemOverrides" + }, + "resourceUri": { + "description": "Unique identifier of the linked resource.", + "type": "string", + "readOnly": true + }, + "termDuration": { + "description": "The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y", + "type": "string" + }, + "termStartDate": { + "format": "date-time", + "description": "Start date of the term in UTC time.", + "type": "string", + "readOnly": true + }, + "termEndDate": { + "format": "date-time", + "description": "End date of the term in UTC time.", + "type": "string", + "readOnly": true + }, + "provisioningTenantId": { + "description": "The tenant in which the subscription is provisioned.", + "type": "string" + }, + "status": { + "description": "The status of the subscription. This field is not available for Enterprise Agreement billing accounts", + "enum": [ + "Other", + "Unknown", + "Active", + "Disabled", + "Deleted", + "Warned", + "Expiring", + "Expired", + "AutoRenew", + "Cancelled", + "Suspended", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingSubscriptionStatus", + "modelAsString": true + } + }, + "operationStatus": { + "description": "The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details.", + "enum": [ + "Other", + "None", + "LockedForUpdate" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingSubscriptionOperationStatus", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "subscriptionId": { + "description": "The ID of the subscription.", + "type": "string", + "readOnly": true + }, + "suspensionReasons": { + "description": "The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "suspensionReasonDetails": { + "description": "The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingSubscriptionStatusDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "BillingSubscriptionSplitRequest": { + "description": "Request parameters that are provided to split the billing subscription.", + "type": "object", + "properties": { + "targetProductTypeId": { + "description": "The ID of the target product to which the subscription needs to be split into. This value is not same as the value returned in Get API call and can be retrieved from Catalog API to know the product id to split into.", + "type": "string" + }, + "targetSkuId": { + "description": "The ID of the target product to which the subscription needs to be split into. This value is not same as the value returned in Get API call and can be retrieved from Catalog API to know the sku id to split into.", + "type": "string" + }, + "quantity": { + "format": "int32", + "description": "The quantity of the target product to which the subscription needs to be split into.", + "type": "integer" + }, + "termDuration": { + "description": "The term duration of the target in ISO8601 format product to which the subscription needs to be split into. Example: P1M, P1Y", + "type": "string" + }, + "billingFrequency": { + "description": "The billing frequency of the target subscription in the ISO8601 format. Example: P1M, P3M, P1Y\"", + "type": "string" + } + } + }, + "BillingSubscriptionStatusDetails": { + "description": "The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.", + "type": "object", + "properties": { + "effectiveDate": { + "format": "date-time", + "description": "The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts.", + "type": "string", + "readOnly": true + }, + "reason": { + "description": "The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.", + "enum": [ + "None", + "Cancelled", + "PastDue", + "SuspiciousActivity", + "Other", + "Transferred", + "PolicyViolation", + "SpendingLimitReached", + "Expired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SubscriptionStatusReason", + "modelAsString": true + } + } + } + }, + "CancelSubscriptionRequest": { + "description": "Request parameters for cancel customer subscription.", + "required": [ + "cancellationReason" + ], + "type": "object", + "properties": { + "cancellationReason": { + "description": "Cancellation reason.", + "enum": [ + "Other", + "Compromise", + "Dispute" + ], + "type": "string", + "x-ms-enum": { + "name": "CancellationReason", + "modelAsString": true + } + }, + "customerId": { + "description": "The fully qualified ID that uniquely identifies a customer.", + "type": "string" + } + } + }, + "EnrollmentAccountSubscriptionDetails": { + "description": "The billing properties that can be modified. Available only for the Enterprise Agreement Type.", + "type": "object", + "properties": { + "enrollmentAccountStartDate": { + "format": "date-time", + "description": "The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type.", + "type": "string", + "readOnly": true + }, + "subscriptionEnrollmentAccountStatus": { + "description": "The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type.", + "enum": [ + "Active", + "Cancelled", + "Expired", + "Deleted", + "TransferredOut", + "Transferring", + "Inactive" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SubscriptionEnrollmentAccountStatus", + "modelAsString": true + } + } + }, + "readOnly": true + }, + "MoveBillingSubscriptionEligibilityResult": { + "description": "Result of the transfer eligibility validation.", + "type": "object", + "properties": { + "isMoveEligible": { + "description": "Specifies whether the subscription is eligible to be transferred.", + "type": "boolean", + "readOnly": true + }, + "errorDetails": { + "description": "Error details of the transfer eligibility validation.", + "$ref": "#/definitions/MoveBillingSubscriptionErrorDetails" + } + } + }, + "MoveBillingSubscriptionErrorDetails": { + "description": "Error details of the transfer eligibility validation.", + "type": "object", + "properties": { + "code": { + "description": "Error code of the transfer validation response.", + "enum": [ + "Other", + "BillingAccountInactive", + "DestinationBillingProfileInactive", + "DestinationBillingProfileNotFound", + "DestinationBillingProfilePastDue", + "DestinationInvoiceSectionInactive", + "DestinationInvoiceSectionNotFound", + "InsufficientPermissionOnDestination", + "InsufficientPermissionOnSource", + "InvalidDestination", + "InvalidSource", + "MarketplaceNotEnabledOnDestination", + "ProductInactive", + "ProductNotFound", + "ProductTypeNotSupported", + "SourceBillingProfilePastDue", + "SourceInvoiceSectionInactive", + "AccountIsLocked", + "AssetHasCap", + "AssetNotActive", + "BillingProfilePastDue", + "CrossBillingAccountNotAllowed", + "NoActiveAzurePlan", + "None", + "SubscriptionNotActive", + "SubscriptionHasReservations", + "SubscriptionTypeNotSupported", + "InvoiceSectionIsRestricted" + ], + "type": "string", + "x-ms-enum": { + "name": "subscriptionTransferValidationErrorCode", + "modelAsString": true + } + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "details": { + "description": "Detailed error message explaining the error.", + "type": "string" + } + } + }, + "MoveBillingSubscriptionRequest": { + "description": "Request parameters to transfer billing subscription.", + "type": "object", + "properties": { + "destinationInvoiceSectionId": { + "description": "The destination invoice section id.", + "type": "string" + }, + "destinationEnrollmentAccountId": { + "description": "The destination enrollment account id.", + "type": "string" + } + } + }, + "NextBillingCycleDetails": { + "description": "Billing cycle details of the product.", + "type": "object", + "properties": { + "billingFrequency": { + "description": "Billing frequency of the product under the subscription.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "RenewalTermDetails": { + "description": "Details for the next renewal term of a subscription.", + "type": "object", + "properties": { + "billingFrequency": { + "description": "The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y", + "type": "string", + "readOnly": true + }, + "productId": { + "description": "Id of the product for which the subscription is purchased.", + "type": "string", + "readOnly": true + }, + "productTypeId": { + "description": "Type Id of the product for which the subscription is purchased.", + "type": "string", + "readOnly": true + }, + "skuId": { + "description": "The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.", + "type": "string", + "readOnly": true + }, + "termDuration": { + "description": "The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y", + "type": "string", + "readOnly": true + }, + "quantity": { + "format": "int64", + "description": "The quantity of licenses or fulfillment units for the subscription.", + "type": "integer" + }, + "termEndDate": { + "format": "date-time", + "description": "End date of the term in UTC time.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "SystemOverrides": { + "description": "System imposed policies that regulate behavior of the subscription.", + "type": "object", + "properties": { + "cancellation": { + "description": "The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.", + "enum": [ + "NotAllowed", + "Allowed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Cancellation", + "modelAsString": true + } + }, + "cancellationAllowedEndDate": { + "format": "date-time", + "description": "The end date in UTC time by when the self-serve cancellation ends.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "billingAccountNameParameter": { + "name": "billingAccountName", + "in": "path", + "description": "The ID that uniquely identifies a billing account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "transferTrackingGuidParameter": { + "name": "transferTrackingGuid", + "in": "path", + "description": "The ID that uniquely identifies a billing subscription transfer request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingProfileNameParameter": { + "name": "billingProfileName", + "in": "path", + "description": "The ID that uniquely identifies a billing profile.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingSubscriptionAliasNameParameter": { + "name": "aliasName", + "in": "path", + "description": "The ID that uniquely identifies a subscription alias.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingSubscriptionNameParameter": { + "name": "billingSubscriptionName", + "in": "path", + "description": "The ID that uniquely identifies a subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "costCenterNameParameter": { + "name": "costCenterName", + "x-ms-parameter-location": "method", + "in": "query", + "required": true, + "description": "Request parameters that are provided to the update cost center operation.", + "type": "string" + }, + "customerNameParameter": { + "name": "customerName", + "in": "path", + "description": "The ID that uniquely identifies a customer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountNameParameter": { + "name": "enrollmentAccountName", + "in": "path", + "description": "The ID that uniquely identifies an enrollment account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentNameParameter": { + "name": "departmentName", + "in": "path", + "description": "The ID that uniquely identifies a department.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "invoiceSectionNameParameter": { + "name": "invoiceSectionName", + "in": "path", + "description": "The ID that uniquely identifies an invoice section.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/customer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/customer.json new file mode 100644 index 000000000000..b09b64b1cde4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/customer.json @@ -0,0 +1,379 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}": { + "get": { + "tags": [ + "Customer" + ], + "description": "Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Customers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A partner's customer.", + "schema": { + "$ref": "#/definitions/Customer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomersGet": { + "$ref": "./examples/customersGet.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers": { + "get": { + "tags": [ + "Customer" + ], + "description": "Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Customers_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "May be used to expand enabledAzurePlans and resellers", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "A list of customers.", + "schema": { + "$ref": "#/definitions/CustomerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomersListByBillingProfile": { + "$ref": "./examples/customersListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}": { + "get": { + "tags": [ + "Customer" + ], + "description": "Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Customers_GetByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A partner's customer.", + "schema": { + "$ref": "#/definitions/Customer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomersGetByBillingAccount": { + "$ref": "./examples/customersGetByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers": { + "get": { + "tags": [ + "Customer" + ], + "description": "Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Customers_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "expand", + "description": "May be used to expand enabledAzurePlans and resellers", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "A list of customers.", + "schema": { + "$ref": "#/definitions/CustomerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomersListByBillingAccount": { + "$ref": "./examples/customersListByBillingAccount.json" + }, + "CustomersListByBillingAccountWithExpand": { + "$ref": "./examples/customersListByBillingAccountWithExpand.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Customer": { + "description": "A partner's customer.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomerProperties" + } + }, + "x-ms-azure-resource": true + }, + "CustomerListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Customer" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "CustomerProperties": { + "description": "A partner's customer.", + "type": "object", + "properties": { + "billingProfileDisplayName": { + "description": "The name of the billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The fully qualified ID that uniquely identifies a billing profile.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The name of the customer.", + "type": "string", + "readOnly": true + }, + "systemId": { + "description": "The system generated unique identifier for a customer.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Identifies the status of an customer. This is an upcoming property that will be populated in the future.", + "enum": [ + "Other", + "Active", + "Pending", + "Disabled", + "Warned", + "Deleted", + "UnderReview" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CustomerStatus", + "modelAsString": true + } + }, + "enabledAzurePlans": { + "description": "Azure plans enabled for the customer.", + "type": "array", + "items": { + "$ref": "./types.json#/definitions/AzurePlan" + }, + "x-ms-identifiers": [] + }, + "resellers": { + "description": "The list of resellers for which an Azure plan is enabled for the customer.", + "type": "array", + "items": { + "$ref": "./types.json#/definitions/Reseller" + }, + "x-ms-identifiers": [] + }, + "tags": { + "description": "Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/department.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/department.json new file mode 100644 index 000000000000..0f713d098362 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/department.json @@ -0,0 +1,204 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}": { + "get": { + "tags": [ + "Department" + ], + "description": "Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Departments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Department" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DepartmentGet": { + "$ref": "./examples/departmentGet.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments": { + "get": { + "tags": [ + "Department" + ], + "description": "Lists the departments that a user has access to. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Departments_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DepartmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DepartmentsListByBillingAccount": { + "$ref": "./examples/departmentsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Department": { + "description": "Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DepartmentProperties" + } + }, + "x-ms-azure-resource": true + }, + "DepartmentListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Department" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "DepartmentProperties": { + "description": "Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.", + "type": "object", + "properties": { + "costCenter": { + "description": "The cost center associated with the department.", + "type": "string" + }, + "displayName": { + "description": "The name of the department.", + "type": "string" + }, + "id": { + "description": "The ID that uniquely identifies the department.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the department.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/enrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/enrollmentAccount.json new file mode 100644 index 000000000000..e4d18239081e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/enrollmentAccount.json @@ -0,0 +1,352 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts/{enrollmentAccountName}": { + "get": { + "tags": [ + "EnrollmentAccount" + ], + "description": "Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "EnrollmentAccounts_GetByDepartment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnrollmentAccountByDepartment": { + "$ref": "./examples/enrollmentAccountByDepartment.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts": { + "get": { + "tags": [ + "EnrollmentAccount" + ], + "description": "Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "EnrollmentAccounts_ListByDepartment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/departmentName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnrollmentAccountsListByDepartment": { + "$ref": "./examples/enrollmentAccountsListByDepartment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}": { + "get": { + "tags": [ + "EnrollmentAccount" + ], + "description": "Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "EnrollmentAccounts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/enrollmentAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnrollmentAccountGet": { + "$ref": "./examples/enrollmentAccountGet.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts": { + "get": { + "tags": [ + "EnrollmentAccount" + ], + "description": "Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "EnrollmentAccounts_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnrollmentAccountsListByBillingAccount": { + "$ref": "./examples/enrollmentAccountsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "EnrollmentAccount": { + "description": "It is an organizational hierarchy within a billing account to administer and manage azure costs.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EnrollmentAccountProperties" + } + }, + "x-ms-azure-resource": true + }, + "EnrollmentAccountListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/EnrollmentAccount" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "EnrollmentAccountProperties": { + "description": "It is an organizational hierarchy within a billing account to administer and manage azure costs.", + "type": "object", + "properties": { + "costCenter": { + "description": "The cost center associated with the enrollment account.", + "type": "string" + }, + "displayName": { + "description": "The name of the enrollment account.", + "type": "string" + }, + "departmentDisplayName": { + "description": "The name of the department under which the enrollment account exists.", + "type": "string", + "readOnly": true + }, + "departmentId": { + "description": "The ID that uniquely identifies the department.", + "type": "string", + "readOnly": true + }, + "isDevTestEnabled": { + "description": "Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates.", + "type": "boolean" + }, + "accountOwner": { + "description": "The owner of the enrollment account.", + "type": "string", + "readOnly": true + }, + "authType": { + "description": "The authorization type of the enrollment account.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the enrollment account.", + "type": "string", + "readOnly": true + }, + "startDate": { + "format": "date-time", + "description": "The date from which the enrollment account became valid and functional.", + "type": "string", + "readOnly": true + }, + "endDate": { + "format": "date-time", + "description": "The date of expiration of the enrollment account.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateInvalid.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateInvalid.json new file mode 100644 index 000000000000..00d4ffedb254 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateInvalid.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "parameters": { + "addressLine1": "1 Test", + "city": "bellevue", + "country": "us", + "postalCode": "12345", + "region": "wa" + } + }, + "responses": { + "200": { + "body": { + "status": "Invalid", + "suggestedAddresses": [ + { + "addressLine1": "1 Test Address", + "city": "Bellevue", + "country": "US", + "postalCode": "98052", + "region": "WA" + }, + { + "addressLine1": "1 Test Address", + "city": "Bellevue", + "country": "US", + "postalCode": "12345-0000", + "region": "WA" + } + ], + "validationMessage": "Invalid address" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateValid.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateValid.json new file mode 100644 index 000000000000..e5151a2e24e1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/addressValidateValid.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "parameters": { + "addressLine1": "1 Test", + "city": "bellevue", + "country": "us", + "postalCode": "12345", + "region": "wa" + } + }, + "responses": { + "200": { + "body": { + "status": "Valid" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementByName.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementByName.json new file mode 100644 index 000000000000..bdfd3e93dc2a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "agreementName": "ABC123" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123", + "name": "ABC123", + "properties": { + "acceptanceMode": "ClickToAccept", + "agreementLink": "https://contoso.com", + "displayName": "Microsoft Customer Agreement", + "effectiveDate": "2018-11-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "status": "Active", + "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "type": "Microsoft.Billing/billingAccounts/agreements" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementsListByBillingAccount.json new file mode 100644 index 000000000000..283236bf49f7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementsListByBillingAccount.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expand": "Participants" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123", + "name": "ABC123", + "properties": { + "acceptanceMode": "ClickToAccept", + "agreementLink": "https://contoso.com", + "displayName": "Microsoft Customer Agreement", + "effectiveDate": "2018-11-01T00:00:00Z", + "expirationDate": "2019-11-01T00:00:00Z", + "participants": [ + { + "email": "abc@contoso.com", + "status": "Accepted", + "statusDate": "2018-11-01T00:00:00Z" + }, + { + "email": "xtz@contoso.com", + "status": "Declined", + "statusDate": "2018-11-02T00:00:00Z" + } + ], + "status": "Active", + "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "type": "Microsoft.Billing/billingAccounts/agreements" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/DEF456", + "name": "DEF456", + "properties": { + "acceptanceMode": "ESignEmbedded", + "agreementLink": "https://contoso.com", + "displayName": "Microsoft Customer Agreement", + "effectiveDate": "2018-12-05T00:00:00Z", + "expirationDate": "2019-12-05T00:00:00Z", + "participants": [ + { + "email": "abc@contoso.com", + "status": "Pending", + "statusDate": "2018-12-05T00:00:00Z" + } + ], + "status": "PendingSignature", + "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "type": "Microsoft.Billing/billingAccounts/agreements" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsCreateOrUpdate.json new file mode 100644 index 000000000000..7367b006742b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsCreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "associatedTenantName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "displayName": "Contoso Finance", + "billingManagementState": "Active", + "provisioningManagementState": "Pending" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "displayName": "Contoso Finance", + "tenantId": "11111111-1111-1111-1111-111111111111", + "billingManagementState": "Active", + "provisioningManagementState": "Pending", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222" + }, + "type": "Microsoft.Billing/billingAccounts/associatedTenants" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "displayName": "Contoso Finance", + "tenantId": "11111111-1111-1111-1111-111111111111", + "billingManagementState": "Active", + "provisioningManagementState": "Pending", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222" + }, + "type": "Microsoft.Billing/billingAccounts/associatedTenants" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsDelete.json new file mode 100644 index 000000000000..17946737cdb4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "associatedTenantName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/deleteAssociatedTenant_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + }, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsGet.json new file mode 100644 index 000000000000..704bd064d321 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "associatedTenantName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "displayName": "Contoso Finance", + "tenantId": "11111111-1111-1111-1111-111111111111", + "billingManagementState": "Active", + "provisioningManagementState": "Pending", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222" + }, + "type": "Microsoft.Billing/billingAccounts/associatedTenants" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsListByBillingAccount.json new file mode 100644 index 000000000000..c2329496b2cc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/associatedTenantsListByBillingAccount.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-000000000000:00000000-0000-0000-000000000000_2019-05-31/associatedTenants/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "displayName": "Contoso Finance", + "tenantId": "11111111-1111-1111-1111-111111111111", + "billingManagementState": "Active", + "provisioningManagementState": "NotRequested" + }, + "type": "Microsoft.Billing/billingAccounts/associatedTenants" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-000000000000:00000000-0000-0000-000000000000_2019-05-31/associatedTenants/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "properties": { + "displayName": "Contoso Engineering", + "tenantId": "22222222-2222-2222-2222-222222222222", + "billingManagementState": "NotAllowed", + "provisioningManagementState": "Pending", + "provisioningBillingRequestId": "/providers/Microsoft.Billing/billingRequests/22222222-2222-2222-2222-222222222222" + }, + "type": "Microsoft.Billing/billingAccounts/associatedTenants" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json new file mode 100644 index 000000000000..f915eff05d30 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/availableBalance/default", + "name": "default", + "properties": { + "amount": { + "currency": "USD", + "value": 500 + }, + "paymentsOnAccount": [ + { + "amount": { + "currency": "USD", + "value": 50 + }, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Finance", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceName": "G123456789", + "date": "2024-04-01T00:00:00.0000000Z", + "type": "CheckWire" + }, + { + "amount": { + "currency": "USD", + "value": 150 + }, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy", + "billingProfileDisplayName": "Contoso Engineering", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", + "invoiceName": "G987654321", + "date": "2023-01-01T00:00:00.0000000Z", + "type": "CheckWire" + } + ], + "totalPaymentsOnAccount": { + "currency": "USD", + "value": 200 + } + }, + "type": "Microsoft.Billing/billingAccounts/availableBalance" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json new file mode 100644 index 000000000000..001a4baece76 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingProfile.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/availableBalance/default", + "name": "default", + "properties": { + "amount": { + "currency": "USD", + "value": 500 + }, + "paymentsOnAccount": [ + { + "amount": { + "currency": "USD", + "value": 50 + }, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Finance", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceName": "G123456789", + "date": "2024-04-01T00:00:00.0000000Z", + "type": "CheckWire" + } + ], + "totalPaymentsOnAccount": { + "currency": "USD", + "value": 200 + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/availableBalance" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json new file mode 100644 index 000000000000..f7e56656bc53 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001", + "name": "20000000-0000-0000-0000-000000000001", + "properties": { + "accountStatus": "Active", + "accountType": "Individual", + "agreementType": "MicrosoftOnlineServicesProgram", + "displayName": "Individual Account 2", + "hasReadAccess": true, + "notificationEmailAddress": "individual@domain.com" + }, + "type": "Microsoft.Billing/billingAccounts" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountUpdateWithPONumber.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountUpdateWithPONumber.json new file mode 100644 index 000000000000..7321a968cdde --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountUpdateWithPONumber.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6575495", + "parameters": { + "properties": { + "enrollmentDetails": { + "poNumber": "poNumber123" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/6575495", + "name": "6575495", + "properties": { + "accountStatus": "Active", + "accountType": "Enterprise", + "accountSubType": "None", + "agreementType": "EnterpriseAgreement", + "displayName": "Enterprise Account", + "enrollmentDetails": { + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z", + "currency": "USD", + "channel": "EaDirect", + "language": "en", + "countryCode": "US", + "billingCycle": "Monthly", + "extendedTermOption": "Opted-Out", + "supportLevel": "Standard", + "supportCoverage": "1/26/2021 - 6/30/2021", + "cloud": "Azure Commercial", + "poNumber": "poNumber123" + }, + "hasReadAccess": true, + "soldTo": { + "addressLine1": "Test Address", + "addressLine2": "Test Address", + "addressLine3": "Test Address", + "city": "City", + "country": "US", + "postalCode": "00000", + "region": "WA" + } + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/6575495/operationStatus/65e1f2bf-c31c-4b89-a599-25d9d4172af9?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithExpandForPONumber.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithExpandForPONumber.json new file mode 100644 index 000000000000..a8a4eae01e60 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithExpandForPONumber.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "8608480", + "expand": "enrollmentDetails/poNumber" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/6564892", + "name": "6564892", + "properties": { + "accountStatus": "Active", + "accountType": "Enterprise", + "agreementType": "EnterpriseAgreement", + "displayName": "Enterprise Account", + "enrollmentDetails": { + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z", + "currency": "USD", + "channel": "EaDirect", + "language": "en", + "countryCode": "US", + "billingCycle": "Monthly", + "extendedTermOption": "Opted-Out", + "supportLevel": "Standard", + "supportCoverage": "1/26/2021 - 6/30/2021", + "cloud": "Azure Commercial", + "poNumber": "poNumber123" + }, + "hasReadAccess": true + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithDefaultType.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithDefaultType.json new file mode 100644 index 000000000000..86534b8a205f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithDefaultType.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Enterprise", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", + "registrationNumber": { + "id": "RegistrationId", + "type": [ + "RegistrationNumber" + ] + } + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithType.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithType.json new file mode 100644 index 000000000000..9b19667a2f93 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountWithRegistrationNumberWithType.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Enterprise", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", + "registrationNumber": { + "id": "SomeRegistrationId", + "required": true, + "type": [ + "TIN" + ] + } + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsConfirmTransition.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsConfirmTransition.json new file mode 100644 index 000000000000..90931c5366b0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsConfirmTransition.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "transitionDate": "2021-05-17T00:00:00Z", + "anniversaryDay": 12 + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGet.json new file mode 100644 index 000000000000..0fc46a87e950 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Enterprise", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGetEA.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGetEA.json new file mode 100644 index 000000000000..392b6b882046 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGetEA.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6575495" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/6575495", + "name": "6575495", + "properties": { + "agreementType": "EnterpriseAgreement", + "enrollmentDetails": { + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z", + "currency": "USD", + "channel": "EaDirect", + "language": "en", + "countryCode": "US", + "billingCycle": "Monthly", + "extendedTermOption": "Opted-Out", + "supportLevel": "Standard", + "supportCoverage": "1/26/2021 - 6/30/2021", + "cloud": "Azure Commercial", + "markupStatus": "Published", + "indirectRelationshipInfo": { + "billingAccountName": "pcn.12345", + "billingProfileName": "", + "displayName": "Test partner" + }, + "invoiceRecipient": "abc@contoso.com" + }, + "soldTo": { + "addressLine1": "Test Address", + "addressLine2": "Test Address", + "addressLine3": "Test Address", + "city": "City", + "country": "US", + "postalCode": "00000", + "region": "WA" + } + }, + "type": "Microsoft.Billing/billingAccounts" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGetWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGetWithExpand.json new file mode 100644 index 000000000000..7c101eff04f6 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsGetWithExpand.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expand": "SoldTo" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Enterprise", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", + "soldTo": { + "addressLine1": "1 Microsoft Way", + "city": "Redmond", + "companyName": "Contoso", + "country": "US", + "postalCode": "98052-8300", + "region": "WA", + "isValidAddress": true + } + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsList.json new file mode 100644 index 000000000000..02fe22b4756a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsList.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Enterprise", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Professional", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Standard Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Individual", + "accountSubType": "Individual", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Individual Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Enterprise", + "agreementType": "MicrosoftPartnerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.json new file mode 100644 index 000000000000..0174a6199e51 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "expand": "soldTo,enrollmentDetails/poNumber" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/6564892", + "name": "6564892", + "properties": { + "accountStatus": "Active", + "accountType": "Enterprise", + "accountSubType": "None", + "agreementType": "EnterpriseAgreement", + "displayName": "Enterprise Account", + "enrollmentDetails": { + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z", + "currency": "USD", + "channel": "EaDirect", + "language": "en", + "countryCode": "US", + "billingCycle": "Monthly", + "extendedTermOption": "Opted-Out", + "supportLevel": "Standard", + "supportCoverage": "1/26/2021 - 6/30/2021", + "cloud": "Azure Commercial", + "poNumber": "poNumber123" + }, + "hasReadAccess": true, + "soldTo": { + "addressLine1": "Test Address", + "city": "City", + "companyName": "Enterprise Company", + "country": "US", + "postalCode": "00000-1111", + "region": "WA" + } + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsUpdate.json new file mode 100644 index 000000000000..5ca422dc07fc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsUpdate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": { + "properties": { + "displayName": "Test Account", + "soldTo": { + "addressLine1": "1 Microsoft Way", + "city": "Redmond", + "companyName": "Contoso", + "country": "US", + "postalCode": "98052-8300", + "region": "WA" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Enterprise", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001", + "soldTo": { + "addressLine1": "1 Microsoft Way", + "city": "Redmond", + "companyName": "Contoso", + "country": "US", + "postalCode": "98052-8300", + "region": "WA", + "isValidAddress": true + } + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/patchBillingAccount_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByBillingAccount.json new file mode 100644 index 000000000000..3519809beda0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByBillingAccount.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000009", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "20000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByBillingProfile.json new file mode 100644 index 000000000000..30679725582c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByBillingProfile.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000009", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "20000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByCustomer.json new file mode 100644 index 000000000000..fb764cafa323 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByCustomer.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByCustomerAtBillingAccount.json new file mode 100644 index 000000000000..e95cf4b397d2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByCustomerAtBillingAccount.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByDepartment.json new file mode 100644 index 000000000000..2b7fd0d80bdb --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByDepartment.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6100092", + "departmentName": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByEnrollmentAccount.json new file mode 100644 index 000000000000..c694c3a90d9a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByEnrollmentAccount.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6100092", + "enrollmentAccountName": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByInvoiceSection.json new file mode 100644 index 000000000000..6ef4355259fc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPermissionsListByInvoiceSection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "XXXX-XXXX-XXX-XXX" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json new file mode 100644 index 000000000000..9b1233afe9d0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "displayName": "Billing Profile 1", + "enabledAzurePlans": [ + { + "skuId": "0001" + }, + { + "skuId": "0002" + } + ], + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "name": "xxxx-xxxx-xxx-xxx", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "status": "Active", + "systemId": "11111111-1111-1111-1111-111111111111" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "name": "xxxx-xxxx-xxx-xxx", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "status": "Active", + "systemId": "11111111-1111-1111-1111-111111111111" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/putBillingProfile_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesDelete.json new file mode 100644 index 000000000000..5dc408f1b7ce --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesDelete.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "displayName": "Billing Profile 1", + "enabledAzurePlans": [ + { + "skuId": "0001" + }, + { + "skuId": "0002" + } + ], + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/deleteBillingProfile_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + }, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesGet.json new file mode 100644 index 000000000000..9bd3c1489818 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesGet.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "name": "xxxx-xxxx-xxx-xxx", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "invoiceRecipients": [ + "abc@contoso.com", + "xyz@contoso.com" + ], + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "soldTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "spendingLimit": "On", + "spendingLimitDetails": [ + { + "amount": 200, + "currency": "USD", + "startDate": "2018-01-01T00:00:00.0000000Z", + "endDate": "2019-01-01T00:00:00.0000000Z", + "type": "FreeAccount", + "status": "Active" + } + ], + "status": "Warned", + "statusReasonCode": "PastDue", + "systemId": "11111111-1111-1111-1111-111111111111" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesListByBillingAccount.json new file mode 100644 index 000000000000..670323da178e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesListByBillingAccount.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "name": "xxxx-xxxx-xxx-xxx", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "invoiceRecipients": [ + "abc@contoso.com", + "xyz@contoso.com" + ], + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "soldTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "spendingLimit": "On", + "spendingLimitDetails": [ + { + "amount": 200, + "currency": "USD", + "startDate": "2018-01-01T00:00:00.0000000Z", + "endDate": "2019-01-01T00:00:00.0000000Z", + "type": "FreeAccount", + "status": "Active" + } + ], + "status": "Warned", + "statusReasonCode": "PastDue", + "systemId": "11111111-1111-1111-1111-111111111111" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy", + "name": "yyyy-yyyy-yyy-yyy", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "currency": "USD", + "displayName": "Billing Profile 2", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "invoiceRecipients": [ + "abc@contoso.com", + "xyz@contoso.com" + ], + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "soldTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "status": "UnderReview", + "statusReasonCode": "UnusualActivity", + "systemId": "22222222-2222-2222-2222-222222222222" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/zzzz-zzzz-zzz-zzz", + "name": "zzzz-zzzz-zzz-zzz", + "properties": { + "billTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "currency": "USD", + "displayName": "Billing Profile 1", + "hasReadAccess": true, + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "invoiceRecipients": [ + "abc@contoso.com", + "xyz@contoso.com" + ], + "poNumber": "ABC12345", + "shipTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "soldTo": { + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "companyName": "Contoso", + "country": "US", + "email": "abc@contoso.com", + "firstName": "Test", + "lastName": "User", + "phoneNumber": "000-000-0000", + "postalCode": "00000", + "region": "WA", + "isValidAddress": true + }, + "status": "Active", + "systemId": "33333333-3333-3333-3333-333333333333" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilityFailure.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilityFailure.json new file mode 100644 index 000000000000..f4cb52ebad28 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilityFailure.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "eligibilityStatus": "NotAllowed", + "eligibilityDetails": [ + { + "code": "ActiveBillingSubscriptions", + "message": "There are active or disabled subscriptions assigned to the invoice section. Either move the subscription to another invoice section or delete the subscriptions and then try deleting the invoice section." + }, + { + "code": "LastBillingProfile", + "message": "Billing profile cannot be deleted as this is the only billing profile in this billing account." + }, + { + "code": "OutstandingCharges", + "message": "Billing Profile cannot be deleted as there are outstanding charges on this billing profile." + }, + { + "code": "PendingCharges", + "message": "Billing Profile cannot be deleted as there are pending charges accumulating on this billing profile." + }, + { + "code": "ReservedInstances", + "message": "Billing Profile cannot be deleted as there are reserved assets with a billing plan." + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilitySuccess.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilitySuccess.json new file mode 100644 index 000000000000..540e412efe3a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesValidateDeleteEligibilitySuccess.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMCA.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMCA.json new file mode 100644 index 000000000000..d5816237b19a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMCA.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "name": "default", + "properties": { + "billingAccountAgreementType": "MicrosoftCustomerAgreement", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Business", + "billingProfileDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileSpendingLimit": "Off", + "billingProfileStatus": "Active", + "costCenter": "1010", + "invoiceSectionDisplayName": "Operations", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", + "subscriptionBillingStatus": "Active", + "subscriptionBillingStatusDetails": [ + { + "effectiveDate": "2023-01-01T17:32:28Z", + "reason": "Cancelled" + } + ], + "subscriptionBillingType": "Free", + "subscriptionWorkloadType": "Production" + }, + "type": "Microsoft.Billing/billingProperty" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMOSP.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMOSP.json new file mode 100644 index 000000000000..f0b6b65b9964 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMOSP.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "name": "default", + "properties": { + "billingAccountAgreementType": "MicrosoftOnlineServicesProgram", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Individual", + "subscriptionBillingType": "Free", + "subscriptionServiceUsageAddress": { + "addressLine1": "Address line 1", + "addressLine2": "Address line 2", + "city": "City", + "country": "US", + "firstName": "Jenny", + "lastName": "Doe", + "middleName": "Ann", + "postalCode": "12345", + "region": "State" + }, + "subscriptionWorkloadType": "Production" + }, + "type": "Microsoft.Billing/billingProperty" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMPA.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMPA.json new file mode 100644 index 000000000000..62788e6d64ae --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyGetMPA.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "name": "default", + "properties": { + "billingAccountAgreementType": "MicrosoftCustomerAgreement", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Business", + "billingProfileDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileSpendingLimit": "Off", + "billingProfileStatus": "Active", + "costCenter": "1010", + "customerDisplayName": "Operations", + "customerId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx/customers/yyyy-yyyy-yyy-yyy", + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", + "subscriptionBillingStatus": "Active", + "subscriptionBillingStatusDetails": [ + { + "effectiveDate": "2023-01-01T17:32:28Z", + "reason": "Cancelled" + } + ], + "subscriptionBillingType": "Free", + "subscriptionWorkloadType": "Production" + }, + "type": "Microsoft.Billing/billingProperty" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyPatchCostCenter.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyPatchCostCenter.json new file mode 100644 index 000000000000..6a4dbba742cf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyPatchCostCenter.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "costCenter": "1010" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "name": "default", + "properties": { + "billingAccountAgreementType": "MicrosoftCustomerAgreement", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Business", + "billingProfileDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileSpendingLimit": "Off", + "billingProfileStatus": "Active", + "costCenter": "1010", + "invoiceSectionDisplayName": "Operations", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000/billingProfiles/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "skuDescription": "Microsoft Azure Plan", + "skuId": "0001", + "subscriptionBillingStatus": "Active", + "subscriptionBillingStatusDetails": [ + { + "effectiveDate": "2023-01-01T17:32:28Z", + "reason": "Cancelled" + } + ], + "subscriptionBillingType": "Free", + "subscriptionWorkloadType": "Production" + }, + "type": "Microsoft.Billing/billingProperty" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyPatchSubscriptionServiceUsageAddress.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyPatchSubscriptionServiceUsageAddress.json new file mode 100644 index 000000000000..4dfbd8a24af2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingPropertyPatchSubscriptionServiceUsageAddress.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "subscriptionServiceUsageAddress": { + "addressLine1": "Address line 1", + "addressLine2": "Address line 2", + "city": "City", + "country": "US", + "firstName": "Jenny", + "lastName": "Doe", + "middleName": "Ann", + "postalCode": "12345", + "region": "State" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingProperty/default", + "name": "default", + "properties": { + "billingAccountAgreementType": "MicrosoftOnlineServicesProgram", + "billingAccountDisplayName": "My Account", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000", + "billingAccountSoldToCountry": "US", + "billingAccountType": "Individual", + "subscriptionBillingType": "Free", + "subscriptionServiceUsageAddress": { + "addressLine1": "Address line 1", + "addressLine2": "Address line 2", + "city": "City", + "country": "US", + "firstName": "Jenny", + "lastName": "Doe", + "middleName": "Ann", + "postalCode": "12345", + "region": "State" + }, + "subscriptionWorkloadType": "Production" + }, + "type": "Microsoft.Billing/billingProperty" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsCreateOrUpdate.json new file mode 100644 index 000000000000..5d1d27f726e5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsCreateOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingRequestName": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "decisionReason": "New team member", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending", + "type": "RoleAssignment" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "properties": { + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Operations Billing", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending", + "type": "RoleAssignment", + "lastUpdatedBy": { + "upn": "admin@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "properties": { + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Operations Billing", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending", + "type": "RoleAssignment", + "lastUpdatedBy": { + "upn": "admin@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsGet.json new file mode 100644 index 000000000000..21f587dd6555 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingRequestName": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "properties": { + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Operations Billing", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending", + "type": "RoleAssignment", + "lastUpdatedBy": { + "upn": "admin@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByBillingAccount.json new file mode 100644 index 000000000000..41fb8f24fb7e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByBillingAccount.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "properties": { + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Operations Billing", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending", + "type": "RoleAssignment", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + }, + { + "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "reviewedBy": { + "upn": "admin@contosofinance.com" + }, + "reviewalDate": "2023-03-02T17:32:28Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2023-03-01T17:32:28Z", + "expirationDate": "2023-03-15T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", + "status": "Approved", + "type": "ProvisioningAccess", + "lastUpdatedBy": { + "upn": "admin@contosofinance.com" + }, + "lastUpdatedDate": "2023-03-02T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByBillingProfile.json new file mode 100644 index 000000000000..0976b2f22ccb --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByBillingProfile.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "properties": { + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Operations Billing", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending", + "type": "RoleAssignment", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByCustomer.json new file mode 100644 index 000000000000..1f54cb48019b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByCustomer.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "properties": { + "additionalInformation": { + "RoleId": "30000000-aaaa-bbbb-cccc-200000000003" + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Operations Billing", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "customerId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "customerName": "11111111-1111-1111-1111-111111111111", + "customerDisplayName": "Customer 1", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "status": "Pending", + "type": "RoleAssignment", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByInvoiceSection.json new file mode 100644 index 000000000000..1c60059b5fb2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByInvoiceSection.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "properties": { + "additionalInformation": { + "RoleId": "30000000-aaaa-bbbb-cccc-200000000003" + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Operations Billing", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Department 1", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "status": "Pending", + "type": "RoleAssignment", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUser.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUser.json new file mode 100644 index 000000000000..3881eb5c7aeb --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUser.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "properties": { + "additionalInformation": { + "RoleId": "40000000-aaaa-bbbb-cccc-200000000006" + }, + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Contoso Operations Billing", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2024-04-01T17:32:28Z", + "expirationDate": "2023-04-15T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "status": "Pending", + "type": "RoleAssignment", + "lastUpdatedBy": { + "upn": "foo@contoso.com" + }, + "lastUpdatedDate": "2024-04-01T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + }, + { + "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "reviewedBy": { + "upn": "admin@contosofinance.com" + }, + "reviewalDate": "2023-03-02T17:32:28Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2023-03-01T17:32:28Z", + "expirationDate": "2023-03-15T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", + "status": "Approved", + "type": "ProvisioningAccess", + "lastUpdatedBy": { + "upn": "admin@contosofinance.com" + }, + "lastUpdatedDate": "2023-03-02T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json new file mode 100644 index 000000000000..7bb6a51fd268 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "filter": "properties/status eq 'Approved'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "reviewedBy": { + "upn": "admin@contosofinance.com" + }, + "reviewalDate": "2023-03-02T17:32:28Z", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingAccountDisplayName": "Contoso", + "createdBy": { + "upn": "foo@contoso.com" + }, + "creationDate": "2023-03-01T17:32:28Z", + "expirationDate": "2023-03-15T17:32:28Z", + "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000", + "status": "Approved", + "type": "ProvisioningAccess", + "lastUpdatedBy": { + "upn": "admin@contosofinance.com" + }, + "lastUpdatedDate": "2023-03-02T17:32:28Z" + }, + "type": "Microsoft.Billing/billingRequests" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.json new file mode 100644 index 000000000000..9a8c4ab25f2c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingAccount.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "parameters": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "userEmailAddress": "john@contoso.com" + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/createBillingRoleAssignment_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingProfile.json new file mode 100644 index 000000000000..cb154faddd73 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByBillingProfile.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "parameters": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "userEmailAddress": "john@contoso.com" + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/operationResults/createBillingRoleAssignment_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByCustomer.json new file mode 100644 index 000000000000..29a38b1ba244 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByCustomer.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d", + "parameters": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "userEmailAddress": "john@contoso.com" + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "name": "30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfileName/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/customers/703ab484-dda2-4402-827b-a74513b61e2d/operationResults/createBillingRoleAssignment_30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "5" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByInvoiceSection.json new file mode 100644 index 000000000000..0b2033585f15 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateByInvoiceSection.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "userEmailAddress": "john@contoso.com" + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "47309529-17e6-4104-b9e8-39f62fa1e5ed", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/xxxx-xxxx-xxx-xxx/operationResults/createBillingRoleAssignment_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json new file mode 100644 index 000000000000..9071b35ccbd5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByBillingAccount.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "parameters": { + "properties": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "userEmailAddress": "john@contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByDepartment.json new file mode 100644 index 000000000000..170eb67e3a3b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByDepartment.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "departmentName": "12345", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "parameters": { + "properties": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "userEmailAddress": "john@contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/12345" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json new file mode 100644 index 000000000000..16ff9d7c3875 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentCreateOrUpdateByEnrollmentAccount.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "enrollmentAccountName": "123456", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "parameters": { + "properties": { + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "userEmailAddress": "john@contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/123456" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingAccount.json new file mode 100644 index 000000000000..1196d51833d1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingProfile.json new file mode 100644 index 000000000000..de71acb39b6a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByBillingProfile.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByCustomer.json new file mode 100644 index 000000000000..bddb5aaefb63 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByCustomer.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d", + "billingRoleAssignmentName": "30000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByDepartment.json new file mode 100644 index 000000000000..ea93fc05db97 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByDepartment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "8608480", + "departmentName": "123456", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByEnrollmentAccount.json new file mode 100644 index 000000000000..636fc3676094 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByEnrollmentAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "8608480", + "enrollmentAccountName": "123456", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByInvoiceSection.json new file mode 100644 index 000000000000..5e0e44a84c39 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentDeleteByInvoiceSection.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingAccount.json new file mode 100644 index 000000000000..7118380548ea --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingAccount.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-01-04T22:39:34.2606750Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingProfile.json new file mode 100644 index 000000000000..b7f629fcf219 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByBillingProfile.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-01-04T22:39:34.2606750Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "46b831ec-42b2-4f1a-8b54-3fd5ff9d6aa1", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByCustomer.json new file mode 100644 index 000000000000..2ef6468dab0f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByCustomer.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d", + "billingRoleAssignmentName": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-01-04T22:39:34.2606750Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByDepartment.json new file mode 100644 index 000000000000..5b9c2cbe3505 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByDepartment.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "departmentName": "225314", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/225314", + "userAuthenticationType": "Organization", + "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByEnrollmentAccount.json new file mode 100644 index 000000000000..77fa64ec2eac --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByEnrollmentAccount.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "7898901", + "enrollmentAccountName": "225314", + "billingRoleAssignmentName": "9dfd08c2-62a3-4d47-85bd-1cdba1408402" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314", + "userAuthenticationType": "Organization", + "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json new file mode 100644 index 000000000000..8aca100e4965 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentGetByInvoiceSection.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx", + "billingRoleAssignmentName": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "46b831ec-42b2-4f1a-8b54-3fd5ff9d6aa1", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingAccount.json new file mode 100644 index 000000000000..9d6a9a865dc4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingAccount.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.json new file mode 100644 index 000000000000..59e87272e0d2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByBillingProfile.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json new file mode 100644 index 000000000000..3dd9bdfd2c60 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByCustomer.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/customers/703ab484-dda2-4402-827b-a74513b61e2d", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByDepartment.json new file mode 100644 index 000000000000..2b11ec60bfaf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByDepartment.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "departmentName": "12345" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "\"/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/departments/12345", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json new file mode 100644 index 000000000000..da059bfb8625 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByEnrollmentAccount.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6100092", + "enrollmentAccountName": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456/billingRoleDefinitions/50000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/6100092/enrollmentAccounts/123456", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByInvoiceSection.json new file mode 100644 index 000000000000..8946b833b4fc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleAssignmentListByInvoiceSection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingAccount.json new file mode 100644 index 000000000000..803b14359713 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingAccount.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "roleDefinitionName": "50000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000000", + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000002", + "50000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000004", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018", + "40000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000016" + ] + } + ], + "roleName": "Billing account owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingProfile.json new file mode 100644 index 000000000000..b8e1eb08b3ba --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByBillingProfile.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "roleDefinitionName": "40000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000000", + "name": "40000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the billing profile.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000011", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Billing profile owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByCustomer.json new file mode 100644 index 000000000000..6ae32186004a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByCustomer.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "roleDefinitionName": "30000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the customer.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ], + "notActions": [] + } + ], + "roleName": "Customer owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByDepartment.json new file mode 100644 index 000000000000..6ed579f03f56 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByDepartment.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456", + "departmentName": "7368531", + "roleDefinitionName": "50000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/departments/action", + "Microsoft.Billing/billingAccounts/departments/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete" + ] + } + ], + "roleName": "Department Admin" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByEnrollmentAccount.json new file mode 100644 index 000000000000..e02092937c61 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByEnrollmentAccount.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456", + "enrollmentAccountName": "4568789", + "roleDefinitionName": "50000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/4568789/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/action" + ] + } + ], + "roleName": "Account Owner" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByInvoiceSection.json new file mode 100644 index 000000000000..e0f495cee1f9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionGetByInvoiceSection.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "roleDefinitionName": "30000000-aaaa-bbbb-cccc-100000000000" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ] + } + ], + "roleName": "Invoice section owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingAccount.json new file mode 100644 index 000000000000..e4a4e49d4ccb --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingAccount.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000000", + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000002", + "50000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000004", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018", + "40000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000016" + ] + } + ], + "roleName": "Billing account owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000001", + "name": "50000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role gives the user all permissions except access management on the organization.", + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000002", + "50000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000004", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000016" + ] + } + ], + "roleName": "Billing account contributor" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002", + "name": "50000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The Reader role gives the user read permissions to an organization.", + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "10000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012" + ] + } + ], + "roleName": "Billing account reader" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002", + "name": "50000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The Reader role gives the user read permissions to an organization.", + "permissions": [ + { + "actions": [ + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000006", + "50000000-aaaa-bbbb-cccc-200000000007", + "10000000-aaaa-bbbb-cccc-200000000003", + "50000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012" + ] + } + ], + "roleName": "Billing account reader" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000003", + "name": "50000000-aaaa-bbbb-cccc-100000000003", + "properties": { + "description": "The Purchaser role gives the user permissions to make purchases by creating new Projects and Billing Groups in an organization.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "50000000-aaaa-bbbb-cccc-200000000001", + "50000000-aaaa-bbbb-cccc-200000000006" + ] + } + ], + "roleName": "Basic Purchaser" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingProfile.json new file mode 100644 index 000000000000..9bc8534a7287 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByBillingProfile.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000000", + "name": "40000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the billing profile.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000011", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Billing profile owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000001", + "name": "40000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role gives the user all permissions except access management rights to the billing profile.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000001", + "40000000-aaaa-bbbb-cccc-200000000002", + "40000000-aaaa-bbbb-cccc-200000000003", + "40000000-aaaa-bbbb-cccc-200000000004", + "40000000-aaaa-bbbb-cccc-200000000005", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000011", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Billing profile contributor" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000002", + "name": "40000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The Reader role gives the user read only access to the billing profile.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012" + ] + } + ], + "roleName": "Billing profile reader" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/40000000-aaaa-bbbb-cccc-100000000004", + "name": "40000000-aaaa-bbbb-cccc-100000000004", + "properties": { + "description": "The Invoice Manager role gives the user the ability to view and manage invoices.", + "permissions": [ + { + "actions": [ + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000011", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000012", + "40000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Invoice manager" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByCustomer.json new file mode 100644 index 000000000000..22eb385cd955 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByCustomer.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the customer.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ], + "notActions": [] + } + ], + "roleName": "Customer owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", + "name": "30000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role gives the user all permissions except access management rights to the customer.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ], + "notActions": [] + } + ], + "roleName": "Customer contributor" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", + "name": "30000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The reader role gives the user read only access to the customer.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017" + ], + "notActions": [] + } + ], + "roleName": "Customer reader" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByDepartment.json new file mode 100644 index 000000000000..94d302ecf033 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByDepartment.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456", + "departmentName": "7368531" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000000", + "name": "50000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/departments/action", + "Microsoft.Billing/billingAccounts/departments/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read" + ] + } + ], + "roleName": "Department Admin" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/7368531/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000001", + "name": "50000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read" + ] + } + ], + "roleName": "Department Reader" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByEnrollmentAccount.json new file mode 100644 index 000000000000..6bc509e9defc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByEnrollmentAccount.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456", + "enrollmentAccountName": "4568789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/4568789/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The account owner role gives the user all permissions including access management rights to an accounts.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/action" + ], + "notActions": [] + } + ], + "roleName": "Account Owner" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByInvoiceSection.json new file mode 100644 index 000000000000..5ab131564f76 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRoleDefinitionListByInvoiceSection.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "name": "30000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ] + } + ], + "roleName": "Invoice section owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000001", + "name": "30000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role gives the user all permissions except access management rights to the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000003", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000005", + "30000000-aaaa-bbbb-cccc-200000000006", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000008", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000011", + "30000000-aaaa-bbbb-cccc-200000000012", + "30000000-aaaa-bbbb-cccc-200000000013", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000016", + "30000000-aaaa-bbbb-cccc-200000000017", + "30000000-aaaa-bbbb-cccc-200000000018" + ] + } + ], + "roleName": "Invoice section contributor" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000002", + "name": "30000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The reader role gives the user read only access to the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000017" + ] + } + ], + "roleName": "Invoice section reader" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000006", + "name": "30000000-aaaa-bbbb-cccc-100000000006", + "properties": { + "description": "The Azure subscription creator role gives the user the ability to create an Azure subscription for the invoice section.", + "permissions": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000013" + ] + } + ], + "roleName": "Azure subscription creator" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasCreateOrUpdate.json new file mode 100644 index 000000000000..157ea2b16c06 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasCreateOrUpdate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "aliasName": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "parameters": { + "properties": { + "billingFrequency": "P1M", + "displayName": "Subscription 3", + "quantity": 1, + "skuId": "0001", + "termDuration": "P1M" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", + "name": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "properties": { + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Billing Subscription Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", + "name": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "properties": { + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Billing Subscription Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/putBillingSubscriptionAlias_c356b7c7-7545-4686-b843-c1a49cf853fc:11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasGet.json new file mode 100644 index 000000000000..b5e4519c85be --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "aliasName": "c356b7c7-7545-4686-b843-c1a49cf853fc" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/c356b7c7-7545-4686-b843-c1a49cf853fc", + "name": "c356b7c7-7545-4686-b843-c1a49cf853fc", + "properties": { + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Billing Subscription Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasList.json new file mode 100644 index 000000000000..82cb718d5786 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionAliasList.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000000", + "name": "90000000-0000-0000-0000-000000000000", + "properties": { + "billingSubscriptionId": "11111111-1111-1111-1111-111111111111", + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "My subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/11111111-1111-1111-1111-111111111111", + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000001", + "name": "90000000-0000-0000-0000-000000000001", + "properties": { + "billingSubscriptionId": "22222222-2222-2222-2222-222222222222", + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Test subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "Software", + "productType": "Software Product Type", + "productTypeId": "EFG456", + "purchaseDate": "2023-01-06T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/22222222-2222-2222-2222-222222222222", + "termDuration": "P1M", + "termStartDate": "2023-01-07T22:39:34.2606750Z", + "termEndDate": "2023-02-07T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "systemData": { + "createdAt": "2023-01-06T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-07T22:39:34.2606750Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptionAliases/90000000-0000-0000-0000-000000000002", + "name": "90000000-0000-0000-0000-000000000002", + "properties": { + "billingSubscriptionId": "33333333-3333-3333-3333-333333333333", + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Dev subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "ReservationOrder", + "productType": "Reservation Product Type", + "productTypeId": "JKL789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "resourceUri": "/providers/Microsoft.Capacity/reservationOrders/33333333-3333-3333-3333-333333333333", + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Suspended", + "suspensionReasons": [ + "Cancelled" + ], + "suspensionReasonDetails": [ + { + "effectiveDate": "2023-01-15T22:39:34.2606750Z", + "reason": "Cancelled" + } + ] + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptionAliases", + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionGetByBillingProfile.json new file mode 100644 index 000000000000..3c66a75b44ed --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionGetByBillingProfile.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "pcn.94077792", + "billingProfileName": "6478903", + "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903", + "billingProfileName": "47268432", + "displayName": "My Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/6564892/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "quantity": 50, + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "systemOverrides": { + "cancellation": "Allowed", + "cancellationAllowedEndDate": "2023-01-05T22:39:34.2606750Z" + }, + "provisioningTenantId": "7d62dbd1-1348-4496-b2f8-df6948c103ee", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingSubscriptions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionMove.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionMove.json new file mode 100644 index 000000000000..709de40b4567 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionMove.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "consumptionCostCenter": "ABC1234", + "displayName": "My Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/operationResults/moveBillingSubscription_11000000-0000-0000-0000-000000000000:22000000-0000-0000-0000-000000000000:6b96d3f2-9008-4a9d-912f-f87744185aa3:44000000-0000-0000-0000-000000000055:10000000-0000-0000-0000-000000000001?api-version=2020-12-15-privatepreview", + "Retry-After": "30" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveFailure.json new file mode 100644 index 000000000000..2f6bbf83fe3f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveFailure.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + } + }, + "responses": { + "200": { + "body": { + "errorDetails": { + "code": "SubscriptionNotActive", + "message": "Invoice Sections can only be changed for active subscriptions." + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveSuccess.json new file mode 100644 index 000000000000..6be9d3debae2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionValidateMoveSuccess.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "billingSubscriptionName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + } + }, + "responses": { + "200": { + "body": { + "isMoveEligible": true + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsCancel.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsCancel.json new file mode 100644 index 000000000000..eb572f74a4f7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsCancel.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "cancellationReason": "Compromise", + "customerId": "11111111-1111-1111-1111-111111111111" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/cancelBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsDelete.json new file mode 100644 index 000000000000..2ef935ea444e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/cancelBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsGet.json new file mode 100644 index 000000000000..69239001d314 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "name": "90000000-0000-0000-0000-000000000000", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "My subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json new file mode 100644 index 000000000000..cf5fa5ea5f24 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "excludeCharges": false, + "includeDeleted": false, + "includeTenantSubscriptions": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "name": "90000000-0000-0000-0000-000000000000", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "My subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001", + "name": "90000000-0000-0000-0000-000000000001", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Test subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "Software", + "productType": "Software Product Type", + "productTypeId": "EFG456", + "purchaseDate": "2023-01-06T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001", + "termDuration": "P1M", + "termStartDate": "2023-01-07T22:39:34.2606750Z", + "termEndDate": "2023-02-07T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "systemData": { + "createdAt": "2023-01-06T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-07T22:39:34.2606750Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000002", + "name": "90000000-0000-0000-0000-000000000002", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Dev subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "ReservationOrder", + "productType": "Reservation Product Type", + "productTypeId": "JKL789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "resourceUri": "/providers/Microsoft.Capacity/reservationOrders/90000000-0000-0000-0000-000000000002", + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Suspended", + "suspensionReasons": [ + "Cancelled" + ], + "suspensionReasonDetails": [ + { + "effectiveDate": "2023-01-15T22:39:34.2606750Z", + "reason": "Cancelled" + } + ] + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json new file mode 100644 index 000000000000..d84a83a85a99 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "pcn.94077792", + "billingProfileName": "6478903" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/pcn.94077792/billingProfiles/6478903", + "billingProfileName": "47268432", + "displayName": "My Subscription", + "enrollmentAccountId": "172988", + "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingSubscriptions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileMCA.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileMCA.json new file mode 100644 index 000000000000..9d937156f3fe --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileMCA.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "My Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Test Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "status": "Active", + "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Dev Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "status": "Active", + "subscriptionId": "90D31600-D46D-4084-84C6-1235CDAFFB56" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Dev Test Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Domain Name Registration ORG", + "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "status": "Active", + "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomer.json new file mode 100644 index 000000000000..fb2066395f9b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomer.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "BillingProfile1", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", + "customerDisplayName": "Customer1", + "displayName": "My Subscription", + "reseller": { + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", + "description": "Reseller1" + }, + "skuId": "0002", + "skuDescription": "Microsoft Azure Standard", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "BillingProfile1", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "customerDisplayName": "Customer1", + "displayName": "Test Subscription", + "reseller": { + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", + "description": "Reseller3" + }, + "skuId": "0002", + "skuDescription": "Microsoft Azure Standard", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "status": "Active", + "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "BillingProfile1", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "customerDisplayName": "Customer1", + "displayName": "Dev Test Subscription", + "skuId": "0001", + "skuDescription": "Domain Name Registration ORG", + "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "status": "Active", + "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomerAtBillingAccount.json new file mode 100644 index 000000000000..d472c8ae74b2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByCustomerAtBillingAccount.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "customerName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "BillingProfile1", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", + "customerDisplayName": "Customer1", + "displayName": "My Subscription", + "reseller": { + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", + "description": "Reseller1" + }, + "skuId": "0002", + "skuDescription": "Microsoft Azure Standard", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "BillingProfile1", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "customerDisplayName": "Customer1", + "displayName": "Test Subscription", + "reseller": { + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", + "description": "Reseller3" + }, + "skuId": "0002", + "skuDescription": "Microsoft Azure Standard", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "status": "Active", + "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "BillingProfile1", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "customerDisplayName": "Customer1", + "displayName": "Dev Test Subscription", + "skuId": "0001", + "skuDescription": "Domain Name Registration ORG", + "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "status": "Active", + "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json new file mode 100644 index 000000000000..3c5cab3ccedd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892", + "enrollmentAccountName": "172988" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "name": "90000000-0000-0000-0000-000000000000", + "properties": { + "consumptionCostCenter": "123", + "displayName": "TestSubscription", + "enrollmentAccountId": "172988", + "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "enrollmentAccountSubscriptionDetails": { + "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z" + }, + "subscriptionId": "90000000-0000-0000-0000-000000000000" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/6564892/billingSubscriptions/90000000-0000-0000-0000-000000000001", + "name": "90000000-0000-0000-0000-000000000001", + "properties": { + "consumptionCostCenter": "", + "displayName": "Microsoft Azure Enterprise-1", + "enrollmentAccountId": "172988", + "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "enrollmentAccountSubscriptionDetails": { + "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z", + "subscriptionEnrollmentAccountStatus": "Deleted" + }, + "subscriptionId": "90000000-0000-0000-0000-000000000001" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByInvoiceSection.json new file mode 100644 index 000000000000..1b6d720e06c1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByInvoiceSection.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "My Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "status": "Active", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Test Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "status": "Active", + "subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Dev Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/90D31600-D46D-4084-84C6-1235CDAFFB56", + "status": "Active", + "subscriptionId": "90D31600-D46D-4084-84C6-1235CDAFFB56" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Dev Test Subscription", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Domain Name Registration ORG", + "resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "status": "Active", + "subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsMerge.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsMerge.json new file mode 100644 index 000000000000..8de5be257344 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsMerge.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "targetBillingSubscriptionName": "22222222-2222-2222-2222-222222222222", + "quantity": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Billing Subscription Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 2, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/splitBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsSplit.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsSplit.json new file mode 100644 index 000000000000..e543605999b9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsSplit.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "targetProductTypeId": "XYZ56789", + "targetSkuId": "0001", + "quantity": 1, + "termDuration": "P1M", + "billingFrequency": "P1M" + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Billing Subscription Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/splitBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsUpdate.json new file mode 100644 index 000000000000..415a2c20f6ba --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingSubscriptionName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "consumptionCostCenter": "ABC1234" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "displayName": "Billing Subscription Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "productCategory": "SeatBased", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "skuId": "0001", + "skuDescription": "SKU Description", + "systemOverrides": { + "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z" + }, + "termDuration": "P1M", + "termStartDate": "2023-01-05T22:39:34.2606750Z", + "termEndDate": "2023-02-05T22:39:34.2606750Z", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "systemData": { + "createdAt": "2023-01-05T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-25T22:39:34.2606750Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/manageBillingSubscription_11111111-1111-1111-1111-111111111111:22222222-2222-2222-2222-222222222222?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByBillingAccount.json new file mode 100644 index 000000000000..5f13a4f6bd5e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByBillingAccount.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByBillingProfile.json new file mode 100644 index 000000000000..f4d5437d5c4a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByBillingProfile.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByCustomer.json new file mode 100644 index 000000000000..d1a84fcc0698 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByCustomer.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByDepartment.json new file mode 100644 index 000000000000..9392d497629c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByDepartment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "departmentName": "12345", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByEnrollmentAccount.json new file mode 100644 index 000000000000..13b589c0e9d3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByEnrollmentAccount.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "enrollmentAccountName": "123456", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByInvoiceSection.json new file mode 100644 index 000000000000..9183596dc5c6 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/checkAccessByInvoiceSection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "parameters": { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + }, + "responses": { + "200": { + "body": [ + { + "accessDecision": "Allowed", + "action": "Microsoft.Billing/billingAccounts/read" + }, + { + "accessDecision": "NotAllowed", + "action": "Microsoft.Subscription/subscriptions/write" + } + ] + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGet.json new file mode 100644 index 000000000000..0420a61fbaf1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "systemId": "yyyy-yyyy-yyy-yyy", + "status": "Active", + "enabledAzurePlans": [ + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "resellers": [ + { + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", + "description": "Reseller1" + }, + { + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", + "description": "Reseller2" + } + ], + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGetByBillingAccount.json new file mode 100644 index 000000000000..3166cddbe70e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersGetByBillingAccount.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "systemId": "yyyy-yyyy-yyy-yyy", + "status": "Active", + "enabledAzurePlans": [ + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "resellers": [ + { + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", + "description": "Reseller1" + }, + { + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", + "description": "Reseller2" + } + ], + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingAccount.json new file mode 100644 index 000000000000..572f5fb6eb48 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingAccount.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "systemId": "yyyy-yyyy-yyy-yyy", + "status": "Active", + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer2", + "systemId": "zzzz-zzzz-zzz-zzz", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingAccountWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingAccountWithExpand.json new file mode 100644 index 000000000000..abdd7d4acfe7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingAccountWithExpand.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expand": "enabledAzurePlans,resellers" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "systemId": "yyyy-yyyy-yyy-yyy", + "status": "Active", + "enabledAzurePlans": [ + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "resellers": [ + { + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", + "description": "Reseller1" + }, + { + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", + "description": "Reseller2" + } + ], + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingProfile.json new file mode 100644 index 000000000000..6655c8fba7a2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/customersListByBillingProfile.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer1", + "systemId": "yyyy-yyyy-yyy-yyy", + "status": "Active", + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "properties": { + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "displayName": "customer2", + "systemId": "zzzz-zzzz-zzz-zzz", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/departmentGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/departmentGet.json new file mode 100644 index 000000000000..a876fa5a6f7b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/departmentGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "456598", + "departmentName": "164821" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164821", + "name": "164821", + "properties": { + "costCenter": "C1", + "displayName": "Test department", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/departments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/departmentsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/departmentsListByBillingAccount.json new file mode 100644 index 000000000000..1d530f257b1d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/departmentsListByBillingAccount.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "456598" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164821", + "name": "164821", + "properties": { + "costCenter": "C1", + "displayName": "departmentName1", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/departments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/456598/departments/164822", + "name": "164822", + "properties": { + "costCenter": "C4", + "displayName": "departmentName2", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/departments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountByDepartment.json new file mode 100644 index 000000000000..69e8c2ad9aeb --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountByDepartment.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892", + "departmentName": "164821", + "enrollmentAccountName": "257698" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698", + "name": "257698", + "properties": { + "costCenter": "C0", + "displayName": "AccountName0", + "departmentDisplayName": "TestDept", + "departmentId": "164821", + "isDevTestEnabled": true, + "accountOwner": "account0@contoso.com", + "authType": "MicrosoftAccount", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + }, + "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountGet.json new file mode 100644 index 000000000000..1727fe1059f8 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892", + "enrollmentAccountName": "257698" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/257698", + "name": "257698", + "properties": { + "costCenter": "C0", + "displayName": "AccountName0", + "departmentDisplayName": "TestDept123", + "departmentId": "234516", + "isDevTestEnabled": true, + "accountOwner": "account0@contoso.com", + "authType": "Organization", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByBillingAccount.json new file mode 100644 index 000000000000..5516c5102f55 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByBillingAccount.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/257698", + "name": "257698", + "properties": { + "costCenter": "C0", + "displayName": "AccountName0", + "departmentDisplayName": "TestDept123", + "departmentId": "234516", + "isDevTestEnabled": true, + "accountOwner": "account0@contoso.com", + "authType": "Organization", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/264698", + "name": "264698", + "properties": { + "costCenter": "C1", + "displayName": "AccountName1", + "departmentDisplayName": "TestDept1", + "departmentId": "234531", + "isDevTestEnabled": true, + "accountOwner": "account1@contoso.com", + "authType": "MicrosoftAccount", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/enrollmentAccounts/276290", + "name": "276290", + "properties": { + "costCenter": "C2", + "displayName": "AccountName2", + "departmentDisplayName": "TestDept2", + "departmentId": "234512", + "isDevTestEnabled": true, + "accountOwner": "account2@contoso.com", + "authType": "Organization", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json new file mode 100644 index 000000000000..e08ee1045efe --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "6564892", + "departmentName": "164821" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698", + "name": "257698", + "properties": { + "costCenter": "C0", + "displayName": "AccountName0", + "departmentDisplayName": "TestDept", + "departmentId": "164821", + "isDevTestEnabled": true, + "accountOwner": "account0@contoso.com", + "authType": "MicrosoftAccount", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + }, + "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/264698", + "name": "264698", + "properties": { + "costCenter": "C1", + "displayName": "AccountName1", + "departmentDisplayName": "TestDept", + "departmentId": "164821", + "isDevTestEnabled": false, + "accountOwner": "account1@contoso.com", + "authType": "Organization", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + }, + "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsCreateOrUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsCreateOrUpdate.json new file mode 100644 index 000000000000..f7f6a1a1731e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsCreateOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "invoice-section-1", + "parameters": { + "properties": { + "displayName": "Invoice Section 1", + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", + "name": "invoice-section-1", + "properties": { + "displayName": "Invoice Section 1", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", + "name": "invoice-section-1", + "properties": { + "displayName": "Invoice Section 1", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/putAssociatedTenant_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsDelete.json new file mode 100644 index 000000000000..0bcbd1035e0c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/deleteInvoiceSection_00000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "retry-after": "10" + } + }, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsGet.json new file mode 100644 index 000000000000..7ea5ce403fe1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", + "name": "invoice-section-1", + "properties": { + "displayName": "Invoice Section 1", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsListByBillingProfile.json new file mode 100644 index 000000000000..b143a636d1a1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsListByBillingProfile.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "includeDeleted": true + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-1", + "name": "invoice-section-1", + "properties": { + "displayName": "Invoice Section 1", + "state": "Active", + "systemId": "yyyy-yyyy-yyy-yyy", + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-2", + "name": "invoice-section-2", + "properties": { + "displayName": "Invoice Section 2", + "state": "Warned", + "reasonCode": "PastDue", + "systemId": "zzzz-zzzz-zzz-zzz", + "tags": { + "pcCode": "Z345678", + "costCategory": "Marketing" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/invoice-section-3", + "name": "invoice-section-3", + "properties": { + "displayName": "Invoice Section 3", + "state": "Deleted", + "systemId": "aaaa-aaaa-aaa-aaa", + "tags": { + "pcCode": "A123456", + "costCategory": "Support" + } + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilityFailure.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilityFailure.json new file mode 100644 index 000000000000..c274e79aded2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilityFailure.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "eligibilityStatus": "NotAllowed", + "eligibilityDetails": [ + { + "code": "ActiveBillingSubscriptions", + "message": "There are active or disabled subscriptions assigned to the invoice section. Either move the subscription to another invoice section or delete the subscriptions and then try deleting the invoice section." + }, + { + "code": "LastInvoiceSection", + "message": "This is the only invoice section in this billing profile so it can’t be deleted." + }, + { + "code": "ActiveAzurePlans", + "message": "This is the invoice section that was created when its billing profile was created so it can’t be deleted." + }, + { + "code": "ReservedInstances", + "message": "The invoice section has the RI asset with a billing plan." + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilitySuccess.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilitySuccess.json new file mode 100644 index 000000000000..21f8bfc23c13 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsValidateDeleteEligibilitySuccess.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsWithCreateSubscriptionPermissionList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsWithCreateSubscriptionPermissionList.json new file mode 100644 index 000000000000..878a9223f35e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoiceSectionsWithCreateSubscriptionPermissionList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "billingProfileDisplayName": "Billing Profile Display Name", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileSystemId": "33000000-0000-0000-0000-000000000000", + "billingProfileStatus": "Warned", + "billingProfileStatusReasonCode": "PastDue", + "billingProfileSpendingLimit": "On", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceSectionDisplayName": "Invoice Section Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionSystemId": "22000000-0000-0000-0000-000000000000" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesAmend.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesAmend.json new file mode 100644 index 000000000000..9aeb97d29b16 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesAmend.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789/operationResults/invoiceAmend_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadByBillingAccount.json new file mode 100644 index 000000000000..50877f606d79 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadByBillingAccount.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789", + "documentName": "12345678" + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadByBillingSubscription.json new file mode 100644 index 000000000000..cd1d29c4d592 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadByBillingSubscription.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "invoiceName": "E123456789", + "documentName": "12345678" + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/00000000-0000-0000-0000-000000000000/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.json new file mode 100644 index 000000000000..3dd14b57b953 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "parameters": [ + { + "documentName": "12345678", + "invoiceName": "G123456789" + }, + { + "documentName": "12345678", + "invoiceName": "G987654321" + } + ] + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json new file mode 100644 index 000000000000..872bde3b455b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": [ + { + "documentName": "12345678", + "invoiceName": "E123456789" + }, + { + "documentName": "12345678", + "invoiceName": "E987654321" + } + ] + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/00000000-0000-0000-0000-000000000000/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadSummaryByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadSummaryByBillingAccount.json new file mode 100644 index 000000000000..f2c3759ba5de --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadSummaryByBillingAccount.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "123456789", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724_summary.pdf?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456789/operationResults/invoiceSummaryDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGet.json new file mode 100644 index 000000000000..3631d75fc2d7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGet.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "name": "G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documents": [ + { + "kind": "Invoice", + "name": "12345678" + }, + { + "kind": "TaxReceipt", + "name": "22345678" + } + ], + "documentType": "Invoice", + "dueDate": "2023-02-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "isMonthlyInvoice": false, + "purchaseOrderNumber": "123456", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + } + }, + "status": "Due", + "specialTaxationType": "SubtotalLevel", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + }, + "type": "Microsoft.Billing/billingAccounts/invoices" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGetByBillingAccount.json new file mode 100644 index 000000000000..9f901c68983f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGetByBillingAccount.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "name": "G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documents": [ + { + "kind": "Invoice", + "name": "12345678" + }, + { + "kind": "TaxReceipt", + "name": "22345678" + } + ], + "documentType": "Invoice", + "dueDate": "2023-02-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "isMonthlyInvoice": false, + "purchaseOrderNumber": "123456", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + } + }, + "status": "Due", + "specialTaxationType": "SubtotalLevel", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + }, + "type": "Microsoft.Billing/billingAccounts/invoices" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGetByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGetByBillingSubscription.json new file mode 100644 index 000000000000..61816249e447 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesGetByBillingSubscription.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "invoiceName": "E123456789" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E123456789", + "name": "E123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "dueDate": "2023-02-16T17:32:28Z", + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "invoiceType": "AzureServices", + "purchaseOrderNumber": "123456", + "status": "Due", + "subscriptionDisplayName": "Contoso Operations Billing", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingAccount.json new file mode 100644 index 000000000000..9027fef1b823 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingAccount.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "periodStartDate": "2023-01-01", + "periodEndDate": "2023-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "name": "G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documents": [ + { + "kind": "Invoice", + "name": "12345678" + }, + { + "kind": "TaxReceipt", + "name": "22345678" + } + ], + "documentType": "Invoice", + "dueDate": "2023-02-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "isMonthlyInvoice": false, + "purchaseOrderNumber": "123456", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + } + }, + "status": "Due", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + }, + "type": "Microsoft.Billing/billingAccounts/invoices" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", + "name": "G987654321", + "properties": { + "amountDue": { + "currency": "USD", + "value": 0 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documents": [ + { + "kind": "Invoice", + "name": "12345678" + }, + { + "kind": "TaxReceipt", + "name": "22345678" + } + ], + "documentType": "Invoice", + "dueDate": "2023-01-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-01-01T17:32:28Z", + "invoicePeriodEndDate": "2023-01-15T17:32:28Z", + "invoicePeriodStartDate": "2023-01-01T17:32:28Z", + "isMonthlyInvoice": false, + "payments": [ + { + "amount": { + "currency": "USD", + "value": 33.99 + }, + "date": "2023-01-14T17:32:28Z", + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa", + "paymentType": "debited" + } + ], + "purchaseOrderNumber": "123455", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + } + }, + "status": "Paid", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + }, + "type": "Microsoft.Billing/billingAccounts/invoices" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json new file mode 100644 index 000000000000..ecf3db7b638b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "periodStartDate": "2023-01-01", + "periodEndDate": "2023-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "name": "G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documents": [ + { + "kind": "Invoice", + "name": "12345678" + }, + { + "kind": "TaxReceipt", + "name": "22345678" + } + ], + "documentType": "Invoice", + "dueDate": "2023-02-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "isMonthlyInvoice": false, + "purchaseOrderNumber": "123456", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + } + }, + "status": "Due", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + }, + "type": "Microsoft.Billing/billingAccounts/invoices" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321", + "name": "G987654321", + "properties": { + "amountDue": { + "currency": "USD", + "value": 0 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "billingProfileDisplayName": "Contoso Operations Billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "creditAmount": { + "currency": "USD", + "value": 0 + }, + "documents": [ + { + "kind": "Invoice", + "name": "12345678" + }, + { + "kind": "TaxReceipt", + "name": "22345678" + } + ], + "documentType": "Invoice", + "dueDate": "2023-01-16T17:32:28Z", + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0 + }, + "invoiceDate": "2023-01-01T17:32:28Z", + "invoicePeriodEndDate": "2023-01-15T17:32:28Z", + "invoicePeriodStartDate": "2023-01-01T17:32:28Z", + "isMonthlyInvoice": false, + "payments": [ + { + "amount": { + "currency": "USD", + "value": 33.99 + }, + "date": "2023-01-14T17:32:28Z", + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa", + "paymentType": "debited" + } + ], + "purchaseOrderNumber": "123455", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2", + "rebillDetails": { + "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001", + "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote" + } + }, + "status": "Paid", + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 1 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + } + }, + "type": "Microsoft.Billing/billingAccounts/invoices" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingSubscription.json new file mode 100644 index 000000000000..9ea623b7b3b5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingSubscription.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "periodStartDate": "2023-01-01", + "periodEndDate": "2023-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E123456789", + "name": "E123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "dueDate": "2023-02-16T17:32:28Z", + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "invoiceType": "AzureServices", + "purchaseOrderNumber": "123456", + "status": "Due", + "subscriptionDisplayName": "Contoso Operations Billing", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/G123456789", + "name": "G123456789", + "properties": { + "amountDue": { + "currency": "USD", + "value": 15.53 + }, + "billedAmount": { + "currency": "USD", + "value": 55.99 + }, + "dueDate": "2023-02-16T17:32:28Z", + "invoiceDate": "2023-02-01T17:32:28Z", + "invoicePeriodEndDate": "2023-02-15T17:32:28Z", + "invoicePeriodStartDate": "2023-02-01T17:32:28Z", + "invoiceType": "AzureMarketplace", + "purchaseOrderNumber": "123456", + "status": "Due", + "subscriptionDisplayName": "Contoso Operations Billing", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E987654321", + "name": "E987654321", + "properties": { + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "documents": [ + { + "kind": "Invoice", + "name": "12345678" + } + ], + "dueDate": "2023-01-16T17:32:28Z", + "invoiceDate": "2023-01-01T17:32:28Z", + "invoicePeriodEndDate": "2023-01-15T17:32:28Z", + "invoicePeriodStartDate": "2023-01-01T17:32:28Z", + "invoiceType": "AzureSupport", + "payments": [ + { + "amount": { + "currency": "USD", + "value": 2000 + }, + "date": "2023-01-14T17:32:28Z", + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa", + "paymentType": "credited" + } + ], + "purchaseOrderNumber": "123456", + "status": "Due", + "subscriptionDisplayName": "Contoso Operations Billing", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/operationsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/operationsList.json new file mode 100644 index 000000000000..43d9ddc7dba2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/operationsList.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{namespace}/resource/read", + "display": { + "operation": "List resources", + "provider": "{namespace}", + "resource": "resource" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersCancel.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersCancel.json new file mode 100644 index 000000000000..05c6064bc437 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersCancel.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "initiatorCustomerType": "Partner", + "canceledBy": "user@contoso.com" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersGet.json new file mode 100644 index 000000000000..077a453b3dd3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "initiatorCustomerType": "Partner", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "productName": "Reservation name", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ] + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersInitiate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersInitiate.json new file mode 100644 index 000000000000..2f504241e882 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersInitiate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "transferName": "aabb123", + "parameters": { + "properties": { + "recipientEmailId": "user@contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "initiatorCustomerType": "Partner" + } + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "initiatorCustomerType": "Partner" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersList.json new file mode 100644 index 000000000000..9a99ec1f3832 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/partnerTransfersList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "initiatorCustomerType": "Partner", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "productName": "Reservation name", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsDeleteAtBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsDeleteAtBillingProfile.json new file mode 100644 index 000000000000..ad9a0b34e97d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsDeleteAtBillingProfile.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31", + "billingProfileName": "ABC1-A1CD-AB1-BP1", + "paymentMethodName": "ABCDABCDABC0" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethodLinks/operationResults/ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsDeleteByUser.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsDeleteByUser.json new file mode 100644 index 000000000000..1573481c5c15 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsDeleteByUser.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "paymentMethodName": "ABCDABCDABC0" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingAccount.json new file mode 100644 index 000000000000..d43dbe5178c0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingAccount.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31", + "paymentMethodName": "21dd9edc-af71-4d62-80ce-37151d475326" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/paymentMethods/21dd9edc-af71-4d62-80ce-37151d475326", + "name": "21dd9edc-af71-4d62-80ce-37151d475326", + "type": "Microsoft.Billing/billingAccounts/paymentMethods", + "properties": { + "family": "CheckWire", + "paymentMethodType": "check", + "displayName": "Check/wire transfer" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.json new file mode 100644 index 000000000000..fb10f118429b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByBillingProfile.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31", + "billingProfileName": "ABC1-A1CD-AB1-BP1", + "paymentMethodName": "ABCDABCDABC0" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0", + "name": "ABCDABCDABC0", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/paymentMethodLinks", + "properties": { + "paymentMethodId": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "accountHolderName": "abc", + "expiration": "1/2035", + "lastFourDigits": "1270", + "family": "CreditCard", + "paymentMethodType": "mc", + "displayName": "Master Card", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" + } + ], + "status": "active" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByUser.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByUser.json new file mode 100644 index 000000000000..03ac39e0d9f3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsGetByUser.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "paymentMethodName": "ABCDABCDABC0" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "name": "ABCDABCDABC0", + "type": "Microsoft.Billing/paymentMethods", + "properties": { + "accountHolderName": "abc", + "expiration": "1/2035", + "lastFourDigits": "1270", + "family": "CreditCard", + "paymentMethodType": "mc", + "displayName": "Master Card", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" + } + ], + "status": "active" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByBillingAccount.json new file mode 100644 index 000000000000..d75938f2a479 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByBillingAccount.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/paymentMethods/21dd9edc-af71-4d62-80ce-37151d475326", + "name": "21dd9edc-af71-4d62-80ce-37151d475326", + "properties": { + "displayName": "Check/wire transfer", + "family": "CheckWire", + "paymentMethodType": "check" + }, + "type": "Microsoft.Billing/billingAccounts/paymentMethods" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByBillingProfile.json new file mode 100644 index 000000000000..876f72195042 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByBillingProfile.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31", + "billingProfileName": "ABC1-A1CD-AB1-BP1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000032:00000000-0000-0000-0000-000000000099_2019-05-31/billingProfiles/ABC1-A1CD-AB1-BP1/paymentMethodLinks/ABCDABCDABC0", + "name": "ABCDABCDABC0", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/paymentMethodLinks", + "properties": { + "paymentMethodId": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "accountHolderName": "abc", + "expiration": "1/2035", + "lastFourDigits": "1270", + "family": "CreditCard", + "paymentMethodType": "mc", + "displayName": "Master Card", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" + } + ], + "status": "active" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json new file mode 100644 index 000000000000..93f6f8355cce --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentMethodsListByUser.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "name": "ABCDABCDABC0", + "type": "Microsoft.Billing/paymentMethods", + "properties": { + "accountHolderName": "abc", + "expiration": "1/2035", + "lastFourDigits": "1270", + "family": "CreditCard", + "paymentMethodType": "mc", + "displayName": "Master Card", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_mc_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_mc.svg" + } + ], + "status": "active" + } + }, + { + "id": "/providers/Microsoft.Billing/paymentMethods/ABCDABCDABC1", + "name": "ABCDABCDABC1", + "type": "Microsoft.Billing/paymentMethods", + "properties": { + "accountHolderName": "abc", + "expiration": "1/2025", + "lastFourDigits": "7373", + "family": "CreditCard", + "paymentMethodType": "visa", + "displayName": "Visa", + "logos": [ + { + "mimeType": "image/png", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa_rect.png" + }, + { + "mimeType": "image/svg+xml", + "url": "https://contoso.com/staticresourceservice/images/v4/logo_visa.svg" + } + ], + "status": "active" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermInvalid.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermInvalid.json new file mode 100644 index 000000000000..30d437b35a74 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermInvalid.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "api-version": "2024-04-01", + "parameters": [ + { + "term": "net10", + "startDate": "2023-02-05T22:39:34.2606750Z", + "endDate": "2023-01-25T22:39:34.2606750Z" + } + ] + }, + "responses": { + "200": { + "body": { + "eligibilityStatus": "Invalid", + "eligibilityDetails": [ + { + "code": "InvalidDateRange", + "message": "The date range is invalid. The start date must be before the end date." + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermValid.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermValid.json new file mode 100644 index 000000000000..0cd84effd69c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermValid.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "api-version": "2024-04-01", + "parameters": [ + { + "term": "net10", + "startDate": "2023-01-05T22:39:34.2606750Z", + "endDate": "2023-01-25T22:39:34.2606750Z" + } + ] + }, + "responses": { + "200": { + "body": { + "eligibilityStatus": "Valid" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsAdd.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsAdd.json new file mode 100644 index 000000000000..7ecf399a26cb --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsAdd.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "api-version": "2024-04-01", + "parameters": [ + { + "term": "net10", + "startDate": "2023-01-05T22:39:34.2606750Z", + "endDate": "2023-01-25T22:39:34.2606750Z" + } + ] + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/addPaymentTerms_ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01", + "retry-after": "10", + "operation-id": "ed2975a8-8f77-43bb-a717-ace54326b14b" + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Enterprise", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsCancel.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsCancel.json new file mode 100644 index 000000000000..e0a806eeaf07 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsCancel.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "api-version": "2024-04-01", + "parameters": "2023-01-05T22:39:34.2606750Z" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/cancelPaymentTerms_ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01", + "retry-after": "10", + "operation-id": "ed2975a8-8f77-43bb-a717-ace54326b14b" + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "name": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "properties": { + "accountStatus": "Active", + "accountType": "Business", + "accountSubType": "Enterprise", + "agreementType": "MicrosoftCustomerAgreement", + "displayName": "Premier Business Account", + "hasReadAccess": true, + "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001" + }, + "type": "Microsoft.Billing/billingAccounts", + "systemData": { + "createdAt": "2023-01-04T22:39:34.2606750Z", + "lastModifiedAt": "2023-01-05T22:39:34.2606750Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByBillingAccount.json new file mode 100644 index 000000000000..557a8d860659 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByBillingAccount.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "1234567" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", + "name": "default", + "properties": { + "enterpriseAgreementPolicies": { + "authenticationType": "OrganizationalAccountOnly" + }, + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "NotAllowed" + }, + "type": "Microsoft.Billing/billingAccounts/policies" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByBillingProfile.json new file mode 100644 index 000000000000..f8fa70b88ffd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByBillingProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", + "name": "default", + "properties": { + "invoiceSectionLabelManagement": "Allowed", + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "Allowed" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByCustomer.json new file mode 100644 index 000000000000..c63a027a93d6 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByCustomer.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "policyName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "name": "default", + "properties": { + "viewCharges": "Allowed" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByCustomerAtBillingAccount.json new file mode 100644 index 000000000000..31151821dd51 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetByCustomerAtBillingAccount.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "customerName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "name": "default", + "properties": { + "viewCharges": "Allowed" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetBySubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetBySubscription.json new file mode 100644 index 000000000000..0f5ed801ddf6 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesGetBySubscription.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/policies/default", + "name": "default", + "properties": { + "policies": [ + { + "name": "ViewCharges", + "value": "Allowed", + "policyType": "SystemControlled", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000" + } + ] + }, + "type": "Microsoft.Billing/policies" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByBillingAccount.json new file mode 100644 index 000000000000..94ef59622ac5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByBillingAccount.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "1234567", + "parameters": { + "properties": { + "enterpriseAgreementPolicies": { + "authenticationType": "OrganizationalAccountOnly" + }, + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "NotAllowed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", + "name": "default", + "properties": { + "enterpriseAgreementPolicies": { + "authenticationType": "OrganizationalAccountOnly" + }, + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "NotAllowed" + }, + "type": "Microsoft.Billing/billingAccounts/policies" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/1234567/policies/default", + "name": "default", + "properties": { + "enterpriseAgreementPolicies": { + "authenticationType": "OrganizationalAccountOnly" + }, + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "NotAllowed" + }, + "type": "Microsoft.Billing/billingAccounts/policies" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByBillingProfile.json new file mode 100644 index 000000000000..9fd97563d7f8 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByBillingProfile.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "parameters": { + "properties": { + "invoiceSectionLabelManagement": "Allowed", + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "Allowed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", + "name": "default", + "properties": { + "invoiceSectionLabelManagement": "Allowed", + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "Allowed" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/policies/default", + "name": "default", + "properties": { + "invoiceSectionLabelManagement": "Allowed", + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "savingsPlanPurchases": "Allowed" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByCustomer.json new file mode 100644 index 000000000000..d3daf3ca1d7b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByCustomer.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "viewCharges": "Allowed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "name": "default", + "properties": { + "viewCharges": "Allowed" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "name": "default", + "properties": { + "viewCharges": "Allowed" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByCustomerAtBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByCustomerAtBillingAccount.json new file mode 100644 index 000000000000..81b1da8e4f12 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/policiesPutByCustomerAtBillingAccount.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "customerName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "viewCharges": "Allowed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "name": "default", + "properties": { + "viewCharges": "Allowed" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/11111111-1111-1111-1111-111111111111/policies/default", + "name": "default", + "properties": { + "viewCharges": "Allowed" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/policies" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productMove.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productMove.json new file mode 100644 index 000000000000..1f657748848b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productMove.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/products/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "My Product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/operationResults/moveProduct_11000000-0000-0000-0000-000000000000:22000000-0000-0000-0000-000000000000:6b96d3f2-9008-4a9d-912f-f87744185aa3:44000000-0000-0000-0000-000000000055:10000000-0000-0000-0000-000000000001?api-version=2020-12-15-privatepreview", + "Retry-After": "30" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productValidateMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productValidateMoveFailure.json new file mode 100644 index 000000000000..1e5d227ab325 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productValidateMoveFailure.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + } + }, + "responses": { + "200": { + "body": { + "errorDetails": { + "code": "ProductInactive", + "message": "Invoice Sections can only be changed for active products." + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productValidateMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productValidateMoveSuccess.json new file mode 100644 index 000000000000..788479ea2fb0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productValidateMoveSuccess.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB", + "productName": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB" + } + }, + "responses": { + "200": { + "body": { + "isMoveEligible": true + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsGet.json new file mode 100644 index 000000000000..ff0ab2c7311d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "productName": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000000", + "name": "90000000-0000-0000-0000-000000000000", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "displayName": "My product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "skuId": "0001", + "skuDescription": "SKU Description", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByBillingAccount.json new file mode 100644 index 000000000000..cb0dbabb8f67 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByBillingAccount.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000000", + "name": "90000000-0000-0000-0000-000000000000", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "displayName": "My product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "skuId": "0001", + "skuDescription": "SKU Description", + "purchaseDate": "2023-01-04T22:39:34.2606750Z", + "quantity": 1, + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000001", + "name": "90000000-0000-0000-0000-000000000001", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "displayName": "Test product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "productType": "Software Product Type", + "productTypeId": "EFG456", + "skuId": "0001", + "skuDescription": "SKU Description", + "purchaseDate": "2023-01-06T22:39:34.2606750Z", + "quantity": 1, + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/90000000-0000-0000-0000-000000000002", + "name": "90000000-0000-0000-0000-000000000002", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "displayName": "Dev product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "productType": "Reservation Product Type", + "productTypeId": "JKL789", + "skuId": "0001", + "skuDescription": "SKU Description", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "status": "Suspended" + }, + "type": "Microsoft.Billing/billingAccounts/products" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByBillingProfile.json new file mode 100644 index 000000000000..b6a016b5a993 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByBillingProfile.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "My Product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Test Product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/90D31600-D46D-4084-84C6-1235CDAFFB56", + "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Dev Product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Dev Test Product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Domain Name Registration ORG", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByCustomer.json new file mode 100644 index 000000000000..a9a46f5e494c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByCustomer.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "customerName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "BillingProfile1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB", + "customerDisplayName": "Customer1", + "displayName": "My Product", + "skuId": "0002", + "skuDescription": "Microsoft Azure Standard", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "BillingProfile1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "customerDisplayName": "Customer1", + "displayName": "Test Product", + "skuId": "0002", + "skuDescription": "Microsoft Azure Standard", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "BillingProfile1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB", + "customerDisplayName": "Customer1", + "displayName": "Dev Test Product", + "skuId": "0001", + "skuDescription": "Domain Name Registration ORG", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByInvoiceSection.json new file mode 100644 index 000000000000..63d5a421af24 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsListByInvoiceSection.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31", + "billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998", + "invoiceSectionName": "Q7GV-UUVA-PJA-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/6b96d3f2-9008-4a9d-912f-f87744185aa3", + "name": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "My Product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Test Product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/90D31600-D46D-4084-84C6-1235CDAFFB56", + "name": "90D31600-D46D-4084-84C6-1235CDAFFB56", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Dev Product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Microsoft Azure Dev/Test", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProducts/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998", + "billingProfileDisplayName": "Contoso operations billing", + "displayName": "Dev Test Product", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/invoiceSections/Q7GV-UUVA-PJA-TGB", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "skuId": "0001", + "skuDescription": "Domain Name Registration ORG", + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsUpdate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsUpdate.json new file mode 100644 index 000000000000..89f0a2e7f8cd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/productsUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "productName": "11111111-1111-1111-1111-111111111111", + "parameters": { + "properties": { + "autoRenew": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/products/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "properties": { + "autoRenew": "On", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "billingProfileDisplayName": "Billing Profile Display Name", + "displayName": "Product Display Name", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy", + "invoiceSectionDisplayName": "Invoice Section Display Name", + "productType": "Seat-Based Product Type", + "productTypeId": "XYZ56789", + "skuId": "0001", + "skuDescription": "SKU Description", + "purchaseDate": "2023-01-05T22:39:34.2606750Z", + "quantity": 1, + "status": "Active" + }, + "type": "Microsoft.Billing/billingAccounts/products" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersAccept.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersAccept.json new file mode 100644 index 000000000000..35a05c53d66a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersAccept.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "transferName": "aabb123", + "parameters": { + "properties": { + "productDetails": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "productName": "Reservation name", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ] + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersDecline.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersDecline.json new file mode 100644 index 000000000000..87f959476250 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersDecline.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "Declined", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersGet.json new file mode 100644 index 000000000000..3ff79fd49a41 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "productName": "Reservation name", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ] + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersList.json new file mode 100644 index 000000000000..7af1664d4fab --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productType": "ReservedInstance", + "productId": "reservedInstanceId", + "productName": "Reservation name", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersValidate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersValidate.json new file mode 100644 index 000000000000..d5d265bcccaa --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/recipientTransfersValidate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "transferName": "aabb123", + "parameters": { + "properties": { + "productDetails": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "productId": "subscriptionId", + "status": "Failed", + "results": [ + { + "level": "Error", + "code": "NotIntendedRecipient", + "message": "Intended recipient is different." + } + ] + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccount.json new file mode 100644 index 000000000000..b91f10f7472a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccount.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000", + "reservationId": "30000000-0000-0000-0000-000000000000", + "$expand": "renewProperties" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "location": "westus", + "etag": 15, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "reservedResourceType": "VirtualMachines", + "userFriendlyRenewState": "On", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "renew": true, + "archived": false, + "quantity": 1, + "appliedScopeType": "Shared", + "displayName": "VM_RI_11-24-2021_22-30", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "Shared", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "lastUpdatedDateTime": "2023-01-24T01:46:05.5344318Z", + "expiryDate": "2024-11-25", + "purchaseDate": "2021-11-25", + "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", + "instanceFlexibility": "On", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ] + }, + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "productCode": "20000000-0000-0000-0000-000000000005", + "renewProperties": { + "purchaseProperties": { + "sku": { + "name": "Standard_DS1_v2" + }, + "location": "westus", + "properties": { + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "term": "P3Y", + "billingPlan": "Monthly", + "quantity": 1, + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "appliedScopeType": "Shared", + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "renew": false + } + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + }, + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + } + } + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountManagementGroup.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountManagementGroup.json new file mode 100644 index 000000000000..8669024ec23d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountManagementGroup.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000", + "reservationId": "30000000-0000-0000-0000-000000000000", + "$expand": "renewProperties" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "location": "westus", + "etag": 21, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "appliedScopeProperties": { + "tenantId": "50000000-0000-0000-0000-000000000009", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "displayName": "TestRg" + }, + "extendedStatusInfo": { + "statusCode": "NoBenefit", + "message": "The subscriptions utilizing the reservation were removed or transferred from this account and no longer receive the reservation benefit. You can cancel the reservation or transfer to the right account or create resources and subscriptions to map it to this reservation." + }, + "reservedResourceType": "VirtualMachines", + "userFriendlyRenewState": "On", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "renew": true, + "archived": false, + "quantity": 1, + "appliedScopeType": "ManagementGroup", + "displayName": "VM_RI_11-24-2021_22-30", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "NoBenefit", + "userFriendlyAppliedScopeType": "ManagementGroup", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "lastUpdatedDateTime": "2023-01-26T01:19:32.0697120Z", + "expiryDate": "2024-11-25", + "purchaseDate": "2021-11-25", + "effectiveDateTime": "2023-01-26T01:19:31.9916066Z", + "instanceFlexibility": "On", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + } + ] + }, + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "productCode": "20000000-0000-0000-0000-000000000005", + "renewProperties": { + "purchaseProperties": { + "sku": { + "name": "Standard_DS1_v2" + }, + "location": "westus", + "properties": { + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "term": "P3Y", + "billingPlan": "Monthly", + "quantity": 1, + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "appliedScopeType": "ManagementGroup", + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "renew": false, + "appliedScopeProperties": { + "tenantId": "50000000-0000-0000-0000-000000000009", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg" + } + } + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + }, + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + } + } + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleResourceGroup.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleResourceGroup.json new file mode 100644 index 000000000000..b1e70ee940b6 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleResourceGroup.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000", + "reservationId": "30000000-0000-0000-0000-000000000000", + "$expand": "renewProperties" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "location": "westus", + "etag": 23, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "appliedScopeProperties": { + "resourceGroupId": "/subscriptions/30000000-0000-0000-0000-000000000009/resourcegroups/fastpathtesting_20210915", + "displayName": "fastpathtesting_20210915" + }, + "reservedResourceType": "VirtualMachines", + "userFriendlyRenewState": "On", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "renew": true, + "archived": false, + "quantity": 1, + "appliedScopeType": "Single", + "displayName": "VM_RI_11-24-2021_22-30", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "ResourceGroup", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "lastUpdatedDateTime": "2023-01-26T01:21:47.3561106Z", + "expiryDate": "2024-11-25", + "purchaseDate": "2021-11-25", + "effectiveDateTime": "2023-01-26T01:21:47.2936116Z", + "instanceFlexibility": "On", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + } + ] + }, + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "productCode": "20000000-0000-0000-0000-000000000005", + "renewProperties": { + "purchaseProperties": { + "sku": { + "name": "Standard_DS1_v2" + }, + "location": "westus", + "properties": { + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "term": "P3Y", + "billingPlan": "Monthly", + "quantity": 1, + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "appliedScopes": [ + "/subscriptions/30000000-0000-0000-0000-000000000009/resourcegroups/fastpathtesting_20210915" + ], + "appliedScopeType": "Single", + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "renew": false + } + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + }, + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + } + } + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleScope.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleScope.json new file mode 100644 index 000000000000..1b7271d06105 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationGetByBillingAccountSingleScope.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000", + "reservationId": "30000000-0000-0000-0000-000000000000", + "$expand": "renewProperties" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "location": "westus", + "etag": 19, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "appliedScopeProperties": { + "subscriptionId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "displayName": "Azure subscription 1" + }, + "reservedResourceType": "VirtualMachines", + "userFriendlyRenewState": "On", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "renew": true, + "archived": false, + "quantity": 1, + "appliedScopeType": "Single", + "displayName": "VM_RI_11-24-2021_22-30", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "Single", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "lastUpdatedDateTime": "2023-01-26T01:14:18.6057756Z", + "expiryDate": "2024-11-25", + "purchaseDate": "2021-11-25", + "effectiveDateTime": "2023-01-26T01:14:18.558909Z", + "instanceFlexibility": "Off", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + } + ] + }, + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "productCode": "20000000-0000-0000-0000-000000000005", + "renewProperties": { + "purchaseProperties": { + "sku": { + "name": "Standard_DS1_v2" + }, + "location": "westus", + "properties": { + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "term": "P3Y", + "billingPlan": "Monthly", + "quantity": 1, + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "appliedScopes": [ + "/subscriptions/30000000-0000-0000-0000-000000000009" + ], + "appliedScopeType": "Single", + "reservedResourceProperties": { + "instanceFlexibility": "Off" + }, + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "Off", + "renew": false + } + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + }, + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + } + } + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccount.json new file mode 100644 index 000000000000..eecfeafaaeed --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccount.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders", + "etag": 27, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "originalQuantity": 1, + "requestDateTime": "2021-11-25T06:31:18.3925493Z", + "billingPlan": "Monthly", + "reservations": [ + { + "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" + } + ], + "term": "P3Y", + "displayName": "VM_RI_11-24-2021_22-30", + "createdDateTime": "2021-11-25T06:34:13.9736776Z", + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "provisioningState": "Succeeded", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "productCode": "20000000-0000-0000-0000-000000000005" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json new file mode 100644 index 000000000000..2ed1a953b092 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json @@ -0,0 +1,409 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000", + "$expand": "schedule" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders", + "etag": 26, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "originalQuantity": 1, + "requestDateTime": "2021-11-25T06:31:18.3925493Z", + "billingPlan": "Monthly", + "reservations": [ + { + "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" + } + ], + "term": "P3Y", + "displayName": "VM_RI_11-24-2021_22-30", + "createdDateTime": "2021-11-25T06:34:13.9736776Z", + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "provisioningState": "Succeeded", + "planInformation": { + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + }, + "startDate": "2021-11-25", + "nextPaymentDueDate": "2023-01-25", + "transactions": [ + { + "dueDate": "2021-11-25", + "paymentDate": "2021-11-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2021-12-25", + "paymentDate": "2021-12-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-01-25", + "paymentDate": "2022-01-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-02-25", + "paymentDate": "2022-02-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-03-25", + "paymentDate": "2022-03-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-04-25", + "paymentDate": "2022-04-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-05-25", + "paymentDate": "2022-05-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-06-25", + "paymentDate": "2022-06-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-07-25", + "paymentDate": "2022-07-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-08-25", + "paymentDate": "2022-08-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-09-25", + "paymentDate": "2022-09-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-10-25", + "paymentDate": "2022-10-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-11-25", + "paymentDate": "2022-11-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2022-12-25", + "paymentDate": "2022-12-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Completed" + }, + { + "dueDate": "2023-01-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-02-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-03-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-04-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-05-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-06-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-07-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-08-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-09-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-10-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-11-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-12-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-01-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-02-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-03-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-04-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-05-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-06-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-07-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-08-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-09-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-10-25", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 19.88 + }, + "status": "Scheduled" + } + ] + }, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "productCode": "20000000-0000-0000-0000-000000000005" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrdersListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrdersListByBillingAccount.json new file mode 100644 index 000000000000..0e605d2e3c11 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationOrdersListByBillingAccount.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000", + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders", + "etag": 10, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "originalQuantity": 1, + "requestDateTime": "2021-08-03T21:23:47.9090964Z", + "billingPlan": "Upfront", + "reservations": [ + { + "id": "/providers/Microsoft.Capacity/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/20000000-0000-0000-0000-000000000001" + } + ], + "term": "P3Y", + "displayName": "SUSE_Plan_08-03-2021_14-22", + "createdDateTime": "2021-08-03T21:26:50.7784836Z", + "benefitStartTime": "2021-08-03T21:26:48.5128969Z", + "provisioningState": "Succeeded", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/400000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expiryDateTime": "2024-08-03T21:26:48.5128969Z", + "productCode": "20000000-0000-0000-0000-000000000005" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationUpdateByBillingAccount.json new file mode 100644 index 000000000000..6f9f5adf1c91 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationUpdateByBillingAccount.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000", + "reservationId": "30000000-0000-0000-0000-000000000000", + "body": { + "properties": { + "displayName": "NewName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "location": "westus", + "etag": 15, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "reservedResourceType": "VirtualMachines", + "userFriendlyRenewState": "On", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "renew": true, + "archived": false, + "quantity": 1, + "appliedScopeType": "Shared", + "displayName": "NewName", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "Shared", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "lastUpdatedDateTime": "2023-01-24T01:46:05.5344318Z", + "expiryDate": "2024-11-25", + "purchaseDate": "2021-11-25", + "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", + "instanceFlexibility": "On", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ] + }, + "billingPlan": "Monthly", + "productCode": "20000000-0000-0000-0000-000000000005", + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "renewProperties": { + "purchaseProperties": { + "sku": { + "name": "Standard_DS1_v2" + }, + "location": "westus", + "properties": { + "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000009", + "term": "P3Y", + "billingPlan": "Monthly", + "quantity": 1, + "displayName": "VM_RI_11-24-2021_22-30_renewed", + "appliedScopeType": "Shared", + "reservedResourceProperties": { + "instanceFlexibility": "On" + }, + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "renew": false + } + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + }, + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 715.68 + } + } + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/20000000-0000-0000-0000-000000000000/reservations/30000000-0000-0000-0000-000000000000?api-version=2024-04-01", + "Retry-After": 120 + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsGetFromOrderByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsGetFromOrderByBillingAccount.json new file mode 100644 index 000000000000..b3f4cdd4ef15 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsGetFromOrderByBillingAccount.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "reservationOrderId": "20000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/4973e1de-a829-5c64-4fef-0a692e2b3108:1970c5da-0aa4-46fd-a917-4772f9a17978_2019-05-31/reservationOrders/99f340d1-6db4-41b4-b469-cfc499716973/reservations/a7d70646-b848-4498-8093-5938128b225c", + "name": "a7d70646-b848-4498-8093-5938128b225c", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "location": "westus", + "etag": 15, + "sku": { + "name": "Standard_DS1_v2" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "reservedResourceType": "VirtualMachines", + "userFriendlyRenewState": "On", + "skuDescription": "Reserved VM Instance, Standard_DS1_v2, US West, 3 Years", + "renew": true, + "archived": false, + "quantity": 1, + "appliedScopeType": "Shared", + "displayName": "VM_RI_11-24-2021_22-30", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "Shared", + "expiryDateTime": "2024-11-25T06:34:12.9266987Z", + "purchaseDateTime": "2021-11-25T06:31:18.3925493Z", + "benefitStartTime": "2021-11-25T06:34:12.9266987Z", + "lastUpdatedDateTime": "2023-01-24T01:46:05.5344318Z", + "expiryDate": "2024-11-25", + "purchaseDate": "2021-11-25", + "effectiveDateTime": "2023-01-24T01:46:05.4250511Z", + "instanceFlexibility": "On", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ] + }, + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", + "productCode": "20000000-0000-0000-0000-000000000005" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsListByBillingAccount.json new file mode 100644 index 000000000000..106f7d43b81e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsListByBillingAccount.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "$filter": "properties/reservedResourceType eq 'VirtualMachineSoftware' and properties/billingProfileId eq '/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-AAAA-AAA-AAA'", + "$orderby": "properties/userFriendlyAppliedScopeType asc", + "refreshsummary": "true", + "selectedState": "Succeeded" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/00000000-0000-0000-0000-000000000001/reservations/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "location": "global", + "sku": { + "name": "mock_sku" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "reservedResourceType": "VirtualMachineSoftware", + "userFriendlyRenewState": "Off", + "skuDescription": "Sku description", + "renew": false, + "archived": false, + "quantity": 1, + "appliedScopeType": "Shared", + "displayName": "VirtualMachineSoftware_01-18-2022_13-51", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "Shared", + "expiryDateTime": "2025-01-18T21:54:31.0741034Z", + "purchaseDateTime": "2022-01-18T21:51:29.9063671Z", + "benefitStartTime": "2022-01-18T21:54:31.0741034Z", + "lastUpdatedDateTime": "0001-01-01T00:00:00.0000000", + "expiryDate": "2025-01-18", + "purchaseDate": "2022-01-18", + "effectiveDateTime": "0001-01-01T00:00:00Z", + "instanceFlexibility": "On", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ] + }, + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", + "productCode": "20000000-0000-0000-0000-000000000005" + } + } + ], + "summary": { + "noBenefitCount": 0, + "warningCount": 0, + "succeededCount": 1, + "failedCount": 0, + "expiringCount": 0, + "expiredCount": 0, + "pendingCount": 0, + "cancelledCount": 0, + "processingCount": 0 + }, + "nextLink": null + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsListByBillingProfile.json new file mode 100644 index 000000000000..cd8277578734 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/reservationsListByBillingProfile.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "AAAA-AAAA-AAA-AAA", + "$filter": "properties/reservedResourceType eq 'VirtualMachineSoftware'", + "$orderby": "properties/userFriendlyAppliedScopeType asc", + "refreshsummary": "true", + "selectedState": "Succeeded" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/reservationOrders/00000000-0000-0000-0000-000000000001/reservations/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/reservationOrders/reservations", + "location": "global", + "sku": { + "name": "mock_sku" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "reservedResourceType": "VirtualMachineSoftware", + "userFriendlyRenewState": "Off", + "skuDescription": "Sku description", + "renew": false, + "archived": false, + "quantity": 1, + "appliedScopeType": "Shared", + "displayName": "VirtualMachineSoftware_01-18-2022_13-51", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "Shared", + "expiryDateTime": "2025-01-18T21:54:31.0741034Z", + "purchaseDateTime": "2022-01-18T21:51:29.9063671Z", + "benefitStartTime": "2022-01-18T21:54:31.0741034Z", + "lastUpdatedDateTime": "0001-01-01T00:00:00.0000000", + "expiryDate": "2025-01-18", + "purchaseDate": "2022-01-18", + "effectiveDateTime": "0001-01-01T00:00:00Z", + "instanceFlexibility": "On", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ] + }, + "billingPlan": "Monthly", + "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47", + "productCode": "20000000-0000-0000-0000-000000000005" + } + } + ], + "summary": { + "noBenefitCount": 0, + "warningCount": 0, + "succeededCount": 1, + "failedCount": 0, + "expiringCount": 0, + "expiredCount": 0, + "pendingCount": 0, + "cancelledCount": 0, + "processingCount": 0 + }, + "nextLink": null + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingAccount.json new file mode 100644 index 000000000000..531994f2ced4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingAccount.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/resolveBillingRoleAssignments_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.json new file mode 100644 index 000000000000..00d296990c67 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByBillingProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/00000000-0000-0000-0000-000000000001", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/operationResults/resolveBillingRoleAssignments_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByCustomer.json new file mode 100644 index 000000000000..ce4029b87bcf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByCustomer.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "703ab484-dda2-4402-827b-a74513b61e2d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "30000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "c360d6f1-2709-476d-81bb-d075b213d9fc", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d", + "userEmailAddress": "foo@bar.com", + "principalTenantName": "Foo Bar", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleAssignments/30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "30000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "principalTenantId": "c360d6f1-2709-476d-81bb-d075b213d9fc", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d", + "userEmailAddress": "foo@bar.com", + "principalTenantName": "Foo Bar", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/customers/billingRoleAssignments" + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/xxxx-xxxx-xxx-xxx/customers/703ab484-dda2-4402-827b-a74513b61e2d/operationResults/resolveBillingRoleAssignments_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByInvoiceSection.json new file mode 100644 index 000000000000..7561321c3cad --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/resolveBillingRoleAssignmentByInvoiceSection.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30", + "billingProfileName": "BKM6-54VH-BG7-PGB", + "invoiceSectionName": "xxxx-xxxx-xxx-xxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2023-10-19T20:10:50.1028398Z", + "createdByPrincipalTenantId": "076915e7-de10-4323-bb34-a58c904068bb", + "createdByPrincipalId": "00000000-0000-0000-0000-000000000001", + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/billingRoleDefinitions/30000000-aaaa-bbbb-cccc-100000000000", + "scope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx", + "principalType": "User" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/billingProfiles/BKM6-54VH-BG7-PGB/invoiceSections/xxxx-xxxx-xxx-xxx/operationResults/resolveBillingRoleAssignments_10000000-0000-0000-0000-000000000001?api-version=2024-04-01", + "retry-after": "5" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json new file mode 100644 index 000000000000..f795f7965c06 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "appliedScopeProperties": { + "tenantId": "70000000-0000-0000-0000-000000000000", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "displayName": "TestRg" + }, + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 0.001 + }, + "renew": false, + "appliedScopeType": "ManagementGroup", + "displayName": "SP1", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "NoBenefit", + "userFriendlyAppliedScopeType": "ManagementGroup", + "expiryDateTime": "2025-11-16T02:25:11.7183866Z", + "purchaseDateTime": "2022-11-16T02:23:21.3864783Z", + "benefitStartTime": "2022-11-16T02:25:11.7183866Z", + "effectiveDateTime": "2022-12-16T01:35:36.2909462Z", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + } + ] + } + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json new file mode 100644 index 000000000000..ff7f0a7116dd --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01", + "$expand": "renewProperties" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "appliedScopeProperties": { + "tenantId": "70000000-0000-0000-0000-000000000000", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "displayName": "TestRg" + }, + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 0.001 + }, + "renew": false, + "appliedScopeType": "ManagementGroup", + "displayName": "SP1", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "NoBenefit", + "userFriendlyAppliedScopeType": "ManagementGroup", + "expiryDateTime": "2025-11-16T02:25:11.7183866Z", + "purchaseDateTime": "2022-11-16T02:23:21.3864783Z", + "benefitStartTime": "2022-11-16T02:25:11.7183866Z", + "effectiveDateTime": "2022-12-16T01:35:36.2909462Z", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + } + ] + }, + "renewProperties": { + "purchaseProperties": { + "sku": { + "name": "Compute_Savings_Plan" + }, + "properties": { + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "term": "P3Y", + "billingPlan": "Monthly", + "displayName": "SP1_renewed", + "appliedScopeType": "ManagementGroup", + "appliedScopeProperties": { + "tenantId": "70000000-0000-0000-0000-000000000000", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg" + }, + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 0.001 + } + } + } + } + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json new file mode 100644 index 000000000000..19bb5664a9d2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderExpandedScheduleGetByBillingAccount.json @@ -0,0 +1,342 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01", + "$expand": "schedule" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "properties": { + "billingScopeId": "10000000-0000-0000-0000-000000000000", + "savingsPlans": [ + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" + ], + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "term": "P3Y", + "displayName": "SP1", + "benefitStartTime": "2023-01-20T02:36:22.3394755Z", + "provisioningState": "Succeeded", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expiryDateTime": "2026-01-20T02:36:22.3394755Z", + "planInformation": { + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 26.28 + }, + "startDate": "2023-01-20", + "nextPaymentDueDate": "2023-02-20", + "transactions": [ + { + "dueDate": "2023-01-20", + "paymentDate": "2023-01-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "billingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Completed" + }, + { + "dueDate": "2023-02-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-03-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-04-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-05-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-06-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-07-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-08-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-09-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-10-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-11-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2023-12-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-01-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-02-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-03-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-04-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-05-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-06-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-07-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-08-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-09-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-10-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-11-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2024-12-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-01-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-02-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-03-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-04-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-05-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-06-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-07-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-08-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-09-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-10-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-11-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + }, + { + "dueDate": "2025-12-20", + "pricingCurrencyTotal": { + "currencyCode": "USD", + "amount": 0.73 + }, + "status": "Scheduled" + } + ] + } + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderGetByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderGetByBillingAccount.json new file mode 100644 index 000000000000..53ace62c439a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderGetByBillingAccount.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "properties": { + "billingScopeId": "10000000-0000-0000-0000-000000000000", + "savingsPlans": [ + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" + ], + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "term": "P3Y", + "displayName": "SP1", + "benefitStartTime": "2023-01-20T02:36:22.3394755Z", + "provisioningState": "Succeeded", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expiryDateTime": "2026-01-20T02:36:22.3394755Z" + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderListByBillingAccount.json new file mode 100644 index 000000000000..01cf057c2560 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanOrderListByBillingAccount.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "api-version": "2024-04-01", + "$filter": "properties/billingProfileId eq '/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD'", + "$orderby": "properties/displayName asc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000", + "name": "20000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "properties": { + "billingScopeId": "10000000-0000-0000-0000-000000000000", + "savingsPlans": [ + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000" + ], + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "term": "P3Y", + "displayName": "SP1", + "benefitStartTime": "2023-02-04T03:18:31.3072635Z", + "provisioningState": "Succeeded", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expiryDateTime": "2026-02-04T03:18:31.3072635Z" + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001", + "name": "20000000-0000-0000-0000-000000000001", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders", + "properties": { + "billingScopeId": "10000000-0000-0000-0000-000000000000", + "savingsPlans": [ + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001" + ], + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "term": "P3Y", + "displayName": "SP2", + "benefitStartTime": "2023-02-04T03:22:19.7304330Z", + "provisioningState": "Succeeded", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "expiryDateTime": "2026-02-04T03:22:19.7304330Z" + }, + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanUpdateByBillingAccount.json new file mode 100644 index 000000000000..9cb852ef892b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanUpdateByBillingAccount.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01", + "body": { + "properties": { + "displayName": "sp_newName", + "appliedScopeType": "ManagementGroup", + "appliedScopeProperties": { + "tenantId": "80000000-0000-0000-0000-000000000000", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1" + }, + "renew": true, + "renewProperties": { + "purchaseProperties": { + "sku": { + "name": "Compute_Savings_Plan" + }, + "properties": { + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "term": "P3Y", + "appliedScopeType": "ManagementGroup", + "appliedScopeProperties": { + "tenantId": "80000000-0000-0000-0000-000000000000", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1" + }, + "displayName": "sp_newName_renewed", + "billingPlan": "P1M", + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 0.001 + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "appliedScopeProperties": { + "tenantId": "80000000-0000-0000-0000-000000000000", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/mg1", + "displayName": "mg1" + }, + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 0.001 + }, + "renew": true, + "appliedScopeType": "ManagementGroup", + "displayName": "sp_newName", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "ManagementGroup", + "expiryDateTime": "2026-02-04T03:18:31.3072635Z", + "purchaseDateTime": "2023-02-04T03:16:38.9065505Z", + "benefitStartTime": "2023-02-04T03:18:31.3072635Z", + "effectiveDateTime": "2023-02-04T04:30:49.1982989Z", + "utilization": { + "aggregates": [] + } + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2022-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2022-11-01", + "Retry-After": 120 + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanValidateUpdateByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanValidateUpdateByBillingAccount.json new file mode 100644 index 000000000000..6722c9f82a1a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanValidateUpdateByBillingAccount.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", + "savingsPlanId": "30000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01", + "body": { + "benefits": [ + { + "appliedScopeType": "Single", + "appliedScopeProperties": { + "subscriptionId": "/subscriptions/50000000-0000-0000-0000-000000000000" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "benefits": [ + { + "valid": true + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json new file mode 100644 index 000000000000..9c2e583b6b4b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "api-version": "2024-04-01", + "$filter": "properties/billingProfileId eq '/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD'", + "$orderby": "properties/displayName asc", + "refreshSummary": "true", + "selectedState": "Succeeded", + "take": "3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 10.0 + }, + "renew": false, + "appliedScopeType": "Shared", + "displayName": "SP1", + "provisioningState": "Succeeded", + "term": "P1Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "Shared", + "expiryDateTime": "2023-12-16T02:17:03.7396152Z", + "purchaseDateTime": "2022-12-16T02:14:58.2304134Z", + "benefitStartTime": "2022-12-16T02:17:03.7396152Z", + "effectiveDateTime": "2022-12-16T02:17:04.9896661Z", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + } + ] + } + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001", + "name": "30000000-0000-0000-0000-000000000001", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "appliedScopeProperties": { + "tenantId": "50000000-0000-0000-0000-000000000000", + "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg", + "displayName": "TestRg" + }, + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 10.0 + }, + "renew": false, + "appliedScopeType": "ManagementGroup", + "displayName": "SP2", + "provisioningState": "Succeeded", + "term": "P1Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "ManagementGroup", + "expiryDateTime": "2023-12-16T02:22:22.7254795Z", + "purchaseDateTime": "2022-12-16T02:20:23.4733076Z", + "benefitStartTime": "2022-12-16T02:22:22.7254795Z", + "effectiveDateTime": "2022-12-16T02:22:24.5536191Z", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0.0, + "valueUnit": "percentage" + } + ] + } + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000002/savingsPlans/30000000-0000-0000-0000-000000000002", + "name": "30000000-0000-0000-0000-000000000002", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/10000000-0000-0000-0000-000000000000", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "appliedScopeProperties": { + "subscriptionId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "displayName": "Azure subscription 1" + }, + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 0.025 + }, + "renew": true, + "appliedScopeType": "Single", + "displayName": "SP3", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "Single", + "expiryDateTime": "2025-10-14T21:18:55.2960613Z", + "purchaseDateTime": "2022-10-14T21:16:57.2347688Z", + "benefitStartTime": "2022-10-14T21:18:55.2960613Z", + "effectiveDateTime": "2022-11-07T23:54:43.8233243Z", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 66.0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 66.0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 65.52, + "valueUnit": "percentage" + } + ] + } + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000003/savingsPlans/30000000-0000-0000-0000-000000000003", + "name": "30000000-0000-0000-0000-000000000003", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "sku": { + "name": "Compute_Savings_Plan" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingPlan": "P1M", + "productCode": "20000000-0000-0000-0000-000000000005", + "appliedScopeProperties": { + "resourceGroupId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourcegroups/testRG", + "displayName": "testRG" + }, + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 0.001 + }, + "renew": false, + "appliedScopeType": "Single", + "displayName": "SP4", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "ResourceGroup", + "expiryDateTime": "2025-11-08T00:00:06.3636747Z", + "purchaseDateTime": "2022-11-07T23:57:58.2428677Z", + "benefitStartTime": "2022-11-08T00:00:06.3636747Z", + "effectiveDateTime": "2022-11-30T21:18:12.1967323Z", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 100.0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 100.0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 100.0, + "valueUnit": "percentage" + } + ] + } + } + } + ], + "summary": { + "noBenefitCount": 0, + "warningCount": 0, + "succeededCount": 3, + "failedCount": 0, + "expiringCount": 0, + "expiredCount": 0, + "pendingCount": 0, + "cancelledCount": 0, + "processingCount": 0 + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListBySavingsPlanOrders.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListBySavingsPlanOrders.json new file mode 100644 index 000000000000..1652634e61b3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListBySavingsPlanOrders.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "savingsPlanOrderId": "20000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000", + "name": "30000000-0000-0000-0000-000000000000", + "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans", + "sku": { + "name": "Compute_Savings_Plan" + }, + "properties": { + "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD", + "billingPlan": "P1M", + "commitment": { + "grain": "Hourly", + "currencyCode": "USD", + "amount": 0.001 + }, + "renew": false, + "appliedScopeType": "Shared", + "displayName": "SP1", + "provisioningState": "Succeeded", + "term": "P3Y", + "displayProvisioningState": "Succeeded", + "userFriendlyAppliedScopeType": "Shared", + "expiryDateTime": "2026-01-20T02:36:22.3394755Z", + "purchaseDateTime": "2023-01-20T02:34:38.1261695Z", + "benefitStartTime": "2023-01-20T02:36:22.3394755Z", + "effectiveDateTime": "2023-01-20T02:36:25.0894669Z", + "utilization": { + "trend": "SAME", + "aggregates": [ + { + "grain": 1.0, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 7.0, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + }, + { + "grain": 30.0, + "grainUnit": "days", + "value": 0, + "valueUnit": "percentage" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionSummaryGetByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionSummaryGetByInvoice.json new file mode 100644 index 000000000000..127cd89f036c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionSummaryGetByInvoice.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "azureCreditApplied": 100, + "billingCurrency": "USD", + "consumptionCommitmentDecremented": 1000, + "subTotal": 1000, + "tax": 500, + "total": 5400 + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsDownloadByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsDownloadByInvoice.json new file mode 100644 index 000000000000..f10fbe0fe886 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsDownloadByInvoice.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "expiryTime": "2023-02-16T17:32:28Z", + "url": "https://myaccount.blob.core.windows.net/invoices/1383724_invoice.csv?sv=2019-02-02&sr=b&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/transactionsDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01", + "Retry-After": "10" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByBillingProfile.json new file mode 100644 index 000000000000..e206a7ddca28 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByBillingProfile.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "periodStartDate": "2024-04-01", + "periodEndDate": "2023-05-30", + "type": "Billed", + "search": "storage", + "filter": "properties/date gt '2020-10-01'", + "orderby": "properties/date" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", + "name": "41000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 2000 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 100 + }, + "date": "2023-05-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "G123456789", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0001", + "pricingCurrency": "USD", + "productDescription": "Standard D1, US West 3", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "quantity": 1, + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 4500 + }, + "tax": { + "currency": "USD", + "value": 500 + }, + "transactionAmount": { + "currency": "USD", + "value": 5000 + }, + "transactionType": "Purchase", + "units": 11.25, + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", + "name": "51000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 20 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 50 + }, + "date": "2024-04-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "pending", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0002", + "pricingCurrency": "USD", + "productDescription": "Standard Support", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "quantity": 1, + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 45 + }, + "tax": { + "currency": "USD", + "value": 5 + }, + "transactionAmount": { + "currency": "USD", + "value": 50 + }, + "transactionType": "Cancel", + "units": 1.25, + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByCustomer.json new file mode 100644 index 000000000000..57d8b1951da8 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByCustomer.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "customerName": "22000000-0000-0000-0000-000000000000", + "periodStartDate": "2024-04-01", + "periodEndDate": "2023-05-30", + "type": "Billed", + "search": "storage", + "filter": "properties/date gt '2020-10-01'", + "orderby": "properties/date" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", + "name": "41000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 2000 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 100 + }, + "customerDisplayName": "Contoso operations customer", + "customerId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22000000-0000-0000-0000-000000000000", + "date": "2023-05-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "G123456789", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0001", + "pricingCurrency": "USD", + "productDescription": "Standard D1, US West 3", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "quantity": 1, + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 4500 + }, + "tax": { + "currency": "USD", + "value": 500 + }, + "transactionAmount": { + "currency": "USD", + "value": 5000 + }, + "transactionType": "Purchase", + "units": 11.25, + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", + "name": "51000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 20 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 50 + }, + "customerDisplayName": "Contoso operations customer", + "customerId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/customers/22000000-0000-0000-0000-000000000000", + "date": "2024-04-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "pending", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0002", + "pricingCurrency": "USD", + "productDescription": "Standard Support", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "quantity": 1, + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 45 + }, + "tax": { + "currency": "USD", + "value": 5 + }, + "transactionAmount": { + "currency": "USD", + "value": 50 + }, + "transactionType": "Cancel", + "units": 1.25, + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByInvoice.json new file mode 100644 index 000000000000..824555238153 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByInvoice.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "invoiceName": "G123456789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", + "name": "41000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 2000 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 100 + }, + "date": "2023-05-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "G123456789", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0001", + "pricingCurrency": "USD", + "productDescription": "Standard D1, US West 3", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "quantity": 1, + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 4500 + }, + "tax": { + "currency": "USD", + "value": 500 + }, + "transactionAmount": { + "currency": "USD", + "value": 5000 + }, + "transactionType": "Purchase", + "units": 11.25, + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", + "name": "51000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 20 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 50 + }, + "date": "2024-04-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "pending", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0002", + "pricingCurrency": "USD", + "productDescription": "Standard Support", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "quantity": 1, + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 45 + }, + "tax": { + "currency": "USD", + "value": 5 + }, + "transactionAmount": { + "currency": "USD", + "value": 50 + }, + "transactionType": "Cancel", + "units": 1.25, + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByInvoiceSection.json new file mode 100644 index 000000000000..875c344770c5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transactionsListByInvoiceSection.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "22000000-0000-0000-0000-000000000000", + "periodStartDate": "2024-04-01", + "periodEndDate": "2023-05-30", + "type": "Billed", + "search": "storage", + "filter": "properties/date gt '2020-10-01'", + "orderby": "properties/date" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000", + "name": "41000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 2000 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 100 + }, + "date": "2023-05-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "G123456789", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0001", + "pricingCurrency": "USD", + "productDescription": "Standard D1, US West 3", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "quantity": 1, + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 4500 + }, + "tax": { + "currency": "USD", + "value": 500 + }, + "transactionAmount": { + "currency": "USD", + "value": 5000 + }, + "transactionType": "Purchase", + "units": 11.25, + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000", + "name": "51000000-0000-0000-0000-000000000000", + "properties": { + "azureCreditApplied": { + "currency": "USD", + "value": 20 + }, + "billingCurrency": "USD", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx", + "consumptionCommitmentDecremented": { + "currency": "USD", + "value": 50 + }, + "date": "2024-04-01T00:00:00Z", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10 + }, + "exchangeRate": 1, + "invoice": "pending", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000", + "marketPrice": { + "currency": "USD", + "value": 20 + }, + "partNumber": "0002", + "pricingCurrency": "USD", + "productDescription": "Standard Support", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "quantity": 1, + "servicePeriodStartDate": "2023-05-01T00:00:00Z", + "servicePeriodEndDate": "2023-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 45 + }, + "tax": { + "currency": "USD", + "value": 5 + }, + "transactionAmount": { + "currency": "USD", + "value": 50 + }, + "transactionType": "Cancel", + "units": 1.25, + "unitOfMeasure": "1 Minute", + "unitType": "1 Runtime Minute" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersCancel.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersCancel.json new file mode 100644 index 000000000000..a78c7887a783 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersCancel.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "canceledBy": "user@contoso.com" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersGet.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersGet.json new file mode 100644 index 000000000000..20cccff9e83f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "transferName": "aabb123" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "productName": "Reservation name", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ] + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersInitiate.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersInitiate.json new file mode 100644 index 000000000000..1930692f02f3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersInitiate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy", + "transferName": "aabb123", + "parameters": { + "properties": { + "recipientEmailId": "user@contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com" + } + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersList.json new file mode 100644 index 000000000000..e51e11fb24bf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/transfersList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "billingAccountName": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", + "billingProfileName": "xxxx-xxxx-xxx-xxx", + "invoiceSectionName": "yyyy-yyyy-yyy-yyy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123", + "name": "aabb123", + "type": "Microsoft.Billing/transfers", + "properties": { + "expirationTime": "2018-11-05T17:32:28Z", + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "xyz@contoso.com", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "productName": "Azure subscription 1", + "skuDescription": "MS-AZR-0017G", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "productName": "Reservation name", + "skuDescription": "Standard_D2s_v3;VirtualMachines;P1Y", + "transferStatus": "InProgress" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/invoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/invoice.json new file mode 100644 index 000000000000..7113849e475e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/invoice.json @@ -0,0 +1,1364 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices": { + "get": { + "tags": [ + "Invoice" + ], + "description": "Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "in": "query", + "name": "periodStartDate", + "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", + "type": "string", + "format": "date" + }, + { + "in": "query", + "name": "periodEndDate", + "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", + "type": "string", + "format": "date" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of invoices.", + "schema": { + "$ref": "#/definitions/InvoiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoicesListByBillingProfile": { + "$ref": "./examples/invoicesListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments": { + "post": { + "tags": [ + "Invoice" + ], + "description": "Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_DownloadDocumentsByBillingAccount", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A list of download details for individual documents.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/DocumentDownloadRequest" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "A secure URL that can be used to download a an entity until the URL expires.", + "schema": { + "$ref": "#/definitions/DocumentDownloadResult" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "InvoicesDownloadDocumentsByBillingAccount": { + "$ref": "./examples/invoicesDownloadDocumentsByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/amend": { + "post": { + "tags": [ + "Invoice" + ], + "description": "Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_Amend", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "InvoicesAmend": { + "$ref": "./examples/invoicesAmend.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download": { + "post": { + "tags": [ + "Invoice" + ], + "description": "Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_DownloadByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "in": "query", + "name": "documentName", + "description": "The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt.", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A secure URL that can be used to download a an entity until the URL expires.", + "schema": { + "$ref": "#/definitions/DocumentDownloadResult" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "InvoicesDownloadByBillingAccount": { + "$ref": "./examples/invoicesDownloadByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/downloadSummary": { + "post": { + "tags": [ + "Invoice" + ], + "description": "Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_DownloadSummaryByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A secure URL that can be used to download a an entity until the URL expires.", + "schema": { + "$ref": "#/definitions/DocumentDownloadResult" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "InvoicesDownloadSummaryByBillingAccount": { + "$ref": "./examples/invoicesDownloadSummaryByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}": { + "get": { + "tags": [ + "Invoice" + ], + "description": "Gets an invoice by billing account name and ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_GetByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of invoices.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoicesGetByBillingAccount": { + "$ref": "./examples/invoicesGetByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices": { + "get": { + "tags": [ + "Invoice" + ], + "description": "Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement, or Microsoft Online Services Program.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "in": "query", + "name": "periodStartDate", + "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", + "type": "string", + "format": "date" + }, + { + "in": "query", + "name": "periodEndDate", + "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", + "type": "string", + "format": "date" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of invoices.", + "schema": { + "$ref": "#/definitions/InvoiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoicesListByBillingAccount": { + "$ref": "./examples/invoicesListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments": { + "post": { + "tags": [ + "Invoice" + ], + "description": "Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_DownloadDocumentsByBillingSubscription", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/subscriptionId" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A list of download details for individual documents.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/DocumentDownloadRequest" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "A secure URL that can be used to download a an entity until the URL expires.", + "schema": { + "$ref": "#/definitions/DocumentDownloadResult" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "InvoicesDownloadDocumentsByBillingSubscription": { + "$ref": "./examples/invoicesDownloadDocumentsByBillingSubscription.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download": { + "post": { + "tags": [ + "Invoice" + ], + "description": "Gets a URL to download an invoice by billing subscription.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_DownloadByBillingSubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/subscriptionId" + }, + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "in": "query", + "name": "documentName", + "description": "The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt.", + "type": "string" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A secure URL that can be used to download a an entity until the URL expires.", + "schema": { + "$ref": "#/definitions/DocumentDownloadResult" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "InvoicesDownloadByBillingSubscription": { + "$ref": "./examples/invoicesDownloadByBillingSubscription.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}": { + "get": { + "tags": [ + "Invoice" + ], + "description": "Gets an invoice by subscription ID and invoice ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_GetByBillingSubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/subscriptionId" + }, + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "An invoice.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoicesGetByBillingSubscription": { + "$ref": "./examples/invoicesGetByBillingSubscription.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices": { + "get": { + "tags": [ + "Invoice" + ], + "description": "Lists the invoices for a subscription.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_ListByBillingSubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/subscriptionId" + }, + { + "in": "query", + "name": "periodStartDate", + "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", + "type": "string", + "format": "date" + }, + { + "in": "query", + "name": "periodEndDate", + "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", + "type": "string", + "format": "date" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of invoices.", + "schema": { + "$ref": "#/definitions/InvoiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoicesListByBillingSubscription": { + "$ref": "./examples/invoicesListByBillingSubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}": { + "get": { + "tags": [ + "Invoice" + ], + "description": "Gets an invoice by ID. The operation is supported for all billing account types.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Invoices_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "An invoice.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoicesGet": { + "$ref": "./examples/invoicesGet.json" + } + } + } + } + }, + "definitions": { + "DocumentDownloadRequest": { + "description": "A list of download details for individual documents.", + "type": "object", + "properties": { + "documentName": { + "description": "The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. If omitted, the most recent invoice PDF for the invoice will be returned.", + "type": "string" + }, + "invoiceName": { + "description": "The ID that uniquely identifies an invoice.", + "type": "string" + } + } + }, + "DocumentDownloadResult": { + "description": "A secure URL that can be used to download a an entity until the URL expires.", + "type": "object", + "properties": { + "expiryTime": { + "description": "The time in UTC when the download URL will expire.", + "type": "string", + "readOnly": true + }, + "url": { + "description": "The URL to the PDF or .zip file.", + "type": "string", + "readOnly": true + } + } + }, + "FailedPayment": { + "description": "A failed payment.", + "type": "object", + "properties": { + "date": { + "format": "date-time", + "description": "The date when the payment was attempted.", + "type": "string", + "readOnly": true + }, + "failedPaymentReason": { + "description": "The reason that the payment failed.", + "enum": [ + "Other", + "BankDeclined", + "CardExpired", + "IncorrectCardDetails" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FailedPaymentReason", + "modelAsString": true + } + } + } + }, + "Invoice": { + "description": "An invoice.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/InvoiceProperties" + } + }, + "x-ms-azure-resource": true + }, + "InvoiceDocument": { + "description": "The properties of a document.", + "type": "object", + "properties": { + "documentNumbers": { + "description": "The document numbers for the invoice document.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "externalUrl": { + "description": "The URL to download the invoice document if the source is external to Microsoft.Billing.", + "type": "string", + "readOnly": true + }, + "kind": { + "description": "The type of the document.", + "enum": [ + "Other", + "Invoice", + "VoidNote", + "TaxReceipt", + "CreditNote", + "Summary", + "Transactions" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InvoiceDocumentType", + "modelAsString": true + } + }, + "name": { + "description": "The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt.", + "type": "string", + "readOnly": true + }, + "url": { + "description": "The URL to download the invoice document if the source is internal to Microsoft.Billing.", + "type": "string", + "readOnly": true + }, + "source": { + "description": "The source of the document. ENF for Brazil and DRS for rest of the world.", + "enum": [ + "Other", + "DRS", + "ENF" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DocumentSource", + "modelAsString": true + } + } + } + }, + "InvoiceListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Invoice" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "InvoiceProperties": { + "description": "An invoice.", + "type": "object", + "properties": { + "amountDue": { + "description": "The amount due as of now.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "azurePrepaymentApplied": { + "description": "The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "billedAmount": { + "description": "The total charges for the invoice billing period.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "billedDocumentId": { + "description": "The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile for which the invoice is generated.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The ID of the billing profile for which the invoice is generated.", + "type": "string", + "readOnly": true + }, + "creditAmount": { + "description": "The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "creditForDocumentId": { + "description": "The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only.", + "type": "string", + "readOnly": true + }, + "documents": { + "description": "List of documents available to download and view such as invoice, credit note, or tax receipt.", + "type": "array", + "items": { + "$ref": "#/definitions/InvoiceDocument" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "documentType": { + "description": "The type of the document.", + "enum": [ + "Other", + "Invoice", + "VoidNote", + "TaxReceipt", + "CreditNote", + "Summary", + "Transactions" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InvoiceDocumentType", + "modelAsString": true + } + }, + "dueDate": { + "format": "date-time", + "description": "The due date for the invoice.", + "type": "string", + "readOnly": true + }, + "failedPayments": { + "description": "List of failed payments.", + "type": "array", + "items": { + "$ref": "#/definitions/FailedPayment" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "freeAzureCreditApplied": { + "description": "The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "invoiceDate": { + "format": "date-time", + "description": "The date when the invoice was generated.", + "type": "string", + "readOnly": true + }, + "invoicePeriodEndDate": { + "format": "date-time", + "description": "The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", + "type": "string", + "readOnly": true + }, + "invoicePeriodStartDate": { + "format": "date-time", + "description": "The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.", + "type": "string", + "readOnly": true + }, + "invoiceType": { + "description": "Invoice type.", + "enum": [ + "Other", + "AzureServices", + "AzureMarketplace", + "AzureSupport" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InvoiceType", + "modelAsString": true + } + }, + "isMonthlyInvoice": { + "description": "Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "type": "boolean", + "readOnly": true + }, + "payments": { + "description": "List of payments.", + "type": "array", + "items": { + "$ref": "#/definitions/Payment" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "purchaseOrderNumber": { + "description": "An optional purchase order number for the invoice.", + "type": "string", + "readOnly": true + }, + "rebillDetails": { + "description": "Rebill details for an invoice.", + "allOf": [ + { + "$ref": "#/definitions/RebillDetails" + } + ] + }, + "status": { + "description": "The current status of the invoice.", + "enum": [ + "Other", + "Due", + "OverDue", + "Paid", + "Void", + "Locked" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InvoiceStatus", + "modelAsString": true + } + }, + "subscriptionDisplayName": { + "description": "The name of the billing subscription for which the invoice is generated.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "The ID of the subscription for which the invoice is generated.", + "type": "string", + "readOnly": true + }, + "specialTaxationType": { + "description": "Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.", + "enum": [ + "SubtotalLevel", + "InvoiceLevel" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SpecialTaxationType", + "modelAsString": true + } + }, + "subTotal": { + "description": "The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "taxAmount": { + "description": "The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "totalAmount": { + "description": "The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "refundDetails": { + "description": "The details of a refund request.", + "allOf": [ + { + "$ref": "#/definitions/RefundDetailsSummary" + } + ] + } + } + }, + "Payment": { + "description": "An invoice payment.", + "type": "object", + "properties": { + "amount": { + "description": "The paid amount.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "date": { + "format": "date-time", + "description": "The date when the payment was made.", + "type": "string", + "readOnly": true + }, + "paymentMethodId": { + "description": "The ID that uniquely identifies the payment method used for the invoice.", + "type": "string", + "readOnly": true + }, + "paymentMethodFamily": { + "description": "The family of payment method.", + "enum": [ + "Other", + "None", + "CreditCard", + "Credits", + "CheckWire", + "EWallet", + "TaskOrder", + "DirectDebit" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PaymentMethodFamily", + "modelAsString": true + } + }, + "paymentMethodType": { + "description": "The type of payment method.", + "type": "string", + "readOnly": true + }, + "paymentType": { + "description": "The type of payment.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "RebillDetails": { + "description": "The rebill details of an invoice.", + "type": "object", + "properties": { + "invoiceDocumentId": { + "description": "The ID of invoice.", + "type": "string", + "readOnly": true + }, + "creditNoteDocumentId": { + "description": "The ID of credit note.", + "type": "string", + "readOnly": true + }, + "rebillDetails": { + "$ref": "#/definitions/RebillDetails" + } + }, + "readOnly": true + }, + "RefundDetailsSummary": { + "description": "The details of refund request.", + "type": "object", + "properties": { + "requestedOn": { + "format": "date-time", + "description": "Date when the refund was requested.", + "type": "string", + "readOnly": true + }, + "approvedOn": { + "format": "date-time", + "description": "Date when the refund was approved.", + "type": "string", + "readOnly": true + }, + "completedOn": { + "format": "date-time", + "description": "Date when the refund was completed.", + "type": "string", + "readOnly": true + }, + "amountRequested": { + "description": "The amount of refund requested.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "amountRefunded": { + "description": "The amount refunded.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "rebillInvoiceId": { + "description": "The invoice ID of the rebill invoice for a refund.", + "type": "string", + "readOnly": true + }, + "transactionCount": { + "format": "int32", + "description": "The number of transactions refunded.", + "type": "integer", + "readOnly": true + }, + "refundStatus": { + "description": "The status of refund request.", + "enum": [ + "Other", + "Pending", + "Approved", + "Declined", + "Cancelled", + "Completed", + "Expired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RefundStatus", + "modelAsString": true + } + }, + "refundOperationId": { + "description": "The ID of refund operation.", + "type": "string", + "readOnly": true + }, + "refundReason": { + "description": "The reason for refund.", + "enum": [ + "Other", + "AccidentalConversion", + "UnclearPricing", + "AccidentalPurchase", + "ForgotToCancel", + "UnclearDocumentation" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RefundReasonCode", + "modelAsString": true + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/invoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/invoiceSection.json new file mode 100644 index 000000000000..1703e936461c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/invoiceSection.json @@ -0,0 +1,523 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/validateDeleteEligibility": { + "post": { + "tags": [ + "InvoiceSection" + ], + "description": "Validates if the invoice section can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "InvoiceSections_ValidateDeleteEligibility", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Eligibility to delete an invoice section result.", + "schema": { + "$ref": "#/definitions/DeleteInvoiceSectionEligibilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoiceSectionsValidateDeleteEligibilitySuccess": { + "$ref": "./examples/invoiceSectionsValidateDeleteEligibilitySuccess.json" + }, + "InvoiceSectionsValidateDeleteEligibilityFailure": { + "$ref": "./examples/invoiceSectionsValidateDeleteEligibilityFailure.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}": { + "delete": { + "tags": [ + "InvoiceSection" + ], + "description": "Deletes an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "InvoiceSections_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "InvoiceSectionsDelete": { + "$ref": "./examples/invoiceSectionsDelete.json" + } + } + }, + "get": { + "tags": [ + "InvoiceSection" + ], + "description": "Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "InvoiceSections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "An invoice section.", + "schema": { + "$ref": "#/definitions/InvoiceSection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoiceSectionsGet": { + "$ref": "./examples/invoiceSectionsGet.json" + } + } + }, + "put": { + "tags": [ + "InvoiceSection" + ], + "description": "Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "InvoiceSections_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "An invoice section.", + "required": true, + "schema": { + "$ref": "#/definitions/InvoiceSection" + } + } + ], + "responses": { + "200": { + "description": "An invoice section.", + "schema": { + "$ref": "#/definitions/InvoiceSection" + } + }, + "201": { + "description": "An invoice section.", + "schema": { + "$ref": "#/definitions/InvoiceSection" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "InvoiceSectionsCreateOrUpdate": { + "$ref": "./examples/invoiceSectionsCreateOrUpdate.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections": { + "get": { + "tags": [ + "InvoiceSection" + ], + "description": "Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "InvoiceSections_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "in": "query", + "name": "includeDeleted", + "description": "Can be used to get deleted invoice sections.", + "type": "boolean", + "default": false + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "A list of invoice sections.", + "schema": { + "$ref": "#/definitions/InvoiceSectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InvoiceSectionsListByBillingProfile": { + "$ref": "./examples/invoiceSectionsListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DeleteInvoiceSectionEligibilityDetail": { + "description": "The details of delete invoice section eligibility result.", + "type": "object", + "properties": { + "code": { + "description": "Code for the delete invoice section validation.", + "enum": [ + "Other", + "LastInvoiceSection", + "ActiveAzurePlans", + "ReservedInstances", + "ActiveBillingSubscriptions" + ], + "type": "string", + "x-ms-enum": { + "name": "DeleteInvoiceSectionEligibilityCode", + "modelAsString": true + } + }, + "message": { + "description": "Validation message.", + "type": "string" + } + } + }, + "DeleteInvoiceSectionEligibilityResult": { + "description": "Eligibility to delete an invoice section result.", + "type": "object", + "properties": { + "eligibilityStatus": { + "description": "Status describing if invoice section is eligible to be deleted.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "DeleteInvoiceSectionEligibilityStatus", + "modelAsString": true + } + }, + "eligibilityDetails": { + "description": "A list of delete invoice section eligibility result details.", + "type": "array", + "items": { + "$ref": "#/definitions/DeleteInvoiceSectionEligibilityDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "InvoiceSection": { + "description": "An invoice section.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/InvoiceSectionProperties" + } + }, + "x-ms-azure-resource": true + }, + "InvoiceSectionListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/InvoiceSection" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "InvoiceSectionProperties": { + "description": "An invoice section.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "displayName": { + "description": "The name of the invoice section.", + "type": "string" + }, + "state": { + "description": "Identifies the status of an invoice section.", + "enum": [ + "Other", + "Active", + "Deleted", + "Disabled", + "UnderReview", + "Warned", + "Restricted" + ], + "type": "string", + "x-ms-enum": { + "name": "InvoiceSectionState", + "modelAsString": true + } + }, + "reasonCode": { + "description": "Reason for the specified invoice section status.", + "enum": [ + "Other", + "PastDue", + "UnusualActivity", + "SpendingLimitReached", + "SpendingLimitExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "InvoiceSectionStateReasonCode", + "modelAsString": true + } + }, + "systemId": { + "description": "The system generated unique identifier for an invoice section.", + "type": "string", + "readOnly": true + }, + "targetCloud": { + "description": "Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds.", + "enum": [ + "Other", + "Internal", + "USGov", + "USNat", + "USSec" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetCloud", + "modelAsString": true + } + }, + "tags": { + "description": "Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/operation.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/operation.json new file mode 100644 index 000000000000..6f876d442faa --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/operation.json @@ -0,0 +1,148 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/operations": { + "get": { + "tags": [ + "ArmOperations" + ], + "description": "List of operations supported by provider.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/operationsList.json" + } + } + } + } + }, + "definitions": { + "Operation": { + "description": "Details of a REST API operation, returned from the Resource Provider Operations API.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\".", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", + "type": "boolean", + "readOnly": true + }, + "display": { + "description": "Localized display information for this particular operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "description": "Localized display information for this particular operation.", + "type": "object", + "properties": { + "description": { + "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".", + "type": "string", + "readOnly": true + }, + "provider": { + "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/payment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/payment.json new file mode 100644 index 000000000000..731c6b050c8f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/payment.json @@ -0,0 +1,661 @@ +{ + "consumes": [ + "application/json" + ], + "definitions": { + "PaymentMethod": { + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "description": "A payment method.", + "properties": { + "properties": { + "$ref": "#/definitions/PaymentMethodProperties", + "description": "Payment method properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "PaymentMethodLink": { + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "description": "A payment method link.", + "properties": { + "properties": { + "$ref": "#/definitions/PaymentMethodLinkProperties", + "description": "Payment method link properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "PaymentMethodLinkProperties": { + "description": "The properties of a payment method link.", + "properties": { + "accountHolderName": { + "description": "The account holder name for the payment method. This is only supported for payment methods with family CreditCard.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name of the payment method.", + "readOnly": true, + "type": "string" + }, + "expiration": { + "description": "The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard.", + "readOnly": true, + "type": "string" + }, + "family": { + "description": "The family of payment method.", + "enum": [ + "Other", + "None", + "CreditCard", + "Credits", + "CheckWire", + "EWallet", + "TaskOrder", + "DirectDebit" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "paymentMethodFamily" + } + }, + "lastFourDigits": { + "description": "Last four digits of payment method.", + "readOnly": true, + "type": "string" + }, + "logos": { + "description": "The list of logos for the payment method.", + "items": { + "$ref": "#/definitions/PaymentMethodLogo" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "paymentMethod": { + "description": "Projection of a payment method. Will not be returned in this or future versions.", + "$ref": "#/definitions/PaymentMethodProperties" + }, + "paymentMethodId": { + "description": "Id of payment method. Example: /providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0", + "type": "string" + }, + "paymentMethodType": { + "description": "The type of payment method.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Status of the payment method.", + "enum": [ + "active", + "inactive" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "paymentMethodStatus" + } + } + }, + "type": "object" + }, + "PaymentMethodLinksListResult": { + "description": "The list of payment method links.", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The list of payment method links.", + "items": { + "$ref": "#/definitions/PaymentMethodLink" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [ + "id" + ] + } + }, + "type": "object" + }, + "PaymentMethodLogo": { + "description": "Logo of payment method.", + "properties": { + "mimeType": { + "description": "MIME type of the logo.", + "readOnly": true, + "type": "string" + }, + "url": { + "description": "Public URL of image of the logo.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "PaymentMethodProperties": { + "description": "The properties of a payment method.", + "properties": { + "id": { + "description": "Id of payment method.", + "type": "string", + "readOnly": true + }, + "accountHolderName": { + "description": "The account holder name for the payment method. This is only supported for payment methods with family CreditCard.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name of the payment method.", + "readOnly": true, + "type": "string" + }, + "expiration": { + "description": "The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard.", + "readOnly": true, + "type": "string" + }, + "family": { + "description": "The family of payment method.", + "enum": [ + "Other", + "None", + "CreditCard", + "Credits", + "CheckWire", + "EWallet", + "TaskOrder", + "DirectDebit" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "paymentMethodFamily" + } + }, + "lastFourDigits": { + "description": "Last four digits of payment method.", + "readOnly": true, + "type": "string" + }, + "logos": { + "description": "The list of logos for the payment method.", + "items": { + "$ref": "#/definitions/PaymentMethodLogo" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "paymentMethodType": { + "description": "The type of payment method.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Status of the payment method.", + "enum": [ + "active", + "inactive" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "paymentMethodStatus" + } + }, + "type": { + "description": "The type of payment method.", + "type": "string", + "readOnly": true + } + }, + "type": "object" + }, + "PaymentMethodsListResult": { + "description": "The list of payment methods.", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The list of payment methods.", + "items": { + "$ref": "#/definitions/PaymentMethod" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object", + "x-ms-identifiers": [ + "id" + ] + } + }, + "host": "management.azure.com", + "info": { + "description": "The billing client allows you to view and manage your billing details programmatically.", + "title": "BillingManagementClient", + "version": "2024-04-01" + }, + "parameters": { + "billingAccountNameParameter": { + "name": "billingAccountName", + "in": "path", + "description": "The ID that uniquely identifies a billing account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingProfileNameParameter": { + "name": "billingProfileName", + "in": "path", + "description": "The ID that uniquely identifies a billing profile.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "paymentMethodNameParameter": { + "description": "The ID that uniquely identifies a payment method.", + "in": "path", + "name": "paymentMethodName", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethodLinks": { + "get": { + "description": "Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "PaymentMethods_ListByBillingProfile", + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PaymentMethodLinksListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "PaymentMethods" + ], + "x-ms-examples": { + "PaymentMethodsListByBillingProfile": { + "$ref": "./examples/paymentMethodsListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethodLinks/{paymentMethodName}": { + "get": { + "description": "Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "PaymentMethods_GetByBillingProfile", + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/paymentMethodNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PaymentMethodLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "PaymentMethods" + ], + "x-ms-examples": { + "PaymentMethodsGetByBillingProfile": { + "$ref": "./examples/paymentMethodsGetByBillingProfile.json" + } + } + }, + "delete": { + "tags": [ + "PaymentMethods" + ], + "operationId": "PaymentMethods_DeleteAtBillingProfile", + "x-ms-long-running-operation": true, + "description": "Deletes a payment method link and removes the payment method from a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "PaymentMethodAtBillingProfileDelete": { + "$ref": "./examples/paymentMethodsDeleteAtBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/paymentMethodNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "The resource was not found." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Retry-After": { + "description": "Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods": { + "get": { + "description": "Lists the payment methods available for a billing account. Along with the payment methods owned by the caller, these payment methods can be attached to a billing profile to make payments. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "PaymentMethods_ListByBillingAccount", + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PaymentMethodsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "PaymentMethods" + ], + "x-ms-examples": { + "PaymentMethodsListByBillingAccount": { + "$ref": "./examples/paymentMethodsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods/{paymentMethodName}": { + "get": { + "description": "Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "PaymentMethods_GetByBillingAccount", + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/paymentMethodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PaymentMethod" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "PaymentMethods" + ], + "x-ms-examples": { + "PaymentMethodGetAtBillingProfile": { + "$ref": "./examples/paymentMethodsGetByBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/paymentMethods": { + "get": { + "description": "Lists the payment methods owned by the caller.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "PaymentMethods_ListByUser", + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PaymentMethodsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "PaymentMethods" + ], + "x-ms-examples": { + "ListPaymentMethodOwnedByUser": { + "$ref": "./examples/paymentMethodsListByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/paymentMethods/{paymentMethodName}": { + "delete": { + "description": "Deletes a payment method owned by the caller.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "PaymentMethods_DeleteByUser", + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/paymentMethodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "PaymentMethods" + ], + "x-ms-examples": { + "DeletePaymentMethodOwnedByUser": { + "$ref": "./examples/paymentMethodsDeleteByUser.json" + } + } + }, + "get": { + "description": "Gets a payment method owned by the caller.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "PaymentMethods_GetByUser", + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/paymentMethodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PaymentMethod" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "PaymentMethods" + ], + "x-ms-examples": { + "GetPaymentMethodOwnedByUser": { + "$ref": "./examples/paymentMethodsGetByUser.json" + } + } + } + } + }, + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "swagger": "2.0" +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/policy.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/policy.json new file mode 100644 index 000000000000..6bf1e9920486 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/policy.json @@ -0,0 +1,977 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/policies/{policyName}": { + "get": { + "tags": [ + "Policy" + ], + "description": "Lists the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Policies_GetByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "in": "path", + "name": "policyName", + "description": "Service-defined resource names such as 'default' which are reserved resource names.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z\\d-_]{1,128}$", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ServiceDefinedResourceName", + "modelAsString": true + } + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A policy at customer scope.", + "schema": { + "$ref": "#/definitions/CustomerPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PoliciesGetByCustomer": { + "$ref": "./examples/policiesGetByCustomer.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/policies/default": { + "put": { + "tags": [ + "Policy" + ], + "description": "Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Policies_CreateOrUpdateByCustomer", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A policy at customer scope.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomerPolicy" + } + } + ], + "responses": { + "200": { + "description": "A policy at customer scope.", + "schema": { + "$ref": "#/definitions/CustomerPolicy" + } + }, + "201": { + "description": "A policy at customer scope.", + "schema": { + "$ref": "#/definitions/CustomerPolicy" + }, + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PoliciesPutByCustomer": { + "$ref": "./examples/policiesPutByCustomer.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default": { + "get": { + "tags": [ + "Policy" + ], + "description": "Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Policies_GetByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A policy at billing profile scope.", + "schema": { + "$ref": "#/definitions/BillingProfilePolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PoliciesGetByBillingProfile": { + "$ref": "./examples/policiesGetByBillingProfile.json" + } + } + }, + "put": { + "tags": [ + "Policy" + ], + "description": "Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Policies_CreateOrUpdateByBillingProfile", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A policy at billing profile scope.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingProfilePolicy" + } + } + ], + "responses": { + "200": { + "description": "A policy at billing profile scope.", + "schema": { + "$ref": "#/definitions/BillingProfilePolicy" + } + }, + "201": { + "description": "A policy at billing profile scope.", + "schema": { + "$ref": "#/definitions/BillingProfilePolicy" + }, + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PoliciesPutByBillingProfile": { + "$ref": "./examples/policiesPutByBillingProfile.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default": { + "get": { + "tags": [ + "Policy" + ], + "description": "Lists the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Policies_GetByCustomerAtBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A policy at customer scope.", + "schema": { + "$ref": "#/definitions/CustomerPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PoliciesGetByCustomerAtBillingAccount": { + "$ref": "./examples/policiesGetByCustomerAtBillingAccount.json" + } + } + }, + "put": { + "tags": [ + "Policy" + ], + "description": "Updates the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Policies_CreateOrUpdateByCustomerAtBillingAccount", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A policy at customer scope.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomerPolicy" + } + } + ], + "responses": { + "200": { + "description": "A policy at customer scope.", + "schema": { + "$ref": "#/definitions/CustomerPolicy" + } + }, + "201": { + "description": "A policy at customer scope.", + "schema": { + "$ref": "#/definitions/CustomerPolicy" + }, + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PoliciesPutByCustomerAtBillingAccount": { + "$ref": "./examples/policiesPutByCustomerAtBillingAccount.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/policies/default": { + "get": { + "tags": [ + "Policy" + ], + "description": "Get the policies for a billing account of Enterprise Agreement type.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Policies_GetByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A policy at billing account scope.", + "schema": { + "$ref": "#/definitions/BillingAccountPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PoliciesGetByBillingAccount": { + "$ref": "./examples/policiesGetByBillingAccount.json" + } + } + }, + "put": { + "tags": [ + "Policy" + ], + "description": "Update the policies for a billing account of Enterprise Agreement type.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Policies_CreateOrUpdateByBillingAccount", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A policy at billing account scope.", + "required": true, + "schema": { + "$ref": "#/definitions/BillingAccountPolicy" + } + } + ], + "responses": { + "200": { + "description": "A policy at billing account scope.", + "schema": { + "$ref": "#/definitions/BillingAccountPolicy" + } + }, + "201": { + "description": "A policy at billing account scope.", + "schema": { + "$ref": "#/definitions/BillingAccountPolicy" + }, + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PoliciesPutByBillingAccount": { + "$ref": "./examples/policiesPutByBillingAccount.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/policies/default": { + "get": { + "tags": [ + "Policy" + ], + "description": "Lists the policies that are managed by the Billing Admin for the defined subscriptions. This is supported for Microsoft Online Services Program, Microsoft Customer Agreement and Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Policies_GetBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/subscriptionId" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A policy at subscription scope.", + "schema": { + "$ref": "#/definitions/SubscriptionPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PoliciesGetBySubscription": { + "$ref": "./examples/policiesGetBySubscription.json" + } + } + } + } + }, + "definitions": { + "BillingAccountPolicy": { + "description": "A policy at billing account scope.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BillingAccountPolicyProperties" + } + }, + "x-ms-azure-resource": true + }, + "BillingAccountPolicyProperties": { + "description": "A policy at billing account scope.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "enterpriseAgreementPolicies": { + "description": "The policies for Enterprise Agreement enrollments.", + "allOf": [ + { + "$ref": "#/definitions/EnterpriseAgreementPolicies" + } + ] + }, + "marketplacePurchases": { + "description": "The policy that controls whether Azure marketplace purchases are allowed.", + "enum": [ + "Other", + "AllAllowed", + "Disabled", + "NotAllowed", + "OnlyFreeAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "MarketplacePurchasesPolicy", + "modelAsString": true + } + }, + "reservationPurchases": { + "description": "The policy that controls whether Azure reservation purchases are allowed.", + "enum": [ + "Other", + "Allowed", + "Disabled", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "ReservationPurchasesPolicy", + "modelAsString": true + } + }, + "savingsPlanPurchases": { + "description": "The policy that controls whether users with Azure savings plan purchase are allowed.", + "enum": [ + "Other", + "Allowed", + "Disabled", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "SavingsPlanPurchasesPolicy", + "modelAsString": true + } + }, + "policies": { + "description": "List of all policies defined at the billing scope.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicySummary" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "BillingProfilePolicy": { + "description": "A policy at billing profile scope.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BillingProfilePolicyProperties" + } + }, + "x-ms-azure-resource": true + }, + "BillingProfilePolicyProperties": { + "description": "A policy at billing profile scope.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "enterpriseAgreementPolicies": { + "description": "The policies for Enterprise Agreement enrollments.", + "allOf": [ + { + "$ref": "#/definitions/EnterpriseAgreementPolicies" + } + ] + }, + "invoiceSectionLabelManagement": { + "description": "The policy that controls invoice section label management at invoice section scope. This is allowed by default.", + "enum": [ + "Other", + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "InvoiceSectionLabelManagementPolicy", + "modelAsString": true + } + }, + "marketplacePurchases": { + "description": "The policy that controls whether Azure marketplace purchases are allowed.", + "enum": [ + "Other", + "AllAllowed", + "Disabled", + "NotAllowed", + "OnlyFreeAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "MarketplacePurchasesPolicy", + "modelAsString": true + } + }, + "reservationPurchases": { + "description": "The policy that controls whether Azure reservation purchases are allowed.", + "enum": [ + "Other", + "Allowed", + "Disabled", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "ReservationPurchasesPolicy", + "modelAsString": true + } + }, + "savingsPlanPurchases": { + "description": "The policy that controls whether users with Azure savings plan purchase are allowed.", + "enum": [ + "Other", + "Allowed", + "Disabled", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "SavingsPlanPurchasesPolicy", + "modelAsString": true + } + }, + "viewCharges": { + "description": "The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices.", + "enum": [ + "Other", + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "ViewChargesPolicy", + "modelAsString": true + } + }, + "policies": { + "description": "List of all policies defined at the billing scope.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicySummary" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "CustomerPolicy": { + "description": "A policy at customer scope.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomerPolicyProperties" + } + }, + "x-ms-azure-resource": true + }, + "CustomerPolicyProperties": { + "description": "A policy at customer scope.", + "required": [ + "viewCharges" + ], + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "viewCharges": { + "description": "The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices.", + "enum": [ + "Other", + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "ViewChargesPolicy", + "modelAsString": true + } + }, + "policies": { + "description": "List of all policies defined at the billing scope.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicySummary" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "EnterpriseAgreementPolicies": { + "description": "The policies for Enterprise Agreement enrollments.", + "type": "object", + "properties": { + "authenticationType": { + "description": "The state showing the enrollment auth level.", + "enum": [ + "Other", + "MicrosoftAccountOnly", + "MixedAccount", + "OrganizationalAccountCrossTenant", + "OrganizationalAccountOnly" + ], + "type": "string", + "x-ms-enum": { + "name": "EnrollmentAuthLevelState", + "modelAsString": true + } + }, + "accountOwnerViewCharges": { + "description": "The policy that controls whether account owner can view charges.", + "enum": [ + "Other", + "Allowed", + "Disabled", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "EnrollmentAccountOwnerViewCharges", + "modelAsString": true + } + }, + "departmentAdminViewCharges": { + "description": "The policy that controls whether department admin can view charges.", + "enum": [ + "Other", + "Allowed", + "Disabled", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "EnrollmentDepartmentAdminViewCharges", + "modelAsString": true + } + } + } + }, + "PolicySummary": { + "description": "The summary of the policy.", + "type": "object", + "properties": { + "name": { + "description": "The name of the policy.", + "type": "string" + }, + "value": { + "description": "The value of the policy.", + "type": "string" + }, + "policyType": { + "description": "The type of the policy.", + "enum": [ + "Other", + "UserControlled", + "SystemControlled" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyType", + "modelAsString": true + } + }, + "scope": { + "description": "The scope at which the policy is defined.", + "type": "string" + } + } + }, + "SubscriptionPolicy": { + "description": "A policy at subscription scope.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SubscriptionPolicyProperties" + } + }, + "x-ms-azure-resource": true + }, + "SubscriptionPolicyProperties": { + "description": "A policy at subscription scope.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource during a long-running operation.", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "New", + "Pending", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "policies": { + "description": "List of all policies defined at the billing scope.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicySummary" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/product.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/product.json new file mode 100644 index 000000000000..f7e58250fb7d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/product.json @@ -0,0 +1,826 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products": { + "get": { + "tags": [ + "Product" + ], + "description": "Lists the products for an invoice section. These don't include products billed based on usage. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Products_ListByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.", + "schema": { + "$ref": "#/definitions/ProductListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProductsListByInvoiceSection": { + "$ref": "./examples/productsListByInvoiceSection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/products": { + "get": { + "tags": [ + "Product" + ], + "description": "Lists the products for a billing profile. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Products_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.", + "schema": { + "$ref": "#/definitions/ProductListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProductsListByBillingProfile": { + "$ref": "./examples/productsListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products": { + "get": { + "tags": [ + "Product" + ], + "description": "Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Products_ListByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.", + "schema": { + "$ref": "#/definitions/ProductListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProductsListByCustomer": { + "$ref": "./examples/productsListByCustomer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/move": { + "post": { + "tags": [ + "Product" + ], + "description": "Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Products_Move", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/productName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of the product to initiate a transfer.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveProductRequest" + } + } + ], + "responses": { + "200": { + "description": "A product.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ProductMove": { + "$ref": "./examples/productMove.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/validateMoveEligibility": { + "post": { + "tags": [ + "Product" + ], + "description": "Validates if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Products_ValidateMoveEligibility", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/productName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The properties of the product to initiate a transfer.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveProductRequest" + } + } + ], + "responses": { + "200": { + "description": "Result of the transfer eligibility validation.", + "schema": { + "$ref": "#/definitions/MoveProductEligibilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProductValidateMoveSuccess": { + "$ref": "./examples/productValidateMoveSuccess.json" + }, + "ProductValidateMoveFailure": { + "$ref": "./examples/productValidateMoveFailure.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}": { + "get": { + "tags": [ + "Product" + ], + "description": "Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Products_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/productName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A product.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProductsGet": { + "$ref": "./examples/productsGet.json" + } + } + }, + "patch": { + "tags": [ + "Product" + ], + "description": "Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Products_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/productName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "A product.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductPatch" + } + } + ], + "responses": { + "200": { + "description": "A product.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProductsUpdate": { + "$ref": "./examples/productsUpdate.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products": { + "get": { + "tags": [ + "Product" + ], + "description": "Lists the products for a billing account. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Products_ListByBillingAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.", + "schema": { + "$ref": "#/definitions/ProductListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProductsListByBillingAccount": { + "$ref": "./examples/productsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ExternalReference": { + "description": "An external reference.", + "type": "object", + "properties": { + "id": { + "description": "The ID that uniquely identifies an external reference.", + "type": "string", + "readOnly": true + }, + "url": { + "description": "The URL of the external reference.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "MoveProductEligibilityResult": { + "description": "Result of the transfer eligibility validation.", + "type": "object", + "properties": { + "isMoveEligible": { + "description": "Specifies whether the subscription is eligible to be transferred.", + "type": "boolean" + }, + "errorDetails": { + "description": "Error details of the transfer eligibility validation.", + "allOf": [ + { + "$ref": "#/definitions/MoveProductErrorDetails" + } + ] + } + } + }, + "MoveProductErrorDetails": { + "description": "Error details of the transfer eligibility validation.", + "type": "object", + "properties": { + "code": { + "description": "Error code for the product transfer validation.", + "enum": [ + "Other", + "BillingAccountInactive", + "DestinationBillingProfileInactive", + "DestinationBillingProfileNotFound", + "DestinationBillingProfilePastDue", + "DestinationInvoiceSectionInactive", + "DestinationInvoiceSectionNotFound", + "InsufficientPermissionOnDestination", + "InsufficientPermissionOnSource", + "InvalidDestination", + "InvalidSource", + "MarketplaceNotEnabledOnDestination", + "ProductInactive", + "ProductNotFound", + "ProductTypeNotSupported", + "SourceBillingProfilePastDue", + "SourceInvoiceSectionInactive" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MoveValidationErrorCode", + "modelAsString": true + } + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Error details of the transfer eligibility validation.", + "type": "string", + "readOnly": true + } + } + }, + "MoveProductRequest": { + "description": "The properties of the product to initiate a transfer.", + "required": [ + "destinationInvoiceSectionId" + ], + "type": "object", + "properties": { + "destinationInvoiceSectionId": { + "description": "The destination invoice section id.", + "minLength": 1, + "type": "string" + } + } + }, + "Product": { + "description": "A product.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProductProperties" + } + }, + "x-ms-azure-resource": true + }, + "ProductListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Product" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "ProductPatch": { + "description": "A product.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProductProperties" + } + }, + "x-ms-azure-resource": true + }, + "ProductProperties": { + "description": "A product.", + "type": "object", + "properties": { + "autoRenew": { + "description": "Indicates whether auto renewal is turned on or off for a product.", + "enum": [ + "Off", + "On" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoRenew", + "modelAsString": true + } + }, + "availabilityId": { + "description": "The availability of the product.", + "type": "string", + "readOnly": true + }, + "billingFrequency": { + "description": "The frequency at which the product will be billed.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The ID of the billing profile to which the product is billed.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile to which the product is billed.", + "type": "string", + "readOnly": true + }, + "customerId": { + "description": "The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.", + "type": "string", + "readOnly": true + }, + "customerDisplayName": { + "description": "The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the product.", + "type": "string", + "readOnly": true + }, + "endDate": { + "description": "The date when the product will be renewed or canceled.", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "The ID of the invoice section to which the product is billed.", + "type": "string", + "readOnly": true + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section to which the product is billed.", + "type": "string", + "readOnly": true + }, + "lastCharge": { + "description": "The last month charges.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "lastChargeDate": { + "description": "The date of the last charge.", + "type": "string", + "readOnly": true + }, + "productType": { + "description": "The description of the type of product.", + "type": "string", + "readOnly": true + }, + "productTypeId": { + "description": "The ID of the type of product.", + "type": "string", + "readOnly": true + }, + "skuId": { + "description": "The sku ID of the product.", + "type": "string", + "readOnly": true + }, + "skuDescription": { + "description": "The sku description of the product.", + "type": "string", + "readOnly": true + }, + "purchaseDate": { + "description": "The date when the product was purchased.", + "type": "string", + "readOnly": true + }, + "quantity": { + "format": "int64", + "description": "The quantity purchased for the product.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "The status of the product.", + "enum": [ + "Other", + "Active", + "Disabled", + "Deleted", + "PastDue", + "Expiring", + "Expired", + "AutoRenew", + "Canceled", + "Suspended" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProductStatus", + "modelAsString": true + } + }, + "tenantId": { + "description": "The id of the tenant in which the product is used.", + "type": "string", + "readOnly": true + }, + "reseller": { + "description": "Reseller for this product. The fields is not available for Microsoft Partner Agreement products.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Reseller" + } + ] + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/reservation.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/reservation.json new file mode 100644 index 000000000000..24ad2e5bae60 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/reservation.json @@ -0,0 +1,1423 @@ +{ + "swagger": "2.0", + "info": { + "description": "Billing client provides access to billing resources for Azure subscriptions.", + "title": "BillingManagementClient", + "version": "2024-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations": { + "get": { + "description": "Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.", + "operationId": "Reservations_ListByBillingAccount", + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + }, + { + "$ref": "#/parameters/RefreshSummaryParameter" + }, + { + "$ref": "#/parameters/SelectedStateParameter" + }, + { + "$ref": "#/parameters/TakeParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Reservations" + ], + "x-ms-examples": { + "reservationsListByBillingAccount": { + "$ref": "./examples/reservationsListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/reservations": { + "get": { + "tags": [ + "Reservations" + ], + "x-ms-examples": { + "ReservationsListByBillingProfile": { + "$ref": "./examples/reservationsListByBillingProfile.json" + } + }, + "operationId": "Reservations_ListByBillingProfile", + "description": "Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.", + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + }, + { + "$ref": "#/parameters/RefreshSummaryParameter" + }, + { + "$ref": "#/parameters/SelectedStateParameter" + }, + { + "$ref": "#/parameters/TakeParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations/{reservationId}": { + "get": { + "summary": "Get Reservation details in the billing account.", + "description": "Get specific Reservation details in the billing account.", + "operationId": "Reservations_GetByReservationOrder", + "x-ms-examples": { + "reservationGetByBillingAccount": { + "$ref": "./examples/reservationGetByBillingAccount.json" + }, + "reservationGetByBillingAccountSingleScope": { + "$ref": "./examples/reservationGetByBillingAccountSingleScope.json" + }, + "reservationGetByBillingAccountSingleResourceGroup": { + "$ref": "./examples/reservationGetByBillingAccountSingleResourceGroup.json" + }, + "reservationGetByBillingAccountManagementGroup": { + "$ref": "./examples/reservationGetByBillingAccountManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ReservationIdParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "tags": [ + "Reservation" + ], + "responses": { + "200": { + "description": "Get `Reservation` details.", + "schema": { + "$ref": "#/definitions/Reservation" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "description": "Update reservation by billing account.", + "operationId": "Reservations_UpdateByBillingAccount", + "tags": [ + "Reservation" + ], + "x-ms-examples": { + "ReservationUpdate": { + "$ref": "./examples/reservationUpdateByBillingAccount.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ReservationIdParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/PatchParameter" + } + ], + "responses": { + "200": { + "description": "The request is completed.", + "schema": { + "$ref": "#/definitions/Reservation" + } + }, + "202": { + "description": "The request is accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URL for checking the ongoing status of the operation." + }, + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "Clients should wait for the Retry-After interval before polling again" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations": { + "get": { + "summary": "Get Reservations in a given reservation Order in the billing account", + "description": "List Reservations within a single ReservationOrder in the billing account.", + "operationId": "Reservations_ListByReservationOrder", + "x-ms-examples": { + "reservationsGetFromOrderByBillingAccount": { + "$ref": "./examples/reservationsGetFromOrderByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "#/parameters/ReservationOrderIdParameter" + } + ], + "tags": [ + "Reservations" + ], + "responses": { + "200": { + "description": "List `Reservation`s within a single `ReservationOrder`.", + "schema": { + "$ref": "#/definitions/ReservationList" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}": { + "get": { + "summary": "Get a specific ReservationOrder in the billing account.", + "description": "Get the details of the ReservationOrder in the billing account.", + "operationId": "ReservationOrders_GetByBillingAccount", + "x-ms-examples": { + "reservationOrderGetByBillingAccount": { + "$ref": "./examples/reservationOrderGetByBillingAccount.json" + }, + "reservationOrderGetByBillingAccountWithExpandPlanInformation": { + "$ref": "./examples/reservationOrderGetByBillingAccountWithExpandPlanInformation.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "tags": [ + "ReservationOrder" + ], + "responses": { + "200": { + "description": "Get the details of the `ReservationOrder`.", + "schema": { + "$ref": "#/definitions/ReservationOrder" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders": { + "get": { + "summary": "Get all `ReservationOrders in the billing account.", + "description": "List all the `ReservationOrders in the billing account.", + "operationId": "ReservationOrders_ListByBillingAccount", + "x-ms-examples": { + "reservationOrderListByBillingAccount": { + "$ref": "./examples/reservationOrdersListByBillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + } + ], + "tags": [ + "ReservationOrders" + ], + "responses": { + "200": { + "description": "List of ReservationOrders", + "schema": { + "$ref": "#/definitions/ReservationOrderList" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ReservationOrder": { + "type": "object", + "description": "Details of a reservation order being returned.", + "x-ms-azure-resource": true, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "etag": { + "type": "integer", + "format": "int32" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReservationOrderProperty", + "description": "The properties associated to this reservation order", + "type": "object" + }, + "tags": { + "description": "Tags for this reservation", + "$ref": "#/definitions/Tags" + } + } + }, + "Reservation": { + "type": "object", + "description": "The definition of the reservation.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "x-ms-azure-resource": true, + "properties": { + "location": { + "description": "The location of the reservation.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "etag": { + "type": "integer", + "format": "int32" + }, + "properties": { + "$ref": "#/definitions/ReservationProperty", + "description": "The properties associated to this reservation", + "type": "object", + "x-ms-client-flatten": true + }, + "tags": { + "description": "Tags for this reservation", + "$ref": "#/definitions/Tags" + }, + "sku": { + "$ref": "#/definitions/ReservationSkuProperty", + "description": "The sku information associated to this reservation", + "type": "object" + } + } + }, + "ReservationAppliedScope": { + "description": "Reservation applied scope", + "readOnly": true, + "type": "string" + }, + "ReservationOrderProperty": { + "type": "object", + "description": "Properties of a reservation order.", + "properties": { + "displayName": { + "type": "string", + "description": "Friendly name for user to easily identified the reservation order." + }, + "enrollmentId": { + "type": "string", + "description": "Enrollment id of the reservation order." + }, + "customerId": { + "type": "string", + "description": "Fully-qualified identifier of the customerId where the benefit is applied. Present only for Enterprise Agreement PartnerLed customers." + }, + "billingProfileId": { + "type": "string", + "description": "Billing profile Id associated to this reservation order." + }, + "billingAccountId": { + "type": "string", + "description": "Billing account Id associated to this reservation order." + }, + "requestDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the DateTime when the reservation order was initially requested for purchase." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the DateTime when the reservation order was created." + }, + "expiryDate": { + "type": "string", + "format": "date", + "description": "This is the date when the reservation order will expire." + }, + "expiryDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the date-time when the reservation order will expire." + }, + "benefitStartTime": { + "type": "string", + "format": "date-time", + "description": "This is the DateTime when the reservation benefit started." + }, + "originalQuantity": { + "type": "integer", + "format": "int32", + "description": "Total original quantity of the skus purchased in the reservation order." + }, + "term": { + "description": "The term of the reservation, e.g. P1Y", + "readOnly": true, + "type": "string" + }, + "provisioningState": { + "description": "The provisioning state of the reservation, e.g. Succeeded", + "readOnly": true, + "type": "string" + }, + "billingPlan": { + "$ref": "#/definitions/ReservationBillingPlan" + }, + "planInformation": { + "$ref": "#/definitions/ReservationOrderBillingPlanInformation" + }, + "reservations": { + "type": "array", + "items": { + "$ref": "#/definitions/Reservation" + } + }, + "reviewDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the date-time when the Azure Hybrid Benefit needs to be reviewed." + }, + "extendedStatusInfo": { + "$ref": "#/definitions/ReservationExtendedStatusInfo" + }, + "productCode": { + "$ref": "#/definitions/ProductCode" + } + } + }, + "ReservationProperty": { + "type": "object", + "description": "The property of reservation object.", + "properties": { + "reservedResourceType": { + "description": "The reserved source type of the reservation, e.g. virtual machine.", + "readOnly": true, + "type": "string" + }, + "instanceFlexibility": { + "description": "Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility.", + "$ref": "#/definitions/InstanceFlexibility" + }, + "displayName": { + "description": "The display name of the reservation", + "readOnly": true, + "type": "string" + }, + "appliedScopes": { + "description": "The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope", + "items": { + "$ref": "#/definitions/ReservationAppliedScope" + }, + "type": "array" + }, + "appliedScopeType": { + "description": "The applied scope type of the reservation.", + "readOnly": true, + "type": "string" + }, + "archived": { + "description": "Indicates if the reservation is archived", + "type": "boolean" + }, + "capabilities": { + "description": "Capabilities of the reservation", + "type": "string" + }, + "quantity": { + "description": "The number of the reservation.", + "readOnly": true, + "type": "number" + }, + "provisioningState": { + "description": "The provisioning state of the reservation, e.g. Succeeded", + "readOnly": true, + "type": "string" + }, + "effectiveDateTime": { + "description": "The effective date time of the reservation", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "benefitStartTime": { + "type": "string", + "format": "date-time", + "description": "This is the DateTime when the reservation benefit started." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "DateTime of the last time the reservation was updated.", + "readOnly": true + }, + "expiryDate": { + "description": "The expiry date of the reservation", + "readOnly": true, + "type": "string" + }, + "expiryDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the date-time when the reservation will expire." + }, + "reviewDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the date-time when the Azure Hybrid Benefit needs to be reviewed." + }, + "skuDescription": { + "description": "The sku description of the reservation", + "readOnly": true, + "type": "string" + }, + "extendedStatusInfo": { + "description": "The message giving detailed information about the status code.", + "$ref": "#/definitions/ReservationExtendedStatusInfo" + }, + "billingPlan": { + "description": "The billing plan options available for this sku.", + "$ref": "#/definitions/ReservationBillingPlan" + }, + "displayProvisioningState": { + "description": "The provisioning state of the reservation for display, e.g. Succeeded", + "readOnly": true, + "type": "string" + }, + "provisioningSubState": { + "description": "The provisioning state of the reservation, e.g. Succeeded", + "readOnly": true, + "type": "string" + }, + "purchaseDate": { + "type": "string", + "format": "date", + "description": "This is the date when the reservation was purchased." + }, + "purchaseDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the date-time when the reservation was purchased." + }, + "splitProperties": { + "$ref": "#/definitions/ReservationSplitProperties" + }, + "mergeProperties": { + "$ref": "#/definitions/ReservationMergeProperties" + }, + "swapProperties": { + "$ref": "#/definitions/ReservationSwapProperties" + }, + "appliedScopeProperties": { + "$ref": "#/definitions/ReservationAppliedScopeProperties" + }, + "billingScopeId": { + "description": "Subscription that will be charged for purchasing reservation or savings plan", + "readOnly": true, + "type": "string" + }, + "renew": { + "description": "The renew state of the reservation", + "readOnly": true, + "type": "boolean" + }, + "renewSource": { + "description": "The renew source of the reservation", + "readOnly": true, + "type": "string" + }, + "renewDestination": { + "type": "string", + "description": "Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}." + }, + "renewProperties": { + "$ref": "#/definitions/RenewPropertiesResponse" + }, + "term": { + "description": "The term of the reservation, e.g. P1Y", + "readOnly": true, + "type": "string" + }, + "userFriendlyAppliedScopeType": { + "description": "The applied scope type of the reservation for display, e.g. Shared", + "readOnly": true, + "type": "string" + }, + "userFriendlyRenewState": { + "description": "The renew state of the reservation for display, e.g. On", + "readOnly": true, + "type": "string" + }, + "utilization": { + "readOnly": true, + "type": "object", + "description": "Reservation utilization", + "x-ms-client-flatten": true, + "properties": { + "trend": { + "description": "last 7 day utilization trend for a reservation", + "readOnly": true, + "type": "string" + }, + "aggregates": { + "description": "The array of aggregates of a reservation's utilization", + "type": "array", + "items": { + "$ref": "#/definitions/ReservationUtilizationAggregates" + }, + "x-ms-identifiers": [] + } + } + }, + "productCode": { + "$ref": "#/definitions/ProductCode" + } + } + }, + "ReservationSkuProperty": { + "type": "object", + "description": "The property of reservation sku object.", + "properties": { + "name": { + "description": "The name of the reservation sku.", + "readOnly": true, + "type": "string" + } + } + }, + "ReservationsListResult": { + "type": "object", + "description": "The list of reservations and summary of roll out count of reservations in each state.", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "readOnly": true, + "type": "string" + }, + "summary": { + "$ref": "#/definitions/ReservationSummary", + "description": "The roll out count summary of the reservations", + "type": "object" + }, + "value": { + "description": "The list of reservations.", + "items": { + "$ref": "#/definitions/Reservation" + }, + "readOnly": true, + "type": "array" + } + } + }, + "ReservationOrderList": { + "type": "object", + "description": "List of ReservationOrders", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReservationOrder" + } + }, + "nextLink": { + "type": "string", + "description": "Url to get the next page of reservationOrders." + } + } + }, + "ReservationList": { + "type": "object", + "description": "List of `Reservations", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Reservation" + } + }, + "nextLink": { + "type": "string", + "description": "Url to get the next page of reservations." + } + } + }, + "ReservationSummary": { + "description": "The roll up count summary of reservations in each state", + "properties": { + "cancelledCount": { + "description": "The number of reservation in Cancelled state", + "readOnly": true, + "type": "number" + }, + "expiredCount": { + "description": "The number of reservation in Expired state", + "readOnly": true, + "type": "number" + }, + "expiringCount": { + "description": "The number of reservation in Expiring state", + "readOnly": true, + "type": "number" + }, + "failedCount": { + "description": "The number of reservation in Failed state", + "readOnly": true, + "type": "number" + }, + "pendingCount": { + "description": "The number of reservation in Pending state", + "readOnly": true, + "type": "number" + }, + "succeededCount": { + "description": "The number of reservation in Succeeded state", + "readOnly": true, + "type": "number" + }, + "noBenefitCount": { + "description": "The number of reservation in 'No Benefit' state", + "readOnly": true, + "type": "number" + }, + "warningCount": { + "description": "The number of reservation in Warning state", + "readOnly": true, + "type": "number" + }, + "processingCount": { + "description": "The number of reservation in Processing state", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "ReservationUtilizationAggregates": { + "description": "The aggregate values of reservation utilization", + "properties": { + "grain": { + "description": "The grain of the aggregate", + "readOnly": true, + "type": "number" + }, + "grainUnit": { + "description": "The grain unit of the aggregate", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The aggregate value", + "readOnly": true, + "type": "number" + }, + "valueUnit": { + "description": "The aggregate value unit", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RenewPropertiesResponse": { + "type": "object", + "description": "The renew properties for a reservation.", + "properties": { + "purchaseProperties": { + "$ref": "#/definitions/ReservationPurchaseRequest" + }, + "pricingCurrencyTotal": { + "$ref": "#/definitions/Price", + "description": "Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry." + }, + "billingCurrencyTotal": { + "$ref": "#/definitions/Price", + "description": "Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included." + } + } + }, + "ReservationPurchaseRequest": { + "type": "object", + "description": "The request for reservation purchase", + "properties": { + "sku": { + "$ref": "#/definitions/SkuName" + }, + "location": { + "type": "string", + "description": "The Azure region where the reserved resource lives.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReservationPurchaseRequestProperties" + } + } + }, + "Patch": { + "type": "object", + "description": "The request for reservation patch", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchProperties" + }, + "sku": { + "$ref": "#/definitions/ReservationSkuProperty", + "description": "The sku information associated to this reservation", + "type": "object" + }, + "tags": { + "description": "Tags for this reservation", + "$ref": "#/definitions/Tags" + } + } + }, + "PatchProperties": { + "type": "object", + "description": "Properties for reservation patch", + "properties": { + "appliedScopeType": { + "$ref": "#/definitions/AppliedScopeType" + }, + "appliedScopeProperties": { + "$ref": "#/definitions/ReservationAppliedScopeProperties" + }, + "instanceFlexibility": { + "$ref": "#/definitions/InstanceFlexibility" + }, + "displayName": { + "type": "string", + "description": "Display name of the reservation" + }, + "renew": { + "$ref": "#/definitions/Renew" + }, + "renewProperties": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "purchaseProperties": { + "$ref": "#/definitions/ReservationPurchaseRequest" + } + } + }, + "reviewDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the date-time when the Azure hybrid benefit needs to be reviewed." + } + } + }, + "Price": { + "type": "object", + "description": "The price.", + "properties": { + "currencyCode": { + "type": "string", + "description": "The ISO 4217 3-letter currency code for the currency used by this purchase record." + }, + "amount": { + "type": "number", + "format": "double" + } + } + }, + "SkuName": { + "type": "object", + "description": "The name of sku", + "properties": { + "name": { + "type": "string" + } + } + }, + "ReservationPurchaseRequestProperties": { + "type": "object", + "description": "Properties of reservation purchase request", + "properties": { + "reservedResourceType": { + "description": "The reserved source type of the reservation, e.g. virtual machine.", + "readOnly": true, + "type": "string" + }, + "billingScopeId": { + "type": "string", + "readOnly": true, + "description": "Subscription that will be charged for purchasing reservation or savings plan" + }, + "term": { + "description": "The term of the reservation, e.g. P1Y", + "readOnly": true, + "type": "string" + }, + "billingPlan": { + "$ref": "#/definitions/ReservationBillingPlan" + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "Quantity of the skus that are part of the reservation. Must be greater than zero." + }, + "displayName": { + "type": "string", + "description": "Friendly name of the reservation" + }, + "appliedScopeType": { + "$ref": "#/definitions/AppliedScopeType" + }, + "appliedScopes": { + "$ref": "#/definitions/AppliedScopes" + }, + "appliedScopeProperties": { + "$ref": "#/definitions/ReservationAppliedScopeProperties" + }, + "renew": { + "$ref": "#/definitions/Renew" + }, + "reservedResourceProperties": { + "type": "object", + "description": "Properties specific to each reserved resource type. Not required if not applicable.", + "x-ms-client-flatten": true, + "properties": { + "instanceFlexibility": { + "$ref": "#/definitions/InstanceFlexibility" + } + } + }, + "instanceFlexibility": { + "description": "Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility.", + "$ref": "#/definitions/InstanceFlexibility" + }, + "reviewDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the date-time when the Azure hybrid benefit needs to be reviewed." + } + } + }, + "ReservationBillingPlan": { + "type": "string", + "description": "Represent the billing plans.", + "enum": [ + "Upfront", + "Monthly" + ], + "x-ms-enum": { + "name": "ReservationBillingPlan", + "modelAsString": true + } + }, + "AppliedScopeType": { + "type": "string", + "description": "Type of the Applied Scope.", + "enum": [ + "Single", + "Shared", + "ManagementGroup" + ], + "x-ms-enum": { + "name": "AppliedScopeType", + "modelAsString": true + } + }, + "AppliedScopes": { + "type": "array", + "description": "List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared.", + "items": { + "type": "string", + "minItems": 1, + "maxItems": 1 + }, + "x-ms-identifiers": [] + }, + "ReservationAppliedScopeProperties": { + "type": "object", + "description": "Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup", + "properties": { + "tenantId": { + "type": "string", + "description": "Tenant ID where the reservation should apply benefit." + }, + "managementGroupId": { + "type": "string", + "description": "Fully-qualified identifier of the management group where the benefit must be applied." + }, + "subscriptionId": { + "type": "string", + "description": "Fully-qualified identifier of the subscription." + }, + "resourceGroupId": { + "type": "string", + "description": "Fully-qualified identifier of the resource group." + }, + "displayName": { + "type": "string", + "description": "Display name" + } + } + }, + "Renew": { + "type": "boolean", + "default": false, + "description": "Setting this to true will automatically purchase a new reservation on the expiration date time." + }, + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource Tags" + }, + "ProductCode": { + "type": "string", + "description": "Represents UPN" + }, + "InstanceFlexibility": { + "type": "string", + "description": "Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.", + "enum": [ + "On", + "Off" + ], + "x-ms-enum": { + "name": "InstanceFlexibility", + "modelAsString": true + } + }, + "ReservationExtendedStatusInfo": { + "type": "object", + "description": "Extended status information for the reservation.", + "properties": { + "statusCode": { + "$ref": "#/definitions/ReservationStatusCode" + }, + "message": { + "type": "string", + "description": "The message giving detailed information about the status code." + }, + "properties": { + "description": "Properties for extended status information", + "$ref": "#/definitions/ExtendedStatusDefinitionProperties" + } + } + }, + "ReservationStatusCode": { + "type": "string", + "description": "The status of the reservation.", + "enum": [ + "None", + "Pending", + "Processing", + "Active", + "PurchaseError", + "PaymentInstrumentError", + "Split", + "Merged", + "Expired", + "Succeeded", + "CapacityError", + "CapacityRestricted", + "Exchanged", + "UnknownError", + "RiskCheckFailed", + "CreditLineCheckFailed", + "Warning", + "NoBenefitDueToSubscriptionTransfer", + "NoBenefitDueToSubscriptionDeletion", + "NoBenefit" + ], + "x-ms-enum": { + "name": "ReservationStatusCode", + "modelAsString": true + } + }, + "ExtendedStatusDefinitionProperties": { + "type": "object", + "description": "Extended status definition properties", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription Id" + } + } + }, + "ReservationSplitProperties": { + "type": "object", + "description": "Properties of reservation split", + "properties": { + "splitDestinations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + }, + "splitSource": { + "type": "string", + "description": "Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + } + } + }, + "ReservationMergeProperties": { + "type": "object", + "description": "Properties of reservation merge", + "properties": { + "mergeDestination": { + "type": "string", + "description": "Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + }, + "mergeSources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + } + } + }, + "ReservationSwapProperties": { + "type": "object", + "description": "Properties of reservation swap", + "properties": { + "swapSource": { + "type": "string", + "description": "Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + }, + "swapDestination": { + "type": "string", + "description": "Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + } + } + }, + "ReservationOrderBillingPlanInformation": { + "type": "object", + "description": "Information describing the type of billing plan for this reservation order.", + "properties": { + "pricingCurrencyTotal": { + "$ref": "#/definitions/Price", + "description": "Amount of money to be paid for the Order. Tax is not included." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "Date when the billing plan has started." + }, + "nextPaymentDueDate": { + "type": "string", + "format": "date", + "description": "For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off." + }, + "transactions": { + "type": "array", + "items": { + "$ref": "#/definitions/ReservationPaymentDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "ReservationPaymentDetail": { + "type": "object", + "description": "Information about payment related to a reservation order.", + "properties": { + "dueDate": { + "type": "string", + "format": "date", + "description": "Date when the payment needs to be done." + }, + "paymentDate": { + "type": "string", + "format": "date", + "description": "Date when the transaction is completed. Is null when it is scheduled." + }, + "pricingCurrencyTotal": { + "$ref": "#/definitions/Price", + "description": "Amount in pricing currency. Tax not included." + }, + "billingCurrencyTotal": { + "$ref": "#/definitions/Price", + "description": "Amount charged in Billing currency. Tax not included. Is null for future payments" + }, + "billingAccount": { + "type": "string", + "description": "Shows the Account that is charged for this payment." + }, + "status": { + "$ref": "#/definitions/PaymentStatus" + }, + "extendedStatusInfo": { + "$ref": "#/definitions/ReservationExtendedStatusInfo" + } + } + }, + "PaymentStatus": { + "type": "string", + "description": "Describes whether the payment is completed, failed, cancelled or scheduled in the future.", + "enum": [ + "Succeeded", + "Failed", + "Scheduled", + "Cancelled", + "Pending", + "Completed" + ], + "x-ms-enum": { + "name": "PaymentStatus", + "modelAsString": true + } + } + }, + "parameters": { + "ExpandParameter": { + "name": "expand", + "description": "May be used to expand the detail information of some properties.", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "string" + }, + "SkipTokenParameter": { + "name": "skiptoken", + "description": "The number of reservations to skip from the list before returning results", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "number" + }, + "TakeParameter": { + "name": "take", + "description": "The number of reservations to return in API response.", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "number" + }, + "SelectedStateParameter": { + "name": "selectedState", + "description": "The selected provisioning state", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "string" + }, + "RefreshSummaryParameter": { + "name": "refreshSummary", + "description": "To indicate whether to refresh the roll up counts of the reservations group by provisioning states", + "in": "query", + "x-ms-parameter-location": "method", + "required": false, + "type": "string" + }, + "ReservationIdParameter": { + "name": "reservationId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the reservation item" + }, + "ReservationOrderIdParameter": { + "name": "reservationOrderId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Order Id of the reservation" + }, + "PatchParameter": { + "name": "body", + "in": "body", + "x-ms-parameter-location": "method", + "required": true, + "description": "Request body for patching a reservation", + "schema": { + "$ref": "#/definitions/Patch" + } + } + }, + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/transaction.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/transaction.json new file mode 100644 index 000000000000..3b0d5852805b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/transaction.json @@ -0,0 +1,862 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transactions": { + "get": { + "tags": [ + "Transaction" + ], + "description": "Lists the billed or unbilled transactions by customer id for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Transactions_ListByCustomer", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "in": "query", + "name": "periodStartDate", + "description": "The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", + "required": true, + "type": "string", + "format": "date" + }, + { + "in": "query", + "name": "periodEndDate", + "description": "The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", + "required": true, + "type": "string", + "format": "date" + }, + { + "in": "query", + "name": "type", + "description": "The type of transaction.", + "required": true, + "type": "string", + "enum": [ + "Other", + "Billed", + "Unbilled" + ], + "x-ms-enum": { + "name": "TransactionType", + "modelAsString": true + } + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of transactions.", + "schema": { + "$ref": "#/definitions/TransactionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransactionsListByCustomer": { + "$ref": "./examples/transactionsListByCustomer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transactions": { + "get": { + "tags": [ + "Transaction" + ], + "description": "Lists the billed or unbilled transactions by invoice section name for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Transactions_ListByInvoiceSection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "in": "query", + "name": "periodStartDate", + "description": "The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", + "required": true, + "type": "string", + "format": "date" + }, + { + "in": "query", + "name": "periodEndDate", + "description": "The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", + "required": true, + "type": "string", + "format": "date" + }, + { + "in": "query", + "name": "type", + "description": "The type of transaction.", + "required": true, + "type": "string", + "enum": [ + "Other", + "Billed", + "Unbilled" + ], + "x-ms-enum": { + "name": "TransactionType", + "modelAsString": true + } + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of transactions.", + "schema": { + "$ref": "#/definitions/TransactionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransactionsListByInvoiceSection": { + "$ref": "./examples/transactionsListByInvoiceSection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions": { + "get": { + "tags": [ + "Transaction" + ], + "description": "Lists the billed or unbilled transactions by billing profile name for given start and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Transactions_ListByBillingProfile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "in": "query", + "name": "periodStartDate", + "description": "The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", + "required": true, + "type": "string", + "format": "date" + }, + { + "in": "query", + "name": "periodEndDate", + "description": "The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.", + "required": true, + "type": "string", + "format": "date" + }, + { + "in": "query", + "name": "type", + "description": "The type of transaction.", + "required": true, + "type": "string", + "enum": [ + "Other", + "Billed", + "Unbilled" + ], + "x-ms-enum": { + "name": "TransactionType", + "modelAsString": true + } + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of transactions.", + "schema": { + "$ref": "#/definitions/TransactionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransactionsListByBillingProfile": { + "$ref": "./examples/transactionsListByBillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactions": { + "get": { + "tags": [ + "Transaction" + ], + "description": "Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Transactions_ListByInvoice", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "$ref": "./types.json#/parameters/filter" + }, + { + "$ref": "./types.json#/parameters/orderBy" + }, + { + "$ref": "./types.json#/parameters/top" + }, + { + "$ref": "./types.json#/parameters/skip" + }, + { + "$ref": "./types.json#/parameters/count" + }, + { + "$ref": "./types.json#/parameters/search" + } + ], + "responses": { + "200": { + "description": "The list of transactions.", + "schema": { + "$ref": "#/definitions/TransactionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransactionsListByInvoice": { + "$ref": "./examples/transactionsListByInvoice.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactionsDownload": { + "post": { + "tags": [ + "Transaction" + ], + "description": "Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Transactions_TransactionsDownloadByInvoice", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A secure URL that can be used to download a an entity until the URL expires.", + "schema": { + "$ref": "#/definitions/DocumentDownloadResult" + } + }, + "202": { + "description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.", + "headers": { + "Location": { + "type": "string" + }, + "Retry-After": { + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "TransactionsDownloadByInvoice": { + "$ref": "./examples/transactionsDownloadByInvoice.json" + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactionSummary": { + "get": { + "tags": [ + "Transaction" + ], + "description": "Gets the transaction summary for an invoice. Transactions include purchases, refunds and Azure usage charges.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "Transactions_GetTransactionSummaryByInvoice", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/invoiceName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + }, + { + "in": "query", + "name": "filter", + "description": "The filter query option allows clients to filter the line items that are aggregated to create the line item summary.", + "type": "string" + }, + { + "in": "query", + "name": "search", + "description": "The search query option allows clients to filter the line items that are aggregated to create the line item summary.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "A transaction summary.", + "schema": { + "$ref": "#/definitions/TransactionSummary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransactionSummaryGetByInvoice": { + "$ref": "./examples/transactionSummaryGetByInvoice.json" + } + } + } + } + }, + "definitions": { + "DocumentDownloadResult": { + "description": "A secure URL that can be used to download a an entity until the URL expires.", + "type": "object", + "properties": { + "expiryTime": { + "description": "The time in UTC when the download URL will expire.", + "type": "string", + "readOnly": true + }, + "url": { + "description": "The URL to the PDF or .zip file.", + "type": "string", + "readOnly": true + } + } + }, + "RefundTransactionDetails": { + "description": "The refund details of a transaction.", + "type": "object", + "properties": { + "amountRequested": { + "description": "The amount of refund requested.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "amountRefunded": { + "description": "The amount refunded.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "refundOperationId": { + "description": "The ID of refund operation.", + "type": "string" + } + } + }, + "Transaction": { + "description": "A transaction.", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TransactionProperties" + } + }, + "x-ms-azure-resource": true + }, + "TransactionListResult": { + "description": "A container for a list of resources", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Transaction" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "TransactionProperties": { + "description": "A transaction.", + "type": "object", + "properties": { + "azureCreditApplied": { + "description": "The amount of any Azure credits automatically applied to this transaction.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "azurePlan": { + "description": "Details of the Azure plan.", + "type": "string" + }, + "billingCurrency": { + "description": "The ISO 4217 code for the currency in which this transaction is billed.", + "type": "string" + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile." + }, + "billingProfileId": { + "description": "The fully qualified ID that uniquely identifies a billing profile.", + "type": "string" + }, + "consumptionCommitmentDecremented": { + "description": "The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "customerDisplayName": { + "description": "The name of the customer.", + "type": "string" + }, + "customerId": { + "description": "The fully qualified ID that uniquely identifies a customer.", + "type": "string" + }, + "creditType": { + "description": "The credit type of the transaction. Applies only to credited transactions.", + "enum": [ + "Other", + "AzureFreeCredit", + "AzureCreditOffer", + "ServiceInterruption", + "Refund" + ], + "type": "string", + "x-ms-enum": { + "name": "CreditType", + "modelAsString": true + } + }, + "date": { + "format": "date-time", + "description": "The date of transaction.", + "type": "string" + }, + "discount": { + "description": "The percentage discount, if any, applied to this transaction.", + "type": "number" + }, + "effectivePrice": { + "description": "The price of the product after applying any discounts.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "exchangeRate": { + "description": "The exchange rate used to convert charged amount to billing currency, if applicable.", + "type": "number" + }, + "invoice": { + "description": "Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed.", + "type": "string" + }, + "invoiceId": { + "description": "The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed.", + "type": "string" + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section.", + "type": "string" + }, + "invoiceSectionId": { + "description": "The fully qualified ID that uniquely identifies an invoice section.", + "type": "string" + }, + "isThirdParty": { + "description": "Whether or not the transaction is third party.", + "type": "boolean" + }, + "kind": { + "description": "Type of the transaction, billed or unbilled.", + "enum": [ + "Other", + "All", + "Reservation" + ], + "type": "string", + "x-ms-enum": { + "name": "TransactionKind", + "modelAsString": true + } + }, + "marketPrice": { + "description": "The retail price of the product.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "partNumber": { + "description": "The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices.", + "type": "string" + }, + "pricingCurrency": { + "description": "The ISO 4217 code for the currency in which the product is priced.", + "type": "string" + }, + "productDescription": { + "description": "The description of the product for which the transaction took place.", + "type": "string" + }, + "productFamily": { + "description": "The family of the product for which the transaction took place.", + "type": "string" + }, + "productTypeId": { + "description": "The ID of the product type for which the transaction took place.", + "type": "string" + }, + "productType": { + "description": "The type of the product for which the transaction took place.", + "type": "string" + }, + "quantity": { + "format": "int32", + "description": "The quantity purchased in the transaction.", + "type": "integer" + }, + "reasonCode": { + "description": "There reason code for the transaction.", + "type": "string" + }, + "servicePeriodStartDate": { + "format": "date-time", + "description": "The date of the purchase of the product, or the start date of the month in which usage started.", + "type": "string" + }, + "servicePeriodEndDate": { + "format": "date-time", + "description": "The end date of the product term, or the end date of the month in which usage ended.", + "type": "string" + }, + "subTotal": { + "description": "The pre-tax charged amount for the transaction.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "tax": { + "description": "The tax amount applied to the transaction.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "transactionAmount": { + "description": "The charge associated with the transaction.", + "allOf": [ + { + "$ref": "./types.json#/definitions/Amount" + } + ] + }, + "transactionType": { + "description": "The type of transaction.", + "type": "string" + }, + "units": { + "description": "The number of units used for a given product.", + "type": "number" + }, + "unitOfMeasure": { + "description": "The unit of measure used to bill for the product. For example, compute services are billed per hour.", + "type": "string" + }, + "unitType": { + "description": "The description for the unit of measure for a given product.", + "type": "string" + }, + "specialTaxationType": { + "description": "Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.", + "enum": [ + "SubtotalLevel", + "InvoiceLevel" + ], + "type": "string", + "x-ms-enum": { + "name": "SpecialTaxationType", + "modelAsString": true + } + }, + "refundTransactionDetails": { + "description": "The refund details of a transaction.", + "allOf": [ + { + "$ref": "#/definitions/RefundTransactionDetails" + } + ] + } + } + }, + "TransactionSummary": { + "description": "A transaction summary.", + "type": "object", + "properties": { + "azureCreditApplied": { + "description": "The total amount of any Azure credits applied.", + "type": "number", + "readOnly": true + }, + "billingCurrency": { + "description": "The ISO 4217 code for the currency in which the transactions are billed.", + "type": "string", + "readOnly": true + }, + "consumptionCommitmentDecremented": { + "description": "The total Microsoft Azure Consumption Commitment (MACC) decrement through the invoice.", + "type": "number", + "readOnly": true + }, + "subTotal": { + "description": "The total pre-tax charged amount.", + "type": "number", + "readOnly": true + }, + "tax": { + "description": "The total tax amount applied.", + "type": "number", + "readOnly": true + }, + "total": { + "description": "The total charges.", + "type": "number", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/transfers.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/transfers.json new file mode 100644 index 000000000000..8163afc7ea57 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/transfers.json @@ -0,0 +1,1225 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "BillingManagementClient", + "description": "Billing client provides access to billing resources for Azure subscriptions." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}": { + "get": { + "tags": [ + "Transfers" + ], + "description": "Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "operationId": "Transfers_Get", + "x-ms-examples": { + "TransferGet": { + "$ref": "./examples/transfersGet.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Details of transfer.", + "schema": { + "$ref": "#/definitions/TransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Transfers" + ], + "description": "Sends a request to a user in another billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "operationId": "Transfers_Initiate", + "x-ms-examples": { + "InitiateTransfer": { + "$ref": "./examples/transfersInitiate.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InitiateTransferRequest" + }, + "description": "Request parameters that are provided to the initiate transfer operation." + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Initiated transfer details.", + "schema": { + "$ref": "#/definitions/TransferDetails" + } + }, + "201": { + "description": "Initiated transfer details.", + "schema": { + "$ref": "#/definitions/TransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}/cancel": { + "post": { + "tags": [ + "Transfers" + ], + "description": "Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "operationId": "Transfers_Cancel", + "x-ms-examples": { + "TransferCancel": { + "$ref": "./examples/transfersCancel.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Details of canceled transfer.", + "schema": { + "$ref": "#/definitions/TransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers": { + "get": { + "tags": [ + "Transfers" + ], + "description": "Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "operationId": "Transfers_List", + "x-ms-examples": { + "TransfersList": { + "$ref": "./examples/transfersList.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/invoiceSectionName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of transfers initiated from this invoice section.", + "schema": { + "$ref": "#/definitions/TransferDetailsListResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}": { + "get": { + "tags": [ + "Transfers" + ], + "description": "Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "operationId": "PartnerTransfers_Get", + "x-ms-examples": { + "PartnerTransferGet": { + "$ref": "./examples/partnerTransfersGet.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Details of transfer.", + "schema": { + "$ref": "#/definitions/PartnerTransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Transfers" + ], + "description": "Sends a request to a user in a customer's billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "operationId": "PartnerTransfers_Initiate", + "x-ms-examples": { + "InitiatePartnerTransfer": { + "$ref": "./examples/partnerTransfersInitiate.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PartnerInitiateTransferRequest" + }, + "description": "Request parameters that are provided to the initiate transfer operation." + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Initiated transfer details.", + "schema": { + "$ref": "#/definitions/PartnerTransferDetails" + } + }, + "201": { + "description": "Initiated transfer details.", + "schema": { + "$ref": "#/definitions/PartnerTransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}/cancel": { + "post": { + "tags": [ + "Transfers" + ], + "description": "Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "operationId": "PartnerTransfers_Cancel", + "x-ms-examples": { + "PartnerTransferCancel": { + "$ref": "./examples/partnerTransfersCancel.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Details of canceled transfer.", + "schema": { + "$ref": "#/definitions/PartnerTransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers": { + "get": { + "tags": [ + "Transfers" + ], + "description": "Lists the transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "operationId": "PartnerTransfers_List", + "x-ms-examples": { + "PartnerTransfersList": { + "$ref": "./examples/partnerTransfersList.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/billingAccountName" + }, + { + "$ref": "./types.json#/parameters/billingProfileName" + }, + { + "$ref": "./types.json#/parameters/customerName" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of transfers initiated from this invoice section.", + "schema": { + "$ref": "#/definitions/PartnerTransferDetailsListResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/transfers/{transferName}/accept": { + "post": { + "tags": [ + "RecipientTransfers" + ], + "summary": "Accepts a transfer request.", + "operationId": "RecipientTransfers_Accept", + "x-ms-examples": { + "AcceptTransfer": { + "$ref": "./examples/recipientTransfersAccept.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AcceptTransferRequest" + }, + "description": "Request parameters that are provided to the accept transfer operation." + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Details of the accepted transfer.", + "schema": { + "$ref": "#/definitions/RecipientTransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/transfers/{transferName}/validate": { + "post": { + "tags": [ + "RecipientTransfers" + ], + "summary": "Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.", + "operationId": "RecipientTransfers_Validate", + "x-ms-examples": { + "ValidateTransfer": { + "$ref": "./examples/recipientTransfersValidate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AcceptTransferRequest" + }, + "description": "Request parameters that are provided to the validate transfer operation." + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Results of the transfer validation.", + "schema": { + "$ref": "#/definitions/ValidateTransferListResponse" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/transfers/{transferName}/decline": { + "post": { + "tags": [ + "RecipientTransfers" + ], + "summary": "Declines a transfer request.", + "operationId": "RecipientTransfers_Decline", + "x-ms-examples": { + "DeclineTransfer": { + "$ref": "./examples/recipientTransfersDecline.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Details of the declined transfer.", + "schema": { + "$ref": "#/definitions/RecipientTransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/transfers/{transferName}": { + "get": { + "tags": [ + "RecipientTransfers" + ], + "summary": "Gets a transfer request by ID. The caller must be the recipient of the transfer request.", + "operationId": "RecipientTransfers_Get", + "x-ms-examples": { + "RecipientTransferGet": { + "$ref": "./examples/recipientTransfersGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/transferNameParameter" + }, + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Details of the transfers with given Id.", + "schema": { + "$ref": "#/definitions/RecipientTransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/transfers": { + "get": { + "tags": [ + "RecipientTransfers" + ], + "summary": "Lists the transfer requests received by the caller.", + "operationId": "RecipientTransfers_List", + "x-ms-examples": { + "RecipientTransfersList": { + "$ref": "./examples/recipientTransfersList.json" + } + }, + "parameters": [ + { + "$ref": "./types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of transfers received by caller.", + "schema": { + "$ref": "#/definitions/RecipientTransferDetailsListResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-odata": "#/definitions/TransferItemQueryParameter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "InitiateTransferRequest": { + "type": "object", + "description": "Request parameters to initiate transfer.", + "properties": { + "properties": { + "description": "Request parameters to initiate transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InitiateTransferProperties" + } + } + }, + "InitiateTransferProperties": { + "type": "object", + "description": "Request parameters to initiate transfer.", + "properties": { + "recipientEmailId": { + "type": "string", + "description": "The email ID of the recipient to whom the transfer request is sent." + } + } + }, + "PartnerInitiateTransferRequest": { + "type": "object", + "description": "Request parameters to initiate partner transfer.", + "properties": { + "properties": { + "description": "Request parameters to initiate partner transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PartnerInitiateTransferProperties" + } + } + }, + "PartnerInitiateTransferProperties": { + "type": "object", + "description": "Request parameters to initiate transfer.", + "properties": { + "recipientEmailId": { + "type": "string", + "description": "The email ID of the recipient to whom the transfer request is sent." + }, + "resellerId": { + "type": "string", + "description": "Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account." + } + } + }, + "AcceptTransferRequest": { + "type": "object", + "description": "Request parameters to accept transfer.", + "properties": { + "properties": { + "description": "Request parameters to accept transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AcceptTransferProperties" + } + } + }, + "AcceptTransferProperties": { + "type": "object", + "description": "Request parameters to accept transfer.", + "properties": { + "productDetails": { + "description": "Request parameters to accept transfer.", + "type": "array", + "items": { + "$ref": "#/definitions/ProductDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "ProductDetails": { + "type": "object", + "description": "Details of the product that is transferred.", + "properties": { + "productType": { + "description": "Type of the product that is transferred.", + "$ref": "#/definitions/ProductType" + }, + "productId": { + "type": "string", + "description": "The ID of the product that is transferred." + } + } + }, + "ProductType": { + "type": "string", + "description": "The type of product that is transferred.", + "enum": [ + "AzureSubscription", + "AzureReservation", + "Department", + "SavingsPlan", + "SAAS" + ], + "x-ms-enum": { + "name": "productType", + "modelAsString": true + } + }, + "TransferDetails": { + "type": "object", + "description": "Details of the transfer.", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "description": "Details of the transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TransferProperties" + } + } + }, + "PartnerTransferDetails": { + "type": "object", + "description": "Details of the transfer.", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "description": "Details of the transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PartnerTransferProperties" + } + } + }, + "RecipientTransferDetails": { + "type": "object", + "description": "Details of the transfer.", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResourceWithTags" + } + ], + "properties": { + "properties": { + "description": "Details of the transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RecipientTransferProperties" + } + } + }, + "DetailedTransferStatus": { + "type": "object", + "description": "Detailed transfer status.", + "properties": { + "productType": { + "type": "string", + "$ref": "#/definitions/ProductType", + "readOnly": true, + "description": "Type of product that is transferred." + }, + "productId": { + "type": "string", + "readOnly": true, + "description": "The ID of the product that is transferred." + }, + "productName": { + "type": "string", + "readOnly": true, + "description": "The name of the product that is transferred." + }, + "skuDescription": { + "type": "string", + "readOnly": true, + "description": "The SKU of the product that is transferred." + }, + "transferStatus": { + "type": "string", + "$ref": "#/definitions/ProductTransferStatus", + "readOnly": true, + "description": "Transfer status." + }, + "errorDetails": { + "description": "Error details for transfer execution.", + "$ref": "#/definitions/TransferError" + } + } + }, + "TransferError": { + "type": "object", + "description": "Error details for transfer execution.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Error message." + } + } + }, + "EligibleProductType": { + "type": "string", + "description": "Type of the products that can be transferred.", + "enum": [ + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" + ], + "x-ms-enum": { + "name": "eligibleProductType", + "modelAsString": true + } + }, + "TransferProperties": { + "description": "Transfer details", + "type": "object", + "properties": { + "expirationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time at which the transfer request expires." + }, + "transferStatus": { + "type": "string", + "$ref": "#/definitions/TransferStatus", + "description": "Overall transfer status.", + "readOnly": true + }, + "recipientEmailId": { + "type": "string", + "readOnly": true, + "description": "The email ID of the user to whom the transfer request was sent." + }, + "initiatorEmailId": { + "type": "string", + "readOnly": true, + "description": "The email ID of the user who sent the transfer request." + }, + "canceledBy": { + "type": "string", + "readOnly": true, + "description": "The email ID of the user who canceled the transfer request." + }, + "detailedTransferStatus": { + "type": "array", + "readOnly": true, + "description": "Detailed transfer status.", + "items": { + "$ref": "#/definitions/DetailedTransferStatus" + }, + "x-ms-identifiers": [] + } + } + }, + "PartnerTransferProperties": { + "description": "Transfer Details.", + "type": "object", + "properties": { + "expirationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time at which the transfer request expires." + }, + "transferStatus": { + "type": "string", + "$ref": "#/definitions/TransferStatus", + "description": "Overall transfer status.", + "readOnly": true + }, + "recipientEmailId": { + "type": "string", + "readOnly": true, + "description": "The email ID of the user to whom the transfer request was sent." + }, + "initiatorCustomerType": { + "type": "string", + "$ref": "#/definitions/InitiatorCustomerType", + "description": "The type of customer who sent the transfer request.", + "readOnly": true + }, + "initiatorEmailId": { + "type": "string", + "readOnly": true, + "description": "The email ID of the user who sent the transfer request." + }, + "resellerId": { + "type": "string", + "description": "Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account.", + "readOnly": true + }, + "resellerName": { + "type": "string", + "description": "Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account.", + "readOnly": true + }, + "canceledBy": { + "type": "string", + "readOnly": true, + "description": "The email ID of the user who canceled the transfer request." + }, + "detailedTransferStatus": { + "type": "array", + "readOnly": true, + "description": "Detailed transfer status.", + "items": { + "$ref": "#/definitions/DetailedTransferStatus" + }, + "x-ms-identifiers": [] + } + } + }, + "RecipientTransferProperties": { + "description": "Transfer Details.", + "type": "object", + "properties": { + "expirationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time at which the transfer request expires." + }, + "allowedProductType": { + "type": "array", + "readOnly": true, + "description": "Type of subscriptions that can be transferred.", + "items": { + "$ref": "#/definitions/EligibleProductType" + } + }, + "transferStatus": { + "type": "string", + "$ref": "#/definitions/TransferStatus", + "description": "Overall transfer status.", + "readOnly": true + }, + "recipientEmailId": { + "type": "string", + "readOnly": true, + "description": "The email ID of the user to whom the transfer request was sent." + }, + "initiatorEmailId": { + "type": "string", + "readOnly": true, + "description": "The email ID of the user who sent the transfer request." + }, + "resellerId": { + "type": "string", + "description": "Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account.", + "readOnly": true + }, + "resellerName": { + "type": "string", + "description": "Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account.", + "readOnly": true + }, + "initiatorCustomerType": { + "type": "string", + "description": "The type of customer who sent the transfer request.", + "$ref": "#/definitions/InitiatorCustomerType", + "readOnly": true + }, + "canceledBy": { + "type": "string", + "readOnly": true, + "description": "The email ID of the user who canceled the transfer request." + }, + "detailedTransferStatus": { + "type": "array", + "readOnly": true, + "description": "Detailed transfer status.", + "items": { + "$ref": "#/definitions/DetailedTransferStatus" + }, + "x-ms-identifiers": [] + }, + "customerTenantId": { + "type": "string", + "description": "The customer tenant id.", + "readOnly": true + }, + "supportedAccounts": { + "type": "array", + "readOnly": true, + "description": "List of supported account types.", + "items": { + "$ref": "#/definitions/SupportedAccountType" + } + } + } + }, + "InitiatorCustomerType": { + "type": "string", + "description": "The type of customer of the transfer initiator.", + "enum": [ + "Partner", + "EA" + ], + "x-ms-enum": { + "name": "initiatorCustomerType", + "modelAsString": true + } + }, + "TransferStatus": { + "type": "string", + "description": "The status of a transfer.", + "enum": [ + "Expired", + "Pending", + "InProgress", + "Completed", + "CompletedWithErrors", + "Failed", + "Canceled", + "Declined" + ], + "x-ms-enum": { + "name": "transferStatus", + "modelAsString": true + } + }, + "ProductTransferStatus": { + "type": "string", + "description": "The status of a transfer.", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "productTransferStatus", + "modelAsString": true + } + }, + "PartnerTransferDetailsListResult": { + "type": "object", + "description": "The list of transfers initiated by partner.", + "properties": { + "value": { + "description": "The list of transfers initiated by partner.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PartnerTransferDetails" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "RecipientTransferDetailsListResult": { + "type": "object", + "description": "The list of transfers received by caller.", + "properties": { + "value": { + "description": "The list of transfers received by caller.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RecipientTransferDetails" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "TransferDetailsListResult": { + "type": "object", + "description": "The list of transfers initiated by caller.", + "properties": { + "value": { + "description": "The list of transfers initiated by caller.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TransferDetails" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ValidateTransferResponse": { + "type": "object", + "description": "Transfer validation response.", + "properties": { + "properties": { + "description": "The properties of transfer validation response.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ValidateTransferResponseProperties" + } + } + }, + "ValidateTransferListResponse": { + "type": "object", + "description": "Result of transfer validation.", + "properties": { + "value": { + "description": "The list of transfer validation results.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ValidateTransferResponse" + }, + "x-ms-identifiers": [] + } + } + }, + "ValidateTransferResponseProperties": { + "type": "object", + "description": "The properties of transfer validation response.", + "properties": { + "status": { + "description": "The status of validation", + "type": "string", + "readOnly": true + }, + "productId": { + "description": "The product id for which this result applies.", + "type": "string", + "readOnly": true + }, + "results": { + "description": "The array of validation results.", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationResultProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "ValidationResultProperties": { + "type": "object", + "description": "The properties of the validation result.", + "properties": { + "level": { + "description": "Result Level.", + "type": "string", + "readOnly": true + }, + "code": { + "description": "Result Code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The validation message.", + "type": "string", + "readOnly": true + } + } + }, + "SupportedAccountType": { + "type": "string", + "description": "The supported account types.", + "enum": [ + "None", + "Partner", + "Individual", + "Enterprise" + ], + "x-ms-enum": { + "name": "supportedAccountType", + "modelAsString": true + } + }, + "TransferItemQueryParameter": { + "description": "Query parameter to enumerate transfer requests.", + "type": "object", + "properties": { + "state": { + "description": "State of the transfer request query filter.", + "type": "string" + } + } + } + }, + "parameters": { + "transferNameParameter": { + "name": "transferName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "The ID that uniquely identifies a transfer request.", + "pattern": "^[a-z0-9]*$" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/types.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/types.json new file mode 100644 index 000000000000..1d1e52f8e390 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/types.json @@ -0,0 +1,363 @@ +{ + "swagger": "2.0", + "info": { + "title": "BillingManagementClient", + "description": "Documentation for Microsoft.Billing.", + "contact": { + "name": "Microsoft.Billing", + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", + "email": "pacebpexphot@microsoft.com" + }, + "version": "2024-04-01" + }, + "paths": {}, + "definitions": { + "ProxyResourceWithTags": { + "description": "Common fields that are returned in the response for all Azure Resource Manager resources.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "tags": { + "description": "Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \\ ? /", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "Amount": { + "description": "The amount.", + "type": "object", + "properties": { + "currency": { + "description": "The currency for the amount value.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.", + "type": "number", + "readOnly": true + } + }, + "readOnly": true + }, + "AddressDetails": { + "description": "Address details.", + "required": [ + "addressLine1", + "country" + ], + "type": "object", + "properties": { + "addressLine1": { + "description": "Address line 1.", + "minLength": 1, + "type": "string" + }, + "addressLine2": { + "description": "Address line 2.", + "type": "string" + }, + "addressLine3": { + "description": "Address line 3.", + "type": "string" + }, + "city": { + "description": "Address city.", + "type": "string" + }, + "companyName": { + "description": "Company name. Optional for MCA Individual (Pay-as-you-go).", + "type": "string" + }, + "country": { + "description": "Country code uses ISO 3166-1 Alpha-2 format.", + "minLength": 1, + "type": "string" + }, + "district": { + "description": "Address district.", + "type": "string" + }, + "email": { + "description": "Email address.", + "type": "string" + }, + "firstName": { + "description": "First name. Optional for MCA Enterprise.", + "type": "string" + }, + "lastName": { + "description": "Last name. Optional for MCA Enterprise.", + "type": "string" + }, + "middleName": { + "description": "Middle name.", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number.", + "type": "string" + }, + "postalCode": { + "description": "Postal code.", + "type": "string" + }, + "region": { + "description": "Address region.", + "type": "string" + }, + "isValidAddress": { + "description": "Indicates if the address is incomplete.", + "type": "boolean" + } + } + }, + "AzurePlan": { + "description": "Details of the Azure plan.", + "type": "object", + "properties": { + "productId": { + "description": "The ID that uniquely identifies a product.", + "type": "string" + }, + "skuId": { + "description": "The ID that uniquely identifies a sku.", + "type": "string" + }, + "skuDescription": { + "description": "The sku description.", + "type": "string" + } + } + }, + "IndirectRelationshipInfo": { + "description": "Identifies the billing profile that is linked to another billing profile in indirect purchase motion.", + "type": "object", + "properties": { + "billingAccountName": { + "description": "The billing account name of the partner or the customer for an indirect motion.", + "type": "string" + }, + "billingProfileName": { + "description": "The billing profile name of the partner or the customer for an indirect motion.", + "type": "string" + }, + "displayName": { + "description": "The display name of the partner or customer for an indirect motion.", + "type": "string" + } + } + }, + "PatchResource": { + "description": "Common fields that are in the patch method request body of all Azure Resource Manager patch resources.", + "type": "object" + }, + "Reseller": { + "description": "Details of the reseller.", + "type": "object", + "properties": { + "resellerId": { + "description": "The MPN ID of the reseller.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The name of the reseller.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + } + }, + "parameters": { + "billingAccountName": { + "in": "path", + "name": "billingAccountName", + "description": "The ID that uniquely identifies a billing account.", + "required": true, + "type": "string", + "pattern": "^([0-9]+|([Pp][Cc][Nn]\\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "in": "query", + "name": "api-version", + "description": "The version of the API to be used with the client request. The current version is 2024-04-01.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "associatedTenantName": { + "in": "path", + "name": "associatedTenantName", + "description": "The ID that uniquely identifies a tenant.", + "required": true, + "type": "string", + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "x-ms-parameter-location": "method" + }, + "filter": { + "in": "query", + "name": "filter", + "description": "The filter query option allows clients to filter a collection of resources that are addressed by a request URL.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "orderBy": { + "in": "query", + "name": "orderBy", + "description": "The orderby query option allows clients to request resources in a particular order.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "top": { + "in": "query", + "name": "top", + "description": "The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.", + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "skip": { + "in": "query", + "name": "skip", + "description": "The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.", + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "count": { + "in": "query", + "name": "count", + "description": "The count query option allows clients to request a count of the matching resources included with the resources in the response.", + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "search": { + "in": "query", + "name": "search", + "description": "The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingProfileName": { + "in": "path", + "name": "billingProfileName", + "description": "The ID that uniquely identifies a billing profile.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z\\d-_]{1,128}$", + "x-ms-parameter-location": "method" + }, + "customerName": { + "in": "path", + "name": "customerName", + "description": "The ID that uniquely identifies a customer.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z\\d-_]{1,128}$", + "x-ms-parameter-location": "method" + }, + "invoiceSectionName": { + "in": "path", + "name": "invoiceSectionName", + "description": "The ID that uniquely identifies an invoice section.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z\\d-_]{1,128}$", + "x-ms-parameter-location": "method" + }, + "departmentName": { + "in": "path", + "name": "departmentName", + "description": "The name of the department.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z\\d-_]{1,128}$", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountName": { + "in": "path", + "name": "enrollmentAccountName", + "description": "The name of the enrollment account.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z\\d-_]{1,128}$", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "in": "path", + "name": "subscriptionId", + "description": "The ID that uniquely identifies a billing subscription.", + "required": true, + "type": "string", + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "x-ms-parameter-location": "client" + }, + "billingRequestName": { + "in": "path", + "name": "billingRequestName", + "description": "The ID that uniquely identifies a billing request.", + "required": true, + "type": "string", + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "x-ms-parameter-location": "method" + }, + "billingRoleAssignmentName": { + "in": "path", + "name": "billingRoleAssignmentName", + "description": "The ID that uniquely identifies a role assignment.", + "required": true, + "type": "string", + "pattern": "^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$", + "x-ms-parameter-location": "method" + }, + "roleDefinitionName": { + "in": "path", + "name": "roleDefinitionName", + "description": "The ID that uniquely identifies a role definition.", + "required": true, + "type": "string", + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "x-ms-parameter-location": "method" + }, + "invoiceName": { + "in": "path", + "name": "invoiceName", + "description": "The ID that uniquely identifies an invoice.", + "required": true, + "type": "string", + "pattern": "^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$", + "x-ms-parameter-location": "method" + }, + "productName": { + "in": "path", + "name": "productName", + "description": "The ID that uniquely identifies a product.", + "required": true, + "type": "string", + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + } +} diff --git a/specification/billing/resource-manager/readme.md b/specification/billing/resource-manager/readme.md index 53a8d6fb2beb..711240e36286 100644 --- a/specification/billing/resource-manager/readme.md +++ b/specification/billing/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for Billing. - - --- + ## Getting Started + To build the SDK for Billing, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,30 +15,251 @@ To build the SDK for Billing, simply [Install AutoRest](https://aka.ms/autorest/ To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the Billing API. -``` yaml +```yaml openapi-type: arm -tag: package-2020-05 +tag: package-2024-04 +``` + +### Tag: package-2024-04 + +These settings apply only when `--tag=package-2024-04` is specified on the command line. + +These settings apply only when `--tag=package-2024-04` is specified on the command line. + +```yaml $(tag) == 'package-2024-04' +title: BillingManagementClient +description: Billing Client +input-file: +- Microsoft.Billing/stable/2024-04-01/agreement.json +- Microsoft.Billing/stable/2024-04-01/associatedTenant.json +- Microsoft.Billing/stable/2024-04-01/availableBalance.json +- Microsoft.Billing/stable/2024-04-01/billingAccount.json +- Microsoft.Billing/stable/2024-04-01/billingPermission.json +- Microsoft.Billing/stable/2024-04-01/billingProfile.json +- Microsoft.Billing/stable/2024-04-01/billingProperty.json +- Microsoft.Billing/stable/2024-04-01/billingRequest.json +- Microsoft.Billing/stable/2024-04-01/billingRoleAssignment.json +- Microsoft.Billing/stable/2024-04-01/billingRoleDefinition.json +- Microsoft.Billing/stable/2024-04-01/billingSavingsPlan.json +- Microsoft.Billing/stable/2024-04-01/billingSubscription.json +- Microsoft.Billing/stable/2024-04-01/customer.json +- Microsoft.Billing/stable/2024-04-01/department.json +- Microsoft.Billing/stable/2024-04-01/enrollmentAccount.json +- Microsoft.Billing/stable/2024-04-01/invoice.json +- Microsoft.Billing/stable/2024-04-01/invoiceSection.json +- Microsoft.Billing/stable/2024-04-01/operation.json +- Microsoft.Billing/stable/2024-04-01/payment.json +- Microsoft.Billing/stable/2024-04-01/policy.json +- Microsoft.Billing/stable/2024-04-01/product.json +- Microsoft.Billing/stable/2024-04-01/reservation.json +- Microsoft.Billing/stable/2024-04-01/transaction.json +- Microsoft.Billing/stable/2024-04-01/transfers.json +- Microsoft.Billing/stable/2024-04-01/types.json +suppressions: +- code: AllProxyResourcesShouldHaveDelete + from: billingRequest.json + reason: Service design forces behavior +- code: AllProxyResourcesShouldHaveDelete + from: billingSubscription.json + reason: Service design forces behavior +- code: AllProxyResourcesShouldHaveDelete + from: policy.json + reason: Service design forces behavior +- code: AllProxyResourcesShouldHaveDelete + from: transfers.json + reason: Service design forces behavior +- code: AllTrackedResourcesMustHaveDelete + from: reservation.json + reason: Breaking change +- code: AvoidAdditionalProperties + from: billingRequest.json + reason: Service design forces behavior +- code: AvoidAdditionalProperties + from: billingSavingsPlan.json + reason: False positive. Used for "tags" +- code: AvoidAdditionalProperties + from: billingSubscription.json + reason: Breaking change +- code: AvoidAdditionalProperties + from: reservation.json + reason: False positive. Used for "tags" +- code: AvoidAnonymousTypes + from: policy.json + reason: Service design forces behavior +- code: EnumInsteadOfBoolean + from: associatedTenant.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: billingAccount.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: billingProfile.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: billingProperty.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: billingRoleAssignment.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: billingSavingsPlan.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: billingSubscription.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: enrollmentAccount.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: invoice.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: invoiceSection.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: operation.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: product.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: reservation.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: transaction.json + reason: Breaking Change +- code: EnumInsteadOfBoolean + from: types.json + reason: Breaking Change +- code: EvenSegmentedPathForPutOperation + from: policy.json + reason: False positive +- code: GetCollectionOnlyHasValueAndNextLink + from: billingSavingsPlan.json + reason: Blocked on resolving this issue by wide adoption of partner services +- code: GetCollectionOnlyHasValueAndNextLink + from: billingSubscription.json + reason: Breaking change +- code: GetCollectionOnlyHasValueAndNextLink + from: reservation.json + reason: Breaking change +- code: GetCollectionOnlyHasValueAndNextLink + from: transaction.json + reason: Breaking change +- code: ListInOperationName + from: billingRoleAssignment.json + reason: Breaking Change +- code: ListInOperationName + from: transfers.json + reason: Breaking Change +- code: LroErrorContent + reason: Service design that generates API definition. Type defined in local types.json +- code: OperationIdNounConflictingModelNames + from: billingProperty.json + reason: Breaking Change +- code: OperationIdNounConflictingModelNames + from: billingRoleDefinition.json + reason: Breaking Change +- code: OperationIdNounVerb + from: billingSavingsPlan.json + reason: False positive. SavingsPlan is a child resource of SavingsPlanOrder +- code: OperationIdNounVerb + from: reservation.json + reason: False positive. Reservations can be a child resource of ReservationOrder. +- code: OperationIdNounVerb + from: transaction.json + reason: False positive. TransactionSummary is an aggregation of transactions. +- code: OperationsApiSchemaUsesCommonTypes + from: operation.json + reason: Service design that generates API definition. Type defined in local types.json +- code: ParametersInPointGet + reason: Service design forces this behavior +- code: ParametersInPost + from: billingAccount.json + reason: Breaking change +- code: ParametersInPost + from: billingRoleAssignment.json + reason: Service design forces this behavior +- code: ParametersInPost + from: invoice.json + reason: Breaking Change +- code: ParameterNotDefinedInGlobalParameters + reason: Referenced in common types.json file +- code: ParameterNotUsingCommonTypes + reason: Service design forces this behavior +- code: PathForTrackedResourceTypes + from: reservation.json + reason: Breaking change +- code: PostOperationIdContainsUrlVerb + from: billingAccount.json + reason: Breaking Change +- code: PostOperationIdContainsUrlVerb + from: billingRoleAssignment.json + reason: Breaking Change +- code: PutInOperationName + from: transfers.json + reason: Breaking Change +- code: PutRequestResponseSchemeArm + from: transfers.json + reason: Design ensures only recipients choose products, not initiators, for security and access reasons. +- code: PutResponseCodes + from: billingProfile.json + reason: Breaking change +- code: PutResponseCodes + from: billingSubscription.json + reason: Breaking change +- code: PutResponseCodes + from: invoiceSection.json + reason: Breaking change +- code: ResourceNameRestriction + from: billingSubscription.json + reason: Breaking change +- code: ResourceNameRestriction + from: payment.json + reason: Breaking change +- code: TenantLevelAPIsNotAllowed + reason: Specific validation rules do not apply to this service. Microsoft.Billing is a tenant level RP +- code: TopLevelResourcesListBySubscription + reason: Specific validation rules do not apply to this service. Microsoft.Billing is a tenant level RP +- code: TrackedResourcesMustHavePut + from: reservation.json + reason: Breaking change +- code: XmsPageableForListCalls + from: availableBalance.json + reason: Breaking change +- code: XmsPageableForListCalls + from: billingProperty.json + reason: Breaking change +- code: XmsPageableForListCalls + from: policy.json + reason: Breaking change +- code: XmsPageableForListCalls + from: transaction.json + reason: Breaking change +- code: XmsResourceInPutResponse + from: transfers.json + reason: Service design forces this behavior ``` ### Tag: package-2021-10 These settings apply only when `--tag=package-2021-10` is specified on the command line. -``` yaml $(tag) == 'package-2021-10' +```yaml $(tag) == 'package-2021-10' title: BillingManagementClient description: Billing Client input-file: -- Microsoft.Billing/stable/2021-10-01/billingSubscription.json -- Microsoft.Billing/stable/2021-10-01/payment.json + - Microsoft.Billing/stable/2021-10-01/billingSubscription.json + - Microsoft.Billing/stable/2021-10-01/payment.json directive: - suppress: R4009 from: Microsoft.Billing/stable/2021-10-01/billingSubscription.json @@ -52,90 +273,90 @@ directive: These settings apply only when `--tag=package-2020-05` is specified on the command line. -``` yaml $(tag) == 'package-2020-05' +```yaml $(tag) == 'package-2020-05' input-file: -- Microsoft.Billing/stable/2020-05-01/billing.json -- Microsoft.Billing/preview/2018-03-01-preview/billingV2.json -- Microsoft.Billing/stable/2020-05-01/billingOperations.json + - Microsoft.Billing/stable/2020-05-01/billing.json + - Microsoft.Billing/preview/2018-03-01-preview/billingV2.json + - Microsoft.Billing/stable/2020-05-01/billingOperations.json ``` ### Tag: package-2020-09-preview These settings apply only when `--tag=package-2020-09-preview` is specified on the command line. -``` yaml $(tag) == 'package-2020-09-preview' +```yaml $(tag) == 'package-2020-09-preview' input-file: -- Microsoft.Billing/stable/2020-05-01/billing.json -- Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json -- Microsoft.Billing/preview/2020-09-01-preview/billingOperations.json + - Microsoft.Billing/stable/2020-05-01/billing.json + - Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json + - Microsoft.Billing/preview/2020-09-01-preview/billingOperations.json ``` ### Tag: package-2020-11-preview These settings apply only when `--tag=package-2020-11-preview` is specified on the command line. -``` yaml $(tag) == 'package-2020-11-preview' +```yaml $(tag) == 'package-2020-11-preview' input-file: -- Microsoft.Billing/stable/2020-05-01/billing.json -- Microsoft.Billing/preview/2020-11-01-preview/billingPromotions.json -- Microsoft.Billing/preview/2020-11-01-preview/billingOperations.json + - Microsoft.Billing/stable/2020-05-01/billing.json + - Microsoft.Billing/preview/2020-11-01-preview/billingPromotions.json + - Microsoft.Billing/preview/2020-11-01-preview/billingOperations.json ``` ### Tag: package-2019-10-preview These settings apply only when `--tag=package-2019-10-preview` is specified on the command line. -``` yaml $(tag) == 'package-2019-10-preview' +```yaml $(tag) == 'package-2019-10-preview' input-file: -- Microsoft.Billing/preview/2019-10-01-preview/billing.json + - Microsoft.Billing/preview/2019-10-01-preview/billing.json ``` ### Tag: package-2018-11-preview These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. -``` yaml $(tag) == 'package-2018-11-preview' +```yaml $(tag) == 'package-2018-11-preview' input-file: -- Microsoft.Billing/preview/2018-11-01-preview/billing.json + - Microsoft.Billing/preview/2018-11-01-preview/billing.json ``` ### Tag: package-2018-03-preview These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. -``` yaml $(tag) == 'package-2018-03-preview' +```yaml $(tag) == 'package-2018-03-preview' input-file: -- Microsoft.Billing/preview/2018-03-01-preview/billing.json + - Microsoft.Billing/preview/2018-03-01-preview/billing.json ``` ### Tag: package-2017-04-preview These settings apply only when `--tag=package-2017-04-preview` is specified on the command line. -``` yaml $(tag) == 'package-2017-04-preview' +```yaml $(tag) == 'package-2017-04-preview' input-file: -- Microsoft.Billing/preview/2017-04-24-preview/billing.json + - Microsoft.Billing/preview/2017-04-24-preview/billing.json ``` ### Tag: package-2017-02-preview These settings apply only when `--tag=package-2017-02-preview` is specified on the command line. -``` yaml $(tag) == 'package-2017-02-preview' +```yaml $(tag) == 'package-2017-02-preview' input-file: -- Microsoft.Billing/preview/2017-02-27-preview/billing.json + - Microsoft.Billing/preview/2017-02-27-preview/billing.json ``` --- -# Code Generation +# Code Generation ## Swagger to SDK This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself. -``` yaml $(swagger-to-sdk) +```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net-track2 - repo: azure-sdk-for-python @@ -151,13 +372,12 @@ swagger-to-sdk: - repo: azure-powershell ``` - ## C# These settings apply only when `--csharp` is specified on the command line. Please also specify `--csharp-sdks-folder=`. -``` yaml $(csharp) +```yaml $(csharp) csharp: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION @@ -179,7 +399,7 @@ See configuration in [readme.go.md](./readme.go.md) These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(java) +```yaml $(java) azure-arm: true fluent: true namespace: com.microsoft.azure.management.billing @@ -190,7 +410,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-billing ### Java multi-api -``` yaml $(java) && $(multiapi) +```yaml $(java) && $(multiapi) batch: - tag: package-2021-10 - tag: package-2020-05 @@ -206,7 +426,7 @@ batch: These settings apply only when `--tag=package-2021-10 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2021-10' && $(java) && $(multiapi) +```yaml $(tag) == 'package-2021-10' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.billing.v2021_10_01 output-folder: $(azure-libraries-for-java-folder)/sdk/billing/mgmt-v2021_10_01 @@ -219,7 +439,7 @@ generate-interface: true These settings apply only when `--tag=package-2020-05 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2020-05' && $(java) && $(multiapi) +```yaml $(tag) == 'package-2020-05' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.billing.v2020_05_01 output-folder: $(azure-libraries-for-java-folder)/sdk/billing/mgmt-v2020_05_01 @@ -232,7 +452,7 @@ generate-interface: true These settings apply only when `--tag=package-2019-10-preview --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2019-10-preview' && $(java) && $(multiapi) +```yaml $(tag) == 'package-2019-10-preview' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.billing.v2019_10_01_preview output-folder: $(azure-libraries-for-java-folder)/sdk/billing/mgmt-v2019_10_01_preview @@ -245,7 +465,7 @@ generate-interface: true These settings apply only when `--tag=package-2018-11-preview --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2018-11-preview' && $(java) && $(multiapi) +```yaml $(tag) == 'package-2018-11-preview' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.billing.v2018_11_01_preview output-folder: $(azure-libraries-for-java-folder)/sdk/billing/mgmt-v2018_11_01_preview @@ -258,7 +478,7 @@ generate-interface: true These settings apply only when `--tag=package-2018-03-preview --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2018-03-preview' && $(java) && $(multiapi) +```yaml $(tag) == 'package-2018-03-preview' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.billing.v2018_03_01_preview output-folder: $(azure-libraries-for-java-folder)/sdk/billing/mgmt-v2018_03_01_preview @@ -271,7 +491,7 @@ generate-interface: true These settings apply only when `--tag=package-2017-04-preview --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2017-04-preview' && $(java) && $(multiapi) +```yaml $(tag) == 'package-2017-04-preview' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.billing.v2017_04_24_preview output-folder: $(azure-libraries-for-java-folder)/sdk/billing/mgmt-v2017_04_24_preview @@ -284,14 +504,10 @@ generate-interface: true These settings apply only when `--tag=package-2017-02-preview --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2017-02-preview' && $(java) && $(multiapi) +```yaml $(tag) == 'package-2017-02-preview' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.billing.v2017_02_27_preview output-folder: $(azure-libraries-for-java-folder)/sdk/billing/mgmt-v2017_02_27_preview regenerate-manager: true generate-interface: true ``` - - - - diff --git a/specification/billing/resource-manager/sdk-suppressions.yaml b/specification/billing/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..33533051487f --- /dev/null +++ b/specification/billing/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,703 @@ +suppressions: + azure-sdk-for-go: + - package: sdk/resourcemanager/billing/armbilling + breaking-changes: + - Function `*AccountsClient.BeginUpdate` parameter(s) have been changed from `(context.Context, string, AccountUpdateRequest, *AccountsClientBeginUpdateOptions)` to `(context.Context, string, AccountPatch, *AccountsClientBeginUpdateOptions)` + - Function `*CustomersClient.Get` parameter(s) have been changed from `(context.Context, string, string, *CustomersClientGetOptions)` to `(context.Context, string, string, string, *CustomersClientGetOptions)` + - Function `*EnrollmentAccountsClient.Get` parameter(s) have been changed from `(context.Context, string, *EnrollmentAccountsClientGetOptions)` to `(context.Context, string, string, *EnrollmentAccountsClientGetOptions)` + - Function `*InvoicesClient.Get` parameter(s) have been changed from `(context.Context, string, string, *InvoicesClientGetOptions)` to `(context.Context, string, *InvoicesClientGetOptions)` + - Function `*InvoicesClient.NewListByBillingAccountPager` parameter(s) have been changed from `(string, string, string, *InvoicesClientListByBillingAccountOptions)` to `(string, *InvoicesClientListByBillingAccountOptions)` + - Function `*InvoicesClient.NewListByBillingProfilePager` parameter(s) have been changed from `(string, string, string, string, *InvoicesClientListByBillingProfileOptions)` to `(string, string, *InvoicesClientListByBillingProfileOptions)` + - Function `*InvoicesClient.NewListByBillingSubscriptionPager` parameter(s) have been changed from `(string, string, *InvoicesClientListByBillingSubscriptionOptions)` to `(*InvoicesClientListByBillingSubscriptionOptions)` + - Function `*PermissionsClient.NewListByCustomerPager` parameter(s) have been changed from `(string, string, *PermissionsClientListByCustomerOptions)` to `(string, string, string, *PermissionsClientListByCustomerOptions)` + - Function `*PoliciesClient.GetByCustomer` parameter(s) have been changed from `(context.Context, string, string, *PoliciesClientGetByCustomerOptions)` to `(context.Context, string, string, string, ServiceDefinedResourceName, *PoliciesClientGetByCustomerOptions)` + - Function `*ProductsClient.Update` parameter(s) have been changed from `(context.Context, string, string, Product, *ProductsClientUpdateOptions)` to `(context.Context, string, string, ProductPatch, *ProductsClientUpdateOptions)` + - Function `*SubscriptionsClient.BeginMove` parameter(s) have been changed from `(context.Context, string, TransferBillingSubscriptionRequestProperties, *SubscriptionsClientBeginMoveOptions)` to `(context.Context, string, string, MoveBillingSubscriptionRequest, *SubscriptionsClientBeginMoveOptions)` + - Function `*SubscriptionsClient.Get` parameter(s) have been changed from `(context.Context, string, *SubscriptionsClientGetOptions)` to `(context.Context, string, string, *SubscriptionsClientGetOptions)` + - Function `*SubscriptionsClient.NewListByCustomerPager` parameter(s) have been changed from `(string, string, *SubscriptionsClientListByCustomerOptions)` to `(string, string, string, *SubscriptionsClientListByCustomerOptions)` + - Type of `AccountProperties.EnrollmentDetails` has been changed from `*Enrollment` to `*AccountPropertiesEnrollmentDetails` + - Type of `AccountProperties.SoldTo` has been changed from `*AddressDetails` to `*AccountPropertiesSoldTo` + - Type of `AgreementProperties.BillingProfileInfo` has been changed from `*ProfileInfo` to `[]*ProfileInfo` + - Type of `AgreementProperties.Participants` has been changed from `[]*Participants` to `[]*Participant` + - Type of `AvailableBalanceProperties.Amount` has been changed from `*Amount` to `*AvailableBalancePropertiesAmount` + - Type of `CustomerPolicyProperties.ViewCharges` has been changed from `*ViewCharges` to `*ViewChargesPolicy` + - Type of `EnrollmentAccountListResult.Value` has been changed from `[]*EnrollmentAccountSummary` to `[]*EnrollmentAccount` + - Type of `ErrorResponse.Error` has been changed from `*ErrorDetails` to `*ErrorDetail` + - Type of `InvoiceProperties.AmountDue` has been changed from `*Amount` to `*InvoicePropertiesAmountDue` + - Type of `InvoiceProperties.AzurePrepaymentApplied` has been changed from `*Amount` to `*InvoicePropertiesAzurePrepaymentApplied` + - Type of `InvoiceProperties.BilledAmount` has been changed from `*Amount` to `*InvoicePropertiesBilledAmount` + - Type of `InvoiceProperties.CreditAmount` has been changed from `*Amount` to `*InvoicePropertiesCreditAmount` + - Type of `InvoiceProperties.Documents` has been changed from `[]*Document` to `[]*InvoiceDocument` + - Type of `InvoiceProperties.FreeAzureCreditApplied` has been changed from `*Amount` to `*InvoicePropertiesFreeAzureCreditApplied` + - Type of `InvoiceProperties.Payments` has been changed from `[]*PaymentProperties` to `[]*Payment` + - Type of `InvoiceProperties.RebillDetails` has been changed from `map[string]*RebillDetails` to `*InvoicePropertiesRebillDetails` + - Type of `InvoiceProperties.SubTotal` has been changed from `*Amount` to `*InvoicePropertiesSubTotal` + - Type of `InvoiceProperties.TaxAmount` has been changed from `*Amount` to `*InvoicePropertiesTaxAmount` + - Type of `InvoiceProperties.TotalAmount` has been changed from `*Amount` to `*InvoicePropertiesTotalAmount` + - Type of `InvoiceSectionWithCreateSubPermission.BillingProfileSpendingLimit` has been changed from `*SpendingLimitForBillingProfile` to `*SpendingLimit` + - Type of `InvoiceSectionWithCreateSubPermission.BillingProfileStatusReasonCode` has been changed from `*StatusReasonCodeForBillingProfile` to `*BillingProfileStatusReasonCode` + - Type of `ProductProperties.BillingFrequency` has been changed from `*BillingFrequency` to `*string` + - Type of `ProductProperties.EndDate` has been changed from `*time.Time` to `*string` + - Type of `ProductProperties.LastCharge` has been changed from `*Amount` to `*ProductPropertiesLastCharge` + - Type of `ProductProperties.LastChargeDate` has been changed from `*time.Time` to `*string` + - Type of `ProductProperties.PurchaseDate` has been changed from `*time.Time` to `*string` + - Type of `ProductProperties.Quantity` has been changed from `*float32` to `*int64` + - Type of `ProductProperties.Reseller` has been changed from `*Reseller` to `*ProductPropertiesReseller` + - Type of `ProductProperties.Status` has been changed from `*ProductStatusType` to `*ProductStatus` + - Type of `ProfileProperties.BillTo` has been changed from `*AddressDetails` to `*ProfilePropertiesBillTo` + - Type of `ProfileProperties.IndirectRelationshipInfo` has been changed from `*IndirectRelationshipInfo` to `*ProfilePropertiesIndirectRelationshipInfo` + - Type of `ProfileProperties.StatusReasonCode` has been changed from `*StatusReasonCode` to `*BillingProfileStatusReasonCode` + - Type of `PropertyProperties.BillingProfileSpendingLimit` has been changed from `*BillingProfileSpendingLimit` to `*SpendingLimit` + - Type of `RebillDetails.RebillDetails` has been changed from `map[string]*RebillDetails` to `*RebillDetails` + - Type of `ReservationProperty.EffectiveDateTime` has been changed from `*string` to `*time.Time` + - Type of `RoleAssignmentProperties.CreatedOn` has been changed from `*string` to `*time.Time` + - Type of `RoleDefinitionProperties.Permissions` has been changed from `[]*PermissionsProperties` to `[]*Permission` + - Type of `TransactionProperties.AzureCreditApplied` has been changed from `*Amount` to `*TransactionPropertiesAzureCreditApplied` + - Type of `TransactionProperties.EffectivePrice` has been changed from `*Amount` to `*TransactionPropertiesEffectivePrice` + - Type of `TransactionProperties.Kind` has been changed from `*TransactionTypeKind` to `*TransactionKind` + - Type of `TransactionProperties.MarketPrice` has been changed from `*Amount` to `*TransactionPropertiesMarketPrice` + - Type of `TransactionProperties.SubTotal` has been changed from `*Amount` to `*TransactionPropertiesSubTotal` + - Type of `TransactionProperties.Tax` has been changed from `*Amount` to `*TransactionPropertiesTax` + - Type of `TransactionProperties.TransactionAmount` has been changed from `*Amount` to `*TransactionPropertiesTransactionAmount` + - Type of `TransactionProperties.TransactionType` has been changed from `*ReservationType` to `*string` + - "`InvoiceTypeAzureService` from enum `InvoiceType` has been removed" + - "`SubscriptionTransferValidationErrorCodeNotAvailableForDestinationMarket` from enum `SubscriptionTransferValidationErrorCode` has been removed" + - Enum `BillingFrequency` has been removed + - Enum `BillingProfileSpendingLimit` has been removed + - Enum `BillingSubscriptionStatusType` has been removed + - Enum `DocumentType` has been removed + - Enum `ProductStatusType` has been removed + - Enum `ProductTransferValidationErrorCode` has been removed + - Enum `ReservationType` has been removed + - Enum `SpendingLimitForBillingProfile` has been removed + - Enum `StatusReasonCode` has been removed + - Enum `StatusReasonCodeForBillingProfile` has been removed + - Enum `TransactionTypeKind` has been removed + - Enum `ViewCharges` has been removed + - Function `*AvailableBalancesClient.Get` has been removed + - Function `*ClientFactory.NewInstructionsClient` has been removed + - Function `*ClientFactory.NewPeriodsClient` has been removed + - Function `*ClientFactory.NewRoleDefinitionsClient` has been removed + - Function `*EnrollmentAccountsClient.NewListPager` has been removed + - Function `NewInstructionsClient` has been removed + - Function `*InstructionsClient.Get` has been removed + - Function `*InstructionsClient.NewListByBillingProfilePager` has been removed + - Function `*InstructionsClient.Put` has been removed + - Function `*InvoicesClient.BeginDownloadBillingSubscriptionInvoice` has been removed + - Function `*InvoicesClient.BeginDownloadInvoice` has been removed + - Function `*InvoicesClient.BeginDownloadMultipleBillingProfileInvoices` has been removed + - Function `*InvoicesClient.BeginDownloadMultipleBillingSubscriptionInvoices` has been removed + - Function `*InvoicesClient.GetByID` has been removed + - Function `*InvoicesClient.GetBySubscriptionAndInvoiceID` has been removed + - Function `NewPeriodsClient` has been removed + - Function `*PeriodsClient.Get` has been removed + - Function `*PeriodsClient.NewListPager` has been removed + - Function `*PermissionsClient.NewListByInvoiceSectionsPager` has been removed + - Function `*PoliciesClient.Update` has been removed + - Function `*PoliciesClient.UpdateCustomer` has been removed + - Function `PossibleStatusReasonCodeValues` has been removed + - Function `*ProductsClient.ValidateMove` has been removed + - Function `NewRoleDefinitionsClient` has been removed + - Function `*RoleDefinitionsClient.GetByBillingAccount` has been removed + - Function `*RoleDefinitionsClient.GetByBillingProfile` has been removed + - Function `*RoleDefinitionsClient.GetByInvoiceSection` has been removed + - Function `*RoleDefinitionsClient.NewListByBillingAccountPager` has been removed + - Function `*RoleDefinitionsClient.NewListByBillingProfilePager` has been removed + - Function `*RoleDefinitionsClient.NewListByInvoiceSectionPager` has been removed + - Function `*SubscriptionsClient.ValidateMove` has been removed + - Operation `*ProductsClient.Move` has been changed to LRO, use `*ProductsClient.BeginMove` instead. + - Operation `*SubscriptionsClient.Update` has been changed to LRO, use `*SubscriptionsClient.BeginUpdate` instead. + - Struct `AccountUpdateRequest` has been removed + - Struct `Document` has been removed + - Struct `DownloadURL` has been removed + - Struct `Enrollment` has been removed + - Struct `EnrollmentAccountContext` has been removed + - Struct `EnrollmentAccountSummary` has been removed + - Struct `EnrollmentAccountSummaryProperties` has been removed + - Struct `EnrollmentPolicies` has been removed + - Struct `ErrorDetails` has been removed + - Struct `ErrorSubDetailsItem` has been removed + - Struct `Instruction` has been removed + - Struct `InstructionListResult` has been removed + - Struct `InstructionProperties` has been removed + - Struct `InvoiceSectionCreationRequest` has been removed + - Struct `InvoiceSectionListWithCreateSubPermissionResult` has been removed + - Struct `InvoiceSectionsOnExpand` has been removed + - Struct `OperationsErrorDetails` has been removed + - Struct `OperationsErrorResponse` has been removed + - Struct `Participants` has been removed + - Struct `PaymentProperties` has been removed + - Struct `Period` has been removed + - Struct `PeriodProperties` has been removed + - Struct `PeriodsListResult` has been removed + - Struct `PermissionsListResult` has been removed + - Struct `PermissionsProperties` has been removed + - Struct `Policy` has been removed + - Struct `PolicyProperties` has been removed + - Struct `ProductsListResult` has been removed + - Struct `ProfileCreationRequest` has been removed + - Struct `ProfilesOnExpand` has been removed + - Struct `SubscriptionsListResult` has been removed + - Struct `TransferBillingSubscriptionRequestProperties` has been removed + - Struct `TransferProductRequestProperties` has been removed + - Struct `ValidateAddressResponse` has been removed + - Struct `ValidateProductTransferEligibilityError` has been removed + - Struct `ValidateProductTransferEligibilityResult` has been removed + - Struct `ValidateSubscriptionTransferEligibilityError` has been removed + - Struct `ValidateSubscriptionTransferEligibilityResult` has been removed + - Field `BillingProfiles`, `Departments`, `EnrollmentAccounts` of struct `AccountProperties` has been removed + - Field `Expand` of struct `AccountsClientGetOptions` has been removed + - Field `InvoiceSectionListWithCreateSubPermissionResult` of struct `AccountsClientListInvoiceSectionsByCreateSubscriptionPermissionResponse` has been removed + - Field `ValidateAddressResponse` of struct `AddressClientValidateResponse` has been removed + - Field `Expand` of struct `AgreementsClientGetOptions` has been removed + - Field `TotalCount` of struct `CustomerListResult` has been removed + - Field `Expand` of struct `CustomersClientGetOptions` has been removed + - Field `DepartmentName`, `EnrollmentAccounts` of struct `DepartmentProperties` has been removed + - Field `AccountName`, `AccountOwnerEmail`, `Department` of struct `EnrollmentAccountProperties` has been removed + - Field `EnrollmentAccountSummary` of struct `EnrollmentAccountsClientGetResponse` has been removed + - Field `TotalCount` of struct `InvoiceListResult` has been removed + - Field `TotalCount` of struct `InvoiceSectionListResult` has been removed + - Field `Labels` of struct `InvoiceSectionProperties` has been removed + - Field `PermissionsListResult` of struct `PermissionsClientListByBillingAccountResponse` has been removed + - Field `PermissionsListResult` of struct `PermissionsClientListByBillingProfileResponse` has been removed + - Field `PermissionsListResult` of struct `PermissionsClientListByCustomerResponse` has been removed + - Field `Policy` of struct `PoliciesClientGetByBillingProfileResponse` has been removed + - Field `ProductsListResult` of struct `ProductsClientListByBillingAccountResponse` has been removed + - Field `ProductsListResult` of struct `ProductsClientListByBillingProfileResponse` has been removed + - Field `ProductsListResult` of struct `ProductsClientListByCustomerResponse` has been removed + - Field `ProductsListResult` of struct `ProductsClientListByInvoiceSectionResponse` has been removed + - Field `TotalCount` of struct `ProfileListResult` has been removed + - Field `InvoiceSections` of struct `ProfileProperties` has been removed + - Field `Expand` of struct `ProfilesClientGetOptions` has been removed + - Field `Expand` of struct `ProfilesClientListByBillingAccountOptions` has been removed + - Field `Orderby` of struct `ReservationsClientListByBillingAccountOptions` has been removed + - Field `Orderby` of struct `ReservationsClientListByBillingProfileOptions` has been removed + - Field `RoleAssignment` of struct `RoleAssignmentsClientDeleteByBillingAccountResponse` has been removed + - Field `RoleAssignment` of struct `RoleAssignmentsClientDeleteByBillingProfileResponse` has been removed + - Field `RoleAssignment` of struct `RoleAssignmentsClientDeleteByInvoiceSectionResponse` has been removed + - Field `CostCenter`, `SubscriptionBillingStatus` of struct `SubscriptionProperties` has been removed + - Field `SubscriptionsListResult` of struct `SubscriptionsClientListByBillingAccountResponse` has been removed + - Field `SubscriptionsListResult` of struct `SubscriptionsClientListByBillingProfileResponse` has been removed + - Field `SubscriptionsListResult` of struct `SubscriptionsClientListByCustomerResponse` has been removed + - Field `SubscriptionsListResult` of struct `SubscriptionsClientListByInvoiceSectionResponse` has been removed + - Field `TotalCount` of struct `TransactionListResult` has been removed + - Field `OrderID`, `OrderName`, `SubscriptionID`, `SubscriptionName` of struct `TransactionProperties` has been removed + + ### Features Added + + - Type of `TransactionProperties.BillingProfileDisplayName` has been changed from `*string` to `any` + - New value `AcceptanceModeImplicit`, `AcceptanceModeOffline`, `AcceptanceModeOther`, `AcceptanceModePhysicalSign` added to enum type `AcceptanceMode` + - New value `AccountStatusNew`, `AccountStatusOther`, `AccountStatusPending`, `AccountStatusUnderReview` added to enum type `AccountStatus` + - New value `AccountTypeBusiness`, `AccountTypeClassicPartner`, `AccountTypeInternal`, `AccountTypeOther`, `AccountTypeReseller`, `AccountTypeTenant` added to enum type `AccountType` + - New value `AddressValidationStatusOther` added to enum type `AddressValidationStatus` + - New value `AgreementTypeOther` added to enum type `AgreementType` + - New value `BillingProfileStatusDeleted`, `BillingProfileStatusOther`, `BillingProfileStatusUnderReview` added to enum type `BillingProfileStatus` + - New value `BillingProfileStatusReasonCodeOther`, `BillingProfileStatusReasonCodeUnusualActivity` added to enum type `BillingProfileStatusReasonCode` + - New value `BillingRelationshipTypeCSPCustomer`, `BillingRelationshipTypeOther` added to enum type `BillingRelationshipType` + - New value `CategoryIndirectForGovernmentAgreement`, `CategoryMicrosoftPartnerAgreement`, `CategoryUKCloudComputeFramework` added to enum type `Category` + - New value `DocumentSourceOther` added to enum type `DocumentSource` + - New value `InvoiceDocumentTypeOther`, `InvoiceDocumentTypeSummary`, `InvoiceDocumentTypeTaxReceipt`, `InvoiceDocumentTypeTransactions`, `InvoiceDocumentTypeVoidNote` added to enum type `InvoiceDocumentType` + - New value `InvoiceSectionStateDeleted`, `InvoiceSectionStateDisabled`, `InvoiceSectionStateOther`, `InvoiceSectionStateUnderReview`, `InvoiceSectionStateWarned` added to enum type `InvoiceSectionState` + - New value `InvoiceStatusLocked`, `InvoiceStatusOther` added to enum type `InvoiceStatus` + - New value `InvoiceTypeAzureServices`, `InvoiceTypeOther` added to enum type `InvoiceType` + - New value `MarketplacePurchasesPolicyDisabled`, `MarketplacePurchasesPolicyOther` added to enum type `MarketplacePurchasesPolicy` + - New value `PaymentMethodFamilyDirectDebit`, `PaymentMethodFamilyEWallet`, `PaymentMethodFamilyOther`, `PaymentMethodFamilyTaskOrder` added to enum type `PaymentMethodFamily` + - New value `ReservationPurchasesPolicyDisabled`, `ReservationPurchasesPolicyOther` added to enum type `ReservationPurchasesPolicy` + - New value `SubscriptionTransferValidationErrorCodeAccountIsLocked`, `SubscriptionTransferValidationErrorCodeAssetHasCap`, `SubscriptionTransferValidationErrorCodeAssetNotActive`, `SubscriptionTransferValidationErrorCodeBillingProfilePastDue`, `SubscriptionTransferValidationErrorCodeInvoiceSectionIsRestricted`, `SubscriptionTransferValidationErrorCodeNoActiveAzurePlan`, `SubscriptionTransferValidationErrorCodeNone`, `SubscriptionTransferValidationErrorCodeOther`, `SubscriptionTransferValidationErrorCodeSubscriptionHasReservations` added to enum type `SubscriptionTransferValidationErrorCode` + - New value `TargetCloudInternal`, `TargetCloudOther` added to enum type `TargetCloud` + - New value `ViewChargesPolicyOther` added to enum type `ViewChargesPolicy` + - New enum type `AccessDecision` with values `AccessDecisionAllowed`, `AccessDecisionNotAllowed`, `AccessDecisionOther` + - New enum type `AccountSubType` with values `AccountSubTypeEnterprise`, `AccountSubTypeIndividual`, `AccountSubTypeNone`, `AccountSubTypeOther`, `AccountSubTypeProfessional` + - New enum type `AppliedScopeType` with values `AppliedScopeTypeManagementGroup`, `AppliedScopeTypeShared`, `AppliedScopeTypeSingle` + - New enum type `BillingAccountStatusReasonCode` with values `BillingAccountStatusReasonCodeExpired`, `BillingAccountStatusReasonCodeManuallyTerminated`, `BillingAccountStatusReasonCodeOther`, `BillingAccountStatusReasonCodeTerminateProcessing`, `BillingAccountStatusReasonCodeTransferred`, `BillingAccountStatusReasonCodeUnusualActivity` + - New enum type `BillingManagementTenantState` with values `BillingManagementTenantStateActive`, `BillingManagementTenantStateNotAllowed`, `BillingManagementTenantStateOther`, `BillingManagementTenantStateRevoked` + - New enum type `BillingPlan` with values `BillingPlanP1M` + - New enum type `BillingRequestStatus` with values `BillingRequestStatusApproved`, `BillingRequestStatusCancelled`, `BillingRequestStatusCompleted`, `BillingRequestStatusDeclined`, `BillingRequestStatusExpired`, `BillingRequestStatusOther`, `BillingRequestStatusPending` + - New enum type `BillingRequestType` with values `BillingRequestTypeInvoiceAccess`, `BillingRequestTypeOther`, `BillingRequestTypeProvisioningAccess`, `BillingRequestTypeRoleAssignment`, `BillingRequestTypeUpdateBillingPolicy` + - New enum type `BillingSubscriptionOperationStatus` with values `BillingSubscriptionOperationStatusLockedForUpdate`, `BillingSubscriptionOperationStatusNone`, `BillingSubscriptionOperationStatusOther` + - New enum type `BillingSubscriptionStatus` with values `BillingSubscriptionStatusActive`, `BillingSubscriptionStatusAutoRenew`, `BillingSubscriptionStatusCancelled`, `BillingSubscriptionStatusDeleted`, `BillingSubscriptionStatusDisabled`, `BillingSubscriptionStatusExpired`, `BillingSubscriptionStatusExpiring`, `BillingSubscriptionStatusFailed`, `BillingSubscriptionStatusOther`, `BillingSubscriptionStatusSuspended`, `BillingSubscriptionStatusUnknown`, `BillingSubscriptionStatusWarned` + - New enum type `Cancellation` with values `CancellationAllowed`, `CancellationNotAllowed` + - New enum type `CancellationReason` with values `CancellationReasonCompromise`, `CancellationReasonDispute`, `CancellationReasonOther` + - New enum type `CommitmentGrain` with values `CommitmentGrainHourly` + - New enum type `CreatedByType` with values `CreatedByTypeApplication`, `CreatedByTypeKey`, `CreatedByTypeManagedIdentity`, `CreatedByTypeUser` + - New enum type `CreditType` with values `CreditTypeAzureCreditOffer`, `CreditTypeAzureFreeCredit`, `CreditTypeOther`, `CreditTypeRefund`, `CreditTypeServiceInterruption` + - New enum type `CustomerStatus` with values `CustomerStatusActive`, `CustomerStatusDeleted`, `CustomerStatusDisabled`, `CustomerStatusOther`, `CustomerStatusPending`, `CustomerStatusUnderReview`, `CustomerStatusWarned` + - New enum type `DeleteBillingProfileEligibilityCode` with values `DeleteBillingProfileEligibilityCodeActiveBillingSubscriptions`, `DeleteBillingProfileEligibilityCodeActiveCreditCard`, `DeleteBillingProfileEligibilityCodeActiveCredits`, `DeleteBillingProfileEligibilityCodeLastBillingProfile`, `DeleteBillingProfileEligibilityCodeNone`, `DeleteBillingProfileEligibilityCodeNotSupported`, `DeleteBillingProfileEligibilityCodeOutstandingCharges`, `DeleteBillingProfileEligibilityCodePendingCharges`, `DeleteBillingProfileEligibilityCodeReservedInstances` + - New enum type `DeleteBillingProfileEligibilityStatus` with values `DeleteBillingProfileEligibilityStatusAllowed`, `DeleteBillingProfileEligibilityStatusNotAllowed` + - New enum type `DeleteInvoiceSectionEligibilityCode` with values `DeleteInvoiceSectionEligibilityCodeActiveAzurePlans`, `DeleteInvoiceSectionEligibilityCodeActiveBillingSubscriptions`, `DeleteInvoiceSectionEligibilityCodeLastInvoiceSection`, `DeleteInvoiceSectionEligibilityCodeOther`, `DeleteInvoiceSectionEligibilityCodeReservedInstances` + - New enum type `DeleteInvoiceSectionEligibilityStatus` with values `DeleteInvoiceSectionEligibilityStatusAllowed`, `DeleteInvoiceSectionEligibilityStatusNotAllowed` + - New enum type `EligibleProductType` with values `EligibleProductTypeAzureReservation`, `EligibleProductTypeDevTestAzureSubscription`, `EligibleProductTypeStandardAzureSubscription` + - New enum type `EnrollmentAccountOwnerViewCharges` with values `EnrollmentAccountOwnerViewChargesAllowed`, `EnrollmentAccountOwnerViewChargesDisabled`, `EnrollmentAccountOwnerViewChargesNotAllowed`, `EnrollmentAccountOwnerViewChargesOther` + - New enum type `EnrollmentAuthLevelState` with values `EnrollmentAuthLevelStateMicrosoftAccountOnly`, `EnrollmentAuthLevelStateMixedAccount`, `EnrollmentAuthLevelStateOrganizationalAccountCrossTenant`, `EnrollmentAuthLevelStateOrganizationalAccountOnly`, `EnrollmentAuthLevelStateOther` + - New enum type `EnrollmentDepartmentAdminViewCharges` with values `EnrollmentDepartmentAdminViewChargesAllowed`, `EnrollmentDepartmentAdminViewChargesDisabled`, `EnrollmentDepartmentAdminViewChargesNotAllowed`, `EnrollmentDepartmentAdminViewChargesOther` + - New enum type `ExtendedTermOption` with values `ExtendedTermOptionOptedIn`, `ExtendedTermOptionOptedOut`, `ExtendedTermOptionOther` + - New enum type `FailedPaymentReason` with values `FailedPaymentReasonBankDeclined`, `FailedPaymentReasonCardExpired`, `FailedPaymentReasonIncorrectCardDetails`, `FailedPaymentReasonOther` + - New enum type `InitiatorCustomerType` with values `InitiatorCustomerTypeEA`, `InitiatorCustomerTypePartner` + - New enum type `InstanceFlexibility` with values `InstanceFlexibilityOff`, `InstanceFlexibilityOn` + - New enum type `InvoiceSectionLabelManagementPolicy` with values `InvoiceSectionLabelManagementPolicyAllowed`, `InvoiceSectionLabelManagementPolicyNotAllowed`, `InvoiceSectionLabelManagementPolicyOther` + - New enum type `InvoiceSectionStateReasonCode` with values `InvoiceSectionStateReasonCodeOther`, `InvoiceSectionStateReasonCodePastDue`, `InvoiceSectionStateReasonCodeSpendingLimitExpired`, `InvoiceSectionStateReasonCodeSpendingLimitReached`, `InvoiceSectionStateReasonCodeUnusualActivity` + - New enum type `MarkupStatus` with values `MarkupStatusDisabled`, `MarkupStatusLocked`, `MarkupStatusOther`, `MarkupStatusPreview`, `MarkupStatusPublished` + - New enum type `MoveValidationErrorCode` with values `MoveValidationErrorCodeBillingAccountInactive`, `MoveValidationErrorCodeDestinationBillingProfileInactive`, `MoveValidationErrorCodeDestinationBillingProfileNotFound`, `MoveValidationErrorCodeDestinationBillingProfilePastDue`, `MoveValidationErrorCodeDestinationInvoiceSectionInactive`, `MoveValidationErrorCodeDestinationInvoiceSectionNotFound`, `MoveValidationErrorCodeInsufficientPermissionOnDestination`, `MoveValidationErrorCodeInsufficientPermissionOnSource`, `MoveValidationErrorCodeInvalidDestination`, `MoveValidationErrorCodeInvalidSource`, `MoveValidationErrorCodeMarketplaceNotEnabledOnDestination`, `MoveValidationErrorCodeOther`, `MoveValidationErrorCodeProductInactive`, `MoveValidationErrorCodeProductNotFound`, `MoveValidationErrorCodeProductTypeNotSupported`, `MoveValidationErrorCodeSourceBillingProfilePastDue`, `MoveValidationErrorCodeSourceInvoiceSectionInactive` + - New enum type `PaymentMethodStatus` with values `PaymentMethodStatusActive`, `PaymentMethodStatusInactive` + - New enum type `PaymentStatus` with values `PaymentStatusCancelled`, `PaymentStatusCompleted`, `PaymentStatusFailed`, `PaymentStatusPending`, `PaymentStatusScheduled`, `PaymentStatusSucceeded` + - New enum type `PaymentTermsEligibilityCode` with values `PaymentTermsEligibilityCodeBillingAccountNotFound`, `PaymentTermsEligibilityCodeInactiveBillingAccount`, `PaymentTermsEligibilityCodeIneligibleBillingAccountStatus`, `PaymentTermsEligibilityCodeInvalidBillingAccountType`, `PaymentTermsEligibilityCodeInvalidDateFormat`, `PaymentTermsEligibilityCodeInvalidDateRange`, `PaymentTermsEligibilityCodeInvalidTerms`, `PaymentTermsEligibilityCodeNullOrEmptyPaymentTerms`, `PaymentTermsEligibilityCodeOther`, `PaymentTermsEligibilityCodeOverlappingPaymentTerms` + - New enum type `PaymentTermsEligibilityStatus` with values `PaymentTermsEligibilityStatusInvalid`, `PaymentTermsEligibilityStatusOther`, `PaymentTermsEligibilityStatusValid` + - New enum type `PolicyType` with values `PolicyTypeOther`, `PolicyTypeSystemControlled`, `PolicyTypeUserControlled` + - New enum type `PrincipalType` with values `PrincipalTypeDirectoryRole`, `PrincipalTypeEveryone`, `PrincipalTypeGroup`, `PrincipalTypeNone`, `PrincipalTypeServicePrincipal`, `PrincipalTypeUnknown`, `PrincipalTypeUser` + - New enum type `ProductStatus` with values `ProductStatusActive`, `ProductStatusAutoRenew`, `ProductStatusCanceled`, `ProductStatusDeleted`, `ProductStatusDisabled`, `ProductStatusExpired`, `ProductStatusExpiring`, `ProductStatusOther`, `ProductStatusPastDue`, `ProductStatusSuspended` + - New enum type `ProductTransferStatus` with values `ProductTransferStatusCompleted`, `ProductTransferStatusFailed`, `ProductTransferStatusInProgress`, `ProductTransferStatusNotStarted` + - New enum type `ProductType` with values `ProductTypeAzureReservation`, `ProductTypeAzureSubscription`, `ProductTypeDepartment`, `ProductTypeSAAS`, `ProductTypeSavingsPlan` + - New enum type `ProvisioningState` with values `ProvisioningStateCanceled`, `ProvisioningStateConfirmedBilling`, `ProvisioningStateCreated`, `ProvisioningStateCreating`, `ProvisioningStateExpired`, `ProvisioningStateFailed`, `ProvisioningStateNew`, `ProvisioningStatePending`, `ProvisioningStatePendingBilling`, `ProvisioningStateProvisioning`, `ProvisioningStateSucceeded` + - New enum type `ProvisioningTenantState` with values `ProvisioningTenantStateActive`, `ProvisioningTenantStateBillingRequestDeclined`, `ProvisioningTenantStateBillingRequestExpired`, `ProvisioningTenantStateNotRequested`, `ProvisioningTenantStateOther`, `ProvisioningTenantStatePending`, `ProvisioningTenantStateRevoked` + - New enum type `RefundReasonCode` with values `RefundReasonCodeAccidentalConversion`, `RefundReasonCodeAccidentalPurchase`, `RefundReasonCodeForgotToCancel`, `RefundReasonCodeOther`, `RefundReasonCodeUnclearDocumentation`, `RefundReasonCodeUnclearPricing` + - New enum type `RefundStatus` with values `RefundStatusApproved`, `RefundStatusCancelled`, `RefundStatusCompleted`, `RefundStatusDeclined`, `RefundStatusExpired`, `RefundStatusOther`, `RefundStatusPending` + - New enum type `ReservationBillingPlan` with values `ReservationBillingPlanMonthly`, `ReservationBillingPlanUpfront` + - New enum type `ReservationStatusCode` with values `ReservationStatusCodeActive`, `ReservationStatusCodeCapacityError`, `ReservationStatusCodeCapacityRestricted`, `ReservationStatusCodeCreditLineCheckFailed`, `ReservationStatusCodeExchanged`, `ReservationStatusCodeExpired`, `ReservationStatusCodeMerged`, `ReservationStatusCodeNoBenefit`, `ReservationStatusCodeNoBenefitDueToSubscriptionDeletion`, `ReservationStatusCodeNoBenefitDueToSubscriptionTransfer`, `ReservationStatusCodeNone`, `ReservationStatusCodePaymentInstrumentError`, `ReservationStatusCodePending`, `ReservationStatusCodeProcessing`, `ReservationStatusCodePurchaseError`, `ReservationStatusCodeRiskCheckFailed`, `ReservationStatusCodeSplit`, `ReservationStatusCodeSucceeded`, `ReservationStatusCodeUnknownError`, `ReservationStatusCodeWarning` + - New enum type `SavingsPlanPurchasesPolicy` with values `SavingsPlanPurchasesPolicyAllowed`, `SavingsPlanPurchasesPolicyDisabled`, `SavingsPlanPurchasesPolicyNotAllowed`, `SavingsPlanPurchasesPolicyOther` + - New enum type `SavingsPlanTerm` with values `SavingsPlanTermP1Y`, `SavingsPlanTermP3Y`, `SavingsPlanTermP5Y` + - New enum type `ServiceDefinedResourceName` with values `ServiceDefinedResourceNameDefault` + - New enum type `SpecialTaxationType` with values `SpecialTaxationTypeInvoiceLevel`, `SpecialTaxationTypeSubtotalLevel` + - New enum type `SpendingLimitStatus` with values `SpendingLimitStatusActive`, `SpendingLimitStatusExpired`, `SpendingLimitStatusLimitReached`, `SpendingLimitStatusLimitRemoved`, `SpendingLimitStatusNone`, `SpendingLimitStatusOther` + - New enum type `SpendingLimitType` with values `SpendingLimitTypeAcademicSponsorship`, `SpendingLimitTypeAzureConsumptionCredit`, `SpendingLimitTypeAzureForStudents`, `SpendingLimitTypeAzureForStudentsStarter`, `SpendingLimitTypeAzurePassSponsorship`, `SpendingLimitTypeFreeAccount`, `SpendingLimitTypeMSDN`, `SpendingLimitTypeMpnSponsorship`, `SpendingLimitTypeNonProfitSponsorship`, `SpendingLimitTypeNone`, `SpendingLimitTypeOther`, `SpendingLimitTypeSandbox`, `SpendingLimitTypeSponsorship`, `SpendingLimitTypeStartupSponsorship`, `SpendingLimitTypeVisualStudio` + - New enum type `SubscriptionBillingType` with values `SubscriptionBillingTypeBenefit`, `SubscriptionBillingTypeFree`, `SubscriptionBillingTypeNone`, `SubscriptionBillingTypePaid`, `SubscriptionBillingTypePrePaid` + - New enum type `SubscriptionEnrollmentAccountStatus` with values `SubscriptionEnrollmentAccountStatusActive`, `SubscriptionEnrollmentAccountStatusCancelled`, `SubscriptionEnrollmentAccountStatusDeleted`, `SubscriptionEnrollmentAccountStatusExpired`, `SubscriptionEnrollmentAccountStatusInactive`, `SubscriptionEnrollmentAccountStatusTransferredOut`, `SubscriptionEnrollmentAccountStatusTransferring` + - New enum type `SubscriptionStatusReason` with values `SubscriptionStatusReasonCancelled`, `SubscriptionStatusReasonExpired`, `SubscriptionStatusReasonNone`, `SubscriptionStatusReasonOther`, `SubscriptionStatusReasonPastDue`, `SubscriptionStatusReasonPolicyViolation`, `SubscriptionStatusReasonSpendingLimitReached`, `SubscriptionStatusReasonSuspiciousActivity`, `SubscriptionStatusReasonTransferred` + - New enum type `SubscriptionWorkloadType` with values `SubscriptionWorkloadTypeDevTest`, `SubscriptionWorkloadTypeInternal`, `SubscriptionWorkloadTypeNone`, `SubscriptionWorkloadTypeProduction` + - New enum type `SupportLevel` with values `SupportLevelDeveloper`, `SupportLevelOther`, `SupportLevelProDirect`, `SupportLevelStandard` + - New enum type `SupportedAccountType` with values `SupportedAccountTypeEnterprise`, `SupportedAccountTypeIndividual`, `SupportedAccountTypeNone`, `SupportedAccountTypePartner` + - New enum type `TaxIdentifierStatus` with values `TaxIdentifierStatusInvalid`, `TaxIdentifierStatusOther`, `TaxIdentifierStatusValid` + - New enum type `TaxIdentifierType` with values `TaxIdentifierTypeBrazilCcmID`, `TaxIdentifierTypeBrazilCnpjID`, `TaxIdentifierTypeBrazilCpfID`, `TaxIdentifierTypeCanadianFederalExempt`, `TaxIdentifierTypeCanadianProvinceExempt`, `TaxIdentifierTypeExternalTaxation`, `TaxIdentifierTypeIndiaFederalServiceTaxID`, `TaxIdentifierTypeIndiaFederalTanID`, `TaxIdentifierTypeIndiaPanID`, `TaxIdentifierTypeIndiaStateCstID`, `TaxIdentifierTypeIndiaStateGstINID`, `TaxIdentifierTypeIndiaStateVatID`, `TaxIdentifierTypeIntlExempt`, `TaxIdentifierTypeLoveCode`, `TaxIdentifierTypeMobileBarCode`, `TaxIdentifierTypeNationalIdentificationNumber`, `TaxIdentifierTypeOther`, `TaxIdentifierTypePublicSectorID`, `TaxIdentifierTypeUSExempt`, `TaxIdentifierTypeVatID` + - New enum type `TransactionKind` with values `TransactionKindAll`, `TransactionKindOther`, `TransactionKindReservation` + - New enum type `TransactionType` with values `TransactionTypeBilled`, `TransactionTypeOther`, `TransactionTypeUnbilled` + - New enum type `TransferStatus` with values `TransferStatusCanceled`, `TransferStatusCompleted`, `TransferStatusCompletedWithErrors`, `TransferStatusDeclined`, `TransferStatusExpired`, `TransferStatusFailed`, `TransferStatusInProgress`, `TransferStatusPending` + - New function `*AccountsClient.BeginAddPaymentTerms(context.Context, string, []*PaymentTerm, *AccountsClientBeginAddPaymentTermsOptions) (*runtime.Poller[AccountsClientAddPaymentTermsResponse], error)` + - New function `*AccountsClient.BeginCancelPaymentTerms(context.Context, string, time.Time, *AccountsClientBeginCancelPaymentTermsOptions) (*runtime.Poller[AccountsClientCancelPaymentTermsResponse], error)` + - New function `*AccountsClient.ConfirmTransition(context.Context, string, *AccountsClientConfirmTransitionOptions) (AccountsClientConfirmTransitionResponse, error)` + - New function `*AccountsClient.ValidatePaymentTerms(context.Context, string, []*PaymentTerm, *AccountsClientValidatePaymentTermsOptions) (AccountsClientValidatePaymentTermsResponse, error)` + - New function `NewAssociatedTenantsClient(azcore.TokenCredential, *arm.ClientOptions) (*AssociatedTenantsClient, error)` + - New function `*AssociatedTenantsClient.BeginCreateOrUpdate(context.Context, string, string, AssociatedTenant, *AssociatedTenantsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AssociatedTenantsClientCreateOrUpdateResponse], error)` + - New function `*AssociatedTenantsClient.BeginDelete(context.Context, string, string, *AssociatedTenantsClientBeginDeleteOptions) (*runtime.Poller[AssociatedTenantsClientDeleteResponse], error)` + - New function `*AssociatedTenantsClient.Get(context.Context, string, string, *AssociatedTenantsClientGetOptions) (AssociatedTenantsClientGetResponse, error)` + - New function `*AssociatedTenantsClient.NewListByBillingAccountPager(string, *AssociatedTenantsClientListByBillingAccountOptions) *runtime.Pager[AssociatedTenantsClientListByBillingAccountResponse]` + - New function `*AvailableBalancesClient.GetByBillingAccount(context.Context, string, *AvailableBalancesClientGetByBillingAccountOptions) (AvailableBalancesClientGetByBillingAccountResponse, error)` + - New function `*AvailableBalancesClient.GetByBillingProfile(context.Context, string, string, *AvailableBalancesClientGetByBillingProfileOptions) (AvailableBalancesClientGetByBillingProfileResponse, error)` + - New function `*ClientFactory.NewAssociatedTenantsClient() *AssociatedTenantsClient` + - New function `*ClientFactory.NewDepartmentsClient() *DepartmentsClient` + - New function `*ClientFactory.NewPartnerTransfersClient() *PartnerTransfersClient` + - New function `*ClientFactory.NewPaymentMethodsClient() *PaymentMethodsClient` + - New function `*ClientFactory.NewRecipientTransfersClient() *RecipientTransfersClient` + - New function `*ClientFactory.NewRequestsClient() *RequestsClient` + - New function `*ClientFactory.NewReservationOrdersClient() *ReservationOrdersClient` + - New function `*ClientFactory.NewRoleDefinitionClient() *RoleDefinitionClient` + - New function `*ClientFactory.NewSavingsPlanOrdersClient() *SavingsPlanOrdersClient` + - New function `*ClientFactory.NewSavingsPlansClient() *SavingsPlansClient` + - New function `*ClientFactory.NewSubscriptionsAliasesClient() *SubscriptionsAliasesClient` + - New function `*ClientFactory.NewTransfersClient() *TransfersClient` + - New function `*CustomersClient.GetByBillingAccount(context.Context, string, string, *CustomersClientGetByBillingAccountOptions) (CustomersClientGetByBillingAccountResponse, error)` + - New function `NewDepartmentsClient(azcore.TokenCredential, *arm.ClientOptions) (*DepartmentsClient, error)` + - New function `*DepartmentsClient.Get(context.Context, string, string, *DepartmentsClientGetOptions) (DepartmentsClientGetResponse, error)` + - New function `*DepartmentsClient.NewListByBillingAccountPager(string, *DepartmentsClientListByBillingAccountOptions) *runtime.Pager[DepartmentsClientListByBillingAccountResponse]` + - New function `*EnrollmentAccountsClient.GetByDepartment(context.Context, string, string, string, *EnrollmentAccountsClientGetByDepartmentOptions) (EnrollmentAccountsClientGetByDepartmentResponse, error)` + - New function `*EnrollmentAccountsClient.NewListByBillingAccountPager(string, *EnrollmentAccountsClientListByBillingAccountOptions) *runtime.Pager[EnrollmentAccountsClientListByBillingAccountResponse]` + - New function `*EnrollmentAccountsClient.NewListByDepartmentPager(string, string, *EnrollmentAccountsClientListByDepartmentOptions) *runtime.Pager[EnrollmentAccountsClientListByDepartmentResponse]` + - New function `*InvoiceSectionsClient.BeginDelete(context.Context, string, string, string, *InvoiceSectionsClientBeginDeleteOptions) (*runtime.Poller[InvoiceSectionsClientDeleteResponse], error)` + - New function `*InvoiceSectionsClient.ValidateDeleteEligibility(context.Context, string, string, string, *InvoiceSectionsClientValidateDeleteEligibilityOptions) (InvoiceSectionsClientValidateDeleteEligibilityResponse, error)` + - New function `*InvoicesClient.BeginAmend(context.Context, string, string, *InvoicesClientBeginAmendOptions) (*runtime.Poller[InvoicesClientAmendResponse], error)` + - New function `*InvoicesClient.BeginDownloadByBillingAccount(context.Context, string, string, *InvoicesClientBeginDownloadByBillingAccountOptions) (*runtime.Poller[InvoicesClientDownloadByBillingAccountResponse], error)` + - New function `*InvoicesClient.BeginDownloadByBillingSubscription(context.Context, string, *InvoicesClientBeginDownloadByBillingSubscriptionOptions) (*runtime.Poller[InvoicesClientDownloadByBillingSubscriptionResponse], error)` + - New function `*InvoicesClient.BeginDownloadDocumentsByBillingAccount(context.Context, string, []*DocumentDownloadRequest, *InvoicesClientBeginDownloadDocumentsByBillingAccountOptions) (*runtime.Poller[InvoicesClientDownloadDocumentsByBillingAccountResponse], error)` + - New function `*InvoicesClient.BeginDownloadDocumentsByBillingSubscription(context.Context, []*DocumentDownloadRequest, *InvoicesClientBeginDownloadDocumentsByBillingSubscriptionOptions) (*runtime.Poller[InvoicesClientDownloadDocumentsByBillingSubscriptionResponse], error)` + - New function `*InvoicesClient.BeginDownloadSummaryByBillingAccount(context.Context, string, string, *InvoicesClientBeginDownloadSummaryByBillingAccountOptions) (*runtime.Poller[InvoicesClientDownloadSummaryByBillingAccountResponse], error)` + - New function `*InvoicesClient.GetByBillingAccount(context.Context, string, string, *InvoicesClientGetByBillingAccountOptions) (InvoicesClientGetByBillingAccountResponse, error)` + - New function `*InvoicesClient.GetByBillingSubscription(context.Context, string, *InvoicesClientGetByBillingSubscriptionOptions) (InvoicesClientGetByBillingSubscriptionResponse, error)` + - New function `NewPartnerTransfersClient(azcore.TokenCredential, *arm.ClientOptions) (*PartnerTransfersClient, error)` + - New function `*PartnerTransfersClient.Cancel(context.Context, string, string, string, string, *PartnerTransfersClientCancelOptions) (PartnerTransfersClientCancelResponse, error)` + - New function `*PartnerTransfersClient.Get(context.Context, string, string, string, string, *PartnerTransfersClientGetOptions) (PartnerTransfersClientGetResponse, error)` + - New function `*PartnerTransfersClient.Initiate(context.Context, string, string, string, string, PartnerInitiateTransferRequest, *PartnerTransfersClientInitiateOptions) (PartnerTransfersClientInitiateResponse, error)` + - New function `*PartnerTransfersClient.NewListPager(string, string, string, *PartnerTransfersClientListOptions) *runtime.Pager[PartnerTransfersClientListResponse]` + - New function `NewPaymentMethodsClient(azcore.TokenCredential, *arm.ClientOptions) (*PaymentMethodsClient, error)` + - New function `*PaymentMethodsClient.BeginDeleteAtBillingProfile(context.Context, string, string, string, *PaymentMethodsClientBeginDeleteAtBillingProfileOptions) (*runtime.Poller[PaymentMethodsClientDeleteAtBillingProfileResponse], error)` + - New function `*PaymentMethodsClient.DeleteByUser(context.Context, string, *PaymentMethodsClientDeleteByUserOptions) (PaymentMethodsClientDeleteByUserResponse, error)` + - New function `*PaymentMethodsClient.GetByBillingAccount(context.Context, string, string, *PaymentMethodsClientGetByBillingAccountOptions) (PaymentMethodsClientGetByBillingAccountResponse, error)` + - New function `*PaymentMethodsClient.GetByBillingProfile(context.Context, string, string, string, *PaymentMethodsClientGetByBillingProfileOptions) (PaymentMethodsClientGetByBillingProfileResponse, error)` + - New function `*PaymentMethodsClient.GetByUser(context.Context, string, *PaymentMethodsClientGetByUserOptions) (PaymentMethodsClientGetByUserResponse, error)` + - New function `*PaymentMethodsClient.NewListByBillingAccountPager(string, *PaymentMethodsClientListByBillingAccountOptions) *runtime.Pager[PaymentMethodsClientListByBillingAccountResponse]` + - New function `*PaymentMethodsClient.NewListByBillingProfilePager(string, string, *PaymentMethodsClientListByBillingProfileOptions) *runtime.Pager[PaymentMethodsClientListByBillingProfileResponse]` + - New function `*PaymentMethodsClient.NewListByUserPager(*PaymentMethodsClientListByUserOptions) *runtime.Pager[PaymentMethodsClientListByUserResponse]` + - New function `*PermissionsClient.CheckAccessByBillingAccount(context.Context, string, CheckAccessRequest, *PermissionsClientCheckAccessByBillingAccountOptions) (PermissionsClientCheckAccessByBillingAccountResponse, error)` + - New function `*PermissionsClient.CheckAccessByBillingProfile(context.Context, string, string, CheckAccessRequest, *PermissionsClientCheckAccessByBillingProfileOptions) (PermissionsClientCheckAccessByBillingProfileResponse, error)` + - New function `*PermissionsClient.CheckAccessByCustomer(context.Context, string, string, string, CheckAccessRequest, *PermissionsClientCheckAccessByCustomerOptions) (PermissionsClientCheckAccessByCustomerResponse, error)` + - New function `*PermissionsClient.CheckAccessByDepartment(context.Context, string, string, CheckAccessRequest, *PermissionsClientCheckAccessByDepartmentOptions) (PermissionsClientCheckAccessByDepartmentResponse, error)` + - New function `*PermissionsClient.CheckAccessByEnrollmentAccount(context.Context, string, string, CheckAccessRequest, *PermissionsClientCheckAccessByEnrollmentAccountOptions) (PermissionsClientCheckAccessByEnrollmentAccountResponse, error)` + - New function `*PermissionsClient.CheckAccessByInvoiceSection(context.Context, string, string, string, CheckAccessRequest, *PermissionsClientCheckAccessByInvoiceSectionOptions) (PermissionsClientCheckAccessByInvoiceSectionResponse, error)` + - New function `*PermissionsClient.NewListByCustomerAtBillingAccountPager(string, string, *PermissionsClientListByCustomerAtBillingAccountOptions) *runtime.Pager[PermissionsClientListByCustomerAtBillingAccountResponse]` + - New function `*PermissionsClient.NewListByDepartmentPager(string, string, *PermissionsClientListByDepartmentOptions) *runtime.Pager[PermissionsClientListByDepartmentResponse]` + - New function `*PermissionsClient.NewListByEnrollmentAccountPager(string, string, *PermissionsClientListByEnrollmentAccountOptions) *runtime.Pager[PermissionsClientListByEnrollmentAccountResponse]` + - New function `*PermissionsClient.NewListByInvoiceSectionPager(string, string, string, *PermissionsClientListByInvoiceSectionOptions) *runtime.Pager[PermissionsClientListByInvoiceSectionResponse]` + - New function `*PoliciesClient.BeginCreateOrUpdateByBillingAccount(context.Context, string, AccountPolicy, *PoliciesClientBeginCreateOrUpdateByBillingAccountOptions) (*runtime.Poller[PoliciesClientCreateOrUpdateByBillingAccountResponse], error)` + - New function `*PoliciesClient.BeginCreateOrUpdateByBillingProfile(context.Context, string, string, ProfilePolicy, *PoliciesClientBeginCreateOrUpdateByBillingProfileOptions) (*runtime.Poller[PoliciesClientCreateOrUpdateByBillingProfileResponse], error)` + - New function `*PoliciesClient.BeginCreateOrUpdateByCustomer(context.Context, string, string, string, CustomerPolicy, *PoliciesClientBeginCreateOrUpdateByCustomerOptions) (*runtime.Poller[PoliciesClientCreateOrUpdateByCustomerResponse], error)` + - New function `*PoliciesClient.BeginCreateOrUpdateByCustomerAtBillingAccount(context.Context, string, string, CustomerPolicy, *PoliciesClientBeginCreateOrUpdateByCustomerAtBillingAccountOptions) (*runtime.Poller[PoliciesClientCreateOrUpdateByCustomerAtBillingAccountResponse], error)` + - New function `*PoliciesClient.GetByBillingAccount(context.Context, string, *PoliciesClientGetByBillingAccountOptions) (PoliciesClientGetByBillingAccountResponse, error)` + - New function `*PoliciesClient.GetByCustomerAtBillingAccount(context.Context, string, string, *PoliciesClientGetByCustomerAtBillingAccountOptions) (PoliciesClientGetByCustomerAtBillingAccountResponse, error)` + - New function `*PoliciesClient.GetBySubscription(context.Context, *PoliciesClientGetBySubscriptionOptions) (PoliciesClientGetBySubscriptionResponse, error)` + - New function `PossibleCancellationValues() []Cancellation` + - New function `*ProductsClient.ValidateMoveEligibility(context.Context, string, string, MoveProductRequest, *ProductsClientValidateMoveEligibilityOptions) (ProductsClientValidateMoveEligibilityResponse, error)` + - New function `*ProfilesClient.BeginDelete(context.Context, string, string, *ProfilesClientBeginDeleteOptions) (*runtime.Poller[ProfilesClientDeleteResponse], error)` + - New function `*ProfilesClient.ValidateDeleteEligibility(context.Context, string, string, *ProfilesClientValidateDeleteEligibilityOptions) (ProfilesClientValidateDeleteEligibilityResponse, error)` + - New function `NewRecipientTransfersClient(azcore.TokenCredential, *arm.ClientOptions) (*RecipientTransfersClient, error)` + - New function `*RecipientTransfersClient.Accept(context.Context, string, AcceptTransferRequest, *RecipientTransfersClientAcceptOptions) (RecipientTransfersClientAcceptResponse, error)` + - New function `*RecipientTransfersClient.Decline(context.Context, string, *RecipientTransfersClientDeclineOptions) (RecipientTransfersClientDeclineResponse, error)` + - New function `*RecipientTransfersClient.Get(context.Context, string, *RecipientTransfersClientGetOptions) (RecipientTransfersClientGetResponse, error)` + - New function `*RecipientTransfersClient.NewListPager(*RecipientTransfersClientListOptions) *runtime.Pager[RecipientTransfersClientListResponse]` + - New function `*RecipientTransfersClient.Validate(context.Context, string, AcceptTransferRequest, *RecipientTransfersClientValidateOptions) (RecipientTransfersClientValidateResponse, error)` + - New function `NewRequestsClient(azcore.TokenCredential, *arm.ClientOptions) (*RequestsClient, error)` + - New function `*RequestsClient.BeginCreateOrUpdate(context.Context, string, Request, *RequestsClientBeginCreateOrUpdateOptions) (*runtime.Poller[RequestsClientCreateOrUpdateResponse], error)` + - New function `*RequestsClient.Get(context.Context, string, *RequestsClientGetOptions) (RequestsClientGetResponse, error)` + - New function `*RequestsClient.NewListByBillingAccountPager(string, *RequestsClientListByBillingAccountOptions) *runtime.Pager[RequestsClientListByBillingAccountResponse]` + - New function `*RequestsClient.NewListByBillingProfilePager(string, string, *RequestsClientListByBillingProfileOptions) *runtime.Pager[RequestsClientListByBillingProfileResponse]` + - New function `*RequestsClient.NewListByCustomerPager(string, string, string, *RequestsClientListByCustomerOptions) *runtime.Pager[RequestsClientListByCustomerResponse]` + - New function `*RequestsClient.NewListByInvoiceSectionPager(string, string, string, *RequestsClientListByInvoiceSectionOptions) *runtime.Pager[RequestsClientListByInvoiceSectionResponse]` + - New function `*RequestsClient.NewListByUserPager(*RequestsClientListByUserOptions) *runtime.Pager[RequestsClientListByUserResponse]` + - New function `NewReservationOrdersClient(azcore.TokenCredential, *arm.ClientOptions) (*ReservationOrdersClient, error)` + - New function `*ReservationOrdersClient.GetByBillingAccount(context.Context, string, string, *ReservationOrdersClientGetByBillingAccountOptions) (ReservationOrdersClientGetByBillingAccountResponse, error)` + - New function `*ReservationOrdersClient.NewListByBillingAccountPager(string, *ReservationOrdersClientListByBillingAccountOptions) *runtime.Pager[ReservationOrdersClientListByBillingAccountResponse]` + - New function `*ReservationsClient.GetByReservationOrder(context.Context, string, string, string, *ReservationsClientGetByReservationOrderOptions) (ReservationsClientGetByReservationOrderResponse, error)` + - New function `*ReservationsClient.NewListByReservationOrderPager(string, string, *ReservationsClientListByReservationOrderOptions) *runtime.Pager[ReservationsClientListByReservationOrderResponse]` + - New function `*ReservationsClient.BeginUpdateByBillingAccount(context.Context, string, string, string, Patch, *ReservationsClientBeginUpdateByBillingAccountOptions) (*runtime.Poller[ReservationsClientUpdateByBillingAccountResponse], error)` + - New function `*RoleAssignmentsClient.BeginCreateByBillingAccount(context.Context, string, RoleAssignmentProperties, *RoleAssignmentsClientBeginCreateByBillingAccountOptions) (*runtime.Poller[RoleAssignmentsClientCreateByBillingAccountResponse], error)` + - New function `*RoleAssignmentsClient.BeginCreateByBillingProfile(context.Context, string, string, RoleAssignmentProperties, *RoleAssignmentsClientBeginCreateByBillingProfileOptions) (*runtime.Poller[RoleAssignmentsClientCreateByBillingProfileResponse], error)` + - New function `*RoleAssignmentsClient.BeginCreateByCustomer(context.Context, string, string, string, RoleAssignmentProperties, *RoleAssignmentsClientBeginCreateByCustomerOptions) (*runtime.Poller[RoleAssignmentsClientCreateByCustomerResponse], error)` + - New function `*RoleAssignmentsClient.BeginCreateByInvoiceSection(context.Context, string, string, string, RoleAssignmentProperties, *RoleAssignmentsClientBeginCreateByInvoiceSectionOptions) (*runtime.Poller[RoleAssignmentsClientCreateByInvoiceSectionResponse], error)` + - New function `*RoleAssignmentsClient.BeginCreateOrUpdateByBillingAccount(context.Context, string, string, RoleAssignment, *RoleAssignmentsClientBeginCreateOrUpdateByBillingAccountOptions) (*runtime.Poller[RoleAssignmentsClientCreateOrUpdateByBillingAccountResponse], error)` + - New function `*RoleAssignmentsClient.BeginCreateOrUpdateByDepartment(context.Context, string, string, string, RoleAssignment, *RoleAssignmentsClientBeginCreateOrUpdateByDepartmentOptions) (*runtime.Poller[RoleAssignmentsClientCreateOrUpdateByDepartmentResponse], error)` + - New function `*RoleAssignmentsClient.BeginCreateOrUpdateByEnrollmentAccount(context.Context, string, string, string, RoleAssignment, *RoleAssignmentsClientBeginCreateOrUpdateByEnrollmentAccountOptions) (*runtime.Poller[RoleAssignmentsClientCreateOrUpdateByEnrollmentAccountResponse], error)` + - New function `*RoleAssignmentsClient.DeleteByCustomer(context.Context, string, string, string, string, *RoleAssignmentsClientDeleteByCustomerOptions) (RoleAssignmentsClientDeleteByCustomerResponse, error)` + - New function `*RoleAssignmentsClient.DeleteByDepartment(context.Context, string, string, string, *RoleAssignmentsClientDeleteByDepartmentOptions) (RoleAssignmentsClientDeleteByDepartmentResponse, error)` + - New function `*RoleAssignmentsClient.DeleteByEnrollmentAccount(context.Context, string, string, string, *RoleAssignmentsClientDeleteByEnrollmentAccountOptions) (RoleAssignmentsClientDeleteByEnrollmentAccountResponse, error)` + - New function `*RoleAssignmentsClient.GetByCustomer(context.Context, string, string, string, string, *RoleAssignmentsClientGetByCustomerOptions) (RoleAssignmentsClientGetByCustomerResponse, error)` + - New function `*RoleAssignmentsClient.GetByDepartment(context.Context, string, string, string, *RoleAssignmentsClientGetByDepartmentOptions) (RoleAssignmentsClientGetByDepartmentResponse, error)` + - New function `*RoleAssignmentsClient.GetByEnrollmentAccount(context.Context, string, string, string, *RoleAssignmentsClientGetByEnrollmentAccountOptions) (RoleAssignmentsClientGetByEnrollmentAccountResponse, error)` + - New function `*RoleAssignmentsClient.NewListByCustomerPager(string, string, string, *RoleAssignmentsClientListByCustomerOptions) *runtime.Pager[RoleAssignmentsClientListByCustomerResponse]` + - New function `*RoleAssignmentsClient.NewListByDepartmentPager(string, string, *RoleAssignmentsClientListByDepartmentOptions) *runtime.Pager[RoleAssignmentsClientListByDepartmentResponse]` + - New function `*RoleAssignmentsClient.NewListByEnrollmentAccountPager(string, string, *RoleAssignmentsClientListByEnrollmentAccountOptions) *runtime.Pager[RoleAssignmentsClientListByEnrollmentAccountResponse]` + - New function `*RoleAssignmentsClient.BeginResolveByBillingAccount(context.Context, string, *RoleAssignmentsClientBeginResolveByBillingAccountOptions) (*runtime.Poller[RoleAssignmentsClientResolveByBillingAccountResponse], error)` + - New function `*RoleAssignmentsClient.BeginResolveByBillingProfile(context.Context, string, string, *RoleAssignmentsClientBeginResolveByBillingProfileOptions) (*runtime.Poller[RoleAssignmentsClientResolveByBillingProfileResponse], error)` + - New function `*RoleAssignmentsClient.BeginResolveByCustomer(context.Context, string, string, string, *RoleAssignmentsClientBeginResolveByCustomerOptions) (*runtime.Poller[RoleAssignmentsClientResolveByCustomerResponse], error)` + - New function `*RoleAssignmentsClient.BeginResolveByInvoiceSection(context.Context, string, string, string, *RoleAssignmentsClientBeginResolveByInvoiceSectionOptions) (*runtime.Poller[RoleAssignmentsClientResolveByInvoiceSectionResponse], error)` + - New function `NewRoleDefinitionClient(azcore.TokenCredential, *arm.ClientOptions) (*RoleDefinitionClient, error)` + - New function `*RoleDefinitionClient.GetByBillingAccount(context.Context, string, string, *RoleDefinitionClientGetByBillingAccountOptions) (RoleDefinitionClientGetByBillingAccountResponse, error)` + - New function `*RoleDefinitionClient.GetByBillingProfile(context.Context, string, string, string, *RoleDefinitionClientGetByBillingProfileOptions) (RoleDefinitionClientGetByBillingProfileResponse, error)` + - New function `*RoleDefinitionClient.GetByCustomer(context.Context, string, string, string, string, *RoleDefinitionClientGetByCustomerOptions) (RoleDefinitionClientGetByCustomerResponse, error)` + - New function `*RoleDefinitionClient.GetByDepartment(context.Context, string, string, string, *RoleDefinitionClientGetByDepartmentOptions) (RoleDefinitionClientGetByDepartmentResponse, error)` + - New function `*RoleDefinitionClient.GetByEnrollmentAccount(context.Context, string, string, string, *RoleDefinitionClientGetByEnrollmentAccountOptions) (RoleDefinitionClientGetByEnrollmentAccountResponse, error)` + - New function `*RoleDefinitionClient.GetByInvoiceSection(context.Context, string, string, string, string, *RoleDefinitionClientGetByInvoiceSectionOptions) (RoleDefinitionClientGetByInvoiceSectionResponse, error)` + - New function `*RoleDefinitionClient.NewListByBillingAccountPager(string, *RoleDefinitionClientListByBillingAccountOptions) *runtime.Pager[RoleDefinitionClientListByBillingAccountResponse]` + - New function `*RoleDefinitionClient.NewListByBillingProfilePager(string, string, *RoleDefinitionClientListByBillingProfileOptions) *runtime.Pager[RoleDefinitionClientListByBillingProfileResponse]` + - New function `*RoleDefinitionClient.NewListByCustomerPager(string, string, string, *RoleDefinitionClientListByCustomerOptions) *runtime.Pager[RoleDefinitionClientListByCustomerResponse]` + - New function `*RoleDefinitionClient.NewListByDepartmentPager(string, string, *RoleDefinitionClientListByDepartmentOptions) *runtime.Pager[RoleDefinitionClientListByDepartmentResponse]` + - New function `*RoleDefinitionClient.NewListByEnrollmentAccountPager(string, string, *RoleDefinitionClientListByEnrollmentAccountOptions) *runtime.Pager[RoleDefinitionClientListByEnrollmentAccountResponse]` + - New function `*RoleDefinitionClient.NewListByInvoiceSectionPager(string, string, string, *RoleDefinitionClientListByInvoiceSectionOptions) *runtime.Pager[RoleDefinitionClientListByInvoiceSectionResponse]` + - New function `NewSavingsPlanOrdersClient(azcore.TokenCredential, *arm.ClientOptions) (*SavingsPlanOrdersClient, error)` + - New function `*SavingsPlanOrdersClient.GetByBillingAccount(context.Context, string, string, *SavingsPlanOrdersClientGetByBillingAccountOptions) (SavingsPlanOrdersClientGetByBillingAccountResponse, error)` + - New function `*SavingsPlanOrdersClient.NewListByBillingAccountPager(string, *SavingsPlanOrdersClientListByBillingAccountOptions) *runtime.Pager[SavingsPlanOrdersClientListByBillingAccountResponse]` + - New function `NewSavingsPlansClient(azcore.TokenCredential, *arm.ClientOptions) (*SavingsPlansClient, error)` + - New function `*SavingsPlansClient.GetByBillingAccount(context.Context, string, string, string, *SavingsPlansClientGetByBillingAccountOptions) (SavingsPlansClientGetByBillingAccountResponse, error)` + - New function `*SavingsPlansClient.NewListByBillingAccountPager(string, *SavingsPlansClientListByBillingAccountOptions) *runtime.Pager[SavingsPlansClientListByBillingAccountResponse]` + - New function `*SavingsPlansClient.NewListBySavingsPlanOrderPager(string, string, *SavingsPlansClientListBySavingsPlanOrderOptions) *runtime.Pager[SavingsPlansClientListBySavingsPlanOrderResponse]` + - New function `*SavingsPlansClient.BeginUpdateByBillingAccount(context.Context, string, string, string, SavingsPlanUpdateRequest, *SavingsPlansClientBeginUpdateByBillingAccountOptions) (*runtime.Poller[SavingsPlansClientUpdateByBillingAccountResponse], error)` + - New function `*SavingsPlansClient.ValidateUpdateByBillingAccount(context.Context, string, string, string, SavingsPlanUpdateValidateRequest, *SavingsPlansClientValidateUpdateByBillingAccountOptions) (SavingsPlansClientValidateUpdateByBillingAccountResponse, error)` + - New function `NewSubscriptionsAliasesClient(azcore.TokenCredential, *arm.ClientOptions) (*SubscriptionsAliasesClient, error)` + - New function `*SubscriptionsAliasesClient.BeginCreateOrUpdate(context.Context, string, string, SubscriptionAlias, *SubscriptionsAliasesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SubscriptionsAliasesClientCreateOrUpdateResponse], error)` + - New function `*SubscriptionsAliasesClient.Get(context.Context, string, string, *SubscriptionsAliasesClientGetOptions) (SubscriptionsAliasesClientGetResponse, error)` + - New function `*SubscriptionsAliasesClient.NewListByBillingAccountPager(string, *SubscriptionsAliasesClientListByBillingAccountOptions) *runtime.Pager[SubscriptionsAliasesClientListByBillingAccountResponse]` + - New function `*SubscriptionsClient.BeginCancel(context.Context, string, string, CancelSubscriptionRequest, *SubscriptionsClientBeginCancelOptions) (*runtime.Poller[SubscriptionsClientCancelResponse], error)` + - New function `*SubscriptionsClient.BeginDelete(context.Context, string, string, *SubscriptionsClientBeginDeleteOptions) (*runtime.Poller[SubscriptionsClientDeleteResponse], error)` + - New function `*SubscriptionsClient.GetByBillingProfile(context.Context, string, string, string, *SubscriptionsClientGetByBillingProfileOptions) (SubscriptionsClientGetByBillingProfileResponse, error)` + - New function `*SubscriptionsClient.NewListByCustomerAtBillingAccountPager(string, string, *SubscriptionsClientListByCustomerAtBillingAccountOptions) *runtime.Pager[SubscriptionsClientListByCustomerAtBillingAccountResponse]` + - New function `*SubscriptionsClient.NewListByEnrollmentAccountPager(string, string, *SubscriptionsClientListByEnrollmentAccountOptions) *runtime.Pager[SubscriptionsClientListByEnrollmentAccountResponse]` + - New function `*SubscriptionsClient.BeginMerge(context.Context, string, string, SubscriptionMergeRequest, *SubscriptionsClientBeginMergeOptions) (*runtime.Poller[SubscriptionsClientMergeResponse], error)` + - New function `*SubscriptionsClient.BeginSplit(context.Context, string, string, SubscriptionSplitRequest, *SubscriptionsClientBeginSplitOptions) (*runtime.Poller[SubscriptionsClientSplitResponse], error)` + - New function `*SubscriptionsClient.ValidateMoveEligibility(context.Context, string, string, MoveBillingSubscriptionRequest, *SubscriptionsClientValidateMoveEligibilityOptions) (SubscriptionsClientValidateMoveEligibilityResponse, error)` + - New function `*TransactionsClient.GetTransactionSummaryByInvoice(context.Context, string, string, *TransactionsClientGetTransactionSummaryByInvoiceOptions) (TransactionsClientGetTransactionSummaryByInvoiceResponse, error)` + - New function `*TransactionsClient.NewListByBillingProfilePager(string, string, time.Time, time.Time, TransactionType, *TransactionsClientListByBillingProfileOptions) *runtime.Pager[TransactionsClientListByBillingProfileResponse]` + - New function `*TransactionsClient.NewListByCustomerPager(string, string, string, time.Time, time.Time, TransactionType, *TransactionsClientListByCustomerOptions) *runtime.Pager[TransactionsClientListByCustomerResponse]` + - New function `*TransactionsClient.NewListByInvoiceSectionPager(string, string, string, time.Time, time.Time, TransactionType, *TransactionsClientListByInvoiceSectionOptions) *runtime.Pager[TransactionsClientListByInvoiceSectionResponse]` + - New function `*TransactionsClient.BeginTransactionsDownloadByInvoice(context.Context, string, string, *TransactionsClientBeginTransactionsDownloadByInvoiceOptions) (*runtime.Poller[TransactionsClientTransactionsDownloadByInvoiceResponse], error)` + - New function `NewTransfersClient(azcore.TokenCredential, *arm.ClientOptions) (*TransfersClient, error)` + - New function `*TransfersClient.Cancel(context.Context, string, string, string, string, *TransfersClientCancelOptions) (TransfersClientCancelResponse, error)` + - New function `*TransfersClient.Get(context.Context, string, string, string, string, *TransfersClientGetOptions) (TransfersClientGetResponse, error)` + - New function `*TransfersClient.Initiate(context.Context, string, string, string, string, InitiateTransferRequest, *TransfersClientInitiateOptions) (TransfersClientInitiateResponse, error)` + - New function `*TransfersClient.NewListPager(string, string, string, *TransfersClientListOptions) *runtime.Pager[TransfersClientListResponse]` + - New struct `AcceptTransferProperties` + - New struct `AcceptTransferRequest` + - New struct `AccountPatch` + - New struct `AccountPolicy` + - New struct `AccountPolicyProperties` + - New struct `AccountPolicyPropertiesEnterpriseAgreementPolicies` + - New struct `AccountPropertiesEnrollmentDetails` + - New struct `AccountPropertiesRegistrationNumber` + - New struct `AccountPropertiesSoldTo` + - New struct `AddressValidationResponse` + - New struct `AppliedScopeProperties` + - New struct `AssociatedTenant` + - New struct `AssociatedTenantListResult` + - New struct `AssociatedTenantProperties` + - New struct `AvailableBalancePropertiesAmount` + - New struct `AvailableBalancePropertiesTotalPaymentsOnAccount` + - New struct `Beneficiary` + - New struct `CancelSubscriptionRequest` + - New struct `CheckAccessRequest` + - New struct `CheckAccessResponse` + - New struct `Commitment` + - New struct `DeleteBillingProfileEligibilityDetail` + - New struct `DeleteBillingProfileEligibilityResult` + - New struct `DeleteInvoiceSectionEligibilityDetail` + - New struct `DeleteInvoiceSectionEligibilityResult` + - New struct `DepartmentListResult` + - New struct `DetailedTransferStatus` + - New struct `DocumentDownloadRequest` + - New struct `DocumentDownloadResult` + - New struct `EnrollmentAccountSubscriptionDetails` + - New struct `EnrollmentDetails` + - New struct `EnrollmentDetailsIndirectRelationshipInfo` + - New struct `EnterpriseAgreementPolicies` + - New struct `ErrorAdditionalInfo` + - New struct `ErrorDetail` + - New struct `ExtendedStatusDefinitionProperties` + - New struct `ExtendedStatusInfo` + - New struct `ExtendedStatusInfoProperties` + - New struct `ExternalReference` + - New struct `FailedPayment` + - New struct `InitiateTransferProperties` + - New struct `InitiateTransferRequest` + - New struct `InvoiceDocument` + - New struct `InvoicePropertiesAmountDue` + - New struct `InvoicePropertiesAzurePrepaymentApplied` + - New struct `InvoicePropertiesBilledAmount` + - New struct `InvoicePropertiesCreditAmount` + - New struct `InvoicePropertiesFreeAzureCreditApplied` + - New struct `InvoicePropertiesRebillDetails` + - New struct `InvoicePropertiesRefundDetails` + - New struct `InvoicePropertiesSubTotal` + - New struct `InvoicePropertiesTaxAmount` + - New struct `InvoicePropertiesTotalAmount` + - New struct `InvoiceSectionWithCreateSubPermissionListResult` + - New struct `MoveBillingSubscriptionEligibilityResult` + - New struct `MoveBillingSubscriptionErrorDetails` + - New struct `MoveBillingSubscriptionRequest` + - New struct `MoveProductEligibilityResult` + - New struct `MoveProductEligibilityResultErrorDetails` + - New struct `MoveProductErrorDetails` + - New struct `MoveProductRequest` + - New struct `NextBillingCycleDetails` + - New struct `Participant` + - New struct `PartnerInitiateTransferProperties` + - New struct `PartnerInitiateTransferRequest` + - New struct `PartnerTransferDetails` + - New struct `PartnerTransferDetailsListResult` + - New struct `PartnerTransferProperties` + - New struct `Patch` + - New struct `PatchProperties` + - New struct `PatchPropertiesRenewProperties` + - New struct `Payment` + - New struct `PaymentAmount` + - New struct `PaymentDetail` + - New struct `PaymentMethod` + - New struct `PaymentMethodLink` + - New struct `PaymentMethodLinkProperties` + - New struct `PaymentMethodLinksListResult` + - New struct `PaymentMethodLogo` + - New struct `PaymentMethodProperties` + - New struct `PaymentMethodsListResult` + - New struct `PaymentOnAccount` + - New struct `PaymentOnAccountAmount` + - New struct `PaymentTerm` + - New struct `PaymentTermsEligibilityDetail` + - New struct `PaymentTermsEligibilityResult` + - New struct `Permission` + - New struct `PermissionListResult` + - New struct `PlanInformation` + - New struct `PolicySummary` + - New struct `Price` + - New struct `Principal` + - New struct `ProductDetails` + - New struct `ProductListResult` + - New struct `ProductPatch` + - New struct `ProductPropertiesLastCharge` + - New struct `ProductPropertiesReseller` + - New struct `ProfilePolicy` + - New struct `ProfilePolicyProperties` + - New struct `ProfilePolicyPropertiesEnterpriseAgreementPolicies` + - New struct `ProfilePropertiesBillTo` + - New struct `ProfilePropertiesCurrentPaymentTerm` + - New struct `ProfilePropertiesIndirectRelationshipInfo` + - New struct `ProfilePropertiesShipTo` + - New struct `ProfilePropertiesSoldTo` + - New struct `PropertyPropertiesEnrollmentDetails` + - New struct `PropertyPropertiesSubscriptionServiceUsageAddress` + - New struct `ProxyResource` + - New struct `ProxyResourceWithTags` + - New struct `PurchaseRequest` + - New struct `PurchaseRequestProperties` + - New struct `RecipientTransferDetails` + - New struct `RecipientTransferDetailsListResult` + - New struct `RecipientTransferProperties` + - New struct `RefundDetailsSummary` + - New struct `RefundDetailsSummaryAmountRefunded` + - New struct `RefundDetailsSummaryAmountRequested` + - New struct `RefundTransactionDetails` + - New struct `RefundTransactionDetailsAmountRefunded` + - New struct `RefundTransactionDetailsAmountRequested` + - New struct `RegistrationNumber` + - New struct `RenewProperties` + - New struct `RenewPropertiesResponse` + - New struct `RenewalTermDetails` + - New struct `Request` + - New struct `RequestListResult` + - New struct `RequestProperties` + - New struct `RequestPropertiesCreatedBy` + - New struct `RequestPropertiesLastUpdatedBy` + - New struct `RequestPropertiesReviewedBy` + - New struct `ReservationAppliedScopeProperties` + - New struct `ReservationExtendedStatusInfo` + - New struct `ReservationList` + - New struct `ReservationMergeProperties` + - New struct `ReservationOrder` + - New struct `ReservationOrderBillingPlanInformation` + - New struct `ReservationOrderList` + - New struct `ReservationOrderProperty` + - New struct `ReservationPaymentDetail` + - New struct `ReservationPurchaseRequest` + - New struct `ReservationPurchaseRequestProperties` + - New struct `ReservationPurchaseRequestPropertiesReservedResourceProperties` + - New struct `ReservationSplitProperties` + - New struct `ReservationSwapProperties` + - New struct `SKU` + - New struct `SKUName` + - New struct `SavingsPlanModel` + - New struct `SavingsPlanModelList` + - New struct `SavingsPlanModelListResult` + - New struct `SavingsPlanModelProperties` + - New struct `SavingsPlanOrderModel` + - New struct `SavingsPlanOrderModelList` + - New struct `SavingsPlanOrderModelProperties` + - New struct `SavingsPlanSummaryCount` + - New struct `SavingsPlanUpdateRequest` + - New struct `SavingsPlanUpdateRequestProperties` + - New struct `SavingsPlanUpdateValidateRequest` + - New struct `SavingsPlanValidResponseProperty` + - New struct `SavingsPlanValidateResponse` + - New struct `SpendingLimitDetails` + - New struct `SubscriptionAlias` + - New struct `SubscriptionAliasListResult` + - New struct `SubscriptionAliasProperties` + - New struct `SubscriptionEnrollmentDetails` + - New struct `SubscriptionListResult` + - New struct `SubscriptionMergeRequest` + - New struct `SubscriptionPatch` + - New struct `SubscriptionPolicy` + - New struct `SubscriptionPolicyProperties` + - New struct `SubscriptionSplitRequest` + - New struct `SubscriptionStatusDetails` + - New struct `SystemData` + - New struct `SystemOverrides` + - New struct `TaxIdentifier` + - New struct `TransactionPropertiesAzureCreditApplied` + - New struct `TransactionPropertiesConsumptionCommitmentDecremented` + - New struct `TransactionPropertiesEffectivePrice` + - New struct `TransactionPropertiesMarketPrice` + - New struct `TransactionPropertiesRefundTransactionDetails` + - New struct `TransactionPropertiesSubTotal` + - New struct `TransactionPropertiesTax` + - New struct `TransactionPropertiesTransactionAmount` + - New struct `TransactionSummary` + - New struct `TransferDetails` + - New struct `TransferDetailsListResult` + - New struct `TransferError` + - New struct `TransferItemQueryParameter` + - New struct `TransferProperties` + - New struct `TransitionDetails` + - New struct `Utilization` + - New struct `UtilizationAggregates` + - New struct `ValidateTransferListResponse` + - New struct `ValidateTransferResponse` + - New struct `ValidateTransferResponseProperties` + - New struct `ValidationResultProperties` + - New field `SystemData`, `Tags` in struct `Account` + - New field `AccountStatusReasonCode`, `AccountSubType`, `BillingRelationshipTypes`, `HasNoBillingProfiles`, `PrimaryBillingTenantID`, `ProvisioningState`, `Qualifications`, `RegistrationNumber`, `TaxIDs` in struct `AccountProperties` + - New field `Filter` in struct `AccountsClientListInvoiceSectionsByCreateSubscriptionPermissionOptions` + - New anonymous field `InvoiceSectionWithCreateSubPermissionListResult` in struct `AccountsClientListInvoiceSectionsByCreateSubscriptionPermissionResponse` + - New field `Filter`, `IncludeAll`, `IncludeAllWithoutBillingProfiles`, `IncludeDeleted`, `IncludePendingAgreement`, `IncludeResellee`, `LegalOwnerOID`, `LegalOwnerTID`, `Search`, `Skip`, `Top` in struct `AccountsClientListOptions` + - New anonymous field `AddressValidationResponse` in struct `AddressClientValidateResponse` + - New field `IsValidAddress` in struct `AddressDetails` + - New field `SystemData`, `Tags` in struct `Agreement` + - New field `DisplayName`, `LeadBillingAccountName` in struct `AgreementProperties` + - New field `SystemData`, `Tags` in struct `AvailableBalance` + - New field `PaymentsOnAccount`, `TotalPaymentsOnAccount` in struct `AvailableBalanceProperties` + - New field `ProductID` in struct `AzurePlan` + - New field `SystemData`, `Tags` in struct `Customer` + - New field `SystemData`, `Tags` in struct `CustomerPolicy` + - New field `Policies`, `ProvisioningState` in struct `CustomerPolicyProperties` + - New field `Status`, `SystemID`, `Tags` in struct `CustomerProperties` + - New field `Count`, `Expand`, `OrderBy`, `Skip`, `Top` in struct `CustomersClientListByBillingAccountOptions` + - New field `Count`, `Expand`, `OrderBy`, `Skip`, `Top` in struct `CustomersClientListByBillingProfileOptions` + - New field `SystemData`, `Tags` in struct `Department` + - New field `DisplayName`, `ID` in struct `DepartmentProperties` + - New field `SystemData`, `Tags` in struct `EnrollmentAccount` + - New field `AuthType`, `DepartmentDisplayName`, `DepartmentID`, `DisplayName`, `IsDevTestEnabled` in struct `EnrollmentAccountProperties` + - New anonymous field `EnrollmentAccount` in struct `EnrollmentAccountsClientGetResponse` + - New field `SystemData`, `Tags` in struct `Invoice` + - New field `FailedPayments`, `RefundDetails`, `SpecialTaxationType`, `SubscriptionDisplayName` in struct `InvoiceProperties` + - New field `SystemData`, `Tags` in struct `InvoiceSection` + - New field `ProvisioningState`, `ReasonCode` in struct `InvoiceSectionProperties` + - New field `Count`, `Filter`, `IncludeDeleted`, `OrderBy`, `Search`, `Skip`, `Top` in struct `InvoiceSectionsClientListByBillingProfileOptions` + - New field `Count`, `Filter`, `OrderBy`, `PeriodEndDate`, `PeriodStartDate`, `Search`, `Skip`, `Top` in struct `InvoicesClientListByBillingAccountOptions` + - New field `Count`, `Filter`, `OrderBy`, `PeriodEndDate`, `PeriodStartDate`, `Search`, `Skip`, `Top` in struct `InvoicesClientListByBillingProfileOptions` + - New field `Count`, `Filter`, `OrderBy`, `PeriodEndDate`, `PeriodStartDate`, `Search`, `Skip`, `Top` in struct `InvoicesClientListByBillingSubscriptionOptions` + - New anonymous field `PermissionListResult` in struct `PermissionsClientListByBillingAccountResponse` + - New anonymous field `PermissionListResult` in struct `PermissionsClientListByBillingProfileResponse` + - New anonymous field `PermissionListResult` in struct `PermissionsClientListByCustomerResponse` + - New anonymous field `ProfilePolicy` in struct `PoliciesClientGetByBillingProfileResponse` + - New field `SystemData`, `Tags` in struct `Product` + - New field `Count`, `OrderBy`, `Search`, `Skip`, `Top` in struct `ProductsClientListByBillingAccountOptions` + - New anonymous field `ProductListResult` in struct `ProductsClientListByBillingAccountResponse` + - New field `Count`, `OrderBy`, `Search`, `Skip`, `Top` in struct `ProductsClientListByBillingProfileOptions` + - New anonymous field `ProductListResult` in struct `ProductsClientListByBillingProfileResponse` + - New field `Count`, `Filter`, `OrderBy`, `Search`, `Skip`, `Top` in struct `ProductsClientListByCustomerOptions` + - New anonymous field `ProductListResult` in struct `ProductsClientListByCustomerResponse` + - New field `Count`, `OrderBy`, `Search`, `Skip`, `Top` in struct `ProductsClientListByInvoiceSectionOptions` + - New anonymous field `ProductListResult` in struct `ProductsClientListByInvoiceSectionResponse` + - New field `SystemData`, `Tags` in struct `Profile` + - New field `BillingAccountID`, `BillingProfileSystemID` in struct `ProfileInfo` + - New field `CurrentPaymentTerm`, `InvoiceRecipients`, `OtherPaymentTerms`, `ProvisioningState`, `ShipTo`, `SoldTo`, `SpendingLimitDetails` in struct `ProfileProperties` + - New field `Count`, `Filter`, `IncludeDeleted`, `OrderBy`, `Search`, `Skip`, `Top` in struct `ProfilesClientListByBillingAccountOptions` + - New field `SystemData`, `Tags` in struct `Property` + - New field `IncludeBillingCountry`, `IncludeTransitionStatus` in struct `PropertyClientGetOptions` + - New field `BillingAccountAgreementType`, `BillingAccountSoldToCountry`, `BillingAccountStatus`, `BillingAccountStatusReasonCode`, `BillingAccountSubType`, `BillingAccountType`, `BillingCurrency`, `BillingProfilePaymentMethodFamily`, `BillingProfilePaymentMethodType`, `BillingProfileSpendingLimitDetails`, `CustomerDisplayName`, `CustomerID`, `CustomerStatus`, `EnrollmentDetails`, `InvoiceSectionStatus`, `InvoiceSectionStatusReasonCode`, `IsTransitionedBillingAccount`, `SubscriptionBillingStatus`, `SubscriptionBillingStatusDetails`, `SubscriptionBillingType`, `SubscriptionServiceUsageAddress`, `SubscriptionWorkloadType` in struct `PropertyProperties` + - New field `Etag`, `SystemData`, `Tags` in struct `Reservation` + - New field `AppliedScopeProperties`, `Archived`, `BenefitStartTime`, `BillingPlan`, `BillingScopeID`, `Capabilities`, `ExpiryDateTime`, `ExtendedStatusInfo`, `InstanceFlexibility`, `LastUpdatedDateTime`, `MergeProperties`, `ProductCode`, `PurchaseDate`, `PurchaseDateTime`, `RenewDestination`, `RenewProperties`, `ReviewDateTime`, `SplitProperties`, `SwapProperties` in struct `ReservationProperty` + - New field `NoBenefitCount`, `ProcessingCount`, `WarningCount` in struct `ReservationSummary` + - New field `OrderBy`, `Skiptoken`, `Take` in struct `ReservationsClientListByBillingAccountOptions` + - New field `OrderBy`, `Skiptoken`, `Take` in struct `ReservationsClientListByBillingProfileOptions` + - New field `SystemData` in struct `Resource` + - New field `SystemData`, `Tags` in struct `RoleAssignment` + - New field `BillingAccountDisplayName`, `BillingAccountID`, `BillingProfileDisplayName`, `BillingProfileID`, `BillingRequestID`, `CreatedByPrincipalPuid`, `CustomerDisplayName`, `CustomerID`, `InvoiceSectionDisplayName`, `InvoiceSectionID`, `ModifiedByPrincipalID`, `ModifiedByPrincipalPuid`, `ModifiedByPrincipalTenantID`, `ModifiedByUserEmailAddress`, `ModifiedOn`, `PrincipalDisplayName`, `PrincipalPuid`, `PrincipalTenantName`, `PrincipalType`, `ProvisioningState` in struct `RoleAssignmentProperties` + - New field `Filter`, `Skip`, `Top` in struct `RoleAssignmentsClientListByBillingAccountOptions` + - New field `Filter`, `Skip`, `Top` in struct `RoleAssignmentsClientListByBillingProfileOptions` + - New field `Filter`, `Skip`, `Top` in struct `RoleAssignmentsClientListByInvoiceSectionOptions` + - New field `SystemData`, `Tags` in struct `RoleDefinition` + - New field `SystemData`, `Tags` in struct `Subscription` + - New field `AutoRenew`, `Beneficiary`, `BeneficiaryTenantID`, `BillingFrequency`, `BillingPolicies`, `BillingProfileName`, `ConsumptionCostCenter`, `CustomerName`, `EnrollmentAccountDisplayName`, `EnrollmentAccountID`, `EnrollmentAccountSubscriptionDetails`, `InvoiceSectionName`, `NextBillingCycleDetails`, `OfferID`, `OperationStatus`, `ProductCategory`, `ProductType`, `ProductTypeID`, `ProvisioningState`, `ProvisioningTenantID`, `PurchaseDate`, `Quantity`, `RenewalTermDetails`, `ResourceURI`, `Status`, `SuspensionReasonDetails`, `SystemOverrides`, `TermDuration`, `TermEndDate`, `TermStartDate` in struct `SubscriptionProperties` + - New field `Expand` in struct `SubscriptionsClientGetOptions` + - New field `Count`, `Expand`, `Filter`, `IncludeDeleted`, `IncludeFailed`, `IncludeTenantSubscriptions`, `OrderBy`, `Search`, `Skip`, `Top` in struct `SubscriptionsClientListByBillingAccountOptions` + - New anonymous field `SubscriptionListResult` in struct `SubscriptionsClientListByBillingAccountResponse` + - New field `Count`, `Expand`, `Filter`, `IncludeDeleted`, `OrderBy`, `Search`, `Skip`, `Top` in struct `SubscriptionsClientListByBillingProfileOptions` + - New anonymous field `SubscriptionListResult` in struct `SubscriptionsClientListByBillingProfileResponse` + - New field `Count`, `Expand`, `Filter`, `IncludeDeleted`, `OrderBy`, `Search`, `Skip`, `Top` in struct `SubscriptionsClientListByCustomerOptions` + - New anonymous field `SubscriptionListResult` in struct `SubscriptionsClientListByCustomerResponse` + - New field `Count`, `Expand`, `Filter`, `IncludeDeleted`, `OrderBy`, `Search`, `Skip`, `Top` in struct `SubscriptionsClientListByInvoiceSectionOptions` + - New anonymous field `SubscriptionListResult` in struct `SubscriptionsClientListByInvoiceSectionResponse` + - New field `SystemData`, `Tags` in struct `Transaction` + - New field `ConsumptionCommitmentDecremented`, `CreditType`, `IsThirdParty`, `PartNumber`, `ReasonCode`, `RefundTransactionDetails`, `SpecialTaxationType` in struct `TransactionProperties` + - New field `Count`, `Filter`, `OrderBy`, `Search`, `Skip`, `Top` in struct `TransactionsClientListByInvoiceOptions` From 2b6c728b10f0d8eca8bad4e7f009e38334ea7f1c Mon Sep 17 00:00:00 2001 From: Drishti Peshwani <148189108+drishtipeshwani09@users.noreply.github.com> Date: Wed, 26 Jun 2024 22:03:46 +0530 Subject: [PATCH 245/343] Microsoft.ContainerInstance: Added API version 2024-05-01-preview (#28964) * Copy files from stable/2023-05-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-05-01-preview Updated the API version from stable/2023-05-01 to preview/2024-05-01-preview. * Added tag for 2024-05-01-preview in readme file * Added ContainerGroupProfile, StandbyPoolProfile, isCreatedFromStandbyPool to Container Group Properties and ConfigMap to ContainerProperties specs and modified examples * Corrected code style issues using prettier * Fixed code styling issues using prettier * Corrected definition types * Added isCreatedFromStandbyPool to container group properties in examples * Corrected config map property definition in example * Added arm resource id identifier for container group profile and standby pool profile * Added format variable for container group profile and standby pool profile reference id * Added 200 http status response in standby pool scenario example * Modified the Container Group Create with standby pools example * Corrected format * Created suppressions.yaml * Update containerInstance.json to remove osType,image and resources as required properties * Update suppressions.yaml * Update suppressions.yaml * Delete specification/containerinstance/resource-manager/suppressions.yaml * Added suppression for AvoidAdditionalProperties in readme.md * Update suppression in readme.md * Update readme.md --- .../2024-05-01-preview/containerInstance.json | 2609 +++++++++++++++++ .../examples/CachedImagesList.json | 27 + .../examples/CapabilitiesList.json | 39 + .../examples/ContainerAttach.json | 17 + .../examples/ContainerExec.json | 24 + .../ContainerGroupCreateConfidential.json | 184 ++ ...ntainerGroupCreateOrUpdateStandbyPool.json | 137 + .../ContainerGroupEncryptionProperties.json | 194 ++ .../examples/ContainerGroupExtensions.json | 210 ++ .../examples/ContainerGroupUsage.json | 24 + .../ContainerGroupsCreateOrUpdate.json | 318 ++ .../ContainerGroupsCreatePriority.json | 122 + .../examples/ContainerGroupsDelete.json | 86 + .../examples/ContainerGroupsGetPriority.json | 88 + .../examples/ContainerGroupsGet_Failed.json | 116 + .../ContainerGroupsGet_Succeeded.json | 80 + .../examples/ContainerGroupsList.json | 91 + .../ContainerGroupsListByResourceGroup.json | 83 + .../examples/ContainerGroupsRestart.json | 11 + .../examples/ContainerGroupsStart.json | 16 + .../examples/ContainerGroupsStop.json | 11 + .../examples/ContainerGroupsUpdate.json | 101 + .../examples/ContainerListLogs.json | 17 + .../examples/OperationsList.json | 23 + .../SubnetServiceAssociationLinkDelete.json | 18 + .../resource-manager/readme.md | 18 +- 26 files changed, 4663 insertions(+), 1 deletion(-) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CachedImagesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CapabilitiesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerAttach.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerExec.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateConfidential.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateOrUpdateStandbyPool.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupEncryptionProperties.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupExtensions.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupUsage.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreateOrUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreatePriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsDelete.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGetPriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Failed.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Succeeded.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsListByResourceGroup.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsRestart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStop.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerListLogs.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/OperationsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/SubnetServiceAssociationLinkDelete.json diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json new file mode 100644 index 000000000000..1375a0e2998e --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json @@ -0,0 +1,2609 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "ContainerInstanceManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_List", + "x-ms-examples": { + "ContainerGroupsList": { + "$ref": "./examples/ContainerGroupsList.json" + } + }, + "summary": "Get a list of container groups in the specified subscription.", + "description": "Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_ListByResourceGroup", + "x-ms-examples": { + "ContainerGroupsListByResourceGroup": { + "$ref": "./examples/ContainerGroupsListByResourceGroup.json" + } + }, + "summary": "Get a list of container groups in the specified subscription and resource group.", + "description": "Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}": { + "get": { + "operationId": "ContainerGroups_Get", + "x-ms-examples": { + "ContainerGroupsGet_Succeeded": { + "$ref": "./examples/ContainerGroupsGet_Succeeded.json" + }, + "ContainerGroupsGet_Failed": { + "$ref": "./examples/ContainerGroupsGet_Failed.json" + }, + "ContainerGroupsGetWithPriority": { + "$ref": "./examples/ContainerGroupsGetPriority.json" + } + }, + "summary": "Get the properties of the specified container group.", + "description": "Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "ContainerGroups_CreateOrUpdate", + "x-ms-examples": { + "ContainerGroupsCreateOrUpdate": { + "$ref": "./examples/ContainerGroupsCreateOrUpdate.json" + }, + "ContainerGroupCreateWithExtensions": { + "$ref": "./examples/ContainerGroupExtensions.json" + }, + "ContainerGroupWithEncryptionProperties": { + "$ref": "./examples/ContainerGroupEncryptionProperties.json" + }, + "ConfidentialContainerGroup": { + "$ref": "./examples/ContainerGroupCreateConfidential.json" + }, + "ContainerGroupCreateOrUpdateWithStandbyPool": { + "$ref": "./examples/ContainerGroupCreateOrUpdateStandbyPool.json" + }, + "ContainerGroupsCreateWithPriority": { + "$ref": "./examples/ContainerGroupsCreatePriority.json" + } + }, + "summary": "Create or update container groups.", + "description": "Create or update container groups with specified configurations.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerGroup", + "description": "The properties of the container group to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "201": { + "description": "Created - the container group is created.", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ContainerGroups_Update", + "x-ms-examples": { + "ContainerGroupsUpdate": { + "$ref": "./examples/ContainerGroupsUpdate.json" + } + }, + "summary": "Update container groups.", + "description": "Updates container group tags with specified values.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "Resource", + "description": "The container group resource with just the tags to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Resource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "ContainerGroups_Delete", + "x-ms-examples": { + "ContainerGroupsDelete": { + "$ref": "./examples/ContainerGroupsDelete.json" + } + }, + "summary": "Delete the specified container group.", + "description": "Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart": { + "post": { + "operationId": "ContainerGroups_Restart", + "x-ms-examples": { + "ContainerRestart": { + "$ref": "./examples/ContainerGroupsRestart.json" + } + }, + "summary": "Restarts all containers in a container group.", + "description": "Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop": { + "post": { + "operationId": "ContainerGroups_Stop", + "x-ms-examples": { + "ContainerStop": { + "$ref": "./examples/ContainerGroupsStop.json" + } + }, + "summary": "Stops all containers in a container group.", + "description": "Stops all containers in a container group. Compute resources will be deallocated and billing will stop.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start": { + "post": { + "operationId": "ContainerGroups_Start", + "x-ms-examples": { + "ContainerStart": { + "$ref": "./examples/ContainerGroupsStart.json" + } + }, + "summary": "Starts all containers in a container group.", + "description": "Starts all containers in a container group. Compute resources will be allocated and billing will start.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "202": { + "description": "Started - the container group is starting." + }, + "204": { + "description": "Started - the container group is already running or starting." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.ContainerInstance/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "List the operations for Azure Container Instance service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages": { + "get": { + "operationId": "Location_ListUsage", + "x-ms-examples": { + "ContainerUsage": { + "$ref": "./examples/ContainerGroupUsage.json" + } + }, + "description": "Get the usage for a subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs": { + "get": { + "operationId": "Containers_ListLogs", + "x-ms-examples": { + "ContainerListLogs": { + "$ref": "./examples/ContainerListLogs.json" + } + }, + "summary": "Get the logs for a specified container instance.", + "description": "Get the logs for a specified container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "tail", + "in": "query", + "description": "The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.", + "type": "integer", + "format": "int32" + }, + { + "name": "timestamps", + "in": "query", + "description": "If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false.", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Logs" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec": { + "post": { + "operationId": "Containers_ExecuteCommand", + "x-ms-examples": { + "ContainerExec": { + "$ref": "./examples/ContainerExec.json" + } + }, + "summary": "Executes a command in a specific container instance.", + "description": "Executes a command for a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "containerExecRequest", + "in": "body", + "description": "The request for the exec command.", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerExecRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerExecResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach": { + "post": { + "operationId": "Containers_Attach", + "x-ms-examples": { + "ContainerAttach": { + "$ref": "./examples/ContainerAttach.json" + } + }, + "summary": "Attach to the output of a specific container instance.", + "description": "Attach to the output stream of a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAttachResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages": { + "get": { + "operationId": "Location_ListCachedImages", + "x-ms-examples": { + "CachedImages": { + "$ref": "./examples/CachedImagesList.json" + } + }, + "summary": "Get the list of cached images.", + "description": "Get the list of cached images on specific OS type for a subscription in a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CachedImagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities": { + "get": { + "operationId": "Location_ListCapabilities", + "x-ms-examples": { + "GetCapabilities": { + "$ref": "./examples/CapabilitiesList.json" + } + }, + "summary": "Get the list of capabilities of the location.", + "description": "Get the list of CPU/memory/GPU capabilities of a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints": { + "get": { + "operationId": "ContainerGroups_GetOutboundNetworkDependenciesEndpoints", + "x-ms-examples": {}, + "summary": "Get all network dependencies for container group.", + "description": "Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkDependenciesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/providers/Microsoft.ContainerInstance/serviceAssociationLinks/default": { + "delete": { + "operationId": "SubnetServiceAssociationLink_Delete", + "x-ms-examples": { + "SubnetServiceAssociationLinkDelete": { + "$ref": "./examples/SubnetServiceAssociationLinkDelete.json" + } + }, + "summary": "Delete container group virtual network association links.", + "description": "Delete container group virtual network association links. The operation does not delete other resources provided by the user.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/SubnetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Container": { + "description": "A container instance.", + "type": "object", + "required": [ + "properties", + "name" + ], + "properties": { + "name": { + "description": "The user-provided name of the container instance.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the container instance.", + "$ref": "#/definitions/ContainerProperties" + } + } + }, + "ContainerProperties": { + "description": "The container instance properties.", + "type": "object", + "properties": { + "image": { + "description": "The name of the image used to create the container instance.", + "type": "string" + }, + "command": { + "description": "The commands to execute within the container instance in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "ports": { + "description": "The exposed ports on the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerPort" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "environmentVariables": { + "description": "The environment variables to set in the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container instance. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the container instance has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "Current container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "Previous container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "resources": { + "description": "The resource requirements of the container instance.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeMounts": { + "description": "The volume mounts available to the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "livenessProbe": { + "description": "The liveness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "readinessProbe": { + "description": "The readiness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + }, + "configMap": { + "description": "The config map.", + "$ref": "#/definitions/ConfigMap" + } + } + }, + "ConfigMap": { + "description": "The container config map.", + "type": "object", + "properties": { + "keyValuePairs": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "The list of key value pairs associated with the config map of the container." + }, + "description": "The key value pairs dictionary in the config map." + } + } + }, + "SecurityContextDefinition": { + "description": "The security context for the container.", + "type": "object", + "properties": { + "privileged": { + "type": "boolean", + "description": "The flag to determine if the container permissions is elevated to Privileged." + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "A boolean value indicating whether the init process can elevate its privileges" + }, + "capabilities": { + "description": "The capabilities to add or drop from a container.", + "$ref": "#/definitions/SecurityContextCapabilitiesDefinition" + }, + "runAsGroup": { + "type": "integer", + "format": "int32", + "description": "Sets the User GID for the container." + }, + "runAsUser": { + "type": "integer", + "format": "int32", + "description": "Sets the User UID for the container." + }, + "seccompProfile": { + "type": "string", + "description": "a base64 encoded string containing the contents of the JSON in the seccomp profile" + } + } + }, + "SecurityContextCapabilitiesDefinition": { + "description": "The capabilities to add or drop from a container.", + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to add to the container." + }, + "drop": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to drop from the container." + } + } + }, + "ContainerState": { + "description": "The container instance state.", + "type": "object", + "readOnly": true, + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the container instance." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state started." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The container instance exit codes correspond to those from the `docker run` command." + }, + "finishTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state finished." + }, + "detailStatus": { + "type": "string", + "readOnly": true, + "description": "The human-readable status of the container instance state." + } + } + }, + "Event": { + "description": "A container group or container instance event.", + "type": "object", + "readOnly": true, + "properties": { + "count": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the earliest logged event." + }, + "lastTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the latest logged event." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The event name." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The event message." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The event type." + } + } + }, + "ResourceRequirements": { + "description": "The resource requirements.", + "type": "object", + "required": [ + "requests" + ], + "properties": { + "requests": { + "description": "The resource requests of this container instance.", + "$ref": "#/definitions/ResourceRequests" + }, + "limits": { + "description": "The resource limits of this container instance.", + "$ref": "#/definitions/ResourceLimits" + } + } + }, + "ResourceRequests": { + "description": "The resource requests.", + "type": "object", + "required": [ + "memoryInGB", + "cpu" + ], + "properties": { + "memoryInGB": { + "description": "The memory request in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU request of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU request of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "ResourceLimits": { + "description": "The resource limits.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU limit of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU limit of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "GpuResource": { + "description": "The GPU resource.", + "type": "object", + "required": [ + "count", + "sku" + ], + "properties": { + "count": { + "description": "The count of the GPU resource.", + "type": "integer", + "format": "int32" + }, + "sku": { + "type": "string", + "description": "The SKU of the GPU resource.", + "enum": [ + "K80", + "P100", + "V100" + ], + "x-ms-enum": { + "name": "GpuSku", + "modelAsString": true + } + } + } + }, + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "type": "object", + "required": [ + "shareName", + "storageAccountName" + ], + "properties": { + "shareName": { + "description": "The name of the Azure File share to be mounted as a volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the Azure File shared mounted as a volume is read-only.", + "type": "boolean" + }, + "storageAccountName": { + "description": "The name of the storage account that contains the Azure File share.", + "type": "string" + }, + "storageAccountKey": { + "description": "The storage account access key used to access the Azure File share.", + "type": "string" + } + } + }, + "EmptyDirVolume": { + "description": "The empty directory volume.", + "type": "object", + "properties": {} + }, + "SecretVolume": { + "description": "The secret volume.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "GitRepoVolume": { + "description": "Represents a volume that is populated with the contents of a git repository", + "required": [ + "repository" + ], + "properties": { + "directory": { + "description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.", + "type": "string" + }, + "repository": { + "description": "Repository URL", + "type": "string" + }, + "revision": { + "description": "Commit hash for the specified revision.", + "type": "string" + } + } + }, + "Volume": { + "description": "The properties of the volume.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the volume.", + "type": "string" + }, + "azureFile": { + "description": "The Azure File volume.", + "$ref": "#/definitions/AzureFileVolume" + }, + "emptyDir": { + "description": "The empty directory volume.", + "$ref": "#/definitions/EmptyDirVolume" + }, + "secret": { + "description": "The secret volume.", + "$ref": "#/definitions/SecretVolume" + }, + "gitRepo": { + "description": "The git repo volume.", + "$ref": "#/definitions/GitRepoVolume" + } + } + }, + "VolumeMount": { + "description": "The properties of the volume mount.", + "type": "object", + "required": [ + "name", + "mountPath" + ], + "properties": { + "name": { + "description": "The name of the volume mount.", + "type": "string" + }, + "mountPath": { + "description": "The path within the container where the volume should be mounted. Must not contain colon (:).", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume mount is read-only.", + "type": "boolean" + } + } + }, + "ContainerExec": { + "type": "object", + "description": "The container execution command, for liveness or readiness probe", + "properties": { + "command": { + "description": "The commands to execute within the container.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ContainerHttpGet": { + "type": "object", + "description": "The container Http Get settings, for liveness or readiness probe", + "properties": { + "path": { + "description": "The path to probe.", + "type": "string" + }, + "port": { + "type": "integer", + "description": "The port number to probe.", + "format": "int32" + }, + "scheme": { + "description": "The scheme.", + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Scheme", + "modelAsString": true + } + }, + "httpHeaders": { + "description": "The HTTP headers.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpHeader" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "port" + ] + }, + "ContainerProbe": { + "type": "object", + "description": "The container probe, for liveness or readiness", + "properties": { + "exec": { + "description": "The execution command to probe", + "$ref": "#/definitions/ContainerExec" + }, + "httpGet": { + "description": "The Http Get settings to probe", + "$ref": "#/definitions/ContainerHttpGet" + }, + "initialDelaySeconds": { + "description": "The initial delay seconds.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "The period seconds.", + "type": "integer", + "format": "int32" + }, + "failureThreshold": { + "description": "The failure threshold.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "The success threshold.", + "type": "integer", + "format": "int32" + }, + "timeoutSeconds": { + "description": "The timeout seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "ContainerGroup": { + "description": "A container group.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ContainerGroupProperties" + } + ] + }, + "ContainerGroupProperties": { + "description": "The container group properties", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ContainerGroupIdentity", + "description": "The identity of the container group, if configured." + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The container group properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the container group. This only appears in the response." + }, + "containers": { + "type": "array", + "description": "The containers within the container group.", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "imageRegistryCredentials": { + "type": "array", + "description": "The image registry credentials by which the container group is created from.", + "items": { + "$ref": "#/definitions/ImageRegistryCredential" + }, + "x-ms-identifiers": [ + "username" + ] + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n", + "enum": [ + "Always", + "OnFailure", + "Never" + ], + "x-ms-enum": { + "name": "ContainerGroupRestartPolicy", + "modelAsString": true + } + }, + "ipAddress": { + "description": "The IP address type of the container group.", + "$ref": "#/definitions/IpAddress" + }, + "osType": { + "type": "string", + "description": "The operating system type required by the containers in the container group.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "volumes": { + "type": "array", + "description": "The list of volumes that can be mounted by containers in this container group.", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container group. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "events": { + "description": "The events of this container group.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the container group. Only valid in response." + } + } + }, + "diagnostics": { + "description": "The diagnostic information for a container group.", + "$ref": "#/definitions/ContainerGroupDiagnostics" + }, + "subnetIds": { + "type": "array", + "description": "The subnet resource IDs for a container group.", + "items": { + "$ref": "#/definitions/ContainerGroupSubnetId" + } + }, + "dnsConfig": { + "description": "The DNS config information for a container group.", + "$ref": "#/definitions/DnsConfiguration" + }, + "sku": { + "description": "The SKU for a container group.", + "$ref": "#/definitions/ContainerGroupSku" + }, + "encryptionProperties": { + "description": "The encryption properties for a container group.", + "$ref": "#/definitions/EncryptionProperties" + }, + "initContainers": { + "type": "array", + "description": "The init containers for a container group.", + "items": { + "$ref": "#/definitions/InitContainerDefinition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "extensions": { + "type": "array", + "description": "extensions used by virtual kubelet", + "items": { + "$ref": "#/definitions/DeploymentExtensionSpec" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "confidentialComputeProperties": { + "description": "The properties for confidential container group", + "$ref": "#/definitions/ConfidentialComputeProperties" + }, + "priority": { + "type": "string", + "description": "The priority of the container group.", + "enum": [ + "Regular", + "Spot" + ], + "x-ms-enum": { + "name": "ContainerGroupPriority", + "modelAsString": true + } + }, + "containerGroupProfile": { + "description": "The reference container group profile properties.", + "$ref": "#/definitions/ContainerGroupProfileReferenceDefinition" + }, + "standbyPoolProfile": { + "description": "The reference standby pool profile properties.", + "$ref": "#/definitions/StandbyPoolProfileDefinition" + }, + "isCreatedFromStandbyPool": { + "readOnly": true, + "type": "boolean", + "description": "The flag indicating whether the container group is created by standby pool." + } + }, + "required": [ + "containers" + ] + } + } + }, + "ContainerGroupProfileReferenceDefinition": { + "description": "The container group profile reference.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The container group profile reference id.This will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}'." + }, + "revision": { + "type": "integer", + "format": "int32", + "description": "The container group profile reference revision." + } + } + }, + "StandbyPoolProfileDefinition": { + "description": "The standby pool profile reference.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The standby pool profile reference id.This will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyPoolName}'." + }, + "failContainerGroupCreateOnReuseFailure": { + "type": "boolean", + "description": "The flag to determine whether ACI should fail the create request if the container group can not be obtained from standby pool." + } + } + }, + "DeploymentExtensionSpec": { + "description": "Extension sidecars to be added to the deployment.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the extension." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Extension specific properties", + "properties": { + "extensionType": { + "type": "string", + "description": "Type of extension to be added." + }, + "version": { + "type": "string", + "description": "Version of the extension being used." + }, + "settings": { + "type": "object", + "description": "Settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings for the extension." + } + }, + "required": [ + "extensionType", + "version" + ] + } + }, + "required": [ + "name" + ] + }, + "ContainerGroupIdentity": { + "description": "Identity for the container group.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the container group identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the container group. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group.", + "additionalProperties": { + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "$ref": "#/definitions/UserAssignedIdentities" + } + } + } + }, + "UserAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "The Docker image registry server without a protocol such as \"http\" and \"https\"." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry.", + "x-ms-secret": true + }, + "identity": { + "type": "string", + "description": "The identity for the private registry." + }, + "identityUrl": { + "type": "string", + "description": "The identity URL for the private registry." + } + }, + "required": [ + "server" + ] + }, + "ContainerGroupDiagnostics": { + "description": "Container group diagnostic information.", + "type": "object", + "properties": { + "logAnalytics": { + "description": "Container group log analytics information.", + "$ref": "#/definitions/LogAnalytics" + } + } + }, + "LogAnalytics": { + "description": "Container group log analytics information.", + "type": "object", + "properties": { + "workspaceId": { + "description": "The workspace id for log analytics", + "type": "string" + }, + "workspaceKey": { + "description": "The workspace key for log analytics", + "type": "string", + "x-ms-secret": true + }, + "logType": { + "type": "string", + "description": "The log type to be used.", + "enum": [ + "ContainerInsights", + "ContainerInstanceLogs" + ], + "x-ms-enum": { + "name": "LogAnalyticsLogType", + "modelAsString": true + } + }, + "metadata": { + "type": "object", + "description": "Metadata for log analytics.", + "additionalProperties": { + "type": "string" + } + }, + "workspaceResourceId": { + "description": "The workspace resource id for log analytics", + "type": "string", + "x-ms-secret": true + } + }, + "required": [ + "workspaceId", + "workspaceKey" + ] + }, + "ContainerGroupSubnetId": { + "description": "Container group subnet information.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID of virtual network and subnet.", + "type": "string" + }, + "name": { + "description": "Friendly name for the subnet.", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "IpAddress": { + "description": "IP address for the container group.", + "type": "object", + "properties": { + "ports": { + "type": "array", + "description": "The list of ports exposed on the container group.", + "items": { + "$ref": "#/definitions/Port" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "type": { + "type": "string", + "description": "Specifies if the IP is exposed to the public internet or private VNET.", + "enum": [ + "Public", + "Private" + ], + "x-ms-enum": { + "name": "ContainerGroupIpAddressType", + "modelAsString": true + } + }, + "ip": { + "type": "string", + "description": "The IP exposed to the public internet." + }, + "dnsNameLabel": { + "type": "string", + "description": "The Dns name label for the IP." + }, + "autoGeneratedDomainNameLabelScope": { + "type": "string", + "description": "The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant.", + "enum": [ + "Unsecure", + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "Noreuse" + ], + "default": "Unsecure", + "x-ms-enum": { + "name": "dnsNameLabelReusePolicy", + "modelAsString": true + } + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN for the IP." + } + }, + "required": [ + "ports", + "type" + ] + }, + "Port": { + "description": "The port exposed on the container group.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerGroupNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "description": "The port number.", + "format": "int32" + } + }, + "required": [ + "port" + ] + }, + "ContainerPort": { + "description": "The port exposed on the container instance.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number exposed within the container group." + } + }, + "required": [ + "port" + ] + }, + "EnvironmentVariable": { + "description": "The environment variable to set within the container instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + }, + "secureValue": { + "type": "string", + "description": "The value of the secure environment variable.", + "x-ms-secret": true + } + }, + "required": [ + "name" + ] + }, + "OperationListResult": { + "description": "The operation list response that contains all operations for Azure Container Instance service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of operations." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of operations." + } + } + }, + "Operation": { + "description": "An operation for Azure Container Instance service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "description": "The display information of the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The name of the provider of the operation.", + "type": "string" + }, + "resource": { + "type": "string", + "description": "The name of the resource type of the operation." + }, + "operation": { + "description": "The friendly name of the operation.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "type": "object", + "description": "The additional properties.", + "x-ms-client-flatten": true + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "ContainerInstanceOperationsOrigin", + "modelAsString": true + } + } + }, + "required": [ + "name", + "display" + ] + }, + "UsageListResult": { + "description": "The response containing the usage data", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "The usage data.", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Usage": { + "description": "A single usage result", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the usage result" + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "Unit of the usage result" + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The current usage of the resource" + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "type": "object", + "description": "The name object of the resource", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource" + } + } + } + } + }, + "ContainerGroupListResult": { + "description": "The container group list response that contains the container group properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroup" + }, + "description": "The list of container groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of container groups." + } + } + }, + "Logs": { + "description": "The logs.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the log." + } + } + }, + "ContainerExecRequest": { + "description": "The container exec request.", + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to be executed." + }, + "terminalSize": { + "type": "object", + "description": "The size of the terminal.", + "properties": { + "rows": { + "type": "integer", + "format": "int32", + "description": "The row size of the terminal" + }, + "cols": { + "type": "integer", + "format": "int32", + "description": "The column size of the terminal" + } + } + } + } + }, + "ContainerExecResponse": { + "description": "The information for the container exec command.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the exec websocket." + }, + "password": { + "type": "string", + "description": "The password to start the exec command.", + "x-ms-secret": true + } + } + }, + "ContainerAttachResponse": { + "description": "The information for the output stream from container attach.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the output stream from the attach." + }, + "password": { + "type": "string", + "description": "The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri.", + "x-ms-secret": true + } + } + }, + "HttpHeader": { + "description": "The HTTP header.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The header name." + }, + "value": { + "type": "string", + "description": "The header value." + } + } + }, + "DnsConfiguration": { + "description": "DNS configuration for the container group.", + "type": "object", + "required": [ + "nameServers" + ], + "properties": { + "nameServers": { + "description": "The DNS servers for the container group.", + "type": "array", + "items": { + "type": "string" + } + }, + "searchDomains": { + "description": "The DNS search domains for hostname lookup in the container group.", + "type": "string" + }, + "options": { + "description": "The DNS options for the container group.", + "type": "string" + } + } + }, + "Resource": { + "type": "object", + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "zones": { + "description": "The zones for the container group.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CachedImagesListResult": { + "description": "The response containing cached images.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/cachedImages" + }, + "x-ms-identifiers": [ + "image" + ], + "description": "The list of cached images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of cached images." + } + } + }, + "cachedImages": { + "description": "The cached image and OS type.", + "type": "object", + "required": [ + "osType", + "image" + ], + "properties": { + "osType": { + "type": "string", + "description": "The OS type of the cached image." + }, + "image": { + "type": "string", + "description": "The cached image name." + } + } + }, + "CapabilitiesListResult": { + "description": "The response containing list of capabilities.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Capabilities" + }, + "x-ms-identifiers": [ + "resourceType", + "location" + ], + "description": "The list of capabilities." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capabilities." + } + } + }, + "Capabilities": { + "description": "The regional capabilities.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The resource type that this capability describes." + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The OS type that this capability describes." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The resource location." + }, + "ipAddressType": { + "type": "string", + "readOnly": true, + "description": "The ip address type that this capability describes." + }, + "gpu": { + "type": "string", + "readOnly": true, + "description": "The GPU sku that this capability describes." + }, + "capabilities": { + "type": "object", + "readOnly": true, + "description": "The supported capabilities.", + "properties": { + "maxMemoryInGB": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed memory request in GB." + }, + "maxCpu": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed CPU request in cores." + }, + "maxGpuCount": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed GPU count." + } + } + } + } + }, + "ContainerGroupSku": { + "description": "The container group SKU.", + "type": "string", + "enum": [ + "Standard", + "Dedicated", + "Confidential" + ], + "x-ms-enum": { + "name": "ContainerGroupSku", + "modelAsString": true + } + }, + "EncryptionProperties": { + "description": "The container group encryption properties.", + "type": "object", + "properties": { + "vaultBaseUrl": { + "description": "The keyvault base url.", + "type": "string" + }, + "keyName": { + "description": "The encryption key name.", + "type": "string" + }, + "keyVersion": { + "description": "The encryption key version.", + "type": "string" + }, + "identity": { + "type": "string", + "description": "The keyvault managed identity." + } + }, + "required": [ + "vaultBaseUrl", + "keyName", + "keyVersion" + ] + }, + "InitContainerDefinition": { + "description": "The init container definition.", + "type": "object", + "properties": { + "name": { + "description": "The name for the init container.", + "type": "string" + }, + "properties": { + "description": "The properties for the init container.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InitContainerPropertiesDefinition" + } + }, + "required": [ + "name", + "properties" + ] + }, + "InitContainerPropertiesDefinition": { + "description": "The init container definition properties.", + "type": "object", + "properties": { + "image": { + "description": "The image of the init container.", + "type": "string" + }, + "command": { + "description": "The command to execute within the init container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the init container. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the init container has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "The current state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "The previous state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "volumeMounts": { + "description": "The volume mounts available to the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container Instance service." + }, + "NetworkDependenciesResponse": { + "description": "Response for network dependencies, always empty list.", + "type": "array", + "items": { + "type": "string" + } + }, + "ConfidentialComputeProperties": { + "description": "The properties for confidential container group", + "type": "object", + "properties": { + "ccePolicy": { + "type": "string", + "description": "The base64 encoded confidential compute enforcement policy" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier for the physical azure location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ContainerGroupNameParameter": { + "name": "containerGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container group.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "SubnetNameParameter": { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet.", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CachedImagesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CachedImagesList.json new file mode 100644 index 000000000000..ddc3207b60f4 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CachedImagesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "image": "ubuntu:16.04" + }, + { + "osType": "Linux", + "image": "alpine:3.6" + }, + { + "osType": "Windows", + "image": "microsoft/nanoserver:10.0.14393.2485" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CapabilitiesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CapabilitiesList.json new file mode 100644 index 000000000000..9bbdbe7194fe --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/CapabilitiesList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westus", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "containerGroups", + "osType": "Linux", + "location": "West US", + "ipAddressType": "Public", + "gpu": "K80", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 4 + } + }, + { + "resourceType": "containerGroups", + "osType": "Windows", + "location": "West US", + "ipAddressType": "Public", + "gpu": "None", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerAttach.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerAttach.json new file mode 100644 index 000000000000..f3c9cb70238f --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerAttach.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1" + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerExec.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerExec.json new file mode 100644 index 000000000000..ec34b861e41c --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerExec.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "containerExecRequest": { + "command": "/bin/bash", + "terminalSize": { + "rows": 12, + "cols": 12 + } + } + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateConfidential.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateConfidential.json new file mode 100644 index 000000000000..20e44336b9dc --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateConfidential.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "westeurope", + "properties": { + "containers": [ + { + "name": "accdemo", + "properties": { + "command": [], + "environmentVariables": [], + "image": "confiimage", + "ports": [ + { + "port": 8000 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "osType": "Linux", + "sku": "Confidential", + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Confidential", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + }, + "201": { + "body": { + "properties": { + "sku": "Confidential", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateOrUpdateStandbyPool.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateOrUpdateStandbyPool.json new file mode 100644 index 000000000000..085e2cea968f --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupCreateOrUpdateStandbyPool.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "configMap": { + "keyValuePairs": { + "Newkey": "value" + } + } + } + } + ], + "containerGroupProfile": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/democgp", + "revision": 1 + }, + "standbyPoolProfile": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.StandbyPool/standbyContainerGroupPools/demopool" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "isCreatedFromStandbyPool": true, + "provisioningState": "Succeeded", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "configMap": { + "keyValuePairs": { + "Newkey": "value" + } + }, + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "containerGroupProfile": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/democgp", + "revision": 1 + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + } + }, + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "isCreatedFromStandbyPool": true, + "provisioningState": "Succeeded", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "configMap": { + "keyValuePairs": { + "Newkey": "value" + } + }, + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "containerGroupProfile": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroupProfiles/democgp", + "revision": 1 + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + } + }, + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupEncryptionProperties.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupEncryptionProperties.json new file mode 100644 index 000000000000..8467e64e2862 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupEncryptionProperties.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net", + "keyName": "test-key", + "keyVersion": "", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "isCreatedFromStandbyPool": false, + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "", + "clientId": "" + } + }, + "tenantId": "", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "isCreatedFromStandbyPool": false, + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "key version", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Running", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "", + "clientId": "" + } + }, + "tenantId": "", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupExtensions.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupExtensions.json new file mode 100644 index 000000000000..9a0c24e8b93d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupExtensions.json @@ -0,0 +1,210 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Private" + }, + "osType": "Linux", + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + }, + "protectedSettings": { + "kubeConfig": "" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "isCreatedFromStandbyPool": false, + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "isCreatedFromStandbyPool": false, + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupUsage.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupUsage.json new file mode 100644 index 000000000000..a03657bca6d5 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 1, + "limit": 2000, + "name": { + "value": "ContainerGroups", + "localizedValue": "Container Groups" + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreateOrUpdate.json new file mode 100644 index 000000000000..27afd2512667 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreateOrUpdate.json @@ -0,0 +1,318 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "subnetIds": [ + { + "id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]" + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKey": "accountKey" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64", + "secretKey2": "SecretValue2InBase64" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ] + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreatePriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreatePriority.json new file mode 100644 index 000000000000..c6f3d9569a5d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsCreatePriority.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerGroup": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "restartPolicy": "Never", + "osType": "Linux", + "priority": "Spot" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "isCreatedFromStandbyPool": false, + "provisioningState": "Created", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Created" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsDelete.json new file mode 100644 index 000000000000..0eb2d6b600c5 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsDelete.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGetPriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGetPriority.json new file mode 100644 index 000000000000..f73660bdea3c --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGetPriority.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Terminated", + "startTime": "2022-11-11T19:33:44.217Z", + "exitCode": 0, + "finishTime": "2022-11-11T19:33:55.565Z", + "detailStatus": "Completed" + }, + "events": [ + { + "count": 2, + "firstTimestamp": "2022-11-11T19:28:22Z", + "lastTimestamp": "2022-11-11T19:32:09Z", + "name": "Pulling", + "message": "pulling image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 2, + "firstTimestamp": "2022-11-11T19:32:08Z", + "lastTimestamp": "2022-11-11T19:32:38Z", + "name": "Pulled", + "message": "Successfully pulled image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2022-11-11T19:33:44Z", + "lastTimestamp": "2022-11-11T19:33:44Z", + "name": "Started", + "message": "Started container", + "type": "Normal" + } + ] + }, + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Failed.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Failed.json new file mode 100644 index 000000000000..5ff099014ec8 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Failed.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Waiting", + "startTime": "2017-08-08T00:09:10Z", + "detailStatus": "" + }, + "events": [ + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:01Z", + "lastTimestamp": "2017-08-08T00:09:01Z", + "message": "pulling image \"nginx\"", + "name": "Pulling", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:10Z", + "lastTimestamp": "2017-08-08T00:09:10Z", + "message": "Successfully pulled image \"nginx\"", + "name": "Pulled", + "type": "Normal" + } + ] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "instanceView": { + "events": [ + { + "count": 1, + "firstTimestamp": "2017-10-08T00:19:10Z", + "lastTimestamp": "2017-10-08T00:19:10Z", + "message": "Output: mount error(2): Permission denied", + "name": "FailedMount", + "type": "Normal" + } + ], + "state": "Pending" + }, + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "isCreatedFromStandbyPool": false, + "provisioningState": "Failed", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Succeeded.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Succeeded.json new file mode 100644 index 000000000000..f2d852a5abf9 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsGet_Succeeded.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsList.json new file mode 100644 index 000000000000..ce9a903fbd5d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsList.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Running", + "startTime": "2017-10-17T17:27:21Z", + "detailStatus": "" + }, + "events": [] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsListByResourceGroup.json new file mode 100644 index 000000000000..ef1d03323719 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsListByResourceGroup.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsRestart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsRestart.json new file mode 100644 index 000000000000..54427e59496a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsRestart.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStart.json new file mode 100644 index 000000000000..21c6cba5a581 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStop.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStop.json new file mode 100644 index 000000000000..54427e59496a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsStop.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsUpdate.json new file mode 100644 index 000000000000..7cc8f8cd6da0 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerGroupsUpdate.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demoResource", + "containerGroupName": "demo1", + "Resource": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "isCreatedFromStandbyPool": false, + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + } + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerListLogs.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerListLogs.json new file mode 100644 index 000000000000..893324e87a3d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/ContainerListLogs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "tail": 10 + }, + "responses": { + "200": { + "body": { + "content": "log content" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/OperationsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..14c7cf61df99 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/OperationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerInstance/containerGroups/read", + "display": { + "provider": "Microsoft Container Instance", + "resource": "Container Group", + "operation": "Get Container Groups", + "description": "Get all container goups." + }, + "origin": "User" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/SubnetServiceAssociationLinkDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/SubnetServiceAssociationLinkDelete.json new file mode 100644 index 000000000000..dd958037e751 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/examples/SubnetServiceAssociationLinkDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-05-01-preview", + "resourceGroupName": "demo", + "virtualNetworkName": "demo2", + "subnetName": "demo3" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 4b07ceb2e8a4..6c4d309167c1 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the ContainerInstance API. ``` yaml openapi-type: arm -tag: package-2023-05 +tag: package-preview-2024-05 +``` + +### Tag: package-preview-2024-05 + +These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-05' +input-file: + - Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json ``` ### Tag: package-2023-05 @@ -198,6 +207,13 @@ directive: - suppress: UniqueResourcePaths from: containerInstance.json reason: false positive, see https://github.com/Azure/azure-openapi-validator/issues/176 +suppressions: + - code: AvoidAdditionalProperties + reason: Using additionalProperties type as the object is user-defined and not subject to any validations at RP level. + from: + - containerInstance.json + where: + - $.definitions.ConfigMap.properties.keyValuePairs ``` --- From c28640102e994513192bc17863eec5968b0057d5 Mon Sep 17 00:00:00 2001 From: iscai-msft <43154838+iscai-msft@users.noreply.github.com> Date: Wed, 26 Jun 2024 18:31:16 -0400 Subject: [PATCH 246/343] use body root to specify which parameter models we want to keep grouped (#29483) * add ops.ResourceCollectionAction KeepModel * add ops.ResourceAction KeepModel * add ops.LongRunningResourceAction KeepModel * other templates * switch over to BodyParameter * format * use valueof in BodyParameter template, add doc * remove unnecessary documentation * add doc to BodyParameter template * add extra specs * fix formatting of BodyParameter * format * format * format * suppress doc warning * move body parameter to template * add default body parameter doc * default bodyparam doc to body parameter * fix validation errors * remove bodyparameter from codetransparency * try for openai * remove incorrect alias bodyparameter * don't spread CreateLivenessWithVerifySessionContent * fix breaking change in easm * add readme to openai assistants * update readme * add tag to readme * fix json file reference * add json files to list --------- Co-authored-by: iscai-msft Co-authored-by: Mark Cowlishaw --- specification/ai/Face/models.common.tsp | 11 + specification/ai/Face/routes.session.tsp | 4 +- .../model.common.shared.tsp | 11 + .../route.oncophenotype.tsp | 2 +- .../route.patienttimeline.tsp | 2 +- .../route.trialmatcher.tsp | 2 +- .../OpenAI.Assistants/assistants/routes.tsp | 4 +- .../ai/OpenAI.Assistants/common/models.tsp | 11 + .../ai/OpenAI.Assistants/runs/routes.tsp | 2 +- .../ai/OpenAI.Assistants/threads/routes.tsp | 8 +- .../vector_stores/routes.tsp | 2 +- .../Face/preview/v1.1-preview.1/Face.json | 2 + .../assistants_generated.json | 36 +- .../assistants_generated.json | 37 +- .../assistants_generated.yaml | 34 +- .../assistants_generated.yaml | 35 +- specification/ai/data-plane/readme.md | 78 +++ .../models/completions/common.tsp | 2 + .../models/embeddings_create.tsp | 11 + .../routes/audio_transcription.tsp | 4 +- .../routes/audio_translation.tsp | 4 +- .../OpenAI.Inference/routes/completions.tsp | 2 +- .../OpenAI.Inference/routes/embeddings.tsp | 2 +- .../OpenAI.Inference/routes/images.tsp | 4 +- .../preview/2023-06-01-preview/generated.json | 3 + .../preview/2023-07-01-preview/generated.json | 3 + .../preview/2024-02-15-preview/generated.json | 503 +++++++++------ .../preview/2024-03-01-preview/generated.json | 503 +++++++++------ .../preview/2024-04-01-preview/generated.json | 604 +++++++++++------- .../preview/2024-05-01-preview/generated.json | 604 +++++++++++------- .../stable/2022-12-01/generated.json | 2 + .../stable/2023-05-15/generated.json | 2 + .../Communication.Messages/models.tsp | 11 + .../Communication.Messages/routes.tsp | 2 +- .../communicationservicesmessages.json | 1 + .../DeveloperSigning/main.tsp | 13 +- .../azure.developer.signing.json | 1 + .../apis/common.tsp | 11 + .../apis/location.tsp | 2 +- .../apis/network.tsp | 2 +- .../apis/number.tsp | 4 +- .../apis/simswap.tsp | 4 +- .../preview/2024-02-09-preview/openapi.json | 6 + .../models.tsp | 11 + .../routes.tsp | 6 +- .../stable/2023-09-01/purviewdatamap.json | 3 + specification/riskiq/Easm/models.tsp | 11 + specification/riskiq/Easm/routes.tsp | 22 +- .../preview/2023-03-01-preview/easm.json | 5 + .../preview/2024-03-01-preview/easm.json | 11 + .../VoiceServices.Provisioning/main.tsp | 25 +- .../preview/2024-02-29-preview/swagger.json | 3 + 52 files changed, 1656 insertions(+), 1032 deletions(-) create mode 100644 specification/ai/data-plane/readme.md diff --git a/specification/ai/Face/models.common.tsp b/specification/ai/Face/models.common.tsp index 4eb0c1e70ae0..e99fe295e601 100644 --- a/specification/ai/Face/models.common.tsp +++ b/specification/ai/Face/models.common.tsp @@ -294,3 +294,14 @@ model FaceError { } model FaceErrorResponse is Azure.Core.Foundations.ErrorResponseBase; + +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; diff --git a/specification/ai/Face/routes.session.tsp b/specification/ai/Face/routes.session.tsp index 70b492cdb31b..4c5c59085f75 100644 --- a/specification/ai/Face/routes.session.tsp +++ b/specification/ai/Face/routes.session.tsp @@ -69,7 +69,7 @@ interface LivenessSessionOperations { @returnsDoc(SessionCreationSuccess) createLivenessSession is FaceResourceCreateWithServiceProvidedName< LivenessSession, - CreateLivenessSessionContent, + BodyParameter, CreateLivenessSessionResult >; @@ -118,7 +118,7 @@ interface LivenessSessionOperations { @sharedRoute createLivenessWithVerifySession is FaceResourceCreateWithServiceProvidedName< LivenessWithVerifySession, - CreateLivenessSessionContent, + BodyParameter, CreateLivenessWithVerifySessionResult >; diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp index a316c356a25f..e7829bde8c95 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp @@ -229,3 +229,14 @@ model ClinicalCodedElement { @doc("A value associated with the code within the given clinical coding system.") value?: string; } + +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp index f60da4e7484a..3bcfdf2454b3 100644 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp @@ -19,7 +19,7 @@ interface OncoPhenotype { @doc("Gets the status and details of the Onco Phenotype job.") @get @route("/onco-phenotype/jobs/{id}") - getJob is HealthInsightsLongRunningPollOperation; + getJob is HealthInsightsLongRunningPollOperation>; #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp index 1514a76dbe88..bbb9c165dd4e 100644 --- a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp +++ b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp @@ -19,7 +19,7 @@ interface PatientTimeline { @doc("Gets the status and details of the Patient Timeline job.") @get @route("/patient-timeline/jobs/{id}") - getJob is HealthInsightsLongRunningPollOperation; + getJob is HealthInsightsLongRunningPollOperation>; #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp index 7f31371b01c9..4e627e65e67c 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp @@ -18,7 +18,7 @@ interface TrialMatcher { @doc("Gets the status and details of the Trial Matcher job.") @get @route("/trial-matcher/jobs/{id}") - getJob is HealthInsightsLongRunningPollOperation; + getJob is HealthInsightsLongRunningPollOperation>; #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" diff --git a/specification/ai/OpenAI.Assistants/assistants/routes.tsp b/specification/ai/OpenAI.Assistants/assistants/routes.tsp index cdefb9fd6aa5..e8746c12abf6 100644 --- a/specification/ai/OpenAI.Assistants/assistants/routes.tsp +++ b/specification/ai/OpenAI.Assistants/assistants/routes.tsp @@ -20,7 +20,7 @@ namespace Azure.AI.OpenAI.Assistants; @post @added(ServiceApiVersions.v2024_02_15_preview) @route("/assistants") -op createAssistant(...AssistantCreationOptions): Assistant; +op createAssistant(...BodyParameter): Assistant; /** * Gets a list of assistants that were previously created. @@ -63,7 +63,7 @@ op getAssistant(@path assistantId: string): Assistant; @post @route("/assistants/{assistantId}") @added(ServiceApiVersions.v2024_02_15_preview) -op updateAssistant(...UpdateAssistantOptions): Assistant; +op updateAssistant(...BodyParameter): Assistant; /** * Deletes an assistant. diff --git a/specification/ai/OpenAI.Assistants/common/models.tsp b/specification/ai/OpenAI.Assistants/common/models.tsp index 5c446a1d1d42..85fb2d648611 100644 --- a/specification/ai/OpenAI.Assistants/common/models.tsp +++ b/specification/ai/OpenAI.Assistants/common/models.tsp @@ -148,3 +148,14 @@ union ApiResponseFormat { /** Using `json_object` format will limit the usage of ToolCall to only functions. */ jsonObject: "json_object", } + +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; diff --git a/specification/ai/OpenAI.Assistants/runs/routes.tsp b/specification/ai/OpenAI.Assistants/runs/routes.tsp index c65c2d07fa06..45847257a2e7 100644 --- a/specification/ai/OpenAI.Assistants/runs/routes.tsp +++ b/specification/ai/OpenAI.Assistants/runs/routes.tsp @@ -139,4 +139,4 @@ op cancelRun(@path threadId: string, @path runId: string): ThreadRun; @route("/threads/runs") @doc("Creates a new assistant thread and immediately starts a run using that new thread.") @added(ServiceApiVersions.v2024_02_15_preview) -op createThreadAndRun(...CreateAndRunThreadOptions): ThreadRun; +op createThreadAndRun(...BodyParameter): ThreadRun; diff --git a/specification/ai/OpenAI.Assistants/threads/routes.tsp b/specification/ai/OpenAI.Assistants/threads/routes.tsp index 53dbc7fa16de..2f06aacfb89d 100644 --- a/specification/ai/OpenAI.Assistants/threads/routes.tsp +++ b/specification/ai/OpenAI.Assistants/threads/routes.tsp @@ -20,7 +20,9 @@ namespace Azure.AI.OpenAI.Assistants; @post @added(ServiceApiVersions.v2024_02_15_preview) @route("/threads") -op createThread(...AssistantThreadCreationOptions): AssistantThread; +op createThread( + ...BodyParameter, +): AssistantThread; // list threads? @@ -52,7 +54,9 @@ op getThread(@path threadId: string): AssistantThread; @post @route("/threads/{threadId}") @added(ServiceApiVersions.v2024_02_15_preview) -op updateThread(...UpdateAssistantThreadOptions): AssistantThread; +op updateThread( + ...BodyParameter, +): AssistantThread; /** * Deletes an existing thread. diff --git a/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp index a01dae88426f..da0395283ad6 100644 --- a/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp +++ b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp @@ -34,7 +34,7 @@ op listVectorStores( @post @route("/vector_stores") @added(ServiceApiVersions.v2024_05_01_preview) -op createVectorStore(...VectorStoreOptions): VectorStore; +op createVectorStore(...BodyParameter): VectorStore; /** * Returns the vector store object matching the specified ID. diff --git a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json index 7f17cd879a5f..f5f77b5d0d1b 100644 --- a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json +++ b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json @@ -408,6 +408,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CreateLivenessSessionContent" @@ -5846,6 +5847,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CreateLivenessSessionContent" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index e1a20fe445e2..6e871cf81b9c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -174,6 +174,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssistantCreationOptions" @@ -217,11 +218,16 @@ "description": "Modifies an existing assistant.", "parameters": [ { - "$ref": "#/parameters/UpdateAssistantOptions.assistantId" + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to modify.", + "required": true, + "type": "string" }, { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/UpdateAssistantOptions" @@ -460,6 +466,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssistantThreadCreationOptions" @@ -503,11 +510,16 @@ "description": "Modifies an existing thread.", "parameters": [ { - "$ref": "#/parameters/UpdateAssistantThreadOptions.threadId" + "name": "threadId", + "in": "path", + "description": "The ID of the thread to modify.", + "required": true, + "type": "string" }, { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/UpdateAssistantThreadOptions" @@ -1235,6 +1247,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CreateAndRunThreadOptions" @@ -3181,22 +3194,5 @@ } } }, - "parameters": { - "UpdateAssistantOptions.assistantId": { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to modify.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "UpdateAssistantThreadOptions.threadId": { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to modify.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } + "parameters": {} } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index b0fe2a911183..5fcda9a56c31 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -174,6 +174,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssistantCreationOptions" @@ -217,11 +218,16 @@ "description": "Modifies an existing assistant.", "parameters": [ { - "$ref": "#/parameters/UpdateAssistantOptions.assistantId" + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to modify.", + "required": true, + "type": "string" }, { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/UpdateAssistantOptions" @@ -496,6 +502,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssistantThreadCreationOptions" @@ -539,11 +546,16 @@ "description": "Modifies an existing thread.", "parameters": [ { - "$ref": "#/parameters/UpdateAssistantThreadOptions.threadId" + "name": "threadId", + "in": "path", + "description": "The ID of the thread to modify.", + "required": true, + "type": "string" }, { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/UpdateAssistantThreadOptions" @@ -1287,6 +1299,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CreateAndRunThreadOptions" @@ -1418,6 +1431,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/VectorStoreOptions" @@ -5172,22 +5186,5 @@ } } }, - "parameters": { - "UpdateAssistantOptions.assistantId": { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to modify.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "UpdateAssistantThreadOptions.threadId": { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to modify.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } + "parameters": {} } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index 5d101eb1cb50..50ff2a97ab68 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -18,6 +18,7 @@ paths: schema: $ref: '#/components/schemas/Assistant' requestBody: + description: Body parameter. required: true content: application/json: @@ -110,7 +111,12 @@ paths: operationId: updateAssistant description: Modifies an existing assistant. parameters: - - $ref: '#/components/parameters/UpdateAssistantOptions.assistantId' + - name: assistantId + in: path + required: true + description: The ID of the assistant to modify. + schema: + type: string responses: '200': description: The updated assistant instance. @@ -119,6 +125,7 @@ paths: schema: $ref: '#/components/schemas/Assistant' requestBody: + description: Body parameter. required: true content: application/json: @@ -257,6 +264,7 @@ paths: schema: $ref: '#/components/schemas/AssistantThread' requestBody: + description: Body parameter. required: true content: application/json: @@ -275,6 +283,7 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: + description: Body parameter. required: true content: application/json: @@ -302,7 +311,12 @@ paths: operationId: updateThread description: Modifies an existing thread. parameters: - - $ref: '#/components/parameters/UpdateAssistantThreadOptions.threadId' + - name: threadId + in: path + required: true + description: The ID of the thread to modify. + schema: + type: string responses: '200': description: Information about the modified thread. @@ -311,6 +325,7 @@ paths: schema: $ref: '#/components/schemas/AssistantThread' requestBody: + description: Body parameter. required: true content: application/json: @@ -817,21 +832,6 @@ security: - OAuth2Auth: - https://cognitiveservices.azure.com/.default components: - parameters: - UpdateAssistantOptions.assistantId: - name: assistantId - in: path - required: true - description: The ID of the assistant to modify. - schema: - type: string - UpdateAssistantThreadOptions.threadId: - name: threadId - in: path - required: true - description: The ID of the thread to modify. - schema: - type: string schemas: Assistant: type: object diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index bb72844194ac..e7a6f9691f97 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -18,6 +18,7 @@ paths: schema: $ref: '#/components/schemas/Assistant' requestBody: + description: Body parameter. required: true content: application/json: @@ -110,7 +111,12 @@ paths: operationId: updateAssistant description: Modifies an existing assistant. parameters: - - $ref: '#/components/parameters/UpdateAssistantOptions.assistantId' + - name: assistantId + in: path + required: true + description: The ID of the assistant to modify. + schema: + type: string responses: '200': description: The updated assistant instance. @@ -119,6 +125,7 @@ paths: schema: $ref: '#/components/schemas/Assistant' requestBody: + description: Body parameter. required: true content: application/json: @@ -257,6 +264,7 @@ paths: schema: $ref: '#/components/schemas/AssistantThread' requestBody: + description: Body parameter. required: true content: application/json: @@ -275,6 +283,7 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: + description: Body parameter. required: true content: application/json: @@ -302,7 +311,12 @@ paths: operationId: updateThread description: Modifies an existing thread. parameters: - - $ref: '#/components/parameters/UpdateAssistantThreadOptions.threadId' + - name: threadId + in: path + required: true + description: The ID of the thread to modify. + schema: + type: string responses: '200': description: Information about the modified thread. @@ -311,6 +325,7 @@ paths: schema: $ref: '#/components/schemas/AssistantThread' requestBody: + description: Body parameter. required: true content: application/json: @@ -903,6 +918,7 @@ paths: schema: $ref: '#/components/schemas/VectorStore' requestBody: + description: Body parameter. required: true content: application/json: @@ -1293,21 +1309,6 @@ security: - OAuth2Auth: - https://cognitiveservices.azure.com/.default components: - parameters: - UpdateAssistantOptions.assistantId: - name: assistantId - in: path - required: true - description: The ID of the assistant to modify. - schema: - type: string - UpdateAssistantThreadOptions.threadId: - name: threadId - in: path - required: true - description: The ID of the thread to modify. - schema: - type: string schemas: ApiResponseFormat: anyOf: diff --git a/specification/ai/data-plane/readme.md b/specification/ai/data-plane/readme.md new file mode 100644 index 000000000000..7abc736f3437 --- /dev/null +++ b/specification/ai/data-plane/readme.md @@ -0,0 +1,78 @@ +# OpenAI + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for OpenAI. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the [OpenAI]. + +```yaml +openapi-type: data-plane +tag: package-2023-11-06-beta +``` + +### Tag: package-2023-11-06-beta + +These settings apply only when `--tag=package-2023-11-06-beta` is specified on the command line. + +```yaml $(tag) == 'package-2023-11-06-beta' +input-file: + - OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json + - OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json +``` + +### Tag: package-2023-02-15-preview + +These settings apply only when `--tag=package-2023-02-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-02-15-preview' +input-file: + - OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json +``` + +### Tag: package-2024-02-15-preview + +These settings apply only when `--tag=package-2024-02-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-02-15-preview' +input-file: + - OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +``` + +### Tag: package-2024-05-01-preview + +These settings apply only when `--tag=package-2024-05-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-05-01-preview' +input-file: + - OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +``` + +### Suppression + +``` yaml +directive: + - suppress: XMS_EXAMPLE_NOTFOUND_ERROR + from: assistants_generated.json + reason: No existing examples. + - suppress: UNREFERENCED_JSON_FILE + from: +``` diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp index 3afebd183971..219388cff428 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp @@ -1,7 +1,9 @@ import "@typespec/versioning"; +import "@typespec/http"; import "@azure-tools/typespec-azure-core"; using TypeSpec.Versioning; +using Http; namespace Azure.OpenAI; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp index eddaa1cb4b5a..e698a2f1d70f 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp @@ -102,3 +102,14 @@ model EmbeddingsUsage { @encodedName("application/json", "total_tokens") totalTokens: int32; } + +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp index 6a3fab3d6e9c..265ba7cedba0 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp @@ -28,7 +28,7 @@ namespace Azure.OpenAI; @sharedRoute op getAudioTranscriptionAsPlainText is Azure.Core.ResourceAction< Deployment, - AudioTranscriptionOptions, // response_format must be one of: text, srt, vtt + BodyParameter, AudioTextResponse, MultipartFormDataRequestHeadersTraits & TextPlainResponseHeadersTraits >; @@ -44,7 +44,7 @@ op getAudioTranscriptionAsPlainText is Azure.Core.ResourceAction< @sharedRoute op getAudioTranscriptionAsResponseObject is Azure.Core.ResourceAction< Deployment, - AudioTranscriptionOptions, // response_format must be unspecified (json) or one of: json, verbose_json + BodyParameter, // response_format must be unspecified (json) or one of: json, verbose_json AudioTranscription, MultipartFormDataRequestHeadersTraits >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp index 0f36637e5964..18cf4a1d1c11 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp @@ -27,7 +27,7 @@ namespace Azure.OpenAI; @sharedRoute op getAudioTranslationAsPlainText is Azure.Core.ResourceAction< Deployment, - AudioTranslationOptions, // response_format must be one of: text, srt, vtt + BodyParameter, AudioTextResponse, MultipartFormDataRequestHeadersTraits & TextPlainResponseHeadersTraits >; @@ -42,7 +42,7 @@ op getAudioTranslationAsPlainText is Azure.Core.ResourceAction< @sharedRoute op getAudioTranslationAsResponseObject is Azure.Core.ResourceAction< Deployment, - AudioTranslationOptions, // response_format must be unspecified (json) or one of: json, verbose_json + BodyParameter, // response_format must be unspecified (json) or one of: json, verbose_json AudioTranslation, MultipartFormDataRequestHeadersTraits >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp index 284b0842ca5d..3b138d588587 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp @@ -23,7 +23,7 @@ namespace Azure.OpenAI; @action("completions") //@convenientAPI(true) op getCompletions is Azure.Core.ResourceAction< Deployment, - CompletionsOptions, + BodyParameter, Completions >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/embeddings.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/embeddings.tsp index 20afaa954d04..ecb49b09e4b1 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/embeddings.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/embeddings.tsp @@ -18,6 +18,6 @@ namespace Azure.OpenAI; @action("embeddings") //@convenientAPI(true) op getEmbeddings is Azure.Core.ResourceAction< Deployment, - EmbeddingsOptions, + BodyParameter, Embeddings >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp index 0f09b3f185bc..b0fcec522f40 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp @@ -20,7 +20,7 @@ namespace Azure.OpenAI; @action("images/generations") op getImageGenerations is Azure.Core.ResourceAction< Deployment, - ImageGenerationOptions, + BodyParameter, ImageGenerations >; @@ -54,7 +54,7 @@ op getAzureBatchImageGenerationOperationStatus is RpcOperation< } ) op beginAzureBatchImageGeneration is OaiLongRunningRpcOperation< - ImageGenerationOptions, + BodyParameter, BatchImageGenerationOperationResponse, BatchImageGenerationOperationResponse >; diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json index cb97b483ca84..08007691cc3a 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json @@ -128,6 +128,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" @@ -179,6 +180,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" @@ -223,6 +225,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ImageGenerationOptions" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json index 9230cd3ea16a..dfd0dcdce0b0 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json @@ -128,6 +128,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" @@ -179,6 +180,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" @@ -223,6 +225,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ImageGenerationOptions" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json index 43de460be08c..0fb1618e5c07 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json @@ -137,25 +137,93 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.language" + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" } ], "responses": { @@ -208,22 +276,86 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranslationOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranslationOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranslationOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" } ], "responses": { @@ -343,6 +475,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" @@ -394,6 +527,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" @@ -445,6 +579,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ImageGenerationOptions" @@ -499,25 +634,93 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.language" + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" } ], "responses": { @@ -566,22 +769,86 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranslationOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranslationOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranslationOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" } ], "responses": { @@ -4014,190 +4281,6 @@ } }, "parameters": { - "AudioTranscriptionOptions.file": { - "name": "file", - "in": "formData", - "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.filename": { - "name": "filename", - "in": "formData", - "description": "The optional filename or descriptive identifier to associate with with the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.language": { - "name": "language", - "in": "formData", - "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.model": { - "name": "model", - "in": "formData", - "description": "The model to use for this transcription request.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.prompt": { - "name": "prompt", - "in": "formData", - "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.responseFormat": { - "name": "response_format", - "in": "formData", - "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", - "required": false, - "type": "string", - "enum": [ - "json", - "verbose_json", - "text", - "srt", - "vtt" - ], - "x-ms-enum": { - "name": "AudioTranscriptionFormat", - "modelAsString": true, - "values": [ - { - "name": "json", - "value": "json", - "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." - }, - { - "name": "verbose_json", - "value": "verbose_json", - "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." - }, - { - "name": "text", - "value": "text", - "description": "Use a response body that is plain text containing the raw, unannotated transcription." - }, - { - "name": "srt", - "value": "srt", - "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." - }, - { - "name": "vtt", - "value": "vtt", - "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "responseFormat" - }, - "AudioTranscriptionOptions.temperature": { - "name": "temperature", - "in": "formData", - "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", - "required": false, - "type": "number", - "format": "float", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.file": { - "name": "file", - "in": "formData", - "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.filename": { - "name": "filename", - "in": "formData", - "description": "The optional filename or descriptive identifier to associate with with the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.model": { - "name": "model", - "in": "formData", - "description": "The model to use for this translation request.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.prompt": { - "name": "prompt", - "in": "formData", - "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.responseFormat": { - "name": "response_format", - "in": "formData", - "description": "The requested format of the translation response data, which will influence the content and detail of the result.", - "required": false, - "type": "string", - "enum": [ - "json", - "verbose_json", - "text", - "srt", - "vtt" - ], - "x-ms-enum": { - "name": "AudioTranslationFormat", - "modelAsString": true, - "values": [ - { - "name": "json", - "value": "json", - "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." - }, - { - "name": "verbose_json", - "value": "verbose_json", - "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." - }, - { - "name": "text", - "value": "text", - "description": "Use a response body that is plain text containing the raw, unannotated translation." - }, - { - "name": "srt", - "value": "srt", - "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." - }, - { - "name": "vtt", - "value": "vtt", - "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "responseFormat" - }, - "AudioTranslationOptions.temperature": { - "name": "temperature", - "in": "formData", - "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", - "required": false, - "type": "number", - "format": "float", - "x-ms-parameter-location": "method" - }, "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json index 3586f7590bf8..50544e3dc1fc 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json @@ -137,25 +137,93 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.language" + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" } ], "responses": { @@ -208,22 +276,86 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranslationOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranslationOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranslationOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" } ], "responses": { @@ -343,6 +475,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" @@ -394,6 +527,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" @@ -445,6 +579,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ImageGenerationOptions" @@ -499,25 +634,93 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.language" + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" } ], "responses": { @@ -566,22 +769,86 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranslationOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranslationOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranslationOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" } ], "responses": { @@ -4045,190 +4312,6 @@ } }, "parameters": { - "AudioTranscriptionOptions.file": { - "name": "file", - "in": "formData", - "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.filename": { - "name": "filename", - "in": "formData", - "description": "The optional filename or descriptive identifier to associate with with the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.language": { - "name": "language", - "in": "formData", - "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.model": { - "name": "model", - "in": "formData", - "description": "The model to use for this transcription request.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.prompt": { - "name": "prompt", - "in": "formData", - "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.responseFormat": { - "name": "response_format", - "in": "formData", - "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", - "required": false, - "type": "string", - "enum": [ - "json", - "verbose_json", - "text", - "srt", - "vtt" - ], - "x-ms-enum": { - "name": "AudioTranscriptionFormat", - "modelAsString": true, - "values": [ - { - "name": "json", - "value": "json", - "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." - }, - { - "name": "verbose_json", - "value": "verbose_json", - "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." - }, - { - "name": "text", - "value": "text", - "description": "Use a response body that is plain text containing the raw, unannotated transcription." - }, - { - "name": "srt", - "value": "srt", - "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." - }, - { - "name": "vtt", - "value": "vtt", - "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "responseFormat" - }, - "AudioTranscriptionOptions.temperature": { - "name": "temperature", - "in": "formData", - "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", - "required": false, - "type": "number", - "format": "float", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.file": { - "name": "file", - "in": "formData", - "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.filename": { - "name": "filename", - "in": "formData", - "description": "The optional filename or descriptive identifier to associate with with the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.model": { - "name": "model", - "in": "formData", - "description": "The model to use for this translation request.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.prompt": { - "name": "prompt", - "in": "formData", - "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.responseFormat": { - "name": "response_format", - "in": "formData", - "description": "The requested format of the translation response data, which will influence the content and detail of the result.", - "required": false, - "type": "string", - "enum": [ - "json", - "verbose_json", - "text", - "srt", - "vtt" - ], - "x-ms-enum": { - "name": "AudioTranslationFormat", - "modelAsString": true, - "values": [ - { - "name": "json", - "value": "json", - "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." - }, - { - "name": "verbose_json", - "value": "verbose_json", - "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." - }, - { - "name": "text", - "value": "text", - "description": "Use a response body that is plain text containing the raw, unannotated translation." - }, - { - "name": "srt", - "value": "srt", - "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." - }, - { - "name": "vtt", - "value": "vtt", - "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "responseFormat" - }, - "AudioTranslationOptions.temperature": { - "name": "temperature", - "in": "formData", - "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", - "required": false, - "type": "number", - "format": "float", - "x-ms-parameter-location": "method" - }, "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json index 7a140362995b..1e2249218c04 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json @@ -137,28 +137,127 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.language" + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.timestampGranularities" + "name": "timestamp_granularities", + "in": "formData", + "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ], + "x-ms-enum": { + "name": "AudioTranscriptionTimestampGranularity", + "modelAsString": true, + "values": [ + { + "name": "word", + "value": "word", + "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." + }, + { + "name": "segment", + "value": "segment", + "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." + } + ] + } + }, + "default": [ + "segment" + ], + "x-ms-client-name": "timestampGranularities" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" } ], "responses": { @@ -211,22 +310,86 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranslationOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranslationOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranslationOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" } ], "responses": { @@ -346,6 +509,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" @@ -397,6 +561,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" @@ -448,6 +613,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ImageGenerationOptions" @@ -502,28 +668,127 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.language" + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.timestampGranularities" + "name": "timestamp_granularities", + "in": "formData", + "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ], + "x-ms-enum": { + "name": "AudioTranscriptionTimestampGranularity", + "modelAsString": true, + "values": [ + { + "name": "word", + "value": "word", + "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." + }, + { + "name": "segment", + "value": "segment", + "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." + } + ] + } + }, + "default": [ + "segment" + ], + "x-ms-client-name": "timestampGranularities" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" } ], "responses": { @@ -572,22 +837,86 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranslationOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranslationOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranslationOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" } ], "responses": { @@ -4151,225 +4480,6 @@ } }, "parameters": { - "AudioTranscriptionOptions.file": { - "name": "file", - "in": "formData", - "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.filename": { - "name": "filename", - "in": "formData", - "description": "The optional filename or descriptive identifier to associate with with the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.language": { - "name": "language", - "in": "formData", - "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.model": { - "name": "model", - "in": "formData", - "description": "The model to use for this transcription request.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.prompt": { - "name": "prompt", - "in": "formData", - "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.responseFormat": { - "name": "response_format", - "in": "formData", - "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", - "required": false, - "type": "string", - "enum": [ - "json", - "verbose_json", - "text", - "srt", - "vtt" - ], - "x-ms-enum": { - "name": "AudioTranscriptionFormat", - "modelAsString": true, - "values": [ - { - "name": "json", - "value": "json", - "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." - }, - { - "name": "verbose_json", - "value": "verbose_json", - "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." - }, - { - "name": "text", - "value": "text", - "description": "Use a response body that is plain text containing the raw, unannotated transcription." - }, - { - "name": "srt", - "value": "srt", - "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." - }, - { - "name": "vtt", - "value": "vtt", - "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "responseFormat" - }, - "AudioTranscriptionOptions.temperature": { - "name": "temperature", - "in": "formData", - "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", - "required": false, - "type": "number", - "format": "float", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.timestampGranularities": { - "name": "timestamp_granularities", - "in": "formData", - "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", - "required": false, - "type": "array", - "items": { - "type": "string", - "enum": [ - "word", - "segment" - ], - "x-ms-enum": { - "name": "AudioTranscriptionTimestampGranularity", - "modelAsString": true, - "values": [ - { - "name": "word", - "value": "word", - "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." - }, - { - "name": "segment", - "value": "segment", - "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." - } - ] - } - }, - "default": [ - "segment" - ], - "x-ms-parameter-location": "method", - "x-ms-client-name": "timestampGranularities" - }, - "AudioTranslationOptions.file": { - "name": "file", - "in": "formData", - "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.filename": { - "name": "filename", - "in": "formData", - "description": "The optional filename or descriptive identifier to associate with with the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.model": { - "name": "model", - "in": "formData", - "description": "The model to use for this translation request.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.prompt": { - "name": "prompt", - "in": "formData", - "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.responseFormat": { - "name": "response_format", - "in": "formData", - "description": "The requested format of the translation response data, which will influence the content and detail of the result.", - "required": false, - "type": "string", - "enum": [ - "json", - "verbose_json", - "text", - "srt", - "vtt" - ], - "x-ms-enum": { - "name": "AudioTranslationFormat", - "modelAsString": true, - "values": [ - { - "name": "json", - "value": "json", - "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." - }, - { - "name": "verbose_json", - "value": "verbose_json", - "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." - }, - { - "name": "text", - "value": "text", - "description": "Use a response body that is plain text containing the raw, unannotated translation." - }, - { - "name": "srt", - "value": "srt", - "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." - }, - { - "name": "vtt", - "value": "vtt", - "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "responseFormat" - }, - "AudioTranslationOptions.temperature": { - "name": "temperature", - "in": "formData", - "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", - "required": false, - "type": "number", - "format": "float", - "x-ms-parameter-location": "method" - }, "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json index 24ed1b370093..8557c34830a2 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json @@ -137,28 +137,127 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.language" + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.timestampGranularities" + "name": "timestamp_granularities", + "in": "formData", + "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ], + "x-ms-enum": { + "name": "AudioTranscriptionTimestampGranularity", + "modelAsString": true, + "values": [ + { + "name": "word", + "value": "word", + "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." + }, + { + "name": "segment", + "value": "segment", + "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." + } + ] + } + }, + "default": [ + "segment" + ], + "x-ms-client-name": "timestampGranularities" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" } ], "responses": { @@ -211,22 +310,86 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranslationOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranslationOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranslationOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" } ], "responses": { @@ -346,6 +509,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" @@ -397,6 +561,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" @@ -448,6 +613,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ImageGenerationOptions" @@ -502,28 +668,127 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.language" + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.timestampGranularities" + "name": "timestamp_granularities", + "in": "formData", + "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ], + "x-ms-enum": { + "name": "AudioTranscriptionTimestampGranularity", + "modelAsString": true, + "values": [ + { + "name": "word", + "value": "word", + "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." + }, + { + "name": "segment", + "value": "segment", + "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." + } + ] + } + }, + "default": [ + "segment" + ], + "x-ms-client-name": "timestampGranularities" }, { - "$ref": "#/parameters/AudioTranscriptionOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" } ], "responses": { @@ -572,22 +837,86 @@ "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.file" + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/AudioTranslationOptions.filename" + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" }, { - "$ref": "#/parameters/AudioTranslationOptions.prompt" + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/AudioTranslationOptions.temperature" + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" }, { - "$ref": "#/parameters/AudioTranslationOptions.model" + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" } ], "responses": { @@ -4468,225 +4797,6 @@ } }, "parameters": { - "AudioTranscriptionOptions.file": { - "name": "file", - "in": "formData", - "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.filename": { - "name": "filename", - "in": "formData", - "description": "The optional filename or descriptive identifier to associate with with the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.language": { - "name": "language", - "in": "formData", - "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.model": { - "name": "model", - "in": "formData", - "description": "The model to use for this transcription request.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.prompt": { - "name": "prompt", - "in": "formData", - "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.responseFormat": { - "name": "response_format", - "in": "formData", - "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", - "required": false, - "type": "string", - "enum": [ - "json", - "verbose_json", - "text", - "srt", - "vtt" - ], - "x-ms-enum": { - "name": "AudioTranscriptionFormat", - "modelAsString": true, - "values": [ - { - "name": "json", - "value": "json", - "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." - }, - { - "name": "verbose_json", - "value": "verbose_json", - "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." - }, - { - "name": "text", - "value": "text", - "description": "Use a response body that is plain text containing the raw, unannotated transcription." - }, - { - "name": "srt", - "value": "srt", - "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." - }, - { - "name": "vtt", - "value": "vtt", - "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "responseFormat" - }, - "AudioTranscriptionOptions.temperature": { - "name": "temperature", - "in": "formData", - "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", - "required": false, - "type": "number", - "format": "float", - "x-ms-parameter-location": "method" - }, - "AudioTranscriptionOptions.timestampGranularities": { - "name": "timestamp_granularities", - "in": "formData", - "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", - "required": false, - "type": "array", - "items": { - "type": "string", - "enum": [ - "word", - "segment" - ], - "x-ms-enum": { - "name": "AudioTranscriptionTimestampGranularity", - "modelAsString": true, - "values": [ - { - "name": "word", - "value": "word", - "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." - }, - { - "name": "segment", - "value": "segment", - "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." - } - ] - } - }, - "default": [ - "segment" - ], - "x-ms-parameter-location": "method", - "x-ms-client-name": "timestampGranularities" - }, - "AudioTranslationOptions.file": { - "name": "file", - "in": "formData", - "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.filename": { - "name": "filename", - "in": "formData", - "description": "The optional filename or descriptive identifier to associate with with the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.model": { - "name": "model", - "in": "formData", - "description": "The model to use for this translation request.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.prompt": { - "name": "prompt", - "in": "formData", - "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AudioTranslationOptions.responseFormat": { - "name": "response_format", - "in": "formData", - "description": "The requested format of the translation response data, which will influence the content and detail of the result.", - "required": false, - "type": "string", - "enum": [ - "json", - "verbose_json", - "text", - "srt", - "vtt" - ], - "x-ms-enum": { - "name": "AudioTranslationFormat", - "modelAsString": true, - "values": [ - { - "name": "json", - "value": "json", - "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." - }, - { - "name": "verbose_json", - "value": "verbose_json", - "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." - }, - { - "name": "text", - "value": "text", - "description": "Use a response body that is plain text containing the raw, unannotated translation." - }, - { - "name": "srt", - "value": "srt", - "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." - }, - { - "name": "vtt", - "value": "vtt", - "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." - } - ] - }, - "x-ms-parameter-location": "method", - "x-ms-client-name": "responseFormat" - }, - "AudioTranslationOptions.temperature": { - "name": "temperature", - "in": "formData", - "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", - "required": false, - "type": "number", - "format": "float", - "x-ms-parameter-location": "method" - }, "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json index b55dcf7f754c..39a5f276c4a8 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json @@ -77,6 +77,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" @@ -128,6 +129,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json index 4025b89cae3a..bf3f9152ea8b 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json @@ -128,6 +128,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" @@ -179,6 +180,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" diff --git a/specification/communication/Communication.Messages/models.tsp b/specification/communication/Communication.Messages/models.tsp index deb3876a0910..4949f3b23047 100644 --- a/specification/communication/Communication.Messages/models.tsp +++ b/specification/communication/Communication.Messages/models.tsp @@ -374,3 +374,14 @@ enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_2) c2024_02_01: "2024-02-01", } + +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; diff --git a/specification/communication/Communication.Messages/routes.tsp b/specification/communication/Communication.Messages/routes.tsp index 95dede298d0a..a2c5d85987a4 100644 --- a/specification/communication/Communication.Messages/routes.tsp +++ b/specification/communication/Communication.Messages/routes.tsp @@ -35,7 +35,7 @@ interface NotificationMessagesOperations { @doc("Sends a notification message from Business to User.") send is Operations.ResourceCollectionAction< Notifications, - NotificationContent, + BodyParameter, AcceptedResponse & SendMessageResult >; } diff --git a/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json b/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json index 10f7cd1b04da..ec91ed70c2ed 100644 --- a/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json +++ b/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json @@ -164,6 +164,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/NotificationContent" diff --git a/specification/developersigning/DeveloperSigning/main.tsp b/specification/developersigning/DeveloperSigning/main.tsp index 89c0df419a51..167bd84ccdc7 100644 --- a/specification/developersigning/DeveloperSigning/main.tsp +++ b/specification/developersigning/DeveloperSigning/main.tsp @@ -68,7 +68,7 @@ interface CertificateProfileOperations { @pollingOperation(CertificateProfileOperations.getSigningStatus) sign is StandardResourceOperations.LongRunningResourceAction< CertificateProfileName, - SigningPayloadOptions, + BodyParameter, SignResult, Foundations.ErrorResponse, SigningRequestHeadersTraits @@ -188,6 +188,17 @@ model BytesBody { contentType: ContentType; } +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; + alias SigningRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTrait<{ @doc("An optional client version.") @header diff --git a/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json b/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json index 167577681423..3ad206e9823f 100644 --- a/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json +++ b/specification/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json @@ -93,6 +93,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SigningPayloadOptions" diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp index daf2d047610f..3393e203af29 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp @@ -104,3 +104,14 @@ model Ipv6Address { @doc("User equipment port.") port: int32; } + +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp index 2fe865cf1574..c90f5b3e63f9 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp @@ -13,7 +13,7 @@ interface DeviceLocation { @doc("Verifies whether a device is within a specified location area, defined as an accuracy (radius) around a point, specified by longitude and latitude.") verify is Operations.ResourceAction< DeviceLocationEndpoint, - DeviceLocationVerificationContent, + BodyParameter, DeviceLocationVerificationResult >; } diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp index 48faea42e171..47bb8931bd9d 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp @@ -14,7 +14,7 @@ interface DeviceNetwork { @doc("Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs.") retrieve is Operations.ResourceAction< DeviceNetworkRetrievalEndpoint, - NetworkIdentifier, + BodyParameter, NetworkRetrievalResult >; } diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp index 550e6d3d4477..c781676a7113 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp @@ -29,7 +29,7 @@ interface NumberVerification { @action("verify") verifyWithoutCode is Operations.ResourceAction< NumberVerificationEndpoint, - NumberVerificationWithoutCodeContent, + BodyParameter, TypeSpec.Http.Response<302> & {}, TraitOverride, NumberVerificationResult >; } diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp index c6c717e9b1b1..c1b76c601aad 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp @@ -14,14 +14,14 @@ interface SimSwap { @doc("Provides timestamp of latest SIM swap") retrieve is Operations.ResourceAction< SimSwapEndpoint, - SimSwapRetrievalContent, + BodyParameter, SimSwapRetrievalResult >; @doc("Verifies if a SIM swap has been performed during a past period (defined in the request with 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured.") verify is Operations.ResourceAction< SimSwapEndpoint, - SimSwapVerificationContent, + BodyParameter, SimSwapVerificationResult >; } diff --git a/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json index 1f674e941505..4c09ff5a23a7 100644 --- a/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json +++ b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json @@ -68,6 +68,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DeviceLocationVerificationContent" @@ -130,6 +131,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/NetworkIdentifier" @@ -192,6 +194,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/NumberVerificationWithoutCodeContent" @@ -256,6 +259,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SimSwapRetrievalContent" @@ -318,6 +322,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SimSwapVerificationContent" @@ -382,6 +387,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/NumberVerificationWithCodeContent" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index dc511d8f89e4..854809ea17d1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -1983,3 +1983,14 @@ model AtlasTypeDefHeader { @doc("The name of the type definition.") name?: string; } + +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index e7ddc9558184..7dd2a7fb5645 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -1619,7 +1619,7 @@ interface Discovery { @route("/search/query") @post query is Azure.Core.Foundations.Operation< - QueryOptions, + BodyParameter, QueryResult, {}, AtlasErrorResponse @@ -1630,7 +1630,7 @@ interface Discovery { @route("/search/suggest") @post suggest is Azure.Core.Foundations.Operation< - SuggestOptions, + BodyParameter, SuggestResult, {}, AtlasErrorResponse @@ -1641,7 +1641,7 @@ interface Discovery { @route("/search/autocomplete") @post autoComplete is Azure.Core.Foundations.Operation< - AutoCompleteOptions, + BodyParameter, AutoCompleteResult, {}, AtlasErrorResponse diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index f2e6eb6c6382..2d8ab19b2b35 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -4266,6 +4266,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AutoCompleteOptions" @@ -4304,6 +4305,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/QueryOptions" @@ -4402,6 +4404,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SuggestOptions" diff --git a/specification/riskiq/Easm/models.tsp b/specification/riskiq/Easm/models.tsp index 74f37c48bd0b..8550fb724269 100644 --- a/specification/riskiq/Easm/models.tsp +++ b/specification/riskiq/Easm/models.tsp @@ -2155,3 +2155,14 @@ model DiscoGroupSummaryResult { @doc("The name that can be used for display purposes.") displayName: string; } + +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; diff --git a/specification/riskiq/Easm/routes.tsp b/specification/riskiq/Easm/routes.tsp index c787851abd12..f8220b541bfb 100644 --- a/specification/riskiq/Easm/routes.tsp +++ b/specification/riskiq/Easm/routes.tsp @@ -41,7 +41,7 @@ interface Assets { @Versioning.added(Versions.v2024_03_01_preview) getAssetsExport is Operations.ResourceCollectionAction< AssetResource, - AssetsExportRequest, + BodyParameter, Task, AssetsExportTrait >; @@ -61,7 +61,7 @@ interface Assets { @Versioning.added(Versions.v2024_03_01_preview) getDeltaDetails is Operations.ResourceCollectionAction< AssetResource, - DeltaDetailsRequest, + BodyParameter, DeltaPageResult, DeltaDetailsTrait >; @@ -71,7 +71,7 @@ interface Assets { @Versioning.added(Versions.v2024_03_01_preview) getDeltaSummary is Operations.ResourceCollectionAction< AssetResource, - DeltaSummaryRequest, + BodyParameter, DeltaSummaryResult, {} >; @@ -90,7 +90,7 @@ interface DataConnections { @action("validate") validateDataConnection is Operations.ResourceCollectionAction< DataConnection, - DataConnectionData, + BodyParameter, ValidateResult >; @doc("Retrieve a data connection with a given dataConnectionName.") @@ -102,7 +102,7 @@ interface DataConnections { @put createOrReplaceDataConnection is Foundations.ResourceOperation< DataConnection, - DataConnectionData, + BodyParameter, DataConnection >; @@ -122,7 +122,7 @@ interface DiscoveryGroups { @clientName("ValidateDiscoveryGroup", "csharp") validateDiscoGroup is Operations.ResourceCollectionAction< DiscoGroup, - DiscoGroupData, + BodyParameter, ValidateResult >; @doc("Retrieve a discovery group with a given groupName.") @@ -162,7 +162,7 @@ interface DiscoveryGroups { @Versioning.added(Versions.v2024_03_01_preview) getAssetChainSummary is Operations.ResourceCollectionAction< DiscoGroup, - AssetChainRequest, + BodyParameter, AssetChainSummaryResult >; @@ -171,7 +171,7 @@ interface DiscoveryGroups { @Versioning.added(Versions.v2024_03_01_preview) dismissAssetChain is Operations.ResourceCollectionAction< DiscoGroup, - AssetChainRequest, + BodyParameter, Task >; } @@ -203,7 +203,7 @@ interface Reports { @route("/reports/assets:getSnapshot") @post getSnapshot is Foundations.Operation< - ReportAssetSnapshotRequest, + BodyParameter, ReportAssetSnapshotResult >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @@ -211,7 +211,7 @@ interface Reports { @route("/reports/assets:getSummary") @post getSummary is Foundations.Operation< - ReportAssetSummaryRequest, + BodyParameter, ReportAssetSummaryResult >; @@ -221,7 +221,7 @@ interface Reports { @route("/reports/assets:getSnapshotExport") @post getSnapshotExport is Foundations.Operation< - ReportAssetSnapshotExportRequest, + BodyParameter, Task >; } diff --git a/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json b/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json index 80583013d4dc..dd82cf71c089 100644 --- a/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json +++ b/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json @@ -337,6 +337,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DataConnectionData" @@ -425,6 +426,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DataConnectionData" @@ -718,6 +720,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DiscoGroupData" @@ -901,6 +904,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ReportAssetSnapshotRequest" @@ -948,6 +952,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ReportAssetSummaryRequest" diff --git a/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json b/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json index 7414e732a170..d6f807a38604 100644 --- a/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json +++ b/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json @@ -314,6 +314,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssetsExportRequest" @@ -367,6 +368,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DeltaDetailsRequest" @@ -417,6 +419,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DeltaSummaryRequest" @@ -651,6 +654,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DataConnectionData" @@ -739,6 +743,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DataConnectionData" @@ -1073,6 +1078,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssetChainRequest" @@ -1120,6 +1126,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssetChainRequest" @@ -1167,6 +1174,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DiscoGroupData" @@ -1350,6 +1358,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ReportAssetSnapshotRequest" @@ -1397,6 +1406,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ReportAssetSnapshotExportRequest" @@ -1444,6 +1454,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ReportAssetSummaryRequest" diff --git a/specification/voiceservices/VoiceServices.Provisioning/main.tsp b/specification/voiceservices/VoiceServices.Provisioning/main.tsp index caf465c869bc..02a41d6528cc 100644 --- a/specification/voiceservices/VoiceServices.Provisioning/main.tsp +++ b/specification/voiceservices/VoiceServices.Provisioning/main.tsp @@ -781,6 +781,17 @@ model CountOfRecordsHeader { countOfRecords?: int32; } +alias BodyParameter< + T, + TName extends valueof string = "body", + TDoc extends valueof string = "Body parameter." +> = { + @doc(TDoc) + @friendlyName(TName) + @bodyRoot + body: T; +}; + alias FilterQueryParameters = QueryParametersTrait<{ ...FilterQueryParameter; }>; @@ -843,7 +854,11 @@ interface Accounts { @doc("Create or update up to 100 Numbers on the specified account.") createOrUpdateNumbers is Operations.ResourceAction< AccountResource, - BatchNumbers, + BodyParameter< + BatchNumbers, + "body", + "Batch of numbers to create or replace." + >, BatchNumbers >; @@ -852,7 +867,7 @@ interface Accounts { @doc("Delete up to 100 Numbers on the specified account.") deleteNumbers is Operations.ResourceAction< AccountResource, - BatchNumbersDelete, + BodyParameter, NoContentResponse >; @@ -893,7 +908,11 @@ interface Accounts { @doc("Get a list of Teams Available Capabilities on the specified account.") getTeamsAvailableCapabilities is Operations.ResourceAction< AccountResource, - NumberIdentifiers, + BodyParameter< + NumberIdentifiers, + "body", + "List identifiers for a Number resource" + >, TeamsAvailableCapabilities >; diff --git a/specification/voiceservices/data-plane/Microsoft.VoiceServices/preview/2024-02-29-preview/swagger.json b/specification/voiceservices/data-plane/Microsoft.VoiceServices/preview/2024-02-29-preview/swagger.json index 87695257d9f6..25cd2ef5dae0 100644 --- a/specification/voiceservices/data-plane/Microsoft.VoiceServices/preview/2024-02-29-preview/swagger.json +++ b/specification/voiceservices/data-plane/Microsoft.VoiceServices/preview/2024-02-29-preview/swagger.json @@ -499,6 +499,7 @@ { "name": "body", "in": "body", + "description": "Batch of numbers to create or replace.", "required": true, "schema": { "$ref": "#/definitions/BatchNumbers" @@ -597,6 +598,7 @@ { "name": "body", "in": "body", + "description": "Batch numbers to delete.", "required": true, "schema": { "$ref": "#/definitions/BatchNumbersDelete" @@ -782,6 +784,7 @@ { "name": "body", "in": "body", + "description": "List identifiers for a Number resource", "required": true, "schema": { "$ref": "#/definitions/NumberIdentifiers" From 43f10d3b8bacd5fc6b01254b5050c613f26c3573 Mon Sep 17 00:00:00 2001 From: yaotongms <137821665+yaotongms@users.noreply.github.com> Date: Wed, 26 Jun 2024 19:17:23 -0400 Subject: [PATCH 247/343] hybridcompute - update readme.md and description for SDK commands generation (#29510) * add back command * remove run command PATCH * update operation description --- .../preview/2024-05-20-preview/HybridCompute.json | 2 +- specification/hybridcompute/resource-manager/readme.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json index 70aeedb7d529..58d3cb75c2d8 100644 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json @@ -1173,7 +1173,7 @@ "MachineExtensions" ], "operationId": "MachineExtensions_Update", - "description": "The operation to create or update the extension.", + "description": "The operation to update the extension.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" diff --git a/specification/hybridcompute/resource-manager/readme.md b/specification/hybridcompute/resource-manager/readme.md index df97284daf81..50fbd33dc9a8 100644 --- a/specification/hybridcompute/resource-manager/readme.md +++ b/specification/hybridcompute/resource-manager/readme.md @@ -131,7 +131,8 @@ directive: subject: MachineRunCommand verb: Set remove: true - - remove-operation: Machines_CreateOrUpdate + + # we don't want user to interact with them / we don't support some operations - remove-operation: AgentVersion_List - remove-operation: AgentVersion_Get - remove-operation: HybridIdentityMetadata_Get @@ -145,7 +146,8 @@ directive: - remove-operation: NetworkConfigurations_Get - remove-operation: NetworkConfigurations_Update - remove-operation: NetworkConfigurations_CreateOrUpdate - - remove-operation: NetworkSecurityPerimeterConfigurations_ReconcileForPrivateLinkScope + - remove-operation: MachineRunCommands_Update #PATCH + ``` From 220ad9c6554fc7d6d10a89bdb441c1e3b36e3285 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 26 Jun 2024 22:01:30 -0700 Subject: [PATCH 248/343] Move TypeSpec content from ci-fix.md to wiki (#29600) --- documentation/ci-fix.md | 86 +---------------------------------------- 1 file changed, 2 insertions(+), 84 deletions(-) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index dc37b413d2bb..6cbedb4b3d0f 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -190,70 +190,7 @@ To reproduce LintDiff failures locally, see [CONTRIBUTING.md / How to locally re ## `Swagger LintDiff` for TypeSpec: troubleshooting guides -Check `Swagger LintDiff` may fail for the OpenAPI generated from TypeSpec, even if there are no warnings or errors reported from the TypeSpec compiler. Causes include bugs in the TypeSpec OpenAPI emitter, bugs in LintDiff rules, incompatibilities between TypeSpec and LintDiff, or checks duplicated in TypeSpec and LintDiff. - -We are working to address the root causes (where possible). Until then, we recommend you [suppress](#suppression-process) these LintDiff errors, using a "permanent suppression" with a descriptive "reason", so we can revert your suppression when the root cause is fixed. - -### `Record` causes `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition` - -The use of `Record` in TypeSpec is discouraged, and there is a TypeSpec lint rule to enforce this. If you still need to use `Record`, the OpenAPI spec generated will cause many LintDiff errors of types `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`. You will need to suppress both the TypeSpec violation (in TypeSpec source code) and the LintDiff violations. - -### `RequestBodyMustExistForPutPatch` - -We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/641 - -### `PatchPropertiesCorrespondToPutProperties` - -We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/642 - -### `@singleton` causes `EvenSegmentedPathForPutOperation` and `XmsPageableForListCalls` - -If `EvenSegmentedPathForPutOperation` and/or `XmsPageableForListCalls` are failing for OpenAPI generated from TypeSpec using `@singleton` (OpenAPI path ends with `/default`), we believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/646 - -### `AvoidAnonymousParameter`, `AvoidAnonymousTypes`, `IntegerTypeMustHaveFormat` - -Data-plane specs can suppress violations of the following rules, since they only exist for the benefit of SDKs generated from swagger, and data-plane SDKs are generated directly from TypeSpec. Resource-manager specs should **not** suppress violations of these rules, since resource-manager SDKs are generated from OpenAPI, and rely on these errors being fixed. - -- `AvoidAnonymousParameter` -- `AvoidAnonymousTypes` -- `IntegerTypeMustHaveFormat` - -### `AvoidAnonymousTypes` inside a 202 response - -As an exception to the previous note, resource-manager specs **may** be able to suppress `AvoidAnonymousTypes`, but only if the error is inside a 202 response from a long-running operation (LRO). It is known that SDKs do not need to generate type names for such responses. - -### `OAuth2Auth` causes `XmsEnumValidation` - -TypeSpec using `OAuth2Auth` may generate the following OpenAPI: - -``` yaml -"type": { - "type": "string", - "description": "OAuth2 authentication", - "enum": [ - "oauth2" - ] -}, -``` - -Which causes error `XmsEnumValidation`. The recommended workaround is to add `omit-unreachable-types: true` to your `tspconfig.yaml`. - -### `ProvisioningStateMustBeReadOnly` - -The root cause is bugs in `azure-openapi-validator` and `oav`: - -https://github.com/Azure/azure-openapi-validator/issues/637 -https://github.com/Azure/oav/issues/848 - -The recommended workaround is to add `use-read-only-status-schema: true` to your `tspconfig.yaml`. - -### `PatchBodyParameterSchema` - -The root cause is a bug in typespec-azure: - -https://github.com/Azure/typespec-azure/issues/383. - -Please see the issue above for the suggested workaround and apply it directly to the spec TypeSpec sources. The LintDiff error should **not** be ignored or suppressed. +https://github.com/Azure/azure-rest-api-specs/wiki/Swagger-LintDiff-for-TypeSpec ## `Swagger ModelValidation` @@ -343,26 +280,7 @@ If you need more information on see [cspell configuration](https://cspell.org/co ## `TypeSpec Validation` -This validator will help ensure your TypeSpec project follows [standard conventions](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/typespec-structure-guidelines.md) as well ensures that the [generated OpenAPI spec](https://azure.github.io/typespec-azure/docs/emitters/typespec-autorest) files are in-sync with your project. - -### Run `tsv` locally - -``` powershell -cd -git checkout -git merge -npm ci -npx tsv -git commit; git push (if any changes) - -# example -npx tsv specification/contosowidgetmanager/Contoso.WidgetManager -``` - -Then check any errors that might be outputted and address any issues as needed. If there are changed files after the runit generally means -that the generated OpenAPI spec files were not in-sync with the TypeSpec project and you should include those changes in your pull request as well. - -If none of the above helped, please reach out on [TypeSpec Discussions Teams channel]. +https://github.com/Azure/azure-rest-api-specs/wiki/TypeSpec-Validation ## `license/cla` From ff6de81b4e56d95e867083f7eb37a524fa6855f6 Mon Sep 17 00:00:00 2001 From: Marcus Beltman Date: Thu, 27 Jun 2024 09:22:56 -0700 Subject: [PATCH 249/343] Add Azure async APIs to Maps data plane api-version 2023-12-01-preview (#29472) * Add Azure async APIs. * Add examples, fix return codes. * Fix typo. * Add tags, run linter. * Add missing refs. * Formatting * Add missing parameters. * Remove unused status codes, defined Location header. * Model validation errors. * Prettier * ProvisioningStateSpecifiedForLROPut * Address PR comments. * Create sdk-suppressions.yaml --------- Co-authored-by: Marcus Beltman Co-authored-by: Yuchao Yan --- .../examples/GetOperationResult.json | 19 +++ .../examples/GetOperationStatus.json | 33 ++++++ ...=> PrivateEndpointConnections_Update.json} | 9 +- .../2023-12-01-preview/maps-management.json | 108 ++++++++++++++++-- .../resource-manager/sdk-suppressions.yaml | 5 + 5 files changed, 163 insertions(+), 11 deletions(-) create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/GetOperationResult.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/GetOperationStatus.json rename specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/{PrivateEndpointConnections_Create.json => PrivateEndpointConnections_Update.json} (87%) create mode 100644 specification/maps/resource-manager/sdk-suppressions.yaml diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/GetOperationResult.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/GetOperationResult.json new file mode 100644 index 000000000000..eb70d4c9a434 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/GetOperationResult.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "operationId": "01234567-89ab-4def-0123-456789abcdef" + }, + "responses": { + "200": {}, + "202": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/GetOperationStatus.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/GetOperationStatus.json new file mode 100644 index 000000000000..ab19ebeda2de --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/GetOperationStatus.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "operationId": "01234567-89ab-4def-0123-456789abcdef" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/providers/Microsoft.Maps/operationsStatuses/01234567-89ab-4def-0123-456789abcdef", + "resourceId": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "01234567-89ab-4def-0123-456789abcdef", + "status": "Failed", + "startTime": "2024-01-23T01:23:45.678+09:00", + "endTime": "2024-01-23T02:00:00.000+09:00", + "percentComplete": 0.0, + "operations": [], + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/PrivateEndpointConnections_Create.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/PrivateEndpointConnections_Update.json similarity index 87% rename from specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/PrivateEndpointConnections_Create.json rename to specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/PrivateEndpointConnections_Update.json index c66ad5987977..b821d125d149 100644 --- a/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/PrivateEndpointConnections_Create.json +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/examples/PrivateEndpointConnections_Update.json @@ -16,7 +16,7 @@ } }, "responses": { - "200": { + "201": { "body": { "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/privateEndpointConnections/privateEndpointConnectionName", "name": "privateEndpointConnectionName", @@ -31,15 +31,18 @@ "description": "Auto-Approved" } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2023-12-01-preview" } }, - "201": { + "200": { "body": { "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/privateEndpointConnections/privateEndpointConnectionName", "name": "privateEndpointConnectionName", "type": "Microsoft.Maps/accounts/privateEndpointConnections", "properties": { - "provisioningState": "Creating", + "provisioningState": "Succeeded", "privateEndpoint": { "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/petest01" }, diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/maps-management.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/maps-management.json index ef1f3081353b..38007b56ec6f 100644 --- a/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/maps-management.json +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2023-12-01-preview/maps-management.json @@ -884,7 +884,7 @@ "description": "Create or update the state of specified private endpoint connection associated with the Maps account.", "x-ms-examples": { "PrivateEndpointConnections_Create": { - "$ref": "./examples/PrivateEndpointConnections_Create.json" + "$ref": "./examples/PrivateEndpointConnections_Update.json" } }, "parameters": [ @@ -914,12 +914,6 @@ } ], "responses": { - "200": { - "description": "Updated the private endpoint connection properties successfully.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" - } - }, "201": { "description": "Created the private endpoint connection properties successfully.", "schema": { @@ -932,6 +926,12 @@ } } }, + "200": { + "description": "Updated the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -978,7 +978,7 @@ "type": "string" }, "Location": { - "description": "Operation Status Location URI", + "description": "Operation Results Location URI", "type": "string" }, "Retry-After": { @@ -1047,6 +1047,98 @@ "nextLinkName": "nextLink" } } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maps/operationResults/{operationId}": { + "get": { + "tags": [ + "AsyncOperations" + ], + "operationId": "OperationResult_Get", + "description": "Get the result of a long running azure asynchronous operation.", + "x-ms-examples": { + "OperationResult_Get": { + "$ref": "./examples/GetOperationResult.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation ID." + } + ], + "responses": { + "200": { + "description": "" + }, + "202": { + "description": "", + "headers": { + "Location": { + "type": "string", + "description": "" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maps/operationStatuses/{operationId}": { + "get": { + "tags": [ + "AsyncOperations" + ], + "operationId": "OperationStatus_Get", + "description": "Get the status of a long running azure asynchronous operation.", + "x-ms-examples": { + "OperationStatus_Get": { + "$ref": "./examples/GetOperationStatus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation ID." + } + ], + "responses": { + "200": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + } + } } }, "parameters": { diff --git a/specification/maps/resource-manager/sdk-suppressions.yaml b/specification/maps/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..3539cf96c7c8 --- /dev/null +++ b/specification/maps/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,5 @@ +suppressions: + azure-sdk-for-python: + - package: azure-mgmt-maps + breaking-changes: + - Removed operation MapsOperations.list_subscription_operations From e6e24a1739919ebbb1a0b1c72994958f56a82f5d Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Thu, 27 Jun 2024 10:35:43 -0700 Subject: [PATCH 250/343] Add additional properties for ChatCompletionsOptions Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/chat_completions.tsp | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 6a21fc17aa51..bf3d811627a3 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -112,6 +112,14 @@ model ChatCompletionsOptions { ID of the specific AI model to use, if more than one model is available on the endpoint. """) `model`?: string; + + @doc(""" + Additional, model-specific parameters that are not in the + standard request payload. They will be added as-is to the root of the JSON in the request body. + How the service handles these extra parameters depends on the value of the + ``unknown-parameters`` request header. Default value is None. + """) + ..Record; } alias ChatCompletionsCommon = { From c33085fe51cbc4a73f60899b0ce2229eed77bbea Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Thu, 27 Jun 2024 10:38:57 -0700 Subject: [PATCH 251/343] 3 dots, not 2 Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/chat_completions.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index bf3d811627a3..c3a5fccbb2a5 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -119,7 +119,7 @@ model ChatCompletionsOptions { How the service handles these extra parameters depends on the value of the ``unknown-parameters`` request header. Default value is None. """) - ..Record; + ...Record; } alias ChatCompletionsCommon = { From bc2ead48f5d3e6bf6860694833a31a4dea5dd791 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Thu, 27 Jun 2024 11:07:15 -0700 Subject: [PATCH 252/343] Can't add docstring to generic spread property Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/chat_completions.tsp | 6 ------ 1 file changed, 6 deletions(-) diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index c3a5fccbb2a5..e4b7a2b902f4 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -113,12 +113,6 @@ model ChatCompletionsOptions { """) `model`?: string; - @doc(""" - Additional, model-specific parameters that are not in the - standard request payload. They will be added as-is to the root of the JSON in the request body. - How the service handles these extra parameters depends on the value of the - ``unknown-parameters`` request header. Default value is None. - """) ...Record; } From 9d794a38333fe0713cc61f3d790cbcf5a97ad56b Mon Sep 17 00:00:00 2001 From: elizatargithub7 <148910954+elizatargithub7@users.noreply.github.com> Date: Thu, 27 Jun 2024 11:43:52 -0700 Subject: [PATCH 253/343] Quotas for DevOpsInfrastructure (#29581) * up * up * almost there * example * up * up * up * review comments --- .../SubscriptionUsages_ListByLocation.json | 44 ------- .../SubscriptionUsages_Usages.json | 38 ++++++ .../Microsoft.DevOpsInfrastructure/main.tsp | 38 +++--- .../devopsinfrastructure.json | 119 ++++++++---------- .../SubscriptionUsages_ListByLocation.json | 44 ------- .../examples/SubscriptionUsages_Usages.json | 38 ++++++ 6 files changed, 150 insertions(+), 171 deletions(-) delete mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_ListByLocation.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_Usages.json delete mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/examples/SubscriptionUsages_ListByLocation.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/examples/SubscriptionUsages_Usages.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_ListByLocation.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_ListByLocation.json deleted file mode 100644 index 0d0426186bc7..000000000000 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_ListByLocation.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "title": "SubscriptionUsages_ListByLocation", - "operationId": "SubscriptionUsages_ListByLocation", - "parameters": { - "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", - "locationName": "eastus", - "api-version": "2024-04-04-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDADSv5Family", - "name": "standardDADSv5Family", - "properties": { - "unit": "Count", - "currentValue": 0, - "limit": 212, - "name": { - "value": "standardDADSv5Family", - "localizedValue": "Standard DADSv5 Family vCPUs (PME VMSS)" - } - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDPLDSv5Family", - "name": "standardDPLDSv5Family", - "properties": { - "unit": "Count", - "currentValue": 0, - "limit": 100, - "name": { - "value": "standardDPLDSv5Family", - "localizedValue": "Standard DPLDSv5 Family vCPUs (PME VMSS)" - } - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_Usages.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_Usages.json new file mode 100644 index 000000000000..13342c3eddd7 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_Usages.json @@ -0,0 +1,38 @@ +{ + "title": "SubscriptionUsages_Usages", + "operationId": "SubscriptionUsages_Usages", + "parameters": { + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "location": "eastus", + "api-version": "2024-04-04-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDADSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 212, + "name": { + "value": "standardDADSv5Family", + "localizedValue": "Standard DADSv5 Family vCPUs (PME VMSS)" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDPLDSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 100, + "name": { + "value": "standardDPLDSv5Family", + "localizedValue": "Standard DPLDSv5 Family vCPUs (PME VMSS)" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp index 7ad4b1ced9e7..a4e453a567fa 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp @@ -23,6 +23,7 @@ namespace Microsoft.DevOpsInfrastructure; enum Versions { /** 2024-04-04-preview preview version */ @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) `2024-04-04-preview`, } @@ -653,22 +654,35 @@ interface Sku { listByLocation is ArmListBySubscription; } +@armResourceOperations +interface SubscriptionUsages { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-action-verb" "Actions must be HTTP Post operations." + @action + @armProviderNameValue + @get + @armResourceList(Location) + @doc("List Quota resources by subscription ID") + usages( + ...SubscriptionIdParameter, + ...Azure.ResourceManager.Foundations.DefaultProviderNamespace, + ...LocationParameter, + ...ApiVersionParameter, + ): ArmResponse> | ErrorResponse; +} + @doc("Describes Resource Quota") @parentResource(Location) -model Quota is ProxyResource { +model Quota { #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "existing api" @doc("The name of the quota.") - @key("quotaName") @segment("usages") @visibility("read") @path - name: string; -} + name?: QuotaName; + + @doc("Fully qualified ARM resource id") + id: armResourceIdentifier; -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" -@doc("Describes Resource Quota properties") -model QuotaProperties { @doc("The unit of usage measurement.") unit: string; @@ -677,9 +691,6 @@ model QuotaProperties { @doc("The maximum permitted usage of the resource.") limit: int64; - - @doc("The details of the quota.") - name: QuotaName; } @doc("The Quota Names") @@ -691,11 +702,6 @@ model QuotaName { localizedValue?: string; } -@armResourceOperations -interface SubscriptionUsages { - listByLocation is ArmListBySubscription; -} - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" #suppress "@azure-tools/typespec-azure-resource-manager/missing-property" "No Identity" @doc("An image resource.") diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json index 89f071f7e6e0..db860f768766 100644 --- a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json @@ -141,34 +141,29 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/locations/{locationName}/usages": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/locations/{location}/usages": { "get": { - "operationId": "SubscriptionUsages_ListByLocation", + "operationId": "SubscriptionUsages_Usages", "tags": [ "SubscriptionUsages" ], "description": "List Quota resources by subscription ID", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { - "name": "locationName", - "in": "path", - "description": "Name of the location.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/QuotaListResult" + "$ref": "#/definitions/PagedQuota" } }, "default": { @@ -179,8 +174,8 @@ } }, "x-ms-examples": { - "SubscriptionUsages_ListByLocation": { - "$ref": "./examples/SubscriptionUsages_ListByLocation.json" + "SubscriptionUsages_Usages": { + "$ref": "./examples/SubscriptionUsages_Usages.json" } }, "x-ms-pageable": { @@ -1094,6 +1089,27 @@ } } }, + "PagedQuota": { + "type": "object", + "description": "Paged collection of Quota items", + "properties": { + "value": { + "type": "array", + "description": "The Quota items on this page", + "items": { + "$ref": "#/definitions/Quota" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "Pool": { "type": "object", "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", @@ -1355,57 +1371,16 @@ "type": "object", "description": "Describes Resource Quota", "properties": { - "properties": { - "$ref": "#/definitions/QuotaProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "QuotaListResult": { - "type": "object", - "description": "The response of a Quota list operation.", - "properties": { - "value": { - "type": "array", - "description": "The Quota items on this page", - "items": { - "$ref": "#/definitions/Quota" - } + "name": { + "$ref": "#/definitions/QuotaName", + "description": "The name of the quota.", + "readOnly": true }, - "nextLink": { + "id": { "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "QuotaName": { - "type": "object", - "description": "The Quota Names", - "properties": { - "value": { - "type": "string", - "description": "The name of the resource." + "format": "arm-id", + "description": "Fully qualified ARM resource id" }, - "localizedValue": { - "type": "string", - "description": "The localized name of the resource." - } - } - }, - "QuotaProperties": { - "type": "object", - "description": "Describes Resource Quota properties", - "properties": { "unit": { "type": "string", "description": "The unit of usage measurement." @@ -1419,19 +1394,29 @@ "type": "integer", "format": "int64", "description": "The maximum permitted usage of the resource." - }, - "name": { - "$ref": "#/definitions/QuotaName", - "description": "The details of the quota." } }, "required": [ + "id", "unit", "currentValue", - "limit", - "name" + "limit" ] }, + "QuotaName": { + "type": "object", + "description": "The Quota Names", + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + } + }, "ResourceDetailsObject": { "type": "object", "description": "A ResourceDetailsObject", diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/examples/SubscriptionUsages_ListByLocation.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/examples/SubscriptionUsages_ListByLocation.json deleted file mode 100644 index 0d0426186bc7..000000000000 --- a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/examples/SubscriptionUsages_ListByLocation.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "title": "SubscriptionUsages_ListByLocation", - "operationId": "SubscriptionUsages_ListByLocation", - "parameters": { - "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", - "locationName": "eastus", - "api-version": "2024-04-04-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDADSv5Family", - "name": "standardDADSv5Family", - "properties": { - "unit": "Count", - "currentValue": 0, - "limit": 212, - "name": { - "value": "standardDADSv5Family", - "localizedValue": "Standard DADSv5 Family vCPUs (PME VMSS)" - } - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDPLDSv5Family", - "name": "standardDPLDSv5Family", - "properties": { - "unit": "Count", - "currentValue": 0, - "limit": 100, - "name": { - "value": "standardDPLDSv5Family", - "localizedValue": "Standard DPLDSv5 Family vCPUs (PME VMSS)" - } - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/examples/SubscriptionUsages_Usages.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/examples/SubscriptionUsages_Usages.json new file mode 100644 index 000000000000..13342c3eddd7 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/examples/SubscriptionUsages_Usages.json @@ -0,0 +1,38 @@ +{ + "title": "SubscriptionUsages_Usages", + "operationId": "SubscriptionUsages_Usages", + "parameters": { + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "location": "eastus", + "api-version": "2024-04-04-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDADSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 212, + "name": { + "value": "standardDADSv5Family", + "localizedValue": "Standard DADSv5 Family vCPUs (PME VMSS)" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDPLDSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 100, + "name": { + "value": "standardDPLDSv5Family", + "localizedValue": "Standard DPLDSv5 Family vCPUs (PME VMSS)" + } + } + ], + "nextLink": null + } + } + } +} From bfb929ca5fd9e73258071724b440ae244e084c56 Mon Sep 17 00:00:00 2001 From: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> Date: Thu, 27 Jun 2024 15:55:32 -0400 Subject: [PATCH 254/343] Revert WebApiSkill design change (#29614) --- .../stable/2024-07-01/searchservice.json | 31 +++++++++++++++++-- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json index 1963fef0f568..c1281bce0580 100644 --- a/specification/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json @@ -8787,12 +8787,26 @@ "allOf": [ { "$ref": "#/definitions/SearchIndexerSkill" - }, - { - "$ref": "#/definitions/WebApiParameters" } ], "properties": { + "uri": { + "type": "string", + "description": "The url for the Web API." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the http request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the http request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, "batchSize": { "type": "integer", "format": "int32", @@ -8804,6 +8818,17 @@ "format": "int32", "x-nullable": true, "description": "If set, the number of parallel calls that can be made to the Web API." + }, + "authResourceId": { + "type": "string", + "x-nullable": true, + "x-ms-format": "arm-id", + "description": "Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." } }, "required": [ From 282cbb1ece88b61690962c14eff25df3b669b3c4 Mon Sep 17 00:00:00 2001 From: rakshithtr <135733794+rakshithtr@users.noreply.github.com> Date: Thu, 27 Jun 2024 16:38:50 -0700 Subject: [PATCH 255/343] Fixing swagger model validation failures (#29507) * Fixing swagger model validation failures * Added headers and changed final state via * Adding location also as part of header --- .../ExpressRoutePortAuthorizationDelete.json | 6 +++- .../examples/ExpressRoutePortDelete.json | 6 +++- .../examples/RouteFilterDelete.json | 6 +++- .../examples/RouteFilterRuleDelete.json | 6 +++- .../stable/2024-01-01/expressRoutePort.json | 28 ++++++++++++++++--- .../stable/2024-01-01/routeFilter.json | 28 ++++++++++++++++--- 6 files changed, 68 insertions(+), 12 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationDelete.json index 22203ddd57ae..eec6e71f6561 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortAuthorizationDelete.json @@ -8,7 +8,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortDelete.json index e760dbdbee10..eb31a9fc9595 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/ExpressRoutePortDelete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterDelete.json index f937aa3a8625..3e1b8cbfb2fd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterDelete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleDelete.json index 4cc4dae1b8af..2daa849def13 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/RouteFilterRuleDelete.json @@ -8,7 +8,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRoutePort.json index 722f3b9b0308..c4958cd93282 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRoutePort.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/expressRoutePort.json @@ -150,7 +150,17 @@ "description": "Delete successful." }, "202": { - "description": "Accepted and the operation will complete asynchronously." + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } }, "204": { "description": "Request successful. Resource does not exist." @@ -164,7 +174,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" }, "x-ms-examples": { "ExpressRoutePortDelete": { @@ -643,7 +653,17 @@ "description": "Delete successful." }, "202": { - "description": "Accepted and the operation will complete asynchronously." + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } }, "204": { "description": "Request successful. Resource does not exist." @@ -657,7 +677,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Delete ExpressRoutePort Authorization": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeFilter.json index 483e4994133a..2d836503b790 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeFilter.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeFilter.json @@ -70,7 +70,17 @@ ], "responses": { "202": { - "description": "Accepted and the operation will complete asynchronously." + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } }, "200": { "description": "Delete successful." @@ -87,7 +97,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } }, "get": { @@ -398,7 +408,17 @@ ], "responses": { "202": { - "description": "Accepted and the operation will complete asynchronously." + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } }, "200": { "description": "Accepted." @@ -415,7 +435,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } }, "get": { From eabbc8ab2cc98dc0753ae6eebffc5b4ba5def1ec Mon Sep 17 00:00:00 2001 From: v-maksymm <161892853+v-maksymm@users.noreply.github.com> Date: Thu, 27 Jun 2024 16:39:24 -0700 Subject: [PATCH 256/343] Oracle.Database. Removed readonly properties from required (#29618) * Oracle.Database. Readonly properties not required anymore * Oracle.Database. Readonly properties not required anymore --- .../autonomousDatabaseCharacterSet.tsp | 2 +- ...autonomousDatabaseNationalCharacterSet.tsp | 2 +- .../autonomousDatabaseVersion.tsp | 2 +- .../oracle/models/exadata/dbNodes.tsp | 4 +- .../oracle/models/exadata/dbSystemShapes.tsp | 2 +- .../oracle/models/exadata/dnsPrivateViews.tsp | 10 ++-- .../oracle/models/exadata/dnsPrivateZones.tsp | 14 ++--- .../oracle/models/exadata/giVersions.tsp | 2 +- .../oracle/models/exadata/systemVersions.tsp | 2 +- .../preview/2023-09-01-preview/openapi.json | 56 +++---------------- .../stable/2023-09-01/openapi.json | 56 +++---------------- 11 files changed, 38 insertions(+), 114 deletions(-) diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp index c7068156c821..ff3c443f7557 100644 --- a/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp @@ -26,5 +26,5 @@ model AutonomousDatabaseCharacterSetProperties { @visibility("read") @minLength(1) @maxLength(255) - characterSet: string; + characterSet?: string; } diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp index 91891da25d0d..bf3d8b820d61 100644 --- a/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp @@ -26,5 +26,5 @@ model AutonomousDatabaseNationalCharacterSetProperties { @visibility("read") @minLength(1) @maxLength(255) - characterSet: string; + characterSet?: string; } diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp index 8560d62b80fe..3171fdebcc8e 100644 --- a/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp @@ -26,7 +26,7 @@ model AutonomousDbVersionProperties { @visibility("read") @minLength(1) @maxLength(255) - version: string; + version?: string; @doc("The Autonomous Database workload type") @visibility("read") diff --git a/specification/oracle/models/exadata/dbNodes.tsp b/specification/oracle/models/exadata/dbNodes.tsp index bfb4a295cbaf..04c9556f6ec0 100644 --- a/specification/oracle/models/exadata/dbNodes.tsp +++ b/specification/oracle/models/exadata/dbNodes.tsp @@ -22,7 +22,7 @@ model DbNode is ProxyResource { model DbNodeProperties { @doc("DbNode OCID") @visibility("read") - ocid: Ocid; + ocid?: Ocid; @doc("Additional information about the planned maintenance.") @visibility("read") @@ -54,7 +54,7 @@ model DbNodeProperties { @doc("The OCID of the DB system.") @visibility("read") - dbSystemId: Ocid; + dbSystemId?: Ocid; @doc("The name of the Fault Domain the instance is contained in.") @minLength(1) diff --git a/specification/oracle/models/exadata/dbSystemShapes.tsp b/specification/oracle/models/exadata/dbSystemShapes.tsp index c76cf13f1f79..3e80e8c9b6b9 100644 --- a/specification/oracle/models/exadata/dbSystemShapes.tsp +++ b/specification/oracle/models/exadata/dbSystemShapes.tsp @@ -26,7 +26,7 @@ model DbSystemShapeProperties { @doc("The maximum number of CPU cores that can be enabled on the DB system for this shape.") @visibility("read") - availableCoreCount: int32; + availableCoreCount?: int32; @doc("The minimum number of CPU cores that can be enabled on the DB system for this shape.") @visibility("read") diff --git a/specification/oracle/models/exadata/dnsPrivateViews.tsp b/specification/oracle/models/exadata/dnsPrivateViews.tsp index d697db6a5313..a961039310a2 100644 --- a/specification/oracle/models/exadata/dnsPrivateViews.tsp +++ b/specification/oracle/models/exadata/dnsPrivateViews.tsp @@ -21,7 +21,7 @@ model DnsPrivateView is ProxyResource { model DnsPrivateViewProperties { @doc("The OCID of the view") @visibility("read") - ocid: Ocid; + ocid?: Ocid; @doc("The display name of the view resource") @visibility("read") @@ -29,7 +29,7 @@ model DnsPrivateViewProperties { @doc("A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.") @visibility("read") - isProtected: boolean; + isProtected?: boolean; @doc("Views lifecycleState") @visibility("read") @@ -37,15 +37,15 @@ model DnsPrivateViewProperties { @doc("The canonical absolute URL of the resource.") @visibility("read") - self: string; + self?: string; @doc("views timeCreated") @visibility("read") - timeCreated: utcDateTime; + timeCreated?: utcDateTime; @doc("views timeCreated") @visibility("read") - timeUpdated: utcDateTime; + timeUpdated?: utcDateTime; @doc("Azure resource provisioning state.") @visibility("read") diff --git a/specification/oracle/models/exadata/dnsPrivateZones.tsp b/specification/oracle/models/exadata/dnsPrivateZones.tsp index 7713ed63fb9b..93fe7769b273 100644 --- a/specification/oracle/models/exadata/dnsPrivateZones.tsp +++ b/specification/oracle/models/exadata/dnsPrivateZones.tsp @@ -23,11 +23,11 @@ model DnsPrivateZone is ProxyResource { model DnsPrivateZoneProperties { @doc("The OCID of the Zone") @visibility("read") - ocid: Ocid; + ocid?: Ocid; @doc("A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.") @visibility("read") - isProtected: boolean; + isProtected?: boolean; @doc("Zones lifecycleState") @visibility("read") @@ -35,15 +35,15 @@ model DnsPrivateZoneProperties { @doc("The canonical absolute URL of the resource.") @visibility("read") - self: string; + self?: string; @doc("The current serial of the zone. As seen in the zone's SOA record.") @visibility("read") - serial: int32; + serial?: int32; @doc("Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.") @visibility("read") - version: string; + version?: string; @doc("The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.") @visibility("read") @@ -51,11 +51,11 @@ model DnsPrivateZoneProperties { @doc("The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.") @visibility("read") - zoneType: ZoneType; + zoneType?: ZoneType; @doc("Zones timeCreated") @visibility("read") - timeCreated: utcDateTime; + timeCreated?: utcDateTime; @doc("Azure resource provisioning state.") @visibility("read") diff --git a/specification/oracle/models/exadata/giVersions.tsp b/specification/oracle/models/exadata/giVersions.tsp index b61ac14c9d23..5699089bf101 100644 --- a/specification/oracle/models/exadata/giVersions.tsp +++ b/specification/oracle/models/exadata/giVersions.tsp @@ -22,5 +22,5 @@ model GiVersionProperties { @visibility("read") @minLength(1) @maxLength(255) - version: string; + version?: string; } diff --git a/specification/oracle/models/exadata/systemVersions.tsp b/specification/oracle/models/exadata/systemVersions.tsp index bfd2ed4af0d8..b47e22617554 100644 --- a/specification/oracle/models/exadata/systemVersions.tsp +++ b/specification/oracle/models/exadata/systemVersions.tsp @@ -32,5 +32,5 @@ model SystemVersionsFilter { model SystemVersionProperties { @doc("A valid Oracle System Version") @visibility("read") - systemVersion: string; + systemVersion?: string; } diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json index 99c09e6891a0..60ebeff32eec 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json @@ -4757,10 +4757,7 @@ "maxLength": 255, "readOnly": true } - }, - "required": [ - "characterSet" - ] + } }, "AutonomousDatabaseCloneProperties": { "type": "object", @@ -5049,10 +5046,7 @@ "maxLength": 255, "readOnly": true } - }, - "required": [ - "characterSet" - ] + } }, "AutonomousDatabaseProperties": { "type": "object", @@ -5428,10 +5422,7 @@ "description": "True if this version of the Oracle Database software has payments enabled.", "readOnly": true } - }, - "required": [ - "version" - ] + } }, "AutonomousMaintenanceScheduleType": { "type": "string", @@ -7148,11 +7139,7 @@ "description": "Azure resource provisioning state.", "readOnly": true } - }, - "required": [ - "ocid", - "dbSystemId" - ] + } }, "DbNodeProvisioningState": { "type": "string", @@ -7663,10 +7650,7 @@ "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", "readOnly": true } - }, - "required": [ - "availableCoreCount" - ] + } }, "DisasterRecoveryType": { "type": "string", @@ -7799,14 +7783,7 @@ "description": "Azure resource provisioning state.", "readOnly": true } - }, - "required": [ - "ocid", - "isProtected", - "self", - "timeCreated", - "timeUpdated" - ] + } }, "DnsPrivateViewsLifecycleState": { "type": "string", @@ -7937,16 +7914,7 @@ "description": "Azure resource provisioning state.", "readOnly": true } - }, - "required": [ - "ocid", - "isProtected", - "self", - "serial", - "version", - "zoneType", - "timeCreated" - ] + } }, "DnsPrivateZonesLifecycleState": { "type": "string", @@ -8148,10 +8116,7 @@ "maxLength": 255, "readOnly": true } - }, - "required": [ - "version" - ] + } }, "HostFormatType": { "type": "string", @@ -9448,10 +9413,7 @@ "description": "A valid Oracle System Version", "readOnly": true } - }, - "required": [ - "systemVersion" - ] + } }, "SystemVersionsFilter": { "type": "object", diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json index c52ff3db2159..1dcb369c3183 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json @@ -4757,10 +4757,7 @@ "maxLength": 255, "readOnly": true } - }, - "required": [ - "characterSet" - ] + } }, "AutonomousDatabaseCloneProperties": { "type": "object", @@ -5049,10 +5046,7 @@ "maxLength": 255, "readOnly": true } - }, - "required": [ - "characterSet" - ] + } }, "AutonomousDatabaseProperties": { "type": "object", @@ -5428,10 +5422,7 @@ "description": "True if this version of the Oracle Database software has payments enabled.", "readOnly": true } - }, - "required": [ - "version" - ] + } }, "AutonomousMaintenanceScheduleType": { "type": "string", @@ -7148,11 +7139,7 @@ "description": "Azure resource provisioning state.", "readOnly": true } - }, - "required": [ - "ocid", - "dbSystemId" - ] + } }, "DbNodeProvisioningState": { "type": "string", @@ -7663,10 +7650,7 @@ "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", "readOnly": true } - }, - "required": [ - "availableCoreCount" - ] + } }, "DisasterRecoveryType": { "type": "string", @@ -7799,14 +7783,7 @@ "description": "Azure resource provisioning state.", "readOnly": true } - }, - "required": [ - "ocid", - "isProtected", - "self", - "timeCreated", - "timeUpdated" - ] + } }, "DnsPrivateViewsLifecycleState": { "type": "string", @@ -7937,16 +7914,7 @@ "description": "Azure resource provisioning state.", "readOnly": true } - }, - "required": [ - "ocid", - "isProtected", - "self", - "serial", - "version", - "zoneType", - "timeCreated" - ] + } }, "DnsPrivateZonesLifecycleState": { "type": "string", @@ -8148,10 +8116,7 @@ "maxLength": 255, "readOnly": true } - }, - "required": [ - "version" - ] + } }, "HostFormatType": { "type": "string", @@ -9448,10 +9413,7 @@ "description": "A valid Oracle System Version", "readOnly": true } - }, - "required": [ - "systemVersion" - ] + } }, "SystemVersionsFilter": { "type": "object", From efef59e950034b937c8d98779ce3a2e8ddbcd7de Mon Sep 17 00:00:00 2001 From: Mary Gao Date: Fri, 28 Jun 2024 09:05:45 +0800 Subject: [PATCH 257/343] tsp, loadtesting, update client.tsp to fix the path change issue for action operation (#29597) * Update the client.tsp * Update specification/loadtestservice/LoadTestService/client.tsp --- specification/loadtestservice/LoadTestService/client.tsp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/specification/loadtestservice/LoadTestService/client.tsp b/specification/loadtestservice/LoadTestService/client.tsp index 0b0a9a46833d..021393f03ca9 100644 --- a/specification/loadtestservice/LoadTestService/client.tsp +++ b/specification/loadtestservice/LoadTestService/client.tsp @@ -57,7 +57,8 @@ interface TestRunOperations { listMetrics is LoadTestRun.listMetrics; listTestRuns is LoadTestRun.listTestRuns; #suppress "@azure-tools/typespec-azure-core/no-operation-id" - stopTestRun is LoadTestRun.stop; + @clientName("stopTestRun", "javascript,python,java,csharp,go") + stop is LoadTestRun.stop; } @client({ @@ -81,5 +82,6 @@ interface TestProfileRunOperations { getTestProfileRun is TestProfileRunAdministration.getTestProfileRun; listTestProfileRuns is TestProfileRunAdministration.listTestProfileRuns; #suppress "@azure-tools/typespec-azure-core/no-operation-id" - stopTestProfileRun is TestProfileRunAdministration.stop; + @clientName("stopTestProfileRun", "javascript,python,java,csharp,go") + stop is TestProfileRunAdministration.stop; } From 6bebe7d575204dd63ef437e7ba736b4922350a9d Mon Sep 17 00:00:00 2001 From: Arthur Ma Date: Fri, 28 Jun 2024 10:04:04 +0800 Subject: [PATCH 258/343] [Informatica] Fix property type (#29605) --- .../Informatica.DataManagement/client.tsp | 86 +++++++++++++++++++ ...zations_CreateOrUpdate_MaximumSet_Gen.json | 6 +- ...tAllServerlessRuntimes_MaximumSet_Gen.json | 4 +- .../Organizations_Get_MaximumSet_Gen.json | 2 +- ...ns_ListByResourceGroup_MaximumSet_Gen.json | 2 +- ...ons_ListBySubscription_MaximumSet_Gen.json | 2 +- .../Organizations_Update_MaximumSet_Gen.json | 4 +- ...untimes_CreateOrUpdate_MaximumSet_Gen.json | 12 +-- ...ServerlessRuntimes_Get_MaximumSet_Gen.json | 4 +- ...caOrganizationResource_MaximumSet_Gen.json | 4 +- ...ServerlessResourceById_MaximumSet_Gen.json | 4 +- ...verlessRuntimes_Update_MaximumSet_Gen.json | 8 +- .../Informatica.DataManagement/main.tsp | 12 +-- .../Informatica.DataManagement/tspconfig.yaml | 4 + ...zations_CreateOrUpdate_MaximumSet_Gen.json | 6 +- ...tAllServerlessRuntimes_MaximumSet_Gen.json | 4 +- .../Organizations_Get_MaximumSet_Gen.json | 2 +- ...ns_ListByResourceGroup_MaximumSet_Gen.json | 2 +- ...ons_ListBySubscription_MaximumSet_Gen.json | 2 +- .../Organizations_Update_MaximumSet_Gen.json | 4 +- ...untimes_CreateOrUpdate_MaximumSet_Gen.json | 12 +-- ...ServerlessRuntimes_Get_MaximumSet_Gen.json | 4 +- ...caOrganizationResource_MaximumSet_Gen.json | 4 +- ...ServerlessResourceById_MaximumSet_Gen.json | 4 +- ...verlessRuntimes_Update_MaximumSet_Gen.json | 8 +- .../stable/2024-05-08/openapi.json | 44 ++++++++-- 26 files changed, 185 insertions(+), 65 deletions(-) diff --git a/specification/informatica/Informatica.DataManagement/client.tsp b/specification/informatica/Informatica.DataManagement/client.tsp index 0fb1792bcb4d..070fa3ec46fd 100644 --- a/specification/informatica/Informatica.DataManagement/client.tsp +++ b/specification/informatica/Informatica.DataManagement/client.tsp @@ -4,3 +4,89 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; @@clientName(Informatica.DataManagement, "InformaticaDataMgmt", "python"); + +namespace Informatica.DataManagement { + @@access(Operations.list, Access.internal); + + @@clientName(InformaticaOrganizationResource, + "InformaticaOrganization", + "csharp" + ); + @@clientName(OrganizationProperties, + "InformaticaOrganizationProperties", + "csharp" + ); + @@clientName(InformaticaServerlessRuntimeResource, + "InformaticaServerlessRuntime", + "csharp" + ); + @@clientName(ApplicationConfigs, "InformaticaApplicationConfigs", "csharp"); + @@clientName(ApplicationType, "InformaticaApplicationType", "csharp"); + @@clientName(ApplicationTypeMetadata, + "InformaticaApplicationTypeMetadata", + "csharp" + ); + @@clientName(CdiConfigProps, "CdiConfigProperties", "csharp"); + @@clientName(CheckDependenciesResponse, "CheckDependenciesResult", "csharp"); + @@clientName(CompanyDetails, "InformaticaCompanyDetails", "csharp"); + @@clientName(CompanyDetailsUpdate, + "InformaticaCompanyDetailsUpdate", + "csharp" + ); + @@clientName(InfaRuntimeResourceFetchMetaData, + "InformaticaRuntimeResourceFetchMetadata", + "csharp" + ); + @@clientName(InfaServerlessFetchConfigProperties, + "InformaticaServerlessFetchConfigProperties", + "csharp" + ); + @@clientName(MarketplaceDetails, "InformaticaMarketplaceDetails", "csharp"); + @@clientName(MarketplaceDetailsUpdate, + "InformaticaMarketplaceDetailsUpdate", + "csharp" + ); + @@clientName(NetworkInterfaceConfiguration, + "InformaticaNetworkInterfaceConfiguration", + "csharp" + ); + @@clientName(NetworkInterfaceConfigurationUpdate, + "InformaticaNetworkInterfaceConfigurationUpdate", + "csharp" + ); + @@clientName(OfferDetails, "InformaticaOfferDetails", "csharp"); + @@clientName(OfferDetailsUpdate, "InformaticaOfferDetailsUpdate", "csharp"); + @@clientName(OrganizationPropertiesCustomUpdate, + "InformaticaOrganizationPropertiesUpdate", + "csharp" + ); + @@clientName(PlatformType, "InformaticaPlatformType", "csharp"); + @@clientName(ProvisioningState, "InformaticaProvisioningState", "csharp"); + @@clientName(RegionsMetadata, "InformaticaRegionsMetadata", "csharp"); + @@clientName(RuntimeType, "InformaticaRuntimeType", "csharp"); + @@clientName(ServerlessRuntimePropertiesCustomUpdate, + "ServerlessRuntimePropertiesUpdate", + "csharp" + ); + @@clientName(UserDetails, "InformaticaUserDetails", "csharp"); + @@clientName(UserDetailsUpdate, "InformaticaUserDetailsUpdate", "csharp"); + + @@clientName(ApplicationConfigs.type, "ApplicationConfigsType", "csharp"); + @@clientName(ApplicationType.CDI, "Cdi", "csharp"); + @@clientName(ApplicationType.CDIE, "Cdie", "csharp"); + @@clientName(InfaRuntimeResourceFetchMetaData.type, "RuntimeType", "csharp"); + @@clientName(InformaticaProperties.singleSignOnUrl, + "SingleSignOnUri", + "csharp" + ); + @@clientName(PlatformType.AZURE, "Azure", "csharp"); + @@clientName(RuntimeType.SERVERLESS, "Serverless", "csharp"); + @@clientName(ServerlessMetadataResponse.type, "RuntimeType", "csharp"); + + @@clientName(ServerlessRuntimes.serverlessResourceById, + "GetServerlessResourceById", + "csharp" + ); + + @@usage(ServerlessRuntimeNetworkProfileUpdate, Usage.output); +} diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json index 6f773c20da97..fcc843ba04b6 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -13,7 +13,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", @@ -60,7 +60,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", @@ -120,7 +120,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json index d77077cc37f2..06318830bfdc 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json @@ -33,10 +33,10 @@ "vnet": "vvs", "executionTimeout": "pbnxiricrjifreoiazmzeqiwu", "computeUnits": "ao", - "tenantId": "elbephnucclhjihcj", + "tenantId": "00000000-0000-0000-0000-000000000000", "subscriptionId": "zl", "region": "lrudpuvzcuh", - "serverlessArmResourceId": "kmviaxayvasaceptsuxkzhqjzjur" + "serverlessArmResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Informatica.DataManagement/organizations/org1/serverlessRuntimes/serverlessRuntimeName" }, "description": "kozzyfee" } diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json index 04b924a62fdd..e0ac50780af0 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json @@ -16,7 +16,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json index abf5a309fb5d..1273a003f18d 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -17,7 +17,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json index c3e4ce0ef2e8..0ba6a920206a 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -16,7 +16,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json index d9ac9070e270..939af4dfb1b7 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json @@ -37,7 +37,7 @@ "business": "mwqblnruflwpolgbxpqbqneve", "numberOfEmployees": 22 }, - "existingResourceId": "uvwlcphdfkqnhrtddpsiacbowcxxo" + "existingResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Informatica.DataManagement/organizations/org1/serverlessRuntimes/serverlessRuntimeName" } } }, @@ -50,7 +50,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "szhyxzgjtssjmlguivepc", diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json index 3cb8bb6a5fe2..01803b123802 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json @@ -18,8 +18,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, @@ -89,8 +89,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, @@ -173,8 +173,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json index a89adc20ac69..e1e0e72b700a 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json @@ -21,8 +21,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json index 3f262de5f901..41e61e294970 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json @@ -22,8 +22,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s" + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1" } }, "advancedCustomProperties": [ diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json index 4d046777b5b8..be32cecbbfc2 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json @@ -21,8 +21,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json index 44d39ec80ed9..7d69d8af08e8 100644 --- a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json +++ b/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json @@ -17,8 +17,8 @@ "serverlessAccountLocation": "goaugkyfanqfnvcmntreibqrswfpis", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "tnsqwwoxydeqqffumdnxlkkb", - "subnetId": "dctcuhgttxhcarwcrgdmsfwksyrzj", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, @@ -88,8 +88,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "tnsqwwoxydeqqffumdnxlkkb", - "subnetId": "dctcuhgttxhcarwcrgdmsfwksyrzj", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, diff --git a/specification/informatica/Informatica.DataManagement/main.tsp b/specification/informatica/Informatica.DataManagement/main.tsp index 086574ad2a0d..1f248963d92d 100644 --- a/specification/informatica/Informatica.DataManagement/main.tsp +++ b/specification/informatica/Informatica.DataManagement/main.tsp @@ -233,7 +233,7 @@ model InfaServerlessFetchConfigProperties { computeUnits?: string; @doc("Tenant ID") - tenantId?: string; + tenantId?: uuid; @doc("subscription ID") subscriptionId?: string; @@ -242,7 +242,7 @@ model InfaServerlessFetchConfigProperties { region?: string; @doc("Serverless Arm Resource ID") - serverlessArmResourceId?: string; + serverlessArmResourceId?: Azure.Core.armResourceIdentifier<[]>; } @doc("A Serverless Runtime environment resource by Informatica.") @@ -348,7 +348,7 @@ model InformaticaProperties { informaticaRegion?: string; @doc("Single sing on URL for informatica organization") - singleSignOnUrl?: string; + singleSignOnUrl?: url; } @doc("Link Organization") @@ -555,10 +555,10 @@ model ApplicationConfigs { @doc("Informatica Serverless Runtime Network Interface configurations.") model NetworkInterfaceConfiguration { @doc("Virtual network resource id") - vnetId: string; + vnetId: Azure.Core.armResourceIdentifier<[]>; @doc("Virtual network subnet resource id") - subnetId: string; + subnetId: Azure.Core.armResourceIdentifier<[]>; @doc("Virtual network resource guid") vnetResourceGuid?: string; @@ -654,7 +654,7 @@ model OrganizationPropertiesCustomUpdate { companyDetails?: CompanyDetailsUpdate; @doc("Existing Resource Id") - existingResourceId?: string; + existingResourceId?: Azure.Core.armResourceIdentifier<[]>; } /** Marketplace details */ diff --git a/specification/informatica/Informatica.DataManagement/tspconfig.yaml b/specification/informatica/Informatica.DataManagement/tspconfig.yaml index 8097586e6389..d351f52d8ea3 100644 --- a/specification/informatica/Informatica.DataManagement/tspconfig.yaml +++ b/specification/informatica/Informatica.DataManagement/tspconfig.yaml @@ -19,6 +19,10 @@ options: namespace: "com.azure.resourcemanager.informaticadatamanagement" service-name: "Informatica DataManagement" examples-directory: "examples" + "@azure-tools/typespec-csharp": + flavor: azure + clear-output-folder: true + namespace: "Azure.ResourceManager.InformaticaDataManagement" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json index 6f773c20da97..fcc843ba04b6 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -13,7 +13,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", @@ -60,7 +60,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", @@ -120,7 +120,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json index d77077cc37f2..06318830bfdc 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json @@ -33,10 +33,10 @@ "vnet": "vvs", "executionTimeout": "pbnxiricrjifreoiazmzeqiwu", "computeUnits": "ao", - "tenantId": "elbephnucclhjihcj", + "tenantId": "00000000-0000-0000-0000-000000000000", "subscriptionId": "zl", "region": "lrudpuvzcuh", - "serverlessArmResourceId": "kmviaxayvasaceptsuxkzhqjzjur" + "serverlessArmResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Informatica.DataManagement/organizations/org1/serverlessRuntimes/serverlessRuntimeName" }, "description": "kozzyfee" } diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_Get_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_Get_MaximumSet_Gen.json index 04b924a62fdd..e0ac50780af0 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_Get_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_Get_MaximumSet_Gen.json @@ -16,7 +16,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json index abf5a309fb5d..1273a003f18d 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -17,7 +17,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_ListBySubscription_MaximumSet_Gen.json index c3e4ce0ef2e8..0ba6a920206a 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_ListBySubscription_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -16,7 +16,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "ovenlecocg", diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_Update_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_Update_MaximumSet_Gen.json index d9ac9070e270..939af4dfb1b7 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_Update_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/Organizations_Update_MaximumSet_Gen.json @@ -37,7 +37,7 @@ "business": "mwqblnruflwpolgbxpqbqneve", "numberOfEmployees": 22 }, - "existingResourceId": "uvwlcphdfkqnhrtddpsiacbowcxxo" + "existingResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Informatica.DataManagement/organizations/org1/serverlessRuntimes/serverlessRuntimeName" } } }, @@ -50,7 +50,7 @@ "organizationId": "wtdmhlwhkvgqdumaehgfgiqcxgnqpx", "organizationName": "nomzbvwe", "informaticaRegion": "zfqodqpbeflhedypiijdkc", - "singleSignOnUrl": "espcbzjhtmgwfdkckhqk" + "singleSignOnUrl": "https://contoso.com/singlesignon" }, "marketplaceDetails": { "marketplaceSubscriptionId": "szhyxzgjtssjmlguivepc", diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json index 3cb8bb6a5fe2..01803b123802 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json @@ -18,8 +18,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, @@ -89,8 +89,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, @@ -173,8 +173,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_Get_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_Get_MaximumSet_Gen.json index a89adc20ac69..e1e0e72b700a 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_Get_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_Get_MaximumSet_Gen.json @@ -21,8 +21,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json index 3f262de5f901..41e61e294970 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json @@ -22,8 +22,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s" + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1" } }, "advancedCustomProperties": [ diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json index 4d046777b5b8..be32cecbbfc2 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json @@ -21,8 +21,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "uaqjvtubxccjs", - "subnetId": "s", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_Update_MaximumSet_Gen.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_Update_MaximumSet_Gen.json index 44d39ec80ed9..7d69d8af08e8 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_Update_MaximumSet_Gen.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/examples/ServerlessRuntimes_Update_MaximumSet_Gen.json @@ -17,8 +17,8 @@ "serverlessAccountLocation": "goaugkyfanqfnvcmntreibqrswfpis", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "tnsqwwoxydeqqffumdnxlkkb", - "subnetId": "dctcuhgttxhcarwcrgdmsfwksyrzj", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, @@ -88,8 +88,8 @@ "serverlessAccountLocation": "bkxdfopapbqucyhduewrubjpaei", "serverlessRuntimeNetworkProfile": { "networkInterfaceConfiguration": { - "vnetId": "tnsqwwoxydeqqffumdnxlkkb", - "subnetId": "dctcuhgttxhcarwcrgdmsfwksyrzj", + "vnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1", + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Networks/virtualNetworks/test-vnet/subnets/subnet1", "vnetResourceGuid": "5328d299-1462-4be0-bef1-303a28e556a0" } }, diff --git a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json index 75f73e977db1..46a3bb064830 100644 --- a/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json +++ b/specification/informatica/resource-manager/Informatica.DataManagement/stable/2024-05-08/openapi.json @@ -1099,6 +1099,11 @@ } } }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, "CdiConfigProps": { "type": "object", "description": "Informatica CDI Configuration Properties.", @@ -1344,7 +1349,7 @@ "description": "Compute Units" }, "tenantId": { - "type": "string", + "$ref": "#/definitions/Azure.Core.uuid", "description": "Tenant ID" }, "subscriptionId": { @@ -1357,7 +1362,11 @@ }, "serverlessArmResourceId": { "type": "string", - "description": "Serverless Arm Resource ID" + "format": "arm-id", + "description": "Serverless Arm Resource ID", + "x-ms-arm-id-details": { + "allowedResources": [] + } } } }, @@ -1433,6 +1442,7 @@ }, "singleSignOnUrl": { "type": "string", + "format": "uri", "description": "Single sing on URL for informatica organization" } } @@ -1617,11 +1627,19 @@ "properties": { "vnetId": { "type": "string", - "description": "Virtual network resource id" + "format": "arm-id", + "description": "Virtual network resource id", + "x-ms-arm-id-details": { + "allowedResources": [] + } }, "subnetId": { "type": "string", - "description": "Virtual network subnet resource id" + "format": "arm-id", + "description": "Virtual network subnet resource id", + "x-ms-arm-id-details": { + "allowedResources": [] + } }, "vnetResourceGuid": { "type": "string", @@ -1639,11 +1657,19 @@ "properties": { "vnetId": { "type": "string", - "description": "Virtual network resource id" + "format": "arm-id", + "description": "Virtual network resource id", + "x-ms-arm-id-details": { + "allowedResources": [] + } }, "subnetId": { "type": "string", - "description": "Virtual network subnet resource id" + "format": "arm-id", + "description": "Virtual network subnet resource id", + "x-ms-arm-id-details": { + "allowedResources": [] + } }, "vnetResourceGuid": { "type": "string", @@ -1783,7 +1809,11 @@ }, "existingResourceId": { "type": "string", - "description": "Existing Resource Id" + "format": "arm-id", + "description": "Existing Resource Id", + "x-ms-arm-id-details": { + "allowedResources": [] + } } } }, From 00a6d4f6cdfe2e3ffd069d0771ee0a52143a13c0 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Fri, 28 Jun 2024 10:55:38 +0800 Subject: [PATCH 259/343] java, informatica disable emitter in tspconfig (#29598) --- .../Informatica.DataManagement/tspconfig.yaml | 12 ++++++------ .../informatica/resource-manager/readme.java.md | 2 ++ 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/specification/informatica/Informatica.DataManagement/tspconfig.yaml b/specification/informatica/Informatica.DataManagement/tspconfig.yaml index d351f52d8ea3..b3a0a313df39 100644 --- a/specification/informatica/Informatica.DataManagement/tspconfig.yaml +++ b/specification/informatica/Informatica.DataManagement/tspconfig.yaml @@ -13,12 +13,12 @@ options: package-dir: "azure-mgmt-informaticadatamanagement" package-name: "{package-dir}" flavor: "azure" - "@azure-tools/typespec-java": - package-dir: "azure-resourcemanager-informaticadatamanagement" - flavor: "azure" - namespace: "com.azure.resourcemanager.informaticadatamanagement" - service-name: "Informatica DataManagement" - examples-directory: "examples" + # "@azure-tools/typespec-java": + # package-dir: "azure-resourcemanager-informaticadatamanagement" + # flavor: "azure" + # namespace: "com.azure.resourcemanager.informaticadatamanagement" + # service-name: "Informatica DataManagement" + # examples-directory: "examples" "@azure-tools/typespec-csharp": flavor: azure clear-output-folder: true diff --git a/specification/informatica/resource-manager/readme.java.md b/specification/informatica/resource-manager/readme.java.md index f8d8ad47bcf3..d62cda4a7c2f 100644 --- a/specification/informatica/resource-manager/readme.java.md +++ b/specification/informatica/resource-manager/readme.java.md @@ -5,4 +5,6 @@ These settings apply only when `--java` is specified on the command line. ```yaml $(java) service-name: Informatica DataManagement client-flattened-annotation-target: disabled +uuid-as-string: true +output-model-immutable: true ``` From a2b526504c60d58ef977ab63ac326ccefb8a208e Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Fri, 28 Jun 2024 13:07:40 -0700 Subject: [PATCH 260/343] [TypeSpecRequirement] Convert to GitHub Action (#29615) --- .github/workflows/typespec-requirement.yaml | 38 +++++++++++++++++++++ eng/pipelines/typespec-requirement.yml | 22 ------------ eng/scripts/Logging-Functions.ps1 | 23 +++++++++++++ 3 files changed, 61 insertions(+), 22 deletions(-) create mode 100644 .github/workflows/typespec-requirement.yaml delete mode 100644 eng/pipelines/typespec-requirement.yml diff --git a/.github/workflows/typespec-requirement.yaml b/.github/workflows/typespec-requirement.yaml new file mode 100644 index 000000000000..d55a79d1038c --- /dev/null +++ b/.github/workflows/typespec-requirement.yaml @@ -0,0 +1,38 @@ +name: TypeSpec Requirement + +on: pull_request + +jobs: + TypeSpec-Requirement: + name: TypeSpec Requirement + strategy: + fail-fast: false + matrix: + spec-type: [data-plane, resource-manager] + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + with: + # Required since "HEAD^" is passed to TypeSpec-Requirement.ps1 + fetch-depth: 2 + + - name: Use Node 20.0 + uses: actions/setup-node@v4 + with: + node-version: 20.0 + + - run: npm --version --loglevel info + + - run: npm ci + + - run: npm ls -a + continue-on-error: true + + - run: | + eng/scripts/TypeSpec-Requirement.ps1 ` + -BaseCommitish HEAD^ ` + -TargetCommitish HEAD ` + -SpecType ${{ matrix.spec-type }} + shell: pwsh diff --git a/eng/pipelines/typespec-requirement.yml b/eng/pipelines/typespec-requirement.yml deleted file mode 100644 index 28b370ddb1db..000000000000 --- a/eng/pipelines/typespec-requirement.yml +++ /dev/null @@ -1,22 +0,0 @@ -trigger: none - -jobs: -- job: - strategy: - matrix: - data-plane: - SpecType: data-plane - resource-manager: - SpecType: resource-manager - - pool: - name: azsdk-pool-mms-ubuntu-2204-general - vmImage: ubuntu-22.04 - - steps: - - template: /eng/pipelines/templates/steps/npm-install.yml - - - pwsh: | - $(Build.SourcesDirectory)/eng/scripts/TypeSpec-Requirement.ps1 -SpecType $(SpecType) - displayName: TypeSpec Requirement - ignoreLASTEXITCODE: true diff --git a/eng/scripts/Logging-Functions.ps1 b/eng/scripts/Logging-Functions.ps1 index 3a407b283aa8..77ce43f7ef07 100644 --- a/eng/scripts/Logging-Functions.ps1 +++ b/eng/scripts/Logging-Functions.ps1 @@ -2,6 +2,10 @@ function Test-SupportsDevOpsLogging() { return ($null -ne $env:SYSTEM_TEAMPROJECTID) } +function Test-SupportsGitHubLogging() { + return ($null -ne $env:GITHUB_ACTIONS) +} + function LogInfo { Write-Host "$args" } @@ -10,6 +14,9 @@ function LogWarning { if (Test-SupportsDevOpsLogging) { Write-Host ("##vso[task.LogIssue type=warning;]$args" -replace "`n", "%0D%0A") } + elseif (Test-SupportsGitHubLogging) { + Write-Host ("::warning::$args" -replace "`n", "%0D%0A") + } else { Write-Warning "$args" } @@ -20,6 +27,9 @@ function LogErrorForFile($file, $errorString) if (Test-SupportsDevOpsLogging) { Write-Host ("##vso[task.logissue type=error;sourcepath=$file;linenumber=1;columnnumber=1;]$errorString" -replace "`n", "%0D%0A") } + elseif (Test-SupportsGitHubLogging) { + Write-Host ("::error file=$file,line=1,col=1::$errorString" -replace "`n", "%0D%0A") + } else { Write-Error "[Error in file $file]$errorString" } @@ -28,6 +38,9 @@ function LogError { if (Test-SupportsDevOpsLogging) { Write-Host ("##vso[task.LogIssue type=error;]$args" -replace "`n", "%0D%0A") } + elseif (Test-SupportsGitHubLogging) { + Write-Host ("::error::$args" -replace "`n", "%0D%0A") + } else { Write-Error "$args" } @@ -37,6 +50,9 @@ function LogDebug { if (Test-SupportsDevOpsLogging) { Write-Host "[debug]$args" } + elseif (Test-SupportsGitHubLogging) { + Write-Host "::debug::$args" + } else { Write-Debug "$args" } @@ -46,16 +62,23 @@ function LogGroupStart() { if (Test-SupportsDevOpsLogging) { Write-Host "##[group]$args" } + elseif (Test-SupportsGitHubLogging) { + Write-Host "::group::$args" + } } function LogGroupEnd() { if (Test-SupportsDevOpsLogging) { Write-Host "##[endgroup]" } + elseif (Test-SupportsGitHubLogging) { + Write-Host "::endgroup::" + } } function LogJobFailure() { if (Test-SupportsDevOpsLogging) { Write-Host "##vso[task.complete result=Failed;]" } + # No equivalent for GitHub Actions. Failure is only determined by nonzero exit code. } From 81a4ee5a83ae38620c0e1404793caffe005d26e4 Mon Sep 17 00:00:00 2001 From: YunsongB <39966392+YunsongB@users.noreply.github.com> Date: Fri, 28 Jun 2024 15:49:41 -0600 Subject: [PATCH 261/343] Add AOAI 2024-06-01 GA API version; (#29612) Co-authored-by: Yunsong Bai Co-authored-by: Travis Wilson <35748617+trrwilson@users.noreply.github.com> --- .../AzureOpenAI/authoring/readme.md | 21 + .../stable/2024-06-01/azureopenai.json | 1751 ++++++++++ .../stable/2024-06-01/azureopenai.yaml | 1181 +++++++ .../examples/cancel_finetuning_job.json | 25 + .../examples/cancel_finetuning_job.yaml | 23 + .../2024-06-01/examples/delete_file.json | 13 + .../2024-06-01/examples/delete_file.yaml | 9 + .../2024-06-01/examples/delete_finetune.json | 13 + .../2024-06-01/examples/delete_finetune.yaml | 9 + .../examples/delete_finetuning_job.json | 13 + .../examples/delete_finetuning_job.yaml | 9 + .../stable/2024-06-01/examples/get_file.json | 22 + .../stable/2024-06-01/examples/get_file.yaml | 17 + .../2024-06-01/examples/get_file_content.json | 14 + .../2024-06-01/examples/get_file_content.yaml | 9 + .../stable/2024-06-01/examples/get_files.json | 35 + .../stable/2024-06-01/examples/get_files.yaml | 26 + .../examples/get_finetuning_job.json | 30 + .../examples/get_finetuning_job.yaml | 25 + .../get_finetuning_job_checkpoints.json | 70 + .../get_finetuning_job_checkpoints.yaml | 54 + .../examples/get_finetuning_job_events.json | 43 + .../examples/get_finetuning_job_events.yaml | 33 + .../examples/get_finetuning_jobs.json | 35 + .../examples/get_finetuning_jobs.yaml | 27 + .../2024-06-01/examples/get_model_base.json | 31 + .../2024-06-01/examples/get_model_base.yaml | 25 + .../examples/get_model_finetune.json | 32 + .../examples/get_model_finetune.yaml | 24 + .../2024-06-01/examples/get_models.json | 54 + .../2024-06-01/examples/get_models.yaml | 41 + .../2024-06-01/examples/import_file.json | 28 + .../2024-06-01/examples/import_file.yaml | 48 + .../examples/post_finetuning_job.json | 30 + .../examples/post_finetuning_job.yaml | 30 + .../2024-06-01/examples/upload_file.json | 25 + .../2024-06-01/examples/upload_file.yaml | 21 + .../AzureOpenAI/inference/readme.md | 7 + .../examples/audio_transcription_object.json | 15 + .../examples/audio_transcription_object.yaml | 9 + .../examples/audio_transcription_text.json | 15 + .../examples/audio_transcription_text.yaml | 19 + .../examples/audio_translation_object.json | 16 + .../examples/audio_translation_object.yaml | 20 + .../examples/audio_translation_text.json | 15 + .../examples/audio_translation_text.yaml | 20 + .../2024-06-01/examples/chat_completions.json | 43 + .../2024-06-01/examples/chat_completions.yaml | 45 + ...hat_completions_azure_search_advanced.json | 96 + ...hat_completions_azure_search_advanced.yaml | 63 + ...chat_completions_azure_search_minimum.json | 63 + ...chat_completions_azure_search_minimum.yaml | 39 + .../examples/chat_completions_cosmos_db.json | 77 + .../examples/chat_completions_cosmos_db.yaml | 49 + .../2024-06-01/examples/completions.json | 38 + .../2024-06-01/examples/embeddings.json | 1566 +++++++++ .../2024-06-01/examples/embeddings.yaml | 1553 +++++++++ .../2024-06-01/examples/image_generation.json | 67 + .../2024-06-01/examples/image_generation.yaml | 46 + .../stable/2024-06-01/inference.json | 3082 +++++++++++++++++ .../stable/2024-06-01/inference.yaml | 2084 +++++++++++ 61 files changed, 12943 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/cancel_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/cancel_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetune.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file_content.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file_content.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_events.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_events.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_jobs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_jobs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_base.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_base.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_finetune.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_models.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_models.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/import_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/import_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/post_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/post_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/upload_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/upload_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_advanced.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_minimum.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_cosmos_db.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/embeddings.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/embeddings.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/image_generation.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/image_generation.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/inference.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/inference.yaml diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md index 19fd3dad4d2a..baf6bd4a1ac4 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md @@ -308,3 +308,24 @@ directive: - suppress: IntegerTypeMustHaveFormat reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. ``` + + +## AzureOpenAI 2024-06-01 +These settings apply only when `--tag=release_2024_06_01` is specified on the command line. + +``` yaml $(tag) == 'release_2024_06_01' +input-file: stable/2024-06-01/azureopenai.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolved without breaking compatibility to existing openai api +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Existing external API uses property names like n_epochs, created_at, not following naming/casing guidelines from azure. + - suppress: ValidFormats + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. + - suppress: IntegerTypeMustHaveFormat + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. +``` diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.json new file mode 100644 index 000000000000..2894b9a871c3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.json @@ -0,0 +1,1751 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API version 2024-06-01", + "description": "APIs for fine-tuning and managing deployments of OpenAI models.", + "version": "2024-06-01" + }, + "paths": { + "/files": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job.", + "operationId": "Files_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "purpose", + "description": "Only return files with the given purpose.", + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + } + ] + } + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FileList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all files owned by this account.": { + "$ref": "./examples/get_files.json" + } + } + }, + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Upload", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + } + ] + } + }, + { + "in": "formData", + "name": "file", + "description": "Gets or sets the file to upload into Azure OpenAI.", + "required": true, + "type": "file" + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a file.": { + "$ref": "./examples/upload_file.json" + } + } + } + }, + "/files/{file-id}": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets details for a single file specified by the given file-id including status, size, purpose, etc.", + "operationId": "Files_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a file.": { + "$ref": "./examples/get_file.json" + } + } + }, + "delete": { + "tags": [ + "Files:" + ], + "summary": "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job.", + "operationId": "Files_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The file was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a file.": { + "$ref": "./examples/delete_file.json" + } + } + } + }, + "/files/{file-id}/content": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job.", + "operationId": "Files_GetContent", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting the file content.": { + "$ref": "./examples/get_file_content.json" + } + } + } + }, + "/files/import": { + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fileImport", + "description": "The definition of the file to create including its purpose, the file name and the url of the file location.", + "required": true, + "schema": { + "$ref": "#/definitions/FileImport" + } + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Importing a file with a blob url as source.": { + "$ref": "./examples/import_file.json" + } + } + } + }, + "/fine_tuning/jobs": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all fine tuning jobs owned by this account.": { + "$ref": "./examples/get_finetuning_jobs.json" + } + } + }, + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete.", + "operationId": "FineTuning_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fineTuningJob", + "description": "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others.", + "required": true, + "schema": { + "$ref": "#/definitions/FineTuningJobCreation" + } + } + ], + "responses": { + "201": { + "description": "The fine tune has been successfully created.", + "schema": { + "$ref": "#/definitions/FineTuningJob" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a fine tuning job.": { + "$ref": "./examples/post_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a fine tuning job.": { + "$ref": "./examples/get_finetuning_job.json" + } + } + }, + "delete": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Deletes the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The fine tune was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a fine tuning job.": { + "$ref": "./examples/delete_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/events": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_GetEvents", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobEventList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting events of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_events.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training.", + "operationId": "FineTuning_GetCheckpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last checkpoint ID from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of checkpoints to retrieve. Defaults to 10.", + "type": "integer", + "format": "int32", + "default": 10 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobCheckpointList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting checkpoints of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_checkpoints.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/cancel": { + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Cancels the processing of the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The fine tune has been successfully canceled", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a fine tuning job.": { + "$ref": "./examples/cancel_finetuning_job.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource.", + "operationId": "Models_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all models owned by account.": { + "$ref": "./examples/get_models.json" + } + } + } + }, + "/models/{model-id}": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets details for the model specified by the given modelId.", + "operationId": "Models_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "model-id", + "description": "The identifier of the model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a base model.": { + "$ref": "./examples/get_model_base.json" + }, + "Getting a fine-tuned model.": { + "$ref": "./examples/get_model_finetune.json" + } + } + } + } + }, + "definitions": { + "Capabilities": { + "title": "Capabilities", + "description": "The capabilities of a base or fine tune model.", + "required": [ + "chat_completion", + "completion", + "embeddings", + "fine_tune", + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "description": "A value indicating whether a model can be used for fine tuning.", + "type": "boolean" + }, + "inference": { + "description": "A value indicating whether a model can be deployed.", + "type": "boolean" + }, + "completion": { + "description": "A value indicating whether a model supports completion.", + "type": "boolean" + }, + "chat_completion": { + "description": "A value indicating whether a model supports chat completion.", + "type": "boolean" + }, + "embeddings": { + "description": "A value indicating whether a model supports embeddings.", + "type": "boolean" + } + } + }, + "Deprecation": { + "title": "Deprecation", + "description": "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties.", + "required": [ + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "format": "unixtime", + "description": "The end date of fine tune support of this model. Will be `null` for fine tune models.", + "type": "integer" + }, + "inference": { + "format": "unixtime", + "description": "The end date of inference support of this model.", + "type": "integer" + } + } + }, + "Error": { + "title": "Error", + "description": "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "description": "The message of this error.", + "minLength": 1, + "type": "string" + }, + "target": { + "description": "The location where the error happened if available.", + "type": "string" + }, + "details": { + "description": "The error details if available.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + }, + "readOnly": true + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "conflict", + "invalidPayload", + "forbidden", + "notFound", + "unexpectedEntityState", + "itemDoesAlreadyExist", + "serviceUnavailable", + "internalFailure", + "quotaExceeded", + "jsonlValidationFailed", + "fileImportFailed", + "tooManyRequests", + "unauthorized", + "contentFilter" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "conflict", + "description": "The requested operation conflicts with the current resource state." + }, + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + }, + { + "value": "forbidden", + "description": "The operation is forbidden for the current user/api key." + }, + { + "value": "notFound", + "description": "The resource is not found." + }, + { + "value": "unexpectedEntityState", + "description": "The operation cannot be executed in the current resource's state." + }, + { + "value": "itemDoesAlreadyExist", + "description": "The item does already exist." + }, + { + "value": "serviceUnavailable", + "description": "The service is currently not available." + }, + { + "value": "internalFailure", + "description": "Internal error. Please retry." + }, + { + "value": "quotaExceeded", + "description": "Quota exceeded." + }, + { + "value": "jsonlValidationFailed", + "description": "Validation of jsonl data failed." + }, + { + "value": "fileImportFailed", + "description": "Import of file failed." + }, + { + "value": "tooManyRequests", + "description": "Too many requests. Please retry later." + }, + { + "value": "unauthorized", + "description": "The current user/api key is not authorized for the operation." + }, + { + "value": "contentFilter", + "description": "Image generation failed as a result of our safety system." + } + ] + } + }, + "ErrorResponse": { + "title": "ErrorResponse", + "description": "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "EventType": { + "title": "EventType", + "description": "Defines the severity of a content filter result.", + "enum": [ + "message", + "metrics" + ], + "type": "string", + "x-ms-enum": { + "name": "EventType", + "modelAsString": true, + "values": [ + { + "value": "message", + "description": "Event only contains human readable messages." + }, + { + "value": "metrics", + "description": "Event contains metrics." + } + ] + } + }, + "File": { + "title": "File", + "description": "A file is a document usable for training and validation. It can also be a service generated document with result details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FileState" + }, + "bytes": { + "format": "int64", + "description": "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers.", + "type": "integer", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + }, + "status_details": { + "description": "The error message with details in case processing of this file failed.", + "type": "string", + "readOnly": true + } + } + }, + "FileImport": { + "title": "FileImport", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "filename", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples.", + "minLength": 1, + "type": "string" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileList": { + "title": "FileList", + "description": "Represents a list of files.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + } + } + } + }, + "FileState": { + "title": "FileState", + "description": "The state of a file.", + "enum": [ + "uploaded", + "pending", + "running", + "processed", + "error", + "deleting", + "deleted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileState", + "modelAsString": true, + "values": [ + { + "value": "uploaded", + "description": "The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "processed", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "error", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + }, + { + "value": "deleting", + "description": "The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state." + }, + { + "value": "deleted", + "description": "The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state." + } + ] + } + }, + "FineTuningHyperParameters": { + "title": "FineTuningHyperParameters", + "description": "The hyper parameter settings used in a fine tune job.", + "type": "object", + "properties": { + "n_epochs": { + "format": "int32", + "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", + "type": "integer" + }, + "batch_size": { + "format": "int32", + "description": "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model.", + "type": "integer" + }, + "learning_rate_multiplier": { + "format": "double", + "description": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.", + "type": "number" + } + } + }, + "FineTuningJob": { + "title": "FineTuningJob", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The identifier (model-id) of the base model used for the fine-tune.", + "minLength": 1, + "type": "string" + }, + "fine_tuned_model": { + "description": "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing.", + "type": "string" + }, + "training_file": { + "description": "The file which is used for training.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file which is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "result_files": { + "description": "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs.", + "type": "array", + "items": { + "type": "string" + } + }, + "finished_at": { + "format": "int32", + "description": "A timestamp when this job or item has finished successfully (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "organisation_id": { + "description": "The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.", + "type": "string" + }, + "trained_tokens": { + "format": "int32", + "description": "The total number of billable tokens processed by this fine tuning job.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/FineTuningJobError" + }, + "estimated_finish": { + "format": "int32", + "description": "The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.", + "type": "integer" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job.", + "type": "integer" + } + } + }, + "FineTuningJobCheckpoint": { + "title": "FineTuningJobCheckpoint", + "required": [ + "created_at", + "fine_tuned_model_checkpoint", + "fine_tuning_job_id", + "metrics", + "step_number" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this checkpoint.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the checkpoint was created.", + "type": "integer" + }, + "fine_tuned_model_checkpoint": { + "description": "The name of the fine-tuned checkpoint model that is created.", + "minLength": 1, + "type": "string" + }, + "step_number": { + "format": "int32", + "description": "The step number that the checkpoint was created at.", + "type": "integer" + }, + "metrics": { + "title": "Dictionary`2", + "description": "The metrics at the step number during the fine-tuning job.", + "type": "object", + "additionalProperties": { + "format": "double", + "type": "number" + } + }, + "fine_tuning_job_id": { + "description": "The name of the fine-tuning job that this checkpoint was created from..", + "minLength": 1, + "type": "string" + } + } + }, + "FineTuningJobCheckpointList": { + "title": "FineTuningJobCheckpointList", + "description": "Represents a list of checkpoints.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobCheckpoint" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobCreation": { + "title": "FineTuningJobCreation", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "model": { + "description": "The identifier (model-id) of the base model used for this fine-tune.", + "minLength": 1, + "type": "string" + }, + "training_file": { + "description": "The file identity (file-id) that is used for training this fine tuned model.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file identity (file-id) that is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.", + "type": "integer" + } + } + }, + "FineTuningJobError": { + "title": "FineTuningJobError", + "description": "For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.", + "type": "object", + "properties": { + "code": { + "description": "The machine-readable error code..", + "type": "string" + }, + "message": { + "description": "The human-readable error message.", + "type": "string" + }, + "param": { + "description": "The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.", + "type": "string" + } + } + }, + "FineTuningJobEvent": { + "title": "FineTuningJobEvent", + "required": [ + "created_at", + "level", + "message", + "type" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this event.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this event was created (in unix epochs).", + "type": "integer" + }, + "level": { + "$ref": "#/definitions/LogLevel" + }, + "message": { + "description": "The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.", + "minLength": 1, + "type": "string" + }, + "type": { + "$ref": "#/definitions/EventType" + }, + "data": { + "description": "Machine readable data of this event." + } + } + }, + "FineTuningJobEventList": { + "title": "FineTuningJobEventList", + "description": "Represents a list of events.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobEvent" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobList": { + "title": "FineTuningJobList", + "description": "Represents a list of fine tunes.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningState": { + "title": "FineTuningState", + "description": "The state of a finetunes object or fine tuning job.", + "enum": [ + "created", + "pending", + "running", + "succeeded", + "cancelled", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FineTuningState", + "modelAsString": true, + "values": [ + { + "value": "created", + "description": "The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation is not yet queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "cancelled", + "description": "The operation has been cancelled and is incomplete. It can be categorized as a terminal state." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + } + ] + } + }, + "InnerError": { + "title": "InnerError", + "description": "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "InnerErrorCode": { + "title": "InnerErrorCode", + "description": "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "invalidPayload" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + } + ] + } + }, + "LifeCycleStatus": { + "title": "LifeCycleStatus", + "description": "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\".", + "enum": [ + "preview", + "generally-available" + ], + "type": "string", + "x-ms-enum": { + "name": "LifeCycleStatus", + "modelAsString": true, + "values": [ + { + "value": "preview", + "description": "Model is in preview and covered by the service preview terms." + }, + { + "value": "generally-available", + "description": "Model is generally available." + } + ] + } + }, + "LogLevel": { + "title": "LogLevel", + "description": "The verbosity level of an event.", + "enum": [ + "info", + "warning", + "error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": true, + "values": [ + { + "value": "info", + "description": "This event is for information only." + }, + { + "value": "warning", + "description": "This event represents a mitigated issue." + }, + { + "value": "error", + "description": "This message represents a non recoverable issue." + } + ] + } + }, + "Model": { + "title": "Model", + "description": "A model is either a base model or the result of a successful fine tune job.", + "required": [ + "capabilities", + "deprecation", + "lifecycle_status" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The base model identity (model-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "fine_tune": { + "description": "The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "capabilities": { + "$ref": "#/definitions/Capabilities" + }, + "lifecycle_status": { + "$ref": "#/definitions/LifeCycleStatus" + }, + "deprecation": { + "$ref": "#/definitions/Deprecation" + } + } + }, + "ModelList": { + "title": "ModelList", + "description": "Represents a list of models.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + } + } + }, + "OperationState": { + "title": "OperationState", + "description": "The state of a job or item.", + "enum": [ + "notRunning", + "running", + "succeeded", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "value": "notRunning", + "description": "The operation is not yet queued to be processed in the future." + }, + { + "value": "running", + "description": "The operation has started to be processed." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed." + } + ] + } + }, + "Purpose": { + "title": "Purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "enum": [ + "fine-tune", + "fine-tune-results" + ], + "type": "string", + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + } + ] + } + }, + "TypeDiscriminator": { + "title": "TypeDiscriminator", + "description": "Defines the type of an object.", + "enum": [ + "list", + "fine_tuning.job", + "file", + "fine_tuning.job.event", + "fine_tuning.job.checkpoint", + "model" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TypeDiscriminator", + "modelAsString": true, + "values": [ + { + "value": "list", + "description": "This object represents a list of other objects." + }, + { + "value": "fine_tuning.job", + "description": "This object represents a fine tune job." + }, + { + "value": "file", + "description": "This object represents a file." + }, + { + "value": "fine_tuning.job.event", + "description": "This object represents an event of a fine tuning job." + }, + { + "value": "fine_tuning.job.checkpoint", + "description": "This object represents a checkpoint of a fine tuning job." + }, + { + "value": "model", + "description": "This object represents a model (can be a base model or fine tune job result)." + } + ] + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace \"aoairesource\" with your Azure OpenAI account name).", + "required": true, + "type": "string", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "apiVersionQueryParameter": { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string", + "x-ms-client-default": "2024-06-01", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "api-key": { + "type": "apiKey", + "name": "api-key", + "in": "header", + "description": "Provide your Cognitive Services Azure OpenAI account key here." + } + }, + "security": [ + { + "api-key": [ ] + } + ], + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/openai", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.yaml new file mode 100644 index 000000000000..b4750990036b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.yaml @@ -0,0 +1,1181 @@ +swagger: '2.0' +info: + title: Azure OpenAI API version 2024-06-01 + description: APIs for fine-tuning and managing deployments of OpenAI models. + version: 2024-06-01 +paths: + /files: + get: + tags: + - 'Files:' + summary: "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job." + operationId: Files_List + produces: + - application/json + parameters: + - in: query + name: purpose + description: Only return files with the given purpose. + type: string + enum: + - fine-tune + - fine-tune-results + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FileList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting all files owned by this account.: + $ref: ./examples/get_files.json + post: + tags: + - 'Files:' + summary: Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Upload + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - $ref: '#/parameters/apiVersionQueryParameter' + - in: formData + name: purpose + description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. + required: true + type: string + enum: + - fine-tune + - fine-tune-results + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - in: formData + name: file + description: Gets or sets the file to upload into Azure OpenAI. + required: true + type: file + responses: + '201': + description: The file has been successfully created. + schema: + $ref: '#/definitions/File' + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Upload a file.: + $ref: ./examples/upload_file.json + /files/{file-id}: + get: + tags: + - 'Files:' + summary: Gets details for a single file specified by the given file-id including status, size, purpose, etc. + operationId: Files_Get + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/File' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting a file.: + $ref: ./examples/get_file.json + delete: + tags: + - 'Files:' + summary: "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job." + operationId: Files_Delete + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '204': + description: The file was successfully deleted. + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Deleting a file.: + $ref: ./examples/delete_file.json + /files/{file-id}/content: + get: + tags: + - 'Files:' + summary: "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job." + operationId: Files_GetContent + produces: + - application/octet-stream + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + type: file + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting the file content.: + $ref: ./examples/get_file_content.json + /files/import: + post: + tags: + - 'Files:' + summary: Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Import + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: '#/parameters/apiVersionQueryParameter' + - in: body + name: fileImport + description: The definition of the file to create including its purpose, the file name and the url of the file location. + required: true + schema: + $ref: '#/definitions/FileImport' + responses: + '201': + description: The file has been successfully created. + schema: + $ref: '#/definitions/File' + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Importing a file with a blob url as source.: + $ref: ./examples/import_file.json + /fine_tuning/jobs: + get: + tags: + - 'Fine-tuning:' + summary: "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJobList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting all fine tuning jobs owned by this account.: + $ref: ./examples/get_finetuning_jobs.json + post: + tags: + - 'Fine-tuning:' + summary: "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete." + operationId: FineTuning_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: '#/parameters/apiVersionQueryParameter' + - in: body + name: fineTuningJob + description: "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others." + required: true + schema: + $ref: '#/definitions/FineTuningJobCreation' + responses: + '201': + description: The fine tune has been successfully created. + schema: + $ref: '#/definitions/FineTuningJob' + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Creating a fine tuning job.: + $ref: ./examples/post_finetuning_job.json + /fine_tuning/jobs/{fine-tuning-job-id}: + get: + tags: + - 'Fine-tuning:' + summary: "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_Get + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJob' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting a fine tuning job.: + $ref: ./examples/get_finetuning_job.json + delete: + tags: + - 'Fine-tuning:' + summary: Deletes the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Delete + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '204': + description: The fine tune was successfully deleted. + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Deleting a fine tuning job.: + $ref: ./examples/delete_finetuning_job.json + /fine_tuning/jobs/{fine-tuning-job-id}/events: + get: + tags: + - 'Fine-tuning:' + summary: "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_GetEvents + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJobEventList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting events of a fine tuning job.: + $ref: ./examples/get_finetuning_job_events.json + /fine_tuning/jobs/{fine-tuning-job-id}/checkpoints: + get: + tags: + - 'Fine-tuning:' + summary: "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training." + operationId: FineTuning_GetCheckpoints + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last checkpoint ID from the previous pagination request. + type: string + - in: query + name: limit + description: Number of checkpoints to retrieve. Defaults to 10. + type: integer + format: int32 + default: 10 + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJobCheckpointList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting checkpoints of a fine tuning job.: + $ref: ./examples/get_finetuning_job_checkpoints.json + /fine_tuning/jobs/{fine-tuning-job-id}/cancel: + post: + tags: + - 'Fine-tuning:' + summary: Cancels the processing of the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Cancel + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: The fine tune has been successfully canceled + schema: + $ref: '#/definitions/FineTuningJob' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Canceling a fine tuning job.: + $ref: ./examples/cancel_finetuning_job.json + /models: + get: + tags: + - 'Models:' + summary: "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource." + operationId: Models_List + produces: + - application/json + parameters: + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/ModelList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting all models owned by account.: + $ref: ./examples/get_models.json + /models/{model-id}: + get: + tags: + - 'Models:' + summary: Gets details for the model specified by the given modelId. + operationId: Models_Get + produces: + - application/json + parameters: + - in: path + name: model-id + description: The identifier of the model. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/Model' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting a base model.: + $ref: ./examples/get_model_base.json + Getting a fine-tuned model.: + $ref: ./examples/get_model_finetune.json +definitions: + Capabilities: + title: Capabilities + description: The capabilities of a base or fine tune model. + required: + - chat_completion + - completion + - embeddings + - fine_tune + - inference + type: object + properties: + fine_tune: + description: A value indicating whether a model can be used for fine tuning. + type: boolean + inference: + description: A value indicating whether a model can be deployed. + type: boolean + completion: + description: A value indicating whether a model supports completion. + type: boolean + chat_completion: + description: A value indicating whether a model supports chat completion. + type: boolean + embeddings: + description: A value indicating whether a model supports embeddings. + type: boolean + Deprecation: + title: Deprecation + description: "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties." + required: + - inference + type: object + properties: + fine_tune: + format: unixtime + description: The end date of fine tune support of this model. Will be `null` for fine tune models. + type: integer + inference: + format: unixtime + description: The end date of inference support of this model. + type: integer + Error: + title: Error + description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - code + - message + type: object + properties: + code: + $ref: '#/definitions/ErrorCode' + message: + description: The message of this error. + minLength: 1 + type: string + target: + description: The location where the error happened if available. + type: string + details: + description: The error details if available. + type: array + items: + $ref: '#/definitions/Error' + innererror: + $ref: '#/definitions/InnerError' + readOnly: true + ErrorCode: + title: ErrorCode + description: "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - conflict + - invalidPayload + - forbidden + - notFound + - unexpectedEntityState + - itemDoesAlreadyExist + - serviceUnavailable + - internalFailure + - quotaExceeded + - jsonlValidationFailed + - fileImportFailed + - tooManyRequests + - unauthorized + - contentFilter + type: string + x-ms-enum: + name: ErrorCode + modelAsString: true + values: + - value: conflict + description: The requested operation conflicts with the current resource state. + - value: invalidPayload + description: The request data is invalid for this operation. + - value: forbidden + description: The operation is forbidden for the current user/api key. + - value: notFound + description: The resource is not found. + - value: unexpectedEntityState + description: The operation cannot be executed in the current resource's state. + - value: itemDoesAlreadyExist + description: The item does already exist. + - value: serviceUnavailable + description: The service is currently not available. + - value: internalFailure + description: Internal error. Please retry. + - value: quotaExceeded + description: Quota exceeded. + - value: jsonlValidationFailed + description: Validation of jsonl data failed. + - value: fileImportFailed + description: Import of file failed. + - value: tooManyRequests + description: Too many requests. Please retry later. + - value: unauthorized + description: The current user/api key is not authorized for the operation. + - value: contentFilter + description: Image generation failed as a result of our safety system. + ErrorResponse: + title: ErrorResponse + description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - error + type: object + properties: + error: + $ref: '#/definitions/Error' + EventType: + title: EventType + description: Defines the severity of a content filter result. + enum: + - message + - metrics + type: string + x-ms-enum: + name: EventType + modelAsString: true + values: + - value: message + description: Event only contains human readable messages. + - value: metrics + description: Event contains metrics. + File: + title: File + description: A file is a document usable for training and validation. It can also be a service generated document with result details. + required: + - filename + - purpose + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FileState' + bytes: + format: int64 + description: "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers." + type: integer + readOnly: true + purpose: + $ref: '#/definitions/Purpose' + filename: + description: The name of the file. + minLength: 1 + type: string + status_details: + description: The error message with details in case processing of this file failed. + type: string + readOnly: true + FileImport: + title: FileImport + description: Defines a document to import from an external content url to be usable with Azure OpenAI. + required: + - content_url + - filename + - purpose + type: object + properties: + purpose: + $ref: '#/definitions/Purpose' + filename: + description: "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples." + minLength: 1 + type: string + content_url: + format: url + description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). + type: string + FileList: + title: FileList + description: Represents a list of files. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/File' + FileState: + title: FileState + description: The state of a file. + enum: + - uploaded + - pending + - running + - processed + - error + - deleting + - deleted + type: string + readOnly: true + x-ms-enum: + name: FileState + modelAsString: true + values: + - value: uploaded + description: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. + - value: pending + description: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. + - value: running + description: The operation has started to be processed. It can be categorized as an active state. + - value: processed + description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. + - value: error + description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + - value: deleting + description: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. + - value: deleted + description: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. + FineTuningHyperParameters: + title: FineTuningHyperParameters + description: The hyper parameter settings used in a fine tune job. + type: object + properties: + n_epochs: + format: int32 + description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. + type: integer + batch_size: + format: int32 + description: "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model." + type: integer + learning_rate_multiplier: + format: double + description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results." + type: number + FineTuningJob: + title: FineTuningJob + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FineTuningState' + model: + description: The identifier (model-id) of the base model used for the fine-tune. + minLength: 1 + type: string + fine_tuned_model: + description: "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing." + type: string + training_file: + description: The file which is used for training. + minLength: 1 + type: string + validation_file: + description: The file which is used to evaluate the fine tuned model during training. + type: string + result_files: + description: "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs." + type: array + items: + type: string + finished_at: + format: int32 + description: A timestamp when this job or item has finished successfully (in unix epochs). + type: integer + readOnly: true + organisation_id: + description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. + type: string + trained_tokens: + format: int32 + description: The total number of billable tokens processed by this fine tuning job. + type: integer + readOnly: true + error: + $ref: '#/definitions/FineTuningJobError' + estimated_finish: + format: int32 + description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running. + type: integer + hyperparameters: + $ref: '#/definitions/FineTuningHyperParameters' + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. + type: integer + FineTuningJobCheckpoint: + title: FineTuningJobCheckpoint + required: + - created_at + - fine_tuned_model_checkpoint + - fine_tuning_job_id + - metrics + - step_number + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + id: + description: The identity of this checkpoint. + type: string + readOnly: true + created_at: + format: unixtime + description: The Unix timestamp (in seconds) for when the checkpoint was created. + type: integer + fine_tuned_model_checkpoint: + description: The name of the fine-tuned checkpoint model that is created. + minLength: 1 + type: string + step_number: + format: int32 + description: The step number that the checkpoint was created at. + type: integer + metrics: + title: Dictionary`2 + description: The metrics at the step number during the fine-tuning job. + type: object + additionalProperties: + format: double + type: number + fine_tuning_job_id: + description: The name of the fine-tuning job that this checkpoint was created from.. + minLength: 1 + type: string + FineTuningJobCheckpointList: + title: FineTuningJobCheckpointList + description: Represents a list of checkpoints. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/FineTuningJobCheckpoint' + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobCreation: + title: FineTuningJobCreation + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + model: + description: The identifier (model-id) of the base model used for this fine-tune. + minLength: 1 + type: string + training_file: + description: The file identity (file-id) that is used for training this fine tuned model. + minLength: 1 + type: string + validation_file: + description: The file identity (file-id) that is used to evaluate the fine tuned model during training. + type: string + hyperparameters: + $ref: '#/definitions/FineTuningHyperParameters' + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you. + type: integer + FineTuningJobError: + title: FineTuningJobError + description: 'For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.' + type: object + properties: + code: + description: The machine-readable error code.. + type: string + message: + description: The human-readable error message. + type: string + param: + description: 'The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.' + type: string + FineTuningJobEvent: + title: FineTuningJobEvent + required: + - created_at + - level + - message + - type + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + id: + description: The identity of this event. + type: string + readOnly: true + created_at: + format: unixtime + description: A timestamp when this event was created (in unix epochs). + type: integer + level: + $ref: '#/definitions/LogLevel' + message: + description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results. + minLength: 1 + type: string + type: + $ref: '#/definitions/EventType' + data: + description: Machine readable data of this event. + FineTuningJobEventList: + title: FineTuningJobEventList + description: Represents a list of events. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/FineTuningJobEvent' + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobList: + title: FineTuningJobList + description: Represents a list of fine tunes. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/FineTuningJob' + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningState: + title: FineTuningState + description: The state of a finetunes object or fine tuning job. + enum: + - created + - pending + - running + - succeeded + - cancelled + - failed + type: string + readOnly: true + x-ms-enum: + name: FineTuningState + modelAsString: true + values: + - value: created + description: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. + - value: pending + description: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. + - value: running + description: The operation has started to be processed. It can be categorized as an active state. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. + - value: cancelled + description: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + InnerError: + title: InnerError + description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + type: object + properties: + code: + $ref: '#/definitions/InnerErrorCode' + innererror: + $ref: '#/definitions/InnerError' + InnerErrorCode: + title: InnerErrorCode + description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - invalidPayload + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: invalidPayload + description: The request data is invalid for this operation. + LifeCycleStatus: + title: LifeCycleStatus + description: "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\"." + enum: + - preview + - generally-available + type: string + x-ms-enum: + name: LifeCycleStatus + modelAsString: true + values: + - value: preview + description: Model is in preview and covered by the service preview terms. + - value: generally-available + description: Model is generally available. + LogLevel: + title: LogLevel + description: The verbosity level of an event. + enum: + - info + - warning + - error + type: string + x-ms-enum: + name: LogLevel + modelAsString: true + values: + - value: info + description: This event is for information only. + - value: warning + description: This event represents a mitigated issue. + - value: error + description: This message represents a non recoverable issue. + Model: + title: Model + description: A model is either a base model or the result of a successful fine tune job. + required: + - capabilities + - deprecation + - lifecycle_status + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FineTuningState' + model: + description: The base model identity (model-id) if this is a fine tune model; otherwise `null`. + type: string + fine_tune: + description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`. + type: string + capabilities: + $ref: '#/definitions/Capabilities' + lifecycle_status: + $ref: '#/definitions/LifeCycleStatus' + deprecation: + $ref: '#/definitions/Deprecation' + ModelList: + title: ModelList + description: Represents a list of models. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/Model' + OperationState: + title: OperationState + description: The state of a job or item. + enum: + - notRunning + - running + - succeeded + - failed + type: string + readOnly: true + x-ms-enum: + name: OperationState + modelAsString: true + values: + - value: notRunning + description: The operation is not yet queued to be processed in the future. + - value: running + description: The operation has started to be processed. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. + Purpose: + title: Purpose + description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. + enum: + - fine-tune + - fine-tune-results + type: string + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + TypeDiscriminator: + title: TypeDiscriminator + description: Defines the type of an object. + enum: + - list + - fine_tuning.job + - file + - fine_tuning.job.event + - fine_tuning.job.checkpoint + - model + type: string + readOnly: true + x-ms-enum: + name: TypeDiscriminator + modelAsString: true + values: + - value: list + description: This object represents a list of other objects. + - value: fine_tuning.job + description: This object represents a fine tune job. + - value: file + description: This object represents a file. + - value: fine_tuning.job.event + description: This object represents an event of a fine tuning job. + - value: fine_tuning.job.checkpoint + description: This object represents a checkpoint of a fine tuning job. + - value: model + description: This object represents a model (can be a base model or fine tune job result). +parameters: + endpoint: + in: path + name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace "aoairesource" with your Azure OpenAI account name).' + required: true + type: string + format: url + x-ms-skip-url-encoding: true + x-ms-parameter-location: client + apiVersionQueryParameter: + in: query + name: api-version + description: The requested API version. + required: true + type: string + x-ms-client-default: 2024-06-01 + x-ms-parameter-location: client +securityDefinitions: + api-key: + type: apiKey + name: api-key + in: header + description: Provide your Cognitive Services Azure OpenAI account key here. +security: + - api-key: [ ] +schemes: + - https +x-ms-parameterized-host: + hostTemplate: '{endpoint}/openai' + useSchemePrefix: false + parameters: + - $ref: '#/parameters/endpoint' \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/cancel_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/cancel_finetuning_job.json new file mode 100644 index 000000000000..315a96fcb4ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/cancel_finetuning_job.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": 2 + }, + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "finished_at": 1646127311, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "canceled", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/cancel_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/cancel_finetuning_job.yaml new file mode 100644 index 000000000000..a965dc07d407 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/cancel_finetuning_job.yaml @@ -0,0 +1,23 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: 2 + suffix: + status: cancelled + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: 1646127311 + organisation_id: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_file.json new file mode 100644 index 000000000000..e2cb4576d119 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_file.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_file.yaml new file mode 100644 index 000000000000..ecfb71d5d86b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_file.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetune.json new file mode 100644 index 000000000000..fdab567f8227 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetune.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "fine-tune-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetune.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetune.yaml new file mode 100644 index 000000000000..f7f85646a69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetune.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + fine-tune-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetuning_job.json new file mode 100644 index 000000000000..acd69500cbf9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetuning_job.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetuning_job.yaml new file mode 100644 index 000000000000..b3531ad63f47 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/delete_finetuning_job.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file.json new file mode 100644 index 000000000000..53e6639a3f20 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file.yaml new file mode 100644 index 000000000000..f6923724b95c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file.yaml @@ -0,0 +1,17 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: + status_details: + status: processed + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file_content.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file_content.json new file mode 100644 index 000000000000..6e8b76e2c187 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": "raw file content" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file_content.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file_content.yaml new file mode 100644 index 000000000000..555ce3642f94 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_file_content.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: raw file content diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_files.json new file mode 100644 index 000000000000..42534afd0aa4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_files.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "object": "file" + }, + { + "bytes": 32423, + "purpose": "fine-tune-results", + "filename": "results.csv", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "object": "file" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_files.yaml new file mode 100644 index 000000000000..060684e31ddd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_files.yaml @@ -0,0 +1,26 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 +responses: + 200: + headers: {} + body: + data: + - status_details: + status: processed + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + - status_details: + status: processed + bytes: 32423 + purpose: fine-tune-results + filename: results.csv + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job.json new file mode 100644 index 000000000000..88fa4ce113c2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": 2 + }, + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job.yaml new file mode 100644 index 000000000000..69114d6af8bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: 2 + suffix: + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.json new file mode 100644 index 000000000000..6d7d387cf3dd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "fine-tuning-job-id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P", + "created_at": 1646126127, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10", + "step_number": 10, + "metrics": { + "step": 10, + "train_loss": 0.478, + "train_mean_token_accuracy": 0.924, + "valid_loss": 10.112, + "valid_mean_token_accuracy": 0.145, + "full_valid_loss": 0.567, + "full_valid_mean_token_accuracy": 0.944 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_frtXDR2453C4FG67t03MLPs5", + "created_at": 1646126137, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20", + "step_number": 20, + "metrics": { + "step": 20, + "train_loss": 0.355, + "train_mean_token_accuracy": 0.947, + "valid_loss": 11.32, + "valid_mean_token_accuracy": 0.122, + "full_valid_loss": 0.317, + "full_valid_mean_token_accuracy": 0.955 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_agLk6Gio560ORp14gl123fgd", + "created_at": 1646126147, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30", + "step_number": 30, + "metrics": { + "step": 30, + "train_loss": 0.155, + "train_mean_token_accuracy": 0.975, + "valid_loss": 9.31, + "valid_mean_token_accuracy": 0.092, + "full_valid_loss": 0.114, + "full_valid_mean_token_accuracy": 0.963 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + } + ], + "object": "list" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.yaml new file mode 100644 index 000000000000..d4254bd80195 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.yaml @@ -0,0 +1,54 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + fine-tuning-job-id: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P + created_at: 1646126127 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10 + stepNumber: 10 + metrics: + step: 10 + train_loss: 0.478 + train_mean_token_accuracy: 0.924 + valid_loss: 10.112 + valid_mean_token_accuracy: 0.145 + full_valid_loss: 0.567 + full_valid_mean_token_accuracy: 0.944 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_frtXDR2453C4FG67t03MLPs5 + created_at: 1646126137 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20 + stepNumber: 20 + metrics: + step: 20 + train_loss: 0.355 + train_mean_token_accuracy: 0.947 + valid_loss: 11.32 + valid_mean_token_accuracy: 0.122 + full_valid_loss: 0.317 + full_valid_mean_token_accuracy: 0.955 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_agLk6Gio560ORp14gl123fgd + created_at: 1646126147 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30 + stepNumber: 30 + metrics: + step: 30 + train_loss: 0.155 + train_mean_token_accuracy: 0.975 + valid_loss: 9.31 + valid_mean_token_accuracy: 0.092 + full_valid_loss: 0.114 + full_valid_mean_token_accuracy: 0.963 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_events.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_events.json new file mode 100644 index 000000000000..7862a0cada4e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_events.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ft-event-363dcd7cb4c74539bc53293c1dceef05", + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ft-event-8c2a44999790437cb3230e543fa2cf0f", + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ft-event-2d47d651d2f3484c8187c88c00078147", + "created_at": 1646126192, + "level": "info", + "message": "Job succeeded.", + "type": "message", + "object": "fine_tuning.job.event" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_events.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_events.yaml new file mode 100644 index 000000000000..51eaa205e06c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_events.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftevent-363dcd7cb4c74539bc53293c1dceef05 + created_at: 1646126127 + level: Info + message: Job enqueued. Waiting for jobs ahead to complete. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-8c2a44999790437cb3230e543fa2cf0f + created_at: 1646126169 + level: Info + message: Job started. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-2d47d651d2f3484c8187c88c00078147 + created_at: 1646126192 + level: Info + message: Job succeeded. + type: message + data: + object: fine_tuning.job.event + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_jobs.json new file mode 100644 index 000000000000..ff39ee0e0cf8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_jobs.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "hyperparameters": { + "n_epochs": 2 + }, + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_jobs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_jobs.yaml new file mode 100644 index 000000000000..9a083320f2cd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_jobs.yaml @@ -0,0 +1,27 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 +responses: + 200: + headers: {} + body: + has_more: false + data: + - hyperparameters: + n_epochs: 2 + suffix: + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_base.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_base.json new file mode 100644 index 000000000000..6544a3f38430 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_base.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "model-id": "curie" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "status": "succeeded", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_base.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_base.yaml new file mode 100644 index 000000000000..e348a4e069d6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_base.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + model-id: curie +responses: + 200: + headers: {} + body: + status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_finetune.json new file mode 100644 index 000000000000..bc19e74f0bcf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_finetune.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "model-id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_finetune.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_finetune.yaml new file mode 100644 index 000000000000..0bd0aa608b5c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_model_finetune.yaml @@ -0,0 +1,24 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 + model-id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_models.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_models.json new file mode 100644 index 000000000000..9f46dc3895e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_models.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "status": "succeeded", + "created_at": 1646126127, + "object": "model" + }, + { + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "object": "model" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_models.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_models.yaml new file mode 100644 index 000000000000..0710003c4767 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_models.yaml @@ -0,0 +1,41 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-06-01 +responses: + 200: + headers: {} + body: + data: + - status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model + - status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/import_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/import_file.json new file mode 100644 index 000000000000..1a7f4477a5ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/import_file.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "fileImport": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "notRunning", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/import_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/import_file.yaml new file mode 100644 index 000000000000..4af1881948b2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/import_file.yaml @@ -0,0 +1,48 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2023-10-01-preview + fileImport: + purpose: fine-tune + filename: puppy.jsonl + content_url: &o0 + absolutePath: /trainingdata/puppy.jsonl + absoluteUri: *o0 + localPath: /trainingdata/puppy.jsonl + authority: www.contoso.com + hostNameType: Dns + isDefaultPort: true + isFile: false + isLoopback: false + pathAndQuery: /trainingdata/puppy.jsonl + segments: + - / + - trainingdata/ + - puppy.jsonl + isUnc: false + host: www.contoso.com + port: 443 + query: '' + fragment: '' + scheme: https + originalString: *o0 + dnsSafeHost: www.contoso.com + idnHost: www.contoso.com + isAbsoluteUri: true + userEscaped: false + userInfo: '' + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + statistics: + status_details: + status: pending + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/post_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/post_finetuning_job.json new file mode 100644 index 000000000000..1bcdbb6ef462 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/post_finetuning_job.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "fineTuningJob": { + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "hyperparameters": { + "n_epochs": 2 + }, + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "notRunning", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/post_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/post_finetuning_job.yaml new file mode 100644 index 000000000000..3c8f95d31d7f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/post_finetuning_job.yaml @@ -0,0 +1,30 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2023-10-01-preview + fineTuningJob: + hyperparameters: + suffix: + model: curie + trainingFile: file-181a1cbdcdcf4677ada87f63a0928099 + validationFile: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f + body: + hyperparameters: + n_epochs: 2 + suffix: + status: pending + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: + organisation_id: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/upload_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/upload_file.json new file mode 100644 index 000000000000..b41b53c9af09 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/upload_file.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-06-01", + "purpose": "fine-tune", + "content-Type": "multipart/form-data", + "file": "raw file content" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "notRunning", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/upload_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/upload_file.yaml new file mode 100644 index 000000000000..67ecbb879ba8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/upload_file.yaml @@ -0,0 +1,21 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2023-10-01-preview + purpose: fine-tune + Content-Type: multipart/form-data + file: raw file content +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + statistics: + status_details: + status: pending + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md index c627e1fb7cfd..ef5984cec041 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md @@ -210,3 +210,10 @@ These settings apply only when `--tag=release_2024_05_01_preview_autogen` is spe ``` yaml $(tag) == 'release_2024_05_01_preview_autogen' input-file: preview/2024-05-01-preview/generated.json ``` + +## AzureOpenAI 2024-06-01 +These settings apply only when `--tag=release_2024_06_01` is specified on the command line. + +``` yaml $(tag) == 'release_2024_06_01' +input-file: stable/2024-06-01/inference.json +``` diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_object.json new file mode 100644 index 000000000000..d3f4ed8145df --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_object.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_object.yaml new file mode 100644 index 000000000000..14cd58252cf2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_object.yaml @@ -0,0 +1,9 @@ +parameters: + api-version: 2024-06-01 + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + body: + text: A structured object when requesting json or verbose_json +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_text.json new file mode 100644 index 000000000000..759d0c38eaeb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_text.yaml new file mode 100644 index 000000000000..fc908e1099df --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_transcription_text.yaml @@ -0,0 +1,19 @@ +parameters: + api-version: 2024-06-01 + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + example: plain text when requesting text, srt, or vtt + type: string +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_object.json new file mode 100644 index 000000000000..fa3bb9c8b891 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_object.json @@ -0,0 +1,16 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_object.yaml new file mode 100644 index 000000000000..2d9c1f166194 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_object.yaml @@ -0,0 +1,20 @@ +parameters: + api-version: 2024-06-01 + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + body: + text: A structured object when requesting json or verbose_json +title: Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_text.json new file mode 100644 index 000000000000..6673d653f034 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_text.yaml new file mode 100644 index 000000000000..4244f0420ad1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/audio_translation_text.yaml @@ -0,0 +1,20 @@ +parameters: + api-version: 2024-06-01 + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + example: plain text when requesting text, srt, or vtt + type: string +title: Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions.json new file mode 100644 index 000000000000..cc74fde4ef44 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions.json @@ -0,0 +1,43 @@ +{ + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions.yaml new file mode 100644 index 000000000000..d6d7fc36e1ce --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions.yaml @@ -0,0 +1,45 @@ +title: Creates a completion for the provided prompt, parameters and chosen model. +parameters: + endpoint: '{endpoint}' + api-version: 2024-06-01 + deployment-id: + body: + messages: + - role: system + content: you are a helpful assistant that talks like a pirate + - role: user + content: can you tell me how to care for a parrot? +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: |- + Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy: + + 1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr! + + 2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh! + + 3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands! + + 4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh! + + 5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr! + + 6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag! + + 7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be. + + 8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners. + + So there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' "Yo-ho-ho" for many years to come! Good luck, sailor, and may the wind be at yer back! + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..ce73db81c2cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_advanced.json @@ -0,0 +1,96 @@ +{ + "title": "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a cat?" + }, + { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "intent": "cat care" + } + }, + { + "role": "user", + "content": "how about dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content 2.", + "title": "Citation Title 2", + "filepath": "contoso2.txt", + "url": "https://contoso.blob.windows.net/container/contoso2.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_advanced.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_advanced.yaml new file mode 100644 index 000000000000..b532160e09bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_advanced.yaml @@ -0,0 +1,63 @@ +title: Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity. +parameters: + endpoint: '{endpoint}' + api-version: 2024-06-01 + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a cat? + - role: assistant + content: Content of the completion [doc1]. + context: + intent: cat care + - role: user + content: how about dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + authentication: + type: user_assigned_managed_identity + managed_identity_resource_id: /subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name} + index_name: '{index name}' + query_type: vector + embedding_dependency: + type: deployment_name + deployment_name: '{embedding deployment name}' + in_scope: true + top_n_documents: 5 + strictness: 3 + role_information: You are an AI assistant that helps people find information. + fields_mapping: + content_fields_separator: \n + content_fields: + - content + filepath_field: filepath + title_field: title + url_field: url + vector_fields: + - contentvector +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content 2. + title: Citation Title 2 + filepath: contoso2.txt + url: https://contoso.blob.windows.net/container/contoso2.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..e7a996eadc57 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_minimum.json @@ -0,0 +1,63 @@ +{ + "title": "Creates a completion based on Azure Search data and system-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "authentication": { + "type": "system_assigned_managed_identity" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_minimum.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_minimum.yaml new file mode 100644 index 000000000000..13e8656d7328 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_azure_search_minimum.yaml @@ -0,0 +1,39 @@ +title: Creates a completion based on Azure Search data and system-assigned managed identity. +parameters: + endpoint: '{endpoint}' + api-version: 2024-06-01 + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: '{index name}' + authentication: + type: system_assigned_managed_identity +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_cosmos_db.json new file mode 100644 index 000000000000..d0045e539e24 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_cosmos_db.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Azure Cosmos DB.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_cosmos_db.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_cosmos_db.yaml new file mode 100644 index 000000000000..24c6b99fdc94 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/chat_completions_cosmos_db.yaml @@ -0,0 +1,49 @@ +title: Creates a completion for the provided Azure Cosmos DB. +parameters: + endpoint: '{endpoint}' + api-version: 2024-06-01 + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_cosmos_db + parameters: + authentication: + type: connection_string + connection_string: mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000 + database_name: vectordb + container_name: azuredocs + index_name: azuredocindex + embedding_dependency: + type: deployment_name + deployment_name: '{embedding deployment name}' + fields_mapping: + content_fields: + - content + vector_fields: + - contentvector +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/completions.json new file mode 100644 index 000000000000..d0d5be75a90e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deploymentId": "", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/embeddings.json new file mode 100644 index 000000000000..c344b1f46ac8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/embeddings.json @@ -0,0 +1,1566 @@ +{ + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/embeddings.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/embeddings.yaml new file mode 100644 index 000000000000..889a5adace01 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/embeddings.yaml @@ -0,0 +1,1553 @@ +title: Return the embeddings for a given prompt. +parameters: + endpoint: "{endpoint}" + api-version: '2024-06-01' + deployment-id: deployment-afa0669ca01e4693ae3a93baf40f26d6 + body: + input: + - this is a test +responses: + '200': + body: + data: + - index: 0 + embedding: + - -0.012838088 + - -0.007421397 + - -0.017617522 + - -0.028278312 + - -0.018666342 + - 0.01737855 + - -0.01821495 + - -0.006950092 + - -0.009937238 + - -0.038580645 + - 0.010674067 + - 0.02412286 + - -0.013647936 + - 0.013189907 + - 0.0021125758 + - 0.012406612 + - 0.020790534 + - 0.00074595667 + - 0.008397198 + - -0.00535031 + - 0.008968075 + - 0.014351576 + - -0.014086051 + - 0.015055214 + - -0.022211088 + - -0.025198232 + - 0.0065186154 + - -0.036350243 + - 0.009180495 + - -0.009698266 + - 0.009446018 + - -0.008463579 + - -0.0040426035 + - -0.03443847 + - -0.00091273896 + - -0.0019217303 + - 0.002349888 + - -0.021560553 + - 0.016515596 + - -0.015572986 + - 0.0038666942 + - -8.432463e-05 + - 0.0032178196 + - -0.020365695 + - -0.009631885 + - -0.007647093 + - 0.0033837722 + - -0.026764825 + - -0.010501476 + - 0.020219658 + - 0.024640633 + - -0.0066912062 + - -0.036456455 + - -0.0040923897 + - -0.013966565 + - 0.017816665 + - 0.005366905 + - 0.022835068 + - 0.0103488 + - -0.0010811808 + - -0.028942121 + - 0.0074280356 + - -0.017033368 + - 0.0074877786 + - 0.021640211 + - 0.002499245 + - 0.013316032 + - 0.0021524043 + - 0.010129742 + - 0.0054731146 + - 0.03143805 + - 0.014856071 + - 0.0023366117 + - -0.0008243692 + - 0.022781964 + - 0.003038591 + - -0.017617522 + - 0.0013309394 + - 0.0022154662 + - 0.00097414135 + - 0.012041516 + - -0.027906578 + - -0.023817508 + - 0.013302756 + - -0.003003741 + - -0.006890349 + - 0.0016744611 + - 0.023658194 + - -0.015851786 + - -0.0045305043 + - -0.003038591 + - 0.017710455 + - 0.019237218 + - 0.016037652 + - -0.022503164 + - 0.025795663 + - -0.001129307 + - 0.032500144 + - -0.008178141 + - -0.019940857 + - -0.009877495 + - 0.00018918588 + - 0.023060765 + - -0.005692172 + - -0.018347712 + - -0.011039163 + - -0.0062066247 + - -5.24047e-05 + - 0.020126723 + - -0.0011691356 + - -0.015811957 + - 0.020086896 + - -0.009114114 + - -0.03056182 + - 0.0029025099 + - -0.006591635 + - -0.014046223 + - -0.01590489 + - -0.02307404 + - -0.008861865 + - -0.004832538 + - 0.010030171 + - 0.02311387 + - -0.012652221 + - 0.024906157 + - 0.003860056 + - -0.01936998 + - -0.02957938 + - -0.008357369 + - -0.0016371218 + - 0.027800368 + - 0.0077333883 + - 0.021626934 + - 0.02140124 + - -0.030482162 + - 0.026406368 + - -0.008277712 + - 0.012884554 + - -0.043784916 + - -0.0145639945 + - -0.0070297495 + - 0.034889862 + - -0.00041508878 + - -0.010528029 + - -0.009572142 + - 0.015692472 + - 0.037810627 + - -0.0022021902 + - 0.008662722 + - -0.016794397 + - 0.0003090866 + - -0.0060506295 + - 0.015227805 + - 0.0006650548 + - 0.01842737 + - 0.036801632 + - -0.002461076 + - -0.0029390194 + - -0.0057120863 + - -0.012486269 + - -0.0046831807 + - -0.0017474802 + - -0.0036210844 + - -0.01178263 + - 0.017869769 + - 0.039111692 + - 0.010946229 + - 0.018467197 + - 0.0027780454 + - -0.005851486 + - -0.016489044 + - 0.03186289 + - -0.040333103 + - 0.016648358 + - -0.006870435 + - 0.0072687212 + - 2.370982e-06 + - 0.006465511 + - -0.018201673 + - -0.00020526254 + - -0.025410652 + - 0.02010017 + - 0.017537864 + - 0.022821793 + - 0.0064555537 + - -0.0012969191 + - 0.02157383 + - -0.0053536287 + - -0.0087622935 + - -0.010952868 + - 0.017564416 + - 0.02185263 + - 0.0004733796 + - 0.0018337755 + - -0.6954606 + - -0.011231667 + - 0.02748174 + - 0.003929756 + - 0.0144843375 + - 0.045192193 + - 0.01898497 + - -0.0070363875 + - -0.007813046 + - 0.017604245 + - -0.017790113 + - 0.011165286 + - -0.0036376796 + - -0.014736585 + - 0.0016421003 + - -0.019144284 + - -0.0072222543 + - -0.023127146 + - 0.006936816 + - 0.025198232 + - 0.0030219958 + - 0.011722887 + - -0.004271618 + - -0.0011127117 + - -0.0051047 + - 0.00077333883 + - 0.018599961 + - 0.0074877786 + - 0.010820106 + - 0.0033406245 + - -0.015055214 + - 0.02384406 + - 0.006090458 + - 0.00891497 + - 0.023366116 + - -0.011078991 + - -0.019582398 + - 0.0011566891 + - 0.015413672 + - 0.01793615 + - -0.014736585 + - 0.002492607 + - 0.027800368 + - 0.023923717 + - -0.007421397 + - 0.0016105693 + - 0.011337877 + - -0.015041938 + - -0.008768932 + - -0.003982861 + - 0.002884255 + - -0.007832959 + - 0.0025457118 + - -0.0023548664 + - -0.0061767534 + - -0.016754568 + - 0.0006036523 + - 0.0105346665 + - 0.0055361767 + - 0.01478969 + - -0.0011251582 + - 0.009605332 + - -0.0037140178 + - -0.017537864 + - -0.021733144 + - 0.012897831 + - -0.024481317 + - 0.022290744 + - 0.0056523434 + - -0.005366905 + - 0.0020412162 + - 0.013435517 + - -0.003408665 + - -0.01705992 + - 0.029446619 + - 0.022011945 + - 0.009226961 + - -0.003310753 + - -0.007939169 + - 0.021308305 + - 0.0026718357 + - 0.002129171 + - -0.020047067 + - -0.007474502 + - 0.021534001 + - -0.0110590765 + - -0.018374264 + - -0.001664504 + - -0.003923118 + - 0.015387119 + - 0.025516862 + - 0.0016421003 + - -0.017498035 + - -0.01825478 + - 0.01451089 + - -0.008198055 + - -0.011656506 + - 0.0044242945 + - 0.031491153 + - 0.01017621 + - -0.010408543 + - -0.009034456 + - -0.0023283141 + - 0.012021601 + - 0.015639367 + - 0.011736163 + - 0.007912617 + - 0.02031259 + - 0.022104878 + - -0.02241023 + - 0.00041156227 + - -0.009817752 + - -0.030880447 + - -0.0017823302 + - 0.0030933553 + - -0.04128899 + - -0.0007783174 + - 0.012393335 + - 0.0122273825 + - -0.009087561 + - 0.022728859 + - -0.002884255 + - 0.028065892 + - 0.0047396044 + - 0.008065294 + - 0.015519881 + - 0.0133956885 + - -0.02279524 + - -0.011729525 + - 0.0037206558 + - -0.0046732235 + - 0.003587894 + - 0.024401661 + - -0.013574918 + - 0.012685412 + - -0.0041620894 + - 0.020578114 + - 0.007394845 + - 0.014139156 + - -0.012512821 + - -0.021042781 + - 0.022423506 + - -0.015360567 + - 0.004009413 + - 0.0104550095 + - -0.024799947 + - -0.0081449505 + - -0.00063850236 + - 0.0070231115 + - -0.0009633545 + - -0.015705748 + - -0.0028942123 + - -0.008815398 + - 0.007461226 + - -0.014417957 + - -0.012931022 + - 0.0015674217 + - -0.02506547 + - -0.0063128346 + - -0.013422241 + - -0.0058614435 + - -0.0006007482 + - -0.015002109 + - 0.0037040606 + - -0.008410474 + - -0.0016089098 + - -0.018653065 + - 0.020538285 + - -0.016980262 + - -0.042244878 + - -0.017498035 + - 0.006727716 + - -0.01877255 + - 0.008987989 + - 0.00077665783 + - -0.0007119364 + - -0.0067243967 + - 0.0038467797 + - -0.018055636 + - -0.01440468 + - 0.007534245 + - 0.0051212953 + - 0.002741536 + - 0.011523744 + - -0.0018603279 + - 0.023684746 + - 0.016196968 + - 0.01731217 + - -0.01992758 + - 0.009372999 + - -0.01982137 + - 0.001150051 + - -0.014417957 + - 0.005672258 + - -0.015785405 + - 0.0049387473 + - -0.0051445286 + - 0.012632307 + - 0.0011666464 + - 0.024587527 + - 0.04259006 + - -0.0025672857 + - 0.02311387 + - -0.014524166 + - 0.0013848739 + - -0.04105002 + - -0.010089914 + - -0.009087561 + - 0.015440224 + - 0.009207047 + - 0.0128048975 + - -0.030216638 + - -0.02549031 + - 0.00499849 + - 0.02737553 + - 0.024985814 + - -0.015055214 + - 0.007580712 + - -0.003979542 + - 0.0016304837 + - 0.0010446712 + - 0.0033373055 + - 0.0066314633 + - -0.011948583 + - -0.021281753 + - 0.012161002 + - 0.030747686 + - 0.03555367 + - 0.023751127 + - -0.03159736 + - -0.0110590765 + - 0.015758853 + - -0.0012197511 + - -0.0023249951 + - -0.0007488608 + - 0.0074877786 + - 0.01643594 + - -0.008098484 + - 0.03730613 + - -0.0010056724 + - -3.4798173e-05 + - 0.011702972 + - 0.039563086 + - -0.012280487 + - 0.027747264 + - 0.018387541 + - 0.033057746 + - -0.004835857 + - -0.00471969 + - 0.025450481 + - -0.0051146573 + - 0.014603823 + - 0.00022258384 + - 0.00060863094 + - 0.015665919 + - -0.021626934 + - -0.013674489 + - 0.0062066247 + - 0.018560132 + - 0.031942543 + - 0.012054792 + - 0.004902238 + - 0.0028510645 + - -0.027667606 + - 0.009817752 + - -0.002580562 + - 0.0069036256 + - 0.020047067 + - -0.009704905 + - -0.012619031 + - -0.0056755766 + - -0.0036443176 + - 0.019383255 + - 0.0030701219 + - 0.024972538 + - 0.009100837 + - 0.026353262 + - 0.012758431 + - 0.029074885 + - 0.021202097 + - -0.0038102702 + - -0.032048754 + - 0.003996137 + - 0.0029738694 + - 0.0032277768 + - -0.026127568 + - -0.02213143 + - 0.0028742978 + - 0.0010637557 + - 0.000580419 + - 0.0021789568 + - 0.00083764544 + - 0.026924139 + - -0.03265946 + - 0.0059211864 + - 0.021892458 + - 0.01178263 + - 0.0018188398 + - 0.009718181 + - -0.020047067 + - 0.017989255 + - 0.0046035233 + - -0.010561219 + - -0.010342162 + - 0.009505761 + - -0.018334435 + - -0.00667793 + - -0.024534423 + - 0.00035347888 + - 0.00082561385 + - -0.006143563 + - 0.016820949 + - -0.0013500239 + - -0.0069832825 + - 0.015347291 + - -0.005094743 + - 0.001838754 + - 0.017073197 + - 0.02521151 + - 0.006209944 + - -0.015612815 + - -0.009744733 + - -0.019794818 + - 0.007786493 + - 0.037624758 + - 0.017564416 + - 0.0076802834 + - 0.0026203906 + - 0.0022403593 + - -0.024560975 + - -0.04062518 + - -0.016581977 + - 0.00789934 + - 0.0099305995 + - 0.006996559 + - 0.011078991 + - 0.016236795 + - -0.0068969876 + - 0.01374087 + - 0.014922452 + - -0.0042882133 + - 0.00022901449 + - -0.0006692036 + - 0.001359981 + - -7.581957e-05 + - 0.0042616613 + - 0.0066381013 + - 0.012512821 + - 0.021534001 + - 0.0032775626 + - 0.016913882 + - -0.00789934 + - -0.009200408 + - -0.020286039 + - -0.017033368 + - 0.014378128 + - 0.009233599 + - 0.0070828544 + - -0.013229736 + - 0.025928425 + - -0.011862287 + - 0.008383922 + - 0.012632307 + - -0.0003097089 + - 0.007593988 + - 0.0059079104 + - -0.0026369859 + - -0.0262205 + - 0.003335646 + - -0.0067609064 + - -0.0042882133 + - 0.008549875 + - -0.007600626 + - -0.012592479 + - 0.028623493 + - -0.0030502076 + - -0.006989921 + - -0.015785405 + - 0.010050085 + - 0.016714739 + - -0.023724575 + - -0.006346025 + - -0.014245366 + - -0.032154962 + - -0.03388087 + - -0.024308728 + - -0.002461076 + - -0.003733932 + - -0.02195884 + - -0.021069333 + - -0.022144707 + - -0.007872788 + - -0.017179407 + - -0.009034456 + - -0.010893124 + - -0.02478667 + - -0.020153277 + - -0.023976821 + - 0.014656927 + - 0.0005368565 + - -0.015878338 + - 0.010123105 + - -0.0030717815 + - 0.01555971 + - 0.0018321159 + - -0.036244035 + - 0.00017176087 + - -0.013375774 + - -0.010375353 + - 0.026512576 + - 0.016581977 + - 0.013847079 + - 0.015719024 + - 0.013223098 + - 0.004975257 + - -0.0010579474 + - -0.0034385365 + - -0.029048331 + - 0.017298892 + - -0.022529716 + - 0.008463579 + - -0.014723309 + - -0.005814977 + - -0.009027818 + - -0.009738095 + - -0.0104682855 + - -0.005044957 + - 0.007905979 + - 0.011656506 + - 0.003153098 + - -0.0005231654 + - 0.019954132 + - -0.021985391 + - -0.005307162 + - 0.0021839354 + - -0.025184957 + - 0.013926737 + - -0.0059908866 + - 0.0065717204 + - 0.009884133 + - -0.0062298584 + - 0.03388087 + - 0.0028577026 + - -0.015931444 + - 0.0010986058 + - -0.025808938 + - 0.0022835068 + - 0.014152432 + - 0.015227805 + - 0.013701041 + - -0.007872788 + - -0.030614924 + - -0.026393091 + - 0.0010753724 + - -0.016940435 + - 0.013647936 + - -0.007408121 + - -0.024308728 + - -0.031915992 + - -0.018161846 + - 0.00072521257 + - 0.028862465 + - 0.012234021 + - -0.019555846 + - -0.027641054 + - -0.00082810316 + - -0.0019150922 + - -0.016276624 + - -0.01125822 + - -0.034146395 + - -0.015294186 + - 0.006671292 + - -0.015533158 + - 0.013674489 + - -0.0011766035 + - -0.017325444 + - -0.023233354 + - -0.013189907 + - 0.0005580154 + - -0.03188944 + - -0.007056302 + - -0.0059942054 + - 0.03411984 + - 0.04317421 + - 0.029420065 + - 0.006488744 + - -0.0022436783 + - 0.013063784 + - 0.00012207884 + - 0.008118398 + - -0.023246631 + - 0.0051909955 + - -0.00894816 + - 0.0081316745 + - 0.0023200165 + - 0.011510468 + - -0.0005770999 + - 0.00016979019 + - 0.010129742 + - 0.015506605 + - -0.0073815687 + - 0.0031995648 + - -0.026578957 + - -0.016674912 + - 0.0049652997 + - 0.0072687212 + - -0.016568702 + - -0.001964878 + - -0.015692472 + - -0.0048955996 + - 0.027773816 + - 0.012864641 + - 0.01594472 + - 0.008244522 + - 0.017139578 + - -0.01772373 + - -0.0012521119 + - 0.011689696 + - 0.0111121815 + - -0.0036476366 + - 0.0012570905 + - -0.007826322 + - -0.016754568 + - 0.011948583 + - -0.0045968853 + - 0.023963546 + - -0.0052739717 + - 0.014656927 + - 0.009731457 + - 0.010727172 + - -0.01705992 + - -0.0026071144 + - 0.010760362 + - 0.000919377 + - -0.006365939 + - -0.03013698 + - -0.010554581 + - -0.018613236 + - 0.013886908 + - 0.029420065 + - -0.013030593 + - 0.016860778 + - -0.019237218 + - -0.022118153 + - 0.007919255 + - -0.0004003605 + - 0.046546366 + - 0.01349526 + - 0.006352663 + - 0.014258642 + - 0.0031813101 + - -0.027017072 + - 0.0070828544 + - -0.020219658 + - 0.0037140178 + - 0.023366116 + - 0.040386207 + - -0.016382834 + - -0.0023681426 + - 0.0064522345 + - 0.016528873 + - 0.0006804054 + - -0.02891557 + - -0.0043545947 + - 0.01101261 + - -0.0014778073 + - -0.018055636 + - -0.0077001974 + - -0.0358723 + - 0.003373815 + - -0.00071940426 + - -0.011822458 + - -0.024295451 + - -0.009791199 + - -0.026565682 + - 0.020989677 + - -0.035155386 + - 0.01832116 + - 0.014776413 + - -0.028012788 + - -0.007262083 + - 0.0030402504 + - -0.029446619 + - 0.00010174965 + - 0.009758009 + - 0.03767786 + - -0.0154535 + - 0.009346447 + - 0.016077481 + - 0.0041189417 + - -0.027800368 + - 0.01720596 + - -0.011158649 + - 0.027800368 + - -0.03003077 + - -0.0072819972 + - 0.0014296811 + - 0.0145374425 + - 0.0043280423 + - -0.017086472 + - -0.01611731 + - -0.01258584 + - -0.016927158 + - 0.007607264 + - 0.018825656 + - 0.011331239 + - -0.0057784673 + - 0.001569911 + - -0.013900184 + - -0.014776413 + - -0.0050814664 + - -0.0012454737 + - -0.0115967635 + - -0.017458206 + - -0.013203184 + - -0.0063692583 + - -0.01244644 + - 0.011882202 + - 0.0007708495 + - -0.02035242 + - 0.016250072 + - 0.018414093 + - -0.029526275 + - 0.012751793 + - -0.01555971 + - 0.0013840442 + - -0.019502742 + - 0.0063758963 + - 0.0037538463 + - -0.035686433 + - 0.027534844 + - -0.016409386 + - -0.03247359 + - -0.008782208 + - -0.0059842486 + - 0.014338299 + - 0.009233599 + - -0.0053171194 + - 0.006160158 + - 0.0072952732 + - 0.01401967 + - 0.008815398 + - -0.023790956 + - 0.013096974 + - -0.0031365028 + - 0.005044957 + - 0.0005356118 + - -0.009379637 + - 0.0066248253 + - -0.00010724682 + - 0.010289057 + - 0.008815398 + - -0.02279524 + - -0.019701885 + - -0.0027747264 + - 0.016183691 + - -0.014205537 + - -0.003933075 + - -0.013375774 + - -0.005751915 + - -0.010116466 + - 0.004988533 + - -0.005904591 + - -0.008656085 + - -0.017431654 + - -0.011988411 + - -0.01594472 + - 0.00660823 + - -0.027216217 + - 0.0073218257 + - -0.029977666 + - -0.004593566 + - -0.026671892 + - -0.028517283 + - -0.0050084474 + - 0.009844304 + - 0.025729282 + - -0.013780698 + - -0.026751548 + - 0.004905557 + - -0.035951957 + - -0.026738273 + - -0.019768266 + - 0.0048690476 + - 0.005250738 + - 0.0014603822 + - -0.018892037 + - 0.017683903 + - 0.0067177587 + - 0.027694158 + - -0.002618731 + - -0.012419888 + - 0.01772373 + - -0.0032593077 + - 0.006611549 + - 0.016648358 + - -0.03789028 + - -0.023100592 + - 0.023684746 + - 0.0031248862 + - 0.016382834 + - 0.019967409 + - -0.008941523 + - -0.02014 + - 0.0073882067 + - 0.011357792 + - -0.0031796505 + - -0.0030253148 + - -0.0010206081 + - -0.017577693 + - -0.009598695 + - 0.002915786 + - 0.001325131 + - -0.0029207645 + - -0.010780277 + - -0.00325101 + - -0.00811176 + - -0.00073434 + - -0.030083876 + - -0.012864641 + - -0.012745155 + - -0.011769353 + - 0.018785827 + - -0.008264436 + - -0.002675155 + - 0.024255622 + - 0.005483072 + - -0.018480474 + - -0.005426648 + - 0.015095043 + - 0.00044392303 + - 0.011271496 + - -0.0027548121 + - 0.0026884312 + - -0.00894816 + - -0.015161424 + - -0.014975557 + - -0.024600804 + - 0.004457485 + - -0.015519881 + - -0.012366783 + - -0.012579202 + - 0.01478969 + - 0.0075541595 + - -0.017962702 + - -0.0017441611 + - -0.014059499 + - 0.005499667 + - -0.0026884312 + - 0.0031929268 + - 0.0010853296 + - -0.008045379 + - 0.017471483 + - 0.02590187 + - -0.018546855 + - -0.007826322 + - 0.009333171 + - 0.0157323 + - 8.6036016e-05 + - 0.004776114 + - 0.22155327 + - 0.006787459 + - -0.0017823302 + - 0.024919434 + - 0.0023449094 + - 0.03210186 + - 0.0047329664 + - -0.010879848 + - 0.0044342517 + - 0.015334014 + - 0.029499723 + - 0.019715162 + - -0.008569789 + - -0.0018901994 + - -0.0077400263 + - -0.019210665 + - -0.005088105 + - -0.023153698 + - -0.032739118 + - -0.029313855 + - 0.00082146504 + - -0.0212552 + - 0.0044309325 + - -0.005446562 + - 0.018613236 + - -0.009751371 + - -0.013023955 + - -0.001996409 + - 0.01915756 + - 0.017431654 + - -0.031092867 + - -0.0070231115 + - 0.025330994 + - -0.00018099198 + - -0.025131851 + - -0.011025886 + - 0.0116498675 + - -0.02506547 + - 0.029234199 + - -0.012287126 + - 0.0069766445 + - 0.0018752636 + - 0.014271918 + - 0.005108019 + - -0.0109064 + - 0.014391404 + - 0.0062597296 + - -0.031411495 + - 0.00014935728 + - 0.013236375 + - -0.02891557 + - -0.0006671292 + - 0.008662722 + - 0.012161002 + - 0.020963125 + - -0.0133691365 + - 0.02653913 + - -0.017989255 + - 0.007978998 + - 0.0093398085 + - -0.02024621 + - 0.03265946 + - -0.02846418 + - 0.025397375 + - -0.024693737 + - -0.0027050264 + - -0.019330151 + - -0.0104417335 + - 0.015626092 + - -0.006541849 + - 0.004653309 + - -0.025118576 + - 0.0038268655 + - 0.004045923 + - -0.017564416 + - -0.02444149 + - 0.030296294 + - 0.028756255 + - 0.03927101 + - 0.010767001 + - -0.012034878 + - -0.007122683 + - -0.022476612 + - -0.034942966 + - -0.028411074 + - -0.03927101 + - -0.0037505273 + - -0.0038799702 + - -0.00037111135 + - -0.009718181 + - -0.013455432 + - -0.015400395 + - -0.0066978442 + - -0.010760362 + - 0.015121595 + - 0.03111942 + - 0.007992274 + - 0.0270569 + - -0.003104972 + - 0.010056724 + - -0.018414093 + - 0.006472149 + - 0.021281753 + - 0.0043579135 + - -0.00021490853 + - 0.0008546556 + - -0.01269205 + - -0.003936394 + - 0.0008870163 + - 0.0009816092 + - 0.0054664765 + - -0.031278733 + - 0.017245788 + - 0.00027734818 + - 0.005161124 + - 0.0048093046 + - -0.003923118 + - -0.027149836 + - 0.006950092 + - -0.00615352 + - 0.014205537 + - 0.0016620146 + - 0.0047396044 + - 0.0039994563 + - -0.015440224 + - -0.0055627287 + - -0.026273604 + - 0.0013276202 + - 0.0021009592 + - -0.034810204 + - 0.0064522345 + - 0.00042608313 + - 0.02307404 + - -0.005957696 + - 0.0016869075 + - -0.0032775626 + - -0.009041094 + - -0.01227385 + - -0.04349284 + - 0.015652644 + - 0.013468708 + - -0.0023249951 + - -0.011171925 + - 0.0030352718 + - -0.0061203293 + - -0.023153698 + - 0.046068422 + - -0.005582643 + - -0.02405648 + - 0.005433286 + - -0.02814555 + - -0.0036874653 + - 0.0067841397 + - 0.006628144 + - 0.029844904 + - -0.0044276137 + - -0.029127989 + - -0.04548427 + - 0.022091601 + - 0.0038069512 + - -0.030269742 + - 0.0051578046 + - 0.043572497 + - -0.0144843375 + - -0.02891557 + - -0.010461648 + - -0.17375894 + - 0.029154541 + - 0.019648781 + - -0.00038335036 + - 0.0029572742 + - -0.0026469429 + - 0.035925403 + - -0.012021601 + - 0.0015566348 + - -0.0033124126 + - 0.0010430117 + - -0.010620962 + - -0.022582822 + - 0.00601412 + - 0.008364008 + - -0.0016586956 + - -0.0011102224 + - -0.013860356 + - 0.022542993 + - 0.020564837 + - 0.018414093 + - -0.008908332 + - 0.032951534 + - -0.011908754 + - 0.010169571 + - -0.011198477 + - 0.0029108075 + - 0.033084296 + - 0.0029008503 + - -0.0010015236 + - -0.019794818 + - 0.005844848 + - 0.011669782 + - 0.0052208668 + - 0.010129742 + - 0.0037737607 + - 0.02880936 + - -0.018599961 + - -0.015095043 + - 0.026578957 + - 0.019662056 + - 0.006823968 + - -0.00045885876 + - -0.019396532 + - -0.0047993474 + - 0.017192682 + - 0.039589636 + - -0.00874238 + - 0.02146762 + - -0.007667007 + - 0.018785827 + - -0.012758431 + - -0.010010257 + - -0.02052501 + - 0.016090758 + - 0.0061867107 + - -0.0145507185 + - 0.008065294 + - 0.0104284575 + - -0.0022386997 + - -0.008324179 + - -0.021640211 + - 0.01705992 + - -0.010541305 + - -0.01639611 + - -0.0074413116 + - -0.034703992 + - 0.007016473 + - -0.003083398 + - 0.0013691084 + - -0.005108019 + - -0.007886064 + - 0.00053270767 + - -0.018865485 + - 0.025503585 + - 0.005101381 + - -0.027534844 + - 0.015028661 + - -0.009286704 + - 0.006233177 + - 4.343289e-05 + - 0.036031615 + - 0.00957878 + - 0.019250493 + - 0.0024411618 + - 0.0023664832 + - -0.0030269742 + - -0.007939169 + - 0.0058581247 + - 0.00587472 + - 0.036589216 + - -0.035288148 + - -0.012997403 + - -0.0110989055 + - -0.002492607 + - 0.008151589 + - -0.008085207 + - -0.00734174 + - -0.0016802694 + - 0.008403837 + - -0.007793131 + - -0.003913161 + - -0.025437204 + - 0.027123282 + - 0.019330151 + - -0.008729103 + - 0.003943032 + - 0.010289057 + - 0.029977666 + - 0.0014836156 + - -0.024282174 + - -0.0024361832 + - 0.0110325245 + - 0.021719867 + - 0.012844726 + - 0.015002109 + - 0.020737428 + - -0.013037231 + - 0.014802966 + - -0.0027332383 + - 0.041634172 + - -0.00926679 + - -0.018759275 + - 0.018666342 + - 0.005386819 + - -0.008822037 + - -0.068399 + - -0.054804165 + - 0.027800368 + - 0.04954679 + - -0.00437119 + - 0.029127989 + - 0.03180978 + - 0.021321582 + - -0.022503164 + - 0.010554581 + - -0.006823968 + - -0.021387963 + - -0.021865906 + - -0.0074479496 + - 0.0037206558 + - 0.004132218 + - 0.01073381 + - -0.0021673401 + - -0.0012819833 + - 0.041235887 + - -0.010202762 + - 0.004839176 + - 0.0081715025 + - -0.030402504 + - -0.023764404 + - -0.010800191 + - -0.018374264 + - 0.033641897 + - 0.005416691 + - -0.0055096243 + - -0.0032775626 + - -0.018095464 + - 0.008563151 + - -0.02339267 + - -0.013674489 + - 0.0023382711 + - -0.028411074 + - -0.0024063117 + - 0.026658615 + - -0.012413249 + - 0.009333171 + - 0.026446195 + - -0.009107475 + - -0.024560975 + - 0.0011085629 + - -0.02395027 + - 0.0013857037 + - 0.01926377 + - -0.0020710877 + - -0.031278733 + - -0.015095043 + - 0.0041720467 + - -0.012798259 + - 0.010162933 + - 0.0063128346 + - -0.010972782 + - 0.045617033 + - 0.016874054 + - -0.010368714 + - -0.0055992384 + - -0.0092999805 + - 0.0015782086 + - -0.013581555 + - 0.017843217 + - -0.01615714 + - 0.0036575939 + - -0.027110007 + - -0.013621384 + - 0.022197811 + - 0.0013964906 + - -0.007348378 + - 0.0145772705 + - -0.003996137 + - 0.0008364008 + - -0.03411984 + - 0.013030593 + - -0.021454344 + - -0.05034336 + - 0.021095887 + - -0.0055029863 + - -0.025623072 + - -0.023525432 + - 0.007335102 + - -0.043413185 + - 0.016316453 + - 0.016196968 + - 0.0093132565 + - -0.0110989055 + - 0.0154535 + - -0.045218747 + - 0.0037737607 + - 0.01639611 + - 0.019887751 + - -0.023366116 + - -0.024043202 + - 0.014258642 + - 0.004271618 + - -0.006877073 + - 0.021387963 + - -0.0019781543 + - -0.036350243 + - -0.009114114 + - -0.037359234 + - 0.01919739 + - 0.011829097 + - -0.015665919 + - -0.0015591241 + - 0.0144843375 + - -0.003139822 + - -0.024083031 + - -0.015307462 + - -0.0040990277 + - -0.013223098 + - 0.0024278855 + - -0.008702551 + - -0.0033207103 + - -0.009804476 + - -0.010554581 + - 0.031066315 + - 0.0044408897 + - 0.025370823 + - 0.009406189 + - 0.025583243 + - -0.002066109 + - 0.015267633 + - 0.008337456 + - -0.009426104 + - 0.01590489 + - -0.011716249 + - 0.007713474 + - -0.029552827 + - -0.013900184 + - 0.0050150855 + - -0.01650232 + - -0.0015757193 + - 0.008549875 + - -0.020471904 + - 0.008397198 + - -0.013136802 + - 0.021520725 + - 0.0060406723 + - 0.012858002 + - -0.004723009 + - -0.029313855 + - 0.009240237 + - -0.0212552 + - -0.028118998 + - 0.017803388 + - -0.0314646 + - 0.012353507 + - 0.029632485 + - -1.6128512e-05 + - 0.016966987 + - 0.009711542 + - -0.037253026 + - -0.015095043 + - 0.013442155 + - -0.00905437 + - -0.000982439 + - -0.0020495139 + - 0.008337456 + - -0.020644495 + - 0.042085562 + - -0.000744712 + - 0.021135716 + - -0.0072886352 + - 0.01643594 + - 0.013767422 + - -0.0044707614 + - -0.014763137 + - 0.018852208 + - -0.03080079 + - -0.0049188333 + - 0.0058846767 + - 0.008330817 + - 0.008257798 + - 0.024202518 + - 0.02307404 + - 0.011065715 + - 0.00036053188 + - -0.00049412367 + - 0.036270585 + - 0.027043626 + - 0.011902116 + - -0.027773816 + - 0.013289479 + - 0.018374264 + - -0.0033157317 + - 0.0016636741 + - 0.0020677685 + - -0.012293763 + - 0.008184779 + - -0.034252603 + - 0.010753725 + - 0.008675998 + - 0.00968499 + - -0.003793675 + - -0.011218391 + - 0.010375353 + - -0.0005737809 + - 0.019781543 + - 0.020591391 + - 0.019954132 + - -0.00053976063 + - -0.0059444197 + - -0.022675755 + - -0.010003619 + - 0.0038467797 + - -0.0212552 + - -0.033482585 + - -0.015572986 + - 0.0037737607 + - 0.01451089 + - 0.0036376796 + - 0.007454588 + - 0.013979842 + - -0.013402327 + - 0.014975557 + - -0.010435095 + - 0.0151747 + - -0.030375952 + - 0.023166973 + - -0.0024760119 + - -0.005881358 + - 0.019914305 + - -0.008596341 + - 0.017737007 + - -0.0036111271 + - 0.012499545 + - -0.02647275 + - 0.0053901384 + - 0.008556513 + - 0.019648781 + - 0.00874238 + - -0.012439802 + - -0.028623493 + - -0.022330573 + - -0.0029340407 + - -0.016303178 + - 0.007474502 + - -0.016555425 + - 0.060645696 + - 0.0023631642 + - -0.012054792 + - 0.017604245 + - 0.013103612 + - 0.026061187 + - 0.015533158 + - 0.025742557 + - 0.00013753316 + - -0.013940013 + - 0.02880936 + - 0.010109829 + - -0.0036111271 + - -0.012419888 + - -0.045457717 + - 0.022835068 + - -0.014139156 + - 0.007819683 + - -0.010461648 + - -0.012008325 + - 0.008895056 + - 0.015984548 + - 0.024043202 + - -0.00059825886 + - -0.0036376796 + - -0.007939169 + - 0.0242689 + - -0.022197811 + - -0.026313433 + - -0.026724996 + - 0.010939592 + - 0.0023449094 + - -0.012074706 + - -0.018493751 + - 0.017697178 + - -0.0052142288 + - -0.00360117 + - 0.0056058764 + - 0.01070062 + - 0.0035248317 + - 0.023671469 + - 0.030880447 + - -0.020299314 + - -0.0145905465 + - 0.018055636 + - -0.013727593 + - -0.023313012 + - 0.013236375 + - -0.0020113448 + usage: + prompt_tokens: 4 + total_tokens: 4 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/image_generation.json new file mode 100644 index 000000000000..2f45e6f162ce --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/image_generation.json @@ -0,0 +1,67 @@ +{ + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "deployment-id": "", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.", + "prompt_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + }, + "profanity": { + "detected": false, + "filtered": false + } + }, + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...", + "content_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/image_generation.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/image_generation.yaml new file mode 100644 index 000000000000..c94126435a4a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/image_generation.yaml @@ -0,0 +1,46 @@ +title: "Creates images given a prompt." +parameters: + endpoint: "{endpoint}" + api-version: "2024-06-01" + deployment-id: "" + body: + prompt: "In the style of WordArt, Microsoft Clippy wearing a cowboy hat." + n: 1 + style: "natural" + quality: "standard" +responses: + '200': + body: + created: 1698342300 + data: + - revised_prompt: "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + prompt_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false + profanity: + detected: false + filtered: false + url: "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + content_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/inference.json new file mode 100644 index 000000000000..79510e374a9d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/inference.json @@ -0,0 +1,3082 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Azure OpenAI Service API", + "description": "Azure OpenAI APIs for completions and search", + "version": "2024-06-01" + }, + "servers": [ + { + "url": "https://{endpoint}/openai", + "variables": { + "endpoint": { + "default": "your-resource-name.openai.azure.com" + } + } + } + ], + "security": [ + { + "bearer": [ + "api.read" + ] + }, + { + "apiKey": [] + } + ], + "paths": { + "/deployments/{deployment-id}/completions": { + "post": { + "summary": "Creates a completion for the provided prompt, parameters and chosen model.", + "operationId": "Completions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "davinci", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-06-01", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prompt": { + "description": "The prompt(s) to generate completions for, encoded as a string or array of strings.\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document. Maximum allowed size of string list is 2048.", + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": false + }, + "description": "Array size minimum of 1 and maximum of 2048" + } + ] + }, + "max_tokens": { + "description": "The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). Has minimum of 0.", + "type": "integer", + "default": 16, + "example": 16, + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.\nWe generally recommend altering this or top_p but not both.", + "type": "number", + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\nWe generally recommend altering this or temperature but not both.", + "type": "number", + "default": 1, + "example": 1, + "nullable": true + }, + "logit_bias": { + "description": "Defaults to null. Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this tokenizer tool (which works for both GPT-2 and GPT-3) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. As an example, you can pass {\"50256\" : -100} to prevent the <|endoftext|> token from being generated.", + "type": "object", + "nullable": false + }, + "user": { + "description": "A unique identifier representing your end-user, which can help monitoring and detecting abuse", + "type": "string", + "nullable": false + }, + "n": { + "description": "How many completions to generate for each prompt. Minimum of 1 and maximum of 128 allowed.\nNote: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.", + "type": "integer", + "default": 1, + "example": 1, + "nullable": true + }, + "stream": { + "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.", + "type": "boolean", + "nullable": true, + "default": false + }, + "logprobs": { + "description": "Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens. For example, if logprobs is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.\nMinimum of 0 and maximum of 5 allowed.", + "type": "integer", + "default": null, + "nullable": true + }, + "suffix": { + "type": "string", + "nullable": true, + "description": "The suffix that comes after a completion of inserted text." + }, + "echo": { + "description": "Echo back the prompt in addition to the completion", + "type": "boolean", + "default": false, + "nullable": true + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.", + "oneOf": [ + { + "type": "string", + "default": "<|endoftext|>", + "example": "\n", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "example": "\n", + "nullable": false + }, + "description": "Array minimum size of 1 and maximum of 4" + } + ] + }, + "completion_config": { + "type": "string", + "nullable": true + }, + "presence_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.", + "type": "number", + "default": 0 + }, + "frequency_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.", + "type": "number", + "default": 0 + }, + "best_of": { + "description": "Generates best_of completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\nWhen used with n, best_of controls the number of candidate completions and n specifies how many to return - best_of must be greater than n.\nNote: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop. Has maximum value of 128.", + "type": "integer" + } + } + }, + "example": { + "prompt": "Negate the following sentence.The price for bubblegum increased on thursday.\n\n Negated Sentence:", + "max_tokens": 50 + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "object": { + "type": "string" + }, + "created": { + "type": "integer" + }, + "model": { + "type": "string" + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "choices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "logprobs": { + "type": "object", + "properties": { + "tokens": { + "type": "array", + "items": { + "type": "string" + } + }, + "token_logprobs": { + "type": "array", + "items": { + "type": "number" + } + }, + "top_logprobs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + }, + "text_offset": { + "type": "array", + "items": { + "type": "integer" + } + } + }, + "nullable": true + }, + "finish_reason": { + "type": "string" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + } + } + } + }, + "usage": { + "type": "object", + "properties": { + "completion_tokens": { + "type": "number", + "format": "int32" + }, + "prompt_tokens": { + "type": "number", + "format": "int32" + }, + "total_tokens": { + "type": "number", + "format": "int32" + } + }, + "required": [ + "prompt_tokens", + "total_tokens", + "completion_tokens" + ] + } + }, + "required": [ + "id", + "object", + "created", + "model", + "choices" + ] + }, + "example": { + "model": "davinci", + "object": "text_completion", + "id": "cmpl-4509KAos68kxOqpE2uYGw81j6m7uo", + "created": 1637097562, + "choices": [ + { + "index": 0, + "text": "The price for bubblegum decreased on thursday.", + "logprobs": null, + "finish_reason": "stop" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a completion.": { + "$ref": "./examples/completions.json" + } + } + } + }, + "/deployments/{deployment-id}/embeddings": { + "post": { + "summary": "Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.", + "operationId": "embeddings_create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "ada-search-index-v1" + }, + "description": "The deployment id of the model which was deployed." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-06-01", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true, + "properties": { + "input": { + "description": "Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length.\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space, as we have observed inferior results when newlines are present.", + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 2048, + "items": { + "type": "string", + "minLength": 1, + "example": "This is a test.", + "nullable": false + } + } + ] + }, + "user": { + "description": "A unique identifier representing your end-user, which can help monitoring and detecting abuse.", + "type": "string", + "nullable": false + }, + "input_type": { + "description": "input type of embedding search to use", + "type": "string", + "example": "query" + }, + "encoding_format": { + "description": "The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`.", + "type": "string", + "example": "float", + "nullable": true + }, + "dimensions": { + "description": "The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.", + "type": "integer", + "example": 1, + "nullable": true + } + }, + "required": [ + "input" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "object": { + "type": "string" + }, + "model": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "object": { + "type": "string" + }, + "embedding": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "index", + "object", + "embedding" + ] + } + }, + "usage": { + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "total_tokens": { + "type": "integer" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + } + }, + "required": [ + "object", + "model", + "data", + "usage" + ] + } + } + } + } + }, + "x-ms-examples": { + "Create a embeddings.": { + "$ref": "./examples/embeddings.json" + } + } + } + }, + "/deployments/{deployment-id}/chat/completions": { + "post": { + "summary": "Creates a completion for the chat message", + "operationId": "ChatCompletions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-06-01", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createChatCompletionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createChatCompletionResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a chat completion.": { + "$ref": "./examples/chat_completions.json" + }, + "Creates a completion based on Azure Search data and system-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_minimum.json" + }, + "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_advanced.json" + }, + "Creates a completion for the provided Azure Cosmos DB.": { + "$ref": "./examples/chat_completions_cosmos_db.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/transcriptions": { + "post": { + "summary": "Transcribes audio into the input language.", + "operationId": "Transcriptions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-06-01", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio transcription with json response format.": { + "$ref": "./examples/audio_transcription_object.json" + }, + "Create an audio transcription with text response format.": { + "$ref": "./examples/audio_transcription_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/translations": { + "post": { + "summary": "Transcribes and translates input audio into English text.", + "operationId": "Translations_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-06-01", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranslationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio translation with json response format.": { + "$ref": "./examples/audio_translation_object.json" + }, + "Create an audio translation with text response format.": { + "$ref": "./examples/audio_translation_text.json" + } + } + } + }, + "/deployments/{deployment-id}/images/generations": { + "post": { + "summary": "Generates a batch of images from a text caption on a given DALLE model deployment", + "operationId": "ImageGenerations_Create", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/imageGenerationsRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "dalle-deployment", + "description": "Deployment id of the dalle model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-06-01", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/generateImagesResponse" + } + } + } + }, + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dalleErrorResponse" + } + } + } + } + }, + "x-ms-examples": { + "Create an image.": { + "$ref": "./examples/image_generation.json" + } + } + } + } + }, + "components": { + "schemas": { + "errorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/error" + } + } + }, + "errorBase": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "error": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/innerError" + } + } + }, + "innerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "innerErrorCode": { + "description": "Error codes for the inner error object.", + "enum": [ + "ResponsibleAIPolicyViolation" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "ResponsibleAIPolicyViolation", + "description": "The prompt violated one of more content filter rules." + } + ] + } + }, + "dalleErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/dalleError" + } + } + }, + "dalleError": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/dalleInnerError" + } + } + }, + "dalleInnerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + } + } + }, + "contentFilterResultBase": { + "type": "object", + "properties": { + "filtered": { + "type": "boolean" + } + }, + "required": [ + "filtered" + ] + }, + "contentFilterSeverityResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "severity": { + "type": "string", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "value": "safe", + "description": "General content or related content in generic or non-harmful contexts." + }, + { + "value": "low", + "description": "Harmful content at a low intensity and risk level." + }, + { + "value": "medium", + "description": "Harmful content at a medium intensity and risk level." + }, + { + "value": "high", + "description": "Harmful content at a high intensity and risk level." + } + ] + } + } + } + } + ], + "required": [ + "severity", + "filtered" + ] + }, + "contentFilterDetectedResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "detected": { + "type": "boolean" + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterDetectedWithCitationResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + { + "properties": { + "citation": { + "type": "object", + "properties": { + "URL": { + "type": "string" + }, + "license": { + "type": "string" + } + } + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterResultsBase": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "error": { + "$ref": "#/components/schemas/errorBase" + } + } + }, + "contentFilterPromptResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + } + ] + }, + "contentFilterChoiceResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "protected_material_text": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + }, + { + "properties": { + "protected_material_code": { + "$ref": "#/components/schemas/contentFilterDetectedWithCitationResult" + } + } + } + ] + }, + "promptFilterResult": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "promptFilterResults": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/components/schemas/promptFilterResult" + } + }, + "dalleContentFilterResults": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + } + } + }, + "dalleFilterResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + { + "properties": { + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + } + ] + }, + "chatCompletionsRequestCommon": { + "type": "object", + "properties": { + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\nWe generally recommend altering this or `temperature` but not both.", + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.", + "type": "boolean", + "nullable": true, + "default": false + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.", + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "nullable": false + }, + "minItems": 1, + "maxItems": 4, + "description": "Array minimum size of 1 and maximum of 4" + } + ], + "default": null + }, + "max_tokens": { + "description": "The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens).", + "type": "integer", + "default": 4096 + }, + "presence_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "frequency_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "logit_bias": { + "description": "Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.", + "type": "object", + "nullable": true + }, + "user": { + "description": "A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse.", + "type": "string", + "example": "user-1234", + "nullable": false + } + } + }, + "createChatCompletionRequest": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionsRequestCommon" + }, + { + "properties": { + "messages": { + "description": "A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + } + }, + "data_sources": { + "type": "array", + "description": " The configuration entries for Azure OpenAI chat extensions that use them.\n This additional specification is only compatible with Azure OpenAI.", + "items": { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + } + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many chat completion choices to generate for each input message." + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "default": 0, + "example": 1, + "nullable": true, + "description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend." + }, + "logprobs": { + "description": "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model.", + "type": "boolean", + "default": false, + "nullable": true + }, + "top_logprobs": { + "description": "An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.", + "type": "integer", + "minimum": 0, + "maximum": 5, + "nullable": true + }, + "response_format": { + "type": "object", + "description": "An object specifying the format that the model must output. Used to enable JSON mode.", + "properties": { + "type": { + "$ref": "#/components/schemas/chatCompletionResponseFormat" + } + } + }, + "tools": { + "description": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionTool" + } + }, + "tool_choice": { + "$ref": "#/components/schemas/chatCompletionToolChoiceOption" + }, + "functions": { + "description": "Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for.", + "type": "array", + "minItems": 1, + "maxItems": 128, + "items": { + "$ref": "#/components/schemas/chatCompletionFunction" + } + }, + "function_call": { + "description": "Deprecated in favor of `tool_choice`. Controls how the model responds to function calls. \"none\" means the model does not call a function, and responds to the end-user. \"auto\" means the model can pick between an end-user or calling a function. Specifying a particular function via `{\"name\":\\ \"my_function\"}` forces the model to call that function. \"none\" is the default when no functions are present. \"auto\" is the default if functions are present.", + "oneOf": [ + { + "type": "string", + "enum": [ + "none", + "auto" + ], + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function." + }, + { + "type": "object", + "description": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + ] + } + } + } + ], + "required": [ + "messages" + ] + }, + "chatCompletionResponseFormat": { + "type": "string", + "enum": [ + "text", + "json_object" + ], + "default": "text", + "example": "json_object", + "nullable": true, + "description": "Setting to `json_object` enables JSON mode. This guarantees that the message the model generates is valid JSON.", + "x-ms-enum": { + "name": "ChatCompletionResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "text", + "description": "Response format is a plain text string." + }, + { + "value": "json_object", + "description": "Response format is a JSON object." + } + ] + } + }, + "chatCompletionFunction": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "description": { + "type": "string", + "description": "The description of what the function does." + }, + "parameters": { + "$ref": "#/components/schemas/chatCompletionFunctionParameters" + } + }, + "required": [ + "name" + ] + }, + "chatCompletionFunctionParameters": { + "type": "object", + "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.", + "additionalProperties": true + }, + "chatCompletionRequestMessage": { + "type": "object", + "properties": { + "role": { + "$ref": "#/components/schemas/chatCompletionRequestMessageRole" + } + }, + "discriminator": { + "propertyName": "role", + "mapping": { + "system": "#/components/schemas/chatCompletionRequestMessageSystem", + "user": "#/components/schemas/chatCompletionRequestMessageUser", + "assistant": "#/components/schemas/chatCompletionRequestMessageAssistant", + "tool": "#/components/schemas/chatCompletionRequestMessageTool", + "function": "#/components/schemas/chatCompletionRequestMessageFunction" + } + }, + "required": [ + "role" + ] + }, + "chatCompletionRequestMessageRole": { + "type": "string", + "enum": [ + "system", + "user", + "assistant", + "tool", + "function" + ], + "description": "The role of the messages author.", + "x-ms-enum": { + "name": "ChatCompletionRequestMessageRole", + "modelAsString": true, + "values": [ + { + "value": "system", + "description": "The message author role is system." + }, + { + "value": "user", + "description": "The message author role is user." + }, + { + "value": "assistant", + "description": "The message author role is assistant." + }, + { + "value": "tool", + "description": "The message author role is tool." + }, + { + "value": "function", + "description": "Deprecated. The message author role is function." + } + ] + } + }, + "chatCompletionRequestMessageSystem": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "content" + ] + }, + "chatCompletionRequestMessageUser": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "properties": { + "content": { + "oneOf": [ + { + "type": "string", + "description": "The contents of the message." + }, + { + "type": "array", + "description": "An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4-visual-preview` model.", + "minimum": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPart" + } + } + ], + "nullable": true + } + } + } + ], + "required": [ + "content" + ] + }, + "chatCompletionRequestMessageContentPart": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "text": "#/components/schemas/chatCompletionRequestMessageContentPartText", + "image_url": "#/components/schemas/chatCompletionRequestMessageContentPartImage" + } + }, + "required": [ + "type" + ] + }, + "chatCompletionRequestMessageContentPartType": { + "type": "string", + "enum": [ + "text", + "image_url" + ], + "description": "The type of the content part.", + "x-ms-enum": { + "name": "ChatCompletionRequestMessageContentPartType", + "modelAsString": true, + "values": [ + { + "value": "text", + "description": "The content part type is text." + }, + { + "value": "image_url", + "description": "The content part type is image_url." + } + ] + } + }, + "chatCompletionRequestMessageContentPartText": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPart" + }, + { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The text content." + } + } + } + ], + "required": [ + "text" + ] + }, + "chatCompletionRequestMessageContentPartImage": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPart" + }, + { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Either a URL of the image or the base64 encoded image data.", + "format": "uri" + }, + "detail": { + "$ref": "#/components/schemas/imageDetailLevel" + } + } + } + ], + "required": [ + "url" + ] + }, + "imageDetailLevel": { + "type": "string", + "description": "Specifies the detail level of the image.", + "enum": [ + "auto", + "low", + "high" + ], + "default": "auto", + "x-ms-enum": { + "name": "ImageDetailLevel", + "modelAsString": true, + "values": [ + { + "value": "auto", + "description": "The image detail level is auto." + }, + { + "value": "low", + "description": "The image detail level is low." + }, + { + "value": "high", + "description": "The image detail level is high." + } + ] + } + }, + "chatCompletionRequestMessageAssistant": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "context": { + "$ref": "#/components/schemas/azureChatExtensionsMessageContext" + } + } + } + ], + "required": [ + "content" + ] + }, + "azureChatExtensionConfiguration": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/azureChatExtensionType" + } + }, + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_search": "#/components/schemas/azureSearchChatExtensionConfiguration", + "azure_cosmos_db": "#/components/schemas/azureCosmosDBChatExtensionConfiguration" + } + } + }, + "azureChatExtensionType": { + "type": "string", + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "enum": [ + "azure_search", + "azure_cosmos_db" + ], + "x-ms-enum": { + "name": "AzureChatExtensionType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "azure_search", + "description": "Represents the use of Azure Search as an Azure OpenAI chat extension." + }, + { + "name": "azureCosmosDB", + "value": "azure_cosmos_db", + "description": "Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension." + } + ] + } + }, + "azureSearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureSearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_search" + }, + "azureSearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "endpoint": { + "type": "string", + "description": "The absolute endpoint path for the Azure Search resource to use.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Search resource." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureSearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/azureSearchQueryType" + }, + "semantic_configuration": { + "type": "string", + "description": "The additional semantic configuration for the query." + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + } + }, + "description": "Parameters for Azure Search when used as an Azure OpenAI chat extension." + }, + "azureSearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Search resource." + }, + "azureSearchQueryType": { + "type": "string", + "description": "The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "semantic", + "vector", + "vector_simple_hybrid", + "vector_semantic_hybrid" + ], + "x-ms-enum": { + "name": "azureSearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "semantic", + "value": "semantic", + "description": "Represents the semantic query parser for advanced semantic modeling." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + }, + { + "name": "vectorSimpleHybrid", + "value": "vector_simple_hybrid", + "description": "Represents a combination of the simple query strategy with vector data." + }, + { + "name": "vectorSemanticHybrid", + "value": "vector_semantic_hybrid", + "description": "Represents a combination of semantic search and vector data querying." + } + ] + } + }, + "azureCosmosDBChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureCosmosDBChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_cosmos_db" + }, + "azureCosmosDBChatExtensionParameters": { + "required": [ + "authentication", + "container_name", + "database_name", + "embedding_dependency", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "database_name": { + "type": "string", + "description": "The MongoDB vCore database name to use with Azure Cosmos DB." + }, + "container_name": { + "type": "string", + "description": "The name of the Azure Cosmos DB resource container." + }, + "index_name": { + "type": "string", + "description": "The MongoDB vCore index name to use with Azure Cosmos DB." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureCosmosDBFieldMappingOptions" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + } + }, + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore." + }, + "azureCosmosDBFieldMappingOptions": { + "required": [ + "content_fields", + "vector_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource." + }, + "onYourDataAuthenticationOptions": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataAuthenticationType" + } + }, + "description": "The authentication options for Azure OpenAI On Your Data.", + "discriminator": { + "propertyName": "type", + "mapping": { + "api_key": "#/components/schemas/onYourDataApiKeyAuthenticationOptions", + "connection_string": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions", + "system_assigned_managed_identity": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions", + "user_assigned_managed_identity": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + } + } + }, + "onYourDataAuthenticationType": { + "type": "string", + "description": "The authentication types supported with Azure OpenAI On Your Data.", + "enum": [ + "api_key", + "connection_string", + "system_assigned_managed_identity", + "user_assigned_managed_identity" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "api_key", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "connection_string", + "description": "Authentication via connection string." + }, + { + "name": "systemAssignedManagedIdentity", + "value": "system_assigned_managed_identity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "user_assigned_managed_identity", + "description": "Authentication via user-assigned managed identity." + } + ] + } + }, + "onYourDataApiKeyAuthenticationOptions": { + "required": [ + "key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "api_key" + }, + "onYourDataConnectionStringAuthenticationOptions": { + "required": [ + "connection_string" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "connection_string": { + "type": "string", + "description": "The connection string to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "connection_string" + }, + "onYourDataSystemAssignedManagedIdentityAuthenticationOptions": { + "description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "system_assigned_managed_identity" + }, + "onYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "required": [ + "managed_identity_resource_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "managed_identity_resource_id": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "user_assigned_managed_identity" + }, + "onYourDataVectorizationSource": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataVectorizationSourceType" + } + }, + "description": "An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.", + "discriminator": { + "propertyName": "type", + "mapping": { + "endpoint": "#/components/schemas/onYourDataEndpointVectorizationSource", + "deployment_name": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + } + }, + "onYourDataVectorizationSourceType": { + "type": "string", + "description": "Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with\nvector search.", + "enum": [ + "endpoint", + "deployment_name" + ], + "x-ms-enum": { + "name": "OnYourDataVectorizationSourceType", + "modelAsString": true, + "values": [ + { + "name": "endpoint", + "value": "endpoint", + "description": "Represents vectorization performed by public service calls to an Azure OpenAI embedding model." + }, + { + "name": "deploymentName", + "value": "deployment_name", + "description": "Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but\nOn Your Data will use this model deployment via an internal call rather than a public one, which enables vector\nsearch even in private networks." + } + ] + } + }, + "onYourDataDeploymentNameVectorizationSource": { + "required": [ + "deployment_name" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non an internal embeddings model deployment name in the same Azure OpenAI resource.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "deployment_name": { + "type": "string", + "description": "Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks." + } + } + } + ], + "x-ms-discriminator-value": "deployment_name" + }, + "onYourDataEndpointVectorizationSource": { + "required": [ + "authentication", + "endpoint" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a public Azure OpenAI endpoint call for embeddings.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + "endpoint": { + "type": "string", + "description": "Specifies the endpoint to use for vectorization. This endpoint must be in the same Azure OpenAI resource, but On Your Data will use this endpoint via an internal call rather than a public one, which enables vector search even in private networks.", + "format": "uri" + } + } + } + ], + "x-ms-discriminator-value": "endpoint" + }, + "azureChatExtensionsMessageContext": { + "type": "object", + "properties": { + "citations": { + "type": "array", + "description": "The data source retrieval result, used to generate the assistant message in the response.", + "items": { + "$ref": "#/components/schemas/citation" + }, + "x-ms-identifiers": [] + }, + "intent": { + "type": "string", + "description": "The detected intent from the chat history, used to pass to the next turn to carry over the context." + } + }, + "description": " A representation of the additional context information available when Azure OpenAI chat extensions are involved\n in the generation of a corresponding chat completions response. This context information is only populated when\n using an Azure OpenAI request configured to use a matching extension." + }, + "citation": { + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the citation." + }, + "title": { + "type": "string", + "description": "The title of the citation." + }, + "url": { + "type": "string", + "description": "The URL of the citation." + }, + "filepath": { + "type": "string", + "description": "The file path of the citation." + }, + "chunk_id": { + "type": "string", + "description": "The chunk ID of the citation." + } + }, + "description": "citation information for a chat completions response message." + }, + "chatCompletionMessageToolCall": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "$ref": "#/components/schemas/toolCallType" + }, + "function": { + "type": "object", + "description": "The function that the model called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "toolCallType": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool call, in this case `function`.", + "x-ms-enum": { + "name": "ToolCallType", + "modelAsString": true, + "values": [ + { + "value": "function", + "description": "The tool call type is function." + } + ] + } + }, + "chatCompletionRequestMessageTool": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "nullable": true, + "properties": { + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "tool_call_id", + "content" + ] + }, + "chatCompletionRequestMessageFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "description": "Deprecated. Message that represents a function.", + "nullable": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "name": { + "type": "string", + "description": "The contents of the message." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "function_call_id", + "content" + ] + }, + "createChatCompletionResponse": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionsResponseCommon" + }, + { + "properties": { + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "choices": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionChoiceCommon" + }, + { + "properties": { + "message": { + "$ref": "#/components/schemas/chatCompletionResponseMessage" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + }, + "logprobs": { + "$ref": "#/components/schemas/chatCompletionChoiceLogProbs" + } + } + } + ] + } + } + } + } + ], + "required": [ + "id", + "object", + "created", + "model", + "choices" + ] + }, + "chatCompletionChoiceLogProbs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content" + ] + }, + "chatCompletionTokenLogprob": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + }, + "top_logprobs": { + "description": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.", + "type": "array", + "items": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + } + }, + "required": [ + "token", + "logprob", + "bytes" + ] + } + } + }, + "required": [ + "token", + "logprob", + "bytes", + "top_logprobs" + ] + }, + "chatCompletionResponseMessage": { + "type": "object", + "description": "A chat completion message generated by the model.", + "properties": { + "role": { + "$ref": "#/components/schemas/chatCompletionResponseMessageRole" + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "function_call": { + "$ref": "#/components/schemas/chatCompletionFunctionCall" + }, + "context": { + "$ref": "#/components/schemas/azureChatExtensionsMessageContext" + } + } + }, + "chatCompletionResponseMessageRole": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the author of the response message." + }, + "chatCompletionToolChoiceOption": { + "description": "Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. Specifying a particular function via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that function.", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.", + "enum": [ + "none", + "auto", + "required" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionNamedToolChoice" + } + ] + }, + "chatCompletionNamedToolChoice": { + "type": "object", + "description": "Specifies a tool the model should use. Use to force the model to call a specific function.", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + } + }, + "chatCompletionFunctionCall": { + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "chatCompletionsResponseCommon": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion." + }, + "object": { + "$ref": "#/components/schemas/chatCompletionResponseObject" + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp (in seconds) of when the chat completion was created." + }, + "model": { + "type": "string", + "description": "The model used for the chat completion." + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + }, + "system_fingerprint": { + "type": "string", + "description": "Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism." + } + }, + "required": [ + "id", + "object", + "created", + "model" + ] + }, + "chatCompletionResponseObject": { + "type": "string", + "description": "The object type.", + "enum": [ + "chat.completion" + ], + "x-ms-enum": { + "name": "ChatCompletionResponseObject", + "modelAsString": true, + "values": [ + { + "value": "chat.completion", + "description": "The object type is chat completion." + } + ] + } + }, + "completionUsage": { + "type": "object", + "description": "Usage statistics for the completion request.", + "properties": { + "prompt_tokens": { + "type": "integer", + "description": "Number of tokens in the prompt." + }, + "completion_tokens": { + "type": "integer", + "description": "Number of tokens in the generated completion." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used in the request (prompt + completion)." + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + }, + "chatCompletionTool": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/chatCompletionToolType" + }, + "function": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/chatCompletionFunctionParameters" + } + }, + "required": [ + "name", + "parameters" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "chatCompletionToolType": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported.", + "x-ms-enum": { + "name": "ChatCompletionToolType", + "modelAsString": true, + "values": [ + { + "value": "function", + "description": "The tool type is function." + } + ] + } + }, + "chatCompletionChoiceCommon": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "finish_reason": { + "type": "string" + } + } + }, + "createTranslationRequest": { + "type": "object", + "description": "Translation request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file to translate.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + } + }, + "required": [ + "file" + ] + }, + "audioResponse": { + "description": "Translation or transcription response when response_format was json", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Translated or transcribed text." + } + }, + "required": [ + "text" + ] + }, + "audioVerboseResponse": { + "description": "Translation or transcription response when response_format was verbose_json", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "properties": { + "task": { + "type": "string", + "description": "Type of audio task.", + "enum": [ + "transcribe", + "translate" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "language": { + "type": "string", + "description": "Language." + }, + "duration": { + "type": "number", + "description": "Duration." + }, + "segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/audioSegment" + } + } + } + } + ], + "required": [ + "text" + ] + }, + "audioResponseFormat": { + "title": "AudioResponseFormat", + "description": "Defines the format of the output.", + "enum": [ + "json", + "text", + "srt", + "verbose_json", + "vtt" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true + } + }, + "createTranscriptionRequest": { + "type": "object", + "description": "Transcription request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file object to transcribe.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "language": { + "type": "string", + "description": "The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency." + } + }, + "required": [ + "file" + ] + }, + "audioSegment": { + "type": "object", + "description": "Transcription or translation segment.", + "properties": { + "id": { + "type": "integer", + "description": "Segment identifier." + }, + "seek": { + "type": "number", + "description": "Offset of the segment." + }, + "start": { + "type": "number", + "description": "Segment start offset." + }, + "end": { + "type": "number", + "description": "Segment end offset." + }, + "text": { + "type": "string", + "description": "Segment text." + }, + "tokens": { + "type": "array", + "items": { + "type": "number", + "nullable": false + }, + "description": "Tokens of the text." + }, + "temperature": { + "type": "number", + "description": "Temperature." + }, + "avg_logprob": { + "type": "number", + "description": "Average log probability." + }, + "compression_ratio": { + "type": "number", + "description": "Compression ratio." + }, + "no_speech_prob": { + "type": "number", + "description": "Probability of 'no speech'." + } + } + }, + "imageQuality": { + "description": "The quality of the image that will be generated.", + "type": "string", + "enum": [ + "standard", + "hd" + ], + "default": "standard", + "x-ms-enum": { + "name": "Quality", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Standard quality creates images with standard quality.", + "name": "Standard" + }, + { + "value": "hd", + "description": "HD quality creates images with finer details and greater consistency across the image.", + "name": "HD" + } + ] + } + }, + "imagesResponseFormat": { + "description": "The format in which the generated images are returned.", + "type": "string", + "enum": [ + "url", + "b64_json" + ], + "default": "url", + "x-ms-enum": { + "name": "ImagesResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "url", + "description": "The URL that provides temporary access to download the generated images.", + "name": "Url" + }, + { + "value": "b64_json", + "description": "The generated images are returned as base64 encoded string.", + "name": "Base64Json" + } + ] + } + }, + "imageSize": { + "description": "The size of the generated images.", + "type": "string", + "enum": [ + "1792x1024", + "1024x1792", + "1024x1024" + ], + "default": "1024x1024", + "x-ms-enum": { + "name": "Size", + "modelAsString": true, + "values": [ + { + "value": "1792x1024", + "description": "The desired size of the generated image is 1792x1024 pixels.", + "name": "Size1792x1024" + }, + { + "value": "1024x1792", + "description": "The desired size of the generated image is 1024x1792 pixels.", + "name": "Size1024x1792" + }, + { + "value": "1024x1024", + "description": "The desired size of the generated image is 1024x1024 pixels.", + "name": "Size1024x1024" + } + ] + } + }, + "imageStyle": { + "description": "The style of the generated images.", + "type": "string", + "enum": [ + "vivid", + "natural" + ], + "default": "vivid", + "x-ms-enum": { + "name": "Style", + "modelAsString": true, + "values": [ + { + "value": "vivid", + "description": "Vivid creates images that are hyper-realistic and dramatic.", + "name": "Vivid" + }, + { + "value": "natural", + "description": "Natural creates images that are more natural and less hyper-realistic.", + "name": "Natural" + } + ] + } + }, + "imageGenerationsRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "A text description of the desired image(s). The maximum length is 4000 characters.", + "type": "string", + "format": "string", + "example": "a corgi in a field", + "minLength": 1 + }, + "n": { + "description": "The number of images to generate.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "default": 1 + }, + "size": { + "$ref": "#/components/schemas/imageSize" + }, + "response_format": { + "$ref": "#/components/schemas/imagesResponseFormat" + }, + "user": { + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.", + "type": "string", + "format": "string", + "example": "user123456" + }, + "quality": { + "$ref": "#/components/schemas/imageQuality" + }, + "style": { + "$ref": "#/components/schemas/imageStyle" + } + }, + "required": [ + "prompt" + ] + }, + "generateImagesResponse": { + "type": "object", + "properties": { + "created": { + "type": "integer", + "format": "unixtime", + "description": "The unix timestamp when the operation was created.", + "example": "1676540381" + }, + "data": { + "type": "array", + "description": "The result data of the operation, if successful", + "items": { + "$ref": "#/components/schemas/imageResult" + } + } + }, + "required": [ + "created", + "data" + ] + }, + "imageResult": { + "type": "object", + "description": "The image url or encoded image if successful, and an error otherwise.", + "properties": { + "url": { + "type": "string", + "description": "The image url.", + "example": "https://www.contoso.com" + }, + "b64_json": { + "type": "string", + "description": "The base64 encoded image" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + } + } + } + }, + "securitySchemes": { + "bearer": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": {} + } + }, + "x-tokenInfoFunc": "api.middleware.auth.bearer_auth", + "x-scopeValidateFunc": "api.middleware.auth.validate_scopes" + }, + "apiKey": { + "type": "apiKey", + "name": "api-key", + "in": "header" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/inference.yaml new file mode 100644 index 000000000000..ec13cc22da6d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/inference.yaml @@ -0,0 +1,2084 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI Service API + description: Azure OpenAI APIs for completions and search + version: '2024-06-01' +servers: + - url: https://{endpoint}/openai + variables: + endpoint: + default: your-resource-name.openai.azure.com +security: + - bearer: + - api.read + - apiKey: [] +paths: + /deployments/{deployment-id}/completions: + post: + summary: Creates a completion for the provided prompt, parameters and chosen model. + operationId: Completions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: davinci + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-06-01 + description: api version + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + prompt: + description: |- + The prompt(s) to generate completions for, encoded as a string or array of strings. + Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document. Maximum allowed size of string list is 2048. + oneOf: + - type: string + default: '' + example: This is a test. + nullable: true + - type: array + items: + type: string + default: '' + example: This is a test. + nullable: false + description: Array size minimum of 1 and maximum of 2048 + max_tokens: + description: The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). Has minimum of 0. + type: integer + default: 16 + example: 16 + nullable: true + temperature: + description: |- + What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer. + We generally recommend altering this or top_p but not both. + type: number + default: 1 + example: 1 + nullable: true + top_p: + description: |- + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + We generally recommend altering this or temperature but not both. + type: number + default: 1 + example: 1 + nullable: true + logit_bias: + description: Defaults to null. Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this tokenizer tool (which works for both GPT-2 and GPT-3) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. As an example, you can pass {"50256" : -100} to prevent the <|endoftext|> token from being generated. + type: object + nullable: false + user: + description: A unique identifier representing your end-user, which can help monitoring and detecting abuse + type: string + nullable: false + 'n': + description: |- + How many completions to generate for each prompt. Minimum of 1 and maximum of 128 allowed. + Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop. + type: integer + default: 1 + example: 1 + nullable: true + stream: + description: 'Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.' + type: boolean + nullable: true + default: false + logprobs: + description: |- + Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens. For example, if logprobs is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response. + Minimum of 0 and maximum of 5 allowed. + type: integer + default: null + nullable: true + suffix: + type: string + nullable: true + description: The suffix that comes after a completion of inserted text. + echo: + description: Echo back the prompt in addition to the completion + type: boolean + default: false + nullable: true + stop: + description: Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. + oneOf: + - type: string + default: <|endoftext|> + example: |+ + nullable: true + - type: array + items: + type: string + example: |+ + nullable: false + description: Array minimum size of 1 and maximum of 4 + completion_config: + type: string + nullable: true + presence_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + type: number + default: 0 + frequency_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + type: number + default: 0 + best_of: + description: |- + Generates best_of completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed. + When used with n, best_of controls the number of candidate completions and n specifies how many to return - best_of must be greater than n. + Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop. Has maximum value of 128. + type: integer + example: + prompt: |- + Negate the following sentence.The price for bubblegum increased on thursday. + Negated Sentence: + max_tokens: 50 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + object: + type: string + created: + type: integer + model: + type: string + prompt_filter_results: + $ref: '#/components/schemas/promptFilterResults' + choices: + type: array + items: + type: object + properties: + text: + type: string + index: + type: integer + logprobs: + type: object + properties: + tokens: + type: array + items: + type: string + token_logprobs: + type: array + items: + type: number + top_logprobs: + type: array + items: + type: object + additionalProperties: + type: number + text_offset: + type: array + items: + type: integer + nullable: true + finish_reason: + type: string + content_filter_results: + $ref: '#/components/schemas/contentFilterChoiceResults' + usage: + type: object + properties: + completion_tokens: + type: number + format: int32 + prompt_tokens: + type: number + format: int32 + total_tokens: + type: number + format: int32 + required: + - prompt_tokens + - total_tokens + - completion_tokens + required: + - id + - object + - created + - model + - choices + example: + model: davinci + object: text_completion + id: cmpl-4509KAos68kxOqpE2uYGw81j6m7uo + created: 1637097562 + choices: + - index: 0 + text: The price for bubblegum decreased on thursday. + logprobs: null + finish_reason: stop + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse' + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + /deployments/{deployment-id}/embeddings: + post: + summary: Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. + operationId: embeddings_create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: ada-search-index-v1 + description: The deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-06-01' + description: api version + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: true + properties: + input: + description: |- + Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length. + Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present. + oneOf: + - type: string + default: '' + example: This is a test. + nullable: true + - type: array + minItems: 1 + maxItems: 2048 + items: + type: string + minLength: 1 + example: This is a test. + nullable: false + user: + description: A unique identifier representing your end-user, which can help monitoring and detecting abuse. + type: string + nullable: false + input_type: + description: input type of embedding search to use + type: string + example: query + encoding_format: + description: The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`. + type: string + example: base64 + nullable: true + dimensions: + description: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. + type: integer + example: 1 + nullable: true + required: + - input + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + object: + type: string + model: + type: string + data: + type: array + items: + type: object + properties: + index: + type: integer + object: + type: string + embedding: + type: array + items: + type: number + required: + - index + - object + - embedding + usage: + type: object + properties: + prompt_tokens: + type: integer + total_tokens: + type: integer + required: + - prompt_tokens + - total_tokens + required: + - object + - model + - data + - usage + x-ms-examples: + Create a embeddings.: + $ref: ./examples/embeddings.yaml + /deployments/{deployment-id}/chat/completions: + post: + summary: Creates a completion for the chat message + operationId: ChatCompletions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-06-01' + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/createChatCompletionRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/createChatCompletionResponse' + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse' + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + x-ms-examples: + Create a chat completion.: + $ref: ./examples/chat_completions.yaml + Creates a completion based on Azure Search data and system-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_minimum.yaml + Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_advanced.yaml + Creates a completion for the provided Azure Cosmos DB.: + $ref: ./examples/chat_completions_cosmos_db.yaml + /deployments/{deployment-id}/audio/transcriptions: + post: + summary: Transcribes audio into the input language. + operationId: Transcriptions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-06-01' + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/createTranscriptionRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/audioResponse' + - $ref: '#/components/schemas/audioVerboseResponse' + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio transcription with json response format.: + $ref: ./examples/audio_transcription_object.yaml + Create an audio transcription with text response format.: + $ref: ./examples/audio_transcription_text.yaml + /deployments/{deployment-id}/audio/translations: + post: + summary: Transcribes and translates input audio into English text. + operationId: Translations_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-06-01' + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/createTranslationRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/audioResponse' + - $ref: '#/components/schemas/audioVerboseResponse' + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio translation with json response format.: + $ref: ./examples/audio_translation_object.yaml + Create an audio translation with text response format.: + $ref: ./examples/audio_translation_text.yaml + /deployments/{deployment-id}/images/generations: + post: + summary: Generates a batch of images from a text caption on a given DALLE model deployment + operationId: ImageGenerations_Create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/imageGenerationsRequest' + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: dalle-deployment + description: Deployment id of the dalle model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-06-01' + description: api version + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/generateImagesResponse' + default: + description: An error occurred. + content: + application/json: + schema: + $ref: '#/components/schemas/dalleErrorResponse' + x-ms-examples: + Create an image.: + $ref: ./examples/image_generation.yaml +components: + schemas: + errorResponse: + type: object + properties: + error: + $ref: '#/components/schemas/error' + errorBase: + type: object + properties: + code: + type: string + message: + type: string + error: + type: object + allOf: + - $ref: '#/components/schemas/errorBase' + properties: + param: + type: string + type: + type: string + inner_error: + $ref: '#/components/schemas/innerError' + innerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: '#/components/schemas/innerErrorCode' + content_filter_results: + $ref: '#/components/schemas/contentFilterPromptResults' + innerErrorCode: + description: Error codes for the inner error object. + enum: + - ResponsibleAIPolicyViolation + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: ResponsibleAIPolicyViolation + description: The prompt violated one of more content filter rules. + dalleErrorResponse: + type: object + properties: + error: + $ref: '#/components/schemas/dalleError' + dalleError: + type: object + allOf: + - $ref: '#/components/schemas/errorBase' + properties: + param: + type: string + type: + type: string + inner_error: + $ref: '#/components/schemas/dalleInnerError' + dalleInnerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: '#/components/schemas/innerErrorCode' + content_filter_results: + $ref: '#/components/schemas/dalleFilterResults' + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + contentFilterResultBase: + type: object + properties: + filtered: + type: boolean + required: + - filtered + contentFilterSeverityResult: + type: object + allOf: + - $ref: '#/components/schemas/contentFilterResultBase' + - properties: + severity: + type: string + enum: + - safe + - low + - medium + - high + x-ms-enum: + name: ContentFilterSeverity + modelAsString: true + values: + - value: safe + description: General content or related content in generic or non-harmful contexts. + - value: low + description: Harmful content at a low intensity and risk level. + - value: medium + description: Harmful content at a medium intensity and risk level. + - value: high + description: Harmful content at a high intensity and risk level. + required: + - severity + - filtered + contentFilterDetectedResult: + type: object + allOf: + - $ref: '#/components/schemas/contentFilterResultBase' + - properties: + detected: + type: boolean + required: + - detected + - filtered + contentFilterDetectedWithCitationResult: + type: object + allOf: + - $ref: '#/components/schemas/contentFilterDetectedResult' + - properties: + citation: + type: object + properties: + URL: + type: string + license: + type: string + required: + - detected + - filtered + contentFilterResultsBase: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: '#/components/schemas/contentFilterSeverityResult' + violence: + $ref: '#/components/schemas/contentFilterSeverityResult' + hate: + $ref: '#/components/schemas/contentFilterSeverityResult' + self_harm: + $ref: '#/components/schemas/contentFilterSeverityResult' + profanity: + $ref: '#/components/schemas/contentFilterDetectedResult' + error: + $ref: '#/components/schemas/errorBase' + contentFilterPromptResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: '#/components/schemas/contentFilterResultsBase' + - properties: + jailbreak: + $ref: '#/components/schemas/contentFilterDetectedResult' + contentFilterChoiceResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: '#/components/schemas/contentFilterResultsBase' + - properties: + protected_material_text: + $ref: '#/components/schemas/contentFilterDetectedResult' + - properties: + protected_material_code: + $ref: '#/components/schemas/contentFilterDetectedWithCitationResult' + promptFilterResult: + type: object + description: Content filtering results for a single prompt in the request. + properties: + prompt_index: + type: integer + content_filter_results: + $ref: '#/components/schemas/contentFilterPromptResults' + promptFilterResults: + type: array + description: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders. + items: + $ref: '#/components/schemas/promptFilterResult' + dalleContentFilterResults: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: '#/components/schemas/contentFilterSeverityResult' + violence: + $ref: '#/components/schemas/contentFilterSeverityResult' + hate: + $ref: '#/components/schemas/contentFilterSeverityResult' + self_harm: + $ref: '#/components/schemas/contentFilterSeverityResult' + dalleFilterResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: '#/components/schemas/dalleContentFilterResults' + - properties: + profanity: + $ref: '#/components/schemas/contentFilterDetectedResult' + jailbreak: + $ref: '#/components/schemas/contentFilterDetectedResult' + chatCompletionsRequestCommon: + type: object + properties: + temperature: + description: |- + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + We generally recommend altering this or `top_p` but not both. + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + description: |- + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + We generally recommend altering this or `temperature` but not both. + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + stream: + description: 'If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.' + type: boolean + nullable: true + default: false + stop: + description: Up to 4 sequences where the API will stop generating further tokens. + oneOf: + - type: string + nullable: true + - type: array + items: + type: string + nullable: false + minItems: 1 + maxItems: 4 + description: Array minimum size of 1 and maximum of 4 + default: null + max_tokens: + description: The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). + type: integer + default: 4096 + presence_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + type: number + default: 0 + minimum: -2 + maximum: 2 + frequency_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + type: number + default: 0 + minimum: -2 + maximum: 2 + logit_bias: + description: Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + type: object + nullable: true + user: + description: A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse. + type: string + example: user-1234 + nullable: false + createChatCompletionRequest: + type: object + allOf: + - $ref: '#/components/schemas/chatCompletionsRequestCommon' + - properties: + messages: + description: A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb). + type: array + minItems: 1 + items: + $ref: '#/components/schemas/chatCompletionRequestMessage' + data_sources: + type: array + description: |2- + The configuration entries for Azure OpenAI chat extensions that use them. + This additional specification is only compatible with Azure OpenAI. + items: + $ref: '#/components/schemas/azureChatExtensionConfiguration' + 'n': + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: How many chat completion choices to generate for each input message. + seed: + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + default: 0 + example: 1 + nullable: true + description: If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + logprobs: + description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model. + type: boolean + default: false + nullable: true + top_logprobs: + description: An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. + type: integer + minimum: 0 + maximum: 5 + nullable: true + response_format: + type: object + description: An object specifying the format that the model must output. Used to enable JSON mode. + properties: + type: + $ref: '#/components/schemas/chatCompletionResponseFormat' + tools: + description: A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. + type: array + minItems: 1 + items: + $ref: '#/components/schemas/chatCompletionTool' + tool_choice: + $ref: '#/components/schemas/chatCompletionToolChoiceOption' + functions: + description: Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for. + type: array + minItems: 1 + maxItems: 128 + items: + $ref: '#/components/schemas/chatCompletionFunction' + function_call: + description: Deprecated in favor of `tool_choice`. Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via `{"name":\ "my_function"}` forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present. + oneOf: + - type: string + enum: + - none + - auto + description: '`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.' + - type: object + description: 'Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.' + properties: + name: + type: string + description: The name of the function to call. + required: + - name + required: + - messages + chatCompletionResponseFormat: + type: string + enum: + - text + - json_object + default: text + example: json_object + nullable: true + description: Setting to `json_object` enables JSON mode. This guarantees that the message the model generates is valid JSON. + x-ms-enum: + name: ChatCompletionResponseFormat + modelAsString: true + values: + - value: text + description: Response format is a plain text string. + - value: json_object + description: Response format is a JSON object. + chatCompletionFunction: + type: object + properties: + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + description: + type: string + description: The description of what the function does. + parameters: + $ref: '#/components/schemas/chatCompletionFunctionParameters' + required: + - name + chatCompletionFunctionParameters: + type: object + description: The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. + additionalProperties: true + chatCompletionRequestMessage: + type: object + properties: + role: + $ref: '#/components/schemas/chatCompletionRequestMessageRole' + discriminator: + propertyName: role + mapping: + system: '#/components/schemas/chatCompletionRequestMessageSystem' + user: '#/components/schemas/chatCompletionRequestMessageUser' + assistant: '#/components/schemas/chatCompletionRequestMessageAssistant' + tool: '#/components/schemas/chatCompletionRequestMessageTool' + function: '#/components/schemas/chatCompletionRequestMessageFunction' + required: + - role + chatCompletionRequestMessageRole: + type: string + enum: + - system + - user + - assistant + - tool + - function + description: The role of the messages author. + x-ms-enum: + name: ChatCompletionRequestMessageRole + modelAsString: true + values: + - value: system + description: The message author role is system. + - value: user + description: The message author role is user. + - value: assistant + description: The message author role is assistant. + - value: tool + description: The message author role is tool. + - value: function + description: Deprecated. The message author role is function. + chatCompletionRequestMessageSystem: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + properties: + content: + type: string + description: The contents of the message. + nullable: true + required: + - content + chatCompletionRequestMessageUser: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + properties: + content: + oneOf: + - type: string + description: The contents of the message. + - type: array + description: An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4-visual-preview` model. + minimum: 1 + items: + $ref: '#/components/schemas/chatCompletionRequestMessageContentPart' + nullable: true + required: + - content + chatCompletionRequestMessageContentPart: + type: object + properties: + type: + $ref: '#/components/schemas/chatCompletionRequestMessageContentPartType' + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/chatCompletionRequestMessageContentPartText' + image_url: '#/components/schemas/chatCompletionRequestMessageContentPartImage' + required: + - type + chatCompletionRequestMessageContentPartType: + type: string + enum: + - text + - image_url + description: The type of the content part. + x-ms-enum: + name: ChatCompletionRequestMessageContentPartType + modelAsString: true + values: + - value: text + description: The content part type is text. + - value: image_url + description: The content part type is image_url. + chatCompletionRequestMessageContentPartText: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessageContentPart' + - type: object + properties: + text: + type: string + description: The text content. + required: + - text + chatCompletionRequestMessageContentPartImage: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessageContentPart' + - type: object + properties: + url: + type: string + description: Either a URL of the image or the base64 encoded image data. + format: uri + detail: + $ref: '#/components/schemas/imageDetailLevel' + required: + - url + imageDetailLevel: + type: string + description: Specifies the detail level of the image. + enum: + - auto + - low + - high + default: auto + x-ms-enum: + name: ImageDetailLevel + modelAsString: true + values: + - value: auto + description: The image detail level is auto. + - value: low + description: The image detail level is low. + - value: high + description: The image detail level is high. + chatCompletionRequestMessageAssistant: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + properties: + content: + type: string + description: The contents of the message. + nullable: true + tool_calls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: '#/components/schemas/chatCompletionMessageToolCall' + context: + $ref: '#/components/schemas/azureChatExtensionsMessageContext' + required: + - content + azureChatExtensionConfiguration: + required: + - type + type: object + properties: + type: + $ref: '#/components/schemas/azureChatExtensionType' + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + discriminator: + propertyName: type + mapping: + azure_search: '#/components/schemas/azureSearchChatExtensionConfiguration' + azure_cosmos_db: '#/components/schemas/azureCosmosDBChatExtensionConfiguration' + azureChatExtensionType: + type: string + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + enum: + - azure_search + - azure_cosmos_db + x-ms-enum: + name: AzureChatExtensionType + modelAsString: true + values: + - name: azureSearch + value: azure_search + description: Represents the use of Azure Search as an Azure OpenAI chat extension. + - name: azureCosmosDB + value: azure_cosmos_db + description: Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension. + azureSearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: '#/components/schemas/azureChatExtensionConfiguration' + - properties: + parameters: + $ref: '#/components/schemas/azureSearchChatExtensionParameters' + x-ms-discriminator-value: azure_search + azureSearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: '#/components/schemas/onYourDataApiKeyAuthenticationOptions' + - $ref: '#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions' + - $ref: '#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions' + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + role_information: + type: string + description: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit. + endpoint: + type: string + description: The absolute endpoint path for the Azure Search resource to use. + format: uri + index_name: + type: string + description: The name of the index to use as available in the referenced Azure Search resource. + fields_mapping: + $ref: '#/components/schemas/azureSearchIndexFieldMappingOptions' + query_type: + $ref: '#/components/schemas/azureSearchQueryType' + semantic_configuration: + type: string + description: The additional semantic configuration for the query. + filter: + type: string + description: Search filter. + embedding_dependency: + oneOf: + - $ref: '#/components/schemas/onYourDataEndpointVectorizationSource' + - $ref: '#/components/schemas/onYourDataDeploymentNameVectorizationSource' + description: Parameters for Azure Search when used as an Azure OpenAI chat extension. + azureSearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Search resource. + azureSearchQueryType: + type: string + description: The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - semantic + - vector + - vector_simple_hybrid + - vector_semantic_hybrid + x-ms-enum: + name: azureSearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: semantic + value: semantic + description: Represents the semantic query parser for advanced semantic modeling. + - name: vector + value: vector + description: Represents vector search over computed data. + - name: vectorSimpleHybrid + value: vector_simple_hybrid + description: Represents a combination of the simple query strategy with vector data. + - name: vectorSemanticHybrid + value: vector_semantic_hybrid + description: Represents a combination of semantic search and vector data querying. + azureCosmosDBChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: '#/components/schemas/azureChatExtensionConfiguration' + - properties: + parameters: + $ref: '#/components/schemas/azureCosmosDBChatExtensionParameters' + x-ms-discriminator-value: azure_cosmos_db + azureCosmosDBChatExtensionParameters: + required: + - authentication + - container_name + - database_name + - embedding_dependency + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: '#/components/schemas/onYourDataConnectionStringAuthenticationOptions' + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + role_information: + type: string + description: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit. + database_name: + type: string + description: The MongoDB vCore database name to use with Azure Cosmos DB. + container_name: + type: string + description: The name of the Azure Cosmos DB resource container. + index_name: + type: string + description: The MongoDB vCore index name to use with Azure Cosmos DB. + fields_mapping: + $ref: '#/components/schemas/azureCosmosDBFieldMappingOptions' + embedding_dependency: + oneOf: + - $ref: '#/components/schemas/onYourDataEndpointVectorizationSource' + - $ref: '#/components/schemas/onYourDataDeploymentNameVectorizationSource' + description: |- + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for + MongoDB vCore. + azureCosmosDBFieldMappingOptions: + required: + - content_fields + - vector_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource. + onYourDataAuthenticationOptions: + required: + - type + type: object + properties: + type: + $ref: '#/components/schemas/onYourDataAuthenticationType' + description: The authentication options for Azure OpenAI On Your Data. + discriminator: + propertyName: type + mapping: + api_key: '#/components/schemas/onYourDataApiKeyAuthenticationOptions' + connection_string: '#/components/schemas/onYourDataConnectionStringAuthenticationOptions' + system_assigned_managed_identity: '#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions' + user_assigned_managed_identity: '#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions' + onYourDataAuthenticationType: + type: string + description: The authentication types supported with Azure OpenAI On Your Data. + enum: + - api_key + - connection_string + - system_assigned_managed_identity + - user_assigned_managed_identity + x-ms-enum: + name: OnYourDataAuthenticationType + modelAsString: true + values: + - name: apiKey + value: api_key + description: Authentication via API key. + - name: connectionString + value: connection_string + description: Authentication via connection string. + - name: systemAssignedManagedIdentity + value: system_assigned_managed_identity + description: Authentication via system-assigned managed identity. + - name: userAssignedManagedIdentity + value: user_assigned_managed_identity + description: Authentication via user-assigned managed identity. + onYourDataApiKeyAuthenticationOptions: + required: + - key + description: The authentication options for Azure OpenAI On Your Data when using an API key. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + - properties: + key: + type: string + description: The API key to use for authentication. + x-ms-discriminator-value: api_key + onYourDataConnectionStringAuthenticationOptions: + required: + - connection_string + description: The authentication options for Azure OpenAI On Your Data when using a connection string. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + - properties: + connection_string: + type: string + description: The connection string to use for authentication. + x-ms-discriminator-value: connection_string + onYourDataSystemAssignedManagedIdentityAuthenticationOptions: + description: The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + x-ms-discriminator-value: system_assigned_managed_identity + onYourDataUserAssignedManagedIdentityAuthenticationOptions: + required: + - managed_identity_resource_id + description: The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + - properties: + managed_identity_resource_id: + type: string + description: The resource ID of the user-assigned managed identity to use for authentication. + x-ms-discriminator-value: user_assigned_managed_identity + onYourDataVectorizationSource: + required: + - type + type: object + properties: + type: + $ref: '#/components/schemas/onYourDataVectorizationSourceType' + description: An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search. + discriminator: + propertyName: type + mapping: + endpoint: '#/components/schemas/onYourDataEndpointVectorizationSource' + deployment_name: '#/components/schemas/onYourDataDeploymentNameVectorizationSource' + onYourDataVectorizationSourceType: + type: string + description: |- + Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with + vector search. + enum: + - endpoint + - deployment_name + x-ms-enum: + name: OnYourDataVectorizationSourceType + modelAsString: true + values: + - name: endpoint + value: endpoint + description: Represents vectorization performed by public service calls to an Azure OpenAI embedding model. + - name: deploymentName + value: deployment_name + description: |- + Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but + On Your Data will use this model deployment via an internal call rather than a public one, which enables vector + search even in private networks. + onYourDataDeploymentNameVectorizationSource: + required: + - deployment_name + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on an internal embeddings model deployment name in the same Azure OpenAI resource. + allOf: + - $ref: '#/components/schemas/onYourDataVectorizationSource' + - properties: + deployment_name: + type: string + description: Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks. + x-ms-discriminator-value: deployment_name + onYourDataEndpointVectorizationSource: + required: + - authentication + - endpoint + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a public Azure OpenAI endpoint call for embeddings. + allOf: + - $ref: '#/components/schemas/onYourDataVectorizationSource' + - properties: + authentication: + $ref: '#/components/schemas/onYourDataApiKeyAuthenticationOptions' + endpoint: + type: string + description: Specifies the endpoint to use for vectorization. This endpoint must be in the same Azure OpenAI resource, but On Your Data will use this endpoint via an internal call rather than a public one, which enables vector search even in private networks. + format: uri + x-ms-discriminator-value: endpoint + azureChatExtensionsMessageContext: + type: object + properties: + citations: + type: array + description: The data source retrieval result, used to generate the assistant message in the response. + items: + $ref: '#/components/schemas/citation' + x-ms-identifiers: [] + intent: + type: string + description: The detected intent from the chat history, used to pass to the next turn to carry over the context. + description: |2- + A representation of the additional context information available when Azure OpenAI chat extensions are involved + in the generation of a corresponding chat completions response. This context information is only populated when + using an Azure OpenAI request configured to use a matching extension. + citation: + required: + - content + type: object + properties: + content: + type: string + description: The content of the citation. + title: + type: string + description: The title of the citation. + url: + type: string + description: The URL of the citation. + filepath: + type: string + description: The file path of the citation. + chunk_id: + type: string + description: The chunk ID of the citation. + description: citation information for a chat completions response message. + chatCompletionMessageToolCall: + type: object + properties: + id: + type: string + description: The ID of the tool call. + type: + $ref: '#/components/schemas/toolCallType' + function: + type: object + description: The function that the model called. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + required: + - id + - type + - function + toolCallType: + type: string + enum: + - function + description: The type of the tool call, in this case `function`. + x-ms-enum: + name: ToolCallType + modelAsString: true + values: + - value: function + description: The tool call type is function. + chatCompletionRequestMessageTool: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + nullable: true + properties: + tool_call_id: + type: string + description: Tool call that this message is responding to. + content: + type: string + description: The contents of the message. + nullable: true + required: + - tool_call_id + - content + chatCompletionRequestMessageFunction: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + description: Deprecated. Message that represents a function. + nullable: true + properties: + role: + type: string + enum: + - function + description: The role of the messages author, in this case `function`. + name: + type: string + description: The contents of the message. + content: + type: string + description: The contents of the message. + nullable: true + required: + - function_call_id + - content + createChatCompletionResponse: + type: object + allOf: + - $ref: '#/components/schemas/chatCompletionsResponseCommon' + - properties: + prompt_filter_results: + $ref: '#/components/schemas/promptFilterResults' + choices: + type: array + items: + type: object + allOf: + - $ref: '#/components/schemas/chatCompletionChoiceCommon' + - properties: + message: + $ref: '#/components/schemas/chatCompletionResponseMessage' + content_filter_results: + $ref: '#/components/schemas/contentFilterChoiceResults' + logprobs: + $ref: '#/components/schemas/chatCompletionChoiceLogProbs' + required: + - id + - object + - created + - model + - choices + chatCompletionChoiceLogProbs: + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: '#/components/schemas/chatCompletionTokenLogprob' + nullable: true + required: + - content + chatCompletionTokenLogprob: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + top_logprobs: + description: List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. + type: array + items: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + required: + - token + - logprob + - bytes + required: + - token + - logprob + - bytes + - top_logprobs + + chatCompletionResponseMessage: + type: object + description: A chat completion message generated by the model. + properties: + role: + $ref: '#/components/schemas/chatCompletionResponseMessageRole' + content: + type: string + description: The contents of the message. + nullable: true + tool_calls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: '#/components/schemas/chatCompletionMessageToolCall' + function_call: + $ref: '#/components/schemas/chatCompletionFunctionCall' + context: + $ref: '#/components/schemas/azureChatExtensionsMessageContext' + chatCompletionResponseMessageRole: + type: string + enum: + - assistant + description: The role of the author of the response message. + chatCompletionToolChoiceOption: + description: 'Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. Specifying a particular function via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that function.' + oneOf: + - type: string + description: '`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.' + enum: + - none + - auto + - required + - $ref: '#/components/schemas/chatCompletionNamedToolChoice' + chatCompletionNamedToolChoice: + type: object + description: Specifies a tool the model should use. Use to force the model to call a specific function. + properties: + type: + type: string + enum: + - function + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + required: + - name + chatCompletionFunctionCall: + type: object + description: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + chatCompletionsResponseCommon: + type: object + properties: + id: + type: string + description: A unique identifier for the chat completion. + object: + $ref: '#/components/schemas/chatCompletionResponseObject' + created: + type: integer + format: unixtime + description: The Unix timestamp (in seconds) of when the chat completion was created. + model: + type: string + description: The model used for the chat completion. + usage: + $ref: '#/components/schemas/completionUsage' + system_fingerprint: + type: string + description: Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + required: + - id + - object + - created + - model + chatCompletionResponseObject: + type: string + description: The object type. + enum: + - chat.completion + x-ms-enum: + name: ChatCompletionResponseObject + modelAsString: true + values: + - value: chat.completion + description: The object type is chat completion. + completionUsage: + type: object + description: Usage statistics for the completion request. + properties: + prompt_tokens: + type: integer + description: Number of tokens in the prompt. + completion_tokens: + type: integer + description: Number of tokens in the generated completion. + total_tokens: + type: integer + description: Total number of tokens used in the request (prompt + completion). + required: + - prompt_tokens + - completion_tokens + - total_tokens + chatCompletionTool: + type: object + properties: + type: + $ref: '#/components/schemas/chatCompletionToolType' + function: + type: object + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: '#/components/schemas/chatCompletionFunctionParameters' + required: + - name + - parameters + required: + - type + - function + chatCompletionToolType: + type: string + enum: + - function + description: The type of the tool. Currently, only `function` is supported. + x-ms-enum: + name: ChatCompletionToolType + modelAsString: true + values: + - value: function + description: The tool type is function. + chatCompletionChoiceCommon: + type: object + properties: + index: + type: integer + finish_reason: + type: string + createTranslationRequest: + type: object + description: Translation request. + properties: + file: + type: string + description: The audio file to translate. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English. + response_format: + $ref: '#/components/schemas/audioResponseFormat' + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + required: + - file + audioResponse: + description: Translation or transcription response when response_format was json + type: object + properties: + text: + type: string + description: Translated or transcribed text. + required: + - text + audioVerboseResponse: + description: Translation or transcription response when response_format was verbose_json + type: object + allOf: + - $ref: '#/components/schemas/audioResponse' + - properties: + task: + type: string + description: Type of audio task. + enum: + - transcribe + - translate + x-ms-enum: + modelAsString: true + language: + type: string + description: Language. + duration: + type: number + description: Duration. + segments: + type: array + items: + $ref: '#/components/schemas/audioSegment' + required: + - text + audioResponseFormat: + title: AudioResponseFormat + description: Defines the format of the output. + enum: + - json + - text + - srt + - verbose_json + - vtt + type: string + x-ms-enum: + modelAsString: true + createTranscriptionRequest: + type: object + description: Transcription request. + properties: + file: + type: string + description: The audio file object to transcribe. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. + response_format: + $ref: '#/components/schemas/audioResponseFormat' + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + language: + type: string + description: The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. + required: + - file + audioSegment: + type: object + description: Transcription or translation segment. + properties: + id: + type: integer + description: Segment identifier. + seek: + type: number + description: Offset of the segment. + start: + type: number + description: Segment start offset. + end: + type: number + description: Segment end offset. + text: + type: string + description: Segment text. + tokens: + type: array + items: + type: number + nullable: false + description: Tokens of the text. + temperature: + type: number + description: Temperature. + avg_logprob: + type: number + description: Average log probability. + compression_ratio: + type: number + description: Compression ratio. + no_speech_prob: + type: number + description: Probability of 'no speech'. + imageQuality: + description: The quality of the image that will be generated. + type: string + enum: + - standard + - hd + default: standard + x-ms-enum: + name: Quality + modelAsString: true + values: + - value: standard + description: Standard quality creates images with standard quality. + name: Standard + - value: hd + description: HD quality creates images with finer details and greater consistency across the image. + name: HD + imagesResponseFormat: + description: The format in which the generated images are returned. + type: string + enum: + - url + - b64_json + default: url + x-ms-enum: + name: ImagesResponseFormat + modelAsString: true + values: + - value: url + description: The URL that provides temporary access to download the generated images. + name: Url + - value: b64_json + description: The generated images are returned as base64 encoded string. + name: Base64Json + imageSize: + description: The size of the generated images. + type: string + enum: + - 1792x1024 + - 1024x1792 + - 1024x1024 + default: 1024x1024 + x-ms-enum: + name: Size + modelAsString: true + values: + - value: 1792x1024 + description: The desired size of the generated image is 1792x1024 pixels. + name: Size1792x1024 + - value: 1024x1792 + description: The desired size of the generated image is 1024x1792 pixels. + name: Size1024x1792 + - value: 1024x1024 + description: The desired size of the generated image is 1024x1024 pixels. + name: Size1024x1024 + imageStyle: + description: The style of the generated images. + type: string + enum: + - vivid + - natural + default: vivid + x-ms-enum: + name: Style + modelAsString: true + values: + - value: vivid + description: Vivid creates images that are hyper-realistic and dramatic. + name: Vivid + - value: natural + description: Natural creates images that are more natural and less hyper-realistic. + name: Natural + imageGenerationsRequest: + type: object + properties: + prompt: + description: A text description of the desired image(s). The maximum length is 4000 characters. + type: string + format: string + example: a corgi in a field + minLength: 1 + 'n': + description: The number of images to generate. + type: integer + minimum: 1 + maximum: 1 + default: 1 + size: + $ref: '#/components/schemas/imageSize' + response_format: + $ref: '#/components/schemas/imagesResponseFormat' + user: + description: A unique identifier representing your end-user, which can help to monitor and detect abuse. + type: string + format: string + example: user123456 + quality: + $ref: '#/components/schemas/imageQuality' + style: + $ref: '#/components/schemas/imageStyle' + required: + - prompt + generateImagesResponse: + type: object + properties: + created: + type: integer + format: unixtime + description: The unix timestamp when the operation was created. + example: '1676540381' + data: + type: array + description: The result data of the operation, if successful + items: + $ref: '#/components/schemas/imageResult' + required: + - created + - data + imageResult: + type: object + description: The image url or encoded image if successful, and an error otherwise. + properties: + url: + type: string + description: The image url. + example: https://www.contoso.com + b64_json: + type: string + description: The base64 encoded image + content_filter_results: + $ref: '#/components/schemas/dalleContentFilterResults' + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + prompt_filter_results: + $ref: '#/components/schemas/dalleFilterResults' + securitySchemes: + bearer: + type: oauth2 + flows: + implicit: + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: {} + x-tokenInfoFunc: api.middleware.auth.bearer_auth + x-scopeValidateFunc: api.middleware.auth.validate_scopes + apiKey: + type: apiKey + name: api-key + in: header From fb8cd14824741eaaad696513e945913e659da396 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Mon, 1 Jul 2024 12:41:25 +0800 Subject: [PATCH 262/343] Update readme.python.md (#29630) * Update readme.python.md * Update readme.python.md --- .../network/resource-manager/readme.python.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/specification/network/resource-manager/readme.python.md b/specification/network/resource-manager/readme.python.md index f458af526457..99f1340e94a7 100644 --- a/specification/network/resource-manager/readme.python.md +++ b/specification/network/resource-manager/readme.python.md @@ -18,9 +18,10 @@ Generate all API versions currently shipped for this package ```yaml $(python) multiapi: true -default-api-version: "2023-11-01" +default-api-version: "2024-01-01" clear-output-folder: true batch: + - tag: package-2024-01 - tag: package-2023-11 - tag: package-2023-09 - tag: package-2023-06 @@ -59,6 +60,16 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2024-01 and python + +These settings apply only when `--tag=package-2024-01 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-01' +namespace: azure.mgmt.network.v2024_01_01 +output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2024_01_01 +``` + ### Tag: package-2023-11 and python These settings apply only when `--tag=package-2023-11 --python` is specified on the command line. From abad0096677005817d2c19df2364663e5583c8fc Mon Sep 17 00:00:00 2001 From: Xiaofei Cao <92354331+XiaofeiCao@users.noreply.github.com> Date: Mon, 1 Jul 2024 15:09:38 +0800 Subject: [PATCH 263/343] MongoCluster, fix lro template PUT with 202 (#29642) * fix lro template * format --- .../DocumentDB.MongoCluster.Management/FirewallRule.tsp | 5 +++-- .../PrivateEndpointConnection.tsp | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp index 3ccc13b563ad..924d19397e63 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp @@ -42,10 +42,11 @@ interface FirewallRules { @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrReplaceAsync< FirewallRule, - Response = ArmAcceptedLroResponse<"Resource operation accepted."> | ArmResourceUpdatedResponse | ArmResourceCreatedResponse< + Response = ArmResourceUpdatedResponse | ArmResourceCreatedResponse< FirewallRule, LroHeaders = {} - > + > | ArmAcceptedLroResponse & + Azure.Core.Foundations.RetryAfterHeader> >; /** Deletes a mongo cluster firewall rule. */ delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp index e7656b6c355c..68df9614f342 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp @@ -22,7 +22,8 @@ interface PrivateEndpointConnections { @Azure.Core.useFinalStateVia("azure-async-operation") create is ArmResourceCreateOrReplaceAsync< PrivateEndpointConnectionResource, - Response = ArmAcceptedLroResponse<"Resource operation accepted."> | ArmResourceUpdatedResponse | ArmResourceCreatedResponse< + Response = ArmAcceptedLroResponse & + Azure.Core.Foundations.RetryAfterHeader> | ArmResourceUpdatedResponse | ArmResourceCreatedResponse< PrivateEndpointConnectionResource, LroHeaders = {} > From be978e57137bfd799e350575c0fdd53511f0e4a8 Mon Sep 17 00:00:00 2001 From: TalFrankel <73380649+TalFrankel@users.noreply.github.com> Date: Mon, 1 Jul 2024 22:47:55 +0300 Subject: [PATCH 264/343] Remove flatten attribute to fix conflict for CLI generation tool (#29276) * Remove flatten attribute to fix conflict for CLI generation tool * Create sdk-suppressions.yaml --- .../defenderForStorageSettings.json | 4 ---- .../security/resource-manager/sdk-suppressions.yaml | 12 ++++++++++++ 2 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 specification/security/resource-manager/sdk-suppressions.yaml diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json b/specification/security/resource-manager/Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json index c10845476167..bb0268c2c42f 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json @@ -130,7 +130,6 @@ ], "properties": { "properties": { - "x-ms-client-flatten": true, "$ref": "#/definitions/DefenderForStorageSettingProperties" } }, @@ -144,11 +143,9 @@ "description": "Indicates whether Defender for Storage is enabled on this storage account." }, "malwareScanning": { - "x-ms-client-flatten": true, "$ref": "#/definitions/MalwareScanningProperties" }, "sensitiveDataDiscovery": { - "x-ms-client-flatten": true, "$ref": "#/definitions/SensitiveDataDiscoveryProperties" }, "overrideSubscriptionLevelSettings": { @@ -162,7 +159,6 @@ "type": "object", "properties": { "onUpload": { - "x-ms-client-flatten": true, "$ref": "#/definitions/OnUploadProperties" }, "scanResultsEventGridTopicResourceId": { diff --git a/specification/security/resource-manager/sdk-suppressions.yaml b/specification/security/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..896fc8cc0bf4 --- /dev/null +++ b/specification/security/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,12 @@ +suppressions: + azure-sdk-for-python: + - package: azure-mgmt-security + breaking-changes: + - Model DefenderForStorageSetting no longer has parameter cap_gb_per_month + - Model DefenderForStorageSetting no longer has parameter is_enabled_properties_is_enabled + - Model DefenderForStorageSetting no longer has parameter is_enabled_properties_malware_scanning_on_upload_is_enabled + - Model DefenderForStorageSetting no longer has parameter is_enabled_properties_sensitive_data_discovery_is_enabled + - Model DefenderForStorageSetting no longer has parameter operation_status_properties_malware_scanning_operation_status + - Model DefenderForStorageSetting no longer has parameter operation_status_properties_sensitive_data_discovery_operation_status + - Model DefenderForStorageSetting no longer has parameter override_subscription_level_settings + - Model DefenderForStorageSetting no longer has parameter scan_results_event_grid_topic_resource_id From 5700885250d8f685a17293e930d98d1c1d72f401 Mon Sep 17 00:00:00 2001 From: Wei Wei Date: Mon, 1 Jul 2024 21:37:12 +0000 Subject: [PATCH 265/343] update code owner for storage/resource-manager (#29645) --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index ac4c89231ee0..a151fec4444e 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -230,7 +230,7 @@ /specification/sql/ @jamestao @ericshape @jeremyfrosti # PRLabel: %Storage -/specification/storage/ @jasonyang-msft +/specification/storage/resource-manager/ @blueww @yifanz7 /specification/storage/data-plane/ @seanmcc-msft @Azure/api-stewardship-board # PRLabel: %Import Export From 87a08b955c257c773a3bd42553c718d4b1092955 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Mon, 1 Jul 2024 18:25:03 -0700 Subject: [PATCH 266/343] [TypeSpecRequirement] Add tests (#29639) --- .../workflows/typespec-requirement-test.yaml | 23 + eng/scripts/Logging-Functions.ps1 | 8 +- eng/scripts/TypeSpec-Requirement.ps1 | 25 +- eng/tools/package.json | 1 + eng/tools/typespec-requirement/package.json | 21 + .../test/specification/empty/placeholder.txt | 1 + .../2024-01-01-preview/hand-written.json | 2 + .../2024-01-01-preview/no-tspconfig.json | 9 + .../2024-01-01-preview/parse-error.json | 1 + .../2024-01-01-preview/suppression.json | 2 + .../suppression/suppressions.yaml | 3 + .../tspconfig.yaml | 1 + .../preview/2024-01-01-preview/valid.json | 9 + .../test/typespec-requirement.test.ts | 83 ++ eng/tools/typespec-requirement/tsconfig.json | 6 + eng/tools/typespec-requirement/vite.config.ts | 8 + package-lock.json | 946 +++++++++++------- 17 files changed, 754 insertions(+), 395 deletions(-) create mode 100644 .github/workflows/typespec-requirement-test.yaml create mode 100644 eng/tools/typespec-requirement/package.json create mode 100644 eng/tools/typespec-requirement/test/specification/empty/placeholder.txt create mode 100644 eng/tools/typespec-requirement/test/specification/hand-written/resource-manager/Microsoft.HandWritten/preview/2024-01-01-preview/hand-written.json create mode 100644 eng/tools/typespec-requirement/test/specification/no-tspconfig/resource-manager/Microsoft.NoTspConfig/preview/2024-01-01-preview/no-tspconfig.json create mode 100644 eng/tools/typespec-requirement/test/specification/parse-error/resource-manager/Microsoft.ParseError/preview/2024-01-01-preview/parse-error.json create mode 100644 eng/tools/typespec-requirement/test/specification/suppression/resource-manager/Microsoft.Suppression/preview/2024-01-01-preview/suppression.json create mode 100644 eng/tools/typespec-requirement/test/specification/suppression/suppressions.yaml create mode 100644 eng/tools/typespec-requirement/test/specification/typespec-generated/Microsoft.TypeSpecGenerated.Management/tspconfig.yaml create mode 100644 eng/tools/typespec-requirement/test/specification/typespec-generated/resource-manager/Microsoft.TypeSpecGenerated/preview/2024-01-01-preview/valid.json create mode 100644 eng/tools/typespec-requirement/test/typespec-requirement.test.ts create mode 100644 eng/tools/typespec-requirement/tsconfig.json create mode 100644 eng/tools/typespec-requirement/vite.config.ts diff --git a/.github/workflows/typespec-requirement-test.yaml b/.github/workflows/typespec-requirement-test.yaml new file mode 100644 index 000000000000..e90bc29c34b2 --- /dev/null +++ b/.github/workflows/typespec-requirement-test.yaml @@ -0,0 +1,23 @@ +name: TypeSpec Requirement - Test + +on: + push: + branches: + - main + pull_request: + paths: + - package-lock.json + - package.json + - tsconfig.json + - .github/workflows/_reusable-eng-tools-test.yaml + - .github/workflows/typespec-requirement-test.yaml + - eng/scripts/** + - eng/tools/package.json + - eng/tools/tsconfig.json + - eng/tools/typespec-requirement/** + +jobs: + typespec-requirement: + uses: ./.github/workflows/_reusable-eng-tools-test.yaml + with: + package: typespec-requirement diff --git a/eng/scripts/Logging-Functions.ps1 b/eng/scripts/Logging-Functions.ps1 index 77ce43f7ef07..2f4522ac2342 100644 --- a/eng/scripts/Logging-Functions.ps1 +++ b/eng/scripts/Logging-Functions.ps1 @@ -15,7 +15,7 @@ function LogWarning { Write-Host ("##vso[task.LogIssue type=warning;]$args" -replace "`n", "%0D%0A") } elseif (Test-SupportsGitHubLogging) { - Write-Host ("::warning::$args" -replace "`n", "%0D%0A") + Write-Warning ("::warning::$args" -replace "`n", "%0D%0A") } else { Write-Warning "$args" @@ -28,7 +28,7 @@ function LogErrorForFile($file, $errorString) Write-Host ("##vso[task.logissue type=error;sourcepath=$file;linenumber=1;columnnumber=1;]$errorString" -replace "`n", "%0D%0A") } elseif (Test-SupportsGitHubLogging) { - Write-Host ("::error file=$file,line=1,col=1::$errorString" -replace "`n", "%0D%0A") + Write-Error ("::error file=$file,line=1,col=1::$errorString" -replace "`n", "%0D%0A") } else { Write-Error "[Error in file $file]$errorString" @@ -39,7 +39,7 @@ function LogError { Write-Host ("##vso[task.LogIssue type=error;]$args" -replace "`n", "%0D%0A") } elseif (Test-SupportsGitHubLogging) { - Write-Host ("::error::$args" -replace "`n", "%0D%0A") + Write-Error ("::error::$args" -replace "`n", "%0D%0A") } else { Write-Error "$args" @@ -51,7 +51,7 @@ function LogDebug { Write-Host "[debug]$args" } elseif (Test-SupportsGitHubLogging) { - Write-Host "::debug::$args" + Write-Debug "::debug::$args" } else { Write-Debug "$args" diff --git a/eng/scripts/TypeSpec-Requirement.ps1 b/eng/scripts/TypeSpec-Requirement.ps1 index 887ce0965485..b6c38af4a4d1 100644 --- a/eng/scripts/TypeSpec-Requirement.ps1 +++ b/eng/scripts/TypeSpec-Requirement.ps1 @@ -6,7 +6,11 @@ param ( [string] $TargetCommitish = "HEAD", [Parameter(Position = 2)] [string] $SpecType = "data-plane|resource-manager", - [string] $CheckAllUnder + [string] $CheckAllUnder, + # Reserved for testing. Call using: + # $ pwsh -Command '... -_ResponseCache @{"url"=200}' + [Parameter(DontShow)] + [hashtable] $_ResponseCache = @{} ) Set-StrictMode -Version 3 @@ -59,7 +63,7 @@ $repoPath = Resolve-Path "$PSScriptRoot/../.." $pathsWithErrors = @() $filesToCheck = $CheckAllUnder ? - (Get-ChildItem -Path $CheckAllUnder -Recurse -File | Resolve-Path -Relative | ForEach-Object { $_ -replace '\\', '/' }) : + (Get-ChildItem -Path $CheckAllUnder -Recurse -File | Resolve-Path -Relative -RelativeBasePath $repoPath | ForEach-Object { $_ -replace '\\', '/' }) : (Get-ChangedSwaggerFiles (Get-ChangedFiles $BaseCommitish $TargetCommitish)) $filesToCheck = $filesToCheck.Where({ @@ -72,7 +76,7 @@ if (!$filesToCheck) { } else { # Cache responses to GitHub web requests, for efficiency and to prevent rate limiting - $responseCache = @{} + $responseCache = $_ResponseCache # - Forward slashes on both Linux and Windows # - May be nested 4 or 5 levels deep, perhaps even deeper @@ -107,16 +111,15 @@ else { if ($null -ne ${jsonContent}?["info"]?["x-typespec-generated"]) { LogInfo " OpenAPI was generated from TypeSpec (contains '/info/x-typespec-generated')" - if ($file -match "specification/(?[^/]+)/") { - $rpFolder = $Matches["rpFolder"]; - $tspConfigs = @(Get-ChildItem -Path (Join-Path $repoPath "specification" $rpFolder) -Recurse -File - | Where-Object { $_.Name -eq "tspconfig.yaml" }) + if ($file -match "^.*specification/[^/]+/") { + $rpFolder = $Matches[0]; + $tspConfigs = @(Get-ChildItem -Path $rpFolder -Recurse -File | Where-Object { $_.Name -eq "tspconfig.yaml" }) if ($tspConfigs) { - LogInfo " Folder 'specification/$rpFolder' contains $($tspConfigs.Count) file(s) named 'tspconfig.yaml'" + LogInfo " Folder '$rpFolder' contains $($tspConfigs.Count) file(s) named 'tspconfig.yaml'" } else { - LogError ("OpenAPI was generated from TypeSpec, but folder 'specification/$rpFolder' contains no files named 'tspconfig.yaml'." ` + LogError ("OpenAPI was generated from TypeSpec, but folder '$rpFolder' contains no files named 'tspconfig.yaml'." ` + " The TypeSpec used to generate OpenAPI must be added to this folder.") LogJobFailure exit 1 @@ -176,12 +179,12 @@ else { if ($responseStatus -eq 200) { LogInfo " Branch 'main' contains path '$servicePath/stable', so spec already exists and is not required to use TypeSpec" } - elseif ($response.StatusCode -eq 404) { + elseif ($responseStatus -eq 404) { LogInfo " Branch 'main' does not contain path '$servicePath/stable', so spec is new and must use TypeSpec" $pathsWithErrors += $file } else { - LogError "Unexpected response from ${logUrlToStableFolder}: ${response.StatusCode}" + LogError "Unexpected response from ${logUrlToStableFolder}: ${responseStatus}" LogJobFailure exit 1 } diff --git a/eng/tools/package.json b/eng/tools/package.json index fc6133b9cce7..1c69ffb902f1 100644 --- a/eng/tools/package.json +++ b/eng/tools/package.json @@ -2,6 +2,7 @@ "name": "azure-rest-api-specs-eng-tools", "devDependencies": { "@azure-tools/suppressions": "file:suppressions", + "@azure-tools/typespec-requirement": "file:typespec-requirement", "@azure-tools/typespec-validation": "file:typespec-validation" }, "private": true diff --git a/eng/tools/typespec-requirement/package.json b/eng/tools/typespec-requirement/package.json new file mode 100644 index 000000000000..e82d0d39da50 --- /dev/null +++ b/eng/tools/typespec-requirement/package.json @@ -0,0 +1,21 @@ +{ + "name": "@azure-tools/typespec-requirement", + "private": true, + "type": "module", + "devDependencies": { + "@types/node": "^18.19.31", + "@vitest/coverage-v8": "^1.6.0", + "execa": "^9.3.0", + "typescript": "~5.4.5", + "vitest": "^1.6.0" + }, + "scripts": { + "build": "tsc", + "postinstall": "npm run build", + "test": "vitest", + "test:ci": "vitest run --coverage --reporter=verbose" + }, + "engines": { + "node": ">= 18.0.0" + } +} diff --git a/eng/tools/typespec-requirement/test/specification/empty/placeholder.txt b/eng/tools/typespec-requirement/test/specification/empty/placeholder.txt new file mode 100644 index 000000000000..8318c86b357b --- /dev/null +++ b/eng/tools/typespec-requirement/test/specification/empty/placeholder.txt @@ -0,0 +1 @@ +Test \ No newline at end of file diff --git a/eng/tools/typespec-requirement/test/specification/hand-written/resource-manager/Microsoft.HandWritten/preview/2024-01-01-preview/hand-written.json b/eng/tools/typespec-requirement/test/specification/hand-written/resource-manager/Microsoft.HandWritten/preview/2024-01-01-preview/hand-written.json new file mode 100644 index 000000000000..2c63c0851048 --- /dev/null +++ b/eng/tools/typespec-requirement/test/specification/hand-written/resource-manager/Microsoft.HandWritten/preview/2024-01-01-preview/hand-written.json @@ -0,0 +1,2 @@ +{ +} diff --git a/eng/tools/typespec-requirement/test/specification/no-tspconfig/resource-manager/Microsoft.NoTspConfig/preview/2024-01-01-preview/no-tspconfig.json b/eng/tools/typespec-requirement/test/specification/no-tspconfig/resource-manager/Microsoft.NoTspConfig/preview/2024-01-01-preview/no-tspconfig.json new file mode 100644 index 000000000000..16669a7232ea --- /dev/null +++ b/eng/tools/typespec-requirement/test/specification/no-tspconfig/resource-manager/Microsoft.NoTspConfig/preview/2024-01-01-preview/no-tspconfig.json @@ -0,0 +1,9 @@ +{ + "info": { + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + } +} diff --git a/eng/tools/typespec-requirement/test/specification/parse-error/resource-manager/Microsoft.ParseError/preview/2024-01-01-preview/parse-error.json b/eng/tools/typespec-requirement/test/specification/parse-error/resource-manager/Microsoft.ParseError/preview/2024-01-01-preview/parse-error.json new file mode 100644 index 000000000000..98232c64fce9 --- /dev/null +++ b/eng/tools/typespec-requirement/test/specification/parse-error/resource-manager/Microsoft.ParseError/preview/2024-01-01-preview/parse-error.json @@ -0,0 +1 @@ +{ diff --git a/eng/tools/typespec-requirement/test/specification/suppression/resource-manager/Microsoft.Suppression/preview/2024-01-01-preview/suppression.json b/eng/tools/typespec-requirement/test/specification/suppression/resource-manager/Microsoft.Suppression/preview/2024-01-01-preview/suppression.json new file mode 100644 index 000000000000..2c63c0851048 --- /dev/null +++ b/eng/tools/typespec-requirement/test/specification/suppression/resource-manager/Microsoft.Suppression/preview/2024-01-01-preview/suppression.json @@ -0,0 +1,2 @@ +{ +} diff --git a/eng/tools/typespec-requirement/test/specification/suppression/suppressions.yaml b/eng/tools/typespec-requirement/test/specification/suppression/suppressions.yaml new file mode 100644 index 000000000000..13ba9f2a355f --- /dev/null +++ b/eng/tools/typespec-requirement/test/specification/suppression/suppressions.yaml @@ -0,0 +1,3 @@ +- tool: TypeSpecRequirement + path: ./resource-manager/Microsoft.Suppression/preview/2024-01-01-preview/*.json + reason: Test diff --git a/eng/tools/typespec-requirement/test/specification/typespec-generated/Microsoft.TypeSpecGenerated.Management/tspconfig.yaml b/eng/tools/typespec-requirement/test/specification/typespec-generated/Microsoft.TypeSpecGenerated.Management/tspconfig.yaml new file mode 100644 index 000000000000..8ae056963b8b --- /dev/null +++ b/eng/tools/typespec-requirement/test/specification/typespec-generated/Microsoft.TypeSpecGenerated.Management/tspconfig.yaml @@ -0,0 +1 @@ +# Test diff --git a/eng/tools/typespec-requirement/test/specification/typespec-generated/resource-manager/Microsoft.TypeSpecGenerated/preview/2024-01-01-preview/valid.json b/eng/tools/typespec-requirement/test/specification/typespec-generated/resource-manager/Microsoft.TypeSpecGenerated/preview/2024-01-01-preview/valid.json new file mode 100644 index 000000000000..16669a7232ea --- /dev/null +++ b/eng/tools/typespec-requirement/test/specification/typespec-generated/resource-manager/Microsoft.TypeSpecGenerated/preview/2024-01-01-preview/valid.json @@ -0,0 +1,9 @@ +{ + "info": { + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + } +} diff --git a/eng/tools/typespec-requirement/test/typespec-requirement.test.ts b/eng/tools/typespec-requirement/test/typespec-requirement.test.ts new file mode 100644 index 000000000000..5e8daa9712b4 --- /dev/null +++ b/eng/tools/typespec-requirement/test/typespec-requirement.test.ts @@ -0,0 +1,83 @@ +import { execa } from 'execa'; +import { join } from 'path'; +import { test } from 'vitest'; + +async function checkAllUnder(path: string, responseCache?: string) { + const repoRoot = join(__dirname, '..', '..', '..', '..'); + const script = join('eng', 'scripts', 'TypeSpec-Requirement.ps1'); + + let command = `${script} -CheckAllUnder ${join(__dirname, path)}`; + if (responseCache) { + command += ` -_ResponseCache ${responseCache}`; + } + + return await execa("pwsh", ["-Command", command], { cwd: repoRoot, reject: false }); +} + +test.concurrent("No files to check", async ({ expect }) => { + const { stdout, exitCode } = await checkAllUnder("specification/empty"); + + expect(stdout).toMatchInlineSnapshot(`"No OpenAPI files found to check"`); + expect(exitCode).toBe(0); +}); + +test.concurrent("Suppression", async ({ expect }) => { + const { stdout, exitCode } = await checkAllUnder("specification/suppression"); + + expect(stdout).toContain("Suppressed"); + expect(exitCode).toBe(0); +}); + +test.concurrent("Parse error", async ({ expect }) => { + const { stdout, exitCode } = await checkAllUnder("specification/parse-error"); + + expect(stdout).toContain("cannot be parsed as JSON"); + expect(exitCode).toBe(1); +}); + +test.concurrent("No tspconfig.yaml", async ({ expect }) => { + const { stderr, exitCode } = await checkAllUnder("specification/no-tspconfig"); + + expect(stderr).toContain("no files named 'tspconfig.yaml'"); + expect(exitCode).toBe(1); +}); + +test.concurrent("Generated from TypeSpec", async ({ expect }) => { + const { stdout, exitCode } = await checkAllUnder("specification/typespec-generated"); + + expect(stdout).toContain("was generated from TypeSpec"); + expect(exitCode).toBe(0); +}); + +test.concurrent("Hand-written, exists in main", async ({ expect }) => { + const { stdout, exitCode } = await checkAllUnder( + "specification/hand-written", + '@{"https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hand-written/resource-manager/Microsoft.HandWritten/stable"=200}' + ); + + expect(stdout).toContain("was not generated from TypeSpec"); + expect(stdout).toContain("'main' contains path"); + expect(exitCode).toBe(0); +}); + +test.concurrent("Hand-written, does not exist in main", async ({ expect }) => { + const { stdout, exitCode } = await checkAllUnder( + "specification/hand-written", + '@{"https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hand-written/resource-manager/Microsoft.HandWritten/stable"=404}' + ); + + expect(stdout).toContain("was not generated from TypeSpec"); + expect(stdout).toContain("'main' does not contain path"); + expect(exitCode).toBe(1); +}); + +test.concurrent("Hand-written, unexpected response checking main", async ({ expect }) => { + const { stdout, stderr, exitCode } = await checkAllUnder( + "specification/hand-written", + '@{"https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hand-written/resource-manager/Microsoft.HandWritten/stable"=519}' + ); + + expect(stdout).toContain("was not generated from TypeSpec"); + expect(stderr).toContain("Unexpected response"); + expect(exitCode).toBe(1); +}); diff --git a/eng/tools/typespec-requirement/tsconfig.json b/eng/tools/typespec-requirement/tsconfig.json new file mode 100644 index 000000000000..ec6d6640928a --- /dev/null +++ b/eng/tools/typespec-requirement/tsconfig.json @@ -0,0 +1,6 @@ +{ + "extends": "../tsconfig.json", + "compilerOptions": { + "outDir": "./dist", + } +} diff --git a/eng/tools/typespec-requirement/vite.config.ts b/eng/tools/typespec-requirement/vite.config.ts new file mode 100644 index 000000000000..8b6908dc0a16 --- /dev/null +++ b/eng/tools/typespec-requirement/vite.config.ts @@ -0,0 +1,8 @@ +import { defineConfig } from 'vite' + +export default defineConfig({ + test: { + // Default timeout of 5 seconds is too low + testTimeout: 20000 + } +}) diff --git a/package-lock.json b/package-lock.json index cf58c9a3a61b..2ef4d7683924 100644 --- a/package-lock.json +++ b/package-lock.json @@ -31,13 +31,14 @@ "dev": true, "devDependencies": { "@azure-tools/suppressions": "file:suppressions", + "@azure-tools/typespec-requirement": "file:typespec-requirement", "@azure-tools/typespec-validation": "file:typespec-validation" } }, "eng/tools/node_modules/@types/node": { - "version": "18.19.33", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.33.tgz", - "integrity": "sha512-NR9+KrpSajr2qBVp/Yt5TU/rp+b5Mayi3+OlMlcg2cVCfRmcG5PWZ7S4+MG9PZ5gWBoc9Pd0BKSRViuBCRPu0A==", + "version": "18.19.39", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.39.tgz", + "integrity": "sha512-nPwTRDKUctxw3di5b4TfT3I0sWDiWoPQCZjXhvdkINntwr8lcoVCKsTgnXeRubKIlfnV+eN/HYk6Jb40tbcEAQ==", "dev": true, "dependencies": { "undici-types": "~5.26.4" @@ -79,10 +80,43 @@ "balanced-match": "^1.0.0" } }, + "eng/tools/node_modules/get-stream": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-8.0.1.tgz", + "integrity": "sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA==", + "dev": true, + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "eng/tools/node_modules/human-signals": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz", + "integrity": "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==", + "dev": true, + "engines": { + "node": ">=16.17.0" + } + }, + "eng/tools/node_modules/is-stream": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz", + "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==", + "dev": true, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "eng/tools/node_modules/minimatch": { - "version": "9.0.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.4.tgz", - "integrity": "sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw==", + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", "dev": true, "dependencies": { "brace-expansion": "^2.0.1" @@ -94,13 +128,25 @@ "url": "https://github.com/sponsors/isaacs" } }, + "eng/tools/node_modules/strip-final-newline": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz", + "integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "eng/tools/node_modules/vite": { - "version": "5.2.11", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.2.11.tgz", - "integrity": "sha512-HndV31LWW05i1BLPMUCE1B9E9GFbOu1MbenhS58FuK6owSO5qHm7GiCotrNY1YE5rMeQSFBGmT5ZaLEjFizgiQ==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.3.2.tgz", + "integrity": "sha512-6lA7OBHBlXUxiJxbO5aAY2fsHHzDr1q7DvXYnyZycRs2Dz+dXBWuhpWHvmljTRTpQC2uvGmUFFkSHF2vGo90MA==", "dev": true, "dependencies": { - "esbuild": "^0.20.1", + "esbuild": "^0.21.3", "postcss": "^8.4.38", "rollup": "^4.13.0" }, @@ -214,6 +260,29 @@ } } }, + "eng/tools/node_modules/vitest/node_modules/execa": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-8.0.1.tgz", + "integrity": "sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg==", + "dev": true, + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^8.0.1", + "human-signals": "^5.0.0", + "is-stream": "^3.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^5.1.0", + "onetime": "^6.0.0", + "signal-exit": "^4.1.0", + "strip-final-newline": "^3.0.0" + }, + "engines": { + "node": ">=16.17" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, "eng/tools/suppressions": { "name": "@azure-tools/suppressions", "dev": true, @@ -237,6 +306,21 @@ "node": ">= 18.0.0" } }, + "eng/tools/typespec-requirement": { + "name": "@azure-tools/typespec-requirement", + "dev": true, + "hasInstallScript": true, + "devDependencies": { + "@types/node": "^18.19.31", + "@vitest/coverage-v8": "^1.6.0", + "execa": "^9.3.0", + "typescript": "~5.4.5", + "vitest": "^1.6.0" + }, + "engines": { + "node": ">= 18.0.0" + } + }, "eng/tools/typespec-validation": { "name": "@azure-tools/typespec-validation", "dev": true, @@ -517,6 +601,10 @@ "@typespec/versioning": "~0.57.0" } }, + "node_modules/@azure-tools/typespec-requirement": { + "resolved": "eng/tools/typespec-requirement", + "link": true + }, "node_modules/@azure-tools/typespec-validation": { "resolved": "eng/tools/typespec-validation", "link": true @@ -646,13 +734,13 @@ } }, "node_modules/@azure/core-util": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.9.0.tgz", - "integrity": "sha512-AfalUQ1ZppaKuxPPMsFEUdX6GZPB3d9paR9d/TTL7Ow2De8cJaC7ibi7kWVlFAVPCYo31OcnGymc0R89DX8Oaw==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.7.0.tgz", + "integrity": "sha512-Zq2i3QO6k9DA8vnm29mYM4G8IE9u1mhF1GUabVEqPNX8Lj833gdxQ2NAFxt2BZsfAL+e9cT8SyVN7dFVJ/Hf0g==", "dev": true, "dependencies": { "@azure/abort-controller": "^2.0.0", - "tslib": "^2.6.2" + "tslib": "^2.2.0" }, "engines": { "node": ">=18.0.0" @@ -671,15 +759,15 @@ } }, "node_modules/@azure/logger": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.1.2.tgz", - "integrity": "sha512-l170uE7bsKpIU6B/giRc9i4NI0Mj+tANMMMxf7Zi/5cKzEqPayP7+X1WPrG7e+91JgY8N+7K7nF2WOi7iVhXvg==", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.0.4.tgz", + "integrity": "sha512-ustrPY8MryhloQj7OWGe+HrYx+aoiOxzbXTtgblbV3xwCqpzUK36phH3XNHQKj3EPonyFUuDTfR3qFhTEAuZEg==", "dev": true, "dependencies": { - "tslib": "^2.6.2" + "tslib": "^2.2.0" }, "engines": { - "node": ">=18.0.0" + "node": ">=14.0.0" } }, "node_modules/@azure/ms-rest-js": { @@ -796,12 +884,12 @@ "dev": true }, "node_modules/@babel/code-frame": { - "version": "7.24.2", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.2.tgz", - "integrity": "sha512-y5+tLQyV8pg3fsiln67BVLD1P13Eg4lh5RW9mF0zUuvLrv9uIQ4MCL+CRT+FTsBlBjcIan6PGsLcBN0m3ClUyQ==", + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.7.tgz", + "integrity": "sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==", "dev": true, "dependencies": { - "@babel/highlight": "^7.24.2", + "@babel/highlight": "^7.24.7", "picocolors": "^1.0.0" }, "engines": { @@ -809,30 +897,30 @@ } }, "node_modules/@babel/helper-string-parser": { - "version": "7.24.1", - "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.24.1.tgz", - "integrity": "sha512-2ofRCjnnA9y+wk8b9IAREroeUP02KHp431N2mhKniy2yKIDKpbrHv9eXwm8cBeWQYcJmzv5qKCu65P47eCF7CQ==", + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.24.7.tgz", + "integrity": "sha512-7MbVt6xrwFQbunH2DNQsAP5sTGxfqQtErvBIvIMi6EQnbgUOuVYanvREcmFrOPhoXBrTtjhhP+lW+o5UfK+tDg==", "dev": true, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-validator-identifier": { - "version": "7.24.5", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.5.tgz", - "integrity": "sha512-3q93SSKX2TWCG30M2G2kwaKeTYgEUp5Snjuj8qm729SObL6nbtUldAi37qbxkD5gg3xnBio+f9nqpSepGZMvxA==", + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz", + "integrity": "sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==", "dev": true, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/highlight": { - "version": "7.24.5", - "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.5.tgz", - "integrity": "sha512-8lLmua6AVh/8SLJRRVD6V8p73Hir9w5mJrhE+IPpILG31KKlI9iz5zmBYKcWPS59qSfgP9RaSBQSHHE81WKuEw==", + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.7.tgz", + "integrity": "sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw==", "dev": true, "dependencies": { - "@babel/helper-validator-identifier": "^7.24.5", + "@babel/helper-validator-identifier": "^7.24.7", "chalk": "^2.4.2", "js-tokens": "^4.0.0", "picocolors": "^1.0.0" @@ -842,9 +930,9 @@ } }, "node_modules/@babel/parser": { - "version": "7.24.5", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.24.5.tgz", - "integrity": "sha512-EOv5IK8arwh3LI47dz1b0tKUb/1uhHAnHJOrjgtQMIpu1uXd9mlFrJg9IUgGUgZ41Ch0K8REPTYpO7B76b4vJg==", + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.24.7.tgz", + "integrity": "sha512-9uUYRm6OqQrCqQdG1iCBwBPZgN8ciDBro2nIOFaiRz1/BCxaI7CNvQbDHvsArAC7Tw9Hda/B3U+6ui9u4HWXPw==", "dev": true, "bin": { "parser": "bin/babel-parser.js" @@ -854,13 +942,13 @@ } }, "node_modules/@babel/types": { - "version": "7.24.5", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.24.5.tgz", - "integrity": "sha512-6mQNsaLeXTw0nxYUYu+NSa4Hx4BlF1x1x8/PMFbiR+GBSr+2DkECc69b8hgy2frEodNcvPffeH8YfWd3LI6jhQ==", + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.24.7.tgz", + "integrity": "sha512-XEFXSlxiG5td2EJRe8vOmRbaXVgfcBlszKujvVmWIK/UpywWljQCfzAv3RQCGujWQ1RD4YYWEAqDXfuJiy8f5Q==", "dev": true, "dependencies": { - "@babel/helper-string-parser": "^7.24.1", - "@babel/helper-validator-identifier": "^7.24.5", + "@babel/helper-string-parser": "^7.24.7", + "@babel/helper-validator-identifier": "^7.24.7", "to-fast-properties": "^2.0.0" }, "engines": { @@ -874,10 +962,11 @@ "dev": true }, "node_modules/@colors/colors": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz", - "integrity": "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA==", + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", + "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", "dev": true, + "optional": true, "engines": { "node": ">=0.1.90" } @@ -894,9 +983,9 @@ } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.20.2.tgz", - "integrity": "sha512-D+EBOJHXdNZcLJRBkhENNG8Wji2kgc9AZ9KiPr1JuZjsNtyHzrsfLRrY0tk2H2aoFu6RANO1y1iPPUCDYWkb5g==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz", + "integrity": "sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==", "cpu": [ "ppc64" ], @@ -910,9 +999,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.20.2.tgz", - "integrity": "sha512-t98Ra6pw2VaDhqNWO2Oph2LXbz/EJcnLmKLGBJwEwXX/JAN83Fym1rU8l0JUWK6HkIbWONCSSatf4sf2NBRx/w==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.21.5.tgz", + "integrity": "sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==", "cpu": [ "arm" ], @@ -926,9 +1015,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.20.2.tgz", - "integrity": "sha512-mRzjLacRtl/tWU0SvD8lUEwb61yP9cqQo6noDZP/O8VkwafSYwZ4yWy24kan8jE/IMERpYncRt2dw438LP3Xmg==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz", + "integrity": "sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==", "cpu": [ "arm64" ], @@ -942,9 +1031,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.20.2.tgz", - "integrity": "sha512-btzExgV+/lMGDDa194CcUQm53ncxzeBrWJcncOBxuC6ndBkKxnHdFJn86mCIgTELsooUmwUm9FkhSp5HYu00Rg==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.21.5.tgz", + "integrity": "sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==", "cpu": [ "x64" ], @@ -958,9 +1047,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.20.2.tgz", - "integrity": "sha512-4J6IRT+10J3aJH3l1yzEg9y3wkTDgDk7TSDFX+wKFiWjqWp/iCfLIYzGyasx9l0SAFPT1HwSCR+0w/h1ES/MjA==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz", + "integrity": "sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==", "cpu": [ "arm64" ], @@ -974,9 +1063,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.20.2.tgz", - "integrity": "sha512-tBcXp9KNphnNH0dfhv8KYkZhjc+H3XBkF5DKtswJblV7KlT9EI2+jeA8DgBjp908WEuYll6pF+UStUCfEpdysA==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz", + "integrity": "sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==", "cpu": [ "x64" ], @@ -990,9 +1079,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.20.2.tgz", - "integrity": "sha512-d3qI41G4SuLiCGCFGUrKsSeTXyWG6yem1KcGZVS+3FYlYhtNoNgYrWcvkOoaqMhwXSMrZRl69ArHsGJ9mYdbbw==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz", + "integrity": "sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==", "cpu": [ "arm64" ], @@ -1006,9 +1095,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.20.2.tgz", - "integrity": "sha512-d+DipyvHRuqEeM5zDivKV1KuXn9WeRX6vqSqIDgwIfPQtwMP4jaDsQsDncjTDDsExT4lR/91OLjRo8bmC1e+Cw==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz", + "integrity": "sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==", "cpu": [ "x64" ], @@ -1022,9 +1111,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.20.2.tgz", - "integrity": "sha512-VhLPeR8HTMPccbuWWcEUD1Az68TqaTYyj6nfE4QByZIQEQVWBB8vup8PpR7y1QHL3CpcF6xd5WVBU/+SBEvGTg==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz", + "integrity": "sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==", "cpu": [ "arm" ], @@ -1038,9 +1127,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.20.2.tgz", - "integrity": "sha512-9pb6rBjGvTFNira2FLIWqDk/uaf42sSyLE8j1rnUpuzsODBq7FvpwHYZxQ/It/8b+QOS1RYfqgGFNLRI+qlq2A==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz", + "integrity": "sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==", "cpu": [ "arm64" ], @@ -1054,9 +1143,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.20.2.tgz", - "integrity": "sha512-o10utieEkNPFDZFQm9CoP7Tvb33UutoJqg3qKf1PWVeeJhJw0Q347PxMvBgVVFgouYLGIhFYG0UGdBumROyiig==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz", + "integrity": "sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==", "cpu": [ "ia32" ], @@ -1070,9 +1159,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.20.2.tgz", - "integrity": "sha512-PR7sp6R/UC4CFVomVINKJ80pMFlfDfMQMYynX7t1tNTeivQ6XdX5r2XovMmha/VjR1YN/HgHWsVcTRIMkymrgQ==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz", + "integrity": "sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==", "cpu": [ "loong64" ], @@ -1086,9 +1175,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.20.2.tgz", - "integrity": "sha512-4BlTqeutE/KnOiTG5Y6Sb/Hw6hsBOZapOVF6njAESHInhlQAghVVZL1ZpIctBOoTFbQyGW+LsVYZ8lSSB3wkjA==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz", + "integrity": "sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==", "cpu": [ "mips64el" ], @@ -1102,9 +1191,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.20.2.tgz", - "integrity": "sha512-rD3KsaDprDcfajSKdn25ooz5J5/fWBylaaXkuotBDGnMnDP1Uv5DLAN/45qfnf3JDYyJv/ytGHQaziHUdyzaAg==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz", + "integrity": "sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==", "cpu": [ "ppc64" ], @@ -1118,9 +1207,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.20.2.tgz", - "integrity": "sha512-snwmBKacKmwTMmhLlz/3aH1Q9T8v45bKYGE3j26TsaOVtjIag4wLfWSiZykXzXuE1kbCE+zJRmwp+ZbIHinnVg==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz", + "integrity": "sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==", "cpu": [ "riscv64" ], @@ -1134,9 +1223,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.20.2.tgz", - "integrity": "sha512-wcWISOobRWNm3cezm5HOZcYz1sKoHLd8VL1dl309DiixxVFoFe/o8HnwuIwn6sXre88Nwj+VwZUvJf4AFxkyrQ==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz", + "integrity": "sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==", "cpu": [ "s390x" ], @@ -1150,9 +1239,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.20.2.tgz", - "integrity": "sha512-1MdwI6OOTsfQfek8sLwgyjOXAu+wKhLEoaOLTjbijk6E2WONYpH9ZU2mNtR+lZ2B4uwr+usqGuVfFT9tMtGvGw==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz", + "integrity": "sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==", "cpu": [ "x64" ], @@ -1166,9 +1255,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.20.2.tgz", - "integrity": "sha512-K8/DhBxcVQkzYc43yJXDSyjlFeHQJBiowJ0uVL6Tor3jGQfSGHNNJcWxNbOI8v5k82prYqzPuwkzHt3J1T1iZQ==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz", + "integrity": "sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==", "cpu": [ "x64" ], @@ -1182,9 +1271,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.20.2.tgz", - "integrity": "sha512-eMpKlV0SThJmmJgiVyN9jTPJ2VBPquf6Kt/nAoo6DgHAoN57K15ZghiHaMvqjCye/uU4X5u3YSMgVBI1h3vKrQ==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz", + "integrity": "sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==", "cpu": [ "x64" ], @@ -1198,9 +1287,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.20.2.tgz", - "integrity": "sha512-2UyFtRC6cXLyejf/YEld4Hajo7UHILetzE1vsRcGL3earZEW77JxrFjH4Ez2qaTiEfMgAXxfAZCm1fvM/G/o8w==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz", + "integrity": "sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==", "cpu": [ "x64" ], @@ -1214,9 +1303,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.20.2.tgz", - "integrity": "sha512-GRibxoawM9ZCnDxnP3usoUDO9vUkpAxIIZ6GQI+IlVmr5kP3zUq+l17xELTHMWTWzjxa2guPNyrpq1GWmPvcGQ==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz", + "integrity": "sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==", "cpu": [ "arm64" ], @@ -1230,9 +1319,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.20.2.tgz", - "integrity": "sha512-HfLOfn9YWmkSKRQqovpnITazdtquEW8/SoHW7pWpuEeguaZI4QnCRW6b+oZTztdBnZOS2hqJ6im/D5cPzBTTlQ==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz", + "integrity": "sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==", "cpu": [ "ia32" ], @@ -1246,9 +1335,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.20.2.tgz", - "integrity": "sha512-N49X4lJX27+l9jbLKSqZ6bKNjzQvHaT8IIFUy+YIqmXQdjYCToGWwOItDrfby14c78aDd5NHQl29xingXfCdLQ==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz", + "integrity": "sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==", "cpu": [ "x64" ], @@ -1393,9 +1482,9 @@ } }, "node_modules/@opentelemetry/api": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.8.0.tgz", - "integrity": "sha512-I/s6F7yKUDdtMsoBWXJe8Qz40Tui5vsuKCWJEWVL+5q9sSWRzzx6v2KeNsOBEwd94j0eWkpWCH4yB6rZg9Mf0w==", + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.9.0.tgz", + "integrity": "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg==", "dev": true, "engines": { "node": ">=8.0.0" @@ -1452,9 +1541,9 @@ } }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.17.2.tgz", - "integrity": "sha512-NM0jFxY8bB8QLkoKxIQeObCaDlJKewVlIEkuyYKm5An1tdVZ966w2+MPQ2l8LBZLjR+SgyV+nRkTIunzOYBMLQ==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.18.0.tgz", + "integrity": "sha512-Tya6xypR10giZV1XzxmH5wr25VcZSncG0pZIjfePT0OVBvqNEurzValetGNarVrGiq66EBVAFn15iYX4w6FKgQ==", "cpu": [ "arm" ], @@ -1465,9 +1554,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.17.2.tgz", - "integrity": "sha512-yeX/Usk7daNIVwkq2uGoq2BYJKZY1JfyLTaHO/jaiSwi/lsf8fTFoQW/n6IdAsx5tx+iotu2zCJwz8MxI6D/Bw==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.18.0.tgz", + "integrity": "sha512-avCea0RAP03lTsDhEyfy+hpfr85KfyTctMADqHVhLAF3MlIkq83CP8UfAHUssgXTYd+6er6PaAhx/QGv4L1EiA==", "cpu": [ "arm64" ], @@ -1478,9 +1567,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.17.2.tgz", - "integrity": "sha512-kcMLpE6uCwls023+kknm71ug7MZOrtXo+y5p/tsg6jltpDtgQY1Eq5sGfHcQfb+lfuKwhBmEURDga9N0ol4YPw==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.18.0.tgz", + "integrity": "sha512-IWfdwU7KDSm07Ty0PuA/W2JYoZ4iTj3TUQjkVsO/6U+4I1jN5lcR71ZEvRh52sDOERdnNhhHU57UITXz5jC1/w==", "cpu": [ "arm64" ], @@ -1491,9 +1580,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.17.2.tgz", - "integrity": "sha512-AtKwD0VEx0zWkL0ZjixEkp5tbNLzX+FCqGG1SvOu993HnSz4qDI6S4kGzubrEJAljpVkhRSlg5bzpV//E6ysTQ==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.18.0.tgz", + "integrity": "sha512-n2LMsUz7Ynu7DoQrSQkBf8iNrjOGyPLrdSg802vk6XT3FtsgX6JbE8IHRvposskFm9SNxzkLYGSq9QdpLYpRNA==", "cpu": [ "x64" ], @@ -1504,9 +1593,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.17.2.tgz", - "integrity": "sha512-3reX2fUHqN7sffBNqmEyMQVj/CKhIHZd4y631duy0hZqI8Qoqf6lTtmAKvJFYa6bhU95B1D0WgzHkmTg33In0A==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.18.0.tgz", + "integrity": "sha512-C/zbRYRXFjWvz9Z4haRxcTdnkPt1BtCkz+7RtBSuNmKzMzp3ZxdM28Mpccn6pt28/UWUCTXa+b0Mx1k3g6NOMA==", "cpu": [ "arm" ], @@ -1517,9 +1606,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.17.2.tgz", - "integrity": "sha512-uSqpsp91mheRgw96xtyAGP9FW5ChctTFEoXP0r5FAzj/3ZRv3Uxjtc7taRQSaQM/q85KEKjKsZuiZM3GyUivRg==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.18.0.tgz", + "integrity": "sha512-l3m9ewPgjQSXrUMHg93vt0hYCGnrMOcUpTz6FLtbwljo2HluS4zTXFy2571YQbisTnfTKPZ01u/ukJdQTLGh9A==", "cpu": [ "arm" ], @@ -1530,9 +1619,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.17.2.tgz", - "integrity": "sha512-EMMPHkiCRtE8Wdk3Qhtciq6BndLtstqZIroHiiGzB3C5LDJmIZcSzVtLRbwuXuUft1Cnv+9fxuDtDxz3k3EW2A==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.18.0.tgz", + "integrity": "sha512-rJ5D47d8WD7J+7STKdCUAgmQk49xuFrRi9pZkWoRD1UeSMakbcepWXPF8ycChBoAqs1pb2wzvbY6Q33WmN2ftw==", "cpu": [ "arm64" ], @@ -1543,9 +1632,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.17.2.tgz", - "integrity": "sha512-NMPylUUZ1i0z/xJUIx6VUhISZDRT+uTWpBcjdv0/zkp7b/bQDF+NfnfdzuTiB1G6HTodgoFa93hp0O1xl+/UbA==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.18.0.tgz", + "integrity": "sha512-be6Yx37b24ZwxQ+wOQXXLZqpq4jTckJhtGlWGZs68TgdKXJgw54lUUoFYrg6Zs/kjzAQwEwYbp8JxZVzZLRepQ==", "cpu": [ "arm64" ], @@ -1556,9 +1645,9 @@ ] }, "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.17.2.tgz", - "integrity": "sha512-T19My13y8uYXPw/L/k0JYaX1fJKFT/PWdXiHr8mTbXWxjVF1t+8Xl31DgBBvEKclw+1b00Chg0hxE2O7bTG7GQ==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.18.0.tgz", + "integrity": "sha512-hNVMQK+qrA9Todu9+wqrXOHxFiD5YmdEi3paj6vP02Kx1hjd2LLYR2eaN7DsEshg09+9uzWi2W18MJDlG0cxJA==", "cpu": [ "ppc64" ], @@ -1569,9 +1658,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.17.2.tgz", - "integrity": "sha512-BOaNfthf3X3fOWAB+IJ9kxTgPmMqPPH5f5k2DcCsRrBIbWnaJCgX2ll77dV1TdSy9SaXTR5iDXRL8n7AnoP5cg==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.18.0.tgz", + "integrity": "sha512-ROCM7i+m1NfdrsmvwSzoxp9HFtmKGHEqu5NNDiZWQtXLA8S5HBCkVvKAxJ8U+CVctHwV2Gb5VUaK7UAkzhDjlg==", "cpu": [ "riscv64" ], @@ -1582,9 +1671,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.17.2.tgz", - "integrity": "sha512-W0UP/x7bnn3xN2eYMql2T/+wpASLE5SjObXILTMPUBDB/Fg/FxC+gX4nvCfPBCbNhz51C+HcqQp2qQ4u25ok6g==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.18.0.tgz", + "integrity": "sha512-0UyyRHyDN42QL+NbqevXIIUnKA47A+45WyasO+y2bGJ1mhQrfrtXUpTxCOrfxCR4esV3/RLYyucGVPiUsO8xjg==", "cpu": [ "s390x" ], @@ -1595,9 +1684,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.17.2.tgz", - "integrity": "sha512-Hy7pLwByUOuyaFC6mAr7m+oMC+V7qyifzs/nW2OJfC8H4hbCzOX07Ov0VFk/zP3kBsELWNFi7rJtgbKYsav9QQ==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.18.0.tgz", + "integrity": "sha512-xuglR2rBVHA5UsI8h8UbX4VJ470PtGCf5Vpswh7p2ukaqBGFTnsfzxUBetoWBWymHMxbIG0Cmx7Y9qDZzr648w==", "cpu": [ "x64" ], @@ -1608,9 +1697,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.17.2.tgz", - "integrity": "sha512-h1+yTWeYbRdAyJ/jMiVw0l6fOOm/0D1vNLui9iPuqgRGnXA0u21gAqOyB5iHjlM9MMfNOm9RHCQ7zLIzT0x11Q==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.18.0.tgz", + "integrity": "sha512-LKaqQL9osY/ir2geuLVvRRs+utWUNilzdE90TpyoX0eNqPzWjRm14oMEE+YLve4k/NAqCdPkGYDaDF5Sw+xBfg==", "cpu": [ "x64" ], @@ -1621,9 +1710,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.17.2.tgz", - "integrity": "sha512-tmdtXMfKAjy5+IQsVtDiCfqbynAQE/TQRpWdVataHmhMb9DCoJxp9vLcCBjEQWMiUYxO1QprH/HbY9ragCEFLA==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.18.0.tgz", + "integrity": "sha512-7J6TkZQFGo9qBKH0pk2cEVSRhJbL6MtfWxth7Y5YmZs57Pi+4x6c2dStAUvaQkHQLnEQv1jzBUW43GvZW8OFqA==", "cpu": [ "arm64" ], @@ -1634,9 +1723,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.17.2.tgz", - "integrity": "sha512-7II/QCSTAHuE5vdZaQEwJq2ZACkBpQDOmQsE6D6XUbnBHW8IAhm4eTufL6msLJorzrHDFv3CF8oCA/hSIRuZeQ==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.18.0.tgz", + "integrity": "sha512-Txjh+IxBPbkUB9+SXZMpv+b/vnTEtFyfWZgJ6iyCmt2tdx0OF5WhFowLmnh8ENGNpfUlUZkdI//4IEmhwPieNg==", "cpu": [ "ia32" ], @@ -1647,9 +1736,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.17.2.tgz", - "integrity": "sha512-TGGO7v7qOq4CYmSBVEYpI1Y5xDuCEnbVC5Vth8mOsW0gDSzxNrVERPc790IGHsrT2dQSimgMr9Ub3Y1Jci5/8w==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.18.0.tgz", + "integrity": "sha512-UOo5FdvOL0+eIVTgS4tIdbW+TtnBLWg1YBCcU2KWM7nuNwRz9bksDX1bekJJCpu25N1DVWaCwnT39dVQxzqS8g==", "cpu": [ "x64" ], @@ -1659,6 +1748,12 @@ "win32" ] }, + "node_modules/@sec-ant/readable-stream": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@sec-ant/readable-stream/-/readable-stream-0.4.1.tgz", + "integrity": "sha512-831qok9r2t8AlxLko40y2ebgSDhenenCatLVeW/uBtnHPyhHOvG0C7TvfgecV+wHzIm5KUICgzmVpWS+IMEAeg==", + "dev": true + }, "node_modules/@sinclair/typebox": { "version": "0.27.8", "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", @@ -2254,9 +2349,9 @@ } }, "node_modules/acorn": { - "version": "8.11.3", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", - "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==", + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.0.tgz", + "integrity": "sha512-RTvkC4w+KNXrM39/lWCUaG0IbRkWdCv7W/IOW9oU6SawyxulvkQy5HQPVTKxEjczcUvapcrw3cFx/60VN/NRNw==", "dev": true, "bin": { "acorn": "bin/acorn" @@ -2266,10 +2361,13 @@ } }, "node_modules/acorn-walk": { - "version": "8.3.2", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.2.tgz", - "integrity": "sha512-cjkyv4OtNCIeqhHrfS81QWXoCBPExR/J62oyEqepVw8WaQeSqpW2uhuLPh1m9eWhDuOo/jUXVTlifvesOWp/4A==", + "version": "8.3.3", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.3.tgz", + "integrity": "sha512-MxXdReSRhGO7VlFe1bRG/oI7/mdLV9B9JJT0N8vZOhF7gFRR5l3M8W9G8JxmKV+JC5mGqJ0QvqfSOLsCPa4nUw==", "dev": true, + "dependencies": { + "acorn": "^8.11.0" + }, "engines": { "node": ">=0.4.0" } @@ -2581,16 +2679,6 @@ "@colors/colors": "1.5.0" } }, - "node_modules/cli-table3/node_modules/@colors/colors": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", - "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", - "dev": true, - "optional": true, - "engines": { - "node": ">=0.1.90" - } - }, "node_modules/cliui": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz", @@ -2764,9 +2852,9 @@ } }, "node_modules/debug": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", - "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", + "version": "4.3.5", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.5.tgz", + "integrity": "sha512-pt0bNEmneDIvdL1Xsd9oDQ/wrQRkXDT4AUWlNZNPKvW5x/jyO9VFXkJUP07vQ2upmw5PlaITaPKc31jK13V+jg==", "dev": true, "dependencies": { "ms": "2.1.2" @@ -2780,6 +2868,12 @@ } } }, + "node_modules/debug/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, "node_modules/decamelize": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", @@ -2790,9 +2884,9 @@ } }, "node_modules/deep-eql": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.3.tgz", - "integrity": "sha512-WaEtAOpRA1MQ0eohqZjpGD8zdI0Ovsm8mmFhaDN8dvDZzyoUMcYDnf5Y6iu7HTXxf8JDS23qWa4a+hKCDyOPzw==", + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.4.tgz", + "integrity": "sha512-SUwdGfqdKOwxCPeVYjwSyRpJ7Z+fhpwIAtmCUdZIWZ/YP5R9WAsyuSgpLVDi9bjWoN2LXHNss/dk3urXtdQxGg==", "dev": true, "dependencies": { "type-detect": "^4.0.0" @@ -2880,9 +2974,9 @@ "dev": true }, "node_modules/esbuild": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.20.2.tgz", - "integrity": "sha512-WdOOppmUNU+IbZ0PaDiTst80zjnrOkyJNHoKupIcVyU8Lvla3Ugx94VzkQ32Ijqd7UhHJy75gNWDMUekcrSJ6g==", + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.21.5.tgz", + "integrity": "sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==", "dev": true, "hasInstallScript": true, "bin": { @@ -2892,29 +2986,29 @@ "node": ">=12" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.20.2", - "@esbuild/android-arm": "0.20.2", - "@esbuild/android-arm64": "0.20.2", - "@esbuild/android-x64": "0.20.2", - "@esbuild/darwin-arm64": "0.20.2", - "@esbuild/darwin-x64": "0.20.2", - "@esbuild/freebsd-arm64": "0.20.2", - "@esbuild/freebsd-x64": "0.20.2", - "@esbuild/linux-arm": "0.20.2", - "@esbuild/linux-arm64": "0.20.2", - "@esbuild/linux-ia32": "0.20.2", - "@esbuild/linux-loong64": "0.20.2", - "@esbuild/linux-mips64el": "0.20.2", - "@esbuild/linux-ppc64": "0.20.2", - "@esbuild/linux-riscv64": "0.20.2", - "@esbuild/linux-s390x": "0.20.2", - "@esbuild/linux-x64": "0.20.2", - "@esbuild/netbsd-x64": "0.20.2", - "@esbuild/openbsd-x64": "0.20.2", - "@esbuild/sunos-x64": "0.20.2", - "@esbuild/win32-arm64": "0.20.2", - "@esbuild/win32-ia32": "0.20.2", - "@esbuild/win32-x64": "0.20.2" + "@esbuild/aix-ppc64": "0.21.5", + "@esbuild/android-arm": "0.21.5", + "@esbuild/android-arm64": "0.21.5", + "@esbuild/android-x64": "0.21.5", + "@esbuild/darwin-arm64": "0.21.5", + "@esbuild/darwin-x64": "0.21.5", + "@esbuild/freebsd-arm64": "0.21.5", + "@esbuild/freebsd-x64": "0.21.5", + "@esbuild/linux-arm": "0.21.5", + "@esbuild/linux-arm64": "0.21.5", + "@esbuild/linux-ia32": "0.21.5", + "@esbuild/linux-loong64": "0.21.5", + "@esbuild/linux-mips64el": "0.21.5", + "@esbuild/linux-ppc64": "0.21.5", + "@esbuild/linux-riscv64": "0.21.5", + "@esbuild/linux-s390x": "0.21.5", + "@esbuild/linux-x64": "0.21.5", + "@esbuild/netbsd-x64": "0.21.5", + "@esbuild/openbsd-x64": "0.21.5", + "@esbuild/sunos-x64": "0.21.5", + "@esbuild/win32-arm64": "0.21.5", + "@esbuild/win32-ia32": "0.21.5", + "@esbuild/win32-x64": "0.21.5" } }, "node_modules/escalade": { @@ -2967,28 +3061,82 @@ } }, "node_modules/execa": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/execa/-/execa-8.0.1.tgz", - "integrity": "sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg==", + "version": "9.3.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-9.3.0.tgz", + "integrity": "sha512-l6JFbqnHEadBoVAVpN5dl2yCyfX28WoBAGaoQcNmLLSedOxTxcn2Qa83s8I/PA5i56vWru2OHOtrwF7Om2vqlg==", "dev": true, "dependencies": { + "@sindresorhus/merge-streams": "^4.0.0", "cross-spawn": "^7.0.3", - "get-stream": "^8.0.1", - "human-signals": "^5.0.0", - "is-stream": "^3.0.0", - "merge-stream": "^2.0.0", - "npm-run-path": "^5.1.0", - "onetime": "^6.0.0", + "figures": "^6.1.0", + "get-stream": "^9.0.0", + "human-signals": "^7.0.0", + "is-plain-obj": "^4.1.0", + "is-stream": "^4.0.1", + "npm-run-path": "^5.2.0", + "pretty-ms": "^9.0.0", "signal-exit": "^4.1.0", - "strip-final-newline": "^3.0.0" + "strip-final-newline": "^4.0.0", + "yoctocolors": "^2.0.0" }, "engines": { - "node": ">=16.17" + "node": "^18.19.0 || >=20.5.0" }, "funding": { "url": "https://github.com/sindresorhus/execa?sponsor=1" } }, + "node_modules/execa/node_modules/@sindresorhus/merge-streams": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-4.0.0.tgz", + "integrity": "sha512-tlqY9xq5ukxTUZBmoOp+m61cqwQD5pHJtFY3Mn8CA8ps6yghLH/Hw8UPdqg4OLmFW3IFlcXnQNmo/dh8HzXYIQ==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/execa/node_modules/is-stream": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-4.0.1.tgz", + "integrity": "sha512-Dnz92NInDqYckGEUJv689RbRiTSEHCQ7wOVeALbkOz999YpqT46yMRIGtSNl2iCL1waAZSx40+h59NV/EwzV/A==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/execa/node_modules/parse-ms": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/parse-ms/-/parse-ms-4.0.0.tgz", + "integrity": "sha512-TXfryirbmq34y8QBwgqCVLi+8oA3oWx2eAnSn62ITyEhEYaWRlVZ2DvMM9eZbMs/RfxPu/PK/aBLyGj4IrqMHw==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/execa/node_modules/pretty-ms": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/pretty-ms/-/pretty-ms-9.0.0.tgz", + "integrity": "sha512-E9e9HJ9R9NasGOgPaPE8VMeiPKAyWR5jcFpNnwIejslIhWqdqOrb2wShBsncMPUb+BcCd2OPYfh7p2W6oemTng==", + "dev": true, + "dependencies": { + "parse-ms": "^4.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/extend": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", @@ -3070,6 +3218,21 @@ "node": "^12.20 || >= 14.13" } }, + "node_modules/figures": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/figures/-/figures-6.1.0.tgz", + "integrity": "sha512-d+l3qxjSesT4V7v2fh+QnmFnUWv9lSpjarhShNTgBOfA0ttejbQUAlHLitbjkoRiDulW0OPoQPYIGhIC8ohejg==", + "dev": true, + "dependencies": { + "is-unicode-supported": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/file-type": { "version": "3.9.0", "resolved": "https://registry.npmjs.org/file-type/-/file-type-3.9.0.tgz", @@ -3228,12 +3391,28 @@ } }, "node_modules/get-stream": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-8.0.1.tgz", - "integrity": "sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA==", + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-9.0.1.tgz", + "integrity": "sha512-kVCxPF3vQM/N0B1PmoqVUqgHP+EeVjmZSQn+1oCRPxd2P21P2F19lIgbR3HBosbB1PUhOAoctJnfEn2GbN2eZA==", "dev": true, + "dependencies": { + "@sec-ant/readable-stream": "^0.4.1", + "is-stream": "^4.0.1" + }, "engines": { - "node": ">=16" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/get-stream/node_modules/is-stream": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-4.0.1.tgz", + "integrity": "sha512-Dnz92NInDqYckGEUJv689RbRiTSEHCQ7wOVeALbkOz999YpqT46yMRIGtSNl2iCL1waAZSx40+h59NV/EwzV/A==", + "dev": true, + "engines": { + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -3252,6 +3431,7 @@ "version": "7.2.3", "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", "dev": true, "dependencies": { "fs.realpath": "^1.0.0", @@ -3281,9 +3461,9 @@ } }, "node_modules/globby": { - "version": "14.0.1", - "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.1.tgz", - "integrity": "sha512-jOMLD2Z7MAhyG8aJpNOpmziMOP4rPLcc95oQPKXBazW82z+CEgPFBQvEpRUa1KeIMUJo4Wsm+q6uzO/Q/4BksQ==", + "version": "14.0.2", + "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.2.tgz", + "integrity": "sha512-s3Fq41ZVh7vbbe2PN3nrW7yC7U7MFVc5c98/iTl9c2GawNMKx/J648KQRW6WKkuU8GIbbh2IXfIRQjOZnXcTnw==", "dev": true, "dependencies": { "@sindresorhus/merge-streams": "^2.1.0", @@ -3454,12 +3634,12 @@ } }, "node_modules/human-signals": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz", - "integrity": "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-7.0.0.tgz", + "integrity": "sha512-74kytxOUSvNbjrT9KisAbaTZ/eJwD/LrbM/kh5j0IhPuJzwuA19dWvniFGwBzN9rVjg+O/e+F310PjObDXS+9Q==", "dev": true, "engines": { - "node": ">=16.17.0" + "node": ">=18.18.0" } }, "node_modules/humanize-duration": { @@ -3493,6 +3673,7 @@ "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", "dev": true, "dependencies": { "once": "^1.3.0", @@ -3571,13 +3752,25 @@ "node": ">=0.12.0" } }, + "node_modules/is-plain-obj": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", + "integrity": "sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-stream": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz", - "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", "dev": true, "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + "node": ">=8" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -3589,6 +3782,18 @@ "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", "dev": true }, + "node_modules/is-unicode-supported": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-2.0.0.tgz", + "integrity": "sha512-FRdAyx5lusK1iHG0TWpVtk9+1i+GjrzRffhDg4ovQ7mcidMQ6mj+MhKPmvh7Xwyv5gIS06ns49CA7Sqg7lC22Q==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-wsl": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz", @@ -3645,6 +3850,21 @@ "node": ">=8" } }, + "node_modules/istanbul-lib-report/node_modules/make-dir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", + "integrity": "sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==", + "dev": true, + "dependencies": { + "semver": "^7.5.3" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/istanbul-lib-report/node_modules/supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", @@ -3658,9 +3878,9 @@ } }, "node_modules/istanbul-lib-source-maps": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-5.0.4.tgz", - "integrity": "sha512-wHOoEsNJTVltaJp8eVkm8w+GVkVNHT2YDYo53YdzQEL2gWm1hBX5cGFR9hQJtuGLebidVX7et3+dmDZrmclduw==", + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-5.0.5.tgz", + "integrity": "sha512-gKf4eJ8bHmSX/ljiOCpnd8vtmHTwG71uugm0kXYd5aqFCl6z8cj8k7QduXSwU6QOst6LCdSXTlaoc8W4554crQ==", "dev": true, "dependencies": { "@jridgewell/trace-mapping": "^0.3.23", @@ -3817,30 +4037,6 @@ "node": ">=8" } }, - "node_modules/junit-report-builder/node_modules/make-dir": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", - "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", - "dev": true, - "dependencies": { - "semver": "^6.0.0" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/junit-report-builder/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "dev": true, - "bin": { - "semver": "bin/semver.js" - } - }, "node_modules/kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -3934,6 +4130,15 @@ "node": ">= 12.0.0" } }, + "node_modules/logform/node_modules/@colors/colors": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz", + "integrity": "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, "node_modules/loupe": { "version": "2.3.7", "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.7.tgz", @@ -3976,20 +4181,29 @@ } }, "node_modules/make-dir": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", - "integrity": "sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", + "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", "dev": true, "dependencies": { - "semver": "^7.5.3" + "semver": "^6.0.0" }, "engines": { - "node": ">=10" + "node": ">=8" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/make-dir/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, "node_modules/md5-file": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/md5-file/-/md5-file-5.0.0.tgz", @@ -4024,12 +4238,12 @@ } }, "node_modules/micromatch": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", + "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", "dev": true, "dependencies": { - "braces": "^3.0.2", + "braces": "^3.0.3", "picomatch": "^2.3.1" }, "engines": { @@ -4118,14 +4332,14 @@ } }, "node_modules/mlly": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/mlly/-/mlly-1.7.0.tgz", - "integrity": "sha512-U9SDaXGEREBYQgfejV97coK0UL1r+qnF2SyO9A3qcI8MzKnsIFKHNVEkrDyNncQTKQQumsasmeq84eNMdBfsNQ==", + "version": "1.7.1", + "resolved": "https://registry.npmjs.org/mlly/-/mlly-1.7.1.tgz", + "integrity": "sha512-rrVRZRELyQzrIUAVMHxP97kv+G786pHmOKzuFII8zDYahFBS7qnHh2AlYSl1GAHhaMPCz6/oHjVMcfFYgFYHgA==", "dev": true, "dependencies": { "acorn": "^8.11.3", "pathe": "^1.1.2", - "pkg-types": "^1.1.0", + "pkg-types": "^1.1.1", "ufo": "^1.5.3" } }, @@ -4139,9 +4353,9 @@ } }, "node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", "dev": true }, "node_modules/mustache": { @@ -4339,9 +4553,9 @@ } }, "node_modules/oav": { - "version": "3.3.7", - "resolved": "https://registry.npmjs.org/oav/-/oav-3.3.7.tgz", - "integrity": "sha512-zwtLSCTCADo8AcjUc8YFLvCHiamAs1E2n/8QVSmX+FzdqI7TeNm98k8xyQX393cD4OW7VFY9BQ9vDpi1Ap/SKg==", + "version": "3.3.8", + "resolved": "https://registry.npmjs.org/oav/-/oav-3.3.8.tgz", + "integrity": "sha512-5euGa3jDaJfYNz/5WSoPEEx5fM6POUqCWol0GIkRjGFXhpaWcXDvDr3CURWDgdh6E8JjMndet9IoHAGtbrEniA==", "dev": true, "dependencies": { "@apidevtools/swagger-parser": "10.0.3", @@ -4390,43 +4604,6 @@ "node": ">=18.0.0" } }, - "node_modules/oav/node_modules/@azure/abort-controller": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", - "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", - "dev": true, - "dependencies": { - "tslib": "^2.6.2" - }, - "engines": { - "node": ">=18.0.0" - } - }, - "node_modules/oav/node_modules/@azure/core-util": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.7.0.tgz", - "integrity": "sha512-Zq2i3QO6k9DA8vnm29mYM4G8IE9u1mhF1GUabVEqPNX8Lj833gdxQ2NAFxt2BZsfAL+e9cT8SyVN7dFVJ/Hf0g==", - "dev": true, - "dependencies": { - "@azure/abort-controller": "^2.0.0", - "tslib": "^2.2.0" - }, - "engines": { - "node": ">=18.0.0" - } - }, - "node_modules/oav/node_modules/@azure/logger": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.0.4.tgz", - "integrity": "sha512-ustrPY8MryhloQj7OWGe+HrYx+aoiOxzbXTtgblbV3xwCqpzUK36phH3XNHQKj3EPonyFUuDTfR3qFhTEAuZEg==", - "dev": true, - "dependencies": { - "tslib": "^2.2.0" - }, - "engines": { - "node": ">=14.0.0" - } - }, "node_modules/oav/node_modules/ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", @@ -4665,13 +4842,13 @@ } }, "node_modules/pkg-types": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/pkg-types/-/pkg-types-1.1.1.tgz", - "integrity": "sha512-ko14TjmDuQJ14zsotODv7dBlwxKhUKQEhuhmbqo1uCi9BB0Z2alo/wAXg6q1dTR5TyuqYyWhjtfe/Tsh+X28jQ==", + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/pkg-types/-/pkg-types-1.1.2.tgz", + "integrity": "sha512-VEGf1he2DR5yowYRl0XJhWJq5ktm9gYIsH+y8sNJpHlxch7JPDaufgrsl4vYjd9hMUY8QVjoNncKbow9I7exyA==", "dev": true, "dependencies": { "confbox": "^0.1.7", - "mlly": "^1.7.0", + "mlly": "^1.7.1", "pathe": "^1.1.2" } }, @@ -4685,9 +4862,9 @@ } }, "node_modules/postcss": { - "version": "8.4.38", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz", - "integrity": "sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==", + "version": "8.4.39", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.39.tgz", + "integrity": "sha512-0vzE+lAiG7hZl1/9I8yzKLx3aR9Xbof3fBHKunvMfOCYAtMhrsnccJY2iTURb9EZd5+pLuiNV9/c/GZJOHsgIw==", "dev": true, "funding": [ { @@ -4705,7 +4882,7 @@ ], "dependencies": { "nanoid": "^3.3.7", - "picocolors": "^1.0.0", + "picocolors": "^1.0.1", "source-map-js": "^1.2.0" }, "engines": { @@ -5092,9 +5269,9 @@ } }, "node_modules/rollup": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.17.2.tgz", - "integrity": "sha512-/9ClTJPByC0U4zNLowV1tMBe8yMEAxewtR3cUNX5BoEpGH3dQEWpJLr6CLp0fPdYRF/fzVOgvDb1zXuakwF5kQ==", + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.18.0.tgz", + "integrity": "sha512-QmJz14PX3rzbJCN1SG4Xe/bAAX2a6NpCP8ab2vfu2GiUr8AQcr2nCV/oEO3yneFarB67zk8ShlIyWb2LGTb3Sg==", "dev": true, "dependencies": { "@types/estree": "1.0.5" @@ -5107,22 +5284,22 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.17.2", - "@rollup/rollup-android-arm64": "4.17.2", - "@rollup/rollup-darwin-arm64": "4.17.2", - "@rollup/rollup-darwin-x64": "4.17.2", - "@rollup/rollup-linux-arm-gnueabihf": "4.17.2", - "@rollup/rollup-linux-arm-musleabihf": "4.17.2", - "@rollup/rollup-linux-arm64-gnu": "4.17.2", - "@rollup/rollup-linux-arm64-musl": "4.17.2", - "@rollup/rollup-linux-powerpc64le-gnu": "4.17.2", - "@rollup/rollup-linux-riscv64-gnu": "4.17.2", - "@rollup/rollup-linux-s390x-gnu": "4.17.2", - "@rollup/rollup-linux-x64-gnu": "4.17.2", - "@rollup/rollup-linux-x64-musl": "4.17.2", - "@rollup/rollup-win32-arm64-msvc": "4.17.2", - "@rollup/rollup-win32-ia32-msvc": "4.17.2", - "@rollup/rollup-win32-x64-msvc": "4.17.2", + "@rollup/rollup-android-arm-eabi": "4.18.0", + "@rollup/rollup-android-arm64": "4.18.0", + "@rollup/rollup-darwin-arm64": "4.18.0", + "@rollup/rollup-darwin-x64": "4.18.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.18.0", + "@rollup/rollup-linux-arm-musleabihf": "4.18.0", + "@rollup/rollup-linux-arm64-gnu": "4.18.0", + "@rollup/rollup-linux-arm64-musl": "4.18.0", + "@rollup/rollup-linux-powerpc64le-gnu": "4.18.0", + "@rollup/rollup-linux-riscv64-gnu": "4.18.0", + "@rollup/rollup-linux-s390x-gnu": "4.18.0", + "@rollup/rollup-linux-x64-gnu": "4.18.0", + "@rollup/rollup-linux-x64-musl": "4.18.0", + "@rollup/rollup-win32-arm64-msvc": "4.18.0", + "@rollup/rollup-win32-ia32-msvc": "4.18.0", + "@rollup/rollup-win32-x64-msvc": "4.18.0", "fsevents": "~2.3.2" } }, @@ -5275,14 +5452,14 @@ } }, "node_modules/simple-git": { - "version": "3.24.0", - "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-3.24.0.tgz", - "integrity": "sha512-QqAKee9Twv+3k8IFOFfPB2hnk6as6Y6ACUpwCtQvRYBAes23Wv3SZlHVobAzqcE8gfsisCvPw3HGW3HYM+VYYw==", + "version": "3.25.0", + "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-3.25.0.tgz", + "integrity": "sha512-KIY5sBnzc4yEcJXW7Tdv4viEz8KyG+nU0hay+DWZasvdFOYKeUZ6Xc25LUHHjw0tinPT7O1eY6pzX7pRT1K8rw==", "dev": true, "dependencies": { "@kwsites/file-exists": "^1.1.1", "@kwsites/promise-deferred": "^1.1.1", - "debug": "^4.3.4" + "debug": "^4.3.5" }, "funding": { "type": "github", @@ -5437,12 +5614,12 @@ } }, "node_modules/strip-final-newline": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz", - "integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-4.0.0.tgz", + "integrity": "sha512-aulFJcD6YK8V1G7iRB5tigAP4TsHBZZrOV8pjV++zdUwmeV8uzbY7yn6h9MswN62adStNZFuCIx4haBnRuMDaw==", "dev": true, "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -5587,9 +5764,9 @@ } }, "node_modules/tslib": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz", - "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==", + "version": "2.6.3", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.3.tgz", + "integrity": "sha512-xNvxJEOUiWPGhUuUdQgAJPKOOJfGnIyKySOc09XkKsgdUV/3E2zvwZYdejjmRgPCgcym1juLH3226yA7sEFJKQ==", "dev": true }, "node_modules/tunnel": { @@ -5773,9 +5950,9 @@ } }, "node_modules/vite-node/node_modules/@types/node": { - "version": "20.12.12", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.12.12.tgz", - "integrity": "sha512-eWLDGF/FOSPtAvEqeRAQ4C8LSA7M1I7i0ky1I8U7kD1J5ITyW3AsRhQrKVoWf5pFKZ2kILsEGJhsI9r93PYnOw==", + "version": "20.14.9", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.9.tgz", + "integrity": "sha512-06OCtnTXtWOZBJlRApleWndH4JsRVs1pDCc8dLSQp+7PpUpX3ePdHyeNSFTeSe7FtKyQkrlPvHwJOW3SLd8Oyg==", "dev": true, "optional": true, "peer": true, @@ -5784,12 +5961,12 @@ } }, "node_modules/vite-node/node_modules/vite": { - "version": "5.2.11", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.2.11.tgz", - "integrity": "sha512-HndV31LWW05i1BLPMUCE1B9E9GFbOu1MbenhS58FuK6owSO5qHm7GiCotrNY1YE5rMeQSFBGmT5ZaLEjFizgiQ==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.3.2.tgz", + "integrity": "sha512-6lA7OBHBlXUxiJxbO5aAY2fsHHzDr1q7DvXYnyZycRs2Dz+dXBWuhpWHvmljTRTpQC2uvGmUFFkSHF2vGo90MA==", "dev": true, "dependencies": { - "esbuild": "^0.20.1", + "esbuild": "^0.21.3", "postcss": "^8.4.38", "rollup": "^4.13.0" }, @@ -5979,16 +6156,13 @@ "node": ">= 12.0.0" } }, - "node_modules/winston/node_modules/is-stream": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", - "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "node_modules/winston/node_modules/@colors/colors": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz", + "integrity": "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA==", "dev": true, "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "node": ">=0.1.90" } }, "node_modules/word-wrap": { @@ -6103,9 +6277,9 @@ "dev": true }, "node_modules/yaml": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.2.tgz", - "integrity": "sha512-B3VqDZ+JAg1nZpaEmWtTXUlBneoGx6CPM9b0TENK6aoSu5t73dItudwdgmi6tHlIZZId4dZ9skcAQ2UbcyAeVA==", + "version": "2.4.5", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.5.tgz", + "integrity": "sha512-aBx2bnqDzVOyNKfsysjA2ms5ZlnjSAW2eG3/L5G/CSujfjLJTJsEw1bGw8kCf04KodQWk1pxlGnZ56CRxiawmg==", "dev": true, "bin": { "yaml": "bin.mjs" @@ -6150,9 +6324,9 @@ } }, "node_modules/yocto-queue": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.0.0.tgz", - "integrity": "sha512-9bnSc/HEW2uRy67wc+T8UwauLuPJVn28jb+GtJY16iiKWyvmYJRXVT4UamsAEGQfPohgr2q4Tq0sQbQlxTfi1g==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.1.1.tgz", + "integrity": "sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==", "dev": true, "engines": { "node": ">=12.20" @@ -6161,6 +6335,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/yoctocolors": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/yoctocolors/-/yoctocolors-2.1.0.tgz", + "integrity": "sha512-FsQpXXeOEe05tcJN4Z2eicuC6+6KiJdBbPOAChanSkwwjZ277XGsh8wh/HaPuGeifTiw/7dgAzabitu2bnDvRg==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/z-schema": { "version": "5.0.5", "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz", From c142d613ea72dcc1251a5d4402147f13afc01f2a Mon Sep 17 00:00:00 2001 From: Mitesh Shah <58204159+mitsha-microsoft@users.noreply.github.com> Date: Tue, 2 Jul 2024 19:50:06 +0530 Subject: [PATCH 267/343] Fixed examples and property documentation in TestProfiles (#29664) * Fixed examples and properrty documentation in TestProfiles * Remove CANCELLED change --- .../2024-05-01-preview/CreateOrUpdateTestProfile.json | 4 ++-- .../2024-05-01-preview/CreateOrUpdateTestProfileRun.json | 4 ++-- .../examples/2024-05-01-preview/GetTestProfile.json | 4 ++-- .../2024-05-01-preview/GetTestProfileRun_Executed.json | 4 ++-- .../2024-05-01-preview/GetTestProfileRun_Executing.json | 4 ++-- .../examples/2024-05-01-preview/ListTestProfileRuns.json | 4 ++-- .../examples/2024-05-01-preview/ListTestProfiles.json | 4 ++-- .../examples/2024-05-01-preview/StopTestProfileRun.json | 4 ++-- .../loadtestservice/LoadTestService/models.testprofile.tsp | 2 +- .../examples/CreateOrUpdateTestProfile.json | 4 ++-- .../examples/CreateOrUpdateTestProfileRun.json | 4 ++-- .../preview/2024-05-01-preview/examples/GetTestProfile.json | 4 ++-- .../examples/GetTestProfileRun_Executed.json | 4 ++-- .../examples/GetTestProfileRun_Executing.json | 4 ++-- .../2024-05-01-preview/examples/ListTestProfileRuns.json | 4 ++-- .../preview/2024-05-01-preview/examples/ListTestProfiles.json | 4 ++-- .../2024-05-01-preview/examples/StopTestProfileRun.json | 4 ++-- .../preview/2024-05-01-preview/loadtestservice.json | 4 ++-- 18 files changed, 35 insertions(+), 35 deletions(-) diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfile.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfile.json index 64e2f5516732..389c8d014750 100644 --- a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfile.json +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfile.json @@ -13,11 +13,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfileRun.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfileRun.json index d0765c4ddf08..ee0823ffc42e 100644 --- a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfileRun.json +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/CreateOrUpdateTestProfileRun.json @@ -26,11 +26,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfile.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfile.json index de3ccfec49b7..6b39216ab1be 100644 --- a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfile.json +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfile.json @@ -17,11 +17,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executed.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executed.json index 2dbfe73ad54f..a6695a3d9075 100644 --- a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executed.json +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executed.json @@ -21,11 +21,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executing.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executing.json index 25756f76a81f..f30557620b8d 100644 --- a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executing.json +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/GetTestProfileRun_Executing.json @@ -19,11 +19,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json index 78af0f0b7ad3..76e1cf9ef561 100644 --- a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json @@ -29,11 +29,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfiles.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfiles.json index fcf359be1f1a..ac5476e50ba6 100644 --- a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfiles.json +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfiles.json @@ -23,11 +23,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestProfileRun.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestProfileRun.json index 0837614fbd0d..57ab06f4caf8 100644 --- a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestProfileRun.json +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/StopTestProfileRun.json @@ -21,11 +21,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/LoadTestService/models.testprofile.tsp b/specification/loadtestservice/LoadTestService/models.testprofile.tsp index 02e1e85232ac..7c82e576f1c3 100644 --- a/specification/loadtestservice/LoadTestService/models.testprofile.tsp +++ b/specification/loadtestservice/LoadTestService/models.testprofile.tsp @@ -85,7 +85,7 @@ union RecommendationCategory { @added(APIVersions.v2024_05_01_preview) model FunctionFlexConsumptionResourceConfiguration { #suppress "@azure-tools/typespec-azure-core/casing-style" "Abbreviating MB to Mb changes the meaning of the value." - @doc("Memory size of the instance. Supported values are 512, 2048, 2096.") + @doc("Memory size of the instance. Supported values are 2048, 4096.") instanceMemoryMB: int64; @doc("HTTP Concurrency for the function app.") diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfile.json index 64e2f5516732..389c8d014750 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfile.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfile.json @@ -13,11 +13,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfileRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfileRun.json index d0765c4ddf08..ee0823ffc42e 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfileRun.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/CreateOrUpdateTestProfileRun.json @@ -26,11 +26,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfile.json index de3ccfec49b7..6b39216ab1be 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfile.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfile.json @@ -17,11 +17,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executed.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executed.json index 2dbfe73ad54f..a6695a3d9075 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executed.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executed.json @@ -21,11 +21,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executing.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executing.json index 25756f76a81f..f30557620b8d 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executing.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/GetTestProfileRun_Executing.json @@ -19,11 +19,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json index 78af0f0b7ad3..76e1cf9ef561 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json @@ -29,11 +29,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfiles.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfiles.json index fcf359be1f1a..ac5476e50ba6 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfiles.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfiles.json @@ -23,11 +23,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestProfileRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestProfileRun.json index 0837614fbd0d..57ab06f4caf8 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestProfileRun.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/StopTestProfileRun.json @@ -21,11 +21,11 @@ "kind": "FunctionsFlexConsumption", "configurations": { "config1": { - "instanceMemoryMB": 512, + "instanceMemoryMB": 2048, "httpConcurrency": 16 }, "config2": { - "instanceMemoryMB": 2048, + "instanceMemoryMB": 4096, "httpConcurrency": 16 } } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json index b0cdb8ed7c12..38839ab8327d 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json @@ -2584,7 +2584,7 @@ "instanceMemoryMB": { "type": "integer", "format": "int64", - "description": "Memory size of the instance. Supported values are 512, 2048, 2096." + "description": "Memory size of the instance. Supported values are 2048, 4096." }, "httpConcurrency": { "type": "integer", @@ -2604,7 +2604,7 @@ "instanceMemoryMB": { "type": "integer", "format": "int64", - "description": "Memory size of the instance. Supported values are 512, 2048, 2096." + "description": "Memory size of the instance. Supported values are 2048, 4096." }, "httpConcurrency": { "type": "integer", From cea8c463144bbcfddd843df17498d3ec4b0c0791 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Tue, 2 Jul 2024 09:17:50 -0700 Subject: [PATCH 268/343] Change unknown parameters to extra parameters Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/common.tsp | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index b38347a08845..8548ced51301 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -132,23 +132,23 @@ union ModelType { alias AdditionalRequestHeaders = { @doc(""" - Controls what happens if unknown parameters are passed in the JSON request payload. - This sets the HTTP request header `unknown-parameters`. + Controls what happens if extra parameters are passed in the JSON request payload. + This sets the HTTP request header `extra-parameters`. """) - @header("unknown-parameters") - unknown_params?: UnknownParams; + @header("extra-parameters") + extra_params?: ExtraParams; }; -@doc("Controls what happens if unknown parameters are passed in the JSON request payload.") -union UnknownParams { +@doc("Controls what happens if extra parameters are passed in the JSON request payload.") +union ExtraParams { string, - @doc("The service will error if it detected unknown parameters in the request payload. This is the service default.") + @doc("The service will error if it detected extra parameters in the request payload. This is the service default.") error: "error", - @doc("The service will ignore (drop) unknown parameters in the request payload. It will only pass the known parameters to the back-end AI model.") + @doc("The service will ignore (drop) extra parameters in the request payload. It will only pass the known parameters to the back-end AI model.") drop: "drop", - @doc("The service will pass unknown parameters to the back-end AI model.") + @doc("The service will pass extra parameters to the back-end AI model.") pass_through: "pass_through", } From 5bf2215763cf40da0ce6136df2be0216eb41d2ec Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 2 Jul 2024 14:42:00 -0700 Subject: [PATCH 269/343] Rename HTTP header to extra-parameters --- .../ai/ModelClient/models/chat_completions.tsp | 2 +- specification/ai/ModelClient/models/common.tsp | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 0018e805b054..73fed6ab5fbe 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -351,7 +351,7 @@ model ChatResponseMessage { toolCalls?: ChatCompletionsToolCall[]; } -// tool_choice: "auto" | "none" | "required" | { "type": "function", "name": string } +// tool_choice: "auto" | "none" | "required" | {"type": "function", "function": {"name": string}} #suppress "@azure-tools/typespec-autorest/union-unsupported" "External API shape is defined in OpenAPI 3.0 as oneOf." alias ChatCompletionsToolSelection = ChatCompletionsToolSelectionPreset | ChatCompletionsNamedToolSelection; diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index b38347a08845..91d19f3dd8a5 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -132,15 +132,16 @@ union ModelType { alias AdditionalRequestHeaders = { @doc(""" - Controls what happens if unknown parameters are passed in the JSON request payload. - This sets the HTTP request header `unknown-parameters`. + Controls what happens if extra parameters, undefined by the REST API, + are passed in the JSON request payload. + This sets the HTTP request header `extra-parameters`. """) - @header("unknown-parameters") - unknown_params?: UnknownParams; + @header("extra-parameters") + extra_params?: ExtraParameters; }; -@doc("Controls what happens if unknown parameters are passed in the JSON request payload.") -union UnknownParams { +@doc("Controls what happens if extra parameters, undefined byt he REST ApI are passed in the JSON request payload.") +union ExtraParameters { string, @doc("The service will error if it detected unknown parameters in the request payload. This is the service default.") From 3cb1b51638616435470fc10ea00de92512186ece Mon Sep 17 00:00:00 2001 From: Han Chiang Date: Wed, 3 Jul 2024 13:54:13 +0800 Subject: [PATCH 270/343] Update detection description (#29662) * Update detection description * update spec --- specification/ai/Face/routes.detection.tsp | 2 +- .../ai/data-plane/Face/preview/v1.1-preview.1/Face.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/ai/Face/routes.detection.tsp b/specification/ai/Face/routes.detection.tsp index 18a54399cfb8..a392586ea93a 100644 --- a/specification/ai/Face/routes.detection.tsp +++ b/specification/ai/Face/routes.detection.tsp @@ -16,7 +16,7 @@ namespace Face; @summary("Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.") @doc(""" > [!IMPORTANT] - > Microsoft has retired or restricted facial recognition capabilities that can be used to try to infer emotional states and identity attributes which, if misused, can subject people to stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email Azure Face API if you have a responsible use case that would benefit from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. + > Microsoft has retired or limited facial recognition capabilities that can be used to try to infer emotional states and identity attributes which, if misused, can subject people to stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion and gender. The limited capabilities are age, smile, facial hair, hair and makeup. Email Azure Face API if you have a responsible use case that would benefit from the use of any of the limited capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. * * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. diff --git a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json index f5f77b5d0d1b..9ad89a4484f6 100644 --- a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json +++ b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json @@ -88,7 +88,7 @@ "post": { "operationId": "FaceDetectionOperations_DetectFromUrl", "summary": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.", - "description": "> [!IMPORTANT]\n> Microsoft has retired or restricted facial recognition capabilities that can be used to try to infer emotional states and identity attributes which, if misused, can subject people to stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email Azure Face API if you have a responsible use case that would benefit from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.\n\n*\n * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.\n * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.\n * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model\n * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.\n * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.\n * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.", + "description": "> [!IMPORTANT]\n> Microsoft has retired or limited facial recognition capabilities that can be used to try to infer emotional states and identity attributes which, if misused, can subject people to stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion and gender. The limited capabilities are age, smile, facial hair, hair and makeup. Email Azure Face API if you have a responsible use case that would benefit from the use of any of the limited capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.\n\n*\n * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.\n * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.\n * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model\n * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.\n * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.\n * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.", "parameters": [ { "name": "detectionModel", @@ -5585,7 +5585,7 @@ "post": { "operationId": "FaceDetectionOperations_Detect", "summary": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.", - "description": "> [!IMPORTANT]\n> Microsoft has retired or restricted facial recognition capabilities that can be used to try to infer emotional states and identity attributes which, if misused, can subject people to stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email Azure Face API if you have a responsible use case that would benefit from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.\n\n*\n * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.\n * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.\n * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model\n * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.\n * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.\n * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.", + "description": "> [!IMPORTANT]\n> Microsoft has retired or limited facial recognition capabilities that can be used to try to infer emotional states and identity attributes which, if misused, can subject people to stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion and gender. The limited capabilities are age, smile, facial hair, hair and makeup. Email Azure Face API if you have a responsible use case that would benefit from the use of any of the limited capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.\n\n*\n * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.\n * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.\n * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model\n * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.\n * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.\n * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.", "consumes": [ "application/octet-stream" ], From 07d286359f828bbc7901e86288a5d62b48ae2052 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Wed, 3 Jul 2024 17:18:15 +0800 Subject: [PATCH 271/343] update password in example to fix sdk credscan error (#29666) * update password in example to fix sdk credscan error * update in tsp example --- .../examples/2023-10-07/GuestAgents_Create_MaximumSet_Gen.json | 2 +- .../2023-10-07/VmmServers_CreateOrUpdate_MaximumSet_Gen.json | 2 +- .../2023-10-07/examples/GuestAgents_Create_MaximumSet_Gen.json | 2 +- .../examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MaximumSet_Gen.json index e9b7586788ff..d4e4906149fe 100644 --- a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MaximumSet_Gen.json +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MaximumSet_Gen.json @@ -8,7 +8,7 @@ "properties": { "credentials": { "username": "jqxuwirrcpfv", - "password": "gkvbnmuahumuoibvscoxzfdqwvfuf" + "password": "SecretPlaceholder" }, "httpProxyConfig": { "httpsProxy": "uoyzyticmohohomlkwct" diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MaximumSet_Gen.json index bb3f5c2817a4..d95fe593f9ec 100644 --- a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "properties": { "credentials": { "username": "jbuoltypmrgqfi", - "password": "gaecsnkjr" + "password": "SecretPlaceholder" }, "fqdn": "pvzcjaqrswbvptgx", "port": 4 diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MaximumSet_Gen.json index e9b7586788ff..d4e4906149fe 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MaximumSet_Gen.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MaximumSet_Gen.json @@ -8,7 +8,7 @@ "properties": { "credentials": { "username": "jqxuwirrcpfv", - "password": "gkvbnmuahumuoibvscoxzfdqwvfuf" + "password": "SecretPlaceholder" }, "httpProxyConfig": { "httpsProxy": "uoyzyticmohohomlkwct" diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json index bb3f5c2817a4..d95fe593f9ec 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "properties": { "credentials": { "username": "jbuoltypmrgqfi", - "password": "gaecsnkjr" + "password": "SecretPlaceholder" }, "fqdn": "pvzcjaqrswbvptgx", "port": 4 From b39fbab7d4b73760655ff7944e12b1056ddf7aff Mon Sep 17 00:00:00 2001 From: Allen Zhang Date: Wed, 3 Jul 2024 15:06:27 -0700 Subject: [PATCH 272/343] Update Getting-started-with-TypeSpec-specifications.md (#29674) fixing broken link to tspconfig.yaml --- .../Getting-started-with-TypeSpec-specifications.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/Getting-started-with-TypeSpec-specifications.md b/documentation/Getting-started-with-TypeSpec-specifications.md index 91f38fedd303..ee2add8f0212 100644 --- a/documentation/Getting-started-with-TypeSpec-specifications.md +++ b/documentation/Getting-started-with-TypeSpec-specifications.md @@ -16,14 +16,14 @@ Within the azure-rest-api-specs repository, the TypeSpec specification serves as #### ARM: - :white_check_mark: TypeSpec folder name should end with `.Management`. -- :white_check_mark: This `tspconfig.yaml` is [standard for ARM](https://github.com/microsoft/typespec/blob/main/eng/feeds/arm/tspconfig.yaml). The one thing you may customize is the output json file name for `typespec-autorest` emitter. +- :white_check_mark: This `tspconfig.yaml` is [standard for ARM](https://github.com/Azure/typespec-azure/blob/main/eng/feeds/arm/tspconfig.yaml). The one thing you may customize is the output json file name for `typespec-autorest` emitter. #### Data-Plane: -- :white_check_mark: `tspconfig.yaml` starting template for [Data-plane is here.](https://github.com/microsoft/typespec/blob/main/eng/feeds/arm/tspconfig.yaml). For `typespec-autorest` emitter, you may only customize the output json file name. For other language SDK emitters' settings, you may override values for TypeSpec direct SDK generation. +- :white_check_mark: `tspconfig.yaml` starting template for [Data-plane is here.](https://github.com/Azure/typespec-azure/blob/main/eng/feeds/data-plane/tspconfig.yaml). For `typespec-autorest` emitter, you may only customize the output json file name. For other language SDK emitters' settings, you may override values for TypeSpec direct SDK generation. ### Detailed information - [Setting up local environment for TypeSpec](./typespec-rest-api-dev-process.md#2-repo-setup--prerequisites) - Read up on [Folder Structure for TypeSpec](./typespec-structure-guidelines.md) - [Setting up a new TypeSpec project](./typespec-rest-api-dev-process.md#3-creating-a-new-typespec-project) -- [Setting up and regenerate SDK projects](./typespec-rest-api-dev-process.md#4-generate-or-refresh-sdk-code-from-a-typespec-project) \ No newline at end of file +- [Setting up and regenerate SDK projects](./typespec-rest-api-dev-process.md#4-generate-or-refresh-sdk-code-from-a-typespec-project) From c760f2590f71fb629648163194436a2efa0969df Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Thu, 4 Jul 2024 11:59:20 +0800 Subject: [PATCH 273/343] [azure fleet] Update tspconfig.yaml for python (#29695) --- specification/azurefleet/AzureFleet.Management/tspconfig.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml index 6e187771dfb0..2f4a5b303be1 100644 --- a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml +++ b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml @@ -26,6 +26,7 @@ options: "@azure-tools/typespec-python": package-dir: "azure-mgmt-computefleet" package-name: "{package-dir}" + generate-test: true flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-computefleet" From 73e75c8d031d9d934d2ea2e431cf9dbeb3902195 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Thu, 4 Jul 2024 14:33:34 +0800 Subject: [PATCH 274/343] Update readme.md to remove `-track2` for python (#29697) * Update readme.md * remote go spec automation --------- Co-authored-by: Alancere <804873052@qq.com> --- specification/mongocluster/resource-manager/readme.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/mongocluster/resource-manager/readme.md b/specification/mongocluster/resource-manager/readme.md index 8cd75006ffd3..37341dec4f7e 100644 --- a/specification/mongocluster/resource-manager/readme.md +++ b/specification/mongocluster/resource-manager/readme.md @@ -49,9 +49,8 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-resource-manager-schemas - repo: azure-cli-extensions From edf14cc0a577f6b9c4e3ce018cec0c383e64b7b0 Mon Sep 17 00:00:00 2001 From: Xiaofei Cao <92354331+XiaofeiCao@users.noreply.github.com> Date: Thu, 4 Jul 2024 17:49:24 +0800 Subject: [PATCH 275/343] fix service-dir (#29679) --- specification/azurefleet/AzureFleet.Management/tspconfig.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml index 2f4a5b303be1..05aeccd4f73e 100644 --- a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml +++ b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml @@ -1,6 +1,6 @@ parameters: "service-dir": - default: "sdk/azurefleet" + default: "sdk/computefleet" "service-directory-name": default: "azurefleet" emit: From ab064e0047ec560a700d6b501097d99471ad817b Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Fri, 5 Jul 2024 17:39:14 +0800 Subject: [PATCH 276/343] Update tspconfig.yaml (#29711) https://github.com/Azure/sdk-release-request/issues/5073 --- specification/edgezones/EdgeZones.Management/tspconfig.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/edgezones/EdgeZones.Management/tspconfig.yaml b/specification/edgezones/EdgeZones.Management/tspconfig.yaml index 22e3d53aa5fe..c89f4eb4e50d 100644 --- a/specification/edgezones/EdgeZones.Management/tspconfig.yaml +++ b/specification/edgezones/EdgeZones.Management/tspconfig.yaml @@ -16,6 +16,7 @@ options: "@azure-tools/typespec-python": package-dir: "azure-mgmt-edgezones" package-name: "{package-dir}" + generate-test: true flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-edgezones" From a977c730fda43ab19c05373b32c7159d6f265e9a Mon Sep 17 00:00:00 2001 From: Ajay verma Date: Mon, 8 Jul 2024 17:28:47 +0530 Subject: [PATCH 277/343] Stable version API for Qumulo: 2024-06-19 (#29673) * adding stable version API for Qumulo * resolved .md comments * resolved .md comments * resolved typespec and swagger comments * resolved typespec and swagger comments * updated readme.md * addressed comments * addressed comments * add sdk-suppressions.yaml * Update readme.typescript.md * Update readme.typescript.md * update readme.go.md * update sdk-suppressions.yaml --------- Co-authored-by: Ajay Verma Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- .../Qumulo.Management/cadl-project.yaml | 4 - ...Systems_CreateOrUpdate_MaximumSet_Gen.json | 149 ---- .../FileSystems_Delete_MaximumSet_Gen.json | 17 - .../FileSystems_Delete_MinimumSet_Gen.json | 17 - .../FileSystems_Get_MaximumSet_Gen.json | 61 -- ...ms_ListByResourceGroup_MaximumSet_Gen.json | 65 -- ...ems_ListBySubscription_MaximumSet_Gen.json | 64 -- .../FileSystems_Update_MaximumSet_Gen.json | 89 --- .../Operations_List_MaximumSet_Gen.json | 26 - .../Operations_List_MinimumSet_Gen.json | 10 - ...Systems_CreateOrUpdate_MaximumSet_Gen.json | 149 ---- .../FileSystems_Delete_MaximumSet_Gen.json | 17 - .../FileSystems_Delete_MinimumSet_Gen.json | 17 - .../FileSystems_Get_MaximumSet_Gen.json | 61 -- ...ms_ListByResourceGroup_MaximumSet_Gen.json | 65 -- ...ems_ListBySubscription_MaximumSet_Gen.json | 64 -- .../FileSystems_Update_MaximumSet_Gen.json | 89 --- .../Operations_List_MaximumSet_Gen.json | 26 - .../Operations_List_MinimumSet_Gen.json | 10 - .../liftrqumulo/Qumulo.Management/main.cadl | 179 ----- .../Qumulo.Management/package.json | 21 - .../LiftrBase.Storage/main.tsp | 137 ++++ .../LiftrBase/main.tsp | 139 ++++ ...Systems_CreateOrUpdate_MaximumSet_Gen.json | 147 ++++ ...Systems_CreateOrUpdate_MinimumSet_Gen.json | 78 +- .../FileSystems_Delete_MaximumSet_Gen.json | 19 + .../FileSystems_Delete_MinimumSet_Gen.json | 19 + .../FileSystems_Get_MaximumSet_Gen.json | 61 ++ .../FileSystems_Get_MinimumSet_Gen.json} | 31 +- ...ms_ListByResourceGroup_MaximumSet_Gen.json | 65 ++ ...ms_ListByResourceGroup_MinimumSet_Gen.json | 28 +- ...ems_ListBySubscription_MaximumSet_Gen.json | 64 ++ ...ems_ListBySubscription_MinimumSet_Gen.json | 24 +- .../FileSystems_Update_MaximumSet_Gen.json | 86 +++ .../FileSystems_Update_MinimumSet_Gen.json} | 30 +- .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + .../Qumulo.Storage.Management/main.tsp | 95 +++ .../Qumulo.Storage.Management/tspconfig.yaml | 13 + ...Systems_CreateOrUpdate_MaximumSet_Gen.json | 2 +- ...Systems_CreateOrUpdate_MinimumSet_Gen.json | 4 +- .../FileSystems_Update_MaximumSet_Gen.json | 2 +- ...Systems_CreateOrUpdate_MaximumSet_Gen.json | 2 +- ...Systems_CreateOrUpdate_MinimumSet_Gen.json | 2 +- .../stable/2024-06-19/Qumulo.Storage.json | 712 ++++++++++++++++++ ...Systems_CreateOrUpdate_MaximumSet_Gen.json | 147 ++++ ...Systems_CreateOrUpdate_MinimumSet_Gen.json | 78 +- .../FileSystems_Delete_MaximumSet_Gen.json | 19 + .../FileSystems_Delete_MinimumSet_Gen.json | 19 + .../FileSystems_Get_MaximumSet_Gen.json | 61 ++ .../FileSystems_Get_MinimumSet_Gen.json} | 31 +- ...ms_ListByResourceGroup_MaximumSet_Gen.json | 65 ++ ...ms_ListByResourceGroup_MinimumSet_Gen.json | 28 +- ...ems_ListBySubscription_MaximumSet_Gen.json | 64 ++ ...ems_ListBySubscription_MinimumSet_Gen.json | 24 +- .../FileSystems_Update_MaximumSet_Gen.json | 86 +++ .../FileSystems_Update_MinimumSet_Gen.json} | 30 +- .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + .../liftrqumulo/resource-manager/readme.go.md | 25 + .../liftrqumulo/resource-manager/readme.md | 11 +- .../resource-manager/readme.typescript.md | 26 + .../resource-manager/sdk-suppressions.yaml | 9 + 63 files changed, 2352 insertions(+), 1411 deletions(-) delete mode 100644 specification/liftrqumulo/Qumulo.Management/cadl-project.yaml delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_CreateOrUpdate_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Delete_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Delete_MinimumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Get_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListByResourceGroup_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListBySubscription_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Update_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/Operations_List_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/Operations_List_MinimumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_CreateOrUpdate_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Delete_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Delete_MinimumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Get_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListByResourceGroup_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListBySubscription_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Update_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/Operations_List_MaximumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/Operations_List_MinimumSet_Gen.json delete mode 100644 specification/liftrqumulo/Qumulo.Management/main.cadl delete mode 100644 specification/liftrqumulo/Qumulo.Management/package.json create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/LiftrBase.Storage/main.tsp create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/LiftrBase/main.tsp create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_CreateOrUpdate_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-06-27-preview => Qumulo.Storage.Management/examples/2024-06-19}/FileSystems_CreateOrUpdate_MinimumSet_Gen.json (65%) create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Delete_MaximumSet_Gen.json create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Delete_MinimumSet_Gen.json create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Get_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-10-12-preview/FileSystems_Update_MinimumSet_Gen.json => Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Get_MinimumSet_Gen.json} (65%) create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListByResourceGroup_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-10-12-preview => Qumulo.Storage.Management/examples/2024-06-19}/FileSystems_ListByResourceGroup_MinimumSet_Gen.json (60%) create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListBySubscription_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-10-12-preview => Qumulo.Storage.Management/examples/2024-06-19}/FileSystems_ListBySubscription_MinimumSet_Gen.json (66%) create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Update_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-06-27-preview/FileSystems_Get_MinimumSet_Gen.json => Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Update_MinimumSet_Gen.json} (56%) create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/Operations_List_MaximumSet_Gen.json create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/Operations_List_MinimumSet_Gen.json create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/main.tsp create mode 100644 specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/Qumulo.Storage.json create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-10-12-preview => resource-manager/Qumulo.Storage/stable/2024-06-19/examples}/FileSystems_CreateOrUpdate_MinimumSet_Gen.json (65%) create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Delete_MaximumSet_Gen.json create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Delete_MinimumSet_Gen.json create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Get_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-06-27-preview/FileSystems_Update_MinimumSet_Gen.json => resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Get_MinimumSet_Gen.json} (65%) create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListByResourceGroup_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-06-27-preview => resource-manager/Qumulo.Storage/stable/2024-06-19/examples}/FileSystems_ListByResourceGroup_MinimumSet_Gen.json (60%) create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListBySubscription_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-06-27-preview => resource-manager/Qumulo.Storage/stable/2024-06-19/examples}/FileSystems_ListBySubscription_MinimumSet_Gen.json (66%) create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Update_MaximumSet_Gen.json rename specification/liftrqumulo/{Qumulo.Management/examples/2022-10-12-preview/FileSystems_Get_MinimumSet_Gen.json => resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Update_MinimumSet_Gen.json} (56%) create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/liftrqumulo/resource-manager/sdk-suppressions.yaml diff --git a/specification/liftrqumulo/Qumulo.Management/cadl-project.yaml b/specification/liftrqumulo/Qumulo.Management/cadl-project.yaml deleted file mode 100644 index 9e8b3c8db87d..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/cadl-project.yaml +++ /dev/null @@ -1,4 +0,0 @@ -emitters: - "@azure-tools/cadl-autorest": - output-file: Qumulo.Storage.json - examples-directory: ./examples \ No newline at end of file diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_CreateOrUpdate_MaximumSet_Gen.json deleted file mode 100644 index 6d4f055f6856..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_CreateOrUpdate_MaximumSet_Gen.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg", - "resource": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "adminPassword": "ekceujoecaashtjlsgcymnrdozk", - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "identity": { - "type": "None", - "userAssignedIdentities": { - "key4522": {} - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq" - } - }, - "responses": { - "200": { - "body": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - }, - "201": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - }, - "body": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Delete_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Delete_MaximumSet_Gen.json deleted file mode 100644 index ae1bd6ade2ee..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Delete_MaximumSet_Gen.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - } - }, - "204": {} - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Delete_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Delete_MinimumSet_Gen.json deleted file mode 100644 index ae1bd6ade2ee..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Delete_MinimumSet_Gen.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - } - }, - "204": {} - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Get_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Get_MaximumSet_Gen.json deleted file mode 100644 index 1995c8c802aa..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Get_MaximumSet_Gen.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg" - }, - "responses": { - "200": { - "body": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListByResourceGroup_MaximumSet_Gen.json deleted file mode 100644 index 365e4a9a8fbd..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListByResourceGroup_MaximumSet_Gen.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - ], - "nextLink": "eisxspfvczpkjjgfpzdydcjrogc" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListBySubscription_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListBySubscription_MaximumSet_Gen.json deleted file mode 100644 index 24350db24265..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListBySubscription_MaximumSet_Gen.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "ulseeqylxb" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - ], - "nextLink": "eisxspfvczpkjjgfpzdydcjrogc" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Update_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Update_MaximumSet_Gen.json deleted file mode 100644 index c9109445f9c3..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Update_MaximumSet_Gen.json +++ /dev/null @@ -1,89 +0,0 @@ -{ - "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg", - "properties": { - "identity": { - "type": "None", - "userAssignedIdentities": { - "key4522": {} - } - }, - "tags": { - "key7534": "jsgqvqbagquvxowbrkanyhzvo" - }, - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "vjfirtaljehawmflyfianw", - "clusterLoginUrl": "adabmuthwrbjshzfbo", - "privateIPs": [ - "eugjqbaoucgjsopzfrq" - ] - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "eugjqbaoucgjsopzfrq" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/Operations_List_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/Operations_List_MaximumSet_Gen.json deleted file mode 100644 index ada0228046a7..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/Operations_List_MaximumSet_Gen.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2022-06-27-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "runmssufdtztqwcjrxyuyodlzbxidp", - "isDataAction": true, - "display": { - "provider": "e", - "resource": "cgzkjnfpkvddogcszpdn", - "operation": "fgyvgifprfxdgyqdbglrysjjsozm", - "description": "cnjdpucbtzreoihwdqnkprk" - }, - "origin": "user", - "actionType": "Internal" - } - ], - "nextLink": "mzpodd" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/Operations_List_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/Operations_List_MinimumSet_Gen.json deleted file mode 100644 index 699e981746c6..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/Operations_List_MinimumSet_Gen.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "api-version": "2022-06-27-preview" - }, - "responses": { - "200": { - "body": {} - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_CreateOrUpdate_MaximumSet_Gen.json deleted file mode 100644 index 8f2441ddd7dc..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_CreateOrUpdate_MaximumSet_Gen.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg", - "resource": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "adminPassword": "ekceujoecaashtjlsgcymnrdozk", - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "identity": { - "type": "None", - "userAssignedIdentities": { - "key4522": {} - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq" - } - }, - "responses": { - "200": { - "body": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - }, - "201": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - }, - "body": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Delete_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Delete_MaximumSet_Gen.json deleted file mode 100644 index 575ca93c4a2f..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Delete_MaximumSet_Gen.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - } - }, - "204": {} - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Delete_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Delete_MinimumSet_Gen.json deleted file mode 100644 index 575ca93c4a2f..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Delete_MinimumSet_Gen.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - } - }, - "204": {} - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Get_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Get_MaximumSet_Gen.json deleted file mode 100644 index e3f1024a760a..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Get_MaximumSet_Gen.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg" - }, - "responses": { - "200": { - "body": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListByResourceGroup_MaximumSet_Gen.json deleted file mode 100644 index 8aeb9616b50a..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListByResourceGroup_MaximumSet_Gen.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - ], - "nextLink": "eisxspfvczpkjjgfpzdydcjrogc" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListBySubscription_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListBySubscription_MaximumSet_Gen.json deleted file mode 100644 index 21e9e6ebe463..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListBySubscription_MaximumSet_Gen.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "ulseeqylxb" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "kslguxrwbwkrj" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - ], - "nextLink": "eisxspfvczpkjjgfpzdydcjrogc" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Update_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Update_MaximumSet_Gen.json deleted file mode 100644 index 32e2b3e5c80d..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Update_MaximumSet_Gen.json +++ /dev/null @@ -1,89 +0,0 @@ -{ - "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "ulseeqylxb", - "resourceGroupName": "rgQumulo", - "fileSystemName": "nauwwbfoqehgbhdsmkewoboyxeqg", - "properties": { - "identity": { - "type": "None", - "userAssignedIdentities": { - "key4522": {} - } - }, - "tags": { - "key7534": "jsgqvqbagquvxowbrkanyhzvo" - }, - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "vjfirtaljehawmflyfianw", - "clusterLoginUrl": "adabmuthwrbjshzfbo", - "privateIPs": [ - "eugjqbaoucgjsopzfrq" - ] - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "marketplaceDetails": { - "marketplaceSubscriptionId": "ujrcqvxfnhxxheoth", - "planId": "x", - "offerId": "eiyhbmpwgezcmzrrfoiskuxlcvwojf", - "publisherId": "wfmokfdjbwpjhz", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" - }, - "provisioningState": "Accepted", - "userDetails": { - "email": "viptslwulnpaupfljvnjeq" - }, - "delegatedSubnetId": "neqctctqdmjezfgt", - "clusterLoginUrl": "jjqhgevy", - "privateIPs": [ - "eugjqbaoucgjsopzfrq" - ], - "storageSku": "Standard", - "initialCapacity": 9, - "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" - }, - "systemData": { - "createdBy": "mtdhqooysjhueaojwpmvophkgntl", - "createdByType": "User", - "createdAt": "2022-10-14T04:40:17.991Z", - "lastModifiedBy": "jcywglomzuamsxltnoegdrkzlscxl", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-10-14T04:40:17.991Z" - }, - "identity": { - "principalId": "11111111-1111-1111-1111-111111111111", - "tenantId": "11111111-1111-1111-1111-111111111111", - "type": "None", - "userAssignedIdentities": { - "key4522": { - "principalId": "11111111-1111-1111-1111-111111111111", - "clientId": "11111111-1111-1111-1111-111111111111" - } - } - }, - "tags": { - "key6565": "cgdhmupta" - }, - "location": "przdlsmlzsszphnixq", - "id": "tvelgpobdtazrweunifqzaxkgjauyx", - "name": "bii", - "type": "qtvxrqwpoistduq" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/Operations_List_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/Operations_List_MaximumSet_Gen.json deleted file mode 100644 index 83ad780508a5..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/Operations_List_MaximumSet_Gen.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2022-10-12-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "runmssufdtztqwcjrxyuyodlzbxidp", - "isDataAction": true, - "display": { - "provider": "e", - "resource": "cgzkjnfpkvddogcszpdn", - "operation": "fgyvgifprfxdgyqdbglrysjjsozm", - "description": "cnjdpucbtzreoihwdqnkprk" - }, - "origin": "user", - "actionType": "Internal" - } - ], - "nextLink": "mzpodd" - } - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/Operations_List_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/Operations_List_MinimumSet_Gen.json deleted file mode 100644 index 1f4353e91f85..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/Operations_List_MinimumSet_Gen.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "api-version": "2022-10-12-preview" - }, - "responses": { - "200": { - "body": {} - } - } -} diff --git a/specification/liftrqumulo/Qumulo.Management/main.cadl b/specification/liftrqumulo/Qumulo.Management/main.cadl deleted file mode 100644 index 2a589452176b..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/main.cadl +++ /dev/null @@ -1,179 +0,0 @@ -import "@cadl-lang/rest"; -import "@azure-tools/cadl-autorest"; -import "@cadl-lang/versioning"; -import "@azure-tools/cadl-azure-resource-manager"; -import "@azure-tools/cadl-providerhub"; - -using Cadl.Versioning; -using Azure.ResourceManager; -using Cadl.Http; -using Cadl.Rest; - -@armProviderNamespace -@service({title:"Qumulo.Storage"}) -@versionedDependency([[Versions.v2022_06_27_preview,Azure.ResourceManager.Versions.v1_0_Preview_1], [Versions.v2022_10_12_preview,Azure.ResourceManager.Versions.v1_0_Preview_1]]) -@versioned(Versions) -namespace Qumulo.Storage; - -@doc("Storage Sku") -enum StorageSku { - - @doc("Standard Storage Sku") - "Standard", - - @doc("Performance Storage Sku") - "Performance" -} - -#suppress "@azure-tools/typespec-azure-core/documentation-required" "https://github.com/Azure/typespec-azure/issues/3107" -enum Versions { - v2022_06_27_preview: "2022-06-27-preview", - v2022_10_12_preview: "2022-10-12-preview", -} - -@doc("Qumulo File System resource") -model FileSystemResource is TrackedResource { - - @key("fileSystemName") - @segment("fileSystems") - - @doc("Name of the storage resource") - name: string; - - ...ManagedServiceIdentity -} - -@armResourceOperations -interface FileSystems extends ResourceOperations { -} - -@doc("Properties specific to the Qumulo File System resource") -model FileSystemResourceProperties { - - @doc("Azure Subscription Id") - subscriptionId: string; - - @doc("Marketplace details") - marketplaceDetails? : MarketplaceDetails; - - @doc("Provisioning State of the resource") - provisioningState: ProvisioningState; - - @doc("User Details") - userDetails: UserDetails; - - @doc("Company Details") - companyDetails: CompanyDetails; - - @doc("Delegated subnet id for Vnet injection") - delegatedSubnetId: string; - - @doc("Qumulo admin dashboard Url") - clusterLoginUrl: string; - - @doc("List of eNIC IPs") - privateIPs: string[]; - - @added(Versions.v2022_10_12_preview) - @doc("Initial administrator password of the resource") - @secret - adminPassword: string; - - @added(Versions.v2022_10_12_preview) - @doc("Storage capacity in TB") - initialCapacity: int32; - - @added(Versions.v2022_10_12_preview) - @doc("Availability zone") - availabilityZone: string; - - @added(Versions.v2022_10_12_preview) - @doc("Storage Sku") - storageSku: StorageSku; -} - -@doc("MarketplaceDetails of Qumulo FileSystem resource") -model MarketplaceDetails{ - @doc("Marketplace Subscription Id") - marketplaceSubscriptionId: string; - - @doc("Plan Id") - planId: string; - - @doc("Offer Id") - offerId: string; - - @doc("Publisher Id") - publisherId: string; - - @doc("Marketplace subscription status") - marketplaceSubscriptionStatus: MarketplaceSubscriptionStatus; -} - -@doc("User Details of Qumulo FileSystem resource") -model UserDetails{ - - @doc("First name") - firstName?: string; - - @doc("Last name") - lastName?: string; - - @doc("User Email") - email: string; - - @doc("Alternate Email address") - alternateEmail?: string; - - @doc("UPN of user") - upn: string; - - @doc("Address of user") - address?: string; - - @doc("Contact phone number") - contactPhoneNumber?: string; -} - -@doc("Company details of Qumulo FileSystem resource") -model CompanyDetails{ - - @doc("Company name") - companyName: string; - - @doc("Office Address") - officeAddress?: string; - - @doc("Country of operation") - country: string; - - @doc("Domain of the company") - domain: string; - - @doc("Business of the company") - business?: string; - - @doc("Number of Employees") - numberOfEmployees: int32; -} - -@doc("Marketplace subscription status of the storage resource") -enum MarketplaceSubscriptionStatus{ - "PendingFulfillmentStart", - "Subscribed", - "Suspended", - "Unsubscribed", -} - -@doc("Provisioning State of the storage resource") -enum ProvisioningState { - "Accepted", - "Creating", - "Updating", - "Deleting", - "Succeeded", - "Failed", - "Canceled", - "Deleted", - "NotSpecified" -} diff --git a/specification/liftrqumulo/Qumulo.Management/package.json b/specification/liftrqumulo/Qumulo.Management/package.json deleted file mode 100644 index 7a8bd56fd1f7..000000000000 --- a/specification/liftrqumulo/Qumulo.Management/package.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "name": "cadl", - "version": "1.0.0", - "description": "npm packages required to run cadl", - "main": "index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "keywords": [], - "author": "", - "license": "ISC", - "dependencies": { - "@azure-tools/cadl-autorest": "^0.22.0", - "@azure-tools/cadl-azure-core": "^0.9.0", - "@azure-tools/cadl-azure-resource-manager": "^0.12.0", - "@azure-tools/cadl-providerhub": "^0.23.0", - "@cadl-lang/rest": "^0.19.0", - "@cadl-lang/versioning": "^0.10.0" - }, - "devDependencies": {} -} diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/LiftrBase.Storage/main.tsp b/specification/liftrqumulo/Qumulo.Storage.Management/LiftrBase.Storage/main.tsp new file mode 100644 index 000000000000..f651932a9915 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/LiftrBase.Storage/main.tsp @@ -0,0 +1,137 @@ +import "./../LiftrBase/main.tsp"; + +import "@typespec/openapi"; +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; + +using Azure.ResourceManager; +using LiftrBase; +using TypeSpec.Http; +using TypeSpec.OpenAPI; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using TypeSpec.Reflection; +using Azure.ResourceManager.Foundations; + +@versioned(LiftrBase.Storage.Versions) +@armLibraryNamespace +namespace LiftrBase.Storage; + +@doc("Supported versions for LiftrBase.Storage resource model") +enum Versions { + @doc("Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1 and LiftrBase.Versions.v1_preview") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(LiftrBase.Versions.v2_preview) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v3) + v2_preview: "2024-02-01-preview", +} + +/** + * Properties specific to the Qumulo File System resource + */ +model FileSystemResourceProperties { + /** + * Marketplace details + */ + marketplaceDetails: MarketplaceDetails; + + /** + * Provisioning State of the resource + */ + @visibility("read") + provisioningState?: ProvisioningState; + + /** + * Storage Sku + */ + storageSku: string; + + /** + * User Details + */ + userDetails: UserDetails; + + /** + * Delegated subnet id for Vnet injection + */ + delegatedSubnetId: string; + + /** + * File system Id of the resource + */ + clusterLoginUrl?: string; + + /** + * Private IPs of the resource + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is the correct name" + privateIPs?: string[]; + + /** + * Initial administrator password of the resource + */ + @extension("x-ms-secret", true) + adminPassword: string; + + /** + * Availability zone + */ + availabilityZone?: string; +} + +/** + * The type used for update operations of the FileSystemResource. + */ +model FileSystemResourceUpdate { + /** + * The managed service identities assigned to this resource. + */ + identity?: Azure.ResourceManager.CommonTypes.ManagedServiceIdentity; + + /** + * Resource tags. + */ + tags?: Record; + + /** + * The updatable properties of the FileSystemResource. + */ + properties?: FileSystemResourceUpdateProperties; +} + +/** + * The updatable properties of the FileSystemResource. + */ +model FileSystemResourceUpdateProperties { + /** + * Marketplace details + */ + marketplaceDetails?: MarketplaceDetails; + + /** + * User Details + */ + userDetails?: UserDetails; + + /** + * Delegated subnet id for Vnet injection + */ + delegatedSubnetId?: string; +} + +@Azure.ResourceManager.Private.armResourceInternal(FileSystemResourceProperties) +model FileSystemResource + is Azure.ResourceManager.TrackedResource { + /** + * Name of the File System resource + */ + @path + @key("fileSystemName") + @segment("fileSystems") + @visibility("read") + @pattern("^[a-zA-Z0-9_-]*$") + name: string; + + ...Azure.ResourceManager.ManagedServiceIdentityProperty; +} diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/LiftrBase/main.tsp b/specification/liftrqumulo/Qumulo.Storage.Management/LiftrBase/main.tsp new file mode 100644 index 000000000000..02ba7a0b9f24 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/LiftrBase/main.tsp @@ -0,0 +1,139 @@ +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; +using TypeSpec.Reflection; +using TypeSpec.OpenAPI; + +@versioned(LiftrBase.Versions) +namespace LiftrBase; + +@doc("Supported versions for LiftrBase resource model") +enum Versions { + @doc("Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v3) + v2_preview: "2024-02-01-preview", +} + +/** + * Marketplace subscription status of the file system resource + */ +union MarketplaceSubscriptionStatus { + /** + * Fulfillment has not started + */ + PendingFulfillmentStart: "PendingFulfillmentStart", + + /** + * Marketplace offer is subscribed + */ + Subscribed: "Subscribed", + + /** + * Marketplace offer is suspended because of non payment + */ + Suspended: "Suspended", + + /** + * Marketplace offer is unsubscribed + */ + Unsubscribed: "Unsubscribed", + + string, +} + +@doc("MarketplaceDetails of Qumulo FileSystem resource") +model MarketplaceDetails { + /** + * Marketplace Subscription Id + */ + marketplaceSubscriptionId?: string; + + /** + * Plan Id + */ + planId: string; + + /** + * Offer Id + */ + offerId: string; + + /** + * Publisher Id + */ + publisherId?: string; + + /** + * Term Unit + */ + termUnit?: string; + + /** + * Marketplace subscription status + */ + @visibility("read") + marketplaceSubscriptionStatus?: MarketplaceSubscriptionStatus; +} + +@doc("User Details of Qumulo FileSystem resource") +model UserDetails { + /** + * User Email + */ + @extension("x-ms-secret", true) + email: string; +} + +/** + * Provisioning State of the File system resource + */ +union ProvisioningState { + /** + * File system resource creation request accepted + */ + Accepted: "Accepted", + + /** + * File system resource creation started + */ + Creating: "Creating", + + /** + * File system resource is being updated + */ + Updating: "Updating", + + /** + * File system resource deletion started + */ + Deleting: "Deleting", + + /** + * File system resource creation successful + */ + Succeeded: "Succeeded", + + /** + * File system resource creation failed + */ + Failed: "Failed", + + /** + * File system resource creation canceled + */ + Canceled: "Canceled", + + /** + * File system resource is deleted + */ + Deleted: "Deleted", + + string, +} diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a5033a3a8a9 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,147 @@ +{ + "title": "FileSystems_CreateOrUpdate", + "operationId": "FileSystems_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "hfcmtgaes", + "resource": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "storageSku": "yhyzby", + "userDetails": { + "email": "aqsnzyroo" + }, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "adminPassword": "fakeTestSecretPlaceholder", + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "key7679": {} + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 10, + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_CreateOrUpdate_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_CreateOrUpdate_MinimumSet_Gen.json similarity index 65% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_CreateOrUpdate_MinimumSet_Gen.json rename to specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_CreateOrUpdate_MinimumSet_Gen.json index c84801309bb5..53811b13e3cd 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_CreateOrUpdate_MinimumSet_Gen.json +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_CreateOrUpdate_MinimumSet_Gen.json @@ -1,77 +1,71 @@ { "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "aaaaaaaaaaaaaaaaaaaaaaaa", - "resourceGroupName": "rgopenapi", + "api-version": "2024-06-19", "fileSystemName": "aaaaaaaa", "resource": { + "location": "aaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "adminPassword": "fakeTestSecretPlaceholder", + "delegatedSubnetId": "aaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaa", - "planId": "aaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaa", - "publisherId": "aa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaa" }, - "provisioningState": "Accepted", - "userDetails": { - "email": "aaaaaaaaaaaaaaaaaaaaaaa" - }, - "delegatedSubnetId": "aaaaaaaaaa", - "adminPassword": "ekceujoecaashtjlsgcymnrdozk", "storageSku": "Standard", - "initialCapacity": 9 - }, - "location": "aaaaaaaaaaaaaaaaaaaaaaaaa" - } + "userDetails": { + "email": "viptslwulnpaupfljvnjeq" + } + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "aaaaaaaaaaaaaaaaaaaaaaaa" }, "responses": { - "201": { - "headers": { - "Azure-AsyncOperation": "https://foo.com/operationstatus" - }, + "200": { "body": { "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaa", - "planId": "aaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaa", - "publisherId": "aa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaa", + "publisherId": "aa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aaaaaaaaaaaaaaaaaaaaaaa" - }, - "delegatedSubnetId": "aaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "location": "aaaaaaaaa" + "userDetails": {} + } } }, - "200": { + "201": { "body": { "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaa", - "planId": "aaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaa", - "publisherId": "aa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaa", + "publisherId": "aa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aaaaaaaaaaaaaaaaaaaaaaa" - }, - "delegatedSubnetId": "aaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "location": "aaaaaaaaa" + "userDetails": {} + } + }, + "headers": { + "Retry-After": 10, + "Azure-AsyncOperation": "https://foo.com/operationstatus" } } - } + }, + "operationId": "FileSystems_CreateOrUpdate", + "title": "FileSystems_CreateOrUpdate_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Delete_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..ad1724124896 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "FileSystems_Delete", + "operationId": "FileSystems_Delete", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "xoschzkccroahrykedlvbbnsddq" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10, + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Delete_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..d28e0ae5ed92 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Delete_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "FileSystems_Delete_MinimumSet_Gen", + "operationId": "FileSystems_Delete", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "jgtskkiplquyrlkaxvhdg" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10, + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Get_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..5b60318e3d84 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Get_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "FileSystems_Get", + "operationId": "FileSystems_Get", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "sihbehcisdqtqqyfiewiiaphgh" + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Update_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Get_MinimumSet_Gen.json similarity index 65% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Update_MinimumSet_Gen.json rename to specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Get_MinimumSet_Gen.json index 9ab01d911d49..d24f92bc0333 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Update_MinimumSet_Gen.json +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Get_MinimumSet_Gen.json @@ -1,33 +1,32 @@ { "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "aaaaaaa", - "resourceGroupName": "rgQumulo", + "api-version": "2024-06-19", "fileSystemName": "aaaaaaaaaaaaaaaaa", - "properties": {} + "resourceGroupName": "rgQumulo", + "subscriptionId": "aaaaaaa" }, "responses": { "200": { "body": { + "name": "aaaaa", + "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaaaaaa", - "planId": "aaaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaa", - "publisherId": "aaaaaaaaaaaaaaaaaaaa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaaa", + "termUnit": "zxv" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aa" - }, - "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "name": "aaaaa", - "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "userDetails": {} + } } } - } + }, + "operationId": "FileSystems_Get", + "title": "FileSystems_Get_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..bbecaa117da0 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "FileSystems_ListByResourceGroup", + "operationId": "FileSystems_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListByResourceGroup_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListByResourceGroup_MinimumSet_Gen.json similarity index 60% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListByResourceGroup_MinimumSet_Gen.json rename to specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListByResourceGroup_MinimumSet_Gen.json index 4476c487281b..835ecfb71204 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListByResourceGroup_MinimumSet_Gen.json +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListByResourceGroup_MinimumSet_Gen.json @@ -1,36 +1,34 @@ { "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "aaaaaaa", - "resourceGroupName": "rgQumulo" + "api-version": "2024-06-19", + "resourceGroupName": "rgQumulo", + "subscriptionId": "aaaaaaa" }, "responses": { "200": { "body": { "value": [ { + "name": "aaaaa", "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaaaaaa", - "planId": "aaaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaa", - "publisherId": "aaaaaaaaaaaaaaaaaaaa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaaa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aa" - }, - "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "name": "aaaaa", - "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "userDetails": {} + } } ] } } - } + }, + "operationId": "FileSystems_ListByResourceGroup", + "title": "FileSystems_ListByResourceGroup_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListBySubscription_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..2b22140e5c1f --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "FileSystems_ListBySubscription", + "operationId": "FileSystems_ListBySubscription", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListBySubscription_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListBySubscription_MinimumSet_Gen.json similarity index 66% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListBySubscription_MinimumSet_Gen.json rename to specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListBySubscription_MinimumSet_Gen.json index 711edba5404f..4a9979aab1c9 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_ListBySubscription_MinimumSet_Gen.json +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_ListBySubscription_MinimumSet_Gen.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-12-preview", + "api-version": "2024-06-19", "subscriptionId": "aaaaaaa" }, "responses": { @@ -8,28 +8,26 @@ "body": { "value": [ { + "name": "aaaaa", "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaaaaaa", - "planId": "aaaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaa", - "publisherId": "aaaaaaaaaaaaaaaaaaaa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaaa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aa" - }, - "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "name": "aaaaa", - "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "userDetails": {} + } } ] } } - } + }, + "operationId": "FileSystems_ListBySubscription", + "title": "FileSystems_ListBySubscription_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Update_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..c14f02923019 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Update_MaximumSet_Gen.json @@ -0,0 +1,86 @@ +{ + "title": "FileSystems_Update", + "operationId": "FileSystems_Update", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "ahpixnvykleksjlr", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key7679": {} + } + }, + "tags": { + "key357": "ztkkvhfia" + }, + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "userDetails": { + "email": "aqsnzyroo" + }, + "delegatedSubnetId": "bqaryqsjlackxphpmzffgoqsvm" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Get_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Update_MinimumSet_Gen.json similarity index 56% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Get_MinimumSet_Gen.json rename to specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Update_MinimumSet_Gen.json index f38618a893af..2199c9f27d4d 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Get_MinimumSet_Gen.json +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/FileSystems_Update_MinimumSet_Gen.json @@ -1,33 +1,31 @@ { "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "aaaaaaa", + "api-version": "2024-06-19", + "fileSystemName": "aaaaaaaaaaaaaaaaa", + "properties": {}, "resourceGroupName": "rgQumulo", - "fileSystemName": "aaaaaaaaaaaaaaaaa" + "subscriptionId": "aaaaaaa" }, "responses": { "200": { "body": { - "id": "aaaaaaaaaaaaaaaaa", + "name": "aaaaa", + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaaaaaa", - "planId": "aaaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaa", - "publisherId": "aaaaaaaaaaaaaaaaaaaa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaaa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aa" - }, - "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "name": "aaaaa", - "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "userDetails": {} + } } } - } + }, + "operationId": "FileSystems_Update", + "title": "FileSystems_Update_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/Operations_List_MaximumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..1eb2670e6c1f --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "melhpzamnyx", + "isDataAction": true, + "display": { + "provider": "ilyrhd", + "resource": "vjz", + "operation": "ayfoeuuyhtwjafroqzimyujr", + "description": "vodhl" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "vxtunikmzmz" + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/Operations_List_MinimumSet_Gen.json b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..4f4302e48074 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/examples/2024-06-19/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MinimumSet_Gen", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-19" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/main.tsp b/specification/liftrqumulo/Qumulo.Storage.Management/main.tsp new file mode 100644 index 000000000000..2719ae4e0cc8 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/main.tsp @@ -0,0 +1,95 @@ +import "./LiftrBase.Storage/main.tsp"; + +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.OpenAPI; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +using LiftrBase.Storage; +using LiftrBase; + +@armProviderNamespace +@useLibraryNamespace(LiftrBase.Storage) +@service({ + title: "Qumulo.Storage", +}) +@versioned(Versions) +namespace Qumulo.Storage; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2024-06-19 Stable API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(LiftrBase.Versions.v2_preview) + @useDependency(LiftrBase.Storage.Versions.v2_preview) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v3) + v2_stable: "2024-06-19", +} + +interface Operations extends Azure.ResourceManager.Operations {} + +@armResourceOperations +interface FileSystems { + /** + * Get a FileSystemResource + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("FileSystems_Get") + get is ArmResourceRead; + + /** + * Create a FileSystemResource + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("FileSystems_CreateOrUpdate") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + FileSystemResource, + BaseParameters, + ArmAsyncOperationHeader & Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * Update a FileSystemResource + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @parameterVisibility + @operationId("FileSystems_Update") + update is ArmCustomPatchSync; + + /** + * Delete a FileSystemResource + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("FileSystems_Delete") + delete is ArmResourceDeleteWithoutOkAsync< + FileSystemResource, + BaseParameters, + ArmCombinedLroHeaders & Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * List FileSystemResource resources by resource group + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("FileSystems_ListByResourceGroup") + listByResourceGroup is ArmResourceListByParent; + + /** + * List FileSystemResource resources by subscription ID + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("FileSystems_ListBySubscription") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml b/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml new file mode 100644 index 000000000000..1934664bb598 --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/Qumulo.Storage.json" + examples-directory: "{project-root}/examples" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json index 83d7b455a14b..605fc541f461 100644 --- a/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json @@ -22,7 +22,7 @@ "privateIPs": [ "kslguxrwbwkrj" ], - "adminPassword": "ekceujoecaashtjlsgcymnrdozk", + "adminPassword": "fakeTestSecretPlaceholder", "storageSku": "Standard", "initialCapacity": 9, "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json index 8e5bb670ce51..fb3681f0ef7f 100644 --- a/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json @@ -15,10 +15,10 @@ }, "provisioningState": "Accepted", "userDetails": { - "email": "aaaaaaaaaaaaaaaaaaaaaaa" + "email": "viptslwulnpaupfljvnjeq" }, "delegatedSubnetId": "aaaaaaaaaa", - "adminPassword": "ekceujoecaashtjlsgcymnrdozk", + "adminPassword": "fakeTestSecretPlaceholder", "storageSku": "Standard", "initialCapacity": 9 }, diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_Update_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_Update_MaximumSet_Gen.json index acded1b38245..63bf8a770f81 100644 --- a/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_Update_MaximumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/preview/2022-10-12-preview/examples/FileSystems_Update_MaximumSet_Gen.json @@ -23,7 +23,7 @@ "marketplaceSubscriptionStatus": "PendingFulfillmentStart" }, "userDetails": { - "email": "viptslwulnpaupfljvnjeq" + "email": "aa" }, "delegatedSubnetId": "vjfirtaljehawmflyfianw", "clusterLoginUrl": "adabmuthwrbjshzfbo", diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2022-10-12/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2022-10-12/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json index d7c51ac8fb36..53305907f1ca 100644 --- a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2022-10-12/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2022-10-12/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json @@ -22,7 +22,7 @@ "privateIPs": [ "kslguxrwbwkrj" ], - "adminPassword": "ekceujoecaashtjlsgcymnrdozk", + "adminPassword": "fakeTestSecretPlaceholder", "storageSku": "Standard", "initialCapacity": 9, "availabilityZone": "maseyqhlnhoiwbabcqabtedbjpip" diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2022-10-12/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2022-10-12/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json index deebbcd793b1..e706084b3a6c 100644 --- a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2022-10-12/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2022-10-12/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json @@ -18,7 +18,7 @@ "email": "viptslwulnpaupfljvnjeq" }, "delegatedSubnetId": "aaaaaaaaaa", - "adminPassword": "ekceujoecaashtjlsgcymnrdozk", + "adminPassword": "fakeTestSecretPlaceholder", "storageSku": "Standard", "initialCapacity": 9 }, diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/Qumulo.Storage.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/Qumulo.Storage.json new file mode 100644 index 000000000000..d9d171c9c8fb --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/Qumulo.Storage.json @@ -0,0 +1,712 @@ +{ + "swagger": "2.0", + "info": { + "title": "Qumulo.Storage", + "version": "2024-06-19", + "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": "FileSystems" + } + ], + "paths": { + "/providers/Qumulo.Storage/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Qumulo.Storage/fileSystems": { + "get": { + "operationId": "FileSystems_ListBySubscription", + "tags": [ + "FileSystems" + ], + "description": "List FileSystemResource resources by subscription ID", + "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/FileSystemResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FileSystems_ListBySubscription": { + "$ref": "./examples/FileSystems_ListBySubscription_MaximumSet_Gen.json" + }, + "FileSystems_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/FileSystems_ListBySubscription_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Qumulo.Storage/fileSystems": { + "get": { + "operationId": "FileSystems_ListByResourceGroup", + "tags": [ + "FileSystems" + ], + "description": "List FileSystemResource resources by 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": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FileSystemResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FileSystems_ListByResourceGroup": { + "$ref": "./examples/FileSystems_ListByResourceGroup_MaximumSet_Gen.json" + }, + "FileSystems_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/FileSystems_ListByResourceGroup_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Qumulo.Storage/fileSystems/{fileSystemName}": { + "get": { + "operationId": "FileSystems_Get", + "tags": [ + "FileSystems" + ], + "description": "Get a FileSystemResource", + "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": "fileSystemName", + "in": "path", + "description": "Name of the File System resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LiftrBase.Storage.FileSystemResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FileSystems_Get": { + "$ref": "./examples/FileSystems_Get_MaximumSet_Gen.json" + }, + "FileSystems_Get_MinimumSet_Gen": { + "$ref": "./examples/FileSystems_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "FileSystems_CreateOrUpdate", + "tags": [ + "FileSystems" + ], + "description": "Create a FileSystemResource", + "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": "fileSystemName", + "in": "path", + "description": "Name of the File System resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]*$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LiftrBase.Storage.FileSystemResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'FileSystemResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/LiftrBase.Storage.FileSystemResource" + } + }, + "201": { + "description": "Resource 'FileSystemResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/LiftrBase.Storage.FileSystemResource" + }, + "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": { + "FileSystems_CreateOrUpdate": { + "$ref": "./examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json" + }, + "FileSystems_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "FileSystems_Update", + "tags": [ + "FileSystems" + ], + "description": "Update a FileSystemResource", + "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": "fileSystemName", + "in": "path", + "description": "Name of the File System resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]*$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LiftrBase.Storage.FileSystemResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LiftrBase.Storage.FileSystemResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FileSystems_Update": { + "$ref": "./examples/FileSystems_Update_MaximumSet_Gen.json" + }, + "FileSystems_Update_MinimumSet_Gen": { + "$ref": "./examples/FileSystems_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "FileSystems_Delete", + "tags": [ + "FileSystems" + ], + "description": "Delete a FileSystemResource", + "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": "fileSystemName", + "in": "path", + "description": "Name of the File System resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "A link to the status monitor" + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FileSystems_Delete": { + "$ref": "./examples/FileSystems_Delete_MaximumSet_Gen.json" + }, + "FileSystems_Delete_MinimumSet_Gen": { + "$ref": "./examples/FileSystems_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "FileSystemResourceListResult": { + "type": "object", + "description": "The response of a FileSystemResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The FileSystemResource items on this page", + "items": { + "$ref": "#/definitions/LiftrBase.Storage.FileSystemResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LiftrBase.MarketplaceDetails": { + "type": "object", + "description": "MarketplaceDetails of Qumulo FileSystem resource", + "properties": { + "marketplaceSubscriptionId": { + "type": "string", + "description": "Marketplace Subscription Id" + }, + "planId": { + "type": "string", + "description": "Plan Id" + }, + "offerId": { + "type": "string", + "description": "Offer Id" + }, + "publisherId": { + "type": "string", + "description": "Publisher Id" + }, + "termUnit": { + "type": "string", + "description": "Term Unit" + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/LiftrBase.MarketplaceSubscriptionStatus", + "description": "Marketplace subscription status", + "readOnly": true + } + }, + "required": [ + "planId", + "offerId" + ] + }, + "LiftrBase.MarketplaceSubscriptionStatus": { + "type": "string", + "description": "Marketplace subscription status of the file system resource", + "enum": [ + "PendingFulfillmentStart", + "Subscribed", + "Suspended", + "Unsubscribed" + ], + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, + "values": [ + { + "name": "PendingFulfillmentStart", + "value": "PendingFulfillmentStart", + "description": "Fulfillment has not started" + }, + { + "name": "Subscribed", + "value": "Subscribed", + "description": "Marketplace offer is subscribed" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "Marketplace offer is suspended because of non payment" + }, + { + "name": "Unsubscribed", + "value": "Unsubscribed", + "description": "Marketplace offer is unsubscribed" + } + ] + } + }, + "LiftrBase.ProvisioningState": { + "type": "string", + "description": "Provisioning State of the File system resource", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted", + "description": "File system resource creation request accepted" + }, + { + "name": "Creating", + "value": "Creating", + "description": "File system resource creation started" + }, + { + "name": "Updating", + "value": "Updating", + "description": "File system resource is being updated" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "File system resource deletion started" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "File system resource creation successful" + }, + { + "name": "Failed", + "value": "Failed", + "description": "File system resource creation failed" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "File system resource creation canceled" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "File system resource is deleted" + } + ] + }, + "readOnly": true + }, + "LiftrBase.Storage.FileSystemResource": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/LiftrBase.Storage.FileSystemResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "LiftrBase.Storage.FileSystemResourceProperties": { + "type": "object", + "description": "Properties specific to the Qumulo File System resource", + "properties": { + "marketplaceDetails": { + "$ref": "#/definitions/LiftrBase.MarketplaceDetails", + "description": "Marketplace details" + }, + "provisioningState": { + "$ref": "#/definitions/LiftrBase.ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + }, + "storageSku": { + "type": "string", + "description": "Storage Sku" + }, + "userDetails": { + "$ref": "#/definitions/LiftrBase.UserDetails", + "description": "User Details" + }, + "delegatedSubnetId": { + "type": "string", + "description": "Delegated subnet id for Vnet injection" + }, + "clusterLoginUrl": { + "type": "string", + "description": "File system Id of the resource" + }, + "privateIPs": { + "type": "array", + "description": "Private IPs of the resource", + "items": { + "type": "string" + } + }, + "adminPassword": { + "type": "string", + "description": "Initial administrator password of the resource", + "x-ms-secret": true + }, + "availabilityZone": { + "type": "string", + "description": "Availability zone" + } + }, + "required": [ + "marketplaceDetails", + "storageSku", + "userDetails", + "delegatedSubnetId", + "adminPassword" + ] + }, + "LiftrBase.Storage.FileSystemResourceUpdate": { + "type": "object", + "description": "The type used for update operations of the FileSystemResource.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/LiftrBase.Storage.FileSystemResourceUpdateProperties", + "description": "The updatable properties of the FileSystemResource." + } + } + }, + "LiftrBase.Storage.FileSystemResourceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the FileSystemResource.", + "properties": { + "marketplaceDetails": { + "$ref": "#/definitions/LiftrBase.MarketplaceDetails", + "description": "Marketplace details" + }, + "userDetails": { + "$ref": "#/definitions/LiftrBase.UserDetails", + "description": "User Details" + }, + "delegatedSubnetId": { + "type": "string", + "description": "Delegated subnet id for Vnet injection" + } + } + }, + "LiftrBase.UserDetails": { + "type": "object", + "description": "User Details of Qumulo FileSystem resource", + "properties": { + "email": { + "type": "string", + "description": "User Email", + "x-ms-secret": true + } + }, + "required": [ + "email" + ] + } + }, + "parameters": {} +} diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a5033a3a8a9 --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,147 @@ +{ + "title": "FileSystems_CreateOrUpdate", + "operationId": "FileSystems_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "hfcmtgaes", + "resource": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "storageSku": "yhyzby", + "userDetails": { + "email": "aqsnzyroo" + }, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "adminPassword": "fakeTestSecretPlaceholder", + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "key7679": {} + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 10, + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_CreateOrUpdate_MinimumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json similarity index 65% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_CreateOrUpdate_MinimumSet_Gen.json rename to specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json index e0d9ae260b41..53811b13e3cd 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_CreateOrUpdate_MinimumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_CreateOrUpdate_MinimumSet_Gen.json @@ -1,77 +1,71 @@ { "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "aaaaaaaaaaaaaaaaaaaaaaaa", - "resourceGroupName": "rgopenapi", + "api-version": "2024-06-19", "fileSystemName": "aaaaaaaa", "resource": { + "location": "aaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "adminPassword": "fakeTestSecretPlaceholder", + "delegatedSubnetId": "aaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaa", - "planId": "aaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaa", - "publisherId": "aa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaa" }, - "provisioningState": "Accepted", - "userDetails": { - "email": "aaaaaaaaaaaaaaaaaaaaaaa" - }, - "delegatedSubnetId": "aaaaaaaaaa", - "adminPassword": "ekceujoecaashtjlsgcymnrdozk", "storageSku": "Standard", - "initialCapacity": 9 - }, - "location": "aaaaaaaaaaaaaaaaaaaaaaaaa" - } + "userDetails": { + "email": "viptslwulnpaupfljvnjeq" + } + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "aaaaaaaaaaaaaaaaaaaaaaaa" }, "responses": { - "201": { - "headers": { - "Azure-AsyncOperation": "https://foo.com/operationstatus" - }, + "200": { "body": { "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaa", - "planId": "aaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaa", - "publisherId": "aa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaa", + "publisherId": "aa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aaaaaaaaaaaaaaaaaaaaaaa" - }, - "delegatedSubnetId": "aaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "location": "aaaaaaaaa" + "userDetails": {} + } } }, - "200": { + "201": { "body": { "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaa", - "planId": "aaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaa", - "publisherId": "aa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaa", + "publisherId": "aa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aaaaaaaaaaaaaaaaaaaaaaa" - }, - "delegatedSubnetId": "aaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "location": "aaaaaaaaa" + "userDetails": {} + } + }, + "headers": { + "Retry-After": 10, + "Azure-AsyncOperation": "https://foo.com/operationstatus" } } - } + }, + "operationId": "FileSystems_CreateOrUpdate", + "title": "FileSystems_CreateOrUpdate_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Delete_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..ad1724124896 --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "FileSystems_Delete", + "operationId": "FileSystems_Delete", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "xoschzkccroahrykedlvbbnsddq" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10, + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Delete_MinimumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..d28e0ae5ed92 --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Delete_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "FileSystems_Delete_MinimumSet_Gen", + "operationId": "FileSystems_Delete", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "jgtskkiplquyrlkaxvhdg" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10, + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Get_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..5b60318e3d84 --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Get_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "FileSystems_Get", + "operationId": "FileSystems_Get", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "sihbehcisdqtqqyfiewiiaphgh" + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Update_MinimumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Get_MinimumSet_Gen.json similarity index 65% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Update_MinimumSet_Gen.json rename to specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Get_MinimumSet_Gen.json index 22303fc8ee85..d24f92bc0333 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_Update_MinimumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Get_MinimumSet_Gen.json @@ -1,33 +1,32 @@ { "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "aaaaaaa", - "resourceGroupName": "rgQumulo", + "api-version": "2024-06-19", "fileSystemName": "aaaaaaaaaaaaaaaaa", - "properties": {} + "resourceGroupName": "rgQumulo", + "subscriptionId": "aaaaaaa" }, "responses": { "200": { "body": { + "name": "aaaaa", + "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaaaaaa", - "planId": "aaaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaa", - "publisherId": "aaaaaaaaaaaaaaaaaaaa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaaa", + "termUnit": "zxv" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aa" - }, - "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "name": "aaaaa", - "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "userDetails": {} + } } } - } + }, + "operationId": "FileSystems_Get", + "title": "FileSystems_Get_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..bbecaa117da0 --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "FileSystems_ListByResourceGroup", + "operationId": "FileSystems_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListByResourceGroup_MinimumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListByResourceGroup_MinimumSet_Gen.json similarity index 60% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListByResourceGroup_MinimumSet_Gen.json rename to specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListByResourceGroup_MinimumSet_Gen.json index e6116376ca5d..835ecfb71204 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListByResourceGroup_MinimumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListByResourceGroup_MinimumSet_Gen.json @@ -1,36 +1,34 @@ { "parameters": { - "api-version": "2022-06-27-preview", - "subscriptionId": "aaaaaaa", - "resourceGroupName": "rgQumulo" + "api-version": "2024-06-19", + "resourceGroupName": "rgQumulo", + "subscriptionId": "aaaaaaa" }, "responses": { "200": { "body": { "value": [ { + "name": "aaaaa", "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaaaaaa", - "planId": "aaaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaa", - "publisherId": "aaaaaaaaaaaaaaaaaaaa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaaa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aa" - }, - "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "name": "aaaaa", - "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "userDetails": {} + } } ] } } - } + }, + "operationId": "FileSystems_ListByResourceGroup", + "title": "FileSystems_ListByResourceGroup_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListBySubscription_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..2b22140e5c1f --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "FileSystems_ListBySubscription", + "operationId": "FileSystems_ListBySubscription", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListBySubscription_MinimumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListBySubscription_MinimumSet_Gen.json similarity index 66% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListBySubscription_MinimumSet_Gen.json rename to specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListBySubscription_MinimumSet_Gen.json index 6b2db1406e1a..4a9979aab1c9 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-06-27-preview/FileSystems_ListBySubscription_MinimumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_ListBySubscription_MinimumSet_Gen.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-06-27-preview", + "api-version": "2024-06-19", "subscriptionId": "aaaaaaa" }, "responses": { @@ -8,28 +8,26 @@ "body": { "value": [ { + "name": "aaaaa", "id": "aaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaaaaaa", - "planId": "aaaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaa", - "publisherId": "aaaaaaaaaaaaaaaaaaaa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaaa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aa" - }, - "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "name": "aaaaa", - "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "userDetails": {} + } } ] } } - } + }, + "operationId": "FileSystems_ListBySubscription", + "title": "FileSystems_ListBySubscription_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Update_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..c14f02923019 --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Update_MaximumSet_Gen.json @@ -0,0 +1,86 @@ +{ + "title": "FileSystems_Update", + "operationId": "FileSystems_Update", + "parameters": { + "api-version": "2024-06-19", + "subscriptionId": "382E8C7A-AC80-4D70-8580-EFE99537B9B7", + "resourceGroupName": "rgQumulo", + "fileSystemName": "ahpixnvykleksjlr", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key7679": {} + } + }, + "tags": { + "key357": "ztkkvhfia" + }, + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "userDetails": { + "email": "aqsnzyroo" + }, + "delegatedSubnetId": "bqaryqsjlackxphpmzffgoqsvm" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "marketplaceSubscriptionId": "xaqtkloiyovmexqhn", + "planId": "fwtpz", + "offerId": "s", + "publisherId": "czxcfrwodazyaft", + "termUnit": "cfwwczmygsimcyvoclcw", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + }, + "provisioningState": "Accepted", + "storageSku": "yhyzby", + "userDetails": {}, + "delegatedSubnetId": "jykmxrf", + "clusterLoginUrl": "ykaynsjvhihdthkkvvodjrgc", + "privateIPs": [ + "gzken" + ], + "availabilityZone": "eqdvbdiuwmhhzqzmksmwllpddqquwt" + }, + "identity": { + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "11111111-1111-1111-1111-111111111111", + "type": "None", + "userAssignedIdentities": { + "key7679": { + "principalId": "11111111-1111-1111-1111-111111111111", + "clientId": "11111111-1111-1111-1111-111111111111" + } + } + }, + "tags": { + "key7090": "rurrdiaqp" + }, + "location": "pnb", + "id": "rfta", + "name": "stftolw", + "type": "wj", + "systemData": { + "createdBy": "usnkckwkizihezb", + "createdByType": "User", + "createdAt": "2024-03-21T08:11:54.895Z", + "lastModifiedBy": "yjsiqdgtsmycxlncjceemlucn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-03-21T08:11:54.895Z" + } + } + } + } +} diff --git a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Get_MinimumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Update_MinimumSet_Gen.json similarity index 56% rename from specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Get_MinimumSet_Gen.json rename to specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Update_MinimumSet_Gen.json index 955c42bb3e19..2199c9f27d4d 100644 --- a/specification/liftrqumulo/Qumulo.Management/examples/2022-10-12-preview/FileSystems_Get_MinimumSet_Gen.json +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/FileSystems_Update_MinimumSet_Gen.json @@ -1,33 +1,31 @@ { "parameters": { - "api-version": "2022-10-12-preview", - "subscriptionId": "aaaaaaa", + "api-version": "2024-06-19", + "fileSystemName": "aaaaaaaaaaaaaaaaa", + "properties": {}, "resourceGroupName": "rgQumulo", - "fileSystemName": "aaaaaaaaaaaaaaaaa" + "subscriptionId": "aaaaaaa" }, "responses": { "200": { "body": { - "id": "aaaaaaaaaaaaaaaaa", + "name": "aaaaa", + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", "properties": { + "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "marketplaceDetails": { "marketplaceSubscriptionId": "aaaaaaaaaaaaaaaaa", - "planId": "aaaaaaa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", "offerId": "aaaaaaaaa", - "publisherId": "aaaaaaaaaaaaaaaaaaaa", - "marketplaceSubscriptionStatus": "PendingFulfillmentStart" + "planId": "aaaaaaa" }, "provisioningState": "Accepted", - "userDetails": { - "email": "aa" - }, - "delegatedSubnetId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "storageSku": "Standard", - "initialCapacity": 9 - }, - "name": "aaaaa", - "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "userDetails": {} + } } } - } + }, + "operationId": "FileSystems_Update", + "title": "FileSystems_Update_MinimumSet_Gen" } diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/Operations_List_MaximumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..1eb2670e6c1f --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "melhpzamnyx", + "isDataAction": true, + "display": { + "provider": "ilyrhd", + "resource": "vjz", + "operation": "ayfoeuuyhtwjafroqzimyujr", + "description": "vodhl" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "vxtunikmzmz" + } + } + } +} diff --git a/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/Operations_List_MinimumSet_Gen.json b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..4f4302e48074 --- /dev/null +++ b/specification/liftrqumulo/resource-manager/Qumulo.Storage/stable/2024-06-19/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MinimumSet_Gen", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-19" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/liftrqumulo/resource-manager/readme.go.md b/specification/liftrqumulo/resource-manager/readme.go.md index 6b8f28b1d784..0a58d895d454 100644 --- a/specification/liftrqumulo/resource-manager/readme.go.md +++ b/specification/liftrqumulo/resource-manager/readme.go.md @@ -8,4 +8,29 @@ module-name: sdk/resourcemanager/liftrqumulo/armqumulo module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true +directive: + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceUpdate' + to: FileSystemResourceUpdate + - rename-model: + from: 'LiftrBase.Storage.FileSystemResource' + to: FileSystemResource + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceUpdateProperties' + to: FileSystemResourceUpdateProperties + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceProperties' + to: FileSystemResourceProperties + - rename-model: + from: 'LiftrBase.MarketplaceDetails' + to: MarketplaceDetails + - rename-model: + from: 'LiftrBase.MarketplaceSubscriptionStatus' + to: MarketplaceSubscriptionStatus + - rename-model: + from: 'LiftrBase.UserDetails' + to: UserDetails + - rename-model: + from: 'LiftrBase.ProvisioningState' + to: ProvisioningState ``` \ No newline at end of file diff --git a/specification/liftrqumulo/resource-manager/readme.md b/specification/liftrqumulo/resource-manager/readme.md index b39953c48b64..f7cd7746a285 100644 --- a/specification/liftrqumulo/resource-manager/readme.md +++ b/specification/liftrqumulo/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the Qumulo.Storage. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2022-10 +tag: package-2024-06-19 ``` @@ -57,6 +57,15 @@ input-file: - Qumulo.Storage/preview/2022-10-12-preview/Qumulo.Storage.json ``` +### Tag: package-2024-06-19 + +These settings apply only when `--tag=package-2024-06-19` is specified on the command line. + +``` yaml $(tag) == 'package-2024-06-19' +input-file: + - Qumulo.Storage/stable/2024-06-19/Qumulo.Storage.json +``` + --- # Code Generation diff --git a/specification/liftrqumulo/resource-manager/readme.typescript.md b/specification/liftrqumulo/resource-manager/readme.typescript.md index 3a02e4bea4c1..d76e0cab6129 100644 --- a/specification/liftrqumulo/resource-manager/readme.typescript.md +++ b/specification/liftrqumulo/resource-manager/readme.typescript.md @@ -10,4 +10,30 @@ typescript: output-folder: "$(typescript-sdks-folder)/sdk/liftrqumulo/arm-qumulo" payload-flattening-threshold: 1 generate-metadata: true + +directive: + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceUpdate' + to: FileSystemResourceUpdate + - rename-model: + from: 'LiftrBase.Storage.FileSystemResource' + to: FileSystemResource + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceUpdateProperties' + to: FileSystemResourceUpdateProperties + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceProperties' + to: FileSystemResourceProperties + - rename-model: + from: 'LiftrBase.MarketplaceDetails' + to: MarketplaceDetails + - rename-model: + from: 'LiftrBase.MarketplaceSubscriptionStatus' + to: MarketplaceSubscriptionStatus + - rename-model: + from: 'LiftrBase.UserDetails' + to: UserDetails + - rename-model: + from: 'LiftrBase.ProvisioningState' + to: ProvisioningState ``` diff --git a/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml b/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..38ec1fd82d93 --- /dev/null +++ b/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,9 @@ +suppressions: + azure-sdk-for-go: + - package: sdk/resourcemanager/liftrqumulo/armqumulo + breaking-changes: + - Enum `StorageSKU` has been removed + - Field `ClusterLoginURL`, `PrivateIPs` of struct `FileSystemResourceUpdateProperties` has been removed + - Field `InitialCapacity` of struct `FileSystemResourceProperties` has been removed + - Type of `FileSystemResourceProperties.StorageSKU` has been changed from `*StorageSKU` to `*string` + - "`ProvisioningStateNotSpecified` from enum `ProvisioningState` has been removed" From b3f6368f53a38c5a038dfe4ccdb046a9a3dec622 Mon Sep 17 00:00:00 2001 From: Felipe Dalorzo <162249355+fdalorzo-msft@users.noreply.github.com> Date: Mon, 8 Jul 2024 11:10:55 -0600 Subject: [PATCH 278/343] #29691 adding OperationContext (#29692) --- .../communicationservicescallautomation.json | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json index d57df1a6a778..359a291c9ab7 100644 --- a/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json +++ b/specification/communication/data-plane/CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json @@ -2400,6 +2400,10 @@ "speechRecognitionModelEndpointId": { "description": "Sets Endpoint id where the custom model was deployed.", "type": "string" + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" } } }, @@ -2703,6 +2707,10 @@ "operationCallbackUri": { "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.", "type": "string" + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" } } }, From cbbe228fd422db02b65e2748f83df5f2bcad7581 Mon Sep 17 00:00:00 2001 From: Avinash Agarwal Date: Mon, 8 Jul 2024 11:21:38 -0700 Subject: [PATCH 279/343] Add new API Version 2024-06-01-preview for Microsoft.Resources\changes (#29325) * [Changes] Swagger updates for new Microsoft.Resources\changes API Version 2024-06-01 * Updated references in readme.md * Ran prettifier --- .../preview/2024-06-01-preview/changes.json | 410 ++++++++++++++++++ .../examples/GetChange.json | 47 ++ .../examples/ListChanges.json | 76 ++++ .../resources/resource-manager/readme.md | 12 + 4 files changed, 545 insertions(+) create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/changes.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/examples/GetChange.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/examples/ListChanges.json diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/changes.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/changes.json new file mode 100644 index 000000000000..8dbba209106e --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/changes.json @@ -0,0 +1,410 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-06-01-preview", + "title": "ChangesClient", + "description": "The Resource Changes Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Resources/changes": { + "get": { + "tags": [ + "ListChanges" + ], + "operationId": "Changes_List", + "x-ms-examples": { + "ListChanges": { + "$ref": "./examples/ListChanges.json" + } + }, + "description": "Obtains a list of change resources from the past 14 days for the target resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/ResourceTypeParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/$top" + }, + { + "$ref": "#/parameters/$skipToken" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ChangeResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Resources/changes/{changeResourceId}": { + "get": { + "tags": [ + "GetChange" + ], + "operationId": "Changes_Get", + "x-ms-examples": { + "GetChange": { + "$ref": "./examples/GetChange.json" + } + }, + "description": "Obtains the specified change resource for the target resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/ResourceTypeParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ChangeResourceIdParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ChangeResourceResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ChangeResourceListResult": { + "description": "The list of resources", + "type": "object", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of Change Resources" + }, + "value": { + "description": "The list of resources", + "type": "array", + "items": { + "$ref": "#/definitions/ChangeResourceResult" + } + } + } + }, + "ChangeResourceResult": { + "description": "Change Resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ChangeProperties" + } + } + }, + "ChangeProperties": { + "description": "The properties of a change", + "type": "object", + "properties": { + "targetResourceId": { + "description": "The fully qualified ID of the target resource that was changed", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "targetResourceType": { + "description": "The namespace and type of the resource", + "type": "string", + "readOnly": true + }, + "changeType": { + "description": "The type of change that was captured in the resource", + "type": "string", + "readOnly": true, + "enum": [ + "Update", + "Delete", + "Create" + ], + "x-ms-enum": { + "name": "ChangeType", + "modelAsString": true, + "values": [ + { + "value": "Update", + "description": "An existing resource underwent a change", + "name": "Update" + }, + { + "value": "Delete", + "description": "An existing resource was deleted", + "name": "Delete" + }, + { + "value": "Create", + "description": "A newly created resource", + "name": "Create" + } + ] + } + }, + "changeAttributes": { + "$ref": "#/definitions/ChangeAttributes" + }, + "changes": { + "$ref": "#/definitions/ChangesDictionary" + } + } + }, + "ChangeAttributes": { + "description": "Details about the change resource", + "type": "object", + "properties": { + "correlationId": { + "description": "The Azure correlation ID of the change resource", + "type": "string", + "readOnly": true + }, + "timestamp": { + "description": "The time the change(s) on the target resource ocurred", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "changesCount": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of changes this resource captures" + }, + "previousResourceSnapshotId": { + "description": "The GUID of the previous snapshot", + "type": "string", + "readOnly": true + }, + "newResourceSnapshotId": { + "description": "The GUID of the new snapshot", + "type": "string", + "readOnly": true + }, + "isTruncated": { + "description": "The flag indicating whether property changes dictionary was truncated in this resource", + "type": "boolean", + "readOnly": true + }, + "changedBy": { + "description": "The identifier i.e. email id or application id of the entity that made the change(s)", + "type": "string", + "readOnly": true + }, + "changedByType": { + "description": "The entity type that made the change(s)", + "type": "string", + "readOnly": true, + "enum": [ + "Application", + "User", + "ManagedIdentity", + "Unknown" + ], + "x-ms-enum": { + "name": "changedByType", + "modelAsString": true, + "values": [ + { + "value": "Application", + "description": "An application made the change(s)", + "name": "Application" + }, + { + "value": "User", + "description": "A user made the change(s)", + "name": "User" + }, + { + "value": "ManagedIdentity", + "description": "A ManagedIdentity made the change(s)", + "name": "ManagedIdentity" + }, + { + "value": "Unknown", + "description": "An Unknown entity made the change(s)", + "name": "Unknown" + } + ] + } + }, + "clientType": { + "description": "Client used to make the changes", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The Azure Resource Provider operation that was invoked to make the change(s). See [here](https://learn.microsoft.com/azure/role-based-access-control/resource-provider-operations) for a full list of possible values", + "type": "string", + "readOnly": true + }, + "changeControlId": { + "description": "The resource identifier of the change control resource associated with this change record.", + "type": "string", + "format": "arm-id", + "readOnly": true + } + } + }, + "ChangesDictionary": { + "description": "A dictionary with changed property name as a key and the change details as the value", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ChangeBase" + } + }, + "ChangeBase": { + "description": "An individual change on the target resource", + "type": "object", + "properties": { + "previousValue": { + "description": "The target resource property value before the change", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "newValue": { + "description": "The target resource property value after the change", + "type": "string", + "readOnly": true, + "x-nullable": true + } + } + } + }, + "parameters": { + "ResourceProviderNamespaceParameter": { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "maxLength": 256, + "description": "The name of the resource provider namespace.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "maxLength": 256, + "description": "The name of the resource type.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource.", + "x-ms-parameter-location": "method" + }, + "ChangeResourceIdParameter": { + "name": "changeResourceId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the change resource", + "x-ms-parameter-location": "method" + }, + "$top": { + "required": false, + "default": 100, + "description": "(Optional) Set the maximum number of results per response.", + "in": "query", + "maximum": 100, + "minimum": 1, + "name": "$top", + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "$skipToken": { + "required": false, + "description": "(Optional) The page-continuation token", + "in": "query", + "name": "$skipToken", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/examples/GetChange.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/examples/GetChange.json new file mode 100644 index 000000000000..d3d5c936598d --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/examples/GetChange.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceProviderNamespace": "Microsoft.Storage", + "resourceType": "storageAccounts", + "resourceName": "myStorageAccount", + "api-version": "2024-06-01-preview", + "changeResourceId": "1d58d72f-0719-4a48-9228-b7ea682885bf" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/providers/Microsoft.Resources/changes/1d58d72f-0719-4a48-9228-b7ea682885bf", + "name": "1d58d72f-0719-4a48-9228-b7ea682885bf", + "type": "Microsoft.Resources/changes", + "properties": { + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "targetResourceType": "Microsoft.Storage/storageAccounts", + "changeType": "Update", + "changeAttributes": { + "correlationId": "88420d5d-8d0e-471f-9115-10d34750c617", + "timestamp": "2021-11-19T14:29:09.9210000Z", + "changesCount": 2, + "previousResourceSnapshotId": "ed90e35a-1661-42cc-a44c-e27f508005be", + "newResourceSnapshotId": "6eac9d0f-63b4-4e7f-97a5-740c73757efb", + "changedBy": "someAlias@microsoft.com", + "changedByType": "User", + "clientType": "Portal", + "operation": "Microsoft.Namespace/ResourceType/write", + "changeControlId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.AzureChangeControl/changecontrols/myChangeControl" + }, + "changes": { + "properties.provisioningState": { + "previousValue": "Updating", + "newValue": "Succeeded" + }, + "tags.key1": { + "previousValue": null, + "newValue": "someValue" + } + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/examples/ListChanges.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/examples/ListChanges.json new file mode 100644 index 000000000000..7e7bb22b0131 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2024-06-01-preview/examples/ListChanges.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceProviderNamespace": "Microsoft.Storage", + "resourceType": "storageAccounts", + "resourceName": "myStorageAccount", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/providers/Microsoft.Resources/changes/a9f34285-13a2-e79c-f468-cfb71c7bd227", + "name": "a9f34285-13a2-e79c-f468-cfb71c7bd227", + "type": "Microsoft.Resources/changes", + "properties": { + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "targetResourceType": "Microsoft.Storage/storageAccounts", + "changeType": "Update", + "changeAttributes": { + "correlationId": "88420d5d-8d0e-471f-9115-10d34750c617", + "timestamp": "2021-11-19T14:29:09.9210000Z", + "changesCount": 2, + "previousResourceSnapshotId": "ed90e35a-1661-42cc-a44c-e27f508005be", + "newResourceSnapshotId": "6eac9d0f-63b4-4e7f-97a5-740c73757efb", + "changedBy": "9500bb33-43da-4588-80b8-f65430dd937a", + "changedByType": "Application", + "clientType": "SDK", + "operation": "Microsoft.Namespace/ResourceType/write", + "changeControlId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.AzureChangeControl/changecontrols/myChangeControl" + }, + "changes": { + "properties.provisioningState": { + "previousValue": "Updating", + "newValue": "Succeeded" + }, + "tags.key1": { + "previousValue": null, + "newValue": "someValue" + }, + "properties.vms[5].sku[1]": { + "previousValue": "Standard", + "newValue": null + } + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/providers/Microsoft.Resources/changes/a9f34285-13a2-e79c-f468-cfb71c7bd227", + "name": "a9f34285-13a2-e79c-f468-cfb71c7bd227", + "type": "Microsoft.Resources/changes", + "properties": { + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "targetResourceType": "Microsoft.Storage/storageAccounts", + "changeType": "Create", + "changeAttributes": { + "changesCount": 0, + "correlationId": "88420d5d-8d0e-471f-9115-10d34750c617", + "timestamp": "2021-11-19T14:29:09.9210000Z", + "previousResourceSnapshotId": "b09f5e52-0b46-4d13-84a9-08653d39fed6", + "newResourceSnapshotId": "4db20fc0-de17-4cdd-92d8-fd6bf94b9fd9", + "changedBy": "9500bb33-43da-4588-80b8-f65430dd937a", + "changedByType": "Application", + "clientType": "SDK", + "operation": "Microsoft.Namespace/ResourceType/write" + }, + "changes": {} + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 913bae224639..596a5be4769a 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -258,6 +258,15 @@ input-file: - Microsoft.Resources/preview/2023-07-01-preview/changes.json ``` +### Tag: package-changes-2024-06-01-preview + +These settings apply only when `--tag=package-changes-2024-06-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-changes-2024-06-01-preview' +input-file: +- Microsoft.Resources/preview/2024-06-01-preview/changes.json +``` + ### Tag: package-snapshots-2022-11 These settings apply only when `--tag=package-snapshots-2022-11` is specified on the command line. @@ -1355,6 +1364,9 @@ directive: - suppress: AvoidAdditionalProperties from: resources.json reason: Breaking change in order to change the property names for multiple API's. Will fix in the future. + - suppress: AvoidAdditionalProperties + from: changes.json + reason: "Change properties including the dictionary of individual property changes are dynamic types. where clause is not working on all parent fields using this property bag, hence we're suppressing the entire file for now." - suppress: XmsExamplesRequired from: resources.json reason: Xms Examples required is a pre-existing lint error. Not related to this version release. Will fix in the future. From 73e33d06b7f3c08b11717374837332cfc5f96a5d Mon Sep 17 00:00:00 2001 From: Dapeng Zhang Date: Tue, 9 Jul 2024 11:22:47 +0800 Subject: [PATCH 280/343] fix spread for purview datamap and translation document (#29707) * update * update * update * update translation * update * fix ai document translation * fix wrong change and regen * fix * update swagger * update * format * change to use @body * update * format --------- Co-authored-by: tadelesh --- .../routes.tsp | 48 +++++++---- .../stable/2023-09-01/purviewdatamap.json | 31 +++++-- .../Azure.AI.DocumentTranslation/client.tsp | 10 +++ .../Azure.AI.DocumentTranslation/models.tsp | 84 +++++++++++-------- .../Azure.AI.DocumentTranslation/routes.tsp | 4 +- .../stable/2024-05-01/openapi.json | 69 ++++++++------- 6 files changed, 146 insertions(+), 100 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 7dd2a7fb5645..b0bce3569d39 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -116,7 +116,7 @@ interface Entity { """) @query collectionId?: string; - } & AtlasEntityWithExtInfo, + } & BodyParameter, EntityMutationResult, AtlasApiVersionParameterTraits >; @@ -174,7 +174,7 @@ interface Entity { """) @query businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; - } & AtlasEntitiesWithExtInfo, + } & BodyParameter, EntityMutationResult, AtlasApiVersionParameterTraits >; @@ -205,7 +205,11 @@ interface Entity { @doc("Associate a classification to multiple entities in bulk.") @route("/atlas/v2/entity/bulk/classification") @post - addClassification is AtlasOperation; + addClassification is AtlasOperation< + BodyParameter, + void, + {} + >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @@ -447,7 +451,7 @@ interface Entity { """) @query("attr:qualifiedName") attribute?: string; - } & AtlasEntityWithExtInfo, + } & BodyParameter, EntityMutationResult, {} >; @@ -576,7 +580,7 @@ interface Entity { @route("/atlas/v2/entity/bulk/setClassifications") @post bulkSetClassifications is AtlasOperation< - AtlasEntityHeaders, + BodyParameter, OkResponse, {} >; @@ -765,7 +769,7 @@ interface Entity { @route("/atlas/v2/entity/businessmetadata/import") @post importBusinessMetadata is AtlasImportOperation< - BusinessMetadataOptions, + BodyParameter, BulkImportResult, MultipartFormDataRequestHeadersTraits >; @@ -966,7 +970,7 @@ interface Entity { @doc("The collection where entities will be moved to.") @query collectionId: string; - } & MoveEntitiesOptions, + } & BodyParameter, EntityMutationResult, {}, AtlasErrorResponse @@ -1011,7 +1015,7 @@ interface Glossary { @doc("Create a glossary.") @route("/atlas/v2/glossary") @post - create is AtlasOperation; + create is AtlasOperation, AtlasGlossary, {}>; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1035,7 +1039,7 @@ interface Glossary { @route("/atlas/v2/glossary/category") @post createCategory is AtlasOperation< - AtlasGlossaryCategory, + BodyParameter, AtlasGlossaryCategory, {} >; @@ -1065,7 +1069,7 @@ interface Glossary { @doc("The globally unique identifier of the category.") @path categoryId: string; - } & AtlasGlossaryCategory, + } & BodyParameter, AtlasGlossaryCategory, {} >; @@ -1178,7 +1182,7 @@ interface Glossary { @doc("Whether include term hierarchy") @query includeTermHierarchy?: boolean; - } & AtlasGlossaryTerm, + } & BodyParameter, AtlasGlossaryTerm, {} >; @@ -1210,7 +1214,7 @@ interface Glossary { @doc("Whether include term hierarchy") @query includeTermHierarchy?: boolean; - } & AtlasGlossaryTerm, + } & BodyParameter, AtlasGlossaryTerm, AtlasApiVersionParameterTraits >; @@ -1412,7 +1416,7 @@ interface Glossary { @doc("Whether ignore terms and categories") @query ignoreTermsAndCategories?: boolean; - } & AtlasGlossary, + } & BodyParameter, AtlasGlossary, AtlasApiVersionParameterTraits >; @@ -1752,14 +1756,22 @@ interface Relationship { @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post - create is AtlasOperation; + create is AtlasOperation< + BodyParameter, + AtlasRelationship, + {} + >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Update an existing relationship between entities.") @route("/atlas/v2/relationship") @put - update is AtlasOperation; + update is AtlasOperation< + BodyParameter, + AtlasRelationship, + {} + >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @@ -2051,7 +2063,7 @@ interface Type { """) @route("/atlas/v2/types/typedefs") @post - bulkCreate is AtlasOperation; + bulkCreate is AtlasOperation, AtlasTypesDef, {}>; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @@ -2061,14 +2073,14 @@ interface Type { """) @route("/atlas/v2/types/typedefs") @put - bulkUpdate is AtlasOperation; + bulkUpdate is AtlasOperation, AtlasTypesDef, {}>; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete API for all types in bulk.") @route("/atlas/v2/types/typedefs") @delete - bulkDelete is AtlasOperation; + bulkDelete is AtlasOperation, void, {}>; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List all type definitions returned as a list of minimal information header.") diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 2d8ab19b2b35..4acce1bf0f2f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -101,6 +101,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityWithExtInfo" @@ -241,6 +242,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntitiesWithExtInfo" @@ -312,6 +314,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ClassificationAssociateOptions" @@ -344,6 +347,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityHeaders" @@ -438,7 +442,11 @@ ], "parameters": [ { - "$ref": "#/parameters/BusinessMetadataOptions" + "name": "file", + "in": "formData", + "description": "InputStream of file", + "required": true, + "type": "file" } ], "responses": { @@ -1237,6 +1245,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityWithExtInfo" @@ -1671,6 +1680,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossary" @@ -1755,6 +1765,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossary" @@ -2203,6 +2214,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryCategory" @@ -2277,6 +2289,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryCategory" @@ -2519,6 +2532,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryTerm" @@ -2612,6 +2626,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryTerm" @@ -3156,6 +3171,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasRelationship" @@ -3189,6 +3205,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasRelationship" @@ -3915,6 +3932,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3948,6 +3966,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3984,6 +4003,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -4142,6 +4162,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/MoveEntitiesOptions" @@ -8241,14 +8262,6 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" - }, - "BusinessMetadataOptions": { - "name": "file", - "in": "formData", - "description": "InputStream of file", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" } } } diff --git a/specification/translation/Azure.AI.DocumentTranslation/client.tsp b/specification/translation/Azure.AI.DocumentTranslation/client.tsp index 0eb76c501974..121ca660a59a 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/client.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/client.tsp @@ -77,3 +77,13 @@ interface SingleDocumentTranslationClient { @@access(DocumentTranslation.DocumentsStatus, Access.internal, "python"); @@access(DocumentTranslation.SupportedFileFormats, Access.internal, "python"); @@access(DocumentTranslation.FileFormat, Access.internal, "python"); + +@@clientName(DocumentTranslation.DocumentTranslateBody.body, + "documentTranslateContent", + "csharp,java" +); + +@@clientName(DocumentTranslation.StartTranslationBody.body, + "startTranslationDetails", + "csharp,java" +); diff --git a/specification/translation/Azure.AI.DocumentTranslation/models.tsp b/specification/translation/Azure.AI.DocumentTranslation/models.tsp index 98f36a54789c..892e598176b8 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/models.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/models.tsp @@ -10,41 +10,6 @@ using TypeSpec.Versioning; namespace DocumentTranslation; @doc("Document Translate Request Content") model DocumentTranslateContent { - @doc(""" - Specifies source language of the input document. - If this parameter isn't specified, automatic language detection is applied to determine the source language. - For example if the source document is written in English, then use sourceLanguage=en - """) - @query("sourceLanguage") - sourceLanguage?: string; - - @doc(""" - Specifies the language of the output document. - The target language must be one of the supported languages included in the translation scope. - For example if you want to translate the document in German language, then use targetLanguage=de - """) - @query("targetLanguage") - targetLanguage: string; - - @doc(""" - A string specifying the category (domain) of the translation. This parameter is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom Translator - project details to this parameter to use your deployed customized system. Default value is: general. - """) - @query("category") - category?: string = "general"; - - @doc(""" - Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. - Possible values are: true (default) or false. - """) - @query("allowFallback") - allowFallback?: boolean; - - @doc("Content Type as multipart/form-data") - @header - contentType: "multipart/form-data"; - @doc("Document to be translated in the form") document: bytes; @@ -470,3 +435,52 @@ model FileFormat { @doc("Supported Type for this format") type?: string; } + +@doc("Document Translate Request Body") +model DocumentTranslateBody { + @doc(""" + Specifies source language of the input document. + If this parameter isn't specified, automatic language detection is applied to determine the source language. + For example if the source document is written in English, then use sourceLanguage=en + """) + @query("sourceLanguage") + sourceLanguage?: string; + + @doc(""" + Specifies the language of the output document. + The target language must be one of the supported languages included in the translation scope. + For example if you want to translate the document in German language, then use targetLanguage=de + """) + @query("targetLanguage") + targetLanguage: string; + + @doc(""" + A string specifying the category (domain) of the translation. This parameter is used to get translations + from a customized system built with Custom Translator. Add the Category ID from your Custom Translator + project details to this parameter to use your deployed customized system. Default value is: general. + """) + @query("category") + category?: string = "general"; + + @doc(""" + Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. + Possible values are: true (default) or false. + """) + @query("allowFallback") + allowFallback?: boolean; + + @doc("Content Type as multipart/form-data") + @header + contentType: "multipart/form-data"; + + @doc("Document Translate Request Content") + @body + body: DocumentTranslateContent; +} + +@doc("Start Translation Request Body") +model StartTranslationBody { + @doc("Translation job submission batch request") + @body + body: StartTranslationDetails; +} diff --git a/specification/translation/Azure.AI.DocumentTranslation/routes.tsp b/specification/translation/Azure.AI.DocumentTranslation/routes.tsp index 63a640672fd5..4b556b6496dc 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/routes.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/routes.tsp @@ -21,7 +21,7 @@ interface DocumentTranslationOperations { @route("document:translate") @post documentTranslate is RpcOperation< - DocumentTranslateContent, + DocumentTranslateBody, DocumentTranslateResult, ServiceTraits >; @@ -54,7 +54,7 @@ interface DocumentTranslationOperations { @route("/document/batches") @post startTranslation is Azure.Core.Foundations.Operation< - StartTranslationDetails, + StartTranslationBody, { @doc("Request has been accepted successfully.") @statusCode diff --git a/specification/translation/data-plane/Azure.AI.DocumentTranslation/stable/2024-05-01/openapi.json b/specification/translation/data-plane/Azure.AI.DocumentTranslation/stable/2024-05-01/openapi.json index 999176fb42ad..a24e8fa059f0 100644 --- a/specification/translation/data-plane/Azure.AI.DocumentTranslation/stable/2024-05-01/openapi.json +++ b/specification/translation/data-plane/Azure.AI.DocumentTranslation/stable/2024-05-01/openapi.json @@ -189,12 +189,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StartTranslationDetails" - } + "$ref": "#/parameters/StartTranslationBody" } ], "responses": { @@ -577,25 +572,37 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/DocumentTranslateContent.sourceLanguage" + "$ref": "#/parameters/DocumentTranslateBody.sourceLanguage" }, { - "$ref": "#/parameters/DocumentTranslateContent.targetLanguage" + "$ref": "#/parameters/DocumentTranslateBody.targetLanguage" }, { - "$ref": "#/parameters/DocumentTranslateContent.category" + "$ref": "#/parameters/DocumentTranslateBody.category" }, { - "$ref": "#/parameters/DocumentTranslateContent.allowFallback" + "$ref": "#/parameters/DocumentTranslateBody.allowFallback" }, { "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" }, { - "$ref": "#/parameters/DocumentTranslateContent.document" + "name": "document", + "in": "formData", + "description": "Document to be translated in the form", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/DocumentTranslateContent.glossary" + "name": "glossary", + "in": "formData", + "description": "Glossary-translation memory will be used during translation in the form. ", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "binary" + } } ], "responses": { @@ -1412,7 +1419,7 @@ "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" }, - "DocumentTranslateContent.allowFallback": { + "DocumentTranslateBody.allowFallback": { "name": "allowFallback", "in": "query", "description": "Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. \nPossible values are: true (default) or false.", @@ -1420,7 +1427,7 @@ "type": "boolean", "x-ms-parameter-location": "method" }, - "DocumentTranslateContent.category": { + "DocumentTranslateBody.category": { "name": "category", "in": "query", "description": "A string specifying the category (domain) of the translation. This parameter is used to get translations \nfrom a customized system built with Custom Translator. Add the Category ID from your Custom Translator \nproject details to this parameter to use your deployed customized system. Default value is: general.", @@ -1429,27 +1436,7 @@ "default": "general", "x-ms-parameter-location": "method" }, - "DocumentTranslateContent.document": { - "name": "document", - "in": "formData", - "description": "Document to be translated in the form", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "DocumentTranslateContent.glossary": { - "name": "glossary", - "in": "formData", - "description": "Glossary-translation memory will be used during translation in the form. ", - "required": false, - "type": "array", - "items": { - "type": "string", - "format": "binary" - }, - "x-ms-parameter-location": "method" - }, - "DocumentTranslateContent.sourceLanguage": { + "DocumentTranslateBody.sourceLanguage": { "name": "sourceLanguage", "in": "query", "description": "Specifies source language of the input document.\nIf this parameter isn't specified, automatic language detection is applied to determine the source language.\nFor example if the source document is written in English, then use sourceLanguage=en", @@ -1457,13 +1444,23 @@ "type": "string", "x-ms-parameter-location": "method" }, - "DocumentTranslateContent.targetLanguage": { + "DocumentTranslateBody.targetLanguage": { "name": "targetLanguage", "in": "query", "description": "Specifies the language of the output document.\nThe target language must be one of the supported languages included in the translation scope.\nFor example if you want to translate the document in German language, then use targetLanguage=de ", "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "StartTranslationBody": { + "name": "body", + "in": "body", + "description": "Translation job submission batch request", + "required": true, + "schema": { + "$ref": "#/definitions/StartTranslationDetails" + }, + "x-ms-parameter-location": "method" } } } From ad84205b407cdd780c9eabdfe23f439c347dd6df Mon Sep 17 00:00:00 2001 From: Chenjie Shi Date: Tue, 9 Jul 2024 11:41:13 +0800 Subject: [PATCH 281/343] fix body spread breaking change (#29723) * fix face * fix communication messages * regen swagger * fix casing * rollback face * fix face * fix tsp * add java * fix easm --- specification/ai/Face/models.session.tsp | 15 ++++++--- specification/ai/Face/routes.session.tsp | 2 +- .../Face/preview/v1.1-preview.1/Face.json | 31 +++++++------------ .../Communication.Messages/client.tsp | 5 +++ .../Communication.Messages/models.tsp | 14 +++------ .../Communication.Messages/routes.tsp | 2 +- .../communicationservicesmessages.json | 18 ++++++----- specification/riskiq/Easm/routes.tsp | 4 +-- .../preview/2023-03-01-preview/easm.json | 2 ++ .../preview/2024-03-01-preview/easm.json | 2 ++ 10 files changed, 51 insertions(+), 44 deletions(-) diff --git a/specification/ai/Face/models.session.tsp b/specification/ai/Face/models.session.tsp index a3cda20247c6..bcf04fe373d2 100644 --- a/specification/ai/Face/models.session.tsp +++ b/specification/ai/Face/models.session.tsp @@ -267,10 +267,6 @@ model LivenessSessionAuditEntry { @doc("Request of liveness with verify session creation.") model CreateLivenessWithVerifySessionContent { - @doc("The content type for the operation. Always multipart/form-data for this operation.") - @header("content-type") - contentType: "multipart/form-data"; - #suppress "@azure-tools/typespec-azure-core/casing-style" @doc("The parameters for creating session.") Parameters: CreateLivenessSessionContent; @@ -279,3 +275,14 @@ model CreateLivenessWithVerifySessionContent { @doc("The image stream for verify. Content-Disposition header field for this part must have filename.") VerifyImage: bytes; } + +@doc("Request wrapper of liveness with verify session creation.") +model CreateLivenessWithVerifySessionRequest { + @doc("The content type for the operation. Always multipart/form-data for this operation.") + @header("content-type") + contentType: "multipart/form-data"; + + @doc("Request content of liveness with verify session creation.") + @body + body: CreateLivenessWithVerifySessionContent; +} diff --git a/specification/ai/Face/routes.session.tsp b/specification/ai/Face/routes.session.tsp index 4c5c59085f75..8878172142a5 100644 --- a/specification/ai/Face/routes.session.tsp +++ b/specification/ai/Face/routes.session.tsp @@ -102,7 +102,7 @@ interface LivenessSessionOperations { @sharedRoute createLivenessWithVerifySessionWithVerifyImage is FaceResourceCreateWithServiceProvidedName< LivenessWithVerifySession, - CreateLivenessWithVerifySessionContent, + CreateLivenessWithVerifySessionRequest, CreateLivenessWithVerifySessionResult >; diff --git a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json index 9ad89a4484f6..c2873f6fcae3 100644 --- a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json +++ b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json @@ -642,10 +642,18 @@ ], "parameters": [ { - "$ref": "#/parameters/CreateLivenessWithVerifySessionContent.Parameters" + "name": "Parameters", + "in": "formData", + "description": "The parameters for creating session.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/CreateLivenessWithVerifySessionContent.VerifyImage" + "name": "VerifyImage", + "in": "formData", + "description": "The image stream for verify. Content-Disposition header field for this part must have filename.", + "required": true, + "type": "file" } ], "responses": { @@ -9405,22 +9413,5 @@ "pattern": "^[a-z0-9-_]+$" } }, - "parameters": { - "CreateLivenessWithVerifySessionContent.Parameters": { - "name": "Parameters", - "in": "formData", - "description": "The parameters for creating session.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "CreateLivenessWithVerifySessionContent.VerifyImage": { - "name": "VerifyImage", - "in": "formData", - "description": "The image stream for verify. Content-Disposition header field for this part must have filename.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - } - } + "parameters": {} } diff --git a/specification/communication/Communication.Messages/client.tsp b/specification/communication/Communication.Messages/client.tsp index d8c9d9c1f1be..6fad713a917c 100644 --- a/specification/communication/Communication.Messages/client.tsp +++ b/specification/communication/Communication.Messages/client.tsp @@ -36,3 +36,8 @@ interface MessageTemplateClient "templateValues", "python" ); + +@@clientName(Azure.Communication.MessagesService.NotificationMessagesSendRequestBody.body, + "notificationContent", + "csharp,java" +); diff --git a/specification/communication/Communication.Messages/models.tsp b/specification/communication/Communication.Messages/models.tsp index 4949f3b23047..9d9c555ad3ff 100644 --- a/specification/communication/Communication.Messages/models.tsp +++ b/specification/communication/Communication.Messages/models.tsp @@ -375,13 +375,9 @@ enum Versions { c2024_02_01: "2024-02-01", } -alias BodyParameter< - T, - TName extends valueof string = "body", - TDoc extends valueof string = "Body parameter." -> = { - @doc(TDoc) - @friendlyName(TName) +@doc("Notification messages send request body.") +model NotificationMessagesSendRequestBody { + @doc("Details of the message to send.") @bodyRoot - body: T; -}; + body: NotificationContent; +} diff --git a/specification/communication/Communication.Messages/routes.tsp b/specification/communication/Communication.Messages/routes.tsp index a2c5d85987a4..75fc25bf3be6 100644 --- a/specification/communication/Communication.Messages/routes.tsp +++ b/specification/communication/Communication.Messages/routes.tsp @@ -35,7 +35,7 @@ interface NotificationMessagesOperations { @doc("Sends a notification message from Business to User.") send is Operations.ResourceCollectionAction< Notifications, - BodyParameter, + NotificationMessagesSendRequestBody, AcceptedResponse & SendMessageResult >; } diff --git a/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json b/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json index ec91ed70c2ed..7a383c60e5d5 100644 --- a/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json +++ b/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json @@ -162,13 +162,7 @@ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/NotificationContent" - } + "$ref": "#/parameters/NotificationMessagesSendRequestBody" } ], "responses": { @@ -1063,6 +1057,16 @@ "type": "string", "x-ms-parameter-location": "method", "x-ms-client-name": "repeatabilityRequestId" + }, + "NotificationMessagesSendRequestBody": { + "name": "body", + "in": "body", + "description": "Details of the message to send.", + "required": true, + "schema": { + "$ref": "#/definitions/NotificationContent" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/riskiq/Easm/routes.tsp b/specification/riskiq/Easm/routes.tsp index f8220b541bfb..396f815f0489 100644 --- a/specification/riskiq/Easm/routes.tsp +++ b/specification/riskiq/Easm/routes.tsp @@ -30,7 +30,7 @@ interface Assets { @updatesResource(AssetResource) @post updateAssets is Foundations.Operation< - AssetsUpdateParameter & AssetUpdateData, + AssetsUpdateParameter & BodyParameter, Task >; @doc("Retrieve an asset by assetId.") @@ -242,7 +242,7 @@ interface SavedFilters { @put createOrReplaceSavedFilter is Foundations.ResourceOperation< SavedFilter, - SavedFilterData, + BodyParameter, SavedFilter >; @doc("Delete a saved filter with a given filterName.") diff --git a/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json b/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json index dd82cf71c089..2979f3851472 100644 --- a/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json +++ b/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json @@ -145,6 +145,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssetUpdateData" @@ -1102,6 +1103,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SavedFilterData" diff --git a/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json b/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json index d6f807a38604..dce621013446 100644 --- a/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json +++ b/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json @@ -157,6 +157,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssetUpdateData" @@ -1604,6 +1605,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SavedFilterData" From b50677fd0b9d49b162ad3ffa44eb35d926988ed6 Mon Sep 17 00:00:00 2001 From: Nate Kimball <97469387+natekimball-msft@users.noreply.github.com> Date: Mon, 8 Jul 2024 21:13:24 -0700 Subject: [PATCH 282/343] [communication] Update examples to use string for retry-after (#29739) - Required by autorest schema for examples --- .../preview/2021-10-01-preview/examples/GetSendStatus.json | 2 +- .../Email/preview/2021-10-01-preview/examples/SendEmail.json | 2 +- .../examples/GetOperationStatusReturnsNonTerminalStatus.json | 2 +- .../Email/preview/2023-01-15-preview/examples/SendEmail.json | 2 +- .../examples/GetOperationStatusReturnsNonTerminalStatus.json | 2 +- .../data-plane/Email/stable/2023-03-31/examples/SendEmail.json | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/GetSendStatus.json b/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/GetSendStatus.json index 31bb078abc0e..554b1288afe3 100644 --- a/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/GetSendStatus.json +++ b/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/GetSendStatus.json @@ -8,7 +8,7 @@ "responses": { "200": { "headers": { - "Retry-After": 100 + "Retry-After": "100" }, "body": { "messageId": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4", diff --git a/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/SendEmail.json b/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/SendEmail.json index 331b415fa3a9..1c3ac170b61a 100644 --- a/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/SendEmail.json +++ b/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/SendEmail.json @@ -81,7 +81,7 @@ "headers": { "Repeatability-Result": "accepted", "Operation-Location": "https://contoso.westus.communications.azure.com//email/status/8540c0de-899f-5cce-acb5-3ec493af3800?api-version=2021-10-01-preview", - "Retry-After": 1, + "Retry-After": "1", "x-ms-request-id": "8540c0de-899f-5cce-acb5-3ec493af3800" } } diff --git a/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/GetOperationStatusReturnsNonTerminalStatus.json b/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/GetOperationStatusReturnsNonTerminalStatus.json index b41652df6f31..b069db247ffa 100644 --- a/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/GetOperationStatusReturnsNonTerminalStatus.json +++ b/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/GetOperationStatusReturnsNonTerminalStatus.json @@ -8,7 +8,7 @@ "responses": { "200": { "headers": { - "retry-after": 100 + "retry-after": "100" }, "body": { "id": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4", diff --git a/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/SendEmail.json b/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/SendEmail.json index b2aa331b52d2..d28653a9cb97 100644 --- a/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/SendEmail.json +++ b/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/SendEmail.json @@ -73,7 +73,7 @@ "202": { "headers": { "Operation-Location": "https://contoso.westus.communications.azure.com//emails/operations/8540c0de-899f-5cce-acb5-3ec493af3800?api-version=2023-01-15-preview", - "retry-after": 20 + "retry-after": "20" }, "body": { "id": "8540c0de-899f-5cce-acb5-3ec493af3800", diff --git a/specification/communication/data-plane/Email/stable/2023-03-31/examples/GetOperationStatusReturnsNonTerminalStatus.json b/specification/communication/data-plane/Email/stable/2023-03-31/examples/GetOperationStatusReturnsNonTerminalStatus.json index 294c5ff9ac61..b673bdfc234a 100644 --- a/specification/communication/data-plane/Email/stable/2023-03-31/examples/GetOperationStatusReturnsNonTerminalStatus.json +++ b/specification/communication/data-plane/Email/stable/2023-03-31/examples/GetOperationStatusReturnsNonTerminalStatus.json @@ -8,7 +8,7 @@ "responses": { "200": { "headers": { - "retry-after": 100 + "retry-after": "100" }, "body": { "id": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4", diff --git a/specification/communication/data-plane/Email/stable/2023-03-31/examples/SendEmail.json b/specification/communication/data-plane/Email/stable/2023-03-31/examples/SendEmail.json index 4698fe5905f9..95c89220ce98 100644 --- a/specification/communication/data-plane/Email/stable/2023-03-31/examples/SendEmail.json +++ b/specification/communication/data-plane/Email/stable/2023-03-31/examples/SendEmail.json @@ -73,7 +73,7 @@ "202": { "headers": { "Operation-Location": "https://contoso.westus.communications.azure.com//emails/operations/8540c0de-899f-5cce-acb5-3ec493af3800?api-version=2023-03-31", - "retry-after": 20 + "retry-after": "20" }, "body": { "id": "8540c0de-899f-5cce-acb5-3ec493af3800", From ed17f23a2893b306acbf600976ba2e9d9c02fbc9 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Mon, 8 Jul 2024 21:19:05 -0700 Subject: [PATCH 283/343] [DevOpsInfrastructure] Add ".Management" suffix to TypeSpec folder name (#29737) --- .../client.tsp | 0 .../examples/2023-12-13-preview/CreateOrUpdatePool.json | 0 .../examples/2023-12-13-preview/DeletePool.json | 0 .../examples/2023-12-13-preview/GetPool.json | 0 .../examples/2023-12-13-preview/ListOperations.json | 0 .../examples/2023-12-13-preview/ListPoolsBySubscription.json | 0 .../ListPoolsBySubscriptionAndResourceGroup.json | 0 .../examples/2023-12-13-preview/UpdatePool.json | 0 .../examples/2024-03-26-preview/CreateOrUpdatePool.json | 0 .../examples/2024-03-26-preview/DeletePool.json | 0 .../examples/2024-03-26-preview/GetPool.json | 0 .../examples/2024-03-26-preview/ListOperations.json | 0 .../examples/2024-03-26-preview/ListPoolsBySubscription.json | 0 .../ListPoolsBySubscriptionAndResourceGroup.json | 0 .../examples/2024-03-26-preview/ResourceDetails_ListByPool.json | 0 .../examples/2024-03-26-preview/Sku_ListByLocation.json | 0 .../examples/2024-03-26-preview/UpdatePool.json | 0 .../examples/2024-04-04-preview/CreateOrUpdatePool.json | 0 .../examples/2024-04-04-preview/DeletePool.json | 0 .../examples/2024-04-04-preview/GetPool.json | 0 .../examples/2024-04-04-preview/ImageVersions_ListByImage.json | 0 .../examples/2024-04-04-preview/ListOperations.json | 0 .../examples/2024-04-04-preview/ListPoolsBySubscription.json | 0 .../ListPoolsBySubscriptionAndResourceGroup.json | 0 .../examples/2024-04-04-preview/ResourceDetails_ListByPool.json | 0 .../examples/2024-04-04-preview/Sku_ListByLocation.json | 0 .../examples/2024-04-04-preview/SubscriptionUsages_Usages.json | 0 .../examples/2024-04-04-preview/UpdatePool.json | 0 .../main.tsp | 0 .../tspconfig.yaml | 0 30 files changed, 0 insertions(+), 0 deletions(-) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/client.tsp (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2023-12-13-preview/CreateOrUpdatePool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2023-12-13-preview/DeletePool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2023-12-13-preview/GetPool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2023-12-13-preview/ListOperations.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2023-12-13-preview/ListPoolsBySubscription.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2023-12-13-preview/ListPoolsBySubscriptionAndResourceGroup.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2023-12-13-preview/UpdatePool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-03-26-preview/CreateOrUpdatePool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-03-26-preview/DeletePool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-03-26-preview/GetPool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-03-26-preview/ListOperations.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-03-26-preview/ListPoolsBySubscription.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-03-26-preview/ListPoolsBySubscriptionAndResourceGroup.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-03-26-preview/ResourceDetails_ListByPool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-03-26-preview/Sku_ListByLocation.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-03-26-preview/UpdatePool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/CreateOrUpdatePool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/DeletePool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/GetPool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/ImageVersions_ListByImage.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/ListOperations.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/ListPoolsBySubscription.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/ListPoolsBySubscriptionAndResourceGroup.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/ResourceDetails_ListByPool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/Sku_ListByLocation.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/SubscriptionUsages_Usages.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/examples/2024-04-04-preview/UpdatePool.json (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/main.tsp (100%) rename specification/devopsinfrastructure/{Microsoft.DevOpsInfrastructure => Microsoft.DevOpsInfrastructure.Management}/tspconfig.yaml (100%) diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/client.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/client.tsp similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/client.tsp rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/client.tsp diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/CreateOrUpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/CreateOrUpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/CreateOrUpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/CreateOrUpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/DeletePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/DeletePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/DeletePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/DeletePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/GetPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/GetPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/GetPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/GetPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListOperations.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListOperations.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListOperations.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListOperations.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListPoolsBySubscription.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListPoolsBySubscription.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListPoolsBySubscription.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListPoolsBySubscription.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListPoolsBySubscriptionAndResourceGroup.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListPoolsBySubscriptionAndResourceGroup.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListPoolsBySubscriptionAndResourceGroup.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/UpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/UpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/UpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/UpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/CreateOrUpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/CreateOrUpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/CreateOrUpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/CreateOrUpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/DeletePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/DeletePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/DeletePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/DeletePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/GetPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/GetPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/GetPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/GetPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListOperations.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListOperations.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListOperations.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListOperations.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListPoolsBySubscription.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListPoolsBySubscription.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListPoolsBySubscription.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListPoolsBySubscription.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListPoolsBySubscriptionAndResourceGroup.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListPoolsBySubscriptionAndResourceGroup.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListPoolsBySubscriptionAndResourceGroup.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ResourceDetails_ListByPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ResourceDetails_ListByPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ResourceDetails_ListByPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ResourceDetails_ListByPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/Sku_ListByLocation.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/Sku_ListByLocation.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/Sku_ListByLocation.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/Sku_ListByLocation.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/UpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/UpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/UpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/UpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/CreateOrUpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/CreateOrUpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/CreateOrUpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/CreateOrUpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/DeletePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/DeletePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/DeletePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/DeletePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/GetPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/GetPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/GetPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/GetPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ImageVersions_ListByImage.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ImageVersions_ListByImage.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ImageVersions_ListByImage.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ImageVersions_ListByImage.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListOperations.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListOperations.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListOperations.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListOperations.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListPoolsBySubscription.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListPoolsBySubscription.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListPoolsBySubscription.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListPoolsBySubscription.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListPoolsBySubscriptionAndResourceGroup.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListPoolsBySubscriptionAndResourceGroup.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListPoolsBySubscriptionAndResourceGroup.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ResourceDetails_ListByPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ResourceDetails_ListByPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ResourceDetails_ListByPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ResourceDetails_ListByPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/Sku_ListByLocation.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/Sku_ListByLocation.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/Sku_ListByLocation.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/Sku_ListByLocation.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_Usages.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/SubscriptionUsages_Usages.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_Usages.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/SubscriptionUsages_Usages.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/UpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/UpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/UpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/UpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/tspconfig.yaml b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/tspconfig.yaml rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml From f69a2f240bc8dff432bfa0d7a4274d9b7760c797 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Tue, 9 Jul 2024 13:44:59 +0800 Subject: [PATCH 284/343] =?UTF-8?q?move=20directive=20to=20readme.md=20to?= =?UTF-8?q?=20avoid=20unnecessary=20breaking=20changes=20for=E2=80=A6=20(#?= =?UTF-8?q?29742)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * move directive to readme.md to avoid unnecessary breaking changes for all languages * update suppressions --------- Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> --- .../liftrqumulo/resource-manager/readme.go.md | 25 ------------------ .../liftrqumulo/resource-manager/readme.md | 25 ++++++++++++++++++ .../resource-manager/readme.typescript.md | 26 ------------------- .../resource-manager/sdk-suppressions.yaml | 7 +++++ 4 files changed, 32 insertions(+), 51 deletions(-) diff --git a/specification/liftrqumulo/resource-manager/readme.go.md b/specification/liftrqumulo/resource-manager/readme.go.md index 0a58d895d454..6b8f28b1d784 100644 --- a/specification/liftrqumulo/resource-manager/readme.go.md +++ b/specification/liftrqumulo/resource-manager/readme.go.md @@ -8,29 +8,4 @@ module-name: sdk/resourcemanager/liftrqumulo/armqumulo module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true -directive: - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceUpdate' - to: FileSystemResourceUpdate - - rename-model: - from: 'LiftrBase.Storage.FileSystemResource' - to: FileSystemResource - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceUpdateProperties' - to: FileSystemResourceUpdateProperties - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceProperties' - to: FileSystemResourceProperties - - rename-model: - from: 'LiftrBase.MarketplaceDetails' - to: MarketplaceDetails - - rename-model: - from: 'LiftrBase.MarketplaceSubscriptionStatus' - to: MarketplaceSubscriptionStatus - - rename-model: - from: 'LiftrBase.UserDetails' - to: UserDetails - - rename-model: - from: 'LiftrBase.ProvisioningState' - to: ProvisioningState ``` \ No newline at end of file diff --git a/specification/liftrqumulo/resource-manager/readme.md b/specification/liftrqumulo/resource-manager/readme.md index f7cd7746a285..d6fd1514d04e 100644 --- a/specification/liftrqumulo/resource-manager/readme.md +++ b/specification/liftrqumulo/resource-manager/readme.md @@ -28,6 +28,31 @@ These are the global settings for the Qumulo.Storage. openapi-type: arm openapi-subtype: rpaas tag: package-2024-06-19 +directive: + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceUpdate' + to: FileSystemResourceUpdate + - rename-model: + from: 'LiftrBase.Storage.FileSystemResource' + to: FileSystemResource + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceUpdateProperties' + to: FileSystemResourceUpdateProperties + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceProperties' + to: FileSystemResourceProperties + - rename-model: + from: 'LiftrBase.MarketplaceDetails' + to: MarketplaceDetails + - rename-model: + from: 'LiftrBase.MarketplaceSubscriptionStatus' + to: MarketplaceSubscriptionStatus + - rename-model: + from: 'LiftrBase.UserDetails' + to: UserDetails + - rename-model: + from: 'LiftrBase.ProvisioningState' + to: ProvisioningState ``` diff --git a/specification/liftrqumulo/resource-manager/readme.typescript.md b/specification/liftrqumulo/resource-manager/readme.typescript.md index d76e0cab6129..3a02e4bea4c1 100644 --- a/specification/liftrqumulo/resource-manager/readme.typescript.md +++ b/specification/liftrqumulo/resource-manager/readme.typescript.md @@ -10,30 +10,4 @@ typescript: output-folder: "$(typescript-sdks-folder)/sdk/liftrqumulo/arm-qumulo" payload-flattening-threshold: 1 generate-metadata: true - -directive: - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceUpdate' - to: FileSystemResourceUpdate - - rename-model: - from: 'LiftrBase.Storage.FileSystemResource' - to: FileSystemResource - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceUpdateProperties' - to: FileSystemResourceUpdateProperties - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceProperties' - to: FileSystemResourceProperties - - rename-model: - from: 'LiftrBase.MarketplaceDetails' - to: MarketplaceDetails - - rename-model: - from: 'LiftrBase.MarketplaceSubscriptionStatus' - to: MarketplaceSubscriptionStatus - - rename-model: - from: 'LiftrBase.UserDetails' - to: UserDetails - - rename-model: - from: 'LiftrBase.ProvisioningState' - to: ProvisioningState ``` diff --git a/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml b/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml index 38ec1fd82d93..fc6ce288b542 100644 --- a/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml +++ b/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml @@ -7,3 +7,10 @@ suppressions: - Field `InitialCapacity` of struct `FileSystemResourceProperties` has been removed - Type of `FileSystemResourceProperties.StorageSKU` has been changed from `*StorageSKU` to `*string` - "`ProvisioningStateNotSpecified` from enum `ProvisioningState` has been removed" + azure-sdk-for-js: + - package: '@azure/arm-qumulo' + breaking-changes: + - Interface FileSystemResource no longer has parameter initialCapacity + - Interface FileSystemResourceUpdateProperties no longer has parameter clusterLoginUrl + - Interface FileSystemResourceUpdateProperties no longer has parameter privateIPs + - Type of parameter storageSku of interface FileSystemResource is changed from StorageSku to string From dda6da8f130c3e2de43451fd820f1d2db74979e1 Mon Sep 17 00:00:00 2001 From: glenn Date: Tue, 9 Jul 2024 09:45:28 -0400 Subject: [PATCH 285/343] namespace to AI.Model, add ApiKeyAuth --- specification/ai/ModelClient/client.tsp | 128 +++++++++--------- specification/ai/ModelClient/main.tsp | 10 +- .../ModelClient/models/chat_completions.tsp | 2 +- .../ai/ModelClient/models/common.tsp | 2 +- .../ai/ModelClient/models/embeddings.tsp | 2 +- .../ModelClient/models/image_embeddings.tsp | 2 +- specification/ai/ModelClient/routes.tsp | 2 +- 7 files changed, 74 insertions(+), 74 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 1d6630fd99be..7254da42efb3 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -5,116 +5,116 @@ import "./main.tsp"; using Azure.ClientGenerator.Core; using TypeSpec.Versioning; -@useDependency(ModelClient.Versions.v2024_05_01_Preview) +@useDependency(AI.Model.Versions.v2024_05_01_Preview) namespace Customizations; // The actual name here doesn't matter and is here for organization purposes only // Are these needed? -@@usage(ModelClient.ChatCompletions, Usage.output); -@@usage(ModelClient.ModelInfo, Usage.output); -@@usage(ModelClient.StreamingChatChoiceUpdate, Usage.output); -@@usage(ModelClient.StreamingChatCompletionsUpdate, Usage.output); +@@usage(AI.Model.ChatCompletions, Usage.output); +@@usage(AI.Model.ModelInfo, Usage.output); +@@usage(AI.Model.StreamingChatChoiceUpdate, Usage.output); +@@usage(AI.Model.StreamingChatCompletionsUpdate, Usage.output); // Since we made all operator methods internal, we need to expliclty // say we still want the models they use to be public. -@@access(ModelClient.ChatChoice, Access.public); -@@access(ModelClient.ChatCompletions, Access.public); -@@access(ModelClient.ChatCompletionsFunctionToolCall, Access.public); -@@access(ModelClient.ChatCompletionsFunctionToolDefinition, Access.public); -@@access(ModelClient.ChatCompletionsNamedToolSelection, Access.public); -@@access(ModelClient.ChatCompletionsNamedFunctionToolSelection, Access.public); -@@access(ModelClient.ChatCompletionsFunctionToolSelection, Access.public); -@@access(ModelClient.ChatCompletionsResponseFormat, Access.public); -@@access(ModelClient.ChatCompletionsToolCall, Access.public); -@@access(ModelClient.ChatCompletionsToolDefinition, Access.public); -@@access(ModelClient.ChatCompletionsToolSelectionPreset, Access.public); -@@access(ModelClient.ChatRequestAssistantMessage, Access.public); -@@access(ModelClient.ChatRequestMessage, Access.public); -@@access(ModelClient.ChatRequestSystemMessage, Access.public); -@@access(ModelClient.ChatRequestToolMessage, Access.public); -@@access(ModelClient.ChatRequestUserMessage, Access.public); -@@access(ModelClient.ChatResponseMessage, Access.public); -@@access(ModelClient.ChatRole, Access.public); -@@access(ModelClient.CompletionsFinishReason, Access.public); -@@access(ModelClient.CompletionsUsage, Access.public); -@@access(ModelClient.EmbeddingEncodingFormat, Access.public, "python"); -@@access(ModelClient.EmbeddingInput, Access.public, "python"); -@@access(ModelClient.EmbeddingInputType, Access.public, "python"); -@@access(ModelClient.EmbeddingItem, Access.public, "python"); -@@access(ModelClient.EmbeddingsResult, Access.public, "python"); -@@access(ModelClient.EmbeddingsUsage, Access.public, "python"); -@@access(ModelClient.FunctionCall, Access.public); -@@access(ModelClient.FunctionDefinition, Access.public); -@@access(ModelClient.ModelInfo, Access.public); -@@access(ModelClient.ModelType, Access.public); -@@access(ModelClient.StreamingChatChoiceUpdate, Access.public, "python"); -@@access(ModelClient.StreamingChatCompletionsUpdate, Access.public, "python"); -@@access(ModelClient.ChatMessageContentItem, Access.public); -@@access(ModelClient.ChatMessageTextContentItem, Access.public); -@@access(ModelClient.ChatMessageImageContentItem, Access.public); -@@access(ModelClient.ChatMessageImageUrl, Access.public); -@@access(ModelClient.ChatMessageImageDetailLevel, Access.public); +@@access(AI.Model.ChatChoice, Access.public); +@@access(AI.Model.ChatCompletions, Access.public); +@@access(AI.Model.ChatCompletionsFunctionToolCall, Access.public); +@@access(AI.Model.ChatCompletionsFunctionToolDefinition, Access.public); +@@access(AI.Model.ChatCompletionsNamedToolSelection, Access.public); +@@access(AI.Model.ChatCompletionsNamedFunctionToolSelection, Access.public); +@@access(AI.Model.ChatCompletionsFunctionToolSelection, Access.public); +@@access(AI.Model.ChatCompletionsResponseFormat, Access.public); +@@access(AI.Model.ChatCompletionsToolCall, Access.public); +@@access(AI.Model.ChatCompletionsToolDefinition, Access.public); +@@access(AI.Model.ChatCompletionsToolSelectionPreset, Access.public); +@@access(AI.Model.ChatRequestAssistantMessage, Access.public); +@@access(AI.Model.ChatRequestMessage, Access.public); +@@access(AI.Model.ChatRequestSystemMessage, Access.public); +@@access(AI.Model.ChatRequestToolMessage, Access.public); +@@access(AI.Model.ChatRequestUserMessage, Access.public); +@@access(AI.Model.ChatResponseMessage, Access.public); +@@access(AI.Model.ChatRole, Access.public); +@@access(AI.Model.CompletionsFinishReason, Access.public); +@@access(AI.Model.CompletionsUsage, Access.public); +@@access(AI.Model.EmbeddingEncodingFormat, Access.public, "python"); +@@access(AI.Model.EmbeddingInput, Access.public, "python"); +@@access(AI.Model.EmbeddingInputType, Access.public, "python"); +@@access(AI.Model.EmbeddingItem, Access.public, "python"); +@@access(AI.Model.EmbeddingsResult, Access.public, "python"); +@@access(AI.Model.EmbeddingsUsage, Access.public, "python"); +@@access(AI.Model.FunctionCall, Access.public); +@@access(AI.Model.FunctionDefinition, Access.public); +@@access(AI.Model.ModelInfo, Access.public); +@@access(AI.Model.ModelType, Access.public); +@@access(AI.Model.StreamingChatChoiceUpdate, Access.public, "python"); +@@access(AI.Model.StreamingChatCompletionsUpdate, Access.public, "python"); +@@access(AI.Model.ChatMessageContentItem, Access.public); +@@access(AI.Model.ChatMessageTextContentItem, Access.public); +@@access(AI.Model.ChatMessageImageContentItem, Access.public); +@@access(AI.Model.ChatMessageImageUrl, Access.public); +@@access(AI.Model.ChatMessageImageDetailLevel, Access.public); // The operators need to be hidden, since we hand-write the public versions of those to // 1. Add chat completions streaming (to getChatCompletions operator) // 2. Add hyper-params (to getChatCompletions/Embeddings/ImageEmbeddings, all clients) // 3. Cache model info (to getModelInfo, all clients, Python only) -@@access(ModelClient.getChatCompletions, Access.internal, "python"); -@@access(ModelClient.getEmbeddings, Access.internal); -@@access(ModelClient.getImageEmbeddings, Access.internal); -@@access(ModelClient.getModelInfo, Access.internal, "python"); +@@access(AI.Model.getChatCompletions, Access.internal, "python"); +@@access(AI.Model.getEmbeddings, Access.internal); +@@access(AI.Model.getImageEmbeddings, Access.internal); +@@access(AI.Model.getModelInfo, Access.internal, "python"); // We use shorter names in the Python client library -@@clientName(ModelClient.ChatRequestSystemMessage, "SystemMessage", "python"); -@@clientName(ModelClient.ChatRequestUserMessage, "UserMessage", "python"); -@@clientName(ModelClient.ChatRequestAssistantMessage, +@@clientName(AI.Model.ChatRequestSystemMessage, "SystemMessage", "python"); +@@clientName(AI.Model.ChatRequestUserMessage, "UserMessage", "python"); +@@clientName(AI.Model.ChatRequestAssistantMessage, "AssistantMessage", "python" ); -@@clientName(ModelClient.ChatRequestToolMessage, "ToolMessage", "python"); -@@clientName(ModelClient.ChatMessageContentItem, "ContentItem", "python"); -@@clientName(ModelClient.ChatMessageTextContentItem, +@@clientName(AI.Model.ChatRequestToolMessage, "ToolMessage", "python"); +@@clientName(AI.Model.ChatMessageContentItem, "ContentItem", "python"); +@@clientName(AI.Model.ChatMessageTextContentItem, "TextContentItem", "python" ); -@@clientName(ModelClient.ChatMessageImageContentItem, +@@clientName(AI.Model.ChatMessageImageContentItem, "ImageContentItem", "python" ); -@@clientName(ModelClient.ChatMessageImageUrl, "ImageUrl", "python"); -@@clientName(ModelClient.ChatMessageImageDetailLevel, +@@clientName(AI.Model.ChatMessageImageUrl, "ImageUrl", "python"); +@@clientName(AI.Model.ChatMessageImageDetailLevel, "ImageDetailLevel", "python" ); @client({ name: "ChatCompletionsClient", - service: ModelClient, + service: AI.Model, }) interface Client1 { - complete is ModelClient.getChatCompletions; - getModelInfo is ModelClient.getModelInfo; + complete is AI.Model.getChatCompletions; + getModelInfo is AI.Model.getModelInfo; } @client( { name: "EmbeddingsClient", - service: ModelClient, + service: AI.Model, }, "python" ) interface Client2 { - embed is ModelClient.getEmbeddings; - getModelInfo is ModelClient.getModelInfo; + embed is AI.Model.getEmbeddings; + getModelInfo is AI.Model.getModelInfo; } @client( { name: "ImageEmbeddingsClient", - service: ModelClient, + service: AI.Model, }, "python" ) interface Client3 { - embed is ModelClient.getImageEmbeddings; - getModelInfo is ModelClient.getModelInfo; + embed is AI.Model.getImageEmbeddings; + getModelInfo is AI.Model.getModelInfo; } diff --git a/specification/ai/ModelClient/main.tsp b/specification/ai/ModelClient/main.tsp index aa9695d23cab..d3958a8697c1 100644 --- a/specification/ai/ModelClient/main.tsp +++ b/specification/ai/ModelClient/main.tsp @@ -10,7 +10,7 @@ using Azure.Core; #suppress "@azure-tools/typespec-autorest/unsupported-http-auth-scheme" @useAuth( - BearerAuth | OAuth2Auth<[ + BearerAuth | ApiKeyAuth | OAuth2Auth<[ { type: OAuth2FlowType.implicit, authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", @@ -21,12 +21,12 @@ using Azure.Core; @service({ title: "AI Model Inference", }) -@versioned(ModelClient.Versions) -namespace ModelClient; +@versioned(AI.Model.Versions) +namespace AI.Model; -@doc("The ModelClient service versions.") +@doc("The AI.Model service versions.") enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_2) - @doc("The 2024-05-01-preview version of the ModelClient service.") + @doc("The 2024-05-01-preview version of the AI.Model service.") v2024_05_01_Preview: "2024-05-01-preview", } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 73fed6ab5fbe..57c261e211cc 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -7,7 +7,7 @@ using TypeSpec.Http; using Azure.ClientGenerator.Core; -namespace ModelClient; +namespace AI.Model; alias ChatCompletionsOptions = { @doc(""" diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 91d19f3dd8a5..c4ccf0626be8 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -4,7 +4,7 @@ import "@typespec/http"; using TypeSpec.Rest; using TypeSpec.Http; -namespace ModelClient; +namespace AI.Model; @doc("Represents the input types used for embedding search.") union EmbeddingInputType { diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index 2d732863062b..87aad9ebc42c 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -4,7 +4,7 @@ import "@typespec/http"; using TypeSpec.Rest; using TypeSpec.Http; -namespace ModelClient; +namespace AI.Model; alias EmbeddingsOptions = { @doc(""" diff --git a/specification/ai/ModelClient/models/image_embeddings.tsp b/specification/ai/ModelClient/models/image_embeddings.tsp index 15826bbc28e5..e83a86c6029a 100644 --- a/specification/ai/ModelClient/models/image_embeddings.tsp +++ b/specification/ai/ModelClient/models/image_embeddings.tsp @@ -4,7 +4,7 @@ import "@typespec/http"; using TypeSpec.Rest; using TypeSpec.Http; -namespace ModelClient; +namespace AI.Model; alias ImageEmbeddingsOptions = { @doc(""" diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 7279e2f66871..7b79bbfad9f8 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -13,7 +13,7 @@ using TypeSpec.Http; using TypeSpec.Versioning; using Azure.Core; -namespace ModelClient; +namespace AI.Model; @doc(""" Gets chat completions for the provided chat messages. From 3fb8f658b497ac3ac229ad32e70492030e8a18bf Mon Sep 17 00:00:00 2001 From: Pamela Fox Date: Tue, 9 Jul 2024 07:04:11 -0700 Subject: [PATCH 286/343] Update fields description (#28483) --- .../Azure.Search/preview/2024-03-01-Preview/searchindex.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json index 1d30f0fbe030..d1a1455aac0d 100644 --- a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json @@ -1863,7 +1863,7 @@ }, "fields": { "type": "string", - "description": "Vector Fields of type Collection(Edm.Single) to be included in the vector searched." + "description": "The comma-separated list of field names to be included in the vector search. Each of the fields must be a valid vector type, such as Collection(Edm.Single). If multiple fields are given, the vector will be used to find the closest matches across all fields." }, "exhaustive": { "type": "boolean", From fbcbda37241f4b8c61ddf858ae7b7f3d9d810f7a Mon Sep 17 00:00:00 2001 From: Badea Marjieh <127952241+badeamarjieh@users.noreply.github.com> Date: Tue, 9 Jul 2024 21:28:18 +0300 Subject: [PATCH 287/343] Microsoft.Fabric - Fix Delete & Update Status Codes. (#29721) * fix status codes and corresponding examples * fix update exmaple --- .../Microsoft.Fabric.Management/capacity.tsp | 4 +- .../2023-11-01/FabricCapacities_Delete.json | 7 +++- .../2023-11-01/FabricCapacities_Update.json | 10 ++++- .../examples/FabricCapacities_Delete.json | 7 +++- .../examples/FabricCapacities_Update.json | 10 ++++- .../stable/2023-11-01/fabric.json | 41 +++++++++++++++++-- 6 files changed, 67 insertions(+), 12 deletions(-) diff --git a/specification/fabric/Microsoft.Fabric.Management/capacity.tsp b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp index 0f44dbf03559..129c1cc86d22 100644 --- a/specification/fabric/Microsoft.Fabric.Management/capacity.tsp +++ b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp @@ -32,8 +32,8 @@ model FabricCapacity is TrackedResource { interface FabricCapacities { get is ArmResourceRead; createOrUpdate is ArmResourceCreateOrReplaceAsync; - update is ArmResourcePatchSync; - delete is ArmResourceDeleteSync; + update is ArmResourcePatchAsync; + delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json index decf9a4809f8..90c9acbf1ebb 100644 --- a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json @@ -8,7 +8,12 @@ "capacityName": "azsdktest" }, "responses": { - "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + } + }, "204": {} } } diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json index 0dbbee872b7c..7bcc4e1649ab 100644 --- a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json @@ -27,8 +27,8 @@ "200": { "body": { "properties": { - "provisioningState": "Provisioning", - "state": "Provisioning", + "provisioningState": "Updating", + "state": "Preparing", "administration": { "members": [ "azsdktest2@microsoft.com" @@ -47,6 +47,12 @@ "name": "azsdktest", "type": "Microsoft.Fabric/capacities" } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + } } } } diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json index decf9a4809f8..90c9acbf1ebb 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json @@ -8,7 +8,12 @@ "capacityName": "azsdktest" }, "responses": { - "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + } + }, "204": {} } } diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json index 0dbbee872b7c..7bcc4e1649ab 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json @@ -27,8 +27,8 @@ "200": { "body": { "properties": { - "provisioningState": "Provisioning", - "state": "Provisioning", + "provisioningState": "Updating", + "state": "Preparing", "administration": { "members": [ "azsdktest2@microsoft.com" @@ -47,6 +47,12 @@ "name": "azsdktest", "type": "Microsoft.Fabric/capacities" } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + } } } } diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json index eb8d87cc9837..90da207021a8 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json @@ -419,6 +419,20 @@ "$ref": "#/definitions/FabricCapacity" } }, + "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": { @@ -430,7 +444,11 @@ "Update capacity properties": { "$ref": "./examples/FabricCapacities_Update.json" } - } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true }, "delete": { "operationId": "FabricCapacities_Delete", @@ -460,8 +478,19 @@ } ], "responses": { - "200": { - "description": "Resource deleted successfully." + "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." @@ -477,7 +506,11 @@ "Delete a capacity": { "$ref": "./examples/FabricCapacities_Delete.json" } - } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/resume": { From 15b7cae1aa9e9756b7f30951aa81224c18e421bb Mon Sep 17 00:00:00 2001 From: ragovada <142325886+ragovada@users.noreply.github.com> Date: Tue, 9 Jul 2024 13:07:16 -0700 Subject: [PATCH 288/343] Update mfe.json to fix out of order gen issue (#29634) --- .../stable/2024-04-01/mfe.json | 6888 ++++++++--------- 1 file changed, 3444 insertions(+), 3444 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json index fdab5a2bbdff..6ef3527532aa 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json @@ -2613,13 +2613,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { "get": { "tags": [ - "MarketplaceSubscription" + "ModelContainer" ], - "summary": "List containers.", - "operationId": "MarketplaceSubscriptions_List", + "summary": "List model containers.", + "operationId": "RegistryModelContainers_List", "produces": [ "application/json" ], @@ -2631,32 +2631,59 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Marketplace Subscription.": { - "$ref": "./examples/Workspace/MarketplaceSubscription/list.json" + "List Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/list.json" } }, "x-ms-pageable": { @@ -2664,13 +2691,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { "delete": { "tags": [ - "MarketplaceSubscription" + "ModelContainer" ], - "summary": "Delete Marketplace Subscription (asynchronous).", - "operationId": "MarketplaceSubscriptions_Delete", + "summary": "Delete container.", + "operationId": "RegistryModelContainers_Delete", "produces": [ "application/json" ], @@ -2682,12 +2709,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "name", - "description": "Marketplace Subscription name.", + "name": "modelName", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -2697,6 +2724,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "202": { "description": "Accepted", "headers": { @@ -2718,19 +2751,16 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Delete Workspace Marketplace Subscription.": { - "$ref": "./examples/Workspace/MarketplaceSubscription/delete.json" + "Delete Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/delete.json" } }, "x-ms-long-running-operation": true, @@ -2740,10 +2770,10 @@ }, "get": { "tags": [ - "MarketplaceSubscription" + "ModelContainer" ], "summary": "Get container.", - "operationId": "MarketplaceSubscriptions_Get", + "operationId": "RegistryModelContainers_Get", "produces": [ "application/json" ], @@ -2755,45 +2785,46 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "name", - "description": "Container name.", + "name": "modelName", + "description": "Container name. This is case-sensitive.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } } }, "x-ms-examples": { - "Get Workspace Marketplace Subscription.": { - "$ref": "./examples/Workspace/MarketplaceSubscription/get.json" + "Get Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/get.json" } } }, "put": { "tags": [ - "MarketplaceSubscription" + "ModelContainer" ], - "summary": "Create or update Marketplace Subscription (asynchronous).", - "operationId": "MarketplaceSubscriptions_CreateOrUpdate", + "summary": "Create or update model container.", + "operationId": "RegistryModelContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -2808,12 +2839,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "name", - "description": "Marketplace Subscription name.", + "name": "modelName", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -2824,24 +2855,30 @@ { "in": "body", "name": "body", - "description": "Marketplace Subscription entity to apply during operation.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResource" + "$ref": "#/definitions/ModelContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResource" + "$ref": "#/definitions/ModelContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResource" + "$ref": "#/definitions/ModelContainerResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -2854,17 +2891,11 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Marketplace Subscription.": { - "$ref": "./examples/Workspace/MarketplaceSubscription/createOrUpdate.json" + "CreateOrUpdate Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -2873,13 +2904,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { "get": { "tags": [ - "ModelContainer" + "ModelVersion" ], - "summary": "List model containers.", - "operationId": "RegistryModelContainers_List", + "summary": "List versions.", + "operationId": "RegistryModelVersions_List", "produces": [ "application/json" ], @@ -2893,12 +2924,57 @@ { "$ref": "registries.json#/parameters/RegistryNameParameter" }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "version", + "description": "Version identifier.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, { "in": "query", "name": "listViewType", @@ -2937,13 +3013,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/list.json" + "List Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/list.json" } }, "x-ms-pageable": { @@ -2951,13 +3027,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { "delete": { "tags": [ - "ModelContainer" + "ModelVersion" ], - "summary": "Delete container.", - "operationId": "RegistryModelContainers_Delete", + "summary": "Delete version.", + "operationId": "RegistryModelVersions_Delete", "produces": [ "application/json" ], @@ -2979,6 +3055,13 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -3019,8 +3102,8 @@ } }, "x-ms-examples": { - "Delete Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/delete.json" + "Delete Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/delete.json" } }, "x-ms-long-running-operation": true, @@ -3030,10 +3113,10 @@ }, "get": { "tags": [ - "ModelContainer" + "ModelVersion" ], - "summary": "Get container.", - "operationId": "RegistryModelContainers_Get", + "summary": "Get version.", + "operationId": "RegistryModelVersions_Get", "produces": [ "application/json" ], @@ -3055,6 +3138,13 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -3069,22 +3159,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/ModelVersionResource" } } }, "x-ms-examples": { - "Get Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/get.json" + "Get Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/get.json" } } }, "put": { "tags": [ - "ModelContainer" + "ModelVersion" ], - "summary": "Create or update model container.", - "operationId": "RegistryModelContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "RegistryModelVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3110,15 +3200,22 @@ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/ModelVersionResource" } } ], @@ -3132,13 +3229,13 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/ModelVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/ModelVersionResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -3154,8 +3251,8 @@ } }, "x-ms-examples": { - "CreateOrUpdate Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" + "CreateOrUpdate Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -3164,13 +3261,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": { + "post": { "tags": [ "ModelVersion" ], - "summary": "List versions.", - "operationId": "RegistryModelVersions_List", + "summary": "Generate a storage location and credential for the client to upload a model asset to.", + "operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -3187,80 +3287,84 @@ { "in": "path", "name": "modelName", - "description": "Container name. This is case-sensitive.", + "description": "Model name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { + "get": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Lists Batch inference endpoint in the workspace.", + "operationId": "BatchEndpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "version", - "description": "Version identifier.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "query", - "name": "description", - "description": "Model description.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "query", - "name": "properties", - "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", - "type": "string" + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" }, { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -3273,13 +3377,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/list.json" + "List Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/list.json" } }, "x-ms-pageable": { @@ -3287,13 +3391,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { "delete": { "tags": [ - "ModelVersion" + "BatchEndpoint" ], - "summary": "Delete version.", - "operationId": "RegistryModelVersions_Delete", + "summary": "Delete Batch Inference Endpoint (asynchronous).", + "operationId": "BatchEndpoints_Delete", "produces": [ "application/json" ], @@ -3305,20 +3409,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" - }, - { - "in": "path", - "name": "modelName", - "description": "Container name.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "version", - "description": "Version identifier.", + "name": "endpointName", + "description": "Inference Endpoint name.", "required": true, "type": "string" }, @@ -3333,6 +3429,9 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, + "200": { + "description": "Success" + }, "202": { "description": "Accepted", "headers": { @@ -3354,16 +3453,13 @@ } } }, - "200": { - "description": "Success" - }, "204": { "description": "No Content" } }, "x-ms-examples": { - "Delete Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/delete.json" + "Delete Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/delete.json" } }, "x-ms-long-running-operation": true, @@ -3373,10 +3469,10 @@ }, "get": { "tags": [ - "ModelVersion" + "BatchEndpoint" ], - "summary": "Get version.", - "operationId": "RegistryModelVersions_Get", + "summary": "Gets a batch inference endpoint by name.", + "operationId": "BatchEndpoints_Get", "produces": [ "application/json" ], @@ -3388,20 +3484,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" - }, - { - "in": "path", - "name": "modelName", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "endpointName", + "description": "Name for the Batch Endpoint.", "required": true, "type": "string" }, @@ -3419,22 +3507,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" } } }, "x-ms-examples": { - "Get Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/get.json" + "Get Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/get.json" } } }, - "put": { + "patch": { "tags": [ - "ModelVersion" + "BatchEndpoint" ], - "summary": "Create or update version.", - "operationId": "RegistryModelVersions_CreateOrUpdate", + "summary": "Update a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_Update", "consumes": [ "application/json" ], @@ -3449,33 +3537,26 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "modelName", - "description": "Container name.", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Mutable batch inference endpoint definition object.", "required": true, "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" } } ], @@ -3487,47 +3568,46 @@ } }, "200": { - "description": "Create or update request is successful.", + "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ModelVersionResource" - }, + "202": { + "description": "Accepted", "headers": { "x-ms-async-operation-timeout": { "description": "Timeout for the client to use when polling the asynchronous operation.", "type": "string", "format": "duration" }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", + "Location": { + "description": "URI to poll for asynchronous operation result.", "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 } } } }, "x-ms-examples": { - "CreateOrUpdate Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" + "Update Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/update.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": { - "post": { + "x-ms-long-running-operation": true + }, + "put": { "tags": [ - "ModelVersion" + "BatchEndpoint" ], - "summary": "Generate a storage location and credential for the client to upload a model asset to.", - "operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload", + "summary": "Creates a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3542,33 +3622,26 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "modelName", - "description": "Model name. This is case-sensitive.", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Pending upload request object", + "description": "Batch inference endpoint definition object.", "required": true, "schema": { - "$ref": "#/definitions/PendingUploadRequestDto" + "$ref": "#/definitions/BatchEndpointTrackedResource" } } ], @@ -3580,26 +3653,47 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/PendingUploadResponseDto" + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "CreateOrGetStartPendingUpload Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json" + "CreateOrUpdate Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { "get": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Lists Batch inference endpoint in the workspace.", - "operationId": "BatchEndpoints_List", + "summary": "Lists Batch inference deployments in the workspace.", + "operationId": "BatchDeployments_List", "produces": [ "application/json" ], @@ -3613,13 +3707,26 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "query", - "name": "count", - "description": "Number of endpoints to be retrieved in a page of results.", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", "type": "integer", "format": "int32" }, @@ -3637,13 +3744,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/list.json" + "List Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/list.json" } }, "x-ms-pageable": { @@ -3651,13 +3758,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { "delete": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Delete Batch Inference Endpoint (asynchronous).", - "operationId": "BatchEndpoints_Delete", + "summary": "Delete Batch Inference deployment (asynchronous).", + "operationId": "BatchDeployments_Delete", "produces": [ "application/json" ], @@ -3674,7 +3781,14 @@ { "in": "path", "name": "endpointName", - "description": "Inference Endpoint name.", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference deployment identifier.", "required": true, "type": "string" }, @@ -3689,9 +3803,6 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Success" - }, "202": { "description": "Accepted", "headers": { @@ -3713,13 +3824,16 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/delete.json" + "Delete Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/delete.json" } }, "x-ms-long-running-operation": true, @@ -3729,10 +3843,10 @@ }, "get": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Gets a batch inference endpoint by name.", - "operationId": "BatchEndpoints_Get", + "summary": "Gets a batch inference deployment by id.", + "operationId": "BatchDeployments_Get", "produces": [ "application/json" ], @@ -3749,7 +3863,14 @@ { "in": "path", "name": "endpointName", - "description": "Name for the Batch Endpoint.", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch deployments.", "required": true, "type": "string" }, @@ -3767,22 +3888,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } } }, "x-ms-examples": { - "Get Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/get.json" + "Get Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/get.json" } } }, "patch": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Update a batch inference endpoint (asynchronous).", - "operationId": "BatchEndpoints_Update", + "summary": "Update a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_Update", "consumes": [ "application/json" ], @@ -3802,7 +3923,15 @@ { "in": "path", "name": "endpointName", - "description": "Name for the Batch inference endpoint.", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -3813,10 +3942,10 @@ { "in": "body", "name": "body", - "description": "Mutable batch inference endpoint definition object.", + "description": "Batch inference deployment definition object.", "required": true, "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" } } ], @@ -3830,7 +3959,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } }, "202": { @@ -3856,18 +3985,18 @@ } }, "x-ms-examples": { - "Update Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/update.json" + "Update Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/update.json" } }, "x-ms-long-running-operation": true }, "put": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Creates a batch inference endpoint (asynchronous).", - "operationId": "BatchEndpoints_CreateOrUpdate", + "summary": "Creates/updates a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3887,7 +4016,15 @@ { "in": "path", "name": "endpointName", - "description": "Name for the Batch inference endpoint.", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -3898,10 +4035,10 @@ { "in": "body", "name": "body", - "description": "Batch inference endpoint definition object.", + "description": "Batch inference deployment definition object.", "required": true, "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } } ], @@ -3915,13 +4052,13 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -3937,8 +4074,8 @@ } }, "x-ms-examples": { - "CreateOrUpdate Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" + "CreateOrUpdate Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -3947,13 +4084,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { + "post": { "tags": [ - "BatchDeployment" + "BatchEndpoint" ], - "summary": "Lists Batch inference deployments in the workspace.", - "operationId": "BatchDeployments_List", + "summary": "Lists batch Inference Endpoint keys.", + "operationId": "BatchEndpoints_ListKeys", "produces": [ "application/json" ], @@ -3970,28 +4107,12 @@ { "in": "path", "name": "endpointName", - "description": "Endpoint name", + "description": "Inference Endpoint name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" - }, - { - "in": "query", - "name": "$top", - "description": "Top of list.", - "type": "integer", - "format": "int32" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -4004,27 +4125,24 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/EndpointAuthKeys" } } }, "x-ms-examples": { - "List Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/list.json" + "ListKeys Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { + "get": { "tags": [ - "BatchDeployment" + "CodeContainer" ], - "summary": "Delete Batch Inference deployment (asynchronous).", - "operationId": "BatchDeployments_Delete", + "summary": "List containers.", + "operationId": "CodeContainers_List", "produces": [ "application/json" ], @@ -4039,21 +4157,10 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "endpointName", - "description": "Endpoint name", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference deployment identifier.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -4063,50 +4170,30 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, "200": { - "description": "Success" - }, - "204": { - "description": "No Content" + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "Delete Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/delete.json" + "List Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/list.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { + "delete": { "tags": [ - "BatchDeployment" + "CodeContainer" ], - "summary": "Gets a batch inference deployment by id.", - "operationId": "BatchDeployments_Get", + "summary": "Delete container.", + "operationId": "CodeContainers_Delete", "produces": [ "application/json" ], @@ -4122,15 +4209,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Endpoint name", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch deployments.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -4146,27 +4226,24 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - } + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Get Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/get.json" + "Delete Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/delete.json" } } }, - "patch": { + "get": { "tags": [ - "BatchDeployment" - ], - "summary": "Update a batch inference deployment (asynchronous).", - "operationId": "BatchDeployments_Update", - "consumes": [ - "application/json" + "CodeContainer" ], + "summary": "Get container.", + "operationId": "CodeContainers_Get", "produces": [ "application/json" ], @@ -4182,31 +4259,13 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch inference deployment.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Batch inference deployment definition object.", - "required": true, - "schema": { - "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" - } } ], "responses": { @@ -4219,44 +4278,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - } - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "$ref": "#/definitions/CodeContainerResource" } } }, "x-ms-examples": { - "Update Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/update.json" + "Get Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/get.json" } - }, - "x-ms-long-running-operation": true + } }, "put": { "tags": [ - "BatchDeployment" + "CodeContainer" ], - "summary": "Creates/updates a batch inference deployment (asynchronous).", - "operationId": "BatchDeployments_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "CodeContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4275,16 +4312,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch inference deployment.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -4295,10 +4324,10 @@ { "in": "body", "name": "body", - "description": "Batch inference deployment definition object.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/CodeContainerResource" } } ], @@ -4312,45 +4341,30 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/CodeContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/CodeContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" + "CreateOrUpdate Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { + "get": { "tags": [ - "BatchEndpoint" + "CodeVersion" ], - "summary": "Lists batch Inference Endpoint keys.", - "operationId": "BatchEndpoints_ListKeys", + "summary": "List versions.", + "operationId": "CodeVersions_List", "produces": [ "application/json" ], @@ -4366,13 +4380,41 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "hash", + "description": "If specified, return CodeVersion assets with specified content hash value, regardless of name", + "type": "string" + }, + { + "in": "query", + "name": "hashVersion", + "description": "Hash algorithm version when listing by hash", + "type": "string" } ], "responses": { @@ -4385,24 +4427,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EndpointAuthKeys" + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "ListKeys Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" + "List Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { + "delete": { "tags": [ - "CodeContainer" + "CodeVersion" ], - "summary": "List containers.", - "operationId": "CodeContainers_List", + "summary": "Delete version.", + "operationId": "CodeVersions_Delete", "produces": [ "application/json" ], @@ -4417,60 +4462,16 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" - } - } - }, - "x-ms-examples": { - "List Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { - "delete": { - "tags": [ - "CodeContainer" - ], - "summary": "Delete container.", - "operationId": "CodeContainers_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -4493,17 +4494,17 @@ } }, "x-ms-examples": { - "Delete Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/delete.json" + "Delete Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/delete.json" } } }, "get": { "tags": [ - "CodeContainer" + "CodeVersion" ], - "summary": "Get container.", - "operationId": "CodeContainers_Get", + "summary": "Get version.", + "operationId": "CodeVersions_Get", "produces": [ "application/json" ], @@ -4524,6 +4525,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -4538,22 +4546,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/CodeVersionResource" } } }, "x-ms-examples": { - "Get Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/get.json" + "Get Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/get.json" } } }, "put": { "tags": [ - "CodeContainer" + "CodeVersion" ], - "summary": "Create or update container.", - "operationId": "CodeContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "CodeVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4578,16 +4586,23 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/CodeVersionResource" } } ], @@ -4601,30 +4616,33 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/CodeVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/CodeVersionResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish": { + "post": { "tags": [ "CodeVersion" ], - "summary": "List versions.", - "operationId": "CodeVersions_List", + "summary": "Publish version asset into registry.", + "operationId": "CodeVersions_Publish", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -4641,40 +4659,28 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Container name.", "required": true, "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, "type": "string" }, { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "hash", - "description": "If specified, return CodeVersion assets with specified content hash value, regardless of name", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "hashVersion", - "description": "Hash algorithm version when listing by hash", - "type": "string" + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } } ], "responses": { @@ -4685,29 +4691,46 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "List Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/list.json" + "Publish Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/publish.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": { + "post": { "tags": [ "CodeVersion" ], - "summary": "Delete version.", - "operationId": "CodeVersions_Delete", + "summary": "Generate a storage location and credential for the client to upload a code asset to.", + "operationId": "CodeVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -4737,6 +4760,15 @@ }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } } ], "responses": { @@ -4747,24 +4779,26 @@ } }, "200": { - "description": "Success" - }, - "204": { - "description": "No Content" + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } } }, "x-ms-examples": { - "Delete Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/delete.json" + "CreateOrGetStartPendingUpload Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json" } } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { "get": { "tags": [ - "CodeVersion" + "ComponentContainer" ], - "summary": "Get version.", - "operationId": "CodeVersions_Get", + "summary": "List component containers.", + "operationId": "ComponentContainers_List", "produces": [ "application/json" ], @@ -4779,21 +4813,37 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { @@ -4806,25 +4856,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeVersionResource" + "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "Get Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/get.json" + "List Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { + "delete": { "tags": [ - "CodeVersion" - ], - "summary": "Create or update version.", - "operationId": "CodeVersions_CreateOrUpdate", - "consumes": [ - "application/json" + "ComponentContainer" ], + "summary": "Delete container.", + "operationId": "ComponentContainers_Delete", "produces": [ "application/json" ], @@ -4841,29 +4893,12 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "description": "Container name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Version entity to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/CodeVersionResource" - } } ], "responses": { @@ -4874,35 +4909,24 @@ } }, "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/CodeVersionResource" - } + "description": "Success" }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/CodeVersionResource" - } + "204": { + "description": "No Content" } }, "x-ms-examples": { - "CreateOrUpdate Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" + "Delete Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/delete.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish": { - "post": { + }, + "get": { "tags": [ - "CodeVersion" - ], - "summary": "Publish version asset into registry.", - "operationId": "CodeVersions_Publish", - "consumes": [ - "application/json" + "ComponentContainer" ], + "summary": "Get container.", + "operationId": "ComponentContainers_Get", "produces": [ "application/json" ], @@ -4923,24 +4947,8 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" - } } ], "responses": { @@ -4951,43 +4959,24 @@ } }, "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" } } }, "x-ms-examples": { - "Publish Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/publish.json" + "Get Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/get.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": { - "post": { + }, + "put": { "tags": [ - "CodeVersion" + "ComponentContainer" ], - "summary": "Generate a storage location and credential for the client to upload a code asset to.", - "operationId": "CodeVersions_CreateOrGetStartPendingUpload", + "summary": "Create or update container.", + "operationId": "ComponentContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5007,16 +4996,10 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "description": "Container name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -5024,10 +5007,10 @@ { "in": "body", "name": "body", - "description": "Pending upload request object", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/PendingUploadRequestDto" + "$ref": "#/definitions/ComponentContainerResource" } } ], @@ -5039,26 +5022,32 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/PendingUploadResponseDto" + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" } } }, "x-ms-examples": { - "CreateOrGetStartPendingUpload Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json" + "CreateOrUpdate Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { "get": { "tags": [ - "ComponentContainer" + "ComponentVersion" ], - "summary": "List component containers.", - "operationId": "ComponentContainers_List", + "summary": "List component versions.", + "operationId": "ComponentVersions_List", "produces": [ "application/json" ], @@ -5072,9 +5061,29 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, + { + "in": "path", + "name": "name", + "description": "Component name.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, @@ -5116,13 +5125,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/list.json" + "List Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/list.json" } }, "x-ms-pageable": { @@ -5130,13 +5139,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { "delete": { "tags": [ - "ComponentContainer" + "ComponentVersion" ], - "summary": "Delete container.", - "operationId": "ComponentContainers_Delete", + "summary": "Delete version.", + "operationId": "ComponentVersions_Delete", "produces": [ "application/json" ], @@ -5157,6 +5166,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5176,17 +5192,17 @@ } }, "x-ms-examples": { - "Delete Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/delete.json" + "Delete Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/delete.json" } } }, "get": { "tags": [ - "ComponentContainer" + "ComponentVersion" ], - "summary": "Get container.", - "operationId": "ComponentContainers_Get", + "summary": "Get version.", + "operationId": "ComponentVersions_Get", "produces": [ "application/json" ], @@ -5207,6 +5223,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5221,22 +5244,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/ComponentVersionResource" } } }, "x-ms-examples": { - "Get Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/get.json" + "Get Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/get.json" } } }, "put": { "tags": [ - "ComponentContainer" + "ComponentVersion" ], - "summary": "Create or update container.", - "operationId": "ComponentContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "ComponentVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5261,16 +5284,23 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/ComponentVersionResource" } } ], @@ -5284,30 +5314,33 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/ComponentVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/ComponentVersionResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish": { + "post": { "tags": [ "ComponentVersion" ], - "summary": "List component versions.", - "operationId": "ComponentVersions_List", + "summary": "Publish version asset into registry.", + "operationId": "ComponentVersions_Publish", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -5324,7 +5357,14 @@ { "in": "path", "name": "name", - "description": "Component name.", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -5332,17 +5372,75 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Publish Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { + "get": { + "tags": [ + "DataContainer" + ], + "summary": "List data containers.", + "operationId": "DataContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" @@ -5385,13 +5483,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/list.json" + "List Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/list.json" } }, "x-ms-pageable": { @@ -5399,13 +5497,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { "delete": { "tags": [ - "ComponentVersion" + "DataContainer" ], - "summary": "Delete version.", - "operationId": "ComponentVersions_Delete", + "summary": "Delete container.", + "operationId": "DataContainers_Delete", "produces": [ "application/json" ], @@ -5426,13 +5524,6 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5452,17 +5543,17 @@ } }, "x-ms-examples": { - "Delete Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/delete.json" + "Delete Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/delete.json" } } }, "get": { "tags": [ - "ComponentVersion" + "DataContainer" ], - "summary": "Get version.", - "operationId": "ComponentVersions_Get", + "summary": "Get container.", + "operationId": "DataContainers_Get", "produces": [ "application/json" ], @@ -5483,13 +5574,6 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5504,22 +5588,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/DataContainerResource" } } }, "x-ms-examples": { - "Get Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/get.json" + "Get Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/get.json" } } }, "put": { "tags": [ - "ComponentVersion" + "DataContainer" ], - "summary": "Create or update version.", - "operationId": "ComponentVersions_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "DataContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5544,23 +5628,16 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/DataContainerResource" } } ], @@ -5574,33 +5651,30 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/DataContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/DataContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" + "CreateOrUpdate Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { + "get": { "tags": [ - "ComponentVersion" - ], - "summary": "Publish version asset into registry.", - "operationId": "ComponentVersions_Publish", - "consumes": [ - "application/json" + "DataVersion" ], + "summary": "List data versions in the data container", + "operationId": "DataVersions_List", "produces": [ "application/json" ], @@ -5617,27 +5691,60 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Data container's name", "required": true, "type": "string" }, { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" }, { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } } ], @@ -5649,107 +5756,15 @@ } }, "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" } } }, "x-ms-examples": { - "Publish Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/publish.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { - "get": { - "tags": [ - "DataContainer" - ], - "summary": "List data containers.", - "operationId": "DataContainers_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" - } - } - }, - "x-ms-examples": { - "List Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/list.json" + "List Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/list.json" } }, "x-ms-pageable": { @@ -5757,13 +5772,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { "delete": { "tags": [ - "DataContainer" + "DataVersion" ], - "summary": "Delete container.", - "operationId": "DataContainers_Delete", + "summary": "Delete version.", + "operationId": "DataVersions_Delete", "produces": [ "application/json" ], @@ -5784,6 +5799,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5803,17 +5825,17 @@ } }, "x-ms-examples": { - "Delete Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/delete.json" + "Delete Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/delete.json" } } }, "get": { "tags": [ - "DataContainer" + "DataVersion" ], - "summary": "Get container.", - "operationId": "DataContainers_Get", + "summary": "Get version.", + "operationId": "DataVersions_Get", "produces": [ "application/json" ], @@ -5834,6 +5856,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5848,22 +5877,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } }, "x-ms-examples": { - "Get Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/get.json" + "Get Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/get.json" } } }, "put": { "tags": [ - "DataContainer" + "DataVersion" ], - "summary": "Create or update container.", - "operationId": "DataContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "DataVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5888,16 +5917,23 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } ], @@ -5911,30 +5947,33 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish": { + "post": { "tags": [ "DataVersion" ], - "summary": "List data versions in the data container", - "operationId": "DataVersions_List", + "summary": "Publish version asset into registry.", + "operationId": "DataVersions_Publish", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -5951,60 +5990,27 @@ { "in": "path", "name": "name", - "description": "Data container's name", + "description": "Container name.", "required": true, "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "$orderBy", - "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, "type": "string" }, { - "in": "query", - "name": "$top", - "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", - "type": "integer", - "format": "int32" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "$tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" } } ], @@ -6016,29 +6022,43 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "List Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/list.json" + "Publish Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/publish.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { + "get": { "tags": [ - "DataVersion" + "Datastore" ], - "summary": "Delete version.", - "operationId": "DataVersions_Delete", + "summary": "List datastores.", + "operationId": "Datastores_List", "produces": [ "application/json" ], @@ -6053,17 +6073,103 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "name", - "description": "Container name.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "in": "query", + "name": "isDefault", + "description": "Filter down to the workspace default datastore.", + "type": "boolean" + }, + { + "in": "query", + "name": "names", + "description": "Names of datastores to return.", + "type": "array", + "items": { + "type": "string" + } + }, + { + "in": "query", + "name": "searchText", + "description": "Text to search for in the datastore names.", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "Order by property (createdtime | modifiedtime | name).", + "type": "string" + }, + { + "in": "query", + "name": "orderByAsc", + "description": "Order by property in ascending order.", + "type": "boolean", + "default": false + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List datastores.": { + "$ref": "./examples/Datastore/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { + "delete": { + "tags": [ + "Datastore" + ], + "summary": "Delete datastore.", + "operationId": "Datastores_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, "type": "string" }, { @@ -6085,17 +6191,17 @@ } }, "x-ms-examples": { - "Delete Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/delete.json" + "Delete datastore.": { + "$ref": "./examples/Datastore/delete.json" } } }, "get": { "tags": [ - "DataVersion" + "Datastore" ], - "summary": "Get version.", - "operationId": "DataVersions_Get", + "summary": "Get datastore.", + "operationId": "Datastores_Get", "produces": [ "application/json" ], @@ -6112,14 +6218,7 @@ { "in": "path", "name": "name", - "description": "Container name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", + "description": "Datastore name.", "required": true, "type": "string" }, @@ -6137,22 +6236,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DatastoreResource" } } }, "x-ms-examples": { - "Get Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/get.json" + "Get datastore.": { + "$ref": "./examples/Datastore/get.json" } } }, "put": { "tags": [ - "DataVersion" + "Datastore" ], - "summary": "Create or update version.", - "operationId": "DataVersions_CreateOrUpdate", + "summary": "Create or update datastore.", + "operationId": "Datastores_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6172,28 +6271,28 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Datastore name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "skipValidation", + "description": "Flag to skip validation.", + "type": "boolean", + "default": false }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Datastore entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DatastoreResource" } } ], @@ -6207,33 +6306,39 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DatastoreResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DatastoreResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" + "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { "post": { "tags": [ - "DataVersion" - ], - "summary": "Publish version asset into registry.", - "operationId": "DataVersions_Publish", - "consumes": [ - "application/json" + "Datastore" ], + "summary": "Get datastore secrets.", + "operationId": "Datastores_ListSecrets", "produces": [ "application/json" ], @@ -6250,28 +6355,12 @@ { "in": "path", "name": "name", - "description": "Container name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", + "description": "Datastore name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" - } } ], "responses": { @@ -6282,43 +6371,27 @@ } }, "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "description": "Success", + "schema": { + "description": "Base definition for datastore secrets.", + "$ref": "#/definitions/DatastoreSecrets" } } }, "x-ms-examples": { - "Publish Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/publish.json" + "Get datastore secrets.": { + "$ref": "./examples/Datastore/listSecrets.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { "get": { "tags": [ - "Datastore" + "EnvironmentContainer" ], - "summary": "List datastores.", - "operationId": "Datastores_List", + "summary": "List environment containers.", + "operationId": "EnvironmentContainers_List", "produces": [ "application/json" ], @@ -6340,45 +6413,30 @@ }, { "in": "query", - "name": "count", - "description": "Maximum number of results to return.", - "type": "integer", - "format": "int32", - "default": 30 - }, - { - "in": "query", - "name": "isDefault", - "description": "Filter down to the workspace default datastore.", - "type": "boolean" - }, - { - "in": "query", - "name": "names", - "description": "Names of datastores to return.", - "type": "array", - "items": { - "type": "string" - } - }, - { - "in": "query", - "name": "searchText", - "description": "Text to search for in the datastore names.", - "type": "string" - }, - { - "in": "query", - "name": "orderBy", - "description": "Order by property (createdtime | modifiedtime | name).", - "type": "string" - }, - { - "in": "query", - "name": "orderByAsc", - "description": "Order by property in ascending order.", - "type": "boolean", - "default": false + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { @@ -6391,13 +6449,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List datastores.": { - "$ref": "./examples/Datastore/list.json" + "List Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/list.json" } }, "x-ms-pageable": { @@ -6405,13 +6463,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { "delete": { "tags": [ - "Datastore" + "EnvironmentContainer" ], - "summary": "Delete datastore.", - "operationId": "Datastores_Delete", + "summary": "Delete container.", + "operationId": "EnvironmentContainers_Delete", "produces": [ "application/json" ], @@ -6428,7 +6486,7 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -6451,17 +6509,17 @@ } }, "x-ms-examples": { - "Delete datastore.": { - "$ref": "./examples/Datastore/delete.json" + "Delete Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" } } }, "get": { "tags": [ - "Datastore" + "EnvironmentContainer" ], - "summary": "Get datastore.", - "operationId": "Datastores_Get", + "summary": "Get container.", + "operationId": "EnvironmentContainers_Get", "produces": [ "application/json" ], @@ -6478,7 +6536,7 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -6496,22 +6554,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "x-ms-examples": { - "Get datastore.": { - "$ref": "./examples/Datastore/get.json" + "Get Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/get.json" } } }, "put": { "tags": [ - "Datastore" + "EnvironmentContainer" ], - "summary": "Create or update datastore.", - "operationId": "Datastores_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "EnvironmentContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6531,7 +6589,7 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -6539,20 +6597,13 @@ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, - { - "in": "query", - "name": "skipValidation", - "description": "Flag to skip validation.", - "type": "boolean", - "default": false - }, { "in": "body", "name": "body", - "description": "Datastore entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } ], @@ -6566,39 +6617,30 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/EnvironmentContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { - "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { - "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { - "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { - "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" + "CreateOrUpdate Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { + "get": { "tags": [ - "Datastore" + "EnvironmentVersion" ], - "summary": "Get datastore secrets.", - "operationId": "Datastores_ListSecrets", + "summary": "List versions.", + "operationId": "EnvironmentVersions_List", "produces": [ "application/json" ], @@ -6615,58 +6657,25 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "description": "Base definition for datastore secrets.", - "$ref": "#/definitions/DatastoreSecrets" - } - } - }, - "x-ms-examples": { - "Get datastore secrets.": { - "$ref": "./examples/Datastore/listSecrets.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { - "get": { - "tags": [ - "EnvironmentContainer" - ], - "summary": "List environment containers.", - "operationId": "EnvironmentContainers_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" @@ -6709,13 +6718,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/list.json" + "List Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/list.json" } }, "x-ms-pageable": { @@ -6723,13 +6732,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { "delete": { "tags": [ - "EnvironmentContainer" + "EnvironmentVersion" ], - "summary": "Delete container.", - "operationId": "EnvironmentContainers_Delete", + "summary": "Delete version.", + "operationId": "EnvironmentVersions_Delete", "produces": [ "application/json" ], @@ -6750,6 +6759,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -6769,17 +6785,17 @@ } }, "x-ms-examples": { - "Delete Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" + "Delete Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" } } }, "get": { "tags": [ - "EnvironmentContainer" + "EnvironmentVersion" ], - "summary": "Get container.", - "operationId": "EnvironmentContainers_Get", + "summary": "Get version.", + "operationId": "EnvironmentVersions_Get", "produces": [ "application/json" ], @@ -6800,6 +6816,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -6814,22 +6837,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } }, "x-ms-examples": { - "Get Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/get.json" + "Get Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/get.json" } } }, "put": { "tags": [ - "EnvironmentContainer" + "EnvironmentVersion" ], - "summary": "Create or update container.", - "operationId": "EnvironmentContainers_CreateOrUpdate", + "summary": "Creates or updates an EnvironmentVersion.", + "operationId": "EnvironmentVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6849,21 +6872,28 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Name of EnvironmentVersion. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version of EnvironmentVersion.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Definition of EnvironmentVersion.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } ], @@ -6877,30 +6907,33 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/EnvironmentVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish": { + "post": { "tags": [ "EnvironmentVersion" ], - "summary": "List versions.", - "operationId": "EnvironmentVersions_List", + "summary": "Publish version asset into registry.", + "operationId": "EnvironmentVersions_Publish", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -6917,7 +6950,14 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -6925,25 +6965,89 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Publish Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { + "get": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "List featurestore entity containers.", + "operationId": "FeaturesetContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, { "in": "query", "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -6966,6 +7070,32 @@ } ] } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "name", + "description": "name for the featureset", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" } ], "responses": { @@ -6978,13 +7108,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/list.json" + "List Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/list.json" } }, "x-ms-pageable": { @@ -6992,13 +7122,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { + "get": { "tags": [ - "EnvironmentVersion" + "Feature" ], - "summary": "Delete version.", - "operationId": "EnvironmentVersions_Delete", + "summary": "List Features.", + "operationId": "Features_List", "produces": [ "application/json" ], @@ -7014,77 +7144,77 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "featuresetName", + "description": "Featureset name. This is case-sensitive.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "featuresetVersion", + "description": "Featureset Version identifier. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success" }, - "204": { - "description": "No Content" - } - }, - "x-ms-examples": { - "Delete Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" - } - } - }, - "get": { - "tags": [ - "EnvironmentVersion" - ], - "summary": "Get version.", - "operationId": "EnvironmentVersions_Get", - "produces": [ - "application/json" - ], - "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "featureName", + "description": "feature name.", + "type": "string" }, { - "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, + "in": "query", + "name": "description", + "description": "Description of the featureset.", "type": "string" }, { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "pageSize", + "description": "Page size.", + "type": "integer", + "format": "int32", + "default": 1000 } ], "responses": { @@ -7097,25 +7227,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/FeatureResourceArmPaginatedResult" } } }, "x-ms-examples": { - "Get Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/get.json" + "List Feature.": { + "$ref": "./examples/Feature/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { + "get": { "tags": [ - "EnvironmentVersion" - ], - "summary": "Creates or updates an EnvironmentVersion.", - "operationId": "EnvironmentVersions_CreateOrUpdate", - "consumes": [ - "application/json" + "Feature" ], + "summary": "Get feature.", + "operationId": "Features_Get", "produces": [ "application/json" ], @@ -7131,30 +7263,29 @@ }, { "in": "path", - "name": "name", - "description": "Name of EnvironmentVersion. This is case-sensitive.", + "name": "featuresetName", + "description": "Feature set name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "version", - "description": "Version of EnvironmentVersion.", + "name": "featuresetVersion", + "description": "Feature set version identifier. This is case-sensitive.", "required": true, "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "featureName", + "description": "Feature Name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "in": "body", - "name": "body", - "description": "Definition of EnvironmentVersion.", - "required": true, - "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -7165,35 +7296,26 @@ } }, "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" - } - }, - "201": { - "description": "Created", + "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/FeatureResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" + "Get Feature.": { + "$ref": "./examples/Feature/get.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { + "delete": { "tags": [ - "EnvironmentVersion" - ], - "summary": "Publish version asset into registry.", - "operationId": "EnvironmentVersions_Publish", - "consumes": [ - "application/json" + "FeaturesetContainer" ], + "summary": "Delete container.", + "operationId": "FeaturesetContainers_Delete", "produces": [ "application/json" ], @@ -7210,28 +7332,12 @@ { "in": "path", "name": "name", - "description": "Container name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" - } } ], "responses": { @@ -7247,6 +7353,11 @@ "202": { "description": "Accepted", "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, "Location": { "description": "URI to poll for asynchronous operation result.", "type": "string" @@ -7259,26 +7370,27 @@ "minimum": 10 } } + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Publish Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/publish.json" + "Delete Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { + }, "get": { "tags": [ "FeaturesetContainer" ], - "summary": "List featurestore entity containers.", - "operationId": "FeaturesetContainers_List", + "summary": "Get container.", + "operationId": "FeaturesetContainers_GetEntity", "produces": [ "application/json" ], @@ -7293,69 +7405,77 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + }, + "x-ms-examples": { + "GetEntity Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" + } + } + }, + "put": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Create or update container.", + "operationId": "FeaturesetContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "query", - "name": "pageSize", - "description": "page size", - "type": "integer", - "format": "int32", - "default": 20 + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", + "in": "path", "name": "name", - "description": "name for the featureset", - "type": "string" + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "in": "query", - "name": "description", - "description": "description for the feature set", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "createdBy", - "description": "createdBy user name", - "type": "string" + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } } ], "responses": { @@ -7366,29 +7486,47 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "List Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/list.json" + "CreateOrUpdate Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { "get": { "tags": [ - "Feature" + "FeaturesetVersion" ], - "summary": "List Features.", - "operationId": "Features_List", + "summary": "List versions.", + "operationId": "FeaturesetVersions_List", "produces": [ "application/json" ], @@ -7404,17 +7542,9 @@ }, { "in": "path", - "name": "featuresetName", + "name": "name", "description": "Featureset name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "featuresetVersion", - "description": "Featureset Version identifier. This is case-sensitive.", - "required": true, "type": "string" }, { @@ -7429,18 +7559,6 @@ "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", "type": "string" }, - { - "in": "query", - "name": "featureName", - "description": "feature name.", - "type": "string" - }, - { - "in": "query", - "name": "description", - "description": "Description of the featureset.", - "type": "string" - }, { "in": "query", "name": "listViewType", @@ -7471,10 +7589,40 @@ { "in": "query", "name": "pageSize", - "description": "Page size.", + "description": "page size", "type": "integer", "format": "int32", - "default": 1000 + "default": 20 + }, + { + "in": "query", + "name": "versionName", + "description": "name for the featureset version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featureset version", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set version", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" } ], "responses": { @@ -7487,13 +7635,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeatureResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Feature.": { - "$ref": "./examples/Feature/list.json" + "List Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/list.json" } }, "x-ms-pageable": { @@ -7501,13 +7649,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { + "delete": { "tags": [ - "Feature" + "FeaturesetVersion" ], - "summary": "Get feature.", - "operationId": "Features_Get", + "summary": "Delete version.", + "operationId": "FeaturesetVersions_Delete", "produces": [ "application/json" ], @@ -7523,26 +7671,17 @@ }, { "in": "path", - "name": "featuresetName", - "description": "Feature set name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "featuresetVersion", - "description": "Feature set version identifier. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", - "name": "featureName", - "description": "Feature Name. This is case-sensitive.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -7556,26 +7695,49 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeatureResource" + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Get Feature.": { - "$ref": "./examples/Feature/get.json" + "Delete Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { - "delete": { + }, + "get": { "tags": [ - "FeaturesetContainer" + "FeaturesetVersion" ], - "summary": "Delete container.", - "operationId": "FeaturesetContainers_Delete", + "summary": "Get version.", + "operationId": "FeaturesetVersions_Get", "produces": [ "application/json" ], @@ -7596,6 +7758,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -7608,49 +7777,27 @@ } }, "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" } - }, - "204": { - "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" + "Get Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/get.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } }, - "get": { + "put": { "tags": [ - "FeaturesetContainer" + "FeaturesetVersion" + ], + "summary": "Create or update version.", + "operationId": "FeaturesetVersions_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "Get container.", - "operationId": "FeaturesetContainers_GetEntity", "produces": [ "application/json" ], @@ -7669,10 +7816,27 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } } ], "responses": { @@ -7683,24 +7847,47 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" + "$ref": "#/definitions/FeaturesetVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "GetEntity Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" + "CreateOrUpdate Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { + "post": { "tags": [ - "FeaturesetContainer" + "FeaturesetVersion" ], - "summary": "Create or update container.", - "operationId": "FeaturesetContainers_CreateOrUpdate", + "summary": "Backfill.", + "operationId": "FeaturesetVersions_Backfill", "consumes": [ "application/json" ], @@ -7722,8 +7909,14 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -7731,10 +7924,10 @@ { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Feature set version backfill request entity.", "required": true, "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" + "$ref": "#/definitions/FeaturesetVersionBackfillRequest" } } ], @@ -7746,47 +7939,46 @@ } }, "200": { - "description": "Create or update request is successful.", + "description": "Success", "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" + "$ref": "#/definitions/FeaturesetVersionBackfillResponse" } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" - }, + "202": { + "description": "Accepted", "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", + "Location": { + "description": "URI to poll for asynchronous operation result.", "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 } } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" + "Backfill Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { "get": { "tags": [ - "FeaturesetVersion" + "FeaturestoreEntityContainer" ], - "summary": "List versions.", - "operationId": "FeaturesetVersions_List", + "summary": "List featurestore entity containers.", + "operationId": "FeaturestoreEntityContainers_List", "produces": [ "application/json" ], @@ -7800,13 +7992,6 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "name", - "description": "Featureset name. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, @@ -7856,20 +8041,14 @@ }, { "in": "query", - "name": "versionName", - "description": "name for the featureset version", - "type": "string" - }, - { - "in": "query", - "name": "version", - "description": "featureset version", + "name": "name", + "description": "name for the featurestore entity", "type": "string" }, { "in": "query", "name": "description", - "description": "description for the feature set version", + "description": "description for the featurestore entity", "type": "string" }, { @@ -7877,12 +8056,6 @@ "name": "createdBy", "description": "createdBy user name", "type": "string" - }, - { - "in": "query", - "name": "stage", - "description": "Specifies the featurestore stage", - "type": "string" } ], "responses": { @@ -7895,13 +8068,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/list.json" + "List Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" } }, "x-ms-pageable": { @@ -7909,13 +8082,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { "delete": { "tags": [ - "FeaturesetVersion" + "FeaturestoreEntityContainer" ], - "summary": "Delete version.", - "operationId": "FeaturesetVersions_Delete", + "summary": "Delete container.", + "operationId": "FeaturestoreEntityContainers_Delete", "produces": [ "application/json" ], @@ -7936,13 +8109,6 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -7983,8 +8149,8 @@ } }, "x-ms-examples": { - "Delete Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" + "Delete Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" } }, "x-ms-long-running-operation": true, @@ -7994,70 +8160,10 @@ }, "get": { "tags": [ - "FeaturesetVersion" - ], - "summary": "Get version.", - "operationId": "FeaturesetVersions_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - } - } - }, - "x-ms-examples": { - "Get Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/get.json" - } - } - }, - "put": { - "tags": [ - "FeaturesetVersion" - ], - "summary": "Create or update version.", - "operationId": "FeaturesetVersions_CreateOrUpdate", - "consumes": [ - "application/json" + "FeaturestoreEntityContainer" ], + "summary": "Get container.", + "operationId": "FeaturestoreEntityContainers_GetEntity", "produces": [ "application/json" ], @@ -8076,27 +8182,10 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Version entity to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - } } ], "responses": { @@ -8106,48 +8195,25 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - } - }, - "201": { - "description": "Created", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" + "GetEntity Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { - "post": { + }, + "put": { "tags": [ - "FeaturesetVersion" + "FeaturestoreEntityContainer" ], - "summary": "Backfill.", - "operationId": "FeaturesetVersions_Backfill", + "summary": "Create or update container.", + "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8169,14 +8235,8 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -8184,10 +8244,10 @@ { "in": "body", "name": "body", - "description": "Feature set version backfill request entity.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/FeaturesetVersionBackfillRequest" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } } ], @@ -8199,46 +8259,47 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturesetVersionBackfillResponse" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + }, "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" } } } }, "x-ms-examples": { - "Backfill Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" + "CreateOrUpdate Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": { "get": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturestoreEntityVersion" ], - "summary": "List featurestore entity containers.", - "operationId": "FeaturestoreEntityContainers_List", + "summary": "List versions.", + "operationId": "FeaturestoreEntityVersions_List", "produces": [ "application/json" ], @@ -8252,6 +8313,13 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, + { + "in": "path", + "name": "name", + "description": "Feature entity name. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, @@ -8301,14 +8369,20 @@ }, { "in": "query", - "name": "name", - "description": "name for the featurestore entity", + "name": "versionName", + "description": "name for the featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featurestore entity version", "type": "string" }, { "in": "query", "name": "description", - "description": "description for the featurestore entity", + "description": "description for the feature entity version", "type": "string" }, { @@ -8316,6 +8390,12 @@ "name": "createdBy", "description": "createdBy user name", "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" } ], "responses": { @@ -8328,13 +8408,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" + "List Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" } }, "x-ms-pageable": { @@ -8342,13 +8422,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { "delete": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturestoreEntityVersion" ], - "summary": "Delete container.", - "operationId": "FeaturestoreEntityContainers_Delete", + "summary": "Delete version.", + "operationId": "FeaturestoreEntityVersions_Delete", "produces": [ "application/json" ], @@ -8369,6 +8449,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -8409,8 +8496,8 @@ } }, "x-ms-examples": { - "Delete Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" + "Delete Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" } }, "x-ms-long-running-operation": true, @@ -8420,10 +8507,10 @@ }, "get": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturestoreEntityVersion" ], - "summary": "Get container.", - "operationId": "FeaturestoreEntityContainers_GetEntity", + "summary": "Get version.", + "operationId": "FeaturestoreEntityVersions_Get", "produces": [ "application/json" ], @@ -8444,6 +8531,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -8458,22 +8552,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } } }, "x-ms-examples": { - "GetEntity Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" + "Get Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" } } }, "put": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturestoreEntityVersion" ], - "summary": "Create or update container.", - "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8498,16 +8592,23 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } } ], @@ -8521,13 +8622,13 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -8543,8 +8644,8 @@ } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -8553,13 +8654,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { "get": { "tags": [ - "FeaturestoreEntityVersion" + "Job" ], - "summary": "List versions.", - "operationId": "FeaturestoreEntityVersions_List", + "summary": "Lists Jobs in the workspace.", + "operationId": "Jobs_List", "produces": [ "application/json" ], @@ -8573,13 +8674,6 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "name", - "description": "Feature entity name. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, @@ -8588,73 +8682,47 @@ }, { "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, - { - "in": "query", - "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } - }, - { - "in": "query", - "name": "pageSize", - "description": "page size", - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "in": "query", - "name": "versionName", - "description": "name for the featurestore entity version", - "type": "string" - }, - { - "in": "query", - "name": "version", - "description": "featurestore entity version", + "name": "jobType", + "description": "Type of job to be returned.", "type": "string" }, { "in": "query", - "name": "description", - "description": "description for the feature entity version", + "name": "tag", + "description": "Jobs returned will have this tag key.", "type": "string" }, { "in": "query", - "name": "createdBy", - "description": "createdBy user name", - "type": "string" + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } }, { "in": "query", - "name": "stage", - "description": "Specifies the featurestore stage", + "name": "properties", + "description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2", "type": "string" } ], @@ -8668,13 +8736,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" + "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" + "List Command Job.": { + "$ref": "./examples/Job/CommandJob/list.json" + }, + "List AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/list.json" + }, + "List Sweep Job.": { + "$ref": "./examples/Job/SweepJob/list.json" + }, + "List Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/list.json" } }, "x-ms-pageable": { @@ -8682,13 +8759,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { "delete": { "tags": [ - "FeaturestoreEntityVersion" + "Job" ], - "summary": "Delete version.", - "operationId": "FeaturestoreEntityVersions_Delete", + "summary": "Deletes a Job (asynchronous).", + "operationId": "Jobs_Delete", "produces": [ "application/json" ], @@ -8704,15 +8781,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, @@ -8756,8 +8826,8 @@ } }, "x-ms-examples": { - "Delete Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" + "Delete Job.": { + "$ref": "./examples/Job/delete.json" } }, "x-ms-long-running-operation": true, @@ -8767,10 +8837,10 @@ }, "get": { "tags": [ - "FeaturestoreEntityVersion" + "Job" ], - "summary": "Get version.", - "operationId": "FeaturestoreEntityVersions_Get", + "summary": "Gets a Job by name/id.", + "operationId": "Jobs_Get", "produces": [ "application/json" ], @@ -8786,15 +8856,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, @@ -8812,22 +8875,31 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" + "$ref": "#/definitions/JobBaseResource" } } }, "x-ms-examples": { - "Get Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" + "Get Command Job.": { + "$ref": "./examples/Job/CommandJob/get.json" + }, + "Get AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/get.json" + }, + "Get Sweep Job.": { + "$ref": "./examples/Job/SweepJob/get.json" + }, + "Get Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/get.json" } } }, "put": { "tags": [ - "FeaturestoreEntityVersion" + "Job" ], - "summary": "Create or update version.", - "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", + "summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", + "operationId": "Jobs_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8846,29 +8918,22 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Job definition object.", "required": true, "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" + "$ref": "#/definitions/JobBaseResource" } } ], @@ -8882,45 +8947,39 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" + "$ref": "#/definitions/JobBaseResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/JobBaseResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json" + "CreateOrUpdate Command Job.": { + "$ref": "./examples/Job/CommandJob/createOrUpdate.json" + }, + "CreateOrUpdate AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" + }, + "CreateOrUpdate Sweep Job.": { + "$ref": "./examples/Job/SweepJob/createOrUpdate.json" + }, + "CreateOrUpdate Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { + "post": { "tags": [ "Job" ], - "summary": "Lists Jobs in the workspace.", - "operationId": "Jobs_List", + "summary": "Cancels a Job (asynchronous).", + "operationId": "Jobs_Cancel", "produces": [ "application/json" ], @@ -8935,55 +8994,79 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, - { - "in": "query", - "name": "jobType", - "description": "Type of job to be returned.", - "type": "string" + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } }, + "200": { + "description": "Success" + } + }, + "x-ms-examples": { + "Cancel Job.": { + "$ref": "./examples/Job/cancel.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions": { + "get": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "List containers.", + "operationId": "MarketplaceSubscriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ { - "in": "query", - "name": "tag", - "description": "Jobs returned will have this tag key.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", - "name": "properties", - "description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -8996,22 +9079,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" + "$ref": "#/definitions/MarketplaceSubscriptionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Command Job.": { - "$ref": "./examples/Job/CommandJob/list.json" - }, - "List AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/list.json" - }, - "List Sweep Job.": { - "$ref": "./examples/Job/SweepJob/list.json" - }, - "List Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/list.json" + "List Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/list.json" } }, "x-ms-pageable": { @@ -9019,13 +9093,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}": { "delete": { "tags": [ - "Job" + "MarketplaceSubscription" ], - "summary": "Deletes a Job (asynchronous).", - "operationId": "Jobs_Delete", + "summary": "Delete Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_Delete", "produces": [ "application/json" ], @@ -9041,10 +9115,11 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Marketplace Subscription name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -9057,8 +9132,8 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Success" + "204": { + "description": "No Content" }, "202": { "description": "Accepted", @@ -9080,14 +9155,11 @@ "minimum": 10 } } - }, - "204": { - "description": "No Content" } }, "x-ms-examples": { - "Delete Job.": { - "$ref": "./examples/Job/delete.json" + "Delete Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/delete.json" } }, "x-ms-long-running-operation": true, @@ -9097,10 +9169,10 @@ }, "get": { "tags": [ - "Job" + "MarketplaceSubscription" ], - "summary": "Gets a Job by name/id.", - "operationId": "Jobs_Get", + "summary": "Get container.", + "operationId": "MarketplaceSubscriptions_Get", "produces": [ "application/json" ], @@ -9116,8 +9188,8 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Container name.", "required": true, "type": "string" }, @@ -9135,31 +9207,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" } } }, "x-ms-examples": { - "Get Command Job.": { - "$ref": "./examples/Job/CommandJob/get.json" - }, - "Get AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/get.json" - }, - "Get Sweep Job.": { - "$ref": "./examples/Job/SweepJob/get.json" - }, - "Get Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/get.json" + "Get Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/get.json" } } }, "put": { "tags": [ - "Job" + "MarketplaceSubscription" ], - "summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", - "operationId": "Jobs_CreateOrUpdate", + "summary": "Create or update Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -9178,8 +9241,8 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Marketplace Subscription name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -9190,10 +9253,10 @@ { "in": "body", "name": "body", - "description": "Job definition object.", + "description": "Marketplace Subscription entity to apply during operation.", "required": true, "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" } } ], @@ -9207,98 +9270,35 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/JobBaseResource" - } - } - }, - "x-ms-examples": { - "CreateOrUpdate Command Job.": { - "$ref": "./examples/Job/CommandJob/createOrUpdate.json" - }, - "CreateOrUpdate AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" - }, - "CreateOrUpdate Sweep Job.": { - "$ref": "./examples/Job/SweepJob/createOrUpdate.json" - }, - "CreateOrUpdate Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { - "post": { - "tags": [ - "Job" - ], - "summary": "Cancels a Job (asynchronous).", - "operationId": "Jobs_Cancel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "202": { - "description": "Accepted", + "$ref": "#/definitions/MarketplaceSubscriptionResource" + }, "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" } } - }, - "200": { - "description": "Success" } }, "x-ms-examples": { - "Cancel Job.": { - "$ref": "./examples/Job/cancel.json" + "CreateOrUpdate Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "original-uri" } } }, @@ -11429,17 +11429,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServerlessEndpointTrackedResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -11485,6 +11485,15 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "No Content" + }, "202": { "description": "Accepted", "headers": { @@ -11505,15 +11514,6 @@ "minimum": 10 } } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -11557,17 +11557,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServerlessEndpointTrackedResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } } }, "x-ms-examples": { @@ -11620,6 +11620,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success", "schema": { @@ -11646,12 +11652,6 @@ "minimum": 10 } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -11705,6 +11705,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -11727,12 +11733,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -11774,22 +11774,22 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EndpointAuthKeys" - } - }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } } }, "x-ms-examples": { @@ -11844,6 +11844,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success", "schema": { @@ -11865,12 +11871,6 @@ "minimum": 10 } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -11994,23 +11994,23 @@ } ], "properties": { - "isAnonymous": { - "description": "If the name version are system generated (anonymous registration).", + "isArchived": { + "description": "Is the asset archived?", "default": false, "type": "boolean", "x-ms-mutability": [ "create", - "read" + "read", + "update" ] }, - "isArchived": { - "description": "Is the asset archived?", + "isAnonymous": { + "description": "If the name version are system generated (anonymous registration).", "default": false, "type": "boolean", "x-ms-mutability": [ "create", - "read", - "update" + "read" ] } }, @@ -12062,6 +12062,12 @@ ], "type": "object", "properties": { + "uri": { + "description": "[Required] Input Asset URI.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, "mode": { "description": "Input Asset Delivery Mode.", "default": "ReadOnlyMount", @@ -12070,12 +12076,6 @@ "create", "read" ] - }, - "uri": { - "description": "[Required] Input Asset URI.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" } }, "additionalProperties": false @@ -12084,6 +12084,11 @@ "description": "Asset output type.", "type": "object", "properties": { + "uri": { + "description": "Output Asset URI.", + "type": "string", + "x-nullable": true + }, "mode": { "description": "Output Asset Delivery Mode.", "default": "ReadWriteMount", @@ -12092,11 +12097,6 @@ "create", "read" ] - }, - "uri": { - "description": "Output Asset URI.", - "type": "string", - "x-nullable": true } }, "additionalProperties": false @@ -12175,6 +12175,15 @@ } ], "properties": { + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, "environmentId": { "description": "The ARM resource ID of the Environment specification for the job.\r\nThis is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.", "type": "string", @@ -12197,6 +12206,10 @@ ], "x-nullable": true }, + "taskDetails": { + "description": "[Required] This represents scenario which can be one of Tables/NLP/Image", + "$ref": "#/definitions/AutoMLVertical" + }, "outputs": { "description": "Mapping of output data bindings used in the job.", "type": "object", @@ -12219,19 +12232,6 @@ "read" ], "x-nullable": true - }, - "resources": { - "description": "Compute Resource configuration for the job.", - "default": "{}", - "$ref": "#/definitions/JobResourceConfiguration", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "taskDetails": { - "description": "[Required] This represents scenario which can be one of Tables/NLP/Image", - "$ref": "#/definitions/AutoMLVertical" } }, "x-ms-discriminator-value": "AutoML", @@ -12245,16 +12245,6 @@ ], "type": "object", "properties": { - "logVerbosity": { - "description": "Log verbosity for the job.", - "default": "Info", - "$ref": "#/definitions/LogVerbosity" - }, - "targetColumnName": { - "description": "Target column name: This is prediction values column.\r\nAlso known as label column name in context of classification tasks.", - "type": "string", - "x-nullable": true - }, "taskType": { "description": "[Required] Task type for AutoMLJob.", "$ref": "#/definitions/TaskType", @@ -12263,9 +12253,19 @@ "read" ] }, + "logVerbosity": { + "description": "Log verbosity for the job.", + "default": "Info", + "$ref": "#/definitions/LogVerbosity" + }, "trainingData": { "description": "[Required] Training data input.", "$ref": "#/definitions/MLTableJobInput" + }, + "targetColumnName": { + "description": "Target column name: This is prediction values column.\r\nAlso known as label column name in context of classification tasks.", + "type": "string", + "x-nullable": true } }, "discriminator": "taskType" @@ -12411,15 +12411,6 @@ } ], "properties": { - "serviceDataAccessAuthIdentity": { - "description": "Indicates which identity to use to authenticate service data access to customer's storage.", - "default": "None", - "$ref": "#/definitions/ServiceDataAccessAuthIdentity", - "x-ms-mutability": [ - "create", - "read" - ] - }, "storeName": { "description": "[Required] Azure Data Lake store name.", "minLength": 1, @@ -12429,6 +12420,15 @@ "create", "read" ] + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] } }, "x-ms-discriminator-value": "AzureDataLakeGen1", @@ -12450,6 +12450,16 @@ } ], "properties": { + "filesystem": { + "description": "[Required] The name of the Data Lake Gen2 filesystem.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, "accountName": { "description": "[Required] Storage account name.", "minLength": 1, @@ -12470,16 +12480,6 @@ ], "x-nullable": true }, - "filesystem": { - "description": "[Required] The name of the Data Lake Gen2 filesystem.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, "protocol": { "description": "Protocol used to communicate with the storage account.", "type": "string", @@ -12507,13 +12507,13 @@ "description": "Base definition for Azure datastore contents configuration.", "type": "object", "properties": { - "resourceGroup": { - "description": "Azure Resource Group name", + "subscriptionId": { + "description": "Azure Subscription Id", "type": "string", "x-nullable": true }, - "subscriptionId": { - "description": "Azure Subscription Id", + "resourceGroup": { + "description": "Azure Resource Group name", "type": "string", "x-nullable": true } @@ -12557,16 +12557,6 @@ "read" ] }, - "endpoint": { - "description": "Azure cloud endpoint for the storage account.", - "type": "string", - "example": "core.windows.net", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "fileShareName": { "description": "[Required] The name of the Azure file share that the datastore points to.", "minLength": 1, @@ -12577,6 +12567,16 @@ "read" ] }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "protocol": { "description": "Protocol used to communicate with the storage account.", "type": "string", @@ -12609,15 +12609,15 @@ } ], "properties": { - "slackAmount": { + "slackFactor": { "format": "float", - "description": "Absolute distance allowed from the best performing run.", + "description": "Ratio of the allowed distance from the best performing run.", "default": 0, "type": "number" }, - "slackFactor": { + "slackAmount": { "format": "float", - "description": "Ratio of the allowed distance from the best performing run.", + "description": "Absolute distance allowed from the best performing run.", "default": 0, "type": "number" } @@ -12650,16 +12650,10 @@ "default": -1, "type": "integer" }, - "loggingLevel": { - "description": "Logging level for batch inference operation.", - "default": "Info", - "$ref": "#/definitions/BatchLoggingLevel" - }, - "maxConcurrencyPerInstance": { - "format": "int32", - "description": "Indicates maximum number of parallelism per instance.", - "default": 1, - "type": "integer" + "retrySettings": { + "description": "Retry Settings for the batch inference operation.\r\nIf not provided, will default to the defaults defined in BatchRetrySettings.", + "$ref": "#/definitions/BatchRetrySettings", + "x-nullable": true }, "miniBatchSize": { "format": "int64", @@ -12667,11 +12661,22 @@ "default": 10, "type": "integer" }, + "loggingLevel": { + "description": "Logging level for batch inference operation.", + "default": "Info", + "$ref": "#/definitions/BatchLoggingLevel" + }, "model": { "description": "Reference to the model asset for the endpoint deployment.", "$ref": "#/definitions/AssetReferenceBase", "x-nullable": true }, + "maxConcurrencyPerInstance": { + "format": "int32", + "description": "Indicates maximum number of parallelism per instance.", + "default": 1, + "type": "integer" + }, "outputAction": { "description": "Indicates how the output will be organized.", "default": "AppendRow", @@ -12682,6 +12687,11 @@ "default": "predictions.csv", "type": "string" }, + "resources": { + "description": "Indicates compute configuration for the job.\r\nIf not provided, will default to the defaults defined in ResourceConfiguration.", + "$ref": "#/definitions/DeploymentResourceConfiguration", + "x-nullable": true + }, "provisioningState": { "description": "Provisioning state for the endpoint deployment.", "$ref": "#/definitions/DeploymentProvisioningState", @@ -12689,16 +12699,6 @@ "x-ms-mutability": [ "read" ] - }, - "resources": { - "description": "Indicates compute configuration for the job.\r\nIf not provided, will default to the defaults defined in ResourceConfiguration.", - "$ref": "#/definitions/DeploymentResourceConfiguration", - "x-nullable": true - }, - "retrySettings": { - "description": "Retry Settings for the batch inference operation.\r\nIf not provided, will default to the defaults defined in BatchRetrySettings.", - "$ref": "#/definitions/BatchRetrySettings", - "x-nullable": true } }, "x-ms-client-name": "BatchDeploymentProperties", @@ -12751,17 +12751,17 @@ } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchDeployment" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/BatchDeployment" + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { "description": "Sku details required for ARM contract for Autoscaling.", @@ -12775,16 +12775,16 @@ "description": "A paginated list of BatchDeployment entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type BatchDeployment.", "type": "array", "items": { "$ref": "#/definitions/BatchDeploymentTrackedResource" } + }, + "nextLink": { + "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -12839,17 +12839,17 @@ } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchEndpoint" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/BatchEndpoint" + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { "description": "Sku details required for ARM contract for Autoscaling.", @@ -12863,16 +12863,16 @@ "description": "A paginated list of BatchEndpoint entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type BatchEndpoint.", "type": "array", "items": { "$ref": "#/definitions/BatchEndpointTrackedResource" } + }, + "nextLink": { + "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -13003,15 +13003,15 @@ "type": "string", "x-nullable": true }, - "credential": { - "description": "Credential info to access storage account", - "$ref": "#/definitions/PendingUploadCredentialDto", - "x-nullable": true - }, "storageAccountArmId": { "description": "Arm ID of the storage account to use", "type": "string", "x-nullable": true + }, + "credential": { + "description": "Credential info to access storage account", + "$ref": "#/definitions/PendingUploadCredentialDto", + "x-nullable": true } }, "additionalProperties": false @@ -13280,35 +13280,35 @@ "type": "string", "x-nullable": true }, - "clientId": { - "format": "uuid", - "description": "[Required] Service principal client ID.", - "type": "string" - }, "resourceUrl": { "description": "Resource the service principal has access to.", "type": "string", "x-nullable": true }, - "secrets": { - "description": "[Required] Service principal secrets.", - "$ref": "#/definitions/CertificateDatastoreSecrets", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true - }, "tenantId": { "format": "uuid", "description": "[Required] ID of the tenant to which the service principal belongs.", "type": "string" }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, "thumbprint": { "description": "[Required] Thumbprint of the certificate used for authentication.", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "type": "string" + }, + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/CertificateDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true } }, "x-ms-discriminator-value": "Certificate", @@ -13344,11 +13344,6 @@ } ], "properties": { - "positiveLabel": { - "description": "Positive label for binary metrics calculation.", - "type": "string", - "x-nullable": true - }, "primaryMetric": { "description": "Primary metric for the task.", "default": "AUCWeighted", @@ -13358,6 +13353,11 @@ "description": "Inputs for training phase for an AutoML Job.", "$ref": "#/definitions/ClassificationTrainingSettings", "x-nullable": true + }, + "positiveLabel": { + "description": "Positive label for binary metrics calculation.", + "type": "string", + "x-nullable": true } }, "x-ms-discriminator-value": "Classification", @@ -13624,16 +13624,16 @@ "description": "A paginated list of CodeContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type CodeContainer.", "type": "array", "items": { "$ref": "#/definitions/CodeContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -13689,16 +13689,16 @@ "description": "A paginated list of CodeVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type CodeVersion.", "type": "array", "items": { "$ref": "#/definitions/CodeVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -13706,10 +13706,11 @@ "Collection": { "type": "object", "properties": { - "clientId": { - "description": "The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth.", - "type": "string", - "x-nullable": true + "samplingRate": { + "format": "double", + "description": "The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default.", + "default": 1, + "type": "number" }, "dataCollectionMode": { "description": "Enable or disable data collection.", @@ -13721,11 +13722,10 @@ "type": "string", "x-nullable": true }, - "samplingRate": { - "format": "double", - "description": "The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default.", - "default": 1, - "type": "number" + "clientId": { + "description": "The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth.", + "type": "string", + "x-nullable": true } }, "additionalProperties": false @@ -13763,6 +13763,15 @@ } ], "properties": { + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, "codeId": { "description": "ARM resource ID of the code asset.", "type": "string", @@ -13782,15 +13791,6 @@ "read" ] }, - "distribution": { - "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", - "$ref": "#/definitions/DistributionConfiguration", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "environmentId": { "description": "[Required] The ARM resource ID of the Environment specification for the job.", "minLength": 1, @@ -13801,11 +13801,12 @@ "read" ] }, - "environmentVariables": { - "description": "Environment variables included in the job.", + "inputs": { + "description": "Mapping of input data bindings used in the job.", "type": "object", "additionalProperties": { - "type": "string", + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", "x-nullable": true }, "x-ms-mutability": [ @@ -13814,12 +13815,12 @@ ], "x-nullable": true }, - "inputs": { - "description": "Mapping of input data bindings used in the job.", + "outputs": { + "description": "Mapping of output data bindings used in the job.", "type": "object", "additionalProperties": { - "description": "Command job definition.", - "$ref": "#/definitions/JobInput", + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", "x-nullable": true }, "x-ms-mutability": [ @@ -13828,6 +13829,15 @@ ], "x-nullable": true }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "limits": { "description": "Command Job limit.", "$ref": "#/definitions/CommandJobLimits", @@ -13837,12 +13847,11 @@ ], "x-nullable": true }, - "outputs": { - "description": "Mapping of output data bindings used in the job.", + "environmentVariables": { + "description": "Environment variables included in the job.", "type": "object", "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", + "type": "string", "x-nullable": true }, "x-ms-mutability": [ @@ -13868,15 +13877,6 @@ "read" ], "x-nullable": true - }, - "resources": { - "description": "Compute Resource configuration for the job.", - "default": "{}", - "$ref": "#/definitions/JobResourceConfiguration", - "x-ms-mutability": [ - "create", - "read" - ] } }, "x-ms-discriminator-value": "Command", @@ -13938,16 +13938,16 @@ "description": "A paginated list of ComponentContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ComponentContainer.", "type": "array", "items": { "$ref": "#/definitions/ComponentContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -14015,16 +14015,16 @@ "description": "A paginated list of ComponentVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ComponentVersion.", "type": "array", "items": { "$ref": "#/definitions/ComponentVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -14033,13 +14033,13 @@ "description": "Resource requirements for each container instance within an online deployment.", "type": "object", "properties": { - "containerResourceLimits": { - "description": "Container resource limit info:", + "containerResourceRequests": { + "description": "Container resource request info:", "$ref": "#/definitions/ContainerResourceSettings", "x-nullable": true }, - "containerResourceRequests": { - "description": "Container resource request info:", + "containerResourceLimits": { + "description": "Container resource limit info:", "$ref": "#/definitions/ContainerResourceSettings", "x-nullable": true } @@ -14055,17 +14055,17 @@ "example": "1", "x-nullable": true }, - "gpu": { - "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", - "type": "string", - "example": "1", - "x-nullable": true - }, "memory": { "description": "Memory size request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", "type": "string", "example": "2Gi", "x-nullable": true + }, + "gpu": { + "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true } }, "additionalProperties": false @@ -14091,20 +14091,19 @@ "additionalProperties": false }, "ContentSafety": { - "additionalProperties": false, + "required": [ + "contentSafetyStatus" + ], + "type": "object", "properties": { "contentSafetyStatus": { - "$ref": "#/definitions/ContentSafetyStatus", - "description": "[Required] Specifies the status of content safety." + "description": "[Required] Specifies the status of content safety.", + "$ref": "#/definitions/ContentSafetyStatus" } }, - "required": [ - "contentSafetyStatus" - ], - "type": "object" + "additionalProperties": false }, "ContentSafetyStatus": { - "additionalProperties": false, "description": "Specifies the status of content safety.", "enum": [ "Enabled", @@ -14112,8 +14111,8 @@ ], "type": "string", "x-ms-enum": { - "modelAsString": true, "name": "ContentSafetyStatus", + "modelAsString": true, "values": [ { "value": "Enabled" @@ -14122,7 +14121,8 @@ "value": "Disabled" } ] - } + }, + "additionalProperties": false }, "CreateMonitorAction": { "required": [ @@ -14228,6 +14228,15 @@ ], "type": "object", "properties": { + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "metric": { "description": "[Required] The user-defined metric to calculate.", "minLength": 1, @@ -14237,15 +14246,6 @@ "create", "read" ] - }, - "threshold": { - "description": "The threshold value. If null, a default value will be set depending on the selected metric.", - "$ref": "#/definitions/MonitoringThreshold", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true } }, "additionalProperties": false @@ -14288,16 +14288,6 @@ } ], "properties": { - "componentId": { - "description": "[Required] Reference to the component asset used to calculate the custom metrics.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, "inputAssets": { "description": "Monitoring assets to take as input. Key is the component input port name, value is the data asset.", "type": "object", @@ -14326,6 +14316,16 @@ ], "x-nullable": true }, + "componentId": { + "description": "[Required] Reference to the component asset used to calculate the custom metrics.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, "metricThresholds": { "description": "[Required] A list of metrics to calculate and their associated thresholds.", "type": "array", @@ -14488,15 +14488,15 @@ "x-nullable": true } }, - "requestLogging": { - "description": "The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional.", - "$ref": "#/definitions/RequestLogging", - "x-nullable": true - }, "rollingRate": { "description": "When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file.\r\nIf the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/.\r\nIf it's day, all data will be collected in blob path /yyyy/MM/dd/.\r\nThe other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly.", "default": "Hour", "$ref": "#/definitions/RollingRateType" + }, + "requestLogging": { + "description": "The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional.", + "$ref": "#/definitions/RequestLogging", + "x-nullable": true } }, "additionalProperties": false @@ -14549,16 +14549,16 @@ "description": "A paginated list of DataContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type DataContainer.", "type": "array", "items": { "$ref": "#/definitions/DataContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -14602,12 +14602,9 @@ } ], "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, + "features": { + "description": "The feature filter which identifies which feature to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", "x-ms-mutability": [ "create", "read" @@ -14623,15 +14620,6 @@ ], "x-nullable": true }, - "features": { - "description": "The feature filter which identifies which feature to calculate drift over.", - "$ref": "#/definitions/MonitoringFeatureFilterBase", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "metricThresholds": { "description": "[Required] A list of metrics to calculate and their associated thresholds.", "type": "array", @@ -14659,6 +14647,18 @@ "create", "read" ] + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "DataDrift", @@ -14673,13 +14673,13 @@ } ], "properties": { - "datastoreId": { - "description": "ARM resource ID of the datastore where the asset is located.", + "path": { + "description": "The path of the file/directory in the datastore.", "type": "string", "x-nullable": true }, - "path": { - "description": "The path of the file/directory in the datastore.", + "datastoreId": { + "description": "ARM resource ID of the datastore where the asset is located.", "type": "string", "x-nullable": true } @@ -14726,12 +14726,9 @@ } ], "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, + "features": { + "description": "The features to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", "x-ms-mutability": [ "create", "read" @@ -14747,15 +14744,6 @@ ], "x-nullable": true }, - "features": { - "description": "The features to calculate drift over.", - "$ref": "#/definitions/MonitoringFeatureFilterBase", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "metricThresholds": { "description": "[Required] A list of metrics to calculate and their associated thresholds.", "type": "array", @@ -14783,6 +14771,18 @@ "create", "read" ] + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "DataQuality", @@ -14915,16 +14915,16 @@ "description": "A paginated list of DataVersionBase entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type DataVersionBase.", "type": "array", "items": { "$ref": "#/definitions/DataVersionBaseResource" } + }, + "nextLink": { + "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -14942,10 +14942,6 @@ } ], "properties": { - "credentials": { - "description": "[Required] Account credentials.", - "$ref": "#/definitions/DatastoreCredentials" - }, "datastoreType": { "description": "[Required] Storage type backing the datastore.", "$ref": "#/definitions/DatastoreType" @@ -14957,6 +14953,10 @@ "x-ms-mutability": [ "read" ] + }, + "credentials": { + "description": "[Required] Account credentials.", + "$ref": "#/definitions/DatastoreCredentials" } }, "discriminator": "datastoreType", @@ -15000,16 +15000,16 @@ "description": "A paginated list of Datastore entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type Datastore.", "type": "array", "items": { "$ref": "#/definitions/DatastoreResource" } + }, + "nextLink": { + "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -15153,6 +15153,11 @@ "description": "Publishing destination registry asset information", "type": "object", "properties": { + "registryName": { + "description": "Destination registry name", + "type": "string", + "x-nullable": true + }, "destinationName": { "description": "Destination asset name", "type": "string", @@ -15162,11 +15167,6 @@ "description": "Destination asset version", "type": "string", "x-nullable": true - }, - "registryName": { - "description": "Destination registry name", - "type": "string", - "x-nullable": true } }, "additionalProperties": false @@ -15223,13 +15223,13 @@ } ], "properties": { - "password": { - "description": "DockerCredential user password", + "userName": { + "description": "DockerCredential user name", "type": "string", "x-nullable": true }, - "userName": { - "description": "DockerCredential user name", + "password": { + "description": "DockerCredential user password", "type": "string", "x-nullable": true } @@ -15244,11 +15244,9 @@ ], "type": "object", "properties": { - "delayEvaluation": { - "format": "int32", - "description": "Number of intervals by which to delay the first evaluation.", - "default": 0, - "type": "integer" + "policyType": { + "description": "[Required] Name of policy configuration", + "$ref": "#/definitions/EarlyTerminationPolicyType" }, "evaluationInterval": { "format": "int32", @@ -15256,9 +15254,11 @@ "default": 0, "type": "integer" }, - "policyType": { - "description": "[Required] Name of policy configuration", - "$ref": "#/definitions/EarlyTerminationPolicyType" + "delayEvaluation": { + "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", + "default": 0, + "type": "integer" } }, "discriminator": "policyType" @@ -15392,6 +15392,11 @@ "type": "string", "x-nullable": true }, + "tokenType": { + "description": "Access token type.", + "type": "string", + "x-nullable": true + }, "expiryTimeUtc": { "format": "int64", "description": "Access token expiry time (UTC).", @@ -15403,11 +15408,6 @@ "description": "Refresh access token after time (UTC).", "default": 0, "type": "integer" - }, - "tokenType": { - "description": "Access token type.", - "type": "string", - "x-nullable": true } }, "additionalProperties": false @@ -15441,23 +15441,13 @@ "description": "Base definition for endpoint deployment.", "type": "object", "properties": { - "codeConfiguration": { - "description": "Code configuration for the endpoint deployment.", - "$ref": "#/definitions/CodeConfiguration", - "x-nullable": true - }, "description": { "description": "Description of the endpoint deployment.", "type": "string", "x-nullable": true }, - "environmentId": { - "description": "ARM resource ID or AssetId of the environment specification for the endpoint deployment.", - "type": "string", - "x-nullable": true - }, - "environmentVariables": { - "description": "Environment variables configuration for the deployment.", + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", "type": "object", "additionalProperties": { "type": "string", @@ -15465,8 +15455,18 @@ }, "x-nullable": true }, - "properties": { - "description": "Property dictionary. Properties can be added, but not removed or altered.", + "codeConfiguration": { + "description": "Code configuration for the endpoint deployment.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + }, + "environmentId": { + "description": "ARM resource ID or AssetId of the environment specification for the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables configuration for the deployment.", "type": "object", "additionalProperties": { "type": "string", @@ -15484,24 +15484,11 @@ ], "type": "object", "properties": { - "authMode": { - "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", - "$ref": "#/definitions/EndpointAuthMode" - }, "description": { "description": "Description of the inference endpoint.", "type": "string", "x-nullable": true }, - "keys": { - "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", - "$ref": "#/definitions/EndpointAuthKeys", - "x-ms-mutability": [ - "create" - ], - "x-ms-secret": true, - "x-nullable": true - }, "properties": { "description": "Property dictionary. Properties can be added, but not removed or altered.", "type": "object", @@ -15530,6 +15517,19 @@ "read" ], "x-nullable": true + }, + "authMode": { + "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", + "$ref": "#/definitions/EndpointAuthMode" + }, + "keys": { + "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", + "$ref": "#/definitions/EndpointAuthKeys", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true, + "x-nullable": true } }, "additionalProperties": false @@ -15647,16 +15647,16 @@ "description": "A paginated list of EnvironmentContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type EnvironmentContainer.", "type": "array", "items": { "$ref": "#/definitions/EnvironmentContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -15691,18 +15691,18 @@ } ], "properties": { - "autoRebuild": { - "description": "Defines if image needs to be rebuilt based on base image changes.", - "default": "Disabled", - "$ref": "#/definitions/AutoRebuildSetting", + "environmentType": { + "description": "Environment type is either user managed or curated by the Azure ML service\r\n", + "$ref": "#/definitions/EnvironmentType", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ] }, - "build": { - "description": "Configuration settings for Docker build context.", - "$ref": "#/definitions/BuildContext", + "image": { + "description": "Name of the image that will be used for the environment.\r\n", + "type": "string", + "example": "docker.io/tensorflow/serving:latest", "x-ms-mutability": [ "create", "read" @@ -15716,18 +15716,18 @@ "read" ] }, - "environmentType": { - "description": "Environment type is either user managed or curated by the Azure ML service\r\n", - "$ref": "#/definitions/EnvironmentType", - "readOnly": true, + "build": { + "description": "Configuration settings for Docker build context.", + "$ref": "#/definitions/BuildContext", "x-ms-mutability": [ + "create", "read" ] }, - "image": { - "description": "Name of the image that will be used for the environment.\r\n", - "type": "string", - "example": "docker.io/tensorflow/serving:latest", + "osType": { + "description": "The OS type of the environment.", + "default": "Linux", + "$ref": "#/definitions/OperatingSystemType", "x-ms-mutability": [ "create", "read" @@ -15741,10 +15741,10 @@ "read" ] }, - "osType": { - "description": "The OS type of the environment.", - "default": "Linux", - "$ref": "#/definitions/OperatingSystemType", + "autoRebuild": { + "description": "Defines if image needs to be rebuilt based on base image changes.", + "default": "Disabled", + "$ref": "#/definitions/AutoRebuildSetting", "x-ms-mutability": [ "create", "read" @@ -15791,16 +15791,16 @@ "description": "A paginated list of EnvironmentVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type EnvironmentVersion.", "type": "array", "items": { "$ref": "#/definitions/EnvironmentVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -15814,15 +15814,15 @@ } ], "properties": { - "dataType": { - "description": "Specifies type", - "default": "String", - "$ref": "#/definitions/FeatureDataType" - }, "featureName": { "description": "Specifies name", "type": "string", "x-nullable": true + }, + "dataType": { + "description": "Specifies type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" } }, "x-ms-client-name": "FeatureProperties", @@ -15840,19 +15840,15 @@ { "$ref": "#/definitions/MonitoringSignalBase" } - ], - "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, + ], + "properties": { + "metricThreshold": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/FeatureAttributionMetricThreshold", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, "featureImportanceSettings": { "description": "[Required] The settings for computing feature importance.", @@ -15862,14 +15858,6 @@ "read" ] }, - "metricThreshold": { - "description": "[Required] A list of metrics to calculate and their associated thresholds.", - "$ref": "#/definitions/FeatureAttributionMetricThreshold", - "x-ms-mutability": [ - "create", - "read" - ] - }, "productionData": { "description": "[Required] The data which drift will be calculated for.", "type": "array", @@ -15890,6 +15878,18 @@ "create", "read" ] + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "FeatureAttributionDrift", @@ -15918,14 +15918,6 @@ ], "type": "object", "properties": { - "metric": { - "description": "[Required] The feature attribution metric to calculate.", - "$ref": "#/definitions/FeatureAttributionMetric", - "x-ms-mutability": [ - "create", - "read" - ] - }, "threshold": { "description": "The threshold value. If null, a default value will be set depending on the selected metric.", "$ref": "#/definitions/MonitoringThreshold", @@ -15934,6 +15926,14 @@ "read" ], "x-nullable": true + }, + "metric": { + "description": "[Required] The feature attribution metric to calculate.", + "$ref": "#/definitions/FeatureAttributionMetric", + "x-ms-mutability": [ + "create", + "read" + ] } }, "additionalProperties": false @@ -16068,16 +16068,16 @@ "description": "A paginated list of Feature entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of Feature objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type Feature.", "type": "array", "items": { "$ref": "#/definitions/FeatureResource" } + }, + "nextLink": { + "description": "The link to the next page of Feature objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16113,15 +16113,15 @@ "description": "Specifies the feature window", "type": "object", "properties": { - "featureWindowEnd": { + "featureWindowStart": { "format": "date-time", - "description": "Specifies the feature window end time", + "description": "Specifies the feature window start time", "type": "string", "x-nullable": true }, - "featureWindowStart": { + "featureWindowEnd": { "format": "date-time", - "description": "Specifies the feature window start time", + "description": "Specifies the feature window end time", "type": "string", "x-nullable": true } @@ -16173,16 +16173,16 @@ "description": "A paginated list of FeaturesetContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of FeaturesetContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type FeaturesetContainer.", "type": "array", "items": { "$ref": "#/definitions/FeaturesetContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of FeaturesetContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16208,6 +16208,21 @@ } ], "properties": { + "specification": { + "description": "Specifies the feature spec details", + "$ref": "#/definitions/FeaturesetSpecification", + "x-nullable": true + }, + "materializationSettings": { + "description": "Specifies the materialization settings", + "$ref": "#/definitions/MaterializationSettings", + "x-nullable": true + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + }, "entities": { "description": "Specifies list of entities", "type": "array", @@ -16216,11 +16231,6 @@ }, "x-nullable": true }, - "materializationSettings": { - "description": "Specifies the materialization settings", - "$ref": "#/definitions/MaterializationSettings", - "x-nullable": true - }, "provisioningState": { "description": "Provisioning state for the featureset version container.", "$ref": "#/definitions/AssetProvisioningState", @@ -16228,16 +16238,6 @@ "x-ms-mutability": [ "read" ] - }, - "specification": { - "description": "Specifies the feature spec details", - "$ref": "#/definitions/FeaturesetSpecification", - "x-nullable": true - }, - "stage": { - "description": "Specifies the asset stage", - "type": "string", - "x-nullable": true } }, "x-ms-client-name": "FeaturesetVersionProperties", @@ -16247,18 +16247,11 @@ "description": "Request payload for creating a backfill request for a given feature set version", "type": "object", "properties": { - "dataAvailabilityStatus": { - "description": "Specified the data availability status that you want to backfill", - "type": "array", - "items": { - "$ref": "#/definitions/DataAvailabilityStatus" - } - }, - "description": { + "displayName": { "description": "Specifies description", "type": "string" }, - "displayName": { + "description": { "description": "Specifies description", "type": "string" }, @@ -16267,12 +16260,19 @@ "$ref": "#/definitions/FeatureWindow", "x-nullable": true }, + "dataAvailabilityStatus": { + "description": "Specified the data availability status that you want to backfill", + "type": "array", + "items": { + "$ref": "#/definitions/DataAvailabilityStatus" + } + }, "jobId": { "description": "Specify the jobId to retry the failed materialization", "type": "string" }, - "properties": { - "description": "Specifies the properties", + "tags": { + "description": "Specifies the tags", "type": "object", "additionalProperties": { "type": "string", @@ -16291,8 +16291,8 @@ "x-nullable": true } }, - "tags": { - "description": "Specifies the tags", + "properties": { + "description": "Specifies the properties", "type": "object", "additionalProperties": { "type": "string", @@ -16341,16 +16341,16 @@ "description": "A paginated list of FeaturesetVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of FeaturesetVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type FeaturesetVersion.", "type": "array", "items": { "$ref": "#/definitions/FeaturesetVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of FeaturesetVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16400,16 +16400,16 @@ "description": "A paginated list of FeaturestoreEntityContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type FeaturestoreEntityContainer.", "type": "array", "items": { "$ref": "#/definitions/FeaturestoreEntityContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16432,6 +16432,11 @@ "x-nullable": true, "x-ms-identifiers": [] }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + }, "provisioningState": { "description": "Provisioning state for the featurestore entity version.", "$ref": "#/definitions/AssetProvisioningState", @@ -16439,11 +16444,6 @@ "x-ms-mutability": [ "read" ] - }, - "stage": { - "description": "Specifies the asset stage", - "type": "string", - "x-nullable": true } }, "x-ms-client-name": "FeaturestoreEntityVersionProperties", @@ -16473,16 +16473,16 @@ "description": "A paginated list of FeaturestoreEntityVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of FeaturestoreEntityVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type FeaturestoreEntityVersion.", "type": "array", "items": { "$ref": "#/definitions/FeaturestoreEntityVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16606,16 +16606,16 @@ } ], "properties": { - "forecastingSettings": { - "description": "Forecasting task specific inputs.", - "$ref": "#/definitions/ForecastingSettings", - "x-nullable": true - }, "primaryMetric": { "description": "Primary metric for forecasting task.", "default": "NormalizedRootMeanSquaredError", "$ref": "#/definitions/ForecastingPrimaryMetrics" }, + "forecastingSettings": { + "description": "Forecasting task specific inputs.", + "$ref": "#/definitions/ForecastingSettings", + "x-nullable": true + }, "trainingSettings": { "description": "Inputs for training phase for an AutoML Job.", "$ref": "#/definitions/ForecastingTrainingSettings", @@ -16775,27 +16775,44 @@ "type": "string", "x-nullable": true }, - "cvStepSize": { - "format": "int32", - "description": "Number of periods between the origin time of one CV fold and the next fold. For\r\nexample, if `CVStepSize` = 3 for daily data, the origin time for each fold will be\r\nthree days apart.", - "type": "integer", + "timeColumnName": { + "description": "The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.", + "type": "string", "x-nullable": true }, - "featureLags": { - "description": "Flag for generating lags for the numeric features with 'auto' or null.", - "default": "None", - "$ref": "#/definitions/FeatureLags" + "targetLags": { + "description": "The number of past periods to lag from the target column.", + "$ref": "#/definitions/TargetLags", + "x-nullable": true + }, + "targetRollingWindowSize": { + "description": "The number of past periods used to create a rolling window average of the target column.", + "$ref": "#/definitions/TargetRollingWindowSize", + "x-nullable": true }, "forecastHorizon": { "description": "The desired maximum forecast horizon in units of time-series frequency.", "default": "{\"Mode\": \"Custom\", \"Value\": 1}", "$ref": "#/definitions/ForecastHorizon" }, + "timeSeriesIdColumnNames": { + "description": "The names of columns used to group a timeseries. It can be used to create multiple series.\r\nIf grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, "frequency": { "description": "When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly, etc. The forecast frequency is dataset frequency by default.", "type": "string", "x-nullable": true }, + "featureLags": { + "description": "Flag for generating lags for the numeric features with 'auto' or null.", + "default": "None", + "$ref": "#/definitions/FeatureLags" + }, "seasonality": { "description": "Set time series seasonality as an integer multiple of the series frequency.\r\nIf seasonality is set to 'auto', it will be inferred.", "default": "{\"Mode\": \"Auto\"}", @@ -16806,38 +16823,21 @@ "default": "Auto", "$ref": "#/definitions/ShortSeriesHandlingConfiguration" }, + "useStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "default": "None", + "$ref": "#/definitions/UseStl" + }, "targetAggregateFunction": { "description": "The function to be used to aggregate the time series target column to conform to a user specified frequency.\r\nIf the TargetAggregateFunction is set i.e. not 'None', but the freq parameter is not set, the error is raised. The possible target aggregation functions are: \"sum\", \"max\", \"min\" and \"mean\".", "default": "None", "$ref": "#/definitions/TargetAggregationFunction" }, - "targetLags": { - "description": "The number of past periods to lag from the target column.", - "$ref": "#/definitions/TargetLags", - "x-nullable": true - }, - "targetRollingWindowSize": { - "description": "The number of past periods used to create a rolling window average of the target column.", - "$ref": "#/definitions/TargetRollingWindowSize", - "x-nullable": true - }, - "timeColumnName": { - "description": "The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.", - "type": "string", - "x-nullable": true - }, - "timeSeriesIdColumnNames": { - "description": "The names of columns used to group a timeseries. It can be used to create multiple series.\r\nIf grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.", - "type": "array", - "items": { - "type": "string" - }, + "cvStepSize": { + "format": "int32", + "description": "Number of periods between the origin time of one CV fold and the next fold. For\r\nexample, if `CVStepSize` = 3 for daily data, the origin time for each fold will be\r\nthree days apart.", + "type": "integer", "x-nullable": true - }, - "useStl": { - "description": "Configure STL Decomposition of the time-series target column.", - "default": "None", - "$ref": "#/definitions/UseStl" } }, "additionalProperties": false @@ -16879,15 +16879,15 @@ "type": "string", "x-nullable": true }, - "credential": { - "description": "Credential info to access storage account", - "$ref": "#/definitions/DataReferenceCredential", - "x-nullable": true - }, "storageAccountArmId": { "description": "The ARM id of the storage account", "type": "string", "x-nullable": true + }, + "credential": { + "description": "Credential info to access storage account", + "$ref": "#/definitions/DataReferenceCredential", + "x-nullable": true } }, "additionalProperties": false @@ -17107,16 +17107,10 @@ "x-ms-discriminator-value": "ImageInstanceSegmentation", "additionalProperties": false }, - "ImageLimitSettings": { - "description": "Limit settings for the AutoML job.", - "type": "object", - "properties": { - "maxConcurrentTrials": { - "format": "int32", - "description": "Maximum number of concurrent AutoML iterations.", - "default": 1, - "type": "integer" - }, + "ImageLimitSettings": { + "description": "Limit settings for the AutoML job.", + "type": "object", + "properties": { "maxTrials": { "format": "int32", "description": "Maximum number of AutoML iterations.", @@ -17128,6 +17122,12 @@ "description": "AutoML job timeout.", "default": "P7D", "type": "string" + }, + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum number of concurrent AutoML iterations.", + "default": 1, + "type": "integer" } }, "additionalProperties": false @@ -17184,18 +17184,18 @@ "example": "choice(1, 5)", "x-nullable": true }, - "enableOnnxNormalization": { - "description": "Enable normalization when exporting ONNX model.", - "type": "string", - "example": "choice(true, false)", - "x-nullable": true - }, "evaluationFrequency": { "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", "type": "string", "example": "choice(1, 5)", "x-nullable": true }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, "gradientAccumulationStep": { "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", "type": "string", @@ -17437,17 +17437,17 @@ "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", "type": "object", "properties": { + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "boolean", + "x-nullable": true + }, "advancedSettings": { "description": "Settings for advanced scenarios.", "type": "string", "example": "key1:val1;key2;key3:val3;key4", "x-nullable": true }, - "amsGradient": { - "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", - "type": "boolean", - "x-nullable": true - }, "augmentations": { "description": "Settings for using Augmentations.", "type": "string", @@ -17472,16 +17472,16 @@ "type": "integer", "x-nullable": true }, - "checkpointModel": { - "description": "The pretrained checkpoint model for incremental training.", - "$ref": "#/definitions/MLFlowModelJobInput", - "x-nullable": true - }, "checkpointRunId": { "description": "The id of a previous run that has a pretrained checkpoint for incremental training.", "type": "string", "x-nullable": true }, + "checkpointModel": { + "description": "The pretrained checkpoint model for incremental training.", + "$ref": "#/definitions/MLFlowModelJobInput", + "x-nullable": true + }, "distributed": { "description": "Whether to use distributed training.", "type": "boolean", @@ -17504,17 +17504,17 @@ "type": "integer", "x-nullable": true }, - "enableOnnxNormalization": { - "description": "Enable normalization when exporting ONNX model.", - "type": "boolean", - "x-nullable": true - }, "evaluationFrequency": { "format": "int32", "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", "type": "integer", "x-nullable": true }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "boolean", + "x-nullable": true + }, "gradientAccumulationStep": { "format": "int32", "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", @@ -17798,14 +17798,14 @@ ], "type": "object", "properties": { + "samplingAlgorithm": { + "description": "[Required] Type of the hyperparameter sampling algorithms.", + "$ref": "#/definitions/SamplingAlgorithmType" + }, "earlyTermination": { "description": "Type of early termination policy.", "$ref": "#/definitions/EarlyTerminationPolicy", "x-nullable": true - }, - "samplingAlgorithm": { - "description": "[Required] Type of the hyperparameter sampling algorithms.", - "$ref": "#/definitions/SamplingAlgorithmType" } }, "additionalProperties": false @@ -17844,15 +17844,15 @@ "description": "DTO object representing index column", "type": "object", "properties": { - "columnName": { - "description": "Specifies the column name", - "type": "string", - "x-nullable": true - }, "dataType": { "description": "Specifies the data type", "default": "String", "$ref": "#/definitions/FeatureDataType" + }, + "columnName": { + "description": "Specifies the column name", + "type": "string", + "x-nullable": true } }, "additionalProperties": false @@ -17942,17 +17942,16 @@ } ], "properties": { - "componentId": { - "description": "ARM resource ID of the component resource.", - "type": "string", + "jobType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobType", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, - "computeId": { - "description": "ARM resource ID of the compute resource.", + "displayName": { + "description": "Display name of job.", "type": "string", "x-ms-mutability": [ "create", @@ -17960,14 +17959,13 @@ ], "x-nullable": true }, - "displayName": { - "description": "Display name of job.", - "type": "string", + "status": { + "description": "Status of the job.", + "$ref": "#/definitions/JobStatus", + "readOnly": true, "x-ms-mutability": [ - "create", "read" - ], - "x-nullable": true + ] }, "experimentName": { "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.", @@ -17978,9 +17976,18 @@ "read" ] }, - "identity": { - "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\r\nDefaults to AmlToken if null.", - "$ref": "#/definitions/IdentityConfiguration", + "services": { + "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/JobService", + "x-nullable": true + }, + "x-nullable": true + }, + "computeId": { + "description": "ARM resource ID of the compute resource.", + "type": "string", "x-ms-mutability": [ "create", "read" @@ -17997,13 +18004,23 @@ "update" ] }, - "jobType": { - "description": "[Required] Specifies the type of job.", - "$ref": "#/definitions/JobType", + "identity": { + "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\r\nDefaults to AmlToken if null.", + "$ref": "#/definitions/IdentityConfiguration", "x-ms-mutability": [ "create", "read" - ] + ], + "x-nullable": true + }, + "componentId": { + "description": "ARM resource ID of the component resource.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true }, "notificationSetting": { "description": "Notification setting for the job", @@ -18014,23 +18031,6 @@ "update" ], "x-nullable": true - }, - "services": { - "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/JobService", - "x-nullable": true - }, - "x-nullable": true - }, - "status": { - "description": "Status of the job.", - "$ref": "#/definitions/JobStatus", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] } }, "discriminator": "jobType", @@ -18060,16 +18060,16 @@ "description": "A paginated list of JobBase entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type JobBase.", "type": "array", "items": { "$ref": "#/definitions/JobBaseResource" } + }, + "nextLink": { + "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -18081,6 +18081,14 @@ ], "type": "object", "properties": { + "jobInputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobInputType", + "x-ms-mutability": [ + "create", + "read" + ] + }, "description": { "description": "Description for the input.", "type": "string", @@ -18089,14 +18097,6 @@ "read" ], "x-nullable": true - }, - "jobInputType": { - "description": "[Required] Specifies the type of job.", - "$ref": "#/definitions/JobInputType", - "x-ms-mutability": [ - "create", - "read" - ] } }, "discriminator": "jobInputType" @@ -18188,6 +18188,14 @@ ], "type": "object", "properties": { + "jobOutputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobOutputType", + "x-ms-mutability": [ + "create", + "read" + ] + }, "description": { "description": "Description for the output.", "type": "string", @@ -18196,14 +18204,6 @@ "read" ], "x-nullable": true - }, - "jobOutputType": { - "description": "[Required] Specifies the type of job.", - "$ref": "#/definitions/JobOutputType", - "x-ms-mutability": [ - "create", - "read" - ] } }, "discriminator": "jobOutputType" @@ -18253,15 +18253,6 @@ } ], "properties": { - "dockerArgs": { - "description": "Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "shmSize": { "description": "Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes).", "default": "2g", @@ -18271,6 +18262,15 @@ "create", "read" ] + }, + "dockerArgs": { + "description": "Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "additionalProperties": false @@ -18304,8 +18304,8 @@ "description": "Job endpoint definition", "type": "object", "properties": { - "endpoint": { - "description": "Url for endpoint.", + "jobServiceType": { + "description": "Endpoint type.", "type": "string", "x-ms-mutability": [ "create", @@ -18313,17 +18313,18 @@ ], "x-nullable": true }, - "errorMessage": { - "description": "Any error in the service.", - "type": "string", - "readOnly": true, + "port": { + "format": "int32", + "description": "Port for endpoint.", + "type": "integer", "x-ms-mutability": [ + "create", "read" ], "x-nullable": true }, - "jobServiceType": { - "description": "Endpoint type.", + "endpoint": { + "description": "Url for endpoint.", "type": "string", "x-ms-mutability": [ "create", @@ -18331,17 +18332,20 @@ ], "x-nullable": true }, - "nodes": { - "description": "Nodes that user would like to start the service on.\r\nIf Nodes is not set or set to null, the service will only be started on leader node.", - "$ref": "#/definitions/Nodes", + "status": { + "description": "Status of endpoint.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true }, - "port": { - "format": "int32", - "description": "Port for endpoint.", - "type": "integer", + "errorMessage": { + "description": "Any error in the service.", + "type": "string", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ], "x-nullable": true @@ -18355,13 +18359,9 @@ }, "x-nullable": true }, - "status": { - "description": "Status of endpoint.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "nodes": { + "description": "Nodes that user would like to start the service on.\r\nIf Nodes is not set or set to null, the service will only be started on leader node.", + "$ref": "#/definitions/Nodes", "x-nullable": true } }, @@ -18832,18 +18832,18 @@ "type": "string", "x-nullable": true }, - "userManagedIdentityClientId": { - "description": "ClientId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "userManagedIdentityResourceId": { + "description": "Full arm scope for the Id. For ManagedIdentityType = SystemManaged, this field is null.", "type": "string", "x-nullable": true }, - "userManagedIdentityPrincipalId": { - "description": "PrincipalId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "userManagedIdentityClientId": { + "description": "ClientId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", "type": "string", "x-nullable": true }, - "userManagedIdentityResourceId": { - "description": "Full arm scope for the Id. For ManagedIdentityType = SystemManaged, this field is null.", + "userManagedIdentityPrincipalId": { + "description": "PrincipalId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", "type": "string", "x-nullable": true }, @@ -18868,44 +18868,53 @@ "additionalProperties": false }, "MarketplacePlan": { - "additionalProperties": false, + "type": "object", "properties": { - "offerId": { - "description": "The identifying name of the Offer of the Marketplace Plan.", - "readOnly": true, + "publisherId": { + "description": "The identifying name of the Publisher of the Marketplace Plan.", "type": "string", + "readOnly": true, "x-ms-mutability": [ "read" ], "x-nullable": true }, - "planId": { - "description": "The identifying name of the Plan of the Marketplace Plan.", - "readOnly": true, + "offerId": { + "description": "The identifying name of the Offer of the Marketplace Plan.", "type": "string", + "readOnly": true, "x-ms-mutability": [ "read" ], "x-nullable": true }, - "publisherId": { - "description": "The identifying name of the Publisher of the Marketplace Plan.", - "readOnly": true, + "planId": { + "description": "The identifying name of the Plan of the Marketplace Plan.", "type": "string", + "readOnly": true, "x-ms-mutability": [ "read" ], "x-nullable": true } }, - "type": "object" + "additionalProperties": false }, "MarketplaceSubscription": { - "additionalProperties": false, + "required": [ + "modelId" + ], + "type": "object", "properties": { + "modelId": { + "description": "[Required] Target Marketplace Model ID to create a Marketplace Subscription for.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, "marketplacePlan": { - "$ref": "#/definitions/MarketplacePlan", "description": "Marketplace Plan associated with the Marketplace Subscription.", + "$ref": "#/definitions/MarketplacePlan", "readOnly": true, "x-ms-mutability": [ "read" @@ -18913,36 +18922,26 @@ "x-nullable": true }, "marketplaceSubscriptionStatus": { - "$ref": "#/definitions/MarketplaceSubscriptionStatus", "description": "Current status of the Marketplace Subscription.", + "$ref": "#/definitions/MarketplaceSubscriptionStatus", "readOnly": true, "x-ms-mutability": [ "read" ] }, - "modelId": { - "description": "[Required] Target Marketplace Model ID to create a Marketplace Subscription for.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" - }, "provisioningState": { - "$ref": "#/definitions/MarketplaceSubscriptionProvisioningState", "description": "Provisioning State of the Marketplace Subscription.", + "$ref": "#/definitions/MarketplaceSubscriptionProvisioningState", "readOnly": true, "x-ms-mutability": [ "read" ] } }, - "required": [ - "modelId" - ], - "type": "object", - "x-ms-client-name": "MarketplaceSubscriptionProperties" + "x-ms-client-name": "MarketplaceSubscriptionProperties", + "additionalProperties": false }, "MarketplaceSubscriptionProvisioningState": { - "additionalProperties": false, "enum": [ "Creating", "Deleting", @@ -18951,78 +18950,78 @@ "Updating", "Canceled" ], - "readOnly": true, "type": "string", + "readOnly": true, "x-ms-enum": { - "modelAsString": true, "name": "MarketplaceSubscriptionProvisioningState", + "modelAsString": true, "values": [ { - "description": "MarketplaceSubscription is being created.", - "value": "Creating" + "value": "Creating", + "description": "MarketplaceSubscription is being created." }, { - "description": "MarketplaceSubscription is being deleted.", - "value": "Deleting" + "value": "Deleting", + "description": "MarketplaceSubscription is being deleted." }, { - "description": "MarketplaceSubscription is successfully provisioned.", - "value": "Succeeded" + "value": "Succeeded", + "description": "MarketplaceSubscription is successfully provisioned." }, { - "description": "MarketplaceSubscription provisioning failed.", - "value": "Failed" + "value": "Failed", + "description": "MarketplaceSubscription provisioning failed." }, { - "description": "MarketplaceSubscription is being updated.", - "value": "Updating" + "value": "Updating", + "description": "MarketplaceSubscription is being updated." }, { "value": "Canceled" } ] - } + }, + "additionalProperties": false }, "MarketplaceSubscriptionResource": { - "additionalProperties": false, + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ], - "description": "Azure Resource Manager resource envelope.", "properties": { "properties": { - "$ref": "#/definitions/MarketplaceSubscription", - "description": "[Required] Additional attributes of the entity." + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/MarketplaceSubscription" } }, - "required": [ - "properties" - ], - "type": "object", - "x-ms-client-name": "MarketplaceSubscription" + "x-ms-client-name": "MarketplaceSubscription", + "additionalProperties": false }, "MarketplaceSubscriptionResourceArmPaginatedResult": { - "additionalProperties": false, "description": "A paginated list of MarketplaceSubscription entities.", + "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of MarketplaceSubscription objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type MarketplaceSubscription.", + "type": "array", "items": { "$ref": "#/definitions/MarketplaceSubscriptionResource" - }, - "type": "array" + } + }, + "nextLink": { + "description": "The link to the next page of MarketplaceSubscription objects. If null, there are no additional pages.", + "type": "string" } }, - "type": "object" + "additionalProperties": false }, "MarketplaceSubscriptionStatus": { - "additionalProperties": false, "enum": [ "Subscribed", "Suspended", @@ -19030,23 +19029,24 @@ ], "type": "string", "x-ms-enum": { - "modelAsString": true, "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, "values": [ { - "description": "The customer can now use the Marketplace Subscription's\nmodel and will be billed.", - "value": "Subscribed" + "value": "Subscribed", + "description": "The customer can now use the Marketplace Subscription's\nmodel and will be billed." }, { - "description": "The customer could not be billed for the Marketplace Subscription.\nThe customer will not be able to access the model.", - "value": "Suspended" + "value": "Suspended", + "description": "The customer could not be billed for the Marketplace Subscription.\nThe customer will not be able to access the model." }, { - "description": "Marketplace Subscriptions reach this state in response to an explicit customer or CSP action.\nA Marketplace Subscription can also be canceled implicitly, as a result of nonpayment of dues,\nafter being in the Suspended state for some time.", - "value": "Unsubscribed" + "value": "Unsubscribed", + "description": "Marketplace Subscriptions reach this state in response to an explicit customer or CSP action.\nA Marketplace Subscription can also be canceled implicitly, as a result of nonpayment of dues,\nafter being in the Suspended state for some time." } ] - } + }, + "additionalProperties": false }, "MaterializationComputeResource": { "description": "DTO object representing compute resource", @@ -19063,6 +19063,16 @@ "MaterializationSettings": { "type": "object", "properties": { + "storeType": { + "description": "Specifies the stores to which materialization should happen", + "default": "None", + "$ref": "#/definitions/MaterializationStoreType" + }, + "schedule": { + "description": "Specifies the schedule details", + "$ref": "#/definitions/RecurrenceTrigger", + "x-nullable": true + }, "notification": { "description": "Specifies the notification details", "$ref": "#/definitions/NotificationSetting", @@ -19073,11 +19083,6 @@ "$ref": "#/definitions/MaterializationComputeResource", "x-nullable": true }, - "schedule": { - "description": "Specifies the schedule details", - "$ref": "#/definitions/RecurrenceTrigger", - "x-nullable": true - }, "sparkConfiguration": { "description": "Specifies the spark compute settings", "type": "object", @@ -19086,11 +19091,6 @@ "x-nullable": true }, "x-nullable": true - }, - "storeType": { - "description": "Specifies the stores to which materialization should happen", - "default": "None", - "$ref": "#/definitions/MaterializationStoreType" } }, "additionalProperties": false @@ -19178,22 +19178,22 @@ "description": "A paginated list of ModelContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ModelContainer.", "type": "array", "items": { "$ref": "#/definitions/ModelContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false }, "ModelSettings": { - "additionalProperties": false, + "type": "object", "properties": { "modelId": { "description": "The unique model identifier that this ServerlessEndpoint should provision.", @@ -19201,7 +19201,7 @@ "x-nullable": true } }, - "type": "object" + "additionalProperties": false }, "ModelSize": { "description": "Image model size.", @@ -19280,11 +19280,6 @@ }, "x-nullable": true }, - "jobName": { - "description": "Name of the training job which produced this model", - "type": "string", - "x-nullable": true - }, "modelType": { "description": "The storage format for this entity. Used for NCD.", "type": "string", @@ -19295,6 +19290,11 @@ "type": "string", "x-nullable": true }, + "jobName": { + "description": "Name of the training job which produced this model", + "type": "string", + "x-nullable": true + }, "provisioningState": { "description": "Provisioning state for the model version.", "$ref": "#/definitions/AssetProvisioningState", @@ -19336,16 +19336,16 @@ "description": "A paginated list of ModelVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ModelVersion.", "type": "array", "items": { "$ref": "#/definitions/ModelVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -19434,23 +19434,6 @@ ], "type": "object", "properties": { - "alertNotificationSettings": { - "description": "The monitor's notification settings.", - "$ref": "#/definitions/MonitorNotificationSettings", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "computeConfiguration": { - "description": "[Required] The ARM resource ID of the compute resource to run the monitoring job on.", - "$ref": "#/definitions/MonitorComputeConfigurationBase", - "x-ms-mutability": [ - "create", - "read" - ] - }, "monitoringTarget": { "description": "The entities targeted by the monitor.", "$ref": "#/definitions/MonitoringTarget", @@ -19471,6 +19454,23 @@ "create", "read" ] + }, + "computeConfiguration": { + "description": "[Required] The ARM resource ID of the compute resource to run the monitoring job on.", + "$ref": "#/definitions/MonitorComputeConfigurationBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "alertNotificationSettings": { + "description": "The monitor's notification settings.", + "$ref": "#/definitions/MonitorNotificationSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "additionalProperties": false @@ -19630,18 +19630,13 @@ ], "type": "object", "properties": { - "columns": { - "description": "Mapping of column names to special uses.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, + "inputDataType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringInputDataType", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, "dataContext": { "description": "The context metadata of the data source.", @@ -19652,14 +19647,6 @@ ], "x-nullable": true }, - "inputDataType": { - "description": "[Required] Specifies the type of signal to monitor.", - "$ref": "#/definitions/MonitoringInputDataType", - "x-ms-mutability": [ - "create", - "read" - ] - }, "jobInputType": { "description": "[Required] Specifies the type of job.", "$ref": "#/definitions/JobInputType", @@ -19677,6 +19664,19 @@ "create", "read" ] + }, + "columns": { + "description": "Mapping of column names to special uses.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "discriminator": "inputDataType" @@ -19732,6 +19732,14 @@ ], "type": "object", "properties": { + "signalType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringSignalType", + "x-ms-mutability": [ + "create", + "read" + ] + }, "notificationTypes": { "description": "The current notification mode for this signal.", "type": "array", @@ -19753,14 +19761,6 @@ "x-nullable": true }, "x-nullable": true - }, - "signalType": { - "description": "[Required] Specifies the type of signal to monitor.", - "$ref": "#/definitions/MonitoringSignalType", - "x-ms-mutability": [ - "create", - "read" - ] } }, "discriminator": "signalType" @@ -19809,8 +19809,8 @@ ], "type": "object", "properties": { - "deploymentId": { - "description": "Reference to the deployment asset targeted by this monitor.", + "modelId": { + "description": "Reference to the model asset targeted by this monitor.", "type": "string", "x-ms-mutability": [ "create", @@ -19818,8 +19818,8 @@ ], "x-nullable": true }, - "modelId": { - "description": "Reference to the model asset targeted by this monitor.", + "deploymentId": { + "description": "Reference to the deployment asset targeted by this monitor.", "type": "string", "x-ms-mutability": [ "create", @@ -19922,16 +19922,16 @@ "description": "Abstract class for NLP related AutoML tasks.\r\nNLP - Natural Language Processing.", "type": "object", "properties": { - "featurizationSettings": { - "description": "Featurization inputs needed for AutoML job.", - "$ref": "#/definitions/NlpVerticalFeaturizationSettings", - "x-nullable": true - }, "limitSettings": { "description": "Execution constraints for AutoMLJob.", "$ref": "#/definitions/NlpVerticalLimitSettings", "x-nullable": true }, + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/NlpVerticalFeaturizationSettings", + "x-nullable": true + }, "validationData": { "description": "Validation data inputs.", "$ref": "#/definitions/MLTableJobInput", @@ -19953,23 +19953,23 @@ "description": "Job execution constraints.", "type": "object", "properties": { - "maxConcurrentTrials": { + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "P7D", + "type": "string" + }, + "maxTrials": { "format": "int32", - "description": "Maximum Concurrent AutoML iterations.", + "description": "Number of AutoML iterations.", "default": 1, "type": "integer" }, - "maxTrials": { + "maxConcurrentTrials": { "format": "int32", - "description": "Number of AutoML iterations.", + "description": "Maximum Concurrent AutoML iterations.", "default": 1, "type": "integer" - }, - "timeout": { - "format": "duration", - "description": "AutoML job timeout.", - "default": "P7D", - "type": "string" } }, "additionalProperties": false @@ -20024,11 +20024,11 @@ "description": "Configuration for notification.", "type": "object", "properties": { - "emailOn": { - "description": "Send email notification to user on specified notification type", + "emails": { + "description": "This is the email recipient list which has a limitation of 499 characters in total concat with comma separator", "type": "array", "items": { - "$ref": "#/definitions/EmailNotificationEnableType" + "type": "string" }, "x-ms-mutability": [ "create", @@ -20036,11 +20036,11 @@ ], "x-nullable": true }, - "emails": { - "description": "This is the email recipient list which has a limitation of 499 characters in total concat with comma separator", + "emailOn": { + "description": "Send email notification to user on specified notification type", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/EmailNotificationEnableType" }, "x-ms-mutability": [ "create", @@ -20248,15 +20248,15 @@ ], "type": "object", "properties": { - "goal": { - "description": "[Required] Defines supported metric goals for hyperparameter tuning", - "$ref": "#/definitions/Goal" - }, "primaryMetric": { "description": "[Required] Name of the metric to optimize.", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "type": "string" + }, + "goal": { + "description": "[Required] Defines supported metric goals for hyperparameter tuning", + "$ref": "#/definitions/Goal" } }, "additionalProperties": false @@ -20269,6 +20269,10 @@ ], "type": "object", "properties": { + "artifactType": { + "description": "[Required] OneLake artifact type", + "$ref": "#/definitions/OneLakeArtifactType" + }, "artifactName": { "description": "[Required] OneLake artifact name", "minLength": 1, @@ -20278,10 +20282,6 @@ "create", "read" ] - }, - "artifactType": { - "description": "[Required] OneLake artifact type", - "$ref": "#/definitions/OneLakeArtifactType" } }, "discriminator": "artifactType" @@ -20324,16 +20324,6 @@ "read" ] }, - "endpoint": { - "description": "OneLake endpoint to use for the datastore.", - "type": "string", - "example": "data.microsoft.com", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "oneLakeWorkspaceName": { "description": "[Required] OneLake workspace name.", "minLength": 1, @@ -20344,6 +20334,16 @@ "read" ] }, + "endpoint": { + "description": "OneLake endpoint to use for the datastore.", + "type": "string", + "example": "data.microsoft.com", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "serviceDataAccessAuthIdentity": { "description": "Indicates which identity to use to authenticate service data access to customer's storage.", "default": "None", @@ -20368,47 +20368,38 @@ } ], "properties": { - "appInsightsEnabled": { - "description": "If true, enables Application Insights logging.", - "default": false, - "type": "boolean" - }, - "dataCollector": { - "description": "The mdc configuration, we disable mdc when it's null.", - "$ref": "#/definitions/DataCollector", - "x-nullable": true - }, - "egressPublicNetworkAccess": { - "description": "If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.", - "default": "Enabled", - "$ref": "#/definitions/EgressPublicNetworkAccessType" - }, "endpointComputeType": { "description": "[Required] The compute type of the endpoint.", "$ref": "#/definitions/EndpointComputeType" }, - "instanceType": { - "description": "Compute instance type.", + "scaleSettings": { + "description": "Scale settings for the deployment.\r\nIf it is null or not provided,\r\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\r\nand to DefaultScaleSettings for ManagedOnlineDeployment.", + "$ref": "#/definitions/OnlineScaleSettings", + "x-nullable": true + }, + "requestSettings": { + "description": "Request settings for the deployment.", + "$ref": "#/definitions/OnlineRequestSettings", + "x-nullable": true + }, + "modelMountPath": { + "description": "The path to mount the model in custom container.", "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], "x-nullable": true }, + "appInsightsEnabled": { + "description": "If true, enables Application Insights logging.", + "default": false, + "type": "boolean" + }, "livenessProbe": { "description": "Liveness probe monitors the health of the container regularly.", "$ref": "#/definitions/ProbeSettings", "x-nullable": true }, - "model": { - "description": "The URI path to the model.", - "type": "string", - "x-nullable": true - }, - "modelMountPath": { - "description": "The path to mount the model in custom container.", - "type": "string", + "readinessProbe": { + "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", + "$ref": "#/definitions/ProbeSettings", "x-nullable": true }, "provisioningState": { @@ -20419,19 +20410,28 @@ "read" ] }, - "readinessProbe": { - "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", - "$ref": "#/definitions/ProbeSettings", + "instanceType": { + "description": "Compute instance type.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "requestSettings": { - "description": "Request settings for the deployment.", - "$ref": "#/definitions/OnlineRequestSettings", + "model": { + "description": "The URI path to the model.", + "type": "string", "x-nullable": true }, - "scaleSettings": { - "description": "Scale settings for the deployment.\r\nIf it is null or not provided,\r\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\r\nand to DefaultScaleSettings for ManagedOnlineDeployment.", - "$ref": "#/definitions/OnlineScaleSettings", + "egressPublicNetworkAccess": { + "description": "If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.", + "default": "Enabled", + "$ref": "#/definitions/EgressPublicNetworkAccessType" + }, + "dataCollector": { + "description": "The mdc configuration, we disable mdc when it's null.", + "$ref": "#/definitions/DataCollector", "x-nullable": true } }, @@ -20450,17 +20450,17 @@ } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/OnlineDeployment" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/OnlineDeployment" + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { "description": "Sku details required for ARM contract for Autoscaling.", @@ -20474,16 +20474,16 @@ "description": "A paginated list of OnlineDeployment entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type OnlineDeployment.", "type": "array", "items": { "$ref": "#/definitions/OnlineDeploymentTrackedResource" } + }, + "nextLink": { + "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -20497,20 +20497,6 @@ } ], "properties": { - "compute": { - "description": "ARM resource ID of the compute if it exists.\r\noptional", - "type": "string", - "x-nullable": true - }, - "mirrorTraffic": { - "description": "Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.", - "type": "object", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "x-nullable": true - }, "provisioningState": { "description": "Provisioning state for the endpoint.", "$ref": "#/definitions/EndpointProvisioningState", @@ -20519,6 +20505,11 @@ "read" ] }, + "compute": { + "description": "ARM resource ID of the compute if it exists.\r\noptional", + "type": "string", + "x-nullable": true + }, "publicNetworkAccess": { "description": "Set to \"Enabled\" for endpoints that should allow public access when Private Link is enabled.", "default": "Enabled", @@ -20532,6 +20523,15 @@ "type": "integer" }, "x-nullable": true + }, + "mirrorTraffic": { + "description": "Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true } }, "x-ms-client-name": "OnlineEndpointProperties", @@ -20549,17 +20549,17 @@ } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/OnlineEndpoint" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/OnlineEndpoint" + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { "description": "Sku details required for ARM contract for Autoscaling.", @@ -20573,16 +20573,16 @@ "description": "A paginated list of OnlineEndpoint entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type OnlineEndpoint.", "type": "array", "items": { "$ref": "#/definitions/OnlineEndpointTrackedResource" } + }, + "nextLink": { + "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -20591,12 +20591,6 @@ "description": "Online deployment scoring requests configuration.", "type": "object", "properties": { - "maxConcurrentRequestsPerInstance": { - "format": "int32", - "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", - "default": 1, - "type": "integer" - }, "maxQueueWait": { "format": "duration", "description": "(Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.\r\n(Now increase `request_timeout_ms` to account for any networking/queue delays)", @@ -20608,6 +20602,12 @@ "description": "The scoring timeout in ISO 8601 format.\r\nDefaults to 5000ms.", "default": "PT5S", "type": "string" + }, + "maxConcurrentRequestsPerInstance": { + "format": "int32", + "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", + "default": 1, + "type": "integer" } }, "additionalProperties": false @@ -20709,13 +20709,13 @@ } ], "properties": { - "jobId": { - "description": "ARM resource ID of the job.", + "path": { + "description": "The path of the file/directory in the job output.", "type": "string", "x-nullable": true }, - "path": { - "description": "The path of the file/directory in the job output.", + "jobId": { + "description": "ARM resource ID of the job.", "type": "string", "x-nullable": true } @@ -20820,49 +20820,49 @@ "additionalProperties": false }, "PartialMinimalTrackedResourceWithSkuAndIdentity": { - "additionalProperties": false, + "description": "Strictly used in update requests.", + "type": "object", "allOf": [ { "$ref": "#/definitions/PartialMinimalTrackedResource" } ], - "description": "Strictly used in update requests.", "properties": { - "identity": { - "$ref": "#/definitions/PartialManagedServiceIdentity", - "description": "Managed service identity (system assigned and/or user assigned identities)" - }, "sku": { - "$ref": "#/definitions/PartialSku", - "description": "Sku details required for ARM contract for Autoscaling." + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/PartialManagedServiceIdentity" } }, - "type": "object" + "additionalProperties": false }, "PartialSku": { "description": "Common SKU definition.", "type": "object", "properties": { - "capacity": { - "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.", - "type": "integer" - }, - "family": { - "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", - "type": "string" - }, "name": { "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", "type": "string" }, + "tier": { + "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.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + }, "size": { "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", "type": "string" }, - "tier": { - "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.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + "family": { + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "capacity": { + "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.", + "type": "integer" } }, "additionalProperties": false @@ -20968,14 +20968,9 @@ } ], "properties": { - "inputs": { - "description": "Inputs for the pipeline job.", + "settings": { + "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", "type": "object", - "additionalProperties": { - "description": "Command job definition.", - "$ref": "#/definitions/JobInput", - "x-nullable": true - }, "x-ms-mutability": [ "create", "read" @@ -20995,12 +20990,12 @@ ], "x-nullable": true }, - "outputs": { - "description": "Outputs for the pipeline job", + "inputs": { + "description": "Inputs for the pipeline job.", "type": "object", "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", "x-nullable": true }, "x-ms-mutability": [ @@ -21009,9 +21004,14 @@ ], "x-nullable": true }, - "settings": { - "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", + "outputs": { + "description": "Outputs for the pipeline job", "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, "x-ms-mutability": [ "create", "read" @@ -21070,18 +21070,6 @@ } ], "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "metricThresholds": { "description": "[Required] A list of metrics to calculate and their associated thresholds.", "type": "array", @@ -21109,6 +21097,18 @@ "create", "read" ] + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "PredictionDrift", @@ -21124,18 +21124,6 @@ "default": 30, "type": "integer" }, - "initialDelay": { - "format": "duration", - "description": "The delay before the first probe in ISO 8601 format.", - "type": "string", - "x-nullable": true - }, - "period": { - "format": "duration", - "description": "The length of time between probes in ISO 8601 format.", - "default": "PT10S", - "type": "string" - }, "successThreshold": { "format": "int32", "description": "The number of successful probes before returning a healthy status.", @@ -21147,6 +21135,18 @@ "description": "The probe timeout in ISO 8601 format.", "default": "PT2S", "type": "string" + }, + "period": { + "format": "duration", + "description": "The length of time between probes in ISO 8601 format.", + "default": "PT10S", + "type": "string" + }, + "initialDelay": { + "format": "duration", + "description": "The delay before the first probe in ISO 8601 format.", + "type": "string", + "x-nullable": true } }, "additionalProperties": false @@ -21215,16 +21215,16 @@ } ], "properties": { - "rule": { - "description": "The specific type of random algorithm", - "default": "Random", - "$ref": "#/definitions/RandomSamplingAlgorithmRule" - }, "seed": { "format": "int32", "description": "An optional integer to use as the seed for random number generation", "type": "integer", "x-nullable": true + }, + "rule": { + "description": "The specific type of random algorithm", + "default": "Random", + "$ref": "#/definitions/RandomSamplingAlgorithmRule" } }, "x-ms-discriminator-value": "Random", @@ -21312,20 +21312,20 @@ "type": "integer" } }, - "monthDays": { - "description": "List of month days for the schedule", + "weekDays": { + "description": "List of days for the schedule.", "type": "array", "items": { - "format": "int32", - "type": "integer" + "$ref": "#/definitions/WeekDay" }, "x-nullable": true }, - "weekDays": { - "description": "List of days for the schedule.", + "monthDays": { + "description": "List of month days for the schedule", "type": "array", "items": { - "$ref": "#/definitions/WeekDay" + "format": "int32", + "type": "integer" }, "x-nullable": true } @@ -21578,8 +21578,8 @@ "type": "string", "x-nullable": true }, - "properties": { - "description": "The asset property dictionary.", + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", "type": "object", "additionalProperties": { "type": "string", @@ -21587,8 +21587,8 @@ }, "x-nullable": true }, - "tags": { - "description": "Tag dictionary. Tags can be added, removed, and updated.", + "properties": { + "description": "The asset property dictionary.", "type": "object", "additionalProperties": { "type": "string", @@ -21650,15 +21650,6 @@ } ], "properties": { - "preprocessingComponentId": { - "description": "Reference to the component asset used to preprocess the data.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "windowOffset": { "format": "duration", "description": "[Required] The time offset between the end of the data window and the monitor's current run time.", @@ -21676,6 +21667,15 @@ "create", "read" ] + }, + "preprocessingComponentId": { + "description": "Reference to the component asset used to preprocess the data.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "Rolling", @@ -21886,15 +21886,6 @@ } ], "properties": { - "action": { - "description": "[Required] Specifies the action of the schedule", - "$ref": "#/definitions/ScheduleActionBase", - "x-ms-mutability": [ - "create", - "read", - "update" - ] - }, "displayName": { "description": "Display name of schedule.", "type": "string", @@ -21914,14 +21905,6 @@ "update" ] }, - "provisioningState": { - "description": "Provisioning state for the schedule.", - "$ref": "#/definitions/ScheduleProvisioningStatus", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, "trigger": { "description": "[Required] Specifies the trigger details", "$ref": "#/definitions/TriggerBase", @@ -21930,6 +21913,23 @@ "read", "update" ] + }, + "action": { + "description": "[Required] Specifies the action of the schedule", + "$ref": "#/definitions/ScheduleActionBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "provisioningState": { + "description": "Provisioning state for the schedule.", + "$ref": "#/definitions/ScheduleProvisioningStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } }, "x-ms-client-name": "ScheduleProperties", @@ -22061,16 +22061,16 @@ "description": "A paginated list of Schedule entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of Schedule objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type Schedule.", "type": "array", "items": { "$ref": "#/definitions/ScheduleResource" } + }, + "nextLink": { + "description": "The link to the next page of Schedule objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -22146,65 +22146,64 @@ "additionalProperties": false }, "ServerlessEndpoint": { - "additionalProperties": false, + "required": [ + "authMode" + ], + "type": "object", "properties": { + "modelSettings": { + "description": "The model settings (model id) for the model being serviced on the ServerlessEndpoint.", + "$ref": "#/definitions/ModelSettings", + "x-nullable": true + }, "authMode": { - "$ref": "#/definitions/ServerlessInferenceEndpointAuthMode", - "description": "[Required] Specifies the authentication mode for the Serverless endpoint." + "description": "[Required] Specifies the authentication mode for the Serverless endpoint.", + "$ref": "#/definitions/ServerlessInferenceEndpointAuthMode" }, - "contentSafety": { - "$ref": "#/definitions/ContentSafety", - "description": "Specifies the content safety options. If omitted, the default content safety settings will be configured", + "inferenceEndpoint": { + "description": "The inference uri to target when making requests against the serverless endpoint", + "$ref": "#/definitions/ServerlessInferenceEndpoint", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true }, - "endpointState": { - "$ref": "#/definitions/ServerlessEndpointState", - "description": "The current state of the ServerlessEndpoint.", + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", "readOnly": true, "x-ms-mutability": [ "read" ] }, - "inferenceEndpoint": { - "$ref": "#/definitions/ServerlessInferenceEndpoint", - "description": "The inference uri to target when making requests against the serverless endpoint", + "endpointState": { + "description": "The current state of the ServerlessEndpoint.", + "$ref": "#/definitions/ServerlessEndpointState", "readOnly": true, "x-ms-mutability": [ "read" - ], - "x-nullable": true + ] }, "marketplaceSubscriptionId": { "description": "The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint.", - "readOnly": true, "type": "string", + "readOnly": true, "x-ms-mutability": [ "read" ], "x-nullable": true }, - "modelSettings": { - "$ref": "#/definitions/ModelSettings", - "description": "The model settings (model id) for the model being serviced on the ServerlessEndpoint.", + "contentSafety": { + "description": "Specifies the content safety options. If omitted, the default content safety settings will be configured", + "$ref": "#/definitions/ContentSafety", "x-nullable": true - }, - "provisioningState": { - "$ref": "#/definitions/EndpointProvisioningState", - "description": "Provisioning state for the endpoint.", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] } }, - "required": [ - "authMode" - ], - "type": "object", - "x-ms-client-name": "ServerlessEndpointProperties" + "x-ms-client-name": "ServerlessEndpointProperties", + "additionalProperties": false }, "ServerlessEndpointState": { - "additionalProperties": false, "description": "State of the Serverless Endpoint.", "enum": [ "Unknown", @@ -22219,8 +22218,8 @@ ], "type": "string", "x-ms-enum": { - "modelAsString": true, "name": "ServerlessEndpointState", + "modelAsString": true, "values": [ { "value": "Unknown" @@ -22250,103 +22249,104 @@ "value": "DeletionFailed" } ] - } + }, + "additionalProperties": false }, "ServerlessEndpointTrackedResource": { - "additionalProperties": false, + "required": [ + "location", + "properties" + ], + "type": "object", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ], "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "Managed service identity (system assigned and/or user assigned identities)" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ServerlessEndpoint" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "$ref": "#/definitions/ServerlessEndpoint", - "description": "[Required] Additional attributes of the entity." + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", - "description": "Sku details required for ARM contract for Autoscaling." + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" } }, - "required": [ - "location", - "properties" - ], - "type": "object", - "x-ms-client-name": "ServerlessEndpoint" + "x-ms-client-name": "ServerlessEndpoint", + "additionalProperties": false }, "ServerlessEndpointTrackedResourceArmPaginatedResult": { - "additionalProperties": false, "description": "A paginated list of ServerlessEndpoint entities.", + "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ServerlessEndpoint objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ServerlessEndpoint.", + "type": "array", "items": { "$ref": "#/definitions/ServerlessEndpointTrackedResource" - }, - "type": "array" + } + }, + "nextLink": { + "description": "The link to the next page of ServerlessEndpoint objects. If null, there are no additional pages.", + "type": "string" } }, - "type": "object" + "additionalProperties": false }, "ServerlessInferenceEndpoint": { - "additionalProperties": false, + "required": [ + "uri" + ], + "type": "object", "properties": { + "uri": { + "format": "uri", + "description": "[Required] The inference uri to target when making requests against the Serverless Endpoint.", + "type": "string", + "x-ms-mutability": [ + "read" + ] + }, "headers": { + "description": "Specifies any required headers to target this serverless endpoint.", + "type": "object", "additionalProperties": { "type": "string", "x-nullable": true }, - "description": "Specifies any required headers to target this serverless endpoint.", "readOnly": true, - "type": "object", "x-ms-mutability": [ "read" ], "x-nullable": true - }, - "uri": { - "description": "[Required] The inference uri to target when making requests against the Serverless Endpoint.", - "format": "uri", - "type": "string", - "x-ms-mutability": [ - "read" - ] } }, - "required": [ - "uri" - ], - "type": "object" + "additionalProperties": false }, "ServerlessInferenceEndpointAuthMode": { - "additionalProperties": false, "enum": [ "Key" ], "type": "string", "x-ms-enum": { - "modelAsString": true, "name": "ServerlessInferenceEndpointAuthMode", + "modelAsString": true, "values": [ { "value": "Key" } ] - } + }, + "additionalProperties": false }, "ServiceDataAccessAuthIdentity": { "enum": [ @@ -22394,16 +22394,21 @@ "type": "string", "x-nullable": true }, - "clientId": { - "format": "uuid", - "description": "[Required] Service principal client ID.", - "type": "string" - }, "resourceUrl": { "description": "Resource the service principal has access to.", "type": "string", "x-nullable": true }, + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" + }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, "secrets": { "description": "[Required] Service principal secrets.", "$ref": "#/definitions/ServicePrincipalDatastoreSecrets", @@ -22412,11 +22417,6 @@ "update" ], "x-ms-secret": true - }, - "tenantId": { - "format": "uuid", - "description": "[Required] ID of the tenant to which the service principal belongs.", - "type": "string" } }, "x-ms-discriminator-value": "ServicePrincipal", @@ -22477,9 +22477,9 @@ "description": "SKU capacity information", "type": "object", "properties": { - "default": { + "minimum": { "format": "int32", - "description": "Gets or sets the default capacity.", + "description": "Gets or sets the minimum.", "default": 0, "type": "integer" }, @@ -22489,9 +22489,9 @@ "default": 0, "type": "integer" }, - "minimum": { + "default": { "format": "int32", - "description": "Gets or sets the minimum.", + "description": "Gets or sets the default capacity.", "default": 0, "type": "integer" }, @@ -22507,11 +22507,6 @@ "description": "Fulfills ARM Contract requirement to list all available SKUS for a resource.", "type": "object", "properties": { - "capacity": { - "description": "Gets or sets the Sku Capacity.", - "$ref": "#/definitions/SkuCapacity", - "x-nullable": true - }, "resourceType": { "description": "The resource type name.", "type": "string", @@ -22525,6 +22520,11 @@ "description": "Gets or sets the Sku.", "$ref": "#/definitions/SkuSetting", "x-nullable": true + }, + "capacity": { + "description": "Gets or sets the Sku Capacity.", + "$ref": "#/definitions/SkuCapacity", + "x-nullable": true } }, "additionalProperties": false @@ -22533,10 +22533,6 @@ "description": "A paginated list of SkuResource entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of SkuResource objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type SkuResource.", "type": "array", @@ -22544,6 +22540,10 @@ "$ref": "#/definitions/SkuResource" }, "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The link to the next page of SkuResource objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -22610,12 +22610,9 @@ } ], "properties": { - "archives": { - "description": "Archive files used in the job.", - "type": "array", - "items": { - "type": "string" - }, + "resources": { + "description": "Compute Resource configuration for the job.", + "$ref": "#/definitions/SparkResourceConfiguration", "x-ms-mutability": [ "create", "read" @@ -22643,24 +22640,6 @@ "read" ] }, - "conf": { - "description": "Spark configured properties.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, - "example": [ - { - "spark.driver.memory": "2g" - } - ], - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "entry": { "description": "[Required] The entry to execute on startup of the job.", "$ref": "#/definitions/SparkJobEntry", @@ -22679,11 +22658,12 @@ ], "x-nullable": true }, - "environmentVariables": { - "description": "Environment variables included in the job.", + "inputs": { + "description": "Mapping of input data bindings used in the job.", "type": "object", "additionalProperties": { - "type": "string", + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", "x-nullable": true }, "x-ms-mutability": [ @@ -22692,11 +22672,13 @@ ], "x-nullable": true }, - "files": { - "description": "Files used in the job.", - "type": "array", - "items": { - "type": "string" + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true }, "x-ms-mutability": [ "create", @@ -22704,13 +22686,11 @@ ], "x-nullable": true }, - "inputs": { - "description": "Mapping of input data bindings used in the job.", - "type": "object", - "additionalProperties": { - "description": "Command job definition.", - "$ref": "#/definitions/JobInput", - "x-nullable": true + "pyFiles": { + "description": "Python files used in the job.", + "type": "array", + "items": { + "type": "string" }, "x-ms-mutability": [ "create", @@ -22730,13 +22710,11 @@ ], "x-nullable": true }, - "outputs": { - "description": "Mapping of output data bindings used in the job.", - "type": "object", - "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", - "x-nullable": true + "files": { + "description": "Files used in the job.", + "type": "array", + "items": { + "type": "string" }, "x-ms-mutability": [ "create", @@ -22744,8 +22722,8 @@ ], "x-nullable": true }, - "pyFiles": { - "description": "Python files used in the job.", + "archives": { + "description": "Archive files used in the job.", "type": "array", "items": { "type": "string" @@ -22756,6 +22734,24 @@ ], "x-nullable": true }, + "conf": { + "description": "Spark configured properties.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "example": [ + { + "spark.driver.memory": "2g" + } + ], + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "queueSettings": { "description": "Queue settings for the job", "$ref": "#/definitions/QueueSettings", @@ -22765,9 +22761,13 @@ ], "x-nullable": true }, - "resources": { - "description": "Compute Resource configuration for the job.", - "$ref": "#/definitions/SparkResourceConfiguration", + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, "x-ms-mutability": [ "create", "read" @@ -22896,10 +22896,10 @@ "description": "Advances setting to customize StackEnsemble run.", "type": "object", "properties": { - "stackMetaLearnerKWargs": { - "description": "Optional parameters to pass to the initializer of the meta-learner.", - "type": "object", - "x-nullable": true + "stackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.", + "default": "None", + "$ref": "#/definitions/StackMetaLearnerType" }, "stackMetaLearnerTrainPercentage": { "format": "double", @@ -22907,10 +22907,10 @@ "default": 0.2, "type": "number" }, - "stackMetaLearnerType": { - "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.", - "default": "None", - "$ref": "#/definitions/StackMetaLearnerType" + "stackMetaLearnerKWargs": { + "description": "Optional parameters to pass to the initializer of the meta-learner.", + "type": "object", + "x-nullable": true } }, "additionalProperties": false @@ -22977,14 +22977,14 @@ } ], "properties": { - "preprocessingComponentId": { - "description": "Reference to the component asset used to preprocess the data.", + "windowStart": { + "format": "date-time", + "description": "[Required] The start date of the data window.", "type": "string", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, "windowEnd": { "format": "date-time", @@ -22995,14 +22995,14 @@ "read" ] }, - "windowStart": { - "format": "date-time", - "description": "[Required] The start date of the data window.", + "preprocessingComponentId": { + "description": "Reference to the component asset used to preprocess the data.", "type": "string", "x-ms-mutability": [ "create", "read" - ] + ], + "x-nullable": true } }, "x-ms-discriminator-value": "Static", @@ -23056,11 +23056,36 @@ } ], "properties": { + "searchSpace": { + "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", + "type": "object" + }, + "samplingAlgorithm": { + "description": "[Required] The hyperparameter sampling algorithm", + "$ref": "#/definitions/SamplingAlgorithm" + }, + "limits": { + "description": "Sweep Job limit.", + "default": "{}", + "$ref": "#/definitions/SweepJobLimits", + "x-ms-mutability": [ + "create", + "read" + ] + }, "earlyTermination": { "description": "Early termination policies enable canceling poor-performing runs before they complete", "$ref": "#/definitions/EarlyTerminationPolicy", "x-nullable": true }, + "objective": { + "description": "[Required] Optimization objective.", + "$ref": "#/definitions/Objective" + }, + "trial": { + "description": "[Required] Trial component definition.", + "$ref": "#/definitions/TrialComponent" + }, "inputs": { "description": "Mapping of input data bindings used in the job.", "type": "object", @@ -23075,19 +23100,6 @@ ], "x-nullable": true }, - "limits": { - "description": "Sweep Job limit.", - "default": "{}", - "$ref": "#/definitions/SweepJobLimits", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "objective": { - "description": "[Required] Optimization objective.", - "$ref": "#/definitions/Objective" - }, "outputs": { "description": "Mapping of output data bindings used in the job.", "type": "object", @@ -23110,18 +23122,6 @@ "read" ], "x-nullable": true - }, - "samplingAlgorithm": { - "description": "[Required] The hyperparameter sampling algorithm", - "$ref": "#/definitions/SamplingAlgorithm" - }, - "searchSpace": { - "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", - "type": "object" - }, - "trial": { - "description": "[Required] Trial component definition.", - "$ref": "#/definitions/TrialComponent" } }, "x-ms-discriminator-value": "Sweep", @@ -23136,15 +23136,15 @@ } ], "properties": { - "maxConcurrentTrials": { + "maxTotalTrials": { "format": "int32", - "description": "Sweep Job max concurrent trials.", + "description": "Sweep Job max total trials.", "type": "integer", "x-nullable": true }, - "maxTotalTrials": { + "maxConcurrentTrials": { "format": "int32", - "description": "Sweep Job max total trials.", + "description": "Sweep Job max concurrent trials.", "type": "integer", "x-nullable": true }, @@ -23162,19 +23162,6 @@ "description": "Abstract class for AutoML tasks that use table dataset as input - such as Classification/Regression/Forecasting.", "type": "object", "properties": { - "cvSplitColumnNames": { - "description": "Columns to use for CVSplit data.", - "type": "array", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "featurizationSettings": { - "description": "Featurization inputs needed for AutoML job.", - "$ref": "#/definitions/TableVerticalFeaturizationSettings", - "x-nullable": true - }, "limitSettings": { "description": "Execution constraints for AutoMLJob.", "$ref": "#/definitions/TableVerticalLimitSettings", @@ -23185,15 +23172,17 @@ "$ref": "#/definitions/NCrossValidations", "x-nullable": true }, - "testData": { - "description": "Test data input.", - "$ref": "#/definitions/MLTableJobInput", + "cvSplitColumnNames": { + "description": "Columns to use for CVSplit data.", + "type": "array", + "items": { + "type": "string" + }, "x-nullable": true }, - "testDataSize": { - "format": "double", - "description": "The fraction of test dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", - "type": "number", + "weightColumnName": { + "description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.", + "type": "string", "x-nullable": true }, "validationData": { @@ -23201,15 +23190,26 @@ "$ref": "#/definitions/MLTableJobInput", "x-nullable": true }, + "testData": { + "description": "Test data input.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, "validationDataSize": { "format": "double", "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", "type": "number", "x-nullable": true }, - "weightColumnName": { - "description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.", - "type": "string", + "testDataSize": { + "format": "double", + "description": "The fraction of test dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/TableVerticalFeaturizationSettings", "x-nullable": true } }, @@ -23224,6 +23224,11 @@ } ], "properties": { + "mode": { + "description": "Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase.\r\nIf 'Off' is selected then no featurization is done.\r\nIf 'Custom' is selected then user can specify additional inputs to customize how featurization is done.", + "default": "Auto", + "$ref": "#/definitions/FeaturizationMode" + }, "blockedTransformers": { "description": "These transformers shall not be used in featurization.", "type": "array", @@ -23241,16 +23246,6 @@ }, "x-nullable": true }, - "enableDnnFeaturization": { - "description": "Determines whether to use Dnn based featurizers for data featurization.", - "default": false, - "type": "boolean" - }, - "mode": { - "description": "Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase.\r\nIf 'Off' is selected then no featurization is done.\r\nIf 'Custom' is selected then user can specify additional inputs to customize how featurization is done.", - "default": "Auto", - "$ref": "#/definitions/FeaturizationMode" - }, "transformerParams": { "description": "User can specify additional transformers to be used along with the columns to which it would be applied and parameters for the transformer constructor.", "type": "object", @@ -23263,6 +23258,11 @@ "x-ms-identifiers": [] }, "x-nullable": true + }, + "enableDnnFeaturization": { + "description": "Determines whether to use Dnn based featurizers for data featurization.", + "default": false, + "type": "boolean" } }, "additionalProperties": false @@ -23271,16 +23271,23 @@ "description": "Job execution constraints.", "type": "object", "properties": { - "enableEarlyTermination": { - "description": "Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations.", - "default": true, - "type": "boolean" + "maxTrials": { + "format": "int32", + "description": "Number of iterations.", + "default": 1000, + "type": "integer" }, - "exitScore": { - "format": "double", - "description": "Exit score for the AutoML job.", - "type": "number", - "x-nullable": true + "trialTimeout": { + "format": "duration", + "description": "Iteration timeout.", + "default": "PT30M", + "type": "string" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "PT6H", + "type": "string" }, "maxConcurrentTrials": { "format": "int32", @@ -23294,23 +23301,16 @@ "default": -1, "type": "integer" }, - "maxTrials": { - "format": "int32", - "description": "Number of iterations.", - "default": 1000, - "type": "integer" - }, - "timeout": { - "format": "duration", - "description": "AutoML job timeout.", - "default": "PT6H", - "type": "string" + "exitScore": { + "format": "double", + "description": "Exit score for the AutoML job.", + "type": "number", + "x-nullable": true }, - "trialTimeout": { - "format": "duration", - "description": "Iteration timeout.", - "default": "PT30M", - "type": "string" + "enableEarlyTermination": { + "description": "Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations.", + "default": true, + "type": "boolean" } }, "additionalProperties": false @@ -23439,18 +23439,6 @@ } ], "properties": { - "maxInstances": { - "format": "int32", - "description": "The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.", - "default": 1, - "type": "integer" - }, - "minInstances": { - "format": "int32", - "description": "The minimum number of instances to always be present.", - "default": 1, - "type": "integer" - }, "pollingInterval": { "format": "duration", "description": "The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.", @@ -23462,6 +23450,18 @@ "description": "Target CPU usage for the autoscaler.", "default": 70, "type": "integer" + }, + "minInstances": { + "format": "int32", + "description": "The minimum number of instances to always be present.", + "default": 1, + "type": "integer" + }, + "maxInstances": { + "format": "int32", + "description": "The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.", + "default": 1, + "type": "integer" } }, "x-ms-discriminator-value": "TargetUtilization", @@ -23539,25 +23539,25 @@ } ], "properties": { - "parameterServerCount": { + "workerCount": { "format": "int32", - "description": "Number of parameter server tasks.", - "default": 0, + "description": "Number of workers. If not specified, will default to the instance count.", "type": "integer", "x-ms-mutability": [ "create", "read" - ] + ], + "x-nullable": true }, - "workerCount": { + "parameterServerCount": { "format": "int32", - "description": "Number of workers. If not specified, will default to the instance count.", + "description": "Number of parameter server tasks.", + "default": 0, "type": "integer", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] } }, "x-ms-discriminator-value": "TensorFlow", @@ -23655,21 +23655,16 @@ "description": "Training related configuration.", "type": "object", "properties": { - "enableDnnTraining": { - "description": "Enable recommendation of DNN models.", - "default": false, - "type": "boolean" - }, - "enableModelExplainability": { - "description": "Flag to turn on explainability on best model.", - "default": true, - "type": "boolean" - }, "enableOnnxCompatibleModels": { "description": "Flag for enabling onnx compatible models.", "default": false, "type": "boolean" }, + "stackEnsembleSettings": { + "description": "Stack ensemble settings for stack ensemble run.", + "$ref": "#/definitions/StackEnsembleSettings", + "x-nullable": true + }, "enableStackEnsemble": { "description": "Enable stack ensemble run.", "default": true, @@ -23686,10 +23681,15 @@ "default": "PT5M", "type": "string" }, - "stackEnsembleSettings": { - "description": "Stack ensemble settings for stack ensemble run.", - "$ref": "#/definitions/StackEnsembleSettings", - "x-nullable": true + "enableModelExplainability": { + "description": "Flag to turn on explainability on best model.", + "default": true, + "type": "boolean" + }, + "enableDnnTraining": { + "description": "Enable recommendation of DNN models.", + "default": false, + "type": "boolean" } }, "additionalProperties": false @@ -23721,15 +23721,6 @@ "read" ] }, - "distribution": { - "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", - "$ref": "#/definitions/DistributionConfiguration", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "environmentId": { "description": "[Required] The ARM resource ID of the Environment specification for the job.", "minLength": 1, @@ -23749,6 +23740,15 @@ ], "x-nullable": true }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "resources": { "description": "Compute Resource configuration for the job.", "default": "{}", @@ -23767,6 +23767,15 @@ ], "type": "object", "properties": { + "triggerType": { + "description": "[Required] ", + "$ref": "#/definitions/TriggerType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, "endTime": { "description": "Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601.\r\nRecommented format would be \"2022-06-01T00:00:01\"\r\nIf not present, the schedule will run indefinitely", "type": "string", @@ -23781,15 +23790,6 @@ "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", "default": "UTC", "type": "string" - }, - "triggerType": { - "description": "[Required] ", - "$ref": "#/definitions/TriggerType", - "x-ms-mutability": [ - "create", - "read", - "update" - ] } }, "discriminator": "triggerType" @@ -24010,6 +24010,14 @@ ], "type": "object", "properties": { + "webhookType": { + "description": "[Required] Specifies the type of service to send a callback", + "$ref": "#/definitions/WebhookType", + "x-ms-mutability": [ + "create", + "read" + ] + }, "eventType": { "description": "Send callback on a specified notification event", "type": "string", @@ -24018,14 +24026,6 @@ "read" ], "x-nullable": true - }, - "webhookType": { - "description": "[Required] Specifies the type of service to send a callback", - "$ref": "#/definitions/WebhookType", - "x-ms-mutability": [ - "create", - "read" - ] } }, "discriminator": "webhookType" From 69c429fb901e091182aa5ee0c1a1f1b074c4f06b Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Tue, 9 Jul 2024 13:12:02 -0700 Subject: [PATCH 289/343] Remove unnecessary rename Signed-off-by: Travis Angevine --- specification/ai/ModelClient/client.tsp | 4 ---- 1 file changed, 4 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 7b24aeed6fe8..7254da42efb3 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -118,7 +118,3 @@ interface Client3 { embed is AI.Model.getImageEmbeddings; getModelInfo is AI.Model.getModelInfo; } - -// The following is to update names as necessary for specific programming languages. -// Done in this file to provide a single point of reference for any renames. -@@clientName(ModelClient.StreamingChatChoiceUpdate.delta, "InternalStreamingDeltaMessage", "csharp"); From 87bcdbe7baec9da6072863730f66194ab3ce8085 Mon Sep 17 00:00:00 2001 From: schaudhari6254888 <111409694+schaudhari6254888@users.noreply.github.com> Date: Wed, 10 Jul 2024 02:05:44 +0530 Subject: [PATCH 290/343] [ServiceBus]: Api version 2023-01-01-preview to support data disaster recovery (#29315) * Base commit * New Api Version 2023/01/01/preview * Readme Updated with new version * Failover API with Example * Minor folder correction * Updates * Updates' --- .../AuthorizationRules.json | 1256 ++++++++++++++++ .../CheckNameAvailability.json | 185 +++ .../DisasterRecoveryConfig.json | 423 ++++++ .../preview/2023-01-01-preview/Queue.json | 394 +++++ .../preview/2023-01-01-preview/Rules.json | 449 ++++++ ...grationconfigurationCompleteMigration.json | 12 + ...nconfigurationCreateAndStartMigration.json | 43 + .../SBMigrationconfigurationDelete.json | 13 + .../SBMigrationconfigurationGet.json | 25 + .../SBMigrationconfigurationList.json | 28 + .../SBMigrationconfigurationRevert.json | 12 + .../PrivateEndPointConnectionCreate.json | 74 + .../PrivateEndPointConnectionDelete.json | 26 + .../PrivateEndPointConnectionGet.json | 28 + .../PrivateEndPointConnectionList.json | 31 + .../NameSpaces/PrivateLinkResourcesGet.json | 30 + .../SBNameSpaceAuthorizationRuleCreate.json | 32 + .../SBNameSpaceAuthorizationRuleDelete.json | 13 + .../SBNameSpaceAuthorizationRuleGet.json | 24 + .../SBNameSpaceAuthorizationRuleListAll.json | 39 + .../SBNameSpaceAuthorizationRuleListKey.json | 20 + ...meSpaceAuthorizationRuleRegenerateKey.json | 23 + .../SBNameSpaceCheckNameAvailability.json | 18 + .../NameSpaces/SBNameSpaceCreate.json | 105 ++ .../NameSpaces/SBNameSpaceDelete.json | 25 + .../examples/NameSpaces/SBNameSpaceGet.json | 52 + .../examples/NameSpaces/SBNameSpaceList.json | 879 +++++++++++ .../SBNameSpaceListByResourceGroup.json | 37 + .../NameSpaces/SBNameSpaceUpdate.json | 67 + .../NameSpaces/SBNamespaceFailover.json | 22 + .../SBNetworkRuleSetCreate.json | 110 ++ .../SBNetworkRuleSetGet.json | 63 + .../SBNetworkRuleSetList.json | 66 + .../SBQueueAuthorizationRuleCreate.json | 33 + .../SBQueueAuthorizationRuleDelete.json | 14 + .../Queues/SBQueueAuthorizationRuleGet.json | 25 + .../SBQueueAuthorizationRuleListAll.json | 28 + .../SBQueueAuthorizationRuleListKey.json | 21 + ...SBQueueAuthorizationRuleRegenerateKey.json | 24 + .../examples/Queues/SBQueueCreate.json | 42 + .../examples/Queues/SBQueueDelete.json | 13 + .../examples/Queues/SBQueueGet.json | 37 + .../Queues/SBQueueListByNameSpace.json | 40 + .../examples/Rules/RuleCreate.json | 29 + .../Rules/RuleCreate_CorrelationFilter.json | 39 + .../examples/Rules/RuleCreate_SqlFilter.json | 36 + .../examples/Rules/RuleDelete.json | 15 + .../examples/Rules/RuleGet.json | 28 + .../Rules/RuleListBySubscription.json | 31 + .../examples/SBOperations_List.json | 301 ++++ .../Subscriptions/SBSubscriptionCreate.json | 48 + .../Subscriptions/SBSubscriptionDelete.json | 14 + .../Subscriptions/SBSubscriptionGet.json | 43 + .../SBSubscriptionListByTopic.json | 46 + .../SBTopicAuthorizationRuleCreate.json | 33 + .../SBTopicAuthorizationRuleDelete.json | 14 + .../Topics/SBTopicAuthorizationRuleGet.json | 25 + .../SBTopicAuthorizationRuleListAll.json | 28 + .../SBTopicAuthorizationRuleListKey.json | 21 + ...SBTopicAuthorizationRuleRegenerateKey.json | 24 + .../examples/Topics/SBTopicCreate.json | 41 + .../examples/Topics/SBTopicDelete.json | 13 + .../examples/Topics/SBTopicGet.json | 36 + .../Topics/SBTopicListByNameSpace.json | 39 + .../SBAliasAuthorizationRuleGet.json | 25 + .../SBAliasAuthorizationRuleListAll.json | 62 + .../SBAliasAuthorizationRuleListKey.json | 21 + .../SBAliasCheckNameAvailability.json | 20 + .../SBAliasCreate.json | 43 + .../SBAliasDelete.json | 13 + .../SBAliasFailOver.json | 12 + .../disasterRecoveryConfigs/SBAliasGet.json | 24 + .../disasterRecoveryConfigs/SBAliasList.json | 27 + .../SBEHAliasBreakPairing.json | 12 + .../2023-01-01-preview/migrationconfigs.json | 385 +++++ .../2023-01-01-preview/namespace-preview.json | 1301 +++++++++++++++++ .../2023-01-01-preview/networksets.json | 310 ++++ .../2023-01-01-preview/operations.json | 150 ++ .../2023-01-01-preview/subscriptions.json | 407 ++++++ .../preview/2023-01-01-preview/topics.json | 372 +++++ .../servicebus/resource-manager/readme.md | 39 +- 81 files changed, 9027 insertions(+), 1 deletion(-) create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/AuthorizationRules.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/CheckNameAvailability.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/DisasterRecoveryConfig.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Queue.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Rules.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceList.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNamespaceFailover.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueListByNameSpace.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_SqlFilter.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleListBySubscription.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/SBOperations_List.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicListByNameSpace.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/migrationconfigs.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/namespace-preview.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/networksets.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/operations.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/subscriptions.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/topics.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/AuthorizationRules.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/AuthorizationRules.json new file mode 100644 index 000000000000..1f24620a8ae9 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/AuthorizationRules.json @@ -0,0 +1,1256 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules": { + "get": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_ListAuthorizationRules", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListAll": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rules returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleCreate": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json" + } + }, + "description": "Creates or updates an authorization rule for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639410.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_DeleteAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleDelete": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a namespace authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639417.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_GetAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleGet": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a namespace by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_ListKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListKey": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_RegenerateKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleRegenerateKey": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt718977.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules": { + "get": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_ListAuthorizationRules", + "x-ms-examples": { + "QueueAuthorizationRuleListAll": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleListAll.json" + } + }, + "description": "Gets all authorization rules for a queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705607.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rules successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleCreate": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleCreate.json" + } + }, + "description": "Creates an authorization rule for a queue.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_DeleteAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleDelete": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a queue authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705609.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_GetAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleGet": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a queue by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705611.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys": { + "post": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_ListKeys", + "x-ms-examples": { + "QueueAuthorizationRuleListKey": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleListKey.json" + } + }, + "description": "Primary and secondary connection strings to the queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705608.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_RegenerateKeys", + "x-ms-examples": { + "QueueAuthorizationRuleRegenerateKey": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings to the queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705606.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules": { + "get": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_ListAuthorizationRules", + "x-ms-examples": { + "TopicAuthorizationRuleListAll": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleListAll.json" + } + }, + "description": "Gets authorization rules for a topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rules successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleCreate": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleCreate.json" + } + }, + "description": "Creates an authorization rule for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule successfully created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_GetAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleGet": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleGet.json" + } + }, + "description": "Returns the specified authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_DeleteAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleDelete": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a topic authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys": { + "post": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_ListKeys", + "x-ms-examples": { + "TopicAuthorizationRuleListKey": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully retrieved.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_RegenerateKeys", + "x-ms-examples": { + "TopicAuthorizationRuleRegenerateKey": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates primary or secondary connection strings for the topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListAll": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "DisasterRecoveryConfigs authorization rules returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", + "x-ms-examples": { + "DisasterRecoveryConfigsAuthorizationRuleGet": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a namespace by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "DisasterRecoveryConfigs authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListKeys", + "x-ms-examples": { + "DisasterRecoveryConfigsAuthorizationRuleListKey": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBAuthorizationRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "Result of the List Authorization Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules." + } + }, + "description": "The response to the List Namespace operation." + }, + "SBAuthorizationRule": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "rights": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Manage", + "Send", + "Listen" + ], + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + }, + "description": "The rights associated with the rule." + } + }, + "required": [ + "rights" + ], + "description": "AuthorizationRule properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of a namespace authorization rule." + }, + "AccessKeys": { + "type": "object", + "properties": { + "primaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the created namespace authorization rule." + }, + "secondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the created namespace authorization rule." + }, + "aliasPrimaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the alias if GEO DR is enabled" + }, + "aliasSecondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the alias if GEO DR is enabled" + }, + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "keyName": { + "readOnly": true, + "type": "string", + "description": "A string that describes the authorization rule." + } + }, + "description": "Namespace/ServiceBus Connection String" + }, + "RegenerateAccessKeyParameters": { + "type": "object", + "properties": { + "keyType": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "key": { + "type": "string", + "description": "Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType" + } + }, + "required": [ + "keyType" + ], + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/CheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/CheckNameAvailability.json new file mode 100644 index 000000000000..049c28de0135 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/CheckNameAvailability.json @@ -0,0 +1,185 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability": { + "post": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CheckNameAvailability", + "x-ms-examples": { + "NameSpaceCheckNameAvailability": { + "$ref": "./examples/NameSpaces/SBNameSpaceCheckNameAvailability.json" + } + }, + "description": "Check the give namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + }, + "description": "Parameters to check availability of the given namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", + "x-ms-examples": { + "AliasNameAvailability": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json" + } + }, + "description": "Check the give namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + }, + "description": "Parameters to check availability of the given namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "CheckNameAvailability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." + } + }, + "required": [ + "name" + ], + "description": "Description of a Check Name availability request properties." + }, + "CheckNameAvailabilityResult": { + "type": "object", + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "The detailed info regarding the reason associated with the namespace." + }, + "nameAvailable": { + "type": "boolean", + "description": "Value indicating namespace is availability, true if the namespace is available; otherwise, false." + }, + "reason": { + "$ref": "#/definitions/UnavailableReason", + "description": "The reason for unavailability of a namespace." + } + }, + "description": "Description of a Check Name availability request properties." + }, + "UnavailableReason": { + "type": "string", + "enum": [ + "None", + "InvalidName", + "SubscriptionIsDisabled", + "NameInUse", + "NameInLockdown", + "TooManyNamespaceInCurrentSubscription" + ], + "x-ms-enum": { + "name": "UnavailableReason", + "modelAsString": false + }, + "description": "Specifies the reason for the unavailability of the service." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/DisasterRecoveryConfig.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/DisasterRecoveryConfig.json new file mode 100644 index 000000000000..4e950442f92b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/DisasterRecoveryConfig.json @@ -0,0 +1,423 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_List", + "x-ms-examples": { + "SBAliasList": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasList.json" + } + }, + "description": "Gets all Alias(Disaster Recovery configurations)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Alias(Disaster Recovery configurations) for servicebus namespace", + "schema": { + "$ref": "#/definitions/ArmDisasterRecoveryListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { + "put": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", + "x-ms-examples": { + "SBAliasCreate": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasCreate.json" + } + }, + "description": "Creates or updates a new Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "Parameters required to create an Alias(Disaster Recovery configuration)" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Alias(Disaster Recovery configuration) successfully created", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "201": { + "description": "Alias(Disaster Recovery configuration) creation request received", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Delete", + "x-ms-examples": { + "SBAliasDelete": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasDelete.json" + } + }, + "description": "Deletes an Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Alias(Disaster Recovery configuration) request accepted" + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Get", + "x-ms-examples": { + "SBAliasGet": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasGet.json" + } + }, + "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Alias(Disaster Recovery configurations)", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_BreakPairing", + "x-ms-examples": { + "SBEHAliasBreakPairing": { + "$ref": "./examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json" + } + }, + "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Break-Pairing operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_FailOver", + "x-ms-examples": { + "SBAliasFailOver": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasFailOver.json" + } + }, + "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FailoverProperties" + }, + "description": "Parameters required to create an Alias(Disaster Recovery configuration)" + } + ], + "responses": { + "200": { + "description": "Failover operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ArmDisasterRecovery": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", + "enum": [ + "Accepted", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningStateDR", + "modelAsString": false + } + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, + "partnerNamespace": { + "type": "string", + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "alternateName": { + "type": "string", + "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "role": { + "readOnly": true, + "type": "string", + "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", + "enum": [ + "Primary", + "PrimaryNotReplicating", + "Secondary" + ], + "x-ms-enum": { + "name": "RoleDisasterRecovery", + "modelAsString": false + } + } + }, + "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" + }, + "FailoverProperties": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "IsSafeFailover": { + "type": "boolean", + "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." + } + }, + "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." + } + }, + "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." + }, + "ArmDisasterRecoveryListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "List of Alias(Disaster Recovery configurations)" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)" + } + }, + "description": "The result of the List Alias(Disaster Recovery configuration) operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Queue.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Queue.json new file mode 100644 index 000000000000..1942caf3659c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Queue.json @@ -0,0 +1,394 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues": { + "get": { + "tags": [ + "Queues" + ], + "operationId": "Queues_ListByNamespace", + "x-ms-examples": { + "QueueListByNameSpace": { + "$ref": "./examples/Queues/SBQueueListByNameSpace.json" + } + }, + "description": "Gets the queues within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639415.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Queues successfully returned.", + "schema": { + "$ref": "#/definitions/SBQueueListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}": { + "put": { + "tags": [ + "Queues" + ], + "operationId": "Queues_CreateOrUpdate", + "x-ms-examples": { + "QueueCreate": { + "$ref": "./examples/Queues/SBQueueCreate.json" + } + }, + "description": "Creates or updates a Service Bus queue. This operation is idempotent.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639395.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBQueue" + }, + "description": "Parameters supplied to create or update a queue resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue successfully created.", + "schema": { + "$ref": "#/definitions/SBQueue" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Queues" + ], + "operationId": "Queues_Delete", + "x-ms-examples": { + "QueueDelete": { + "$ref": "./examples/Queues/SBQueueDelete.json" + } + }, + "description": "Deletes a queue from the specified namespace in a resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639411.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Queues" + ], + "operationId": "Queues_Get", + "x-ms-examples": { + "QueueGet": { + "$ref": "./examples/Queues/SBQueueGet.json" + } + }, + "description": "Returns a description for the specified queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639380.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue description successfully returned.", + "schema": { + "$ref": "#/definitions/SBQueue" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBQueueListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBQueue" + }, + "description": "Result of the List Queues operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of queues." + } + }, + "description": "The response to the List Queues operation." + }, + "SBQueue": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBQueueProperties", + "description": "Queue Properties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of queue Resource." + }, + "SBQueueProperties": { + "type": "object", + "properties": { + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message Count Details." + }, + "createdAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The exact time the message was updated." + }, + "accessedAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last time a message was sent, or the last time there was a receive request to this queue." + }, + "sizeInBytes": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "The size of the queue, in bytes." + }, + "messageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "The number of messages in the queue." + }, + "lockDuration": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." + }, + "maxSizeInMegabytes": { + "format": "int32", + "type": "integer", + "description": "The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024." + }, + "maxMessageSizeInKilobytes": { + "format": "int64", + "type": "integer", + "description": "Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024." + }, + "requiresDuplicateDetection": { + "type": "boolean", + "description": "A value indicating if this queue requires duplicate detection." + }, + "requiresSession": { + "type": "boolean", + "description": "A value that indicates whether the queue supports the concept of sessions." + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "deadLetteringOnMessageExpiration": { + "type": "boolean", + "description": "A value that indicates whether this queue has dead letter support when a message expires." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "maxDeliveryCount": { + "format": "int32", + "type": "integer", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes." + }, + "enablePartitioning": { + "type": "boolean", + "description": "A value that indicates whether the queue is to be partitioned across multiple message brokers." + }, + "enableExpress": { + "type": "boolean", + "description": "A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage." + }, + "forwardTo": { + "type": "string", + "description": "Queue/Topic name to forward the messages" + }, + "forwardDeadLetteredMessagesTo": { + "type": "string", + "description": "Queue/Topic name to forward the Dead Letter message" + } + }, + "description": "The Queue Properties definition." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Rules.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Rules.json new file mode 100644 index 000000000000..216631491cee --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Rules.json @@ -0,0 +1,449 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules": { + "get": { + "tags": [ + "Rules" + ], + "operationId": "Rules_ListBySubscriptions", + "x-ms-examples": { + "RulesListBySubscriptions": { + "$ref": "./examples/Rules/RuleListBySubscription.json" + } + }, + "description": "List all the rules within given topic-subscription", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of Rules.", + "schema": { + "$ref": "#/definitions/RuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}": { + "put": { + "tags": [ + "Rules" + ], + "operationId": "Rules_CreateOrUpdate", + "x-ms-examples": { + "RulesCreateOrUpdate": { + "$ref": "./examples/Rules/RuleCreate.json" + }, + "RulesCreateSqlFilter": { + "$ref": "./examples/Rules/RuleCreate_SqlFilter.json" + }, + "RulesCreateCorrelationFilter": { + "$ref": "./examples/Rules/RuleCreate_CorrelationFilter.json" + } + }, + "description": "Creates a new rule and updates an existing rule", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Rule" + }, + "description": "Parameters supplied to create a rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Rule created.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Rules" + ], + "operationId": "Rules_Delete", + "x-ms-examples": { + "RulesDelete": { + "$ref": "./examples/Rules/RuleDelete.json" + } + }, + "description": "Deletes an existing rule.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Rule deleted." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Rules_Get", + "x-ms-examples": { + "RulesGet": { + "$ref": "./examples/Rules/RuleGet.json" + } + }, + "description": "Retrieves the description for the specified rule.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved rule description.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Rule": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Ruleproperties", + "description": "Properties of Rule resource" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of Rule Resource." + }, + "Ruleproperties": { + "type": "object", + "properties": { + "action": { + "$ref": "#/definitions/Action", + "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." + }, + "filterType": { + "$ref": "#/definitions/FilterType", + "description": "Filter type that is evaluated against a BrokeredMessage." + }, + "sqlFilter": { + "$ref": "#/definitions/SqlFilter", + "description": "Properties of sqlFilter" + }, + "correlationFilter": { + "$ref": "#/definitions/CorrelationFilter", + "description": "Properties of correlationFilter" + } + }, + "description": "Description of Rule Resource." + }, + "RuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Rule" + }, + "description": "Result of the List Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of rules" + } + }, + "description": "The response of the List rule operation." + }, + "FilterType": { + "type": "string", + "enum": [ + "SqlFilter", + "CorrelationFilter" + ], + "x-ms-enum": { + "name": "FilterType", + "modelAsString": false + }, + "description": "Rule filter types" + }, + "SqlFilter": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "The SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline." + }, + "CorrelationFilter": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "dictionary object for custom filters" + }, + "correlationId": { + "type": "string", + "description": "Identifier of the correlation." + }, + "messageId": { + "type": "string", + "description": "Identifier of the message." + }, + "to": { + "type": "string", + "description": "Address to send to." + }, + "replyTo": { + "type": "string", + "description": "Address of the queue to reply to." + }, + "label": { + "type": "string", + "description": "Application specific label." + }, + "sessionId": { + "type": "string", + "description": "Session identifier." + }, + "replyToSessionId": { + "type": "string", + "description": "Session identifier to reply to." + }, + "contentType": { + "type": "string", + "description": "Content type of the message." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents the correlation filter expression." + }, + "Action": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." + }, + "SqlRuleAction": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "description": "Represents set of actions written in SQL language-based syntax that is performed against a ServiceBus.Messaging.BrokeredMessage " + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json new file mode 100644 index 000000000000..469d02b7f204 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json new file mode 100644 index 000000000000..4484b01f35c8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "subscriptionId": "SubscriptionId", + "configName": "$default", + "parameters": { + "properties": { + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Accepted", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919", + "migrationState": "Initiating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Accepted", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919", + "migrationState": "Initiating" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json new file mode 100644 index 000000000000..40de85f34520 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json new file mode 100644 index 000000000000..15a2f68d8218 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Succeeded", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919", + "pendingReplicationOperationsCount": 0, + "migrationState": "Active" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json new file mode 100644 index 000000000000..f6ac93f377bd --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9259", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9259/migrationConfigs/sdk-Namespace-9259", + "name": "sdk-Namespace-9259", + "type": "Microsoft.ServiceBus/Namespaces/migrationconfigurations", + "properties": { + "provisioningState": "Succeeded", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7454", + "postMigrationName": "sdk-PostMigration-9423", + "migrationState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json new file mode 100644 index 000000000000..469d02b7f204 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json new file mode 100644 index 000000000000..ba58b32b58d6 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "subID", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "testing" + }, + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json new file mode 100644 index 000000000000..4a5375b9d768 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "privateEndpointConnectionName": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "api-version": "2023-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json new file mode 100644 index 000000000000..a913508142af --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-ServiceBus-4794", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "api-version": "2023-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json new file mode 100644 index 000000000000..6b6cbe04150a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-ServiceBus-4794", + "api-version": "2023-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5705-new/privateEndpointConnections/5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "name": "5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5705-new" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..f27f99fd043c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/subID/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateLinkResources/namespace", + "name": "namespace", + "type": "Microsoft.ServiceBus/namespaces/privateLinkResources", + "properties": { + "groupId": "namespace", + "requiredMembers": [ + "namespace" + ], + "requiredZoneNames": [ + "privatelink.servicebus.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json new file mode 100644 index 000000000000..989370fb6cba --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules/sdk-AuthRules-1788", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json new file mode 100644 index 000000000000..ac0946d68008 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json new file mode 100644 index 000000000000..20cfb6eaf730 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules/sdk-AuthRules-1788/", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json new file mode 100644 index 000000000000..8baa5afc2b0d --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6914", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://sbgm.windows-int.net/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules?api-version=2017-04-01/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Manage", + "Send" + ] + } + }, + { + "id": "https://sbgm.windows-int.net/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules?api-version=2017-04-01/sdk-AuthRules-1788", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json new file mode 100644 index 000000000000..f2ed9f91c56b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "namespaceName": "sdk-namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=############################################", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-1788" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..b4c395ee924a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "namespaceName": "sdk-namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=#############################################", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=#############################################", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-AuthRules-1788" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json new file mode 100644 index 000000000000..d311c19689ed --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "name": "sdk-Namespace-2924" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json new file mode 100644 index 000000000000..cce6842bb7e8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 4 + }, + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "geoDataReplication": { + "maxReplicationLagDurationInSeconds": 300, + "locations": [ + { + "locationName": "eastus", + "roleType": "Primary" + }, + { + "locationName": "southcentralus", + "roleType": "Secondary" + } + ] + }, + "premiumMessagingPartitions": 2 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 4 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "geoDataReplication": { + "maxReplicationLagDurationInSeconds": 300, + "locations": [ + { + "locationName": "eastus", + "roleType": "Primary" + }, + { + "locationName": "southcentralus", + "roleType": "Secondary" + } + ] + }, + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:36.76Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "minimumTlsVersion": "1.2", + "premiumMessagingPartitions": 2 + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 4 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:36.76Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false, + "minimumTlsVersion": "1.2", + "premiumMessagingPartitions": 2 + } + } + }, + "202": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json new file mode 100644 index 000000000000..ae716ae34586 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json new file mode 100644 index 000000000000..5b0bd9f0b97f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "minimumTlsVersion": "1.2", + "disableLocalAuth": false, + "privateEndpointConnections": [ + { + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceList.json new file mode 100644 index 000000000000..c0c2e1162e70 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceList.json @@ -0,0 +1,879 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "name": "NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "createdAt": "2016-08-23T02:40:17.27Z", + "updatedAt": "2017-02-11T07:15:30.78Z", + "serviceBusEndpoint": "https://NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20.servicebus.windows-int.net:443/", + "minimumTlsVersion": "1.2", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "name": "NS-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "createdAt": "2016-08-23T03:50:38.98Z", + "updatedAt": "2017-02-11T10:42:58.003Z", + "serviceBusEndpoint": "https://NS-41dc63f4-0b08-4029-b3ef-535a131bfa65.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-df52cf51-e831-4bf2-bd92-e9885f68a996", + "name": "NS-df52cf51-e831-4bf2-bd92-e9885f68a996", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-df52cf51-e831-4bf2-bd92-e9885f68a996", + "createdAt": "2016-09-16T01:17:54.997Z", + "updatedAt": "2017-02-11T06:44:39.737Z", + "serviceBusEndpoint": "https://NS-df52cf51-e831-4bf2-bd92-e9885f68a996.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/SBPremium", + "name": "SBPremium", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbpremium", + "createdAt": "2016-10-10T22:01:00.42Z", + "updatedAt": "2016-10-10T22:01:00.42Z", + "serviceBusEndpoint": "https://SBPremium.servicebus.windows-int.net:443/", + "disableLocalAuth": false, + "premiumMessagingPartitions": 1 + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/sadfsadfsadf/providers/Microsoft.ServiceBus/namespaces/rrama-ns2", + "name": "rrama-ns2", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-ns2", + "createdAt": "2016-08-23T04:14:00.013Z", + "updatedAt": "2017-02-03T22:53:32.927Z", + "serviceBusEndpoint": "https://rrama-ns2.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-20e57600-29d0-4035-ac85-74f4c54dcda1", + "name": "NS-20e57600-29d0-4035-ac85-74f4c54dcda1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-20e57600-29d0-4035-ac85-74f4c54dcda1", + "createdAt": "2016-08-23T03:30:49.16Z", + "updatedAt": "2017-02-11T04:17:58.483Z", + "serviceBusEndpoint": "https://NS-20e57600-29d0-4035-ac85-74f4c54dcda1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "name": "NS-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "createdAt": "2016-09-16T18:07:30.05Z", + "updatedAt": "2017-02-11T10:42:57.747Z", + "serviceBusEndpoint": "https://NS-3e538a1a-58fb-4315-b2ce-76f5c944114c.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 4 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/prem-ns123", + "name": "prem-ns123", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:prem-ns123", + "createdAt": "2016-09-13T00:02:39.997Z", + "updatedAt": "2016-09-13T00:02:39.997Z", + "serviceBusEndpoint": "https://prem-ns123.servicebus.windows-int.net:443/", + "disableLocalAuth": false, + "premiumMessagingPartitions": 2 + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "name": "NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "createdAt": "2016-09-16T01:01:58.73Z", + "updatedAt": "2017-02-11T03:02:59.8Z", + "serviceBusEndpoint": "https://NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "name": "NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "createdAt": "2016-08-23T03:22:45.327Z", + "updatedAt": "2017-02-11T06:08:01.207Z", + "serviceBusEndpoint": "https://NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-c05e9df3-7737-44ee-a321-15f6e0545b97", + "name": "NS-c05e9df3-7737-44ee-a321-15f6e0545b97", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-c05e9df3-7737-44ee-a321-15f6e0545b97", + "createdAt": "2016-08-05T03:29:19.75Z", + "updatedAt": "2017-02-11T08:10:35.527Z", + "serviceBusEndpoint": "https://NS-c05e9df3-7737-44ee-a321-15f6e0545b97.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "name": "NS-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "createdAt": "2016-08-05T03:34:35.363Z", + "updatedAt": "2017-02-11T05:33:00.957Z", + "serviceBusEndpoint": "https://NS-dcb4152c-231b-4c16-a683-07cc6b38fa46.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-f501f5e6-1f24-439b-8982-9af665156d40", + "name": "NS-f501f5e6-1f24-439b-8982-9af665156d40", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-f501f5e6-1f24-439b-8982-9af665156d40", + "createdAt": "2016-09-16T01:25:55.707Z", + "updatedAt": "2017-02-11T07:42:59.687Z", + "serviceBusEndpoint": "https://NS-f501f5e6-1f24-439b-8982-9af665156d40.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "name": "NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "createdAt": "2016-08-23T02:32:08.227Z", + "updatedAt": "2017-02-11T06:32:57.77Z", + "serviceBusEndpoint": "https://NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "name": "NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "createdAt": "2016-09-16T00:54:05.103Z", + "updatedAt": "2017-02-11T10:43:50.313Z", + "serviceBusEndpoint": "https://NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-6520cc09-01ac-40a3-bc09-c5c431116e92", + "name": "NS-6520cc09-01ac-40a3-bc09-c5c431116e92", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-6520cc09-01ac-40a3-bc09-c5c431116e92", + "createdAt": "2016-09-16T01:49:59.243Z", + "updatedAt": "2017-02-11T08:15:36.95Z", + "serviceBusEndpoint": "https://NS-6520cc09-01ac-40a3-bc09-c5c431116e92.servicebus.windows-int.net:443", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "name": "NS-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "createdAt": "2016-08-05T03:23:32.083Z", + "updatedAt": "2017-02-11T09:02:57.433Z", + "serviceBusEndpoint": "https://NS-bfba6d5c-a425-42d9-85db-0f4da770e29a.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/SBPrem", + "name": "SBPrem", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbprem", + "createdAt": "2016-10-10T22:16:30.87Z", + "updatedAt": "2016-10-10T22:16:30.87Z", + "serviceBusEndpoint": "https://SBPrem.servicebus.windows-int.net:443/", + "disableLocalAuth": false, + "premiumMessagingPartitions": 2 + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-43b136b4-8716-40b2-97c5-0d77cac0062c", + "name": "NS-43b136b4-8716-40b2-97c5-0d77cac0062c", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-43b136b4-8716-40b2-97c5-0d77cac0062c", + "createdAt": "2016-08-23T03:14:50.577Z", + "updatedAt": "2017-02-11T09:23:01.067Z", + "serviceBusEndpoint": "https://NS-43b136b4-8716-40b2-97c5-0d77cac0062c.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-7c0443de-5f88-450c-b574-83f60a097dd1", + "name": "NS-7c0443de-5f88-450c-b574-83f60a097dd1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-7c0443de-5f88-450c-b574-83f60a097dd1", + "createdAt": "2016-08-23T04:07:15.397Z", + "updatedAt": "2017-02-11T04:03:03.097Z", + "serviceBusEndpoint": "https://NS-7c0443de-5f88-450c-b574-83f60a097dd1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "name": "NS-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "createdAt": "2016-09-16T01:33:50.45Z", + "updatedAt": "2017-02-11T05:35:33.053Z", + "serviceBusEndpoint": "https://NS-62dd7753-a5f9-42fd-a354-ca38a4505d69.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-ae18a18c-97ab-4089-965d-8acbf4794091", + "name": "NS-ae18a18c-97ab-4089-965d-8acbf4794091", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-ae18a18c-97ab-4089-965d-8acbf4794091", + "createdAt": "2016-08-23T02:43:36.517Z", + "updatedAt": "2017-02-11T12:40:30.587Z", + "serviceBusEndpoint": "https://NS-ae18a18c-97ab-4089-965d-8acbf4794091.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "name": "NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "createdAt": "2016-09-16T00:46:03.773Z", + "updatedAt": "2017-02-11T04:43:54.56Z", + "serviceBusEndpoint": "https://NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "name": "NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "createdAt": "2016-08-23T03:59:12.1Z", + "updatedAt": "2017-02-11T06:33:52.23Z", + "serviceBusEndpoint": "https://NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "name": "NS-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "createdAt": "2016-08-05T03:45:09.27Z", + "updatedAt": "2017-02-11T06:20:31.863Z", + "serviceBusEndpoint": "https://NS-d9337efd-9b27-454c-b2a5-dcfea56920d9.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "name": "NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "createdAt": "2016-08-23T02:34:36.447Z", + "updatedAt": "2017-02-11T06:15:31.607Z", + "serviceBusEndpoint": "https://NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-d447fb03-c7da-40fe-b5eb-14f36888837b", + "name": "NS-d447fb03-c7da-40fe-b5eb-14f36888837b", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-d447fb03-c7da-40fe-b5eb-14f36888837b", + "createdAt": "2016-08-05T00:53:46.697Z", + "updatedAt": "2017-02-11T11:09:41.26Z", + "serviceBusEndpoint": "https://NS-d447fb03-c7da-40fe-b5eb-14f36888837b.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/ReproSB", + "name": "ReproSB", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:reprosb", + "createdAt": "2017-02-27T19:29:34.523Z", + "updatedAt": "2017-02-27T19:29:58.64Z", + "serviceBusEndpoint": "https://ReproSB.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-4c90097f-19a8-42e7-bb3c-4ac088994719", + "name": "NS-4c90097f-19a8-42e7-bb3c-4ac088994719", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-4c90097f-19a8-42e7-bb3c-4ac088994719", + "createdAt": "2016-09-16T17:35:32.61Z", + "updatedAt": "2017-02-11T09:13:52.27Z", + "serviceBusEndpoint": "https://NS-4c90097f-19a8-42e7-bb3c-4ac088994719.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/rrama-1-23-17", + "name": "rrama-1-23-17", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-1-23-17", + "createdAt": "2017-01-23T22:54:40.907Z", + "updatedAt": "2017-02-04T00:53:28.777Z", + "serviceBusEndpoint": "https://rrama-1-23-17.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "name": "NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "createdAt": "2016-09-16T17:43:25.71Z", + "updatedAt": "2017-02-11T11:05:31.89Z", + "serviceBusEndpoint": "https://NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-be903820-3533-46e8-90e4-72c132411848", + "name": "NS-be903820-3533-46e8-90e4-72c132411848", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-be903820-3533-46e8-90e4-72c132411848", + "createdAt": "2016-08-05T03:24:01.923Z", + "updatedAt": "2017-02-11T10:09:42.513Z", + "serviceBusEndpoint": "https://NS-be903820-3533-46e8-90e4-72c132411848.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/rrama-namespace1", + "name": "rrama-namespace1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-namespace1", + "createdAt": "2016-08-05T00:47:22.963Z", + "updatedAt": "2016-08-05T00:47:27.297Z", + "serviceBusEndpoint": "https://rrama-namespace1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "name": "NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "createdAt": "2016-09-16T00:38:02.517Z", + "updatedAt": "2017-02-11T05:03:55.96Z", + "serviceBusEndpoint": "https://NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "name": "NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "createdAt": "2016-08-23T03:42:40.01Z", + "updatedAt": "2017-02-11T06:33:02.363Z", + "serviceBusEndpoint": "https://NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "name": "NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "createdAt": "2016-08-05T04:28:10.71Z", + "updatedAt": "2017-02-11T08:43:51.587Z", + "serviceBusEndpoint": "https://NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/rrama-sb1", + "name": "rrama-sb1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-sb1", + "createdAt": "2017-05-01T21:47:34.903Z", + "updatedAt": "2017-05-02T02:10:03.083Z", + "serviceBusEndpoint": "https://rrama-sb1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/WhackWhack", + "name": "WhackWhack", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:whackwhack", + "createdAt": "2016-10-10T23:39:01.347Z", + "updatedAt": "2017-02-04T00:56:32.687Z", + "serviceBusEndpoint": "https://WhackWhack.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "name": "NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "createdAt": "2016-09-16T17:51:27.73Z", + "updatedAt": "2017-02-11T08:19:43.383Z", + "serviceBusEndpoint": "https://NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "name": "NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "createdAt": "2016-08-05T01:14:25.613Z", + "updatedAt": "2017-02-11T12:33:01.727Z", + "serviceBusEndpoint": "https://NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/bn3-rrama-foo1", + "name": "bn3-rrama-foo1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bn3-rrama-foo1", + "createdAt": "2017-04-28T23:54:26.927Z", + "updatedAt": "2017-04-28T23:54:26.927Z", + "serviceBusEndpoint": "https://bn3-rrama-foo1.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/bn3-rrama-foo3", + "name": "bn3-rrama-foo3", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bn3-rrama-foo3", + "createdAt": "2017-04-29T00:24:09.907Z", + "updatedAt": "2017-04-29T00:24:33.233Z", + "serviceBusEndpoint": "https://bn3-rrama-foo3.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/bn3-rrama-foo2", + "name": "bn3-rrama-foo2", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bn3-rrama-foo2", + "createdAt": "2017-04-28T23:57:40.82Z", + "updatedAt": "2017-04-28T23:57:40.82Z", + "serviceBusEndpoint": "https://bn3-rrama-foo2.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/db3-rrama-foo2", + "name": "db3-rrama-foo2", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "North Europe", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:db3-rrama-foo2", + "createdAt": "2017-04-29T00:10:43.463Z", + "updatedAt": "2017-04-29T00:11:09.133Z", + "serviceBusEndpoint": "https://db3-rrama-foo2.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json new file mode 100644 index 000000000000..b8ba14389194 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "resourceGroupName": "ArunMonocle" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json new file mode 100644 index 000000000000..7e0ff4aa35ed --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3285", + "name": "sdk-Namespace-3285", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + }, + "properties": { + "provisioningState": "Updating", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3285", + "createdAt": "2017-05-25T23:07:58.17Z", + "updatedAt": "2017-05-25T23:08:45.497Z", + "serviceBusEndpoint": "https://sdk-Namespace-3285.servicebus.windows-int.net:443/", + "minimumTlsVersion": "1.1", + "disableLocalAuth": false + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3285", + "name": "sdk-Namespace-3285", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + }, + "properties": { + "provisioningState": "Updating", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3285", + "createdAt": "2017-05-25T23:07:58.17Z", + "updatedAt": "2017-05-25T23:08:45.497Z", + "serviceBusEndpoint": "https://sdk-Namespace-3285.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + } + }, + "202": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNamespaceFailover.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNamespaceFailover.json new file mode 100644 index 000000000000..73df6d08ae98 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNamespaceFailover.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "namespaceName": "NamespaceGeoDRFailoverSample", + "resourceGroupName": "ResurceGroupSample", + "api-version": "2023-01-01-preview", + "subscriptionId": "SampleSubscription", + "parameters": { + "properties": { + "primaryLocation": "centralus", + "force": true + } + } + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "https://management.azure.com/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/EHNamespaceFailover/eastus?api-version=2023-01-01-preview" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json new file mode 100644 index 000000000000..f3ec425ada00 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscription", + "parameters": { + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "publicNetworkAccess": "Enabled", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json new file mode 100644 index 000000000000..865cbfb086c5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionid/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Allow", + "publicNetworkAccess": "Enabled", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json new file mode 100644 index 000000000000..e936d0573b2f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionid/resourceGroups/resourcegroupid/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkrulesets/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json new file mode 100644 index 000000000000..f952e6005546 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800", + "name": "sdk-AuthRules-5800", + "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json new file mode 100644 index 000000000000..8457ad6562b8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json new file mode 100644 index 000000000000..7203a07ca31c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800", + "name": "sdk-AuthRules-5800", + "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json new file mode 100644 index 000000000000..f8c847ecf9bb --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-7982", + "queueName": "sdk-Queues-2317", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800", + "name": "sdk-AuthRules-5800", + "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json new file mode 100644 index 000000000000..0b3dd7221e7c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-5800" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..9a2ebf9e0077 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-5800" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueCreate.json new file mode 100644 index 000000000000..dcb6c8874376 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueCreate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3174", + "resourceGroupName": "ArunMonocle", + "queueName": "sdk-Queues-5647", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "enablePartitioning": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647", + "name": "sdk-Queues-5647", + "type": "Microsoft.ServiceBus/Namespaces/Queues", + "properties": { + "lockDuration": "PT1M", + "maxSizeInMegabytes": 163840, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "duplicateDetectionHistoryTimeWindow": "PT10M", + "maxDeliveryCount": 10, + "sizeInBytes": 0, + "messageCount": 0, + "status": "Active", + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": true, + "enableExpress": false, + "createdAt": "2017-05-26T18:07:33.68Z", + "updatedAt": "2017-05-26T18:07:34.227Z", + "accessedAt": "2017-05-26T18:07:34.227Z" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueDelete.json new file mode 100644 index 000000000000..2f8755f6245d --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-183", + "resourceGroupName": "ArunMonocle", + "queueName": "sdk-Queues-8708", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueGet.json new file mode 100644 index 000000000000..69218faab5d6 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3174", + "resourceGroupName": "ArunMonocle", + "queueName": "sdk-Queues-5647", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647", + "name": "sdk-Queues-5647", + "type": "Microsoft.ServiceBus/Namespaces/Queues", + "properties": { + "lockDuration": "PT1M", + "maxSizeInMegabytes": 163840, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "duplicateDetectionHistoryTimeWindow": "PT10M", + "maxDeliveryCount": 10, + "sizeInBytes": 0, + "messageCount": 0, + "status": "Active", + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": true, + "enableExpress": false, + "createdAt": "2017-05-26T18:07:32.4592931Z", + "updatedAt": "2017-05-26T18:07:34.6243761Z", + "accessedAt": "0001-01-01T00:00:00Z" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueListByNameSpace.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueListByNameSpace.json new file mode 100644 index 000000000000..7e2a5864d103 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueListByNameSpace.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3174", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-queues-5647", + "name": "sdk-queues-5647", + "type": "Microsoft.ServiceBus/Namespaces/Queues", + "properties": { + "lockDuration": "PT1M", + "maxSizeInMegabytes": 163840, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "duplicateDetectionHistoryTimeWindow": "PT10M", + "maxDeliveryCount": 10, + "sizeInBytes": 0, + "messageCount": 0, + "status": "Active", + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": true, + "enableExpress": false, + "createdAt": "2017-05-26T18:07:32.4592931Z", + "updatedAt": "2017-05-26T18:07:34.6243761Z", + "accessedAt": "0001-01-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate.json new file mode 100644 index 000000000000..dac6f83f27f2 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "resourceGroupName", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "subscriptionId", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "1=1", + "compatibilityLevel": 20 + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json new file mode 100644 index 000000000000..b8a7dcbc8070 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "resourceGroupName", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "filterType": "CorrelationFilter", + "correlationFilter": { + "properties": { + "topicHint": "Crop" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "CorrelationFilter", + "correlationFilter": { + "properties": { + "queueHint": "Crop" + } + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_SqlFilter.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_SqlFilter.json new file mode 100644 index 000000000000..6bda3a315aa5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_SqlFilter.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "resourceGroupName", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "myproperty=test" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "myproperty=test", + "compatibilityLevel": 20 + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleDelete.json new file mode 100644 index 000000000000..695bba753df8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleGet.json new file mode 100644 index 000000000000..647fc586ed19 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "1=1", + "compatibilityLevel": 20 + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleListBySubscription.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleListBySubscription.json new file mode 100644 index 000000000000..8159cab4975f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "1=1", + "compatibilityLevel": 20 + } + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/SBOperations_List.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/SBOperations_List.json new file mode 100644 index 000000000000..37bda682e4a5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/SBOperations_List.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ServiceBus/checkNameAvailability/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Non Resource Operation", + "operation": "Get namespace availability." + } + }, + { + "name": "Microsoft.ServiceBus/register/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "ServiceBus Resource Provider", + "operation": "Registers the ServiceBus Resource Provider" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Create Or Update Namespace " + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Get Namespace Resource" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Delete Namespace" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Create or Update Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Get Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Delete Namespace Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Get Namespace Listkeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Create or Update Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Get Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Delete Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Create or Update Queue Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": " Get Queue Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Delete Queue Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "List Queue keys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Create or Update Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Get Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Delete Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Create or Update Topic Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": " Get Topic Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Delete Topic Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "List Topic keys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Create or Update TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Get TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Delete TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Create or Update Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Get Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Delete Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/metricDefinitions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace metrics", + "operation": "Get Namespace metrics" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/diagnosticSettings/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace diagnostic settings", + "operation": "Get Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/diagnosticSettings/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace diagnostic settings", + "operation": "Create or Update Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/logDefinitions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace logs", + "operation": "Get Namespace logs" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionCreate.json new file mode 100644 index 000000000000..8705a38eb053 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1349", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-8740", + "subscriptionName": "sdk-Subscriptions-2178", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscriptionid", + "parameters": { + "properties": { + "enableBatchedOperations": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178", + "name": "sdk-Subscriptions-2178", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions", + "properties": { + "lockDuration": "PT1M", + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "deadLetteringOnMessageExpiration": true, + "deadLetteringOnFilterEvaluationExceptions": true, + "messageCount": 0, + "maxDeliveryCount": 10, + "status": "Active", + "enableBatchedOperations": true, + "createdAt": "2021-01-04T18:02:20.5992764Z", + "updatedAt": "2021-01-04T18:02:20.5992764Z", + "accessedAt": "2021-01-04T18:02:20.5992764Z", + "countDetails": { + "activeMessageCount": 0, + "deadLetterMessageCount": 0, + "scheduledMessageCount": 0, + "transferMessageCount": 0, + "transferDeadLetterMessageCount": 0 + }, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "forwardTo": "sdk-Topics-3065", + "forwardDeadLetteredMessagesTo": "sdk-Topics-3065" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionDelete.json new file mode 100644 index 000000000000..df2b7986bf7f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5882", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-1804", + "subscriptionName": "sdk-Subscriptions-3670", + "api-version": "2023-01-01-preview", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionGet.json new file mode 100644 index 000000000000..9f5e4d07607b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1349", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-8740", + "subscriptionName": "sdk-Subscriptions-2178", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscriptionid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178", + "name": "sdk-Subscriptions-2178", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions", + "properties": { + "lockDuration": "PT1M", + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "deadLetteringOnMessageExpiration": true, + "deadLetteringOnFilterEvaluationExceptions": true, + "messageCount": 0, + "maxDeliveryCount": 10, + "status": "Active", + "enableBatchedOperations": true, + "createdAt": "2021-01-04T18:02:20.5992764Z", + "updatedAt": "2021-01-04T18:02:20.5992764Z", + "accessedAt": "2021-01-04T18:02:20.5992764Z", + "countDetails": { + "activeMessageCount": 0, + "deadLetterMessageCount": 0, + "scheduledMessageCount": 0, + "transferMessageCount": 0, + "transferDeadLetterMessageCount": 0 + }, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "forwardTo": "sdk-Topics-3065", + "forwardDeadLetteredMessagesTo": "sdk-Topics-3065" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json new file mode 100644 index 000000000000..47e6d1044f63 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1349", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-8740", + "api-version": "2023-01-01-preview", + "subscriptionId": "5{Subscriptionid}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178", + "name": "sdk-Subscriptions-2178", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions", + "properties": { + "lockDuration": "PT1M", + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "deadLetteringOnMessageExpiration": true, + "deadLetteringOnFilterEvaluationExceptions": true, + "messageCount": 0, + "maxDeliveryCount": 10, + "status": "Active", + "enableBatchedOperations": true, + "createdAt": "2021-01-04T18:02:20.5992764Z", + "updatedAt": "2021-01-04T18:02:20.5992764Z", + "accessedAt": "2021-01-04T18:02:20.5992764Z", + "countDetails": { + "activeMessageCount": 0, + "deadLetterMessageCount": 0, + "scheduledMessageCount": 0, + "transferMessageCount": 0, + "transferDeadLetterMessageCount": 0 + }, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "forwardTo": "sdk-Topics-3065", + "forwardDeadLetteredMessagesTo": "sdk-Topics-3065" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json new file mode 100644 index 000000000000..bd94db218a3e --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "authorizationRuleName": "sdk-AuthRules-4310", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6261/topics/sdk-Topics-1984/authorizationRules/sdk-AuthRules-4310", + "name": "sdk-AuthRules-4310", + "type": "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json new file mode 100644 index 000000000000..fe16d17693c2 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "authorizationRuleName": "sdk-AuthRules-4310", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json new file mode 100644 index 000000000000..ab1e0a9496de --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "authorizationRuleName": "sdk-AuthRules-4310", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6261/topics/sdk-Topics-1984/authorizationRules/sdk-AuthRules-4310", + "name": "sdk-AuthRules-4310", + "type": "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json new file mode 100644 index 000000000000..4ca636808728 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6261/topics/sdk-Topics-1984/authorizationRules/sdk-AuthRules-4310", + "name": "sdk-AuthRules-4310", + "type": "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json new file mode 100644 index 000000000000..8e48293353f9 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "Default-ServiceBus-WestUS", + "namespaceName": "sdk-Namespace8408", + "topicName": "sdk-Topics2075", + "authorizationRuleName": "sdk-Authrules5067", + "api-version": "2023-01-01-preview", + "subscriptionId": "e2f361f0-3b27-4503-a9cc-21cfba380093" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-AuthRules-4310" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..a626a337faf0 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "Default-ServiceBus-WestUS", + "namespaceName": "sdk-Namespace8408", + "topicName": "sdk-Topics2075", + "authorizationRuleName": "sdk-Authrules5067", + "api-version": "2023-01-01-preview", + "subscriptionId": "e2f361f0-3b27-4503-a9cc-21cfba380093", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-AuthRules-4310" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicCreate.json new file mode 100644 index 000000000000..1ab3da720aa6 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicCreate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-5488", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "enableExpress": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-Topics-5488", + "name": "sdk-Topics-5488", + "type": "Microsoft.ServiceBus/Namespaces/Topics", + "properties": { + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "maxSizeInMegabytes": 10240, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "duplicateDetectionHistoryTimeWindow": "PT10M", + "enableBatchedOperations": true, + "sizeInBytes": 0, + "status": "Active", + "supportOrdering": true, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": false, + "enableExpress": true, + "createdAt": "2017-05-26T20:50:34.1Z", + "updatedAt": "2017-05-26T20:50:34.32Z", + "accessedAt": "2017-05-26T20:50:34.32Z", + "subscriptionCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicDelete.json new file mode 100644 index 000000000000..266712e2b6ad --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-5488", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicGet.json new file mode 100644 index 000000000000..ad13ddda813a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-5488", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-Topics-5488", + "name": "sdk-Topics-5488", + "type": "Microsoft.ServiceBus/Namespaces/Topics", + "properties": { + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "maxSizeInMegabytes": 10240, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "duplicateDetectionHistoryTimeWindow": "PT10M", + "enableBatchedOperations": true, + "sizeInBytes": 0, + "status": "Active", + "supportOrdering": true, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": false, + "enableExpress": true, + "createdAt": "2017-05-26T20:50:31.4442694Z", + "updatedAt": "2017-05-26T20:52:32.2092264Z", + "accessedAt": "0001-01-01T00:00:00Z", + "subscriptionCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicListByNameSpace.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicListByNameSpace.json new file mode 100644 index 000000000000..3f165c00952a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicListByNameSpace.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "Default-ServiceBus-WestUS", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-topics-5488", + "name": "sdk-topics-5488", + "type": "Microsoft.ServiceBus/Namespaces/Topics", + "properties": { + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "maxSizeInMegabytes": 10240, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "duplicateDetectionHistoryTimeWindow": "PT10M", + "enableBatchedOperations": true, + "sizeInBytes": 0, + "status": "Active", + "supportOrdering": true, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": false, + "enableExpress": true, + "createdAt": "2017-05-26T20:50:31.4442694Z", + "updatedAt": "2017-05-26T20:52:32.2092264Z", + "accessedAt": "0001-01-01T00:00:00Z", + "subscriptionCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json new file mode 100644 index 000000000000..440097d1f3a2 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9080", + "authorizationRuleName": "sdk-Authrules-4879", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4879", + "api-version": "2023-01-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-4879", + "name": "sdk-Authrules-4879", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json new file mode 100644 index 000000000000..df6cbaf224c5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9080", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4047", + "api-version": "2023-01-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Manage", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1067", + "name": "sdk-Authrules-1067", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1684", + "name": "sdk-Authrules-1684", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-4879", + "name": "sdk-Authrules-4879", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json new file mode 100644 index 000000000000..dadb8c6de753 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2702", + "authorizationRuleName": "sdk-Authrules-1746", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4047", + "api-version": "2023-01-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "aliasPrimaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "aliasSecondaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-Authrules-1746" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json new file mode 100644 index 000000000000..b862269eba10 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "subscriptionId": "exampleSubscriptionId", + "namespaceName": "sdk-Namespace-9080", + "resourceGroupName": "exampleResourceGroup", + "parameters": { + "name": "sdk-DisasterRecovery-9474" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json new file mode 100644 index 000000000000..efbfc9887970 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-Namespace-8860", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "partnerNamespace": "sdk-Namespace-37", + "alternateName": "alternameforAlias-Namespace-8860" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-Namespace-8860", + "name": "sdk-Namespace-8860", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "alternateName": "alternameforAlias-Namespace-8860", + "role": "Primary" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-Namespace-8860", + "name": "sdk-Namespace-8860", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "alternateName": "alternameforAlias-Namespace-8860", + "role": "Primary" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json new file mode 100644 index 000000000000..9c58279a47bc --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "SouthCentralUS", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json new file mode 100644 index 000000000000..69aeb09882e7 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json new file mode 100644 index 000000000000..5cd07d6d7d47 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-37/disasterRecoveryConfig/sdk-DisasterRecovery-3814", + "name": "sdk-DisasterRecovery-3814", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-8860", + "role": "Secondary", + "pendingReplicationOperationsCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json new file mode 100644 index 000000000000..1465505de99f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-DisasterRecovery-3814", + "name": "sdk-DisasterRecovery-3814", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "role": "Primary" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json new file mode 100644 index 000000000000..69aeb09882e7 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/migrationconfigs.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/migrationconfigs.json new file mode 100644 index 000000000000..f0221b752179 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/migrationconfigs.json @@ -0,0 +1,385 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations": { + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_List", + "x-ms-examples": { + "MigrationConfigurationsList": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationList.json" + } + }, + "description": "Gets all migrationConfigurations", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of migrationConfigurations for servicebus namespace", + "schema": { + "$ref": "#/definitions/MigrationConfigListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}": { + "put": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CreateAndStartMigration", + "x-ms-examples": { + "MigrationConfigurationsStartMigration": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json" + } + }, + "description": "Creates Migration configuration and starts migration of entities from Standard to Premium namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "Parameters required to create Migration Configuration" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Migration Config successfully created", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "201": { + "description": "Migration Config creation request received", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Delete", + "x-ms-examples": { + "MigrationConfigurationsDelete": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationDelete.json" + } + }, + "description": "Deletes a MigrationConfiguration", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Migration Config request accepted" + }, + "204": { + "description": "Not Found" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Get", + "x-ms-examples": { + "MigrationConfigurationsGet": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationGet.json" + } + }, + "description": "Retrieves Migration Config", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Migration Config)", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/upgrade": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CompleteMigration", + "x-ms-examples": { + "MigrationConfigurationsCompleteMigration": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json" + } + }, + "description": "This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "upgrade operation of Migration Config is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/revert": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Revert", + "x-ms-examples": { + "MigrationConfigurationsRevert": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationRevert.json" + } + }, + "description": "This operation reverts Migration", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "MigrationConfig Revert operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "MigrationConfigProperties": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of Migration Configuration " + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, + "targetNamespace": { + "type": "string", + "description": "Existing premium Namespace ARM Id name which has no entities, will be used for migration" + }, + "postMigrationName": { + "type": "string", + "description": "Name to access Standard Namespace after migration" + }, + "migrationState": { + "readOnly": true, + "type": "string", + "description": "State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active" + } + }, + "required": [ + "targetNamespace", + "postMigrationName" + ], + "description": "Properties required to the Create Migration Configuration" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Single item in List or Get Migration Config operation" + }, + "MigrationConfigListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "List of Migration Configs" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of migrationConfigurations" + } + }, + "description": "The result of the List migrationConfigurations operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/namespace-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/namespace-preview.json new file mode 100644 index 000000000000..8d6cb1b623ea --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/namespace-preview.json @@ -0,0 +1,1301 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client for managing Namespace", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NameSpaceList": { + "$ref": "./examples/NameSpaces/SBNameSpaceList.json" + } + }, + "description": "Gets all the available namespaces within the subscription, irrespective of the resource groups.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NameSpaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/SBNameSpaceListByResourceGroup.json" + } + }, + "description": "Gets the available namespaces within a resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/SBNameSpaceCreate.json" + } + }, + "description": "Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Parameters supplied to create a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace created successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Delete", + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/NameSpaces/SBNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully deleted." + }, + "202": { + "description": "Namespace delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Get", + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/NameSpaces/SBNameSpaceGet.json" + } + }, + "description": "Gets a description for the specified namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NameSpaceUpdate": { + "$ref": "./examples/NameSpaces/SBNameSpaceUpdate.json" + } + }, + "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespaceUpdateParameters" + }, + "description": "Parameters supplied to update a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace updated successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionList.json" + } + }, + "description": "Gets the available PrivateEndpointConnections within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "PrivateEndpointConnections successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/failover": { + "post": { + "tags": [ + "Namespaces Geo DR Failover" + ], + "operationId": "Namespaces_Failover", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/SBNamespaceFailover.json" + } + }, + "description": "GeoDR Failover", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailOver" + }, + "description": "Parameters for updating a namespace resource." + } + ], + "responses": { + "202": { + "description": "Accepted. The failover policy change operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionCreate.json" + } + }, + "description": "Creates or updates PrivateEndpointConnections of service namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource." + } + ], + "responses": { + "200": { + "description": "Status of PrivateEndPoint Connection Created successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Request to update Status of PrivateEndPoint Connection accepted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Request to update Status of PrivateEndPoint Connection accepted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionDelete": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionDelete.json" + } + }, + "description": "Deletes an existing Private Endpoint Connection.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Private Endpoint Connection successfully deleted." + }, + "202": { + "description": "Private Endpoint Connection delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionGet": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionGet.json" + } + }, + "description": "Gets a description for the specified Private Endpoint Connection.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Description of Private Endpoint Connection returned successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateLinkResources": { + "get": { + "tags": [ + "Namespaces PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "NameSpacePrivateLinkResourcesGet": { + "$ref": "./examples/NameSpaces/PrivateLinkResourcesGet.json" + } + }, + "description": "Gets lists of resources that supports Privatelinks.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private Link resource List", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ResourceNamespacePatch": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "The Resource definition." + }, + "SBNamespaceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Result of the List Namespace operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Namespaces." + } + }, + "description": "The response of the List Namespace operation." + }, + "SBNamespace": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of SKU" + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Properties of BYOK Identity description" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceProperties", + "description": "Properties of the namespace." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceUpdateParameters": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of SKU" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceUpdateProperties", + "description": "Properties of the namespace." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Properties of BYOK Identity description" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceNamespacePatch" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceProperties": { + "type": "object", + "properties": { + "minimumTlsVersion": { + "type": "string", + "description": "The minimum TLS version for the cluster to support, e.g. '1.2'", + "enum": [ + "1.0", + "1.1", + "1.2" + ], + "x-ms-enum": { + "name": "TlsVersion", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the namespace." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was created" + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics" + }, + "zoneRedundant": { + "type": "boolean", + "description": "Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Properties of BYOK Encryption description" + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "disableLocalAuth": { + "type": "boolean", + "description": "This property disables SAS authentication for the Service Bus namespace." + }, + "alternateName": { + "type": "string", + "description": "Alternate name for namespace" + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled.", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "default": "Enabled" + }, + "premiumMessagingPartitions": { + "format": "int32", + "type": "integer", + "description": "The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4" + }, + "geoDataReplication": { + "$ref": "#/definitions/GeoDataReplicationProperties", + "description": "Geo Data Replication settings for the namespace" + } + }, + "description": "Properties of the namespace." + }, + "SBNamespaceUpdateProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the namespace." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was created" + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics" + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Properties of BYOK Encryption description" + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "disableLocalAuth": { + "type": "boolean", + "description": "This property disables SAS authentication for the Service Bus namespace." + }, + "alternateName": { + "type": "string", + "description": "Alternate name for namespace" + } + }, + "description": "Properties of the namespace." + }, + "SBSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + } + }, + "capacity": { + "format": "int32", + "type": "integer", + "description": "Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64" + } + }, + "required": [ + "name" + ], + "description": "SKU of the namespace." + }, + "GeoDataReplicationProperties": { + "type": "object", + "properties": { + "maxReplicationLagDurationInSeconds": { + "format": "int32", + "type": "integer", + "description": "The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day." + }, + "locations": { + "type": "array", + "items": { + "$ref": "#/definitions/NamespaceReplicaLocation" + }, + "x-ms-identifiers": [], + "description": "A list of regions where replicas of the namespace are maintained." + } + }, + "description": "GeoDR Replication properties" + }, + "NamespaceReplicaLocation": { + "type": "object", + "properties": { + "locationName": { + "type": "string", + "description": "Azure regions where a replica of the namespace is maintained" + }, + "roleType": { + "type": "string", + "description": "GeoDR Role Types", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "GeoDRRoleType", + "modelAsString": true + } + }, + "clusterArmId": { + "type": "string", + "description": "Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster" + } + }, + "description": "Namespace replication properties" + }, + "FailOver": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FailOverProperties" + } + } + }, + "FailOverProperties": { + "type": "object", + "properties": { + "primaryLocation": { + "type": "string", + "description": "Query parameter for the new primary location after failover." + }, + "force": { + "type": "boolean", + "description": "If Force is false then graceful failover is attempted after ensuring no data loss. If Force flag is set to true, Forced failover is attempted with possible data loss." + } + } + }, + "Identity": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "principalId": { + "type": "string", + "description": "ObjectId from the KeyVault", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "TenantId from the KeyVault", + "readOnly": true + }, + "type": { + "description": "Type of managed service identity.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Properties for User Assigned Identities" + } + }, + "description": "Properties to configure User Assigned Identities for Bring your Own Keys" + }, + "UserAssignedIdentity": { + "description": "Recognized Dictionary value.", + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id of user assigned identity", + "type": "string", + "x-ms-client-name": "PrincipalId", + "readOnly": true + }, + "clientId": { + "description": "Client Id of user assigned identity", + "type": "string", + "x-ms-client-name": "ClientId", + "readOnly": true + } + } + }, + "Encryption": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "keyVaultProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyVaultProperties" + }, + "x-ms-client-name": "KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "keySource", + "modelAsString": false + } + }, + "requireInfrastructureEncryption": { + "type": "boolean", + "description": "Enable Infrastructure Encryption (Double Encryption)" + } + }, + "description": "Properties to configure Encryption" + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault" + }, + "keyVersion": { + "type": "string", + "description": "Version of KeyVault" + }, + "identity": { + "$ref": "#/definitions/userAssignedIdentityProperties" + } + }, + "description": "Properties to configure keyVault Properties" + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "Properties of the PrivateEndpointConnection.", + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the PrivateEndpointConnection.", + "x-ms-client-flatten": true + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + } + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of the private endpoint connection resource.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The Private Endpoint resource for this Connection." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Details about the state of the connection." + }, + "provisioningState": { + "description": "Provisioning state of the Private Endpoint Connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "EndPointProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateEndpoint": { + "type": "object", + "description": "PrivateEndpoint information.", + "properties": { + "id": { + "description": "The ARM identifier for Private Endpoint.", + "type": "string" + } + } + }, + "ConnectionState": { + "type": "object", + "description": "ConnectionState information.", + "properties": { + "status": { + "description": "Status of the connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Description of the connection state.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "Result of the list of all private endpoint connections operation.", + "properties": { + "value": { + "description": "A collection of private endpoint connection resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "A link for the next page of private endpoint connection resources.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "Information of the private link resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of the private link resource.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string" + }, + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "description": "Type of the resource", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of PrivateLinkResource", + "properties": { + "groupId": { + "type": "string" + }, + "requiredMembers": { + "type": "array", + "description": "Required Members", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "description": "Required Zone Names", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "Result of the List private link resources operation.", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "A link for the next page of private link resources.", + "type": "string" + } + } + }, + "userAssignedIdentityProperties": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "ARM ID of user Identity selected for encryption" + } + } + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/networksets.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/networksets.json new file mode 100644 index 000000000000..efb6af8cf558 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/networksets.json @@ -0,0 +1,310 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", + "description": "Create or update NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace IpFilterRule." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets": { + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetList": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json" + } + }, + "operationId": "Namespaces_ListNetworkRuleSets", + "description": "Gets list of NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of NetworkRuleSets for Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSetListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NWRuleSetIpRules": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + }, + "default": "Allow" + } + }, + "description": "Description of NetWorkRuleSet - IpRules resource." + }, + "Subnet": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "required": [ + "id" + ], + "description": "Properties supplied for Subnet" + }, + "NWRuleSetVirtualNetworkRules": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing VNet Service Endpoint" + } + }, + "description": "Description of VirtualNetworkRules - NetworkRules resource." + }, + "NetworkRuleSet": { + "type": "object", + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "trustedServiceAccessEnabled": { + "type": "boolean", + "description": "Value that indicates whether Trusted Service Access is Enabled or not." + }, + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessFlag", + "modelAsString": true + }, + "default": "Enabled" + } + } + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of NetworkRuleSet resource." + }, + "NetworkRuleSetListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "Result of the List NetworkRuleSet operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet." + } + }, + "description": "The response of the List NetworkRuleSet operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/operations.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/operations.json new file mode 100644 index 000000000000..e42df4f46bf4 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/operations.json @@ -0,0 +1,150 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ServiceBus/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/SBOperations_List.json" + } + }, + "description": "Lists all of the available ServiceBus REST API operations.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "description": "Result of the request to list ServiceBus operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider.", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A Service Bus REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "description": "Properties of the operation", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource of the operation", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Localized friendly name for the operation", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/subscriptions.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/subscriptions.json new file mode 100644 index 000000000000..ee2b3fb8df67 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/subscriptions.json @@ -0,0 +1,407 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_ListByTopic", + "x-ms-examples": { + "SubscriptionListByTopic": { + "$ref": "./examples/Subscriptions/SBSubscriptionListByTopic.json" + } + }, + "description": "List all the subscriptions under a specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639400.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of subscriptions.", + "schema": { + "$ref": "#/definitions/SBSubscriptionListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}": { + "put": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_CreateOrUpdate", + "x-ms-examples": { + "SubscriptionCreate": { + "$ref": "./examples/Subscriptions/SBSubscriptionCreate.json" + } + }, + "description": "Creates a topic subscription.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639385.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBSubscription" + }, + "description": "Parameters supplied to create a subscription resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Subscription create request accepted.", + "schema": { + "$ref": "#/definitions/SBSubscription" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Delete", + "x-ms-examples": { + "SubscriptionDelete": { + "$ref": "./examples/Subscriptions/SBSubscriptionDelete.json" + } + }, + "description": "Deletes a subscription from the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639381.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Subscription successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Get", + "x-ms-examples": { + "SubscriptionGet": { + "$ref": "./examples/Subscriptions/SBSubscriptionGet.json" + } + }, + "description": "Returns a subscription description for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639402.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved subscription description.", + "schema": { + "$ref": "#/definitions/SBSubscription" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBSubscriptionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBSubscription" + }, + "description": "Result of the List Subscriptions operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of subscriptions." + } + }, + "description": "The response to the List Subscriptions operation." + }, + "SBSubscription": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBSubscriptionProperties", + "description": "Properties of subscriptions resource." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of subscription resource." + }, + "SBSubscriptionProperties": { + "type": "object", + "properties": { + "messageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of messages." + }, + "createdAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Exact time the message was created." + }, + "accessedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Last time there was a receive request to this subscription." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message count details" + }, + "lockDuration": { + "format": "duration", + "type": "string", + "description": "ISO 8061 lock duration timespan for the subscription. The default value is 1 minute." + }, + "requiresSession": { + "type": "boolean", + "description": "Value indicating if a subscription supports the concept of sessions." + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "deadLetteringOnFilterEvaluationExceptions": { + "type": "boolean", + "description": "Value that indicates whether a subscription has dead letter support on filter evaluation exceptions." + }, + "deadLetteringOnMessageExpiration": { + "type": "boolean", + "description": "Value that indicates whether a subscription has dead letter support when a message expires." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "maxDeliveryCount": { + "format": "int32", + "type": "integer", + "description": "Number of maximum deliveries." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." + }, + "forwardTo": { + "type": "string", + "description": "Queue/Topic name to forward the messages" + }, + "forwardDeadLetteredMessagesTo": { + "type": "string", + "description": "Queue/Topic name to forward the Dead Letter message" + }, + "isClientAffine": { + "type": "boolean", + "description": "Value that indicates whether the subscription has an affinity to the client id." + }, + "clientAffineProperties": { + "$ref": "#/definitions/SBClientAffineProperties", + "description": "Properties specific to client affine subscriptions." + } + }, + "description": "Description of Subscription Resource." + }, + "SBClientAffineProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Indicates the Client ID of the application that created the client-affine subscription." + }, + "isDurable": { + "type": "boolean", + "description": "For client-affine subscriptions, this value indicates whether the subscription is durable or not." + }, + "isShared": { + "type": "boolean", + "description": "For client-affine subscriptions, this value indicates whether the subscription is shared or not." + } + }, + "description": "Properties specific to client affine subscriptions." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/topics.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/topics.json new file mode 100644 index 000000000000..b677bb87e9dd --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/topics.json @@ -0,0 +1,372 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics": { + "get": { + "tags": [ + "Topics" + ], + "operationId": "Topics_ListByNamespace", + "x-ms-examples": { + "TopicGet": { + "$ref": "./examples/Topics/SBTopicListByNameSpace.json" + } + }, + "description": "Gets all the topics in a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of topics.", + "schema": { + "$ref": "#/definitions/SBTopicListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}": { + "put": { + "tags": [ + "Topics" + ], + "operationId": "Topics_CreateOrUpdate", + "x-ms-examples": { + "TopicCreate": { + "$ref": "./examples/Topics/SBTopicCreate.json" + } + }, + "description": "Creates a topic in the specified namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBTopic" + }, + "description": "Parameters supplied to create a topic resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic successfully created.", + "schema": { + "$ref": "#/definitions/SBTopic" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Topics" + ], + "operationId": "Topics_Delete", + "x-ms-examples": { + "TopicDelete": { + "$ref": "./examples/Topics/SBTopicDelete.json" + } + }, + "description": "Deletes a topic from the specified namespace and resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic successfully deleted." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Topics" + ], + "operationId": "Topics_Get", + "x-ms-examples": { + "TopicGet": { + "$ref": "./examples/Topics/SBTopicGet.json" + } + }, + "description": "Returns a description for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic description successfully retrieved.", + "schema": { + "$ref": "#/definitions/SBTopic" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBTopicListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBTopic" + }, + "description": "Result of the List Topics operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of topics." + } + }, + "description": "The response to the List Topics operation." + }, + "SBTopic": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBTopicProperties", + "description": "Properties of topic resource." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of topic resource." + }, + "SBTopicProperties": { + "type": "object", + "properties": { + "sizeInBytes": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Size of the topic, in bytes." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "accessedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Last time the message was sent, or a request was received, for this topic." + }, + "subscriptionCount": { + "readOnly": true, + "format": "int32", + "type": "integer", + "description": "Number of subscriptions." + }, + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message count details" + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "maxSizeInMegabytes": { + "format": "int32", + "type": "integer", + "description": "Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024." + }, + "maxMessageSizeInKilobytes": { + "format": "int64", + "type": "integer", + "description": "Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024." + }, + "requiresDuplicateDetection": { + "type": "boolean", + "description": "Value indicating if this topic requires duplicate detection." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "supportOrdering": { + "type": "boolean", + "description": "Value that indicates whether the topic supports ordering." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." + }, + "enablePartitioning": { + "type": "boolean", + "description": "Value that indicates whether the topic to be partitioned across multiple message brokers is enabled." + }, + "enableExpress": { + "type": "boolean", + "description": "Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage." + } + }, + "description": "The Topic Properties definition." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md index 643e3e803f24..923698d74f39 100644 --- a/specification/servicebus/resource-manager/readme.md +++ b/specification/servicebus/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the ServiceBus API. ``` yaml openapi-type: arm -tag: package-2022-10-preview +tag: package-2023-01-preview ``` ### Tag: package-2021-01-preview @@ -173,6 +173,25 @@ input-file: - Microsoft.ServiceBus/stable/2017-04-01/topics.json ``` +### Tag: package-2023-01-preview + +These settings apply only when `--tag=package-2023-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2023-01-preview' +input-file: +- Microsoft.ServiceBus/preview/2023-01-01-preview/namespace-preview.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/operations.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/DisasterRecoveryConfig.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/migrationconfigs.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/networksets.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/AuthorizationRules.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/Queue.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/topics.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/Rules.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/subscriptions.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/CheckNameAvailability.json +``` + Important notes: On the advice of @fearthecowboy, the `EncodingCaptureDescription` enum previously contained two values [`Avro`,`AvroDeflate`] ; the service has been changed (on 2018-01-17) and will not ever return the `AvroDeflate` value, however, we have left the value in the enum (in servicebus.json) so that existing clients won't suffer a binary breaking change @@ -238,5 +257,23 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.java.md](./readme.java.md) +## Suppression + +``` yaml +directive: + - suppress: ResourceNameRestriction + from: namespace-preview.json + reason: Addition of Pattern restriction will cause a breaking change as there is no restriction in previous api versions. + + - suppress: ResourceNameRestriction + from: AuthorizationRules.json + reason: Addition of Pattern restriction will cause a breaking change as there is no restriction in previous api versions. + - suppress: RequestSchemaForTrackedResourcesMustHaveTags + from: AuthorizationRules.json + reason: Authorization rules are not tracked resources. + - suppress: PutResponseCodes + from: AuthorizationRules.json + reason: Breaking change in order to change the API response code. +``` From f4cabaa4f22f7ae7c4b804617d16aeb17d166ba6 Mon Sep 17 00:00:00 2001 From: Pranav Nair Date: Tue, 9 Jul 2024 13:36:28 -0700 Subject: [PATCH 291/343] Add new API version (2024-06-01), and nxdomainRedirect property to VirtualNetworkLink resource (#29470) * Add nxdomainRedirect property to VirtualNetworkLink resource * Updated readme files and fixed various warnings/errors --- .../examples/PrivateZoneDelete.json | 19 + .../2024-06-01/examples/PrivateZoneGet.json | 31 + .../PrivateZoneListInResourceGroup.json | 51 + .../PrivateZoneListInSubscription.json | 50 + .../2024-06-01/examples/PrivateZonePatch.json | 43 + .../2024-06-01/examples/PrivateZonePut.json | 65 + .../examples/RecordSetAAAADelete.json | 14 + .../2024-06-01/examples/RecordSetAAAAGet.json | 33 + .../examples/RecordSetAAAAList.json | 53 + .../examples/RecordSetAAAAPatch.json | 40 + .../2024-06-01/examples/RecordSetAAAAPut.json | 67 + .../2024-06-01/examples/RecordSetADelete.json | 14 + .../2024-06-01/examples/RecordSetAGet.json | 33 + .../2024-06-01/examples/RecordSetALLList.json | 73 + .../2024-06-01/examples/RecordSetAList.json | 53 + .../2024-06-01/examples/RecordSetAPatch.json | 40 + .../2024-06-01/examples/RecordSetAPut.json | 67 + .../examples/RecordSetCNAMEDelete.json | 14 + .../examples/RecordSetCNAMEGet.json | 31 + .../examples/RecordSetCNAMEList.json | 34 + .../examples/RecordSetCNAMEPatch.json | 38 + .../examples/RecordSetCNAMEPut.json | 61 + .../examples/RecordSetMXDelete.json | 14 + .../2024-06-01/examples/RecordSetMXGet.json | 34 + .../2024-06-01/examples/RecordSetMXList.json | 55 + .../2024-06-01/examples/RecordSetMXPatch.json | 41 + .../2024-06-01/examples/RecordSetMXPut.json | 70 + .../examples/RecordSetPTRDelete.json | 14 + .../2024-06-01/examples/RecordSetPTRGet.json | 33 + .../2024-06-01/examples/RecordSetPTRList.json | 37 + .../examples/RecordSetPTRPatch.json | 40 + .../2024-06-01/examples/RecordSetPTRPut.json | 67 + .../2024-06-01/examples/RecordSetSOAGet.json | 37 + .../2024-06-01/examples/RecordSetSOAList.json | 40 + .../examples/RecordSetSOAPatch.json | 44 + .../2024-06-01/examples/RecordSetSOAPut.json | 79 + .../examples/RecordSetSRVDelete.json | 14 + .../2024-06-01/examples/RecordSetSRVGet.json | 36 + .../2024-06-01/examples/RecordSetSRVList.json | 40 + .../examples/RecordSetSRVPatch.json | 43 + .../2024-06-01/examples/RecordSetSRVPut.json | 76 + .../examples/RecordSetTXTDelete.json | 14 + .../2024-06-01/examples/RecordSetTXTGet.json | 36 + .../2024-06-01/examples/RecordSetTXTList.json | 40 + .../examples/RecordSetTXTPatch.json | 43 + .../2024-06-01/examples/RecordSetTXTPut.json | 76 + .../examples/VirtualNetworkLinkDelete.json | 20 + .../examples/VirtualNetworkLinkGet.json | 31 + .../examples/VirtualNetworkLinkList.json | 52 + .../examples/VirtualNetworkLinkPatch.json | 48 + .../examples/VirtualNetworkLinkPut.json | 70 + .../stable/2024-06-01/privatedns.json | 1949 +++++++++++++++++ .../privatedns/resource-manager/readme.go.md | 12 +- .../privatedns/resource-manager/readme.md | 33 +- .../resource-manager/readme.nodejs.md | 14 + .../resource-manager/readme.python.md | 2 - .../resource-manager/readme.ruby.md | 13 +- 57 files changed, 4183 insertions(+), 8 deletions(-) create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneDelete.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInResourceGroup.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInSubscription.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAADelete.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetADelete.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetALLList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEDelete.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXDelete.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRDelete.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVDelete.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTDelete.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkDelete.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkGet.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkList.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPatch.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPut.json create mode 100644 specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/privatedns.json create mode 100644 specification/privatedns/resource-manager/readme.nodejs.md diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneDelete.json new file mode 100644 index 000000000000..293b3da1fa54 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneGet.json new file mode 100644 index 000000000000..a17f37baf68c --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInResourceGroup.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInResourceGroup.json new file mode 100644 index 000000000000..c078c96d3893 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInResourceGroup.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone2.com", + "name": "privatezone2.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInSubscription.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInSubscription.json new file mode 100644 index 000000000000..2d50019ad46d --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInSubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Network/privateDnsZones?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateDnsZones/privatezone2.com", + "name": "privatezone2.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePatch.json new file mode 100644 index 000000000000..63d772233814 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePatch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "tags": { + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key2": "value2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePut.json new file mode 100644 index 000000000000..00262b80d9e4 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePut.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "location": "Global", + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAADelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAADelete.json new file mode 100644 index 000000000000..ac4526f77c52 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAADelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "relativeRecordSetName": "recordAAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAGet.json new file mode 100644 index 000000000000..c634d9dbfd16 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "relativeRecordSetName": "recordAAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordaaaa.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAList.json new file mode 100644 index 000000000000..ca5f657beab5 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/AAAA?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa1", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordaaaa1.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa2", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa2", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "ttl": 3600, + "fqdn": "recordaaaa2.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPatch.json new file mode 100644 index 000000000000..a884ebaeef40 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPatch.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "relativeRecordSetName": "recordAAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordaaaa.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPut.json new file mode 100644 index 000000000000..65221307b3f8 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPut.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "relativeRecordSetName": "recordAAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordaaaa.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordaaaa.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetADelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetADelete.json new file mode 100644 index 000000000000..fe40553dfbf5 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetADelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "relativeRecordSetName": "recordA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAGet.json new file mode 100644 index 000000000000..d79dac05d54c --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "relativeRecordSetName": "recordA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetALLList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetALLList.json new file mode 100644 index 000000000000..b7f9ab5fd704 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetALLList.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/ALL?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.contoso1.com" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAList.json new file mode 100644 index 000000000000..29aa487d5ea0 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/A?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda1", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda1.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda2", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda2", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "ttl": 3600, + "fqdn": "recorda2.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "5.6.7.8" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPatch.json new file mode 100644 index 000000000000..ecb5a9e7c6a0 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPatch.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "relativeRecordSetName": "recordA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPut.json new file mode 100644 index 000000000000..0c23419d77f4 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPut.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "relativeRecordSetName": "recordA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEDelete.json new file mode 100644 index 000000000000..f57b7524c7c0 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "relativeRecordSetName": "recordCNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEGet.json new file mode 100644 index 000000000000..2df8df7a4ba8 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "relativeRecordSetName": "recordCNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEList.json new file mode 100644 index 000000000000..170d3eb94b16 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPatch.json new file mode 100644 index 000000000000..bce3da0a9512 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPatch.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "relativeRecordSetName": "recordCNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPut.json new file mode 100644 index 000000000000..64ea5d4375ed --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPut.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "relativeRecordSetName": "recordCNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXDelete.json new file mode 100644 index 000000000000..2fe802130034 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "relativeRecordSetName": "recordMX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXGet.json new file mode 100644 index 000000000000..38b48dc703e4 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "relativeRecordSetName": "recordMX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXList.json new file mode 100644 index 000000000000..1400f59ae0be --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/MX?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx1", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx1.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.contoso1.com" + } + ] + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx2", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx2", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "ttl": 3600, + "fqdn": "recordmx2.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.contoso2.com" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPatch.json new file mode 100644 index 000000000000..588fc80fa15d --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPatch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "relativeRecordSetName": "recordMX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPut.json new file mode 100644 index 000000000000..cea14eedec2a --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPut.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "relativeRecordSetName": "recordMX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRDelete.json new file mode 100644 index 000000000000..acb596137da3 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "relativeRecordSetName": "1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRGet.json new file mode 100644 index 000000000000..ef8fd5f4e5a6 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "relativeRecordSetName": "1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRList.json new file mode 100644 index 000000000000..a2eb197968c6 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/PTR?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPatch.json new file mode 100644 index 000000000000..69c9e435ed16 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPatch.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "relativeRecordSetName": "1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPut.json new file mode 100644 index 000000000000..612453585f6b --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPut.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "relativeRecordSetName": "1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAGet.json new file mode 100644 index 000000000000..15419db68f02 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SOA", + "relativeRecordSetName": "@", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAList.json new file mode 100644 index 000000000000..c9123b755074 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SOA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPatch.json new file mode 100644 index 000000000000..8159ae2e8d53 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPatch.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SOA", + "relativeRecordSetName": "@", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPut.json new file mode 100644 index 000000000000..0a774dc7c39a --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPut.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SOA", + "relativeRecordSetName": "@", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVDelete.json new file mode 100644 index 000000000000..48d5e5e92f8d --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "relativeRecordSetName": "recordSRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVGet.json new file mode 100644 index 000000000000..0f2118490b0b --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "relativeRecordSetName": "recordSRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVList.json new file mode 100644 index 000000000000..6031c9ed75c8 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/SRV?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPatch.json new file mode 100644 index 000000000000..6bc99f37b1b2 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPatch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "relativeRecordSetName": "recordSRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPut.json new file mode 100644 index 000000000000..7df086e6153f --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPut.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "relativeRecordSetName": "recordSRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTDelete.json new file mode 100644 index 000000000000..9b976a8d6e0d --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "relativeRecordSetName": "recordTXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTGet.json new file mode 100644 index 000000000000..74ed545530ad --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "relativeRecordSetName": "recordTXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTList.json new file mode 100644 index 000000000000..7b2d4e4f0340 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/TXT?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPatch.json new file mode 100644 index 000000000000..f9bfcad40248 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPatch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "relativeRecordSetName": "recordTXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPut.json new file mode 100644 index 000000000000..000b10b521fb --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPut.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "relativeRecordSetName": "recordTXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkDelete.json new file mode 100644 index 000000000000..97d8f034483e --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "virtualNetworkLinkName": "virtualNetworkLink1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkGet.json new file mode 100644 index 000000000000..da23d99350d1 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "virtualNetworkLinkName": "virtualNetworkLink1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false, + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkList.json new file mode 100644 index 000000000000..a01c5a1e4851 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatelink.contoso.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/virtualNetworkLinks?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatelink.contoso.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false, + "resolutionPolicy": "NxDomainRedirect", + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatelink.contoso.com/virtualNetworkLinks/virtualNetworkLink2", + "name": "virtualNetworkLink2", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": true, + "resolutionPolicy": "Default", + "virtualNetworkLinkState": "InProgress", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPatch.json new file mode 100644 index 000000000000..0000939541ae --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPatch.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatelink.contoso.com", + "virtualNetworkLinkName": "virtualNetworkLink1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "tags": { + "key2": "value2" + }, + "properties": { + "registrationEnabled": true, + "resolutionPolicy": "NxDomainRedirect" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatelink.contoso.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": true, + "resolutionPolicy": "NxDomainRedirect", + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key2": "value2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPut.json new file mode 100644 index 000000000000..45be026b032f --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPut.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "virtualNetworkLinkName": "virtualNetworkLink1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "location": "Global", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false, + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false, + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/privatedns.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/privatedns.json new file mode 100644 index 000000000000..25e214a28caa --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/privatedns.json @@ -0,0 +1,1949 @@ +{ + "swagger": "2.0", + "info": { + "title": "PrivateDnsManagementClient", + "description": "The Private DNS Management Client.", + "version": "2024-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}": { + "put": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_CreateOrUpdate", + "description": "Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateZone" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The Private DNS zone has been created.", + "schema": { + "$ref": "#/definitions/PrivateZone" + } + }, + "200": { + "description": "The Private DNS zone has been updated.", + "schema": { + "$ref": "#/definitions/PrivateZone" + } + }, + "202": { + "description": "The Private DNS zone upsert operation has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PUT Private DNS Zone": { + "$ref": "./examples/PrivateZonePut.json" + } + } + }, + "patch": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_Update", + "description": "Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateZone" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Private DNS zone has been updated.", + "schema": { + "$ref": "#/definitions/PrivateZone" + } + }, + "202": { + "description": "The Private DNS zone update operation has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PATCH Private DNS Zone": { + "$ref": "./examples/PrivateZonePatch.json" + } + } + }, + "delete": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_Delete", + "description": "Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Private DNS zone has been deleted." + }, + "202": { + "description": "The Private DNS zone delete operation has been accepted and will complete asynchronously." + }, + "204": { + "description": "The Private DNS zone was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DELETE Private DNS Zone": { + "$ref": "./examples/PrivateZoneDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_Get", + "description": "Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/PrivateZone" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GET Private DNS Zone": { + "$ref": "./examples/PrivateZoneGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateDnsZones": { + "get": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_List", + "description": "Lists the Private DNS zones in all resource groups in a subscription.", + "parameters": [ + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of Private DNS zones to return. If not specified, returns up to 100 zones." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/PrivateZoneListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET Private DNS Zone by Subscription": { + "$ref": "./examples/PrivateZoneListInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones": { + "get": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_ListByResourceGroup", + "description": "Lists the Private DNS zones within a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of record sets to return. If not specified, returns up to 100 record sets." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/PrivateZoneListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET Private DNS Zone by Resource Group": { + "$ref": "./examples/PrivateZoneListInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}": { + "put": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_CreateOrUpdate", + "description": "Creates or updates a virtual network link to the specified Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new virtual network link to the Private DNS zone to be created, but to prevent updating an existing link. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The virtual network link to the Private DNS zone has been created.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "200": { + "description": "The virtual network link to the Private DNS zone has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to upsert virtual network link to the Private DNS zone has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PUT Private DNS Zone Virtual Network Link": { + "$ref": "./examples/VirtualNetworkLinkPut.json" + } + } + }, + "patch": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Update", + "description": "Updates a virtual network link to the specified Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the Private DNS zone has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to link virtual network link to Private DNS zone has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PATCH Private DNS Zone Virtual Network Link": { + "$ref": "./examples/VirtualNetworkLinkPatch.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Delete", + "description": "Deletes a virtual network link to the specified Private DNS zone. WARNING: In case of a registration virtual network, all auto-registered DNS records in the zone for the virtual network will also be deleted. This operation cannot be undone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the virtual network link to the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the Private DNS zone has been deleted." + }, + "202": { + "description": "The operation to delete virtual network link to the Private DNS zone has been accepted and will complete asynchronously." + }, + "204": { + "description": "The virtual network link to the Private DNS zone was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DELETE Private DNS Zone Virtual Network Link": { + "$ref": "./examples/VirtualNetworkLinkDelete.json" + } + } + }, + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Get", + "description": "Gets a virtual network link to the specified Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GET Private DNS Zone Virtual Network Link": { + "$ref": "./examples/VirtualNetworkLinkGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks": { + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_List", + "description": "Lists the virtual network links to the specified Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLinkListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Private DNS Zone Virtual Network Links": { + "$ref": "./examples/VirtualNetworkLinkList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}": { + "put": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_CreateOrUpdate", + "description": "Creates or updates a record set within a Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of DNS record in this record set. Record sets of type SOA can be updated but not created (they are created when the Private DNS zone is created).", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "relativeRecordSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the record set, relative to the name of the zone.", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RecordSet" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The record set has been created.", + "schema": { + "$ref": "#/definitions/RecordSet" + } + }, + "200": { + "description": "The record set has been updated.", + "schema": { + "$ref": "#/definitions/RecordSet" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PUT Private DNS Zone A Record Set": { + "$ref": "./examples/RecordSetAPut.json" + }, + "PUT Private DNS Zone AAAA Record Set": { + "$ref": "./examples/RecordSetAAAAPut.json" + }, + "PUT Private DNS Zone CNAME Record Set": { + "$ref": "./examples/RecordSetCNAMEPut.json" + }, + "PUT Private DNS Zone MX Record Set": { + "$ref": "./examples/RecordSetMXPut.json" + }, + "PUT Private DNS Zone PTR Record Set": { + "$ref": "./examples/RecordSetPTRPut.json" + }, + "PUT Private DNS Zone SOA Record Set": { + "$ref": "./examples/RecordSetSOAPut.json" + }, + "PUT Private DNS Zone SRV Record Set": { + "$ref": "./examples/RecordSetSRVPut.json" + }, + "PUT Private DNS Zone TXT Record Set": { + "$ref": "./examples/RecordSetTXTPut.json" + } + } + }, + "patch": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_Update", + "description": "Updates a record set within a Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of DNS record in this record set.", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "relativeRecordSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the record set, relative to the name of the zone.", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RecordSet" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The record set has been updated.", + "schema": { + "$ref": "#/definitions/RecordSet" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PATCH Private DNS Zone A Record Set": { + "$ref": "./examples/RecordSetAPatch.json" + }, + "PATCH Private DNS Zone AAAA Record Set": { + "$ref": "./examples/RecordSetAAAAPatch.json" + }, + "PATCH Private DNS Zone CNAME Record Set": { + "$ref": "./examples/RecordSetCNAMEPatch.json" + }, + "PATCH Private DNS Zone MX Record Set": { + "$ref": "./examples/RecordSetMXPatch.json" + }, + "PATCH Private DNS Zone PTR Record Set": { + "$ref": "./examples/RecordSetPTRPatch.json" + }, + "PATCH Private DNS Zone SOA Record Set": { + "$ref": "./examples/RecordSetSOAPatch.json" + }, + "PATCH Private DNS Zone SRV Record Set": { + "$ref": "./examples/RecordSetSRVPatch.json" + }, + "PATCH Private DNS Zone TXT Record Set": { + "$ref": "./examples/RecordSetTXTPatch.json" + } + } + }, + "delete": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_Delete", + "description": "Deletes a record set from a Private DNS zone. This operation cannot be undone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of DNS record in this record set. Record sets of type SOA cannot be deleted (they are deleted when the Private DNS zone is deleted).", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "relativeRecordSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the record set, relative to the name of the zone.", + "x-ms-skip-url-encoding": true + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the record set. Omit this value to always delete the current record set. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The record set has been deleted." + }, + "204": { + "description": "The record set was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DELETE Private DNS Zone A Record Set": { + "$ref": "./examples/RecordSetADelete.json" + }, + "DELETE Private DNS Zone AAAA Record Set": { + "$ref": "./examples/RecordSetAAAADelete.json" + }, + "DELETE Private DNS Zone CNAME Record Set": { + "$ref": "./examples/RecordSetCNAMEDelete.json" + }, + "DELETE Private DNS Zone MX Record Set": { + "$ref": "./examples/RecordSetMXDelete.json" + }, + "DELETE Private DNS Zone PTR Record Set": { + "$ref": "./examples/RecordSetPTRDelete.json" + }, + "DELETE Private DNS Zone SRV Record Set": { + "$ref": "./examples/RecordSetSRVDelete.json" + }, + "DELETE Private DNS Zone TXT Record Set": { + "$ref": "./examples/RecordSetTXTDelete.json" + } + } + }, + "get": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_Get", + "description": "Gets a record set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of DNS record in this record set.", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "relativeRecordSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the record set, relative to the name of the zone.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/RecordSet" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GET Private DNS Zone A Record Set": { + "$ref": "./examples/RecordSetAGet.json" + }, + "GET Private DNS Zone AAAA Record Set": { + "$ref": "./examples/RecordSetAAAAGet.json" + }, + "GET Private DNS Zone CNAME Record Set": { + "$ref": "./examples/RecordSetCNAMEGet.json" + }, + "GET Private DNS Zone MX Record Set": { + "$ref": "./examples/RecordSetMXGet.json" + }, + "GET Private DNS Zone PTR Record Set": { + "$ref": "./examples/RecordSetPTRGet.json" + }, + "GET Private DNS Zone SOA Record Set": { + "$ref": "./examples/RecordSetSOAGet.json" + }, + "GET Private DNS Zone SRV Record Set": { + "$ref": "./examples/RecordSetSRVGet.json" + }, + "GET Private DNS Zone TXT Record Set": { + "$ref": "./examples/RecordSetTXTGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}": { + "get": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_ListByType", + "description": "Lists the record sets of a specified type in a Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of record sets to enumerate.", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of record sets to return. If not specified, returns up to 100 record sets." + }, + { + "name": "$recordsetnamesuffix", + "in": "query", + "required": false, + "type": "string", + "description": "The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with \".\"." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/RecordSetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET Private DNS Zone A Record Sets": { + "$ref": "./examples/RecordSetAList.json" + }, + "GET Private DNS Zone AAAA Record Sets": { + "$ref": "./examples/RecordSetAAAAList.json" + }, + "GET Private DNS Zone CNAME Record Sets": { + "$ref": "./examples/RecordSetCNAMEList.json" + }, + "GET Private DNS Zone MX Record Sets": { + "$ref": "./examples/RecordSetMXList.json" + }, + "GET Private DNS Zone PTR Record Sets": { + "$ref": "./examples/RecordSetPTRList.json" + }, + "GET Private DNS Zone SOA Record Sets": { + "$ref": "./examples/RecordSetSOAList.json" + }, + "GET Private DNS Zone SRV Record Sets": { + "$ref": "./examples/RecordSetSRVList.json" + }, + "GET Private DNS Zone TXT Record Sets": { + "$ref": "./examples/RecordSetTXTList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/ALL": { + "get": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_List", + "description": "Lists all record sets in a Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of record sets to return. If not specified, returns up to 100 record sets." + }, + { + "name": "$recordsetnamesuffix", + "in": "query", + "required": false, + "type": "string", + "description": "The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with \".\"." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/RecordSetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET Private DNS Zone ALL Record Sets": { + "$ref": "./examples/RecordSetALLList.json" + } + } + } + } + }, + "definitions": { + "PrivateZoneProperties": { + "properties": { + "maxNumberOfRecordSets": { + "type": "integer", + "format": "int64", + "description": "The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "numberOfRecordSets": { + "type": "integer", + "format": "int64", + "description": "The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "maxNumberOfVirtualNetworkLinks": { + "type": "integer", + "format": "int64", + "description": "The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "numberOfVirtualNetworkLinks": { + "type": "integer", + "format": "int64", + "description": "The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "maxNumberOfVirtualNetworkLinksWithRegistration": { + "type": "integer", + "format": "int64", + "description": "The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "numberOfVirtualNetworkLinksWithRegistration": { + "type": "integer", + "format": "int64", + "description": "The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "internalId": { + "type": "string", + "description": "Private zone internal Id", + "readOnly": true + } + }, + "description": "Represents the properties of the Private DNS zone." + }, + "PrivateZone": { + "properties": { + "etag": { + "type": "string", + "description": "The ETag of the zone." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateZoneProperties", + "description": "Properties of the Private DNS zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Describes a Private DNS zone." + }, + "PrivateZoneListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateZone" + }, + "description": "Information about the Private DNS zones." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response to a Private DNS zone list operation." + }, + "VirtualNetworkLinkProperties": { + "properties": { + "virtualNetwork": { + "$ref": "#/definitions/SubResource", + "description": "The reference of the virtual network." + }, + "registrationEnabled": { + "type": "boolean", + "description": "Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?" + }, + "resolutionPolicy": { + "type": "string", + "description": "The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response.", + "enum": [ + "Default", + "NxDomainRedirect" + ], + "x-ms-enum": { + "name": "resolutionPolicy", + "modelAsString": true + } + }, + "virtualNetworkLinkState": { + "type": "string", + "description": "The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.", + "enum": [ + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "VirtualNetworkLinkState", + "modelAsString": true + }, + "readOnly": true + }, + "provisioningState": { + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + } + }, + "description": "Represents the properties of the Private DNS zone." + }, + "VirtualNetworkLink": { + "properties": { + "etag": { + "type": "string", + "description": "The ETag of the virtual network link." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkLinkProperties", + "description": "Properties of the virtual network link to the Private DNS zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Describes a link to virtual network for a Private DNS zone." + }, + "VirtualNetworkLinkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkLink" + }, + "description": "Information about the virtual network links to the Private DNS zones." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response to a list virtual network link to Private DNS zone operation." + }, + "ARecord": { + "properties": { + "ipv4Address": { + "type": "string", + "description": "The IPv4 address of this A record." + } + }, + "description": "An A record." + }, + "AaaaRecord": { + "properties": { + "ipv6Address": { + "type": "string", + "description": "The IPv6 address of this AAAA record." + } + }, + "description": "An AAAA record." + }, + "CnameRecord": { + "properties": { + "cname": { + "type": "string", + "description": "The canonical name for this CNAME record." + } + }, + "description": "A CNAME record." + }, + "MxRecord": { + "properties": { + "preference": { + "type": "integer", + "format": "int32", + "description": "The preference value for this MX record." + }, + "exchange": { + "type": "string", + "description": "The domain name of the mail host for this MX record." + } + }, + "description": "An MX record." + }, + "PtrRecord": { + "properties": { + "ptrdname": { + "type": "string", + "description": "The PTR target domain name for this PTR record." + } + }, + "description": "A PTR record." + }, + "SoaRecord": { + "properties": { + "host": { + "type": "string", + "description": "The domain name of the authoritative name server for this SOA record." + }, + "email": { + "type": "string", + "description": "The email contact for this SOA record." + }, + "serialNumber": { + "type": "integer", + "format": "int64", + "description": "The serial number for this SOA record." + }, + "refreshTime": { + "type": "integer", + "format": "int64", + "description": "The refresh value for this SOA record." + }, + "retryTime": { + "type": "integer", + "format": "int64", + "description": "The retry time for this SOA record." + }, + "expireTime": { + "type": "integer", + "format": "int64", + "description": "The expire time for this SOA record." + }, + "minimumTtl": { + "type": "integer", + "format": "int64", + "description": "The minimum value for this SOA record. By convention this is used to determine the negative caching duration." + } + }, + "description": "An SOA record." + }, + "SrvRecord": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority value for this SRV record." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "The weight value for this SRV record." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port value for this SRV record." + }, + "target": { + "type": "string", + "description": "The target domain name for this SRV record." + } + }, + "description": "An SRV record." + }, + "TxtRecord": { + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The text value of this TXT record." + } + }, + "description": "A TXT record." + }, + "RecordSetProperties": { + "properties": { + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The metadata attached to the record set." + }, + "ttl": { + "type": "integer", + "format": "int64", + "description": "The TTL (time-to-live) of the records in the record set." + }, + "fqdn": { + "type": "string", + "description": "Fully qualified domain name of the record set.", + "readOnly": true + }, + "isAutoRegistered": { + "type": "boolean", + "description": "Is the record set auto-registered in the Private DNS zone through a virtual network link?", + "readOnly": true + }, + "aRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/ARecord" + }, + "x-ms-identifiers": [ + "ipv4Address" + ], + "description": "The list of A records in the record set." + }, + "aaaaRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/AaaaRecord" + }, + "x-ms-identifiers": [ + "ipv6Address" + ], + "description": "The list of AAAA records in the record set." + }, + "cnameRecord": { + "$ref": "#/definitions/CnameRecord", + "description": "The CNAME record in the record set." + }, + "mxRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/MxRecord" + }, + "x-ms-identifiers": [], + "description": "The list of MX records in the record set." + }, + "ptrRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/PtrRecord" + }, + "x-ms-identifiers": [], + "description": "The list of PTR records in the record set." + }, + "soaRecord": { + "$ref": "#/definitions/SoaRecord", + "description": "The SOA record in the record set." + }, + "srvRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/SrvRecord" + }, + "x-ms-identifiers": [], + "description": "The list of SRV records in the record set." + }, + "txtRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/TxtRecord" + }, + "x-ms-identifiers": [], + "description": "The list of TXT records in the record set." + } + }, + "description": "Represents the properties of the records in the record set." + }, + "RecordSet": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the record set.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the record set.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the record set.", + "readOnly": true + }, + "etag": { + "type": "string", + "description": "The ETag of the record set." + }, + "properties": { + "$ref": "#/definitions/RecordSetProperties", + "x-ms-client-flatten": true, + "description": "The properties of the record set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Describes a DNS record set (a collection of DNS records with the same name and type) in a Private DNS zone." + }, + "RecordSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RecordSet" + }, + "description": "Information about the record sets in the response." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response to a record set list operation." + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of the resource. Example - 'Microsoft.Network/privateDnsZones'." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for an ARM proxy resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the service." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/privatedns/resource-manager/readme.go.md b/specification/privatedns/resource-manager/readme.go.md index fda918b8f833..befe899c4cd3 100644 --- a/specification/privatedns/resource-manager/readme.go.md +++ b/specification/privatedns/resource-manager/readme.go.md @@ -19,11 +19,21 @@ azure-arm: true ### Go multi-api -``` yaml $(go) && $(multiapi) +``` yaml $(go) && $(multiapi) batch: + - tag: package-2024-06 - tag: package-2018-09 ``` +### Tag: package-2024-06 and go + +These settings apply only when `--tag=package-2024-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2024-06' && $(go) +output-folder: $(go-sdk-folder)/services/privatedns/mgmt/2024-06-01/privatedns +``` + ### Tag: package-2018-09 and go These settings apply only when `--tag=package-2018-09 --go` is specified on the command line. diff --git a/specification/privatedns/resource-manager/readme.md b/specification/privatedns/resource-manager/readme.md index 55eef147509e..a55ac17b280a 100644 --- a/specification/privatedns/resource-manager/readme.md +++ b/specification/privatedns/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Private DNS API. ``` yaml openapi-type: arm -tag: package-2020-06 +tag: package-2024-06 ``` ### Tag: package-2018-09 @@ -56,6 +56,15 @@ input-file: - Microsoft.Network/stable/2020-06-01/privatedns.json ``` +### Tag: package-2024-06 + +These settings apply only when `--tag=package-2024-06` is specified on the command line. + +``` yaml $(tag) == 'package-2024-06' +input-file: + - Microsoft.Network/stable/2024-06-01/privatedns.json +``` + # Code Generation ## Swagger to SDK @@ -129,6 +138,11 @@ batch: - tag: package-2020-06 ``` +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2024-06 +``` + ### Tag: package-2018-09 and java These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. @@ -171,6 +185,20 @@ generate-interface: true fconfig: '{"moduleName": "privatedns"}' ``` +### Tag: package-2024-06 and java + +These settings apply only when `--tag=package-2024-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.privatedns.v2024_06_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/privatedns/mgmt-v2024_06_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "privatedns"}' +``` + ## Suppression ``` yaml @@ -196,6 +224,3 @@ directive: suppress: DescriptionAndTitleMissing reason: Common types warning. ``` - - - diff --git a/specification/privatedns/resource-manager/readme.nodejs.md b/specification/privatedns/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..19ed26788d52 --- /dev/null +++ b/specification/privatedns/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-privatedns + output-folder: $(node-sdks-folder)/lib/services/privatednsManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/privatedns/resource-manager/readme.python.md b/specification/privatedns/resource-manager/readme.python.md index 845e3cf448bb..752c68007741 100644 --- a/specification/privatedns/resource-manager/readme.python.md +++ b/specification/privatedns/resource-manager/readme.python.md @@ -4,7 +4,6 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - ``` yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION @@ -18,4 +17,3 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/network/azure-mgmt-privatedns/azure/mgmt/privatedns ``` - diff --git a/specification/privatedns/resource-manager/readme.ruby.md b/specification/privatedns/resource-manager/readme.ruby.md index 88b668230fc5..30bae7002192 100644 --- a/specification/privatedns/resource-manager/readme.ruby.md +++ b/specification/privatedns/resource-manager/readme.ruby.md @@ -4,7 +4,7 @@ These settings apply only when `--ruby` is specified on the command line. ``` yaml package-name: azure_mgmt_privatedns -package-version: "0.16.0" +package-version: "0.16.1" azure-arm: true ``` @@ -12,9 +12,20 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2024-06 - tag: package-2018-09 ``` +### Tag: package-2024-06 and ruby + +These settings apply only when `--tag=package-2024-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-06' && $(ruby) +namespace: "Azure::PrivateDns::Mgmt::V2024_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_privatedns/lib +``` + ### Tag: package-2018-09 and ruby These settings apply only when `--tag=package-2018-09 --ruby` is specified on the command line. From 794e29ee5f8eca63ce0ddf007c60da7df37baaad Mon Sep 17 00:00:00 2001 From: FumingZhang <81607949+FumingZhang@users.noreply.github.com> Date: Wed, 10 Jul 2024 04:37:35 +0800 Subject: [PATCH 292/343] Review request for Microsoft.ContainerService/aks to add version stable/2024-05-01 (#29535) * Adds base for updating Microsoft.ContainerService/aks from version stable/2024-02-01 to version 2024-05-01 * Updates readme * Updates API version in new specs and examples * remove osOptions from AKS 2024-05-01 API (#29422) Co-authored-by: Charlie Li * add SecurityPatch to NodeOsUpgradeChannel (#29468) * Adding Daemonset related flags to May 2024 GA (#29579) * update sdk-suppressions.yaml * Update sdk-suppressions.yaml * Update sdk-suppressions.yaml * add value 'none' for networkPolicy field (#29653) --------- Co-authored-by: Charlie Li <39974812+chengliangli0918@users.noreply.github.com> Co-authored-by: Charlie Li Co-authored-by: Ye Wang [msft] <36743427+yewmsft@users.noreply.github.com> Co-authored-by: Youn Jae Kim Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: Yuchao Yan Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: robogatikov <132703210+robogatikov@users.noreply.github.com> --- .../aks/readme.java.md | 14 + .../Microsoft.ContainerService/aks/readme.md | 11 +- .../aks/readme.python.md | 13 +- .../aks/sdk-suppressions.yaml | 10 +- .../examples/AgentPoolsAbortOperation.json | 18 + .../examples/AgentPoolsCreate_CRG.json | 54 + .../AgentPoolsCreate_CustomNodeConfig.json | 124 + .../AgentPoolsCreate_DedicatedHostGroup.json | 52 + ...entPoolsCreate_EnableEncryptionAtHost.json | 54 + .../examples/AgentPoolsCreate_EnableFIPS.json | 54 + .../AgentPoolsCreate_EnableUltraSSD.json | 54 + .../examples/AgentPoolsCreate_Ephemeral.json | 58 + .../examples/AgentPoolsCreate_GPUMIG.json | 127 + .../examples/AgentPoolsCreate_OSSKU.json | 127 + .../examples/AgentPoolsCreate_PPG.json | 54 + .../examples/AgentPoolsCreate_Snapshot.json | 63 + .../examples/AgentPoolsCreate_Spot.json | 86 + .../examples/AgentPoolsCreate_Update.json | 88 + .../examples/AgentPoolsCreate_WasmWasi.json | 60 + ...PoolsCreate_WindowsDisableOutboundNAT.json | 63 + .../AgentPoolsCreate_WindowsOSSKU.json | 54 + .../2024-05-01/examples/AgentPoolsDelete.json | 17 + .../2024-05-01/examples/AgentPoolsGet.json | 30 + ...entPoolsGetAgentPoolAvailableVersions.json | 32 + .../examples/AgentPoolsGetUpgradeProfile.json | 28 + .../2024-05-01/examples/AgentPoolsList.json | 30 + .../AgentPoolsUpgradeNodeImageVersion.json | 34 + .../2024-05-01/examples/AgentPools_Start.json | 52 + .../2024-05-01/examples/AgentPools_Stop.json | 52 + .../examples/AgentPools_Update.json | 75 + .../examples/KubernetesVersions_List.json | 97 + ...aintenanceConfigurationsCreate_Update.json | 94 + ...ationsCreate_Update_MaintenanceWindow.json | 98 + .../MaintenanceConfigurationsDelete.json | 13 + ...onfigurationsDelete_MaintenanceWindow.json | 13 + .../MaintenanceConfigurationsGet.json | 42 + ...ceConfigurationsGet_MaintenanceWindow.json | 40 + .../MaintenanceConfigurationsList.json | 37 + ...eConfigurationsList_MaintenanceWindow.json | 61 + .../ManagedClustersAbortOperation.json | 17 + ...rsCreate_AzureKeyvaultSecretsProvider.json | 259 + ...anagedClustersCreate_AzureServiceMesh.json | 346 + .../examples/ManagedClustersCreate_CRG.json | 254 + ...agedClustersCreate_DedicatedHostGroup.json | 249 + ...nagedClustersCreate_DisableRunCommand.json | 267 + ...gedClustersCreate_DualStackNetworking.json | 323 + ...ClustersCreate_EnableEncryptionAtHost.json | 256 + .../ManagedClustersCreate_EnableUltraSSD.json | 256 + .../ManagedClustersCreate_EnabledFIPS.json | 256 + .../ManagedClustersCreate_GPUMIG.json | 283 + .../ManagedClustersCreate_HTTPProxy.json | 280 + ...rsCreate_IngressProfile_WebAppRouting.json | 249 + ...nagedClustersCreate_ManagedNATGateway.json | 233 + ...agedClustersCreate_NodePublicIPPrefix.json | 256 + .../examples/ManagedClustersCreate_OSSKU.json | 283 + .../examples/ManagedClustersCreate_PPG.json | 256 + .../ManagedClustersCreate_PodIdentity.json | 265 + .../ManagedClustersCreate_Premium.json | 274 + ...ersCreate_PrivateClusterFQDNSubdomain.json | 266 + ...ustersCreate_PrivateClusterPublicFQDN.json | 270 + ...ManagedClustersCreate_SecurityProfile.json | 262 + .../ManagedClustersCreate_Snapshot.json | 265 + .../ManagedClustersCreate_Update.json | 317 + ...nagedClustersCreate_UpdateWindowsGmsa.json | 301 + .../ManagedClustersCreate_UpdateWithAHUB.json | 295 + ...stersCreate_UpdateWithEnableAzureRBAC.json | 284 + ...ClustersCreate_UserAssignedNATGateway.json | 200 + .../examples/ManagedClustersDelete.json | 16 + .../examples/ManagedClustersGet.json | 113 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 49 + ...anagedClustersGet_MeshRevisionProfile.json | 53 + ...ManagedClustersGet_MeshUpgradeProfile.json | 35 + .../examples/ManagedClustersList.json | 66 + .../ManagedClustersListByResourceGroup.json | 67 + ...edClustersListClusterAdminCredentials.json | 20 + ...sListClusterMonitoringUserCredentials.json | 20 + ...gedClustersListClusterUserCredentials.json | 20 + ...agedClustersList_MeshRevisionProfiles.json | 56 + ...nagedClustersList_MeshUpgradeProfiles.json | 38 + .../ManagedClustersResetAADProfile.json | 22 + ...dClustersResetServicePrincipalProfile.json | 20 + ...agedClustersRotateClusterCertificates.json | 16 + ...ustersRotateServiceAccountSigningKeys.json | 16 + .../examples/ManagedClustersStart.json | 16 + .../examples/ManagedClustersStop.json | 16 + .../examples/ManagedClustersUpdateTags.json | 68 + .../2024-05-01/examples/Operation_List.json | 3573 ++++++++ ...boundNetworkDependenciesEndpointsList.json | 242 + .../PrivateEndpointConnectionsDelete.json | 13 + .../PrivateEndpointConnectionsGet.json | 27 + .../PrivateEndpointConnectionsList.json | 30 + .../PrivateEndpointConnectionsUpdate.json | 50 + .../examples/PrivateLinkResourcesList.json | 25 + .../examples/ResolvePrivateLinkServiceId.json | 18 + .../examples/RunCommandRequest.json | 33 + .../examples/RunCommandResultFailed.json | 25 + .../examples/RunCommandResultSucceed.json | 28 + .../2024-05-01/examples/SnapshotsCreate.json | 80 + .../2024-05-01/examples/SnapshotsDelete.json | 12 + .../2024-05-01/examples/SnapshotsGet.json | 39 + .../2024-05-01/examples/SnapshotsList.json | 41 + .../SnapshotsListByResourceGroup.json | 42 + .../examples/SnapshotsUpdateTags.json | 45 + ...stedAccessRoleBindings_CreateOrUpdate.json | 48 + .../TrustedAccessRoleBindings_Delete.json | 17 + .../TrustedAccessRoleBindings_Get.json | 25 + .../TrustedAccessRoleBindings_List.json | 28 + .../examples/TrustedAccessRoles_List.json | 34 + .../stable/2024-05-01/managedClusters.json | 7536 +++++++++++++++++ 110 files changed, 22162 insertions(+), 3 deletions(-) create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CustomNodeConfig.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Ephemeral.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Spot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WasmWasi.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsOSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsUpgradeNodeImageVersion.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Start.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Stop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/KubernetesVersions_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureServiceMesh.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DisableRunCommand.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DualStackNetworking.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnabledFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_HTTPProxy.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_ManagedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PodIdentity.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Premium.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_SecurityProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithAHUB.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshRevisionProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterAdminCredentials.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterUserCredentials.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshRevisionProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshUpgradeProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateClusterCertificates.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStart.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/Operation_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/OutboundNetworkDependenciesEndpointsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateLinkResourcesList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ResolvePrivateLinkServiceId.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandRequest.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultFailed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultSucceed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsCreate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Delete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Get.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoles_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/managedClusters.json diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md index 796eab88cc62..cd2472fdda27 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md @@ -99,6 +99,20 @@ batch: - tag: package-2024-02 - tag: package-preview-2024-03 - tag: package-preview-2024-04 + - tag: package-2024-05 +``` + +### Tag: package-2024-05 and java + +These settings apply only when `--tag=package-2024-05` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2024_05_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2024_05_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-preview-2024-04 and java diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index 24cc58a27dfa..8925557eedbb 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -34,7 +34,16 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-preview-2024-04 +tag: package-2024-05 +``` + +### Tag: package-2024-05 + +These settings apply only when `--tag=package-2024-05` is specified on the command line. + +``` yaml $(tag) == 'package-2024-05' +input-file: + - stable/2024-05-01/managedClusters.json ``` ### Tag: package-preview-2024-04 diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md index 779869c9f997..0d115454c1e5 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md @@ -16,9 +16,10 @@ no-namespace-folders: true Generate all API versions currently shipped for this package ```yaml $(python) -default-api-version: "2024-04-02-preview" +default-api-version: "2024-05-01" multiapi: true batch: + - tag: package-2024-05 - tag: package-preview-2024-04 - tag: package-preview-2024-03 - tag: package-2024-02 @@ -106,6 +107,16 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2024-05 and python + +These settings apply only when `--tag=package-2024-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-05' && $(python) +namespace: azure.mgmt.containerservice.v2024_05_01 +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2024_05_01 +``` + ### Tag: package-preview-2024-04 and python These settings apply only when `--tag=package-preview-2024-04 --python` is specified on the command line. diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml index 1ba9d10b7347..cd6278a277a2 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml @@ -2,9 +2,17 @@ suppressions: azure-sdk-for-go: - package: 'sdk/resourcemanager/containerservice/armcontainerservice' breaking-changes: - - Field `NodeSelector` of struct `IstioEgressGateway` has been removed + - Function `*ManagedClustersClient.GetOSOptions` has been removed + - Struct `OSOptionProfile` has been removed + - Struct `OSOptionPropertyList` has been removed + - Struct `OSOptionProperty` has been removed azure-sdk-for-python: - package: azure-mgmt-containerservice breaking-changes: + - Removed operation ManagedClustersOperations.get_os_options - Model ManagedClusterAzureMonitorProfileAppMonitoring no longer has parameter enabled - Model ManagedClusterAzureMonitorProfileContainerInsights no longer has parameter windows_host_logs + azure-sdk-for-js: + - package: '@azure/arm-containerservice' + breaking-changes: + - Removed operation ManagedClusters.getOSOptions diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..b88b8c57f71f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-05-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CRG.json new file mode 100644 index 000000000000..fb2c21ddb325 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CRG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..b8f243ebf9df --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..c37463404e30 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..5bd68158af97 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..ee3682b035c2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..64952d67b4ea --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..ae3c30e5ef6a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..38b3f433a095 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..8293e45dbddc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..1f010fe9f7fc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..a4f405d908fa --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..150630802fd6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..985d803cc610 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..92d619cdf8d5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json new file mode 100644 index 000000000000..28ce480e00a5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..aeea79ba266c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..2892372d6863 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..48e199f12cc0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..a022b90982ff --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..5c0b217bc852 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..b1fae2d56a85 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..fabd67883522 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Start.json new file mode 100644 index 000000000000..94461091925f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..27fa821a826c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..f23a92ee4749 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..0e50facef5a4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/KubernetesVersions_List.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "isDefault": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "isPreview": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..677d9e5b8f42 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..e1956d07a8ee --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..9d626e2f47c4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..97f274294cc6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..338887b3d6ad --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..a82d01f4624a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..42c8063cbc1e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..b38c2e3ca3be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..c99f6ff44ff7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-05-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..812cf2179f29 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureServiceMesh.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureServiceMesh.json new file mode 100644 index 000000000000..35ac459120ba --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureServiceMesh.json @@ -0,0 +1,346 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + } + } + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_CRG.json new file mode 100644 index 000000000000..271357932088 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_CRG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..66deb2ffb625 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..ffd5fee9279c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..ee9e757fe310 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,323 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..36252d8e16a9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..53ad25115575 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..24e7cd79bb10 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..b4037e01ad6a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..35ad9b752716 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json new file mode 100644 index 000000000000..45350da37f42 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..1e85923c9409 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..2f6d6b4421ce --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..7dc6a2139258 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..1f879da395d8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..504e354f7299 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..26565bc83b40 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,274 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..82d78373b358 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,266 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..5d41f2f960be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..81e60481f5c4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,262 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..aad29f3f980e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..f1a39b49cda2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,317 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..c4cf6fcdcb51 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..f0b500dfde91 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,295 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..d484d7e3b795 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..97c698992812 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..d0eab49813c5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..50b09bfe6b0a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..79bcc25eb8a6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshRevisionProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshRevisionProfile.json new file mode 100644 index 000000000000..ac9d6b1c4f8c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshRevisionProfile.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshUpgradeProfile.json new file mode 100644 index 000000000000..cc5ed550d959 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshUpgradeProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..9e9b35630245 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..cd6087e4a52b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterAdminCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterAdminCredentials.json new file mode 100644 index 000000000000..52d37c53593b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterAdminCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json new file mode 100644 index 000000000000..52d37c53593b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterUserCredentials.json new file mode 100644 index 000000000000..52d37c53593b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshRevisionProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshRevisionProfiles.json new file mode 100644 index 000000000000..82f4bcafdac2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshRevisionProfiles.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshUpgradeProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshUpgradeProfiles.json new file mode 100644 index 000000000000..38ab6738ba56 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshUpgradeProfiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..7b23c9e3f336 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..2351ae6fa39f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..3b3d7d1b8e8d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/Operation_List.json new file mode 100644 index 000000000000..31883723aed1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/Operation_List.json @@ -0,0 +1,3573 @@ +{ + "parameters": { + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..450c9b895bd8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..d07c1a5f48b7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..fda0a3ea9f55 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..fd101e0c65ef --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..db74932b9817 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..30fe25014187 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..48bbee588d78 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandRequest.json new file mode 100644 index 000000000000..8dc8a5cc9c72 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-05-01" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..1da30c39fe25 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-05-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..60260ab5b794 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-05-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..0e4131560ea9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..e4c48ede811f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsGet.json new file mode 100644 index 000000000000..a79152e6a0d7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsList.json new file mode 100644 index 000000000000..16df653f1e68 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..ae4f982c0c8b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..ee0886b11ce9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json new file mode 100644 index 000000000000..220bd4c574fb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1", + "trustedAccessRoleBinding": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Delete.json new file mode 100644 index 000000000000..b38a7391b657 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Get.json new file mode 100644 index 000000000000..1f42bc9440b6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_List.json new file mode 100644 index 000000000000..f06156f21379 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoles_List.json new file mode 100644 index 000000000000..e3668e2f5d1c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoles_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sourceResourceType": "Microsoft.MachineLearningServices/workspaces", + "name": "reader", + "rules": [ + { + "verbs": [ + "get" + ], + "apiGroups": [ + "" + ], + "resources": [ + "pods" + ], + "resourceNames": [], + "nonResourceURLs": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/managedClusters.json new file mode 100644 index 000000000000..5faa5bdb79a5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/managedClusters.json @@ -0,0 +1,7536 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2024-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterAdminCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterMonitoringUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure KeyVault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with Web App Routing Ingress Profile configured": { + "$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Create Managed Cluster with Capacity Reservation Group": { + "$ref": "./examples/ManagedClustersCreate_CRG.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + }, + "Create/Update Managed Cluster with Azure Service Mesh": { + "$ref": "./examples/ManagedClustersCreate_AzureServiceMesh.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + }, + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + }, + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + }, + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + }, + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Windows Agent Pool with disabling OutboundNAT": { + "$ref": "./examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Create Agent Pool with Capacity Reservation Group": { + "$ref": "./examples/AgentPoolsCreate_CRG.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshRevisionProfiles", + "summary": "Lists mesh revision profiles for all meshes in the specified location.", + "description": "Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List mesh revision profiles in a location": { + "$ref": "./examples/ManagedClustersList_MeshRevisionProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshRevisionProfile", + "summary": "Gets a mesh revision profile for a specified mesh in the specified location.", + "description": "Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a mesh revision profile for a mesh mode": { + "$ref": "./examples/ManagedClustersGet_MeshRevisionProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshUpgradeProfiles", + "summary": "Lists available upgrades for all service meshes in a specific cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists version compatibility and upgrade profile for all service meshes in a cluster": { + "$ref": "./examples/ManagedClustersList_MeshUpgradeProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshUpgradeProfile", + "summary": "Gets available upgrades for a service mesh in a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets version compatibility and upgrade profile for a service mesh in a cluster": { + "$ref": "./examples/ManagedClustersGet_MeshUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_List", + "summary": "List trusted access role bindings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBindingListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access role bindings": { + "$ref": "./examples/TrustedAccessRoleBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Get", + "summary": "Get a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_CreateOrUpdate", + "summary": "Create or update a trusted access role binding", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + }, + { + "name": "trustedAccessRoleBinding", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "A trusted access role binding" + } + ], + "responses": { + "200": { + "description": "The existing trusted access role binding was successfully updated.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "201": { + "description": "The new trusted access role binding was successfully created.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Delete", + "summary": "Delete a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoles_List", + "summary": "List supported trusted access roles.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access roles": { + "$ref": "./examples/TrustedAccessRoles_List.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Agent Pool is running.", + "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "title": "Whether the Agent Pool is running or stopped.", + "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "capacityReservationGroupID": { + "$ref": "#/definitions/CapacityReservationGroupID", + "description": "AKS will associate the specified agent pool with the Capacity Reservation Group." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + }, + "networkProfile": { + "$ref": "#/definitions/AgentPoolNetworkProfile", + "description": "Network-related settings of an agent pool." + }, + "windowsProfile": { + "$ref": "#/definitions/AgentPoolWindowsProfile", + "description": "The Windows agent pool's specific profile." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "AgentPoolNetworkProfile": { + "type": "object", + "properties": { + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + }, + "allowedHostPorts": { + "type": "array", + "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationSecurityGroups" + } + ] + } + }, + "description": "The IDs of the application security groups which agent pool will associate when created." + } + }, + "description": "Network settings of an agent pool." + }, + "NodePublicIPTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of tags associated with the node public IP address." + }, + "IPTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: RoutingPreference." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: Internet." + } + }, + "description": "Contains the IPTag associated with the object." + }, + "PortRange": { + "type": "object", + "description": "The port range.", + "properties": { + "portStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd." + }, + "portEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart." + }, + "protocol": { + "type": "string", + "description": "The network protocol of the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP", + "description": "TCP protocol." + }, + { + "value": "UDP", + "description": "UDP protocol." + } + ] + } + } + } + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "title": "The drain timeout for a node", + "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "nodeSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 30, + "minimum": 0, + "title": "The soak duration for a node", + "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes." + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Restriction:** Cannot end in \".\"

**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

**Minimum-length:** 1 character

**Max-length:** 20 characters" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + }, + "gmsaProfile": { + "$ref": "#/definitions/WindowsGmsaProfile", + "description": "The Windows gMSA Profile in the Managed Cluster." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "WindowsGmsaProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable Windows gMSA.", + "description": "Specifies whether to enable Windows gMSA in the managed cluster." + }, + "dnsServer": { + "type": "string", + "description": "Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + }, + "rootDomainName": { + "type": "string", + "description": "Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "none", + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Network policies will not be enforced. This is the default value when NetworkPolicy is not specified." + }, + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign pod IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign service cluster IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "type": "string", + "description": "The IP version to use for cluster networking and IP assignment.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true + } + }, + "title": "The IP families used to specify IP versions available to the cluster.", + "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "x-ms-identifiers": [], + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First week of the month." + }, + { + "value": "Second", + "description": "Second week of the month." + }, + { + "value": "Third", + "description": "Third week of the month." + }, + { + "value": "Fourth", + "description": "Fourth week of the month." + }, + { + "value": "Last", + "description": "Last week of the month." + } + ] + }, + "title": "The week index.", + "description": "Specifies on which week of the month the dayOfWeek applies." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "title": "A date range.", + "description": "For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + }, + "backendPoolType": { + "type": "string", + "x-ms-enum": { + "name": "BackendPoolType", + "modelAsString": true, + "values": [ + { + "value": "NodeIPConfiguration", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + }, + { + "value": "NodeIP", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + } + ] + }, + "enum": [ + "NodeIPConfiguration", + "NodeIP" + ], + "description": "The type of the managed inbound Load Balancer BackendPool.", + "default": "NodeIPConfiguration" + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is running.", + "description": "If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "daemonset-eviction-for-empty-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from empty nodes", + "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "daemonset-eviction-for-occupied-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from non-empty nodes", + "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "ignore-daemonsets-utilization": { + "type": "boolean", + "title": "Should CA ignore DaemonSet pods when calculating resource utilization for scaling down", + "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions." + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "ingressProfile": { + "$ref": "#/definitions/ManagedClusterIngressProfile", + "description": "Ingress profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "title": "PublicNetworkAccess of the managedCluster", + "description": "Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + }, + "serviceMeshProfile": { + "$ref": "#/definitions/ServiceMeshProfile" + }, + "resourceUID": { + "readOnly": true, + "type": "string", + "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)" + }, + "metricsProfile": { + "$ref": "#/definitions/ManagedClusterMetricsProfile", + "description": "Optional cluster metrics configuration." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "NodeImage", + "SecurityPatch" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + }, + { + "value": "SecurityPatch", + "description": "AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption." + } + ] + }, + "title": "Node OS Upgrade Channel", + "description": "Manner in which the OS on your nodes is updated. The default is NodeImage." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner", + "AzureLinux", + "Windows2019", + "Windows2022" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + } + ] + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "AgentPoolWindowsProfile": { + "type": "object", + "description": "The Windows agent pool's specific profile.", + "properties": { + "disableOutboundNat": { + "type": "boolean", + "title": "Whether to disable OutboundNAT in windows nodes", + "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled." + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterIngressProfile": { + "type": "object", + "properties": { + "webAppRouting": { + "$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting", + "description": "App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default." + } + }, + "description": "Ingress profile for the container service cluster." + }, + "ManagedClusterIngressProfileWebAppRouting": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the Application Routing add-on." + }, + "dnsZoneResourceIds": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/dnszones" + }, + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + } + }, + "maxItems": 5, + "description": "Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group." + }, + "identity": { + "readOnly": true, + "type": "object", + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions." + } + }, + "description": "Application Routing add-on settings for the ingress profile." + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + } + }, + "description": "Security profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "title": "Network access of the key vault", + "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "description": "VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA. Default value is false.", + "default": false + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Azure Monitor addon profiles for monitoring the managed cluster.", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels." + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling." + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "ServiceMeshProfile": { + "type": "object", + "description": "Service mesh profile for a managed cluster.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of the service mesh.", + "enum": [ + "Istio", + "Disabled" + ], + "x-ms-enum": { + "name": "ServiceMeshMode", + "modelAsString": true, + "values": [ + { + "value": "Istio", + "description": "Istio deployed as an AKS addon." + }, + { + "value": "Disabled", + "description": "Mesh is disabled." + } + ] + } + }, + "istio": { + "$ref": "#/definitions/IstioServiceMesh" + } + }, + "required": [ + "mode" + ] + }, + "IstioServiceMesh": { + "type": "object", + "description": "Istio service mesh configuration.", + "properties": { + "components": { + "$ref": "#/definitions/IstioComponents" + }, + "certificateAuthority": { + "$ref": "#/definitions/IstioCertificateAuthority" + }, + "revisions": { + "type": "array", + "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade", + "items": { + "type": "string" + }, + "uniqueItems": true, + "maxItems": 2 + } + } + }, + "IstioComponents": { + "type": "object", + "description": "Istio components configuration.", + "properties": { + "ingressGateways": { + "type": "array", + "description": "Istio ingress gateways.", + "items": { + "$ref": "#/definitions/IstioIngressGateway" + }, + "x-ms-identifiers": [] + }, + "egressGateways": { + "type": "array", + "description": "Istio egress gateways.", + "items": { + "$ref": "#/definitions/IstioEgressGateway" + }, + "x-ms-identifiers": [] + } + } + }, + "IstioIngressGateway": { + "type": "object", + "description": "Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of an ingress gateway.", + "enum": [ + "External", + "Internal" + ], + "x-ms-enum": { + "name": "IstioIngressGatewayMode", + "modelAsString": true, + "values": [ + { + "value": "External", + "description": "The ingress gateway is assigned a public IP address and is publicly accessible." + }, + { + "value": "Internal", + "description": "The ingress gateway is assigned an internal IP address and cannot is accessed publicly." + } + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable the ingress gateway." + } + }, + "required": [ + "mode", + "enabled" + ] + }, + "IstioCertificateAuthority": { + "type": "object", + "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca", + "properties": { + "plugin": { + "$ref": "#/definitions/IstioPluginCertificateAuthority" + } + } + }, + "IstioPluginCertificateAuthority": { + "type": "object", + "description": "Plugin certificates information for Service Mesh.", + "properties": { + "keyVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Key Vault." + }, + "certObjectName": { + "type": "string", + "description": "Intermediate certificate object name in Azure Key Vault." + }, + "keyObjectName": { + "type": "string", + "description": "Intermediate certificate private key object name in Azure Key Vault." + }, + "rootCertObjectName": { + "type": "string", + "description": "Root certificate object name in Azure Key Vault." + }, + "certChainObjectName": { + "type": "string", + "description": "Certificate chain object name in Azure Key Vault." + } + } + }, + "IstioEgressGateway": { + "type": "object", + "description": "Istio egress gateway configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the egress gateway." + } + }, + "required": [ + "enabled" + ] + }, + "MeshRevisionProfileList": { + "type": "object", + "description": "Holds an array of MeshRevisionsProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevisionProfile" + }, + "description": "Array of service mesh add-on revision profiles for all supported mesh modes." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh revision profile.", + "readOnly": true + } + } + }, + "MeshRevisionProfile": { + "type": "object", + "description": "Mesh revision profile for a mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshRevisionProfileProperties" + } + } + }, + "MeshRevisionProfileProperties": { + "type": "object", + "description": "Mesh revision profile properties for a mesh", + "properties": { + "meshRevisions": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevision" + } + } + } + }, + "MeshUpgradeProfileList": { + "type": "object", + "description": "Holds an array of MeshUpgradeProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshUpgradeProfile" + }, + "description": "Array of supported service mesh add-on upgrade profiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh upgrade profile.", + "readOnly": true + } + } + }, + "MeshUpgradeProfile": { + "type": "object", + "description": "Upgrade profile for given mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshUpgradeProfileProperties" + } + } + }, + "MeshUpgradeProfileProperties": { + "type": "object", + "description": "Mesh upgrade profile properties for a major.minor release.", + "allOf": [ + { + "$ref": "#/definitions/MeshRevision" + } + ] + }, + "MeshRevision": { + "type": "object", + "description": "Holds information on upgrades and compatibility for given major.minor mesh release.", + "properties": { + "revision": { + "type": "string", + "description": "The revision of the mesh release." + }, + "upgrades": { + "type": "array", + "description": "List of revisions available for upgrade of a specific mesh revision", + "items": { + "type": "string", + "description": "An upgradeable mesh revision" + } + }, + "compatibleWith": { + "type": "array", + "description": "List of items this revision of service mesh is compatible with, and their associated versions.", + "items": { + "$ref": "#/definitions/CompatibleVersions" + }, + "x-ms-identifiers": [] + } + } + }, + "CompatibleVersions": { + "type": "object", + "description": "Version information about a product/service that is compatible with a service mesh revision.", + "properties": { + "name": { + "type": "string", + "description": "The product/service name." + }, + "versions": { + "type": "array", + "description": "Product/service versions compatible with a service mesh add-on revision.", + "items": { + "type": "string", + "description": "A compatible product/service version." + } + } + } + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isDefault": { + "type": "boolean", + "description": "Whether this version is default." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + }, + "ManagedClusterMetricsProfile": { + "type": "object", + "description": "The metrics profile for the ManagedCluster.", + "properties": { + "costAnalysis": { + "$ref": "#/definitions/ManagedClusterCostAnalysis", + "title": "The configuration for detailed per-Kubernetes resource cost analysis." + } + } + }, + "ManagedClusterCostAnalysis": { + "type": "object", + "description": "The cost analysis configuration for the cluster", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable cost analysis", + "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis." + } + } + }, + "TrustedAccessRoleRule": { + "type": "object", + "description": "Rule for trusted access role", + "properties": { + "verbs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed verbs" + }, + "apiGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed apiGroups" + }, + "resources": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed resources" + }, + "resourceNames": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed names" + }, + "nonResourceURLs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed nonResourceURLs" + } + } + }, + "TrustedAccessRole": { + "type": "object", + "description": "Trusted access role definition.", + "properties": { + "sourceResourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type of Azure resource" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of role, name is unique under a source resource type" + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRoleRule" + }, + "x-ms-identifiers": [], + "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)." + } + } + }, + "TrustedAccessRoleBindingProperties": { + "type": "object", + "description": "Properties for trusted access role binding", + "required": [ + "sourceResourceId", + "roles" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of trusted access role binding.", + "enum": [ + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "TrustedAccessRoleBindingProvisioningState", + "modelAsString": true + } + }, + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource ID of source resource that trusted access is configured for." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'." + } + } + }, + "TrustedAccessRoleBinding": { + "type": "object", + "description": "Defines binding between a resource and role", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedAccessRoleBindingProperties", + "x-ms-client-flatten": true + } + } + }, + "TrustedAccessRoleBindingListResult": { + "type": "object", + "description": "List of trusted access role bindings", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "Role binding list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TrustedAccessRoleListResult": { + "type": "object", + "description": "List of trusted access roles", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRole" + }, + "x-ms-identifiers": [ + "sourceResourceType", + "name" + ], + "description": "Role list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CapacityReservationGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/CapacityReservationGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}' Customers use it to create an agentpool with a specified CRG. For more information see [Capacity Reservation](https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview)" + } + }, + "parameters": { + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "AgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "TrustedAccessRoleBindingNameParameter": { + "name": "trustedAccessRoleBindingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of trusted access role binding.", + "pattern": "^([A-Za-z0-9-])+$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + }, + "MeshModeParameter": { + "name": "mode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The mode of the mesh.", + "x-ms-parameter-location": "method" + } + } +} From 3b1151dd901f2b7d96f0dcdb539f9b63bc1040e8 Mon Sep 17 00:00:00 2001 From: Kunal K Singh <103039164+kunsinghms@users.noreply.github.com> Date: Wed, 10 Jul 2024 02:08:08 +0530 Subject: [PATCH 293/343] Change default deployment for Msteam channel to CommercialDeployment (#28741) --- .../preview/2023-09-15-preview/botservice.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2023-09-15-preview/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2023-09-15-preview/botservice.json index 85d4ff731c3d..fce9212914b8 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2023-09-15-preview/botservice.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2023-09-15-preview/botservice.json @@ -2412,7 +2412,7 @@ "deploymentEnvironment": { "type": "string", "description": "Deployment environment for Microsoft Teams channel calls", - "default": "FallbackDeploymentEnvironment" + "default": "CommercialDeployment" }, "acceptedTerms": { "type": "boolean", From 8dafffff904977d164f51a99a78cf8d0ffc9bedf Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 9 Jul 2024 15:00:59 -0700 Subject: [PATCH 294/343] [Monitor] Add .Management suffix to TypeSpec folder name (#29740) --- .../examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json | 0 .../examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json | 0 .../examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json | 0 .../examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json | 0 .../AzureMonitorWorkspacesListByResourceGroup.json | 0 .../AzureMonitorWorkspacesListBySubscription.json | 0 .../examples/2023-10-01-preview/OperationsList.json | 0 .../examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json | 0 .../2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json | 0 .../PipelineGroupCreateSyslogsWithNetworking.json | 0 .../examples/2023-10-01-preview/PipelineGroupCreateUdp.json | 0 .../examples/2023-10-01-preview/PipelineGroupDelete.json | 0 .../examples/2023-10-01-preview/PipelineGroupGet.json | 0 .../2023-10-01-preview/PipelineGroupListByResourceGroup.json | 0 .../2023-10-01-preview/PipelineGroupListBySubscription.json | 0 .../examples/2023-10-01-preview/PipelineGroupUpdate.json | 0 .../{Microsoft.Monitor => Microsoft.Monitor.Management}/main.tsp | 0 .../tspconfig.yaml | 0 .../typespec/azureMonitorWorkspace.tsp | 0 .../typespec/exporters/AzureMonitorWorkspaceLogs.tsp | 0 .../typespec/exporters/TcpExporters.tsp | 0 .../typespec/pipelineGroup.tsp | 0 .../typespec/processors/BatchProcessor.tsp | 0 .../typespec/receivers/OtlpReceiver.tsp | 0 .../typespec/receivers/SyslogReceiver.tsp | 0 .../typespec/receivers/TcpReceivers.tsp | 0 .../typespec/service.tsp | 0 27 files changed, 0 insertions(+), 0 deletions(-) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/AzureMonitorWorkspacesListByResourceGroup.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/AzureMonitorWorkspacesListBySubscription.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/OperationsList.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithNetworking.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/PipelineGroupCreateUdp.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/PipelineGroupDelete.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/PipelineGroupGet.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/PipelineGroupListByResourceGroup.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/PipelineGroupListBySubscription.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/examples/2023-10-01-preview/PipelineGroupUpdate.json (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/main.tsp (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/tspconfig.yaml (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/typespec/azureMonitorWorkspace.tsp (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/typespec/exporters/AzureMonitorWorkspaceLogs.tsp (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/typespec/exporters/TcpExporters.tsp (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/typespec/pipelineGroup.tsp (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/typespec/processors/BatchProcessor.tsp (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/typespec/receivers/OtlpReceiver.tsp (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/typespec/receivers/SyslogReceiver.tsp (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/typespec/receivers/TcpReceivers.tsp (100%) rename specification/monitor/{Microsoft.Monitor => Microsoft.Monitor.Management}/typespec/service.tsp (100%) diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspacesListByResourceGroup.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspacesListByResourceGroup.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspacesListByResourceGroup.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspacesListByResourceGroup.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspacesListBySubscription.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspacesListBySubscription.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspacesListBySubscription.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspacesListBySubscription.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/OperationsList.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/OperationsList.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/OperationsList.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/OperationsList.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithNetworking.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithNetworking.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithNetworking.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithNetworking.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateUdp.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateUdp.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateUdp.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateUdp.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupDelete.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupDelete.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupDelete.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupDelete.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupGet.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupGet.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupGet.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupGet.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupListByResourceGroup.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupListByResourceGroup.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupListByResourceGroup.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupListByResourceGroup.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupListBySubscription.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupListBySubscription.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupListBySubscription.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupListBySubscription.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupUpdate.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupUpdate.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupUpdate.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupUpdate.json diff --git a/specification/monitor/Microsoft.Monitor/main.tsp b/specification/monitor/Microsoft.Monitor.Management/main.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/main.tsp rename to specification/monitor/Microsoft.Monitor.Management/main.tsp diff --git a/specification/monitor/Microsoft.Monitor/tspconfig.yaml b/specification/monitor/Microsoft.Monitor.Management/tspconfig.yaml similarity index 100% rename from specification/monitor/Microsoft.Monitor/tspconfig.yaml rename to specification/monitor/Microsoft.Monitor.Management/tspconfig.yaml diff --git a/specification/monitor/Microsoft.Monitor/typespec/azureMonitorWorkspace.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/azureMonitorWorkspace.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/azureMonitorWorkspace.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/azureMonitorWorkspace.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/exporters/AzureMonitorWorkspaceLogs.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/exporters/AzureMonitorWorkspaceLogs.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/exporters/AzureMonitorWorkspaceLogs.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/exporters/AzureMonitorWorkspaceLogs.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/exporters/TcpExporters.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/exporters/TcpExporters.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/exporters/TcpExporters.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/exporters/TcpExporters.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/pipelineGroup.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/pipelineGroup.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/pipelineGroup.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/pipelineGroup.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/processors/BatchProcessor.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/processors/BatchProcessor.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/processors/BatchProcessor.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/processors/BatchProcessor.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/receivers/OtlpReceiver.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/receivers/OtlpReceiver.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/receivers/OtlpReceiver.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/receivers/OtlpReceiver.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/receivers/SyslogReceiver.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/receivers/SyslogReceiver.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/receivers/SyslogReceiver.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/receivers/SyslogReceiver.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/receivers/TcpReceivers.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/receivers/TcpReceivers.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/receivers/TcpReceivers.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/receivers/TcpReceivers.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/service.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/service.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/service.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/service.tsp From 72de08114673a547de8a017c85ed89a2017a86f7 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 9 Jul 2024 15:06:34 -0700 Subject: [PATCH 295/343] [VerifiedId] Add ".Management" suffix to TypeSpec folder name (#29747) --- .../examples/2024-01-26-preview/Authorities_CreateOrUpdate.json | 0 .../examples/2024-01-26-preview/Authorities_Delete.json | 0 .../examples/2024-01-26-preview/Authorities_Get.json | 0 .../2024-01-26-preview/Authorities_ListByResourceGroup.json | 0 .../2024-01-26-preview/Authorities_ListBySubscription.json | 0 .../examples/2024-01-26-preview/Authorities_Update.json | 0 .../examples/2024-01-26-preview/Operations_List.json | 0 .../main.tsp | 0 .../tspconfig.yaml | 0 9 files changed, 0 insertions(+), 0 deletions(-) rename specification/verifiedid/{Microsoft.VerifiedId => Microsoft.VerifiedId.Management}/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json (100%) rename specification/verifiedid/{Microsoft.VerifiedId => Microsoft.VerifiedId.Management}/examples/2024-01-26-preview/Authorities_Delete.json (100%) rename specification/verifiedid/{Microsoft.VerifiedId => Microsoft.VerifiedId.Management}/examples/2024-01-26-preview/Authorities_Get.json (100%) rename specification/verifiedid/{Microsoft.VerifiedId => Microsoft.VerifiedId.Management}/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json (100%) rename specification/verifiedid/{Microsoft.VerifiedId => Microsoft.VerifiedId.Management}/examples/2024-01-26-preview/Authorities_ListBySubscription.json (100%) rename specification/verifiedid/{Microsoft.VerifiedId => Microsoft.VerifiedId.Management}/examples/2024-01-26-preview/Authorities_Update.json (100%) rename specification/verifiedid/{Microsoft.VerifiedId => Microsoft.VerifiedId.Management}/examples/2024-01-26-preview/Operations_List.json (100%) rename specification/verifiedid/{Microsoft.VerifiedId => Microsoft.VerifiedId.Management}/main.tsp (100%) rename specification/verifiedid/{Microsoft.VerifiedId => Microsoft.VerifiedId.Management}/tspconfig.yaml (100%) diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Delete.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Delete.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Get.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Get.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_ListBySubscription.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_ListBySubscription.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Update.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Update.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Operations_List.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Operations_List.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/main.tsp b/specification/verifiedid/Microsoft.VerifiedId.Management/main.tsp similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/main.tsp rename to specification/verifiedid/Microsoft.VerifiedId.Management/main.tsp diff --git a/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml b/specification/verifiedid/Microsoft.VerifiedId.Management/tspconfig.yaml similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml rename to specification/verifiedid/Microsoft.VerifiedId.Management/tspconfig.yaml From a906851d8d1a358f5053c8d8dff518f6170cb761 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 10 Jul 2024 10:07:05 +0800 Subject: [PATCH 296/343] disable flatten for informatica (#29755) * Update readme.md * Update readme.python.md * Update tspconfig.yaml --- .../informatica/Informatica.DataManagement/tspconfig.yaml | 8 ++++---- specification/informatica/resource-manager/readme.md | 5 +++++ .../informatica/resource-manager/readme.python.md | 1 + 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/specification/informatica/Informatica.DataManagement/tspconfig.yaml b/specification/informatica/Informatica.DataManagement/tspconfig.yaml index b3a0a313df39..889428f85414 100644 --- a/specification/informatica/Informatica.DataManagement/tspconfig.yaml +++ b/specification/informatica/Informatica.DataManagement/tspconfig.yaml @@ -9,10 +9,10 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" examples-directory: "{project-root}/examples" - "@azure-tools/typespec-python": - package-dir: "azure-mgmt-informaticadatamanagement" - package-name: "{package-dir}" - flavor: "azure" + # "@azure-tools/typespec-python": + # package-dir: "azure-mgmt-informaticadatamanagement" + # package-name: "{package-dir}" + # flavor: "azure" # "@azure-tools/typespec-java": # package-dir: "azure-resourcemanager-informaticadatamanagement" # flavor: "azure" diff --git a/specification/informatica/resource-manager/readme.md b/specification/informatica/resource-manager/readme.md index 1b044bb17cbf..efdc4d0e1e4c 100644 --- a/specification/informatica/resource-manager/readme.md +++ b/specification/informatica/resource-manager/readme.md @@ -30,6 +30,11 @@ openapi-subtype: rpaas tag: package-2024-05-08 ``` +``` yaml +modelerfour: + flatten-models: false +``` + ### Tag: package-2024-05-08 These settings apply only when `--tag=package-2024-05-08` is specified on the command line. diff --git a/specification/informatica/resource-manager/readme.python.md b/specification/informatica/resource-manager/readme.python.md index 43dd631bea18..1d0a5311b830 100644 --- a/specification/informatica/resource-manager/readme.python.md +++ b/specification/informatica/resource-manager/readme.python.md @@ -4,6 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. ``` yaml $(python) +title: InformaticaDataMgmtClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-informaticadatamanagement From 40390d1f34a8f74584a272d4da55f12827972357 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 10 Jul 2024 11:03:38 +0800 Subject: [PATCH 297/343] Update readme.python.md (#29769) --- specification/informatica/resource-manager/readme.python.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/informatica/resource-manager/readme.python.md b/specification/informatica/resource-manager/readme.python.md index 1d0a5311b830..01f0b3001521 100644 --- a/specification/informatica/resource-manager/readme.python.md +++ b/specification/informatica/resource-manager/readme.python.md @@ -15,5 +15,5 @@ clear-output-folder: true ``` yaml $(python) no-namespace-folders: true -output-folder: $(python-sdks-folder)/informatica/azure-mgmt-informaticadatamanagement/azure/mgmt/informaticadatamanagement +output-folder: $(python-sdks-folder)/informaticadatamanagement/azure-mgmt-informaticadatamanagement/azure/mgmt/informaticadatamanagement ``` From ad586683a95c59b4e581081881037f614049040c Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Wed, 10 Jul 2024 11:42:24 +0800 Subject: [PATCH 298/343] tsp, BodyParameter, fix a few missing op (#29770) --- specification/ai/OpenAI.Assistants/vector_stores/routes.tsp | 2 +- .../preview/2024-05-01-preview/assistants_generated.json | 1 + .../OpenApiV3/2024-05-01-preview/assistants_generated.yaml | 1 + .../cognitiveservices/OpenAI.Inference/routes/audio_speech.tsp | 2 +- .../cognitiveservices/OpenAI.Inference/routes/completions.tsp | 2 +- .../inference/preview/2023-06-01-preview/generated.json | 1 + .../inference/preview/2023-07-01-preview/generated.json | 1 + .../inference/preview/2024-02-15-preview/generated.json | 2 ++ .../inference/preview/2024-03-01-preview/generated.json | 2 ++ .../inference/preview/2024-04-01-preview/generated.json | 2 ++ .../inference/preview/2024-05-01-preview/generated.json | 2 ++ .../AzureOpenAI/inference/stable/2023-05-15/generated.json | 1 + 12 files changed, 16 insertions(+), 3 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp index da0395283ad6..6662d455a6a2 100644 --- a/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp +++ b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp @@ -63,7 +63,7 @@ op modifyVectorStore( /** The ID of the vector store to modify. */ @path vectorStoreId: string, - ...VectorStoreUpdateOptions, + ...BodyParameter, ): VectorStore; /** diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 5fcda9a56c31..745a9723a11b 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -1484,6 +1484,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/VectorStoreUpdateOptions" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index e7a6f9691f97..7e0ac545e325 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -960,6 +960,7 @@ paths: schema: $ref: '#/components/schemas/VectorStore' requestBody: + description: Body parameter. required: true content: application/json: diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/audio_speech.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/audio_speech.tsp index 0d456088cd1f..92286d6f603e 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/audio_speech.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/audio_speech.tsp @@ -20,6 +20,6 @@ namespace Azure.OpenAI; @actionSeparator("/") op generateSpeechFromText is ResourceAction< Deployment, - SpeechGenerationOptions, + BodyParameter, SpeechGenerationResponse >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp index 3b138d588587..109be6748818 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp @@ -37,6 +37,6 @@ op getCompletions is Azure.Core.ResourceAction< @action("chat/completions") //@convenientAPI(true) op getChatCompletions is ResourceAction< Deployment, - ChatCompletionsOptions, + BodyParameter, ChatCompletions >; diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json index 08007691cc3a..37e3541babb0 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json @@ -77,6 +77,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json index dfd0dcdce0b0..bd8333d75792 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json @@ -77,6 +77,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json index 0fb1618e5c07..9cd76529a51e 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json @@ -81,6 +81,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SpeechGenerationOptions" @@ -403,6 +404,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json index 50544e3dc1fc..0ad10094651e 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json @@ -81,6 +81,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SpeechGenerationOptions" @@ -403,6 +404,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json index 1e2249218c04..cf5f9a0abc39 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json @@ -81,6 +81,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SpeechGenerationOptions" @@ -437,6 +438,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json index 8557c34830a2..1a0d46d86c47 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json @@ -81,6 +81,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SpeechGenerationOptions" @@ -437,6 +438,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json index bf3f9152ea8b..ab36ec1d5ceb 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json @@ -77,6 +77,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" From df3cd3e3d50eec1d1da593750e1ea3a4db3f541d Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Wed, 10 Jul 2024 14:05:00 +0800 Subject: [PATCH 299/343] tsp, loadtesting, remove empty visibility from FileInfo.fileName (#29521) --- specification/loadtestservice/LoadTestService/models.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/loadtestservice/LoadTestService/models.tsp b/specification/loadtestservice/LoadTestService/models.tsp index 5f1ccb5d57ba..77317b553889 100644 --- a/specification/loadtestservice/LoadTestService/models.tsp +++ b/specification/loadtestservice/LoadTestService/models.tsp @@ -496,9 +496,9 @@ model TestInputArtifacts { @doc("File info") model FileInfo { + #suppress "@azure-tools/typespec-azure-core/key-visibility-required" "model is output only" @doc("Name of the file.") @key - @visibility fileName: string; @doc("File URL.") From 876c4ba5af4413894802dc9de8f7a9cf3ead76aa Mon Sep 17 00:00:00 2001 From: Shawn Fang <45607042+mssfang@users.noreply.github.com> Date: Wed, 10 Jul 2024 10:12:57 -0700 Subject: [PATCH 300/343] Enable stream-style-serialization (#29768) --- specification/ai/Face/tspconfig.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/ai/Face/tspconfig.yaml b/specification/ai/Face/tspconfig.yaml index b96f9c05c0aa..6fcc4953bc9f 100644 --- a/specification/ai/Face/tspconfig.yaml +++ b/specification/ai/Face/tspconfig.yaml @@ -37,7 +37,6 @@ options: package-dir: "azure-ai-vision-face" namespace: com.azure.ai.vision.face partial-update: true - stream-style-serialization: false flavor: azure linter: extends: From b195dd7a970dbd1c6cbb50e6a6845d5d9a868b21 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 10 Jul 2024 19:26:29 +0200 Subject: [PATCH 301/343] [OpenAI-Assistants] Fixing examples and avocado related CI issues (#29499) * cleaned up config file * reverted name * Restored names and verified example adding behaviour for openapi2 emitter * Added example JSON files and the readme file * Added examples for past releases * Added more documentation to the script * Readme corrections * More readme corrections * Renamed retrieveAssistants examples to getAssistants to match TSP definition * Removed some swagger files * create_assistants json corrections * wip * Get Assistants * WIP * File operations * Files JSON examples * wip * wip * More various fixes * wip * wip * wip * removing bodyRoot decorator * Checking if things are actually fixed * Made expandable nullable enum into 'null' instead of null * Revert "Made expandable nullable enum into 'null' instead of null" This reverts commit 03d2bf5227c11326ac836e29bb3a8647a914ced5. * WIP * wip * Possible solution to bad @body usage * Found better solution for version added mismatch createMessage * wip * WIP * Started with vector store stuff * More fixes for vector store stuff * More fixes * Last fixes for vector store batch files * Using string 'null' instread of JSON null * Revert "Using string 'null' instread of JSON null" This reverts commit 39fdbc665924b28a0f55dc15c4db8f101e4c5a38. * Corrected operationId * trying out null as a string * Revert "trying out null as a string" This reverts commit ab876a135efecc12d7aa4b74f0d35f41a726b949. * Stringified nulls to make CI happy * Changed the value of instructions for ThreadRun examples. Field not nullable nor optional * Addressing metadata issue * Revert "Stringified nulls to make CI happy" This reverts commit 3dbb7233e27a5ee9b0a2eef0ac4e1d93a5fb5f36. * Reverting left over stuff * TSP formatter * Prettified JSON * Added suppresion to work around bug * Removed unnecessary example files * Removed convenience scripts * Using bodyRoot again * Revert "Using bodyRoot again" This reverts commit a31f2a05e95d0bd4f13063ee44766ee8484bba32. * Using BodyParameter in createMessage op * The CI seems stuck --- .../2024-02-15-preview/cancel_run.json | 38 + .../2024-02-15-preview/create_assistant.json | 37 +- .../2024-02-15-preview/create_message.json | 40 + .../2024-02-15-preview/create_run.json | 36 + .../2024-02-15-preview/create_thread.json | 19 + .../create_thread_and_run.json | 35 + .../2024-02-15-preview/delete_assistant.json | 18 + .../2024-02-15-preview/delete_file.json | 18 + .../2024-02-15-preview/delete_thread.json | 18 + .../2024-02-15-preview/get_assistant.json | 28 + .../examples/2024-02-15-preview/get_file.json | 21 + .../2024-02-15-preview/get_file_content.json | 14 + .../2024-02-15-preview/get_message.json | 37 + .../examples/2024-02-15-preview/get_run.json | 34 + .../2024-02-15-preview/get_run_step.json | 42 + .../2024-02-15-preview/get_thread.json | 19 + .../2024-02-15-preview/list_assistants.json | 52 + .../2024-02-15-preview/list_file.json | 34 + .../2024-02-15-preview/list_messages.json | 67 + .../2024-02-15-preview/list_run_steps.json | 49 + .../2024-02-15-preview/list_runs.json | 45 + .../submit_tool_outputs_to_run.json | 69 + .../2024-02-15-preview/update_assistant.json | 31 + .../2024-02-15-preview/update_message.json | 46 + .../2024-02-15-preview/update_run.json | 43 + .../2024-02-15-preview/update_thread.json | 28 + .../2024-02-15-preview/upload_file.json | 28 + .../2024-05-01-preview/cancel_run.json | 48 + .../cancel_vector_store_file_batch.json | 28 + .../2024-05-01-preview/create_assistant.json | 41 +- .../2024-05-01-preview/create_message.json | 41 + .../2024-05-01-preview/create_run.json | 50 + .../2024-05-01-preview/create_thread.json | 20 + .../create_thread_and_run.json | 54 + .../create_vector_store.json | 32 + .../create_vector_store_file.json | 25 + .../create_vector_store_file_batch.json | 33 + .../2024-05-01-preview/delete_assistant.json | 18 + .../2024-05-01-preview/delete_file.json | 18 + .../2024-05-01-preview/delete_thread.json | 18 + .../delete_vector_store.json | 18 + .../delete_vector_store_file.json | 19 + .../2024-05-01-preview/get_assistant.json | 32 + .../examples/2024-05-01-preview/get_file.json | 23 + .../2024-05-01-preview/get_file_content.json | 14 + .../2024-05-01-preview/get_message.json | 38 + .../examples/2024-05-01-preview/get_run.json | 42 + .../2024-05-01-preview/get_run_step.json | 42 + .../2024-05-01-preview/get_thread.json | 24 + .../2024-05-01-preview/get_vector_store.json | 30 + .../get_vector_store_file.json | 23 + .../get_vector_store_file_batch.json | 28 + .../2024-05-01-preview/list_assistants.json | 71 + .../2024-05-01-preview/list_file.json | 38 + .../2024-05-01-preview/list_messages.json | 69 + .../2024-05-01-preview/list_run_steps.json | 49 + .../2024-05-01-preview/list_runs.json | 97 + .../list_vector_store_file_batch_files.json | 40 + .../list_vector_store_files.json | 39 + .../list_vector_stores.json | 54 + .../modify_vector_store.json | 33 + .../submit_tool_outputs_to_run.json | 79 + .../2024-05-01-preview/update_assistant.json | 45 + .../2024-05-01-preview/update_message.json | 47 + .../2024-05-01-preview/update_run.json | 59 + .../2024-05-01-preview/update_thread.json | 29 + .../2024-05-01-preview/upload_file.json | 30 + .../ai/OpenAI.Assistants/messages/models.tsp | 3 +- .../ai/OpenAI.Assistants/messages/routes.tsp | 4 +- .../ai/OpenAI.Assistants/runs/routes.tsp | 5 +- .../ai/OpenAI.Assistants/tspconfig.yaml | 12 +- .../assistants_generated.json | 3452 ----------------- .../assistants_generated.json | 173 +- .../examples/cancel_run.json | 38 + .../examples/create_assistant.json | 37 + .../examples/create_message.json | 40 + .../examples/create_run.json | 36 + .../examples/create_thread.json | 19 + .../examples/create_thread_and_run.json | 35 + .../examples/delete_assistant.json | 18 + .../examples/delete_file.json | 18 + .../examples/delete_thread.json | 18 + .../examples/get_assistant.json | 28 + .../2024-02-15-preview/examples/get_file.json | 21 + .../examples/get_file_content.json | 14 + .../examples/get_message.json | 37 + .../2024-02-15-preview/examples/get_run.json | 34 + .../examples/get_run_step.json | 42 + .../examples/get_thread.json | 19 + .../examples/list_assistants.json | 52 + .../examples/list_file.json | 34 + .../examples/list_messages.json | 67 + .../examples/list_run_steps.json | 49 + .../examples/list_runs.json | 45 + .../examples/submit_tool_outputs_to_run.json | 69 + .../examples/update_assistant.json | 31 + .../examples/update_message.json | 46 + .../examples/update_run.json | 43 + .../examples/update_thread.json | 28 + .../examples/upload_file.json | 28 + .../assistants_generated.json | 207 +- .../examples/cancel_run.json | 48 + .../cancel_vector_store_file_batch.json | 28 + .../examples/create_assistant.json | 41 + .../examples/create_message.json | 41 + .../examples/create_run.json | 50 + .../examples/create_thread.json | 20 + .../examples/create_thread_and_run.json | 54 + .../examples/create_vector_store.json | 32 + .../examples/create_vector_store_file.json | 25 + .../create_vector_store_file_batch.json | 33 + .../examples/delete_assistant.json | 18 + .../examples/delete_file.json | 18 + .../examples/delete_thread.json | 18 + .../examples/delete_vector_store.json | 18 + .../examples/delete_vector_store_file.json | 19 + .../examples/get_assistant.json | 32 + .../2024-05-01-preview/examples/get_file.json | 23 + .../examples/get_file_content.json | 14 + .../examples/get_message.json | 38 + .../2024-05-01-preview/examples/get_run.json | 42 + .../examples/get_run_step.json | 42 + .../examples/get_thread.json | 24 + .../examples/get_vector_store.json | 30 + .../examples/get_vector_store_file.json | 23 + .../examples/get_vector_store_file_batch.json | 28 + .../examples/list_assistants.json | 71 + .../examples/list_file.json | 38 + .../examples/list_messages.json | 69 + .../examples/list_run_steps.json | 49 + .../examples/list_runs.json | 97 + .../list_vector_store_file_batch_files.json | 40 + .../examples/list_vector_store_files.json | 39 + .../examples/list_vector_stores.json | 54 + .../examples/modify_vector_store.json | 33 + .../examples/submit_tool_outputs_to_run.json | 79 + .../examples/update_assistant.json | 45 + .../examples/update_message.json | 47 + .../examples/update_run.json | 59 + .../examples/update_thread.json | 29 + .../examples/upload_file.json | 30 + .../2023-11-06-beta/assistants_generated.json | 3452 ----------------- .../examples/create_assistant.json | 4 - .../assistants_generated.yaml | 2388 ------------ .../2023-11-06-beta/assistants_generated.yaml | 2388 ------------ .../assistants_generated.yaml | 34 +- .../assistants_generated.yaml | 3 +- .../ai/data-plane/OpenAI.Assistants/readme.md | 38 + 148 files changed, 5420 insertions(+), 11711 deletions(-) create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml delete mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml create mode 100644 specification/ai/data-plane/OpenAI.Assistants/readme.md diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json new file mode 100644 index 000000000000..5317d558935b --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -0,0 +1,38 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_BUf53eW0aua3EjHTyO3P3evb", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106", + "instructions": "You solve math problems.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "incomplete_details": null, + "metadata": {}, + "usage": null + } + } + }, + "operationId": "CancelRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json index 24f1208ac3df..5a9981a936b5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -1,4 +1,37 @@ { - "title": "Assistants_CreateAssistant", - "operationId": "Assistants_CreateAssistant" + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + } + }, + "operationId": "CreateAssistant" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json new file mode 100644 index 000000000000..c0318a2f3364 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json @@ -0,0 +1,40 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json new file mode 100644 index 000000000000..b516adecefd2 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -0,0 +1,36 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "body": { + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + } + }, + "responses": { + "200": { + "body": { + "id": "run_dmC5IgLBfaK8gBy0FKIXGtpr", + "object": "thread.run", + "created_at": 1707301142, + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "status": "queued", + "incomplete_details": null, + "usage": null, + "started_at": null, + "expires_at": 1707301742, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "metadata": {} + } + } + }, + "operationId": "CreateRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json new file mode 100644 index 000000000000..9b2b9a3a463c --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json @@ -0,0 +1,19 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json new file mode 100644 index 000000000000..2babffbce6d5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -0,0 +1,35 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "assistant_id": "{{assistants.id}}" + } + }, + "responses": { + "200": { + "body": { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "queued", + "started_at": null, + "expires_at": 1707300852, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "usage": null, + "incomplete_details": null, + "metadata": {} + } + } + }, + "operationId": "CreateThreadAndRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json new file mode 100644 index 000000000000..f300dfb2ad72 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json new file mode 100644 index 000000000000..7d89fe77f52f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json new file mode 100644 index 000000000000..e14eac104c85 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json new file mode 100644 index 000000000000..09fa93da8abc --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json @@ -0,0 +1,28 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + } + }, + "operationId": "GetAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json new file mode 100644 index 000000000000..c0a99d1b7a24 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json @@ -0,0 +1,21 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json new file mode 100644 index 000000000000..9f05e09e75d2 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json @@ -0,0 +1,14 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": "file content" + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json new file mode 100644 index 000000000000..20fd1c2f15c2 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json @@ -0,0 +1,37 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json new file mode 100644 index 000000000000..6dab7987a07e --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -0,0 +1,34 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "incomplete_details": null, + "usage": null, + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json new file mode 100644 index 000000000000..5f74b0d0067a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json @@ -0,0 +1,42 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + } + }, + "operationId": "GetRunStep" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json new file mode 100644 index 000000000000..b2c902c476aa --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json new file mode 100644 index 000000000000..56f32fa4007a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json @@ -0,0 +1,52 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + }, + { + "id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "object": "assistant", + "created_at": 1707249683, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a personal math tutor. Answer questions briefly, in a sentence or less.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + ], + "first_id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "last_id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "has_more": false + } + } + }, + "operationId": "ListAssistants" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json new file mode 100644 index 000000000000..39b31a4aa1b6 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json @@ -0,0 +1,34 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043 + } + ] + } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json new file mode 100644 index 000000000000..20f01a6fda3f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json @@ -0,0 +1,67 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "object": "thread.message", + "created_at": 1707298439, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "assistant", + "content": [ + { + "type": "text", + "text": { + "value": "The cube root of the sum of the given numbers, rounded to the nearest integer, is 12345.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", + "run_id": "run_35BhBv0Ry4vVgjF0vO36Ajzf", + "metadata": {} + }, + { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + ], + "first_id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "last_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json new file mode 100644 index 000000000000..7378eddd2de5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json @@ -0,0 +1,49 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json new file mode 100644 index 000000000000..c044c0365b3f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -0,0 +1,45 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_7CJfaYBtuRIOSksocRrYNQGV" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "completed", + "started_at": 1707300255, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707300267, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "incomplete_details": null, + "usage": { + "completion_tokens": 1, + "prompt_tokens": 999, + "total_tokens": 1000 + }, + "metadata": {} + } + ], + "first_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "last_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..ff1009e9c1fc --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -0,0 +1,69 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_abc123", + "output": "28C" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_abc123", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4", + "instructions": "You tell the weather.", + "incomplete_details": null, + "tools": [ + { + "type": "function", + "function": { + "name": "get_weather", + "description": "Determine weather in my location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "c", + "f" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json new file mode 100644 index 000000000000..f0fb253c5f64 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json @@ -0,0 +1,31 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "body": { + "name": "Math Tutor Improved" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor Improved", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json new file mode 100644 index 000000000000..0021cd3ec12c --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json @@ -0,0 +1,46 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "assistant_id": null, + "run_id": null, + "status": "incomplete", + "incomplete_details": null, + "completed_at": 1707298421, + "incomplete_at": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json new file mode 100644 index 000000000000..15e95dd58e30 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json @@ -0,0 +1,43 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "incomplete_details": null, + "usage": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json new file mode 100644 index 000000000000..af3b0ddfef32 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json @@ -0,0 +1,28 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json new file mode 100644 index 000000000000..94fd2039a6db --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json @@ -0,0 +1,28 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json new file mode 100644 index 000000000000..7f3456272098 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -0,0 +1,48 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You summarize books.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_choice": "auto", + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "max_completion_tokens": 1000, + "max_prompt_tokens": 1000, + "incomplete_details": null, + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "CancelRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json new file mode 100644 index 000000000000..1d73787e8c47 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "title": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "cancelling", + "file_counts": { + "in_progress": 12, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 15 + } + } + } + }, + "operationId": "CancelVectorStoreFileBatch" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json index 24f1208ac3df..66b92133fe32 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json @@ -1,4 +1,41 @@ { - "title": "Assistants_CreateAssistant", - "operationId": "Assistants_CreateAssistant" + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "CreateAssistant" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json new file mode 100644 index 000000000000..70ae2b1b9da1 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json @@ -0,0 +1,41 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "assistant_id": null, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json new file mode 100644 index 000000000000..97d2f5b79785 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -0,0 +1,50 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "body": { + "assistant_id": "asst_abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "CreateRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json new file mode 100644 index 000000000000..101ade5b001f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json @@ -0,0 +1,20 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "tool_resources": {}, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json new file mode 100644 index 000000000000..5fdbcedb411f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -0,0 +1,54 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "assistant_id": "asst_abc123", + "thread": { + "messages": [ + { + "role": "user", + "content": "Explain deep learning to a 5 year old." + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076792, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": null, + "expires_at": 1699077392, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "required_action": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant.", + "tools": [], + "metadata": {}, + "temperature": 1.0, + "top_p": 1.0, + "max_completion_tokens": null, + "max_prompt_tokens": null, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "incomplete_details": null, + "usage": null, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "CreateThreadAndRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json new file mode 100644 index 000000000000..60ae754b38c9 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json @@ -0,0 +1,32 @@ +{ + "title": "Creates a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "CreateVectorStore" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json new file mode 100644 index 000000000000..404fe3f1caf9 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json @@ -0,0 +1,25 @@ +{ + "title": "Create a vector store file by attaching a File to a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "file_id": "file-abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 1234, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + }, + "operationId": "CreateVectorStoreFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json new file mode 100644 index 000000000000..c985b6e7a580 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json @@ -0,0 +1,33 @@ +{ + "title": "Create a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } + }, + "operationId": "CreateVectorStoreFileBatch" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json new file mode 100644 index 000000000000..a4675ff13925 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json new file mode 100644 index 000000000000..7c4d93ffd9a6 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json new file mode 100644 index 000000000000..fe2b6bc1b662 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json new file mode 100644 index 000000000000..1adda1765fb3 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123 " + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStore" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json new file mode 100644 index 000000000000..804790877bdb --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json @@ -0,0 +1,19 @@ +{ + "title": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "fileId": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file_abc123", + "object": "vector_store.file.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStoreFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json new file mode 100644 index 000000000000..514a7c390012 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json @@ -0,0 +1,32 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_abc123" + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "top_p": 1.0, + "temperature": 1.0, + "tool_resources": {}, + "metadata": {}, + "response_format": "auto" + } + } + }, + "operationId": "GetAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json new file mode 100644 index 000000000000..af3ab4586d76 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json @@ -0,0 +1,23 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json new file mode 100644 index 000000000000..4b5fec6d67f7 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json @@ -0,0 +1,14 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": "file content" + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json new file mode 100644 index 000000000000..03af4b1a4ebe --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -0,0 +1,38 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "attachments": [], + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json new file mode 100644 index 000000000000..2895df4dce16 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -0,0 +1,42 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "incomplete_details": null, + "usage": null, + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto", + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json new file mode 100644 index 000000000000..556262ddc1a4 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json @@ -0,0 +1,42 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + } + }, + "operationId": "GetRunStep" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json new file mode 100644 index 000000000000..8d95c82cfe2d --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json @@ -0,0 +1,24 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {}, + "tool_resources": { + "code_interpreter": { + "file_ids": [] + } + } + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json new file mode 100644 index 000000000000..a8cc51d89802 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "GetVectorStore" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json new file mode 100644 index 000000000000..2f351de142b6 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json @@ -0,0 +1,23 @@ +{ + "title": "Retrieves a vector store file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "fileId": "file-abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 123456, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + }, + "operationId": "GetVectorStoreFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json new file mode 100644 index 000000000000..18f0a0f0a385 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "title": "Retrieves a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } + }, + "operationId": "GetVectorStoreFileBatch" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json new file mode 100644 index 000000000000..2e2a78969007 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json @@ -0,0 +1,71 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc456", + "object": "assistant", + "created_at": 1698982718, + "name": "My Assistant", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant designed to make me better at coding!", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc789", + "object": "assistant", + "created_at": 1698982643, + "name": null, + "description": null, + "model": "gpt-4-turbo", + "instructions": "", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + ], + "first_id": "asst_abc123", + "last_id": "asst_abc789", + "has_more": false + } + } + }, + "operationId": "ListAssistants" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json new file mode 100644 index 000000000000..a8c406924328 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json @@ -0,0 +1,38 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] + } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json new file mode 100644 index 000000000000..4813900797ae --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -0,0 +1,69 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + }, + { + "id": "msg_abc456", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "Hello, what is AI?", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + } + ], + "first_id": "msg_abc123", + "last_id": "msg_abc456", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json new file mode 100644 index 000000000000..e57f889c9165 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json @@ -0,0 +1,49 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "run_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json new file mode 100644 index 000000000000..e80a557e64c1 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -0,0 +1,97 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + }, + { + "id": "run_abc456", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + ], + "first_id": "run_abc123", + "last_id": "run_abc456", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json new file mode 100644 index 000000000000..be54b92a08b5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json @@ -0,0 +1,40 @@ +{ + "title": "Returns a list of vector store files of a given batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "batch-abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFileBatchFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json new file mode 100644 index 000000000000..e6406462f735 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json @@ -0,0 +1,39 @@ +{ + "title": "Returns a list of vector store files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json new file mode 100644 index 000000000000..df84331efbac --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json @@ -0,0 +1,54 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "in_progress", + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + }, + "last_active_at": 1699061776, + "metadata": {} + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "usage_bytes": 139920, + "status": "in_progress", + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + }, + "last_active_at": 1699061776, + "metadata": {} + } + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStores" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json new file mode 100644 index 000000000000..935bdadbd7d2 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json @@ -0,0 +1,33 @@ +{ + "title": "Modifies a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "ModifyVectorStore" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..cd810dd4169a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -0,0 +1,79 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_123", + "runId": "run_123", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_001", + "output": "70 degrees and sunny." + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_123", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_123", + "thread_id": "thread_123", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "tools": [ + { + "type": "function", + "function": { + "name": "get_current_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "celsius", + "fahrenheit" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "incomplete_details": null, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json new file mode 100644 index 000000000000..c0e7fc6ee699 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json @@ -0,0 +1,45 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_abc123", + "body": { + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "model": "gpt-4-turbo" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [] + } + }, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json new file mode 100644 index 000000000000..7621cc8605c7 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -0,0 +1,47 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "messageId": "msg_abc123 ", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "status": "complete", + "incomplete_details": null, + "completed_at": 1699017614, + "incomplete_at": null, + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json new file mode 100644 index 000000000000..709ed437a3ce --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -0,0 +1,59 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "run_abc123", + "body": { + "metadata": { + "user_id": "user_abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": { + "user_id": "user_abc123" + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "UpdateRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json new file mode 100644 index 000000000000..e7610f8ec4cf --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json @@ -0,0 +1,29 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + }, + "tool_resources": {} + } + } + }, + "operationId": "UpdateThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json new file mode 100644 index 000000000000..933d5d59974e --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json @@ -0,0 +1,30 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/OpenAI.Assistants/messages/models.tsp b/specification/ai/OpenAI.Assistants/messages/models.tsp index 118cdf5a0d73..3f59eaed0f3c 100644 --- a/specification/ai/OpenAI.Assistants/messages/models.tsp +++ b/specification/ai/OpenAI.Assistants/messages/models.tsp @@ -8,7 +8,7 @@ namespace Azure.AI.OpenAI.Assistants; using TypeSpec.Versioning; /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ -@added(ServiceApiVersions.v2024_05_01_preview) +@added(ServiceApiVersions.v2024_02_15_preview) model ThreadMessageOptions { /** * The role of the entity that is creating the message. Allowed values include: @@ -25,6 +25,7 @@ model ThreadMessageOptions { /** A list of files attached to the message, and the tools they should be added to. */ #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) attachments?: MessageAttachment[] | null; ...OptionalNullableMetadata; diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp index 9d8b27ad11f1..181f50433021 100644 --- a/specification/ai/OpenAI.Assistants/messages/routes.tsp +++ b/specification/ai/OpenAI.Assistants/messages/routes.tsp @@ -32,9 +32,7 @@ op createMessage( @path threadId: string, /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ - @added(ServiceApiVersions.v2024_05_01_preview) - @body - threadMessageOptions: ThreadMessageOptions, + ...BodyParameter, ): ThreadMessage; /** diff --git a/specification/ai/OpenAI.Assistants/runs/routes.tsp b/specification/ai/OpenAI.Assistants/runs/routes.tsp index 45847257a2e7..6d2d3ed7eab8 100644 --- a/specification/ai/OpenAI.Assistants/runs/routes.tsp +++ b/specification/ai/OpenAI.Assistants/runs/routes.tsp @@ -28,10 +28,7 @@ namespace Azure.AI.OpenAI.Assistants; @route("/threads/{threadId}/runs") @doc("Creates a new run for an assistant thread.") @added(ServiceApiVersions.v2024_02_15_preview) -op createRun( - @path threadId: string, - @bodyRoot createRunOptions: CreateRunOptions, -): ThreadRun; +op createRun(@path threadId: string, ...CreateRunOptions): ThreadRun; /** * Gets a list of runs for a specified thread. diff --git a/specification/ai/OpenAI.Assistants/tspconfig.yaml b/specification/ai/OpenAI.Assistants/tspconfig.yaml index 564b8e16d05f..75c925ce08fa 100644 --- a/specification/ai/OpenAI.Assistants/tspconfig.yaml +++ b/specification/ai/OpenAI.Assistants/tspconfig.yaml @@ -3,25 +3,25 @@ parameters: default: "sdk/openai" "dependencies": default: "" + output-folder-base: + default: "data-plane/OpenAI.Assistants/" emit: - "@azure-tools/typespec-autorest" - "@typespec/openapi3" -# - "@azure-tools/typespec-java" -# - "@azure-tools/typespec-csharp" linter: extends: - "@azure-tools/typespec-azure-rulesets/data-plane" options: "@azure-tools/typespec-autorest": - azure-resource-provider-folder: "data-plane" - emit-lro-options: "none" emitter-output-dir: "{project-root}/../" - output-file: "data-plane/OpenAI.Assistants/OpenApiV2/{version-status}/{version}/assistants_generated.json" + azure-resource-provider-folder: "data-plane" examples-directory: "{project-root}/examples" + output-file: "{output-folder-base}/OpenApiV2/{version-status}/{version}/assistants_generated.json" omit-unreachable-types: true + emit-lro-options: "none" "@typespec/openapi3": emitter-output-dir: "{project-root}/../" - output-file: "data-plane/OpenAI.Assistants/OpenApiV3/{version}/assistants_generated.yaml" + output-file: "{output-folder-base}/OpenApiV3/{version}/assistants_generated.yaml" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.OpenAI.Assistants" namespace: "Azure.AI.OpenAI.Assistants" diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json deleted file mode 100644 index 436e3f654419..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json +++ /dev/null @@ -1,3452 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure OpenAI", - "version": "2023-02-15-preview", - "description": "Azure OpenAI APIs for Assistants.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "description": "An OpenAI endpoint supporting assistants functionality.", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "ApiKeyAuth": [] - }, - { - "OAuth2Auth": [ - "https://cognitiveservices.azure.com/.default" - ] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "api-key", - "in": "header" - }, - "OAuth2Auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://cognitiveservices.azure.com/.default": "" - } - } - }, - "tags": [], - "paths": { - "/assistants": { - "get": { - "operationId": "ListAssistants", - "description": "Gets a list of assistants that were previously created.", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of assistants.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/Assistant" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistant", - "description": "Creates a new assistant.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "The new assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - } - }, - "/assistants/{assistantId}": { - "get": { - "operationId": "GetAssistant", - "description": "Retrieves an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "post": { - "operationId": "ModifyAssistant", - "description": "Modifies an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to modify.", - "required": true, - "type": "string" - }, - { - "name": "modificationOptions", - "in": "body", - "description": "The details of the modification to perform on the specified assistant.", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantModificationOptions" - } - } - ], - "responses": { - "200": { - "description": "The updated assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistant", - "description": "Deletes an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested deletion operation.", - "schema": { - "$ref": "#/definitions/AssistantDeletionStatus" - } - } - } - } - }, - "/assistants/{assistantId}/files": { - "get": { - "operationId": "ListAssistantFiles", - "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve the list of attached files for.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files attached to the specified assistant.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/AssistantFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistantFile", - "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to attach the file to.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the previously uploaded file to attach.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - } - }, - "/assistants/{assistantId}/files/{fileId}": { - "get": { - "operationId": "GetAssistantFile", - "description": "Retrieves a file attached to an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant associated with the attached file.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistantFile", - "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant from which the specified file should be unlinked.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to unlink from the specified assistant.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested file association deletion.", - "schema": { - "$ref": "#/definitions/AssistantFileDeletionStatus" - } - } - } - } - }, - "/files": { - "get": { - "operationId": "ListFiles", - "description": "Gets a list of previously uploaded files.", - "parameters": [ - { - "name": "purpose", - "in": "query", - "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", - "required": false, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - } - ], - "responses": { - "200": { - "description": "The requested list of files.", - "schema": { - "$ref": "#/definitions/FileListResponse" - } - } - } - }, - "post": { - "operationId": "CreateFile", - "description": "Uploads a file for use by other operations.", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "name": "file", - "in": "formData", - "description": "The file data (not filename) to upload.", - "required": true, - "type": "file" - }, - { - "name": "purpose", - "in": "formData", - "description": "The intended purpose of the file.", - "required": true, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - { - "name": "filename", - "in": "formData", - "description": "A filename to associate with the uploaded data.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the uploaded file.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - } - }, - "/files/{fileId}": { - "get": { - "operationId": "RetrieveFile", - "description": "Returns information about a specific file. Does not retrieve file content.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - }, - "delete": { - "operationId": "DeleteFile", - "description": "Delete a previously uploaded file.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/FileDeletionStatus" - } - } - } - } - }, - "/threads": { - "post": { - "operationId": "CreateThread", - "description": "Creates a new thread. Threads contain messages and can be run by assistants.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantThreadCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - } - }, - "/threads/{threadId}": { - "get": { - "operationId": "GetThread", - "description": "Gets information about an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "post": { - "operationId": "ModifyThread", - "description": "Modifies an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "delete": { - "operationId": "DeleteThread", - "description": "Deletes an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested thread deletion operation.", - "schema": { - "$ref": "#/definitions/ThreadDeletionStatus" - } - } - } - } - }, - "/threads/{threadId}/messages": { - "get": { - "operationId": "ListMessages", - "description": "Gets a list of messages that exist on a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list messages from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of messages.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateMessage", - "description": "Creates a new message on a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to create the new message on.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role to associate with the new message." - }, - "content": { - "type": "string", - "description": "The textual content for the new message." - }, - "file_ids": { - "type": "array", - "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "role", - "content" - ] - } - } - ], - "responses": { - "200": { - "description": "A representation of the new message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}": { - "get": { - "operationId": "GetMessage", - "description": "Gets an existing message from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve the specified message from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to retrieve from the specified thread.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the requested message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - }, - "post": { - "operationId": "ModifyMessage", - "description": "Modifies an existing message on an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the specified message to modify.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to modify on the specified thread.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "A representation of the modified message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files": { - "get": { - "operationId": "ListMessageFiles", - "description": "Gets a list of previously uploaded files associated with a message from a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files associated with the specified message.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/MessageFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files/{fileId}": { - "get": { - "operationId": "GetMessageFile", - "description": "Gets information about a file attachment to a message within a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to get information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested file information.", - "schema": { - "$ref": "#/definitions/MessageFile" - } - } - } - } - }, - "/threads/{threadId}/runs": { - "get": { - "operationId": "ListRuns", - "description": "Gets a list of runs for a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list runs from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of thread runs.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadRun" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateRun", - "description": "Creates a new run for an assistant thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to run.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant that should run the thread.", - "x-ms-client-name": "assistantId" - }, - "model": { - "type": "string", - "description": "The overridden model name that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions that the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools that the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the new thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}": { - "get": { - "operationId": "GetRun", - "description": "Gets an existing run from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve run information from.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested information about the specified thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - }, - "post": { - "operationId": "ModifyRun", - "description": "Modifies an existing thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread associated with the specified run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/cancel": { - "post": { - "operationId": "CancelRun", - "description": "Cancels a run of an in progress thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread being run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to cancel.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Updated information about the cancelled run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps": { - "get": { - "operationId": "ListRunSteps", - "description": "Gets a list of run steps from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to list steps from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of run steps.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/RunStep" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps/{stepId}": { - "get": { - "operationId": "GetRunStep", - "description": "Gets a single run step from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the specific run to retrieve the step from.", - "required": true, - "type": "string" - }, - { - "name": "stepId", - "in": "path", - "description": "The ID of the step to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested run step.", - "schema": { - "$ref": "#/definitions/RunStep" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { - "post": { - "operationId": "SubmitToolOutputsToRun", - "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run that requires tool outputs.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "tool_outputs": { - "type": "array", - "description": "The list of tool outputs requested by tool calls from the specified run.", - "items": { - "$ref": "#/definitions/ToolOutput" - }, - "x-ms-client-name": "toolOutputs", - "x-ms-identifiers": [] - } - }, - "required": [ - "tool_outputs" - ] - } - } - ], - "responses": { - "200": { - "description": "Updated information about the run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/runs": { - "post": { - "operationId": "CreateThreadAndRun", - "description": "Creates a new assistant thread and immediately starts a run using that new thread.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateAndRunThreadOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - } - }, - "definitions": { - "Assistant": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always assistant.", - "enum": [ - "assistant" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "name": { - "type": "string", - "description": "The name of the assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the assistant.", - "x-nullable": true - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The system instructions for the assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools enabled for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "name", - "description", - "model", - "instructions", - "tools", - "file_ids", - "metadata" - ] - }, - "AssistantCreationOptions": { - "type": "object", - "description": "The request details to use when creating a new assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The name of the new assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the new assistant.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools to enable for the new assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of previously uploaded file IDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "model" - ] - }, - "AssistantDeletionStatus": { - "type": "object", - "description": "The status of an assistant deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.deleted'.", - "enum": [ - "assistant.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantFile": { - "type": "object", - "description": "Information about a file attached to an assistant, as used by tools that can read files.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file'.", - "enum": [ - "assistant.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "assistant_id": { - "type": "string", - "description": "The assistant ID that the file is attached to.", - "x-ms-client-name": "assistantId" - } - }, - "required": [ - "id", - "object", - "created_at", - "assistant_id" - ] - }, - "AssistantFileDeletionStatus": { - "type": "object", - "description": "The status of an assistant file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file.deleted'.", - "enum": [ - "assistant.file.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantModificationOptions": { - "type": "object", - "description": "The request details to use when modifying an existing assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The modified name for the assistant to use.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The modified description for the assistant to use.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The modified system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The modified collection of tools to enable for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "AssistantThread": { - "type": "object", - "description": "Information about a single thread associated with an assistant.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread'.", - "enum": [ - "thread" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "metadata" - ] - }, - "AssistantThreadCreationOptions": { - "type": "object", - "description": "The details used to create a new assistant thread.", - "properties": { - "messages": { - "type": "array", - "description": "The messages to associate with the new thread.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "CodeInterpreterImageOutput": { - "type": "object", - "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "image": { - "$ref": "#/definitions/CodeInterpreterImageReference", - "description": "Referential information for the image associated with this output." - } - }, - "required": [ - "image" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "image" - }, - "CodeInterpreterImageReference": { - "type": "object", - "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "CodeInterpreterLogOutput": { - "type": "object", - "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "logs": { - "type": "string", - "description": "The serialized log output emitted by the code interpreter." - } - }, - "required": [ - "logs" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "logs" - }, - "CodeInterpreterToolCall": { - "type": "object", - "description": "A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that\nrepresents submitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "code_interpreter": { - "$ref": "#/definitions/CodeInterpreterToolCallDetails", - "description": "The details of the tool call to the code interpreter tool.", - "x-ms-client-name": "codeInterpreter" - } - }, - "required": [ - "code_interpreter" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CodeInterpreterToolCallDetails": { - "type": "object", - "description": "The detailed information about a code interpreter invocation by the model.", - "properties": { - "input": { - "type": "string", - "description": "The input provided by the model to the code interpreter tool." - }, - "outputs": { - "type": "array", - "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", - "items": { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "input", - "outputs" - ] - }, - "CodeInterpreterToolCallOutput": { - "type": "object", - "description": "An abstract representation of an emitted output from a code interpreter tool.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "CodeInterpreterToolDefinition": { - "type": "object", - "description": "The input definition information for a code interpreter tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CreateAndRunThreadOptions": { - "type": "object", - "description": "The details used when creating and immediately running a new assistant thread.", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant for which the thread should be created.", - "x-ms-client-name": "assistantId" - }, - "thread": { - "$ref": "#/definitions/AssistantThreadCreationOptions", - "description": "The details used to create the new thread." - }, - "model": { - "type": "string", - "description": "The overridden model that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - }, - "FileDeletionStatus": { - "type": "object", - "description": "A status response from a file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "FileListResponse": { - "type": "object", - "description": "The response data from a file list operation.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'list'.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The files returned for the request.", - "items": { - "$ref": "#/definitions/OpenAIFile" - } - } - }, - "required": [ - "object", - "data" - ] - }, - "FilePurpose": { - "type": "string", - "description": "The possible values denoting the intended usage of a file.", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - "FunctionDefinition": { - "type": "object", - "description": "The input definition information for a function.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function to be called." - }, - "description": { - "type": "string", - "description": "A description of what the function does, used by the model to choose when and how to call the function." - }, - "parameters": { - "description": "The parameters the functions accepts, described as a JSON Schema object." - } - }, - "required": [ - "name", - "parameters" - ] - }, - "FunctionToolCall": { - "type": "object", - "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\ngiven function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionToolCallDetails", - "description": "The detailed information about the function called by the model." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "function" - }, - "FunctionToolCallDetails": { - "type": "object", - "description": "The detailed information about the function called by the model.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function." - }, - "arguments": { - "type": "string", - "description": "The arguments that the model requires are provided to the named function." - }, - "output": { - "type": "string", - "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", - "x-nullable": true - } - }, - "required": [ - "name", - "arguments", - "output" - ] - }, - "FunctionToolDefinition": { - "type": "object", - "description": "The input definition information for a function tool as used to configure an assistant.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionDefinition", - "description": "The definition of the concrete function that the function tool should call." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "function" - }, - "MessageContent": { - "type": "object", - "description": "An abstract representation of a single item of thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "MessageFile": { - "type": "object", - "description": "Information about a file attached to an assistant thread message.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message.file'.", - "enum": [ - "thread.message.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "message_id": { - "type": "string", - "description": "The ID of the message that this file is attached to.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "id", - "object", - "created_at", - "message_id" - ] - }, - "MessageFileCitationTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.", - "properties": { - "file_citation": { - "$ref": "#/definitions/MessageTextFileCitationDetails", - "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", - "x-ms-client-name": "fileCitation" - } - }, - "required": [ - "file_citation" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_citation" - }, - "MessageFilePathDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific file that the citation is from.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageFilePathTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a file located at a specific path.", - "properties": { - "file_path": { - "$ref": "#/definitions/MessageFilePathDetails", - "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", - "x-ms-client-name": "filePath" - } - }, - "required": [ - "file_path" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_path" - }, - "MessageImageFileContent": { - "type": "object", - "description": "A representation of image file content in a thread message.", - "properties": { - "image_file": { - "$ref": "#/definitions/MessageImageFileDetails", - "description": "The image file for this thread message content item.", - "x-ms-client-name": "imageFile" - } - }, - "required": [ - "image_file" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "image_file" - }, - "MessageImageFileDetails": { - "type": "object", - "description": "An image reference, as represented in thread message content.", - "properties": { - "file_id": { - "$ref": "#/definitions/MessageImageFileIdDetails", - "description": "The ID for the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageImageFileIdDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific image file.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageRole": { - "type": "string", - "description": "The possible values for roles attributed to messages in a thread.", - "enum": [ - "user", - "assistant" - ], - "x-ms-enum": { - "name": "MessageRole", - "modelAsString": true, - "values": [ - { - "name": "user", - "value": "user", - "description": "The role representing the end-user." - }, - { - "name": "assistant", - "value": "assistant", - "description": "The role representing the assistant." - } - ] - } - }, - "MessageTextAnnotation": { - "type": "object", - "description": "An abstract representation of an annotation to text thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "text": { - "type": "string", - "description": "The textual content associated with this text annotation item." - }, - "start_index": { - "type": "integer", - "format": "int32", - "description": "The first text index associated with this text annotation.", - "x-ms-client-name": "startIndex" - }, - "end_index": { - "type": "integer", - "format": "int32", - "description": "The last text index associated with this text annotation.", - "x-ms-client-name": "endIndex" - } - }, - "discriminator": "type", - "required": [ - "type", - "text", - "start_index", - "end_index" - ] - }, - "MessageTextContent": { - "type": "object", - "description": "A representation of a textual item of thread message content.", - "properties": { - "text": { - "$ref": "#/definitions/MessageTextDetails", - "description": "The text and associated annotations for this thread message content item." - } - }, - "required": [ - "text" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "text" - }, - "MessageTextDetails": { - "type": "object", - "description": "The text and associated annotations for a single item of assistant thread message content.", - "properties": { - "value": { - "type": "string", - "description": "The text data." - }, - "annotations": { - "type": "array", - "description": "A list of annotations associated with this text.", - "items": { - "$ref": "#/definitions/MessageTextAnnotation" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "value", - "annotations" - ] - }, - "MessageTextFileCitationDetails": { - "type": "object", - "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this citation.", - "x-ms-client-name": "fileId" - }, - "quote": { - "type": "string", - "description": "The specific quote cited in the associated file." - } - }, - "required": [ - "file_id", - "quote" - ] - }, - "OpenAIFile": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "bytes": { - "type": "integer", - "format": "int32", - "description": "The size of the file, in bytes." - }, - "filename": { - "type": "string", - "description": "The name of the file." - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "purpose": { - "$ref": "#/definitions/FilePurpose", - "description": "The intended purpose of a file." - } - }, - "required": [ - "object", - "id", - "bytes", - "filename", - "created_at", - "purpose" - ] - }, - "RequiredAction": { - "type": "object", - "description": "An abstract representation of a required action for an assistant thread run to continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RetrievalToolCall": { - "type": "object", - "description": "A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents\nsubmitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "retrieval": { - "type": "object", - "description": "The key/value pairs produced by the retrieval tool.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "retrieval" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RetrievalToolDefinition": { - "type": "object", - "description": "The input definition information for a retrieval tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RunError": { - "type": "object", - "description": "The details of an error as encountered by an assistant thread run.", - "properties": { - "code": { - "type": "string", - "description": "The status for the error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStatus": { - "type": "string", - "description": "Possible values for the status of an assistant thread run.", - "enum": [ - "queued", - "in_progress", - "requires_action", - "cancelling", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStatus", - "modelAsString": true, - "values": [ - { - "name": "queued", - "value": "queued", - "description": "Represents a run that is queued to start." - }, - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run that is in progress." - }, - { - "name": "requiresAction", - "value": "requires_action", - "description": "Represents a run that needs another operation, such as tool output submission, to continue." - }, - { - "name": "cancelling", - "value": "cancelling", - "description": "Represents a run that is in the process of cancellation." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run that has been cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run that expired before it could otherwise finish." - } - ] - } - }, - "RunStep": { - "type": "object", - "description": "Detailed information about a single step of an assistant thread run.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run.step'.", - "enum": [ - "thread.run.step" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The type of run step, which can be either message_creation or tool_calls." - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the run step.", - "x-ms-client-name": "assistantId" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that was run.", - "x-ms-client-name": "threadId" - }, - "run_id": { - "type": "string", - "description": "The ID of the run that this run step is a part of.", - "x-ms-client-name": "runId" - }, - "status": { - "$ref": "#/definitions/RunStepStatus", - "description": "The status of this run step." - }, - "step_details": { - "$ref": "#/definitions/RunStepDetails", - "description": "The details for this run step.", - "x-ms-client-name": "stepDetails" - }, - "last_error": { - "type": "object", - "description": "If applicable, information about the last error encountered by this run step.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunStepError" - } - ], - "x-ms-client-name": "lastError" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expired_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expired.", - "x-nullable": true, - "x-ms-client-name": "expiredAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "type", - "assistant_id", - "thread_id", - "run_id", - "status", - "step_details", - "last_error", - "created_at", - "expired_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "RunStepDetails": { - "type": "object", - "description": "An abstract representation of the details for a run step.", - "properties": { - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RunStepError": { - "type": "object", - "description": "The error information associated with a failed run step.", - "properties": { - "code": { - "$ref": "#/definitions/RunStepErrorCode", - "description": "The error code for this error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with this error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStepErrorCode": { - "type": "string", - "description": "Possible error code values attributable to a failed run step.", - "enum": [ - "server_error", - "rate_limit_exceeded" - ], - "x-ms-enum": { - "name": "RunStepErrorCode", - "modelAsString": true, - "values": [ - { - "name": "serverError", - "value": "server_error", - "description": "Represents a server error." - }, - { - "name": "rateLimitExceeded", - "value": "rate_limit_exceeded", - "description": "Represents an error indicating configured rate limits were exceeded." - } - ] - } - }, - "RunStepMessageCreationDetails": { - "type": "object", - "description": "The detailed information associated with a message creation run step.", - "properties": { - "message_creation": { - "$ref": "#/definitions/RunStepMessageCreationReference", - "description": "Information about the message creation associated with this run step.", - "x-ms-client-name": "messageCreation" - } - }, - "required": [ - "message_creation" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "message_creation" - }, - "RunStepMessageCreationReference": { - "type": "object", - "description": "The details of a message created as a part of a run step.", - "properties": { - "message_id": { - "type": "string", - "description": "The ID of the message created by this run step.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "message_id" - ] - }, - "RunStepStatus": { - "type": "string", - "description": "Possible values for the status of a run step.", - "enum": [ - "in_progress", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStepStatus", - "modelAsString": true, - "values": [ - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run step still in progress." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run step that was cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run step that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run step that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run step that expired before otherwise finishing." - } - ] - } - }, - "RunStepToolCallDetails": { - "type": "object", - "description": "The detailed information associated with a run step calling tools.", - "properties": { - "tool_calls": { - "type": "array", - "description": "A list tool call details for this run step.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "tool_calls" - }, - "RunStepType": { - "type": "string", - "description": "The possible types of run steps.", - "enum": [ - "message_creation", - "tool_calls" - ], - "x-ms-enum": { - "name": "RunStepType", - "modelAsString": true, - "values": [ - { - "name": "messageCreation", - "value": "message_creation", - "description": "Represents a run step to create a message." - }, - { - "name": "toolCalls", - "value": "tool_calls", - "description": "Represents a run step that calls tools." - } - ] - } - }, - "SubmitToolOutputsAction": { - "type": "object", - "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", - "properties": { - "submit_tool_outputs": { - "$ref": "#/definitions/SubmitToolOutputsDetails", - "description": "The details describing tools that should be called to submit tool outputs.", - "x-ms-client-name": "submitToolOutputs" - } - }, - "required": [ - "submit_tool_outputs" - ], - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-discriminator-value": "submit_tool_outputs" - }, - "SubmitToolOutputsDetails": { - "type": "object", - "description": "The details describing tools that should be called to submit tool outputs.", - "properties": { - "tool_calls": { - "type": "array", - "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ] - }, - "ThreadDeletionStatus": { - "type": "object", - "description": "The status of a thread deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.deleted'.", - "enum": [ - "thread.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "ThreadMessage": { - "type": "object", - "description": "A single message within an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message'.", - "enum": [ - "thread.message" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that this message belongs to.", - "x-ms-client-name": "threadId" - }, - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role associated with the assistant thread message." - }, - "content": { - "type": "array", - "description": "The list of content items associated with the assistant thread message.", - "items": { - "$ref": "#/definitions/MessageContent" - }, - "x-ms-identifiers": [] - }, - "assistant_id": { - "type": "string", - "description": "If applicable, the ID of the assistant that authored this message.", - "x-ms-client-name": "assistantId" - }, - "run_id": { - "type": "string", - "description": "If applicable, the ID of the run associated with the authoring of this message.", - "x-ms-client-name": "runId" - }, - "file_ids": { - "type": "array", - "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "thread_id", - "role", - "content", - "file_ids", - "metadata" - ] - }, - "ThreadRun": { - "type": "object", - "description": "Data representing a single evaluation run of an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run'.", - "enum": [ - "thread.run" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread associated with this run.", - "x-ms-client-name": "threadId" - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the thread this run was performed against.", - "x-ms-client-name": "assistantId" - }, - "status": { - "$ref": "#/definitions/RunStatus", - "description": "The status of the assistant thread run." - }, - "required_action": { - "type": "object", - "description": "The details of the action required for the assistant thread run to continue.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-client-name": "requiredAction" - }, - "last_error": { - "type": "object", - "description": "The last error, if any, encountered by this assistant thread run.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunError" - } - ], - "x-ms-client-name": "lastError" - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions used for this assistant thread run." - }, - "tools": { - "type": "array", - "description": "The overridden enabled tools used for this assistant thread run.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expires.", - "x-nullable": true, - "x-ms-client-name": "expiresAt" - }, - "started_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item was started.", - "x-nullable": true, - "x-ms-client-name": "startedAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "thread_id", - "assistant_id", - "status", - "last_error", - "model", - "instructions", - "tools", - "file_ids", - "created_at", - "expires_at", - "started_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "ToolCall": { - "type": "object", - "description": "An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must\nbe fulfilled and have its outputs submitted before the model can continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "id": { - "type": "string", - "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." - } - }, - "discriminator": "type", - "required": [ - "type", - "id" - ] - }, - "ToolDefinition": { - "type": "object", - "description": "An abstract representation of an input tool definition that an assistant can use.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "ToolOutput": { - "type": "object", - "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", - "properties": { - "tool_call_id": { - "type": "string", - "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", - "x-ms-client-name": "toolCallId" - }, - "output": { - "type": "string", - "description": "The output from the tool to be submitted." - } - } - } - }, - "parameters": {} -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 6e871cf81b9c..df03da8c2ff9 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -165,6 +165,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of assistants.": { + "$ref": "./examples/list_assistants.json" + } } }, "post": { @@ -188,6 +193,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Create an assistant with a model and instructions.": { + "$ref": "./examples/create_assistant.json" + } } } }, @@ -211,6 +221,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/get_assistant.json" + } } }, "post": { @@ -241,6 +256,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/update_assistant.json" + } } }, "delete": { @@ -262,6 +282,11 @@ "$ref": "#/definitions/AssistantDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes an assistant.": { + "$ref": "./examples/delete_assistant.json" + } } } }, @@ -317,6 +342,11 @@ "$ref": "#/definitions/FileListResponse" } } + }, + "x-ms-examples": { + "Returns a list of files filtered by purpose": { + "$ref": "./examples/list_file.json" + } } }, "post": { @@ -387,6 +417,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Uploads a file": { + "$ref": "./examples/upload_file.json" + } } } }, @@ -410,6 +445,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Returns a file": { + "$ref": "./examples/get_file.json" + } } }, "delete": { @@ -431,6 +471,11 @@ "$ref": "#/definitions/FileDeletionStatus" } } + }, + "x-ms-examples": { + "Delete a previously uploaded file.": { + "$ref": "./examples/delete_file.json" + } } } }, @@ -455,6 +500,11 @@ "format": "byte" } } + }, + "x-ms-examples": { + "Returns the content of a file": { + "$ref": "./examples/get_file_content.json" + } } } }, @@ -480,6 +530,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Creates a thread.": { + "$ref": "./examples/create_thread.json" + } } } }, @@ -503,6 +558,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Retrieves a thread.": { + "$ref": "./examples/get_thread.json" + } } }, "post": { @@ -533,6 +593,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Modifies a thread.": { + "$ref": "./examples/update_thread.json" + } } }, "delete": { @@ -554,6 +619,11 @@ "$ref": "#/definitions/ThreadDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes a thread.": { + "$ref": "./examples/delete_thread.json" + } } } }, @@ -670,6 +740,11 @@ ] } } + }, + "x-ms-examples": { + "List Messages": { + "$ref": "./examples/list_messages.json" + } } }, "post": { @@ -682,6 +757,15 @@ "description": "The ID of the thread to create the new message on.", "required": true, "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Body parameter.", + "required": true, + "schema": { + "$ref": "#/definitions/ThreadMessageOptions" + } } ], "responses": { @@ -691,6 +775,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } } } }, @@ -721,6 +810,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } } }, "post": { @@ -767,6 +861,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/update_message.json" + } } } }, @@ -883,6 +982,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of runs belonging to a thread.": { + "$ref": "./examples/list_runs.json" + } } }, "post": { @@ -897,9 +1001,8 @@ "type": "string" }, { - "name": "createRunOptions", + "name": "body", "in": "body", - "description": "The details for the run to create.", "required": true, "schema": { "$ref": "#/definitions/CreateRunOptions" @@ -913,6 +1016,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } } } }, @@ -943,6 +1051,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Gets a run.": { + "$ref": "./examples/get_run.json" + } } }, "post": { @@ -989,6 +1102,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Modifies a run.": { + "$ref": "./examples/update_run.json" + } } } }, @@ -1019,6 +1137,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Cancels a run that is `in_progress`.\n": { + "$ref": "./examples/cancel_run.json" + } } } }, @@ -1142,6 +1265,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of run steps belonging to a run.": { + "$ref": "./examples/list_run_steps.json" + } } } }, @@ -1179,6 +1307,11 @@ "$ref": "#/definitions/RunStep" } } + }, + "x-ms-examples": { + "Retrieves a run step.": { + "$ref": "./examples/get_run_step.json" + } } } }, @@ -1236,6 +1369,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } } } }, @@ -1261,6 +1399,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a thread and run it in one request.": { + "$ref": "./examples/create_thread_and_run.json" + } } } } @@ -2950,6 +3093,32 @@ "metadata" ] }, + "ThreadMessageOptions": { + "type": "object", + "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", + "properties": { + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role of the entity that is creating the message. Allowed values include:\n- `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n- `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into\nthe conversation." + }, + "content": { + "type": "string", + "description": "The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via\na separate call to the create message API." + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "role", + "content" + ] + }, "ThreadRun": { "type": "object", "description": "Data representing a single evaluation run of an assistant thread.", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json new file mode 100644 index 000000000000..5317d558935b --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -0,0 +1,38 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_BUf53eW0aua3EjHTyO3P3evb", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106", + "instructions": "You solve math problems.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "incomplete_details": null, + "metadata": {}, + "usage": null + } + } + }, + "operationId": "CancelRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json new file mode 100644 index 000000000000..5a9981a936b5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json @@ -0,0 +1,37 @@ +{ + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + } + }, + "operationId": "CreateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json new file mode 100644 index 000000000000..c0318a2f3364 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json @@ -0,0 +1,40 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json new file mode 100644 index 000000000000..b516adecefd2 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -0,0 +1,36 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "body": { + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + } + }, + "responses": { + "200": { + "body": { + "id": "run_dmC5IgLBfaK8gBy0FKIXGtpr", + "object": "thread.run", + "created_at": 1707301142, + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "status": "queued", + "incomplete_details": null, + "usage": null, + "started_at": null, + "expires_at": 1707301742, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "metadata": {} + } + } + }, + "operationId": "CreateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json new file mode 100644 index 000000000000..9b2b9a3a463c --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json @@ -0,0 +1,19 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..2babffbce6d5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -0,0 +1,35 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "assistant_id": "{{assistants.id}}" + } + }, + "responses": { + "200": { + "body": { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "queued", + "started_at": null, + "expires_at": 1707300852, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "usage": null, + "incomplete_details": null, + "metadata": {} + } + } + }, + "operationId": "CreateThreadAndRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..f300dfb2ad72 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json new file mode 100644 index 000000000000..7d89fe77f52f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json new file mode 100644 index 000000000000..e14eac104c85 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json new file mode 100644 index 000000000000..09fa93da8abc --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json @@ -0,0 +1,28 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + } + }, + "operationId": "GetAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json new file mode 100644 index 000000000000..c0a99d1b7a24 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json @@ -0,0 +1,21 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json new file mode 100644 index 000000000000..9f05e09e75d2 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": "file content" + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json new file mode 100644 index 000000000000..20fd1c2f15c2 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json @@ -0,0 +1,37 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json new file mode 100644 index 000000000000..6dab7987a07e --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -0,0 +1,34 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "incomplete_details": null, + "usage": null, + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json new file mode 100644 index 000000000000..5f74b0d0067a --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json @@ -0,0 +1,42 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + } + }, + "operationId": "GetRunStep" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json new file mode 100644 index 000000000000..b2c902c476aa --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json new file mode 100644 index 000000000000..56f32fa4007a --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json @@ -0,0 +1,52 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + }, + { + "id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "object": "assistant", + "created_at": 1707249683, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a personal math tutor. Answer questions briefly, in a sentence or less.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + ], + "first_id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "last_id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "has_more": false + } + } + }, + "operationId": "ListAssistants" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json new file mode 100644 index 000000000000..39b31a4aa1b6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json @@ -0,0 +1,34 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043 + } + ] + } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json new file mode 100644 index 000000000000..20f01a6fda3f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json @@ -0,0 +1,67 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "object": "thread.message", + "created_at": 1707298439, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "assistant", + "content": [ + { + "type": "text", + "text": { + "value": "The cube root of the sum of the given numbers, rounded to the nearest integer, is 12345.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", + "run_id": "run_35BhBv0Ry4vVgjF0vO36Ajzf", + "metadata": {} + }, + { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + ], + "first_id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "last_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..7378eddd2de5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json @@ -0,0 +1,49 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json new file mode 100644 index 000000000000..c044c0365b3f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -0,0 +1,45 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_7CJfaYBtuRIOSksocRrYNQGV" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "completed", + "started_at": 1707300255, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707300267, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "incomplete_details": null, + "usage": { + "completion_tokens": 1, + "prompt_tokens": 999, + "total_tokens": 1000 + }, + "metadata": {} + } + ], + "first_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "last_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..ff1009e9c1fc --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,69 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_abc123", + "output": "28C" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_abc123", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4", + "instructions": "You tell the weather.", + "incomplete_details": null, + "tools": [ + { + "type": "function", + "function": { + "name": "get_weather", + "description": "Determine weather in my location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "c", + "f" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json new file mode 100644 index 000000000000..f0fb253c5f64 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json @@ -0,0 +1,31 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "body": { + "name": "Math Tutor Improved" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor Improved", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json new file mode 100644 index 000000000000..0021cd3ec12c --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json @@ -0,0 +1,46 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "assistant_id": null, + "run_id": null, + "status": "incomplete", + "incomplete_details": null, + "completed_at": 1707298421, + "incomplete_at": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json new file mode 100644 index 000000000000..15e95dd58e30 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json @@ -0,0 +1,43 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "incomplete_details": null, + "usage": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json new file mode 100644 index 000000000000..af3b0ddfef32 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json @@ -0,0 +1,28 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json new file mode 100644 index 000000000000..94fd2039a6db --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json @@ -0,0 +1,28 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 745a9723a11b..c574712af773 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -165,6 +165,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of assistants.": { + "$ref": "./examples/list_assistants.json" + } } }, "post": { @@ -188,6 +193,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Create an assistant with a model and instructions.": { + "$ref": "./examples/create_assistant.json" + } } } }, @@ -211,6 +221,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/get_assistant.json" + } } }, "post": { @@ -241,6 +256,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/update_assistant.json" + } } }, "delete": { @@ -262,6 +282,11 @@ "$ref": "#/definitions/AssistantDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes an assistant.": { + "$ref": "./examples/delete_assistant.json" + } } } }, @@ -335,6 +360,11 @@ "$ref": "#/definitions/FileListResponse" } } + }, + "x-ms-examples": { + "Returns a list of files filtered by purpose": { + "$ref": "./examples/list_file.json" + } } }, "post": { @@ -423,6 +453,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Uploads a file": { + "$ref": "./examples/upload_file.json" + } } } }, @@ -446,6 +481,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Returns a file": { + "$ref": "./examples/get_file.json" + } } }, "delete": { @@ -467,6 +507,11 @@ "$ref": "#/definitions/FileDeletionStatus" } } + }, + "x-ms-examples": { + "Delete a previously uploaded file.": { + "$ref": "./examples/delete_file.json" + } } } }, @@ -491,6 +536,11 @@ "format": "byte" } } + }, + "x-ms-examples": { + "Returns the content of a file": { + "$ref": "./examples/get_file_content.json" + } } } }, @@ -516,6 +566,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Creates a thread.": { + "$ref": "./examples/create_thread.json" + } } } }, @@ -539,6 +594,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Retrieves a thread.": { + "$ref": "./examples/get_thread.json" + } } }, "post": { @@ -569,6 +629,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Modifies a thread.": { + "$ref": "./examples/update_thread.json" + } } }, "delete": { @@ -590,6 +655,11 @@ "$ref": "#/definitions/ThreadDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes a thread.": { + "$ref": "./examples/delete_thread.json" + } } } }, @@ -713,6 +783,11 @@ ] } } + }, + "x-ms-examples": { + "List Messages": { + "$ref": "./examples/list_messages.json" + } } }, "post": { @@ -727,9 +802,9 @@ "type": "string" }, { - "name": "threadMessageOptions", + "name": "body", "in": "body", - "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ThreadMessageOptions" @@ -743,6 +818,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } } } }, @@ -773,6 +853,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } } }, "post": { @@ -819,6 +904,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/update_message.json" + } } } }, @@ -935,6 +1025,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of runs belonging to a thread.": { + "$ref": "./examples/list_runs.json" + } } }, "post": { @@ -949,9 +1044,8 @@ "type": "string" }, { - "name": "createRunOptions", + "name": "body", "in": "body", - "description": "The details for the run to create.", "required": true, "schema": { "$ref": "#/definitions/CreateRunOptions" @@ -965,6 +1059,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } } } }, @@ -995,6 +1094,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Gets a run.": { + "$ref": "./examples/get_run.json" + } } }, "post": { @@ -1041,6 +1145,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Modifies a run.": { + "$ref": "./examples/update_run.json" + } } } }, @@ -1071,6 +1180,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Cancels a run that is `in_progress`.\n": { + "$ref": "./examples/cancel_run.json" + } } } }, @@ -1194,6 +1308,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of run steps belonging to a run.": { + "$ref": "./examples/list_run_steps.json" + } } } }, @@ -1231,6 +1350,11 @@ "$ref": "#/definitions/RunStep" } } + }, + "x-ms-examples": { + "Retrieves a run step.": { + "$ref": "./examples/get_run_step.json" + } } } }, @@ -1288,6 +1412,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } } } }, @@ -1313,6 +1442,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a thread and run it in one request.": { + "$ref": "./examples/create_thread_and_run.json" + } } } }, @@ -1422,6 +1556,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of vector stores.": { + "$ref": "./examples/list_vector_stores.json" + } } }, "post": { @@ -1445,6 +1584,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Creates a vector store.": { + "$ref": "./examples/create_vector_store.json" + } } } }, @@ -1468,6 +1612,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Retrieves a vector store.": { + "$ref": "./examples/get_vector_store.json" + } } }, "post": { @@ -1498,6 +1647,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Modifies a vector store.": { + "$ref": "./examples/modify_vector_store.json" + } } }, "delete": { @@ -1519,6 +1673,11 @@ "$ref": "#/definitions/VectorStoreDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes a vector store.": { + "$ref": "./examples/delete_vector_store.json" + } } } }, @@ -1565,6 +1724,11 @@ "$ref": "#/definitions/VectorStoreFileBatch" } } + }, + "x-ms-examples": { + "Create a vector store file batch.": { + "$ref": "./examples/create_vector_store_file_batch.json" + } } } }, @@ -1595,6 +1759,11 @@ "$ref": "#/definitions/VectorStoreFileBatch" } } + }, + "x-ms-examples": { + "Retrieves a vector store file batch.": { + "$ref": "./examples/get_vector_store_file_batch.json" + } } } }, @@ -1625,6 +1794,11 @@ "$ref": "#/definitions/VectorStoreFileBatch" } } + }, + "x-ms-examples": { + "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.": { + "$ref": "./examples/cancel_vector_store_file_batch.json" + } } } }, @@ -1787,6 +1961,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of vector store files of a given batch.": { + "$ref": "./examples/list_vector_store_file_batch_files.json" + } } } }, @@ -1942,6 +2121,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of vector store files.": { + "$ref": "./examples/list_vector_store_files.json" + } } }, "post": { @@ -1981,6 +2165,11 @@ "$ref": "#/definitions/VectorStoreFile" } } + }, + "x-ms-examples": { + "Create a vector store file by attaching a File to a vector store.": { + "$ref": "./examples/create_vector_store_file.json" + } } } }, @@ -2011,6 +2200,11 @@ "$ref": "#/definitions/VectorStoreFile" } } + }, + "x-ms-examples": { + "Retrieves a vector store file.": { + "$ref": "./examples/get_vector_store_file.json" + } } }, "delete": { @@ -2039,6 +2233,11 @@ "$ref": "#/definitions/VectorStoreFileDeletionStatus" } } + }, + "x-ms-examples": { + "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.": { + "$ref": "./examples/delete_vector_store_file.json" + } } } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json new file mode 100644 index 000000000000..7f3456272098 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json @@ -0,0 +1,48 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You summarize books.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_choice": "auto", + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "max_completion_tokens": 1000, + "max_prompt_tokens": 1000, + "incomplete_details": null, + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "CancelRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json new file mode 100644 index 000000000000..1d73787e8c47 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "title": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "cancelling", + "file_counts": { + "in_progress": 12, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 15 + } + } + } + }, + "operationId": "CancelVectorStoreFileBatch" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json new file mode 100644 index 000000000000..66b92133fe32 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json @@ -0,0 +1,41 @@ +{ + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "CreateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json new file mode 100644 index 000000000000..70ae2b1b9da1 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json @@ -0,0 +1,41 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "assistant_id": null, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json new file mode 100644 index 000000000000..97d2f5b79785 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -0,0 +1,50 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "body": { + "assistant_id": "asst_abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "CreateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json new file mode 100644 index 000000000000..101ade5b001f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json @@ -0,0 +1,20 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "tool_resources": {}, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..5fdbcedb411f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json @@ -0,0 +1,54 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "assistant_id": "asst_abc123", + "thread": { + "messages": [ + { + "role": "user", + "content": "Explain deep learning to a 5 year old." + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076792, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": null, + "expires_at": 1699077392, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "required_action": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant.", + "tools": [], + "metadata": {}, + "temperature": 1.0, + "top_p": 1.0, + "max_completion_tokens": null, + "max_prompt_tokens": null, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "incomplete_details": null, + "usage": null, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "CreateThreadAndRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json new file mode 100644 index 000000000000..60ae754b38c9 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json @@ -0,0 +1,32 @@ +{ + "title": "Creates a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "CreateVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json new file mode 100644 index 000000000000..404fe3f1caf9 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json @@ -0,0 +1,25 @@ +{ + "title": "Create a vector store file by attaching a File to a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "file_id": "file-abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 1234, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + }, + "operationId": "CreateVectorStoreFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json new file mode 100644 index 000000000000..c985b6e7a580 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json @@ -0,0 +1,33 @@ +{ + "title": "Create a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } + }, + "operationId": "CreateVectorStoreFileBatch" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..a4675ff13925 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json new file mode 100644 index 000000000000..7c4d93ffd9a6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json new file mode 100644 index 000000000000..fe2b6bc1b662 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json new file mode 100644 index 000000000000..1adda1765fb3 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123 " + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json new file mode 100644 index 000000000000..804790877bdb --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json @@ -0,0 +1,19 @@ +{ + "title": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "fileId": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file_abc123", + "object": "vector_store.file.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStoreFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json new file mode 100644 index 000000000000..514a7c390012 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json @@ -0,0 +1,32 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_abc123" + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "top_p": 1.0, + "temperature": 1.0, + "tool_resources": {}, + "metadata": {}, + "response_format": "auto" + } + } + }, + "operationId": "GetAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json new file mode 100644 index 000000000000..af3ab4586d76 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json @@ -0,0 +1,23 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json new file mode 100644 index 000000000000..4b5fec6d67f7 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": "file content" + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json new file mode 100644 index 000000000000..03af4b1a4ebe --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json @@ -0,0 +1,38 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "attachments": [], + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json new file mode 100644 index 000000000000..2895df4dce16 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -0,0 +1,42 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "incomplete_details": null, + "usage": null, + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto", + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json new file mode 100644 index 000000000000..556262ddc1a4 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json @@ -0,0 +1,42 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + } + }, + "operationId": "GetRunStep" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json new file mode 100644 index 000000000000..8d95c82cfe2d --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json @@ -0,0 +1,24 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {}, + "tool_resources": { + "code_interpreter": { + "file_ids": [] + } + } + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json new file mode 100644 index 000000000000..a8cc51d89802 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "GetVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json new file mode 100644 index 000000000000..2f351de142b6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json @@ -0,0 +1,23 @@ +{ + "title": "Retrieves a vector store file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "fileId": "file-abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 123456, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + }, + "operationId": "GetVectorStoreFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json new file mode 100644 index 000000000000..18f0a0f0a385 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "title": "Retrieves a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } + }, + "operationId": "GetVectorStoreFileBatch" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json new file mode 100644 index 000000000000..2e2a78969007 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json @@ -0,0 +1,71 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc456", + "object": "assistant", + "created_at": 1698982718, + "name": "My Assistant", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant designed to make me better at coding!", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc789", + "object": "assistant", + "created_at": 1698982643, + "name": null, + "description": null, + "model": "gpt-4-turbo", + "instructions": "", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + ], + "first_id": "asst_abc123", + "last_id": "asst_abc789", + "has_more": false + } + } + }, + "operationId": "ListAssistants" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json new file mode 100644 index 000000000000..a8c406924328 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json @@ -0,0 +1,38 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] + } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json new file mode 100644 index 000000000000..4813900797ae --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json @@ -0,0 +1,69 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + }, + { + "id": "msg_abc456", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "Hello, what is AI?", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + } + ], + "first_id": "msg_abc123", + "last_id": "msg_abc456", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..e57f889c9165 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json @@ -0,0 +1,49 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "run_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json new file mode 100644 index 000000000000..e80a557e64c1 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -0,0 +1,97 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + }, + { + "id": "run_abc456", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + ], + "first_id": "run_abc123", + "last_id": "run_abc456", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json new file mode 100644 index 000000000000..be54b92a08b5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json @@ -0,0 +1,40 @@ +{ + "title": "Returns a list of vector store files of a given batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "batch-abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFileBatchFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json new file mode 100644 index 000000000000..e6406462f735 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json @@ -0,0 +1,39 @@ +{ + "title": "Returns a list of vector store files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json new file mode 100644 index 000000000000..df84331efbac --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json @@ -0,0 +1,54 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "in_progress", + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + }, + "last_active_at": 1699061776, + "metadata": {} + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "usage_bytes": 139920, + "status": "in_progress", + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + }, + "last_active_at": 1699061776, + "metadata": {} + } + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStores" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json new file mode 100644 index 000000000000..935bdadbd7d2 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json @@ -0,0 +1,33 @@ +{ + "title": "Modifies a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "ModifyVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..cd810dd4169a --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,79 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_123", + "runId": "run_123", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_001", + "output": "70 degrees and sunny." + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_123", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_123", + "thread_id": "thread_123", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "tools": [ + { + "type": "function", + "function": { + "name": "get_current_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "celsius", + "fahrenheit" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "incomplete_details": null, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json new file mode 100644 index 000000000000..c0e7fc6ee699 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json @@ -0,0 +1,45 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_abc123", + "body": { + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "model": "gpt-4-turbo" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [] + } + }, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json new file mode 100644 index 000000000000..7621cc8605c7 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -0,0 +1,47 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "messageId": "msg_abc123 ", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "status": "complete", + "incomplete_details": null, + "completed_at": 1699017614, + "incomplete_at": null, + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json new file mode 100644 index 000000000000..709ed437a3ce --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -0,0 +1,59 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "run_abc123", + "body": { + "metadata": { + "user_id": "user_abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": { + "user_id": "user_abc123" + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "UpdateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json new file mode 100644 index 000000000000..e7610f8ec4cf --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json @@ -0,0 +1,29 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + }, + "tool_resources": {} + } + } + }, + "operationId": "UpdateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json new file mode 100644 index 000000000000..933d5d59974e --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json @@ -0,0 +1,30 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json deleted file mode 100644 index 7b5bd59f8c14..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json +++ /dev/null @@ -1,3452 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure OpenAI", - "version": "2023-11-06-beta", - "description": "Azure OpenAI APIs for Assistants.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "description": "An OpenAI endpoint supporting assistants functionality.", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "ApiKeyAuth": [] - }, - { - "OAuth2Auth": [ - "https://cognitiveservices.azure.com/.default" - ] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "api-key", - "in": "header" - }, - "OAuth2Auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://cognitiveservices.azure.com/.default": "" - } - } - }, - "tags": [], - "paths": { - "/assistants": { - "get": { - "operationId": "ListAssistants", - "description": "Gets a list of assistants that were previously created.", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of assistants.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/Assistant" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistant", - "description": "Creates a new assistant.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "The new assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - } - }, - "/assistants/{assistantId}": { - "get": { - "operationId": "GetAssistant", - "description": "Retrieves an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "post": { - "operationId": "ModifyAssistant", - "description": "Modifies an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to modify.", - "required": true, - "type": "string" - }, - { - "name": "modificationOptions", - "in": "body", - "description": "The details of the modification to perform on the specified assistant.", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantModificationOptions" - } - } - ], - "responses": { - "200": { - "description": "The updated assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistant", - "description": "Deletes an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested deletion operation.", - "schema": { - "$ref": "#/definitions/AssistantDeletionStatus" - } - } - } - } - }, - "/assistants/{assistantId}/files": { - "get": { - "operationId": "ListAssistantFiles", - "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve the list of attached files for.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files attached to the specified assistant.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/AssistantFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistantFile", - "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to attach the file to.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the previously uploaded file to attach.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - } - }, - "/assistants/{assistantId}/files/{fileId}": { - "get": { - "operationId": "GetAssistantFile", - "description": "Retrieves a file attached to an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant associated with the attached file.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistantFile", - "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant from which the specified file should be unlinked.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to unlink from the specified assistant.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested file association deletion.", - "schema": { - "$ref": "#/definitions/AssistantFileDeletionStatus" - } - } - } - } - }, - "/files": { - "get": { - "operationId": "ListFiles", - "description": "Gets a list of previously uploaded files.", - "parameters": [ - { - "name": "purpose", - "in": "query", - "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", - "required": false, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - } - ], - "responses": { - "200": { - "description": "The requested list of files.", - "schema": { - "$ref": "#/definitions/FileListResponse" - } - } - } - }, - "post": { - "operationId": "CreateFile", - "description": "Uploads a file for use by other operations.", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "name": "file", - "in": "formData", - "description": "The file data (not filename) to upload.", - "required": true, - "type": "file" - }, - { - "name": "purpose", - "in": "formData", - "description": "The intended purpose of the file.", - "required": true, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - { - "name": "filename", - "in": "formData", - "description": "A filename to associate with the uploaded data.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the uploaded file.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - } - }, - "/files/{fileId}": { - "get": { - "operationId": "RetrieveFile", - "description": "Returns information about a specific file. Does not retrieve file content.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - }, - "delete": { - "operationId": "DeleteFile", - "description": "Delete a previously uploaded file.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/FileDeletionStatus" - } - } - } - } - }, - "/threads": { - "post": { - "operationId": "CreateThread", - "description": "Creates a new thread. Threads contain messages and can be run by assistants.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantThreadCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - } - }, - "/threads/{threadId}": { - "get": { - "operationId": "GetThread", - "description": "Gets information about an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "post": { - "operationId": "ModifyThread", - "description": "Modifies an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "delete": { - "operationId": "DeleteThread", - "description": "Deletes an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested thread deletion operation.", - "schema": { - "$ref": "#/definitions/ThreadDeletionStatus" - } - } - } - } - }, - "/threads/{threadId}/messages": { - "get": { - "operationId": "ListMessages", - "description": "Gets a list of messages that exist on a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list messages from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of messages.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateMessage", - "description": "Creates a new message on a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to create the new message on.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role to associate with the new message." - }, - "content": { - "type": "string", - "description": "The textual content for the new message." - }, - "file_ids": { - "type": "array", - "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "role", - "content" - ] - } - } - ], - "responses": { - "200": { - "description": "A representation of the new message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}": { - "get": { - "operationId": "GetMessage", - "description": "Gets an existing message from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve the specified message from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to retrieve from the specified thread.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the requested message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - }, - "post": { - "operationId": "ModifyMessage", - "description": "Modifies an existing message on an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the specified message to modify.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to modify on the specified thread.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "A representation of the modified message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files": { - "get": { - "operationId": "ListMessageFiles", - "description": "Gets a list of previously uploaded files associated with a message from a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files associated with the specified message.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/MessageFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files/{fileId}": { - "get": { - "operationId": "GetMessageFile", - "description": "Gets information about a file attachment to a message within a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to get information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested file information.", - "schema": { - "$ref": "#/definitions/MessageFile" - } - } - } - } - }, - "/threads/{threadId}/runs": { - "get": { - "operationId": "ListRuns", - "description": "Gets a list of runs for a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list runs from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of thread runs.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadRun" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateRun", - "description": "Creates a new run for an assistant thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to run.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant that should run the thread.", - "x-ms-client-name": "assistantId" - }, - "model": { - "type": "string", - "description": "The overridden model name that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions that the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools that the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the new thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}": { - "get": { - "operationId": "GetRun", - "description": "Gets an existing run from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve run information from.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested information about the specified thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - }, - "post": { - "operationId": "ModifyRun", - "description": "Modifies an existing thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread associated with the specified run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/cancel": { - "post": { - "operationId": "CancelRun", - "description": "Cancels a run of an in progress thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread being run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to cancel.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Updated information about the cancelled run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps": { - "get": { - "operationId": "ListRunSteps", - "description": "Gets a list of run steps from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to list steps from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of run steps.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/RunStep" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps/{stepId}": { - "get": { - "operationId": "GetRunStep", - "description": "Gets a single run step from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the specific run to retrieve the step from.", - "required": true, - "type": "string" - }, - { - "name": "stepId", - "in": "path", - "description": "The ID of the step to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested run step.", - "schema": { - "$ref": "#/definitions/RunStep" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { - "post": { - "operationId": "SubmitToolOutputsToRun", - "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run that requires tool outputs.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "tool_outputs": { - "type": "array", - "description": "The list of tool outputs requested by tool calls from the specified run.", - "items": { - "$ref": "#/definitions/ToolOutput" - }, - "x-ms-client-name": "toolOutputs", - "x-ms-identifiers": [] - } - }, - "required": [ - "tool_outputs" - ] - } - } - ], - "responses": { - "200": { - "description": "Updated information about the run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/runs": { - "post": { - "operationId": "CreateThreadAndRun", - "description": "Creates a new assistant thread and immediately starts a run using that new thread.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateAndRunThreadOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - } - }, - "definitions": { - "Assistant": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always assistant.", - "enum": [ - "assistant" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "name": { - "type": "string", - "description": "The name of the assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the assistant.", - "x-nullable": true - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The system instructions for the assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools enabled for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "name", - "description", - "model", - "instructions", - "tools", - "file_ids", - "metadata" - ] - }, - "AssistantCreationOptions": { - "type": "object", - "description": "The request details to use when creating a new assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The name of the new assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the new assistant.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools to enable for the new assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of previously uploaded file IDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "model" - ] - }, - "AssistantDeletionStatus": { - "type": "object", - "description": "The status of an assistant deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.deleted'.", - "enum": [ - "assistant.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantFile": { - "type": "object", - "description": "Information about a file attached to an assistant, as used by tools that can read files.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file'.", - "enum": [ - "assistant.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "assistant_id": { - "type": "string", - "description": "The assistant ID that the file is attached to.", - "x-ms-client-name": "assistantId" - } - }, - "required": [ - "id", - "object", - "created_at", - "assistant_id" - ] - }, - "AssistantFileDeletionStatus": { - "type": "object", - "description": "The status of an assistant file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file.deleted'.", - "enum": [ - "assistant.file.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantModificationOptions": { - "type": "object", - "description": "The request details to use when modifying an existing assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The modified name for the assistant to use.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The modified description for the assistant to use.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The modified system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The modified collection of tools to enable for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "AssistantThread": { - "type": "object", - "description": "Information about a single thread associated with an assistant.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread'.", - "enum": [ - "thread" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "metadata" - ] - }, - "AssistantThreadCreationOptions": { - "type": "object", - "description": "The details used to create a new assistant thread.", - "properties": { - "messages": { - "type": "array", - "description": "The messages to associate with the new thread.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "CodeInterpreterImageOutput": { - "type": "object", - "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "image": { - "$ref": "#/definitions/CodeInterpreterImageReference", - "description": "Referential information for the image associated with this output." - } - }, - "required": [ - "image" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "image" - }, - "CodeInterpreterImageReference": { - "type": "object", - "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "CodeInterpreterLogOutput": { - "type": "object", - "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "logs": { - "type": "string", - "description": "The serialized log output emitted by the code interpreter." - } - }, - "required": [ - "logs" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "logs" - }, - "CodeInterpreterToolCall": { - "type": "object", - "description": "A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that\nrepresents submitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "code_interpreter": { - "$ref": "#/definitions/CodeInterpreterToolCallDetails", - "description": "The details of the tool call to the code interpreter tool.", - "x-ms-client-name": "codeInterpreter" - } - }, - "required": [ - "code_interpreter" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CodeInterpreterToolCallDetails": { - "type": "object", - "description": "The detailed information about a code interpreter invocation by the model.", - "properties": { - "input": { - "type": "string", - "description": "The input provided by the model to the code interpreter tool." - }, - "outputs": { - "type": "array", - "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", - "items": { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "input", - "outputs" - ] - }, - "CodeInterpreterToolCallOutput": { - "type": "object", - "description": "An abstract representation of an emitted output from a code interpreter tool.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "CodeInterpreterToolDefinition": { - "type": "object", - "description": "The input definition information for a code interpreter tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CreateAndRunThreadOptions": { - "type": "object", - "description": "The details used when creating and immediately running a new assistant thread.", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant for which the thread should be created.", - "x-ms-client-name": "assistantId" - }, - "thread": { - "$ref": "#/definitions/AssistantThreadCreationOptions", - "description": "The details used to create the new thread." - }, - "model": { - "type": "string", - "description": "The overridden model that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - }, - "FileDeletionStatus": { - "type": "object", - "description": "A status response from a file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "FileListResponse": { - "type": "object", - "description": "The response data from a file list operation.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'list'.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The files returned for the request.", - "items": { - "$ref": "#/definitions/OpenAIFile" - } - } - }, - "required": [ - "object", - "data" - ] - }, - "FilePurpose": { - "type": "string", - "description": "The possible values denoting the intended usage of a file.", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - "FunctionDefinition": { - "type": "object", - "description": "The input definition information for a function.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function to be called." - }, - "description": { - "type": "string", - "description": "A description of what the function does, used by the model to choose when and how to call the function." - }, - "parameters": { - "description": "The parameters the functions accepts, described as a JSON Schema object." - } - }, - "required": [ - "name", - "parameters" - ] - }, - "FunctionToolCall": { - "type": "object", - "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\ngiven function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionToolCallDetails", - "description": "The detailed information about the function called by the model." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "function" - }, - "FunctionToolCallDetails": { - "type": "object", - "description": "The detailed information about the function called by the model.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function." - }, - "arguments": { - "type": "string", - "description": "The arguments that the model requires are provided to the named function." - }, - "output": { - "type": "string", - "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", - "x-nullable": true - } - }, - "required": [ - "name", - "arguments", - "output" - ] - }, - "FunctionToolDefinition": { - "type": "object", - "description": "The input definition information for a function tool as used to configure an assistant.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionDefinition", - "description": "The definition of the concrete function that the function tool should call." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "function" - }, - "MessageContent": { - "type": "object", - "description": "An abstract representation of a single item of thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "MessageFile": { - "type": "object", - "description": "Information about a file attached to an assistant thread message.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message.file'.", - "enum": [ - "thread.message.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "message_id": { - "type": "string", - "description": "The ID of the message that this file is attached to.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "id", - "object", - "created_at", - "message_id" - ] - }, - "MessageFileCitationTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.", - "properties": { - "file_citation": { - "$ref": "#/definitions/MessageTextFileCitationDetails", - "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", - "x-ms-client-name": "fileCitation" - } - }, - "required": [ - "file_citation" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_citation" - }, - "MessageFilePathDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific file that the citation is from.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageFilePathTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a file located at a specific path.", - "properties": { - "file_path": { - "$ref": "#/definitions/MessageFilePathDetails", - "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", - "x-ms-client-name": "filePath" - } - }, - "required": [ - "file_path" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_path" - }, - "MessageImageFileContent": { - "type": "object", - "description": "A representation of image file content in a thread message.", - "properties": { - "image_file": { - "$ref": "#/definitions/MessageImageFileDetails", - "description": "The image file for this thread message content item.", - "x-ms-client-name": "imageFile" - } - }, - "required": [ - "image_file" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "image_file" - }, - "MessageImageFileDetails": { - "type": "object", - "description": "An image reference, as represented in thread message content.", - "properties": { - "file_id": { - "$ref": "#/definitions/MessageImageFileIdDetails", - "description": "The ID for the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageImageFileIdDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific image file.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageRole": { - "type": "string", - "description": "The possible values for roles attributed to messages in a thread.", - "enum": [ - "user", - "assistant" - ], - "x-ms-enum": { - "name": "MessageRole", - "modelAsString": true, - "values": [ - { - "name": "user", - "value": "user", - "description": "The role representing the end-user." - }, - { - "name": "assistant", - "value": "assistant", - "description": "The role representing the assistant." - } - ] - } - }, - "MessageTextAnnotation": { - "type": "object", - "description": "An abstract representation of an annotation to text thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "text": { - "type": "string", - "description": "The textual content associated with this text annotation item." - }, - "start_index": { - "type": "integer", - "format": "int32", - "description": "The first text index associated with this text annotation.", - "x-ms-client-name": "startIndex" - }, - "end_index": { - "type": "integer", - "format": "int32", - "description": "The last text index associated with this text annotation.", - "x-ms-client-name": "endIndex" - } - }, - "discriminator": "type", - "required": [ - "type", - "text", - "start_index", - "end_index" - ] - }, - "MessageTextContent": { - "type": "object", - "description": "A representation of a textual item of thread message content.", - "properties": { - "text": { - "$ref": "#/definitions/MessageTextDetails", - "description": "The text and associated annotations for this thread message content item." - } - }, - "required": [ - "text" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "text" - }, - "MessageTextDetails": { - "type": "object", - "description": "The text and associated annotations for a single item of assistant thread message content.", - "properties": { - "value": { - "type": "string", - "description": "The text data." - }, - "annotations": { - "type": "array", - "description": "A list of annotations associated with this text.", - "items": { - "$ref": "#/definitions/MessageTextAnnotation" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "value", - "annotations" - ] - }, - "MessageTextFileCitationDetails": { - "type": "object", - "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this citation.", - "x-ms-client-name": "fileId" - }, - "quote": { - "type": "string", - "description": "The specific quote cited in the associated file." - } - }, - "required": [ - "file_id", - "quote" - ] - }, - "OpenAIFile": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "bytes": { - "type": "integer", - "format": "int32", - "description": "The size of the file, in bytes." - }, - "filename": { - "type": "string", - "description": "The name of the file." - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "purpose": { - "$ref": "#/definitions/FilePurpose", - "description": "The intended purpose of a file." - } - }, - "required": [ - "object", - "id", - "bytes", - "filename", - "created_at", - "purpose" - ] - }, - "RequiredAction": { - "type": "object", - "description": "An abstract representation of a required action for an assistant thread run to continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RetrievalToolCall": { - "type": "object", - "description": "A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents\nsubmitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "retrieval": { - "type": "object", - "description": "The key/value pairs produced by the retrieval tool.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "retrieval" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RetrievalToolDefinition": { - "type": "object", - "description": "The input definition information for a retrieval tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RunError": { - "type": "object", - "description": "The details of an error as encountered by an assistant thread run.", - "properties": { - "code": { - "type": "string", - "description": "The status for the error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStatus": { - "type": "string", - "description": "Possible values for the status of an assistant thread run.", - "enum": [ - "queued", - "in_progress", - "requires_action", - "cancelling", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStatus", - "modelAsString": true, - "values": [ - { - "name": "queued", - "value": "queued", - "description": "Represents a run that is queued to start." - }, - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run that is in progress." - }, - { - "name": "requiresAction", - "value": "requires_action", - "description": "Represents a run that needs another operation, such as tool output submission, to continue." - }, - { - "name": "cancelling", - "value": "cancelling", - "description": "Represents a run that is in the process of cancellation." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run that has been cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run that expired before it could otherwise finish." - } - ] - } - }, - "RunStep": { - "type": "object", - "description": "Detailed information about a single step of an assistant thread run.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run.step'.", - "enum": [ - "thread.run.step" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The type of run step, which can be either message_creation or tool_calls." - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the run step.", - "x-ms-client-name": "assistantId" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that was run.", - "x-ms-client-name": "threadId" - }, - "run_id": { - "type": "string", - "description": "The ID of the run that this run step is a part of.", - "x-ms-client-name": "runId" - }, - "status": { - "$ref": "#/definitions/RunStepStatus", - "description": "The status of this run step." - }, - "step_details": { - "$ref": "#/definitions/RunStepDetails", - "description": "The details for this run step.", - "x-ms-client-name": "stepDetails" - }, - "last_error": { - "type": "object", - "description": "If applicable, information about the last error encountered by this run step.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunStepError" - } - ], - "x-ms-client-name": "lastError" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expired_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expired.", - "x-nullable": true, - "x-ms-client-name": "expiredAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "type", - "assistant_id", - "thread_id", - "run_id", - "status", - "step_details", - "last_error", - "created_at", - "expired_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "RunStepDetails": { - "type": "object", - "description": "An abstract representation of the details for a run step.", - "properties": { - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RunStepError": { - "type": "object", - "description": "The error information associated with a failed run step.", - "properties": { - "code": { - "$ref": "#/definitions/RunStepErrorCode", - "description": "The error code for this error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with this error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStepErrorCode": { - "type": "string", - "description": "Possible error code values attributable to a failed run step.", - "enum": [ - "server_error", - "rate_limit_exceeded" - ], - "x-ms-enum": { - "name": "RunStepErrorCode", - "modelAsString": true, - "values": [ - { - "name": "serverError", - "value": "server_error", - "description": "Represents a server error." - }, - { - "name": "rateLimitExceeded", - "value": "rate_limit_exceeded", - "description": "Represents an error indicating configured rate limits were exceeded." - } - ] - } - }, - "RunStepMessageCreationDetails": { - "type": "object", - "description": "The detailed information associated with a message creation run step.", - "properties": { - "message_creation": { - "$ref": "#/definitions/RunStepMessageCreationReference", - "description": "Information about the message creation associated with this run step.", - "x-ms-client-name": "messageCreation" - } - }, - "required": [ - "message_creation" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "message_creation" - }, - "RunStepMessageCreationReference": { - "type": "object", - "description": "The details of a message created as a part of a run step.", - "properties": { - "message_id": { - "type": "string", - "description": "The ID of the message created by this run step.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "message_id" - ] - }, - "RunStepStatus": { - "type": "string", - "description": "Possible values for the status of a run step.", - "enum": [ - "in_progress", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStepStatus", - "modelAsString": true, - "values": [ - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run step still in progress." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run step that was cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run step that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run step that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run step that expired before otherwise finishing." - } - ] - } - }, - "RunStepToolCallDetails": { - "type": "object", - "description": "The detailed information associated with a run step calling tools.", - "properties": { - "tool_calls": { - "type": "array", - "description": "A list tool call details for this run step.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "tool_calls" - }, - "RunStepType": { - "type": "string", - "description": "The possible types of run steps.", - "enum": [ - "message_creation", - "tool_calls" - ], - "x-ms-enum": { - "name": "RunStepType", - "modelAsString": true, - "values": [ - { - "name": "messageCreation", - "value": "message_creation", - "description": "Represents a run step to create a message." - }, - { - "name": "toolCalls", - "value": "tool_calls", - "description": "Represents a run step that calls tools." - } - ] - } - }, - "SubmitToolOutputsAction": { - "type": "object", - "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", - "properties": { - "submit_tool_outputs": { - "$ref": "#/definitions/SubmitToolOutputsDetails", - "description": "The details describing tools that should be called to submit tool outputs.", - "x-ms-client-name": "submitToolOutputs" - } - }, - "required": [ - "submit_tool_outputs" - ], - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-discriminator-value": "submit_tool_outputs" - }, - "SubmitToolOutputsDetails": { - "type": "object", - "description": "The details describing tools that should be called to submit tool outputs.", - "properties": { - "tool_calls": { - "type": "array", - "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ] - }, - "ThreadDeletionStatus": { - "type": "object", - "description": "The status of a thread deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.deleted'.", - "enum": [ - "thread.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "ThreadMessage": { - "type": "object", - "description": "A single message within an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message'.", - "enum": [ - "thread.message" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that this message belongs to.", - "x-ms-client-name": "threadId" - }, - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role associated with the assistant thread message." - }, - "content": { - "type": "array", - "description": "The list of content items associated with the assistant thread message.", - "items": { - "$ref": "#/definitions/MessageContent" - }, - "x-ms-identifiers": [] - }, - "assistant_id": { - "type": "string", - "description": "If applicable, the ID of the assistant that authored this message.", - "x-ms-client-name": "assistantId" - }, - "run_id": { - "type": "string", - "description": "If applicable, the ID of the run associated with the authoring of this message.", - "x-ms-client-name": "runId" - }, - "file_ids": { - "type": "array", - "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "thread_id", - "role", - "content", - "file_ids", - "metadata" - ] - }, - "ThreadRun": { - "type": "object", - "description": "Data representing a single evaluation run of an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run'.", - "enum": [ - "thread.run" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread associated with this run.", - "x-ms-client-name": "threadId" - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the thread this run was performed against.", - "x-ms-client-name": "assistantId" - }, - "status": { - "$ref": "#/definitions/RunStatus", - "description": "The status of the assistant thread run." - }, - "required_action": { - "type": "object", - "description": "The details of the action required for the assistant thread run to continue.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-client-name": "requiredAction" - }, - "last_error": { - "type": "object", - "description": "The last error, if any, encountered by this assistant thread run.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunError" - } - ], - "x-ms-client-name": "lastError" - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions used for this assistant thread run." - }, - "tools": { - "type": "array", - "description": "The overridden enabled tools used for this assistant thread run.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expires.", - "x-nullable": true, - "x-ms-client-name": "expiresAt" - }, - "started_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item was started.", - "x-nullable": true, - "x-ms-client-name": "startedAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "thread_id", - "assistant_id", - "status", - "last_error", - "model", - "instructions", - "tools", - "file_ids", - "created_at", - "expires_at", - "started_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "ToolCall": { - "type": "object", - "description": "An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must\nbe fulfilled and have its outputs submitted before the model can continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "id": { - "type": "string", - "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." - } - }, - "discriminator": "type", - "required": [ - "type", - "id" - ] - }, - "ToolDefinition": { - "type": "object", - "description": "An abstract representation of an input tool definition that an assistant can use.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "ToolOutput": { - "type": "object", - "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", - "properties": { - "tool_call_id": { - "type": "string", - "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", - "x-ms-client-name": "toolCallId" - }, - "output": { - "type": "string", - "description": "The output from the tool to be submitted." - } - } - } - }, - "parameters": {} -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json deleted file mode 100644 index 24f1208ac3df..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "title": "Assistants_CreateAssistant", - "operationId": "Assistants_CreateAssistant" -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml deleted file mode 100644 index 8a83ec762134..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml +++ /dev/null @@ -1,2388 +0,0 @@ -openapi: 3.0.0 -info: - title: Azure OpenAI - version: 2023-02-15-preview - description: Azure OpenAI APIs for Assistants. -tags: [] -paths: - /assistants: - post: - operationId: createAssistant - description: Creates a new assistant. - parameters: [] - responses: - '200': - description: The new assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantCreationOptions' - get: - operationId: listAssistants - description: Gets a list of assistants that were previously created. - parameters: - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of assistants. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/Assistant' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}: - get: - operationId: getAssistant - description: Retrieves an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve. - schema: - type: string - responses: - '200': - description: The requested assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - post: - operationId: modifyAssistant - description: Modifies an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to modify. - schema: - type: string - responses: - '200': - description: The updated assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - description: The details of the modification to perform on the specified assistant. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantModificationOptions' - delete: - operationId: deleteAssistant - description: Deletes an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantDeletionStatus' - /assistants/{assistantId}/files: - post: - operationId: createAssistantFile - description: Attaches a previously uploaded file to an assistant for use by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to attach the file to. - schema: - type: string - responses: - '200': - description: Information about the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - file_id: - type: string - description: The ID of the previously uploaded file to attach. - required: - - file_id - get: - operationId: listAssistantFiles - description: Gets a list of files attached to a specific assistant, as used by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve the list of attached files for. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of files attached to the specified assistant. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/AssistantFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}/files/{fileId}: - get: - operationId: getAssistantFile - description: Retrieves a file attached to an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant associated with the attached file. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: A representation of the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - delete: - operationId: deleteAssistantFile - description: |- - Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read - files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant from which the specified file should be unlinked. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to unlink from the specified assistant. - schema: - type: string - responses: - '200': - description: Status information about the requested file association deletion. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFileDeletionStatus' - /files: - get: - operationId: listFiles - description: Gets a list of previously uploaded files. - parameters: - - name: purpose - in: query - required: false - description: A value that, when provided, limits list results to files matching the corresponding purpose. - schema: - $ref: '#/components/schemas/FilePurpose' - responses: - '200': - description: The requested list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/FileListResponse' - post: - operationId: createFile - description: Uploads a file for use by other operations. - parameters: [] - responses: - '200': - description: A representation of the uploaded file. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of the file. - filename: - type: string - description: A filename to associate with the uploaded data. - required: - - file - - purpose - /files/{fileId}/{file_id}: - delete: - operationId: deleteFile - description: Delete a previously uploaded file. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to delete. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/FileDeletionStatus' - get: - operationId: retrieveFile - description: Returns information about a specific file. Does not retrieve file content. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - /threads: - post: - operationId: createThread - description: Creates a new thread. Threads contain messages and can be run by assistants. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThreadCreationOptions' - /threads/runs: - post: - operationId: createThreadAndRun - description: Creates a new assistant thread and immediately starts a run using that new thread. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAndRunThreadOptions' - /threads/{threadId}: - get: - operationId: getThread - description: Gets information about an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - post: - operationId: modifyThread - description: Modifies an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to modify. - schema: - type: string - responses: - '200': - description: Information about the modified thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - delete: - operationId: deleteThread - description: Deletes an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested thread deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadDeletionStatus' - /threads/{threadId}/messages: - post: - operationId: createMessage - description: Creates a new message on a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to create the new message on. - schema: - type: string - responses: - '200': - description: A representation of the new message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role to associate with the new message. - content: - type: string - description: The textual content for the new message. - file_ids: - type: array - items: - type: string - description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - role - - content - get: - operationId: listMessages - description: Gets a list of messages that exist on a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list messages from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of messages. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}: - get: - operationId: getMessage - description: Gets an existing message from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve the specified message from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to retrieve from the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the requested message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - post: - operationId: modifyMessage - description: Modifies an existing message on an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the specified message to modify. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to modify on the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the modified message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/messages/{messageId}/files: - get: - operationId: listMessageFiles - description: Gets a list of previously uploaded files associated with a message from a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to list files from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to list files from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of files associated with the specified message. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/MessageFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}/files/{fileId}: - get: - operationId: getMessageFile - description: Gets information about a file attachment to a message within a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to get information from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to get information from. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to get information about. - schema: - type: string - responses: - '200': - description: The requested file information. - content: - application/json: - schema: - $ref: '#/components/schemas/MessageFile' - /threads/{threadId}/runs: - post: - operationId: createRun - description: Creates a new run for an assistant thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to run. - schema: - type: string - responses: - '200': - description: Information about the new thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - assistant_id: - type: string - description: The ID of the assistant that should run the thread. - model: - type: string - description: The overridden model name that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions that the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools that the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - assistant_id - get: - operationId: listRuns - description: Gets a list of runs for a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list runs from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of thread runs. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadRun' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}: - get: - operationId: getRun - description: Gets an existing run from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve run information from. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: The requested information about the specified thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - post: - operationId: modifyRun - description: Modifies an existing thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread associated with the specified run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to modify. - schema: - type: string - responses: - '200': - description: Information about the modified run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/runs/{runId}/cancel: - post: - operationId: cancelRun - description: Cancels a run of an in progress thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread being run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to cancel. - schema: - type: string - responses: - '200': - description: Updated information about the cancelled run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - /threads/{threadId}/runs/{runId}/steps: - get: - operationId: listRunSteps - description: Gets a list of run steps from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to list steps from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of run steps. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/RunStep' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}/steps/{stepId}: - get: - operationId: getRunStep - description: Gets a single run step from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the specific run to retrieve the step from. - schema: - type: string - - name: stepId - in: path - required: true - description: The ID of the step to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested run step. - content: - application/json: - schema: - $ref: '#/components/schemas/RunStep' - /threads/{threadId}/runs/{runId}/submit_tool_outputs: - post: - operationId: submitToolOutputsToRun - description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run that requires tool outputs. - schema: - type: string - responses: - '200': - description: Updated information about the run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tool_outputs: - type: array - items: - $ref: '#/components/schemas/ToolOutput' - description: The list of tool outputs requested by tool calls from the specified run. - required: - - tool_outputs -security: - - ApiKeyAuth: [] - - OAuth2Auth: - - https://cognitiveservices.azure.com/.default -components: - schemas: - Assistant: - type: object - required: - - id - - object - - created_at - - name - - description - - model - - instructions - - tools - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant - description: The object type, which is always assistant. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - name: - type: string - nullable: true - description: The name of the assistant. - description: - type: string - nullable: true - description: The description of the assistant. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - nullable: true - description: The system instructions for the assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools enabled for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Represents an assistant that can call the model and use tools. - AssistantCreationOptions: - type: object - required: - - model - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The name of the new assistant. - description: - type: string - nullable: true - description: The description of the new assistant. - instructions: - type: string - nullable: true - description: The system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools to enable for the new assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of previously uploaded file IDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when creating a new assistant. - AssistantDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.deleted - description: The object type, which is always 'assistant.deleted'. - description: The status of an assistant deletion operation. - AssistantFile: - type: object - required: - - id - - object - - created_at - - assistant_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant.file - description: The object type, which is always 'assistant.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - assistant_id: - type: string - description: The assistant ID that the file is attached to. - description: Information about a file attached to an assistant, as used by tools that can read files. - AssistantFileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.file.deleted - description: The object type, which is always 'assistant.file.deleted'. - description: The status of an assistant file deletion operation. - AssistantModificationOptions: - type: object - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The modified name for the assistant to use. - description: - type: string - nullable: true - description: The modified description for the assistant to use. - instructions: - type: string - nullable: true - description: The modified system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The modified collection of tools to enable for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: The modified list of previously uploaded fileIDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when modifying an existing assistant. - AssistantThread: - type: object - required: - - id - - object - - created_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread - description: The object type, which is always 'thread'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Information about a single thread associated with an assistant. - AssistantThreadCreationOptions: - type: object - properties: - messages: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The messages to associate with the new thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used to create a new assistant thread. - CodeInterpreterImageOutput: - type: object - required: - - type - - image - properties: - type: - type: string - enum: - - image - description: The object type, which is always 'image'. - image: - allOf: - - $ref: '#/components/schemas/CodeInterpreterImageReference' - description: Referential information for the image associated with this output. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterImageReference: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the file associated with this image. - description: An image reference emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterLogOutput: - type: object - required: - - type - - logs - properties: - type: - type: string - enum: - - logs - description: The object type, which is always 'logs'. - logs: - type: string - description: The serialized log output emitted by the code interpreter. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterToolCall: - type: object - required: - - type - - code_interpreter - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - code_interpreter: - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallDetails' - description: The details of the tool call to the code interpreter tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that - represents submitted output needed or already fulfilled by the tool for the model to continue. - CodeInterpreterToolCallDetails: - type: object - required: - - input - - outputs - properties: - input: - type: string - description: The input provided by the model to the code interpreter tool. - outputs: - type: array - items: - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: The outputs produced by the code interpreter tool back to the model in response to the tool call. - description: The detailed information about a code interpreter invocation by the model. - CodeInterpreterToolCallOutput: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - logs: '#/components/schemas/CodeInterpreterLogOutput' - image: '#/components/schemas/CodeInterpreterImageOutput' - description: An abstract representation of an emitted output from a code interpreter tool. - CodeInterpreterToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a code interpreter tool as used to configure an assistant. - CreateAndRunThreadOptions: - type: object - required: - - assistant_id - properties: - assistant_id: - type: string - description: The ID of the assistant for which the thread should be created. - thread: - allOf: - - $ref: '#/components/schemas/AssistantThreadCreationOptions' - description: The details used to create the new thread. - model: - type: string - description: The overridden model that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used when creating and immediately running a new assistant thread. - FileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - description: A status response from a file deletion operation. - FileListResponse: - type: object - required: - - object - - data - properties: - object: - type: string - enum: - - list - description: The object type, which is always 'list'. - data: - type: array - items: - $ref: '#/components/schemas/OpenAIFile' - description: The files returned for the request. - description: The response data from a file list operation. - FilePurpose: - type: string - enum: - - fine-tune - - fine-tune-results - - assistants - - assistants_output - description: The possible values denoting the intended usage of a file. - FunctionDefinition: - type: object - required: - - name - - parameters - properties: - name: - type: string - description: The name of the function to be called. - description: - type: string - description: A description of what the function does, used by the model to choose when and how to call the function. - parameters: - description: The parameters the functions accepts, described as a JSON Schema object. - description: The input definition information for a function. - FunctionToolCall: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionToolCallDetails' - description: The detailed information about the function called by the model. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents - given function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue. - FunctionToolCallDetails: - type: object - required: - - name - - arguments - - output - properties: - name: - type: string - description: The name of the function. - arguments: - type: string - description: The arguments that the model requires are provided to the named function. - output: - type: string - nullable: true - description: The output of the function, only populated for function calls that have already have had their outputs submitted. - description: The detailed information about the function called by the model. - FunctionToolDefinition: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionDefinition' - description: The definition of the concrete function that the function tool should call. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a function tool as used to configure an assistant. - ListSortOrder: - type: string - enum: - - asc - - desc - description: The available sorting options when requesting a list of response objects. - MessageContent: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - text: '#/components/schemas/MessageTextContent' - image_file: '#/components/schemas/MessageImageFileContent' - description: An abstract representation of a single item of thread message content. - MessageFile: - type: object - required: - - id - - object - - created_at - - message_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message.file - description: The object type, which is always 'thread.message.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - message_id: - type: string - description: The ID of the message that this file is attached to. - description: Information about a file attached to an assistant thread message. - MessageFileCitationTextAnnotation: - type: object - required: - - type - - file_citation - properties: - type: - type: string - enum: - - file_citation - description: The object type, which is always 'file_citation'. - file_citation: - allOf: - - $ref: '#/components/schemas/MessageTextFileCitationDetails' - description: |- - A citation within the message that points to a specific quote from a specific file. - Generated when the assistant uses the "retrieval" tool to search files. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. - MessageFilePathDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific file that the citation is from. - description: An encapsulation of an image file ID, as used by message image content. - MessageFilePathTextAnnotation: - type: object - required: - - type - - file_path - properties: - type: - type: string - enum: - - file_path - description: The object type, which is always 'file_path'. - file_path: - allOf: - - $ref: '#/components/schemas/MessageFilePathDetails' - description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a file located at a specific path. - MessageImageFileContent: - type: object - required: - - type - - image_file - properties: - type: - type: string - enum: - - image_file - description: The object type, which is always 'image_file'. - image_file: - allOf: - - $ref: '#/components/schemas/MessageImageFileDetails' - description: The image file for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of image file content in a thread message. - MessageImageFileDetails: - type: object - required: - - file_id - properties: - file_id: - allOf: - - $ref: '#/components/schemas/MessageImageFileIdDetails' - description: The ID for the file associated with this image. - description: An image reference, as represented in thread message content. - MessageImageFileIdDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific image file. - description: An encapsulation of an image file ID, as used by message image content. - MessageRole: - type: string - enum: - - user - - assistant - description: The possible values for roles attributed to messages in a thread. - MessageTextAnnotation: - type: object - required: - - type - - text - - start_index - - end_index - properties: - type: - type: string - description: The object type. - text: - type: string - description: The textual content associated with this text annotation item. - start_index: - type: integer - format: int32 - description: The first text index associated with this text annotation. - end_index: - type: integer - format: int32 - description: The last text index associated with this text annotation. - discriminator: - propertyName: type - mapping: - file_citation: '#/components/schemas/MessageFileCitationTextAnnotation' - file_path: '#/components/schemas/MessageFilePathTextAnnotation' - description: An abstract representation of an annotation to text thread message content. - MessageTextContent: - type: object - required: - - type - - text - properties: - type: - type: string - enum: - - text - description: The object type, which is always 'text'. - text: - allOf: - - $ref: '#/components/schemas/MessageTextDetails' - description: The text and associated annotations for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of a textual item of thread message content. - MessageTextDetails: - type: object - required: - - value - - annotations - properties: - value: - type: string - description: The text data. - annotations: - type: array - items: - $ref: '#/components/schemas/MessageTextAnnotation' - description: A list of annotations associated with this text. - description: The text and associated annotations for a single item of assistant thread message content. - MessageTextFileCitationDetails: - type: object - required: - - file_id - - quote - properties: - file_id: - type: string - description: The ID of the file associated with this citation. - quote: - type: string - description: The specific quote cited in the associated file. - description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. - OpenAIFile: - type: object - required: - - object - - id - - bytes - - filename - - created_at - - purpose - properties: - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - id: - type: string - description: The identifier, which can be referenced in API endpoints. - bytes: - type: integer - format: int32 - description: The size of the file, in bytes. - filename: - type: string - description: The name of the file. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of a file. - description: Represents an assistant that can call the model and use tools. - RequiredAction: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' - description: An abstract representation of a required action for an assistant thread run to continue. - RetrievalToolCall: - type: object - required: - - type - - retrieval - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - retrieval: - type: object - additionalProperties: - type: string - description: The key/value pairs produced by the retrieval tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents - submitted output needed or already fulfilled by the tool for the model to continue. - RetrievalToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a retrieval tool as used to configure an assistant. - RunError: - type: object - required: - - code - - message - properties: - code: - type: string - description: The status for the error. - message: - type: string - description: The human-readable text associated with the error. - description: The details of an error as encountered by an assistant thread run. - RunStatus: - type: string - enum: - - queued - - in_progress - - requires_action - - cancelling - - cancelled - - failed - - completed - - expired - description: Possible values for the status of an assistant thread run. - RunStep: - type: object - required: - - id - - object - - type - - assistant_id - - thread_id - - run_id - - status - - step_details - - last_error - - created_at - - expired_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run.step - description: The object type, which is always 'thread.run.step'. - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The type of run step, which can be either message_creation or tool_calls. - assistant_id: - type: string - description: The ID of the assistant associated with the run step. - thread_id: - type: string - description: The ID of the thread that was run. - run_id: - type: string - description: The ID of the run that this run step is a part of. - status: - allOf: - - $ref: '#/components/schemas/RunStepStatus' - description: The status of this run step. - step_details: - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The details for this run step. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunStepError' - nullable: true - description: If applicable, information about the last error encountered by this run step. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expired_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expired. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Detailed information about a single step of an assistant thread run. - RunStepDetails: - type: object - required: - - type - properties: - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The object type. - discriminator: - propertyName: type - mapping: - message_creation: '#/components/schemas/RunStepMessageCreationDetails' - tool_calls: '#/components/schemas/RunStepToolCallDetails' - description: An abstract representation of the details for a run step. - RunStepError: - type: object - required: - - code - - message - properties: - code: - allOf: - - $ref: '#/components/schemas/RunStepErrorCode' - description: The error code for this error. - message: - type: string - description: The human-readable text associated with this error. - description: The error information associated with a failed run step. - RunStepErrorCode: - type: string - enum: - - server_error - - rate_limit_exceeded - description: Possible error code values attributable to a failed run step. - RunStepMessageCreationDetails: - type: object - required: - - type - - message_creation - properties: - type: - type: string - enum: - - message_creation - description: The object type, which is always 'message_creation'. - message_creation: - allOf: - - $ref: '#/components/schemas/RunStepMessageCreationReference' - description: Information about the message creation associated with this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a message creation run step. - RunStepMessageCreationReference: - type: object - required: - - message_id - properties: - message_id: - type: string - description: The ID of the message created by this run step. - description: The details of a message created as a part of a run step. - RunStepStatus: - type: string - enum: - - in_progress - - cancelled - - failed - - completed - - expired - description: Possible values for the status of a run step. - RunStepToolCallDetails: - type: object - required: - - type - - tool_calls - properties: - type: - type: string - enum: - - tool_calls - description: The object type, which is always 'tool_calls'. - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: A list tool call details for this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a run step calling tools. - RunStepType: - type: string - enum: - - message_creation - - tool_calls - description: The possible types of run steps. - ServiceApiVersions: - type: string - enum: - - 2023-02-15-preview - description: The known set of supported API versions. - SubmitToolOutputsAction: - type: object - required: - - type - - submit_tool_outputs - properties: - type: - type: string - enum: - - submit_tool_outputs - description: The object type, which is always 'submit_tool_outputs'. - submit_tool_outputs: - allOf: - - $ref: '#/components/schemas/SubmitToolOutputsDetails' - description: The details describing tools that should be called to submit tool outputs. - allOf: - - $ref: '#/components/schemas/RequiredAction' - description: The details for required tool calls that must be submitted for an assistant thread run to continue. - SubmitToolOutputsDetails: - type: object - required: - - tool_calls - properties: - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: The list of tool calls that must be resolved for the assistant thread run to continue. - description: The details describing tools that should be called to submit tool outputs. - ThreadDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - thread.deleted - description: The object type, which is always 'thread.deleted'. - description: The status of a thread deletion operation. - ThreadMessage: - type: object - required: - - id - - object - - created_at - - thread_id - - role - - content - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message - description: The object type, which is always 'thread.message'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - thread_id: - type: string - description: The ID of the thread that this message belongs to. - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role associated with the assistant thread message. - content: - type: array - items: - $ref: '#/components/schemas/MessageContent' - description: The list of content items associated with the assistant thread message. - assistant_id: - type: string - description: If applicable, the ID of the assistant that authored this message. - run_id: - type: string - description: If applicable, the ID of the run associated with the authoring of this message. - file_ids: - type: array - items: - type: string - description: |- - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: A single message within an assistant thread. - ThreadRun: - type: object - required: - - id - - object - - thread_id - - assistant_id - - status - - last_error - - model - - instructions - - tools - - file_ids - - created_at - - expires_at - - started_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run - description: The object type, which is always 'thread.run'. - thread_id: - type: string - description: The ID of the thread associated with this run. - assistant_id: - type: string - description: The ID of the assistant associated with the thread this run was performed against. - status: - allOf: - - $ref: '#/components/schemas/RunStatus' - description: The status of the assistant thread run. - required_action: - type: object - allOf: - - $ref: '#/components/schemas/RequiredAction' - nullable: true - description: The details of the action required for the assistant thread run to continue. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunError' - nullable: true - description: The last error, if any, encountered by this assistant thread run. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - description: The overridden system instructions used for this assistant thread run. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden enabled tools used for this assistant thread run. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expires_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expires. - started_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item was started. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Data representing a single evaluation run of an assistant thread. - ToolCall: - type: object - required: - - type - - id - properties: - type: - type: string - description: The object type. - id: - type: string - description: The ID of the tool call. This ID must be referenced when you submit tool outputs. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolCall' - retrieval: '#/components/schemas/RetrievalToolCall' - function: '#/components/schemas/FunctionToolCall' - description: |- - An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must - be fulfilled and have its outputs submitted before the model can continue. - ToolDefinition: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' - retrieval: '#/components/schemas/RetrievalToolDefinition' - function: '#/components/schemas/FunctionToolDefinition' - description: An abstract representation of an input tool definition that an assistant can use. - ToolOutput: - type: object - properties: - tool_call_id: - type: string - description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. - output: - type: string - description: The output from the tool to be submitted. - description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. - securitySchemes: - ApiKeyAuth: - type: apiKey - in: header - name: api-key - OAuth2Auth: - type: oauth2 - flows: - implicit: - authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize - scopes: - https://cognitiveservices.azure.com/.default: '' -servers: - - url: '{endpoint}' - description: Azure OpenAI APIs for Assistants. - variables: - endpoint: - default: '' - description: An OpenAI endpoint supporting assistants functionality. diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml deleted file mode 100644 index ee485d79df7c..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml +++ /dev/null @@ -1,2388 +0,0 @@ -openapi: 3.0.0 -info: - title: Azure OpenAI - version: 2023-11-06-beta - description: Azure OpenAI APIs for Assistants. -tags: [] -paths: - /assistants: - post: - operationId: createAssistant - description: Creates a new assistant. - parameters: [] - responses: - '200': - description: The new assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantCreationOptions' - get: - operationId: listAssistants - description: Gets a list of assistants that were previously created. - parameters: - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of assistants. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/Assistant' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}: - get: - operationId: getAssistant - description: Retrieves an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve. - schema: - type: string - responses: - '200': - description: The requested assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - post: - operationId: modifyAssistant - description: Modifies an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to modify. - schema: - type: string - responses: - '200': - description: The updated assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - description: The details of the modification to perform on the specified assistant. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantModificationOptions' - delete: - operationId: deleteAssistant - description: Deletes an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantDeletionStatus' - /assistants/{assistantId}/files: - post: - operationId: createAssistantFile - description: Attaches a previously uploaded file to an assistant for use by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to attach the file to. - schema: - type: string - responses: - '200': - description: Information about the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - file_id: - type: string - description: The ID of the previously uploaded file to attach. - required: - - file_id - get: - operationId: listAssistantFiles - description: Gets a list of files attached to a specific assistant, as used by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve the list of attached files for. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of files attached to the specified assistant. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/AssistantFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}/files/{fileId}: - get: - operationId: getAssistantFile - description: Retrieves a file attached to an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant associated with the attached file. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: A representation of the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - delete: - operationId: deleteAssistantFile - description: |- - Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read - files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant from which the specified file should be unlinked. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to unlink from the specified assistant. - schema: - type: string - responses: - '200': - description: Status information about the requested file association deletion. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFileDeletionStatus' - /files: - get: - operationId: listFiles - description: Gets a list of previously uploaded files. - parameters: - - name: purpose - in: query - required: false - description: A value that, when provided, limits list results to files matching the corresponding purpose. - schema: - $ref: '#/components/schemas/FilePurpose' - responses: - '200': - description: The requested list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/FileListResponse' - post: - operationId: createFile - description: Uploads a file for use by other operations. - parameters: [] - responses: - '200': - description: A representation of the uploaded file. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of the file. - filename: - type: string - description: A filename to associate with the uploaded data. - required: - - file - - purpose - /files/{fileId}/{file_id}: - delete: - operationId: deleteFile - description: Delete a previously uploaded file. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to delete. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/FileDeletionStatus' - get: - operationId: retrieveFile - description: Returns information about a specific file. Does not retrieve file content. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - /threads: - post: - operationId: createThread - description: Creates a new thread. Threads contain messages and can be run by assistants. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThreadCreationOptions' - /threads/runs: - post: - operationId: createThreadAndRun - description: Creates a new assistant thread and immediately starts a run using that new thread. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAndRunThreadOptions' - /threads/{threadId}: - get: - operationId: getThread - description: Gets information about an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - post: - operationId: modifyThread - description: Modifies an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to modify. - schema: - type: string - responses: - '200': - description: Information about the modified thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - delete: - operationId: deleteThread - description: Deletes an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested thread deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadDeletionStatus' - /threads/{threadId}/messages: - post: - operationId: createMessage - description: Creates a new message on a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to create the new message on. - schema: - type: string - responses: - '200': - description: A representation of the new message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role to associate with the new message. - content: - type: string - description: The textual content for the new message. - file_ids: - type: array - items: - type: string - description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - role - - content - get: - operationId: listMessages - description: Gets a list of messages that exist on a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list messages from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of messages. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}: - get: - operationId: getMessage - description: Gets an existing message from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve the specified message from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to retrieve from the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the requested message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - post: - operationId: modifyMessage - description: Modifies an existing message on an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the specified message to modify. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to modify on the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the modified message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/messages/{messageId}/files: - get: - operationId: listMessageFiles - description: Gets a list of previously uploaded files associated with a message from a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to list files from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to list files from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of files associated with the specified message. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/MessageFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}/files/{fileId}: - get: - operationId: getMessageFile - description: Gets information about a file attachment to a message within a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to get information from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to get information from. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to get information about. - schema: - type: string - responses: - '200': - description: The requested file information. - content: - application/json: - schema: - $ref: '#/components/schemas/MessageFile' - /threads/{threadId}/runs: - post: - operationId: createRun - description: Creates a new run for an assistant thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to run. - schema: - type: string - responses: - '200': - description: Information about the new thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - assistant_id: - type: string - description: The ID of the assistant that should run the thread. - model: - type: string - description: The overridden model name that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions that the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools that the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - assistant_id - get: - operationId: listRuns - description: Gets a list of runs for a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list runs from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of thread runs. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadRun' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}: - get: - operationId: getRun - description: Gets an existing run from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve run information from. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: The requested information about the specified thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - post: - operationId: modifyRun - description: Modifies an existing thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread associated with the specified run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to modify. - schema: - type: string - responses: - '200': - description: Information about the modified run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/runs/{runId}/cancel: - post: - operationId: cancelRun - description: Cancels a run of an in progress thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread being run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to cancel. - schema: - type: string - responses: - '200': - description: Updated information about the cancelled run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - /threads/{threadId}/runs/{runId}/steps: - get: - operationId: listRunSteps - description: Gets a list of run steps from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to list steps from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of run steps. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/RunStep' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}/steps/{stepId}: - get: - operationId: getRunStep - description: Gets a single run step from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the specific run to retrieve the step from. - schema: - type: string - - name: stepId - in: path - required: true - description: The ID of the step to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested run step. - content: - application/json: - schema: - $ref: '#/components/schemas/RunStep' - /threads/{threadId}/runs/{runId}/submit_tool_outputs: - post: - operationId: submitToolOutputsToRun - description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run that requires tool outputs. - schema: - type: string - responses: - '200': - description: Updated information about the run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tool_outputs: - type: array - items: - $ref: '#/components/schemas/ToolOutput' - description: The list of tool outputs requested by tool calls from the specified run. - required: - - tool_outputs -security: - - ApiKeyAuth: [] - - OAuth2Auth: - - https://cognitiveservices.azure.com/.default -components: - schemas: - Assistant: - type: object - required: - - id - - object - - created_at - - name - - description - - model - - instructions - - tools - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant - description: The object type, which is always assistant. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - name: - type: string - nullable: true - description: The name of the assistant. - description: - type: string - nullable: true - description: The description of the assistant. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - nullable: true - description: The system instructions for the assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools enabled for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Represents an assistant that can call the model and use tools. - AssistantCreationOptions: - type: object - required: - - model - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The name of the new assistant. - description: - type: string - nullable: true - description: The description of the new assistant. - instructions: - type: string - nullable: true - description: The system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools to enable for the new assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of previously uploaded file IDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when creating a new assistant. - AssistantDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.deleted - description: The object type, which is always 'assistant.deleted'. - description: The status of an assistant deletion operation. - AssistantFile: - type: object - required: - - id - - object - - created_at - - assistant_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant.file - description: The object type, which is always 'assistant.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - assistant_id: - type: string - description: The assistant ID that the file is attached to. - description: Information about a file attached to an assistant, as used by tools that can read files. - AssistantFileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.file.deleted - description: The object type, which is always 'assistant.file.deleted'. - description: The status of an assistant file deletion operation. - AssistantModificationOptions: - type: object - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The modified name for the assistant to use. - description: - type: string - nullable: true - description: The modified description for the assistant to use. - instructions: - type: string - nullable: true - description: The modified system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The modified collection of tools to enable for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: The modified list of previously uploaded fileIDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when modifying an existing assistant. - AssistantThread: - type: object - required: - - id - - object - - created_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread - description: The object type, which is always 'thread'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Information about a single thread associated with an assistant. - AssistantThreadCreationOptions: - type: object - properties: - messages: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The messages to associate with the new thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used to create a new assistant thread. - CodeInterpreterImageOutput: - type: object - required: - - type - - image - properties: - type: - type: string - enum: - - image - description: The object type, which is always 'image'. - image: - allOf: - - $ref: '#/components/schemas/CodeInterpreterImageReference' - description: Referential information for the image associated with this output. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterImageReference: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the file associated with this image. - description: An image reference emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterLogOutput: - type: object - required: - - type - - logs - properties: - type: - type: string - enum: - - logs - description: The object type, which is always 'logs'. - logs: - type: string - description: The serialized log output emitted by the code interpreter. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterToolCall: - type: object - required: - - type - - code_interpreter - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - code_interpreter: - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallDetails' - description: The details of the tool call to the code interpreter tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that - represents submitted output needed or already fulfilled by the tool for the model to continue. - CodeInterpreterToolCallDetails: - type: object - required: - - input - - outputs - properties: - input: - type: string - description: The input provided by the model to the code interpreter tool. - outputs: - type: array - items: - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: The outputs produced by the code interpreter tool back to the model in response to the tool call. - description: The detailed information about a code interpreter invocation by the model. - CodeInterpreterToolCallOutput: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - logs: '#/components/schemas/CodeInterpreterLogOutput' - image: '#/components/schemas/CodeInterpreterImageOutput' - description: An abstract representation of an emitted output from a code interpreter tool. - CodeInterpreterToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a code interpreter tool as used to configure an assistant. - CreateAndRunThreadOptions: - type: object - required: - - assistant_id - properties: - assistant_id: - type: string - description: The ID of the assistant for which the thread should be created. - thread: - allOf: - - $ref: '#/components/schemas/AssistantThreadCreationOptions' - description: The details used to create the new thread. - model: - type: string - description: The overridden model that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used when creating and immediately running a new assistant thread. - FileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - description: A status response from a file deletion operation. - FileListResponse: - type: object - required: - - object - - data - properties: - object: - type: string - enum: - - list - description: The object type, which is always 'list'. - data: - type: array - items: - $ref: '#/components/schemas/OpenAIFile' - description: The files returned for the request. - description: The response data from a file list operation. - FilePurpose: - type: string - enum: - - fine-tune - - fine-tune-results - - assistants - - assistants_output - description: The possible values denoting the intended usage of a file. - FunctionDefinition: - type: object - required: - - name - - parameters - properties: - name: - type: string - description: The name of the function to be called. - description: - type: string - description: A description of what the function does, used by the model to choose when and how to call the function. - parameters: - description: The parameters the functions accepts, described as a JSON Schema object. - description: The input definition information for a function. - FunctionToolCall: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionToolCallDetails' - description: The detailed information about the function called by the model. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents - given function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue. - FunctionToolCallDetails: - type: object - required: - - name - - arguments - - output - properties: - name: - type: string - description: The name of the function. - arguments: - type: string - description: The arguments that the model requires are provided to the named function. - output: - type: string - nullable: true - description: The output of the function, only populated for function calls that have already have had their outputs submitted. - description: The detailed information about the function called by the model. - FunctionToolDefinition: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionDefinition' - description: The definition of the concrete function that the function tool should call. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a function tool as used to configure an assistant. - ListSortOrder: - type: string - enum: - - asc - - desc - description: The available sorting options when requesting a list of response objects. - MessageContent: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - text: '#/components/schemas/MessageTextContent' - image_file: '#/components/schemas/MessageImageFileContent' - description: An abstract representation of a single item of thread message content. - MessageFile: - type: object - required: - - id - - object - - created_at - - message_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message.file - description: The object type, which is always 'thread.message.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - message_id: - type: string - description: The ID of the message that this file is attached to. - description: Information about a file attached to an assistant thread message. - MessageFileCitationTextAnnotation: - type: object - required: - - type - - file_citation - properties: - type: - type: string - enum: - - file_citation - description: The object type, which is always 'file_citation'. - file_citation: - allOf: - - $ref: '#/components/schemas/MessageTextFileCitationDetails' - description: |- - A citation within the message that points to a specific quote from a specific file. - Generated when the assistant uses the "retrieval" tool to search files. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. - MessageFilePathDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific file that the citation is from. - description: An encapsulation of an image file ID, as used by message image content. - MessageFilePathTextAnnotation: - type: object - required: - - type - - file_path - properties: - type: - type: string - enum: - - file_path - description: The object type, which is always 'file_path'. - file_path: - allOf: - - $ref: '#/components/schemas/MessageFilePathDetails' - description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a file located at a specific path. - MessageImageFileContent: - type: object - required: - - type - - image_file - properties: - type: - type: string - enum: - - image_file - description: The object type, which is always 'image_file'. - image_file: - allOf: - - $ref: '#/components/schemas/MessageImageFileDetails' - description: The image file for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of image file content in a thread message. - MessageImageFileDetails: - type: object - required: - - file_id - properties: - file_id: - allOf: - - $ref: '#/components/schemas/MessageImageFileIdDetails' - description: The ID for the file associated with this image. - description: An image reference, as represented in thread message content. - MessageImageFileIdDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific image file. - description: An encapsulation of an image file ID, as used by message image content. - MessageRole: - type: string - enum: - - user - - assistant - description: The possible values for roles attributed to messages in a thread. - MessageTextAnnotation: - type: object - required: - - type - - text - - start_index - - end_index - properties: - type: - type: string - description: The object type. - text: - type: string - description: The textual content associated with this text annotation item. - start_index: - type: integer - format: int32 - description: The first text index associated with this text annotation. - end_index: - type: integer - format: int32 - description: The last text index associated with this text annotation. - discriminator: - propertyName: type - mapping: - file_citation: '#/components/schemas/MessageFileCitationTextAnnotation' - file_path: '#/components/schemas/MessageFilePathTextAnnotation' - description: An abstract representation of an annotation to text thread message content. - MessageTextContent: - type: object - required: - - type - - text - properties: - type: - type: string - enum: - - text - description: The object type, which is always 'text'. - text: - allOf: - - $ref: '#/components/schemas/MessageTextDetails' - description: The text and associated annotations for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of a textual item of thread message content. - MessageTextDetails: - type: object - required: - - value - - annotations - properties: - value: - type: string - description: The text data. - annotations: - type: array - items: - $ref: '#/components/schemas/MessageTextAnnotation' - description: A list of annotations associated with this text. - description: The text and associated annotations for a single item of assistant thread message content. - MessageTextFileCitationDetails: - type: object - required: - - file_id - - quote - properties: - file_id: - type: string - description: The ID of the file associated with this citation. - quote: - type: string - description: The specific quote cited in the associated file. - description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. - OpenAIFile: - type: object - required: - - object - - id - - bytes - - filename - - created_at - - purpose - properties: - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - id: - type: string - description: The identifier, which can be referenced in API endpoints. - bytes: - type: integer - format: int32 - description: The size of the file, in bytes. - filename: - type: string - description: The name of the file. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of a file. - description: Represents an assistant that can call the model and use tools. - RequiredAction: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' - description: An abstract representation of a required action for an assistant thread run to continue. - RetrievalToolCall: - type: object - required: - - type - - retrieval - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - retrieval: - type: object - additionalProperties: - type: string - description: The key/value pairs produced by the retrieval tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents - submitted output needed or already fulfilled by the tool for the model to continue. - RetrievalToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a retrieval tool as used to configure an assistant. - RunError: - type: object - required: - - code - - message - properties: - code: - type: string - description: The status for the error. - message: - type: string - description: The human-readable text associated with the error. - description: The details of an error as encountered by an assistant thread run. - RunStatus: - type: string - enum: - - queued - - in_progress - - requires_action - - cancelling - - cancelled - - failed - - completed - - expired - description: Possible values for the status of an assistant thread run. - RunStep: - type: object - required: - - id - - object - - type - - assistant_id - - thread_id - - run_id - - status - - step_details - - last_error - - created_at - - expired_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run.step - description: The object type, which is always 'thread.run.step'. - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The type of run step, which can be either message_creation or tool_calls. - assistant_id: - type: string - description: The ID of the assistant associated with the run step. - thread_id: - type: string - description: The ID of the thread that was run. - run_id: - type: string - description: The ID of the run that this run step is a part of. - status: - allOf: - - $ref: '#/components/schemas/RunStepStatus' - description: The status of this run step. - step_details: - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The details for this run step. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunStepError' - nullable: true - description: If applicable, information about the last error encountered by this run step. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expired_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expired. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Detailed information about a single step of an assistant thread run. - RunStepDetails: - type: object - required: - - type - properties: - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The object type. - discriminator: - propertyName: type - mapping: - message_creation: '#/components/schemas/RunStepMessageCreationDetails' - tool_calls: '#/components/schemas/RunStepToolCallDetails' - description: An abstract representation of the details for a run step. - RunStepError: - type: object - required: - - code - - message - properties: - code: - allOf: - - $ref: '#/components/schemas/RunStepErrorCode' - description: The error code for this error. - message: - type: string - description: The human-readable text associated with this error. - description: The error information associated with a failed run step. - RunStepErrorCode: - type: string - enum: - - server_error - - rate_limit_exceeded - description: Possible error code values attributable to a failed run step. - RunStepMessageCreationDetails: - type: object - required: - - type - - message_creation - properties: - type: - type: string - enum: - - message_creation - description: The object type, which is always 'message_creation'. - message_creation: - allOf: - - $ref: '#/components/schemas/RunStepMessageCreationReference' - description: Information about the message creation associated with this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a message creation run step. - RunStepMessageCreationReference: - type: object - required: - - message_id - properties: - message_id: - type: string - description: The ID of the message created by this run step. - description: The details of a message created as a part of a run step. - RunStepStatus: - type: string - enum: - - in_progress - - cancelled - - failed - - completed - - expired - description: Possible values for the status of a run step. - RunStepToolCallDetails: - type: object - required: - - type - - tool_calls - properties: - type: - type: string - enum: - - tool_calls - description: The object type, which is always 'tool_calls'. - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: A list tool call details for this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a run step calling tools. - RunStepType: - type: string - enum: - - message_creation - - tool_calls - description: The possible types of run steps. - ServiceApiVersions: - type: string - enum: - - 2023-11-06-beta - description: The known set of supported API versions. - SubmitToolOutputsAction: - type: object - required: - - type - - submit_tool_outputs - properties: - type: - type: string - enum: - - submit_tool_outputs - description: The object type, which is always 'submit_tool_outputs'. - submit_tool_outputs: - allOf: - - $ref: '#/components/schemas/SubmitToolOutputsDetails' - description: The details describing tools that should be called to submit tool outputs. - allOf: - - $ref: '#/components/schemas/RequiredAction' - description: The details for required tool calls that must be submitted for an assistant thread run to continue. - SubmitToolOutputsDetails: - type: object - required: - - tool_calls - properties: - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: The list of tool calls that must be resolved for the assistant thread run to continue. - description: The details describing tools that should be called to submit tool outputs. - ThreadDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - thread.deleted - description: The object type, which is always 'thread.deleted'. - description: The status of a thread deletion operation. - ThreadMessage: - type: object - required: - - id - - object - - created_at - - thread_id - - role - - content - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message - description: The object type, which is always 'thread.message'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - thread_id: - type: string - description: The ID of the thread that this message belongs to. - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role associated with the assistant thread message. - content: - type: array - items: - $ref: '#/components/schemas/MessageContent' - description: The list of content items associated with the assistant thread message. - assistant_id: - type: string - description: If applicable, the ID of the assistant that authored this message. - run_id: - type: string - description: If applicable, the ID of the run associated with the authoring of this message. - file_ids: - type: array - items: - type: string - description: |- - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: A single message within an assistant thread. - ThreadRun: - type: object - required: - - id - - object - - thread_id - - assistant_id - - status - - last_error - - model - - instructions - - tools - - file_ids - - created_at - - expires_at - - started_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run - description: The object type, which is always 'thread.run'. - thread_id: - type: string - description: The ID of the thread associated with this run. - assistant_id: - type: string - description: The ID of the assistant associated with the thread this run was performed against. - status: - allOf: - - $ref: '#/components/schemas/RunStatus' - description: The status of the assistant thread run. - required_action: - type: object - allOf: - - $ref: '#/components/schemas/RequiredAction' - nullable: true - description: The details of the action required for the assistant thread run to continue. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunError' - nullable: true - description: The last error, if any, encountered by this assistant thread run. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - description: The overridden system instructions used for this assistant thread run. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden enabled tools used for this assistant thread run. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expires_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expires. - started_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item was started. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Data representing a single evaluation run of an assistant thread. - ToolCall: - type: object - required: - - type - - id - properties: - type: - type: string - description: The object type. - id: - type: string - description: The ID of the tool call. This ID must be referenced when you submit tool outputs. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolCall' - retrieval: '#/components/schemas/RetrievalToolCall' - function: '#/components/schemas/FunctionToolCall' - description: |- - An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must - be fulfilled and have its outputs submitted before the model can continue. - ToolDefinition: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' - retrieval: '#/components/schemas/RetrievalToolDefinition' - function: '#/components/schemas/FunctionToolDefinition' - description: An abstract representation of an input tool definition that an assistant can use. - ToolOutput: - type: object - properties: - tool_call_id: - type: string - description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. - output: - type: string - description: The output from the tool to be submitted. - description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. - securitySchemes: - ApiKeyAuth: - type: apiKey - in: header - name: api-key - OAuth2Auth: - type: oauth2 - flows: - implicit: - authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize - scopes: - https://cognitiveservices.azure.com/.default: '' -servers: - - url: '{endpoint}' - description: Azure OpenAI APIs for Assistants. - variables: - endpoint: - default: '' - description: An OpenAI endpoint supporting assistants functionality. diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index 50ff2a97ab68..f9a9e7602c4a 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -366,6 +366,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ThreadMessage' + requestBody: + description: Body parameter. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessageOptions' get: operationId: listMessages description: Gets a list of messages that exist on a thread. @@ -516,7 +523,6 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: - description: The details for the run to create. required: true content: application/json: @@ -2510,6 +2516,32 @@ components: nullable: true description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. description: A single, existing message within an assistant thread. + ThreadMessageOptions: + type: object + required: + - role + - content + properties: + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: |- + The role of the entity that is creating the message. Allowed values include: + - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. + - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into + the conversation. + content: + type: string + description: |- + The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via + a separate call to the create message API. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A single message within an assistant thread, as provided during that thread's creation for its initial state. ThreadRun: type: object required: diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index 7e0ac545e325..4a68786a0ff0 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -367,7 +367,7 @@ paths: schema: $ref: '#/components/schemas/ThreadMessage' requestBody: - description: A single message within an assistant thread, as provided during that thread's creation for its initial state. + description: Body parameter. required: true content: application/json: @@ -529,7 +529,6 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: - description: The details for the run to create. required: true content: application/json: diff --git a/specification/ai/data-plane/OpenAI.Assistants/readme.md b/specification/ai/data-plane/OpenAI.Assistants/readme.md new file mode 100644 index 000000000000..5733840ef282 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/readme.md @@ -0,0 +1,38 @@ +# AI OpenAI.Assistants SDK + +> see https://aka.ms/autorest + +Configuration for generating AzureOpenAI Inference SDK. + +The current release for the AzureOpenAI is `release_2024_05_01`. + +``` yaml +tag: release_2023_05_15 +add-credentials: true +openapi-type: data-plane +``` + +## Suppression + +``` yaml +directive: + - suppress: INVALID_TYPE + from: assistants_generated.json + reason: A bug in oav is preventing a x-nullable attribute on incomplete_details from being honored. +``` + +# Releases + +## OpenAI.Assistants 2024-02-15-preview (generated) +These settings apply only when `--tag=release_2024_02_15_preview_autogen` is specified on the command line. + +``` yaml $(tag) == 'release_2024_02_15_preview_autogen' +input-file: OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +``` + +## OpenAI.Assistants 2024-05-01-preview (generated) +These settings apply only when `--tag=release_2024_05_01_preview_autogen` is specified on the command line. + +``` yaml $(tag) == 'release_2024_05_01_preview_autogen' +input-file: OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +``` From 1b788be606fa5e71853d7181ccbc500ea9ecbeb6 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 10 Jul 2024 11:33:55 -0700 Subject: [PATCH 302/343] [TypeSpec] Upgrade typespec-apiview to 0.4.9 (#29783) --- package-lock.json | 12 ++++++------ package.json | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/package-lock.json b/package-lock.json index 2ef4d7683924..d944b3309f4a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,7 +6,7 @@ "": { "name": "azure-rest-api-specs", "devDependencies": { - "@azure-tools/typespec-apiview": "0.4.8", + "@azure-tools/typespec-apiview": "0.4.9", "@azure-tools/typespec-autorest": "0.43.0", "@azure-tools/typespec-azure-core": "0.43.0", "@azure-tools/typespec-azure-portal-core": "0.43.0", @@ -490,16 +490,16 @@ "link": true }, "node_modules/@azure-tools/typespec-apiview": { - "version": "0.4.8", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-apiview/-/typespec-apiview-0.4.8.tgz", - "integrity": "sha512-9608+exEW9R4rjfZlGeXkfIoz6Xrg2EZGnF/lVaT/jWR/LdzDr1EoGtxKgo4mUlHK4rhLB3TOO8Gx/WW901+kA==", + "version": "0.4.9", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-apiview/-/typespec-apiview-0.4.9.tgz", + "integrity": "sha512-44KT4okSi5/tcCMWZqy9kOu+1I4BcB3Cyh8mu5XakVnAOHWjDPelbMm/4Vi/EpUKHSCTCYCRVno3j3Wz0M6Ppg==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": ">=0.52 <1.0", - "@typespec/versioning": ">=0.52 <1.0" + "@typespec/compiler": ">=0.57 <1.0", + "@typespec/versioning": ">=0.57 <1.0" } }, "node_modules/@azure-tools/typespec-autorest": { diff --git a/package.json b/package.json index 9b953df05fc1..2e9c0bdeb944 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "azure-rest-api-specs", "devDependencies": { - "@azure-tools/typespec-apiview": "0.4.8", + "@azure-tools/typespec-apiview": "0.4.9", "@azure-tools/typespec-autorest": "0.43.0", "@azure-tools/typespec-azure-core": "0.43.0", "@azure-tools/typespec-azure-portal-core": "0.43.0", From 1b0e82df2f7f953796af2aee0372e34e00baa2d2 Mon Sep 17 00:00:00 2001 From: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Date: Wed, 10 Jul 2024 11:34:09 -0700 Subject: [PATCH 303/343] Fix casing of timestamp properties (#29675) * Fix casing of timestamp properties * Fix examples * more examples * property overrides * regen swagger --- .../AzureCommunicationServices.tsp | 4 ++-- .../2024-01-01/email_delivery_report_received.json | 2 +- .../email_engagement_tracking_report_received.json | 2 +- .../propertyNameOverride.tsp | 8 -------- .../propertyNameOverrideCsharp.tsp | 8 -------- .../propertyNameOverrideGo.tsp | 8 -------- .../propertyNameOverrideJs.tsp | 10 ++-------- .../2018-01-01/AzureCommunicationServices.json | 10 ++++------ .../email_delivery_report_received.json | 2 +- .../email_engagement_tracking_report_received.json | 2 +- .../email_delivery_report_received.json | 2 +- .../email_engagement_tracking_report_received.json | 2 +- .../stable/2024-01-01/SystemEvents.json | 14 ++++++-------- 13 files changed, 20 insertions(+), 54 deletions(-) diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp index 69b9b1966ffb..634f85970444 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp @@ -252,7 +252,7 @@ model AcsEmailDeliveryReportReceivedEventData { deliveryStatusDetails: AcsEmailDeliveryReportStatusDetails; /** The time at which the email delivery report received timestamp */ - deliveryAttemptTimeStamp: utcDateTime; + deliveryAttemptTimestamp: utcDateTime; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event. */ @@ -267,7 +267,7 @@ model AcsEmailEngagementTrackingReportReceivedEventData { messageId?: string; /** The time at which the user interacted with the email */ - userActionTimeStamp: utcDateTime; + userActionTimestamp: utcDateTime; /** The context of the type of engagement user had with email */ engagementContext?: string; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_delivery_report_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_delivery_report_received.json index bf96f5e6b66f..51dddcbc6d56 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_delivery_report_received.json +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_delivery_report_received.json @@ -7,7 +7,7 @@ "recipient": "test1@contoso.com", "messageId": "950850f5-bcdf-4315-b77a-6447cf56fac9", "status": "delivered", - "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00" + "deliveryAttemptTimestamp": "2023-02-09T19:46:12.2480265+00:00" }, "type": "Microsoft.Communication.EmailDeliveryReportReceived", "time": "2023-02-09T19:46:12.2478002Z", diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_engagement_tracking_report_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_engagement_tracking_report_received.json index 85f10a93a965..f45a02148908 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_engagement_tracking_report_received.json +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_engagement_tracking_report_received.json @@ -5,7 +5,7 @@ "data": { "sender": "test2@contoso.org", "messageId": "fe26a737-6941-410c-b126-7eacbe4035d1", - "userActionTimeStamp": "2023-02-09T20:07:22.745555+00:00", + "userActionTimestamp": "2023-02-09T20:07:22.745555+00:00", "engagementContext": "www.example.com", "userAgent": "Desktop", "engagementType": "click" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp index 1b2b2247d318..afce376662a8 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp @@ -25,14 +25,6 @@ using Azure.ClientGenerator.Core; ); @@clientName(AcsRouterWorkerSelector.value, "labelValue", "autorest"); -@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, - "deliveryAttemptTimestamp", - "autorest" -); -@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, - "userActionTimestamp", - "autorest" -); @@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, "engagement", "autorest" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp index 60933e665420..5bb8dea15e6d 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp @@ -23,14 +23,6 @@ using Microsoft.EventGrid.SystemEvents; "csharp" ); -@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, - "deliveryAttemptTimestamp", - "csharp" -); -@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, - "userActionTimestamp", - "csharp" -); @@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, "engagement", "csharp" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp index 3f1332b43f72..67d69823970f 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp @@ -333,10 +333,6 @@ using Microsoft.EventGrid.SystemEvents; "ACSEmailDeliveryReportReceivedEventData", "go" ); -@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, - "DeliveryAttemptTimestamp", - "go" -); @@clientName(AcsEmailDeliveryReportStatus, "ACSEmailDeliveryReportStatus", @@ -355,10 +351,6 @@ using Microsoft.EventGrid.SystemEvents; "Engagement", "go" ); -@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, - "UserActionTimestamp", - "go" -); @@clientName(AcsIncomingCallCustomContext, "ACSIncomingCallCustomContext", diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp index aae89181bef8..b729151e8e59 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp @@ -45,10 +45,7 @@ using Microsoft.EventGrid.SystemEvents; "toCommunicationIdentifier", "javascript" ); -@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, - "userActionTimestamp", - "javascript" -); + @@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, "engagement", "javascript" @@ -65,10 +62,7 @@ using Microsoft.EventGrid.SystemEvents; "summaryReportBlobUri", "javascript" ); -@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, - "deliveryAttemptTimestamp", - "javascript" -); + @@clientName(ResourceNotificationsResourceUpdatedEventData.resourceInfo, "resourceDetails", "javascript" diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 8cbf69a50d02..4228c52100eb 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -1480,11 +1480,10 @@ "description": "Detailed information about the status if any", "$ref": "#/definitions/AcsEmailDeliveryReportStatusDetails" }, - "deliveryAttemptTimeStamp": { + "deliveryAttemptTimestamp": { "description": "The time at which the email delivery report received timestamp", "format": "date-time", - "type": "string", - "x-ms-client-name": "deliveryAttemptTimestamp" + "type": "string" } } }, @@ -1504,11 +1503,10 @@ "description": "The Id of the email that has been sent", "type": "string" }, - "userActionTimeStamp": { + "userActionTimestamp": { "description": "The time at which the user interacted with the email", "format": "date-time", - "type": "string", - "x-ms-client-name": "userActionTimestamp" + "type": "string" }, "engagementContext": { "description": "The context of the type of engagement user had with email", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_delivery_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_delivery_report_received.json index cefae0de0469..73732b719478 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_delivery_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_delivery_report_received.json @@ -7,7 +7,7 @@ "recipient": "test1@contoso.com", "messageId": "950850f5-bcdf-4315-b77a-6447cf56fac9", "status": "delivered", - "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00" + "deliveryAttemptTimestamp": "2023-02-09T19:46:12.2480265+00:00" }, "type": "Microsoft.Communication.EmailDeliveryReportReceived", "time": "2023-02-09T19:46:12.2478002Z", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_engagement_tracking_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_engagement_tracking_report_received.json index a3f80e9ec99f..aeff3ea6ff26 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_engagement_tracking_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_engagement_tracking_report_received.json @@ -5,7 +5,7 @@ "data": { "sender": "test2@contoso.org", "messageId": "fe26a737-6941-410c-b126-7eacbe4035d1", - "userActionTimeStamp": "2023-02-09T20:07:22.745555+00:00", + "userActionTimestamp": "2023-02-09T20:07:22.745555+00:00", "engagementContext": "www.example.com", "userAgent": "Desktop", "engagementType": "click" diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json index cd033a72e70a..47d4fc8b7d68 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json @@ -7,7 +7,7 @@ "recipient": "test1@contoso.com", "messageId": "950850f5-bcdf-4315-b77a-6447cf56fac9", "status": "delivered", - "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00", + "deliveryAttemptTimestamp": "2023-02-09T19:46:12.2480265+00:00", "deliveryStatusDetails": { "statusMessage": "DestinationMailboxFull" } diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_engagement_tracking_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_engagement_tracking_report_received.json index 7b543b7e3444..65bc2f04746e 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_engagement_tracking_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_engagement_tracking_report_received.json @@ -5,7 +5,7 @@ "data": { "sender": "test2@contoso.org", "messageId": "fe26a737-6941-410c-b126-7eacbe4035d1", - "userActionTimeStamp": "2023-02-09T20:07:22.745555+00:00", + "userActionTimestamp": "2023-02-09T20:07:22.745555+00:00", "engagementContext": "www.example.com", "userAgent": "Desktop", "engagementType": "click" diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json index 292cc198dde2..3de7019fb636 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json @@ -718,17 +718,16 @@ "$ref": "#/definitions/AcsEmailDeliveryReportStatusDetails", "description": "Detailed information about the status if any" }, - "deliveryAttemptTimeStamp": { + "deliveryAttemptTimestamp": { "type": "string", "format": "date-time", - "description": "The time at which the email delivery report received timestamp", - "x-ms-client-name": "deliveryAttemptTimestamp" + "description": "The time at which the email delivery report received timestamp" } }, "required": [ "status", "deliveryStatusDetails", - "deliveryAttemptTimeStamp" + "deliveryAttemptTimestamp" ] }, "AcsEmailDeliveryReportStatus": { @@ -805,11 +804,10 @@ "type": "string", "description": "The Id of the email that has been sent" }, - "userActionTimeStamp": { + "userActionTimestamp": { "type": "string", "format": "date-time", - "description": "The time at which the user interacted with the email", - "x-ms-client-name": "userActionTimestamp" + "description": "The time at which the user interacted with the email" }, "engagementContext": { "type": "string", @@ -826,7 +824,7 @@ } }, "required": [ - "userActionTimeStamp", + "userActionTimestamp", "engagementType" ] }, From 0117e474a03d0b5b4cdd3b713105ae17196c18ce Mon Sep 17 00:00:00 2001 From: Osahumen Uyi Aghasomwan <65305780+osaghaso@users.noreply.github.com> Date: Wed, 10 Jul 2024 12:55:38 -0700 Subject: [PATCH 304/343] adding MessageAnalysisCompletedEvent to EG SDk (#28912) * adding MessageAnalysisCompletedEvent to EG SDk * adding event to communication tps * generating spec * generating spec * removing sentiment * removing sentiment * removing sentiment * more changes * addressing comments * updating the analysis events * updating the analysis events * updating the analysis events * Update specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json * tsp format --------- Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Co-authored-by: l0lawrence --- .../AzureCommunicationServices.tsp | 31 +++++++ .../Microsoft.Communication/client.tsp | 6 ++ .../AzureCommunicationServices.json | 88 +++++++++++++++++++ .../advanced_message_analysis_completed.json | 25 ++++++ ...anced_message_delivery_status_updated.json | 4 +- .../advanced_message_received.json | 8 +- .../advanced_message_analysis_completed.json | 26 ++++++ ...anced_message_delivery_status_updated.json | 4 +- .../advanced_message_received.json | 8 +- .../stable/2024-01-01/SystemEvents.json | 65 ++++++++++++++ 10 files changed, 253 insertions(+), 12 deletions(-) create mode 100644 specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_analysis_completed.json create mode 100644 specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_analysis_completed.json diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp index 634f85970444..3470904b4b15 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp @@ -1160,6 +1160,25 @@ model AcsMessageReceivedEventData extends AcsMessageEventData { interactive: AcsMessageInteractiveContent; } +/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageAnalysisCompleted event. */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." +model AcsMessageAnalysisCompletedEventData extends AcsMessageEventData { + /** The original message received. */ + originalMessage: string; + + /** The analysed message channel kind. */ + channelKind: AcsMessageChannelKind; + + /** The intent of the analysed message. */ + intentAnalysis: string; + + /** List of key phrases extracted. */ + extractedKeyPhrases: string[]; + + /** The analysed message language detection. */ + languageDetection: AcsMessageLanguageDetection; +} + /** Message Media Content */ model AcsMessageMediaContent { /** The MIME type of the file this media represents */ @@ -1250,6 +1269,18 @@ model AcsMessageChannelEventError { channelMessage?: string; } +/** Message Analysis Language Detection */ +model AcsMessageLanguageDetection { + /** The language of the message. */ + language: string; + + /** The confidence score of the language detected. */ + confidenceScore: float64; + + /** The translation of the message. */ + translation: string; +} + /** Interactive reply kind */ union AcsInteractiveReplyKind { /** Messaged interactive reply type is ButtonReply */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp index 71570ba1be06..9912ae7c7b4b 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp @@ -511,3 +511,9 @@ using Azure.ClientGenerator.Core; @@access(Microsoft.EventGrid.SystemEvents.CommunicationCloudEnvironmentModel, Access.public ); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageAnalysisCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageAnalysisCompletedEventData, + Access.public +); diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 4228c52100eb..f478d0889f89 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -1671,6 +1671,70 @@ } } }, + "AcsMessageAnalysisCompletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageAnalysisCompleted event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ], + "properties": { + "originalMessage": { + "description": "The original message received", + "type": "string" + }, + "channelType": { + "description": "The Analysed message channel Kind", + "type": "string", + "x-ms-client-name": "channelKind", + "enum": [ + "whatsapp" + ], + "x-ms-enum": { + "name": "AcsMessageChannelKind", + "modelAsString": true, + "values": [ + { + "value": "whatsapp", + "description": "Updated message channel type is Whatsapp" + } + ] + } + }, + "intentAnalysis": { + "description": "The intent of the analysed message", + "type": "string" + }, + "extractedKeyPhrases": { + "description": "List of key phrases extracted", + "type": "array", + "items": { + "type": "string" + } + }, + "languageDetection": { + "description": "The analysed message language detection", + "$ref": "#/definitions/AcsMessageLanguageDetection", + "type": "object" + } + }, + "required": [ + "originalMessage", + "channelType", + "intentAnalysis", + "extractedKeyPhrases", + "languageDetection" + ], + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/advanced_message_analysis_completed.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/advanced_message_analysis_completed.json" + } + } + }, "AcsMessageEventData": { "description": "Schema of common properties of all chat thread events", "type": "object", @@ -2338,6 +2402,30 @@ "type": "string" } } + }, + "AcsMessageLanguageDetection": { + "description": "Message Analysis Language Detection", + "type": "object", + "properties": { + "language": { + "description": "The language of the message", + "type": "string" + }, + "confidenceScore": { + "description": "The confidence score of the language detected", + "type": "number", + "format": "double" + }, + "translation": { + "description": "The translation of the message", + "type": "string" + } + }, + "required": [ + "language", + "confidenceScore", + "translation" + ] } } } diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_analysis_completed.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_analysis_completed.json new file mode 100644 index 000000000000..785cff903af8 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_analysis_completed.json @@ -0,0 +1,25 @@ +{ + "id": "daa5be3b-2652-4eb1-b330-689aaf6606d7", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "advanceMessageAnalysis/sender/{sender@id}/recipient/{recipient@id}", + "data": { + "originalMessage": "Yesterday I talked to sara parker, she said that my package did not arrive in Kalamazoo, but was sent to lafeyette instead. So said that I should get in touch with herb and he will help me. My order number is #567890. Can you please help me track my package? I'm really frustrated", + "channelType": "whatsapp", + "from": "{sender@id}", + "to": "{recipient@id}", + "languageDetection": { + "language": "English", + "confidenceScore": 0.99, + "translation": "Yesterday I talked to sara parker, she said that my package did not arrive in Kalamazoo, but was sent to lafeyette instead. So said that I should get in touch with herb and he will help me. My order number is #567890. Can you please help me track my package? I'm really frustrated" + }, + "intentAnalysis": "The customer is contacting customer service to request assistance with tracking their package.", + "keyphraseExtraction": [ + "Sara Parker", + "package", + "Kalamazoo" + ] + }, + "type": "Microsoft.Communication.AdvancedMessageAnalysisCompleted", + "specVersion": "1.0", + "time": "2023-02-01T01:54:35.567235Z" +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_delivery_status_updated.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_delivery_status_updated.json index 76c09ffb8d9c..315151bb8ca8 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_delivery_status_updated.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_delivery_status_updated.json @@ -5,8 +5,8 @@ "messageId": "d59f9468-0a5c-4022-8200-d7bf6fb78bc5", "status": "delivered", "channelType": "whatsapp", - "from": "12375679879", - "to": "1345679879", + "from": "{recipient@id}", + "to": "{sender@id}", "receivedTimestamp": "2024-03-22T17:06:11.1980225+00:00", "error": { "channelCode": "channelCode", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_received.json index bf349b0c6e80..ca72b1f2ca79 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_received.json @@ -1,7 +1,7 @@ { "id": "4611364c-08fb-4a8a-a8b5-7e40203285d3", "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", - "subject": "advancedMessage/sender/18334411877/recipient/be57b49d-5cd4-4f96-9a6b-4af41bc9fdfb", + "subject": "advancedMessage/sender/{sender@id}/recipient/{recipient@id}", "data": { "content": "Come on guys, lets go for lunch together.", "channelType": "whatsapp", @@ -12,7 +12,7 @@ "caption": "caption" }, "context": { - "from": "1234578988", + "from": "{recipient@id}", "id": "messageId" }, "button": { @@ -26,8 +26,8 @@ "title": "button reply" } }, - "from": "12375679879", - "to": "1345679879", + "from": "{recipient@id}", + "to": "{sender@id}", "receivedTimestamp": "2024-03-22T17:06:11.2610383+00:00", "error": { "channelCode": "channelCode", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_analysis_completed.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_analysis_completed.json new file mode 100644 index 000000000000..2639451abe43 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_analysis_completed.json @@ -0,0 +1,26 @@ +{ + "id": "daa5be3b-2652-4eb1-b330-689aaf6606d7", + "topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "advanceMessageAnalysis/sender/{sender@id}/recipient/{recipient@id}", + "data": { + "originalMessage": "Yesterday I talked to sara parker, she said that my package did not arrive in Kalamazoo, but was sent to lafeyette instead. So said that I should get in touch with herb and he will help me. My order number is #567890. Can you please help me track my package? I'm really frustrated", + "channelType": "whatsapp", + "from": "{sender@id}", + "to": "{recipient@id}", + "languageDetection": { + "language": "English", + "confidenceScore": 0.99, + "translation": "Yesterday I talked to sara parker, she said that my package did not arrive in Kalamazoo, but was sent to lafeyette instead. So said that I should get in touch with herb and he will help me. My order number is #567890. Can you please help me track my package? I'm really frustrated" + }, + "intentAnalysis": "The customer is contacting customer service to request assistance with tracking their package.", + "keyphraseExtraction": [ + "Sara Parker", + "package", + "Kalamazoo" + ] + }, + "eventType": "Microsoft.Communication.AdvancedMessageAnalysisCompleted", + "dataVersion": "1.0", + "metadataVersion": "1", + "eventTime": "2023-02-01T01:54:35.567235Z" +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_delivery_status_updated.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_delivery_status_updated.json index d5d1947a09fe..95eb999a47c4 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_delivery_status_updated.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_delivery_status_updated.json @@ -6,8 +6,8 @@ "messageId": "d59f9468-0a5c-4022-8200-d7bf6fb78bc5", "status": "delivered", "channelType": "whatsapp", - "from": "12375679879", - "to": "1345679879", + "from": "{sender@id}", + "to": "{recipient@id}", "receivedTimestamp": "2024-03-22T17:06:11.1980225+00:00", "error": { "channelCode": "channelCode", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_received.json index 8ec02dc97c3a..ff5e43476788 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_received.json @@ -1,7 +1,7 @@ { "id": "4611364c-08fb-4a8a-a8b5-7e40203285d3", "topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", - "subject": "advancedMessage/sender/18334411877/recipient/be57b49d-5cd4-4f96-9a6b-4af41bc9fdfb", + "subject": "advancedMessage/sender/{sender@id}/recipient/{recipient@id}", "data": { "content": "Come on guys, lets go for lunch together.", "channelType": "whatsapp", @@ -12,7 +12,7 @@ "caption": "caption" }, "context": { - "from": "1234578988", + "from": "{sender@id}", "id": "messageId" }, "button": { @@ -26,8 +26,8 @@ "title": "button reply" } }, - "from": "12375679879", - "to": "1345679879", + "from": "{sender@id}", + "to": "{recipient@id}", "receivedTimestamp": "2024-03-22T17:06:11.2610383+00:00", "error": { "channelCode": "channelCode", diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json index 3de7019fb636..780d040d18b8 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json @@ -923,6 +923,47 @@ ] } }, + "AcsMessageAnalysisCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageAnalysisCompleted event.", + "properties": { + "originalMessage": { + "type": "string", + "description": "The original message received." + }, + "channelKind": { + "$ref": "#/definitions/AcsMessageChannelKind", + "description": "The analysed message channel kind." + }, + "intentAnalysis": { + "type": "string", + "description": "The intent of the analysed message." + }, + "extractedKeyPhrases": { + "type": "array", + "description": "List of key phrases extracted.", + "items": { + "type": "string" + } + }, + "languageDetection": { + "$ref": "#/definitions/AcsMessageLanguageDetection", + "description": "The analysed message language detection." + } + }, + "required": [ + "originalMessage", + "channelKind", + "intentAnalysis", + "extractedKeyPhrases", + "languageDetection" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ] + }, "AcsMessageButtonContent": { "type": "object", "description": "Message Button Content", @@ -1145,6 +1186,30 @@ } } }, + "AcsMessageLanguageDetection": { + "type": "object", + "description": "Message Analysis Language Detection", + "properties": { + "language": { + "type": "string", + "description": "The language of the message." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "The confidence score of the language detected." + }, + "translation": { + "type": "string", + "description": "The translation of the message." + } + }, + "required": [ + "language", + "confidenceScore", + "translation" + ] + }, "AcsMessageMediaContent": { "type": "object", "description": "Message Media Content", From a5a3106d1209a6ac56311a9f13a390ea1314d4f3 Mon Sep 17 00:00:00 2001 From: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Date: Wed, 10 Jul 2024 16:29:54 -0700 Subject: [PATCH 305/343] Revert "adding MessageAnalysisCompletedEvent to EG SDk (#28912)" (#29789) This reverts commit 0117e474a03d0b5b4cdd3b713105ae17196c18ce. --- .../AzureCommunicationServices.tsp | 31 ------- .../Microsoft.Communication/client.tsp | 6 -- .../AzureCommunicationServices.json | 88 ------------------- .../advanced_message_analysis_completed.json | 25 ------ ...anced_message_delivery_status_updated.json | 4 +- .../advanced_message_received.json | 8 +- .../advanced_message_analysis_completed.json | 26 ------ ...anced_message_delivery_status_updated.json | 4 +- .../advanced_message_received.json | 8 +- .../stable/2024-01-01/SystemEvents.json | 65 -------------- 10 files changed, 12 insertions(+), 253 deletions(-) delete mode 100644 specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_analysis_completed.json delete mode 100644 specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_analysis_completed.json diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp index 3470904b4b15..634f85970444 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp @@ -1160,25 +1160,6 @@ model AcsMessageReceivedEventData extends AcsMessageEventData { interactive: AcsMessageInteractiveContent; } -/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageAnalysisCompleted event. */ -#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." -model AcsMessageAnalysisCompletedEventData extends AcsMessageEventData { - /** The original message received. */ - originalMessage: string; - - /** The analysed message channel kind. */ - channelKind: AcsMessageChannelKind; - - /** The intent of the analysed message. */ - intentAnalysis: string; - - /** List of key phrases extracted. */ - extractedKeyPhrases: string[]; - - /** The analysed message language detection. */ - languageDetection: AcsMessageLanguageDetection; -} - /** Message Media Content */ model AcsMessageMediaContent { /** The MIME type of the file this media represents */ @@ -1269,18 +1250,6 @@ model AcsMessageChannelEventError { channelMessage?: string; } -/** Message Analysis Language Detection */ -model AcsMessageLanguageDetection { - /** The language of the message. */ - language: string; - - /** The confidence score of the language detected. */ - confidenceScore: float64; - - /** The translation of the message. */ - translation: string; -} - /** Interactive reply kind */ union AcsInteractiveReplyKind { /** Messaged interactive reply type is ButtonReply */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp index 9912ae7c7b4b..71570ba1be06 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp @@ -511,9 +511,3 @@ using Azure.ClientGenerator.Core; @@access(Microsoft.EventGrid.SystemEvents.CommunicationCloudEnvironmentModel, Access.public ); -@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageAnalysisCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsMessageAnalysisCompletedEventData, - Access.public -); diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index f478d0889f89..4228c52100eb 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -1671,70 +1671,6 @@ } } }, - "AcsMessageAnalysisCompletedEventData": { - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageAnalysisCompleted event.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AcsMessageEventData" - } - ], - "properties": { - "originalMessage": { - "description": "The original message received", - "type": "string" - }, - "channelType": { - "description": "The Analysed message channel Kind", - "type": "string", - "x-ms-client-name": "channelKind", - "enum": [ - "whatsapp" - ], - "x-ms-enum": { - "name": "AcsMessageChannelKind", - "modelAsString": true, - "values": [ - { - "value": "whatsapp", - "description": "Updated message channel type is Whatsapp" - } - ] - } - }, - "intentAnalysis": { - "description": "The intent of the analysed message", - "type": "string" - }, - "extractedKeyPhrases": { - "description": "List of key phrases extracted", - "type": "array", - "items": { - "type": "string" - } - }, - "languageDetection": { - "description": "The analysed message language detection", - "$ref": "#/definitions/AcsMessageLanguageDetection", - "type": "object" - } - }, - "required": [ - "originalMessage", - "channelType", - "intentAnalysis", - "extractedKeyPhrases", - "languageDetection" - ], - "x-ms-examples": { - "snapshotCreatedCloudEventsSchema": { - "$ref": "./examples/cloud-events-schema/advanced_message_analysis_completed.json" - }, - "snapshotCreatedEventGridSchema": { - "$ref": "./examples/event-grid-schema/advanced_message_analysis_completed.json" - } - } - }, "AcsMessageEventData": { "description": "Schema of common properties of all chat thread events", "type": "object", @@ -2402,30 +2338,6 @@ "type": "string" } } - }, - "AcsMessageLanguageDetection": { - "description": "Message Analysis Language Detection", - "type": "object", - "properties": { - "language": { - "description": "The language of the message", - "type": "string" - }, - "confidenceScore": { - "description": "The confidence score of the language detected", - "type": "number", - "format": "double" - }, - "translation": { - "description": "The translation of the message", - "type": "string" - } - }, - "required": [ - "language", - "confidenceScore", - "translation" - ] } } } diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_analysis_completed.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_analysis_completed.json deleted file mode 100644 index 785cff903af8..000000000000 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_analysis_completed.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "id": "daa5be3b-2652-4eb1-b330-689aaf6606d7", - "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", - "subject": "advanceMessageAnalysis/sender/{sender@id}/recipient/{recipient@id}", - "data": { - "originalMessage": "Yesterday I talked to sara parker, she said that my package did not arrive in Kalamazoo, but was sent to lafeyette instead. So said that I should get in touch with herb and he will help me. My order number is #567890. Can you please help me track my package? I'm really frustrated", - "channelType": "whatsapp", - "from": "{sender@id}", - "to": "{recipient@id}", - "languageDetection": { - "language": "English", - "confidenceScore": 0.99, - "translation": "Yesterday I talked to sara parker, she said that my package did not arrive in Kalamazoo, but was sent to lafeyette instead. So said that I should get in touch with herb and he will help me. My order number is #567890. Can you please help me track my package? I'm really frustrated" - }, - "intentAnalysis": "The customer is contacting customer service to request assistance with tracking their package.", - "keyphraseExtraction": [ - "Sara Parker", - "package", - "Kalamazoo" - ] - }, - "type": "Microsoft.Communication.AdvancedMessageAnalysisCompleted", - "specVersion": "1.0", - "time": "2023-02-01T01:54:35.567235Z" -} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_delivery_status_updated.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_delivery_status_updated.json index 315151bb8ca8..76c09ffb8d9c 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_delivery_status_updated.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_delivery_status_updated.json @@ -5,8 +5,8 @@ "messageId": "d59f9468-0a5c-4022-8200-d7bf6fb78bc5", "status": "delivered", "channelType": "whatsapp", - "from": "{recipient@id}", - "to": "{sender@id}", + "from": "12375679879", + "to": "1345679879", "receivedTimestamp": "2024-03-22T17:06:11.1980225+00:00", "error": { "channelCode": "channelCode", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_received.json index ca72b1f2ca79..bf349b0c6e80 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/advanced_message_received.json @@ -1,7 +1,7 @@ { "id": "4611364c-08fb-4a8a-a8b5-7e40203285d3", "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", - "subject": "advancedMessage/sender/{sender@id}/recipient/{recipient@id}", + "subject": "advancedMessage/sender/18334411877/recipient/be57b49d-5cd4-4f96-9a6b-4af41bc9fdfb", "data": { "content": "Come on guys, lets go for lunch together.", "channelType": "whatsapp", @@ -12,7 +12,7 @@ "caption": "caption" }, "context": { - "from": "{recipient@id}", + "from": "1234578988", "id": "messageId" }, "button": { @@ -26,8 +26,8 @@ "title": "button reply" } }, - "from": "{recipient@id}", - "to": "{sender@id}", + "from": "12375679879", + "to": "1345679879", "receivedTimestamp": "2024-03-22T17:06:11.2610383+00:00", "error": { "channelCode": "channelCode", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_analysis_completed.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_analysis_completed.json deleted file mode 100644 index 2639451abe43..000000000000 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_analysis_completed.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "id": "daa5be3b-2652-4eb1-b330-689aaf6606d7", - "topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", - "subject": "advanceMessageAnalysis/sender/{sender@id}/recipient/{recipient@id}", - "data": { - "originalMessage": "Yesterday I talked to sara parker, she said that my package did not arrive in Kalamazoo, but was sent to lafeyette instead. So said that I should get in touch with herb and he will help me. My order number is #567890. Can you please help me track my package? I'm really frustrated", - "channelType": "whatsapp", - "from": "{sender@id}", - "to": "{recipient@id}", - "languageDetection": { - "language": "English", - "confidenceScore": 0.99, - "translation": "Yesterday I talked to sara parker, she said that my package did not arrive in Kalamazoo, but was sent to lafeyette instead. So said that I should get in touch with herb and he will help me. My order number is #567890. Can you please help me track my package? I'm really frustrated" - }, - "intentAnalysis": "The customer is contacting customer service to request assistance with tracking their package.", - "keyphraseExtraction": [ - "Sara Parker", - "package", - "Kalamazoo" - ] - }, - "eventType": "Microsoft.Communication.AdvancedMessageAnalysisCompleted", - "dataVersion": "1.0", - "metadataVersion": "1", - "eventTime": "2023-02-01T01:54:35.567235Z" -} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_delivery_status_updated.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_delivery_status_updated.json index 95eb999a47c4..d5d1947a09fe 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_delivery_status_updated.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_delivery_status_updated.json @@ -6,8 +6,8 @@ "messageId": "d59f9468-0a5c-4022-8200-d7bf6fb78bc5", "status": "delivered", "channelType": "whatsapp", - "from": "{sender@id}", - "to": "{recipient@id}", + "from": "12375679879", + "to": "1345679879", "receivedTimestamp": "2024-03-22T17:06:11.1980225+00:00", "error": { "channelCode": "channelCode", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_received.json index ff5e43476788..8ec02dc97c3a 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/advanced_message_received.json @@ -1,7 +1,7 @@ { "id": "4611364c-08fb-4a8a-a8b5-7e40203285d3", "topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", - "subject": "advancedMessage/sender/{sender@id}/recipient/{recipient@id}", + "subject": "advancedMessage/sender/18334411877/recipient/be57b49d-5cd4-4f96-9a6b-4af41bc9fdfb", "data": { "content": "Come on guys, lets go for lunch together.", "channelType": "whatsapp", @@ -12,7 +12,7 @@ "caption": "caption" }, "context": { - "from": "{sender@id}", + "from": "1234578988", "id": "messageId" }, "button": { @@ -26,8 +26,8 @@ "title": "button reply" } }, - "from": "{sender@id}", - "to": "{recipient@id}", + "from": "12375679879", + "to": "1345679879", "receivedTimestamp": "2024-03-22T17:06:11.2610383+00:00", "error": { "channelCode": "channelCode", diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json index 780d040d18b8..3de7019fb636 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json @@ -923,47 +923,6 @@ ] } }, - "AcsMessageAnalysisCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageAnalysisCompleted event.", - "properties": { - "originalMessage": { - "type": "string", - "description": "The original message received." - }, - "channelKind": { - "$ref": "#/definitions/AcsMessageChannelKind", - "description": "The analysed message channel kind." - }, - "intentAnalysis": { - "type": "string", - "description": "The intent of the analysed message." - }, - "extractedKeyPhrases": { - "type": "array", - "description": "List of key phrases extracted.", - "items": { - "type": "string" - } - }, - "languageDetection": { - "$ref": "#/definitions/AcsMessageLanguageDetection", - "description": "The analysed message language detection." - } - }, - "required": [ - "originalMessage", - "channelKind", - "intentAnalysis", - "extractedKeyPhrases", - "languageDetection" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsMessageEventData" - } - ] - }, "AcsMessageButtonContent": { "type": "object", "description": "Message Button Content", @@ -1186,30 +1145,6 @@ } } }, - "AcsMessageLanguageDetection": { - "type": "object", - "description": "Message Analysis Language Detection", - "properties": { - "language": { - "type": "string", - "description": "The language of the message." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "The confidence score of the language detected." - }, - "translation": { - "type": "string", - "description": "The translation of the message." - } - }, - "required": [ - "language", - "confidenceScore", - "translation" - ] - }, "AcsMessageMediaContent": { "type": "object", "description": "Message Media Content", From 56537883b7cdb95618c3d1ec1c0ee37b59d88d72 Mon Sep 17 00:00:00 2001 From: ameyaiam3 <141965277+ameyaiam3@users.noreply.github.com> Date: Wed, 10 Jul 2024 16:35:53 -0700 Subject: [PATCH 306/343] Added examples for new api version - 2024-04-05 in GuestConfigurationRP (#29166) * Copy files from stable/2022-01-25 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-04-05 Updated the API version from stable/2022-01-25 to stable/2024-04-05. * Added tag for 2024-04-05 in readme file * Fixing swagger PrettierCheck * Prettier changes * Add changes for Api * Prettier scan fix * Fixing failing net sdk * Revert of previous change. --- ...eOrUpdateGuestConfigurationAssignment.json | 100 + ...ationConnectedVMwarevSphereAssignment.json | 97 + ...pdateGuestConfigurationHCRPAssignment.json | 91 + ...pdateGuestConfigurationVMSSAssignment.json | 100 + .../deleteGuestConfigurationAssignment.json | 12 + ...ationConnectedVMwarevSphereAssignment.json | 13 + ...eleteGuestConfigurationHCRPAssignment.json | 12 + ...eleteGuestConfigurationVMSSAssignment.json | 39 + .../getGuestConfigurationAssignment.json | 37 + ...uestConfigurationAssignmentReportById.json | 95 + ...ationConnectedVMwarevSphereAssignment.json | 36 + ...ctedVMwarevSphereAssignmentReportById.json | 95 + .../getGuestConfigurationHCRPAssignment.json | 36 + ...ConfigurationHCRPAssignmentReportById.json | 95 + .../getVMSSGuestConfigurationAssignment.json | 39 + ...uestConfigurationAssignmentReportById.json | 95 + ...llGuestConfigurationAssignmentReports.json | 60 + ...nectedVMwarevSphereAssignmentsReports.json | 60 + ...estConfigurationHCRPAssignmentReports.json | 60 + ...SSGuestConfigurationAssignmentReports.json | 60 + .../listGuestConfigurationAssignments.json | 59 + ...tionConnectedVMwarevSphereAssignments.json | 59 + ...listGuestConfigurationHCRPAssignments.json | 59 + .../2024-04-05/examples/listOperations.json | 54 + .../listRGGuestConfigurationAssignments.json | 59 + .../listSubGuestConfigurationAssignments.json | 58 + ...listVMSSGuestConfigurationAssignments.json | 59 + .../stable/2024-04-05/guestconfiguration.json | 2191 +++++++++++++++++ .../scenarios/GuestAssignmentTests.yaml | 188 ++ .../resource-manager/readme.go.md | 10 + .../resource-manager/readme.md | 11 +- 31 files changed, 4038 insertions(+), 1 deletion(-) create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationConnectedVMwarevSphereAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationHCRPAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationVMSSAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationConnectedVMwarevSphereAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationHCRPAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationVMSSAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignmentReportById.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignmentReportById.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignmentReportById.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationAssignmentReports.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationConnectedVMwarevSphereAssignmentsReports.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationHCRPAssignmentReports.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllVMSSGuestConfigurationAssignmentReports.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationAssignments.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationConnectedVMwarevSphereAssignments.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationHCRPAssignments.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listOperations.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listRGGuestConfigurationAssignments.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listSubGuestConfigurationAssignments.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listVMSSGuestConfigurationAssignments.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/scenarios/GuestAssignmentTests.yaml diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json new file mode 100644 index 000000000000..7ea14f73f050 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "NotInstalledApplicationForWindows", + "api-version": "2024-04-05", + "parameters": { + "location": "westcentralus", + "name": "NotInstalledApplicationForWindows", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", + "contentManagedIdentity": "test_identity", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "contentManagedIdentity": null, + "assignmentSource": "AzurePolicy", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "contentManagedIdentity": null, + "assignmentSource": "AzurePolicy", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationConnectedVMwarevSphereAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationConnectedVMwarevSphereAssignment.json new file mode 100644 index 000000000000..8d700c48feb2 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationConnectedVMwarevSphereAssignment.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "NotInstalledApplicationForWindows", + "api-version": "2024-04-05", + "parameters": { + "location": "westcentralus", + "name": "NotInstalledApplicationForWindows", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.0", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "assignmentSource": "AzurePolicy", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "assignmentSource": "AzurePolicy", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..dc035f23d335 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationHCRPAssignment.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "NotInstalledApplicationForWindows", + "api-version": "2024-04-05", + "parameters": { + "location": "westcentralus", + "name": "NotInstalledApplicationForWindows", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/HybridRP.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": "abcdr453g", + "latestReportId": "a2a64e5d-a1a9-4344-a866-fb9e1541f723", + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/HybridRP.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": "abcdr453g", + "latestReportId": "a2a64e5d-a1a9-4344-a866-fb9e1541f723", + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationVMSSAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationVMSSAssignment.json new file mode 100644 index 000000000000..0ea390962e71 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationVMSSAssignment.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "name": "NotInstalledApplicationForWindows", + "api-version": "2024-04-05", + "parameters": { + "location": "westcentralus", + "name": "NotInstalledApplicationForWindows", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", + "contentManagedIdentity": "test_identity", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualmachinescalesets/myvmssname/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "assignmentSource": "AzurePolicy", + "contentManagedIdentity": "test_identity", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualmachinescalesets/myvmssname/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "assignmentSource": "AzurePolicy", + "contentManagedIdentity": "test_identity", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationAssignment.json new file mode 100644 index 000000000000..535ce8939e05 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationAssignment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationConnectedVMwarevSphereAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationConnectedVMwarevSphereAssignment.json new file mode 100644 index 000000000000..5fde70225dd5 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationConnectedVMwarevSphereAssignment.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..42e041eff7b1 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationHCRPAssignment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationVMSSAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationVMSSAssignment.json new file mode 100644 index 000000000000..720a041b6442 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationVMSSAssignment.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "name": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": null, + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded", + "resourceType": "VMSS", + "vmssVMList": null + } + } + }, + "204": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignment.json new file mode 100644 index 000000000000..ec7608f277ca --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignment.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "contentManagedIdentity": "test_identity", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignmentReportById.json new file mode 100644 index 000000000000..8e53acc78012 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myvm", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignment.json new file mode 100644 index 000000000000..744167af77bd --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json new file mode 100644 index 000000000000..46065c571a78 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myvm", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..81218c40b230 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignmentReportById.json new file mode 100644 index 000000000000..45e30574a026 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignment.json new file mode 100644 index 000000000000..73d79d20dc07 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignment.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "name": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": null, + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "contentManagedIdentity": "test_identity", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded", + "resourceType": "VMSS", + "vmssVMList": null + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignmentReportById.json new file mode 100644 index 000000000000..3c460fa57e38 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myvmss", + "name": "AuditSecureProtocol", + "id": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myvmss/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mySubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myvmss/virtualMachines/1", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationAssignmentReports.json new file mode 100644 index 000000000000..2270acb515ae --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationAssignmentReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationConnectedVMwarevSphereAssignmentsReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationConnectedVMwarevSphereAssignmentsReports.json new file mode 100644 index 000000000000..b9e7322d4de0 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationConnectedVMwarevSphereAssignmentsReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationHCRPAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationHCRPAssignmentReports.json new file mode 100644 index 000000000000..264bbf86767e --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationHCRPAssignmentReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllVMSSGuestConfigurationAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllVMSSGuestConfigurationAssignmentReports.json new file mode 100644 index 000000000000..2cf8428beb05 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllVMSSGuestConfigurationAssignmentReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "name": "AuditSecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/virtualMachines/1", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/virtualMachines/1", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationAssignments.json new file mode 100644 index 000000000000..4a5143634915 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationConnectedVMwarevSphereAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationConnectedVMwarevSphereAssignments.json new file mode 100644 index 000000000000..c46cce0791ab --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationConnectedVMwarevSphereAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationHCRPAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationHCRPAssignments.json new file mode 100644 index 000000000000..159e0721c276 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationHCRPAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listOperations.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listOperations.json new file mode 100644 index 000000000000..6361eb97dade --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listOperations.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "description": "Create new guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/register/action", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Register", + "operation": "Registers the feature for Microsoft.GuestConfiguration.", + "description": "Registers the subscription for the Microsoft.GuestConfiguration resource provider." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "description": "Get guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "description": "Get guest configuration assignment report." + }, + "properties": null + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listRGGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listRGGuestConfigurationAssignments.json new file mode 100644 index 000000000000..34128e287758 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listRGGuestConfigurationAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + }, + "204": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listSubGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listSubGuestConfigurationAssignments.json new file mode 100644 index 000000000000..1c510b030d04 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listSubGuestConfigurationAssignments.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + }, + "204": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listVMSSGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listVMSSGuestConfigurationAssignments.json new file mode 100644 index 000000000000..64bf536bd16b --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listVMSSGuestConfigurationAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json new file mode 100644 index 000000000000..43ec0f14e009 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json @@ -0,0 +1,2191 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-05", + "title": "GuestConfiguration" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_CreateOrUpdate", + "description": "Creates an association between a VM and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the VM was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the VM was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_SubscriptionList", + "description": "List all guest configuration assignments for a subscription.", + "x-ms-examples": { + "List all guest configuration assignments for a subscription": { + "$ref": "./examples/listSubGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_RGList", + "description": "List all guest configuration assignments for a resource group.", + "x-ms-examples": { + "List all guest configuration assignments for a resource group": { + "$ref": "./examples/listRGGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_List", + "description": "List all guest configuration assignments for a virtual machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_CreateOrUpdate", + "description": "Creates an association between a ARC machine and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the ARC machine was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the ARC machine was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_List", + "description": "List all guest configuration assignments for an ARC machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationHCRPAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentHCRPReports" + ], + "operationId": "GuestConfigurationHCRPAssignmentReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationHCRPAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentHCRPReports" + ], + "operationId": "GuestConfigurationHCRPAssignmentReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationHCRPAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{name}": { + "put": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignmentsVMSS_CreateOrUpdate", + "description": "Creates an association between a VMSS and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationVMSSAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the VMSS was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the VMSS was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignmentsVMSS_Get", + "description": "Get information about a guest configuration assignment for VMSS", + "x-ms-examples": { + "Get a VMSS guest configuration assignment": { + "$ref": "./examples/getVMSSGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignmentsVMSS_Delete", + "description": "Delete a guest configuration assignment for VMSS", + "x-ms-examples": { + "Delete an guest configuration assignment for VMSS": { + "$ref": "./examples/deleteGuestConfigurationVMSSAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "204": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignmentsVMSS_List", + "description": "List all guest configuration assignments for VMSS.", + "x-ms-examples": { + "List all guest configuration assignments for VMSS": { + "$ref": "./examples/listVMSSGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{name}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReportsVMSS_List", + "description": "List all reports for the VMSS guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all reports for the VMSS guest configuration assignment with latest report first": { + "$ref": "./examples/listAllVMSSGuestConfigurationAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{name}/reports/{id}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReportsVMSS_Get", + "description": "Get a report for the VMSS guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine scale set": { + "$ref": "./examples/getVMSSGuestConfigurationAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignments" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignments_CreateOrUpdate", + "description": "Creates an association between a Connected VM Sphere machine and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationConnectedVMwarevSphereAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the Connected VM Sphere machine was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the Connected VM Sphere machine was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignments" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationConnectedVMwarevSphereAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignments" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationConnectedVMwarevSphereAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignments" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignments_List", + "description": "List all guest configuration assignments for an ARC machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationConnectedVMwarevSphereAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignmentsReports" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignmentsReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationConnectedVMwarevSphereAssignmentsReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignmentsReports" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignmentsReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/providers/Microsoft.GuestConfiguration/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available GuestConfiguration REST API operations.", + "x-ms-examples": { + "Lists all of the available GuestConfiguration REST API operations": { + "$ref": "./examples/listOperations.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "GuestConfigurationAssignmentList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Result of the list guest configuration assignment operation." + } + }, + "description": "The response of the list guest configuration assignment operation." + }, + "GuestConfigurationAssignment": { + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/GuestConfigurationAssignmentProperties", + "description": "Properties of the Guest configuration assignment." + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Guest configuration assignment is an association between a machine and guest configuration." + }, + "GuestConfigurationNavigation": { + "description": "Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules.", + "properties": { + "kind": { + "type": "string", + "description": "Kind of the guest configuration. For example:DSC", + "x-ms-enum": { + "name": "kind", + "modelAsString": true + }, + "enum": [ + "DSC" + ] + }, + "name": { + "type": "string", + "description": "Name of the guest configuration." + }, + "version": { + "type": "string", + "description": "Version of the guest configuration." + }, + "contentUri": { + "type": "string", + "description": "Uri of the storage where guest configuration package is uploaded." + }, + "contentHash": { + "type": "string", + "description": "Combined hash of the guest configuration package and configuration parameters." + }, + "contentManagedIdentity": { + "type": "string", + "description": "Managed identity with storage access of the guest configuration package and configuration parameters." + }, + "assignmentType": { + "type": "string", + "description": "Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.", + "x-ms-enum": { + "name": "assignmentType", + "modelAsString": true + }, + "enum": [ + "Audit", + "DeployAndAutoCorrect", + "ApplyAndAutoCorrect", + "ApplyAndMonitor" + ] + }, + "assignmentSource": { + "type": "string", + "readOnly": true, + "description": "Specifies the origin of the configuration.", + "x-nullable": true + }, + "contentType": { + "type": "string", + "readOnly": true, + "description": "Specifies the content type of the configuration. Possible values could be Builtin or Custom.", + "x-nullable": true + }, + "configurationParameter": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The configuration parameters for the guest configuration." + }, + "configurationProtectedParameter": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The protected configuration parameters for the guest configuration." + }, + "configurationSetting": { + "$ref": "#/definitions/ConfigurationSetting", + "readOnly": true, + "description": "The configuration setting for the guest configuration." + } + } + }, + "ConfigurationParameter": { + "properties": { + "name": { + "type": "string", + "readOnly": false, + "description": "Name of the configuration parameter." + }, + "value": { + "type": "string", + "readOnly": false, + "description": "Value of the configuration parameter." + } + }, + "description": "Represents a configuration parameter." + }, + "ConfigurationSetting": { + "properties": { + "configurationMode": { + "type": "string", + "readOnly": true, + "description": "Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.", + "x-ms-enum": { + "name": "configurationMode", + "modelAsString": true + }, + "enum": [ + "ApplyOnly", + "ApplyAndMonitor", + "ApplyAndAutoCorrect" + ] + }, + "allowModuleOverwrite": { + "type": "boolean", + "readOnly": true, + "description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false" + }, + "actionAfterReboot": { + "type": "string", + "readOnly": true, + "description": "Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration", + "x-ms-enum": { + "name": "actionAfterReboot", + "modelAsString": true + }, + "enum": [ + "ContinueConfiguration", + "StopConfiguration" + ] + }, + "refreshFrequencyMins": { + "type": "number", + "readOnly": true, + "default": 30, + "description": "The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30." + }, + "rebootIfNeeded": { + "type": "boolean", + "readOnly": true, + "description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module." + }, + "configurationModeFrequencyMins": { + "type": "number", + "readOnly": true, + "default": 15, + "description": "How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15." + } + }, + "description": "Configuration setting of LCM (Local Configuration Manager)." + }, + "AssignmentReport": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ARM resource id of the report for the guest configuration assignment." + }, + "reportId": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "assignment": { + "$ref": "#/definitions/AssignmentInfo", + "description": "Configuration details of the guest configuration assignment." + }, + "vm": { + "$ref": "#/definitions/VMInfo", + "description": "Information about the VM." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "Type of report, Consistency or Initial", + "x-ms-enum": { + "name": "type", + "modelAsString": true + }, + "enum": [ + "Consistency", + "Initial" + ] + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResource" + }, + "x-ms-identifiers": [], + "description": "The list of resources for which guest configuration assignment compliance is checked." + } + } + }, + "GuestConfigurationAssignmentProperties": { + "properties": { + "targetResourceId": { + "type": "string", + "readOnly": true, + "description": "VM resource Id.", + "x-nullable": true + }, + "guestConfiguration": { + "$ref": "#/definitions/GuestConfigurationNavigation", + "description": "The guest configuration to assign." + }, + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "lastComplianceStatusChecked": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Date and time when last compliance status was checked.", + "x-nullable": true + }, + "latestReportId": { + "type": "string", + "readOnly": true, + "description": "Id of the latest report for the guest configuration assignment. ", + "x-nullable": true + }, + "parameterHash": { + "type": "string", + "readOnly": true, + "description": "parameter hash for the guest configuration assignment. ", + "x-nullable": true + }, + "latestAssignmentReport": { + "$ref": "#/definitions/AssignmentReport", + "description": "Last reported guest configuration assignment report." + }, + "context": { + "type": "string", + "description": "The source which initiated the guest configuration assignment. Ex: Azure Policy" + }, + "assignmentHash": { + "type": "string", + "readOnly": true, + "description": "Combined hash of the configuration package and parameters.", + "x-nullable": true + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "x-nullable": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Created" + ] + }, + "resourceType": { + "type": "string", + "readOnly": true, + "description": "Type of the resource - VMSS / VM", + "x-nullable": true + }, + "vmssVMList": { + "type": "array", + "items": { + "$ref": "#/definitions/VMSSVMInfo" + }, + "x-ms-identifiers": [ + "vmId" + ], + "description": "The list of VM Compliance data for VMSS" + } + }, + "description": "Guest configuration assignment properties." + }, + "GuestConfigurationAssignmentReportList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + }, + "description": "List of reports for the guest configuration. Report contains information such as compliance status, reason and more." + } + }, + "description": "List of guest configuration assignment reports." + }, + "GuestConfigurationAssignmentReport": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ARM resource id of the report for the guest configuration assignment." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "properties": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportProperties", + "description": "Properties of the guest configuration report." + } + }, + "description": "Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more." + }, + "GuestConfigurationAssignmentReportProperties": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "reportId": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "assignment": { + "$ref": "#/definitions/AssignmentInfo", + "description": "Configuration details of the guest configuration assignment." + }, + "vm": { + "$ref": "#/definitions/VMInfo", + "description": "Information about the VM." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "details": { + "$ref": "#/definitions/AssignmentReportDetails", + "description": "Details of the assignment report.", + "x-nullable": true + }, + "vmssResourceId": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id of the VMSS." + } + }, + "description": "Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more." + }, + "AssignmentInfo": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the guest configuration assignment." + }, + "configuration": { + "$ref": "#/definitions/ConfigurationInfo", + "description": "Information about the configuration." + } + }, + "description": "Information about the guest configuration assignment." + }, + "VMInfo": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id of the VM." + }, + "uuid": { + "type": "string", + "readOnly": true, + "description": "UUID(Universally Unique Identifier) of the VM." + } + }, + "description": "Information about the VM." + }, + "ConfigurationInfo": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the configuration." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "Version of the configuration." + } + }, + "description": "Information about the configuration." + }, + "AssignmentReportDetails": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "jobId": { + "type": "string", + "readOnly": true, + "description": "GUID of the report." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "Type of report, Consistency or Initial", + "x-ms-enum": { + "name": "type", + "modelAsString": true + }, + "enum": [ + "Consistency", + "Initial" + ] + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResource" + }, + "x-ms-identifiers": [], + "description": "The list of resources for which guest configuration assignment compliance is checked." + } + }, + "description": "Details of the guest configuration assignment report." + }, + "AssignmentReportResource": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "resourceId": { + "type": "string", + "readOnly": true, + "description": "Name of the guest configuration assignment resource setting." + }, + "reasons": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResourceComplianceReason" + }, + "x-ms-identifiers": [ + "phrase", + "code" + ], + "description": "Compliance reason and reason code for a resource." + }, + "properties": { + "type": "object", + "readOnly": true, + "description": "Properties of a guest configuration assignment resource." + } + }, + "description": "The guest configuration assignment resource." + }, + "AssignmentReportResourceComplianceReason": { + "properties": { + "phrase": { + "type": "string", + "readOnly": true, + "description": "Reason for the compliance of the guest configuration assignment resource." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Code for the compliance of the guest configuration assignment resource." + } + }, + "description": "Reason and code for the compliance of the guest configuration assignment resource." + }, + "VMSSVMInfo": { + "properties": { + "vmId": { + "type": "string", + "readOnly": true, + "description": "UUID of the VM." + }, + "vmResourceId": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id of the VM." + }, + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "latestReportId": { + "type": "string", + "readOnly": true, + "description": "Id of the latest report for the guest configuration assignment. ", + "x-nullable": true + }, + "lastComplianceChecked": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Date and time when last compliance status was checked.", + "x-nullable": true + } + }, + "description": "Information about VMSS VM" + } + }, + "parameters": {} +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/scenarios/GuestAssignmentTests.yaml b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/scenarios/GuestAssignmentTests.yaml new file mode 100644 index 000000000000..391b823de7c7 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/scenarios/GuestAssignmentTests.yaml @@ -0,0 +1,188 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json +scope: ResourceGroup +variables: + guestConfigurationAssignmentName: + type: string + prefix: guestcon + vmName: + type: string + prefix: vmname + vmssName: + type: string + prefix: vmssname + name: + type: string + prefix: name + adminPassword: + type: secureString + prefix: Admin@1 + +prepareSteps: + - step: createVirtualNetwork + operationId: VirtualNetworks_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md#package-2021-05 + parameters: + virtualNetworkName: $(vmName)-VNET + parameters: + location: $(location) + properties: + addressSpace: + addressPrefixes: + - 10.0.0.0/16 + subnets: + - name: $(vmName)-Subnet + properties: + addressPrefix: 10.0.0.0/24 + outputVariables: + subnetId: + type: string + fromResponse: /properties/subnets/0/id + - step: createNSG + operationId: NetworkSecurityGroups_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md#package-2021-05 + parameters: + networkSecurityGroupName: $(vmName)-NSG + parameters: + location: $(location) + properties: + securityRules: + - name: rdp + properties: + protocol: Tcp + sourcePortRange: "*" + destinationPortRange: "3389" + sourceAddressPrefix: "*" + destinationAddressPrefix: "*" + access: Allow + priority: 1000 + direction: Inbound + outputVariables: + networkSecurityGroupId: + type: string + fromResponse: /id + - step: createPublicIP + operationId: PublicIPAddresses_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md#package-2021-05 + parameters: + publicIpAddressName: $(vmName)-PublicIP + parameters: + location: $(location) + sku: + name: Standard + properties: + publicIPAllocationMethod: Static + outputVariables: + publicIPAddressId: + type: string + fromResponse: /id + - step: createNIC + operationId: NetworkInterfaces_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md#package-2021-05 + parameters: + networkInterfaceName: $(vmName)-VMNic + parameters: + location: $(location) + properties: + ipConfigurations: + - name: ipconfig-$(vmName) + properties: + privateIPAllocationMethod: Dynamic + subnet: + id: $(subnetId) + publicIpAddress: + id: $(publicIPAddressId) + networkSecurityGroup: + id: $(networkSecurityGroupId) + outputVariables: + vmNicId: + type: string + fromResponse: /id + - step: createVirtualMachine + operationId: VirtualMachines_CreateOrUpdate + readmeTag: ../../../../../../compute/resource-manager/readme.md#package-2022-11-01 + parameters: + vmName: $(vmName) + parameters: + location: $(location) + properties: + hardwareProfile: + vmSize: Standard_A2_v2 + networkProfile: + networkInterfaces: + - id: $(vmNicId) + storageProfile: + osDisk: + createOption: fromImage + caching: ReadWrite + imageReference: + publisher: MicrosoftWindowsServer + offer: WindowsServer + sku: 2019-Datacenter + version: latest + osProfile: + computerName: $(vmName) + adminUsername: azureuser + adminPassword: $(adminPassword) + additionalCapabilities: {} + - step: createVirtualMachineScaleSets + operationId: VirtualMachineScaleSets_CreateOrUpdate + readmeTag: ../../../../../../compute/resource-manager/readme.md#package-2022-11-01 + parameters: + vmScaleSetName: $(vmssName) + parameters: + location: $(location) + properties: + overprovision: false + upgradePolicy: + mode: Automatic + automaticOSUpgradePolicy: + enableAutomaticOSUpgrade: false + virtualMachineProfile: + storageProfile: + osDisk: + createOption: fromImage + imageReference: + publisher: MicrosoftWindowsServer + offer: WindowsServer + sku: 2019-Datacenter + version: latest + osProfile: + computerNamePrefix: vmss + adminUsername: $(vmssName) + adminPassword: $(adminPassword) + networkProfile: + networkInterfaceConfigurations: + - name: $(vmssName) + properties: + primary: true + ipConfigurations: + - name: ipconfig-$(vmssName) + properties: + subnet: + id: $(subnetId) + sku: + name: Standard_A1_v2 + capacity: 1 + tier: Standard +scenarios: + - scenario: GeneratedScenario + steps: + - operationId: GuestConfigurationAssignments_CreateOrUpdate + exampleFile: ../../2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json + - operationId: GuestConfigurationAssignments_SubscriptionList + exampleFile: ../../2024-04-05/examples/listSubGuestConfigurationAssignments.json + - operationId: GuestConfigurationAssignments_RGList + exampleFile: ../../2024-04-05/examples/listRGGuestConfigurationAssignments.json + - operationId: Operations_List + exampleFile: ../../2024-04-05/examples/listOperations.json + - operationId: GuestConfigurationAssignments_Get + exampleFile: ../../2024-04-05/examples/getGuestConfigurationAssignment.json + - operationId: GuestConfigurationAssignments_List + exampleFile: ../../2024-04-05/examples/listGuestConfigurationAssignments.json + - operationId: GuestConfigurationAssignments_Delete + exampleFile: ../../2024-04-05/examples/deleteGuestConfigurationAssignment.json + - operationId: GuestConfigurationAssignmentsVMSS_CreateOrUpdate + exampleFile: ../../2024-04-05/examples/createOrUpdateGuestConfigurationVMSSAssignment.json + - operationId: GuestConfigurationAssignmentsVMSS_Get + exampleFile: ../../2024-04-05/examples/getVMSSGuestConfigurationAssignment.json + diff --git a/specification/guestconfiguration/resource-manager/readme.go.md b/specification/guestconfiguration/resource-manager/readme.go.md index a1abf43d714a..5172389f1de4 100644 --- a/specification/guestconfiguration/resource-manager/readme.go.md +++ b/specification/guestconfiguration/resource-manager/readme.go.md @@ -28,7 +28,17 @@ batch: - tag: package-2020-06-25 - tag: package-2021-01-25 - tag: package-2022-01-25 + - tag: package-2024-04-05 ``` +### Tag: package-2024-04-05 and go + +These settings apply only when `--tag=package-2024-04-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2024-04-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2024-04-05/$(namespace) +``` + ### Tag: package-2022-01-25 and go These settings apply only when `--tag=package-2022-01-25 --go` is specified on the command line. diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index 8c0424e7ef10..be2a587ff043 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the Guest Configuration API. title: GuestConfigurationClient description: Guest Configuration Client openapi-type: arm -tag: package-2022-01-25 +tag: package-2024-04-05 ``` ``` yaml !$(csharp) @@ -36,6 +36,15 @@ modelerfour: flatten-models: false ``` +### Tag: package-2024-04-05 + +These settings apply only when `--tag=package-2024-04-05` is specified on the command line. + +```yaml $(tag) == 'package-2024-04-05' +input-file: + - Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json +``` + ### Tag: package-2022-01-25 These settings apply only when `--tag=package-2022-01-25` is specified on the command line. From c2de40ba4230261fb909f8f96ac756b4b2c9cd4d Mon Sep 17 00:00:00 2001 From: Xiaofei Cao <92354331+XiaofeiCao@users.noreply.github.com> Date: Thu, 11 Jul 2024 13:44:35 +0800 Subject: [PATCH 307/343] java update automation config (#29777) * java update automation config * format --- specificationRepositoryConfiguration.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specificationRepositoryConfiguration.json b/specificationRepositoryConfiguration.json index 0ddbbe026169..2271468321a8 100644 --- a/specificationRepositoryConfiguration.json +++ b/specificationRepositoryConfiguration.json @@ -10,7 +10,7 @@ "azure-sdk-for-java": { "integrationRepository": "azure-sdk/azure-sdk-for-java", "mainRepository": "Azure/azure-sdk-for-java", - "configFilePath": "eng/mgmt/automation/swagger_to_sdk_config.json" + "configFilePath": "eng/automation/swagger_to_sdk_config.json" }, "azure-sdk-for-js": { "integrationRepository": "azure-sdk/azure-sdk-for-js", @@ -53,7 +53,7 @@ "azure-sdk-for-java": { "integrationRepository": "azure-sdk/azure-sdk-for-java-pr", "mainRepository": "Azure/azure-sdk-for-java-pr", - "configFilePath": "eng/mgmt/automation/swagger_to_sdk_config.json" + "configFilePath": "eng/automation/swagger_to_sdk_config.json" }, "azure-sdk-for-js": { "integrationRepository": "azure-sdk/azure-sdk-for-js-pr", From 224b9dc129f67fc484dfdcbf2853bfa35723b3a9 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Thu, 11 Jul 2024 15:52:31 +0800 Subject: [PATCH 308/343] rename property name for python sdk (#29793) --- .../liftrqumulo/resource-manager/readme.python.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/specification/liftrqumulo/resource-manager/readme.python.md b/specification/liftrqumulo/resource-manager/readme.python.md index d69356f3247a..92bab489c2e5 100644 --- a/specification/liftrqumulo/resource-manager/readme.python.md +++ b/specification/liftrqumulo/resource-manager/readme.python.md @@ -19,3 +19,10 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/qumulo/azure-mgmt-qumulo/azure/mgmt/qumulo ``` + +``` yaml $(python) +directive: + - from: swagger-document + where: $["definitions"]["LiftrBase.Storage.FileSystemResourceProperties"] + transform: $["properties"]["privateIPs"]["x-ms-client-name"] = "private_ips" +``` From 9353cd8bfa0a6666995fe08ffbab007f91422f40 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Thu, 11 Jul 2024 10:32:23 -0700 Subject: [PATCH 309/343] Removing api-key change for python, for now Signed-off-by: Travis Angevine --- specification/ai/ModelClient/main.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/main.tsp b/specification/ai/ModelClient/main.tsp index d3958a8697c1..396f471b7171 100644 --- a/specification/ai/ModelClient/main.tsp +++ b/specification/ai/ModelClient/main.tsp @@ -10,7 +10,7 @@ using Azure.Core; #suppress "@azure-tools/typespec-autorest/unsupported-http-auth-scheme" @useAuth( - BearerAuth | ApiKeyAuth | OAuth2Auth<[ + BearerAuth | OAuth2Auth<[ { type: OAuth2FlowType.implicit, authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", From 6dd7b1f0b4e62d1c2d78e1fa6ab3addd032d9920 Mon Sep 17 00:00:00 2001 From: zhuoyunwang <148281879+zhuoyunwang@users.noreply.github.com> Date: Thu, 11 Jul 2024 10:47:54 -0700 Subject: [PATCH 310/343] [Oracle Database@Azure] Add new preview and stable API versions for 2024-06-01 (#29585) * add new preview and stable API versions * remove unnecessary add decorator * re-compile after merging with main --------- Co-authored-by: zhuoyun wang --- .../autonomousDatabaseBackup_create.json | 71 + .../autonomousDatabaseBackup_delete.json | 20 + .../autonomousDatabaseBackup_get.json | 37 + ...autonomousDatabaseBackup_listByParent.json | 40 + .../autonomousDatabaseBackup_patch.json | 41 + .../autonomousDatabaseCharacterSet_get.json | 21 + ...usDatabaseCharacterSet_listByLocation.json | 32 + .../autonomousDatabaseClone_create.json | 141 + ...omousDatabaseNationalCharacterSet_get.json | 21 + ...seNationalCharacterSet_listByLocation.json | 25 + .../autonomousDatabaseVersion_get.json | 21 + ...onomousDatabaseVersion_listByLocation.json | 25 + .../autonomousDatabase_create.json | 136 + .../autonomousDatabase_delete.json | 19 + .../autonomousDatabase_failover.json | 90 + .../autonomousDatabase_generateWallet.json | 25 + .../autonomousDatabase_get.json | 63 + ...utonomousDatabase_listByResourceGroup.json | 67 + ...autonomousDatabase_listBySubscription.json | 66 + .../autonomousDatabase_patch.json | 73 + .../autonomousDatabase_restore.json | 80 + .../autonomousDatabase_shrink.json | 77 + .../autonomousDatabase_switchover.json | 89 + .../2024-06-01-preview/dbNodes_action.json | 50 + .../2024-06-01-preview/dbNodes_get.json | 41 + .../dbNodes_listByParent.json | 45 + .../2024-06-01-preview/dbServers_get.json | 42 + .../dbServers_listByParent.json | 46 + .../dbSystemShapes_get.json | 40 + .../dbSystemShapes_listByLocation.json | 44 + .../dnsPrivateViews_get.json | 27 + .../dnsPrivateViews_listByLocation.json | 44 + .../dnsPrivateZones_get.json | 29 + .../dnsPrivateZones_listByLocation.json | 48 + .../exaInfra_addStorageCapacity.json | 95 + .../2024-06-01-preview/exaInfra_create.json | 184 + .../2024-06-01-preview/exaInfra_delete.json | 19 + .../2024-06-01-preview/exaInfra_get.json | 89 + .../exaInfra_listByResourceGroup.json | 93 + .../exaInfra_listBySubscription.json | 92 + .../2024-06-01-preview/exaInfra_patch.json | 102 + .../2024-06-01-preview/giVersions_get.json | 21 + .../giVersions_listByLocation.json | 25 + .../2024-06-01-preview/operations_list.json | 25 + ...leSubscriptions_addAzureSubscriptions.json | 21 + .../oracleSubscriptions_create.json | 56 + .../oracleSubscriptions_delete.json | 17 + .../oracleSubscriptions_get.json | 29 + ...acleSubscriptions_listActivationLinks.json | 22 + ...racleSubscriptions_listBySubscription.json | 34 + ...Subscriptions_listCloudAccountDetails.json | 22 + ...criptions_listSaasSubscriptionDetails.json | 32 + .../oracleSubscriptions_patch.json | 43 + .../systemVersions_get.json | 20 + .../systemVersions_listByLocation.json | 24 + .../virtualNetworkAddresses_create.json | 48 + .../virtualNetworkAddresses_delete.json | 20 + .../virtualNetworkAddresses_get.json | 29 + .../virtualNetworkAddresses_listByParent.json | 33 + .../2024-06-01-preview/vmClusters_addVms.json | 102 + .../2024-06-01-preview/vmClusters_create.json | 224 + .../2024-06-01-preview/vmClusters_delete.json | 19 + .../2024-06-01-preview/vmClusters_get.json | 104 + .../vmClusters_listByResourceGroup.json | 95 + .../vmClusters_listBySubscription.json | 94 + .../vmClusters_listPrivateIpAddresses.json | 27 + .../2024-06-01-preview/vmClusters_patch.json | 101 + .../vmClusters_removeVms.json | 102 + .../autonomousDatabaseBackup_create.json | 71 + .../autonomousDatabaseBackup_delete.json | 20 + .../autonomousDatabaseBackup_get.json | 37 + ...autonomousDatabaseBackup_listByParent.json | 40 + .../autonomousDatabaseBackup_patch.json | 41 + .../autonomousDatabaseCharacterSet_get.json | 21 + ...usDatabaseCharacterSet_listByLocation.json | 32 + .../autonomousDatabaseClone_create.json | 141 + ...omousDatabaseNationalCharacterSet_get.json | 21 + ...seNationalCharacterSet_listByLocation.json | 25 + .../autonomousDatabaseVersion_get.json | 21 + ...onomousDatabaseVersion_listByLocation.json | 25 + .../2024-06-01/autonomousDatabase_create.json | 136 + .../2024-06-01/autonomousDatabase_delete.json | 19 + .../autonomousDatabase_failover.json | 90 + .../autonomousDatabase_generateWallet.json | 25 + .../2024-06-01/autonomousDatabase_get.json | 63 + ...utonomousDatabase_listByResourceGroup.json | 67 + ...autonomousDatabase_listBySubscription.json | 66 + .../2024-06-01/autonomousDatabase_patch.json | 73 + .../autonomousDatabase_restore.json | 80 + .../2024-06-01/autonomousDatabase_shrink.json | 77 + .../autonomousDatabase_switchover.json | 89 + .../examples/2024-06-01/dbNodes_action.json | 50 + .../examples/2024-06-01/dbNodes_get.json | 41 + .../2024-06-01/dbNodes_listByParent.json | 45 + .../examples/2024-06-01/dbServers_get.json | 42 + .../2024-06-01/dbServers_listByParent.json | 46 + .../2024-06-01/dbSystemShapes_get.json | 40 + .../dbSystemShapes_listByLocation.json | 44 + .../2024-06-01/dnsPrivateViews_get.json | 27 + .../dnsPrivateViews_listByLocation.json | 44 + .../2024-06-01/dnsPrivateZones_get.json | 29 + .../dnsPrivateZones_listByLocation.json | 48 + .../exaInfra_addStorageCapacity.json | 95 + .../examples/2024-06-01/exaInfra_create.json | 184 + .../examples/2024-06-01/exaInfra_delete.json | 19 + .../examples/2024-06-01/exaInfra_get.json | 89 + .../exaInfra_listByResourceGroup.json | 93 + .../exaInfra_listBySubscription.json | 92 + .../examples/2024-06-01/exaInfra_patch.json | 102 + .../examples/2024-06-01/giVersions_get.json | 21 + .../2024-06-01/giVersions_listByLocation.json | 25 + .../examples/2024-06-01/operations_list.json | 25 + ...leSubscriptions_addAzureSubscriptions.json | 21 + .../oracleSubscriptions_create.json | 56 + .../oracleSubscriptions_delete.json | 17 + .../2024-06-01/oracleSubscriptions_get.json | 29 + ...acleSubscriptions_listActivationLinks.json | 22 + ...racleSubscriptions_listBySubscription.json | 34 + ...Subscriptions_listCloudAccountDetails.json | 22 + ...criptions_listSaasSubscriptionDetails.json | 32 + .../2024-06-01/oracleSubscriptions_patch.json | 43 + .../2024-06-01/systemVersions_get.json | 20 + .../systemVersions_listByLocation.json | 24 + .../virtualNetworkAddresses_create.json | 48 + .../virtualNetworkAddresses_delete.json | 20 + .../virtualNetworkAddresses_get.json | 29 + .../virtualNetworkAddresses_listByParent.json | 33 + .../2024-06-01/vmClusters_addVms.json | 102 + .../2024-06-01/vmClusters_create.json | 224 + .../2024-06-01/vmClusters_delete.json | 19 + .../examples/2024-06-01/vmClusters_get.json | 104 + .../vmClusters_listByResourceGroup.json | 95 + .../vmClusters_listBySubscription.json | 94 + .../vmClusters_listPrivateIpAddresses.json | 27 + .../examples/2024-06-01/vmClusters_patch.json | 101 + .../2024-06-01/vmClusters_removeVms.json | 102 + .../oracleSubscriptionOperations.tsp | 12 + .../oracle/Oracle.Database/versions.tsp | 10 + .../oraclesubscription/oracleSubscription.tsp | 38 + .../autonomousDatabaseBackup_create.json | 71 + .../autonomousDatabaseBackup_delete.json | 20 + .../autonomousDatabaseBackup_get.json | 37 + ...autonomousDatabaseBackup_listByParent.json | 40 + .../autonomousDatabaseBackup_patch.json | 41 + .../autonomousDatabaseCharacterSet_get.json | 21 + ...usDatabaseCharacterSet_listByLocation.json | 32 + .../autonomousDatabaseClone_create.json | 141 + ...omousDatabaseNationalCharacterSet_get.json | 21 + ...seNationalCharacterSet_listByLocation.json | 25 + .../autonomousDatabaseVersion_get.json | 21 + ...onomousDatabaseVersion_listByLocation.json | 25 + .../examples/autonomousDatabase_create.json | 136 + .../examples/autonomousDatabase_delete.json | 19 + .../examples/autonomousDatabase_failover.json | 90 + .../autonomousDatabase_generateWallet.json | 25 + .../examples/autonomousDatabase_get.json | 63 + ...utonomousDatabase_listByResourceGroup.json | 67 + ...autonomousDatabase_listBySubscription.json | 66 + .../examples/autonomousDatabase_patch.json | 73 + .../examples/autonomousDatabase_restore.json | 80 + .../examples/autonomousDatabase_shrink.json | 77 + .../autonomousDatabase_switchover.json | 89 + .../examples/dbNodes_action.json | 50 + .../examples/dbNodes_get.json | 41 + .../examples/dbNodes_listByParent.json | 45 + .../examples/dbServers_get.json | 42 + .../examples/dbServers_listByParent.json | 46 + .../examples/dbSystemShapes_get.json | 40 + .../dbSystemShapes_listByLocation.json | 44 + .../examples/dnsPrivateViews_get.json | 27 + .../dnsPrivateViews_listByLocation.json | 44 + .../examples/dnsPrivateZones_get.json | 29 + .../dnsPrivateZones_listByLocation.json | 48 + .../examples/exaInfra_addStorageCapacity.json | 95 + .../examples/exaInfra_create.json | 184 + .../examples/exaInfra_delete.json | 19 + .../examples/exaInfra_get.json | 89 + .../exaInfra_listByResourceGroup.json | 93 + .../examples/exaInfra_listBySubscription.json | 92 + .../examples/exaInfra_patch.json | 102 + .../examples/giVersions_get.json | 21 + .../examples/giVersions_listByLocation.json | 25 + .../examples/operations_list.json | 25 + ...leSubscriptions_addAzureSubscriptions.json | 21 + .../examples/oracleSubscriptions_create.json | 56 + .../examples/oracleSubscriptions_delete.json | 17 + .../examples/oracleSubscriptions_get.json | 29 + ...acleSubscriptions_listActivationLinks.json | 22 + ...racleSubscriptions_listBySubscription.json | 34 + ...Subscriptions_listCloudAccountDetails.json | 22 + ...criptions_listSaasSubscriptionDetails.json | 32 + .../examples/oracleSubscriptions_patch.json | 43 + .../examples/systemVersions_get.json | 20 + .../systemVersions_listByLocation.json | 24 + .../virtualNetworkAddresses_create.json | 48 + .../virtualNetworkAddresses_delete.json | 20 + .../examples/virtualNetworkAddresses_get.json | 29 + .../virtualNetworkAddresses_listByParent.json | 33 + .../examples/vmClusters_addVms.json | 102 + .../examples/vmClusters_create.json | 224 + .../examples/vmClusters_delete.json | 19 + .../examples/vmClusters_get.json | 104 + .../vmClusters_listByResourceGroup.json | 95 + .../vmClusters_listBySubscription.json | 94 + .../vmClusters_listPrivateIpAddresses.json | 27 + .../examples/vmClusters_patch.json | 101 + .../examples/vmClusters_removeVms.json | 102 + .../preview/2024-06-01-preview/openapi.json | 9895 +++++++++++++++++ .../autonomousDatabaseBackup_create.json | 71 + .../autonomousDatabaseBackup_delete.json | 20 + .../autonomousDatabaseBackup_get.json | 37 + ...autonomousDatabaseBackup_listByParent.json | 40 + .../autonomousDatabaseBackup_patch.json | 41 + .../autonomousDatabaseCharacterSet_get.json | 21 + ...usDatabaseCharacterSet_listByLocation.json | 32 + .../autonomousDatabaseClone_create.json | 141 + ...omousDatabaseNationalCharacterSet_get.json | 21 + ...seNationalCharacterSet_listByLocation.json | 25 + .../autonomousDatabaseVersion_get.json | 21 + ...onomousDatabaseVersion_listByLocation.json | 25 + .../examples/autonomousDatabase_create.json | 136 + .../examples/autonomousDatabase_delete.json | 19 + .../examples/autonomousDatabase_failover.json | 90 + .../autonomousDatabase_generateWallet.json | 25 + .../examples/autonomousDatabase_get.json | 63 + ...utonomousDatabase_listByResourceGroup.json | 67 + ...autonomousDatabase_listBySubscription.json | 66 + .../examples/autonomousDatabase_patch.json | 73 + .../examples/autonomousDatabase_restore.json | 80 + .../examples/autonomousDatabase_shrink.json | 77 + .../autonomousDatabase_switchover.json | 89 + .../2024-06-01/examples/dbNodes_action.json | 50 + .../2024-06-01/examples/dbNodes_get.json | 41 + .../examples/dbNodes_listByParent.json | 45 + .../2024-06-01/examples/dbServers_get.json | 42 + .../examples/dbServers_listByParent.json | 46 + .../examples/dbSystemShapes_get.json | 40 + .../dbSystemShapes_listByLocation.json | 44 + .../examples/dnsPrivateViews_get.json | 27 + .../dnsPrivateViews_listByLocation.json | 44 + .../examples/dnsPrivateZones_get.json | 29 + .../dnsPrivateZones_listByLocation.json | 48 + .../examples/exaInfra_addStorageCapacity.json | 95 + .../2024-06-01/examples/exaInfra_create.json | 184 + .../2024-06-01/examples/exaInfra_delete.json | 19 + .../2024-06-01/examples/exaInfra_get.json | 89 + .../exaInfra_listByResourceGroup.json | 93 + .../examples/exaInfra_listBySubscription.json | 92 + .../2024-06-01/examples/exaInfra_patch.json | 102 + .../2024-06-01/examples/giVersions_get.json | 21 + .../examples/giVersions_listByLocation.json | 25 + .../2024-06-01/examples/operations_list.json | 25 + ...leSubscriptions_addAzureSubscriptions.json | 21 + .../examples/oracleSubscriptions_create.json | 56 + .../examples/oracleSubscriptions_delete.json | 17 + .../examples/oracleSubscriptions_get.json | 29 + ...acleSubscriptions_listActivationLinks.json | 22 + ...racleSubscriptions_listBySubscription.json | 34 + ...Subscriptions_listCloudAccountDetails.json | 22 + ...criptions_listSaasSubscriptionDetails.json | 32 + .../examples/oracleSubscriptions_patch.json | 43 + .../examples/systemVersions_get.json | 20 + .../systemVersions_listByLocation.json | 24 + .../virtualNetworkAddresses_create.json | 48 + .../virtualNetworkAddresses_delete.json | 20 + .../examples/virtualNetworkAddresses_get.json | 29 + .../virtualNetworkAddresses_listByParent.json | 33 + .../examples/vmClusters_addVms.json | 102 + .../examples/vmClusters_create.json | 224 + .../examples/vmClusters_delete.json | 19 + .../2024-06-01/examples/vmClusters_get.json | 104 + .../vmClusters_listByResourceGroup.json | 95 + .../vmClusters_listBySubscription.json | 94 + .../vmClusters_listPrivateIpAddresses.json | 27 + .../2024-06-01/examples/vmClusters_patch.json | 101 + .../examples/vmClusters_removeVms.json | 102 + .../stable/2024-06-01/openapi.json | 9895 +++++++++++++++++ .../oracle/resource-manager/readme.md | 20 +- 278 files changed, 35065 insertions(+), 1 deletion(-) create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseClone_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseVersion_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseVersion_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_failover.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_generateWallet.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_restore.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_shrink.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_switchover.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_action.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbServers_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbServers_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbSystemShapes_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbSystemShapes_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateViews_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateViews_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateZones_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateZones_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_addStorageCapacity.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/giVersions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/giVersions_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/operations_list.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_addAzureSubscriptions.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listActivationLinks.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listCloudAccountDetails.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/systemVersions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/systemVersions_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_addVms.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listPrivateIpAddresses.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_removeVms.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseCharacterSet_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseCharacterSet_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseClone_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseVersion_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseVersion_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_failover.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_generateWallet.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_restore.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_shrink.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_switchover.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_action.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dbServers_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dbServers_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dbSystemShapes_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dbSystemShapes_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateViews_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateViews_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateZones_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateZones_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_addStorageCapacity.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/giVersions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/giVersions_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/operations_list.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_addAzureSubscriptions.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listActivationLinks.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listCloudAccountDetails.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listSaasSubscriptionDetails.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/systemVersions_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/systemVersions_listByLocation.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_listByParent.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_addVms.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_create.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_delete.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_get.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listByResourceGroup.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listBySubscription.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listPrivateIpAddresses.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_patch.json create mode 100644 specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_removeVms.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseClone_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_failover.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_generateWallet.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listByResourceGroup.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_restore.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_shrink.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_switchover.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_addStorageCapacity.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listByResourceGroup.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/operations_list.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_addAzureSubscriptions.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listActivationLinks.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listCloudAccountDetails.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listSaasSubscriptionDetails.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_addVms.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listByResourceGroup.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listPrivateIpAddresses.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_removeVms.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseClone_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_failover.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_generateWallet.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listByResourceGroup.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_restore.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_shrink.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_switchover.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_addStorageCapacity.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listByResourceGroup.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/operations_list.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_addAzureSubscriptions.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listActivationLinks.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listCloudAccountDetails.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_listByLocation.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_listByParent.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_addVms.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_create.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_delete.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_get.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listByResourceGroup.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listBySubscription.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listPrivateIpAddresses.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_patch.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_removeVms.json create mode 100644 specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..e7a747bf7f99 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..9024bb556814 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..28b9844e4af7 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_listByParent.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..3b8ef5d0c023 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..d770ccd7bf25 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..6b48c38b3242 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..3208a62ffde7 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseClone_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..fe956ffdd48e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..ad1ecd6d6092 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..6acb2eb02a49 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseVersion_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..1e516b3b27ed --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..899b89d86f16 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_create.json new file mode 100644 index 000000000000..92fa3fd8899a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_delete.json new file mode 100644 index 000000000000..1b362325b846 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_failover.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_failover.json new file mode 100644 index 000000000000..d252740d5b69 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_generateWallet.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..9605115fd580 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_get.json new file mode 100644 index 000000000000..4b888b79d297 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..b4ed6e0a4a6d --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..80112af9c96d --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_patch.json new file mode 100644 index 000000000000..dc9c1975b077 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_restore.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_restore.json new file mode 100644 index 000000000000..5022c67f321b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_shrink.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..f7cd000c059b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_switchover.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..32d91768c7a9 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_action.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_action.json new file mode 100644 index 000000000000..ba39d8bb992f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_get.json new file mode 100644 index 000000000000..0dae0617aa9b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_listByParent.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_listByParent.json new file mode 100644 index 000000000000..997a2a6df52f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbServers_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbServers_get.json new file mode 100644 index 000000000000..54fa1809fb1e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbServers_listByParent.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbServers_listByParent.json new file mode 100644 index 000000000000..77a7073106e8 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbSystemShapes_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbSystemShapes_get.json new file mode 100644 index 000000000000..249db363069d --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbSystemShapes_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..eb2183605dbf --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateViews_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateViews_get.json new file mode 100644 index 000000000000..5f4a3f707f16 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateViews_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..befa9f52d572 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateZones_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateZones_get.json new file mode 100644 index 000000000000..237b23d32ef4 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateZones_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..9b716d67db53 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_addStorageCapacity.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..2f1f55f1e0f5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_create.json new file mode 100644 index 000000000000..950670cb1a0e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_delete.json new file mode 100644 index 000000000000..d6544bee4267 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_get.json new file mode 100644 index 000000000000..35f9d5ca638c --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..c7b0ec071c04 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..97acca1bb5fd --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_patch.json new file mode 100644 index 000000000000..83b7cef6f8db --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/giVersions_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/giVersions_get.json new file mode 100644 index 000000000000..60ec5e30ae01 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/giVersions_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/giVersions_listByLocation.json new file mode 100644 index 000000000000..3563879e8421 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/operations_list.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/operations_list.json new file mode 100644 index 000000000000..7f3d0d47252f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_addAzureSubscriptions.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_addAzureSubscriptions.json new file mode 100644 index 000000000000..91211e23321f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_addAzureSubscriptions.json @@ -0,0 +1,21 @@ +{ + "operationId": "OracleSubscriptions_addAzureSubscriptions", + "title": "OracleSubscriptions_addAzureSubscriptions", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "azureSubscriptionIds": [ + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_create.json new file mode 100644 index 000000000000..5e5e61d7a559 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..ebd194b690dc --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_get.json new file mode 100644 index 000000000000..42519ceb1456 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listActivationLinks.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..752a012c3b30 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..ea13f43dba02 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..9d091d428625 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..f33b7487c230 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..eb3bf9935a8c --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/systemVersions_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/systemVersions_get.json new file mode 100644 index 000000000000..772079509ae6 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/systemVersions_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/systemVersions_listByLocation.json new file mode 100644 index 000000000000..b7d86b03d49b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..f55ccc3f7a31 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..0cd1fcd5de39 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..4e6ca34d8a8a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_listByParent.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..06393148fcf5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_addVms.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_addVms.json new file mode 100644 index 000000000000..ae3e82195734 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_create.json new file mode 100644 index 000000000000..81d70bdfea31 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_delete.json new file mode 100644 index 000000000000..26b2c05ca71f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_get.json new file mode 100644 index 000000000000..8b5d66fc5d5a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..1b0434639d71 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..7be3134c943b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listPrivateIpAddresses.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..496cecd570e3 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_patch.json new file mode 100644 index 000000000000..eca77cb6d6b2 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_removeVms.json b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_removeVms.json new file mode 100644 index 000000000000..b7142d5d1909 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01-preview/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..9ebce87139c0 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..14b89f7ae2b5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..18f1545476f1 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_listByParent.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..a29bb766f51b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..bbad833f86a4 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseCharacterSet_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..523f1ff24bed --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..a76071985fef --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseClone_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..9d2b4af6f591 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..37dafabacdd5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..c0b0c4f7a0aa --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseVersion_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..47fa4b9d66d6 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..9a726ca84fb9 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_create.json new file mode 100644 index 000000000000..f6fea70651ba --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_delete.json new file mode 100644 index 000000000000..6b708c825459 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_failover.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_failover.json new file mode 100644 index 000000000000..61a9ed318856 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_generateWallet.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..f7d99778b93d --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_get.json new file mode 100644 index 000000000000..70f7a939e68f --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..3e3e79afdef9 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..fc9fc22c896c --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_patch.json new file mode 100644 index 000000000000..c87c05211523 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_restore.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_restore.json new file mode 100644 index 000000000000..e1ad46f498f2 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_shrink.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..0d4514db9cc7 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_switchover.json b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..24a17baf196a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_action.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_action.json new file mode 100644 index 000000000000..8759060a9153 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_get.json new file mode 100644 index 000000000000..f1c05c614172 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_listByParent.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_listByParent.json new file mode 100644 index 000000000000..a129607a449b --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dbServers_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dbServers_get.json new file mode 100644 index 000000000000..b36cbd0ca1f1 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dbServers_listByParent.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dbServers_listByParent.json new file mode 100644 index 000000000000..e373e2fe04ff --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dbSystemShapes_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dbSystemShapes_get.json new file mode 100644 index 000000000000..ded7bb7b5c5e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dbSystemShapes_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..961bceef1071 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateViews_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateViews_get.json new file mode 100644 index 000000000000..826e6cbed202 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateViews_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..41452ef83946 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateZones_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateZones_get.json new file mode 100644 index 000000000000..8f025cdf4583 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateZones_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..f83d475eaf7a --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_addStorageCapacity.json b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..a8c9b7f02411 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_create.json new file mode 100644 index 000000000000..fe163d1df594 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_delete.json new file mode 100644 index 000000000000..690faa2619be --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_get.json new file mode 100644 index 000000000000..02018dc9d070 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..637714be7f17 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..bc1d84648c85 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_patch.json new file mode 100644 index 000000000000..4d224bfb31e5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/giVersions_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/giVersions_get.json new file mode 100644 index 000000000000..9f869012ffa4 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/giVersions_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01/giVersions_listByLocation.json new file mode 100644 index 000000000000..e1f9a8790206 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/operations_list.json b/specification/oracle/Oracle.Database/examples/2024-06-01/operations_list.json new file mode 100644 index 000000000000..90d233fd2bed --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_addAzureSubscriptions.json b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_addAzureSubscriptions.json new file mode 100644 index 000000000000..5ced338ab0a8 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_addAzureSubscriptions.json @@ -0,0 +1,21 @@ +{ + "operationId": "OracleSubscriptions_addAzureSubscriptions", + "title": "OracleSubscriptions_addAzureSubscriptions", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "azureSubscriptionIds": [ + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_create.json new file mode 100644 index 000000000000..087479add3a6 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..8f36e973bb3e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_get.json new file mode 100644 index 000000000000..54ff6b48c87e --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listActivationLinks.json b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..8e1f22e31ef5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..e7ddb186b915 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..92430982a4a4 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..7fbb31a28fb5 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..68ba78376523 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/systemVersions_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/systemVersions_get.json new file mode 100644 index 000000000000..5f490d631bd4 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/systemVersions_listByLocation.json b/specification/oracle/Oracle.Database/examples/2024-06-01/systemVersions_listByLocation.json new file mode 100644 index 000000000000..cab8022e27f1 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..1060f3098866 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..154d26c1fccb --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..21de10dd3bc8 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_listByParent.json b/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..8cb03a39fb76 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_addVms.json b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_addVms.json new file mode 100644 index 000000000000..376ab18bcab7 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_create.json b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_create.json new file mode 100644 index 000000000000..5f3f539ba6a8 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_delete.json b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_delete.json new file mode 100644 index 000000000000..4892b0899e72 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_get.json b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_get.json new file mode 100644 index 000000000000..7bf1d3d3d351 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listByResourceGroup.json b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..ebe7f027aacb --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listBySubscription.json b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..26d22f28ced8 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listPrivateIpAddresses.json b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..9bf2ea94b6e0 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_patch.json b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_patch.json new file mode 100644 index 000000000000..677fa1d0a913 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_removeVms.json b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_removeVms.json new file mode 100644 index 000000000000..27fe11214c93 --- /dev/null +++ b/specification/oracle/Oracle.Database/examples/2024-06-01/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp b/specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp index 24189714b5ba..9ace7746a9b2 100644 --- a/specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp +++ b/specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp @@ -3,6 +3,7 @@ import "../../../models/oraclesubscription/oracleSubscription.tsp"; using Azure.ResourceManager; using Azure.ResourceManager.Foundations; using Autorest; +using TypeSpec.Versioning; namespace Oracle.Database; @@ -42,6 +43,17 @@ interface OracleSubscriptions ActivationLinks >; + @added(Versions.v20240601_preview) + @doc("Add Azure Subscriptions") + @example( + "./examples/oracleSubscriptions_addAzureSubscriptions.json", + "Add Azure Subscriptions to the OracleSubscription" + ) + addAzureSubscriptions is ArmResourceActionNoResponseContentAsync< + OracleSubscription, + AzureSubscriptions + >; + /** * @dev Update a resource using the asynchronous call pattern. * @template Resource The ArmResource to update. diff --git a/specification/oracle/Oracle.Database/versions.tsp b/specification/oracle/Oracle.Database/versions.tsp index 6536215fc8a8..a577e1983f4e 100644 --- a/specification/oracle/Oracle.Database/versions.tsp +++ b/specification/oracle/Oracle.Database/versions.tsp @@ -13,4 +13,14 @@ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @doc("2023-09-01") v20230901: "2023-09-01", + + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("2024-06-01-preview") + v20240601_preview: "2024-06-01-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("2024-06-01") + v20240601: "2024-06-01", } diff --git a/specification/oracle/models/oraclesubscription/oracleSubscription.tsp b/specification/oracle/models/oraclesubscription/oracleSubscription.tsp index 35f57cae1404..1d21cb098e5a 100644 --- a/specification/oracle/models/oraclesubscription/oracleSubscription.tsp +++ b/specification/oracle/models/oraclesubscription/oracleSubscription.tsp @@ -1,5 +1,6 @@ using TypeSpec.Http; using TypeSpec.Rest; +using TypeSpec.Versioning; using Azure.ResourceManager; namespace Oracle.Database; @@ -145,6 +146,28 @@ model ActivationLinks { existingCloudAccountActivationLink?: string; } +@added(Versions.v20240601_preview) +@doc("Azure Subscriptions model") +model AzureSubscriptions { + @doc("Azure Subscription Ids to be updated") + azureSubscriptionIds: string[]; +} + +@added(Versions.v20240601_preview) +@doc("Add Subscription Operation state enum") +union AddSubscriptionOperationState { + @doc("Succeeded - State when Add Subscription operation succeeded") + Succeeded: "Succeeded", + + @doc("Updating - State when Add Subscription operation is being Updated") + Updating: "Updating", + + @doc("Failed - State when Add Subscription operation failed") + Failed: "Failed", + + string, +} + @doc("Oracle Subscription resource model") model OracleSubscriptionProperties { @doc("OracleSubscriptionProvisioningState provisioning state") @@ -174,4 +197,19 @@ model OracleSubscriptionProperties { @doc("Intent for the update operation") @visibility("update") intent?: Intent; + + @added(Versions.v20240601_preview) + @doc("Azure subscriptions associated with this OracleSubscription") + @visibility("read") + azureSubscriptionIds?: string[]; + + @added(Versions.v20240601_preview) + @doc("State of the add Azure subscription operation on Oracle subscription") + @visibility("read") + addSubscriptionOperationState?: AddSubscriptionOperationState; + + @added(Versions.v20240601_preview) + @doc("Status details of the last operation on Oracle subscription") + @visibility("read") + lastOperationStatusDetail?: string; } diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..e7a747bf7f99 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..9024bb556814 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..28b9844e4af7 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..3b8ef5d0c023 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..d770ccd7bf25 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..6b48c38b3242 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..3208a62ffde7 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseClone_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..fe956ffdd48e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..ad1ecd6d6092 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..6acb2eb02a49 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..1e516b3b27ed --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..899b89d86f16 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_create.json new file mode 100644 index 000000000000..92fa3fd8899a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_delete.json new file mode 100644 index 000000000000..1b362325b846 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_failover.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_failover.json new file mode 100644 index 000000000000..d252740d5b69 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_generateWallet.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..9605115fd580 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_get.json new file mode 100644 index 000000000000..4b888b79d297 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..b4ed6e0a4a6d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..80112af9c96d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_patch.json new file mode 100644 index 000000000000..dc9c1975b077 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_restore.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_restore.json new file mode 100644 index 000000000000..5022c67f321b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_shrink.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..f7cd000c059b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_switchover.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..32d91768c7a9 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json new file mode 100644 index 000000000000..ba39d8bb992f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_get.json new file mode 100644 index 000000000000..0dae0617aa9b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_listByParent.json new file mode 100644 index 000000000000..997a2a6df52f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_get.json new file mode 100644 index 000000000000..54fa1809fb1e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_listByParent.json new file mode 100644 index 000000000000..77a7073106e8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_get.json new file mode 100644 index 000000000000..249db363069d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..eb2183605dbf --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_get.json new file mode 100644 index 000000000000..5f4a3f707f16 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..befa9f52d572 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_get.json new file mode 100644 index 000000000000..237b23d32ef4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..9b716d67db53 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_addStorageCapacity.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..2f1f55f1e0f5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_create.json new file mode 100644 index 000000000000..950670cb1a0e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_delete.json new file mode 100644 index 000000000000..d6544bee4267 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_get.json new file mode 100644 index 000000000000..35f9d5ca638c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..c7b0ec071c04 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..97acca1bb5fd --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_patch.json new file mode 100644 index 000000000000..83b7cef6f8db --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_get.json new file mode 100644 index 000000000000..60ec5e30ae01 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_listByLocation.json new file mode 100644 index 000000000000..3563879e8421 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/operations_list.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/operations_list.json new file mode 100644 index 000000000000..7f3d0d47252f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_addAzureSubscriptions.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_addAzureSubscriptions.json new file mode 100644 index 000000000000..91211e23321f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_addAzureSubscriptions.json @@ -0,0 +1,21 @@ +{ + "operationId": "OracleSubscriptions_addAzureSubscriptions", + "title": "OracleSubscriptions_addAzureSubscriptions", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "azureSubscriptionIds": [ + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_create.json new file mode 100644 index 000000000000..5e5e61d7a559 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..ebd194b690dc --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_get.json new file mode 100644 index 000000000000..42519ceb1456 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listActivationLinks.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..752a012c3b30 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..ea13f43dba02 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..9d091d428625 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..f33b7487c230 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..eb3bf9935a8c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_get.json new file mode 100644 index 000000000000..772079509ae6 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_listByLocation.json new file mode 100644 index 000000000000..b7d86b03d49b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..f55ccc3f7a31 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..0cd1fcd5de39 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..4e6ca34d8a8a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..06393148fcf5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_addVms.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_addVms.json new file mode 100644 index 000000000000..ae3e82195734 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_create.json new file mode 100644 index 000000000000..81d70bdfea31 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_delete.json new file mode 100644 index 000000000000..26b2c05ca71f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_get.json new file mode 100644 index 000000000000..8b5d66fc5d5a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..1b0434639d71 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..7be3134c943b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listPrivateIpAddresses.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..496cecd570e3 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_patch.json new file mode 100644 index 000000000000..eca77cb6d6b2 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_removeVms.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_removeVms.json new file mode 100644 index 000000000000..b7142d5d1909 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json new file mode 100644 index 000000000000..9b9fe7f5c179 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json @@ -0,0 +1,9895 @@ +{ + "swagger": "2.0", + "info": { + "title": "Oracle Database Resource Manager", + "version": "2024-06-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": "CloudExadataInfrastructures" + }, + { + "name": "DbServers" + }, + { + "name": "CloudVmClusters" + }, + { + "name": "VirtualNetworkAddresses" + }, + { + "name": "SystemVersions" + }, + { + "name": "OracleSubscriptions" + }, + { + "name": "DbNodes" + }, + { + "name": "GiVersions" + }, + { + "name": "DbSystemShapes" + }, + { + "name": "DnsPrivateViews" + }, + { + "name": "DnsPrivateZones" + }, + { + "name": "AutonomousDatabases" + }, + { + "name": "AutonomousDatabaseBackups" + }, + { + "name": "AutonomousDatabaseCharacterSets" + }, + { + "name": "AutonomousDatabaseNationalCharacterSets" + }, + { + "name": "AutonomousDatabaseVersions" + } + ], + "paths": { + "/providers/Oracle.Database/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Operations": { + "$ref": "./examples/operations_list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListBySubscription", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by subscription": { + "$ref": "./examples/autonomousDatabase_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListBySubscription", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by subscription": { + "$ref": "./examples/exaInfra_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListBySubscription", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by subscription": { + "$ref": "./examples/vmClusters_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "List AutonomousDatabaseCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db character sets by location": { + "$ref": "./examples/autonomousDatabaseCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets/{adbscharsetname}": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_Get", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "Get a AutonomousDatabaseCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "adbscharsetname", + "in": "path", + "description": "AutonomousDatabaseCharacterSet name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db character set": { + "$ref": "./examples/autonomousDatabaseCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "List AutonomousDatabaseNationalCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db national character sets by location": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets/{adbsncharsetname}": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_Get", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "Get a AutonomousDatabaseNationalCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "adbsncharsetname", + "in": "path", + "description": "AutonomousDatabaseNationalCharacterSets name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db national character set": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions": { + "get": { + "operationId": "AutonomousDatabaseVersions_ListByLocation", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "List AutonomousDbVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDbVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List an autonomous versions by location": { + "$ref": "./examples/autonomousDatabaseVersion_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions/{autonomousdbversionsname}": { + "get": { + "operationId": "AutonomousDatabaseVersions_Get", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "Get a AutonomousDbVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "autonomousdbversionsname", + "in": "path", + "description": "AutonomousDbVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get an autonomous version": { + "$ref": "./examples/autonomousDatabaseVersion_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes": { + "get": { + "operationId": "DbSystemShapes_ListByLocation", + "tags": [ + "DbSystemShapes" + ], + "description": "List DbSystemShape resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbSystemShapeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbSystemShapes by location": { + "$ref": "./examples/dbSystemShapes_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes/{dbsystemshapename}": { + "get": { + "operationId": "DbSystemShapes_Get", + "tags": [ + "DbSystemShapes" + ], + "description": "Get a DbSystemShape", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "dbsystemshapename", + "in": "path", + "description": "DbSystemShape name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DbSystemShape by name": { + "$ref": "./examples/dbSystemShapes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews": { + "get": { + "operationId": "DnsPrivateViews_ListByLocation", + "tags": [ + "DnsPrivateViews" + ], + "description": "List DnsPrivateView resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateViewListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateViews by location": { + "$ref": "./examples/dnsPrivateViews_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews/{dnsprivateviewocid}": { + "get": { + "operationId": "DnsPrivateViews_Get", + "tags": [ + "DnsPrivateViews" + ], + "description": "Get a DnsPrivateView", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "dnsprivateviewocid", + "in": "path", + "description": "DnsPrivateView OCID", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateView by name": { + "$ref": "./examples/dnsPrivateViews_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones": { + "get": { + "operationId": "DnsPrivateZones_ListByLocation", + "tags": [ + "DnsPrivateZones" + ], + "description": "List DnsPrivateZone resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateZoneListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateZones by location": { + "$ref": "./examples/dnsPrivateZones_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones/{dnsprivatezonename}": { + "get": { + "operationId": "DnsPrivateZones_Get", + "tags": [ + "DnsPrivateZones" + ], + "description": "Get a DnsPrivateZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "dnsprivatezonename", + "in": "path", + "description": "DnsPrivateZone name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateZone by name": { + "$ref": "./examples/dnsPrivateZones_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions": { + "get": { + "operationId": "GiVersions_ListByLocation", + "tags": [ + "GiVersions" + ], + "description": "List GiVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GiVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List GiVersions by location": { + "$ref": "./examples/giVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions/{giversionname}": { + "get": { + "operationId": "GiVersions_Get", + "tags": [ + "GiVersions" + ], + "description": "Get a GiVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "giversionname", + "in": "path", + "description": "GiVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GiVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a GiVersion by name": { + "$ref": "./examples/giVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions": { + "get": { + "operationId": "SystemVersions_ListByLocation", + "tags": [ + "SystemVersions" + ], + "description": "List SystemVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata System Versions by the provided filter": { + "$ref": "./examples/systemVersions_listByLocation.json" + }, + "systemVersions_listByLocation": { + "$ref": "./examples/systemVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions/{systemversionname}": { + "get": { + "operationId": "SystemVersions_Get", + "tags": [ + "SystemVersions" + ], + "description": "Get a SystemVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "systemversionname", + "in": "path", + "description": "SystemVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata System Version": { + "$ref": "./examples/systemVersions_get.json" + }, + "systemVersions_listSystemVersions": { + "$ref": "./examples/systemVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions": { + "get": { + "operationId": "OracleSubscriptions_ListBySubscription", + "tags": [ + "OracleSubscriptions" + ], + "description": "List OracleSubscription resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Oracle Subscriptions by subscription": { + "$ref": "./examples/oracleSubscriptions_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default": { + "get": { + "operationId": "OracleSubscriptions_Get", + "tags": [ + "OracleSubscriptions" + ], + "description": "Get a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_get.json" + } + } + }, + "put": { + "operationId": "OracleSubscriptions_CreateOrUpdate", + "tags": [ + "OracleSubscriptions" + ], + "description": "Create a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OracleSubscription' update operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "201": { + "description": "Resource 'OracleSubscription' create operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "OracleSubscriptions_Update", + "tags": [ + "OracleSubscriptions" + ], + "description": "Update a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "OracleSubscriptions_Delete", + "tags": [ + "OracleSubscriptions" + ], + "description": "Delete a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/addAzureSubscriptions": { + "post": { + "operationId": "OracleSubscriptions_AddAzureSubscriptions", + "tags": [ + "OracleSubscriptions" + ], + "description": "Add Azure Subscriptions", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AzureSubscriptions" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Add Azure Subscriptions to the OracleSubscription": { + "$ref": "./examples/oracleSubscriptions_addAzureSubscriptions.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listActivationLinks": { + "post": { + "operationId": "OracleSubscriptions_ListActivationLinks", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Activation Links", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ActivationLinks" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Activation Links for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listActivationLinks.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listCloudAccountDetails": { + "post": { + "operationId": "OracleSubscriptions_ListCloudAccountDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Cloud Account Details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudAccountDetails" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Cloud Account details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listCloudAccountDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listSaasSubscriptionDetails": { + "post": { + "operationId": "OracleSubscriptions_ListSaasSubscriptionDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Saas Subscription Details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SaasSubscriptionDetails" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Saas Subscription details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listSaasSubscriptionDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListByResourceGroup", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by resource group": { + "$ref": "./examples/autonomousDatabase_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}": { + "get": { + "operationId": "AutonomousDatabases_Get", + "tags": [ + "AutonomousDatabases" + ], + "description": "Get a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Get": { + "$ref": "./examples/autonomousDatabase_get.json" + }, + "Get Autonomous Database": { + "$ref": "./examples/autonomousDatabase_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabases_CreateOrUpdate", + "tags": [ + "AutonomousDatabases" + ], + "description": "Create a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabase' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "201": { + "description": "Resource 'AutonomousDatabase' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "AutonomousDatabases_CreateOrUpdate_clone": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + }, + "Create Autonomous Database": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "Create clone Autonomous Database": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabases_Update", + "tags": [ + "AutonomousDatabases" + ], + "description": "Update a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Autonomous Database": { + "$ref": "./examples/autonomousDatabase_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabases_Delete", + "tags": [ + "AutonomousDatabases" + ], + "description": "Delete a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Autonomous Database": { + "$ref": "./examples/autonomousDatabase_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups": { + "get": { + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "List AutonomousDatabaseBackup resources by AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_ListByAutonomousDatabase": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + }, + "List Autonomous Database Backups by Autonomous Database.": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups/{adbbackupid}": { + "get": { + "operationId": "AutonomousDatabaseBackups_Get", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Get a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Get": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + }, + "Get Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Create a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabaseBackup' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "201": { + "description": "Resource 'AutonomousDatabaseBackup' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + }, + "Create Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabaseBackups_Update", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Update a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Update": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + }, + "Patch Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabaseBackups_Delete", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Delete a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Delete": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + }, + "Delete Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/failover": { + "post": { + "operationId": "AutonomousDatabases_Failover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform failover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Failover": { + "$ref": "./examples/autonomousDatabase_failover.json" + }, + "Perform failover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_failover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/generateWallet": { + "post": { + "operationId": "AutonomousDatabases_GenerateWallet", + "tags": [ + "AutonomousDatabases" + ], + "description": "Generate wallet action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateAutonomousDatabaseWalletDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseWalletFile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Generate wallet action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_generateWallet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/restore": { + "post": { + "operationId": "AutonomousDatabases_Restore", + "tags": [ + "AutonomousDatabases" + ], + "description": "Restores an Autonomous Database based on the provided request parameters.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreAutonomousDatabaseDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Restore": { + "$ref": "./examples/autonomousDatabase_restore.json" + }, + "Perform restore action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_restore.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/shrink": { + "post": { + "operationId": "AutonomousDatabases_Shrink", + "tags": [ + "AutonomousDatabases" + ], + "description": "This operation shrinks the current allocated storage down to the current actual used data storage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Perform shrink action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_shrink.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/switchover": { + "post": { + "operationId": "AutonomousDatabases_Switchover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform switchover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Switchover": { + "$ref": "./examples/autonomousDatabase_switchover.json" + }, + "Perform switchover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_switchover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListByResourceGroup", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by resource group": { + "$ref": "./examples/exaInfra_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}": { + "get": { + "operationId": "CloudExadataInfrastructures_Get", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Get a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata Infrastructure": { + "$ref": "./examples/exaInfra_get.json" + } + } + }, + "put": { + "operationId": "CloudExadataInfrastructures_CreateOrUpdate", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Create a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudExadataInfrastructure' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "201": { + "description": "Resource 'CloudExadataInfrastructure' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Exadata Infrastructure": { + "$ref": "./examples/exaInfra_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudExadataInfrastructures_Update", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Update a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Exadata Infrastructure": { + "$ref": "./examples/exaInfra_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudExadataInfrastructures_Delete", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Delete a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Exadata Infrastructure": { + "$ref": "./examples/exaInfra_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/addStorageCapacity": { + "post": { + "operationId": "CloudExadataInfrastructures_AddStorageCapacity", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Perform add storage capacity on exadata infra", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Perform add storage capacity on exadata infra": { + "$ref": "./examples/exaInfra_addStorageCapacity.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers": { + "get": { + "operationId": "DbServers_ListByCloudExadataInfrastructure", + "tags": [ + "DbServers" + ], + "description": "List DbServer resources by CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbServers by Exadata Infrastructure": { + "$ref": "./examples/dbServers_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers/{dbserverocid}": { + "get": { + "operationId": "DbServers_Get", + "tags": [ + "DbServers" + ], + "description": "Get a DbServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbserverocid", + "in": "path", + "description": "DbServer OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbServer by parent": { + "$ref": "./examples/dbServers_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListByResourceGroup", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by resource group": { + "$ref": "./examples/vmClusters_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}": { + "get": { + "operationId": "CloudVmClusters_Get", + "tags": [ + "CloudVmClusters" + ], + "description": "Get a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get VM Cluster": { + "$ref": "./examples/vmClusters_get.json" + } + } + }, + "put": { + "operationId": "CloudVmClusters_CreateOrUpdate", + "tags": [ + "CloudVmClusters" + ], + "description": "Create a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudVmCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "201": { + "description": "Resource 'CloudVmCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create VM Cluster": { + "$ref": "./examples/vmClusters_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudVmClusters_Update", + "tags": [ + "CloudVmClusters" + ], + "description": "Update a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmClusterUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch VM Cluster": { + "$ref": "./examples/vmClusters_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudVmClusters_Delete", + "tags": [ + "CloudVmClusters" + ], + "description": "Delete a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete VM Cluster": { + "$ref": "./examples/vmClusters_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/addVms": { + "post": { + "operationId": "CloudVmClusters_AddVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Add VMs to the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Add VMs to VM Cluster": { + "$ref": "./examples/vmClusters_addVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes": { + "get": { + "operationId": "DbNodes_ListByCloudVmCluster", + "tags": [ + "DbNodes" + ], + "description": "List DbNode resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNodeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbNodes by VM Cluster": { + "$ref": "./examples/dbNodes_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}": { + "get": { + "operationId": "DbNodes_Get", + "tags": [ + "DbNodes" + ], + "description": "Get a DbNode", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbNode": { + "$ref": "./examples/dbNodes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}/action": { + "post": { + "operationId": "DbNodes_Action", + "tags": [ + "DbNodes" + ], + "description": "VM actions on DbNode of VM Cluster by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DbNodeAction" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DbNodes_Action": { + "$ref": "./examples/dbNodes_action.json" + }, + "VM actions on DbNodes of VM Cluster": { + "$ref": "./examples/dbNodes_action.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/listPrivateIpAddresses": { + "post": { + "operationId": "CloudVmClusters_ListPrivateIpAddresses", + "tags": [ + "CloudVmClusters" + ], + "description": "List Private IP Addresses by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateIpAddressesFilter" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateIpAddressProperties" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private IP Addresses for VM Cluster": { + "$ref": "./examples/vmClusters_listPrivateIpAddresses.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/removeVms": { + "post": { + "operationId": "CloudVmClusters_RemoveVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Remove VMs from the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Remove VMs from VM Cluster": { + "$ref": "./examples/vmClusters_removeVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses": { + "get": { + "operationId": "VirtualNetworkAddresses_ListByCloudVmCluster", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "List VirtualNetworkAddress resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddressListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Virtual Network Addresses by VM Cluster": { + "$ref": "./examples/virtualNetworkAddresses_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses/{virtualnetworkaddressname}": { + "get": { + "operationId": "VirtualNetworkAddresses_Get", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Get a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_get.json" + } + } + }, + "put": { + "operationId": "VirtualNetworkAddresses_CreateOrUpdate", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Create a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualNetworkAddress' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "201": { + "description": "Resource 'VirtualNetworkAddress' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualNetworkAddresses_Delete", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Delete a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActivationLinks": { + "type": "object", + "description": "Activation Links model", + "properties": { + "newCloudAccountActivationLink": { + "type": "string", + "description": "New Cloud Account Activation Link", + "readOnly": true + }, + "existingCloudAccountActivationLink": { + "type": "string", + "description": "Existing Cloud Account Activation Link", + "readOnly": true + } + } + }, + "AddRemoveDbNode": { + "type": "object", + "description": "Add/Remove (Virtual Machine) DbNode model", + "properties": { + "dbServers": { + "type": "array", + "description": "Db servers ocids", + "items": { + "$ref": "#/definitions/Ocid" + } + } + }, + "required": [ + "dbServers" + ] + }, + "AddSubscriptionOperationState": { + "type": "string", + "description": "Add Subscription Operation state enum", + "enum": [ + "Succeeded", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "AddSubscriptionOperationState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded - State when Add Subscription operation succeeded" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Updating - State when Add Subscription operation is being Updated" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed - State when Add Subscription operation failed" + } + ] + }, + "readOnly": true + }, + "AllConnectionStringType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + } + } + }, + "ApexDetailsType": { + "type": "object", + "description": "Information about Oracle APEX Application Development.", + "properties": { + "apexVersion": { + "type": "string", + "description": "The Oracle APEX Application Development version." + }, + "ordsVersion": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) version." + } + } + }, + "AutonomousDatabase": { + "type": "object", + "description": "Autonomous Database resource model.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AutonomousDatabaseBackup": { + "type": "object", + "description": "AutonomousDatabaseBackup resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseBackupLifecycleState": { + "type": "string", + "description": "Autonomous database backup lifecycle state enum", + "enum": [ + "Creating", + "Active", + "Deleting", + "Failed", + "Updating" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "AutonomousDatabase backup is creating" + }, + { + "name": "Active", + "value": "Active", + "description": "AutonomousDatabase backup is active" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "AutonomousDatabase backup is deleting" + }, + { + "name": "Failed", + "value": "Failed", + "description": "AutonomousDatabase backup is failed" + }, + { + "name": "Updating", + "value": "Updating", + "description": "AutonomousDatabase backup is updating" + } + ] + } + }, + "AutonomousDatabaseBackupListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseBackup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseBackup items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseBackupProperties": { + "type": "object", + "description": "AutonomousDatabaseBackup resource model", + "properties": { + "autonomousDatabaseOcid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database.", + "readOnly": true + }, + "databaseSizeInTbs": { + "type": "number", + "format": "double", + "description": "The size of the database in terabytes at the time the backup was taken.", + "readOnly": true + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the backup. The name does not have to be unique.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database backup.", + "readOnly": true + }, + "isAutomatic": { + "type": "boolean", + "description": "Indicates whether the backup is user-initiated or automatic.", + "readOnly": true + }, + "isRestorable": { + "type": "boolean", + "description": "Indicates whether the backup can be used to restore the associated Autonomous Database.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseBackupLifecycleState", + "description": "The current state of the backup.", + "readOnly": true + }, + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "sizeInTbs": { + "type": "number", + "format": "double", + "description": "The backup size in terabytes (TB).", + "readOnly": true + }, + "timeAvailableTil": { + "type": "string", + "format": "date-time", + "description": "Timestamp until when the backup will be available.", + "readOnly": true + }, + "timeStarted": { + "type": "string", + "description": "The date and time the backup started.", + "readOnly": true + }, + "timeEnded": { + "type": "string", + "description": "The date and time the backup completed.", + "readOnly": true + }, + "backupType": { + "$ref": "#/definitions/AutonomousDatabaseBackupType", + "description": "The type of backup.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "AutonomousDatabaseBackupType": { + "type": "string", + "description": "Autonomous database backup type enum", + "enum": [ + "Incremental", + "Full", + "LongTerm" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupType", + "modelAsString": true, + "values": [ + { + "name": "Incremental", + "value": "Incremental", + "description": "Incremental backup" + }, + { + "name": "Full", + "value": "Full", + "description": "Full backup" + }, + { + "name": "LongTerm", + "value": "LongTerm", + "description": "LongTerm backup" + } + ] + } + }, + "AutonomousDatabaseBackupUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabaseBackup.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseBackupUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabaseBackup.", + "properties": { + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseBaseProperties": { + "type": "object", + "description": "Autonomous Database base resource model.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "dataBaseType": { + "$ref": "#/definitions/DataBaseType", + "description": "Database type to be created.", + "x-ms-mutability": [ + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "characterSet": { + "type": "string", + "description": "The character set for the autonomous database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeModel": { + "$ref": "#/definitions/ComputeModel", + "description": "The compute model of the Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbIds": { + "type": "array", + "description": "The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isRemoteDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has Cross Region Data Guard enabled.", + "readOnly": true + }, + "localDisasterRecoveryType": { + "$ref": "#/definitions/DisasterRecoveryType", + "description": "Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance.Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover.Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.", + "readOnly": true + }, + "localStandbyDb": { + "$ref": "#/definitions/AutonomousDatabaseStandbySummary", + "description": "Local Autonomous Disaster Recovery standby database details.", + "readOnly": true + }, + "failedDataRecoveryInSeconds": { + "type": "integer", + "format": "int32", + "description": "Indicates the number of seconds of data loss for a Data Guard failover.", + "readOnly": true + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isPreviewVersionWithServiceTermsAccepted": { + "type": "boolean", + "description": "Specifies if the Autonomous Database preview version is being provisioned.", + "x-ms-mutability": [ + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "ncharacterSet": { + "type": "string", + "description": "The character set for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsType", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "privateEndpointIp": { + "type": "string", + "description": "The private endpoint Ip address for the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "privateEndpointLabel": { + "type": "string", + "description": "The resource's private endpoint label.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database was created.", + "readOnly": true + }, + "timeMaintenanceBegin": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will begin.", + "readOnly": true + }, + "timeMaintenanceEnd": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will end.", + "readOnly": true + }, + "actualUsedDataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The current amount of storage in use for user and system data, in terabytes (TB).", + "readOnly": true + }, + "allocatedStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The amount of storage currently allocated for the database tables and billed for, rounded up.", + "readOnly": true + }, + "apexDetails": { + "$ref": "#/definitions/ApexDetailsType", + "description": "Information about Oracle APEX Application Development.", + "readOnly": true + }, + "availableUpgradeVersions": { + "type": "array", + "description": "List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "connectionStrings": { + "$ref": "#/definitions/ConnectionStringType", + "description": "The connection string used to connect to the Autonomous Database.", + "readOnly": true + }, + "connectionUrls": { + "$ref": "#/definitions/ConnectionUrlType", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. ", + "readOnly": true + }, + "dataSafeStatus": { + "$ref": "#/definitions/DataSafeStatusType", + "description": "Status of the Data Safe registration for this Autonomous Database.", + "readOnly": true + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "autonomousDatabaseId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "Autonomous Database ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "inMemoryAreaInGbs": { + "type": "integer", + "format": "int32", + "description": "The area assigned to In-Memory tables in Autonomous Database.", + "readOnly": true + }, + "nextLongTermBackupTimeStamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the next long-term backup would be created.", + "readOnly": true + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "isPreview": { + "type": "boolean", + "description": "Indicates if the Autonomous Database version is a preview version.", + "readOnly": true + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "memoryPerOracleComputeUnitInGbs": { + "type": "integer", + "format": "int32", + "description": "The amount of memory (in GBs) enabled per ECPU or OCPU.", + "readOnly": true + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "operationsInsightsStatus": { + "$ref": "#/definitions/OperationsInsightsStatusType", + "description": "Status of Operations Insights for this Autonomous Database.", + "readOnly": true + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "privateEndpoint": { + "type": "string", + "description": "The private endpoint for the resource.", + "readOnly": true + }, + "provisionableCpus": { + "type": "array", + "description": "An array of CPU values that an Autonomous Database can be scaled to.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "serviceConsoleUrl": { + "type": "string", + "description": "The URL of the Service Console for the Autonomous Database.", + "minLength": 10, + "maxLength": 255, + "readOnly": true + }, + "sqlWebDeveloperUrl": { + "type": "string", + "description": "The SQL Web Developer URL for the Oracle Autonomous Database.", + "minLength": 10, + "maxLength": 2048, + "readOnly": true + }, + "supportedRegionsToCloneTo": { + "type": "array", + "description": "The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.", + "maxItems": 50, + "items": { + "type": "string" + }, + "readOnly": true + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the Autonomous Database.", + "readOnly": true + }, + "timeDeletionOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be automatically deleted because of inactivity.", + "readOnly": true + }, + "timeLocalDataGuardEnabled": { + "type": "string", + "description": "The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.", + "readOnly": true + }, + "timeOfLastFailover": { + "type": "string", + "description": "The timestamp of the last failover operation.", + "readOnly": true + }, + "timeOfLastRefresh": { + "type": "string", + "description": "The date and time when last refresh happened.", + "readOnly": true + }, + "timeOfLastRefreshPoint": { + "type": "string", + "description": "The refresh point timestamp (UTC).", + "readOnly": true + }, + "timeOfLastSwitchover": { + "type": "string", + "description": "The timestamp of the last switchover operation for the Autonomous Database.", + "readOnly": true + }, + "timeReclamationOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be stopped because of inactivity.", + "readOnly": true + }, + "usedDataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The storage space consumed by Autonomous Database in GBs.", + "readOnly": true + }, + "usedDataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The amount of storage that has been used, in terabytes.", + "readOnly": true + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Database ocid", + "readOnly": true + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "discriminator": "dataBaseType", + "required": [ + "dataBaseType" + ] + }, + "AutonomousDatabaseCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "AutonomousDatabaseCloneProperties": { + "type": "object", + "description": "Autonomous Database clone resource model.", + "properties": { + "source": { + "$ref": "#/definitions/SourceType", + "description": "The source of the database.", + "x-ms-mutability": [ + "create" + ] + }, + "sourceId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "The Azure ID of the Autonomous Database that was cloned to create the current Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloneType": { + "$ref": "#/definitions/CloneType", + "description": "The Autonomous Database clone type.", + "x-ms-mutability": [ + "create" + ] + }, + "isReconnectCloneEnabled": { + "type": "boolean", + "description": "Indicates if the refreshable clone can be reconnected to its source database.", + "readOnly": true + }, + "isRefreshableClone": { + "type": "boolean", + "description": "Indicates if the Autonomous Database is a refreshable clone.", + "readOnly": true + }, + "refreshableModel": { + "$ref": "#/definitions/RefreshableModelType", + "description": "The refresh mode of the clone.", + "x-ms-mutability": [ + "create" + ] + }, + "refreshableStatus": { + "$ref": "#/definitions/RefreshableStatusType", + "description": "The refresh status of the clone.", + "readOnly": true + }, + "timeUntilReconnectCloneEnabled": { + "type": "string", + "description": "The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.", + "x-ms-mutability": [ + "read", + "update" + ] + } + }, + "required": [ + "sourceId", + "cloneType" + ], + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Clone" + }, + "AutonomousDatabaseId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/autonomousDatabases" + } + ] + } + }, + "AutonomousDatabaseLifecycleState": { + "type": "string", + "description": "Autonomous database lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Unavailable", + "RestoreInProgress", + "RestoreFailed", + "BackupInProgress", + "ScaleInProgress", + "AvailableNeedsAttention", + "Updating", + "MaintenanceInProgress", + "Restarting", + "Recreating", + "RoleChangeInProgress", + "Upgrading", + "Inaccessible", + "Standby" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "RestoreInProgress", + "value": "RestoreInProgress", + "description": "Indicates that resource in RestoreInProgress state" + }, + { + "name": "RestoreFailed", + "value": "RestoreFailed", + "description": "Indicates that resource in RestoreFailed state" + }, + { + "name": "BackupInProgress", + "value": "BackupInProgress", + "description": "Indicates that resource in BackupInProgress state" + }, + { + "name": "ScaleInProgress", + "value": "ScaleInProgress", + "description": "Indicates that resource in ScaleInProgress state" + }, + { + "name": "AvailableNeedsAttention", + "value": "AvailableNeedsAttention", + "description": "Indicates that resource is available but needs attention" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Restarting", + "value": "Restarting", + "description": "Indicates that resource in Restarting state" + }, + { + "name": "Recreating", + "value": "Recreating", + "description": "Indicates that resource in Recreating state" + }, + { + "name": "RoleChangeInProgress", + "value": "RoleChangeInProgress", + "description": "Indicates that resource role change in progress state" + }, + { + "name": "Upgrading", + "value": "Upgrading", + "description": "Indicates that resource in Upgrading state" + }, + { + "name": "Inaccessible", + "value": "Inaccessible", + "description": "IIndicates that resource in Inaccessible state" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Indicates that resource in Standby state" + } + ] + } + }, + "AutonomousDatabaseListResult": { + "type": "object", + "description": "The response of a AutonomousDatabase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabase items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseNationalCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseNationalCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseNationalCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported national character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "AutonomousDatabaseProperties": { + "type": "object", + "description": "Autonomous Database resource model.", + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Regular" + }, + "AutonomousDatabaseStandbySummary": { + "type": "object", + "description": "Autonomous Disaster Recovery standby database details.", + "properties": { + "lagTimeInSeconds": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover." + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "The current state of the Autonomous Database." + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state." + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database." + }, + "timeDisasterRecoveryRoleChanged": { + "type": "string", + "description": "The date and time the Disaster Recovery role was switched for the standby Autonomous Database." + } + } + }, + "AutonomousDatabaseUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabase.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AutonomousDatabaseUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabase.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsTypeUpdate", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseWalletFile": { + "type": "object", + "description": "Autonomous Database Wallet File resource model.", + "properties": { + "walletFiles": { + "type": "string", + "description": "The base64 encoded wallet files" + } + }, + "required": [ + "walletFiles" + ] + }, + "AutonomousDbVersion": { + "type": "object", + "description": "AutonomousDbVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDbVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDbVersionListResult": { + "type": "object", + "description": "The response of a AutonomousDbVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDbVersion items on this page", + "items": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDbVersionProperties": { + "type": "object", + "description": "AutonomousDbVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "Supported Autonomous Db versions.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "readOnly": true + }, + "isDefaultForFree": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is free.", + "readOnly": true + }, + "isDefaultForPaid": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is paid.", + "readOnly": true + }, + "isFreeTierEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.", + "readOnly": true + }, + "isPaidEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software has payments enabled.", + "readOnly": true + } + } + }, + "AutonomousMaintenanceScheduleType": { + "type": "string", + "description": "Autonomous database maintenance schedule type enum.", + "enum": [ + "Early", + "Regular" + ], + "x-ms-enum": { + "name": "AutonomousMaintenanceScheduleType", + "modelAsString": true, + "values": [ + { + "name": "Early", + "value": "Early", + "description": "Early maintenance schedule" + }, + { + "name": "Regular", + "value": "Regular", + "description": "Regular maintenance schedule" + } + ] + } + }, + "Azure.ResourceManager.ResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource type.", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ResourceProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "AzureResourceProvisioningState": { + "type": "string", + "description": "Azure Resource Provisioning State enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "x-ms-enum": { + "name": "AzureResourceProvisioningState", + "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": "Indicates that resource in Provisioning state" + } + ] + }, + "readOnly": true + }, + "AzureSubscriptions": { + "type": "object", + "description": "Azure Subscriptions model", + "properties": { + "azureSubscriptionIds": { + "type": "array", + "description": "Azure Subscription Ids to be updated", + "items": { + "type": "string" + } + } + }, + "required": [ + "azureSubscriptionIds" + ] + }, + "CloneType": { + "type": "string", + "description": "Clone type enum", + "enum": [ + "Full", + "Metadata" + ], + "x-ms-enum": { + "name": "CloneType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full clone" + }, + { + "name": "Metadata", + "value": "Metadata", + "description": "Metadata only" + } + ] + } + }, + "CloudAccountDetails": { + "type": "object", + "description": "Cloud Account Details model", + "properties": { + "cloudAccountName": { + "type": "string", + "description": "Cloud Account name", + "readOnly": true + }, + "cloudAccountHomeRegion": { + "type": "string", + "description": "Cloud Account Home region", + "readOnly": true + } + } + }, + "CloudAccountProvisioningState": { + "type": "string", + "description": "CloudAccountProvisioningState enum", + "enum": [ + "Pending", + "Provisioning", + "Available" + ], + "x-ms-enum": { + "name": "CloudAccountProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Pending - Initial state when Oracle cloud account is not configured" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning - State when Oracle cloud account is being provisioned" + }, + { + "name": "Available", + "value": "Available", + "description": "Available - State when Oracle cloud account cloud linking is complete and it is available" + } + ] + } + }, + "CloudExadataInfrastructure": { + "type": "object", + "description": "CloudExadataInfrastructure resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + } + }, + "required": [ + "zones" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudExadataInfrastructureId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/cloudExadataInfrastructures" + } + ] + } + }, + "CloudExadataInfrastructureLifecycleState": { + "type": "string", + "description": "CloudExadataInfrastructureLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudExadataInfrastructureLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudExadataInfrastructureListResult": { + "type": "object", + "description": "The response of a CloudExadataInfrastructure list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudExadataInfrastructure items on this page", + "items": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudExadataInfrastructureProperties": { + "type": "object", + "description": "CloudExadataInfrastructure resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Exadata infra ocid", + "readOnly": true + }, + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "totalStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "availableStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "description": "The date and time the cloud Exadata infrastructure resource was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "estimatedPatchingTime": { + "$ref": "#/definitions/EstimatedPatchingTime", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "readOnly": true + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudExadataInfrastructure provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudExadataInfrastructureLifecycleState", + "description": "CloudExadataInfrastructure lifecycle state", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the cloud Exadata infrastructure resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores allocated.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory allocated in GBs.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs.", + "readOnly": true + }, + "maxDbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total local node storage available in GBs.", + "readOnly": true + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The quantity of data in the database, in terabytes.", + "readOnly": true + }, + "maxDataStorageInTbs": { + "type": "number", + "format": "double", + "description": "The total available DATA disk group size.", + "readOnly": true + }, + "dbServerVersion": { + "type": "string", + "description": "The software version of the database servers (dom0) in the Exadata infrastructure.", + "readOnly": true + }, + "storageServerVersion": { + "type": "string", + "description": "The software version of the storage servers (cells) in the Exadata infrastructure.", + "readOnly": true + }, + "activatedStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers activated for the Exadata infrastructure.", + "readOnly": true + }, + "additionalStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers for the Exadata infrastructure.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "lastMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance run.", + "readOnly": true + }, + "nextMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the next maintenance run.", + "readOnly": true + }, + "monthlyDbServerVersion": { + "type": "string", + "description": "Monthly Db Server version", + "readOnly": true + }, + "monthlyStorageServerVersion": { + "type": "string", + "description": "Monthly Storage Server version", + "readOnly": true + } + }, + "required": [ + "shape", + "displayName" + ] + }, + "CloudExadataInfrastructureUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudExadataInfrastructure.", + "properties": { + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "CloudExadataInfrastructureUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudExadataInfrastructure.", + "properties": { + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "CloudVmCluster": { + "type": "object", + "description": "CloudVmCluster resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudVmClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudVmClusterLifecycleState": { + "type": "string", + "description": "Cloud VM Cluster lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudVmClusterLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource Maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudVmClusterListResult": { + "type": "object", + "description": "The response of a CloudVmCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudVmCluster items on this page", + "items": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudVmClusterProperties": { + "type": "object", + "description": "CloudVmCluster resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Cloud VM Cluster ocid", + "readOnly": true + }, + "listenerPort": { + "type": "integer", + "format": "int64", + "description": "The port number configured for the listener on the cloud VM cluster.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the cloud VM cluster. ", + "readOnly": true + }, + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the cloud VM cluster was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "timeZone": { + "type": "string", + "description": "The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm).", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "zoneId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the zone the cloud VM cluster is associated with.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hostname": { + "type": "string", + "description": "The hostname for the cloud VM cluster.", + "minLength": 1, + "maxLength": 23, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "domain": { + "type": "string", + "description": "The domain name for the cloud VM cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "clusterName": { + "type": "string", + "description": "The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ", + "minLength": 1, + "maxLength": 11, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataStoragePercentage": { + "type": "integer", + "format": "int32", + "description": "The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isLocalBackupEnabled": { + "type": "boolean", + "description": "If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudExadataInfrastructureId": { + "$ref": "#/definitions/CloudExadataInfrastructureId", + "description": "Cloud Exadata Infrastructure ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isSparseDiskgroupEnabled": { + "type": "boolean", + "description": "If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemVersion": { + "type": "string", + "description": "Operating system version of the image.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "diskRedundancy": { + "$ref": "#/definitions/DiskRedundancy", + "description": "The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ", + "readOnly": true + }, + "scanIpIds": { + "type": "array", + "description": "The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vipIds": { + "type": "array", + "description": "The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "scanDnsName": { + "type": "string", + "description": "The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ", + "minLength": 1, + "maxLength": 72, + "readOnly": true + }, + "scanListenerPortTcp": { + "type": "integer", + "format": "int32", + "description": "The TCP Single Client Access Name (SCAN) port. The default port is 1521.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanListenerPortTcpSsl": { + "type": "integer", + "format": "int32", + "description": "The TCPS Single Client Access Name (SCAN) port. The default port is 2484.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanDnsRecordId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the Exadata hardware running the cloud VM cluster.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudVmCluster provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudVmClusterLifecycleState", + "description": "CloudVmCluster lifecycle state", + "readOnly": true + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "giVersion": { + "type": "string", + "description": "Oracle Grid Infrastructure (GI) software version", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "nsgUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupSubnetCidr": { + "type": "string", + "description": "Client OCI backup subnet CIDR, default is 192.168.252.0/22", + "minLength": 1, + "maxLength": 32, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nsgCidrs": { + "type": "array", + "description": "CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.", + "items": { + "$ref": "#/definitions/NsgCidr" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + }, + "iormConfigCache": { + "$ref": "#/definitions/ExadataIormConfig", + "description": "iormConfigCache details for cloud VM cluster.", + "readOnly": true + }, + "lastUpdateHistoryEntryId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance update history entry.", + "readOnly": true + }, + "dbServers": { + "type": "array", + "description": "The list of DB servers.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "Cluster compartmentId", + "readOnly": true + }, + "subnetOcid": { + "$ref": "#/definitions/Ocid", + "description": "Cluster subnet ocid", + "readOnly": true + } + }, + "required": [ + "hostname", + "cpuCoreCount", + "cloudExadataInfrastructureId", + "sshPublicKeys", + "vnetId", + "giVersion", + "subnetId", + "displayName" + ] + }, + "CloudVmClusterUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudVmCluster.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudVmClusterUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "CloudVmClusterUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudVmCluster.", + "properties": { + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ComputeModel": { + "type": "string", + "description": "Compute model enum", + "enum": [ + "ECPU", + "OCPU" + ], + "x-ms-enum": { + "name": "ComputeModel", + "modelAsString": true, + "values": [ + { + "name": "ECPU", + "value": "ECPU", + "description": "ECPU model type" + }, + { + "name": "OCPU", + "value": "OCPU", + "description": "OCPU model type" + } + ] + } + }, + "ConnectionStringType": { + "type": "object", + "description": "Connection strings to connect to an Oracle Autonomous Database.", + "properties": { + "allConnectionStrings": { + "$ref": "#/definitions/AllConnectionStringType", + "description": "Returns all connection strings that can be used to connect to the Autonomous Database." + }, + "dedicated": { + "type": "string", + "description": "The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "profiles": { + "type": "array", + "description": "A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.", + "items": { + "$ref": "#/definitions/ProfileType" + }, + "x-ms-identifiers": [] + } + } + }, + "ConnectionUrlType": { + "type": "object", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.", + "properties": { + "apexUrl": { + "type": "string", + "description": "Oracle Application Express (APEX) URL.", + "minLength": 10, + "maxLength": 512 + }, + "databaseTransformsUrl": { + "type": "string", + "description": "The URL of the Database Transforms for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "graphStudioUrl": { + "type": "string", + "description": "The URL of the Graph Studio for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "machineLearningNotebookUrl": { + "type": "string", + "description": "The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "mongoDbUrl": { + "type": "string", + "description": "The URL of the MongoDB API for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "ordsUrl": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "sqlDevWebUrl": { + "type": "string", + "description": "Oracle SQL Developer Web URL.", + "minLength": 10, + "maxLength": 512 + } + } + }, + "ConsumerGroup": { + "type": "string", + "description": "Consumer group enum.", + "enum": [ + "High", + "Medium", + "Low", + "Tp", + "Tpurgent" + ], + "x-ms-enum": { + "name": "ConsumerGroup", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High group" + }, + { + "name": "Medium", + "value": "Medium", + "description": "Medium group" + }, + { + "name": "Low", + "value": "Low", + "description": "Low group" + }, + { + "name": "Tp", + "value": "Tp", + "description": "TP group" + }, + { + "name": "Tpurgent", + "value": "Tpurgent", + "description": "TPurgent group" + } + ] + } + }, + "CustomerContact": { + "type": "object", + "description": "CustomerContact resource properties", + "properties": { + "email": { + "type": "string", + "description": "The email address used by Oracle to send notifications regarding databases and infrastructure.", + "minLength": 1, + "maxLength": 320 + } + }, + "required": [ + "email" + ] + }, + "DataBaseType": { + "type": "string", + "description": "Database type enum", + "enum": [ + "Regular", + "Clone" + ], + "x-ms-enum": { + "name": "DataBaseType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular DB" + }, + { + "name": "Clone", + "value": "Clone", + "description": "Clone DB" + } + ] + } + }, + "DataCollectionOptions": { + "type": "object", + "description": "DataCollectionOptions resource properties", + "properties": { + "isDiagnosticsEventsEnabled": { + "type": "boolean", + "description": "Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS.", + "default": false + }, + "isHealthMonitoringEnabled": { + "type": "boolean", + "description": "Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + }, + "isIncidentLogsEnabled": { + "type": "boolean", + "description": "Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + } + } + }, + "DataSafeStatusType": { + "type": "string", + "description": "DataSafe status type enum.", + "enum": [ + "Registering", + "Registered", + "Deregistering", + "NotRegistered", + "Failed" + ], + "x-ms-enum": { + "name": "DataSafeStatusType", + "modelAsString": true, + "values": [ + { + "name": "Registering", + "value": "Registering", + "description": "Registering status" + }, + { + "name": "Registered", + "value": "Registered", + "description": "Registered status" + }, + { + "name": "Deregistering", + "value": "Deregistering", + "description": "Deregistering status" + }, + { + "name": "NotRegistered", + "value": "NotRegistered", + "description": "NotRegistered status" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed status" + } + ] + } + }, + "DatabaseEditionType": { + "type": "string", + "description": "Database edition type enum.", + "enum": [ + "StandardEdition", + "EnterpriseEdition" + ], + "x-ms-enum": { + "name": "DatabaseEditionType", + "modelAsString": true, + "values": [ + { + "name": "StandardEdition", + "value": "StandardEdition", + "description": "Standard edition" + }, + { + "name": "EnterpriseEdition", + "value": "EnterpriseEdition", + "description": "Enterprise edition" + } + ] + } + }, + "DayOfWeek": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + }, + "required": [ + "name" + ] + }, + "DayOfWeekName": { + "type": "string", + "description": "DayOfWeekName enum", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeekName", + "modelAsString": true, + "values": [ + { + "name": "Monday", + "value": "Monday", + "description": "Monday value" + }, + { + "name": "Tuesday", + "value": "Tuesday", + "description": "Tuesday value" + }, + { + "name": "Wednesday", + "value": "Wednesday", + "description": "Wednesday value" + }, + { + "name": "Thursday", + "value": "Thursday", + "description": "Thursday value" + }, + { + "name": "Friday", + "value": "Friday", + "description": "Friday value" + }, + { + "name": "Saturday", + "value": "Saturday", + "description": "Saturday value" + }, + { + "name": "Sunday", + "value": "Sunday", + "description": "Sunday value" + } + ] + } + }, + "DayOfWeekUpdate": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + } + }, + "DbIormConfig": { + "type": "object", + "description": "DbIormConfig for cloud vm cluster", + "properties": { + "dbName": { + "type": "string", + "description": "The database name. For the default DbPlan, the dbName is default." + }, + "flashCacheLimit": { + "type": "string", + "description": "The flash cache limit for this database. This value is internally configured based on the share value assigned to the database." + }, + "share": { + "type": "integer", + "format": "int32", + "description": "The relative priority of this database.", + "minimum": 1, + "maximum": 32 + } + } + }, + "DbNode": { + "type": "object", + "description": "The DbNode resource belonging to vmCluster", + "properties": { + "properties": { + "$ref": "#/definitions/DbNodeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbNodeAction": { + "type": "object", + "description": "DbNode action object", + "properties": { + "action": { + "$ref": "#/definitions/DbNodeActionEnum", + "description": "Db action" + } + }, + "required": [ + "action" + ] + }, + "DbNodeActionEnum": { + "type": "string", + "description": "DbNode action enum", + "enum": [ + "Start", + "Stop", + "SoftReset", + "Reset" + ], + "x-ms-enum": { + "name": "DbNodeActionEnum", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "Start DbNode" + }, + { + "name": "Stop", + "value": "Stop", + "description": "Stop DbNode" + }, + { + "name": "SoftReset", + "value": "SoftReset", + "description": "Soft reset DbNode" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset DbNode" + } + ] + } + }, + "DbNodeListResult": { + "type": "object", + "description": "The response of a DbNode list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbNode items on this page", + "items": { + "$ref": "#/definitions/DbNode" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbNodeMaintenanceType": { + "type": "string", + "description": "The type of database node maintenance.", + "enum": [ + "VmdbRebootMigration" + ], + "x-ms-enum": { + "name": "DbNodeMaintenanceType", + "modelAsString": true, + "values": [ + { + "name": "VmdbRebootMigration", + "value": "VmdbRebootMigration", + "description": "VMDB reboot migration maintenance type" + } + ] + } + }, + "DbNodeProperties": { + "type": "object", + "description": "The properties of DbNodeResource", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "DbNode OCID", + "readOnly": true + }, + "additionalDetails": { + "type": "string", + "description": "Additional information about the planned maintenance.", + "readOnly": true + }, + "backupIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup IP address associated with the database node.", + "readOnly": true + }, + "backupVnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second backup VNIC.", + "readOnly": true + }, + "backupVnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup VNIC.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db node.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db node.", + "readOnly": true + }, + "dbServerId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exacc Db server associated with the database node.", + "readOnly": true + }, + "dbSystemId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DB system.", + "readOnly": true + }, + "faultDomain": { + "type": "string", + "description": "The name of the Fault Domain the instance is contained in.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "hostIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the host IP address associated with the database node.", + "readOnly": true + }, + "hostname": { + "type": "string", + "description": "The host name for the database node.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbNodeProvisioningState", + "description": "The current state of the database node.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of Db Node.", + "readOnly": true + }, + "maintenanceType": { + "$ref": "#/definitions/DbNodeMaintenanceType", + "description": "The type of database node maintenance.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated memory in GBs on the Db node.", + "readOnly": true + }, + "softwareStorageSizeInGb": { + "type": "integer", + "format": "int32", + "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database node was created.", + "readOnly": true + }, + "timeMaintenanceWindowEnd": { + "type": "string", + "format": "date-time", + "description": "End date and time of maintenance window.", + "readOnly": true + }, + "timeMaintenanceWindowStart": { + "type": "string", + "format": "date-time", + "description": "Start date and time of maintenance window.", + "readOnly": true + }, + "vnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second VNIC.", + "readOnly": true + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the VNIC.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DbNodeProvisioningState": { + "type": "string", + "description": "DnNode provisioning state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "DbNodeProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "DbServer": { + "type": "object", + "description": "DbServer resource model", + "properties": { + "properties": { + "$ref": "#/definitions/DbServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbServerListResult": { + "type": "object", + "description": "The response of a DbServer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbServer items on this page", + "items": { + "$ref": "#/definitions/DbServer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbServerPatchingDetails": { + "type": "object", + "description": "DbServer Patching Properties", + "properties": { + "estimatedPatchDuration": { + "type": "integer", + "format": "int32", + "description": "Estimated Patch Duration", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "patchingStatus": { + "$ref": "#/definitions/DbServerPatchingStatus", + "description": "Patching Status", + "readOnly": true + }, + "timePatchingEnded": { + "type": "string", + "format": "date-time", + "description": "Time Patching Ended", + "readOnly": true + }, + "timePatchingStarted": { + "type": "string", + "format": "date-time", + "description": "Time Patching Started", + "readOnly": true + } + } + }, + "DbServerPatchingStatus": { + "type": "string", + "description": "DB Server patching status enum", + "enum": [ + "Scheduled", + "MaintenanceInProgress", + "Failed", + "Complete" + ], + "x-ms-enum": { + "name": "DbServerPatchingStatus", + "modelAsString": true, + "values": [ + { + "name": "Scheduled", + "value": "Scheduled", + "description": "Patching scheduled" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Patching in progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Patching failed" + }, + { + "name": "Complete", + "value": "Complete", + "description": "Patching completed" + } + ] + } + }, + "DbServerProperties": { + "type": "object", + "description": "DbServer resource properties", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Db server name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Db Server.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the compartment.", + "readOnly": true + }, + "exadataInfrastructureId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exadata infrastructure.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db server.", + "readOnly": true + }, + "dbServerPatchingDetails": { + "$ref": "#/definitions/DbServerPatchingDetails", + "description": "dbServerPatching details of the Db server.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db server.", + "readOnly": true + }, + "vmClusterIds": { + "type": "array", + "description": "The OCID of the VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "dbNodeIds": { + "type": "array", + "description": "The OCID of the Db nodes associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of dbServer.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbServerProvisioningState", + "description": "DbServer provisioning state.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "autonomousVmClusterIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "autonomousVirtualMachineIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "maxDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The total max dbNode storage in GBs.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory size in GBs.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the Db Server was created.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DbServerProvisioningState": { + "type": "string", + "description": "DbServerProvisioningState enum", + "enum": [ + "Creating", + "Available", + "Unavailable", + "Deleting", + "Deleted", + "MaintenanceInProgress" + ], + "x-ms-enum": { + "name": "DbServerProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "Indicates that resource in Creating state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Indicates that resource in Deleting state" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Indicates that resource in Deleted state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + } + ] + } + }, + "DbSystemShape": { + "type": "object", + "description": "DbSystemShape resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DbSystemShapeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbSystemShapeListResult": { + "type": "object", + "description": "The response of a DbSystemShape list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbSystemShape items on this page", + "items": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbSystemShapeProperties": { + "type": "object", + "description": "DbSystemShape resource model", + "properties": { + "shapeFamily": { + "type": "string", + "description": "The family of the shape used for the DB system.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "availableCoreCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "minimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "runtimeMinimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "coreCountIncrement": { + "type": "integer", + "format": "int32", + "description": "The discrete number by which the CPU core count for this shape can be increased or decreased.", + "readOnly": true + }, + "minStorageCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "maxStorageCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "availableDataStoragePerServerInTbs": { + "type": "number", + "format": "double", + "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableDbNodePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "minCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled per node for this shape.", + "readOnly": true + }, + "availableMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory that can be enabled for this shape.", + "readOnly": true + }, + "minMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum memory that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage that can be enabled for this shape.", + "readOnly": true + }, + "minDbNodeStoragePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum Db Node storage that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The maximum DATA storage that can be enabled for this shape.", + "readOnly": true + }, + "minDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The minimum data storage that need be allocated for this shape.", + "readOnly": true + }, + "minimumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of database nodes available for this shape.", + "readOnly": true + }, + "maximumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of database nodes available for this shape.", + "readOnly": true + }, + "availableCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", + "readOnly": true + } + } + }, + "DisasterRecoveryType": { + "type": "string", + "description": "Disaster recovery type enum.", + "enum": [ + "Adg", + "BackupBased" + ], + "x-ms-enum": { + "name": "DisasterRecoveryType", + "modelAsString": true, + "values": [ + { + "name": "Adg", + "value": "Adg", + "description": "ADG type" + }, + { + "name": "BackupBased", + "value": "BackupBased", + "description": "Backup based type" + } + ] + } + }, + "DiskRedundancy": { + "type": "string", + "description": "Disk redundancy enum", + "enum": [ + "High", + "Normal" + ], + "x-ms-enum": { + "name": "DiskRedundancy", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High redundancy" + }, + { + "name": "Normal", + "value": "Normal", + "description": "Normal redundancy" + } + ] + } + }, + "DnsPrivateView": { + "type": "object", + "description": "DnsPrivateView resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateViewProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateViewListResult": { + "type": "object", + "description": "The response of a DnsPrivateView list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateView items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateViewProperties": { + "type": "object", + "description": "Views resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the view", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name of the view resource", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateViewsLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "timeUpdated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DnsPrivateViewsLifecycleState": { + "type": "string", + "description": "DNS Private Views lifecycle state enum", + "enum": [ + "Active", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateViewsLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private View is active" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private View is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private View is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private View is updating" + } + ] + } + }, + "DnsPrivateZone": { + "type": "object", + "description": "DnsPrivateZone resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateZoneProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateZoneListResult": { + "type": "object", + "description": "The response of a DnsPrivateZone list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateZone items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateZoneProperties": { + "type": "object", + "description": "Zones resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Zone", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateZonesLifecycleState", + "description": "Zones lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "serial": { + "type": "integer", + "format": "int32", + "description": "The current serial of the zone. As seen in the zone's SOA record.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.", + "readOnly": true + }, + "viewId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.", + "readOnly": true + }, + "zoneType": { + "$ref": "#/definitions/ZoneType", + "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Zones timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DnsPrivateZonesLifecycleState": { + "type": "string", + "description": "DNS Private Zones lifecycle state enum", + "enum": [ + "Active", + "Creating", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateZonesLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private Zones is active" + }, + { + "name": "Creating", + "value": "Creating", + "description": "DNS Private Zones is creating" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private Zones is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private Zones is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private Zones is updating" + } + ] + } + }, + "EstimatedPatchingTime": { + "type": "object", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "properties": { + "estimatedDbServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for database server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedNetworkSwitchesPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for network switch patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedStorageServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for storage server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "totalEstimatedPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated total time required in minutes for all patching operations.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + } + } + }, + "ExadataIormConfig": { + "type": "object", + "description": "ExadataIormConfig for cloud vm cluster", + "properties": { + "dbPlans": { + "type": "array", + "description": "An array of IORM settings for all the database in the Exadata DB system.", + "items": { + "$ref": "#/definitions/DbIormConfig" + }, + "x-ms-identifiers": [] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycleState." + }, + "lifecycleState": { + "$ref": "#/definitions/IormLifecycleState", + "description": "The current state of IORM configuration for the Exadata DB system." + }, + "objective": { + "$ref": "#/definitions/Objective", + "description": "The current value for the IORM objective. The default is AUTO." + } + } + }, + "GenerateAutonomousDatabaseWalletDetails": { + "type": "object", + "description": "Autonomous Database Generate Wallet resource model.", + "properties": { + "generateType": { + "$ref": "#/definitions/GenerateType", + "description": "The type of wallet to generate." + }, + "isRegional": { + "type": "boolean", + "description": "True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only." + }, + "password": { + "$ref": "#/definitions/Password", + "description": "The password to encrypt the keys inside the wallet", + "minLength": 8 + } + }, + "required": [ + "password" + ] + }, + "GenerateType": { + "type": "string", + "description": "Generate type enum", + "enum": [ + "Single", + "All" + ], + "x-ms-enum": { + "name": "GenerateType", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "Single", + "description": "Generate single" + }, + { + "name": "All", + "value": "All", + "description": "Generate all" + } + ] + } + }, + "GiVersion": { + "type": "object", + "description": "GiVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/GiVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GiVersionListResult": { + "type": "object", + "description": "The response of a GiVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GiVersion items on this page", + "items": { + "$ref": "#/definitions/GiVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GiVersionProperties": { + "type": "object", + "description": "GiVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "A valid Oracle Grid Infrastructure (GI) software version.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "HostFormatType": { + "type": "string", + "description": "Host format type enum.", + "enum": [ + "Fqdn", + "Ip" + ], + "x-ms-enum": { + "name": "HostFormatType", + "modelAsString": true, + "values": [ + { + "name": "Fqdn", + "value": "Fqdn", + "description": "FQDN format" + }, + { + "name": "Ip", + "value": "Ip", + "description": "IP format" + } + ] + } + }, + "Intent": { + "type": "string", + "description": "Intent enum", + "enum": [ + "Retain", + "Reset" + ], + "x-ms-enum": { + "name": "Intent", + "modelAsString": true, + "values": [ + { + "name": "Retain", + "value": "Retain", + "description": "Retain intent" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset intent" + } + ] + } + }, + "IormLifecycleState": { + "type": "string", + "description": "ORM lifecycle state enum", + "enum": [ + "BootStrapping", + "Enabled", + "Disabled", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "IormLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "BootStrapping", + "value": "BootStrapping", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Indicates that resource in Enabled state" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Indicates that resource in Disabled state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "LicenseModel": { + "type": "string", + "description": "LicenseModel enum", + "enum": [ + "LicenseIncluded", + "BringYourOwnLicense" + ], + "x-ms-enum": { + "name": "LicenseModel", + "modelAsString": true, + "values": [ + { + "name": "LicenseIncluded", + "value": "LicenseIncluded", + "description": "License included" + }, + { + "name": "BringYourOwnLicense", + "value": "BringYourOwnLicense", + "description": "Bring Your Own License" + } + ] + } + }, + "LongTermBackUpScheduleDetails": { + "type": "object", + "description": "Details for the long-term backup schedule.", + "properties": { + "repeatCadence": { + "$ref": "#/definitions/RepeatCadenceType", + "description": "The frequency of the long-term backup schedule" + }, + "timeOfBackup": { + "type": "string", + "format": "date-time", + "description": "The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month." + }, + "retentionPeriodInDays": { + "$ref": "#/definitions/RetentionPeriod", + "description": "Retention period, in days, for backups." + }, + "isDisabled": { + "type": "boolean", + "description": "Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`." + } + } + }, + "MaintenanceWindow": { + "type": "object", + "description": "MaintenanceWindow resource properties", + "properties": { + "preference": { + "$ref": "#/definitions/Preference", + "description": "The maintenance window scheduling preference." + }, + "months": { + "type": "array", + "description": "Months during the year when maintenance should be performed.", + "items": { + "$ref": "#/definitions/Month" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "weeksOfMonth": { + "type": "array", + "description": "Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ", + "items": { + "type": "integer", + "format": "int32" + } + }, + "daysOfWeek": { + "type": "array", + "description": "Days during the week when maintenance should be performed.", + "items": { + "$ref": "#/definitions/DayOfWeek" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hoursOfDay": { + "type": "array", + "description": "The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC", + "items": { + "type": "integer", + "format": "int32" + } + }, + "leadTimeInWeeks": { + "type": "integer", + "format": "int32", + "description": "Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. " + }, + "patchingMode": { + "$ref": "#/definitions/PatchingMode", + "description": "Cloud Exadata infrastructure node patching method." + }, + "customActionTimeoutInMins": { + "type": "integer", + "format": "int32", + "description": "Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).", + "minimum": 0, + "maximum": 120 + }, + "isCustomActionTimeoutEnabled": { + "type": "boolean", + "description": "If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations." + }, + "isMonthlyPatchingEnabled": { + "type": "boolean", + "description": "is Monthly Patching Enabled" + } + } + }, + "Month": { + "type": "object", + "description": "Month resource properties", + "properties": { + "name": { + "$ref": "#/definitions/MonthName", + "description": "Name of the month of the year." + } + }, + "required": [ + "name" + ] + }, + "MonthName": { + "type": "string", + "description": "MonthName enum", + "enum": [ + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ], + "x-ms-enum": { + "name": "MonthName", + "modelAsString": true, + "values": [ + { + "name": "January", + "value": "January", + "description": "January value" + }, + { + "name": "February", + "value": "February", + "description": "February value" + }, + { + "name": "March", + "value": "March", + "description": "March value" + }, + { + "name": "April", + "value": "April", + "description": "April value" + }, + { + "name": "May", + "value": "May", + "description": "May value" + }, + { + "name": "June", + "value": "June", + "description": "June value" + }, + { + "name": "July", + "value": "July", + "description": "July value" + }, + { + "name": "August", + "value": "August", + "description": "August value" + }, + { + "name": "September", + "value": "September", + "description": "September value" + }, + { + "name": "October", + "value": "October", + "description": "October value" + }, + { + "name": "November", + "value": "November", + "description": "November value" + }, + { + "name": "December", + "value": "December", + "description": "December value" + } + ] + } + }, + "MsRpaasNewResourceHeader": { + "type": "object", + "description": "Header to distinguish between resource creation or update" + }, + "NsgCidr": { + "type": "object", + "description": "A rule for allowing inbound (INGRESS) IP packets", + "properties": { + "source": { + "type": "string", + "description": "Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.", + "minLength": 1, + "maxLength": 128 + }, + "destinationPortRange": { + "$ref": "#/definitions/PortRange", + "description": "Destination port range to specify particular destination ports for TCP rules." + } + }, + "required": [ + "source" + ] + }, + "Objective": { + "type": "string", + "description": "Objective enum", + "enum": [ + "LowLatency", + "HighThroughput", + "Balanced", + "Auto", + "Basic" + ], + "x-ms-enum": { + "name": "Objective", + "modelAsString": true, + "values": [ + { + "name": "LowLatency", + "value": "LowLatency", + "description": "Low latency objective" + }, + { + "name": "HighThroughput", + "value": "HighThroughput", + "description": "High throughput objective" + }, + { + "name": "Balanced", + "value": "Balanced", + "description": "Balanced objective" + }, + { + "name": "Auto", + "value": "Auto", + "description": "Auto objective" + }, + { + "name": "Basic", + "value": "Basic", + "description": "Basic objective" + } + ] + } + }, + "Ocid": { + "type": "string", + "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.", + "minLength": 1, + "maxLength": 255 + }, + "OpenModeType": { + "type": "string", + "description": "Open mode type enum.", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "OpenModeType", + "modelAsString": true, + "values": [ + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "ReadOnly mode" + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "ReadWrite mode" + } + ] + } + }, + "OperationsInsightsStatusType": { + "type": "string", + "description": "Operations Insights status type enum.", + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "NotEnabled", + "FailedEnabling", + "FailedDisabling" + ], + "x-ms-enum": { + "name": "OperationsInsightsStatusType", + "modelAsString": true, + "values": [ + { + "name": "Enabling", + "value": "Enabling", + "description": "Enabling status" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled status" + }, + { + "name": "Disabling", + "value": "Disabling", + "description": "Disabling status" + }, + { + "name": "NotEnabled", + "value": "NotEnabled", + "description": "NotEnabled status" + }, + { + "name": "FailedEnabling", + "value": "FailedEnabling", + "description": "FailedEnabling status" + }, + { + "name": "FailedDisabling", + "value": "FailedDisabling", + "description": "FailedDisabling status" + } + ] + } + }, + "OracleSubscription": { + "type": "object", + "description": "OracleSubscription resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/OracleSubscriptionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan", + "description": "Details of the resource plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OracleSubscriptionListResult": { + "type": "object", + "description": "The response of a OracleSubscription list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OracleSubscription items on this page", + "items": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OracleSubscriptionProperties": { + "type": "object", + "description": "Oracle Subscription resource model", + "properties": { + "provisioningState": { + "$ref": "#/definitions/OracleSubscriptionProvisioningState", + "description": "OracleSubscriptionProvisioningState provisioning state", + "readOnly": true + }, + "saasSubscriptionId": { + "type": "string", + "description": "SAAS subscription ID generated by Marketplace", + "readOnly": true + }, + "cloudAccountId": { + "$ref": "#/definitions/Ocid", + "description": "Cloud Account Id", + "readOnly": true + }, + "cloudAccountState": { + "$ref": "#/definitions/CloudAccountProvisioningState", + "description": "Cloud Account provisioning state.", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + }, + "azureSubscriptionIds": { + "type": "array", + "description": "Azure subscriptions associated with this OracleSubscription", + "items": { + "type": "string" + }, + "readOnly": true + }, + "addSubscriptionOperationState": { + "$ref": "#/definitions/AddSubscriptionOperationState", + "description": "State of the add Azure subscription operation on Oracle subscription", + "readOnly": true + }, + "lastOperationStatusDetail": { + "type": "string", + "description": "Status details of the last operation on Oracle subscription", + "readOnly": true + } + } + }, + "OracleSubscriptionProvisioningState": { + "type": "string", + "description": "OracleSubscriptionProvisioningState enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OracleSubscriptionProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "OracleSubscriptionUpdate": { + "type": "object", + "description": "The type used for update operations of the OracleSubscription.", + "properties": { + "plan": { + "$ref": "#/definitions/PlanUpdate", + "description": "Details of the resource plan." + }, + "properties": { + "$ref": "#/definitions/OracleSubscriptionUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "OracleSubscriptionUpdateProperties": { + "type": "object", + "description": "The updatable properties of the OracleSubscription.", + "properties": { + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + } + } + }, + "Password": { + "type": "string", + "format": "password", + "description": "Password string.", + "x-ms-secret": true + }, + "PatchingMode": { + "type": "string", + "description": "Patching mode enum", + "enum": [ + "Rolling", + "NonRolling" + ], + "x-ms-enum": { + "name": "PatchingMode", + "modelAsString": true, + "values": [ + { + "name": "Rolling", + "value": "Rolling", + "description": "Rolling patching" + }, + { + "name": "NonRolling", + "value": "NonRolling", + "description": "Non Rolling patching" + } + ] + } + }, + "PeerDbDetails": { + "type": "object", + "description": "PeerDb Details", + "properties": { + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255 + } + } + }, + "PermissionLevelType": { + "type": "string", + "description": "Permission level type enum.", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "PermissionLevelType", + "modelAsString": true, + "values": [ + { + "name": "Restricted", + "value": "Restricted", + "description": "Restricted permission level" + }, + { + "name": "Unrestricted", + "value": "Unrestricted", + "description": "Unrestricted permission level" + } + ] + } + }, + "PlanUpdate": { + "type": "object", + "description": "ResourcePlanTypeUpdate model definition", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + } + }, + "PortRange": { + "type": "object", + "description": "Port Range to specify particular destination ports for TCP rules.", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum port number, which must not be greater than the maximum port number.", + "minimum": 1, + "maximum": 65535 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.", + "minimum": 1, + "maximum": 65535 + } + }, + "required": [ + "min", + "max" + ] + }, + "Preference": { + "type": "string", + "description": "Preference enum", + "enum": [ + "NoPreference", + "CustomPreference" + ], + "x-ms-enum": { + "name": "Preference", + "modelAsString": true, + "values": [ + { + "name": "NoPreference", + "value": "NoPreference", + "description": "No preference" + }, + { + "name": "CustomPreference", + "value": "CustomPreference", + "description": "Custom preference" + } + ] + } + }, + "PrivateIpAddressProperties": { + "type": "object", + "description": "PrivateIpAddress resource properties", + "properties": { + "displayName": { + "type": "string", + "description": "PrivateIpAddresses displayName" + }, + "hostnameLabel": { + "type": "string", + "description": "PrivateIpAddresses hostnameLabel" + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses Id" + }, + "ipAddress": { + "type": "string", + "description": "PrivateIpAddresses ipAddress" + }, + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses subnetId" + } + }, + "required": [ + "displayName", + "hostnameLabel", + "ocid", + "ipAddress", + "subnetId" + ] + }, + "PrivateIpAddressesFilter": { + "type": "object", + "description": "Private Ip Addresses filter", + "properties": { + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "Subnet OCID" + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "VCN OCID" + } + }, + "required": [ + "subnetId", + "vnicId" + ] + }, + "ProfileType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "consumerGroup": { + "$ref": "#/definitions/ConsumerGroup", + "description": "Consumer group used by the connection." + }, + "displayName": { + "type": "string", + "description": "A user-friendly name for the connection.", + "minLength": 1, + "maxLength": 255 + }, + "hostFormat": { + "$ref": "#/definitions/HostFormatType", + "description": "Host format used in connection string." + }, + "isRegional": { + "type": "boolean", + "description": "True for a regional connection string, applicable to cross-region DG only." + }, + "protocol": { + "$ref": "#/definitions/ProtocolType", + "description": "Protocol used by the connection." + }, + "sessionMode": { + "$ref": "#/definitions/SessionModeType", + "description": "Specifies whether the listener performs a direct hand-off of the session, or redirects the session." + }, + "syntaxFormat": { + "$ref": "#/definitions/SyntaxFormatType", + "description": "Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format." + }, + "tlsAuthentication": { + "$ref": "#/definitions/TlsAuthenticationType", + "description": "Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication." + }, + "value": { + "type": "string", + "description": "Connection string value." + } + }, + "required": [ + "displayName", + "hostFormat", + "protocol", + "sessionMode", + "syntaxFormat", + "value" + ] + }, + "ProtocolType": { + "type": "string", + "description": "Protocol type enum.", + "enum": [ + "TCP", + "TCPS" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true, + "values": [ + { + "name": "TCP", + "value": "TCP", + "description": "TCP protocol" + }, + { + "name": "TCPS", + "value": "TCPS", + "description": "TCPS protocol" + } + ] + } + }, + "RefreshableModelType": { + "type": "string", + "description": "Refreshable model type enum", + "enum": [ + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "RefreshableModelType", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatic refreshable model type" + }, + { + "name": "Manual", + "value": "Manual", + "description": "Manual refreshable model type" + } + ] + } + }, + "RefreshableStatusType": { + "type": "string", + "description": "Refreshable status type enum.", + "enum": [ + "Refreshing", + "NotRefreshing" + ], + "x-ms-enum": { + "name": "RefreshableStatusType", + "modelAsString": true, + "values": [ + { + "name": "Refreshing", + "value": "Refreshing", + "description": "Refreshing status" + }, + { + "name": "NotRefreshing", + "value": "NotRefreshing", + "description": "NotRefreshing status" + } + ] + } + }, + "RepeatCadenceType": { + "type": "string", + "description": "Repeat cadence type enum", + "enum": [ + "OneTime", + "Weekly", + "Monthly", + "Yearly" + ], + "x-ms-enum": { + "name": "RepeatCadenceType", + "modelAsString": true, + "values": [ + { + "name": "OneTime", + "value": "OneTime", + "description": "Repeat one time" + }, + { + "name": "Weekly", + "value": "Weekly", + "description": "Repeat weekly" + }, + { + "name": "Monthly", + "value": "Monthly", + "description": "Repeat monthly" + }, + { + "name": "Yearly", + "value": "Yearly", + "description": "Repeat yearly" + } + ] + } + }, + "RestoreAutonomousDatabaseDetails": { + "type": "object", + "description": "Details to restore an Oracle Autonomous Database.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time to restore the database to." + } + }, + "required": [ + "timestamp" + ] + }, + "RetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for backups.", + "minimum": 90, + "maximum": 2558 + }, + "RoleType": { + "type": "string", + "description": "Role type enum.", + "enum": [ + "Primary", + "Standby", + "DisabledStandby", + "BackupCopy", + "SnapshotStandby" + ], + "x-ms-enum": { + "name": "RoleType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary role" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Standby role" + }, + { + "name": "DisabledStandby", + "value": "DisabledStandby", + "description": "DisabledStandby role" + }, + { + "name": "BackupCopy", + "value": "BackupCopy", + "description": "BackupCopy role" + }, + { + "name": "SnapshotStandby", + "value": "SnapshotStandby", + "description": "SnapshotStandby role" + } + ] + } + }, + "SaasSubscriptionDetails": { + "type": "object", + "description": "SaaS Subscription Details model", + "properties": { + "id": { + "type": "string", + "description": "Purchased SaaS subscription ID", + "readOnly": true + }, + "subscriptionName": { + "type": "string", + "description": "SaaS subscription name", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Creation Date and Time", + "readOnly": true + }, + "offerId": { + "type": "string", + "description": "Purchased offer ID", + "readOnly": true + }, + "planId": { + "type": "string", + "description": "Purchased offer's plan ID", + "readOnly": true + }, + "saasSubscriptionStatus": { + "type": "string", + "description": "Indicates the status of the Subscription.", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Publisher ID", + "readOnly": true + }, + "purchaserEmailId": { + "type": "string", + "description": "Purchaser Email ID", + "readOnly": true + }, + "purchaserTenantId": { + "type": "string", + "description": "Purchaser Tenant ID", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Purchase Term Unit", + "readOnly": true + }, + "isAutoRenew": { + "type": "boolean", + "description": "AutoRenew flag", + "readOnly": true + }, + "isFreeTrial": { + "type": "boolean", + "description": "FreeTrial flag", + "readOnly": true + } + } + }, + "ScheduledOperationsType": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeek", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + }, + "required": [ + "dayOfWeek" + ] + }, + "ScheduledOperationsTypeUpdate": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeekUpdate", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + } + }, + "SessionModeType": { + "type": "string", + "description": "Session mode type enum.", + "enum": [ + "Direct", + "Redirect" + ], + "x-ms-enum": { + "name": "SessionModeType", + "modelAsString": true, + "values": [ + { + "name": "Direct", + "value": "Direct", + "description": "Direct session mode" + }, + { + "name": "Redirect", + "value": "Redirect", + "description": "Redirect session mode" + } + ] + } + }, + "SourceType": { + "type": "string", + "description": "Source type enum.", + "enum": [ + "None", + "Database", + "BackupFromId", + "BackupFromTimestamp", + "CloneToRefreshable", + "CrossRegionDataguard", + "CrossRegionDisasterRecovery" + ], + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None source" + }, + { + "name": "Database", + "value": "Database", + "description": "Database source" + }, + { + "name": "BackupFromId", + "value": "BackupFromId", + "description": "Backup from ID source" + }, + { + "name": "BackupFromTimestamp", + "value": "BackupFromTimestamp", + "description": "Backup from timestamp source" + }, + { + "name": "CloneToRefreshable", + "value": "CloneToRefreshable", + "description": "Clone to refreshable source" + }, + { + "name": "CrossRegionDataguard", + "value": "CrossRegionDataguard", + "description": "Cross region dataguard source" + }, + { + "name": "CrossRegionDisasterRecovery", + "value": "CrossRegionDisasterRecovery", + "description": "cross region disaster recovery source" + } + ] + } + }, + "SubnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "SyntaxFormatType": { + "type": "string", + "description": "Syntax format type enum.", + "enum": [ + "Long", + "Ezconnect", + "Ezconnectplus" + ], + "x-ms-enum": { + "name": "SyntaxFormatType", + "modelAsString": true, + "values": [ + { + "name": "Long", + "value": "Long", + "description": "Long format" + }, + { + "name": "Ezconnect", + "value": "Ezconnect", + "description": "Ezconnect format" + }, + { + "name": "Ezconnectplus", + "value": "Ezconnectplus", + "description": "Ezconnectplus format" + } + ] + } + }, + "SystemVersion": { + "type": "object", + "description": "SystemVersion resource Definition", + "properties": { + "properties": { + "$ref": "#/definitions/SystemVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SystemVersionListResult": { + "type": "object", + "description": "The response of a SystemVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SystemVersion items on this page", + "items": { + "$ref": "#/definitions/SystemVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SystemVersionProperties": { + "type": "object", + "description": "System Version Resource model", + "properties": { + "systemVersion": { + "type": "string", + "description": "A valid Oracle System Version", + "readOnly": true + } + } + }, + "SystemVersionsFilter": { + "type": "object", + "description": "SystemVersions filter", + "properties": { + "giVersion": { + "type": "string", + "description": "Grid Infrastructure version" + }, + "shape": { + "type": "string", + "description": "Exadata shape" + }, + "isLatestVersion": { + "type": "boolean", + "description": "Check If we have to list only latest versions" + } + }, + "required": [ + "giVersion", + "shape" + ] + }, + "TlsAuthenticationType": { + "type": "string", + "description": "TLS authentication type enum.", + "enum": [ + "Server", + "Mutual" + ], + "x-ms-enum": { + "name": "TlsAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "Server", + "value": "Server", + "description": "Server authentication" + }, + { + "name": "Mutual", + "value": "Mutual", + "description": "Mutual TLS" + } + ] + } + }, + "UpdateAction": { + "type": "string", + "description": "Update action enum", + "enum": [ + "RollingApply", + "NonRollingApply", + "PreCheck", + "RollBack" + ], + "x-ms-enum": { + "name": "UpdateAction", + "modelAsString": true, + "values": [ + { + "name": "RollingApply", + "value": "RollingApply", + "description": "Rolling apply action" + }, + { + "name": "NonRollingApply", + "value": "NonRollingApply", + "description": "Non rolling apply action" + }, + { + "name": "PreCheck", + "value": "PreCheck", + "description": "Pre-check action" + }, + { + "name": "RollBack", + "value": "RollBack", + "description": "Rollback action" + } + ] + } + }, + "ValidationError": { + "type": "object", + "description": "validation error", + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "required": [ + "code", + "message" + ] + }, + "ValidationResult": { + "type": "object", + "description": "validation result", + "properties": { + "status": { + "$ref": "#/definitions/ValidationStatus", + "description": "validation status" + }, + "error": { + "$ref": "#/definitions/ValidationError", + "description": "validation error" + } + }, + "required": [ + "status", + "error" + ] + }, + "ValidationStatus": { + "type": "string", + "description": "validation status", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Validation failed" + } + ] + }, + "readOnly": true + }, + "VirtualNetworkAddress": { + "type": "object", + "description": "Virtual IP resource belonging to a vm cluster resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkAddressProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualNetworkAddressLifecycleState": { + "type": "string", + "description": "VirtualNetworkAddressLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "VirtualNetworkAddressLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "VirtualNetworkAddressListResult": { + "type": "object", + "description": "The response of a VirtualNetworkAddress list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualNetworkAddress items on this page", + "items": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualNetworkAddressProperties": { + "type": "object", + "description": "virtualNetworkAddress resource properties", + "properties": { + "ipAddress": { + "type": "string", + "description": "Virtual network Address address.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmOcid": { + "$ref": "#/definitions/Ocid", + "description": "Virtual Machine OCID.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Application VIP OCID.", + "readOnly": true + }, + "domain": { + "type": "string", + "description": "Virtual network address fully qualified domain name.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state of the application virtual IP (VIP) address.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/VirtualNetworkAddressLifecycleState", + "description": "virtual network address lifecycle state.", + "readOnly": true + }, + "timeAssigned": { + "type": "string", + "format": "date-time", + "description": "The date and time when the create operation for the application virtual IP (VIP) address completed.", + "readOnly": true + } + } + }, + "VnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + } + }, + "WorkloadType": { + "type": "string", + "description": "WorkloadType enum", + "enum": [ + "OLTP", + "DW", + "AJD", + "APEX" + ], + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true, + "values": [ + { + "name": "OLTP", + "value": "OLTP", + "description": "OLTP - indicates an Autonomous Transaction Processing database" + }, + { + "name": "DW", + "value": "DW", + "description": "DW - indicates an Autonomous Data Warehouse database" + }, + { + "name": "AJD", + "value": "AJD", + "description": "AJD - indicates an Autonomous JSON Database" + }, + { + "name": "APEX", + "value": "APEX", + "description": "APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type." + } + ] + } + }, + "ZoneType": { + "type": "string", + "description": "Zone type enum", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "ZoneType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary zone" + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary zone" + } + ] + } + }, + "aclString": { + "type": "string", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "minLength": 1, + "maxLength": 1024 + } + }, + "parameters": {} +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..9ebce87139c0 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..14b89f7ae2b5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..18f1545476f1 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..a29bb766f51b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..bbad833f86a4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..523f1ff24bed --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..a76071985fef --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseClone_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..9d2b4af6f591 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..37dafabacdd5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..c0b0c4f7a0aa --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..47fa4b9d66d6 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..9a726ca84fb9 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_create.json new file mode 100644 index 000000000000..f6fea70651ba --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_delete.json new file mode 100644 index 000000000000..6b708c825459 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_failover.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_failover.json new file mode 100644 index 000000000000..61a9ed318856 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_generateWallet.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..f7d99778b93d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_get.json new file mode 100644 index 000000000000..70f7a939e68f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..3e3e79afdef9 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..fc9fc22c896c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_patch.json new file mode 100644 index 000000000000..c87c05211523 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_restore.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_restore.json new file mode 100644 index 000000000000..e1ad46f498f2 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_shrink.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..0d4514db9cc7 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_switchover.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..24a17baf196a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json new file mode 100644 index 000000000000..8759060a9153 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_get.json new file mode 100644 index 000000000000..f1c05c614172 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_listByParent.json new file mode 100644 index 000000000000..a129607a449b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_get.json new file mode 100644 index 000000000000..b36cbd0ca1f1 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_listByParent.json new file mode 100644 index 000000000000..e373e2fe04ff --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_get.json new file mode 100644 index 000000000000..ded7bb7b5c5e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..961bceef1071 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_get.json new file mode 100644 index 000000000000..826e6cbed202 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..41452ef83946 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_get.json new file mode 100644 index 000000000000..8f025cdf4583 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..f83d475eaf7a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_addStorageCapacity.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..a8c9b7f02411 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_create.json new file mode 100644 index 000000000000..fe163d1df594 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_delete.json new file mode 100644 index 000000000000..690faa2619be --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_get.json new file mode 100644 index 000000000000..02018dc9d070 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..637714be7f17 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..bc1d84648c85 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_patch.json new file mode 100644 index 000000000000..4d224bfb31e5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_get.json new file mode 100644 index 000000000000..9f869012ffa4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_listByLocation.json new file mode 100644 index 000000000000..e1f9a8790206 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/operations_list.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/operations_list.json new file mode 100644 index 000000000000..90d233fd2bed --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_addAzureSubscriptions.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_addAzureSubscriptions.json new file mode 100644 index 000000000000..5ced338ab0a8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_addAzureSubscriptions.json @@ -0,0 +1,21 @@ +{ + "operationId": "OracleSubscriptions_addAzureSubscriptions", + "title": "OracleSubscriptions_addAzureSubscriptions", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "azureSubscriptionIds": [ + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_create.json new file mode 100644 index 000000000000..087479add3a6 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..8f36e973bb3e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_get.json new file mode 100644 index 000000000000..54ff6b48c87e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listActivationLinks.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..8e1f22e31ef5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..e7ddb186b915 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..92430982a4a4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..7fbb31a28fb5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..68ba78376523 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_get.json new file mode 100644 index 000000000000..5f490d631bd4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_listByLocation.json new file mode 100644 index 000000000000..cab8022e27f1 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..1060f3098866 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..154d26c1fccb --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..21de10dd3bc8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..8cb03a39fb76 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_addVms.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_addVms.json new file mode 100644 index 000000000000..376ab18bcab7 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_create.json new file mode 100644 index 000000000000..5f3f539ba6a8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_delete.json new file mode 100644 index 000000000000..4892b0899e72 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_get.json new file mode 100644 index 000000000000..7bf1d3d3d351 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..ebe7f027aacb --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..26d22f28ced8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listPrivateIpAddresses.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..9bf2ea94b6e0 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_patch.json new file mode 100644 index 000000000000..677fa1d0a913 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_removeVms.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_removeVms.json new file mode 100644 index 000000000000..27fe11214c93 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json new file mode 100644 index 000000000000..0872759e3f81 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json @@ -0,0 +1,9895 @@ +{ + "swagger": "2.0", + "info": { + "title": "Oracle Database Resource Manager", + "version": "2024-06-01", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "CloudExadataInfrastructures" + }, + { + "name": "DbServers" + }, + { + "name": "CloudVmClusters" + }, + { + "name": "VirtualNetworkAddresses" + }, + { + "name": "SystemVersions" + }, + { + "name": "OracleSubscriptions" + }, + { + "name": "DbNodes" + }, + { + "name": "GiVersions" + }, + { + "name": "DbSystemShapes" + }, + { + "name": "DnsPrivateViews" + }, + { + "name": "DnsPrivateZones" + }, + { + "name": "AutonomousDatabases" + }, + { + "name": "AutonomousDatabaseBackups" + }, + { + "name": "AutonomousDatabaseCharacterSets" + }, + { + "name": "AutonomousDatabaseNationalCharacterSets" + }, + { + "name": "AutonomousDatabaseVersions" + } + ], + "paths": { + "/providers/Oracle.Database/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Operations": { + "$ref": "./examples/operations_list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListBySubscription", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by subscription": { + "$ref": "./examples/autonomousDatabase_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListBySubscription", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by subscription": { + "$ref": "./examples/exaInfra_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListBySubscription", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by subscription": { + "$ref": "./examples/vmClusters_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "List AutonomousDatabaseCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db character sets by location": { + "$ref": "./examples/autonomousDatabaseCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets/{adbscharsetname}": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_Get", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "Get a AutonomousDatabaseCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "adbscharsetname", + "in": "path", + "description": "AutonomousDatabaseCharacterSet name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db character set": { + "$ref": "./examples/autonomousDatabaseCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "List AutonomousDatabaseNationalCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db national character sets by location": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets/{adbsncharsetname}": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_Get", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "Get a AutonomousDatabaseNationalCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "adbsncharsetname", + "in": "path", + "description": "AutonomousDatabaseNationalCharacterSets name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db national character set": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions": { + "get": { + "operationId": "AutonomousDatabaseVersions_ListByLocation", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "List AutonomousDbVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDbVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List an autonomous versions by location": { + "$ref": "./examples/autonomousDatabaseVersion_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions/{autonomousdbversionsname}": { + "get": { + "operationId": "AutonomousDatabaseVersions_Get", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "Get a AutonomousDbVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "autonomousdbversionsname", + "in": "path", + "description": "AutonomousDbVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get an autonomous version": { + "$ref": "./examples/autonomousDatabaseVersion_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes": { + "get": { + "operationId": "DbSystemShapes_ListByLocation", + "tags": [ + "DbSystemShapes" + ], + "description": "List DbSystemShape resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbSystemShapeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbSystemShapes by location": { + "$ref": "./examples/dbSystemShapes_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes/{dbsystemshapename}": { + "get": { + "operationId": "DbSystemShapes_Get", + "tags": [ + "DbSystemShapes" + ], + "description": "Get a DbSystemShape", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "dbsystemshapename", + "in": "path", + "description": "DbSystemShape name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DbSystemShape by name": { + "$ref": "./examples/dbSystemShapes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews": { + "get": { + "operationId": "DnsPrivateViews_ListByLocation", + "tags": [ + "DnsPrivateViews" + ], + "description": "List DnsPrivateView resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateViewListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateViews by location": { + "$ref": "./examples/dnsPrivateViews_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews/{dnsprivateviewocid}": { + "get": { + "operationId": "DnsPrivateViews_Get", + "tags": [ + "DnsPrivateViews" + ], + "description": "Get a DnsPrivateView", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "dnsprivateviewocid", + "in": "path", + "description": "DnsPrivateView OCID", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateView by name": { + "$ref": "./examples/dnsPrivateViews_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones": { + "get": { + "operationId": "DnsPrivateZones_ListByLocation", + "tags": [ + "DnsPrivateZones" + ], + "description": "List DnsPrivateZone resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateZoneListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateZones by location": { + "$ref": "./examples/dnsPrivateZones_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones/{dnsprivatezonename}": { + "get": { + "operationId": "DnsPrivateZones_Get", + "tags": [ + "DnsPrivateZones" + ], + "description": "Get a DnsPrivateZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "dnsprivatezonename", + "in": "path", + "description": "DnsPrivateZone name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateZone by name": { + "$ref": "./examples/dnsPrivateZones_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions": { + "get": { + "operationId": "GiVersions_ListByLocation", + "tags": [ + "GiVersions" + ], + "description": "List GiVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GiVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List GiVersions by location": { + "$ref": "./examples/giVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions/{giversionname}": { + "get": { + "operationId": "GiVersions_Get", + "tags": [ + "GiVersions" + ], + "description": "Get a GiVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "giversionname", + "in": "path", + "description": "GiVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GiVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a GiVersion by name": { + "$ref": "./examples/giVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions": { + "get": { + "operationId": "SystemVersions_ListByLocation", + "tags": [ + "SystemVersions" + ], + "description": "List SystemVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata System Versions by the provided filter": { + "$ref": "./examples/systemVersions_listByLocation.json" + }, + "systemVersions_listByLocation": { + "$ref": "./examples/systemVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions/{systemversionname}": { + "get": { + "operationId": "SystemVersions_Get", + "tags": [ + "SystemVersions" + ], + "description": "Get a SystemVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "systemversionname", + "in": "path", + "description": "SystemVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata System Version": { + "$ref": "./examples/systemVersions_get.json" + }, + "systemVersions_listSystemVersions": { + "$ref": "./examples/systemVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions": { + "get": { + "operationId": "OracleSubscriptions_ListBySubscription", + "tags": [ + "OracleSubscriptions" + ], + "description": "List OracleSubscription resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Oracle Subscriptions by subscription": { + "$ref": "./examples/oracleSubscriptions_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default": { + "get": { + "operationId": "OracleSubscriptions_Get", + "tags": [ + "OracleSubscriptions" + ], + "description": "Get a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_get.json" + } + } + }, + "put": { + "operationId": "OracleSubscriptions_CreateOrUpdate", + "tags": [ + "OracleSubscriptions" + ], + "description": "Create a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OracleSubscription' update operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "201": { + "description": "Resource 'OracleSubscription' create operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "OracleSubscriptions_Update", + "tags": [ + "OracleSubscriptions" + ], + "description": "Update a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "OracleSubscriptions_Delete", + "tags": [ + "OracleSubscriptions" + ], + "description": "Delete a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/addAzureSubscriptions": { + "post": { + "operationId": "OracleSubscriptions_AddAzureSubscriptions", + "tags": [ + "OracleSubscriptions" + ], + "description": "Add Azure Subscriptions", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AzureSubscriptions" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Add Azure Subscriptions to the OracleSubscription": { + "$ref": "./examples/oracleSubscriptions_addAzureSubscriptions.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listActivationLinks": { + "post": { + "operationId": "OracleSubscriptions_ListActivationLinks", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Activation Links", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ActivationLinks" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Activation Links for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listActivationLinks.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listCloudAccountDetails": { + "post": { + "operationId": "OracleSubscriptions_ListCloudAccountDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Cloud Account Details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudAccountDetails" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Cloud Account details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listCloudAccountDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listSaasSubscriptionDetails": { + "post": { + "operationId": "OracleSubscriptions_ListSaasSubscriptionDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Saas Subscription Details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SaasSubscriptionDetails" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Saas Subscription details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listSaasSubscriptionDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListByResourceGroup", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by resource group": { + "$ref": "./examples/autonomousDatabase_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}": { + "get": { + "operationId": "AutonomousDatabases_Get", + "tags": [ + "AutonomousDatabases" + ], + "description": "Get a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Get": { + "$ref": "./examples/autonomousDatabase_get.json" + }, + "Get Autonomous Database": { + "$ref": "./examples/autonomousDatabase_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabases_CreateOrUpdate", + "tags": [ + "AutonomousDatabases" + ], + "description": "Create a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabase' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "201": { + "description": "Resource 'AutonomousDatabase' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "AutonomousDatabases_CreateOrUpdate_clone": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + }, + "Create Autonomous Database": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "Create clone Autonomous Database": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabases_Update", + "tags": [ + "AutonomousDatabases" + ], + "description": "Update a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Autonomous Database": { + "$ref": "./examples/autonomousDatabase_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabases_Delete", + "tags": [ + "AutonomousDatabases" + ], + "description": "Delete a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Autonomous Database": { + "$ref": "./examples/autonomousDatabase_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups": { + "get": { + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "List AutonomousDatabaseBackup resources by AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_ListByAutonomousDatabase": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + }, + "List Autonomous Database Backups by Autonomous Database.": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups/{adbbackupid}": { + "get": { + "operationId": "AutonomousDatabaseBackups_Get", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Get a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Get": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + }, + "Get Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Create a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabaseBackup' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "201": { + "description": "Resource 'AutonomousDatabaseBackup' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + }, + "Create Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabaseBackups_Update", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Update a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Update": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + }, + "Patch Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabaseBackups_Delete", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Delete a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Delete": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + }, + "Delete Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/failover": { + "post": { + "operationId": "AutonomousDatabases_Failover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform failover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Failover": { + "$ref": "./examples/autonomousDatabase_failover.json" + }, + "Perform failover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_failover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/generateWallet": { + "post": { + "operationId": "AutonomousDatabases_GenerateWallet", + "tags": [ + "AutonomousDatabases" + ], + "description": "Generate wallet action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateAutonomousDatabaseWalletDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseWalletFile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Generate wallet action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_generateWallet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/restore": { + "post": { + "operationId": "AutonomousDatabases_Restore", + "tags": [ + "AutonomousDatabases" + ], + "description": "Restores an Autonomous Database based on the provided request parameters.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreAutonomousDatabaseDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Restore": { + "$ref": "./examples/autonomousDatabase_restore.json" + }, + "Perform restore action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_restore.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/shrink": { + "post": { + "operationId": "AutonomousDatabases_Shrink", + "tags": [ + "AutonomousDatabases" + ], + "description": "This operation shrinks the current allocated storage down to the current actual used data storage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Perform shrink action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_shrink.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/switchover": { + "post": { + "operationId": "AutonomousDatabases_Switchover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform switchover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Switchover": { + "$ref": "./examples/autonomousDatabase_switchover.json" + }, + "Perform switchover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_switchover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListByResourceGroup", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by resource group": { + "$ref": "./examples/exaInfra_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}": { + "get": { + "operationId": "CloudExadataInfrastructures_Get", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Get a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata Infrastructure": { + "$ref": "./examples/exaInfra_get.json" + } + } + }, + "put": { + "operationId": "CloudExadataInfrastructures_CreateOrUpdate", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Create a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudExadataInfrastructure' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "201": { + "description": "Resource 'CloudExadataInfrastructure' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Exadata Infrastructure": { + "$ref": "./examples/exaInfra_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudExadataInfrastructures_Update", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Update a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Exadata Infrastructure": { + "$ref": "./examples/exaInfra_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudExadataInfrastructures_Delete", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Delete a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Exadata Infrastructure": { + "$ref": "./examples/exaInfra_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/addStorageCapacity": { + "post": { + "operationId": "CloudExadataInfrastructures_AddStorageCapacity", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Perform add storage capacity on exadata infra", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Perform add storage capacity on exadata infra": { + "$ref": "./examples/exaInfra_addStorageCapacity.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers": { + "get": { + "operationId": "DbServers_ListByCloudExadataInfrastructure", + "tags": [ + "DbServers" + ], + "description": "List DbServer resources by CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbServers by Exadata Infrastructure": { + "$ref": "./examples/dbServers_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers/{dbserverocid}": { + "get": { + "operationId": "DbServers_Get", + "tags": [ + "DbServers" + ], + "description": "Get a DbServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbserverocid", + "in": "path", + "description": "DbServer OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbServer by parent": { + "$ref": "./examples/dbServers_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListByResourceGroup", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by resource group": { + "$ref": "./examples/vmClusters_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}": { + "get": { + "operationId": "CloudVmClusters_Get", + "tags": [ + "CloudVmClusters" + ], + "description": "Get a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get VM Cluster": { + "$ref": "./examples/vmClusters_get.json" + } + } + }, + "put": { + "operationId": "CloudVmClusters_CreateOrUpdate", + "tags": [ + "CloudVmClusters" + ], + "description": "Create a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudVmCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "201": { + "description": "Resource 'CloudVmCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create VM Cluster": { + "$ref": "./examples/vmClusters_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudVmClusters_Update", + "tags": [ + "CloudVmClusters" + ], + "description": "Update a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmClusterUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch VM Cluster": { + "$ref": "./examples/vmClusters_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudVmClusters_Delete", + "tags": [ + "CloudVmClusters" + ], + "description": "Delete a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete VM Cluster": { + "$ref": "./examples/vmClusters_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/addVms": { + "post": { + "operationId": "CloudVmClusters_AddVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Add VMs to the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Add VMs to VM Cluster": { + "$ref": "./examples/vmClusters_addVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes": { + "get": { + "operationId": "DbNodes_ListByCloudVmCluster", + "tags": [ + "DbNodes" + ], + "description": "List DbNode resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNodeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbNodes by VM Cluster": { + "$ref": "./examples/dbNodes_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}": { + "get": { + "operationId": "DbNodes_Get", + "tags": [ + "DbNodes" + ], + "description": "Get a DbNode", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbNode": { + "$ref": "./examples/dbNodes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}/action": { + "post": { + "operationId": "DbNodes_Action", + "tags": [ + "DbNodes" + ], + "description": "VM actions on DbNode of VM Cluster by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DbNodeAction" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DbNodes_Action": { + "$ref": "./examples/dbNodes_action.json" + }, + "VM actions on DbNodes of VM Cluster": { + "$ref": "./examples/dbNodes_action.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/listPrivateIpAddresses": { + "post": { + "operationId": "CloudVmClusters_ListPrivateIpAddresses", + "tags": [ + "CloudVmClusters" + ], + "description": "List Private IP Addresses by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateIpAddressesFilter" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateIpAddressProperties" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private IP Addresses for VM Cluster": { + "$ref": "./examples/vmClusters_listPrivateIpAddresses.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/removeVms": { + "post": { + "operationId": "CloudVmClusters_RemoveVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Remove VMs from the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Remove VMs from VM Cluster": { + "$ref": "./examples/vmClusters_removeVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses": { + "get": { + "operationId": "VirtualNetworkAddresses_ListByCloudVmCluster", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "List VirtualNetworkAddress resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddressListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Virtual Network Addresses by VM Cluster": { + "$ref": "./examples/virtualNetworkAddresses_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses/{virtualnetworkaddressname}": { + "get": { + "operationId": "VirtualNetworkAddresses_Get", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Get a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_get.json" + } + } + }, + "put": { + "operationId": "VirtualNetworkAddresses_CreateOrUpdate", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Create a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualNetworkAddress' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "201": { + "description": "Resource 'VirtualNetworkAddress' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualNetworkAddresses_Delete", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Delete a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActivationLinks": { + "type": "object", + "description": "Activation Links model", + "properties": { + "newCloudAccountActivationLink": { + "type": "string", + "description": "New Cloud Account Activation Link", + "readOnly": true + }, + "existingCloudAccountActivationLink": { + "type": "string", + "description": "Existing Cloud Account Activation Link", + "readOnly": true + } + } + }, + "AddRemoveDbNode": { + "type": "object", + "description": "Add/Remove (Virtual Machine) DbNode model", + "properties": { + "dbServers": { + "type": "array", + "description": "Db servers ocids", + "items": { + "$ref": "#/definitions/Ocid" + } + } + }, + "required": [ + "dbServers" + ] + }, + "AddSubscriptionOperationState": { + "type": "string", + "description": "Add Subscription Operation state enum", + "enum": [ + "Succeeded", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "AddSubscriptionOperationState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded - State when Add Subscription operation succeeded" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Updating - State when Add Subscription operation is being Updated" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed - State when Add Subscription operation failed" + } + ] + }, + "readOnly": true + }, + "AllConnectionStringType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + } + } + }, + "ApexDetailsType": { + "type": "object", + "description": "Information about Oracle APEX Application Development.", + "properties": { + "apexVersion": { + "type": "string", + "description": "The Oracle APEX Application Development version." + }, + "ordsVersion": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) version." + } + } + }, + "AutonomousDatabase": { + "type": "object", + "description": "Autonomous Database resource model.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AutonomousDatabaseBackup": { + "type": "object", + "description": "AutonomousDatabaseBackup resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseBackupLifecycleState": { + "type": "string", + "description": "Autonomous database backup lifecycle state enum", + "enum": [ + "Creating", + "Active", + "Deleting", + "Failed", + "Updating" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "AutonomousDatabase backup is creating" + }, + { + "name": "Active", + "value": "Active", + "description": "AutonomousDatabase backup is active" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "AutonomousDatabase backup is deleting" + }, + { + "name": "Failed", + "value": "Failed", + "description": "AutonomousDatabase backup is failed" + }, + { + "name": "Updating", + "value": "Updating", + "description": "AutonomousDatabase backup is updating" + } + ] + } + }, + "AutonomousDatabaseBackupListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseBackup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseBackup items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseBackupProperties": { + "type": "object", + "description": "AutonomousDatabaseBackup resource model", + "properties": { + "autonomousDatabaseOcid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database.", + "readOnly": true + }, + "databaseSizeInTbs": { + "type": "number", + "format": "double", + "description": "The size of the database in terabytes at the time the backup was taken.", + "readOnly": true + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the backup. The name does not have to be unique.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database backup.", + "readOnly": true + }, + "isAutomatic": { + "type": "boolean", + "description": "Indicates whether the backup is user-initiated or automatic.", + "readOnly": true + }, + "isRestorable": { + "type": "boolean", + "description": "Indicates whether the backup can be used to restore the associated Autonomous Database.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseBackupLifecycleState", + "description": "The current state of the backup.", + "readOnly": true + }, + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "sizeInTbs": { + "type": "number", + "format": "double", + "description": "The backup size in terabytes (TB).", + "readOnly": true + }, + "timeAvailableTil": { + "type": "string", + "format": "date-time", + "description": "Timestamp until when the backup will be available.", + "readOnly": true + }, + "timeStarted": { + "type": "string", + "description": "The date and time the backup started.", + "readOnly": true + }, + "timeEnded": { + "type": "string", + "description": "The date and time the backup completed.", + "readOnly": true + }, + "backupType": { + "$ref": "#/definitions/AutonomousDatabaseBackupType", + "description": "The type of backup.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "AutonomousDatabaseBackupType": { + "type": "string", + "description": "Autonomous database backup type enum", + "enum": [ + "Incremental", + "Full", + "LongTerm" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupType", + "modelAsString": true, + "values": [ + { + "name": "Incremental", + "value": "Incremental", + "description": "Incremental backup" + }, + { + "name": "Full", + "value": "Full", + "description": "Full backup" + }, + { + "name": "LongTerm", + "value": "LongTerm", + "description": "LongTerm backup" + } + ] + } + }, + "AutonomousDatabaseBackupUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabaseBackup.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseBackupUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabaseBackup.", + "properties": { + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseBaseProperties": { + "type": "object", + "description": "Autonomous Database base resource model.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "dataBaseType": { + "$ref": "#/definitions/DataBaseType", + "description": "Database type to be created.", + "x-ms-mutability": [ + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "characterSet": { + "type": "string", + "description": "The character set for the autonomous database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeModel": { + "$ref": "#/definitions/ComputeModel", + "description": "The compute model of the Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbIds": { + "type": "array", + "description": "The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isRemoteDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has Cross Region Data Guard enabled.", + "readOnly": true + }, + "localDisasterRecoveryType": { + "$ref": "#/definitions/DisasterRecoveryType", + "description": "Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance.Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover.Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.", + "readOnly": true + }, + "localStandbyDb": { + "$ref": "#/definitions/AutonomousDatabaseStandbySummary", + "description": "Local Autonomous Disaster Recovery standby database details.", + "readOnly": true + }, + "failedDataRecoveryInSeconds": { + "type": "integer", + "format": "int32", + "description": "Indicates the number of seconds of data loss for a Data Guard failover.", + "readOnly": true + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isPreviewVersionWithServiceTermsAccepted": { + "type": "boolean", + "description": "Specifies if the Autonomous Database preview version is being provisioned.", + "x-ms-mutability": [ + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "ncharacterSet": { + "type": "string", + "description": "The character set for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsType", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "privateEndpointIp": { + "type": "string", + "description": "The private endpoint Ip address for the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "privateEndpointLabel": { + "type": "string", + "description": "The resource's private endpoint label.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database was created.", + "readOnly": true + }, + "timeMaintenanceBegin": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will begin.", + "readOnly": true + }, + "timeMaintenanceEnd": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will end.", + "readOnly": true + }, + "actualUsedDataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The current amount of storage in use for user and system data, in terabytes (TB).", + "readOnly": true + }, + "allocatedStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The amount of storage currently allocated for the database tables and billed for, rounded up.", + "readOnly": true + }, + "apexDetails": { + "$ref": "#/definitions/ApexDetailsType", + "description": "Information about Oracle APEX Application Development.", + "readOnly": true + }, + "availableUpgradeVersions": { + "type": "array", + "description": "List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "connectionStrings": { + "$ref": "#/definitions/ConnectionStringType", + "description": "The connection string used to connect to the Autonomous Database.", + "readOnly": true + }, + "connectionUrls": { + "$ref": "#/definitions/ConnectionUrlType", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. ", + "readOnly": true + }, + "dataSafeStatus": { + "$ref": "#/definitions/DataSafeStatusType", + "description": "Status of the Data Safe registration for this Autonomous Database.", + "readOnly": true + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "autonomousDatabaseId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "Autonomous Database ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "inMemoryAreaInGbs": { + "type": "integer", + "format": "int32", + "description": "The area assigned to In-Memory tables in Autonomous Database.", + "readOnly": true + }, + "nextLongTermBackupTimeStamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the next long-term backup would be created.", + "readOnly": true + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "isPreview": { + "type": "boolean", + "description": "Indicates if the Autonomous Database version is a preview version.", + "readOnly": true + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "memoryPerOracleComputeUnitInGbs": { + "type": "integer", + "format": "int32", + "description": "The amount of memory (in GBs) enabled per ECPU or OCPU.", + "readOnly": true + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "operationsInsightsStatus": { + "$ref": "#/definitions/OperationsInsightsStatusType", + "description": "Status of Operations Insights for this Autonomous Database.", + "readOnly": true + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "privateEndpoint": { + "type": "string", + "description": "The private endpoint for the resource.", + "readOnly": true + }, + "provisionableCpus": { + "type": "array", + "description": "An array of CPU values that an Autonomous Database can be scaled to.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "serviceConsoleUrl": { + "type": "string", + "description": "The URL of the Service Console for the Autonomous Database.", + "minLength": 10, + "maxLength": 255, + "readOnly": true + }, + "sqlWebDeveloperUrl": { + "type": "string", + "description": "The SQL Web Developer URL for the Oracle Autonomous Database.", + "minLength": 10, + "maxLength": 2048, + "readOnly": true + }, + "supportedRegionsToCloneTo": { + "type": "array", + "description": "The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.", + "maxItems": 50, + "items": { + "type": "string" + }, + "readOnly": true + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the Autonomous Database.", + "readOnly": true + }, + "timeDeletionOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be automatically deleted because of inactivity.", + "readOnly": true + }, + "timeLocalDataGuardEnabled": { + "type": "string", + "description": "The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.", + "readOnly": true + }, + "timeOfLastFailover": { + "type": "string", + "description": "The timestamp of the last failover operation.", + "readOnly": true + }, + "timeOfLastRefresh": { + "type": "string", + "description": "The date and time when last refresh happened.", + "readOnly": true + }, + "timeOfLastRefreshPoint": { + "type": "string", + "description": "The refresh point timestamp (UTC).", + "readOnly": true + }, + "timeOfLastSwitchover": { + "type": "string", + "description": "The timestamp of the last switchover operation for the Autonomous Database.", + "readOnly": true + }, + "timeReclamationOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be stopped because of inactivity.", + "readOnly": true + }, + "usedDataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The storage space consumed by Autonomous Database in GBs.", + "readOnly": true + }, + "usedDataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The amount of storage that has been used, in terabytes.", + "readOnly": true + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Database ocid", + "readOnly": true + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "discriminator": "dataBaseType", + "required": [ + "dataBaseType" + ] + }, + "AutonomousDatabaseCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "AutonomousDatabaseCloneProperties": { + "type": "object", + "description": "Autonomous Database clone resource model.", + "properties": { + "source": { + "$ref": "#/definitions/SourceType", + "description": "The source of the database.", + "x-ms-mutability": [ + "create" + ] + }, + "sourceId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "The Azure ID of the Autonomous Database that was cloned to create the current Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloneType": { + "$ref": "#/definitions/CloneType", + "description": "The Autonomous Database clone type.", + "x-ms-mutability": [ + "create" + ] + }, + "isReconnectCloneEnabled": { + "type": "boolean", + "description": "Indicates if the refreshable clone can be reconnected to its source database.", + "readOnly": true + }, + "isRefreshableClone": { + "type": "boolean", + "description": "Indicates if the Autonomous Database is a refreshable clone.", + "readOnly": true + }, + "refreshableModel": { + "$ref": "#/definitions/RefreshableModelType", + "description": "The refresh mode of the clone.", + "x-ms-mutability": [ + "create" + ] + }, + "refreshableStatus": { + "$ref": "#/definitions/RefreshableStatusType", + "description": "The refresh status of the clone.", + "readOnly": true + }, + "timeUntilReconnectCloneEnabled": { + "type": "string", + "description": "The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.", + "x-ms-mutability": [ + "read", + "update" + ] + } + }, + "required": [ + "sourceId", + "cloneType" + ], + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Clone" + }, + "AutonomousDatabaseId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/autonomousDatabases" + } + ] + } + }, + "AutonomousDatabaseLifecycleState": { + "type": "string", + "description": "Autonomous database lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Unavailable", + "RestoreInProgress", + "RestoreFailed", + "BackupInProgress", + "ScaleInProgress", + "AvailableNeedsAttention", + "Updating", + "MaintenanceInProgress", + "Restarting", + "Recreating", + "RoleChangeInProgress", + "Upgrading", + "Inaccessible", + "Standby" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "RestoreInProgress", + "value": "RestoreInProgress", + "description": "Indicates that resource in RestoreInProgress state" + }, + { + "name": "RestoreFailed", + "value": "RestoreFailed", + "description": "Indicates that resource in RestoreFailed state" + }, + { + "name": "BackupInProgress", + "value": "BackupInProgress", + "description": "Indicates that resource in BackupInProgress state" + }, + { + "name": "ScaleInProgress", + "value": "ScaleInProgress", + "description": "Indicates that resource in ScaleInProgress state" + }, + { + "name": "AvailableNeedsAttention", + "value": "AvailableNeedsAttention", + "description": "Indicates that resource is available but needs attention" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Restarting", + "value": "Restarting", + "description": "Indicates that resource in Restarting state" + }, + { + "name": "Recreating", + "value": "Recreating", + "description": "Indicates that resource in Recreating state" + }, + { + "name": "RoleChangeInProgress", + "value": "RoleChangeInProgress", + "description": "Indicates that resource role change in progress state" + }, + { + "name": "Upgrading", + "value": "Upgrading", + "description": "Indicates that resource in Upgrading state" + }, + { + "name": "Inaccessible", + "value": "Inaccessible", + "description": "IIndicates that resource in Inaccessible state" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Indicates that resource in Standby state" + } + ] + } + }, + "AutonomousDatabaseListResult": { + "type": "object", + "description": "The response of a AutonomousDatabase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabase items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseNationalCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseNationalCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseNationalCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported national character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "AutonomousDatabaseProperties": { + "type": "object", + "description": "Autonomous Database resource model.", + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Regular" + }, + "AutonomousDatabaseStandbySummary": { + "type": "object", + "description": "Autonomous Disaster Recovery standby database details.", + "properties": { + "lagTimeInSeconds": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover." + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "The current state of the Autonomous Database." + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state." + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database." + }, + "timeDisasterRecoveryRoleChanged": { + "type": "string", + "description": "The date and time the Disaster Recovery role was switched for the standby Autonomous Database." + } + } + }, + "AutonomousDatabaseUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabase.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AutonomousDatabaseUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabase.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsTypeUpdate", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseWalletFile": { + "type": "object", + "description": "Autonomous Database Wallet File resource model.", + "properties": { + "walletFiles": { + "type": "string", + "description": "The base64 encoded wallet files" + } + }, + "required": [ + "walletFiles" + ] + }, + "AutonomousDbVersion": { + "type": "object", + "description": "AutonomousDbVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDbVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDbVersionListResult": { + "type": "object", + "description": "The response of a AutonomousDbVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDbVersion items on this page", + "items": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDbVersionProperties": { + "type": "object", + "description": "AutonomousDbVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "Supported Autonomous Db versions.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "readOnly": true + }, + "isDefaultForFree": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is free.", + "readOnly": true + }, + "isDefaultForPaid": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is paid.", + "readOnly": true + }, + "isFreeTierEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.", + "readOnly": true + }, + "isPaidEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software has payments enabled.", + "readOnly": true + } + } + }, + "AutonomousMaintenanceScheduleType": { + "type": "string", + "description": "Autonomous database maintenance schedule type enum.", + "enum": [ + "Early", + "Regular" + ], + "x-ms-enum": { + "name": "AutonomousMaintenanceScheduleType", + "modelAsString": true, + "values": [ + { + "name": "Early", + "value": "Early", + "description": "Early maintenance schedule" + }, + { + "name": "Regular", + "value": "Regular", + "description": "Regular maintenance schedule" + } + ] + } + }, + "Azure.ResourceManager.ResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource type.", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ResourceProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "AzureResourceProvisioningState": { + "type": "string", + "description": "Azure Resource Provisioning State enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "x-ms-enum": { + "name": "AzureResourceProvisioningState", + "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": "Indicates that resource in Provisioning state" + } + ] + }, + "readOnly": true + }, + "AzureSubscriptions": { + "type": "object", + "description": "Azure Subscriptions model", + "properties": { + "azureSubscriptionIds": { + "type": "array", + "description": "Azure Subscription Ids to be updated", + "items": { + "type": "string" + } + } + }, + "required": [ + "azureSubscriptionIds" + ] + }, + "CloneType": { + "type": "string", + "description": "Clone type enum", + "enum": [ + "Full", + "Metadata" + ], + "x-ms-enum": { + "name": "CloneType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full clone" + }, + { + "name": "Metadata", + "value": "Metadata", + "description": "Metadata only" + } + ] + } + }, + "CloudAccountDetails": { + "type": "object", + "description": "Cloud Account Details model", + "properties": { + "cloudAccountName": { + "type": "string", + "description": "Cloud Account name", + "readOnly": true + }, + "cloudAccountHomeRegion": { + "type": "string", + "description": "Cloud Account Home region", + "readOnly": true + } + } + }, + "CloudAccountProvisioningState": { + "type": "string", + "description": "CloudAccountProvisioningState enum", + "enum": [ + "Pending", + "Provisioning", + "Available" + ], + "x-ms-enum": { + "name": "CloudAccountProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Pending - Initial state when Oracle cloud account is not configured" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning - State when Oracle cloud account is being provisioned" + }, + { + "name": "Available", + "value": "Available", + "description": "Available - State when Oracle cloud account cloud linking is complete and it is available" + } + ] + } + }, + "CloudExadataInfrastructure": { + "type": "object", + "description": "CloudExadataInfrastructure resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + } + }, + "required": [ + "zones" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudExadataInfrastructureId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/cloudExadataInfrastructures" + } + ] + } + }, + "CloudExadataInfrastructureLifecycleState": { + "type": "string", + "description": "CloudExadataInfrastructureLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudExadataInfrastructureLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudExadataInfrastructureListResult": { + "type": "object", + "description": "The response of a CloudExadataInfrastructure list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudExadataInfrastructure items on this page", + "items": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudExadataInfrastructureProperties": { + "type": "object", + "description": "CloudExadataInfrastructure resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Exadata infra ocid", + "readOnly": true + }, + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "totalStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "availableStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "description": "The date and time the cloud Exadata infrastructure resource was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "estimatedPatchingTime": { + "$ref": "#/definitions/EstimatedPatchingTime", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "readOnly": true + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudExadataInfrastructure provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudExadataInfrastructureLifecycleState", + "description": "CloudExadataInfrastructure lifecycle state", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the cloud Exadata infrastructure resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores allocated.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory allocated in GBs.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs.", + "readOnly": true + }, + "maxDbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total local node storage available in GBs.", + "readOnly": true + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The quantity of data in the database, in terabytes.", + "readOnly": true + }, + "maxDataStorageInTbs": { + "type": "number", + "format": "double", + "description": "The total available DATA disk group size.", + "readOnly": true + }, + "dbServerVersion": { + "type": "string", + "description": "The software version of the database servers (dom0) in the Exadata infrastructure.", + "readOnly": true + }, + "storageServerVersion": { + "type": "string", + "description": "The software version of the storage servers (cells) in the Exadata infrastructure.", + "readOnly": true + }, + "activatedStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers activated for the Exadata infrastructure.", + "readOnly": true + }, + "additionalStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers for the Exadata infrastructure.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "lastMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance run.", + "readOnly": true + }, + "nextMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the next maintenance run.", + "readOnly": true + }, + "monthlyDbServerVersion": { + "type": "string", + "description": "Monthly Db Server version", + "readOnly": true + }, + "monthlyStorageServerVersion": { + "type": "string", + "description": "Monthly Storage Server version", + "readOnly": true + } + }, + "required": [ + "shape", + "displayName" + ] + }, + "CloudExadataInfrastructureUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudExadataInfrastructure.", + "properties": { + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "CloudExadataInfrastructureUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudExadataInfrastructure.", + "properties": { + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "CloudVmCluster": { + "type": "object", + "description": "CloudVmCluster resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudVmClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudVmClusterLifecycleState": { + "type": "string", + "description": "Cloud VM Cluster lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudVmClusterLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource Maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudVmClusterListResult": { + "type": "object", + "description": "The response of a CloudVmCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudVmCluster items on this page", + "items": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudVmClusterProperties": { + "type": "object", + "description": "CloudVmCluster resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Cloud VM Cluster ocid", + "readOnly": true + }, + "listenerPort": { + "type": "integer", + "format": "int64", + "description": "The port number configured for the listener on the cloud VM cluster.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the cloud VM cluster. ", + "readOnly": true + }, + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the cloud VM cluster was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "timeZone": { + "type": "string", + "description": "The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm).", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "zoneId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the zone the cloud VM cluster is associated with.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hostname": { + "type": "string", + "description": "The hostname for the cloud VM cluster.", + "minLength": 1, + "maxLength": 23, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "domain": { + "type": "string", + "description": "The domain name for the cloud VM cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "clusterName": { + "type": "string", + "description": "The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ", + "minLength": 1, + "maxLength": 11, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataStoragePercentage": { + "type": "integer", + "format": "int32", + "description": "The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isLocalBackupEnabled": { + "type": "boolean", + "description": "If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudExadataInfrastructureId": { + "$ref": "#/definitions/CloudExadataInfrastructureId", + "description": "Cloud Exadata Infrastructure ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isSparseDiskgroupEnabled": { + "type": "boolean", + "description": "If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemVersion": { + "type": "string", + "description": "Operating system version of the image.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "diskRedundancy": { + "$ref": "#/definitions/DiskRedundancy", + "description": "The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ", + "readOnly": true + }, + "scanIpIds": { + "type": "array", + "description": "The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vipIds": { + "type": "array", + "description": "The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "scanDnsName": { + "type": "string", + "description": "The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ", + "minLength": 1, + "maxLength": 72, + "readOnly": true + }, + "scanListenerPortTcp": { + "type": "integer", + "format": "int32", + "description": "The TCP Single Client Access Name (SCAN) port. The default port is 1521.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanListenerPortTcpSsl": { + "type": "integer", + "format": "int32", + "description": "The TCPS Single Client Access Name (SCAN) port. The default port is 2484.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanDnsRecordId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the Exadata hardware running the cloud VM cluster.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudVmCluster provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudVmClusterLifecycleState", + "description": "CloudVmCluster lifecycle state", + "readOnly": true + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "giVersion": { + "type": "string", + "description": "Oracle Grid Infrastructure (GI) software version", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "nsgUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupSubnetCidr": { + "type": "string", + "description": "Client OCI backup subnet CIDR, default is 192.168.252.0/22", + "minLength": 1, + "maxLength": 32, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nsgCidrs": { + "type": "array", + "description": "CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.", + "items": { + "$ref": "#/definitions/NsgCidr" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + }, + "iormConfigCache": { + "$ref": "#/definitions/ExadataIormConfig", + "description": "iormConfigCache details for cloud VM cluster.", + "readOnly": true + }, + "lastUpdateHistoryEntryId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance update history entry.", + "readOnly": true + }, + "dbServers": { + "type": "array", + "description": "The list of DB servers.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "Cluster compartmentId", + "readOnly": true + }, + "subnetOcid": { + "$ref": "#/definitions/Ocid", + "description": "Cluster subnet ocid", + "readOnly": true + } + }, + "required": [ + "hostname", + "cpuCoreCount", + "cloudExadataInfrastructureId", + "sshPublicKeys", + "vnetId", + "giVersion", + "subnetId", + "displayName" + ] + }, + "CloudVmClusterUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudVmCluster.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudVmClusterUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "CloudVmClusterUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudVmCluster.", + "properties": { + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ComputeModel": { + "type": "string", + "description": "Compute model enum", + "enum": [ + "ECPU", + "OCPU" + ], + "x-ms-enum": { + "name": "ComputeModel", + "modelAsString": true, + "values": [ + { + "name": "ECPU", + "value": "ECPU", + "description": "ECPU model type" + }, + { + "name": "OCPU", + "value": "OCPU", + "description": "OCPU model type" + } + ] + } + }, + "ConnectionStringType": { + "type": "object", + "description": "Connection strings to connect to an Oracle Autonomous Database.", + "properties": { + "allConnectionStrings": { + "$ref": "#/definitions/AllConnectionStringType", + "description": "Returns all connection strings that can be used to connect to the Autonomous Database." + }, + "dedicated": { + "type": "string", + "description": "The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "profiles": { + "type": "array", + "description": "A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.", + "items": { + "$ref": "#/definitions/ProfileType" + }, + "x-ms-identifiers": [] + } + } + }, + "ConnectionUrlType": { + "type": "object", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.", + "properties": { + "apexUrl": { + "type": "string", + "description": "Oracle Application Express (APEX) URL.", + "minLength": 10, + "maxLength": 512 + }, + "databaseTransformsUrl": { + "type": "string", + "description": "The URL of the Database Transforms for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "graphStudioUrl": { + "type": "string", + "description": "The URL of the Graph Studio for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "machineLearningNotebookUrl": { + "type": "string", + "description": "The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "mongoDbUrl": { + "type": "string", + "description": "The URL of the MongoDB API for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "ordsUrl": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "sqlDevWebUrl": { + "type": "string", + "description": "Oracle SQL Developer Web URL.", + "minLength": 10, + "maxLength": 512 + } + } + }, + "ConsumerGroup": { + "type": "string", + "description": "Consumer group enum.", + "enum": [ + "High", + "Medium", + "Low", + "Tp", + "Tpurgent" + ], + "x-ms-enum": { + "name": "ConsumerGroup", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High group" + }, + { + "name": "Medium", + "value": "Medium", + "description": "Medium group" + }, + { + "name": "Low", + "value": "Low", + "description": "Low group" + }, + { + "name": "Tp", + "value": "Tp", + "description": "TP group" + }, + { + "name": "Tpurgent", + "value": "Tpurgent", + "description": "TPurgent group" + } + ] + } + }, + "CustomerContact": { + "type": "object", + "description": "CustomerContact resource properties", + "properties": { + "email": { + "type": "string", + "description": "The email address used by Oracle to send notifications regarding databases and infrastructure.", + "minLength": 1, + "maxLength": 320 + } + }, + "required": [ + "email" + ] + }, + "DataBaseType": { + "type": "string", + "description": "Database type enum", + "enum": [ + "Regular", + "Clone" + ], + "x-ms-enum": { + "name": "DataBaseType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular DB" + }, + { + "name": "Clone", + "value": "Clone", + "description": "Clone DB" + } + ] + } + }, + "DataCollectionOptions": { + "type": "object", + "description": "DataCollectionOptions resource properties", + "properties": { + "isDiagnosticsEventsEnabled": { + "type": "boolean", + "description": "Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS.", + "default": false + }, + "isHealthMonitoringEnabled": { + "type": "boolean", + "description": "Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + }, + "isIncidentLogsEnabled": { + "type": "boolean", + "description": "Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + } + } + }, + "DataSafeStatusType": { + "type": "string", + "description": "DataSafe status type enum.", + "enum": [ + "Registering", + "Registered", + "Deregistering", + "NotRegistered", + "Failed" + ], + "x-ms-enum": { + "name": "DataSafeStatusType", + "modelAsString": true, + "values": [ + { + "name": "Registering", + "value": "Registering", + "description": "Registering status" + }, + { + "name": "Registered", + "value": "Registered", + "description": "Registered status" + }, + { + "name": "Deregistering", + "value": "Deregistering", + "description": "Deregistering status" + }, + { + "name": "NotRegistered", + "value": "NotRegistered", + "description": "NotRegistered status" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed status" + } + ] + } + }, + "DatabaseEditionType": { + "type": "string", + "description": "Database edition type enum.", + "enum": [ + "StandardEdition", + "EnterpriseEdition" + ], + "x-ms-enum": { + "name": "DatabaseEditionType", + "modelAsString": true, + "values": [ + { + "name": "StandardEdition", + "value": "StandardEdition", + "description": "Standard edition" + }, + { + "name": "EnterpriseEdition", + "value": "EnterpriseEdition", + "description": "Enterprise edition" + } + ] + } + }, + "DayOfWeek": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + }, + "required": [ + "name" + ] + }, + "DayOfWeekName": { + "type": "string", + "description": "DayOfWeekName enum", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeekName", + "modelAsString": true, + "values": [ + { + "name": "Monday", + "value": "Monday", + "description": "Monday value" + }, + { + "name": "Tuesday", + "value": "Tuesday", + "description": "Tuesday value" + }, + { + "name": "Wednesday", + "value": "Wednesday", + "description": "Wednesday value" + }, + { + "name": "Thursday", + "value": "Thursday", + "description": "Thursday value" + }, + { + "name": "Friday", + "value": "Friday", + "description": "Friday value" + }, + { + "name": "Saturday", + "value": "Saturday", + "description": "Saturday value" + }, + { + "name": "Sunday", + "value": "Sunday", + "description": "Sunday value" + } + ] + } + }, + "DayOfWeekUpdate": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + } + }, + "DbIormConfig": { + "type": "object", + "description": "DbIormConfig for cloud vm cluster", + "properties": { + "dbName": { + "type": "string", + "description": "The database name. For the default DbPlan, the dbName is default." + }, + "flashCacheLimit": { + "type": "string", + "description": "The flash cache limit for this database. This value is internally configured based on the share value assigned to the database." + }, + "share": { + "type": "integer", + "format": "int32", + "description": "The relative priority of this database.", + "minimum": 1, + "maximum": 32 + } + } + }, + "DbNode": { + "type": "object", + "description": "The DbNode resource belonging to vmCluster", + "properties": { + "properties": { + "$ref": "#/definitions/DbNodeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbNodeAction": { + "type": "object", + "description": "DbNode action object", + "properties": { + "action": { + "$ref": "#/definitions/DbNodeActionEnum", + "description": "Db action" + } + }, + "required": [ + "action" + ] + }, + "DbNodeActionEnum": { + "type": "string", + "description": "DbNode action enum", + "enum": [ + "Start", + "Stop", + "SoftReset", + "Reset" + ], + "x-ms-enum": { + "name": "DbNodeActionEnum", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "Start DbNode" + }, + { + "name": "Stop", + "value": "Stop", + "description": "Stop DbNode" + }, + { + "name": "SoftReset", + "value": "SoftReset", + "description": "Soft reset DbNode" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset DbNode" + } + ] + } + }, + "DbNodeListResult": { + "type": "object", + "description": "The response of a DbNode list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbNode items on this page", + "items": { + "$ref": "#/definitions/DbNode" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbNodeMaintenanceType": { + "type": "string", + "description": "The type of database node maintenance.", + "enum": [ + "VmdbRebootMigration" + ], + "x-ms-enum": { + "name": "DbNodeMaintenanceType", + "modelAsString": true, + "values": [ + { + "name": "VmdbRebootMigration", + "value": "VmdbRebootMigration", + "description": "VMDB reboot migration maintenance type" + } + ] + } + }, + "DbNodeProperties": { + "type": "object", + "description": "The properties of DbNodeResource", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "DbNode OCID", + "readOnly": true + }, + "additionalDetails": { + "type": "string", + "description": "Additional information about the planned maintenance.", + "readOnly": true + }, + "backupIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup IP address associated with the database node.", + "readOnly": true + }, + "backupVnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second backup VNIC.", + "readOnly": true + }, + "backupVnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup VNIC.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db node.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db node.", + "readOnly": true + }, + "dbServerId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exacc Db server associated with the database node.", + "readOnly": true + }, + "dbSystemId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DB system.", + "readOnly": true + }, + "faultDomain": { + "type": "string", + "description": "The name of the Fault Domain the instance is contained in.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "hostIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the host IP address associated with the database node.", + "readOnly": true + }, + "hostname": { + "type": "string", + "description": "The host name for the database node.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbNodeProvisioningState", + "description": "The current state of the database node.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of Db Node.", + "readOnly": true + }, + "maintenanceType": { + "$ref": "#/definitions/DbNodeMaintenanceType", + "description": "The type of database node maintenance.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated memory in GBs on the Db node.", + "readOnly": true + }, + "softwareStorageSizeInGb": { + "type": "integer", + "format": "int32", + "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database node was created.", + "readOnly": true + }, + "timeMaintenanceWindowEnd": { + "type": "string", + "format": "date-time", + "description": "End date and time of maintenance window.", + "readOnly": true + }, + "timeMaintenanceWindowStart": { + "type": "string", + "format": "date-time", + "description": "Start date and time of maintenance window.", + "readOnly": true + }, + "vnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second VNIC.", + "readOnly": true + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the VNIC.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DbNodeProvisioningState": { + "type": "string", + "description": "DnNode provisioning state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "DbNodeProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "DbServer": { + "type": "object", + "description": "DbServer resource model", + "properties": { + "properties": { + "$ref": "#/definitions/DbServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbServerListResult": { + "type": "object", + "description": "The response of a DbServer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbServer items on this page", + "items": { + "$ref": "#/definitions/DbServer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbServerPatchingDetails": { + "type": "object", + "description": "DbServer Patching Properties", + "properties": { + "estimatedPatchDuration": { + "type": "integer", + "format": "int32", + "description": "Estimated Patch Duration", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "patchingStatus": { + "$ref": "#/definitions/DbServerPatchingStatus", + "description": "Patching Status", + "readOnly": true + }, + "timePatchingEnded": { + "type": "string", + "format": "date-time", + "description": "Time Patching Ended", + "readOnly": true + }, + "timePatchingStarted": { + "type": "string", + "format": "date-time", + "description": "Time Patching Started", + "readOnly": true + } + } + }, + "DbServerPatchingStatus": { + "type": "string", + "description": "DB Server patching status enum", + "enum": [ + "Scheduled", + "MaintenanceInProgress", + "Failed", + "Complete" + ], + "x-ms-enum": { + "name": "DbServerPatchingStatus", + "modelAsString": true, + "values": [ + { + "name": "Scheduled", + "value": "Scheduled", + "description": "Patching scheduled" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Patching in progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Patching failed" + }, + { + "name": "Complete", + "value": "Complete", + "description": "Patching completed" + } + ] + } + }, + "DbServerProperties": { + "type": "object", + "description": "DbServer resource properties", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Db server name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Db Server.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the compartment.", + "readOnly": true + }, + "exadataInfrastructureId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exadata infrastructure.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db server.", + "readOnly": true + }, + "dbServerPatchingDetails": { + "$ref": "#/definitions/DbServerPatchingDetails", + "description": "dbServerPatching details of the Db server.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db server.", + "readOnly": true + }, + "vmClusterIds": { + "type": "array", + "description": "The OCID of the VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "dbNodeIds": { + "type": "array", + "description": "The OCID of the Db nodes associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of dbServer.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbServerProvisioningState", + "description": "DbServer provisioning state.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "autonomousVmClusterIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "autonomousVirtualMachineIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "maxDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The total max dbNode storage in GBs.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory size in GBs.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the Db Server was created.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DbServerProvisioningState": { + "type": "string", + "description": "DbServerProvisioningState enum", + "enum": [ + "Creating", + "Available", + "Unavailable", + "Deleting", + "Deleted", + "MaintenanceInProgress" + ], + "x-ms-enum": { + "name": "DbServerProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "Indicates that resource in Creating state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Indicates that resource in Deleting state" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Indicates that resource in Deleted state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + } + ] + } + }, + "DbSystemShape": { + "type": "object", + "description": "DbSystemShape resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DbSystemShapeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbSystemShapeListResult": { + "type": "object", + "description": "The response of a DbSystemShape list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbSystemShape items on this page", + "items": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbSystemShapeProperties": { + "type": "object", + "description": "DbSystemShape resource model", + "properties": { + "shapeFamily": { + "type": "string", + "description": "The family of the shape used for the DB system.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "availableCoreCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "minimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "runtimeMinimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "coreCountIncrement": { + "type": "integer", + "format": "int32", + "description": "The discrete number by which the CPU core count for this shape can be increased or decreased.", + "readOnly": true + }, + "minStorageCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "maxStorageCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "availableDataStoragePerServerInTbs": { + "type": "number", + "format": "double", + "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableDbNodePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "minCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled per node for this shape.", + "readOnly": true + }, + "availableMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory that can be enabled for this shape.", + "readOnly": true + }, + "minMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum memory that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage that can be enabled for this shape.", + "readOnly": true + }, + "minDbNodeStoragePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum Db Node storage that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The maximum DATA storage that can be enabled for this shape.", + "readOnly": true + }, + "minDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The minimum data storage that need be allocated for this shape.", + "readOnly": true + }, + "minimumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of database nodes available for this shape.", + "readOnly": true + }, + "maximumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of database nodes available for this shape.", + "readOnly": true + }, + "availableCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", + "readOnly": true + } + } + }, + "DisasterRecoveryType": { + "type": "string", + "description": "Disaster recovery type enum.", + "enum": [ + "Adg", + "BackupBased" + ], + "x-ms-enum": { + "name": "DisasterRecoveryType", + "modelAsString": true, + "values": [ + { + "name": "Adg", + "value": "Adg", + "description": "ADG type" + }, + { + "name": "BackupBased", + "value": "BackupBased", + "description": "Backup based type" + } + ] + } + }, + "DiskRedundancy": { + "type": "string", + "description": "Disk redundancy enum", + "enum": [ + "High", + "Normal" + ], + "x-ms-enum": { + "name": "DiskRedundancy", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High redundancy" + }, + { + "name": "Normal", + "value": "Normal", + "description": "Normal redundancy" + } + ] + } + }, + "DnsPrivateView": { + "type": "object", + "description": "DnsPrivateView resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateViewProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateViewListResult": { + "type": "object", + "description": "The response of a DnsPrivateView list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateView items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateViewProperties": { + "type": "object", + "description": "Views resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the view", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name of the view resource", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateViewsLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "timeUpdated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DnsPrivateViewsLifecycleState": { + "type": "string", + "description": "DNS Private Views lifecycle state enum", + "enum": [ + "Active", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateViewsLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private View is active" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private View is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private View is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private View is updating" + } + ] + } + }, + "DnsPrivateZone": { + "type": "object", + "description": "DnsPrivateZone resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateZoneProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateZoneListResult": { + "type": "object", + "description": "The response of a DnsPrivateZone list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateZone items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateZoneProperties": { + "type": "object", + "description": "Zones resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Zone", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateZonesLifecycleState", + "description": "Zones lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "serial": { + "type": "integer", + "format": "int32", + "description": "The current serial of the zone. As seen in the zone's SOA record.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.", + "readOnly": true + }, + "viewId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.", + "readOnly": true + }, + "zoneType": { + "$ref": "#/definitions/ZoneType", + "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Zones timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DnsPrivateZonesLifecycleState": { + "type": "string", + "description": "DNS Private Zones lifecycle state enum", + "enum": [ + "Active", + "Creating", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateZonesLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private Zones is active" + }, + { + "name": "Creating", + "value": "Creating", + "description": "DNS Private Zones is creating" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private Zones is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private Zones is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private Zones is updating" + } + ] + } + }, + "EstimatedPatchingTime": { + "type": "object", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "properties": { + "estimatedDbServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for database server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedNetworkSwitchesPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for network switch patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedStorageServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for storage server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "totalEstimatedPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated total time required in minutes for all patching operations.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + } + } + }, + "ExadataIormConfig": { + "type": "object", + "description": "ExadataIormConfig for cloud vm cluster", + "properties": { + "dbPlans": { + "type": "array", + "description": "An array of IORM settings for all the database in the Exadata DB system.", + "items": { + "$ref": "#/definitions/DbIormConfig" + }, + "x-ms-identifiers": [] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycleState." + }, + "lifecycleState": { + "$ref": "#/definitions/IormLifecycleState", + "description": "The current state of IORM configuration for the Exadata DB system." + }, + "objective": { + "$ref": "#/definitions/Objective", + "description": "The current value for the IORM objective. The default is AUTO." + } + } + }, + "GenerateAutonomousDatabaseWalletDetails": { + "type": "object", + "description": "Autonomous Database Generate Wallet resource model.", + "properties": { + "generateType": { + "$ref": "#/definitions/GenerateType", + "description": "The type of wallet to generate." + }, + "isRegional": { + "type": "boolean", + "description": "True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only." + }, + "password": { + "$ref": "#/definitions/Password", + "description": "The password to encrypt the keys inside the wallet", + "minLength": 8 + } + }, + "required": [ + "password" + ] + }, + "GenerateType": { + "type": "string", + "description": "Generate type enum", + "enum": [ + "Single", + "All" + ], + "x-ms-enum": { + "name": "GenerateType", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "Single", + "description": "Generate single" + }, + { + "name": "All", + "value": "All", + "description": "Generate all" + } + ] + } + }, + "GiVersion": { + "type": "object", + "description": "GiVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/GiVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GiVersionListResult": { + "type": "object", + "description": "The response of a GiVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GiVersion items on this page", + "items": { + "$ref": "#/definitions/GiVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GiVersionProperties": { + "type": "object", + "description": "GiVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "A valid Oracle Grid Infrastructure (GI) software version.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "HostFormatType": { + "type": "string", + "description": "Host format type enum.", + "enum": [ + "Fqdn", + "Ip" + ], + "x-ms-enum": { + "name": "HostFormatType", + "modelAsString": true, + "values": [ + { + "name": "Fqdn", + "value": "Fqdn", + "description": "FQDN format" + }, + { + "name": "Ip", + "value": "Ip", + "description": "IP format" + } + ] + } + }, + "Intent": { + "type": "string", + "description": "Intent enum", + "enum": [ + "Retain", + "Reset" + ], + "x-ms-enum": { + "name": "Intent", + "modelAsString": true, + "values": [ + { + "name": "Retain", + "value": "Retain", + "description": "Retain intent" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset intent" + } + ] + } + }, + "IormLifecycleState": { + "type": "string", + "description": "ORM lifecycle state enum", + "enum": [ + "BootStrapping", + "Enabled", + "Disabled", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "IormLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "BootStrapping", + "value": "BootStrapping", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Indicates that resource in Enabled state" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Indicates that resource in Disabled state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "LicenseModel": { + "type": "string", + "description": "LicenseModel enum", + "enum": [ + "LicenseIncluded", + "BringYourOwnLicense" + ], + "x-ms-enum": { + "name": "LicenseModel", + "modelAsString": true, + "values": [ + { + "name": "LicenseIncluded", + "value": "LicenseIncluded", + "description": "License included" + }, + { + "name": "BringYourOwnLicense", + "value": "BringYourOwnLicense", + "description": "Bring Your Own License" + } + ] + } + }, + "LongTermBackUpScheduleDetails": { + "type": "object", + "description": "Details for the long-term backup schedule.", + "properties": { + "repeatCadence": { + "$ref": "#/definitions/RepeatCadenceType", + "description": "The frequency of the long-term backup schedule" + }, + "timeOfBackup": { + "type": "string", + "format": "date-time", + "description": "The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month." + }, + "retentionPeriodInDays": { + "$ref": "#/definitions/RetentionPeriod", + "description": "Retention period, in days, for backups." + }, + "isDisabled": { + "type": "boolean", + "description": "Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`." + } + } + }, + "MaintenanceWindow": { + "type": "object", + "description": "MaintenanceWindow resource properties", + "properties": { + "preference": { + "$ref": "#/definitions/Preference", + "description": "The maintenance window scheduling preference." + }, + "months": { + "type": "array", + "description": "Months during the year when maintenance should be performed.", + "items": { + "$ref": "#/definitions/Month" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "weeksOfMonth": { + "type": "array", + "description": "Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ", + "items": { + "type": "integer", + "format": "int32" + } + }, + "daysOfWeek": { + "type": "array", + "description": "Days during the week when maintenance should be performed.", + "items": { + "$ref": "#/definitions/DayOfWeek" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hoursOfDay": { + "type": "array", + "description": "The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC", + "items": { + "type": "integer", + "format": "int32" + } + }, + "leadTimeInWeeks": { + "type": "integer", + "format": "int32", + "description": "Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. " + }, + "patchingMode": { + "$ref": "#/definitions/PatchingMode", + "description": "Cloud Exadata infrastructure node patching method." + }, + "customActionTimeoutInMins": { + "type": "integer", + "format": "int32", + "description": "Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).", + "minimum": 0, + "maximum": 120 + }, + "isCustomActionTimeoutEnabled": { + "type": "boolean", + "description": "If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations." + }, + "isMonthlyPatchingEnabled": { + "type": "boolean", + "description": "is Monthly Patching Enabled" + } + } + }, + "Month": { + "type": "object", + "description": "Month resource properties", + "properties": { + "name": { + "$ref": "#/definitions/MonthName", + "description": "Name of the month of the year." + } + }, + "required": [ + "name" + ] + }, + "MonthName": { + "type": "string", + "description": "MonthName enum", + "enum": [ + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ], + "x-ms-enum": { + "name": "MonthName", + "modelAsString": true, + "values": [ + { + "name": "January", + "value": "January", + "description": "January value" + }, + { + "name": "February", + "value": "February", + "description": "February value" + }, + { + "name": "March", + "value": "March", + "description": "March value" + }, + { + "name": "April", + "value": "April", + "description": "April value" + }, + { + "name": "May", + "value": "May", + "description": "May value" + }, + { + "name": "June", + "value": "June", + "description": "June value" + }, + { + "name": "July", + "value": "July", + "description": "July value" + }, + { + "name": "August", + "value": "August", + "description": "August value" + }, + { + "name": "September", + "value": "September", + "description": "September value" + }, + { + "name": "October", + "value": "October", + "description": "October value" + }, + { + "name": "November", + "value": "November", + "description": "November value" + }, + { + "name": "December", + "value": "December", + "description": "December value" + } + ] + } + }, + "MsRpaasNewResourceHeader": { + "type": "object", + "description": "Header to distinguish between resource creation or update" + }, + "NsgCidr": { + "type": "object", + "description": "A rule for allowing inbound (INGRESS) IP packets", + "properties": { + "source": { + "type": "string", + "description": "Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.", + "minLength": 1, + "maxLength": 128 + }, + "destinationPortRange": { + "$ref": "#/definitions/PortRange", + "description": "Destination port range to specify particular destination ports for TCP rules." + } + }, + "required": [ + "source" + ] + }, + "Objective": { + "type": "string", + "description": "Objective enum", + "enum": [ + "LowLatency", + "HighThroughput", + "Balanced", + "Auto", + "Basic" + ], + "x-ms-enum": { + "name": "Objective", + "modelAsString": true, + "values": [ + { + "name": "LowLatency", + "value": "LowLatency", + "description": "Low latency objective" + }, + { + "name": "HighThroughput", + "value": "HighThroughput", + "description": "High throughput objective" + }, + { + "name": "Balanced", + "value": "Balanced", + "description": "Balanced objective" + }, + { + "name": "Auto", + "value": "Auto", + "description": "Auto objective" + }, + { + "name": "Basic", + "value": "Basic", + "description": "Basic objective" + } + ] + } + }, + "Ocid": { + "type": "string", + "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.", + "minLength": 1, + "maxLength": 255 + }, + "OpenModeType": { + "type": "string", + "description": "Open mode type enum.", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "OpenModeType", + "modelAsString": true, + "values": [ + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "ReadOnly mode" + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "ReadWrite mode" + } + ] + } + }, + "OperationsInsightsStatusType": { + "type": "string", + "description": "Operations Insights status type enum.", + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "NotEnabled", + "FailedEnabling", + "FailedDisabling" + ], + "x-ms-enum": { + "name": "OperationsInsightsStatusType", + "modelAsString": true, + "values": [ + { + "name": "Enabling", + "value": "Enabling", + "description": "Enabling status" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled status" + }, + { + "name": "Disabling", + "value": "Disabling", + "description": "Disabling status" + }, + { + "name": "NotEnabled", + "value": "NotEnabled", + "description": "NotEnabled status" + }, + { + "name": "FailedEnabling", + "value": "FailedEnabling", + "description": "FailedEnabling status" + }, + { + "name": "FailedDisabling", + "value": "FailedDisabling", + "description": "FailedDisabling status" + } + ] + } + }, + "OracleSubscription": { + "type": "object", + "description": "OracleSubscription resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/OracleSubscriptionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan", + "description": "Details of the resource plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OracleSubscriptionListResult": { + "type": "object", + "description": "The response of a OracleSubscription list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OracleSubscription items on this page", + "items": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OracleSubscriptionProperties": { + "type": "object", + "description": "Oracle Subscription resource model", + "properties": { + "provisioningState": { + "$ref": "#/definitions/OracleSubscriptionProvisioningState", + "description": "OracleSubscriptionProvisioningState provisioning state", + "readOnly": true + }, + "saasSubscriptionId": { + "type": "string", + "description": "SAAS subscription ID generated by Marketplace", + "readOnly": true + }, + "cloudAccountId": { + "$ref": "#/definitions/Ocid", + "description": "Cloud Account Id", + "readOnly": true + }, + "cloudAccountState": { + "$ref": "#/definitions/CloudAccountProvisioningState", + "description": "Cloud Account provisioning state.", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + }, + "azureSubscriptionIds": { + "type": "array", + "description": "Azure subscriptions associated with this OracleSubscription", + "items": { + "type": "string" + }, + "readOnly": true + }, + "addSubscriptionOperationState": { + "$ref": "#/definitions/AddSubscriptionOperationState", + "description": "State of the add Azure subscription operation on Oracle subscription", + "readOnly": true + }, + "lastOperationStatusDetail": { + "type": "string", + "description": "Status details of the last operation on Oracle subscription", + "readOnly": true + } + } + }, + "OracleSubscriptionProvisioningState": { + "type": "string", + "description": "OracleSubscriptionProvisioningState enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OracleSubscriptionProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "OracleSubscriptionUpdate": { + "type": "object", + "description": "The type used for update operations of the OracleSubscription.", + "properties": { + "plan": { + "$ref": "#/definitions/PlanUpdate", + "description": "Details of the resource plan." + }, + "properties": { + "$ref": "#/definitions/OracleSubscriptionUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "OracleSubscriptionUpdateProperties": { + "type": "object", + "description": "The updatable properties of the OracleSubscription.", + "properties": { + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + } + } + }, + "Password": { + "type": "string", + "format": "password", + "description": "Password string.", + "x-ms-secret": true + }, + "PatchingMode": { + "type": "string", + "description": "Patching mode enum", + "enum": [ + "Rolling", + "NonRolling" + ], + "x-ms-enum": { + "name": "PatchingMode", + "modelAsString": true, + "values": [ + { + "name": "Rolling", + "value": "Rolling", + "description": "Rolling patching" + }, + { + "name": "NonRolling", + "value": "NonRolling", + "description": "Non Rolling patching" + } + ] + } + }, + "PeerDbDetails": { + "type": "object", + "description": "PeerDb Details", + "properties": { + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255 + } + } + }, + "PermissionLevelType": { + "type": "string", + "description": "Permission level type enum.", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "PermissionLevelType", + "modelAsString": true, + "values": [ + { + "name": "Restricted", + "value": "Restricted", + "description": "Restricted permission level" + }, + { + "name": "Unrestricted", + "value": "Unrestricted", + "description": "Unrestricted permission level" + } + ] + } + }, + "PlanUpdate": { + "type": "object", + "description": "ResourcePlanTypeUpdate model definition", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + } + }, + "PortRange": { + "type": "object", + "description": "Port Range to specify particular destination ports for TCP rules.", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum port number, which must not be greater than the maximum port number.", + "minimum": 1, + "maximum": 65535 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.", + "minimum": 1, + "maximum": 65535 + } + }, + "required": [ + "min", + "max" + ] + }, + "Preference": { + "type": "string", + "description": "Preference enum", + "enum": [ + "NoPreference", + "CustomPreference" + ], + "x-ms-enum": { + "name": "Preference", + "modelAsString": true, + "values": [ + { + "name": "NoPreference", + "value": "NoPreference", + "description": "No preference" + }, + { + "name": "CustomPreference", + "value": "CustomPreference", + "description": "Custom preference" + } + ] + } + }, + "PrivateIpAddressProperties": { + "type": "object", + "description": "PrivateIpAddress resource properties", + "properties": { + "displayName": { + "type": "string", + "description": "PrivateIpAddresses displayName" + }, + "hostnameLabel": { + "type": "string", + "description": "PrivateIpAddresses hostnameLabel" + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses Id" + }, + "ipAddress": { + "type": "string", + "description": "PrivateIpAddresses ipAddress" + }, + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses subnetId" + } + }, + "required": [ + "displayName", + "hostnameLabel", + "ocid", + "ipAddress", + "subnetId" + ] + }, + "PrivateIpAddressesFilter": { + "type": "object", + "description": "Private Ip Addresses filter", + "properties": { + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "Subnet OCID" + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "VCN OCID" + } + }, + "required": [ + "subnetId", + "vnicId" + ] + }, + "ProfileType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "consumerGroup": { + "$ref": "#/definitions/ConsumerGroup", + "description": "Consumer group used by the connection." + }, + "displayName": { + "type": "string", + "description": "A user-friendly name for the connection.", + "minLength": 1, + "maxLength": 255 + }, + "hostFormat": { + "$ref": "#/definitions/HostFormatType", + "description": "Host format used in connection string." + }, + "isRegional": { + "type": "boolean", + "description": "True for a regional connection string, applicable to cross-region DG only." + }, + "protocol": { + "$ref": "#/definitions/ProtocolType", + "description": "Protocol used by the connection." + }, + "sessionMode": { + "$ref": "#/definitions/SessionModeType", + "description": "Specifies whether the listener performs a direct hand-off of the session, or redirects the session." + }, + "syntaxFormat": { + "$ref": "#/definitions/SyntaxFormatType", + "description": "Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format." + }, + "tlsAuthentication": { + "$ref": "#/definitions/TlsAuthenticationType", + "description": "Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication." + }, + "value": { + "type": "string", + "description": "Connection string value." + } + }, + "required": [ + "displayName", + "hostFormat", + "protocol", + "sessionMode", + "syntaxFormat", + "value" + ] + }, + "ProtocolType": { + "type": "string", + "description": "Protocol type enum.", + "enum": [ + "TCP", + "TCPS" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true, + "values": [ + { + "name": "TCP", + "value": "TCP", + "description": "TCP protocol" + }, + { + "name": "TCPS", + "value": "TCPS", + "description": "TCPS protocol" + } + ] + } + }, + "RefreshableModelType": { + "type": "string", + "description": "Refreshable model type enum", + "enum": [ + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "RefreshableModelType", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatic refreshable model type" + }, + { + "name": "Manual", + "value": "Manual", + "description": "Manual refreshable model type" + } + ] + } + }, + "RefreshableStatusType": { + "type": "string", + "description": "Refreshable status type enum.", + "enum": [ + "Refreshing", + "NotRefreshing" + ], + "x-ms-enum": { + "name": "RefreshableStatusType", + "modelAsString": true, + "values": [ + { + "name": "Refreshing", + "value": "Refreshing", + "description": "Refreshing status" + }, + { + "name": "NotRefreshing", + "value": "NotRefreshing", + "description": "NotRefreshing status" + } + ] + } + }, + "RepeatCadenceType": { + "type": "string", + "description": "Repeat cadence type enum", + "enum": [ + "OneTime", + "Weekly", + "Monthly", + "Yearly" + ], + "x-ms-enum": { + "name": "RepeatCadenceType", + "modelAsString": true, + "values": [ + { + "name": "OneTime", + "value": "OneTime", + "description": "Repeat one time" + }, + { + "name": "Weekly", + "value": "Weekly", + "description": "Repeat weekly" + }, + { + "name": "Monthly", + "value": "Monthly", + "description": "Repeat monthly" + }, + { + "name": "Yearly", + "value": "Yearly", + "description": "Repeat yearly" + } + ] + } + }, + "RestoreAutonomousDatabaseDetails": { + "type": "object", + "description": "Details to restore an Oracle Autonomous Database.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time to restore the database to." + } + }, + "required": [ + "timestamp" + ] + }, + "RetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for backups.", + "minimum": 90, + "maximum": 2558 + }, + "RoleType": { + "type": "string", + "description": "Role type enum.", + "enum": [ + "Primary", + "Standby", + "DisabledStandby", + "BackupCopy", + "SnapshotStandby" + ], + "x-ms-enum": { + "name": "RoleType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary role" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Standby role" + }, + { + "name": "DisabledStandby", + "value": "DisabledStandby", + "description": "DisabledStandby role" + }, + { + "name": "BackupCopy", + "value": "BackupCopy", + "description": "BackupCopy role" + }, + { + "name": "SnapshotStandby", + "value": "SnapshotStandby", + "description": "SnapshotStandby role" + } + ] + } + }, + "SaasSubscriptionDetails": { + "type": "object", + "description": "SaaS Subscription Details model", + "properties": { + "id": { + "type": "string", + "description": "Purchased SaaS subscription ID", + "readOnly": true + }, + "subscriptionName": { + "type": "string", + "description": "SaaS subscription name", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Creation Date and Time", + "readOnly": true + }, + "offerId": { + "type": "string", + "description": "Purchased offer ID", + "readOnly": true + }, + "planId": { + "type": "string", + "description": "Purchased offer's plan ID", + "readOnly": true + }, + "saasSubscriptionStatus": { + "type": "string", + "description": "Indicates the status of the Subscription.", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Publisher ID", + "readOnly": true + }, + "purchaserEmailId": { + "type": "string", + "description": "Purchaser Email ID", + "readOnly": true + }, + "purchaserTenantId": { + "type": "string", + "description": "Purchaser Tenant ID", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Purchase Term Unit", + "readOnly": true + }, + "isAutoRenew": { + "type": "boolean", + "description": "AutoRenew flag", + "readOnly": true + }, + "isFreeTrial": { + "type": "boolean", + "description": "FreeTrial flag", + "readOnly": true + } + } + }, + "ScheduledOperationsType": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeek", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + }, + "required": [ + "dayOfWeek" + ] + }, + "ScheduledOperationsTypeUpdate": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeekUpdate", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + } + }, + "SessionModeType": { + "type": "string", + "description": "Session mode type enum.", + "enum": [ + "Direct", + "Redirect" + ], + "x-ms-enum": { + "name": "SessionModeType", + "modelAsString": true, + "values": [ + { + "name": "Direct", + "value": "Direct", + "description": "Direct session mode" + }, + { + "name": "Redirect", + "value": "Redirect", + "description": "Redirect session mode" + } + ] + } + }, + "SourceType": { + "type": "string", + "description": "Source type enum.", + "enum": [ + "None", + "Database", + "BackupFromId", + "BackupFromTimestamp", + "CloneToRefreshable", + "CrossRegionDataguard", + "CrossRegionDisasterRecovery" + ], + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None source" + }, + { + "name": "Database", + "value": "Database", + "description": "Database source" + }, + { + "name": "BackupFromId", + "value": "BackupFromId", + "description": "Backup from ID source" + }, + { + "name": "BackupFromTimestamp", + "value": "BackupFromTimestamp", + "description": "Backup from timestamp source" + }, + { + "name": "CloneToRefreshable", + "value": "CloneToRefreshable", + "description": "Clone to refreshable source" + }, + { + "name": "CrossRegionDataguard", + "value": "CrossRegionDataguard", + "description": "Cross region dataguard source" + }, + { + "name": "CrossRegionDisasterRecovery", + "value": "CrossRegionDisasterRecovery", + "description": "cross region disaster recovery source" + } + ] + } + }, + "SubnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "SyntaxFormatType": { + "type": "string", + "description": "Syntax format type enum.", + "enum": [ + "Long", + "Ezconnect", + "Ezconnectplus" + ], + "x-ms-enum": { + "name": "SyntaxFormatType", + "modelAsString": true, + "values": [ + { + "name": "Long", + "value": "Long", + "description": "Long format" + }, + { + "name": "Ezconnect", + "value": "Ezconnect", + "description": "Ezconnect format" + }, + { + "name": "Ezconnectplus", + "value": "Ezconnectplus", + "description": "Ezconnectplus format" + } + ] + } + }, + "SystemVersion": { + "type": "object", + "description": "SystemVersion resource Definition", + "properties": { + "properties": { + "$ref": "#/definitions/SystemVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SystemVersionListResult": { + "type": "object", + "description": "The response of a SystemVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SystemVersion items on this page", + "items": { + "$ref": "#/definitions/SystemVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SystemVersionProperties": { + "type": "object", + "description": "System Version Resource model", + "properties": { + "systemVersion": { + "type": "string", + "description": "A valid Oracle System Version", + "readOnly": true + } + } + }, + "SystemVersionsFilter": { + "type": "object", + "description": "SystemVersions filter", + "properties": { + "giVersion": { + "type": "string", + "description": "Grid Infrastructure version" + }, + "shape": { + "type": "string", + "description": "Exadata shape" + }, + "isLatestVersion": { + "type": "boolean", + "description": "Check If we have to list only latest versions" + } + }, + "required": [ + "giVersion", + "shape" + ] + }, + "TlsAuthenticationType": { + "type": "string", + "description": "TLS authentication type enum.", + "enum": [ + "Server", + "Mutual" + ], + "x-ms-enum": { + "name": "TlsAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "Server", + "value": "Server", + "description": "Server authentication" + }, + { + "name": "Mutual", + "value": "Mutual", + "description": "Mutual TLS" + } + ] + } + }, + "UpdateAction": { + "type": "string", + "description": "Update action enum", + "enum": [ + "RollingApply", + "NonRollingApply", + "PreCheck", + "RollBack" + ], + "x-ms-enum": { + "name": "UpdateAction", + "modelAsString": true, + "values": [ + { + "name": "RollingApply", + "value": "RollingApply", + "description": "Rolling apply action" + }, + { + "name": "NonRollingApply", + "value": "NonRollingApply", + "description": "Non rolling apply action" + }, + { + "name": "PreCheck", + "value": "PreCheck", + "description": "Pre-check action" + }, + { + "name": "RollBack", + "value": "RollBack", + "description": "Rollback action" + } + ] + } + }, + "ValidationError": { + "type": "object", + "description": "validation error", + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "required": [ + "code", + "message" + ] + }, + "ValidationResult": { + "type": "object", + "description": "validation result", + "properties": { + "status": { + "$ref": "#/definitions/ValidationStatus", + "description": "validation status" + }, + "error": { + "$ref": "#/definitions/ValidationError", + "description": "validation error" + } + }, + "required": [ + "status", + "error" + ] + }, + "ValidationStatus": { + "type": "string", + "description": "validation status", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Validation failed" + } + ] + }, + "readOnly": true + }, + "VirtualNetworkAddress": { + "type": "object", + "description": "Virtual IP resource belonging to a vm cluster resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkAddressProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualNetworkAddressLifecycleState": { + "type": "string", + "description": "VirtualNetworkAddressLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "VirtualNetworkAddressLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "VirtualNetworkAddressListResult": { + "type": "object", + "description": "The response of a VirtualNetworkAddress list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualNetworkAddress items on this page", + "items": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualNetworkAddressProperties": { + "type": "object", + "description": "virtualNetworkAddress resource properties", + "properties": { + "ipAddress": { + "type": "string", + "description": "Virtual network Address address.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmOcid": { + "$ref": "#/definitions/Ocid", + "description": "Virtual Machine OCID.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Application VIP OCID.", + "readOnly": true + }, + "domain": { + "type": "string", + "description": "Virtual network address fully qualified domain name.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state of the application virtual IP (VIP) address.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/VirtualNetworkAddressLifecycleState", + "description": "virtual network address lifecycle state.", + "readOnly": true + }, + "timeAssigned": { + "type": "string", + "format": "date-time", + "description": "The date and time when the create operation for the application virtual IP (VIP) address completed.", + "readOnly": true + } + } + }, + "VnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + } + }, + "WorkloadType": { + "type": "string", + "description": "WorkloadType enum", + "enum": [ + "OLTP", + "DW", + "AJD", + "APEX" + ], + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true, + "values": [ + { + "name": "OLTP", + "value": "OLTP", + "description": "OLTP - indicates an Autonomous Transaction Processing database" + }, + { + "name": "DW", + "value": "DW", + "description": "DW - indicates an Autonomous Data Warehouse database" + }, + { + "name": "AJD", + "value": "AJD", + "description": "AJD - indicates an Autonomous JSON Database" + }, + { + "name": "APEX", + "value": "APEX", + "description": "APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type." + } + ] + } + }, + "ZoneType": { + "type": "string", + "description": "Zone type enum", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "ZoneType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary zone" + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary zone" + } + ] + } + }, + "aclString": { + "type": "string", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "minLength": 1, + "maxLength": 1024 + } + }, + "parameters": {} +} diff --git a/specification/oracle/resource-manager/readme.md b/specification/oracle/resource-manager/readme.md index 56be976c7689..a51771bffeb7 100644 --- a/specification/oracle/resource-manager/readme.md +++ b/specification/oracle/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the Oracle.Database. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-09-01 +tag: package-2024-06-01 ``` ``` yaml @@ -53,6 +53,24 @@ input-file: - Oracle.Database/stable/2023-09-01/openapi.json ``` +### Tag: package-2024-06-01-preview + +These settings apply only when `--tag=package-2024-06-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-06-01-preview' +input-file: + - Oracle.Database/preview/2024-06-01-preview/openapi.json +``` + +### Tag: package-2024-06-01 + +These settings apply only when `--tag=package-2024-06-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-06-01' +input-file: + - Oracle.Database/stable/2024-06-01/openapi.json +``` + --- # Code Generation From 706526c01882406fc31889c2b77741d354cf9a2a Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Thu, 11 Jul 2024 13:40:51 -0700 Subject: [PATCH 311/343] [vmware] Add ".Management" suffix to TypeSpec folder name (#29748) --- .../examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json | 0 .../examples/2023-09-01/Addons_CreateOrUpdate_HCX.json | 0 .../examples/2023-09-01/Addons_CreateOrUpdate_SRM.json | 0 .../examples/2023-09-01/Addons_CreateOrUpdate_VR.json | 0 .../examples/2023-09-01/Addons_Delete.json | 0 .../examples/2023-09-01/Addons_Get_ArcReg.json | 0 .../examples/2023-09-01/Addons_Get_HCX.json | 0 .../examples/2023-09-01/Addons_Get_SRM.json | 0 .../examples/2023-09-01/Addons_Get_VR.json | 0 .../examples/2023-09-01/Addons_List.json | 0 .../examples/2023-09-01/Authorizations_CreateOrUpdate.json | 0 .../examples/2023-09-01/Authorizations_Delete.json | 0 .../examples/2023-09-01/Authorizations_Get.json | 0 .../examples/2023-09-01/Authorizations_List.json | 0 .../examples/2023-09-01/CloudLinks_CreateOrUpdate.json | 0 .../examples/2023-09-01/CloudLinks_Delete.json | 0 .../examples/2023-09-01/CloudLinks_Get.json | 0 .../examples/2023-09-01/CloudLinks_List.json | 0 .../examples/2023-09-01/Clusters_CreateOrUpdate.json | 0 .../examples/2023-09-01/Clusters_Delete.json | 0 .../examples/2023-09-01/Clusters_Get.json | 0 .../examples/2023-09-01/Clusters_List.json | 0 .../examples/2023-09-01/Clusters_ListZones.json | 0 .../examples/2023-09-01/Clusters_ListZones_Stretched.json | 0 .../examples/2023-09-01/Clusters_Update.json | 0 .../examples/2023-09-01/Datastores_CreateOrUpdate.json | 0 .../examples/2023-09-01/Datastores_Delete.json | 0 .../examples/2023-09-01/Datastores_Get.json | 0 .../examples/2023-09-01/Datastores_List.json | 0 .../2023-09-01/GlobalReachConnections_CreateOrUpdate.json | 0 .../examples/2023-09-01/GlobalReachConnections_Delete.json | 0 .../examples/2023-09-01/GlobalReachConnections_Get.json | 0 .../examples/2023-09-01/GlobalReachConnections_List.json | 0 .../examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json | 0 .../examples/2023-09-01/HcxEnterpriseSites_Delete.json | 0 .../examples/2023-09-01/HcxEnterpriseSites_Get.json | 0 .../examples/2023-09-01/HcxEnterpriseSites_List.json | 0 .../examples/2023-09-01/IscsiPaths_CreateOrUpdate.json | 0 .../examples/2023-09-01/IscsiPaths_Delete.json | 0 .../examples/2023-09-01/IscsiPaths_Get.json | 0 .../examples/2023-09-01/IscsiPaths_List.json | 0 .../examples/2023-09-01/Locations_CheckQuotaAvailability.json | 0 .../examples/2023-09-01/Locations_CheckTrialAvailability.json | 0 .../2023-09-01/Locations_CheckTrialAvailabilityWithSku.json | 0 .../examples/2023-09-01/Operations_List.json | 0 .../examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json | 0 .../examples/2023-09-01/PlacementPolicies_Delete.json | 0 .../examples/2023-09-01/PlacementPolicies_Get.json | 0 .../examples/2023-09-01/PlacementPolicies_List.json | 0 .../examples/2023-09-01/PlacementPolicies_Update.json | 0 .../examples/2023-09-01/PrivateClouds_CreateOrUpdate.json | 0 .../2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json | 0 .../examples/2023-09-01/PrivateClouds_Delete.json | 0 .../examples/2023-09-01/PrivateClouds_Get.json | 0 .../examples/2023-09-01/PrivateClouds_Get_Stretched.json | 0 .../examples/2023-09-01/PrivateClouds_List.json | 0 .../examples/2023-09-01/PrivateClouds_ListAdminCredentials.json | 0 .../examples/2023-09-01/PrivateClouds_ListInSubscription.json | 0 .../2023-09-01/PrivateClouds_ListInSubscription_Stretched.json | 0 .../examples/2023-09-01/PrivateClouds_List_Stretched.json | 0 .../examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json | 0 .../examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json | 0 .../examples/2023-09-01/PrivateClouds_Update.json | 0 .../examples/2023-09-01/PrivateClouds_Update_Stretched.json | 0 .../examples/2023-09-01/ScriptCmdlets_Get.json | 0 .../examples/2023-09-01/ScriptCmdlets_List.json | 0 .../examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json | 0 .../examples/2023-09-01/ScriptExecutions_Delete.json | 0 .../examples/2023-09-01/ScriptExecutions_Get.json | 0 .../examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json | 0 .../examples/2023-09-01/ScriptExecutions_List.json | 0 .../examples/2023-09-01/ScriptPackages_Get.json | 0 .../examples/2023-09-01/ScriptPackages_List.json | 0 .../examples/2023-09-01/VirtualMachines_Get.json | 0 .../examples/2023-09-01/VirtualMachines_List.json | 0 .../examples/2023-09-01/VirtualMachines_RestrictMovement.json | 0 .../examples/2023-09-01/WorkloadNetworks_CreateDhcp.json | 0 .../examples/2023-09-01/WorkloadNetworks_CreateDnsService.json | 0 .../examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json | 0 .../examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json | 0 .../examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json | 0 .../examples/2023-09-01/WorkloadNetworks_CreateSegments.json | 0 .../examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json | 0 .../examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json | 0 .../examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json | 0 .../examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json | 0 .../examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json | 0 .../examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json | 0 .../examples/2023-09-01/WorkloadNetworks_DeleteSegment.json | 0 .../examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json | 0 .../examples/2023-09-01/WorkloadNetworks_Get.json | 0 .../examples/2023-09-01/WorkloadNetworks_GetDhcp.json | 0 .../examples/2023-09-01/WorkloadNetworks_GetDnsService.json | 0 .../examples/2023-09-01/WorkloadNetworks_GetDnsZone.json | 0 .../examples/2023-09-01/WorkloadNetworks_GetGateway.json | 0 .../examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json | 0 .../examples/2023-09-01/WorkloadNetworks_GetPublicIP.json | 0 .../examples/2023-09-01/WorkloadNetworks_GetSegment.json | 0 .../examples/2023-09-01/WorkloadNetworks_GetVMGroup.json | 0 .../examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json | 0 .../examples/2023-09-01/WorkloadNetworks_List.json | 0 .../examples/2023-09-01/WorkloadNetworks_ListDhcp.json | 0 .../examples/2023-09-01/WorkloadNetworks_ListDnsServices.json | 0 .../examples/2023-09-01/WorkloadNetworks_ListDnsZones.json | 0 .../examples/2023-09-01/WorkloadNetworks_ListGateways.json | 0 .../examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json | 0 .../examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json | 0 .../examples/2023-09-01/WorkloadNetworks_ListSegments.json | 0 .../examples/2023-09-01/WorkloadNetworks_ListVMGroups.json | 0 .../examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json | 0 .../examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json | 0 .../examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json | 0 .../examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json | 0 .../examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json | 0 .../examples/2023-09-01/WorkloadNetworks_UpdateSegments.json | 0 .../examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json | 0 .../vmware/{Microsoft.AVS => Microsoft.AVS.Management}/main.tsp | 0 .../vmware/{Microsoft.AVS => Microsoft.AVS.Management}/models.tsp | 0 .../vmware/{Microsoft.AVS => Microsoft.AVS.Management}/routes.tsp | 0 .../{Microsoft.AVS => Microsoft.AVS.Management}/tspconfig.yaml | 0 120 files changed, 0 insertions(+), 0 deletions(-) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_CreateOrUpdate_HCX.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_CreateOrUpdate_SRM.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_CreateOrUpdate_VR.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_Get_ArcReg.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_Get_HCX.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_Get_SRM.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_Get_VR.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Addons_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Authorizations_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Authorizations_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Authorizations_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Authorizations_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/CloudLinks_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/CloudLinks_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/CloudLinks_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/CloudLinks_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Clusters_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Clusters_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Clusters_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Clusters_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Clusters_ListZones.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Clusters_ListZones_Stretched.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Clusters_Update.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Datastores_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Datastores_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Datastores_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Datastores_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/GlobalReachConnections_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/GlobalReachConnections_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/GlobalReachConnections_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/GlobalReachConnections_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/HcxEnterpriseSites_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/HcxEnterpriseSites_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/HcxEnterpriseSites_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/IscsiPaths_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/IscsiPaths_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/IscsiPaths_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/IscsiPaths_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Locations_CheckQuotaAvailability.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Locations_CheckTrialAvailability.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Locations_CheckTrialAvailabilityWithSku.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/Operations_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PlacementPolicies_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PlacementPolicies_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PlacementPolicies_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PlacementPolicies_Update.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_Get_Stretched.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_ListAdminCredentials.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_ListInSubscription.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_ListInSubscription_Stretched.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_List_Stretched.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_Update.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/PrivateClouds_Update_Stretched.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/ScriptCmdlets_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/ScriptCmdlets_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/ScriptExecutions_Delete.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/ScriptExecutions_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/ScriptExecutions_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/ScriptPackages_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/ScriptPackages_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/VirtualMachines_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/VirtualMachines_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/VirtualMachines_RestrictMovement.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_CreateDhcp.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_CreateDnsService.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_CreateSegments.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_DeleteSegment.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_Get.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_GetDhcp.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_GetDnsService.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_GetDnsZone.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_GetGateway.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_GetPublicIP.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_GetSegment.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_GetVMGroup.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_List.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_ListDhcp.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_ListDnsServices.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_ListDnsZones.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_ListGateways.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_ListSegments.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_ListVMGroups.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_UpdateSegments.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/main.tsp (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/models.tsp (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/routes.tsp (100%) rename specification/vmware/{Microsoft.AVS => Microsoft.AVS.Management}/tspconfig.yaml (100%) diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_HCX.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_HCX.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_HCX.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_HCX.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_SRM.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_SRM.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_SRM.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_SRM.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_VR.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_VR.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_VR.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_VR.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_ArcReg.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_ArcReg.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_ArcReg.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_ArcReg.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_HCX.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_HCX.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_HCX.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_HCX.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_SRM.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_SRM.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_SRM.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_SRM.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_VR.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_VR.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_VR.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_VR.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_ListZones.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_ListZones.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_ListZones.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_ListZones.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_ListZones_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_ListZones_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_ListZones_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_ListZones_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Update.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Update.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Update.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Update.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckQuotaAvailability.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckQuotaAvailability.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckQuotaAvailability.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckQuotaAvailability.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckTrialAvailability.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckTrialAvailability.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckTrialAvailability.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckTrialAvailability.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckTrialAvailabilityWithSku.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckTrialAvailabilityWithSku.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckTrialAvailabilityWithSku.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckTrialAvailabilityWithSku.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Operations_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Operations_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Operations_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Operations_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Update.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Update.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Update.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Update.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Get_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Get_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Get_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Get_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListAdminCredentials.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListAdminCredentials.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListAdminCredentials.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListAdminCredentials.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListInSubscription.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListInSubscription.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListInSubscription.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListInSubscription.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListInSubscription_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListInSubscription_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListInSubscription_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListInSubscription_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_List_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_List_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_List_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_List_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Update.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Update.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Update.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Update.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Update_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Update_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Update_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Update_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptCmdlets_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptCmdlets_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptCmdlets_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptCmdlets_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptCmdlets_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptCmdlets_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptCmdlets_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptCmdlets_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptPackages_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptPackages_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptPackages_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptPackages_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptPackages_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptPackages_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptPackages_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptPackages_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_RestrictMovement.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_RestrictMovement.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_RestrictMovement.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_RestrictMovement.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDnsService.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDnsService.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDnsService.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDnsService.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateSegments.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateSegments.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateSegments.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateSegments.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteSegment.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteSegment.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteSegment.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteSegment.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDnsService.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDnsService.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDnsService.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDnsService.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDnsZone.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDnsZone.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDnsZone.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDnsZone.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetGateway.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetGateway.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetGateway.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetGateway.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetPublicIP.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetPublicIP.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetPublicIP.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetPublicIP.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetSegment.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetSegment.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetSegment.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetSegment.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetVMGroup.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetVMGroup.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetVMGroup.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetVMGroup.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDnsServices.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDnsServices.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDnsServices.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDnsServices.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDnsZones.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDnsZones.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDnsZones.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDnsZones.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListGateways.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListGateways.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListGateways.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListGateways.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListSegments.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListSegments.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListSegments.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListSegments.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListVMGroups.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListVMGroups.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListVMGroups.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListVMGroups.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateSegments.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateSegments.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateSegments.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateSegments.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json diff --git a/specification/vmware/Microsoft.AVS/main.tsp b/specification/vmware/Microsoft.AVS.Management/main.tsp similarity index 100% rename from specification/vmware/Microsoft.AVS/main.tsp rename to specification/vmware/Microsoft.AVS.Management/main.tsp diff --git a/specification/vmware/Microsoft.AVS/models.tsp b/specification/vmware/Microsoft.AVS.Management/models.tsp similarity index 100% rename from specification/vmware/Microsoft.AVS/models.tsp rename to specification/vmware/Microsoft.AVS.Management/models.tsp diff --git a/specification/vmware/Microsoft.AVS/routes.tsp b/specification/vmware/Microsoft.AVS.Management/routes.tsp similarity index 100% rename from specification/vmware/Microsoft.AVS/routes.tsp rename to specification/vmware/Microsoft.AVS.Management/routes.tsp diff --git a/specification/vmware/Microsoft.AVS/tspconfig.yaml b/specification/vmware/Microsoft.AVS.Management/tspconfig.yaml similarity index 100% rename from specification/vmware/Microsoft.AVS/tspconfig.yaml rename to specification/vmware/Microsoft.AVS.Management/tspconfig.yaml From abb3908c7b4b2d37a63a36e13c82ef424a4eba54 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Thu, 11 Jul 2024 14:15:48 -0700 Subject: [PATCH 312/343] [Informatica.DataManagement] Add .Management suffix to TypeSpec folder name (#29738) --- .../client.tsp | 0 .../examples/2024-05-08/Operations_List_MaximumSet_Gen.json | 0 .../examples/2024-05-08/Operations_List_MinimumSet_Gen.json | 0 .../2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json | 0 .../2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json | 0 .../examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json | 0 .../examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json | 0 .../Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json | 0 .../Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json | 0 .../Organizations_GetServerlessMetadata_MaximumSet_Gen.json | 0 .../Organizations_GetServerlessMetadata_MinimumSet_Gen.json | 0 .../examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json | 0 .../examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json | 0 .../Organizations_ListByResourceGroup_MaximumSet_Gen.json | 0 .../Organizations_ListByResourceGroup_MinimumSet_Gen.json | 0 .../Organizations_ListBySubscription_MaximumSet_Gen.json | 0 .../Organizations_ListBySubscription_MinimumSet_Gen.json | 0 .../examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json | 0 .../examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json | 0 .../ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json | 0 .../ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json | 0 .../ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json | 0 .../ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json | 0 .../2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json | 0 .../2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json | 0 .../2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json | 0 ...imes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json | 0 .../ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json | 0 ...rlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json | 0 .../2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json | 0 .../2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json | 0 .../main.tsp | 0 .../tspconfig.yaml | 0 33 files changed, 0 insertions(+), 0 deletions(-) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/client.tsp (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Operations_List_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Operations_List_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_GetServerlessMetadata_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_GetServerlessMetadata_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_ListByResourceGroup_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_ListBySubscription_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/examples/2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/main.tsp (100%) rename specification/informatica/{Informatica.DataManagement => Informatica.DataManagement.Management}/tspconfig.yaml (100%) diff --git a/specification/informatica/Informatica.DataManagement/client.tsp b/specification/informatica/Informatica.DataManagement.Management/client.tsp similarity index 100% rename from specification/informatica/Informatica.DataManagement/client.tsp rename to specification/informatica/Informatica.DataManagement.Management/client.tsp diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Operations_List_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Operations_List_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Operations_List_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Operations_List_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Operations_List_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Operations_List_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Operations_List_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Operations_List_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetServerlessMetadata_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetServerlessMetadata_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetServerlessMetadata_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetServerlessMetadata_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetServerlessMetadata_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetServerlessMetadata_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetServerlessMetadata_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetServerlessMetadata_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListByResourceGroup_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListByResourceGroup_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListBySubscription_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListBySubscription_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/main.tsp b/specification/informatica/Informatica.DataManagement.Management/main.tsp similarity index 100% rename from specification/informatica/Informatica.DataManagement/main.tsp rename to specification/informatica/Informatica.DataManagement.Management/main.tsp diff --git a/specification/informatica/Informatica.DataManagement/tspconfig.yaml b/specification/informatica/Informatica.DataManagement.Management/tspconfig.yaml similarity index 100% rename from specification/informatica/Informatica.DataManagement/tspconfig.yaml rename to specification/informatica/Informatica.DataManagement.Management/tspconfig.yaml From 48bc190af82bb0a7daecd991ab837347ec66b6aa Mon Sep 17 00:00:00 2001 From: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Date: Thu, 11 Jul 2024 14:50:30 -0700 Subject: [PATCH 313/343] Fix acronym casing (#29797) * Fix acronym casing * tsp format --- .../propertyNameOverrideCsharp.tsp | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp index 5bb8dea15e6d..abea6683fbfb 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp @@ -193,6 +193,48 @@ using Microsoft.EventGrid.SystemEvents; "csharp" ); +@@clientName(EventGridMQTTClientCreatedOrUpdatedEventData, + "EventGridMqttClientCreatedOrUpdatedEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientDeletedEventData, + "EventGridMqttClientDeletedEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientSessionConnectedEventData, + "EventGridMqttClientSessionConnectedEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientSessionDisconnectedEventData, + "EventGridMqttClientSessionDisconnectedEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientEventData, + "EventGridMqttClientEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientState, "EventGridMqttClientState", "csharp"); + +@@clientName(EventGridMQTTClientDisconnectionReason, + "EventGridMqttClientDisconnectionReason", + "csharp" +); + +@@clientName(RedisImportRDBCompletedEventData, + "RedisImportRdbCompletedEventData", + "csharp" +); + +@@clientName(RedisExportRDBCompletedEventData, + "RedisExportRdbCompletedEventData", + "csharp" +); + @@clientName(AcsRouterWorkerSelector.state, "SelectorState", "csharp"); @@clientName(AcsRouterWorkerSelector.ttlSeconds, "TimeToLive", "csharp"); @@clientName(AcsRouterWorkerSelector.value, "labelValue", "csharp"); From eca9822bcbb8fb5f3a1012cb77ed61b2ae647e77 Mon Sep 17 00:00:00 2001 From: Chris Stackhouse Date: Thu, 11 Jul 2024 16:47:34 -0700 Subject: [PATCH 314/343] Add Typespec conversion option to intake template (#29616) * Add Typespec converstion option to intake template Intake form needs an option to indicate the author is converting swagger to Typespec. This change adds a checkbox for that option and indicates it should not be combined with adding a new API version. * Update control_plane_template.md Update text and add link to TypeSpec conversion docs per feedback. * Update control_plane_template.md * Update control_plane_template.md Update help link for TypeSpec conversion --------- Co-authored-by: Konrad Jamrozik --- .github/PULL_REQUEST_TEMPLATE/control_plane_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md index 60aba042de93..e1b7a2a97ffb 100644 --- a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md @@ -17,6 +17,7 @@ What's the purpose of this PR? Check the specific option that applies. This is * - [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to [OpenAPI specs PR creation guidance](https://aka.ms/azsdkdocs/createopenapispec)). - [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.) - [ ] Update existing version to fix OpenAPI spec quality issues in S360. + - [ ] Convert existing [OpenAPI spec to TypeSpec spec](https://aka.ms/typespec/conversion) (do not combine this with implementing changes for a new API version). - [ ] Other, please clarify: - _edit this with your clarification_ From abd5157cf12219dcd693b6d8edd5334281110af5 Mon Sep 17 00:00:00 2001 From: Kesem Sharabi <54834915+KesemSharabi@users.noreply.github.com> Date: Fri, 12 Jul 2024 06:02:27 +0300 Subject: [PATCH 315/343] Update powerbidedicated.json (#29322) Updated based on this doc bug: https://dev.azure.com/msft-skilling/Content/_workitems/edit/154565 --- .../stable/2017-10-01/powerbidedicated.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json b/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json index d71673d707bb..0492b227b712 100644 --- a/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json +++ b/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json @@ -86,7 +86,7 @@ } }, "put": { - "description": "Provisions the specified Dedicated capacity based on the configuration specified in the request.", + "description": "Provisions the specified dedicated capacity based on the configuration specified in the request. You can’t create a capacity with a name that’s used by another capacity in another tenant in the target location.", "x-ms-examples": { "Create capacity": { "$ref": "./examples/createCapacity.json" @@ -568,7 +568,7 @@ "Capacities" ], "operationId": "Capacities_CheckNameAvailability", - "description": "Check the name availability in the target location.", + "description": "Check the name availability in the target location. The name isn’t available if it’s used by another capacity in another tenant in the target location.", "parameters": [ { "name": "location", From 3bcdb0ee47bfa6bcc79036b4c9e5fe287701f796 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Fri, 12 Jul 2024 11:41:01 -0700 Subject: [PATCH 316/343] Add tsp-client to root package.json (#29803) - Allows devs to run `npx tsp-client` after `npm ci`, with no additional installs - Pins versions of `tsp-client` and its deps in the root package-lock.json - Fixes #29686 --- package-lock.json | 172 ++++++++++++++++++++++++++++++++++++++++++++++ package.json | 3 +- 2 files changed, 174 insertions(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index d944b3309f4a..d4cafb68ee5d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,6 +12,7 @@ "@azure-tools/typespec-azure-portal-core": "0.43.0", "@azure-tools/typespec-azure-resource-manager": "0.43.0", "@azure-tools/typespec-azure-rulesets": "0.43.0", + "@azure-tools/typespec-client-generator-cli": "0.9.2", "@azure-tools/typespec-client-generator-core": "0.43.0", "@azure/avocado": "^0.8.4", "@typespec/compiler": "0.57.0", @@ -581,6 +582,41 @@ "@typespec/compiler": "~0.57.0" } }, + "node_modules/@azure-tools/typespec-client-generator-cli": { + "version": "0.9.2", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-cli/-/typespec-client-generator-cli-0.9.2.tgz", + "integrity": "sha512-9Ycbmb2v7ISyp6SgadEyFZr02+Bm2GR2pFBqSIoOrxanQttHZ9BplzWZwXmH6IERgGg4/Wmb91z9hao6DljEAQ==", + "dev": true, + "dependencies": { + "@azure/core-rest-pipeline": "^1.12.0", + "chalk": "^5.3.0", + "dotenv": "^16.4.5", + "prompt-sync": "^4.2.0", + "simple-git": "^3.20.0", + "yaml": "^2.3.1" + }, + "bin": { + "tsp-client": "cmd/tsp-client.js" + }, + "engines": { + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": ">=0.48.1 <1.0.0" + } + }, + "node_modules/@azure-tools/typespec-client-generator-cli/node_modules/chalk": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", + "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", + "dev": true, + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, "node_modules/@azure-tools/typespec-client-generator-core": { "version": "0.43.0", "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.43.0.tgz", @@ -720,6 +756,62 @@ } } }, + "node_modules/@azure/core-rest-pipeline": { + "version": "1.16.2", + "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.16.2.tgz", + "integrity": "sha512-Hnhm/PG9/SQ07JJyLDv3l9Qr8V3xgAe1hFoBYzt6LaalMxfL/ZqFaZf/bz5VN3pMcleCPwl8ivlS2Fjxq/iC8Q==", + "dev": true, + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "@azure/core-auth": "^1.4.0", + "@azure/core-tracing": "^1.0.1", + "@azure/core-util": "^1.9.0", + "@azure/logger": "^1.0.0", + "http-proxy-agent": "^7.0.0", + "https-proxy-agent": "^7.0.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@azure/core-rest-pipeline/node_modules/@azure/abort-controller": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", + "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", + "dev": true, + "dependencies": { + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@azure/core-rest-pipeline/node_modules/@azure/core-tracing": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.1.2.tgz", + "integrity": "sha512-dawW9ifvWAWmUm9/h+/UQ2jrdvjCJ7VJEuCJ6XVNudzcOwm53BFZH4Q845vjfgoUAM8ZxokvVNxNxAITc502YA==", + "dev": true, + "dependencies": { + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@azure/core-rest-pipeline/node_modules/@azure/core-util": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.9.1.tgz", + "integrity": "sha512-OLsq0etbHO1MA7j6FouXFghuHrAFGk+5C1imcpQ2e+0oZhYF07WLA+NW2Vqs70R7d+zOAWiWM3tbE1sXcDN66g==", + "dev": true, + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=18.0.0" + } + }, "node_modules/@azure/core-tracing": { "version": "1.0.0-preview.13", "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.0.0-preview.13.tgz", @@ -2372,6 +2464,18 @@ "node": ">=0.4.0" } }, + "node_modules/agent-base": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.1.tgz", + "integrity": "sha512-H0TSyFNDMomMNJQBn8wFV5YC/2eJ+VXECwOadZJT554xP6cODZHPX3H9QMQECxvrgiSOP1pHjy1sMWQVYJOUOA==", + "dev": true, + "dependencies": { + "debug": "^4.3.4" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/ajv": { "version": "8.13.0", "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.13.0.tgz", @@ -2945,6 +3049,18 @@ "node": "*" } }, + "node_modules/dotenv": { + "version": "16.4.5", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.4.5.tgz", + "integrity": "sha512-ZmdL2rui+eB2YwhsWzjInR8LldtZHGDoQ1ugH85ppHKwpUHL7j7rN0Ti9NCnGiQbhaZ11FpR+7ao1dNsmduNUg==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://dotenvx.com" + } + }, "node_modules/ecc-jsbn": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", @@ -3579,6 +3695,19 @@ "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", "dev": true }, + "node_modules/http-proxy-agent": { + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz", + "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==", + "dev": true, + "dependencies": { + "agent-base": "^7.1.0", + "debug": "^4.3.4" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/http-reasons": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/http-reasons/-/http-reasons-0.1.0.tgz", @@ -3633,6 +3762,19 @@ "node": ">= 6.15.1" } }, + "node_modules/https-proxy-agent": { + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz", + "integrity": "sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==", + "dev": true, + "dependencies": { + "agent-base": "^7.0.2", + "debug": "4" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/human-signals": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-7.0.0.tgz", @@ -5130,6 +5272,36 @@ "node": ">= 0.6.0" } }, + "node_modules/prompt-sync": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/prompt-sync/-/prompt-sync-4.2.0.tgz", + "integrity": "sha512-BuEzzc5zptP5LsgV5MZETjDaKSWfchl5U9Luiu8SKp7iZWD5tZalOxvNcZRwv+d2phNFr8xlbxmFNcRKfJOzJw==", + "dev": true, + "dependencies": { + "strip-ansi": "^5.0.0" + } + }, + "node_modules/prompt-sync/node_modules/ansi-regex": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.1.tgz", + "integrity": "sha512-ILlv4k/3f6vfQ4OoP2AGvirOktlQ98ZEL1k9FaQjxa3L1abBgbuTDAdPOpvbGncC0BTVQrl+OM8xZGK6tWXt7g==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/prompt-sync/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, "node_modules/prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", diff --git a/package.json b/package.json index 2e9c0bdeb944..29fbf431bdd8 100644 --- a/package.json +++ b/package.json @@ -6,8 +6,9 @@ "@azure-tools/typespec-azure-core": "0.43.0", "@azure-tools/typespec-azure-portal-core": "0.43.0", "@azure-tools/typespec-azure-resource-manager": "0.43.0", - "@azure-tools/typespec-client-generator-core": "0.43.0", "@azure-tools/typespec-azure-rulesets": "0.43.0", + "@azure-tools/typespec-client-generator-cli": "0.9.2", + "@azure-tools/typespec-client-generator-core": "0.43.0", "@azure/avocado": "^0.8.4", "@typespec/compiler": "0.57.0", "@typespec/http": "0.57.0", From 1aa912658531534e4e57ea613591075f7b97897c Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Sat, 13 Jul 2024 01:19:34 +0200 Subject: [PATCH 317/343] Add 2024-05-15-preview of SpeechToText API (CognitiveServices) (#29804) * Add preview GA as base * Updates for new preview version * Update readme.md * Added required ttl to examples * Add description * Add missing example * Keep latest GA latest --- .../examples/commit_block_list.json | 27 + .../copy_model_with_authorization.json | 31 + .../create_container_transcription.json | 58 + .../create_copy_model_authorization.json | 24 + .../examples/create_dataset_with_blocks.json | 34 + .../create_dataset_with_content_url.json | 41 + .../examples/create_endpoint.json | 51 + .../examples/create_evaluation.json | 117 + .../examples/create_lid_transcription.json | 88 + .../examples/create_model.json | 66 + .../examples/create_model_with_weight.json | 71 + ...ultispeaker_diarization_transcription.json | 74 + .../examples/create_project.json | 30 + ...eate_simple_diarization_transcription.json | 62 + .../examples/create_uri_transcription.json | 59 + .../examples/create_web_hook.json | 46 + .../examples/delete_base_model_log.json | 14 + .../examples/delete_base_model_logs.json | 14 + .../examples/delete_dataset.json | 13 + .../examples/delete_endpoint.json | 13 + .../examples/delete_endpoint_log.json | 14 + .../examples/delete_endpoint_logs.json | 14 + .../examples/delete_evaluation.json | 13 + .../examples/delete_model.json | 13 + .../examples/delete_project.json | 13 + .../examples/delete_transcription.json | 13 + .../examples/delete_web_hook.json | 13 + .../examples/get_acoustic_datasets.json | 38 + .../examples/get_base_model.json | 45 + .../examples/get_base_model_log.json | 27 + .../examples/get_base_model_logs.json | 45 + .../examples/get_base_model_manifest.json | 54 + .../examples/get_dataset.json | 32 + .../examples/get_dataset_blocks.json | 29 + .../examples/get_dataset_file.json | 27 + .../examples/get_dataset_files.json | 46 + .../examples/get_dataset_report_files.json | 33 + .../examples/get_datasets.json | 57 + .../examples/get_endpoint.json | 38 + .../examples/get_endpoint_log.json | 27 + .../examples/get_endpoint_logs.json | 45 + .../examples/get_endpoints.json | 70 + .../examples/get_english_base_models.json | 51 + .../examples/get_evaluation.json | 101 + .../examples/get_evaluation_file.json | 27 + .../examples/get_evaluation_files.json | 45 + .../examples/get_evaluations.json | 195 + .../get_evaluations_with_status_running.json | 75 + .../examples/get_failed_transcriptions.json | 53 + .../examples/get_model.json | 51 + .../examples/get_model_file.json | 27 + .../examples/get_model_files.json | 34 + .../examples/get_model_manifest.json | 54 + .../examples/get_model_with_weight.json | 51 + .../examples/get_not_started_endpoints.json | 44 + .../examples/get_operation_copy_model.json | 23 + .../get_operation_copy_model_pending.json | 20 + .../examples/get_project.json | 26 + .../examples/get_project_datasets.json | 58 + .../examples/get_project_endpoints.json | 71 + .../examples/get_project_evaluations.json | 196 + .../examples/get_project_models.json | 97 + .../examples/get_project_transcriptions.json | 85 + .../examples/get_projects.json | 58 + .../get_projects_from_2018_and_2019.json | 59 + .../examples/get_running_models.json | 96 + .../get_supported_dataset_locales.json | 32 + .../get_supported_endpoint_locales.json | 16 + .../get_supported_evaluations_locales.json | 16 + .../examples/get_supported_model_locales.json | 16 + .../get_supported_project_locales.json | 16 + .../get_supported_transcription_locales.json | 23 + .../examples/get_transcription.json | 43 + .../examples/get_transcription_file.json | 27 + .../examples/get_transcription_files.json | 46 + ..._transcription_files_filtered_by_name.json | 33 + .../examples/get_transcriptions.json | 84 + .../examples/get_web_hook.json | 33 + .../examples/get_web_hooks.json | 60 + .../get_web_hooks_from_march_2020.json | 60 + .../examples/ping_web_hook.json | 13 + .../examples/test_web_hook.json | 16 + .../examples/transcribe_file.json | 38 + .../examples/update_dataset.json | 40 + .../examples/update_endpoint.json | 51 + .../examples/update_evaluation.json | 106 + .../examples/update_model.json | 59 + .../examples/update_project.json | 33 + .../examples/update_transcription.json | 51 + .../examples/update_web_hook.json | 51 + .../examples/upload_block.json | 15 + .../2024-05-15-preview/speechtotext.json | 7179 +++++++++++++++++ .../data-plane/Speech/SpeechToText/readme.md | 25 +- 93 files changed, 11417 insertions(+), 1 deletion(-) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/commit_block_list.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/copy_model_with_authorization.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_container_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_copy_model_authorization.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_blocks.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_content_url.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_lid_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model_with_weight.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_multispeaker_diarization_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_simple_diarization_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_uri_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_acoustic_datasets.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_manifest.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_blocks.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_report_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_datasets.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoints.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_english_base_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations_with_status_running.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_failed_transcriptions.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_manifest.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_with_weight.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_not_started_endpoints.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model_pending.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_datasets.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_endpoints.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_evaluations.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_transcriptions.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects_from_2018_and_2019.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_running_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_dataset_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_endpoint_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_evaluations_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_model_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_project_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_transcription_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files_filtered_by_name.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcriptions.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks_from_march_2020.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/ping_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/test_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/transcribe_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/upload_block.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/speechtotext.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/commit_block_list.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/commit_block_list.json new file mode 100644 index 000000000000..00d23c4a02a8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/commit_block_list.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "blockList": [ + { + "kind": "Uncommitted", + "id": "AAA=" + }, + { + "kind": "Uncommitted", + "id": "AAE=" + }, + { + "kind": "Uncommitted", + "id": "AAI=" + } + ] + }, + "responses": { + "200": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/copy_model_with_authorization.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/copy_model_with_authorization.json new file mode 100644 index 000000000000..d2d60144ecee --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/copy_model_with_authorization.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "modelCopyAuthorization": { + "targetResourceRegion": "westus2", + "targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName", + "targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/models?api-version=2024-05-15-preview", + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName", + "expirationDateTime": "2019-01-07T11:34:12Z", + "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b" + }, + "Content-Type": "application/json" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF?api-version=2024-05-15-preview", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "NotStarted", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_container_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_container_transcription.json new file mode 100644 index 000000000000..af95823b4214 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_container_transcription.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentContainerUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/audiofiles/", + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D" + }, + "locale": "en-US", + "displayName": "Transcription of storage container using default model for en-US" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_copy_model_authorization.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_copy_model_authorization.json new file mode 100644 index 000000000000..5fdf322b084b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_copy_model_authorization.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "modelCopyAuthorizationDefinition": { + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "targetResourceRegion": "westus2", + "targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName", + "targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/models?api-version=2024-05-15-preview", + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName", + "expirationDateTime": "2019-01-07T11:34:12Z", + "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_blocks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_blocks.json new file mode 100644 index 000000000000..0ddcf0da45c6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_blocks.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "dataset": { + "kind": "Acoustic", + "locale": "en-US", + "displayName": "My speech dataset name", + "description": "My speech dataset description" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/files?api-version=2024-05-15-preview", + "commitBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/blocks:commit?api-version=2024-05-15-preview", + "listBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/blocks?api-version=2024-05-15-preview", + "uploadBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/blocks?api-version=2024-05-15-preview" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_content_url.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_content_url.json new file mode 100644 index 000000000000..70e1ec609790 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_content_url.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "dataset": { + "kind": "Acoustic", + "contentUrl": "https://contoso.com/location", + "locale": "en-US", + "displayName": "My speech dataset name", + "description": "My speech dataset description" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_endpoint.json new file mode 100644 index 000000000000..ef20de32e487 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_endpoint.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "endpoint": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "properties": { + "loggingEnabled": true + }, + "locale": "en-US", + "displayName": "Speech endpoint definition", + "description": "This is a speech endpoint" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_evaluation.json new file mode 100644 index 000000000000..9295d8d65946 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_evaluation.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "evaluation": { + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "locale": "en-US", + "displayName": "My new evaluation", + "description": "The description of the evaluation" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_lid_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_lid_transcription.json new file mode 100644 index 000000000000..d7648b4cdb2c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_lid_transcription.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D", + "languageIdentification": { + "mode": "Single", + "candidateLocales": [ + "fr-FR", + "nl-NL", + "el-GR" + ], + "speechModelMapping": { + "nl-NL": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + } + } + } + }, + "locale": "fr-FR", + "displayName": "Transcription using language identification with three candidate languages, 'fr-FR' as fallback locale and a custom model for transcribing utterances that were classified as 'nl-NL' locale." + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D", + "languageIdentification": { + "mode": "Single", + "candidateLocales": [ + "fr-FR", + "nl-NL", + "el-GR" + ], + "speechModelMapping": { + "nl-NL": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + } + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "fr-FR", + "displayName": "Transcription using language identification with three candidate languages, 'fr-FR' as fallback locale and a custom model for transcribing utterances that were classified as 'nl-NL' locale.", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model.json new file mode 100644 index 000000000000..b405143d0c10 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "model": { + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "locale": "en-US", + "displayName": "Model with acoustic and language datasets" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model_with_weight.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model_with_weight.json new file mode 100644 index 000000000000..cd8e5e89aa6e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model_with_weight.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "model": { + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "properties": { + "customModelWeightPercent": 42 + }, + "locale": "en-US", + "displayName": "Model with acoustic and language datasets" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 42, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_multispeaker_diarization_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_multispeaker_diarization_transcription.json new file mode 100644 index 000000000000..dfa866cd350a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_multispeaker_diarization_transcription.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D", + "diarization": { + "speakers": { + "minCount": 3, + "maxCount": 5 + } + } + }, + "locale": "en-US", + "displayName": "Transcription using diarization for audio that is known to contain speech from 3-5 speakers" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D", + "diarization": { + "speakers": { + "minCount": 3, + "maxCount": 5 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using diarization for audio that is known to contain speech from 3-5 speakers", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_project.json new file mode 100644 index 000000000000..0b9163a1b064 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_project.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "project": { + "locale": "en-US", + "displayName": "My speech project" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_simple_diarization_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_simple_diarization_transcription.json new file mode 100644 index 000000000000..2b361a53245a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_simple_diarization_transcription.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D" + }, + "locale": "en-US", + "displayName": "Transcription using basic two-speaker diarization" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using basic two-speaker diarization", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_uri_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_uri_transcription.json new file mode 100644 index 000000000000..bde98d3572a3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_uri_transcription.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation", + "https://contoso.com/myotherstoragelocation" + ], + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D" + }, + "locale": "en-US", + "displayName": "Transcription using default model for en-US" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_web_hook.json new file mode 100644 index 000000000000..a659a5318140 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_web_hook.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "webHook": { + "displayName": "TranscriptionCompletionWebHook", + "properties": { + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription." + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-05-15-preview" + }, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "NotStarted" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_log.json new file mode 100644 index 000000000000..53c17dc2f5c9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_log.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "locale": "Acoustic", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_logs.json new file mode 100644 index 000000000000..c021d89b9c6f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_logs.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "locale": "Acoustic", + "endDate": "2019-01-01" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_dataset.json new file mode 100644 index 000000000000..49c0c55a3239 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_dataset.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint.json new file mode 100644 index 000000000000..bce9b23586c7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_log.json new file mode 100644 index 000000000000..a65662272748 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_log.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_logs.json new file mode 100644 index 000000000000..95172a3ab6b9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_logs.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endDate": "2019-01-01" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_evaluation.json new file mode 100644 index 000000000000..94a60fdb220c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_evaluation.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_model.json new file mode 100644 index 000000000000..de1d640a1c18 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_model.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_project.json new file mode 100644 index 000000000000..707d84f3e38c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_project.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_transcription.json new file mode 100644 index 000000000000..cedd7a357901 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_transcription.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_web_hook.json new file mode 100644 index 000000000000..d8d31c16d729 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_web_hook.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_acoustic_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_acoustic_datasets.json new file mode 100644 index 000000000000..c0e66a6e2c59 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_acoustic_datasets.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 10, + "filter": "kind%20eq%20'Acoustic'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model.json new file mode 100644 index 000000000000..b401a44b7abe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T00:00:00Z", + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": true, + "supportsTranscriptionsTranscribe": true, + "supportsAdaptationsWith": [ + "Language", + "Acoustic" + ], + "supportedOutputFormats": [ + "Display", + "Lexical" + ] + }, + "chargeForAdaptation": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_log.json new file mode 100644 index 000000000000..f089e53562a0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_log.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "locale": "Acoustic", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_logs.json new file mode 100644 index 000000000000..cfcd64bcfb28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_logs.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "locale": "Acoustic", + "sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/base/en-us/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_manifest.json new file mode 100644 index 000000000000..ef8ca901e0f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_manifest.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/02231df2-012f-45d4-9af0-8a3e4ccc877c?api-version=2024-05-15-preview" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset.json new file mode 100644 index 000000000000..1e20e8692c8d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_blocks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_blocks.json new file mode 100644 index 000000000000..cc6da66cabd6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_blocks.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "uncommittedBlocks": [ + { + "name": "AAA=", + "size": 123 + }, + { + "name": "AAE=", + "size": 234 + }, + { + "name": "AAI=", + "size": 345 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_file.json new file mode 100644 index 000000000000..c859f9d8320e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_files.json new file mode 100644 index 000000000000..552a39033c38 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_files.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/f035cf2d-4051-4131-85e7-97e3a7349c86?api-version=3.2", + "name": "language_data.txt", + "kind": "LanguageData", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_report_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_report_files.json new file mode 100644 index 000000000000..741febb04a8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_report_files.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 10, + "filter": "kind%20eq%20'DatasetReport'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_datasets.json new file mode 100644 index 000000000000..5274a36a5e6e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_datasets.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview", + "kind": "Language", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint.json new file mode 100644 index 000000000000..8c75cd382f0e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_log.json new file mode 100644 index 000000000000..39d496ab35fe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_log.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_logs.json new file mode 100644 index 000000000000..9ea3cf31a554 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_logs.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoints.json new file mode 100644 index 000000000000..c0d53eb87926 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoints.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_english_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_english_base_models.json new file mode 100644 index 000000000000..b64a8a24e947 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_english_base_models.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "locale%20eq%20'en-US'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T00:00:00Z", + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": true, + "supportsTranscriptionsTranscribe": true, + "supportsAdaptationsWith": [ + "Language", + "Acoustic" + ], + "supportedOutputFormats": [ + "Display", + "Lexical" + ] + }, + "chargeForAdaptation": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation.json new file mode 100644 index 000000000000..5427c38552e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_file.json new file mode 100644 index 000000000000..19e994381bd0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.model2_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_files.json new file mode 100644 index 000000000000..1f6a92654a21 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_files.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/8ad6c551-9d6e-43f7-9649-94680899e77a?api-version=3.2", + "name": "mywavefile1.wav.model1_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model1_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.model2_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations.json new file mode 100644 index 000000000000..68bfe7dc3950 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/a55a327b-c866-40b3-a08d-9c0945738633?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations_with_status_running.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations_with_status_running.json new file mode 100644 index 000000000000..ece2ab500746 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations_with_status_running.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/f85a328c-c866-40b3-a08d-9c0945738633?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.89, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "wordErrorRate2": 0.98, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_failed_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_failed_transcriptions.json new file mode 100644 index 000000000000..6c868e16eb8a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_failed_transcriptions.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Failed'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model.json new file mode 100644 index 000000000000..664bca28f1aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_file.json new file mode 100644 index 000000000000..e6171a0c9892 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "ModelReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_files.json new file mode 100644 index 000000000000..9e401dbebb6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_files.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "ModelReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_manifest.json new file mode 100644 index 000000000000..ef8ca901e0f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_manifest.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/02231df2-012f-45d4-9af0-8a3e4ccc877c?api-version=2024-05-15-preview" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_with_weight.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_with_weight.json new file mode 100644 index 000000000000..043f3e0c7672 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_with_weight.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 42, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_not_started_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_not_started_endpoints.json new file mode 100644 index 000000000000..aad5a685a3bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_not_started_endpoints.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'NotStarted'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model.json new file mode 100644 index 000000000000..3c4549dc69e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/e30f6a27-82be-4cca-9258-0399c70489ff?api-version=2024-05-15-preview", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "Succeeded", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff", + "result": { + "link": "https://westus.api.cognitive.microsoft.com/speechtotext/models/be640db7-c44b-47f2-bf6c-47e431d23d63?api-version=2024-05-15-preview" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model_pending.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model_pending.json new file mode 100644 index 000000000000..f8ca0c712939 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model_pending.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF?api-version=2024-05-15-preview", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "NotStarted", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project.json new file mode 100644 index 000000000000..058dc3554926 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_datasets.json new file mode 100644 index 000000000000..fa6392fe86f0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_datasets.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview", + "kind": "Language", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_endpoints.json new file mode 100644 index 000000000000..572dde67f24f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_endpoints.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_evaluations.json new file mode 100644 index 000000000000..ffae4c1862fd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_evaluations.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/a55a327b-c866-40b3-a08d-9c0945738633?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_models.json new file mode 100644 index 000000000000..2a9d18b00dbc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_models.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/models?skip=2&top=2&filter=status%20eq%20'Running'&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_transcriptions.json new file mode 100644 index 000000000000..f90e489fb53a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_transcriptions.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects.json new file mode 100644 index 000000000000..1290dbd56dce --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 3 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/projects?skip=3&top=3&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects_from_2018_and_2019.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects_from_2018_and_2019.json new file mode 100644 index 000000000000..f3a579e7ff7a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects_from_2018_and_2019.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 3, + "filter": "createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2018-03-03T12:45:27Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2018-12-19T17:54:57Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-02-01T00:45:27Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_running_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_running_models.json new file mode 100644 index 000000000000..8b9ea33fa89e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_running_models.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/models?skip=2&top=2&filter=status%20eq%20'Running'&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_dataset_locales.json new file mode 100644 index 000000000000..cb54a558a4f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_dataset_locales.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Acoustic": [ + "en-US", + "de-DE" + ], + "Language": [ + "en-US", + "de-DE" + ], + "Pronunciation": [ + "en-US" + ], + "AudioFiles": [ + "en-US", + "de-DE" + ], + "LanguageMarkdown": [ + "en-US" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_endpoint_locales.json new file mode 100644 index 000000000000..3cd62009d0a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_endpoint_locales.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_evaluations_locales.json new file mode 100644 index 000000000000..3cd62009d0a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_evaluations_locales.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_model_locales.json new file mode 100644 index 000000000000..3cd62009d0a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_model_locales.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_project_locales.json new file mode 100644 index 000000000000..3cd62009d0a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_project_locales.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_transcription_locales.json new file mode 100644 index 000000000000..6e26ea1d79d4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_transcription_locales.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Transcribe": [ + "en-US", + "de-DE" + ], + "Submit": [ + "en-US", + "de-DE", + "es-ES" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription.json new file mode 100644 index 000000000000..59397a438f0e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_file.json new file mode 100644 index 000000000000..575da6b81ca5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files.json new file mode 100644 index 000000000000..50c291161724 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef?api-version=3.2", + "name": "mywavefile2.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile2.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=2&top=2&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files_filtered_by_name.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files_filtered_by_name.json new file mode 100644 index 000000000000..c33851a9225c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files_filtered_by_name.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 10, + "filter": "name%20eq%20'mywavefile1.wav.json'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcriptions.json new file mode 100644 index 000000000000..e0d6cf8df7e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcriptions.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hook.json new file mode 100644 index 000000000000..07fc723cea53 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hook.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks.json new file mode 100644 index 000000000000..c4df85cdadd1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/aff13a6e-17c4-4247-862f-70e99469c553?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2019-02-11T00:00:00Z", + "lastActionDateTime": "2019-02-28T00:00:00Z", + "status": "Succeeded" + }, + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks_from_march_2020.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks_from_march_2020.json new file mode 100644 index 000000000000..d28d0b24e95a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks_from_march_2020.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "A test web hook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/aff13a6e-17c4-4247-862f-70e99469c553?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2020-03-11T14:13:12Z", + "lastActionDateTime": "2020-03-11T14:13:12Z", + "status": "Succeeded" + }, + { + "displayName": "Beta version web hook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2020-03-21T09:07:43Z", + "lastActionDateTime": "2020-03-21T09:07:43Z", + "status": "Succeeded" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/ping_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/ping_web_hook.json new file mode 100644 index 000000000000..9ab0f36f99f2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/ping_web_hook.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/test_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/test_web_hook.json new file mode 100644 index 000000000000..6d6b5ccaf4d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/test_web_hook.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/transcribe_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/transcribe_file.json new file mode 100644 index 000000000000..f7935ff37540 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/transcribe_file.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "multipart/form-data", + "definition": "{ \"locales\": \"en-US\"] }", + "audio": "{binary}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "duration": 2000, + "combinedPhrases": [ + { + "text": "Weather" + } + ], + "phrases": [ + { + "offset": 40, + "duration": 240, + "text": "Weather", + "words": [ + { + "text": "Weather", + "offset": 40, + "duration": 240 + } + ], + "locale": "en-US", + "confidence": 0.7881154 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_dataset.json new file mode 100644 index 000000000000..2bc5610f76ff --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_dataset.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "datasetUpdate": { + "displayName": "Updated dataset name", + "description": "Updated dataset description", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_endpoint.json new file mode 100644 index 000000000000..f23e8b879620 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_endpoint.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endpointUpdate": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "properties": { + "contentLoggingEnabled": true + }, + "displayName": "Updated endpoint with new model", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_evaluation.json new file mode 100644 index 000000000000..971b439c0e78 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_evaluation.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "evaluationUpdate": { + "displayName": "Updated evaluation", + "description": "Updated evaluation description" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_model.json new file mode 100644 index 000000000000..038b70171ba5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_model.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "modelUpdate": { + "displayName": "Language model update", + "description": "This is a language model update", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_project.json new file mode 100644 index 000000000000..49b1a6469e22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_project.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "projectUpdate": { + "displayName": "My updated speech project", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_transcription.json new file mode 100644 index 000000000000..41cbb221aa16 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_transcription.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "transcriptionUpdate": { + "displayName": "Updated transcription name", + "description": "Updated transcription description", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_web_hook.json new file mode 100644 index 000000000000..e5d63e5782f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_web_hook.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d", + "webHookUpdate": { + "properties": { + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "events": { + "evaluationCreation": true, + "evaluationProcessing": true, + "evaluationCompletion": true, + "evaluationDeletion": true + }, + "webUrl": "https://contoso.com/call/me/back", + "displayName": "TranscriptionCompletionWebHook", + "description": "I registered this URL to get a POST request for each completed transcription.", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/upload_block.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/upload_block.json new file mode 100644 index 000000000000..506ed695eec1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/upload_block.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "blockid": "AAE=", + "body": "{binary}" + }, + "responses": { + "201": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/speechtotext.json new file mode 100644 index 000000000000..908035a32fff --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/speechtotext.json @@ -0,0 +1,7179 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speech Services API version 2024-05-15-preview", + "description": "Speech Services API version 2024-05-15-preview.", + "contact": { + "name": "Cognitive Services - Speech Services", + "url": "https://learn.microsoft.com/azure/cognitive-services/speech-service/support" + }, + "version": "2024-05-15-preview" + }, + "paths": { + "/datasets/locales": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of supported locales for datasets.", + "operationId": "Datasets_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatasetLocales" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_dataset_locales.json" + } + } + } + }, + "/datasets": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of datasets for the authenticated subscription.", + "operationId": "Datasets_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available datasets.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n -Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z and displayName eq 'My dataset'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_datasets.json" + }, + "Get all acoustic datasets": { + "$ref": "./examples/get_acoustic_datasets.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads and creates a new dataset by getting the data from a specified URL or starts waiting for data blocks to be uploaded.", + "operationId": "Datasets_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "dataset", + "description": "Definition for the new dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/Dataset" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a dataset with content url": { + "$ref": "./examples/create_dataset_with_content_url.json" + }, + "Create dataset from data blocks": { + "$ref": "./examples/create_dataset_with_blocks.json" + } + } + } + }, + "/datasets/{id}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the dataset identified by the given ID.", + "operationId": "Datasets_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a dataset": { + "$ref": "./examples/get_dataset.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Updates the mutable details of the dataset identified by its ID.", + "operationId": "Datasets_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "datasetUpdate", + "description": "The updated values for the dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a dataset": { + "$ref": "./examples/update_dataset.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Deletes the specified dataset.", + "operationId": "Datasets_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The dataset was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a dataset": { + "$ref": "./examples/delete_dataset.json" + } + } + } + }, + "/datasets/{id}/blocks": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the list of uploaded blocks for this dataset.", + "operationId": "Datasets_GetBlocks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UploadedBlocks" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get uploaded blocks for dataset": { + "$ref": "./examples/get_dataset_blocks.json" + } + } + }, + "put": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Upload a block of data for the dataset. The maximum size of the block is 8MiB.", + "operationId": "Datasets_UploadBlock", + "consumes": [ + "application/octet-stream" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "blockid", + "description": "A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. Note that the Base64 string must be URL-encoded.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "The data block was uploaded successfully." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Upload a block for a dataset": { + "$ref": "./examples/upload_block.json" + } + } + } + }, + "/datasets/{id}/blocks:commit": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Commit block list to complete the upload of the dataset.", + "operationId": "Datasets_CommitBlocks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "blockList", + "description": "The list of blocks that compile the dataset.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CommitBlocksEntry" + } + } + } + ], + "responses": { + "200": { + "description": "The block list is accepted and the data import process can continue." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Commit uploaded blocks to dataset": { + "$ref": "./examples/commit_block_list.json" + } + } + } + }, + "/datasets/{id}/files": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the files of the dataset identified by the given ID.", + "operationId": "Datasets_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_dataset_files.json" + }, + "Get all dataset report files": { + "$ref": "./examples/get_dataset_report_files.json" + } + } + } + }, + "/datasets/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets one specific file (identified with fileId) from a dataset (identified with id).", + "operationId": "Datasets_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_dataset_file.json" + } + } + } + }, + "/endpoints/locales": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a list of supported locales for endpoint creations.", + "operationId": "Endpoints_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_endpoint_locales.json" + } + } + } + }, + "/endpoints": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoints for the authenticated subscription.", + "operationId": "Endpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available endpoints.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=locale eq 'en-US'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_endpoints.json" + }, + "Get all queued endpoints.": { + "$ref": "./examples/get_not_started_endpoints.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Creates a new endpoint.", + "operationId": "Endpoints_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "endpoint", + "description": "The details of the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create an endpoint": { + "$ref": "./examples/create_endpoint.json" + } + } + } + }, + "/endpoints/{id}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the endpoint identified by the given ID.", + "operationId": "Endpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get an endpoint": { + "$ref": "./examples/get_endpoint.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint identified by the given ID.", + "operationId": "Endpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The model endpoint was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete an endpoint": { + "$ref": "./examples/delete_endpoint.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Updates the metadata of the endpoint identified by the given ID.", + "operationId": "Endpoints_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "endpointUpdate", + "description": "The updated values for the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update an endpoint": { + "$ref": "./examples/update_endpoint.json" + } + } + } + }, + "/endpoints/{id}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored for a given endpoint.", + "operationId": "Endpoints_ListLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoint logs": { + "$ref": "./examples/get_endpoint_logs.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored for a given endpoint. It deletes all logs before (and including) a specific day.", + "description": "The deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "Endpoints_DeleteLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2023-03-15\" results in deleting all logs on March 15th, 2023 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete all endpoint logs": { + "$ref": "./examples/delete_endpoint_logs.json" + } + } + } + }, + "/endpoints/{id}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for a given endpoint.", + "operationId": "Endpoints_GetLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get an endpoint log": { + "$ref": "./examples/get_endpoint_log.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored for a given endpoint.", + "operationId": "Endpoints_DeleteLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete an endpoint log": { + "$ref": "./examples/delete_endpoint_log.json" + } + } + } + }, + "/endpoints/base/{locale}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored when using the default base model of a given language.", + "operationId": "Endpoints_ListBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all base model logs": { + "$ref": "./examples/get_base_model_logs.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored when using the default base model of a given language. It deletes all logs before (and including) a specific day.", + "description": "Deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "Endpoints_DeleteBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2023-03-15\" results in deleting all logs on March 15th, 2023 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete all base model logs": { + "$ref": "./examples/delete_base_model_logs.json" + } + } + } + }, + "/endpoints/base/{locale}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for the default base model in a given language.", + "operationId": "Endpoints_GetBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model log": { + "$ref": "./examples/get_base_model_log.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored when using the default base model of a given language.", + "operationId": "Endpoints_DeleteBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a base model log": { + "$ref": "./examples/delete_base_model_log.json" + } + } + } + }, + "/evaluations/locales": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets a list of supported locales for evaluations.", + "operationId": "Evaluations_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_evaluations_locales.json" + } + } + } + }, + "/evaluations": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the list of evaluations for the authenticated subscription.", + "operationId": "Evaluations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available evaluations.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'My evaluation'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all evaluations": { + "$ref": "./examples/get_evaluations.json" + }, + "Get all evaluations with where status is equal to 'Running'": { + "$ref": "./examples/get_evaluations_with_status_running.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Creates a new evaluation.", + "operationId": "Evaluations_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "evaluation", + "description": "The details of the new evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/Evaluation" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a evaluation": { + "$ref": "./examples/create_evaluation.json" + } + } + } + }, + "/evaluations/{id}/files": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the files of the evaluation identified by the given ID.", + "operationId": "Evaluations_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_evaluation_files.json" + } + } + } + }, + "/evaluations/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets one specific file (identified with fileId) from an evaluation (identified with id).", + "operationId": "Evaluations_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_evaluation_file.json" + } + } + } + }, + "/evaluations/{id}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the evaluation identified by the given ID.", + "operationId": "Evaluations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a evaluation": { + "$ref": "./examples/get_evaluation.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Updates the mutable details of the evaluation identified by its id.", + "operationId": "Evaluations_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "evaluationUpdate", + "description": "The object containing the updated fields of the evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/EvaluationUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a evaluation": { + "$ref": "./examples/update_evaluation.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Deletes the evaluation identified by the given ID.", + "operationId": "Evaluations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The evaluation was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a evaluation": { + "$ref": "./examples/delete_evaluation.json" + } + } + } + }, + "/models/locales": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets a list of supported locales for model adaptation.", + "operationId": "Models_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_model_locales.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of custom models for the authenticated subscription.", + "operationId": "Models_ListCustomModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedCustomModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all models in state 'Running'": { + "$ref": "./examples/get_running_models.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Creates a new model.", + "operationId": "Models_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "model", + "description": "The details of the new model.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomModel" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a model": { + "$ref": "./examples/create_model.json" + }, + "Create a model with custom model weight": { + "$ref": "./examples/create_model_with_weight.json" + } + } + } + }, + "/models/base": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of base models for the authenticated subscription.", + "operationId": "Models_ListBaseModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available base models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedBaseModels" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all english base models": { + "$ref": "./examples/get_english_base_models.json" + } + } + } + }, + "/models/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the model identified by the given ID.", + "operationId": "Models_GetCustomModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a model": { + "$ref": "./examples/get_model.json" + }, + "Get a model with custom model weight": { + "$ref": "./examples/get_model_with_weight.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Updates the metadata of the model identified by the given ID.", + "operationId": "Models_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "modelUpdate", + "description": "The updated values for the model.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a model": { + "$ref": "./examples/update_model.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Deletes the model identified by the given ID.", + "operationId": "Models_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The model was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a model": { + "$ref": "./examples/delete_model.json" + } + } + } + }, + "/models/base/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the base model identified by the given ID.", + "operationId": "Models_GetBaseModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the base model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseModel" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model": { + "$ref": "./examples/get_base_model.json" + } + } + } + }, + "/models/{id}:copy": { + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Copies a model from one subscription to another.", + "description": "This method can be used to copy a model from this speech resource to a target one.\r\nThe authorization is obtained on the target speech resource.\r\nOnly custom models can be copied to another speech resource.", + "operationId": "Models_Copy", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model that will be copied.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "modelCopyAuthorization", + "description": "The body contains the authorization to copy to the target speech resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCopyAuthorization" + } + } + ], + "responses": { + "202": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + }, + "Operation-Location": { + "description": "The location of the operation to track progress.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Copy a model from source resource to target resource": { + "$ref": "./examples/copy_model_with_authorization.json" + } + } + } + }, + "/models:authorizecopy": { + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Allows another speech resource (source) to copy a model to this speech resource (target).", + "description": "This method can be used to allow copying a model from another speech resource.\r\nOnly custom models can be copied from another speech resource.", + "operationId": "Models_AuthorizeCopy", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "modelCopyAuthorizationDefinition", + "description": "The body contains the Azure Resource ID of the source speech resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCopyAuthorizationDefinition" + } + } + ], + "responses": { + "200": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/ModelCopyAuthorization" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a copy model authorization on target resource": { + "$ref": "./examples/create_copy_model_authorization.json" + } + } + } + }, + "/models/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this model which can be used in an on-premise container.", + "operationId": "Models_GetCustomModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a model manifest": { + "$ref": "./examples/get_model_manifest.json" + } + } + } + }, + "/models/base/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this base model which can be used in an on-premise container.", + "operationId": "Models_GetBaseModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model manifest": { + "$ref": "./examples/get_base_model_manifest.json" + } + } + } + }, + "/models/{id}/files": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the files of the model identified by the given ID.", + "operationId": "Models_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_model_files.json" + } + } + } + }, + "/models/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets one specific file (identified with fileId) from a model (identified with id).", + "operationId": "Models_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_model_file.json" + } + } + } + }, + "/operations/models/copy/{id}": { + "get": { + "tags": [ + "Custom Speech operations:" + ], + "summary": "Gets the operation identified by the given ID.", + "operationId": "Operations_GetModelCopy", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the operation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Operation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get model copy operation pending": { + "$ref": "./examples/get_operation_copy_model_pending.json" + }, + "Get model copy operation": { + "$ref": "./examples/get_operation_copy_model.json" + } + } + } + }, + "/projects/locales": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of supported locales.", + "operationId": "Projects_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_project_locales.json" + } + } + } + }, + "/projects": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of projects for the authenticated subscription.", + "operationId": "Projects_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available projects.\r\n - Supported properties: displayName, description, createdDateTime, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'My test'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedProjects" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all projects": { + "$ref": "./examples/get_projects.json" + }, + "Get all projects created in 2018 or 2019": { + "$ref": "./examples/get_projects_from_2018_and_2019.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Creates a new project.", + "operationId": "Projects_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "project", + "description": "The details of the project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Project" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a project": { + "$ref": "./examples/create_project.json" + } + } + } + }, + "/projects/{id}": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the project identified by the given ID.", + "operationId": "Projects_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a project": { + "$ref": "./examples/get_project.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Updates the project identified by the given ID.", + "operationId": "Projects_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "projectUpdate", + "description": "The updated values for the project.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a project": { + "$ref": "./examples/update_project.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Deletes the project identified by the given ID.", + "operationId": "Projects_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The project was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a project": { + "$ref": "./examples/delete_project.json" + } + } + } + }, + "/projects/{id}/evaluations": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of evaluations for specified project.", + "operationId": "Projects_ListEvaluations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available evaluations.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example\r\n filter=displayName eq 'My evaluation'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all evaluations": { + "$ref": "./examples/get_project_evaluations.json" + } + } + } + }, + "/projects/{id}/datasets": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of datasets for specified project.", + "operationId": "Projects_ListDatasets", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available datasets.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_project_datasets.json" + } + } + } + }, + "/projects/{id}/endpoints": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of endpoints for specified project.", + "operationId": "Projects_ListEndpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available endpoints.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=locale eq 'en-US'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_project_endpoints.json" + } + } + } + }, + "/projects/{id}/models": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of models for specified project.", + "operationId": "Projects_ListModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedCustomModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all models": { + "$ref": "./examples/get_project_models.json" + } + } + } + }, + "/projects/{id}/transcriptions": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of transcriptions for specified project.", + "operationId": "Projects_ListTranscriptions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available transcriptions.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_project_transcriptions.json" + } + } + } + }, + "/transcriptions/locales": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of supported locales for offline transcriptions.", + "operationId": "Transcriptions_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TranscriptionLocales" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_transcription_locales.json" + } + } + } + }, + "/transcriptions": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of transcriptions for the authenticated subscription.", + "operationId": "Transcriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available transcriptions.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_transcriptions.json" + }, + "Get all failed transcriptions": { + "$ref": "./examples/get_failed_transcriptions.json" + } + } + } + }, + "/transcriptions/{id}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the transcription identified by the given ID.", + "operationId": "Transcriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a transcription": { + "$ref": "./examples/get_transcription.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Updates the mutable details of the transcription identified by its ID.", + "operationId": "Transcriptions_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "transcriptionUpdate", + "description": "The updated values for the transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/TranscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a transcription": { + "$ref": "./examples/update_transcription.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Deletes the specified transcription task.", + "operationId": "Transcriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The transcription was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a transcription": { + "$ref": "./examples/delete_transcription.json" + } + } + } + }, + "/transcriptions:submit": { + "post": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Submits a new transcription job.", + "operationId": "Transcriptions_Submit", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "transcription", + "description": "The details of the new transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/Transcription" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a transcription for URIs": { + "$ref": "./examples/create_uri_transcription.json" + }, + "Create a transcription with basic two-speaker diarization": { + "$ref": "./examples/create_simple_diarization_transcription.json" + }, + "Create a transcription with multispeaker diarization": { + "$ref": "./examples/create_multispeaker_diarization_transcription.json" + }, + "Create a transcription with language identification": { + "$ref": "./examples/create_lid_transcription.json" + }, + "Create a transcription from blob container": { + "$ref": "./examples/create_container_transcription.json" + } + } + } + }, + "/transcriptions/{id}/files": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the files of the transcription identified by the given ID.", + "operationId": "Transcriptions_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav.json' and kind eq 'Transcription'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_transcription_files.json" + }, + "Get all transcription files the name of which starts with the specified string": { + "$ref": "./examples/get_transcription_files_filtered_by_name.json" + } + } + } + }, + "/transcriptions/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets one specific file (identified with fileId) from a transcription (identified with id).", + "operationId": "Transcriptions_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_transcription_file.json" + } + } + } + }, + "/webhooks": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the list of web hooks for the authenticated subscription.", + "operationId": "WebHooks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available hooks.\r\n Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and webUrl.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'test'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebHooks" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all web hooks": { + "$ref": "./examples/get_web_hooks.json" + }, + "Get all web hooks created in 03/2020 ordered by their name": { + "$ref": "./examples/get_web_hooks_from_march_2020.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Creates a new web hook.", + "description": "If the property secret in the configuration is present and contains a non-empty string, it will be used to create a SHA256 hash of the payload with\r\nthe secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nWhen calling back into the registered URL, the request will contain a X-MicrosoftSpeechServices-Event header containing one of the registered event\r\ntypes. There will be one request per registered event type.\r\n \r\nAfter successfully registering the web hook, it will not be usable until a challenge/response is completed. To do this, a request with the event type\r\nchallenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken\r\nquery parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events.", + "operationId": "WebHooks_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "webHook", + "description": "The details of the new web hook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebHook" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a web hook": { + "$ref": "./examples/create_web_hook.json" + } + } + } + }, + "/webhooks/{id}": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the web hook identified by the given ID.", + "operationId": "WebHooks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a web hook": { + "$ref": "./examples/get_web_hook.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Updates the web hook identified by the given ID.", + "description": "If the property secret in the configuration is omitted or contains an empty string, future callbacks won't contain X-MicrosoftSpeechServices-Signature\r\nheaders. If the property contains a non-empty string, it will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash\r\nwill be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nIf the URL changes, the web hook will stop receiving events until a\r\nchallenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken.\r\nRespond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response\r\nis successfully completed, the web hook will begin receiving events.", + "operationId": "WebHooks_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "webHookUpdate", + "description": "The updated values for the web hook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebHookUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a web hook": { + "$ref": "./examples/update_web_hook.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Deletes the web hook identified by the given ID.", + "operationId": "WebHooks_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The web hook was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a web hook": { + "$ref": "./examples/delete_web_hook.json" + } + } + } + }, + "/webhooks/{id}:ping": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a ping event to the registered URL.", + "description": "The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook.\r\nThe Swagger Schema ID of the model is WebHookV3.\r\n \r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with\r\na secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "WebHooks_Ping", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "202": { + "description": "Started trying to send a ping request to the web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Ping a web hook": { + "$ref": "./examples/ping_web_hook.json" + } + } + } + }, + "/webhooks/{id}:test": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a request for each registered event type to the registered URL.", + "description": "The payload will be generated from the last entity that would have invoked the web hook. If no entity is present for none of the registered event types,\r\nthe POST will respond with 204. If a test request can be made, it will respond with 200.\r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type.\r\nIf the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "WebHooks_Test", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "202": { + "description": "A test request with the last entity is sent to the registered web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "No entity could be found for any event type, so no test request is sent to the registered web hook." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Test a web hook": { + "$ref": "./examples/test_web_hook.json" + } + } + } + }, + "/transcriptions:transcribe": { + "post": { + "tags": [ + "Transcribe" + ], + "summary": "Transcribes the provided audio stream.", + "operationId": "Transcribe", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "definition", + "description": "Metadata for a fast transcription request. This field contains a JSON-serialized object of type `TranscribeDefinition`.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "audio", + "description": "The audio as a stream of bytes.", + "required": true, + "type": "file", + "format": "binary" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TranscribeResult" + } + } + }, + "x-ms-examples": { + "Transcribe an audio file": { + "$ref": "./examples/transcribe_file.json" + } + } + } + } + }, + "definitions": { + "BaseModel": { + "title": "BaseModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModel" + } + ], + "properties": { + "links": { + "$ref": "#/definitions/BaseModelLinks" + }, + "properties": { + "$ref": "#/definitions/BaseModelProperties" + } + } + }, + "BaseModelDeprecationDates": { + "title": "BaseModelDeprecationDates", + "type": "object", + "properties": { + "adaptationDateTime": { + "format": "date-time", + "description": "The date when adaptation becomes deprecated.", + "type": "string", + "readOnly": true + }, + "transcriptionDateTime": { + "format": "date-time", + "description": "The date when transcription becomes deprecated.", + "type": "string", + "readOnly": true + } + } + }, + "BaseModelFeatures": { + "title": "BaseModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModelFeatures" + } + ], + "properties": { + "supportsAdaptationsWith": { + "description": "Supported dataset kinds to adapt the model.", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetKind" + }, + "readOnly": true + } + } + }, + "BaseModelLinks": { + "title": "BaseModelLinks", + "type": "object", + "properties": { + "manifest": { + "format": "uri", + "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", + "type": "string", + "readOnly": true + } + } + }, + "BaseModelProperties": { + "title": "BaseModelProperties", + "type": "object", + "properties": { + "deprecationDates": { + "$ref": "#/definitions/BaseModelDeprecationDates" + }, + "features": { + "$ref": "#/definitions/BaseModelFeatures" + }, + "chargeForAdaptation": { + "description": "A value indicating whether model adaptation is charged.", + "type": "boolean", + "readOnly": true + } + } + }, + "BlockKind": { + "title": "BlockKind", + "description": "Type of data block.", + "enum": [ + "Committed", + "Uncommitted", + "Latest" + ], + "type": "string", + "x-ms-enum": { + "name": "BlockKind", + "modelAsString": true, + "values": [ + { + "value": "Committed", + "description": "A data block from the committed block list." + }, + { + "value": "Uncommitted", + "description": "A data block from the uncommitted block list." + }, + { + "value": "Latest", + "description": "A data block from the uncommitted block list, if present, otherwise from the committed block list." + } + ] + } + }, + "CommitBlocksEntry": { + "title": "CommitBlocksEntry", + "description": "Entry of the commit block list.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/BlockKind" + }, + "id": { + "type": "string" + } + } + }, + "CustomModel": { + "title": "CustomModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModel" + } + ], + "properties": { + "links": { + "$ref": "#/definitions/CustomModelLinks" + }, + "properties": { + "$ref": "#/definitions/CustomModelProperties" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "text": { + "description": "The text used to adapt this language model.", + "type": "string" + }, + "baseModel": { + "$ref": "#/definitions/EntityReference" + }, + "datasets": { + "description": "Datasets used for adaptation.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityReference" + } + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CustomModelDeprecationDates": { + "title": "CustomModelDeprecationDates", + "type": "object", + "properties": { + "transcriptionDateTime": { + "format": "date-time", + "description": "The date when transcription becomes deprecated.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "CustomModelFeatures": { + "title": "CustomModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModelFeatures" + } + ], + "readOnly": true + }, + "CustomModelLinks": { + "title": "CustomModelLinks", + "type": "object", + "properties": { + "copy": { + "format": "uri", + "description": "The location to the model copy action. See operation \"Models_Copy\" for more details.", + "type": "string", + "readOnly": true + }, + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Models_ListFiles\" for more details.", + "type": "string", + "readOnly": true + }, + "manifest": { + "format": "uri", + "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "CustomModelProperties": { + "title": "CustomModelProperties", + "type": "object", + "properties": { + "customModelWeightPercent": { + "format": "int32", + "description": "The weight of custom model between 1 (1% custom model and 99% base model) and 100 (100% custom model and 0% base model).\r\nWhen this property is not set, the service chooses a suitable value (get the model to retrieve the selected weight).\r\nStart without using this property. If needed, choose a larger (or smaller) weight to increase (or decrease) the impact of the custom model.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "deprecationDates": { + "$ref": "#/definitions/CustomModelDeprecationDates" + }, + "features": { + "$ref": "#/definitions/CustomModelFeatures" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "Dataset": { + "title": "Dataset", + "required": [ + "displayName", + "kind", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/DatasetLinks" + }, + "properties": { + "$ref": "#/definitions/DatasetProperties" + }, + "kind": { + "$ref": "#/definitions/DatasetKind" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "contentUrl": { + "format": "uri", + "description": "The URL of the data for the dataset.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "DatasetKind": { + "title": "DatasetKind", + "description": "Type of data import.", + "enum": [ + "Language", + "Acoustic", + "Pronunciation", + "AudioFiles", + "LanguageMarkdown", + "OutputFormatting" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": true, + "values": [ + { + "value": "Language", + "description": "A language dataset." + }, + { + "value": "Acoustic", + "description": "An acoustic dataset." + }, + { + "value": "Pronunciation", + "description": "A pronunciation dataset." + }, + { + "value": "AudioFiles", + "description": "An audio files dataset." + }, + { + "value": "LanguageMarkdown", + "description": "A language markdown dataset." + }, + { + "value": "OutputFormatting", + "description": "Dataset that contains rules to customize inverse text normalization, capitalization, reformulation, profanity and also defines tests for dataset validation" + } + ] + } + }, + "DatasetLinks": { + "title": "DatasetLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Datasets_ListFiles\" for more details.", + "type": "string", + "readOnly": true + }, + "commitBlocks": { + "format": "uri", + "description": "The location to commit the list of blocks when uploading a dataset using blocks. See operation \"Datasets_CommitBlocks\" for more details.", + "type": "string", + "readOnly": true + }, + "listBlocks": { + "format": "uri", + "description": "The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation \"Datasets_GetBlocks\" for more details.", + "type": "string", + "readOnly": true + }, + "uploadBlocks": { + "format": "uri", + "description": "The location to upload blocks to when uploading a dataset using blocks. See operation \"Datasets_UploadBlock\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "DatasetLocales": { + "title": "DatasetLocales", + "type": "object", + "properties": { + "Language": { + "type": "array", + "items": { + "type": "string" + } + }, + "Acoustic": { + "type": "array", + "items": { + "type": "string" + } + }, + "Pronunciation": { + "type": "array", + "items": { + "type": "string" + } + }, + "AudioFiles": { + "type": "array", + "items": { + "type": "string" + } + }, + "LanguageMarkdown": { + "type": "array", + "items": { + "type": "string" + } + }, + "OutputFormatting": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DatasetProperties": { + "title": "DatasetProperties", + "type": "object", + "properties": { + "textNormalizationKind": { + "$ref": "#/definitions/TextNormalizationKind" + }, + "acceptedLineCount": { + "format": "int32", + "description": "The number of lines accepted for this data set.", + "type": "integer", + "readOnly": true + }, + "rejectedLineCount": { + "format": "int32", + "description": "The number of lines rejected for this data set.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "DatasetUpdate": { + "title": "DatasetUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "DetailedErrorCode": { + "title": "DetailedErrorCode", + "description": "Detailed error code enum.", + "enum": [ + "InvalidParameterValue", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputRecords", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "DataImportFailed", + "InUseViolation", + "InvalidLocale", + "InvalidBaseModel", + "InvalidAdaptationMapping", + "InvalidDataset", + "InvalidTest", + "FailedDataset", + "InvalidModel", + "InvalidTranscription", + "InvalidPayload", + "InvalidParameter", + "EndpointWithoutLogging", + "InvalidPermissions", + "InvalidPrerequisite", + "InvalidProductId", + "InvalidSubscription", + "InvalidProject", + "InvalidProjectKind", + "InvalidRecordingsUri", + "OnlyOneOfUrlsOrContainerOrDataset", + "ExceededNumberOfRecordingsUris", + "InvalidChannels", + "ModelMismatch", + "ProjectGenderMismatch", + "ModelDeprecated", + "ModelExists", + "ModelNotDeployable", + "EndpointNotUpdatable", + "SingleDefaultEndpoint", + "EndpointCannotBeDefault", + "InvalidModelUri", + "SubscriptionNotFound", + "QuotaViolation", + "UnsupportedDelta", + "UnsupportedFilter", + "UnsupportedPagination", + "UnsupportedDynamicConfiguration", + "UnsupportedOrderBy", + "NoUtf8WithBom", + "ModelDeploymentNotCompleteState", + "SkuLimitsExist", + "DeployingFailedModel", + "UnsupportedTimeRange", + "InvalidLogDate", + "InvalidLogId", + "InvalidLogStartTime", + "InvalidLogEndTime", + "InvalidTopForLogs", + "InvalidSkipTokenForLogs", + "DeleteNotAllowed", + "Forbidden", + "DeployNotAllowed", + "UnexpectedError", + "InvalidCollection", + "InvalidCallbackUri", + "InvalidSasValidityDuration", + "InaccessibleCustomerStorage", + "UnsupportedClassBasedAdaptation", + "InvalidWebHookEventKind", + "InvalidTimeToLive", + "InvalidSourceAzureResourceId", + "ModelCopyAuthorizationExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "DetailedErrorCode", + "modelAsString": true, + "values": [ + { + "value": "InvalidParameterValue", + "description": "Invalid parameter value." + }, + { + "value": "InvalidRequestBodyFormat", + "description": "Invalid request body format." + }, + { + "value": "EmptyRequest", + "description": "Empty Request." + }, + { + "value": "MissingInputRecords", + "description": "Missing Input Records." + }, + { + "value": "InvalidDocument", + "description": "Invalid Document." + }, + { + "value": "ModelVersionIncorrect", + "description": "Model Version Incorrect." + }, + { + "value": "InvalidDocumentBatch", + "description": "Invalid Document Batch." + }, + { + "value": "UnsupportedLanguageCode", + "description": "Unsupported language code." + }, + { + "value": "DataImportFailed", + "description": "Data import failed." + }, + { + "value": "InUseViolation", + "description": "In use violation." + }, + { + "value": "InvalidLocale", + "description": "Invalid locale." + }, + { + "value": "InvalidBaseModel", + "description": "Invalid base model." + }, + { + "value": "InvalidAdaptationMapping", + "description": "Invalid adaptation mapping." + }, + { + "value": "InvalidDataset", + "description": "Invalid dataset." + }, + { + "value": "InvalidTest", + "description": "Invalid test." + }, + { + "value": "FailedDataset", + "description": "Failed dataset." + }, + { + "value": "InvalidModel", + "description": "Invalid model." + }, + { + "value": "InvalidTranscription", + "description": "Invalid transcription." + }, + { + "value": "InvalidPayload", + "description": "Invalid payload." + }, + { + "value": "InvalidParameter", + "description": "Invalid parameter." + }, + { + "value": "EndpointWithoutLogging", + "description": "Endpoint without logging." + }, + { + "value": "InvalidPermissions", + "description": "Invalid permissions." + }, + { + "value": "InvalidPrerequisite", + "description": "Invalid prerequisite." + }, + { + "value": "InvalidProductId", + "description": "Invalid product id." + }, + { + "value": "InvalidSubscription", + "description": "Invalid subscription." + }, + { + "value": "InvalidProject", + "description": "Invalid project." + }, + { + "value": "InvalidProjectKind", + "description": "Invalid project kind." + }, + { + "value": "InvalidRecordingsUri", + "description": "Invalid recordings uri." + }, + { + "value": "OnlyOneOfUrlsOrContainerOrDataset", + "description": "Only one of urls or container or dataset." + }, + { + "value": "ExceededNumberOfRecordingsUris", + "description": "Exceeded number of recordings uris." + }, + { + "value": "InvalidChannels", + "description": "Invalid channels." + }, + { + "value": "ModelMismatch", + "description": "Model mismatch." + }, + { + "value": "ProjectGenderMismatch", + "description": "Project gender mismatch." + }, + { + "value": "ModelDeprecated", + "description": "Model deprecated." + }, + { + "value": "ModelExists", + "description": "Model exists." + }, + { + "value": "ModelNotDeployable", + "description": "Model not deployable." + }, + { + "value": "EndpointNotUpdatable", + "description": "Endpoint not updatable." + }, + { + "value": "SingleDefaultEndpoint", + "description": "Single default endpoint." + }, + { + "value": "EndpointCannotBeDefault", + "description": "Endpoint cannot be default." + }, + { + "value": "InvalidModelUri", + "description": "Invalid model uri." + }, + { + "value": "SubscriptionNotFound", + "description": "Subscription not found." + }, + { + "value": "QuotaViolation", + "description": "Quota violation." + }, + { + "value": "UnsupportedDelta", + "description": "Unsupported delta." + }, + { + "value": "UnsupportedFilter", + "description": "Unsupported filter." + }, + { + "value": "UnsupportedPagination", + "description": "Unsupported pagination." + }, + { + "value": "UnsupportedDynamicConfiguration", + "description": "Unsupported dynamic configuration." + }, + { + "value": "UnsupportedOrderBy", + "description": "Unsupported order by." + }, + { + "value": "NoUtf8WithBom", + "description": "No utf8 with bom." + }, + { + "value": "ModelDeploymentNotCompleteState", + "description": "Model deployment not complete state." + }, + { + "value": "SkuLimitsExist", + "description": "Sku limits exist." + }, + { + "value": "DeployingFailedModel", + "description": "Deploying failed model." + }, + { + "value": "UnsupportedTimeRange", + "description": "Unsupported time range." + }, + { + "value": "InvalidLogDate", + "description": "Invalid log date." + }, + { + "value": "InvalidLogId", + "description": "Invalid log id." + }, + { + "value": "InvalidLogStartTime", + "description": "Invalid log start time." + }, + { + "value": "InvalidLogEndTime", + "description": "Invalid log end time." + }, + { + "value": "InvalidTopForLogs", + "description": "Invalid top for logs." + }, + { + "value": "InvalidSkipTokenForLogs", + "description": "Invalid skip token for logs." + }, + { + "value": "DeleteNotAllowed", + "description": "Delete not allowed." + }, + { + "value": "Forbidden", + "description": "Forbidden." + }, + { + "value": "DeployNotAllowed", + "description": "Deploy not allowed." + }, + { + "value": "UnexpectedError", + "description": "Unexpected error." + }, + { + "value": "InvalidCollection", + "description": "Invalid collection." + }, + { + "value": "InvalidCallbackUri", + "description": "Invalid callback uri." + }, + { + "value": "InvalidSasValidityDuration", + "description": "Invalid sas validity duration." + }, + { + "value": "InaccessibleCustomerStorage", + "description": "Inaccessible customer storage." + }, + { + "value": "UnsupportedClassBasedAdaptation", + "description": "Unsupported class based adaptation." + }, + { + "value": "InvalidWebHookEventKind", + "description": "Invalid web hook event kind." + }, + { + "value": "InvalidTimeToLive", + "description": "Invalid time to live." + }, + { + "value": "InvalidSourceAzureResourceId", + "description": "Invalid source Azure resource ID." + }, + { + "value": "ModelCopyAuthorizationExpired", + "description": "Expired ModelCopyAuthorization." + } + ] + } + }, + "DiarizationProperties": { + "title": "DiarizationProperties", + "required": [ + "speakers" + ], + "type": "object", + "properties": { + "speakers": { + "$ref": "#/definitions/DiarizationSpeakersProperties" + } + } + }, + "DiarizationSpeakersProperties": { + "title": "DiarizationSpeakersProperties", + "type": "object", + "properties": { + "minCount": { + "format": "int32", + "description": "A hint for the minimum number of speakers for diarization. Must be smaller than or equal to the maxSpeakers property.", + "minimum": 1, + "type": "integer" + }, + "maxCount": { + "format": "int32", + "description": "The maximum number of speakers for diarization. Must be less than 36 and larger than or equal to the minSpeakers property.", + "minimum": 1, + "type": "integer" + } + } + }, + "EditsSummary": { + "title": "EditsSummary", + "type": "object", + "properties": { + "numberOfEdits": { + "format": "int32", + "description": "The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription.", + "type": "integer", + "readOnly": true + }, + "percentageOfAllEdits": { + "format": "double", + "description": "The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription.", + "type": "number", + "readOnly": true + } + }, + "readOnly": true + }, + "Endpoint": { + "title": "Endpoint", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/EndpointLinks" + }, + "properties": { + "$ref": "#/definitions/EndpointProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "text": { + "description": "The text used to adapt a language model for this endpoint.", + "type": "string" + }, + "model": { + "$ref": "#/definitions/EntityReference" + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EndpointLinks": { + "title": "EndpointLinks", + "type": "object", + "properties": { + "restInteractive": { + "format": "uri", + "description": "The REST endpoint for short requests up to 15 seconds.", + "type": "string", + "readOnly": true + }, + "restConversation": { + "format": "uri", + "description": "The REST endpoint for requests up to 60 seconds.", + "type": "string", + "readOnly": true + }, + "restDictation": { + "format": "uri", + "description": "The REST endpoint for requests up to 60 seconds, supporting dictation of punctuation marks.", + "type": "string", + "readOnly": true + }, + "webSocketInteractive": { + "format": "uri", + "description": "The Speech SDK endpoint for short requests up to 15 seconds with a single final result.", + "type": "string", + "readOnly": true + }, + "webSocketConversation": { + "format": "uri", + "description": "The Speech SDK endpoint for long requests with multiple final results.", + "type": "string", + "readOnly": true + }, + "webSocketDictation": { + "format": "uri", + "description": "The Speech SDK endpoint for long requests with multiple final results, supporting dictation of\r\npunctuation marks.", + "type": "string", + "readOnly": true + }, + "logs": { + "format": "uri", + "description": "The audio and transcription logs for this endpoint. See operation \"Endpoints_ListLogs\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EndpointProperties": { + "title": "EndpointProperties", + "type": "object", + "properties": { + "loggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", + "type": "boolean" + }, + "timeToLive": { + "description": "How long the endpoint will be kept in the system. Once the endpoint reaches the time to live\r\nafter completion (successful or failed) it will be automatically deleted. Not setting this value or setting\r\nto 0 will disable automatic deletion. The longest supported duration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "EndpointPropertiesUpdate": { + "title": "EndpointPropertiesUpdate", + "type": "object", + "properties": { + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions)\r\nis being used for a deployment.", + "type": "boolean" + } + } + }, + "EndpointUpdate": { + "title": "EndpointUpdate", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/EntityReference" + }, + "properties": { + "$ref": "#/definitions/EndpointPropertiesUpdate" + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EntityError": { + "title": "EntityError", + "type": "object", + "properties": { + "code": { + "description": "The code of this error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message for this error.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EntityReference": { + "title": "EntityReference", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "format": "uri", + "description": "The location of the referenced entity.", + "type": "string" + } + } + }, + "Error": { + "title": "Error", + "description": "New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains an outer error with error code, message, details, target and an inner error with more descriptive details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "High level error codes.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "NotFound", + "PipelineError", + "Conflict", + "InternalCommunicationFailed", + "Forbidden", + "NotAllowed", + "Unauthorized", + "UnsupportedMediaType", + "TooManyRequests", + "UnprocessableEntity" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "InvalidRequest", + "description": "Representing the invalid request error code." + }, + { + "value": "InvalidArgument", + "description": "Representing the invalid argument error code." + }, + { + "value": "InternalServerError", + "description": "Representing the internal server error error code." + }, + { + "value": "ServiceUnavailable", + "description": "Representing the service unavailable error code." + }, + { + "value": "NotFound", + "description": "Representing the not found error code." + }, + { + "value": "PipelineError", + "description": "Representing the pipeline error error code." + }, + { + "value": "Conflict", + "description": "Representing the conflict error code." + }, + { + "value": "InternalCommunicationFailed", + "description": "Representing the internal communication failed error code." + }, + { + "value": "Forbidden", + "description": "Representing the forbidden error code." + }, + { + "value": "NotAllowed", + "description": "Representing the not allowed error code." + }, + { + "value": "Unauthorized", + "description": "Representing the unauthorized error code." + }, + { + "value": "UnsupportedMediaType", + "description": "Representing the unsupported media type error code." + }, + { + "value": "TooManyRequests", + "description": "Representing the too many requests error code." + }, + { + "value": "UnprocessableEntity", + "description": "Representing the unprocessable entity error code." + } + ] + } + }, + "Evaluation": { + "title": "Evaluation", + "required": [ + "dataset", + "displayName", + "locale", + "model1", + "model2" + ], + "type": "object", + "properties": { + "model1": { + "$ref": "#/definitions/EntityReference" + }, + "model2": { + "$ref": "#/definitions/EntityReference" + }, + "transcription1": { + "$ref": "#/definitions/EntityReference" + }, + "transcription2": { + "$ref": "#/definitions/EntityReference" + }, + "dataset": { + "$ref": "#/definitions/EntityReference" + }, + "links": { + "$ref": "#/definitions/EvaluationLinks" + }, + "properties": { + "$ref": "#/definitions/EvaluationProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EvaluationLinks": { + "title": "EvaluationLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Evaluations_ListFiles\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EvaluationProperties": { + "title": "EvaluationProperties", + "type": "object", + "properties": { + "wordErrorRate1": { + "format": "double", + "description": "The word error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate1": { + "format": "double", + "description": "The sentence error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "tokenErrorRate1": { + "format": "double", + "description": "The optional token error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceCount1": { + "format": "int32", + "description": "The number of processed sentences by model1.", + "type": "integer", + "readOnly": true + }, + "wordCount1": { + "format": "int32", + "description": "The number of processed words by model1.", + "type": "integer", + "readOnly": true + }, + "correctWordCount1": { + "format": "int32", + "description": "The number of correctly recognized words by model1.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenCount1": { + "format": "int32", + "description": "The optional number of processed tokens by model1.", + "type": "integer", + "readOnly": true + }, + "correctTokenCount1": { + "format": "int32", + "description": "The optional number of correctly recognized tokens by model1.", + "type": "integer", + "readOnly": true + }, + "tokenSubstitutionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "tokenDeletionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are deletions.", + "type": "integer", + "readOnly": true + }, + "tokenInsertionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenErrors1": { + "$ref": "#/definitions/TokenErrorDetails" + }, + "wordErrorRate2": { + "format": "double", + "description": "The word error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate2": { + "format": "double", + "description": "The sentence error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "tokenErrorRate2": { + "format": "double", + "description": "The optional token error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "sentenceCount2": { + "format": "int32", + "description": "The number of processed sentences by model2.", + "type": "integer", + "readOnly": true + }, + "wordCount2": { + "format": "int32", + "description": "The number of processed words by model2.", + "type": "integer", + "readOnly": true + }, + "correctWordCount2": { + "format": "int32", + "description": "The number of correctly recognized words by model2.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenCount2": { + "format": "int32", + "description": "The optional number of processed tokens by model2.", + "type": "integer", + "readOnly": true + }, + "correctTokenCount2": { + "format": "int32", + "description": "The optional number of correctly recognized tokens by model2.", + "type": "integer", + "readOnly": true + }, + "tokenSubstitutionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "tokenDeletionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are deletions.", + "type": "integer", + "readOnly": true + }, + "tokenInsertionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenErrors2": { + "$ref": "#/definitions/TokenErrorDetails" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + }, + "readOnly": true + }, + "EvaluationUpdate": { + "title": "EvaluationUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "File": { + "title": "File", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/FileKind" + }, + "links": { + "$ref": "#/definitions/FileLinks" + }, + "createdDateTime": { + "format": "date-time", + "description": "The creation time of this file.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/FileProperties" + }, + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + } + } + }, + "FileKind": { + "title": "FileKind", + "description": "Type of data.", + "enum": [ + "DatasetReport", + "Audio", + "LanguageData", + "PronunciationData", + "AcousticDataArchive", + "AcousticDataTranscriptionV2", + "Transcription", + "TranscriptionReport", + "EvaluationDetails", + "ModelReport", + "OutputFormattingData" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileKind", + "modelAsString": true, + "values": [ + { + "value": "DatasetReport", + "description": "Type of data is dataset report." + }, + { + "value": "Audio", + "description": "Type of data is audio." + }, + { + "value": "LanguageData", + "description": "Type of data is language data." + }, + { + "value": "PronunciationData", + "description": "Type of data is pronunciation data." + }, + { + "value": "AcousticDataArchive", + "description": "Type of data is acoustic data archive." + }, + { + "value": "AcousticDataTranscriptionV2", + "description": "Type of data is acoustic data transcription v2." + }, + { + "value": "Transcription", + "description": "Type of data is transcription." + }, + { + "value": "TranscriptionReport", + "description": "Type of data is transcription report." + }, + { + "value": "EvaluationDetails", + "description": "Type of data is evaluation details." + }, + { + "value": "ModelReport", + "description": "Type of data is model report." + }, + { + "value": "OutputFormattingData", + "description": "Type of data is output formatting input file." + } + ] + } + }, + "FileLinks": { + "title": "FileLinks", + "type": "object", + "properties": { + "contentUrl": { + "format": "uri", + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "FileProperties": { + "title": "FileProperties", + "type": "object", + "properties": { + "size": { + "format": "int64", + "description": "The size of the data in bytes.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The duration in case this file is an audio file. The duration is encoded as ISO 8601\r\nduration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + } + } + }, + "InnerError": { + "title": "InnerError", + "description": "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/DetailedErrorCode" + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "$ref": "#/definitions/InnerError" + } + } + }, + "LanguageIdentificationMode": { + "title": "LanguageIdentificationMode", + "description": "The mode used for language identification.", + "default": "Continuous", + "enum": [ + "Continuous", + "Single" + ], + "type": "string", + "x-ms-enum": { + "name": "LanguageIdentificationMode", + "modelAsString": true, + "values": [ + { + "value": "Continuous", + "description": "Continuous language identification (Default)." + }, + { + "value": "Single", + "description": "Single language identification. If no language can be identified, the error code NoLanguageIdentified is returned to the user. If there is ambiguity between multiple languages, the error code MultipleLanguagesIdentified is returned to the user." + } + ] + } + }, + "LanguageIdentificationProperties": { + "title": "LanguageIdentificationProperties", + "required": [ + "candidateLocales" + ], + "type": "object", + "properties": { + "mode": { + "$ref": "#/definitions/LanguageIdentificationMode" + }, + "candidateLocales": { + "description": "The candidate locales for language identification (example [\"en-US\", \"de-DE\", \"es-ES\"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded.", + "type": "array", + "items": { + "type": "string" + } + }, + "speechModelMapping": { + "description": "An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used.\r\nKeys must be locales contained in the candidate locales, values are entities for models of the respective locales.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EntityReference" + } + } + } + }, + "ModelCopyAuthorization": { + "title": "ModelCopyAuthorization", + "required": [ + "expirationDateTime", + "id", + "sourceResourceId", + "targetResourceEndpoint", + "targetResourceId", + "targetResourceRegion" + ], + "type": "object", + "properties": { + "targetResourceRegion": { + "description": "The region (aka location) of the target speech resource (e.g., westus2).", + "minLength": 1, + "type": "string" + }, + "targetResourceId": { + "description": "The Azure Resource ID of the target speech resource.", + "minLength": 1, + "type": "string" + }, + "targetResourceEndpoint": { + "description": "The endpoint (base url) of the target resource (with custom domain name when it is used).", + "minLength": 1, + "type": "string" + }, + "sourceResourceId": { + "description": "The Azure Resource ID of the source speech resource.", + "minLength": 1, + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "The expiration date of this copy authorization.", + "type": "string" + }, + "id": { + "description": "The ID of this copy authorization.", + "minLength": 1, + "type": "string" + } + } + }, + "ModelCopyAuthorizationDefinition": { + "title": "ModelCopyAuthorizationDefinition", + "required": [ + "sourceResourceId" + ], + "type": "object", + "properties": { + "sourceResourceId": { + "description": "The Azure Resource ID of the source speech resource.", + "minLength": 1, + "type": "string" + } + } + }, + "ModelFile": { + "title": "ModelFile", + "type": "object", + "properties": { + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "contentUrl": { + "format": "uri", + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "ModelManifest": { + "title": "ModelManifest", + "required": [ + "model", + "modelFiles", + "properties" + ], + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/EntityReference" + }, + "modelFiles": { + "description": "The model files of this model.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelFile" + } + }, + "properties": { + "description": "The configuration for running this model in a container.", + "type": "object", + "additionalProperties": {} + } + } + }, + "ModelUpdate": { + "title": "ModelUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "Operation": { + "title": "Operation", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this Operation.", + "type": "string" + }, + "result": { + "$ref": "#/definitions/OperationResult" + }, + "error": { + "$ref": "#/definitions/EntityError" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "OperationResult": { + "title": "OperationResult", + "type": "object", + "properties": { + "link": { + "format": "uri", + "description": "The link to the result of the operation.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "OutputFormatType": { + "title": "OutputFormatType", + "enum": [ + "Lexical", + "Display" + ], + "type": "string", + "x-ms-enum": { + "name": "OutputFormatType", + "modelAsString": true, + "values": [ + { + "value": "Lexical", + "description": "Model provides the transcription output without formatting." + }, + { + "value": "Display", + "description": "Model supports display formatting transcriptions output or endpoints." + } + ] + } + }, + "PaginatedBaseModels": { + "title": "PaginatedBaseModels", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseModel" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedCustomModels": { + "title": "PaginatedCustomModels", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomModel" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedDatasets": { + "title": "PaginatedDatasets", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEndpoints": { + "title": "PaginatedEndpoints", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEvaluations": { + "title": "PaginatedEvaluations", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Evaluation" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedFiles": { + "title": "PaginatedFiles", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedProjects": { + "title": "PaginatedProjects", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedTranscriptions": { + "title": "PaginatedTranscriptions", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Transcription" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedWebHooks": { + "title": "PaginatedWebHooks", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/WebHook" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "ProfanityFilterMode": { + "title": "ProfanityFilterMode", + "description": "Mode of profanity filtering.", + "enum": [ + "None", + "Removed", + "Tags", + "Masked" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfanityFilterMode", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "Disable profanity filtering." + }, + { + "value": "Removed", + "description": "Remove profanity." + }, + { + "value": "Tags", + "description": "Add \"profanity\" XML tags</Profanity>" + }, + { + "value": "Masked", + "description": "Mask the profanity with * except of the first letter, e.g., f***" + } + ] + } + }, + "Project": { + "title": "Project", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/ProjectLinks" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "ProjectLinks": { + "title": "ProjectLinks", + "type": "object", + "properties": { + "evaluations": { + "format": "uri", + "description": "The location to get a list of all evaluations of this project. See operation \"Projects_ListEvaluations\" for more details.", + "type": "string", + "readOnly": true + }, + "datasets": { + "format": "uri", + "description": "The location to get a list of all datasets of this project. See operation \"Projects_ListDatasets\" for more details.", + "type": "string", + "readOnly": true + }, + "models": { + "format": "uri", + "description": "The location to get a list of all models of this project. See operation \"Projects_ListModels\" for more details.", + "type": "string", + "readOnly": true + }, + "endpoints": { + "format": "uri", + "description": "The location to get a list of all endpoints of this project. See operation \"Projects_ListEndpoints\" for more details.", + "type": "string", + "readOnly": true + }, + "transcriptions": { + "format": "uri", + "description": "The location to get a list of all transcriptions of this project. See operation \"Projects_ListTranscriptions\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "ProjectUpdate": { + "title": "ProjectUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PunctuationMode": { + "title": "PunctuationMode", + "description": "The mode used for punctuation.", + "enum": [ + "None", + "Dictated", + "Automatic", + "DictatedAndAutomatic" + ], + "type": "string", + "x-ms-enum": { + "name": "PunctuationMode", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "No punctuation." + }, + { + "value": "Dictated", + "description": "Dictated punctuation marks only, i.e., explicit punctuation." + }, + { + "value": "Automatic", + "description": "Automatic punctuation." + }, + { + "value": "DictatedAndAutomatic", + "description": "Dictated punctuation marks or automatic punctuation." + } + ] + } + }, + "ResponseBlock": { + "title": "ResponseBlock", + "description": "ResponseBlock.", + "type": "object", + "properties": { + "name": { + "description": "The name of the block.", + "type": "string" + }, + "size": { + "format": "int32", + "description": "The size of the block.", + "type": "integer" + } + } + }, + "SharedModel": { + "title": "SharedModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "SharedModelFeatures": { + "title": "SharedModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "properties": { + "supportsTranscriptionsSubmit": { + "description": "A value indicating whether submission of transcription jobs is supported (POST /transcriptions:submit).", + "type": "boolean", + "readOnly": true + }, + "supportsTranscriptionsTranscribe": { + "description": "A value indicating whether the transcribe action is supported (POST /transcriptions:transcribe).", + "type": "boolean", + "readOnly": true + }, + "supportsEndpoints": { + "description": "A value indicating whether creation of endpoints for live transcription is supported.", + "type": "boolean", + "readOnly": true + }, + "supportsTranscriptionsOnSpeechContainers": { + "description": "A value indicating whether this model can be used for transcription on speech container. This feature can be added on existing models when it becomes usable on speech container.", + "type": "boolean", + "readOnly": true + }, + "supportedOutputFormats": { + "description": "Supported output formats.", + "type": "array", + "items": { + "$ref": "#/definitions/OutputFormatType" + }, + "readOnly": true + } + } + }, + "Status": { + "title": "Status", + "description": "Describe the current state of the API.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false, + "values": [ + { + "value": "NotStarted", + "description": "The long running operation has not yet started." + }, + { + "value": "Running", + "description": "The long running operation is currently processing." + }, + { + "value": "Succeeded", + "description": "The long running operation has successfully completed." + }, + { + "value": "Failed", + "description": "The long running operation has failed." + } + ] + } + }, + "TextNormalizationKind": { + "title": "TextNormalizationKind", + "description": "The kind of text normalization.", + "enum": [ + "Default", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "TextNormalizationKind", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US)." + }, + { + "value": "None", + "description": "No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload." + } + ] + } + }, + "TokenErrorDetails": { + "title": "TokenErrorDetails", + "type": "object", + "properties": { + "punctuation": { + "$ref": "#/definitions/EditsSummary" + }, + "capitalization": { + "$ref": "#/definitions/EditsSummary" + }, + "inverseTextNormalization": { + "$ref": "#/definitions/EditsSummary" + }, + "lexical": { + "$ref": "#/definitions/EditsSummary" + }, + "others": { + "$ref": "#/definitions/EditsSummary" + } + }, + "readOnly": true + }, + "Transcription": { + "title": "Transcription", + "required": [ + "displayName", + "locale", + "properties" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/TranscriptionLinks" + }, + "properties": { + "$ref": "#/definitions/TranscriptionProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "model": { + "$ref": "#/definitions/EntityReference" + }, + "dataset": { + "$ref": "#/definitions/EntityReference" + }, + "contentUrls": { + "description": "A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response.", + "type": "array", + "items": { + "format": "uri", + "type": "string" + } + }, + "contentContainerUrl": { + "format": "uri", + "description": "A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs.\r\nThe maximum size for a blob is 2.5GB.\r\nContainer SAS should contain 'r' (read) and 'l' (list) permissions.\r\nThis property will not be returned in a response.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected.", + "minLength": 1, + "type": "string" + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "TranscriptionLinks": { + "title": "TranscriptionLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Transcriptions_ListFiles\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "TranscriptionLocales": { + "title": "TranscriptionLocales", + "type": "object", + "properties": { + "Transcribe": { + "type": "array", + "items": { + "type": "string" + } + }, + "Submit": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TranscriptionProperties": { + "title": "TranscriptionProperties", + "required": [ + "timeToLive" + ], + "type": "object", + "properties": { + "wordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps are requested. The default value is\r\n`false`.", + "type": "boolean" + }, + "displayFormWordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps for the display form are requested. The default value is `false`.", + "type": "boolean" + }, + "duration": { + "description": "The duration of the transcription. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "channels": { + "description": "A collection of the requested channel numbers.\r\nIn the default case, the channels 0 and 1 are considered.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "destinationContainerUrl": { + "format": "uri", + "description": "The requested destination container.\r\n### Remarks ###\r\nWhen a destination container is used in combination with a `timeToLive`, the metadata of a\r\ntranscription will be deleted normally, but the data stored in the destination container, including\r\ntranscription results, will remain untouched, because no delete permissions are required for this\r\ncontainer.\n\r\nTo support automatic cleanup, either configure blob lifetimes on the container, or use \"Bring your own Storage (BYOS)\"\r\ninstead of `destinationContainerUrl`, where blobs can be cleaned up.", + "type": "string" + }, + "punctuationMode": { + "$ref": "#/definitions/PunctuationMode" + }, + "profanityFilterMode": { + "$ref": "#/definitions/ProfanityFilterMode" + }, + "timeToLive": { + "description": "How long the transcription will be kept in the system after it has completed. Once the\r\ntranscription reaches the time to live after completion (successful or failed) it will be automatically\r\ndeleted.\r\n \r\nNote: When using BYOS (bring your own storage), the result files on the customer owned storage account\r\nwill also be deleted. Use either destinationContainerUrl to specify a separate container for result files\r\nwhich will not be deleted when the timeToLive expires, or retrieve the result files through the API and\r\nstore them as needed.\r\n \r\nThe shortest supported duration is 6h, the longest supported duration is 31 days. 2 days (\"P2D\") is the recommended default value\r\nwhen data is consumed directly.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + }, + "diarizationEnabled": { + "description": "A value indicating whether diarization (speaker identification) is requested. The default value\r\nis `false`.\r\nIf this field is set to true and the improved diarization system is configured by specifying\r\n`DiarizationProperties`, the improved diarization system will provide diarization for a configurable\r\nrange of speakers.\r\nIf this field is set to true and the improved diarization system is not enabled (not specifying\r\n`DiarizationProperties`), the basic diarization system will distinguish between up to two speakers.\r\nNo extra charges are applied for the basic diarization.\r\n \r\nThe basic diarization system is deprecated and will be removed in the next major version of the API.\r\nThis `diarizationEnabled` setting will also be removed.", + "type": "boolean" + }, + "diarization": { + "$ref": "#/definitions/DiarizationProperties" + }, + "languageIdentification": { + "$ref": "#/definitions/LanguageIdentificationProperties" + } + } + }, + "TranscriptionUpdate": { + "title": "TranscriptionUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "UploadedBlocks": { + "title": "UploadedBlocks", + "description": "List of uploaded blocks.", + "type": "object", + "properties": { + "committedBlocks": { + "description": "The block description of blocks already committed.", + "type": "array", + "items": { + "$ref": "#/definitions/ResponseBlock" + } + }, + "uncommittedBlocks": { + "description": "The block description of blocks not committed to the blob.", + "type": "array", + "items": { + "$ref": "#/definitions/ResponseBlock" + } + } + } + }, + "WebHook": { + "title": "WebHook", + "required": [ + "displayName", + "events", + "webUrl" + ], + "type": "object", + "properties": { + "webUrl": { + "format": "uri", + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "links": { + "$ref": "#/definitions/WebHookLinks" + }, + "properties": { + "$ref": "#/definitions/WebHookProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "events": { + "$ref": "#/definitions/WebHookEvents" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WebHookEvents": { + "title": "WebHookEvents", + "type": "object", + "properties": { + "datasetCreation": { + "type": "boolean" + }, + "datasetProcessing": { + "type": "boolean" + }, + "datasetCompletion": { + "type": "boolean" + }, + "datasetDeletion": { + "type": "boolean" + }, + "modelCreation": { + "type": "boolean" + }, + "modelProcessing": { + "type": "boolean" + }, + "modelCompletion": { + "type": "boolean" + }, + "modelDeletion": { + "type": "boolean" + }, + "evaluationCreation": { + "type": "boolean" + }, + "evaluationProcessing": { + "type": "boolean" + }, + "evaluationCompletion": { + "type": "boolean" + }, + "evaluationDeletion": { + "type": "boolean" + }, + "transcriptionCreation": { + "type": "boolean" + }, + "transcriptionProcessing": { + "type": "boolean" + }, + "transcriptionCompletion": { + "type": "boolean" + }, + "transcriptionDeletion": { + "type": "boolean" + }, + "endpointCreation": { + "type": "boolean" + }, + "endpointProcessing": { + "type": "boolean" + }, + "endpointCompletion": { + "type": "boolean" + }, + "endpointDeletion": { + "type": "boolean" + }, + "ping": { + "type": "boolean" + }, + "challenge": { + "type": "boolean" + } + } + }, + "WebHookLinks": { + "title": "WebHookLinks", + "type": "object", + "properties": { + "ping": { + "format": "uri", + "description": "The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation \"WebHooks_Ping\" for more details.", + "type": "string", + "readOnly": true + }, + "test": { + "format": "uri", + "description": "The URL that can be used sending test events to the registered URL of a web hook registration. See operation \"WebHooks_Test\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "WebHookProperties": { + "title": "WebHookProperties", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/EntityError" + }, + "apiVersion": { + "description": "The API version the web hook was created in. This defines the shape of the payload in the callbacks.\r\nIf the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation),\r\nthe web hook will be disabled.", + "type": "string", + "readOnly": true + }, + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookPropertiesUpdate": { + "title": "WebHookPropertiesUpdate", + "type": "object", + "properties": { + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookUpdate": { + "title": "WebHookUpdate", + "type": "object", + "properties": { + "webUrl": { + "format": "uri", + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/WebHookPropertiesUpdate" + }, + "events": { + "$ref": "#/definitions/WebHookEvents" + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CombinedPhrases": { + "required": [ + "text" + ], + "type": "object", + "properties": { + "channel": { + "format": "int32", + "description": "The 0-based channel index. Only present if channel separation is enabled.", + "type": "integer" + }, + "text": { + "description": "The complete transcribed text for the channel.", + "type": "string" + } + } + }, + "Phrase": { + "description": "A transcribed phrase.", + "required": [ + "confidence", + "duration", + "offset", + "text" + ], + "type": "object", + "properties": { + "channel": { + "format": "int32", + "description": "The 0-based channel index. Only present if channel separation is enabled.", + "type": "integer" + }, + "speaker": { + "format": "int32", + "description": "The speaker number. Only present if speaker diarization is enabled.", + "type": "integer" + }, + "offset": { + "format": "int64", + "description": "The start offset of the phrase in milliseconds.", + "type": "integer" + }, + "duration": { + "format": "int64", + "description": "The duration of the phrase in milliseconds.", + "type": "integer" + }, + "text": { + "description": "The transcribed text of the phrase.", + "type": "string" + }, + "words": { + "description": "The words that make up the phrase. Only present if word-level timestamps are enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/Word" + } + }, + "locale": { + "description": "The locale of the phrase.", + "type": "string" + }, + "confidence": { + "format": "float", + "description": "The confidence value for the phrase.", + "type": "number" + } + } + }, + "TranscribeDefinition": { + "description": "Metadata for a fast transcription request.", + "type": "object", + "properties": { + "locales": { + "description": "The input locales. Currently, only one locale is supported.", + "type": "array", + "items": { + "type": "string" + } + }, + "models": { + "description": "Maps some or all candidate locales to a model URI to be used for transcription. If no mapping is given, the default model for the locale is used.", + "type": "object", + "additionalProperties": { + "format": "uri", + "type": "string" + } + }, + "profanityFilterMode": { + "$ref": "#/definitions/ProfanityFilterMode" + }, + "channels": { + "description": "The 0-based indices of the channels to be transcribed separately. If not specified, multiple channels are merged and transcribed jointly. Only up to two channels are supported.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + } + }, + "TranscribeResult": { + "description": "The result of the transcribe operation.", + "required": [ + "combinedPhrases", + "duration", + "phrases" + ], + "type": "object", + "properties": { + "duration": { + "format": "int64", + "description": "The duration of the audio in milliseconds.", + "type": "integer" + }, + "combinedPhrases": { + "description": "The combined transcription results for each channel.", + "type": "array", + "items": { + "$ref": "#/definitions/CombinedPhrases" + } + }, + "phrases": { + "description": "The transcription results segmented into phrases.", + "type": "array", + "items": { + "$ref": "#/definitions/Phrase" + } + } + } + }, + "Word": { + "description": "Time-stamped word in the display form.", + "required": [ + "duration", + "offset", + "text" + ], + "type": "object", + "properties": { + "text": { + "description": "The recognized word, including punctuation.", + "type": "string" + }, + "offset": { + "format": "int64", + "description": "The start offset of the word in milliseconds.", + "type": "integer" + }, + "duration": { + "format": "int64", + "description": "The duration of the word in milliseconds.", + "type": "integer" + } + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "apiVersionQueryParameter": { + "in": "query", + "name": "api-version", + "description": "The requested api version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "skipQueryParameter": { + "in": "query", + "name": "skip", + "description": "Number of datasets that will be skipped.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "topQueryParameter": { + "in": "query", + "name": "top", + "description": "Number of datasets that will be included after skipping.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "sasValidityQueryParameter": { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): A value of 0 means that a plain blob URI without SAS token will be generated.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "api_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services account key here." + }, + "token": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement" + } + }, + "security": [ + { + "api_key": [] + }, + { + "token": [] + } + ], + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/speechtotext/", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md index 880ec988957b..883049a017dc 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -162,4 +162,27 @@ directive: reason: There is a sub-route called /models/base/ that refers to the base models. Therefore, the correct operation ID seems to be "Models_GetBaseModel", for example. - suppress: HostParametersValidation reason: Existing API, change would potentially be breaking. -``` \ No newline at end of file +``` + +## Tag: release_2024_05_15_preview + +These settings apply only when `--tag=release_2024_05_15_preview` is specified on the command line. + +```yaml $(tag) == 'release_2024_05_15_preview' +input-file: + - preview/2024-05-15-preview/speechtotext.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: LongRunningOperationsWithLongRunningExtension + reason: Does not apply in those two places. The method is a DELETE which lazily deletes blobs, so it's Accepted, not NoContent. + - suppress: OperationIdNounVerb + where: $..paths[($..operationId["Models_*"])] + reason: There is a sub-route called /models/base/ that refers to the base models. Therefore, the correct operation ID seems to be "Models_GetBaseModel", for example. + - suppress: HostParametersValidation + reason: Existing API, change would potentially be breaking. +``` From 52b7554377a307536bc68d7746a1f375b09f70c7 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 15 Jul 2024 14:22:11 -0700 Subject: [PATCH 318/343] Add `model` to text and image embedding clients --- .../GetChatCompletions_MaximumSet_Gen.json | 30 +++--- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++-- .../GetEmbeddings_MaximumSet_Gen.json | 21 +++-- .../GetEmbeddings_MinimumSet_Gen.json | 14 +-- .../GetImageEmbeddings_MaximumSet_Gen.json | 23 ++--- .../GetImageEmbeddings_MinimumSet_Gen.json | 14 +-- .../GetModelInfo_MaximumSet_Gen.json | 4 +- .../GetModelInfo_MinimumSet_Gen.json | 4 +- .../ModelClient/models/chat_completions.tsp | 1 - .../ai/ModelClient/models/embeddings.tsp | 5 + .../ModelClient/models/image_embeddings.tsp | 5 + .../GetChatCompletions_MaximumSet_Gen.json | 30 +++--- .../GetChatCompletions_MinimumSet_Gen.json | 16 ++-- .../GetEmbeddings_MaximumSet_Gen.json | 21 +++-- .../GetEmbeddings_MinimumSet_Gen.json | 14 +-- .../GetImageEmbeddings_MaximumSet_Gen.json | 23 ++--- .../GetImageEmbeddings_MinimumSet_Gen.json | 14 +-- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +- .../preview/2024-05-01-preview/openapi.json | 92 ++++++++++--------- 20 files changed, 188 insertions(+), 167 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index b244b51dfe30..671926d16ec5 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -3,54 +3,54 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", - "unknown-parameters": "error", + "extra-parameters": "error", "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, + "frequency_penalty": -2, "stream": true, - "presence_penalty": 0, + "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "vfxomqkhovrxtkyyazvmex" + "h" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 28, - "model": "hegocluceqeqwfavwnmwecscp" + "seed": 12, + "model": "agxirqqfasmuhfsziecj" } }, "responses": { "200": { "body": { - "id": "eag", - "created": 16, - "model": "bcfftujqwrlhjosamwtpvsru", + "id": "ceeptxrurcdjkqt", + "created": 21, + "model": "osoowiogoxcsuosvrljoifvelm", "usage": { - "completion_tokens": 17, - "prompt_tokens": 3, - "total_tokens": 28 + "completion_tokens": 18, + "prompt_tokens": 29, + "total_tokens": 16 }, "choices": [ { - "index": 11, + "index": 2, "finish_reason": "stop", "message": { "role": "system", - "content": "sqfqcimvanxhufaxpuwaqltchbv", + "content": "yjsdnmarsnuckaky", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "mkfvplwmxxjp" + "id": "onnuzyosgeqebloipnweqqmbijf" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index 94ef6ec6379e..d152fe0fa05e 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "eag", - "created": 16, - "model": "bcfftujqwrlhjosamwtpvsru", + "id": "ceeptxrurcdjkqt", + "created": 21, + "model": "osoowiogoxcsuosvrljoifvelm", "usage": { - "completion_tokens": 17, - "prompt_tokens": 3, - "total_tokens": 28 + "completion_tokens": 18, + "prompt_tokens": 29, + "total_tokens": 16 }, "choices": [ { - "index": 11, + "index": 2, "finish_reason": "stop", "message": { "role": "system", - "content": "sqfqcimvanxhufaxpuwaqltchbv" + "content": "yjsdnmarsnuckaky" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index 213d37f9845c..b39a592eb949 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -3,33 +3,34 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", - "unknown-parameters": "error", + "extra-parameters": "error", "body": { "input": [ - "ivypgiezduiievgerd" + "lxrdcihhbsuttj" ], - "dimensions": 30, + "dimensions": 10, "encoding_format": "base64", - "input_type": "text" + "input_type": "text", + "model": "hnklvnqqvhjysqgxkpwumqyropwsg" } }, "responses": { "200": { "body": { - "id": "wzfybqqgaefhnyyp", + "id": "sayjtezwjpugjkfyabot", "data": [ { "embedding": [ - 23 + 7 ], - "index": 13 + "index": 5 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 11 + "prompt_tokens": 30, + "total_tokens": 6 }, - "model": "muksoblvhrxtplhgqeagwo" + "model": "bnjeukmodnmysrltqlwnnkbyvaa" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index 6ea121e179c7..45f988a3a52d 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,27 +5,27 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "nisqlderyrvwaytwhfxck" + "jxrfkslpfaxs" ] } }, "responses": { "200": { "body": { - "id": "wzfybqqgaefhnyyp", + "id": "sayjtezwjpugjkfyabot", "data": [ { "embedding": [ - 23 + 7 ], - "index": 13 + "index": 5 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 11 + "prompt_tokens": 30, + "total_tokens": 6 }, - "model": "muksoblvhrxtplhgqeagwo" + "model": "bnjeukmodnmysrltqlwnnkbyvaa" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index 977fd94ea3ae..4fccead2ea5e 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -3,36 +3,37 @@ "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", - "unknown-parameters": "error", + "extra-parameters": "error", "body": { "input": [ { - "image": "nardcgbukclsvpbhtvu", - "text": "ntxmijavbuoikywdbjembhhklakaz" + "image": "njthflfuhnrcirthvwoomw", + "text": "cgzvhethfch" } ], - "dimensions": 11, + "dimensions": 3, "encoding_format": "base64", - "input_type": "text" + "input_type": "text", + "model": "oiyvxcyjxceafhjvfpllmgedsthac" } }, "responses": { "200": { "body": { - "id": "wzfybqqgaefhnyyp", + "id": "sayjtezwjpugjkfyabot", "data": [ { "embedding": [ - 23 + 7 ], - "index": 13 + "index": 5 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 11 + "prompt_tokens": 30, + "total_tokens": 6 }, - "model": "muksoblvhrxtplhgqeagwo" + "model": "bnjeukmodnmysrltqlwnnkbyvaa" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 163621adcfa3..0897963bc46a 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "nardcgbukclsvpbhtvu" + "image": "njthflfuhnrcirthvwoomw" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "wzfybqqgaefhnyyp", + "id": "sayjtezwjpugjkfyabot", "data": [ { "embedding": [ - 23 + 7 ], - "index": 13 + "index": 5 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 11 + "prompt_tokens": 30, + "total_tokens": 6 }, - "model": "muksoblvhrxtplhgqeagwo" + "model": "bnjeukmodnmysrltqlwnnkbyvaa" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index 032a6546ce8c..7d15e091037c 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "xtcbadylzzpq", + "model_name": "guqanuglbybwhnadwzktydthbdylsg", "model_type": "embeddings", - "model_provider_name": "rmrfrcpsppxuuchqitje" + "model_provider_name": "jx" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index ca922ff14c96..e751465bd106 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "xtcbadylzzpq", + "model_name": "guqanuglbybwhnadwzktydthbdylsg", "model_type": "embeddings", - "model_provider_name": "rmrfrcpsppxuuchqitje" + "model_provider_name": "jx" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 73fed6ab5fbe..8ea6f353ef31 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -103,7 +103,6 @@ alias ChatCompletionsOptions = { @doc(""" ID of the specific AI model to use, if more than one model is available on the endpoint. """) - @clientName("DeploymentName", "csharp") `model`?: string; }; diff --git a/specification/ai/ModelClient/models/embeddings.tsp b/specification/ai/ModelClient/models/embeddings.tsp index 2d732863062b..e978f1e8277a 100644 --- a/specification/ai/ModelClient/models/embeddings.tsp +++ b/specification/ai/ModelClient/models/embeddings.tsp @@ -31,4 +31,9 @@ alias EmbeddingsOptions = { Returns a 422 error if the model doesn't support the value or parameter. """) input_type?: EmbeddingInputType; + + @doc(""" + ID of the specific AI model to use, if more than one model is available on the endpoint. + """) + `model`?: string; }; diff --git a/specification/ai/ModelClient/models/image_embeddings.tsp b/specification/ai/ModelClient/models/image_embeddings.tsp index 15826bbc28e5..7a552e388343 100644 --- a/specification/ai/ModelClient/models/image_embeddings.tsp +++ b/specification/ai/ModelClient/models/image_embeddings.tsp @@ -32,6 +32,11 @@ alias ImageEmbeddingsOptions = { Returns a 422 error if the model doesn't support the value or parameter. """) input_type?: EmbeddingInputType; + + @doc(""" + ID of the specific AI model to use, if more than one model is available on the endpoint. + """) + `model`?: string; }; @doc("Represents an image with optional text.") diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index b244b51dfe30..671926d16ec5 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -3,54 +3,54 @@ "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", - "unknown-parameters": "error", + "extra-parameters": "error", "body": { "messages": [ { "role": "ChatRequestMessage" } ], - "frequency_penalty": 0, + "frequency_penalty": -2, "stream": true, - "presence_penalty": 0, + "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": "text", "stop": [ - "vfxomqkhovrxtkyyazvmex" + "h" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 28, - "model": "hegocluceqeqwfavwnmwecscp" + "seed": 12, + "model": "agxirqqfasmuhfsziecj" } }, "responses": { "200": { "body": { - "id": "eag", - "created": 16, - "model": "bcfftujqwrlhjosamwtpvsru", + "id": "ceeptxrurcdjkqt", + "created": 21, + "model": "osoowiogoxcsuosvrljoifvelm", "usage": { - "completion_tokens": 17, - "prompt_tokens": 3, - "total_tokens": 28 + "completion_tokens": 18, + "prompt_tokens": 29, + "total_tokens": 16 }, "choices": [ { - "index": 11, + "index": 2, "finish_reason": "stop", "message": { "role": "system", - "content": "sqfqcimvanxhufaxpuwaqltchbv", + "content": "yjsdnmarsnuckaky", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "mkfvplwmxxjp" + "id": "onnuzyosgeqebloipnweqqmbijf" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 94ef6ec6379e..d152fe0fa05e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "eag", - "created": 16, - "model": "bcfftujqwrlhjosamwtpvsru", + "id": "ceeptxrurcdjkqt", + "created": 21, + "model": "osoowiogoxcsuosvrljoifvelm", "usage": { - "completion_tokens": 17, - "prompt_tokens": 3, - "total_tokens": 28 + "completion_tokens": 18, + "prompt_tokens": 29, + "total_tokens": 16 }, "choices": [ { - "index": 11, + "index": 2, "finish_reason": "stop", "message": { "role": "system", - "content": "sqfqcimvanxhufaxpuwaqltchbv" + "content": "yjsdnmarsnuckaky" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 213d37f9845c..b39a592eb949 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -3,33 +3,34 @@ "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", - "unknown-parameters": "error", + "extra-parameters": "error", "body": { "input": [ - "ivypgiezduiievgerd" + "lxrdcihhbsuttj" ], - "dimensions": 30, + "dimensions": 10, "encoding_format": "base64", - "input_type": "text" + "input_type": "text", + "model": "hnklvnqqvhjysqgxkpwumqyropwsg" } }, "responses": { "200": { "body": { - "id": "wzfybqqgaefhnyyp", + "id": "sayjtezwjpugjkfyabot", "data": [ { "embedding": [ - 23 + 7 ], - "index": 13 + "index": 5 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 11 + "prompt_tokens": 30, + "total_tokens": 6 }, - "model": "muksoblvhrxtplhgqeagwo" + "model": "bnjeukmodnmysrltqlwnnkbyvaa" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 6ea121e179c7..45f988a3a52d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,27 +5,27 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "nisqlderyrvwaytwhfxck" + "jxrfkslpfaxs" ] } }, "responses": { "200": { "body": { - "id": "wzfybqqgaefhnyyp", + "id": "sayjtezwjpugjkfyabot", "data": [ { "embedding": [ - 23 + 7 ], - "index": 13 + "index": 5 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 11 + "prompt_tokens": 30, + "total_tokens": 6 }, - "model": "muksoblvhrxtplhgqeagwo" + "model": "bnjeukmodnmysrltqlwnnkbyvaa" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index 977fd94ea3ae..4fccead2ea5e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -3,36 +3,37 @@ "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", - "unknown-parameters": "error", + "extra-parameters": "error", "body": { "input": [ { - "image": "nardcgbukclsvpbhtvu", - "text": "ntxmijavbuoikywdbjembhhklakaz" + "image": "njthflfuhnrcirthvwoomw", + "text": "cgzvhethfch" } ], - "dimensions": 11, + "dimensions": 3, "encoding_format": "base64", - "input_type": "text" + "input_type": "text", + "model": "oiyvxcyjxceafhjvfpllmgedsthac" } }, "responses": { "200": { "body": { - "id": "wzfybqqgaefhnyyp", + "id": "sayjtezwjpugjkfyabot", "data": [ { "embedding": [ - 23 + 7 ], - "index": 13 + "index": 5 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 11 + "prompt_tokens": 30, + "total_tokens": 6 }, - "model": "muksoblvhrxtplhgqeagwo" + "model": "bnjeukmodnmysrltqlwnnkbyvaa" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 163621adcfa3..0897963bc46a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "nardcgbukclsvpbhtvu" + "image": "njthflfuhnrcirthvwoomw" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "wzfybqqgaefhnyyp", + "id": "sayjtezwjpugjkfyabot", "data": [ { "embedding": [ - 23 + 7 ], - "index": 13 + "index": 5 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 11 + "prompt_tokens": 30, + "total_tokens": 6 }, - "model": "muksoblvhrxtplhgqeagwo" + "model": "bnjeukmodnmysrltqlwnnkbyvaa" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 032a6546ce8c..7d15e091037c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "xtcbadylzzpq", + "model_name": "guqanuglbybwhnadwzktydthbdylsg", "model_type": "embeddings", - "model_provider_name": "rmrfrcpsppxuuchqitje" + "model_provider_name": "jx" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index ca922ff14c96..e751465bd106 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "xtcbadylzzpq", + "model_name": "guqanuglbybwhnadwzktydthbdylsg", "model_type": "embeddings", - "model_provider_name": "rmrfrcpsppxuuchqitje" + "model_provider_name": "jx" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json index bb884343aa2e..87131f1d3b2d 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json @@ -46,9 +46,9 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "unknown-parameters", + "name": "extra-parameters", "in": "header", - "description": "Controls what happens if unknown parameters are passed in the JSON request payload.\nThis sets the HTTP request header `unknown-parameters`.", + "description": "Controls what happens if extra parameters, undefined by the REST API,\nare passed in the JSON request payload.\nThis sets the HTTP request header `extra-parameters`.", "required": false, "type": "string", "enum": [ @@ -57,7 +57,7 @@ "pass_through" ], "x-ms-enum": { - "name": "UnknownParams", + "name": "ExtraParameters", "modelAsString": true, "values": [ { @@ -77,7 +77,7 @@ } ] }, - "x-ms-client-name": "unknown_params" + "x-ms-client-name": "extra_params" }, { "name": "body", @@ -217,9 +217,9 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "unknown-parameters", + "name": "extra-parameters", "in": "header", - "description": "Controls what happens if unknown parameters are passed in the JSON request payload.\nThis sets the HTTP request header `unknown-parameters`.", + "description": "Controls what happens if extra parameters, undefined by the REST API,\nare passed in the JSON request payload.\nThis sets the HTTP request header `extra-parameters`.", "required": false, "type": "string", "enum": [ @@ -228,7 +228,7 @@ "pass_through" ], "x-ms-enum": { - "name": "UnknownParams", + "name": "ExtraParameters", "modelAsString": true, "values": [ { @@ -248,7 +248,7 @@ } ] }, - "x-ms-client-name": "unknown_params" + "x-ms-client-name": "extra_params" }, { "name": "body", @@ -276,6 +276,10 @@ "input_type": { "$ref": "#/definitions/EmbeddingInputType", "description": "Optional. The type of the input.\nReturns a 422 error if the model doesn't support the value or parameter." + }, + "model": { + "type": "string", + "description": "ID of the specific AI model to use, if more than one model is available on the endpoint." } }, "required": [ @@ -323,9 +327,9 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "unknown-parameters", + "name": "extra-parameters", "in": "header", - "description": "Controls what happens if unknown parameters are passed in the JSON request payload.\nThis sets the HTTP request header `unknown-parameters`.", + "description": "Controls what happens if extra parameters, undefined by the REST API,\nare passed in the JSON request payload.\nThis sets the HTTP request header `extra-parameters`.", "required": false, "type": "string", "enum": [ @@ -334,7 +338,7 @@ "pass_through" ], "x-ms-enum": { - "name": "UnknownParams", + "name": "ExtraParameters", "modelAsString": true, "values": [ { @@ -354,7 +358,7 @@ } ] }, - "x-ms-client-name": "unknown_params" + "x-ms-client-name": "extra_params" }, { "name": "body", @@ -383,6 +387,10 @@ "input_type": { "$ref": "#/definitions/EmbeddingInputType", "description": "Optional. The type of the input.\nReturns a 422 error if the model doesn't support the value or parameter." + }, + "model": { + "type": "string", + "description": "ID of the specific AI model to use, if more than one model is available on the endpoint." } }, "required": [ @@ -1256,6 +1264,36 @@ "total_tokens" ] }, + "ExtraParameters": { + "type": "string", + "description": "Controls what happens if extra parameters, undefined byt he REST ApI are passed in the JSON request payload.", + "enum": [ + "error", + "drop", + "pass_through" + ], + "x-ms-enum": { + "name": "ExtraParameters", + "modelAsString": true, + "values": [ + { + "name": "error", + "value": "error", + "description": "The service will error if it detected unknown parameters in the request payload. This is the service default." + }, + { + "name": "drop", + "value": "drop", + "description": "The service will ignore (drop) unknown parameters in the request payload. It will only pass the known parameters to the back-end AI model." + }, + { + "name": "pass_through", + "value": "pass_through", + "description": "The service will pass unknown parameters to the back-end AI model." + } + ] + } + }, "FunctionCall": { "type": "object", "description": "The name and arguments of a function that should be called, as generated by the model.", @@ -1428,36 +1466,6 @@ "usage", "choices" ] - }, - "UnknownParams": { - "type": "string", - "description": "Controls what happens if unknown parameters are passed in the JSON request payload.", - "enum": [ - "error", - "drop", - "pass_through" - ], - "x-ms-enum": { - "name": "UnknownParams", - "modelAsString": true, - "values": [ - { - "name": "error", - "value": "error", - "description": "The service will error if it detected unknown parameters in the request payload. This is the service default." - }, - { - "name": "drop", - "value": "drop", - "description": "The service will ignore (drop) unknown parameters in the request payload. It will only pass the known parameters to the back-end AI model." - }, - { - "name": "pass_through", - "value": "pass_through", - "description": "The service will pass unknown parameters to the back-end AI model." - } - ] - } } }, "parameters": { From 3169d3920b8551b9affadba72cc92a3986845376 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 23 Jul 2024 09:43:27 -0700 Subject: [PATCH 319/343] Fix response_format --- specification/ai/ModelClient/client.tsp | 5 +- .../GetChatCompletions_MaximumSet_Gen.json | 32 +++++++------ .../GetChatCompletions_MinimumSet_Gen.json | 18 +++---- .../GetEmbeddings_MaximumSet_Gen.json | 20 ++++---- .../GetEmbeddings_MinimumSet_Gen.json | 16 +++---- .../GetImageEmbeddings_MaximumSet_Gen.json | 22 ++++----- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 +++---- .../GetModelInfo_MaximumSet_Gen.json | 6 +-- .../GetModelInfo_MinimumSet_Gen.json | 6 +-- .../ModelClient/models/chat_completions.tsp | 25 ++++++++-- .../GetChatCompletions_MaximumSet_Gen.json | 32 +++++++------ .../GetChatCompletions_MinimumSet_Gen.json | 18 +++---- .../GetEmbeddings_MaximumSet_Gen.json | 20 ++++---- .../GetEmbeddings_MinimumSet_Gen.json | 16 +++---- .../GetImageEmbeddings_MaximumSet_Gen.json | 22 ++++----- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 +++---- .../examples/GetModelInfo_MaximumSet_Gen.json | 6 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 6 +-- .../preview/2024-05-01-preview/openapi.json | 47 ++++++++++++++----- .../{ModelClient => AI.Model}/readme.md | 0 20 files changed, 193 insertions(+), 156 deletions(-) rename specification/ai/data-plane/{ModelClient => AI.Model}/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json (62%) rename specification/ai/data-plane/{ModelClient => AI.Model}/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json (58%) rename specification/ai/data-plane/{ModelClient => AI.Model}/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json (55%) rename specification/ai/data-plane/{ModelClient => AI.Model}/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json (53%) rename specification/ai/data-plane/{ModelClient => AI.Model}/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json (53%) rename specification/ai/data-plane/{ModelClient => AI.Model}/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json (55%) rename specification/ai/data-plane/{ModelClient => AI.Model}/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json (54%) rename specification/ai/data-plane/{ModelClient => AI.Model}/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json (54%) rename specification/ai/data-plane/{ModelClient => AI.Model}/preview/2024-05-01-preview/openapi.json (96%) rename specification/ai/data-plane/{ModelClient => AI.Model}/readme.md (100%) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index 7254da42efb3..b67978d9ecbe 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -72,10 +72,7 @@ namespace Customizations; // The actual name here doesn't matter and is here for ); @@clientName(AI.Model.ChatRequestToolMessage, "ToolMessage", "python"); @@clientName(AI.Model.ChatMessageContentItem, "ContentItem", "python"); -@@clientName(AI.Model.ChatMessageTextContentItem, - "TextContentItem", - "python" -); +@@clientName(AI.Model.ChatMessageTextContentItem, "TextContentItem", "python"); @@clientName(AI.Model.ChatMessageImageContentItem, "ImageContentItem", "python" diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index 671926d16ec5..6b9175cdc168 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "maximum set chat completion", + "title": "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", @@ -10,47 +10,49 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": 1, "stream": true, "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, - "response_format": "text", + "response_format": { + "type": "text" + }, "stop": [ - "h" + "e" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 12, - "model": "agxirqqfasmuhfsziecj" + "seed": 15, + "model": "nvcrjpvluopnppqcapdghnrb" } }, "responses": { "200": { "body": { - "id": "ceeptxrurcdjkqt", - "created": 21, - "model": "osoowiogoxcsuosvrljoifvelm", + "id": "cmbhgamujt", + "created": 2, + "model": "uemvvbeb", "usage": { - "completion_tokens": 18, - "prompt_tokens": 29, - "total_tokens": 16 + "completion_tokens": 25, + "prompt_tokens": 10, + "total_tokens": 2 }, "choices": [ { - "index": 2, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "yjsdnmarsnuckaky", + "content": "geqcebxnownhcbiqhqxstvkbs", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "onnuzyosgeqebloipnweqqmbijf" + "id": "mleer" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index d152fe0fa05e..9fb9029ac11e 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "minimum set chat completion", + "title": "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "ceeptxrurcdjkqt", - "created": 21, - "model": "osoowiogoxcsuosvrljoifvelm", + "id": "cmbhgamujt", + "created": 2, + "model": "uemvvbeb", "usage": { - "completion_tokens": 18, - "prompt_tokens": 29, - "total_tokens": 16 + "completion_tokens": 25, + "prompt_tokens": 10, + "total_tokens": 2 }, "choices": [ { - "index": 2, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "yjsdnmarsnuckaky" + "content": "geqcebxnownhcbiqhqxstvkbs" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index b39a592eb949..3886ab604113 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -1,36 +1,36 @@ { - "title": "maximum set embeddings", + "title": "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "extra-parameters": "error", "body": { "input": [ - "lxrdcihhbsuttj" + "lacghpavhmlejmohnntinqpaknh" ], - "dimensions": 10, + "dimensions": 23, "encoding_format": "base64", "input_type": "text", - "model": "hnklvnqqvhjysqgxkpwumqyropwsg" + "model": "melnrcbsuacwy" } }, "responses": { "200": { "body": { - "id": "sayjtezwjpugjkfyabot", + "id": "doqoabmzjhjkr", "data": [ { "embedding": [ - 7 + 25 ], - "index": 5 + "index": 17 } ], "usage": { - "prompt_tokens": 30, - "total_tokens": 6 + "prompt_tokens": 12, + "total_tokens": 29 }, - "model": "bnjeukmodnmysrltqlwnnkbyvaa" + "model": "ppweiubguuxrdtnniadxmm" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index 45f988a3a52d..e4ec4097617a 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -1,31 +1,31 @@ { - "title": "minimum set embeddings", + "title": "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "body": { "input": [ - "jxrfkslpfaxs" + "cjuxwrojaxihbnssolrkmrloncsxwb" ] } }, "responses": { "200": { "body": { - "id": "sayjtezwjpugjkfyabot", + "id": "doqoabmzjhjkr", "data": [ { "embedding": [ - 7 + 25 ], - "index": 5 + "index": 17 } ], "usage": { - "prompt_tokens": 30, - "total_tokens": 6 + "prompt_tokens": 12, + "total_tokens": 29 }, - "model": "bnjeukmodnmysrltqlwnnkbyvaa" + "model": "ppweiubguuxrdtnniadxmm" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index 4fccead2ea5e..1b5c64e9866c 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "maximum set image embeddings", + "title": "GetImageEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", @@ -7,33 +7,33 @@ "body": { "input": [ { - "image": "njthflfuhnrcirthvwoomw", - "text": "cgzvhethfch" + "image": "zkodzqvsojjzhtjbp", + "text": "rkiknirndfpfgduvjsct" } ], - "dimensions": 3, + "dimensions": 12, "encoding_format": "base64", "input_type": "text", - "model": "oiyvxcyjxceafhjvfpllmgedsthac" + "model": "xdzhvlrplsmhnjsutyyt" } }, "responses": { "200": { "body": { - "id": "sayjtezwjpugjkfyabot", + "id": "doqoabmzjhjkr", "data": [ { "embedding": [ - 7 + 25 ], - "index": 5 + "index": 17 } ], "usage": { - "prompt_tokens": 30, - "total_tokens": 6 + "prompt_tokens": 12, + "total_tokens": 29 }, - "model": "bnjeukmodnmysrltqlwnnkbyvaa" + "model": "ppweiubguuxrdtnniadxmm" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 0897963bc46a..7cccf41dadff 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -1,12 +1,12 @@ { - "title": "minimum set image embeddings", + "title": "GetImageEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "body": { "input": [ { - "image": "njthflfuhnrcirthvwoomw" + "image": "zkodzqvsojjzhtjbp" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "sayjtezwjpugjkfyabot", + "id": "doqoabmzjhjkr", "data": [ { "embedding": [ - 7 + 25 ], - "index": 5 + "index": 17 } ], "usage": { - "prompt_tokens": 30, - "total_tokens": 6 + "prompt_tokens": 12, + "total_tokens": 29 }, - "model": "bnjeukmodnmysrltqlwnnkbyvaa" + "model": "ppweiubguuxrdtnniadxmm" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index 7d15e091037c..58d9f20eae7c 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "maximum set model information", + "title": "GetModelInfo_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetModelInfo", "parameters": { "api-version": "2024-05-01-preview" @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "guqanuglbybwhnadwzktydthbdylsg", + "model_name": "wbnpjzjftfmbhdxjsuyi", "model_type": "embeddings", - "model_provider_name": "jx" + "model_provider_name": "fsrdugbahjpjzv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index e751465bd106..cacdf2af7986 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "minimum set model information", + "title": "GetModelInfo_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetModelInfo", "parameters": { "api-version": "2024-05-01-preview" @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "guqanuglbybwhnadwzktydthbdylsg", + "model_name": "wbnpjzjftfmbhdxjsuyi", "model_type": "embeddings", - "model_provider_name": "jx" + "model_provider_name": "fsrdugbahjpjzv" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 626246eb7a59..4e57cb8e5d4b 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -75,7 +75,11 @@ alias ChatCompletionsOptions = { @minValue(0.0) max_tokens?: int32; - @doc("An object specifying the format that the model must output. Used to enable JSON mode.") + @doc(""" + The format that the model must output. Use this to enable JSON mode instead of the default text mode. + Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON + via a system or user message. + """) response_format?: ChatCompletionsResponseFormat; @doc(""" @@ -220,20 +224,31 @@ union ChatRole { } @doc(""" - An representation of a response format configuration usable by Chat Completions. Can be used to enable JSON + Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode. + Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON + via a system or user message. + """) +model ChatCompletionsResponseFormat { + @doc("The response format type to use for the chat completions response.") + type: ChatCompletionsResponseFormatType; +} + +@doc(""" + A representation of a response format type usable by Chat Completions. Can be used to enable JSON mode. """) -union ChatCompletionsResponseFormat { +union ChatCompletionsResponseFormatType { string, @doc(""" - The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response - content that adheres to a specific schema. + A response format for Chat Compltions that emits text responses. This is the default response format. """) text: "text", @doc(""" A response format for Chat Completions that restricts responses to emitting valid JSON objects. + Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON + via a system or user message. """) json_object: "json_object", } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json similarity index 62% rename from specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json rename to specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 671926d16ec5..6b9175cdc168 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "maximum set chat completion", + "title": "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", @@ -10,47 +10,49 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -2, + "frequency_penalty": 1, "stream": true, "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, - "response_format": "text", + "response_format": { + "type": "text" + }, "stop": [ - "h" + "e" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 12, - "model": "agxirqqfasmuhfsziecj" + "seed": 15, + "model": "nvcrjpvluopnppqcapdghnrb" } }, "responses": { "200": { "body": { - "id": "ceeptxrurcdjkqt", - "created": 21, - "model": "osoowiogoxcsuosvrljoifvelm", + "id": "cmbhgamujt", + "created": 2, + "model": "uemvvbeb", "usage": { - "completion_tokens": 18, - "prompt_tokens": 29, - "total_tokens": 16 + "completion_tokens": 25, + "prompt_tokens": 10, + "total_tokens": 2 }, "choices": [ { - "index": 2, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "yjsdnmarsnuckaky", + "content": "geqcebxnownhcbiqhqxstvkbs", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "onnuzyosgeqebloipnweqqmbijf" + "id": "mleer" } ] } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json similarity index 58% rename from specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json rename to specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index d152fe0fa05e..9fb9029ac11e 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "minimum set chat completion", + "title": "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "ceeptxrurcdjkqt", - "created": 21, - "model": "osoowiogoxcsuosvrljoifvelm", + "id": "cmbhgamujt", + "created": 2, + "model": "uemvvbeb", "usage": { - "completion_tokens": 18, - "prompt_tokens": 29, - "total_tokens": 16 + "completion_tokens": 25, + "prompt_tokens": 10, + "total_tokens": 2 }, "choices": [ { - "index": 2, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "yjsdnmarsnuckaky" + "content": "geqcebxnownhcbiqhqxstvkbs" } } ] diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json similarity index 55% rename from specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json rename to specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index b39a592eb949..3886ab604113 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -1,36 +1,36 @@ { - "title": "maximum set embeddings", + "title": "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "extra-parameters": "error", "body": { "input": [ - "lxrdcihhbsuttj" + "lacghpavhmlejmohnntinqpaknh" ], - "dimensions": 10, + "dimensions": 23, "encoding_format": "base64", "input_type": "text", - "model": "hnklvnqqvhjysqgxkpwumqyropwsg" + "model": "melnrcbsuacwy" } }, "responses": { "200": { "body": { - "id": "sayjtezwjpugjkfyabot", + "id": "doqoabmzjhjkr", "data": [ { "embedding": [ - 7 + 25 ], - "index": 5 + "index": 17 } ], "usage": { - "prompt_tokens": 30, - "total_tokens": 6 + "prompt_tokens": 12, + "total_tokens": 29 }, - "model": "bnjeukmodnmysrltqlwnnkbyvaa" + "model": "ppweiubguuxrdtnniadxmm" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json similarity index 53% rename from specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json rename to specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 45f988a3a52d..e4ec4097617a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -1,31 +1,31 @@ { - "title": "minimum set embeddings", + "title": "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "body": { "input": [ - "jxrfkslpfaxs" + "cjuxwrojaxihbnssolrkmrloncsxwb" ] } }, "responses": { "200": { "body": { - "id": "sayjtezwjpugjkfyabot", + "id": "doqoabmzjhjkr", "data": [ { "embedding": [ - 7 + 25 ], - "index": 5 + "index": 17 } ], "usage": { - "prompt_tokens": 30, - "total_tokens": 6 + "prompt_tokens": 12, + "total_tokens": 29 }, - "model": "bnjeukmodnmysrltqlwnnkbyvaa" + "model": "ppweiubguuxrdtnniadxmm" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json similarity index 53% rename from specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json rename to specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index 4fccead2ea5e..1b5c64e9866c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "maximum set image embeddings", + "title": "GetImageEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", @@ -7,33 +7,33 @@ "body": { "input": [ { - "image": "njthflfuhnrcirthvwoomw", - "text": "cgzvhethfch" + "image": "zkodzqvsojjzhtjbp", + "text": "rkiknirndfpfgduvjsct" } ], - "dimensions": 3, + "dimensions": 12, "encoding_format": "base64", "input_type": "text", - "model": "oiyvxcyjxceafhjvfpllmgedsthac" + "model": "xdzhvlrplsmhnjsutyyt" } }, "responses": { "200": { "body": { - "id": "sayjtezwjpugjkfyabot", + "id": "doqoabmzjhjkr", "data": [ { "embedding": [ - 7 + 25 ], - "index": 5 + "index": 17 } ], "usage": { - "prompt_tokens": 30, - "total_tokens": 6 + "prompt_tokens": 12, + "total_tokens": 29 }, - "model": "bnjeukmodnmysrltqlwnnkbyvaa" + "model": "ppweiubguuxrdtnniadxmm" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json similarity index 55% rename from specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json rename to specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 0897963bc46a..7cccf41dadff 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -1,12 +1,12 @@ { - "title": "minimum set image embeddings", + "title": "GetImageEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "body": { "input": [ { - "image": "njthflfuhnrcirthvwoomw" + "image": "zkodzqvsojjzhtjbp" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "sayjtezwjpugjkfyabot", + "id": "doqoabmzjhjkr", "data": [ { "embedding": [ - 7 + 25 ], - "index": 5 + "index": 17 } ], "usage": { - "prompt_tokens": 30, - "total_tokens": 6 + "prompt_tokens": 12, + "total_tokens": 29 }, - "model": "bnjeukmodnmysrltqlwnnkbyvaa" + "model": "ppweiubguuxrdtnniadxmm" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json similarity index 54% rename from specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json rename to specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 7d15e091037c..58d9f20eae7c 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "maximum set model information", + "title": "GetModelInfo_MaximumSet_Gen - generated by [MaximumSet] rule", "operationId": "GetModelInfo", "parameters": { "api-version": "2024-05-01-preview" @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "guqanuglbybwhnadwzktydthbdylsg", + "model_name": "wbnpjzjftfmbhdxjsuyi", "model_type": "embeddings", - "model_provider_name": "jx" + "model_provider_name": "fsrdugbahjpjzv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json similarity index 54% rename from specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json rename to specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index e751465bd106..cacdf2af7986 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "minimum set model information", + "title": "GetModelInfo_MaximumSet_Gen - generated by [MinimumSet] rule", "operationId": "GetModelInfo", "parameters": { "api-version": "2024-05-01-preview" @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "guqanuglbybwhnadwzktydthbdylsg", + "model_name": "wbnpjzjftfmbhdxjsuyi", "model_type": "embeddings", - "model_provider_name": "jx" + "model_provider_name": "fsrdugbahjpjzv" } } } diff --git a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json similarity index 96% rename from specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json rename to specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json index 87131f1d3b2d..dcca86da689a 100644 --- a/specification/ai/data-plane/ModelClient/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json @@ -19,6 +19,9 @@ "application/json" ], "security": [ + { + "ApiKeyAuth": [] + }, { "OAuth2Auth": [ "https://ml.azure.com/.default" @@ -26,6 +29,11 @@ } ], "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, "OAuth2Auth": { "type": "oauth2", "flow": "implicit", @@ -139,7 +147,7 @@ }, "response_format": { "$ref": "#/definitions/ChatCompletionsResponseFormat", - "description": "An object specifying the format that the model must output. Used to enable JSON mode." + "description": "The format that the model must output. Use this to enable JSON mode instead of the default text mode.\nNote that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON\nvia a system or user message." }, "stop": { "type": "array", @@ -199,10 +207,10 @@ } }, "x-ms-examples": { - "maximum set chat completion": { + "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "minimum set chat completion": { + "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -309,10 +317,10 @@ } }, "x-ms-examples": { - "maximum set embeddings": { + "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "minimum set embeddings": { + "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } @@ -420,10 +428,10 @@ } }, "x-ms-examples": { - "maximum set image embeddings": { + "GetImageEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule": { "$ref": "./examples/GetImageEmbeddings_MaximumSet_Gen.json" }, - "minimum set image embeddings": { + "GetImageEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule": { "$ref": "./examples/GetImageEmbeddings_MinimumSet_Gen.json" } } @@ -459,10 +467,10 @@ } }, "x-ms-examples": { - "maximum set model information": { + "GetModelInfo_MaximumSet_Gen - generated by [MaximumSet] rule": { "$ref": "./examples/GetModelInfo_MaximumSet_Gen.json" }, - "minimum set model information": { + "GetModelInfo_MaximumSet_Gen - generated by [MinimumSet] rule": { "$ref": "./examples/GetModelInfo_MinimumSet_Gen.json" } } @@ -680,25 +688,38 @@ ] }, "ChatCompletionsResponseFormat": { + "type": "object", + "description": "Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode.\nNote that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON\nvia a system or user message.", + "properties": { + "type": { + "$ref": "#/definitions/ChatCompletionsResponseFormatType", + "description": "The response format type to use for the chat completions response." + } + }, + "required": [ + "type" + ] + }, + "ChatCompletionsResponseFormatType": { "type": "string", - "description": "An representation of a response format configuration usable by Chat Completions. Can be used to enable JSON\nmode.", + "description": "A representation of a response format type usable by Chat Completions. Can be used to enable JSON\nmode.", "enum": [ "text", "json_object" ], "x-ms-enum": { - "name": "ChatCompletionsResponseFormat", + "name": "ChatCompletionsResponseFormatType", "modelAsString": true, "values": [ { "name": "text", "value": "text", - "description": "The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response\ncontent that adheres to a specific schema." + "description": "A response format for Chat Compltions that emits text responses. This is the default response format." }, { "name": "json_object", "value": "json_object", - "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects." + "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects.\nNote that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON\nvia a system or user message." } ] } diff --git a/specification/ai/data-plane/ModelClient/readme.md b/specification/ai/data-plane/AI.Model/readme.md similarity index 100% rename from specification/ai/data-plane/ModelClient/readme.md rename to specification/ai/data-plane/AI.Model/readme.md From a7376f6a4576b1db911be4d5cbc5ef5855205416 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Tue, 23 Jul 2024 12:09:57 -0700 Subject: [PATCH 320/343] Another update to response_format --- .../GetChatCompletions_MaximumSet_Gen.json | 30 ++++----- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++--- .../GetEmbeddings_MaximumSet_Gen.json | 20 +++--- .../GetEmbeddings_MinimumSet_Gen.json | 16 ++--- .../GetImageEmbeddings_MaximumSet_Gen.json | 22 +++---- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 ++--- .../GetModelInfo_MaximumSet_Gen.json | 6 +- .../GetModelInfo_MinimumSet_Gen.json | 6 +- .../ModelClient/models/chat_completions.tsp | 33 +++++----- .../GetChatCompletions_MaximumSet_Gen.json | 30 ++++----- .../GetChatCompletions_MinimumSet_Gen.json | 18 +++--- .../GetEmbeddings_MaximumSet_Gen.json | 20 +++--- .../GetEmbeddings_MinimumSet_Gen.json | 16 ++--- .../GetImageEmbeddings_MaximumSet_Gen.json | 22 +++---- .../GetImageEmbeddings_MinimumSet_Gen.json | 16 ++--- .../examples/GetModelInfo_MaximumSet_Gen.json | 6 +- .../examples/GetModelInfo_MinimumSet_Gen.json | 6 +- .../preview/2024-05-01-preview/openapi.json | 61 +++++++++---------- 18 files changed, 179 insertions(+), 183 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index 6b9175cdc168..80072b544cd7 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", @@ -10,49 +10,49 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, + "frequency_penalty": -1, "stream": true, "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": { - "type": "text" + "type": "ChatCompletionsResponseFormat" }, "stop": [ - "e" + "eaci" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 15, - "model": "nvcrjpvluopnppqcapdghnrb" + "seed": 5, + "model": "glassawrurnrjlogqwkbuxwegqev" } }, "responses": { "200": { "body": { - "id": "cmbhgamujt", - "created": 2, - "model": "uemvvbeb", + "id": "geovtffzoflmmcwafnxxtodjeg", + "created": 29, + "model": "dxafxxeoguemtjyi", "usage": { - "completion_tokens": 25, - "prompt_tokens": 10, - "total_tokens": 2 + "completion_tokens": 2, + "prompt_tokens": 21, + "total_tokens": 14 }, "choices": [ { - "index": 12, + "index": 29, "finish_reason": "stop", "message": { "role": "system", - "content": "geqcebxnownhcbiqhqxstvkbs", + "content": "ksmchnhpogwrzvyikqzldcjj", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "mleer" + "id": "atrs" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index 9fb9029ac11e..18c2b9361651 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "cmbhgamujt", - "created": 2, - "model": "uemvvbeb", + "id": "geovtffzoflmmcwafnxxtodjeg", + "created": 29, + "model": "dxafxxeoguemtjyi", "usage": { - "completion_tokens": 25, - "prompt_tokens": 10, - "total_tokens": 2 + "completion_tokens": 2, + "prompt_tokens": 21, + "total_tokens": 14 }, "choices": [ { - "index": 12, + "index": 29, "finish_reason": "stop", "message": { "role": "system", - "content": "geqcebxnownhcbiqhqxstvkbs" + "content": "ksmchnhpogwrzvyikqzldcjj" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index 3886ab604113..f5eecb9a493b 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -1,36 +1,36 @@ { - "title": "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set embeddings", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "extra-parameters": "error", "body": { "input": [ - "lacghpavhmlejmohnntinqpaknh" + "umrntih" ], - "dimensions": 23, + "dimensions": 11, "encoding_format": "base64", "input_type": "text", - "model": "melnrcbsuacwy" + "model": "cgdxfwhmwzuzc" } }, "responses": { "200": { "body": { - "id": "doqoabmzjhjkr", + "id": "xqaffburopresrejyeklwhdvgzz", "data": [ { "embedding": [ - 25 + 21 ], - "index": 17 + "index": 29 } ], "usage": { - "prompt_tokens": 12, - "total_tokens": 29 + "prompt_tokens": 2, + "total_tokens": 6 }, - "model": "ppweiubguuxrdtnniadxmm" + "model": "rrqqiv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index e4ec4097617a..7bce9f916710 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -1,31 +1,31 @@ { - "title": "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set embeddings", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "body": { "input": [ - "cjuxwrojaxihbnssolrkmrloncsxwb" + "pqzaclythijzhgdx" ] } }, "responses": { "200": { "body": { - "id": "doqoabmzjhjkr", + "id": "xqaffburopresrejyeklwhdvgzz", "data": [ { "embedding": [ - 25 + 21 ], - "index": 17 + "index": 29 } ], "usage": { - "prompt_tokens": 12, - "total_tokens": 29 + "prompt_tokens": 2, + "total_tokens": 6 }, - "model": "ppweiubguuxrdtnniadxmm" + "model": "rrqqiv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index 1b5c64e9866c..d1fc78f8ea50 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetImageEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set image embeddings", "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", @@ -7,33 +7,33 @@ "body": { "input": [ { - "image": "zkodzqvsojjzhtjbp", - "text": "rkiknirndfpfgduvjsct" + "image": "d", + "text": "vxakqdw" } ], - "dimensions": 12, + "dimensions": 20, "encoding_format": "base64", "input_type": "text", - "model": "xdzhvlrplsmhnjsutyyt" + "model": "jofsujnpjhvjkqzdskdxoutpfojl" } }, "responses": { "200": { "body": { - "id": "doqoabmzjhjkr", + "id": "xqaffburopresrejyeklwhdvgzz", "data": [ { "embedding": [ - 25 + 21 ], - "index": 17 + "index": 29 } ], "usage": { - "prompt_tokens": 12, - "total_tokens": 29 + "prompt_tokens": 2, + "total_tokens": 6 }, - "model": "ppweiubguuxrdtnniadxmm" + "model": "rrqqiv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 7cccf41dadff..6b67b5eb454d 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -1,12 +1,12 @@ { - "title": "GetImageEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set image embeddings", "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "body": { "input": [ { - "image": "zkodzqvsojjzhtjbp" + "image": "d" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "doqoabmzjhjkr", + "id": "xqaffburopresrejyeklwhdvgzz", "data": [ { "embedding": [ - 25 + 21 ], - "index": 17 + "index": 29 } ], "usage": { - "prompt_tokens": 12, - "total_tokens": 29 + "prompt_tokens": 2, + "total_tokens": 6 }, - "model": "ppweiubguuxrdtnniadxmm" + "model": "rrqqiv" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index 58d9f20eae7c..80d071a2a08f 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetModelInfo_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set model information", "operationId": "GetModelInfo", "parameters": { "api-version": "2024-05-01-preview" @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "wbnpjzjftfmbhdxjsuyi", + "model_name": "xxhqafyp", "model_type": "embeddings", - "model_provider_name": "fsrdugbahjpjzv" + "model_provider_name": "fcoytwfk" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index cacdf2af7986..49b32911271b 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetModelInfo_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set model information", "operationId": "GetModelInfo", "parameters": { "api-version": "2024-05-01-preview" @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "wbnpjzjftfmbhdxjsuyi", + "model_name": "xxhqafyp", "model_type": "embeddings", - "model_provider_name": "fsrdugbahjpjzv" + "model_provider_name": "fcoytwfk" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index 4e57cb8e5d4b..acdc1a3e9a80 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -228,29 +228,28 @@ union ChatRole { Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON via a system or user message. """) +@discriminator("type") model ChatCompletionsResponseFormat { - @doc("The response format type to use for the chat completions response.") - type: ChatCompletionsResponseFormatType; + @doc("The response format type to use for chat completions.") + type: string; } @doc(""" - A representation of a response format type usable by Chat Completions. Can be used to enable JSON - mode. + A response format for Chat Completions that emits text responses. This is the default response format. """) -union ChatCompletionsResponseFormatType { - string, - - @doc(""" - A response format for Chat Compltions that emits text responses. This is the default response format. - """) - text: "text", +model ChatCompletionsResponseFormatText extends ChatCompletionsResponseFormat { + @doc("Response format type: always 'text' for this object.") + type: "text"; +} - @doc(""" - A response format for Chat Completions that restricts responses to emitting valid JSON objects. - Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON - via a system or user message. - """) - json_object: "json_object", +@doc(""" + A response format for Chat Completions that restricts responses to emitting valid JSON objects. + Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON + via a system or user message. + """) +model ChatCompletionsResponseFormatJSON extends ChatCompletionsResponseFormat { + @doc("Response format type: always 'json_object' for this object.") + type: "json_object"; } alias ChatChoiceCommon = { diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 6b9175cdc168..80072b544cd7 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", @@ -10,49 +10,49 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": 1, + "frequency_penalty": -1, "stream": true, "presence_penalty": 1, "temperature": 0, "top_p": 0, "max_tokens": 0, "response_format": { - "type": "text" + "type": "ChatCompletionsResponseFormat" }, "stop": [ - "e" + "eaci" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 15, - "model": "nvcrjpvluopnppqcapdghnrb" + "seed": 5, + "model": "glassawrurnrjlogqwkbuxwegqev" } }, "responses": { "200": { "body": { - "id": "cmbhgamujt", - "created": 2, - "model": "uemvvbeb", + "id": "geovtffzoflmmcwafnxxtodjeg", + "created": 29, + "model": "dxafxxeoguemtjyi", "usage": { - "completion_tokens": 25, - "prompt_tokens": 10, - "total_tokens": 2 + "completion_tokens": 2, + "prompt_tokens": 21, + "total_tokens": 14 }, "choices": [ { - "index": 12, + "index": 29, "finish_reason": "stop", "message": { "role": "system", - "content": "geqcebxnownhcbiqhqxstvkbs", + "content": "ksmchnhpogwrzvyikqzldcjj", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "mleer" + "id": "atrs" } ] } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 9fb9029ac11e..18c2b9361651 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set chat completion", "operationId": "GetChatCompletions", "parameters": { "api-version": "2024-05-01-preview", @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "cmbhgamujt", - "created": 2, - "model": "uemvvbeb", + "id": "geovtffzoflmmcwafnxxtodjeg", + "created": 29, + "model": "dxafxxeoguemtjyi", "usage": { - "completion_tokens": 25, - "prompt_tokens": 10, - "total_tokens": 2 + "completion_tokens": 2, + "prompt_tokens": 21, + "total_tokens": 14 }, "choices": [ { - "index": 12, + "index": 29, "finish_reason": "stop", "message": { "role": "system", - "content": "geqcebxnownhcbiqhqxstvkbs" + "content": "ksmchnhpogwrzvyikqzldcjj" } } ] diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 3886ab604113..f5eecb9a493b 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -1,36 +1,36 @@ { - "title": "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set embeddings", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "extra-parameters": "error", "body": { "input": [ - "lacghpavhmlejmohnntinqpaknh" + "umrntih" ], - "dimensions": 23, + "dimensions": 11, "encoding_format": "base64", "input_type": "text", - "model": "melnrcbsuacwy" + "model": "cgdxfwhmwzuzc" } }, "responses": { "200": { "body": { - "id": "doqoabmzjhjkr", + "id": "xqaffburopresrejyeklwhdvgzz", "data": [ { "embedding": [ - 25 + 21 ], - "index": 17 + "index": 29 } ], "usage": { - "prompt_tokens": 12, - "total_tokens": 29 + "prompt_tokens": 2, + "total_tokens": 6 }, - "model": "ppweiubguuxrdtnniadxmm" + "model": "rrqqiv" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index e4ec4097617a..7bce9f916710 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -1,31 +1,31 @@ { - "title": "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set embeddings", "operationId": "GetEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "body": { "input": [ - "cjuxwrojaxihbnssolrkmrloncsxwb" + "pqzaclythijzhgdx" ] } }, "responses": { "200": { "body": { - "id": "doqoabmzjhjkr", + "id": "xqaffburopresrejyeklwhdvgzz", "data": [ { "embedding": [ - 25 + 21 ], - "index": 17 + "index": 29 } ], "usage": { - "prompt_tokens": 12, - "total_tokens": 29 + "prompt_tokens": 2, + "total_tokens": 6 }, - "model": "ppweiubguuxrdtnniadxmm" + "model": "rrqqiv" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index 1b5c64e9866c..d1fc78f8ea50 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetImageEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set image embeddings", "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", @@ -7,33 +7,33 @@ "body": { "input": [ { - "image": "zkodzqvsojjzhtjbp", - "text": "rkiknirndfpfgduvjsct" + "image": "d", + "text": "vxakqdw" } ], - "dimensions": 12, + "dimensions": 20, "encoding_format": "base64", "input_type": "text", - "model": "xdzhvlrplsmhnjsutyyt" + "model": "jofsujnpjhvjkqzdskdxoutpfojl" } }, "responses": { "200": { "body": { - "id": "doqoabmzjhjkr", + "id": "xqaffburopresrejyeklwhdvgzz", "data": [ { "embedding": [ - 25 + 21 ], - "index": 17 + "index": 29 } ], "usage": { - "prompt_tokens": 12, - "total_tokens": 29 + "prompt_tokens": 2, + "total_tokens": 6 }, - "model": "ppweiubguuxrdtnniadxmm" + "model": "rrqqiv" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 7cccf41dadff..6b67b5eb454d 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -1,12 +1,12 @@ { - "title": "GetImageEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set image embeddings", "operationId": "GetImageEmbeddings", "parameters": { "api-version": "2024-05-01-preview", "body": { "input": [ { - "image": "zkodzqvsojjzhtjbp" + "image": "d" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "doqoabmzjhjkr", + "id": "xqaffburopresrejyeklwhdvgzz", "data": [ { "embedding": [ - 25 + 21 ], - "index": 17 + "index": 29 } ], "usage": { - "prompt_tokens": 12, - "total_tokens": 29 + "prompt_tokens": 2, + "total_tokens": 6 }, - "model": "ppweiubguuxrdtnniadxmm" + "model": "rrqqiv" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 58d9f20eae7c..80d071a2a08f 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetModelInfo_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "maximum set model information", "operationId": "GetModelInfo", "parameters": { "api-version": "2024-05-01-preview" @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "wbnpjzjftfmbhdxjsuyi", + "model_name": "xxhqafyp", "model_type": "embeddings", - "model_provider_name": "fsrdugbahjpjzv" + "model_provider_name": "fcoytwfk" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index cacdf2af7986..49b32911271b 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "GetModelInfo_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "minimum set model information", "operationId": "GetModelInfo", "parameters": { "api-version": "2024-05-01-preview" @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "wbnpjzjftfmbhdxjsuyi", + "model_name": "xxhqafyp", "model_type": "embeddings", - "model_provider_name": "fsrdugbahjpjzv" + "model_provider_name": "fcoytwfk" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json index dcca86da689a..29513ce45564 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json @@ -207,10 +207,10 @@ } }, "x-ms-examples": { - "GetChatCompletions_MaximumSet_Gen - generated by [MaximumSet] rule": { + "maximum set chat completion": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "GetChatCompletions_MaximumSet_Gen - generated by [MinimumSet] rule": { + "minimum set chat completion": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -317,10 +317,10 @@ } }, "x-ms-examples": { - "GetEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule": { + "maximum set embeddings": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "GetEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule": { + "minimum set embeddings": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } @@ -428,10 +428,10 @@ } }, "x-ms-examples": { - "GetImageEmbeddings_MaximumSet_Gen - generated by [MaximumSet] rule": { + "maximum set image embeddings": { "$ref": "./examples/GetImageEmbeddings_MaximumSet_Gen.json" }, - "GetImageEmbeddings_MaximumSet_Gen - generated by [MinimumSet] rule": { + "minimum set image embeddings": { "$ref": "./examples/GetImageEmbeddings_MinimumSet_Gen.json" } } @@ -467,10 +467,10 @@ } }, "x-ms-examples": { - "GetModelInfo_MaximumSet_Gen - generated by [MaximumSet] rule": { + "maximum set model information": { "$ref": "./examples/GetModelInfo_MaximumSet_Gen.json" }, - "GetModelInfo_MaximumSet_Gen - generated by [MinimumSet] rule": { + "minimum set model information": { "$ref": "./examples/GetModelInfo_MinimumSet_Gen.json" } } @@ -692,37 +692,34 @@ "description": "Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode.\nNote that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON\nvia a system or user message.", "properties": { "type": { - "$ref": "#/definitions/ChatCompletionsResponseFormatType", - "description": "The response format type to use for the chat completions response." + "type": "string", + "description": "The response format type to use for chat completions." } }, + "discriminator": "type", "required": [ "type" ] }, - "ChatCompletionsResponseFormatType": { - "type": "string", - "description": "A representation of a response format type usable by Chat Completions. Can be used to enable JSON\nmode.", - "enum": [ - "text", - "json_object" + "ChatCompletionsResponseFormatJSON": { + "type": "object", + "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects.\nNote that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON\nvia a system or user message.", + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsResponseFormat" + } ], - "x-ms-enum": { - "name": "ChatCompletionsResponseFormatType", - "modelAsString": true, - "values": [ - { - "name": "text", - "value": "text", - "description": "A response format for Chat Compltions that emits text responses. This is the default response format." - }, - { - "name": "json_object", - "value": "json_object", - "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects.\nNote that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON\nvia a system or user message." - } - ] - } + "x-ms-discriminator-value": "json_object" + }, + "ChatCompletionsResponseFormatText": { + "type": "object", + "description": "A response format for Chat Completions that emits text responses. This is the default response format.", + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsResponseFormat" + } + ], + "x-ms-discriminator-value": "text" }, "ChatCompletionsToolCall": { "type": "object", From acd2c9ae2b6fe3518b3cb37798d2feb514a990eb Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Tue, 23 Jul 2024 15:08:18 -0700 Subject: [PATCH 321/343] Make operator method internal Signed-off-by: Travis Angevine --- specification/ai/ModelClient/client.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index b67978d9ecbe..9125c05d514e 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -58,7 +58,7 @@ namespace Customizations; // The actual name here doesn't matter and is here for // 1. Add chat completions streaming (to getChatCompletions operator) // 2. Add hyper-params (to getChatCompletions/Embeddings/ImageEmbeddings, all clients) // 3. Cache model info (to getModelInfo, all clients, Python only) -@@access(AI.Model.getChatCompletions, Access.internal, "python"); +@@access(AI.Model.getChatCompletions, Access.internal); @@access(AI.Model.getEmbeddings, Access.internal); @@access(AI.Model.getImageEmbeddings, Access.internal); @@access(AI.Model.getModelInfo, Access.internal, "python"); From bec9f1900050dc64b7a54a919f6a7292bc780350 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Wed, 24 Jul 2024 17:08:26 -0700 Subject: [PATCH 322/343] Fix pass_through to pass-through --- .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++++-------- .../GetChatCompletions_MinimumSet_Gen.json | 16 +++++----- .../GetEmbeddings_MaximumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MinimumSet_Gen.json | 14 ++++---- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 ++++++------ .../GetImageEmbeddings_MinimumSet_Gen.json | 14 ++++---- .../GetModelInfo_MaximumSet_Gen.json | 4 +-- .../GetModelInfo_MinimumSet_Gen.json | 4 +-- .../ai/ModelClient/models/common.tsp | 2 +- .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++++-------- .../GetChatCompletions_MinimumSet_Gen.json | 16 +++++----- .../GetEmbeddings_MaximumSet_Gen.json | 18 +++++------ .../GetEmbeddings_MinimumSet_Gen.json | 14 ++++---- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 ++++++------ .../GetImageEmbeddings_MinimumSet_Gen.json | 14 ++++---- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +-- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +-- .../preview/2024-05-01-preview/openapi.json | 32 +++++++++---------- 18 files changed, 133 insertions(+), 133 deletions(-) diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index 80072b544cd7..84134c6c778d 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": -2, "stream": true, "presence_penalty": 1, "temperature": 0, @@ -20,39 +20,39 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "eaci" + "zwwxvquhrhpaevppqwexdxil" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 5, - "model": "glassawrurnrjlogqwkbuxwegqev" + "seed": 13, + "model": "okpvoortuwcnlcqfunqxclxpznresa" } }, "responses": { "200": { "body": { - "id": "geovtffzoflmmcwafnxxtodjeg", - "created": 29, - "model": "dxafxxeoguemtjyi", + "id": "pzvoxwsrfgaoyumlwihrdliisembh", + "created": 20, + "model": "xloxamseoxvhjlnhtokspgzmn", "usage": { - "completion_tokens": 2, - "prompt_tokens": 21, - "total_tokens": 14 + "completion_tokens": 11, + "prompt_tokens": 24, + "total_tokens": 5 }, "choices": [ { - "index": 29, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "ksmchnhpogwrzvyikqzldcjj", + "content": "sjnpbii", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "atrs" + "id": "xiivijvrdytofzempfqawcueb" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index 18c2b9361651..15b10fcebe5f 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "geovtffzoflmmcwafnxxtodjeg", - "created": 29, - "model": "dxafxxeoguemtjyi", + "id": "pzvoxwsrfgaoyumlwihrdliisembh", + "created": 20, + "model": "xloxamseoxvhjlnhtokspgzmn", "usage": { - "completion_tokens": 2, - "prompt_tokens": 21, - "total_tokens": 14 + "completion_tokens": 11, + "prompt_tokens": 24, + "total_tokens": 5 }, "choices": [ { - "index": 29, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "ksmchnhpogwrzvyikqzldcjj" + "content": "sjnpbii" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index f5eecb9a493b..1110b128d5f6 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,31 +6,31 @@ "extra-parameters": "error", "body": { "input": [ - "umrntih" + "gqtbabjehgcotxdmhqibjfopxalpad" ], - "dimensions": 11, + "dimensions": 20, "encoding_format": "base64", "input_type": "text", - "model": "cgdxfwhmwzuzc" + "model": "hodzmeuxtaovannqkrldwy" } }, "responses": { "200": { "body": { - "id": "xqaffburopresrejyeklwhdvgzz", + "id": "uuipgsfeggzjqftntbnhi", "data": [ { "embedding": [ - 21 + 6 ], - "index": 29 + "index": 16 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 6 + "prompt_tokens": 13, + "total_tokens": 2 }, - "model": "rrqqiv" + "model": "nx" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index 7bce9f916710..a9f1828c3dc5 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,27 +5,27 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "pqzaclythijzhgdx" + "mylusofgpbcdlqergwc" ] } }, "responses": { "200": { "body": { - "id": "xqaffburopresrejyeklwhdvgzz", + "id": "uuipgsfeggzjqftntbnhi", "data": [ { "embedding": [ - 21 + 6 ], - "index": 29 + "index": 16 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 6 + "prompt_tokens": 13, + "total_tokens": 2 }, - "model": "rrqqiv" + "model": "nx" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index d1fc78f8ea50..012d0249d093 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,33 +7,33 @@ "body": { "input": [ { - "image": "d", - "text": "vxakqdw" + "image": "afor", + "text": "lme" } ], - "dimensions": 20, + "dimensions": 29, "encoding_format": "base64", "input_type": "text", - "model": "jofsujnpjhvjkqzdskdxoutpfojl" + "model": "gzjrpzlfnotbwkuycbuogcorjvjcn" } }, "responses": { "200": { "body": { - "id": "xqaffburopresrejyeklwhdvgzz", + "id": "uuipgsfeggzjqftntbnhi", "data": [ { "embedding": [ - 21 + 6 ], - "index": 29 + "index": 16 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 6 + "prompt_tokens": 13, + "total_tokens": 2 }, - "model": "rrqqiv" + "model": "nx" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 6b67b5eb454d..606f4f3d4934 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "d" + "image": "afor" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "xqaffburopresrejyeklwhdvgzz", + "id": "uuipgsfeggzjqftntbnhi", "data": [ { "embedding": [ - 21 + 6 ], - "index": 29 + "index": 16 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 6 + "prompt_tokens": 13, + "total_tokens": 2 }, - "model": "rrqqiv" + "model": "nx" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index 80d071a2a08f..0987ea6e2884 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "xxhqafyp", + "model_name": "qzfwujagjyqdgkosgrfw", "model_type": "embeddings", - "model_provider_name": "fcoytwfk" + "model_provider_name": "xnqb" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index 49b32911271b..4462cda78836 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "xxhqafyp", + "model_name": "qzfwujagjyqdgkosgrfw", "model_type": "embeddings", - "model_provider_name": "fcoytwfk" + "model_provider_name": "xnqb" } } } diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index c4ccf0626be8..22e1af360f54 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -151,5 +151,5 @@ union ExtraParameters { drop: "drop", @doc("The service will pass unknown parameters to the back-end AI model.") - pass_through: "pass_through", + pass_through: "pass-through", } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 80072b544cd7..84134c6c778d 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -10,7 +10,7 @@ "role": "ChatRequestMessage" } ], - "frequency_penalty": -1, + "frequency_penalty": -2, "stream": true, "presence_penalty": 1, "temperature": 0, @@ -20,39 +20,39 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "eaci" + "zwwxvquhrhpaevppqwexdxil" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 5, - "model": "glassawrurnrjlogqwkbuxwegqev" + "seed": 13, + "model": "okpvoortuwcnlcqfunqxclxpznresa" } }, "responses": { "200": { "body": { - "id": "geovtffzoflmmcwafnxxtodjeg", - "created": 29, - "model": "dxafxxeoguemtjyi", + "id": "pzvoxwsrfgaoyumlwihrdliisembh", + "created": 20, + "model": "xloxamseoxvhjlnhtokspgzmn", "usage": { - "completion_tokens": 2, - "prompt_tokens": 21, - "total_tokens": 14 + "completion_tokens": 11, + "prompt_tokens": 24, + "total_tokens": 5 }, "choices": [ { - "index": 29, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "ksmchnhpogwrzvyikqzldcjj", + "content": "sjnpbii", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "atrs" + "id": "xiivijvrdytofzempfqawcueb" } ] } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 18c2b9361651..15b10fcebe5f 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "geovtffzoflmmcwafnxxtodjeg", - "created": 29, - "model": "dxafxxeoguemtjyi", + "id": "pzvoxwsrfgaoyumlwihrdliisembh", + "created": 20, + "model": "xloxamseoxvhjlnhtokspgzmn", "usage": { - "completion_tokens": 2, - "prompt_tokens": 21, - "total_tokens": 14 + "completion_tokens": 11, + "prompt_tokens": 24, + "total_tokens": 5 }, "choices": [ { - "index": 29, + "index": 12, "finish_reason": "stop", "message": { "role": "system", - "content": "ksmchnhpogwrzvyikqzldcjj" + "content": "sjnpbii" } } ] diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index f5eecb9a493b..1110b128d5f6 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,31 +6,31 @@ "extra-parameters": "error", "body": { "input": [ - "umrntih" + "gqtbabjehgcotxdmhqibjfopxalpad" ], - "dimensions": 11, + "dimensions": 20, "encoding_format": "base64", "input_type": "text", - "model": "cgdxfwhmwzuzc" + "model": "hodzmeuxtaovannqkrldwy" } }, "responses": { "200": { "body": { - "id": "xqaffburopresrejyeklwhdvgzz", + "id": "uuipgsfeggzjqftntbnhi", "data": [ { "embedding": [ - 21 + 6 ], - "index": 29 + "index": 16 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 6 + "prompt_tokens": 13, + "total_tokens": 2 }, - "model": "rrqqiv" + "model": "nx" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index 7bce9f916710..a9f1828c3dc5 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,27 +5,27 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "pqzaclythijzhgdx" + "mylusofgpbcdlqergwc" ] } }, "responses": { "200": { "body": { - "id": "xqaffburopresrejyeklwhdvgzz", + "id": "uuipgsfeggzjqftntbnhi", "data": [ { "embedding": [ - 21 + 6 ], - "index": 29 + "index": 16 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 6 + "prompt_tokens": 13, + "total_tokens": 2 }, - "model": "rrqqiv" + "model": "nx" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index d1fc78f8ea50..012d0249d093 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,33 +7,33 @@ "body": { "input": [ { - "image": "d", - "text": "vxakqdw" + "image": "afor", + "text": "lme" } ], - "dimensions": 20, + "dimensions": 29, "encoding_format": "base64", "input_type": "text", - "model": "jofsujnpjhvjkqzdskdxoutpfojl" + "model": "gzjrpzlfnotbwkuycbuogcorjvjcn" } }, "responses": { "200": { "body": { - "id": "xqaffburopresrejyeklwhdvgzz", + "id": "uuipgsfeggzjqftntbnhi", "data": [ { "embedding": [ - 21 + 6 ], - "index": 29 + "index": 16 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 6 + "prompt_tokens": 13, + "total_tokens": 2 }, - "model": "rrqqiv" + "model": "nx" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 6b67b5eb454d..606f4f3d4934 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "d" + "image": "afor" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "xqaffburopresrejyeklwhdvgzz", + "id": "uuipgsfeggzjqftntbnhi", "data": [ { "embedding": [ - 21 + 6 ], - "index": 29 + "index": 16 } ], "usage": { - "prompt_tokens": 2, - "total_tokens": 6 + "prompt_tokens": 13, + "total_tokens": 2 }, - "model": "rrqqiv" + "model": "nx" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 80d071a2a08f..0987ea6e2884 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "xxhqafyp", + "model_name": "qzfwujagjyqdgkosgrfw", "model_type": "embeddings", - "model_provider_name": "fcoytwfk" + "model_provider_name": "xnqb" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 49b32911271b..4462cda78836 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "xxhqafyp", + "model_name": "qzfwujagjyqdgkosgrfw", "model_type": "embeddings", - "model_provider_name": "fcoytwfk" + "model_provider_name": "xnqb" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json index 29513ce45564..eb539ed8ed3c 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json @@ -62,7 +62,7 @@ "enum": [ "error", "drop", - "pass_through" + "pass-through" ], "x-ms-enum": { "name": "ExtraParameters", @@ -80,7 +80,7 @@ }, { "name": "pass_through", - "value": "pass_through", + "value": "pass-through", "description": "The service will pass unknown parameters to the back-end AI model." } ] @@ -207,10 +207,10 @@ } }, "x-ms-examples": { - "maximum set chat completion": { + "GetChatCompletions_MaximumSet_Gen": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "minimum set chat completion": { + "GetChatCompletions_MinimumSet_Gen": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -233,7 +233,7 @@ "enum": [ "error", "drop", - "pass_through" + "pass-through" ], "x-ms-enum": { "name": "ExtraParameters", @@ -251,7 +251,7 @@ }, { "name": "pass_through", - "value": "pass_through", + "value": "pass-through", "description": "The service will pass unknown parameters to the back-end AI model." } ] @@ -317,10 +317,10 @@ } }, "x-ms-examples": { - "maximum set embeddings": { + "GetEmbeddings_MaximumSet_Gen": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "minimum set embeddings": { + "GetEmbeddings_MinimumSet_Gen": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } @@ -343,7 +343,7 @@ "enum": [ "error", "drop", - "pass_through" + "pass-through" ], "x-ms-enum": { "name": "ExtraParameters", @@ -361,7 +361,7 @@ }, { "name": "pass_through", - "value": "pass_through", + "value": "pass-through", "description": "The service will pass unknown parameters to the back-end AI model." } ] @@ -428,10 +428,10 @@ } }, "x-ms-examples": { - "maximum set image embeddings": { + "GetImageEmbeddings_MaximumSet_Gen": { "$ref": "./examples/GetImageEmbeddings_MaximumSet_Gen.json" }, - "minimum set image embeddings": { + "GetImageEmbeddings_MinimumSet_Gen": { "$ref": "./examples/GetImageEmbeddings_MinimumSet_Gen.json" } } @@ -467,10 +467,10 @@ } }, "x-ms-examples": { - "maximum set model information": { + "GetModelInfo_MaximumSet_Gen": { "$ref": "./examples/GetModelInfo_MaximumSet_Gen.json" }, - "minimum set model information": { + "GetModelInfo_MinimumSet_Gen": { "$ref": "./examples/GetModelInfo_MinimumSet_Gen.json" } } @@ -1288,7 +1288,7 @@ "enum": [ "error", "drop", - "pass_through" + "pass-through" ], "x-ms-enum": { "name": "ExtraParameters", @@ -1306,7 +1306,7 @@ }, { "name": "pass_through", - "value": "pass_through", + "value": "pass-through", "description": "The service will pass unknown parameters to the back-end AI model." } ] From 7e90c46e0e94ecc7852cf1c8cc941f9906c59d0b Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Thu, 25 Jul 2024 16:38:25 -0700 Subject: [PATCH 323/343] Fix pass-through header Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/common.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 97d76628688d..c6e6a0b24f23 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -151,5 +151,5 @@ union ExtraParameters { drop: "drop", @doc("The service will pass extra parameters to the back-end AI model.") - pass_through: "pass_through", + pass_through: "pass-through", } From 6525a08a59edd52d0b9a670deff5fdb3e09dc105 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 26 Jul 2024 10:08:06 -0700 Subject: [PATCH 324/343] Re-enable protocol methods for csharp Signed-off-by: Travis Angevine --- specification/ai/ModelClient/tspconfig.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index ce37a126573f..d8545016b4ed 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -28,5 +28,4 @@ options: namespace: "Azure.AI.Inference" clear-output-folder: true model-namespace: false - generate-protocol-methods: false flavor: azure \ No newline at end of file From c625ccb513a53bca685fe3e9522a9c78b78fcf7e Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 26 Jul 2024 13:45:16 -0700 Subject: [PATCH 325/343] Remove "spread" for ChatCompletionsOptions Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 7b79bbfad9f8..099c85796f8c 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -25,7 +25,7 @@ namespace AI.Model; @route("chat/completions") op getChatCompletions is Azure.Core.RpcOperation< { - ...ChatCompletionsOptions; + ChatCompletionsOptions; ...AdditionalRequestHeaders; }, ChatCompletions From b3ff7cfc31c6b0a3d873e150af4e0b4c2c289b54 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 26 Jul 2024 13:47:06 -0700 Subject: [PATCH 326/343] Remove spread for additionalRequestHeaders Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 099c85796f8c..4ca23fc8ffae 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -26,7 +26,7 @@ namespace AI.Model; op getChatCompletions is Azure.Core.RpcOperation< { ChatCompletionsOptions; - ...AdditionalRequestHeaders; + AdditionalRequestHeaders; }, ChatCompletions >; From 3cad35ae84bf87371383a55e5a0d46dc3e27db20 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 26 Jul 2024 13:54:43 -0700 Subject: [PATCH 327/343] needed commas Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 4ca23fc8ffae..e074d258be24 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -25,8 +25,8 @@ namespace AI.Model; @route("chat/completions") op getChatCompletions is Azure.Core.RpcOperation< { - ChatCompletionsOptions; - AdditionalRequestHeaders; + ChatCompletionsOptions, + AdditionalRequestHeaders }, ChatCompletions >; From 4d8fe2cbb55d7ff3fd2c0942a727c870ea01487b Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 26 Jul 2024 14:07:34 -0700 Subject: [PATCH 328/343] another formatting attempt Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index e074d258be24..ed4a98970c09 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -25,8 +25,8 @@ namespace AI.Model; @route("chat/completions") op getChatCompletions is Azure.Core.RpcOperation< { - ChatCompletionsOptions, - AdditionalRequestHeaders + body: ChatCompletionsOptions, + ...AdditionalRequestHeaders }, ChatCompletions >; From 442e62ec6da735d3fd71402b941ea612f77b54d5 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 26 Jul 2024 14:25:34 -0700 Subject: [PATCH 329/343] okay, figured out how the formatting works Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index ed4a98970c09..2c1d0ae65e26 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -25,8 +25,8 @@ namespace AI.Model; @route("chat/completions") op getChatCompletions is Azure.Core.RpcOperation< { - body: ChatCompletionsOptions, - ...AdditionalRequestHeaders + chatCompletionsOptions: ChatCompletionsOptions, + extraParams: AdditionalRequestHeaders }, ChatCompletions >; From eba14dabb3bb775b80c7f87f88b72803eaf82562 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 26 Jul 2024 14:31:27 -0700 Subject: [PATCH 330/343] Alias breaks the generator Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/common.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index c6e6a0b24f23..48dee68041bb 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -130,7 +130,7 @@ union ModelType { chat: "chat", } -alias AdditionalRequestHeaders = { +model AdditionalRequestHeaders = { @doc(""" Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload. From 4a3dfd2ac0ca91599e9bc74030e635b631d9520e Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 26 Jul 2024 14:38:59 -0700 Subject: [PATCH 331/343] A model won't give us the interaction pattern that we want. Trying this. Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/common.tsp | 4 ++-- specification/ai/ModelClient/routes.tsp | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 48dee68041bb..3947f08b01e2 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -130,7 +130,7 @@ union ModelType { chat: "chat", } -model AdditionalRequestHeaders = { +alias AdditionalRequestHeaders = { @doc(""" Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload. @@ -138,7 +138,7 @@ model AdditionalRequestHeaders = { """) @header("extra-parameters") extra_params?: ExtraParameters; -}; +} @doc("Controls what happens if extra parameters, undefined by the REST ApI are passed in the JSON request payload.") union ExtraParameters { diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 2c1d0ae65e26..1ebdf5f6e5e1 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -26,7 +26,8 @@ namespace AI.Model; op getChatCompletions is Azure.Core.RpcOperation< { chatCompletionsOptions: ChatCompletionsOptions, - extraParams: AdditionalRequestHeaders + @header("extra-parameters") + extraParams: ExtraParameters }, ChatCompletions >; From 392243f3532a97a0f88520e99997af0cb1214b7d Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Fri, 26 Jul 2024 14:40:36 -0700 Subject: [PATCH 332/343] Forgot semicolon Signed-off-by: Travis Angevine --- specification/ai/ModelClient/models/common.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 3947f08b01e2..c6e6a0b24f23 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -138,7 +138,7 @@ alias AdditionalRequestHeaders = { """) @header("extra-parameters") extra_params?: ExtraParameters; -} +}; @doc("Controls what happens if extra parameters, undefined by the REST ApI are passed in the JSON request payload.") union ExtraParameters { From 072b39922d23a690e4cbffee44baa4b37e300f51 Mon Sep 17 00:00:00 2001 From: Darren Cohen <39422044+dargilco@users.noreply.github.com> Date: Mon, 29 Jul 2024 09:00:37 -0700 Subject: [PATCH 333/343] Bring changes from Travis' TypeSpec branch. Also modify image url to `string` --- specification/ai/ModelClient/client.tsp | 2 +- .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++------ .../GetChatCompletions_MinimumSet_Gen.json | 16 +++---- .../GetEmbeddings_MaximumSet_Gen.json | 18 ++++---- .../GetEmbeddings_MinimumSet_Gen.json | 14 +++--- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 ++++----- .../GetImageEmbeddings_MinimumSet_Gen.json | 14 +++--- .../GetModelInfo_MaximumSet_Gen.json | 4 +- .../GetModelInfo_MinimumSet_Gen.json | 4 +- .../ModelClient/models/chat_completions.tsp | 5 ++- .../ai/ModelClient/models/common.tsp | 8 ++-- specification/ai/ModelClient/tspconfig.yaml | 6 +++ .../GetChatCompletions_MaximumSet_Gen.json | 26 +++++------ .../GetChatCompletions_MinimumSet_Gen.json | 16 +++---- .../GetEmbeddings_MaximumSet_Gen.json | 18 ++++---- .../GetEmbeddings_MinimumSet_Gen.json | 14 +++--- .../GetImageEmbeddings_MaximumSet_Gen.json | 20 ++++----- .../GetImageEmbeddings_MinimumSet_Gen.json | 14 +++--- .../examples/GetModelInfo_MaximumSet_Gen.json | 4 +- .../examples/GetModelInfo_MinimumSet_Gen.json | 4 +- .../preview/2024-05-01-preview/openapi.json | 43 +++++++++---------- 21 files changed, 152 insertions(+), 144 deletions(-) diff --git a/specification/ai/ModelClient/client.tsp b/specification/ai/ModelClient/client.tsp index b67978d9ecbe..9125c05d514e 100644 --- a/specification/ai/ModelClient/client.tsp +++ b/specification/ai/ModelClient/client.tsp @@ -58,7 +58,7 @@ namespace Customizations; // The actual name here doesn't matter and is here for // 1. Add chat completions streaming (to getChatCompletions operator) // 2. Add hyper-params (to getChatCompletions/Embeddings/ImageEmbeddings, all clients) // 3. Cache model info (to getModelInfo, all clients, Python only) -@@access(AI.Model.getChatCompletions, Access.internal, "python"); +@@access(AI.Model.getChatCompletions, Access.internal); @@access(AI.Model.getEmbeddings, Access.internal); @@access(AI.Model.getImageEmbeddings, Access.internal); @@access(AI.Model.getModelInfo, Access.internal, "python"); diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json index 84134c6c778d..e6d3046e3777 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MaximumSet_Gen.json @@ -12,7 +12,7 @@ ], "frequency_penalty": -2, "stream": true, - "presence_penalty": 1, + "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -20,39 +20,39 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "zwwxvquhrhpaevppqwexdxil" + "ssbwclb" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 13, - "model": "okpvoortuwcnlcqfunqxclxpznresa" + "seed": 24, + "model": "ywenpzfibpkmkunmeadllhcadauv" } }, "responses": { "200": { "body": { - "id": "pzvoxwsrfgaoyumlwihrdliisembh", - "created": 20, - "model": "xloxamseoxvhjlnhtokspgzmn", + "id": "jmrhtfblhsuikkokuyxhfarwite", + "created": 14, + "model": "pqixfxtbrvywpoe", "usage": { - "completion_tokens": 11, - "prompt_tokens": 24, - "total_tokens": 5 + "completion_tokens": 26, + "prompt_tokens": 20, + "total_tokens": 2 }, "choices": [ { - "index": 12, + "index": 8, "finish_reason": "stop", "message": { "role": "system", - "content": "sjnpbii", + "content": "csgynyhcslcsbdjvomhiiqxy", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "xiivijvrdytofzempfqawcueb" + "id": "ukzdopmdztxlkmrjhzgeilwb" } ] } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json index 15b10fcebe5f..f531e5e7db98 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "pzvoxwsrfgaoyumlwihrdliisembh", - "created": 20, - "model": "xloxamseoxvhjlnhtokspgzmn", + "id": "jmrhtfblhsuikkokuyxhfarwite", + "created": 14, + "model": "pqixfxtbrvywpoe", "usage": { - "completion_tokens": 11, - "prompt_tokens": 24, - "total_tokens": 5 + "completion_tokens": 26, + "prompt_tokens": 20, + "total_tokens": 2 }, "choices": [ { - "index": 12, + "index": 8, "finish_reason": "stop", "message": { "role": "system", - "content": "sjnpbii" + "content": "csgynyhcslcsbdjvomhiiqxy" } } ] diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json index 1110b128d5f6..ed254f6b6934 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MaximumSet_Gen.json @@ -6,31 +6,31 @@ "extra-parameters": "error", "body": { "input": [ - "gqtbabjehgcotxdmhqibjfopxalpad" + "asnckkogedtvtodumpbusxpoteif" ], - "dimensions": 20, + "dimensions": 4, "encoding_format": "base64", "input_type": "text", - "model": "hodzmeuxtaovannqkrldwy" + "model": "hbbjcynbaqvpxwzxrqvrodsrqcsa" } }, "responses": { "200": { "body": { - "id": "uuipgsfeggzjqftntbnhi", + "id": "yzbiigssewkfajwwdfmncos", "data": [ { "embedding": [ - 6 + 16 ], - "index": 16 + "index": 17 } ], "usage": { - "prompt_tokens": 13, - "total_tokens": 2 + "prompt_tokens": 11, + "total_tokens": 26 }, - "model": "nx" + "model": "szvebelgobogjjmayufu" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json index a9f1828c3dc5..af7e642a5957 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetEmbeddings_MinimumSet_Gen.json @@ -5,27 +5,27 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "mylusofgpbcdlqergwc" + "zyoasagrjfawa" ] } }, "responses": { "200": { "body": { - "id": "uuipgsfeggzjqftntbnhi", + "id": "yzbiigssewkfajwwdfmncos", "data": [ { "embedding": [ - 6 + 16 ], - "index": 16 + "index": 17 } ], "usage": { - "prompt_tokens": 13, - "total_tokens": 2 + "prompt_tokens": 11, + "total_tokens": 26 }, - "model": "nx" + "model": "szvebelgobogjjmayufu" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json index 012d0249d093..064ec0a298b5 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,33 +7,33 @@ "body": { "input": [ { - "image": "afor", - "text": "lme" + "image": "hoxyrkhicrqqxmyzpullhfxamdm", + "text": "cbczrcgdxdaqr" } ], - "dimensions": 29, + "dimensions": 28, "encoding_format": "base64", "input_type": "text", - "model": "gzjrpzlfnotbwkuycbuogcorjvjcn" + "model": "lofsczyh" } }, "responses": { "200": { "body": { - "id": "uuipgsfeggzjqftntbnhi", + "id": "yzbiigssewkfajwwdfmncos", "data": [ { "embedding": [ - 6 + 16 ], - "index": 16 + "index": 17 } ], "usage": { - "prompt_tokens": 13, - "total_tokens": 2 + "prompt_tokens": 11, + "total_tokens": 26 }, - "model": "nx" + "model": "szvebelgobogjjmayufu" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json index 606f4f3d4934..2887cb29d9a8 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "afor" + "image": "hoxyrkhicrqqxmyzpullhfxamdm" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "uuipgsfeggzjqftntbnhi", + "id": "yzbiigssewkfajwwdfmncos", "data": [ { "embedding": [ - 6 + 16 ], - "index": 16 + "index": 17 } ], "usage": { - "prompt_tokens": 13, - "total_tokens": 2 + "prompt_tokens": 11, + "total_tokens": 26 }, - "model": "nx" + "model": "szvebelgobogjjmayufu" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json index 0987ea6e2884..02e03d76e31e 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "qzfwujagjyqdgkosgrfw", + "model_name": "kvndu", "model_type": "embeddings", - "model_provider_name": "xnqb" + "model_provider_name": "cfaheoodkzkhuurrkgr" } } } diff --git a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json index 4462cda78836..2042c0c67230 100644 --- a/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/ModelClient/examples/2024-05-01-preview/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "qzfwujagjyqdgkosgrfw", + "model_name": "kvndu", "model_type": "embeddings", - "model_provider_name": "xnqb" + "model_provider_name": "cfaheoodkzkhuurrkgr" } } } diff --git a/specification/ai/ModelClient/models/chat_completions.tsp b/specification/ai/ModelClient/models/chat_completions.tsp index acdc1a3e9a80..99046658f9b5 100644 --- a/specification/ai/ModelClient/models/chat_completions.tsp +++ b/specification/ai/ModelClient/models/chat_completions.tsp @@ -33,6 +33,7 @@ alias ChatCompletionsOptions = { @doc(""" A value indicating whether chat completions should be streamed for this request. """) + @clientName("InternalShouldStreamResponse", "csharp") stream?: boolean; @doc(""" @@ -69,6 +70,7 @@ alias ChatCompletionsOptions = { """) @maxValue(1.0) @minValue(0.0) + @clientName("NucleusSamplingFactor", "csharp") top_p?: float32 = 1.0; @doc("The maximum number of tokens to generate.") @@ -86,6 +88,7 @@ alias ChatCompletionsOptions = { A collection of textual sequences that will end completions generation. """) @minItems(1) + @clientName("StopSequences", "csharp") stop?: string[]; @doc("The available tool definitions that the chat completions request can use, including caller-defined functions.") @@ -519,7 +522,7 @@ model ChatMessageImageContentItem extends ChatMessageContentItem { @doc("An internet location from which the model may retrieve an image.") model ChatMessageImageUrl { @doc("The URL of the image.") - url: url; + url: string; @doc(""" The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and diff --git a/specification/ai/ModelClient/models/common.tsp b/specification/ai/ModelClient/models/common.tsp index 22e1af360f54..1ed5cebe7f3d 100644 --- a/specification/ai/ModelClient/models/common.tsp +++ b/specification/ai/ModelClient/models/common.tsp @@ -140,16 +140,16 @@ alias AdditionalRequestHeaders = { extra_params?: ExtraParameters; }; -@doc("Controls what happens if extra parameters, undefined byt he REST ApI are passed in the JSON request payload.") +@doc("Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload.") union ExtraParameters { string, - @doc("The service will error if it detected unknown parameters in the request payload. This is the service default.") + @doc("The service will error if it detected exta parameters in the request payload. This is the service default.") error: "error", - @doc("The service will ignore (drop) unknown parameters in the request payload. It will only pass the known parameters to the back-end AI model.") + @doc("The service will ignore (drop) extra parameters in the request payload. It will only pass the known parameters to the back-end AI model.") drop: "drop", - @doc("The service will pass unknown parameters to the back-end AI model.") + @doc("The service will pass extra parameters to the back-end AI model.") pass_through: "pass-through", } diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index a26f4bb590e9..a43f47381cc8 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -23,3 +23,9 @@ options: package-dir: "azure-ai-inference" package-name: "{package-dir}" flavor: azure + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.Inference" + namespace: "Azure.AI.Inference" + clear-output-folder: true + model-namespace: false + flavor: azure diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json index 84134c6c778d..e6d3046e3777 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MaximumSet_Gen.json @@ -12,7 +12,7 @@ ], "frequency_penalty": -2, "stream": true, - "presence_penalty": 1, + "presence_penalty": -1, "temperature": 0, "top_p": 0, "max_tokens": 0, @@ -20,39 +20,39 @@ "type": "ChatCompletionsResponseFormat" }, "stop": [ - "zwwxvquhrhpaevppqwexdxil" + "ssbwclb" ], "tools": [ { "type": "ChatCompletionsToolDefinition" } ], - "seed": 13, - "model": "okpvoortuwcnlcqfunqxclxpznresa" + "seed": 24, + "model": "ywenpzfibpkmkunmeadllhcadauv" } }, "responses": { "200": { "body": { - "id": "pzvoxwsrfgaoyumlwihrdliisembh", - "created": 20, - "model": "xloxamseoxvhjlnhtokspgzmn", + "id": "jmrhtfblhsuikkokuyxhfarwite", + "created": 14, + "model": "pqixfxtbrvywpoe", "usage": { - "completion_tokens": 11, - "prompt_tokens": 24, - "total_tokens": 5 + "completion_tokens": 26, + "prompt_tokens": 20, + "total_tokens": 2 }, "choices": [ { - "index": 12, + "index": 8, "finish_reason": "stop", "message": { "role": "system", - "content": "sjnpbii", + "content": "csgynyhcslcsbdjvomhiiqxy", "tool_calls": [ { "type": "ChatCompletionsToolCall", - "id": "xiivijvrdytofzempfqawcueb" + "id": "ukzdopmdztxlkmrjhzgeilwb" } ] } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json index 15b10fcebe5f..f531e5e7db98 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetChatCompletions_MinimumSet_Gen.json @@ -14,21 +14,21 @@ "responses": { "200": { "body": { - "id": "pzvoxwsrfgaoyumlwihrdliisembh", - "created": 20, - "model": "xloxamseoxvhjlnhtokspgzmn", + "id": "jmrhtfblhsuikkokuyxhfarwite", + "created": 14, + "model": "pqixfxtbrvywpoe", "usage": { - "completion_tokens": 11, - "prompt_tokens": 24, - "total_tokens": 5 + "completion_tokens": 26, + "prompt_tokens": 20, + "total_tokens": 2 }, "choices": [ { - "index": 12, + "index": 8, "finish_reason": "stop", "message": { "role": "system", - "content": "sjnpbii" + "content": "csgynyhcslcsbdjvomhiiqxy" } } ] diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json index 1110b128d5f6..ed254f6b6934 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MaximumSet_Gen.json @@ -6,31 +6,31 @@ "extra-parameters": "error", "body": { "input": [ - "gqtbabjehgcotxdmhqibjfopxalpad" + "asnckkogedtvtodumpbusxpoteif" ], - "dimensions": 20, + "dimensions": 4, "encoding_format": "base64", "input_type": "text", - "model": "hodzmeuxtaovannqkrldwy" + "model": "hbbjcynbaqvpxwzxrqvrodsrqcsa" } }, "responses": { "200": { "body": { - "id": "uuipgsfeggzjqftntbnhi", + "id": "yzbiigssewkfajwwdfmncos", "data": [ { "embedding": [ - 6 + 16 ], - "index": 16 + "index": 17 } ], "usage": { - "prompt_tokens": 13, - "total_tokens": 2 + "prompt_tokens": 11, + "total_tokens": 26 }, - "model": "nx" + "model": "szvebelgobogjjmayufu" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json index a9f1828c3dc5..af7e642a5957 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetEmbeddings_MinimumSet_Gen.json @@ -5,27 +5,27 @@ "api-version": "2024-05-01-preview", "body": { "input": [ - "mylusofgpbcdlqergwc" + "zyoasagrjfawa" ] } }, "responses": { "200": { "body": { - "id": "uuipgsfeggzjqftntbnhi", + "id": "yzbiigssewkfajwwdfmncos", "data": [ { "embedding": [ - 6 + 16 ], - "index": 16 + "index": 17 } ], "usage": { - "prompt_tokens": 13, - "total_tokens": 2 + "prompt_tokens": 11, + "total_tokens": 26 }, - "model": "nx" + "model": "szvebelgobogjjmayufu" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json index 012d0249d093..064ec0a298b5 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MaximumSet_Gen.json @@ -7,33 +7,33 @@ "body": { "input": [ { - "image": "afor", - "text": "lme" + "image": "hoxyrkhicrqqxmyzpullhfxamdm", + "text": "cbczrcgdxdaqr" } ], - "dimensions": 29, + "dimensions": 28, "encoding_format": "base64", "input_type": "text", - "model": "gzjrpzlfnotbwkuycbuogcorjvjcn" + "model": "lofsczyh" } }, "responses": { "200": { "body": { - "id": "uuipgsfeggzjqftntbnhi", + "id": "yzbiigssewkfajwwdfmncos", "data": [ { "embedding": [ - 6 + 16 ], - "index": 16 + "index": 17 } ], "usage": { - "prompt_tokens": 13, - "total_tokens": 2 + "prompt_tokens": 11, + "total_tokens": 26 }, - "model": "nx" + "model": "szvebelgobogjjmayufu" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json index 606f4f3d4934..2887cb29d9a8 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetImageEmbeddings_MinimumSet_Gen.json @@ -6,7 +6,7 @@ "body": { "input": [ { - "image": "afor" + "image": "hoxyrkhicrqqxmyzpullhfxamdm" } ] } @@ -14,20 +14,20 @@ "responses": { "200": { "body": { - "id": "uuipgsfeggzjqftntbnhi", + "id": "yzbiigssewkfajwwdfmncos", "data": [ { "embedding": [ - 6 + 16 ], - "index": 16 + "index": 17 } ], "usage": { - "prompt_tokens": 13, - "total_tokens": 2 + "prompt_tokens": 11, + "total_tokens": 26 }, - "model": "nx" + "model": "szvebelgobogjjmayufu" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json index 0987ea6e2884..02e03d76e31e 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MaximumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "qzfwujagjyqdgkosgrfw", + "model_name": "kvndu", "model_type": "embeddings", - "model_provider_name": "xnqb" + "model_provider_name": "cfaheoodkzkhuurrkgr" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json index 4462cda78836..2042c0c67230 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/examples/GetModelInfo_MinimumSet_Gen.json @@ -7,9 +7,9 @@ "responses": { "200": { "body": { - "model_name": "qzfwujagjyqdgkosgrfw", + "model_name": "kvndu", "model_type": "embeddings", - "model_provider_name": "xnqb" + "model_provider_name": "cfaheoodkzkhuurrkgr" } } } diff --git a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json index eb539ed8ed3c..59ca4757d6dd 100644 --- a/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json +++ b/specification/ai/data-plane/AI.Model/preview/2024-05-01-preview/openapi.json @@ -71,17 +71,17 @@ { "name": "error", "value": "error", - "description": "The service will error if it detected unknown parameters in the request payload. This is the service default." + "description": "The service will error if it detected exta parameters in the request payload. This is the service default." }, { "name": "drop", "value": "drop", - "description": "The service will ignore (drop) unknown parameters in the request payload. It will only pass the known parameters to the back-end AI model." + "description": "The service will ignore (drop) extra parameters in the request payload. It will only pass the known parameters to the back-end AI model." }, { "name": "pass_through", "value": "pass-through", - "description": "The service will pass unknown parameters to the back-end AI model." + "description": "The service will pass extra parameters to the back-end AI model." } ] }, @@ -207,10 +207,10 @@ } }, "x-ms-examples": { - "GetChatCompletions_MaximumSet_Gen": { + "maximum set chat completion": { "$ref": "./examples/GetChatCompletions_MaximumSet_Gen.json" }, - "GetChatCompletions_MinimumSet_Gen": { + "minimum set chat completion": { "$ref": "./examples/GetChatCompletions_MinimumSet_Gen.json" } } @@ -242,17 +242,17 @@ { "name": "error", "value": "error", - "description": "The service will error if it detected unknown parameters in the request payload. This is the service default." + "description": "The service will error if it detected exta parameters in the request payload. This is the service default." }, { "name": "drop", "value": "drop", - "description": "The service will ignore (drop) unknown parameters in the request payload. It will only pass the known parameters to the back-end AI model." + "description": "The service will ignore (drop) extra parameters in the request payload. It will only pass the known parameters to the back-end AI model." }, { "name": "pass_through", "value": "pass-through", - "description": "The service will pass unknown parameters to the back-end AI model." + "description": "The service will pass extra parameters to the back-end AI model." } ] }, @@ -317,10 +317,10 @@ } }, "x-ms-examples": { - "GetEmbeddings_MaximumSet_Gen": { + "maximum set embeddings": { "$ref": "./examples/GetEmbeddings_MaximumSet_Gen.json" }, - "GetEmbeddings_MinimumSet_Gen": { + "minimum set embeddings": { "$ref": "./examples/GetEmbeddings_MinimumSet_Gen.json" } } @@ -352,17 +352,17 @@ { "name": "error", "value": "error", - "description": "The service will error if it detected unknown parameters in the request payload. This is the service default." + "description": "The service will error if it detected exta parameters in the request payload. This is the service default." }, { "name": "drop", "value": "drop", - "description": "The service will ignore (drop) unknown parameters in the request payload. It will only pass the known parameters to the back-end AI model." + "description": "The service will ignore (drop) extra parameters in the request payload. It will only pass the known parameters to the back-end AI model." }, { "name": "pass_through", "value": "pass-through", - "description": "The service will pass unknown parameters to the back-end AI model." + "description": "The service will pass extra parameters to the back-end AI model." } ] }, @@ -428,10 +428,10 @@ } }, "x-ms-examples": { - "GetImageEmbeddings_MaximumSet_Gen": { + "maximum set image embeddings": { "$ref": "./examples/GetImageEmbeddings_MaximumSet_Gen.json" }, - "GetImageEmbeddings_MinimumSet_Gen": { + "minimum set image embeddings": { "$ref": "./examples/GetImageEmbeddings_MinimumSet_Gen.json" } } @@ -467,10 +467,10 @@ } }, "x-ms-examples": { - "GetModelInfo_MaximumSet_Gen": { + "maximum set model information": { "$ref": "./examples/GetModelInfo_MaximumSet_Gen.json" }, - "GetModelInfo_MinimumSet_Gen": { + "minimum set model information": { "$ref": "./examples/GetModelInfo_MinimumSet_Gen.json" } } @@ -854,7 +854,6 @@ "properties": { "url": { "type": "string", - "format": "uri", "description": "The URL of the image." }, "detail": { @@ -1284,7 +1283,7 @@ }, "ExtraParameters": { "type": "string", - "description": "Controls what happens if extra parameters, undefined byt he REST ApI are passed in the JSON request payload.", + "description": "Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload.", "enum": [ "error", "drop", @@ -1297,17 +1296,17 @@ { "name": "error", "value": "error", - "description": "The service will error if it detected unknown parameters in the request payload. This is the service default." + "description": "The service will error if it detected exta parameters in the request payload. This is the service default." }, { "name": "drop", "value": "drop", - "description": "The service will ignore (drop) unknown parameters in the request payload. It will only pass the known parameters to the back-end AI model." + "description": "The service will ignore (drop) extra parameters in the request payload. It will only pass the known parameters to the back-end AI model." }, { "name": "pass_through", "value": "pass-through", - "description": "The service will pass unknown parameters to the back-end AI model." + "description": "The service will pass extra parameters to the back-end AI model." } ] } From 72ff5d0c95232077cb14077aa19418ac3be4c51c Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Mon, 29 Jul 2024 10:21:39 -0700 Subject: [PATCH 334/343] Does swapping the order of parameters matter? Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 1ebdf5f6e5e1..43f7e6623496 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -25,9 +25,9 @@ namespace AI.Model; @route("chat/completions") op getChatCompletions is Azure.Core.RpcOperation< { - chatCompletionsOptions: ChatCompletionsOptions, @header("extra-parameters") - extraParams: ExtraParameters + extraParams: ExtraParameters, + chatCompletionsOptions: ChatCompletionsOptions }, ChatCompletions >; From 063b0518fe07a2bc9c86c1fc32080693682891f0 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Mon, 29 Jul 2024 10:31:39 -0700 Subject: [PATCH 335/343] Make extraParams optional? Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 43f7e6623496..2b3589e8eb7d 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -25,9 +25,9 @@ namespace AI.Model; @route("chat/completions") op getChatCompletions is Azure.Core.RpcOperation< { + chatCompletionsOptions: ChatCompletionsOptions, @header("extra-parameters") - extraParams: ExtraParameters, - chatCompletionsOptions: ChatCompletionsOptions + extraParams?: ExtraParameters }, ChatCompletions >; From dd47e68edf1ff4fa61842a54815a88b29ef084ea Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Mon, 29 Jul 2024 13:15:21 -0700 Subject: [PATCH 336/343] Try and get rid of anonymous model Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 2b3589e8eb7d..df5d35330b65 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -24,11 +24,7 @@ namespace AI.Model; @actionSeparator("/") @route("chat/completions") op getChatCompletions is Azure.Core.RpcOperation< - { - chatCompletionsOptions: ChatCompletionsOptions, - @header("extra-parameters") - extraParams?: ExtraParameters - }, + ChatCompletionsOptions & AdditionalRequestHeaders, ChatCompletions >; From 1f6224294f94d356afa456576f85aef37a4b165c Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Mon, 29 Jul 2024 13:49:57 -0700 Subject: [PATCH 337/343] Try adding RequestHeadersTrait Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index df5d35330b65..83114aca3158 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -24,8 +24,9 @@ namespace AI.Model; @actionSeparator("/") @route("chat/completions") op getChatCompletions is Azure.Core.RpcOperation< - ChatCompletionsOptions & AdditionalRequestHeaders, - ChatCompletions + ChatCompletionsOptions, + ChatCompletions, + RequestHeadersTrait >; @doc(""" From 7254471d0389b26504ced9de61025c3e8524b0cd Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Mon, 29 Jul 2024 14:09:23 -0700 Subject: [PATCH 338/343] Maybe needs to be an object? Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 83114aca3158..a59a8475bd5d 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -26,7 +26,7 @@ namespace AI.Model; op getChatCompletions is Azure.Core.RpcOperation< ChatCompletionsOptions, ChatCompletions, - RequestHeadersTrait + {RequestHeadersTrait} >; @doc(""" From d752df67297da65db27bf12502914a2eb85666c4 Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Mon, 29 Jul 2024 14:16:21 -0700 Subject: [PATCH 339/343] Add using Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index a59a8475bd5d..604830894dfc 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -12,6 +12,7 @@ using TypeSpec.Rest; using TypeSpec.Http; using TypeSpec.Versioning; using Azure.Core; +using Azure.Core.Traits; namespace AI.Model; @@ -26,7 +27,7 @@ namespace AI.Model; op getChatCompletions is Azure.Core.RpcOperation< ChatCompletionsOptions, ChatCompletions, - {RequestHeadersTrait} + RequestHeadersTrait >; @doc(""" From 4039eb161a839f14dd1daa1ef01bc7a475fea5ff Mon Sep 17 00:00:00 2001 From: Travis Angevine Date: Tue, 30 Jul 2024 09:24:21 -0700 Subject: [PATCH 340/343] Revert to "good" state Signed-off-by: Travis Angevine --- specification/ai/ModelClient/routes.tsp | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/specification/ai/ModelClient/routes.tsp b/specification/ai/ModelClient/routes.tsp index 604830894dfc..258eb23a0b6a 100644 --- a/specification/ai/ModelClient/routes.tsp +++ b/specification/ai/ModelClient/routes.tsp @@ -16,6 +16,9 @@ using Azure.Core.Traits; namespace AI.Model; +/* +Leaving this comment out for now as the "Goal" for how this should be formatted + @doc(""" Gets chat completions for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" @@ -29,6 +32,24 @@ op getChatCompletions is Azure.Core.RpcOperation< ChatCompletions, RequestHeadersTrait >; +*/ + +@doc(""" + Gets chat completions for the provided chat messages. + Completions support a wide variety of tasks and generate text that continues from or "completes" + provided prompt data. The method makes a REST API call to the `/chat/completions` route + on the given endpoint. + """) +@actionSeparator("/") +@route("chat/completions") +op getChatCompletions is Azure.Core.RpcOperation< + { + chatCompletionsOptions: ChatCompletionsOptions, + @header("extra-parameters") + extraParams?: ExtraParameters, + }, + ChatCompletions +>; @doc(""" Return the embedding vectors for given text prompts. From b74a7a8646bfba65812ac9860e7ef3c1dc7c4ea5 Mon Sep 17 00:00:00 2001 From: Wenming Liu Date: Mon, 21 Oct 2024 16:45:42 +0800 Subject: [PATCH 341/343] Update tspconfig.yaml --- specification/ai/ModelClient/tspconfig.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index d8545016b4ed..7e198715f9e3 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -28,4 +28,5 @@ options: namespace: "Azure.AI.Inference" clear-output-folder: true model-namespace: false - flavor: azure \ No newline at end of file + flavor: azure + use-write-core: true \ No newline at end of file From a8186cda8e2a89d8d3fdfd1d123f83d8c0fcc69d Mon Sep 17 00:00:00 2001 From: Wenming Liu Date: Mon, 21 Oct 2024 16:46:05 +0800 Subject: [PATCH 342/343] Revert "Update tspconfig.yaml" This reverts commit b74a7a8646bfba65812ac9860e7ef3c1dc7c4ea5. --- specification/ai/ModelClient/tspconfig.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index 7e198715f9e3..d8545016b4ed 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -28,5 +28,4 @@ options: namespace: "Azure.AI.Inference" clear-output-folder: true model-namespace: false - flavor: azure - use-write-core: true \ No newline at end of file + flavor: azure \ No newline at end of file From 77b8dceea9dc9b958323f34cbbc12e741d93d95d Mon Sep 17 00:00:00 2001 From: Wenming Liu Date: Mon, 21 Oct 2024 16:47:18 +0800 Subject: [PATCH 343/343] Update tspconfig.yaml --- specification/ai/ModelClient/tspconfig.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/ai/ModelClient/tspconfig.yaml b/specification/ai/ModelClient/tspconfig.yaml index d8545016b4ed..7e198715f9e3 100644 --- a/specification/ai/ModelClient/tspconfig.yaml +++ b/specification/ai/ModelClient/tspconfig.yaml @@ -28,4 +28,5 @@ options: namespace: "Azure.AI.Inference" clear-output-folder: true model-namespace: false - flavor: azure \ No newline at end of file + flavor: azure + use-write-core: true \ No newline at end of file